github-bot-sdk 0.2.1

A comprehensive Rust SDK for GitHub App integration with authentication, webhooks, and 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

//! Tests for GitHub App metadata types.

use super::*;
use crate::auth::{User, UserType};

#[test]
fn test_app_construction() {
    let owner = User {
        id: crate::auth::UserId::new(1),
        login: "octocat".to_string(),
        user_type: UserType::User,
        avatar_url: Some("https://github.com/images/error/octocat_happy.gif".to_string()),
        html_url: "https://github.com/octocat".to_string(),
    };

    let app = App {
        id: 12345,
        slug: "my-app".to_string(),
        name: "My App".to_string(),
        owner: owner.clone(),
        description: Some("A test app".to_string()),
        external_url: "https://example.com".to_string(),
        html_url: "https://github.com/apps/my-app".to_string(),
        created_at: Utc::now(),
        updated_at: Utc::now(),
    };

    assert_eq!(app.id, 12345);
    assert_eq!(app.slug, "my-app");
    assert_eq!(app.name, "My App");
    assert_eq!(app.owner.login, "octocat");
    assert_eq!(app.description, Some("A test app".to_string()));
}

#[test]
fn test_app_serialization() {
    let owner = User {
        id: crate::auth::UserId::new(1),
        login: "octocat".to_string(),
        user_type: UserType::User,
        avatar_url: Some("https://github.com/images/error/octocat_happy.gif".to_string()),
        html_url: "https://github.com/octocat".to_string(),
    };

    let app = App {
        id: 12345,
        slug: "my-app".to_string(),
        name: "My App".to_string(),
        owner,
        description: Some("A test app".to_string()),
        external_url: "https://example.com".to_string(),
        html_url: "https://github.com/apps/my-app".to_string(),
        created_at: Utc::now(),
        updated_at: Utc::now(),
    };

    let json = serde_json::to_string(&app).unwrap();
    assert!(json.contains("\"id\":12345"));
    assert!(json.contains("\"slug\":\"my-app\""));
    assert!(json.contains("\"name\":\"My App\""));
}

#[test]
fn test_app_deserialization() {
    let json = r#"{
        "id": 12345,
        "slug": "my-app",
        "name": "My App",
        "owner": {
            "id": 1,
            "login": "octocat",
            "type": "User",
            "avatar_url": "https://github.com/images/error/octocat_happy.gif",
            "html_url": "https://github.com/octocat"
        },
        "description": "A test app",
        "external_url": "https://example.com",
        "html_url": "https://github.com/apps/my-app",
        "created_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-02T00:00:00Z"
    }"#;

    let app: App = serde_json::from_str(json).unwrap();

    assert_eq!(app.id, 12345);
    assert_eq!(app.slug, "my-app");
    assert_eq!(app.name, "My App");
    assert_eq!(app.owner.login, "octocat");
    assert_eq!(app.description, Some("A test app".to_string()));
    assert_eq!(app.external_url, "https://example.com");
}

#[test]
fn test_app_with_optional_description() {
    let json = r#"{
        "id": 12345,
        "slug": "my-app",
        "name": "My App",
        "owner": {
            "id": 1,
            "login": "octocat",
            "type": "User",
            "avatar_url": null,
            "html_url": "https://github.com/octocat"
        },
        "description": null,
        "external_url": "https://example.com",
        "html_url": "https://github.com/apps/my-app",
        "created_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-02T00:00:00Z"
    }"#;

    let app: App = serde_json::from_str(json).unwrap();

    assert_eq!(app.description, None);
}

#[test]
fn test_app_clone() {
    let owner = User {
        id: crate::auth::UserId::new(1),
        login: "octocat".to_string(),
        user_type: UserType::User,
        avatar_url: Some("https://github.com/images/error/octocat_happy.gif".to_string()),
        html_url: "https://github.com/octocat".to_string(),
    };

    let app = App {
        id: 12345,
        slug: "my-app".to_string(),
        name: "My App".to_string(),
        owner,
        description: Some("A test app".to_string()),
        external_url: "https://example.com".to_string(),
        html_url: "https://github.com/apps/my-app".to_string(),
        created_at: Utc::now(),
        updated_at: Utc::now(),
    };

    let cloned = app.clone();

    assert_eq!(app, cloned);
}