Skip to main content

crossref_client/query/
members.rs

1use crate::error::Result;
2use crate::query::works::{WorksCombiner, WorksIdentQuery};
3use crate::query::*;
4use std::borrow::Cow;
5
6define_filter! {
7/// Narrows a `/members` query.
8///
9/// `has-public-references` and `reference-visibility` used to be here; the
10/// route rejects both with a `400`. `blackfile-doi-count` was a typo for
11/// `backfile-doi-count` and never matched anything either.
12MembersFilter;
13markers {}
14values {
15    /// members that own the given DOI prefix
16    Prefix(String) => "prefix",
17    /// count of DOIs for material published more than two years ago
18    BackfileDoiCount(i32) => "backfile-doi-count",
19    /// count of DOIs for material published within the last two years
20    CurrentDoiCount(i32) => "current-doi-count",
21}
22}
23
24impl_list_query!(
25    /// Used to construct a query that targets crossref `Member` elements
26    ///
27    /// # Example
28    ///
29    /// ```no_run
30    /// use crossref_client::{MembersFilter, MembersQuery, ResultControl};
31    ///
32    /// let query = MembersQuery::new("Elsevier")
33    ///     .filter(MembersFilter::CurrentDoiCount(1000))
34    ///     .result_control(ResultControl::Rows(10));
35    /// ```
36    ///
37    /// The route takes terms, filters and paging. It used to also offer
38    /// `sort`, `order` and `facet`, which crossref answers with a `400`.
39    MembersQuery,
40    filter = MembersFilter
41);
42
43/// constructs the request payload for the `/members` route
44#[derive(Debug, Clone)]
45pub enum Members {
46    /// target a specific member at `/members/{id}`
47    Identifier(String),
48    /// target all members that match the query at `/members?query...`
49    Query(MembersQuery),
50    /// target a `Work` for a specific funder at `/members/{id}/works?query..`
51    Works(WorksIdentQuery),
52}
53
54impl CrossrefRoute for Members {
55    fn route(&self) -> Result<String> {
56        match self {
57            Members::Identifier(s) => Ok(format!("{}/{}", Component::Members.route()?, s)),
58            // `route` already carries its own `?` and is empty for an empty query
59            Members::Query(query) => {
60                Ok(format!("{}{}", Component::Members.route()?, query.route()?))
61            }
62            Members::Works(combined) => Self::combined_route(combined),
63        }
64    }
65}
66
67impl CrossrefQuery for Members {
68    fn resource_component(self) -> ResourceComponent {
69        ResourceComponent::Members(self)
70    }
71}
72
73#[cfg(test)]
74mod tests {
75    use super::*;
76
77    #[test]
78    fn filters_share_one_comma_separated_parameter() {
79        let query = MembersQuery::empty()
80            .filter(MembersFilter::Prefix("10.1016".to_string()))
81            .filter(MembersFilter::CurrentDoiCount(1_000));
82
83        assert_eq!(
84            "/members?filter=prefix:10.1016,current-doi-count:1000",
85            &Members::Query(query).route().unwrap()
86        );
87    }
88}