patent 0.7.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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! Hex source — `GET https://hex.pm/api/packages?search=`.
//!
//! Hex is the package registry for the Erlang/Elixir ecosystem (Mix, Rebar3,
//! Phoenix). The search endpoint returns a JSON array of packages; each carries
//! a `meta.description`, an `html_url`, and a `downloads` block whose `all`
//! field is the lifetime download count we surface as popularity.

use serde::Deserialize;

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

/// Default Hex host. Overridable in tests via [`Hex::with_base_url`].
const DEFAULT_BASE_URL: &str = "https://hex.pm";

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

impl Hex {
    /// Construct against the live Hex 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 }
    }
}

/// A single package in the Hex search response array. Only the fields we
/// surface are decoded.
#[derive(Debug, Deserialize)]
struct Package {
    name: String,
    #[serde(default)]
    html_url: Option<String>,
    #[serde(default)]
    meta: Meta,
    #[serde(default)]
    downloads: Downloads,
}

/// The `meta` block; only the human-readable description is used.
#[derive(Debug, Default, Deserialize)]
struct Meta {
    #[serde(default)]
    description: Option<String>,
}

/// The `downloads` block; `all` is the lifetime count used as popularity.
#[derive(Debug, Default, Deserialize)]
struct Downloads {
    #[serde(default)]
    all: Option<u64>,
}

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

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

        let body: Vec<Package> = self
            .client
            .get(&url)
            .query(&[("search", q.as_str()), ("page", "1")])
            .send()
            .await?
            .error_for_status()?
            .json()
            .await?;

        Ok(body
            .into_iter()
            .map(|p| {
                // Prefer the registry-provided web link; fall back to the
                // canonical package URL (honoring base_url so tests stay local).
                let url = p
                    .html_url
                    .filter(|u| !u.trim().is_empty())
                    .unwrap_or_else(|| format!("{}/packages/{}", self.base_url, p.name));
                Match {
                    name: p.name,
                    source: Source::Hex,
                    url,
                    description: p.meta.description.unwrap_or_default(),
                    // Treat a zero/absent lifetime download count as no signal.
                    popularity: p.downloads.all.filter(|&d| d > 0),
                    similarity: 0.0,
                }
            })
            .collect())
    }
}