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

mod mock_error;

use wiremock::{
    matchers::{method, path},
    Mock, MockServer, ResponseTemplate,
};

use mock_error::setup_error_handler;
use octocrab::models::ClassroomId;
use octocrab::{models, Octocrab};

async fn setup_mock_http_server(
    http_method: &str,
    mocked_path: &str,
    template: ResponseTemplate,
) -> MockServer {
    let mock_server = MockServer::start().await;

    Mock::given(method(http_method))
        .and(path(mocked_path))
        .respond_with(template.clone())
        .mount(&mock_server)
        .await;
    setup_error_handler(
        &mock_server,
        &format!("http method {http_method} on {mocked_path} was not received"),
    )
    .await;
    mock_server
}

fn setup_octocrab(uri: &str) -> Octocrab {
    Octocrab::builder().base_uri(uri).unwrap().build().unwrap()
}

#[tokio::test]
async fn should_respond_to_list_classrooms() {
    let mocked_response: Vec<models::classroom::Classroom> =
        serde_json::from_str(include_str!("resources/classroom_list_classrooms.json")).unwrap();
    let template = ResponseTemplate::new(200).set_body_json(&mocked_response);
    let mock_server = setup_mock_http_server("GET", "/classrooms", template).await;
    let client = setup_octocrab(&mock_server.uri());
    let result = client.classrooms().list_classrooms().await;
    assert!(
        result.is_ok(),
        "expected successful result, got error: {:#?}",
        result
    );
    let response = result.unwrap();
    assert_eq!(response.len(), 1);
    assert_eq!(response[0].name, "Programming Elixir");
    assert_eq!(response[0].archived, false);
    assert_eq!(
        response[0].url,
        "https://classroom.github.com/classrooms/1-programming-elixir"
    );
}

#[tokio::test]
async fn should_respond_to_get_classroom() {
    let classroom_id: ClassroomId = 1296269.into();
    let mocked_response: models::classroom::Classroom =
        serde_json::from_str(include_str!("resources/classroom_get_classroom.json")).unwrap();
    let template = ResponseTemplate::new(200).set_body_json(&mocked_response);
    let mock_server = setup_mock_http_server(
        "GET",
        format!("/classrooms/{classroom_id}").as_str(),
        template,
    )
    .await;
    let client = setup_octocrab(&mock_server.uri());
    let result = client.classrooms().get_classroom(classroom_id.into()).await;
    assert!(
        result.is_ok(),
        "expected successful result, got error: {:#?}",
        result
    );
    let response = result.unwrap();
    assert_eq!(response.name, "Programming Elixir");
    assert_eq!(response.archived, false);
    assert_eq!(
        response.url,
        "https://classroom.github.com/classrooms/1-programming-elixir"
    );
}

#[tokio::test]
async fn should_respond_to_list_assignments() {
    let classroom_id: ClassroomId = 1296269.into();
    let mocked_response: Vec<models::classroom::SimpleAssignment> =
        serde_json::from_str(include_str!("resources/classroom_list_assignments.json")).unwrap();
    let template = ResponseTemplate::new(200).set_body_json(&mocked_response);
    let mock_server = setup_mock_http_server(
        "GET",
        format!("/classrooms/{classroom_id}/assignments").as_str(),
        template,
    )
    .await;
    let client = setup_octocrab(&mock_server.uri());
    let result = client
        .classrooms()
        .list_assignments(classroom_id.into())
        .await;
    assert!(
        result.is_ok(),
        "expected successful result, got error: {:#?}",
        result
    );
    let response = result.unwrap();
    assert_eq!(response.len(), 1);
    assert_eq!(response[0].title, "Intro to Binaries");
    assert_eq!(response[0].public_repo, false);
    assert_eq!(response[0].language, "ruby");
}