Merge pull request #1 from ListenNotes/cameron-develop

Initial architecture review

Author: wenbinf

.gitignore

@@ -1,10 +1,2 @@
-# Generated by Cargo
-# will have compiled files and executables
-/target/
-
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+/target
 Cargo.lock
-
-# These are backup files generated by rustfmt
-**/*.rs.bk

Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "podcast-api"
+version = "0.1.0"
+authors = ["Cameron Fyfe <cameron.j.fyfe@gmail.com>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+serde = { version = "1", features = ["derive"] } 
+serde_json = "1"
+tokio = { version = "1", features = ["full"] }
+reqwest = { version = "0.11", features = ["json"] }

examples/sample/.gitignore

@@ -0,0 +1 @@
+/target

examples/sample/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "sample"
+version = "0.1.0"
+authors = ["Cameron Fyfe <cameron.j.fyfe@gmail.com>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+podcast-api = { version = "^0", path = "../../" }
+reqwest = { version = "0.11", features = ["json"] }
+serde = { version = "1", features = ["derive"] } 
+serde_json = "1"
+tokio = { version = "1", features = ["full"] }

examples/sample/src/main.rs

@@ -0,0 +1,29 @@
+use serde_json::json;
+
+#[tokio::main]
+async fn main() {
+    // Api Key  (None => Test API, Some(key) => Production API)
+    let api_key = None;
+
+    // Create client
+    let client = podcast_api::Client::new(reqwest::Client::new(), api_key);
+
+    // Call API
+    match client
+        .typeahead(&json!({
+            "q": "startup",
+            "show_podcasts": 1
+        }))
+        .await
+    {
+        Ok(response) => {
+            println!("Successfully called \"typeahead\" endpoint.");
+            println!("Response Body:");
+            println!("{:?}", response);
+        }
+        Err(err) => {
+            println!("Error calling \"typeahead\" endpoint:");
+            println!("{:?},", err);
+        }
+    };
+}

src/api.rs

@@ -0,0 +1,13 @@
+pub enum Api {
+    Production(String),
+    Mock,
+}
+
+impl Api {
+    pub fn url(&self) -> &str {
+        match &self {
+            Api::Production(_) => "https://listen-api.listennotes.com/api/v2",
+            Api::Mock => "https://listen-api-test.listennotes.com/api/v2",
+        }
+    }
+}

src/client.rs

@@ -0,0 +1,76 @@
+use super::{Api, Result};
+use serde_json::{json, Value};
+
+pub struct Client {
+    client: reqwest::Client,
+    api: Api,
+}
+
+impl Client {
+    pub fn new(client: reqwest::Client, id: Option<String>) -> Client {
+        Client {
+            client,
+            api: if let Some(id) = id {
+                Api::Production(id)
+            } else {
+                Api::Mock
+            },
+        }
+    }
+
+    pub async fn search(&self, parameters: &Value) -> Result<Value> {
+        self.get("search", parameters).await
+    }
+
+    pub async fn typeahead(&self, parameters: &Value) -> Result<Value> {
+        self.get("typeahead", parameters).await
+    }
+
+    pub async fn episode_by_id(&self, id: &str, parameters: &Value) -> Result<Value> {
+        self.get(&format!("episodes/{}", id), parameters).await
+    }
+
+    pub async fn episodes(&self, ids: &[&str], parameters: &Value) -> Result<Value> {
+        self.post("episodes", &parameters.with("ids", &ids.join(",").as_str()))
+            .await
+    }
+
+    pub async fn genres(&self, parameters: &Value) -> Result<Value> {
+        self.get("genres", parameters).await
+    }
+
+    async fn get(&self, endpoint: &str, parameters: &Value) -> Result<Value> {
+        Ok(self
+            .client
+            .get(format!("{}/{}", self.api.url(), endpoint))
+            .query(parameters)
+            .send()
+            .await?
+            .json()
+            .await?)
+    }
+
+    async fn post(&self, endpoint: &str, parameters: &Value) -> Result<Value> {
+        Ok(self
+            .client
+            .post(format!("{}/{}", self.api.url(), endpoint))
+            .header("Content-Type", "application/x-www-form-urlencoded")
+            .body(serde_json::to_string(&parameters)?) // TODO: switch to URL encoding
+            .send()
+            .await?
+            .json()
+            .await?)
+    }
+}
+
+trait AddField {
+    fn with(&self, key: &str, value: &str) -> Self;
+}
+
+impl AddField for Value {
+    fn with(&self, key: &str, value: &str) -> Self {
+        let mut p = self.clone();
+        p[key] = json!(value);
+        p
+    }
+}

src/error.rs

@@ -0,0 +1,32 @@
+#[derive(Debug)]
+pub enum Error {
+    Reqwest(reqwest::Error),
+    Json(serde_json::Error),
+}
+
+impl From<reqwest::Error> for Error {
+    fn from(e: reqwest::Error) -> Error {
+        Error::Reqwest(e)
+    }
+}
+
+impl From<serde_json::Error> for Error {
+    fn from(e: serde_json::Error) -> Error {
+        Error::Json(e)
+    }
+}
+
+impl std::error::Error for Error {
+    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+        match *self {
+            Error::Reqwest(ref e) => Some(e),
+            Error::Json(ref e) => Some(e),
+        }
+    }
+}
+
+impl std::fmt::Display for Error {
+    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
+        write!(f, "{}", *self)
+    }
+}

src/lib.rs

@@ -0,0 +1,9 @@
+mod api;
+mod client;
+mod error;
+
+use api::Api;
+
+pub use client::Client;
+pub use error::Error;
+pub type Result<T> = std::result::Result<T, error::Error>;