shopify-client 1.5.4

Type-safe, async Rust client for the Shopify Admin and Storefront APIs
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

use std::fmt;

pub const GID_PREFIX: &str = "gid://shopify/";

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Gid<'a> {
    kind: &'a str,
    id: &'a str,
}

impl<'a> Gid<'a> {
    pub const ORDER: &'static str = "Order";

    pub fn of(kind: &'a str, id: &'a str) -> Self {
        Self {
            kind,
            id: Self::id_of(id),
        }
    }

    pub fn id_of(value: &str) -> &str {
        match value.strip_prefix(GID_PREFIX) {
            Some(rest) => rest
                .split('?')
                .next()
                .unwrap_or(rest)
                .rsplit('/')
                .next()
                .unwrap_or(rest),
            None => value,
        }
    }

    pub fn kind(&self) -> &'a str {
        self.kind
    }

    pub fn id(&self) -> &'a str {
        self.id
    }
}

impl fmt::Display for Gid<'_> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{GID_PREFIX}{}/{}", self.kind, self.id)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn renders_a_gid_from_a_bare_id() {
        assert_eq!(
            Gid::of(Gid::ORDER, "1001").to_string(),
            "gid://shopify/Order/1001"
        );
    }

    #[test]
    fn building_from_a_gid_is_idempotent() {
        let once = Gid::of(Gid::ORDER, "1001").to_string();
        assert_eq!(Gid::of(Gid::ORDER, &once).to_string(), once);
    }

    #[test]
    fn id_of_strips_the_prefix_and_the_type() {
        assert_eq!(Gid::id_of("gid://shopify/Order/1001"), "1001");
        assert_eq!(Gid::id_of("gid://shopify/ProductVariant/11"), "11");
    }

    #[test]
    fn id_of_drops_query_parameters() {
        assert_eq!(
            Gid::id_of("gid://shopify/Order/1001?namespace=custom"),
            "1001"
        );
    }

    #[test]
    fn id_of_leaves_a_value_that_is_not_a_gid_alone() {
        assert_eq!(Gid::id_of("1001"), "1001");
        assert_eq!(Gid::id_of(""), "");
        assert_eq!(Gid::id_of("shopify/Order/1001"), "shopify/Order/1001");
    }

    #[test]
    fn parts_are_readable_back() {
        let gid = Gid::of(Gid::ORDER, "gid://shopify/Order/1001");
        assert_eq!(gid.kind(), "Order");
        assert_eq!(gid.id(), "1001");
    }
}