wicrs_common 0.2.1

Code shared by the wicrs projects.
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

use std::str::FromStr;

use crate::ID;
use serde::{Deserialize, Serialize};

/// Always sent in requests that require authentication, sent as URL query (`?user={User ID}&token={Auth Token}`)
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct UserToken {
    pub user: String,
    pub token: String,
}

/// Data required for /api/v1/user/addaccount
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct CreateAccountQuery {
    pub name: String,
    pub is_bot: bool,
}

/// Data required for /api/v1/hubs/create
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct HubCreateQuery {
    pub account: ID,
    pub name: String,
}

/// Data required for /api/v1/hubs/create_channel
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct ChannelCreateQuery {
    pub account: ID,
    pub hub: ID,
    pub name: String,
}

/// Data required for /api/v1/hubs/rename_channel
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct ChannelRenameQuery {
    pub account: ID,
    pub hub: ID,
    pub channel: ID,
    pub new_name: String
}

/// Data required for /api/v1/hubs/delete_channel
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct ChannelDeleteQuery {
    pub account: ID,
    pub hub: ID,
    pub channel: ID,
}

/// Data required for /api/v1/hubs/send_message
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct MessageSendQuery {
    pub account: ID,
    pub  hub: ID,
    pub channel: ID,
    pub message: String,
}

/// Data required for /api/v1/hubs/channels
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct ChannelsQuery {
    pub account: ID,
    pub hub: ID,
}

/// Data required for /api/v1/hubs/messages
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct LastMessagesQuery {
    pub account: ID,
    pub hub: ID,
    pub channel: ID,
    pub count: u128,
}

/// Data required for /api/v1/auth/{Service}
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct AuthQuery {
    pub state: String,
    pub code: String,
    pub expires: Option<u128>,
}

/// Response for /api/v1/auth/{Service}
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct AccountTokenResponse {
    pub id: String,
    pub token: String,
}

/// Sent as part of the URL path when authenticating e.g. /api/v1/login/{Service}
pub enum Service {
    GitHub,
}

impl FromStr for Service {
    type Err = ();

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s.to_ascii_lowercase().as_str() {
            "github" => Ok(Self::GitHub),
            _ => Err(()),
        }
    }
}

impl ToString for Service {
    fn to_string(&self) -> String {
        match self {
            &Service::GitHub => "github".to_string(),
        }
    }
}