Merge branch 'master' into provider/microsoft

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @torto

Cargo.toml

@@ -30,3 +30,9 @@ name = "discord"
 
 [[example]]
 name = "twitter"
+
+[[example]]
+name = "facebook"
+
+[[example]]
+name = "spotify"

README.md

@@ -13,13 +13,15 @@ To use it, it's very simple. Just create a new instance of some provider:
 - TwitterProvider
 - GoogleProvider
 - MicrosoftProvider
+- FacebookProvider
+- SpotifyProvider
 
 in your project, pass to the `new` function:
 
 - **client_id:** Unique ID from the app created in your provider
 - **secret_id:** Secret token from your app inside the provider, this token needs to be hidden from the users
 - **redirect_url:** URL from your backend that will accept the return from the provider
-  
+
   If you are using **`CustomProvider`** you need to pass:
 
 - **auth_url:** URL from your provider that is used to get the permission of your app access user account
@@ -37,15 +39,15 @@ This step is important because that will generate the VERIFIER field, it is need
 
 ### 2. Callback URL
 
-After the user accepts the auth from the provider, it will redirect the user to the specific URL that you added in the config of the provider ``redirect_url``, and is important to remember that the same URL should be set in the oauth-axum params, if it is not the same an error will happen. 
+After the user accepts the auth from the provider, it will redirect the user to the specific URL that you added in the config of the provider `redirect_url`, and is important to remember that the same URL should be set in the oauth-axum params, if it is not the same an error will happen.
 This redirect will have two query parameters, CODE and STATE, we need to generate a token from the code and verifier fields, which is the reason that in the first step, you need to save the verifier and state together.
 After that, you will have a token to access the API in the provider.
 
 ## Example
 
 This method is for a small project that will run in one unique instance of Axum. It saves the state and verifier in memory, which can be accessible in the callback URL call.
 
-```rust 
+```rust
 mod utils;
 use std::sync::Arc;
 

examples/facebook.rs

@@ -0,0 +1,69 @@
+mod utils;
+use std::sync::Arc;
+
+use axum::extract::Query;
+use axum::Router;
+use axum::{routing::get, Extension};
+use oauth_axum::providers::facebook::FacebookProvider;
+use oauth_axum::{CustomProvider, OAuthClient};
+
+use crate::utils::memory_db_util::AxumState;
+
+#[derive(Clone, serde::Deserialize)]
+pub struct QueryAxumCallback {
+    pub code: String,
+    pub state: String,
+}
+
+#[tokio::main]
+async fn main() {
+    dotenv::from_filename("examples/.env").ok();
+    println!("Starting server...");
+
+    let state = Arc::new(AxumState::new());
+    let app = Router::new()
+        .route("/", get(create_url))
+        .route("/api/v1/facebook/callback", get(callback))
+        .layer(Extension(state.clone()));
+
+    println!("🚀 Server started successfully");
+    let listener = tokio::net::TcpListener::bind("127.0.0.1:3000")
+        .await
+        .unwrap();
+    axum::serve(listener, app).await.unwrap();
+}
+
+fn get_client() -> CustomProvider {
+    FacebookProvider::new(
+        std::env::var("FACEBOOK_CLIENT_ID").expect("FACEBOOK_CLIENT_ID must be set"),
+        std::env::var("FACEBOOK_SECRET").expect("FACEBOOK_SECRET must be set"),
+        "http://localhost:3000/api/v1/facebook/callback".to_string(),
+    )
+}
+
+pub async fn create_url(Extension(state): Extension<Arc<AxumState>>) -> String {
+    let state_oauth = get_client()
+        .generate_url(
+            Vec::from(["public_profile".to_string(), "email".to_string()]),
+            |state_e| async move {
+                state.set(state_e.state, state_e.verifier);
+            },
+        )
+        .await
+        .unwrap()
+        .state
+        .unwrap();
+
+    state_oauth.url_generated.unwrap()
+}
+
+pub async fn callback(
+    Extension(state): Extension<Arc<AxumState>>,
+    Query(queries): Query<QueryAxumCallback>,
+) -> String {
+    println!("{:?}", state.clone().get_all_items());
+    let item = state.get(queries.state.clone());
+    get_client()
+        .generate_token(queries.code, item.unwrap())
+        .await
+}

examples/spotify.rs

@@ -0,0 +1,72 @@
+mod utils;
+use std::sync::Arc;
+
+use axum::extract::Query;
+use axum::Router;
+use axum::{routing::get, Extension};
+use oauth_axum::providers::spotify::SpotifyProvider;
+use oauth_axum::{CustomProvider, OAuthClient};
+
+use crate::utils::memory_db_util::AxumState;
+
+#[derive(Clone, serde::Deserialize)]
+pub struct QueryAxumCallback {
+    pub code: String,
+    pub state: String,
+}
+
+#[tokio::main]
+async fn main() {
+    dotenv::from_filename("examples/.env").ok();
+    println!("Starting server...");
+
+    let state = Arc::new(AxumState::new());
+    let app = Router::new()
+        .route("/", get(create_url))
+        .route("/api/v1/spotify/callback", get(callback))
+        .layer(Extension(state.clone()));
+
+    println!("🚀 Server started successfully");
+    let listener = tokio::net::TcpListener::bind("127.0.0.1:3000")
+        .await
+        .unwrap();
+    axum::serve(listener, app).await.unwrap();
+}
+
+fn get_client() -> CustomProvider {
+    SpotifyProvider::new(
+        std::env::var("SPOTIFY_CLIENT_ID").expect("SPOTIFY_CLIENT_ID must be set"),
+        std::env::var("SPOTIFY_SECRET").expect("SPOTIFY_SECRET must be set"),
+        "http://localhost:3000/api/v1/spotify/callback".to_string(),
+    )
+}
+
+pub async fn create_url(Extension(state): Extension<Arc<AxumState>>) -> String {
+    let state_oauth = get_client()
+        .generate_url(
+            Vec::from([
+                "user-read-email".to_string(),
+                "user-read-private".to_string(),
+            ]),
+            |state_e| async move {
+                state.set(state_e.state, state_e.verifier);
+            },
+        )
+        .await
+        .unwrap()
+        .state
+        .unwrap();
+
+    state_oauth.url_generated.unwrap()
+}
+
+pub async fn callback(
+    Extension(state): Extension<Arc<AxumState>>,
+    Query(queries): Query<QueryAxumCallback>,
+) -> String {
+    println!("{:?}", state.clone().get_all_items());
+    let item = state.get(queries.state.clone());
+    get_client()
+        .generate_token(queries.code, item.unwrap())
+        .await
+}

src/lib.rs

@@ -13,13 +13,15 @@
 //! - TwitterProvider
 //! - GoogleProvider
 //! - MicrosoftProvider
+//! - FacebookProvider
+//! - SpotifyProvider
 //!
 //! in your project, pass to the ```new``` function:
 //!
 //!   - **client_id:** Unique ID from the app created in your provider
 //!   - **secret_id:** Secret token from your app inside the provider, this token needs to be hidden from the users
 //!   - **redirect_url:** URL from your backend that will accept the return from the provider
-//!   
+//!
 //!   If you are using **``CustomProvider``** you need to pass:
 //!
 //!   - **auth_url:** URL from your provider that is used to get the permission of your app access user account

src/providers/facebook.rs

@@ -0,0 +1,15 @@
+use crate::CustomProvider;
+
+pub struct FacebookProvider {}
+
+impl FacebookProvider {
+    pub fn new(client_id: String, client_secret: String, redirect_url: String) -> CustomProvider {
+        CustomProvider::new(
+            String::from("https://www.facebook.com/v19.0/dialog/oauth"),
+            String::from("https://graph.facebook.com/v19.0/oauth/access_token"),
+            client_id,
+            client_secret,
+            redirect_url,
+        )
+    }
+}

src/providers/mod.rs

@@ -1,5 +1,7 @@
 pub mod discord;
+pub mod facebook;
 pub mod github;
 pub mod google;
 pub mod microsoft;
+pub mod spotify;
 pub mod twitter;

src/providers/spotify.rs

@@ -0,0 +1,15 @@
+use crate::CustomProvider;
+
+pub struct SpotifyProvider {}
+
+impl SpotifyProvider {
+    pub fn new(client_id: String, client_secret: String, redirect_url: String) -> CustomProvider {
+        CustomProvider::new(
+            String::from("https://accounts.spotify.com/authorize"),
+            String::from("https://accounts.spotify.com/api/token"),
+            client_id,
+            client_secret,
+            redirect_url,
+        )
+    }
+}