patent 0.2.0

A prior-art search for your code ideas — has this dev tool already been shipped?
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! crates.io source — `GET https://crates.io/api/v1/crates?q=`.

use serde::Deserialize;

use super::SourceAdapter;
use crate::model::{Match, Query, Source};
use crate::Result;

/// Default crates.io host. Overridable in tests via [`CratesIo::with_base_url`].
const DEFAULT_BASE_URL: &str = "https://crates.io";

/// User-Agent sent on every request — crates.io rejects requests without one.
const USER_AGENT: &str = concat!(
    "patent/",
    env!("CARGO_PKG_VERSION"),
    " (prior-art search; https://github.com/riad/patent)"
);

/// Searches the crates.io registry.
#[derive(Debug, Clone)]
pub struct CratesIo {
    client: reqwest::Client,
    base_url: String,
}

impl CratesIo {
    /// Construct against the live crates.io host.
    pub fn new(client: reqwest::Client) -> Self {
        Self::with_base_url(client, DEFAULT_BASE_URL.to_string())
    }

    /// Construct against an arbitrary base URL (used by tests to point at a mock
    /// server). `base_url` should have no trailing slash.
    pub fn with_base_url(client: reqwest::Client, base_url: String) -> Self {
        Self { client, base_url }
    }
}

/// Top-level shape of the crates.io search response.
#[derive(Debug, Deserialize)]
struct SearchResponse {
    crates: Vec<CrateHit>,
}

/// A single crate in the `crates` array. Only the fields we surface are decoded.
#[derive(Debug, Deserialize)]
struct CrateHit {
    name: String,
    #[serde(default)]
    description: Option<String>,
    #[serde(default)]
    downloads: Option<u64>,
}

#[async_trait::async_trait]
impl SourceAdapter for CratesIo {
    fn id(&self) -> Source {
        Source::CratesIo
    }

    async fn search(&self, query: &Query) -> Result<Vec<Match>> {
        let url = format!("{}/api/v1/crates", self.base_url);
        let q = query.keywords.join(" ");

        let response = self
            .client
            .get(&url)
            .header(reqwest::header::USER_AGENT, USER_AGENT)
            .query(&[("q", q.as_str()), ("per_page", "20")])
            .send()
            .await?
            .error_for_status()?;

        let body: SearchResponse = response.json().await?;

        Ok(body
            .crates
            .into_iter()
            .map(|c| Match {
                url: format!("{DEFAULT_BASE_URL}/crates/{}", c.name),
                name: c.name,
                source: Source::CratesIo,
                description: c.description.unwrap_or_default(),
                popularity: c.downloads,
                similarity: 0.0,
            })
            .collect())
    }
}