Add Source trait (#21)

* Add source trait

* Move github & gitlab into source module, implementing `Source` trait

Author: SRv6d

Cargo.lock

@@ -6,6 +6,7 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+async-trait = "0.1.80"
 chrono = "0.4.37"
 clap = { version = "4.5.4", features = ["derive", "env", "string"] }
 figment = { version = "0.10.16", features = ["toml"] }

Cargo.toml

@@ -9,7 +9,7 @@ pub enum ManageSources {
         name: String,
         /// The Git provider used by the source.
         #[arg(short, long)]
-        provider: config::GitProviderType,
+        provider: config::SourceType, // TODO: Rename parameter to source type
         /// The URL of the source.
         #[arg(short, long)]
         url: Option<reqwest::Url>,

src/cli/manage_sources.rs

@@ -1,22 +1,21 @@
 //! The update subcommand used to get the latest allowed signers and write them to the output file.
+use crate::{AllowedSigner, Config, Source, SshPublicKey};
 use std::collections::{HashMap, HashSet};
 
-use crate::{AllowedSigner, Config, SshPublicKey};
-
 pub(super) fn update(config: Config) {
     let sources = config.get_sources();
 
     let mut allowed_signers: HashSet<AllowedSigner> = HashSet::new();
     if let Some(users) = config.users {
         for user in users {
-            let public_keys = get_public_keys((), sources.clone());
+            let public_keys = get_public_keys((), &sources);
             for public_key in public_keys {
                 todo!("Insert allowed signer into set.");
             }
         }
     }
 }
 
-fn get_public_keys(user: (), sources: HashMap<String, ()>) -> Vec<SshPublicKey> {
+fn get_public_keys(user: (), sources: &HashMap<String, Box<dyn Source>>) -> Vec<SshPublicKey> {
     todo!("Retrieve public keys for a user from all sources.");
 }

src/cli/update.rs

@@ -1,4 +1,4 @@
-use crate::GitProvider;
+use crate::Source;
 use figment::{
     providers::{Format, Serialized, Toml},
     Figment,
@@ -30,12 +30,12 @@ impl Default for Config {
             sources: vec![
                 SourceConfiguration {
                     name: "github".to_string(),
-                    provider: GitProviderType::Github,
+                    provider: SourceType::Github,
                     url: "https://api.github.com".to_string(),
                 },
                 SourceConfiguration {
                     name: "gitlab".to_string(),
-                    provider: GitProviderType::Gitlab,
+                    provider: SourceType::Gitlab,
                     url: "https://gitlab.com".to_string(),
                 },
             ],
@@ -46,7 +46,7 @@ impl Default for Config {
 impl Config {
     /// Get the configured sources.
     #[must_use]
-    pub fn get_sources(&self) -> HashMap<String, ()> {
+    pub fn get_sources(&self) -> HashMap<String, Box<dyn Source>> {
         todo!()
     }
 
@@ -87,13 +87,11 @@ fn git_allowed_signers() -> Option<PathBuf> {
     Some(path.into())
 }
 
-/// The type of Git provider.
+/// The type of source.
 #[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, clap::ValueEnum)]
 #[serde(rename_all = "lowercase")]
-pub enum GitProviderType {
-    /// A Git provider that implements the GitHub API.
+pub enum SourceType {
     Github,
-    /// A Git provider that implements the GitLab API.
     Gitlab,
 }
 
@@ -108,19 +106,10 @@ pub struct User {
 #[derive(Debug, Deserialize, Serialize, PartialEq)]
 struct SourceConfiguration {
     name: String,
-    provider: GitProviderType,
+    provider: SourceType,
     url: String,
 }
 
-impl From<SourceConfiguration> for GitProvider {
-    fn from(source: SourceConfiguration) -> Self {
-        match source.provider {
-            GitProviderType::Github => GitProvider::github(source.url.parse().unwrap()),
-            GitProviderType::Gitlab => GitProvider::gitlab(source.url.parse().unwrap()),
-        }
-    }
-}
-
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -185,7 +174,7 @@ mod tests {
             sources: vec![
                 SourceConfiguration {
                     name: "acme-corp".to_string(),
-                    provider: GitProviderType::Gitlab,
+                    provider: SourceType::Gitlab,
                     url: "https://git.acme.corp".to_string(),
                 }
             ]
@@ -201,12 +190,12 @@ mod tests {
         let default_sources = Config::default().sources;
         assert!(default_sources.contains(&SourceConfiguration {
             name: "github".to_string(),
-            provider: GitProviderType::Github,
+            provider: SourceType::Github,
             url: "https://api.github.com".to_string(),
         }));
         assert!(default_sources.contains(&SourceConfiguration {
             name: "gitlab".to_string(),
-            provider: GitProviderType::Gitlab,
+            provider: SourceType::Gitlab,
             url: "https://gitlab.com".to_string(),
         }));
     }

src/config.rs

@@ -5,10 +5,10 @@
 pub use allowed_signers::{AllowedSigner, AllowedSignersFile};
 pub use config::Config;
 pub use core::*;
-pub use provider::GitProvider;
+pub use source::Source;
 
 mod allowed_signers;
 pub mod cli;
 mod config;
 mod core;
-mod provider;
+mod source;

src/lib.rs

@@ -1,4 +1,6 @@
+use super::Source;
 use crate::{SshPublicKey, USER_AGENT};
+use async_trait::async_trait;
 use reqwest::{Client, Result, Url};
 
 #[derive(Debug)]
@@ -14,11 +16,12 @@ impl Github {
     pub fn new(base_url: Url) -> Self {
         Self { base_url }
     }
+}
 
-    /// Get the signing keys of a user by their username.
-    ///
-    /// [API documentation](https://docs.github.com/en/rest/users/ssh-signing-keys?apiVersion=2022-11-28#list-ssh-signing-keys-for-a-user)
-    pub async fn get_keys_by_username(
+#[async_trait]
+impl Source for Github {
+    // [API documentation](https://docs.github.com/en/rest/users/ssh-signing-keys?apiVersion=2022-11-28#list-ssh-signing-keys-for-a-user)
+    async fn get_keys_by_username(
         &self,
         username: &str,
         client: &Client,

src/provider/core.rs

@@ -1,4 +1,6 @@
+use super::Source;
 use crate::{SshPublicKey, USER_AGENT};
+use async_trait::async_trait;
 use reqwest::{Client, Result, Url};
 use serde::Deserialize;
 
@@ -15,11 +17,12 @@ impl Gitlab {
     pub fn new(base_url: Url) -> Self {
         Self { base_url }
     }
+}
 
-    /// Get the signing keys of a user by their username.
-    ///
-    /// [API Documentation](https://docs.gitlab.com/16.10/ee/api/users.html#list-ssh-keys-for-user)
-    pub async fn get_keys_by_username(
+#[async_trait]
+impl Source for Gitlab {
+    // [API Documentation](https://docs.gitlab.com/16.10/ee/api/users.html#list-ssh-keys-for-user)
+    async fn get_keys_by_username(
         &self,
         username: &str,
         client: &Client,

src/provider/mod.rs

@@ -0,0 +1,13 @@
+use crate::SshPublicKey;
+use async_trait::async_trait;
+
+/// A source implements a way to get public keys from a Git provider.
+#[async_trait]
+pub trait Source {
+    /// Get a users public keys by their username.
+    async fn get_keys_by_username(
+        &self,
+        username: &str,
+        client: &reqwest::Client,
+    ) -> Result<Vec<SshPublicKey>, reqwest::Error>;
+}

src/provider/github.rs src/source/github.rs

@@ -0,0 +1,5 @@
+pub use main::Source;
+
+mod github;
+mod gitlab;
+mod main;