authy 0.9.8

Bindings for the Authy two factor web service.
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

use std::thread;
use std::io::Read;
use std::time::Duration;

use reqwest::{self, StatusCode, Method, Url};
use serde_json::{self, Value};

use error::AuthyError;

/// The Authy REST client.
///
/// This allows the rest of this library to interact with the Authy API service.
#[derive(Debug)]
pub struct Client {
    /// Configure the client to retry the request `retry_count` number of times
    /// when the service is unavailable.
    pub retry_count: u8,

    /// Duration of time to wait between retry attempts.
    pub retry_wait: u16,

    api_url: String,
    api_key: String,
    reqwest: reqwest::Client,
}

/// Status message returned by every API request.
#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub struct Status {
    pub success: bool,
    pub message: String,

    pub error_code: Option<String>,
}

impl Client {
    /// Create a new client to the Authy service.
    pub fn new(api_url: &str, api_key: &str) -> Client {
        Client {
            retry_count: 3,
            retry_wait: 250,
            api_url: api_url.into(), 
            api_key: api_key.into(),
            reqwest: reqwest::Client::new(),
        }
    }

    /// Send a `get` request to the Authy service. This is intended to be used
    /// by the library and not the user.
    pub fn get(&self, prefix: &str, path: &str, url_params: Option<Vec<(String, String)>>) -> Result<(Status, Value), AuthyError> {
        self.request(Method::GET, self.url(prefix, path, url_params), None)
    }

    /// Send a `post` request to the Authy service. This is intended to be used
    /// by the library and not the user.
    pub fn post(&self, prefix: &str, path: &str, url_params: Option<Vec<(String, String)>>, post_params: Option<Vec<(String, String)>>) -> Result<(Status, Value), AuthyError> {
        self.request(Method::POST, self.url(prefix, path, url_params), post_params)
    }

    fn url(&self, prefix: &str, path: &str, params: Option<Vec<(String, String)>>) -> Url {
        let base = format!("{api_url}/{prefix}/json/{path}", 
                           api_url = self.api_url,
                           prefix = prefix,
                           path = path);
        match params {
            Some(params) => Url::parse_with_params(&base, params),
            None => Url::parse(&base),
        }.expect("Url to be valid")
    }

    fn request(&self, method: Method, url: Url, params: Option<Vec<(String, String)>>) -> Result<(Status, Value), AuthyError> {
        let mut count = self.retry_count;
        loop {
            let url = url.clone();
            let mut res = match params.clone() {
                Some(p) => self.reqwest.request(method.clone(), url).header("X-Authy-API-Key", self.api_key.clone()).form(&p).send()?,
                None => self.reqwest.request(method.clone(), url).header("X-Authy-API-Key", self.api_key.clone()).send()?,
            };

            let mut body = String::new();
            res.read_to_string(&mut body)?;

            // I wish could just check the content type but authy mixes json
            // and html content types when returning valid json.
            match serde_json::from_str::<Value>(&body) {
                Ok(mut value) => {
                    // It seems that for whatever reason at least one call is returning
                    // a *string* of a bool rather than a bool for success.
                    value["success"] = match value.clone()["success"] {
                        Value::Bool(v) => Value::Bool(v),
                        Value::String(ref v) => match v.as_ref() {
                            "true" => Value::Bool(true),
                            _ => Value::Bool(false),
                        },
                        _ => Value::Bool(false),
                    };

                    let status: Status = serde_json::from_value(value.clone())?;

                    match res.status() {
                        StatusCode::OK => return Ok((status, value)),
                        StatusCode::BAD_REQUEST => return Err(AuthyError::BadRequest(status)),
                        StatusCode::UNAUTHORIZED => return Err(AuthyError::UnauthorizedKey(status)),
                        StatusCode::FORBIDDEN => return Err(AuthyError::Forbidden(status)),
                        StatusCode::TOO_MANY_REQUESTS => return Err(AuthyError::TooManyRequests(status)),
                        StatusCode::NOT_FOUND => return Err(AuthyError::UserNotFound(status)),
                        StatusCode::INTERNAL_SERVER_ERROR => return Err(AuthyError::InternalServerError(status)),
                        s => return Err(AuthyError::UnknownServerResponse(format!("Status code not covered in authy REST specification: {}", s))),
                    };
                },
                Err(_) => {
                    match res.status() {
                        StatusCode::SERVICE_UNAVAILABLE => {
                            count -= 1;
                            if count == 0 {
                                return Err(AuthyError::ServiceUnavailable);
                            }
                            else {
                                thread::sleep(Duration::from_millis(self.retry_wait.into()));
                                continue;
                            }
                        },
                        _ => return Err(AuthyError::InvalidServerResponse),
                    }
                },
            };
        }
    }
}