Rename GetPublicKeys trait to GitProvider (#14)

* Rename `GitProvider` to `GitProviderType` and move it to config module

* Rename `GetPublicKeys` trait to `GitProvider`

Author: SRv6d

src/cli/manage_sources.rs

@@ -1,4 +1,4 @@
-use crate::GitProvider;
+use crate::config;
 use clap::Subcommand;
 
 #[derive(Debug, Subcommand)]
@@ -9,7 +9,7 @@ pub enum ManageSources {
         name: String,
         /// The Git provider used by the source.
         #[arg(short, long)]
-        provider: GitProvider,
+        provider: config::GitProviderType,
         /// The URL of the source.
         #[arg(short, long)]
         url: Option<reqwest::Url>,

src/config.rs

@@ -1,4 +1,3 @@
-use crate::GitProvider;
 use figment::{
     providers::{Format, Serialized, Toml},
     Figment,
@@ -31,12 +30,12 @@ impl Default for Config {
             sources: Some(vec![
                 Source {
                     name: "github".to_string(),
-                    provider: GitProvider::Github,
+                    provider: GitProviderType::Github,
                     url: "https://api.github.com".to_string(),
                 },
                 Source {
                     name: "gitlab".to_string(),
-                    provider: GitProvider::Gitlab,
+                    provider: GitProviderType::Gitlab,
                     url: "https://gitlab.com".to_string(),
                 },
             ]),
@@ -83,6 +82,16 @@ fn git_allowed_signers() -> Option<PathBuf> {
     Some(path.into())
 }
 
+/// The type of Git provider.
+#[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.
+    Github,
+    /// A Git provider that implements the GitLab API.
+    Gitlab,
+}
+
 #[derive(Debug, Deserialize, Serialize, PartialEq)]
 struct User {
     name: String,
@@ -98,7 +107,7 @@ struct Organization {
 #[derive(Debug, Deserialize, Serialize, PartialEq)]
 struct Source {
     name: String,
-    provider: GitProvider,
+    provider: GitProviderType,
     url: String,
 }
 
@@ -168,17 +177,17 @@ mod tests {
             sources: Some(vec![
                 Source {
                     name: "github".to_string(),
-                    provider: GitProvider::Github,
+                    provider: GitProviderType::Github,
                     url: "https://api.github.com".to_string(),
                 },
                 Source {
                     name: "gitlab".to_string(),
-                    provider: GitProvider::Gitlab,
+                    provider: GitProviderType::Gitlab,
                     url: "https://gitlab.com".to_string(),
                 },
                 Source {
                     name: "acme-corp".to_string(),
-                    provider: GitProvider::Gitlab,
+                    provider: GitProviderType::Gitlab,
                     url: "https://git.acme.corp".to_string(),
                 },
             ])

src/core.rs

@@ -1,4 +1,3 @@
-use async_trait::async_trait;
 use serde::{Deserialize, Serialize};
 use std::{fmt, str::FromStr};
 
@@ -22,19 +21,3 @@ impl fmt::Display for SshPublicKey {
         write!(f, "{}", self.key)
     }
 }
-
-#[async_trait]
-pub trait GetPublicKeys {
-    type Err;
-
-    /// Get the public keys of a user by their username.
-    async fn by_username(&self, username: &str) -> Result<Vec<SshPublicKey>, Self::Err>;
-}
-
-/// A Git provider.
-#[derive(Debug, Clone, Copy, Deserialize, Serialize, PartialEq, Eq, clap::ValueEnum)]
-#[serde(rename_all = "lowercase")]
-pub enum GitProvider {
-    Github,
-    Gitlab,
-}

src/github.rs

@@ -1,4 +1,4 @@
-use crate::{GetPublicKeys, SshPublicKey, USER_AGENT};
+use crate::{GitProvider, SshPublicKey, USER_AGENT};
 use async_trait::async_trait;
 use reqwest::{Client, Result, Url};
 
@@ -16,14 +16,14 @@ impl Api<'_> {
 }
 
 #[async_trait]
-impl GetPublicKeys for Api<'_> {
+impl GitProvider for Api<'_> {
     type Err = reqwest::Error;
 
     /// 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
-    async fn by_username(&self, username: &str) -> Result<Vec<SshPublicKey>> {
+    async fn get_keys_by_username(&self, username: &str) -> Result<Vec<SshPublicKey>> {
         let url = self
             .base_url
             .join(&format!("/users/{username}/ssh_signing_keys"))
@@ -67,7 +67,7 @@ mod tests {
             base_url: server.base_url().parse().unwrap(),
             client: &client,
         };
-        let _ = api.by_username(username).await;
+        let _ = api.get_keys_by_username(username).await;
 
         mock.assert();
     }
@@ -122,7 +122,7 @@ mod tests {
             base_url: server.base_url().parse().unwrap(),
             client: &client,
         };
-        let keys = api.by_username(username).await.unwrap();
+        let keys = api.get_keys_by_username(username).await.unwrap();
 
         assert_eq!(keys, expected);
     }

src/gitlab.rs

@@ -1,4 +1,4 @@
-use crate::{GetPublicKeys, SshPublicKey, USER_AGENT};
+use crate::{GitProvider, SshPublicKey, USER_AGENT};
 use async_trait::async_trait;
 use reqwest::{Client, Result, Url};
 use serde::Deserialize;
@@ -17,14 +17,14 @@ impl Api<'_> {
 }
 
 #[async_trait]
-impl GetPublicKeys for Api<'_> {
+impl GitProvider for Api<'_> {
     type Err = reqwest::Error;
 
     /// 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
-    async fn by_username(&self, username: &str) -> Result<Vec<SshPublicKey>> {
+    async fn get_keys_by_username(&self, username: &str) -> Result<Vec<SshPublicKey>> {
         let url = self
             .base_url
             .join(&format!(
@@ -110,7 +110,7 @@ mod tests {
             base_url: server.base_url().parse().unwrap(),
             client: &client,
         };
-        let _ = api.by_username(username).await;
+        let _ = api.get_keys_by_username(username).await;
 
         mock.assert();
     }
@@ -170,7 +170,7 @@ mod tests {
             base_url: server.base_url().parse().unwrap(),
             client: &client,
         };
-        let keys = api.by_username(username).await.unwrap();
+        let keys = api.get_keys_by_username(username).await.unwrap();
 
         assert_eq!(keys, expected);
     }

src/lib.rs

@@ -1,10 +1,12 @@
 pub use allowed_signers::{AllowedSigner, AllowedSignersFile};
 pub use config::Config;
 pub use core::*;
+pub use provider::GitProvider;
 
 mod allowed_signers;
 pub mod cli;
 mod config;
 mod core;
 mod github;
 mod gitlab;
+mod provider;

src/provider.rs

@@ -0,0 +1,11 @@
+use crate::SshPublicKey;
+use async_trait::async_trait;
+
+/// A Git provider.
+#[async_trait]
+pub trait GitProvider {
+    type Err;
+
+    /// Get the public keys of a user by their username.
+    async fn get_keys_by_username(&self, username: &str) -> Result<Vec<SshPublicKey>, Self::Err>;
+}