Merge pull request #5 from ListenNotes/cameron-develop

Cameron develop

Author: wenbinf

Cargo.toml

@@ -3,6 +3,12 @@ name = "podcast-api"
 version = "0.1.0"
 authors = ["Cameron Fyfe <cameron.j.fyfe@gmail.com>"]
 edition = "2018"
+description = "Rust bindings for the Listen Notes Podcast API"
+license = "MIT"
+keywords = ["listennotes", "podcast"]
+documentation = "https://docs.rs/podcast-api"
+repository = "https://github.com/ListenNotes/podcast-api-rust"
+readme = "README.md"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

src/client.rs

@@ -112,36 +112,66 @@ impl Client<'_> {
         self.post("episodes", parameters).await
     }
 
-    /// Calls [`GET /curated_podcasts/{id}`](https://www.listennotes.com/api/docs/#post-api-v2-curated_podcasts-id) with supplied parameters.
+    /// Calls [`GET /curated_podcasts/{id}`](https://www.listennotes.com/api/docs/#get-api-v2-curated_podcasts-id) with supplied parameters.
     pub async fn fetch_curated_podcasts_list_by_id(&self, id: &str, parameters: &Value) -> Result<Response> {
         self.get(&format!("curated_podcasts/{}", id), parameters).await
     }
 
-    /// Calls [`GET /curated_podcasts`](https://www.listennotes.com/api/docs/#post-api-v2-curated_podcasts) with supplied parameters.
+    /// Calls [`GET /curated_podcasts`](https://www.listennotes.com/api/docs/#get-api-v2-curated_podcasts) with supplied parameters.
     pub async fn fetch_curated_podcasts_lists(&self, parameters: &Value) -> Result<Response> {
         self.get("curated_podcasts", parameters).await
     }
 
-    /// Calls [`GET /genres`](https://www.listennotes.com/api/docs/#post-api-v2-genres) with supplied parameters.
+    /// Calls [`GET /genres`](https://www.listennotes.com/api/docs/#get-api-v2-genres) with supplied parameters.
     pub async fn fetch_podcast_genres(&self, parameters: &Value) -> Result<Response> {
         self.get("genres", parameters).await
     }
 
-    /// Calls [`GET /regions`](https://www.listennotes.com/api/docs/#post-api-v2-regions) with supplied parameters.
+    /// Calls [`GET /regions`](https://www.listennotes.com/api/docs/#get-api-v2-regions) with supplied parameters.
     pub async fn fetch_podcast_regions(&self, parameters: &Value) -> Result<Response> {
         self.get("regions", parameters).await
     }
 
-    /// Calls [`GET /languages`](https://www.listennotes.com/api/docs/#post-api-v2-languages) with supplied parameters.
+    /// Calls [`GET /languages`](https://www.listennotes.com/api/docs/#get-api-v2-languages) with supplied parameters.
     pub async fn fetch_podcast_languages(&self, parameters: &Value) -> Result<Response> {
         self.get("languages", parameters).await
     }
 
-    /// Calls [`GET /just_listen`](https://www.listennotes.com/api/docs/#post-api-v2-just_listen) with supplied parameters.
+    /// Calls [`GET /just_listen`](https://www.listennotes.com/api/docs/#get-api-v2-just_listen) with supplied parameters.
     pub async fn just_listen(&self, parameters: &Value) -> Result<Response> {
         self.get("just_listen", parameters).await
     }
 
+    /// Calls [`GET /podcasts/{id}/recommendations`](https://www.listennotes.com/api/docs/#get-api-v2-podcasts-id-recommendations) with supplied parameters.
+    pub async fn fetch_recommendations_for_podcast(&self, id: &str, parameters: &Value) -> Result<Response> {
+        self.get(&format!("podcasts/{}/recommendations", id), parameters).await
+    }
+
+    /// Calls [`GET /episodes/{id}/recommendations`](https://www.listennotes.com/api/docs/#get-api-v2-episodes-id-recommendations) with supplied parameters.
+    pub async fn fetch_recommendations_for_episode(&self, id: &str, parameters: &Value) -> Result<Response> {
+        self.get(&format!("episodes/{}/recommendations", id), parameters).await
+    }
+
+    /// Calls [`GET /playlists/{id}`](https://www.listennotes.com/api/docs/#get-api-v2-playlists-id) with supplied parameters.
+    pub async fn fetch_playlist_by_id(&self, id: &str, parameters: &Value) -> Result<Response> {
+        self.get(&format!("playlists/{}", id), parameters).await
+    }
+
+    /// Calls [`GET /playlists`](https://www.listennotes.com/api/docs/#get-api-v2-playlists) with supplied parameters.
+    pub async fn fetch_my_playlists(&self, parameters: &Value) -> Result<Response> {
+        self.get("playlists", parameters).await
+    }
+
+    /// Calls [`POST /podcasts/submit`](https://www.listennotes.com/api/docs/#post-api-v2-podcasts-submit) with supplied parameters.
+    pub async fn submit_podcast(&self, parameters: &Value) -> Result<Response> {
+        self.post("podcasts/submit", parameters).await
+    }
+
+    /// Calls [`DELETE /podcasts/{id}`](https://www.listennotes.com/api/docs/#delete-api-v2-podcasts-id) with supplied parameters.
+    pub async fn delete_podcast(&self, id: &str, parameters: &Value) -> Result<Response> {
+        self.delete(&format!("podcasts/{}", id), parameters).await
+    }
+
     async fn get(&self, endpoint: &str, parameters: &Value) -> Result<Response> {
         let request = self
             .client
@@ -161,6 +191,15 @@ impl Client<'_> {
         Ok(self.request(request).await?)
     }
 
+    async fn delete(&self, endpoint: &str, parameters: &Value) -> Result<Response> {
+        let request = self
+            .client
+            .delete(format!("{}/{}", self.api.url(), endpoint))
+            .query(parameters);
+
+        Ok(self.request(request).await?)
+    }
+
     async fn request(&self, request: RequestBuilder) -> Result<Response> {
         let request = if let Api::Production(key) = self.api {
             request.header("X-ListenAPI-Key", key)

tests/client_tests.rs

@@ -290,4 +290,127 @@ mod mock {
             assert!(body["audio_length_sec"].as_i64().unwrap() > 0);
         });
     }
+
+    #[test]
+    fn fetch_recommendations_for_podcast() {
+        b!(async {
+            let response = client()
+                .fetch_recommendations_for_podcast("adfsddf", &json!({}))
+                .await
+                .unwrap();
+            // Request
+            assert_eq!(response.request.method(), http::Method::GET);
+            assert_eq!(
+                response.request.url().path(),
+                "/api/v2/podcasts/adfsddf/recommendations"
+            );
+            let p = response.request.url().query_pairs();
+            assert_eq!(p.count(), 0);
+            // Response
+            let body = response.json().await.unwrap();
+            assert!(body.is_object());
+            assert!(body["recommendations"].as_array().unwrap().len() > 0);
+        });
+    }
+
+    #[test]
+    fn fetch_recommendations_for_episode() {
+        b!(async {
+            let response = client()
+                .fetch_recommendations_for_episode("asdfasdf", &json!({}))
+                .await
+                .unwrap();
+            // Request
+            assert_eq!(response.request.method(), http::Method::GET);
+            assert_eq!(
+                response.request.url().path(),
+                "/api/v2/episodes/asdfasdf/recommendations"
+            );
+            let p = response.request.url().query_pairs();
+            assert_eq!(p.count(), 0);
+            // Response
+            let body = response.json().await.unwrap();
+            assert!(body.is_object());
+            assert!(body["recommendations"].as_array().unwrap().len() > 0);
+        });
+    }
+
+    #[test]
+    fn fetch_playlist_by_id() {
+        b!(async {
+            let response = client().fetch_playlist_by_id("fdsafdsa", &json!({})).await.unwrap();
+            // Request
+            assert_eq!(response.request.method(), http::Method::GET);
+            assert_eq!(response.request.url().path(), "/api/v2/playlists/fdsafdsa");
+            let p = response.request.url().query_pairs();
+            assert_eq!(p.count(), 0);
+            // Response
+            let body = response.json().await.unwrap();
+            assert!(body.is_object());
+            assert!(body["items"].as_array().unwrap().len() > 0);
+        });
+    }
+
+    #[test]
+    fn fetch_my_playlists() {
+        b!(async {
+            let response = client()
+                .fetch_my_playlists(&json!({
+                    "page": 2
+                }))
+                .await
+                .unwrap();
+            // Request
+            assert_eq!(response.request.method(), http::Method::GET);
+            assert_eq!(response.request.url().path(), "/api/v2/playlists");
+            let mut p = response.request.url().query_pairs();
+            assert_eq!(p.count(), 1);
+            assert_eq!(p.next(), Some((Cow::Borrowed("page"), Cow::Borrowed("2"))));
+            // Response
+            let body = response.json().await.unwrap();
+            assert!(body.is_object());
+            assert!(body["playlists"].as_array().unwrap().len() > 0);
+        });
+    }
+
+    #[test]
+    fn submit_podcast() {
+        b!(async {
+            let response = client()
+                .submit_podcast(&json!({
+                    "rss": "http://myrss.com/rss"
+                }))
+                .await
+                .unwrap();
+            // Request
+            assert_eq!(response.request.method(), http::Method::POST);
+            assert_eq!(response.request.url().path(), "/api/v2/podcasts/submit");
+            let mut p = form_urlencoded::parse(response.request.body().unwrap().as_bytes().unwrap());
+            assert_eq!(p.count(), 1);
+            assert_eq!(
+                p.next(),
+                Some((Cow::Borrowed("rss"), Cow::Borrowed("http://myrss.com/rss")))
+            );
+            // Response
+            let body = response.json().await.unwrap();
+            assert!(body.is_object());
+            assert!(body["status"].as_str().unwrap().len() > 0);
+        });
+    }
+
+    #[test]
+    fn delete_podcast() {
+        b!(async {
+            let response = client().delete_podcast("asdfasdfdf", &json!({})).await.unwrap();
+            // Request
+            assert_eq!(response.request.method(), http::Method::DELETE);
+            assert_eq!(response.request.url().path(), "/api/v2/podcasts/asdfasdfdf");
+            let p = response.request.url().query_pairs();
+            assert_eq!(p.count(), 0);
+            // Response
+            let body = response.json().await.unwrap();
+            assert!(body.is_object());
+            assert!(body["status"].as_str().unwrap().len() > 0);
+        });
+    }
 }