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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
use std::any;
use std::error::Error;

use thiserror::Error;

use crate::api::paged::PaginationError;
use crate::auth::AuthError;

/// Errors which may occur when creating form data.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum BodyError {
    /// Body data could not be serialized from form parameters.
    #[error("failed to URL encode form parameters: {}", source)]
    UrlEncoded {
        /// The source of the error.
        #[from]
        source: serde_urlencoded::ser::Error,
    },
}

/// Errors which may occur when using API endpoints.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum ApiError<E>
where
    E: Error + Send + Sync + 'static,
{
    /// Missing authentication information.
    #[error("missing auth error: {}", source)]
    Auth {
        /// The auth error.
        source: AuthError,
    },
    /// Issues with setting pagination parameter.
    #[error("pagination error: {}", source)]
    Pagination {
        /// The pagination error.
        source: PaginationError,
    },
    /// The client encountered an error.
    #[error("client error: {}", source)]
    Client {
        /// The client error.
        source: E,
    },
    /// The URL failed to parse.
    #[error("failed to parse URL: {}", source)]
    UrlParse {
        /// The source of the error.
        #[from]
        source: url::ParseError,
    },
    /// Body data could not be created.
    #[error("failed to create request body: {}", source)]
    Body {
        /// The source of the error.
        #[from]
        source: BodyError,
    },
    /// JSON deserialization from Marketstack failed.
    #[error("could not parse JSON response: {}", source)]
    Json {
        /// The source of the error.
        #[from]
        source: serde_json::Error,
    },
    /// Marketstack returned an error message.
    #[error("marketstack server error: {}", msg)]
    Marketstack {
        /// The error message from Marketstack.
        msg: String,
    },
    /// Marketstack returned an error without JSON information.
    #[error("marketstack internal server error: {}", status)]
    MarketstackService {
        /// The status code for the return.
        status: http::StatusCode,
        /// The error data from Marketstack.
        data: Vec<u8>,
    },
    /// Marketstack returned an error object.
    #[error("marketstack server error: {:?}", obj)]
    MarketstackObject {
        /// The error object from Marketstack.
        obj: serde_json::Value,
    },
    /// Marketstack returned an HTTP error with JSON we did not recognize.
    #[error("marketstack server error: {:?}", obj)]
    MarketstackUnrecognized {
        /// The full object from Marketstack.
        obj: serde_json::Value,
    },
    /// Failed to parse an expected data type from JSON.
    #[error("could not parse {} data from JSON: {}", typename, source)]
    DataType {
        /// The source of the error.
        source: serde_json::Error,
        /// The name of the type that could not be deserialized.
        typename: &'static str,
    },
}

impl<E> ApiError<E>
where
    E: Error + Send + Sync + 'static,
{
    /// Create an API error in a client error.
    pub fn client(source: E) -> Self {
        ApiError::Client { source }
    }

    /// Wrap a client error in another wrapper.
    pub fn map_client<F, W>(self, f: F) -> ApiError<W>
    where
        F: FnOnce(E) -> W,
        W: Error + Send + Sync + 'static,
    {
        match self {
            Self::Auth { source } => ApiError::Auth { source },
            Self::Client { source } => ApiError::client(f(source)),
            Self::UrlParse { source } => ApiError::UrlParse { source },
            Self::Body { source } => ApiError::Body { source },
            Self::Json { source } => ApiError::Json { source },
            Self::Marketstack { msg } => ApiError::Marketstack { msg },
            Self::MarketstackService { status, data } => {
                ApiError::MarketstackService { status, data }
            }
            Self::MarketstackObject { obj } => ApiError::MarketstackObject { obj },
            Self::MarketstackUnrecognized { obj } => ApiError::MarketstackUnrecognized { obj },
            Self::DataType { source, typename } => ApiError::DataType { source, typename },
            Self::Pagination { source } => ApiError::Pagination { source },
        }
    }

    pub(crate) fn auth_error() -> Self {
        Self::Auth {
            source: AuthError::MissingAuth,
        }
    }

    pub(crate) fn server_error(status: http::StatusCode, body: &bytes::Bytes) -> Self {
        Self::MarketstackService {
            status,
            data: body.into_iter().copied().collect(),
        }
    }

    pub(crate) fn from_marketstack(value: serde_json::Value) -> Self {
        let error_value = value
            .pointer("/message")
            .or_else(|| value.pointer("/error"));

        if let Some(error_value) = error_value {
            if let Some(msg) = error_value.as_str() {
                ApiError::Marketstack { msg: msg.into() }
            } else {
                ApiError::MarketstackObject {
                    obj: error_value.clone(),
                }
            }
        } else {
            ApiError::MarketstackUnrecognized { obj: value }
        }
    }

    pub(crate) fn data_type<T>(source: serde_json::Error) -> Self {
        ApiError::DataType {
            source,
            typename: any::type_name::<T>(),
        }
    }
}

#[cfg(test)]
mod tests {
    use core::panic;

    use serde_json::json;
    use thiserror::Error;

    use crate::api::ApiError;

    #[derive(Debug, Error)]
    #[error("my error")]
    enum MyError {}

    #[test]
    fn marketstack_error_error() {
        let obj = json! {{
            "error": "error contents"
        }};

        let err: ApiError<MyError> = ApiError::from_marketstack(obj);
        if let ApiError::Marketstack { msg } = err {
            assert_eq!(msg, "error contents");
        } else {
            panic!("unexpected error: {}", err);
        }
    }

    #[test]
    fn marketstack_error_message_string() {
        let obj = json!({
            "message": "error contents"
        });

        let err: ApiError<MyError> = ApiError::from_marketstack(obj);
        if let ApiError::Marketstack { msg } = err {
            assert_eq!(msg, "error contents");
        } else {
            panic!("unexpected error: {}", err);
        }
    }

    #[test]
    fn marketstack_error_object() {
        let err_obj = json!({
            "blah": "foo",
        });
        let obj = json!({
            "message": err_obj
        });

        let err: ApiError<MyError> = ApiError::from_marketstack(obj);
        if let ApiError::MarketstackObject { obj } = err {
            assert_eq!(obj, err_obj);
        } else {
            panic!("unexpected error: {}", err);
        }
    }

    #[test]
    fn marketstack_error_message_unrecognized() {
        let err_obj = json!({
            "some_weird_key": "an even weirder value",
        });

        let err: ApiError<MyError> = ApiError::from_marketstack(err_obj.clone());
        if let ApiError::MarketstackUnrecognized { obj } = err {
            assert_eq!(obj, err_obj);
        } else {
            panic!("unexpected error: {}", err);
        }
    }
}