autoschematic-connector-github 0.14.0

An Autoschematic connector for GitHub repository management
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
use std::collections::HashMap;

use async_trait::async_trait;
use octocrab::{Octocrab, Page, Result};
use serde::{Deserialize, Serialize};

use crate::resource::{CollaboratorPrincipal, Role};

// GitHub API response structures for branch protection
#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubBranchProtection {
    pub required_status_checks: Option<GitHubRequiredStatusChecks>,
    pub enforce_admins: GitHubEnforceAdmins,
    pub required_pull_request_reviews: Option<GitHubPullRequestReviewEnforcement>,
    pub restrictions: Option<GitHubBranchRestrictions>,
    pub required_linear_history: Option<GitHubBooleanSetting>,
    pub allow_force_pushes: Option<GitHubBooleanSetting>,
    pub allow_deletions: Option<GitHubBooleanSetting>,
    pub block_creations: Option<GitHubBooleanSetting>,
    pub required_conversation_resolution: Option<GitHubBooleanSetting>,
    pub lock_branch: Option<GitHubBooleanSetting>,
    pub allow_fork_syncing: Option<GitHubBooleanSetting>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubRequiredStatusChecks {
    pub strict: bool,
    pub contexts: Vec<String>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubEnforceAdmins {
    pub enabled: bool,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubPullRequestReviewEnforcement {
    pub required_approving_review_count: Option<u32>,
    pub dismiss_stale_reviews: Option<bool>,
    pub require_code_owner_reviews: Option<bool>,
    pub require_last_push_approval: Option<bool>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubBranchRestrictions {
    pub users: Vec<GitHubUser>,
    pub teams: Vec<GitHubTeam>,
    pub apps: Vec<GitHubApp>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubUser {
    pub login: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubTeam {
    pub name: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubApp {
    pub name: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubBooleanSetting {
    pub enabled: bool,
}

// Collaborator response structure
#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubCollaboratorPermissions {
    pub pull: bool,
    pub triage: bool,
    pub push: bool,
    pub maintain: bool,
    pub admin: bool,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubCollaborator {
    pub permissions: GitHubCollaboratorPermissions,
    pub role_name: String,
}

#[async_trait]
pub trait BranchProtectionExt {
    async fn get_branch_protection(&self, owner: &str, repo: &str, branch: &str) -> Result<GitHubBranchProtection>;
}

#[async_trait]
impl BranchProtectionExt for Octocrab {
    async fn get_branch_protection(&self, owner: &str, repo: &str, branch: &str) -> Result<GitHubBranchProtection> {
        let route = format!("/repos/{}/{}/branches/{}/protection", owner, repo, branch);
        self.get(route, None::<&()>).await
    }
}

#[async_trait]
pub trait CollaboratorExt {
    async fn get_collaborator_permission(&self, owner: &str, repo: &str, username: &str) -> Result<GitHubCollaborator>;
}

#[async_trait]
impl CollaboratorExt for Octocrab {
    async fn get_collaborator_permission(&self, owner: &str, repo: &str, username: &str) -> Result<GitHubCollaborator> {
        let route = format!("/repos/{}/{}/collaborators/{}/permission", owner, repo, username);
        self.get(route, None::<&()>).await
    }
}

// Additional structures for listing
#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubBranch {
    pub name: String,
    pub protected: bool,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct GitHubCollaboratorInfo {
    pub login: String,
    pub role_name: String,
}

#[async_trait]
pub trait ListExt {
    // async fn list_user_repos(&self, username: &str) -> Result<octocrab::Page<octocrab::models::Repository>>;
    async fn list_repo_branches(&self, owner: &str, repo: &str) -> Result<octocrab::Page<GitHubBranch>>;
    async fn list_repo_collaborators(
        &self,
        owner: &str,
        repo: &str,
        affiliation: Option<&str>,
    ) -> Result<HashMap<CollaboratorPrincipal, Role>>;
}

#[async_trait]
impl ListExt for Octocrab {
    // async fn list_user_repos(&self, username: &str) -> Result<octocrab::Page<octocrab::models::Repository>> {
    //     let route = format!("/users/{}/repos", username);
    //     self.get(route, None::<&()>).await
    // }

    async fn list_repo_branches(&self, owner: &str, repo: &str) -> Result<octocrab::Page<GitHubBranch>> {
        let route = format!("/repos/{}/{}/branches", owner, repo);
        self.get(route, None::<&()>).await
    }

    async fn list_repo_collaborators(
        &self,
        owner: &str,
        repo: &str,
        affiliation: Option<&str>,
    ) -> Result<HashMap<CollaboratorPrincipal, Role>> {
        let mut res = HashMap::new();

        #[derive(serde::Serialize)]
        struct CollabQuery<'a> {
            affiliation: &'a str, // "direct" | "outside" | "all"
            per_page: u8,
            page: u32,
        }

        let route = format!("/repos/{}/{}/collaborators", owner, repo);
        let users: Page<GitHubCollaboratorInfo> = self
            .get(
                route,
                affiliation
                    .map(|affiliation| CollabQuery {
                        affiliation: affiliation,
                        per_page: 100,
                        page: 1,
                    })
                    .as_ref(),
            )
            .await?;

        let users = self.all_pages(users).await?;

        for user in users {
            res.insert(CollaboratorPrincipal::User(user.login), Role::from_str(&user.role_name));
        }

        Ok(res)
    }

    // async fn list_repo_collaborators(
    //     &self,
    //     owner: &str,
    //     repo: &str,
    //     affiliation: Option<&str>,
    // ) -> Result<octocrab::Page<GitHubCollaboratorInfo>> {
    //     #[derive(serde::Serialize)]
    //     struct CollabQuery<'a> {
    //         affiliation: &'a str, // "direct" | "outside" | "all"
    //         per_page: u8,
    //         page: u32,
    //     }

    //     let route = format!("/repos/{}/{}/collaborators", owner, repo);
    //     self.get(
    //         route,
    //         affiliation
    //             .map(|affiliation| CollabQuery {
    //                 affiliation: affiliation,
    //                 per_page: 100,
    //                 page: 1,
    //             })
    //             .as_ref(),
    //     )
    //     .await
    // }
}

// Structures for repository operations
#[derive(Debug, Serialize, Deserialize)]
pub struct CreateRepositoryRequest {
    pub name: String,
    pub description: Option<String>,
    pub homepage: Option<String>,
    pub private: bool,
    pub has_issues: bool,
    pub has_projects: bool,
    pub has_wiki: bool,
    pub allow_squash_merge: bool,
    pub allow_merge_commit: bool,
    pub allow_rebase_merge: bool,
    pub allow_auto_merge: bool,
    pub delete_branch_on_merge: bool,
    pub default_branch: Option<String>,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct UpdateRepositoryRequest {
    pub name: Option<String>,
    pub description: Option<String>,
    pub homepage: Option<String>,
    pub private: Option<bool>,
    pub has_issues: Option<bool>,
    pub has_projects: Option<bool>,
    pub has_wiki: Option<bool>,
    pub allow_squash_merge: Option<bool>,
    pub allow_merge_commit: Option<bool>,
    pub allow_rebase_merge: Option<bool>,
    pub allow_auto_merge: Option<bool>,
    pub delete_branch_on_merge: Option<bool>,
    pub default_branch: Option<String>,
    pub archived: Option<bool>,
}

// Structures for branch protection operations
#[derive(Debug, Serialize, Deserialize)]
pub struct CreateBranchProtectionRequest {
    pub required_status_checks: Option<GitHubRequiredStatusChecks>,
    pub enforce_admins: bool,
    pub required_pull_request_reviews: Option<GitHubPullRequestReviewEnforcement>,
    pub restrictions: Option<GitHubBranchRestrictions>,
    pub required_linear_history: Option<bool>,
    pub allow_force_pushes: Option<bool>,
    pub allow_deletions: Option<bool>,
    pub block_creations: Option<bool>,
    pub required_conversation_resolution: Option<bool>,
    pub lock_branch: Option<bool>,
    pub allow_fork_syncing: Option<bool>,
}

// Structures for collaborator operations
#[derive(Debug, Serialize, Deserialize)]
pub struct AddCollaboratorRequest {
    pub permission: String, // "pull", "triage", "push", "maintain", "admin"
}

#[derive(Debug, Serialize, Deserialize)]
pub struct AddTeamCollaboratorRequest {
    pub permission: String, // "pull", "triage", "push", "maintain", "admin"
}

#[async_trait]
pub trait RepositoryOpsExt {
    async fn create_repository(&self, owner: &str, repo_data: &CreateRepositoryRequest)
    -> Result<octocrab::models::Repository>;
    async fn update_repository(
        &self,
        owner: &str,
        repo: &str,
        repo_data: &UpdateRepositoryRequest,
    ) -> Result<octocrab::models::Repository>;
    async fn delete_repository(&self, owner: &str, repo: &str) -> Result<()>;
}

#[async_trait]
impl RepositoryOpsExt for Octocrab {
    async fn create_repository(
        &self,
        _owner: &str,
        repo_data: &CreateRepositoryRequest,
    ) -> Result<octocrab::models::Repository> {
        let route = format!("/user/repos");
        self.post(route, Some(repo_data)).await
    }

    async fn update_repository(
        &self,
        owner: &str,
        repo: &str,
        repo_data: &UpdateRepositoryRequest,
    ) -> Result<octocrab::models::Repository> {
        let route = format!("/repos/{}/{}", owner, repo);
        self.patch(route, Some(repo_data)).await
    }

    async fn delete_repository(&self, owner: &str, repo: &str) -> Result<()> {
        let route = format!("/repos/{}/{}", owner, repo);
        self.delete(route, None::<&()>).await
    }
}

#[async_trait]
pub trait BranchProtectionOpsExt {
    async fn create_branch_protection(
        &self,
        owner: &str,
        repo: &str,
        branch: &str,
        protection_data: &CreateBranchProtectionRequest,
    ) -> Result<GitHubBranchProtection>;
    async fn update_branch_protection(
        &self,
        owner: &str,
        repo: &str,
        branch: &str,
        protection_data: &CreateBranchProtectionRequest,
    ) -> Result<GitHubBranchProtection>;
    async fn delete_branch_protection(&self, owner: &str, repo: &str, branch: &str) -> Result<()>;
}

#[async_trait]
impl BranchProtectionOpsExt for Octocrab {
    async fn create_branch_protection(
        &self,
        owner: &str,
        repo: &str,
        branch: &str,
        protection_data: &CreateBranchProtectionRequest,
    ) -> Result<GitHubBranchProtection> {
        let route = format!("/repos/{}/{}/branches/{}/protection", owner, repo, branch);
        self.put(route, Some(protection_data)).await
    }

    async fn update_branch_protection(
        &self,
        owner: &str,
        repo: &str,
        branch: &str,
        protection_data: &CreateBranchProtectionRequest,
    ) -> Result<GitHubBranchProtection> {
        let route = format!("/repos/{}/{}/branches/{}/protection", owner, repo, branch);
        self.put(route, Some(protection_data)).await
    }

    async fn delete_branch_protection(&self, owner: &str, repo: &str, branch: &str) -> Result<()> {
        let route = format!("/repos/{}/{}/branches/{}/protection", owner, repo, branch);
        self.delete(route, None::<&()>).await
    }
}

#[async_trait]
pub trait CollaboratorOpsExt {
    async fn add_collaborator(
        &self,
        owner: &str,
        repo: &str,
        username: &str,
        permission_data: &AddCollaboratorRequest,
    ) -> Result<()>;
    async fn update_collaborator_permission(
        &self,
        owner: &str,
        repo: &str,
        username: &str,
        permission_data: &AddCollaboratorRequest,
    ) -> Result<()>;
    async fn remove_collaborator(&self, owner: &str, repo: &str, username: &str) -> Result<()>;
    async fn add_team_to_repository(
        &self,
        owner: &str,
        repo: &str,
        team_slug: &str,
        permission_data: &AddTeamCollaboratorRequest,
    ) -> Result<()>;
    async fn update_team_permission(
        &self,
        owner: &str,
        repo: &str,
        team_slug: &str,
        permission_data: &AddTeamCollaboratorRequest,
    ) -> Result<()>;
    async fn remove_team_from_repository(&self, owner: &str, repo: &str, team_slug: &str) -> Result<()>;
}

#[async_trait]
impl CollaboratorOpsExt for Octocrab {
    async fn add_collaborator(
        &self,
        owner: &str,
        repo: &str,
        username: &str,
        permission_data: &AddCollaboratorRequest,
    ) -> Result<()> {
        let route = format!("/repos/{}/{}/collaborators/{}", owner, repo, username);
        self.put(route, Some(permission_data)).await
    }

    async fn update_collaborator_permission(
        &self,
        owner: &str,
        repo: &str,
        username: &str,
        permission_data: &AddCollaboratorRequest,
    ) -> Result<()> {
        let route = format!("/repos/{}/{}/collaborators/{}", owner, repo, username);
        self.put(route, Some(permission_data)).await
    }

    async fn remove_collaborator(&self, owner: &str, repo: &str, username: &str) -> Result<()> {
        let route = format!("/repos/{}/{}/collaborators/{}", owner, repo, username);
        self.delete(route, None::<&()>).await
    }

    async fn add_team_to_repository(
        &self,
        owner: &str,
        repo: &str,
        team_slug: &str,
        permission_data: &AddTeamCollaboratorRequest,
    ) -> Result<()> {
        let route = format!("/orgs/{}/teams/{}/repos/{}/{}", owner, team_slug, owner, repo);
        self.put(route, Some(permission_data)).await
    }

    async fn update_team_permission(
        &self,
        owner: &str,
        repo: &str,
        team_slug: &str,
        permission_data: &AddTeamCollaboratorRequest,
    ) -> Result<()> {
        let route = format!("/orgs/{}/teams/{}/repos/{}/{}", owner, team_slug, owner, repo);
        self.put(route, Some(permission_data)).await
    }

    async fn remove_team_from_repository(&self, owner: &str, repo: &str, team_slug: &str) -> Result<()> {
        let route = format!("/orgs/{}/teams/{}/repos/{}/{}", owner, team_slug, owner, repo);
        self.delete(route, None::<&()>).await
    }
}