Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ on:
pull_request:
branches: [main]

permissions:
contents: read

env:
CARGO_TERM_COLOR: always
RUST_BACKTRACE: 1
Expand Down Expand Up @@ -80,3 +83,14 @@ jobs:
run: cargo doc --workspace --no-deps
env:
RUSTDOCFLAGS: -D warnings

examples:
name: Examples
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Run fetch_urls example
run: cargo run -p fetchkit --example fetch_urls
timeout-minutes: 2
12 changes: 12 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description = "AI-friendly fetchkit tool, CLI, MCP server, and library"
tokio = { version = "1", features = ["rt-multi-thread", "macros", "time", "sync"] }

# HTTP client
reqwest = { version = "0.12", default-features = false, features = ["rustls-tls-native-roots", "gzip", "brotli", "deflate", "stream"] }
reqwest = { version = "0.12", default-features = false, features = ["rustls-tls-native-roots", "gzip", "brotli", "deflate", "stream", "json"] }

# Serialization
serde = { version = "1", features = ["derive"] }
Expand All @@ -42,3 +42,6 @@ bytes = "1"

# Testing
wiremock = "0.6"

# Async traits
async-trait = "0.1"
1 change: 1 addition & 0 deletions crates/fetchkit/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ tracing = { workspace = true }
thiserror = { workspace = true }
futures = { workspace = true }
bytes = { workspace = true }
async-trait = { workspace = true }

[dev-dependencies]
wiremock = { workspace = true }
Expand Down
146 changes: 146 additions & 0 deletions crates/fetchkit/examples/fetch_urls.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
//! Example: Fetch various URLs and display results
//!
//! Run with: cargo run -p fetchkit --example fetch_urls
//!
//! This example demonstrates the fetcher system with different URL types.

use fetchkit::{fetch, FetchRequest, FetchResponse};

/// Test case definition
struct TestCase {
url: &'static str,
description: &'static str,
expect_format: Option<&'static str>,
expect_contains: Option<&'static str>,
}

/// Define test cases here
const TEST_CASES: &[TestCase] = &[
TestCase {
url: "https://example.com",
description: "Simple HTML page",
expect_format: Some("markdown"),
expect_contains: Some("Example Domain"),
},
TestCase {
url: "https://httpbin.org/json",
description: "JSON endpoint",
expect_format: Some("raw"),
expect_contains: Some("slideshow"),
},
TestCase {
url: "https://httpbin.org/html",
description: "HTML endpoint",
expect_format: Some("markdown"),
expect_contains: Some("Herman Melville"),
},
TestCase {
url: "https://github.com/rust-lang/rust",
description: "GitHub repository (uses GitHubRepoFetcher)",
expect_format: Some("github_repo"),
expect_contains: Some("rust-lang/rust"),
},
TestCase {
url: "https://raw.githubusercontent.com/rust-lang/rust/master/README.md",
description: "Raw markdown file",
expect_format: Some("raw"),
expect_contains: Some("Rust"),
},
];

#[tokio::main]
async fn main() {
println!("FetchKit URL Examples");
println!("=====================\n");

let mut passed = 0;
let mut failed = 0;

for (i, case) in TEST_CASES.iter().enumerate() {
println!("{}. {}", i + 1, case.description);
println!(" URL: {}", case.url);

let request = FetchRequest::new(case.url).as_markdown();

match fetch(request).await {
Ok(response) => {
let check_result = check_expectations(case, &response);
print_response_summary(&response);

if check_result {
println!(" ✓ PASS\n");
passed += 1;
} else {
println!(" ✗ FAIL (expectations not met)\n");
failed += 1;
}
}
Err(e) => {
println!(" Error: {}", e);
println!(" ✗ FAIL\n");
failed += 1;
}
}
}

println!("=====================");
println!("Results: {} passed, {} failed", passed, failed);

if failed > 0 {
std::process::exit(1);
}
}

fn print_response_summary(response: &FetchResponse) {
println!(" Status: {}", response.status_code);

if let Some(ref format) = response.format {
println!(" Format: {}", format);
}

if let Some(ref ct) = response.content_type {
println!(" Content-Type: {}", ct);
}

if let Some(size) = response.size {
println!(" Size: {} bytes", size);
}

if let Some(ref content) = response.content {
let preview = content.chars().take(100).collect::<String>();
let preview = preview.replace('\n', " ");
println!(
" Preview: {}{}",
preview,
if content.len() > 100 { "..." } else { "" }
);
}

if let Some(ref error) = response.error {
println!(" Error: {}", error);
}
}

fn check_expectations(case: &TestCase, response: &FetchResponse) -> bool {
// Check format
if let Some(expected_format) = case.expect_format {
if response.format.as_deref() != Some(expected_format) {
println!(
" Expected format '{}', got '{:?}'",
expected_format, response.format
);
return false;
}
}

// Check content contains
if let Some(expected_text) = case.expect_contains {
let content = response.content.as_deref().unwrap_or("");
if !content.contains(expected_text) {
println!(" Expected content to contain '{}'", expected_text);
return false;
}
}

true
}
Loading