Merge pull request #2 from rruckley/CommonTrait

rruckley · Mar 30, 2024 · 0074662 · 0074662
2 parents 7721b43 + dbdb460
commit 0074662
Show file tree

Hide file tree

Showing 9 changed files with 377 additions and 207 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,13 +1,13 @@
 [package]
 name = "tmf-client"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 authors = ["Ryan Ruckley <[email protected]"]
 description = "A Rust client library for TMF conformant APIs"
 
 [dependencies]
-env_logger = "0.11.1"
-reqwest = {version = "0.11.24", features = ["blocking"]}
-serde = "1.0.196"
-serde_json = "1.0.113"
+env_logger = "0.11.3"
+reqwest = {version = "0.12.2", features = ["blocking"]}
+serde = "1.0"
+serde_json = "1.0"
 tmflib = { git = "https://github.com/rruckley/tmflib.git"}
diff --git a/examples/get_catalog.rs b/examples/get_catalog.rs
@@ -1,6 +1,6 @@
 //! Get Catalog Example
 
-use tmf_client::{TMFClient,QueryOptions};
+use tmf_client::{TMFClient,QueryOptions,Operations};
 use tmflib::HasName;
 
 fn main() {

diff --git a/examples/get_product_offering.rs b/examples/get_product_offering.rs
@@ -1,6 +1,6 @@
 //! Product Offering Example
 
-use tmf_client::{TMFClient,QueryOptions};
+use tmf_client::{TMFClient,QueryOptions,Operations};
 use tmflib::{HasId,HasName};
 
 fn main() {

diff --git a/examples/get_product_offering_price.rs b/examples/get_product_offering_price.rs
@@ -1,6 +1,6 @@
 //! Product Offering Example
 
-use tmf_client::{TMFClient,QueryOptions};
+use tmf_client::{TMFClient,QueryOptions,Operations};
 use tmflib::{HasId,HasName};
 
 fn main() {

diff --git a/examples/get_product_specification.rs b/examples/get_product_specification.rs
@@ -1,6 +1,6 @@
 //! Product Offering Example
 
-use tmf_client::{TMFClient,QueryOptions};
+use tmf_client::{TMFClient,QueryOptions,Operations};
 use tmflib::{HasId,HasName};
 
 fn main() {

diff --git a/src/lib.rs b/src/lib.rs
@@ -4,9 +4,12 @@
 pub mod tmf;
 pub mod common;
 
+use common::tmf_error::TMFError;
 use tmf::tmf620::TMF620;
 use tmf::tmf622::TMF622;
 
+use tmflib::HasId;
+
 /// Fields for filtering output
 #[derive(Clone, Default, Debug)]
 pub struct QueryOptions {
@@ -57,6 +60,40 @@ impl From<QueryOptions> for String {
     }
 }
 
+pub trait Operations {
+    type TMF : HasId;
+
+    /// Get a specific tmf object by Id
+    /// ```
+    /// # use tmf_client::TMFClient;
+    /// let categories = TMFClient::new("http://localhost:8000")
+    ///     .tmf620()
+    ///     .category()
+    ///     .get("ID123");
+    /// ```
+    fn get(&self, id : impl Into<String>) -> Result<Vec<Self::TMF>,TMFError>;
+    /// Get a list of tmf objects applying optional filter
+    /// ```
+    /// # use tmf_client::TMFClient;
+    /// let categories = TMFClient::new("http://localhost:8000")
+    ///     .tmf620()
+    ///     .category()
+    ///     .list(None);
+    /// ```
+    fn list(&self, filter : Option<QueryOptions>) -> Result<Vec<Self::TMF>,TMFError>;
+    fn create(&self, item : Self::TMF) -> Result<Self::TMF,TMFError>;
+    fn update(&self, id : impl Into<String>, patch : Self::TMF) -> Result<Self::TMF,TMFError>;
+    /// Delete a specific tmf object by Id
+    /// ```
+    /// # use tmf_client::TMFClient;
+    /// let categories = TMFClient::new("http://localhost:8000")
+    ///     .tmf620()
+    ///     .category()
+    ///     .get("ID123");
+    /// ```
+    fn delete(&self, id : impl Into<String>) -> Result<Self::TMF,TMFError>;
+}
+
 pub struct TMFClient {
     host : String,
     tmf620 : Option<TMF620>,

diff --git a/src/tmf/tmf620.rs b/src/tmf/tmf620.rs
@@ -1,5 +1,6 @@
 //! TMF620 Product Catalogue
 
+
 use tmflib::tmf620::catalog::Catalog;
 use tmflib::tmf620::category::Category;
 use tmflib::tmf620::product_offering::ProductOffering;
@@ -9,7 +10,7 @@ use tmflib::Uri;
 use super::{get_tmf,list_tmf};
 use crate::common::tmf_error::TMFError;
 
-use crate::QueryOptions;
+use crate::{QueryOptions,Operations};
 
 /// TMF620 Category API calls
 #[derive(Clone,Default,Debug)]
@@ -26,19 +27,32 @@ impl TMF620Category {
     pub fn get(&self, _id : impl Into<String>) -> Result<Vec<Category>,TMFError> {
         get_tmf(self.host.clone(),_id.into())
     }
-    /// Get a list of catalogs applying optional filter
-    /// ```
-    /// # use tmf_client::TMFClient;
-    /// let categories = TMFClient::new("http://localhost:8000")
-    ///     .tmf620()
-    ///     .category()
-    ///     .list(None);
-    /// ```
+
     pub fn list(&self, filter : Option<QueryOptions>) -> Result<Vec<Category>,TMFError> {
         list_tmf(self.host.clone(),filter)
     }
 }
 
+impl Operations for TMF620Category {
+    type TMF = Category;
+
+    fn create(&self, _item : Self::TMF) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))    
+    }
+    fn delete(&self, _id : impl Into<String>) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))        
+    }
+    fn get(&self, id : impl Into<String>) -> Result<Vec<Self::TMF>,TMFError> {
+        get_tmf(self.host.clone(),id.into())    
+    }
+    fn list(&self, filter : Option<QueryOptions>) -> Result<Vec<Self::TMF>,TMFError> {
+        list_tmf(self.host.clone(),filter)    
+    }
+    fn update(&self, _id : impl Into<String>, _patch : Self::TMF) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))
+    }
+}
+
 /// TMF620 Catalog API calls
 #[derive(Clone,Default,Debug)]
 pub struct TMF620Catalog {
@@ -50,16 +64,30 @@ impl TMF620Catalog {
     pub fn new(host : Uri) -> TMF620Catalog {
         TMF620Catalog { host }
     }
-    /// Get a single catalog entry
-    pub fn get(&self, _id : impl Into<String>) -> Result<Vec<Catalog>,TMFError> {
-        get_tmf(self.host.clone(),_id.into())
+}
+
+impl Operations for TMF620Catalog {
+    type TMF = Catalog;
+
+    fn create(&self, _item : Self::TMF) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))    
     }
-    /// Get a list of catalogs applying optional filter
-    pub fn list(&self, filter : Option<QueryOptions>) -> Result<Vec<Catalog>,TMFError> {
-        list_tmf(self.host.clone(),filter)
+    fn delete(&self, _id : impl Into<String>) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))    
+    }
+    fn get(&self, id : impl Into<String>) -> Result<Vec<Self::TMF>,TMFError> {
+        get_tmf(self.host.clone(),id.into())    
+    }
+    fn list(&self, filter : Option<QueryOptions>) -> Result<Vec<Self::TMF>,TMFError> {
+        list_tmf(self.host.clone(),filter)    
+    }
+    fn update(&self, _id : impl Into<String>, _patch : Self::TMF) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))    
     }
 }
 
+
+
 /// TMF620 ProductOffering API calls
 #[derive(Clone,Default,Debug)]
 pub struct TMF620ProductOffering {
@@ -71,15 +99,25 @@ impl TMF620ProductOffering {
     pub fn new(host : Uri) -> TMF620ProductOffering {
         TMF620ProductOffering { host }
     }
+}
 
-    /// Get a single product offering
-    pub fn get(&self, _id : impl Into<String>) -> Result<Vec<ProductOffering>,TMFError> {
-        get_tmf(self.host.clone(),_id.into())
-    }
+impl Operations for TMF620ProductOffering {
+    type TMF = ProductOffering;
 
-    /// Get a list of catalogs applying optional filter
-    pub fn list(&self, filter : Option<QueryOptions>) -> Result<Vec<ProductOffering>,TMFError> {
-        list_tmf(self.host.clone(),filter)
+    fn create(&self, _item : Self::TMF) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))    
+    }
+    fn delete(&self, _id : impl Into<String>) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))        
+    }
+    fn get(&self, id : impl Into<String>) -> Result<Vec<Self::TMF>,TMFError> {
+        get_tmf(self.host.clone(),id.into())    
+    }
+    fn list(&self, filter : Option<QueryOptions>) -> Result<Vec<Self::TMF>,TMFError> {
+        list_tmf(self.host.clone(),filter)    
+    }
+    fn update(&self, _id : impl Into<String>, _patch : Self::TMF) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))
     }
 }
 
@@ -94,15 +132,25 @@ impl TMF620ProductOfferingPrice {
     pub fn new(host : Uri) -> TMF620ProductOfferingPrice {
         TMF620ProductOfferingPrice { host }
     }
+}
 
-    /// Get a single product offering
-    pub fn get(&self, _id : impl Into<String>) -> Result<Vec<ProductOfferingPrice>,TMFError> {
-        get_tmf(self.host.clone(),_id.into())
-    }
+impl Operations for TMF620ProductOfferingPrice {
+    type TMF = ProductOfferingPrice;
 
-    /// Get a list of catalogs applying optional filter
-    pub fn list(&self, filter : Option<QueryOptions>) -> Result<Vec<ProductOfferingPrice>,TMFError> {
-        list_tmf(self.host.clone(),filter)
+    fn create(&self, _item : Self::TMF) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))    
+    }
+    fn delete(&self, _id : impl Into<String>) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))        
+    }
+    fn get(&self, id : impl Into<String>) -> Result<Vec<Self::TMF>,TMFError> {
+        get_tmf(self.host.clone(),id.into())    
+    }
+    fn list(&self, filter : Option<QueryOptions>) -> Result<Vec<Self::TMF>,TMFError> {
+        list_tmf(self.host.clone(),filter)    
+    }
+    fn update(&self, _id : impl Into<String>, _patch : Self::TMF) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))
     }
 }
 
@@ -117,15 +165,25 @@ impl TMF620ProductSpecification {
     pub fn new(host : Uri) -> TMF620ProductSpecification {
         TMF620ProductSpecification { host }
     }
+}
 
-    /// Get a single product offering
-    pub fn get(&self, _id : impl Into<String>) -> Result<Vec<ProductSpecification>,TMFError> {
-        get_tmf(self.host.clone(),_id.into())
-    }
+impl Operations for TMF620ProductSpecification {
+    type TMF = ProductSpecification;
 
-    /// Get a list of catalogs applying optional filter
-    pub fn list(&self, filter : Option<QueryOptions>) -> Result<Vec<ProductSpecification>,TMFError> {
-        list_tmf(self.host.clone(),filter)
+    fn create(&self, _item : Self::TMF) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))    
+    }
+    fn delete(&self, _id : impl Into<String>) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))        
+    }
+    fn get(&self, id : impl Into<String>) -> Result<Vec<Self::TMF>,TMFError> {
+        get_tmf(self.host.clone(),id.into())    
+    }
+    fn list(&self, filter : Option<QueryOptions>) -> Result<Vec<Self::TMF>,TMFError> {
+        list_tmf(self.host.clone(),filter)    
+    }
+    fn update(&self, _id : impl Into<String>, _patch : Self::TMF) -> Result<Self::TMF,TMFError> {
+        Err(TMFError::from("Not implemented"))
     }
 }