Update error message for HTTP 429.

Author: wenbinf

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "podcast-api"
-version = "1.1.0"
+version = "1.1.1"
 authors = ["Listen Notes, Inc. <hello@listennotes.com>"]
 edition = "2018"
 description = "Rust bindings for the Listen Notes Podcast API"

README.md

@@ -56,7 +56,7 @@ Install [podcast-api from crates.io](https://crates.io/crates/podcast-api). Add
 
 ```toml
 [dependencies]
-podcast-api = "1.1.0"
+podcast-api = "1.1.1"
 ```
 
 ## Usage
@@ -122,7 +122,7 @@ Unsuccessful requests return errors.
 | ------------- | ------------- |
 |  AuthenticationError | wrong api key or your account is suspended  |
 | InvalidRequestError  | something wrong on your end (client side errors), e.g., missing required parameters  |
-| RateLimitError  | you are using FREE plan and you exceed the quota limit  |
+| RateLimitError  | for FREE plan, exceeding the quota limit; or for all plans, sending too many requests too fast and exceeding the rate limit  |
 | NotFoundError  | endpoint not exist, or podcast / episode not exist  |
 | ApiConnectionError | failed to connect to Listen API servers | 
 | ListenApiError  | something wrong on our end (unexpected server errors)  |

examples/sample/Cargo.toml

@@ -7,7 +7,7 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-podcast-api = { version = "^1.1.0", path = "../../" }
+podcast-api = { version = "^1.1.1", path = "../../" }
 reqwest = { version = "0.11", features = ["json"] }
 serde = { version = "1", features = ["derive"] } 
 serde_json = "1"

src/client.rs

@@ -90,17 +90,17 @@ impl Client<'_> {
     /// Calls [`GET /spellcheck`](https://www.listennotes.com/api/docs/#get-api-v2-spellcheck) with supplied parameters.
     pub async fn spellcheck(&self, parameters: &Value) -> Result<Response> {
         self.get("spellcheck", parameters).await
-    }    
+    }
 
     /// Calls [`GET /related_searches`](https://www.listennotes.com/api/docs/#get-api-v2-related_searches) with supplied parameters.
     pub async fn fetch_related_searches(&self, parameters: &Value) -> Result<Response> {
         self.get("related_searches", parameters).await
-    } 
-    
+    }
+
     /// Calls [`GET /trending_searches`](https://www.listennotes.com/api/docs/#get-api-v2-trending_searches) with supplied parameters.
     pub async fn fetch_trending_searches(&self, parameters: &Value) -> Result<Response> {
         self.get("trending_searches", parameters).await
-    }     
+    }
 
     /// Calls [`GET /best_podcasts`](https://www.listennotes.com/api/docs/#get-api-v2-best_podcasts) with supplied parameters.
     pub async fn fetch_best_podcasts(&self, parameters: &Value) -> Result<Response> {

src/error.rs

@@ -7,7 +7,8 @@ pub enum Error {
     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.
+    /// For FREE plan, exceeding the quota limit; or for all plans, sending too many requests
+    /// too fast and exceeding the rate limit - https://www.listennotes.com/api/faq/#faq17
     RateLimitError,
     /// Endpoint not exist, or podcast / episode not exist.
     NotFoundError,
@@ -57,7 +58,12 @@ impl std::fmt::Display for Error {
                 )
             }
             Error::RateLimitError => {
-                write!(f, "You are using FREE plan and you exceed the quota limit.")
+                write!(
+                    f,
+                    "For FREE plan, exceeding the quota limit; or for all plans, sending too many 
+                    requests too fast and exceeding the rate limit 
+                    - https://www.listennotes.com/api/faq/#faq17"
+                )
             }
             Error::NotFoundError => {
                 write!(f, "Endpoint not exist, or podcast / episode not exist.")

tests/client_tests.rs

@@ -96,7 +96,7 @@ mod mock {
             assert!(body.is_object());
             assert!(body["tokens"].as_array().unwrap().len() > 0);
         });
-    }    
+    }
 
     #[test]
     fn related_searches() {
@@ -118,20 +118,16 @@ mod mock {
             assert!(body.is_object());
             assert!(body["terms"].as_array().unwrap().len() > 0);
         });
-    } 
+    }
 
     #[test]
     fn trending_searches() {
         b!(async {
-            let response = client()
-                .fetch_trending_searches(&json!({
-                }))
-                .await
-                .unwrap();
+            let response = client().fetch_trending_searches(&json!({})).await.unwrap();
             // Request
             assert_eq!(response.request.method(), http::Method::GET);
             assert_eq!(response.request.url().path(), "/api/v2/trending_searches");
-            let mut p = response.request.url().query_pairs();
+            let p = response.request.url().query_pairs();
             assert_eq!(p.count(), 0);
             // Response
             let body = response.json().await.unwrap();