octocrate 0.1.4

A library of github API
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

use crate::{GithubMergePullRequestResponse, GithubPullRequest, GithubPullRequestFile};
use octocrate_api_builder::github_api;

// TODO
// check if the pull request is mergeable
// 1. 返回 404 代表没有合并，但现在 API client 代表出错
// 2. 要使用 response_text 代替 send 方法，API 设计不统一
github_api! {
  /// Github Pull Request API
  ///
  /// see https://docs.github.com/en/rest/reference/pulls
  GithubPullRequestAPI {
    get_pull_request {
      path "/repos/{}/{}/pulls/{}"
      params {
        owner String
        repo String
        pull_number u64
      }
      response GithubPullRequest
      test {
        params {
          envs.repo_owner
          envs.repo_name
          envs.issue_number.clone()
        }
        assert assert_eq!(res.number, envs.issue_number)
      }
    }

    list_pull_requests {
      path "/repos/{}/{}/pulls"
      params {
        owner String
        repo String
      }
      response Vec<GithubPullRequest>
      test {
        params {
          envs.repo_owner
          envs.repo_name
        }
        query {
          state "closed"
        }
        assert assert!(res.len() > 0)
      }
    }

    merge_pull_request {
      path "/repos/{}/{}/pulls/{}/merge"
      method PUT
      params {
        owner String
        repo String
        pull_number u64
      }
      response GithubMergePullRequestResponse
      test {
        ignore
        params {
          envs.repo_owner
          envs.repo_name
          envs.issue_number
        }
        assert assert_eq!(res.merged, true)
      }
    }

    list_pull_request_files {
      path "/repos/{}/{}/pulls/{}/files"
      params {
        owner String
        repo String
        pull_number u64
      }
      response Vec<GithubPullRequestFile>
      test {
        params {
          envs.repo_owner
          envs.repo_name
          envs.issue_number
        }
        assert assert!(res.len() > 0)
      }
    }

    /// check if the pull request is merged
    ///
    /// DON'T use `send` to send request
    ///
    /// Please use `respond_text` instead
    check_if_pull_request_is_merged {
      path "/repos/{}/{}/pulls/{}/merge"
      method GET
      params {
        owner String
        repo String
        pull_number u64
      }
      response ()
    }
  }
}

#[cfg(test)]
mod tests {
    use super::GithubPullRequestAPI;
    use crate::utils::test_utils;
    use octocrate_infra::GithubResult;
    use std::sync::Arc;

    #[tokio::test]
    async fn check_if_pull_request_is_merged() -> GithubResult<()> {
        let envs = test_utils::load_test_envs()?;
        let api_client = test_utils::create_api_client()?;

        let api = GithubPullRequestAPI::new(Arc::new(api_client));
        api.check_if_pull_request_is_merged(envs.repo_owner, envs.repo_name, envs.issue_number)
            .respond_text()
            .await?;

        Ok(())
    }
}