hey-sdk 0.31.0

Rust client for the HEY API, generated from a Smithy model of the 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
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

//! How a client derived for a linked account scopes what it sends and what it works out.

mod support;

use hey_sdk::ErrorCode;
use hey_sdk::services::BoxKind;
use serde_json::{Value, json};
use wiremock::matchers::{method, path, query_param, query_param_is_missing};
use wiremock::{Mock, MockServer, ResponseTemplate};

use support::client;

#[tokio::test]
async fn a_scoped_client_checks_the_account_and_filters_what_it_reads() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/identity.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(identity()))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .and(path("/boxes.json"))
        .and(query_param("filtered_account_id", "42"))
        .respond_with(
            ResponseTemplate::new(200)
                .set_body_json(json!([{ "id": 7, "kind": "imbox", "name": "Imbox" }])),
        )
        .mount(&server)
        .await;

    let scoped = client(&server).for_account(42).await.unwrap();
    let boxes = scoped.boxes().list().await.unwrap();

    assert_eq!(scoped.account_id(), Some(42));
    assert_eq!(boxes[0].name, "Imbox");
    let requests = server.received_requests().await.unwrap();
    assert_eq!(requests.len(), 2);
    assert_eq!(requests[0].url.path(), "/identity.json");
    assert_eq!(requests[1].url.path(), "/boxes.json");
    assert_eq!(requests[1].url.query(), Some("filtered_account_id=42"));
}

#[tokio::test]
async fn an_account_the_identity_cannot_reach_is_not_found() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/identity.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "id": 1,
            "accounts": [
                { "id": 42, "status": "active" },
                { "id": 7, "status": "inactive", "purpose": "personal" }
            ]
        })))
        .mount(&server)
        .await;

    let client = client(&server);
    let unknown = client.for_account(99).await.err().unwrap();
    let inactive = client.for_account(7).await.err().unwrap();

    assert_eq!(unknown.code(), ErrorCode::NotFound);
    assert_eq!(unknown.message(), "accessible account not found: 99");
    assert_eq!(inactive.code(), ErrorCode::NotFound);
    assert_eq!(inactive.http_status(), Some(404));
}

#[tokio::test]
async fn the_scoped_default_sender_comes_from_the_identity_already_read() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/identity.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(identity()))
        .mount(&server)
        .await;

    let scoped = client(&server).for_account(42).await.unwrap();

    assert_eq!(scoped.default_sender_id().await.unwrap(), 314);
    assert_eq!(scoped.default_sender_id().await.unwrap(), 314);
    assert_eq!(server.received_requests().await.unwrap().len(), 1);
}

#[tokio::test]
async fn the_identitys_own_default_sender_is_read_once_and_remembered() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/identity.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "id": 1,
            "senders": [{ "id": 1, "default": false }, { "id": 2, "default": true }]
        })))
        .mount(&server)
        .await;

    let client = client(&server);

    assert_eq!(client.default_sender_id().await.unwrap(), 2);
    assert_eq!(client.default_sender_id().await.unwrap(), 2);
    assert_eq!(server.received_requests().await.unwrap().len(), 1);
}

/// Box ids belong to the account they were read under, so a derived client works the index
/// out again rather than borrowing what the client it came from resolved.
#[tokio::test]
async fn a_derived_client_resolves_box_kinds_against_its_own_account() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/identity.json"))
        .respond_with(ResponseTemplate::new(200).set_body_json(identity()))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .and(path("/boxes.json"))
        .and(query_param("filtered_account_id", "42"))
        .respond_with(
            ResponseTemplate::new(200)
                .set_body_json(json!([{ "id": 7, "kind": "imbox", "name": "Imbox" }])),
        )
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .and(path("/boxes.json"))
        .and(query_param_is_missing("filtered_account_id"))
        .respond_with(
            ResponseTemplate::new(200)
                .set_body_json(json!([{ "id": 1, "kind": "imbox", "name": "Imbox" }])),
        )
        .mount(&server)
        .await;

    let all_accounts = client(&server);
    let scoped = all_accounts.for_account(42).await.unwrap();

    assert_eq!(
        all_accounts
            .boxes()
            .id_by_kind(BoxKind::Imbox)
            .await
            .unwrap(),
        1
    );
    assert_eq!(scoped.boxes().id_by_kind(BoxKind::Imbox).await.unwrap(), 7);
}

fn identity() -> Value {
    json!({
        "id": 1,
        "accounts": [{ "id": 42, "status": "active" }],
        "senders": [{ "id": 314, "account_id": 42, "default": true }]
    })
}