gr/github/
gist.rs

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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
use crate::{
    api_traits::{ApiOperation, CodeGist, NumberDeltaErr},
    cmds::gist::{Gist, GistListBodyArgs},
    io::{HttpResponse, HttpRunner},
    remote::{query, URLQueryParamBuilder},
    Result,
};

use super::Github;

// https://docs.github.com/en/rest/gists/gists?apiVersion=2022-11-28

impl<R: HttpRunner<Response = HttpResponse>> CodeGist for Github<R> {
    fn list(&self, args: GistListBodyArgs) -> crate::Result<Vec<Gist>> {
        let url = self.auth_user_gist_url(false);
        query::paged(
            &self.runner,
            &url,
            args.body_args,
            self.request_headers(),
            None,
            ApiOperation::Gist,
            |value| GithubGistFields::from(value).into(),
        )
    }

    fn num_pages(&self) -> Result<Option<u32>> {
        let url = self.auth_user_gist_url(true);
        query::num_pages(
            &self.runner,
            &url,
            self.request_headers(),
            ApiOperation::Gist,
        )
    }

    fn num_resources(&self) -> Result<Option<NumberDeltaErr>> {
        let url = self.auth_user_gist_url(true);
        query::num_resources(
            &self.runner,
            &url,
            self.request_headers(),
            ApiOperation::Gist,
        )
    }
}

impl<R> Github<R> {
    fn auth_user_gist_url(&self, first_page: bool) -> String {
        let url = format!("{}/gists", self.rest_api_basepath);
        let mut url_query_param = URLQueryParamBuilder::new(&url);
        if first_page {
            url_query_param.add_param("page", "1");
        }
        url_query_param.build()
    }
}

pub struct GithubGistFields {
    pub gist: Gist,
}

impl From<&serde_json::Value> for GithubGistFields {
    fn from(value: &serde_json::Value) -> Self {
        let gist = Gist::builder()
            .url(value["html_url"].as_str().unwrap().to_string())
            .description(value["description"].as_str().unwrap().to_string())
            .files(
                value["files"]
                    .as_object()
                    .unwrap_or(&serde_json::Map::new())
                    .keys()
                    .map(|k| k.to_string())
                    .collect::<Vec<String>>()
                    .join(","),
            )
            .created_at(value["created_at"].as_str().unwrap_or("").to_string())
            .build()
            .unwrap();
        Self { gist }
    }
}

impl From<GithubGistFields> for Gist {
    fn from(fields: GithubGistFields) -> Self {
        fields.gist
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        setup_client,
        test::utils::{default_github, ContractType, ResponseContracts},
    };

    use super::*;

    #[test]
    fn test_github_list_user_gists() {
        let contracts = ResponseContracts::new(ContractType::Github).add_contract(
            200,
            "list_user_gist.json",
            None,
        );
        let args = GistListBodyArgs::builder().body_args(None).build().unwrap();
        let (client, github) = setup_client!(contracts, default_github(), dyn CodeGist);
        let gists = github.list(args).unwrap();
        assert_eq!("https://api.github.com/gists", *client.url());
        assert_eq!(1, gists.len());
        assert_eq!(Some(ApiOperation::Gist), *client.api_operation.borrow());
    }

    #[test]
    fn test_github_num_pages() {
        let contracts = ResponseContracts::new(ContractType::Github).add_contract(
            200,
            "list_user_gist.json",
            None,
        );
        let (client, github) = setup_client!(contracts, default_github(), dyn CodeGist);
        let num_pages = github.num_pages().unwrap();
        assert_eq!("https://api.github.com/gists?page=1", *client.url());
        assert_eq!(1, num_pages.unwrap());
        assert_eq!(Some(ApiOperation::Gist), *client.api_operation.borrow());
    }

    #[test]
    fn test_github_num_resources() {
        let contracts = ResponseContracts::new(ContractType::Github).add_contract(
            200,
            "list_user_gist.json",
            None,
        );
        let (client, github) = setup_client!(contracts, default_github(), dyn CodeGist);
        github.num_resources().unwrap();
        assert_eq!("https://api.github.com/gists?page=1", *client.url());
        assert_eq!(Some(ApiOperation::Gist), *client.api_operation.borrow());
    }
}