initial commit

lib/src/configuration.rs

@@ -1,57 +1,135 @@
+use url::Url;
+/// A struct representing a configuration for the SDK.
+///
+/// The `Configuration` struct is responsible for specifying details of the Endpoint where the requests are made.
+/// It provides methods for making constructing new configuration, changing the base url, and specifying a default configuration.
 #[derive(Debug, Clone)]
 pub struct Configuration {
-    pub base_path: String,
+    /// The base path for API requests.
+    pub base_path: Url,
+    /// The user agent to be used in API requests.
     pub user_agent: Option<String>,
+    /// The basic authentication credentials.
     pub basic_auth: Option<BasicAuth>,
+    /// The OAuth access token for authentication.
     pub oauth_access_token: Option<String>,
+    /// The bearer access token for authentication.
     pub bearer_access_token: Option<String>,
+    /// The API key for authentication.
     pub api_key: Option<ApiKey>,
 }
 
-// Check whether defining BasicAuth works like this or not, else revert to the basic definition commented out
-#[derive(Debug, Clone)]
+/// Represents the basic authentication credentials.
+#[derive(Debug, Clone, PartialEq)]
 pub struct BasicAuth {
+    /// The username for basic authentication.
     pub username: String,
+    /// The password for basic authentication.
     pub password: Option<String>,
 }
-// pub type BasicAuth = (String, Option<String>);
 
-#[derive(Debug, Clone)]
+/// Represents the API key for authentication.
+#[derive(Debug, Clone, PartialEq)]
 pub struct ApiKey {
+    /// The prefix for the API key.
     pub prefix: Option<String>,
+    /// The key value of the API key.
     pub key: String,
 }
 
 impl Configuration {
+    /// Creates a new instance of Configuration.
+    ///
+    /// # Arguments
+    ///
+    /// * `base_path` - The base path for API requests.
+    /// * `user_agent` - The user agent to be used in API requests.
+    /// * `basic_auth` - The basic authentication credentials.
+    /// * `oauth_access_token` - The OAuth access token for authentication.
+    ///
+    /// # Returns
+    ///
+    /// A new instance of Configuration.
     pub fn new(
-        base_path: String,
-        user_agent: Option<String>,
-        basic_auth: Option<BasicAuth>,
-        oauth_access_token: Option<String>,
+        base_path: Url,
     ) -> Self {
         Configuration {
             base_path,
-            user_agent,
-            basic_auth,
-            oauth_access_token,
+            user_agent:None,
+            basic_auth: None,
+            oauth_access_token: None,
             bearer_access_token: None,
             api_key: None,
         }
     }
 
-    pub fn set_base_path(&mut self, base_path: &str) -> &mut Self {
-        if base_path.is_empty() {
-            panic!("Empty base path");
-        }
-        self.base_path = base_path.to_string();
+    /// Sets the base path for API requests.
+    ///
+    /// # Arguments
+    ///
+    /// * `base_path` - The base path for API requests.
+    ///
+    /// # Returns
+    ///
+    /// A mutable reference to the Configuration instance.
+    pub fn set_base_path(&mut self, base_path: Url) -> &mut Self {
+        self.base_path = base_path;
+        self
+    }
+
+    /// Sets the user agent for API requests.
+    ///
+    /// # Arguments
+    ///
+    /// * `user_agent` - The user agent to be used in API requests.
+    ///
+    /// # Returns
+    ///
+    /// A new instance of Configuration.
+    pub fn with_user_agent(mut self, user_agent: String) -> Self {
+        self.user_agent = Some(user_agent);
+        self
+    }
+
+    /// Sets the basic authentication credentials for API requests.
+    ///
+    /// # Arguments
+    ///
+    /// * `basic_auth` - The basic authentication credentials.
+    ///
+    /// # Returns
+    ///
+    /// A new instance of Configuration.
+    pub fn with_basic_auth(mut self, basic_auth: BasicAuth) -> Self {
+        self.basic_auth = Some(basic_auth);
+        self
+    }
+
+    /// Sets the OAuth access token for API requests.
+    ///
+    /// # Arguments
+    ///
+    /// * `oauth_access_token` - The OAuth access token for authentication.
+    ///
+    /// # Returns
+    ///
+    /// A new instance of Configuration.
+    pub fn with_oauth_access_token(mut self, oauth_access_token: String) -> Self {
+        self.oauth_access_token = Some(oauth_access_token);
         self
     }
 }
 
 impl Default for Configuration {
+    /// Creates a default instance of Configuration.
+    ///
+    /// # Returns
+    ///
+    /// A default instance of Configuration.
+    /// This is used to define a configuration for a server that is running on your localhost
     fn default() -> Self {
         Configuration {
-            base_path: "localhost".to_owned(),
+            base_path: Url::parse("http://localhost").unwrap(),
             user_agent: Some("GA4GH SDK".to_owned()),
             basic_auth: None,
             oauth_access_token: None,
@@ -60,3 +138,42 @@ impl Default for Configuration {
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use url::Url;
+
+    #[test]
+    fn test_new_configuration() {
+        let config = Configuration::new(
+    Url::parse("https://api.example.com").unwrap(),
+        )
+        .with_user_agent("My User Agent".to_owned())
+        .with_basic_auth(BasicAuth {
+            username: "admin".to_owned(),
+            password: Some("password".to_owned()),
+        })
+        .with_oauth_access_token("my_oauth_token".to_owned());
+
+        assert_eq!(config.base_path.as_str(), "https://api.example.com/");
+        assert_eq!(config.user_agent, Some("My User Agent".to_owned()));
+        assert_eq!(
+            config.basic_auth,
+            Some(BasicAuth {
+                username: "admin".to_owned(),
+                password: Some("password".to_owned()),
+            })
+        );
+        assert_eq!(config.oauth_access_token, Some("my_oauth_token".to_owned()));
+        assert_eq!(config.bearer_access_token, None);
+        assert_eq!(config.api_key, None);
+    }
+
+    #[test]
+    fn test_set_base_path() {
+        let mut config = Configuration::default();
+        config.set_base_path(Url::parse("https://api.example.com").unwrap());
+        assert_eq!(config.base_path.as_str(), "https://api.example.com/");
+    }
+}

lib/src/lib.rs

@@ -6,6 +6,7 @@ extern crate serde_derive;
 mod test_utils;
 
 pub mod configuration;
+pub mod transport;
 pub mod serviceinfo;
 pub mod tes;
-pub mod transport;
+

lib/src/serviceinfo/mod.rs

@@ -46,7 +46,11 @@ mod tests {
         setup();
         let mut config = Configuration::default();
         let funnel_url = ensure_funnel_running().await;
-        config.set_base_path(&funnel_url);
+
+        // Parse the funnel_url String into a Url
+        let funnel_url = url::Url::parse(&funnel_url).expect("Invalid URL format");
+
+        config.set_base_path(funnel_url);
         let service_info = ServiceInfo::new(&config).unwrap();
 
         // Call get_service_info and print the result

lib/src/tes/mod.rs

@@ -204,7 +204,11 @@ mod tests {
         // setup(); – should be run once in the test function
         let mut config = Configuration::default();
         let funnel_url = ensure_funnel_running().await;
-        config.set_base_path(&funnel_url);
+
+        // Parse the funnel_url String into a Url
+        let funnel_url = url::Url::parse(&funnel_url).expect("Invalid URL format");
+
+        config.set_base_path(funnel_url);
         let tes = match TES::new(&config).await {
             Ok(tes) => tes,
             Err(e) => {