[WIP] Auth restructure

.github/workflows/ci.yml

@@ -43,8 +43,8 @@ jobs:
           - arm-unknown-linux-gnueabihf
           - armv7-unknown-linux-gnueabihf
         client:
-          - client-ureq,ureq-rustls-tls
-          - client-reqwest,reqwest-rustls-tls
+          - rspotify/cli,rspotify/env-file,rspotify/client-ureq,rspotify/ureq-rustls-tls,rspotify-http/client-ureq,rspotify-http/ureq-rustls-tls
+          - rspotify/cli,rspotify/env-file,rspotify/client-reqwest,rspotify/reqwest-rustls-tls,rspotify-http/client-reqwest,rspotify-http/reqwest-rustls-tls
     steps:
       - name: Checkout sources
         uses: actions/checkout@v2
@@ -64,16 +64,16 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: build
-          args: --workspace --target ${{ matrix.target }} --no-default-features --features=cli,env-file,${{ matrix.client }}
+          args: -p rspotify -p rspotify-http -p rspotify-model -p rspotify-macros --no-default-features --features=${{ matrix.client }} --target ${{ matrix.target }} 
 
   test-client:
     name: Test and Lint for each Client
     runs-on: ubuntu-latest
     strategy:
       matrix:
         client:
-          - client-ureq,ureq-rustls-tls
-          - client-reqwest,reqwest-rustls-tls
+          - rspotify/cli,rspotify/env-file,rspotify/client-ureq,rspotify/ureq-rustls-tls,rspotify-http/client-ureq,rspotify-http/ureq-rustls-tls
+          - rspotify/cli,rspotify/env-file,rspotify/client-reqwest,rspotify/reqwest-rustls-tls,rspotify-http/client-reqwest,rspotify-http/reqwest-rustls-tls
     steps:
       - name: Checkout sources
         uses: actions/checkout@v2
@@ -90,32 +90,10 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --workspace --no-default-features --features=cli,env-file,${{ matrix.client }} -- -D warnings
+          args: -p rspotify -p rspotify-http -p rspotify-model -p rspotify-macros --no-default-features --features=${{ matrix.client }} -- -D warnings
 
       - name: Run cargo test
         uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --no-default-features --features=env-file,${{ matrix.client }}
-
-  # The rest of the crates don't need to be tested with multiple feature
-  # combinations.
-  test-crates:
-    name: Simple Tests for Crates
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout sources
-        uses: actions/checkout@v2
-
-      - name: Install stable toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          override: true
-
-      - name: Run cargo test
-        uses: actions-rs/cargo@v1
-        with:
-          command: test
-          args: -p rspotify-macros -p rspotify-model
+          args: -p rspotify -p rspotify-http -p rspotify-model -p rspotify-macros --no-default-features --features=${{ matrix.client }}

Cargo.toml

@@ -1,5 +1,8 @@
 [package]
-authors = ["Ramsay Leung <[email protected]>"]
+authors = [
+    "Ramsay Leung <[email protected]>",
+    "Mario Ortiz Manero <[email protected]>"
+]
 name = "rspotify"
 version = "0.10.0"
 license = "MIT"
@@ -13,7 +16,8 @@ edition = "2018"
 [workspace]
 members = [
     "rspotify-macros",
-    "rspotify-model"
+    "rspotify-model",
+    "rspotify-http"
 ]
 exclude = [
     "examples/webapp"
@@ -25,19 +29,23 @@ resolver = "2"
 [dependencies]
 rspotify-macros = { path = "rspotify-macros", version = "0.10.0" }
 rspotify-model = { path = "rspotify-model", version = "0.10.0" }
+rspotify-http = { path = "rspotify-http", version = "0.10.0", default-features = false }
 
 ### Client ###
 async-stream = { version = "0.3.0", optional = true }
+async-trait = { version = "0.1.48", optional = true }
+base64 = "0.13.0"
 chrono = { version = "0.4.13", features = ["serde", "rustc-serialize"] }
-derive_builder = "0.10.0"
 dotenv = { version = "0.15.0", optional = true }
 futures = { version = "0.3.8", optional = true }
+futures-util = "0.3.8"  # TODO
 getrandom = "0.2.0"
 log = "0.4.11"
 maybe-async = "0.2.1"
 serde = { version = "1.0.115", features = ["derive"] }
 serde_json = "1.0.57"
 thiserror = "1.0.20"
+url = "2.2.2"
 webbrowser = { version = "0.5.5", optional = true }
 
 ### Auth ###
@@ -46,18 +54,6 @@ webbrowser = { version = "0.5.5", optional = true }
 # maybe-async = "0.2.1"
 # thiserror = "1.0.20"
 
-### HTTP ###
-# Temporary until https://github.com/rust-lang/rfcs/issues/2739, for
-# `maybe_async`.
-async-trait = { version = "0.1.48", optional = true }
-base64 = "0.13.0"
-# log = "0.4.11"
-# maybe-async = "0.2.1"
-reqwest = { version = "0.11.0", default-features = false, features = ["json", "socks"], optional = true }
-# thiserror = "1.0.20"
-ureq = { version = "2.0", default-features = false, features = ["json", "cookies"], optional = true }
-url = "2.1.1"
-
 [dev-dependencies]
 env_logger = "0.8.1"
 tokio = { version = "1.0", features = ["rt-multi-thread", "macros"] }
@@ -73,49 +69,44 @@ env-file = ["dotenv"]
 ### HTTP ###
 # Available clients. By default they don't include a TLS so that it can be
 # configured.
-client-ureq = ["ureq", "__sync"]
-client-reqwest = ["reqwest", "__async"]
+client-ureq = ["rspotify-http/client-ureq", "__sync"]
+client-reqwest = ["rspotify-http/client-reqwest", "__async"]
 
 # Passing the TLS features to reqwest.
-reqwest-default-tls = ["reqwest/default-tls"]
-reqwest-rustls-tls = ["reqwest/rustls-tls"]
-reqwest-native-tls = ["reqwest/native-tls"]
-reqwest-native-tls-vendored = ["reqwest/native-tls-vendored"]
+reqwest-default-tls = ["rspotify-http/reqwest-default-tls"]
+reqwest-rustls-tls = ["rspotify-http/reqwest-rustls-tls"]
+reqwest-native-tls = ["rspotify-http/reqwest-native-tls"]
+reqwest-native-tls-vendored = ["rspotify-http/reqwest-native-tls-vendored"]
 # Same for ureq.
-ureq-rustls-tls = ["ureq/tls"]
+ureq-rustls-tls = ["rspotify-http/ureq-rustls-tls"]
 
 # Internal features for checking async or sync compilation
-__async = ["async-trait", "async-stream", "futures"]
+__async = ["futures", "async-stream", "async-trait"]
 __sync = ["maybe-async/is_sync"]
 
 [package.metadata.docs.rs]
 # Also documenting the CLI methods
 features = ["cli"]
 
 [[example]]
-name = "album"
-required-features = ["env-file", "cli", "client-reqwest"]
-path = "examples/album.rs"
-
-[[example]]
-name = "current_user_recently_played"
+name = "client_creds"
 required-features = ["env-file", "cli", "client-reqwest"]
-path = "examples/current_user_recently_played.rs"
+path = "examples/client_creds.rs"
 
 [[example]]
-name = "oauth_tokens"
+name = "auth_code"
 required-features = ["env-file", "cli", "client-reqwest"]
-path = "examples/oauth_tokens.rs"
+path = "examples/auth_code.rs"
 
 [[example]]
-name = "track"
+name = "auth_code_pkce"
 required-features = ["env-file", "cli", "client-reqwest"]
-path = "examples/track.rs"
+path = "examples/auth_code_pkce.rs"
 
 [[example]]
-name = "tracks"
+name = "oauth_tokens"
 required-features = ["env-file", "cli", "client-reqwest"]
-path = "examples/tracks.rs"
+path = "examples/oauth_tokens.rs"
 
 [[example]]
 name = "with_refresh_token"

examples/auth_code.rs

@@ -0,0 +1,55 @@
+use rspotify::{
+    model::{AdditionalType, Country, Market},
+    prelude::*,
+    scopes, AuthCodeSpotify, Credentials, OAuth,
+};
+
+#[tokio::main]
+async fn main() {
+    // You can use any logger for debugging.
+    env_logger::init();
+
+    // Set RSPOTIFY_CLIENT_ID, RSPOTIFY_CLIENT_SECRET and
+    // RSPOTIFY_REDIRECT_URI in an .env file or export them manually:
+    //
+    // export RSPOTIFY_CLIENT_ID="your client_id"
+    // export RSPOTIFY_CLIENT_SECRET="secret"
+    //
+    // These will then be read with `from_env`.
+    //
+    // Otherwise, set client_id and client_secret explictly:
+    //
+    // ```
+    // let creds = Credentials {
+    //     id: "this-is-my-client-id".to_string(),
+    //     secret: "this-is-my-client-secret".to_string()
+    // };
+    // ```
+    let creds = Credentials::from_env().unwrap();
+
+    // Or set the redirect_uri explictly:
+    //
+    // ```
+    // let oauth = OAuth {
+    //     redirect_uri: "http://localhost:8888/callback".to_string(),
+    //     scope: scopes!("user-read-recently-played"),
+    //     ..Default::default(),
+    // };
+    // ```
+    let oauth = OAuth::from_env(scopes!("user-read-currently-playing")).unwrap();
+
+    let mut spotify = AuthCodeSpotify::new(creds, oauth);
+
+    // Obtaining the access token
+    let url = spotify.get_authorize_url(false).unwrap();
+    spotify.prompt_for_token(&url).await.unwrap();
+
+    // Running the requests
+    let market = Market::Country(Country::Spain);
+    let additional_types = [AdditionalType::Episode];
+    let artists = spotify
+        .current_playing(Some(&market), Some(&additional_types))
+        .await;
+
+    println!("Response: {:?}", artists);
+}

examples/auth_code_pkce.rs

@@ -0,0 +1,47 @@
+use rspotify::{prelude::*, scopes, AuthCodePkceSpotify, Credentials, OAuth};
+
+#[tokio::main]
+async fn main() {
+    // You can use any logger for debugging.
+    env_logger::init();
+
+    // Set RSPOTIFY_CLIENT_ID, RSPOTIFY_CLIENT_SECRET and
+    // RSPOTIFY_REDIRECT_URI in an .env file or export them manually:
+    //
+    // export RSPOTIFY_CLIENT_ID="your client_id"
+    // export RSPOTIFY_CLIENT_SECRET="secret"
+    //
+    // These will then be read with `from_env`.
+    //
+    // Otherwise, set client_id and client_secret explictly:
+    //
+    // ```
+    // let creds = Credentials {
+    //     id: "this-is-my-client-id".to_string(),
+    //     secret: "this-is-my-client-secret".to_string()
+    // };
+    // ```
+    let creds = Credentials::from_env().unwrap();
+
+    // Or set the redirect_uri explictly:
+    //
+    // ```
+    // let oauth = OAuth {
+    //     redirect_uri: "http://localhost:8888/callback".to_string(),
+    //     scope: scopes!("user-read-recently-played"),
+    //     ..Default::default(),
+    // };
+    // ```
+    let oauth = OAuth::from_env(scopes!("user-read-recently-played")).unwrap();
+
+    let mut spotify = AuthCodePkceSpotify::new(creds, oauth);
+
+    // Obtaining the access token
+    let url = spotify.get_authorize_url().unwrap();
+    spotify.prompt_for_token(&url).await.unwrap();
+
+    // Running the requests
+    let history = spotify.current_playback(None, None::<Vec<_>>).await;
+
+    println!("Response: {:?}", history);
+}

examples/album.rs → examples/client_creds.rs

@@ -1,6 +1,4 @@
-use rspotify::client::SpotifyBuilder;
-use rspotify::model::Id;
-use rspotify::oauth2::CredentialsBuilder;
+use rspotify::{model::Id, prelude::*, ClientCredsSpotify, Credentials};
 
 #[tokio::main]
 async fn main() {
@@ -17,22 +15,20 @@ async fn main() {
     //
     // Otherwise, set client_id and client_secret explictly:
     //
-    // let creds = CredentialsBuilder::default()
-    //     .client_id("this-is-my-client-id")
-    //     .client_secret("this-is-my-client-secret")
-    //     .build()
-    //     .unwrap();
-    let creds = CredentialsBuilder::from_env().build().unwrap();
+    // ```
+    // let creds = Credentials {
+    //     id: "this-is-my-client-id".to_string(),
+    //     secret: "this-is-my-client-secret".to_string()
+    // };
+    // ```
+    let creds = Credentials::from_env().unwrap();
 
-    let mut spotify = SpotifyBuilder::default()
-        .credentials(creds)
-        .build()
-        .unwrap();
+    let mut spotify = ClientCredsSpotify::new(creds);
 
     // Obtaining the access token. Requires to be mutable because the internal
     // token will be modified. We don't need OAuth for this specific endpoint,
     // so `...` is used instead of `prompt_for_user_token`.
-    spotify.request_client_token().await.unwrap();
+    spotify.request_token().await.unwrap();
 
     // Running the requests
     let birdy_uri = Id::from_uri("spotify:album:0sNOF9WDwhWunNAHPD3Baj").unwrap();