Add custom errors to match other language libraries

Author: cameronfyfe

examples/sample/src/main.rs

@@ -20,14 +20,14 @@ async fn main() {
             println!("Successfully called \"typeahead\" endpoint.");
             if let Ok(body) = response.json().await {
                 println!("Response Body:");
-                println!("{:?}", body);
+                println!("{}", body);
             } else {
                 println!("Response body JSON data parsing error.")
             }
         }
         Err(err) => {
             println!("Error calling \"typeahead\" endpoint:");
-            println!("{:?},", err);
+            println!("{},", err);
         }
     };
 }

src/client.rs

@@ -1,4 +1,5 @@
-use super::{Api, Result};
+use super::{Api, Error, Result};
+use http::StatusCode;
 use reqwest::RequestBuilder;
 use serde_json::Value;
 use std::time::Duration;
@@ -143,8 +144,26 @@ impl Client<'_> {
         .header("User-Agent", self.user_agent)
         .build()?;
 
+        let response = self.client.execute(request.try_clone().expect("Error can remain unhandled because we're not using streams, which are the try_clone fail condition")).await;
+
+        match &response {
+            Ok(response) => match response.status() {
+                StatusCode::NOT_FOUND => return Err(Error::NotFoundError),
+                StatusCode::UNAUTHORIZED => return Err(Error::AuthenticationError),
+                StatusCode::TOO_MANY_REQUESTS => return Err(Error::RateLimitError),
+                StatusCode::BAD_REQUEST => return Err(Error::InvalidRequestError),
+                StatusCode::INTERNAL_SERVER_ERROR => return Err(Error::ListenApiError),
+                _ => {}
+            },
+            Err(err) => {
+                if err.is_connect() || err.is_timeout() {
+                    return Err(Error::ApiConnectionError);
+                }
+            }
+        };
+
         Ok(Response {
-            response: self.client.execute(request.try_clone().expect("Error can remain unhandled because we're not using streams, which are the try_clone fail condition")).await?,
+            response: response?,
             request,
         })
     }

src/error.rs

@@ -1,6 +1,18 @@
 /// Error for API calls from [`Client`](super::Client).
 #[derive(Debug)]
 pub enum Error {
+    /// Wrong api key or your account is suspended.
+    AuthenticationError,
+    /// Fail to connect to API servers.
+    ApiConnectionError,
+    /// Something wrong on your end (client side errors), e.g., missing required parameters.
+    InvalidRequestError,
+    /// You are using FREE plan and you exceed the quota limit.
+    RateLimitError,
+    /// Endpoint not exist, or podcast / episode not exist.
+    NotFoundError,
+    /// Something wrong on our end (unexpected server errors).
+    ListenApiError,
     /// Error from http client.
     Reqwest(reqwest::Error),
     /// Error from JSON creation/processing.
@@ -24,12 +36,21 @@ impl std::error::Error for Error {
         match *self {
             Error::Reqwest(ref e) => Some(e),
             Error::Json(ref e) => Some(e),
+            _ => None,
         }
     }
 }
 
 impl std::fmt::Display for Error {
     fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
-        write!(f, "{}", *self)
+        match self {
+            Error::AuthenticationError =>   write!(f, "Wrong api key or your account is suspended."),
+            Error::ApiConnectionError =>    write!(f, "Fail to connect to API servers."),
+            Error::InvalidRequestError =>   write!(f, "Something wrong on your end (client side errors), e.g., missing required parameters."),
+            Error::RateLimitError =>        write!(f, "You are using FREE plan and you exceed the quota limit."),
+            Error::NotFoundError =>         write!(f, "Endpoint not exist, or podcast / episode not exist."),
+            Error::ListenApiError =>        write!(f, "Something wrong on our end (unexpected server errors)."),
+            Error::Reqwest(_) | Error::Json(_) => write!(f, "{}", self)
+        }
     }
 }

tests/client_tests.rs

@@ -47,9 +47,11 @@ mod mock {
                     "q": "dummy",
                     "sort_by_date": 1
                 }))
-                .await
-                .unwrap();
-            assert_eq!(response.response.status(), http::StatusCode::UNAUTHORIZED);
+                .await;
+            assert!(match response {
+                Err(podcast_api::Error::AuthenticationError) => true,
+                _ => false,
+            });
         });
     }