octocrab 0.48.1

A modern, extensible GitHub API client.
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

use crate::models::{AssignmentId, ClassroomId, OrgId, RepositoryId, UserId};
use chrono::DateTime;
use serde::{Deserialize, Serialize};
use url::Url;

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
/// A GitHub Classroom assignment
pub struct Assignment {
    pub id: AssignmentId,
    pub public_repo: bool,
    pub title: String,
    #[serde(rename = "type")]
    pub type_: AssignmentType,
    pub invite_link: String,
    pub invitations_enabled: bool,
    pub slug: String,
    pub students_are_repo_admins: bool,
    pub feedback_pull_requests_enabled: bool,
    pub max_teams: Option<u32>,
    pub max_members: Option<u32>,
    pub editor: String,
    pub accepted: u32,
    pub submitted: u32,
    pub passing: u32,
    pub language: String,
    pub deadline: Option<DateTime<chrono::Utc>>,
    pub starter_code_repository: SimpleCodeRepository,
    pub classroom: Classroom,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
#[serde(rename_all = "snake_case")]
pub enum AssignmentType {
    Individual,
    Group,
}

/// GitHub repository view for Classroom
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SimpleCodeRepository {
    pub id: RepositoryId,
    pub full_name: String,
    pub html_url: String,
    pub node_id: String,
    pub private: bool,
    pub default_branch: String,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct Classroom {
    pub id: ClassroomId,
    pub name: String,
    pub archived: bool,
    pub organization: Option<SimpleOrganization>,
    pub url: String,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SimpleOrganization {
    pub id: OrgId,
    pub login: String,
    pub node_id: String,
    pub html_url: String,
    pub name: String,
    pub avatar_url: String,
}

/// A GitHub Classroom Accepted assignment
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct AcceptedAssignment {
    pub id: AssignmentId,
    pub submitted: bool,
    pub passing: bool,
    pub commit_count: u32,
    pub grade: String,
    pub students: Vec<SimpleClassroomUser>,
    pub repository: SimpleCodeRepository,
    pub assignment: SimpleAssignment,
}

#[derive(Debug, Clone, Hash, Eq, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SimpleClassroomUser {
    pub id: UserId,
    pub login: String,
    pub avatar_url: Url,
    pub html_url: Url,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SimpleAssignment {
    pub id: AssignmentId,
    pub public_repo: bool,
    pub title: String,
    #[serde(rename = "type")]
    pub type_: AssignmentType,
    pub invite_link: String,
    pub invitations_enabled: bool,
    pub slug: String,
    pub students_are_repo_admins: bool,
    pub feedback_pull_requests_enabled: bool,
    pub max_teams: Option<u32>,
    pub max_members: Option<u32>,
    pub editor: String,
    pub accepted: u32,
    pub submitted: u32,
    pub passing: u32,
    pub language: String,
    pub deadline: Option<DateTime<chrono::Utc>>,
    pub classroom: SimpleClassroom,
}

/// A GitHub Classroom simple classroom
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct SimpleClassroom {
    pub id: ClassroomId,
    pub name: String,
    pub archived: bool,
    pub url: String,
}

/// Classroom Assignment Grade
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct AssignmentGrade {
    pub assignment_name: String,
    pub assignment_url: String,
    pub starter_code_url: String,
    pub github_username: String,
    pub roster_identifier: String,
    pub student_repository_name: String,
    pub student_repository_url: String,
    pub submission_timestamp: DateTime<chrono::Utc>,
    pub points_awarded: u32,
    pub points_available: u32,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub group_name: Option<String>,
}