Fix refreshing token

.github/workflows/publish.yaml

@@ -0,0 +1,29 @@
+on:
+  create:
+    tags:
+      - v*
+
+name: Publish Crate
+
+jobs:
+  publish:
+    name: Deploy a new version of Rspotify to crate.io
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Install Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          override: true
+
+      - name: Release
+        env:
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
+        shell: bash
+        run: |
+          # Publishing crates
+          "${GITHUB_WORKSPACE}/tools/publish.sh"

CHANGELOG.md

@@ -187,15 +187,16 @@ More in the [`examples` directory](https://github.com/ramsayleung/rspotify/tree/
 - The `Spotify` client has been split up by authorization flows (`ClientCredsSpotify`, `AuthCodeSpotify`, `AuthCodePkceSpotify`), which allows us to remove the builder pattern. The authentication process has been rewritten. ([#216](https://github.com/ramsayleung/rspotify/pull/216)).
 - Fix typo in `user_playlist_remove_specific_occurrenes_of_tracks`, now it's `user_playlist_remove_specific_occurrences_of_tracks`.
 - ([#123](https://github.com/ramsayleung/rspotify/pull/123)) All fallible calls in the client return a `ClientError` rather than using `failure`.
-- ([#161](https://github.com/ramsayleung/rspotify/pull/161)) Endpoints taking `Vec<String>/&[String]` as parameter have changed to `impl IntoIterator<Item = &Id<Type>>`.
-  + The endpoints which changes parameter from `Vec<String>` to `impl IntoIterator<Item = &Id<Type>>`:
+- ([#244](https://github.com/ramsayleung/rspotify/pull/244)) Model objects like `FullTrack` or `AudioFeatures` have had their `_type` and `uri` fields removed. These can be accessed instead with the `id` field: `id._type()` or `id.uri()`.
+- ([#244](https://github.com/ramsayleung/rspotify/pull/244)) Endpoints taking `Vec<String>/&[String]` as parameter have changed to `impl IntoIterator<Item = &Id>`.
+  + The endpoints which changes parameter from `Vec<String>` to `impl IntoIterator<Item = &Id>`:
 	- `albums`
 	- `artists`
 	- `check_users_saved_shows`
 	- `get_several_episodes`
 	- `remove_users_saved_shows`
 	- `save_shows`
-  + The endpoints which changes parameter from `&[String]` to `impl IntoIterator<Item = &Id<Type>>`:
+  + The endpoints which changes parameter from `&[String]` to `impl IntoIterator<Item = &Id>`:
 	- `audios_features`
 	- `current_user_saved_albums_add`
 	- `current_user_saved_albums_contains`
@@ -211,7 +212,7 @@ More in the [`examples` directory](https://github.com/ramsayleung/rspotify/tree/
 	- `user_playlist_replace_tracks`
 	- `user_unfollow_artists`
 	- `user_unfollow_users`
-  + The endpoints which changes parameter from `String` to `&Id<Type>`:
+  + The endpoints which changes parameter from `String` to `&Id`:
         - `get_a_show`
         - `get_an_episode`
         - `get_shows_episodes`
@@ -226,6 +227,7 @@ More in the [`examples` directory](https://github.com/ramsayleung/rspotify/tree/
 - ([#128](https://github.com/ramsayleung/rspotify/pull/128)) Refactor all enum files with `strum`, reduced boilerplate code.
    + All enums don't have a method named `as_str()` anymore, by leveraging `strum`, it's easy to convert strings to enum variants based on their name, with method `as_ref()`.
 - Fix typo in `transfer_playback`: `device_id` to `device_ids`.
+- ([#249](https://github.com/ramsayleung/rspotify/pull/249)) The `recommendations` endpoint has been made simpler to use; the attributes are now serialized with `RecommendationsAttribute`.
 - ([#145](https://github.com/ramsayleung/rspotify/pull/145)) Refactor models to make it easier to use:
   + Changed type of `track` in `PlayHistory` to `FullTrack` ([#139](https://github.com/ramsayleung/rspotify/pull/139)).
   + Rename model `CurrentlyPlaybackContext` to `CurrentPlaybackContext`
@@ -245,7 +247,7 @@ More in the [`examples` directory](https://github.com/ramsayleung/rspotify/tree/
   + Change `{FullArtist, FullPlaylist, PublicUser, PrivateUser}::followers` from `HashMap<String, Option<Value>>` to struct `Followers`
   + Replace `Actions::disallows` with a `Vec<DisallowKey>` by removing all entires whose value is false, which will result in a simpler API
   + Replace `{FullAlbum, SimplifiedEpisode, FullEpisode}::release_date_precision` from `String` to `DatePrecision` enum, makes it easier to use.
-  + Id and URI parameters are type-safe now everywhere, `Id<Type>` and `IdBuf<Type>` types for ids/URIs added (non-owning and owning structs).
+  + Id and URI parameters are type-safe now everywhere thanks to the `Id` trait and its implementations.
 - ([#157](https://github.com/ramsayleung/rspotify/pull/157)) Keep polishing models to make it easier to use:
   + Constrain visibility of `FullArtists` struct with `pub (in crate)`, make `artists` and `artist_related_artists` endpoints return a `Vec<FullArtist>` instead.
   + Constrain visibility of `FullTracks` struct with `pub (in crate)`, make `tracks` and `artist_top_tracks` endpoints return a `Vec<FullTrack>` instead.

Cargo.toml

@@ -31,33 +31,25 @@ 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 }
+async-stream = { version = "0.3.2", optional = true }
+async-trait = { version = "0.1.51", optional = true }
 base64 = "0.13.0"
-chrono = { version = "0.4.13", features = ["serde", "rustc-serialize"] }
+chrono = { version = "0.4.19", features = ["serde", "rustc-serialize"] }
 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"
+futures = { version = "0.3.17", optional = true }
+getrandom = "0.2.3"
+log = "0.4.14"
+maybe-async = "0.2.6"
+serde = { version = "1.0.130", default-features = false }
+serde_json = "1.0.67"
+thiserror = "1.0.29"
 url = "2.2.2"
 webbrowser = { version = "0.5.5", optional = true }
 
-### Auth ###
-# chrono = { version = "0.4.13", features = ["serde", "rustc-serialize"] }
-# log = "0.4.11"
-# maybe-async = "0.2.1"
-# thiserror = "1.0.20"
-
 [dev-dependencies]
-env_logger = "0.9.0"
-tokio = { version = "1.0", features = ["rt-multi-thread", "macros"] }
-futures-util = "0.3.8"
+env_logger = { version = "0.9.0", default-features = false }
+tokio = { version = "1.11.0", features = ["rt-multi-thread", "macros"] }
+futures-util = "0.3.17"
 
 [features]
 default = ["client-reqwest", "reqwest-default-tls"]

examples/client_creds.rs

@@ -1,4 +1,4 @@
-use rspotify::{model::Id, prelude::*, ClientCredsSpotify, Credentials};
+use rspotify::{model::AlbumId, prelude::*, ClientCredsSpotify, Credentials};
 
 #[tokio::main]
 async fn main() {
@@ -23,16 +23,16 @@ async fn main() {
     // ```
     let creds = Credentials::from_env().unwrap();
 
-    let mut spotify = ClientCredsSpotify::new(creds);
+    let 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_token().await.unwrap();
 
     // Running the requests
-    let birdy_uri = Id::from_uri("spotify:album:0sNOF9WDwhWunNAHPD3Baj").unwrap();
-    let albums = spotify.album(birdy_uri).await;
+    let birdy_uri = AlbumId::from_uri("spotify:album:0sNOF9WDwhWunNAHPD3Baj").unwrap();
+    let albums = spotify.album(&birdy_uri).await;
 
     println!("Response: {:#?}", albums);
 }

examples/oauth_tokens.rs

@@ -43,7 +43,7 @@ async fn main() {
     let url = spotify.get_authorize_url(false).unwrap();
     spotify.prompt_for_token(&url).await.unwrap();
 
-    let token = spotify.get_token().await;
+    let token = spotify.token.lock().await.unwrap();
     println!("Access token: {}", token.as_ref().unwrap().access_token);
     println!(
         "Refresh token: {}",

examples/ureq/threading.rs

@@ -1,7 +1,7 @@
 //! This example showcases how the Rspotify client can be used to perform
 //! multithreaded requests as well.
 
-use rspotify::{model::Id, prelude::*, ClientCredsSpotify, Credentials};
+use rspotify::{model::AlbumId, prelude::*, ClientCredsSpotify, Credentials};
 use std::{
     sync::{mpsc::channel, Arc},
     thread,
@@ -12,10 +12,11 @@ fn main() {
 
     let spotify = ClientCredsSpotify::new(creds);
     let ids = [
-        Id::from_uri("spotify:album:0sNOF9WDwhWunNAHPD3Baj").unwrap(),
-        Id::from_uri("spotify:album:5EBb7SSkPgxO9Lmt8NjAPT").unwrap(),
-        Id::from_uri("spotify:album:3jtOeny1Xh5fp6aSOHahe2").unwrap(),
+        AlbumId::from_uri("spotify:album:0sNOF9WDwhWunNAHPD3Baj").unwrap(),
+        AlbumId::from_uri("spotify:album:5EBb7SSkPgxO9Lmt8NjAPT").unwrap(),
+        AlbumId::from_uri("spotify:album:3jtOeny1Xh5fp6aSOHahe2").unwrap(),
     ];
+    let num_ids = ids.len();
     let mut handles = Vec::new();
     let (wr, rd) = channel();
 
@@ -27,14 +28,14 @@ fn main() {
         let spotify = Arc::clone(&spotify);
         let wr = wr.clone();
         let handle = thread::spawn(move || {
-            let albums = spotify.album(id).unwrap();
+            let albums = spotify.album(&id).unwrap();
             wr.send(albums).unwrap();
         });
 
         handles.push(handle);
     }
 
-    for _ in ids {
+    for _ in 0..num_ids {
         let album = rd.recv().unwrap();
         println!("Album: {}", album.name);
     }

examples/with_auto_reauth.rs

@@ -83,6 +83,7 @@ async fn main() {
         .await
         .lock()
         .await
+        .unwrap()
         .as_mut()
         .map(|x| x.expires_at = Some(now.clone()));
     println!(">>> Session two, the token should expire, then re-auth automatically");
@@ -104,8 +105,9 @@ async fn main() {
         .await
         .lock()
         .await
+        .unwrap()
         .as_mut()
-        .map(|x| x.expires_at.replace(now));
+        .map(|x| x.expires_at = Some(now));
     println!(">>> New Session two from ClientCredsSpotify, expiring the token and then re-auth automatically");
     client_creds_do_things(&spotify).await;
 }

examples/with_refresh_token.rs

@@ -15,18 +15,18 @@
 //! tokens](https://github.com/felix-hilden/tekore/issues/86), so in the case of
 //! Spotify it doesn't seem to revoke them at all.
 
-use rspotify::{model::Id, prelude::*, scopes, AuthCodeSpotify, Credentials, OAuth};
+use rspotify::{model::ArtistId, prelude::*, scopes, AuthCodeSpotify, Credentials, OAuth};
 
 // Sample request that will follow some artists, print the user's
 // followed artists, and then unfollow the artists.
 async fn do_things(spotify: AuthCodeSpotify) {
-    let artists = vec![
-        Id::from_id("3RGLhK1IP9jnYFH4BRFJBS").unwrap(), // The Clash
-        Id::from_id("0yNLKJebCb8Aueb54LYya3").unwrap(), // New Order
-        Id::from_id("2jzc5TC5TVFLXQlBNiIUzE").unwrap(), // a-ha
+    let artists = [
+        &ArtistId::from_id("3RGLhK1IP9jnYFH4BRFJBS").unwrap(), // The Clash
+        &ArtistId::from_id("0yNLKJebCb8Aueb54LYya3").unwrap(), // New Order
+        &ArtistId::from_id("2jzc5TC5TVFLXQlBNiIUzE").unwrap(), // a-ha
     ];
     spotify
-        .user_follow_artists(artists.clone())
+        .user_follow_artists(artists)
         .await
         .expect("couldn't follow artists");
     println!("Followed {} artists successfully.", artists.len());
@@ -42,7 +42,7 @@ async fn do_things(spotify: AuthCodeSpotify) {
     );
 
     spotify
-        .user_unfollow_artists(artists.clone())
+        .user_unfollow_artists(artists)
         .await
         .expect("couldn't unfollow artists");
     println!("Unfollowed {} artists successfully.", artists.len());

rspotify-http/Cargo.toml

@@ -18,20 +18,15 @@ rspotify-model = { path = "../rspotify-model", version = "0.10.0" }
 
 # 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"
-futures = { version = "0.3.8", optional = true }
-log = "0.4.11"
-maybe-async = "0.2.4"
-reqwest = { version = "0.11.0", default-features = false, features = ["json", "socks"], optional = true }
-serde_json = "1.0.57"
-thiserror = "1.0.20"
-ureq = { version = "2.0", default-features = false, features = ["json", "cookies"], optional = true }
-url = "2.2.2"
+async-trait = { version = "0.1.51", optional = true }
+log = "0.4.14"
+maybe-async = "0.2.6"
+serde_json = "1.0.67"
+thiserror = "1.0.29"
 
-[dev-dependencies]
-env_logger = "0.9.0"
-tokio = { version = "1.0", features = ["rt-multi-thread", "macros"] }
+# Supported clients
+reqwest = { version = "0.11.4", default-features = false, features = ["json", "socks"], optional = true }
+ureq = { version = "2.2.0", default-features = false, features = ["json", "cookies"], optional = true }
 
 [features]
 default = ["client-reqwest", "reqwest-default-tls"]
@@ -50,5 +45,5 @@ reqwest-native-tls-vendored = ["reqwest/native-tls-vendored"]
 ureq-rustls-tls = ["ureq/tls"]
 
 # Internal features for checking async or sync compilation
-__async = ["async-trait", "futures"]
+__async = ["async-trait"]
 __sync = ["maybe-async/is_sync"]

rspotify-macros/Cargo.toml

@@ -14,4 +14,4 @@ keywords = ["spotify", "api", "rspotify"]
 edition = "2018"
 
 [dev-dependencies]
-serde_json = "1.0.57"
+serde_json = "1.0.67"

rspotify-model/Cargo.toml

@@ -14,10 +14,9 @@ keywords = ["spotify", "api", "rspotify"]
 edition = "2018"
 
 [dependencies]
-chrono = { version = "0.4.13", features = ["serde", "rustc-serialize"] }
-serde = { version = "1.0.115", features = ["derive"] }
-strum = { version = "0.21", features = ["derive"] }
-thiserror = "1.0.20"
+chrono = { version = "0.4.19", features = ["serde", "rustc-serialize"] }
+serde = { version = "1.0.130", features = ["derive"] }
+serde_json = "1.0.67"
+strum = { version = "0.21.0", features = ["derive"] }
+thiserror = "1.0.29"
 
-[dev-dependencies]
-serde_json = "1.0.57"

rspotify-model/src/album.rs

@@ -5,12 +5,10 @@ use serde::{Deserialize, Serialize};
 
 use std::collections::HashMap;
 
-use super::artist::SimplifiedArtist;
-use super::image::Image;
-use super::page::Page;
-use super::track::SimplifiedTrack;
-use super::Restriction;
-use crate::{AlbumType, Copyright, DatePrecision, Type};
+use crate::{
+    AlbumId, AlbumType, Copyright, DatePrecision, Image, Page, RestrictionReason, SimplifiedArtist,
+    SimplifiedTrack,
+};
 
 /// Simplified Album Object
 ///
@@ -25,7 +23,7 @@ pub struct SimplifiedAlbum {
     pub available_markets: Vec<String>,
     pub external_urls: HashMap<String, String>,
     pub href: Option<String>,
-    pub id: Option<String>,
+    pub id: Option<AlbumId>,
     pub images: Vec<Image>,
     pub name: String,
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -34,9 +32,6 @@ pub struct SimplifiedAlbum {
     pub release_date_precision: Option<String>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub restrictions: Option<Restriction>,
-    #[serde(rename = "type")]
-    pub _type: Type,
-    pub uri: Option<String>,
 }
 
 /// Full Album Object
@@ -52,16 +47,13 @@ pub struct FullAlbum {
     pub external_urls: HashMap<String, String>,
     pub genres: Vec<String>,
     pub href: String,
-    pub id: String,
+    pub id: AlbumId,
     pub images: Vec<Image>,
     pub name: String,
     pub popularity: u32,
     pub release_date: String,
     pub release_date_precision: DatePrecision,
     pub tracks: Page<SimplifiedTrack>,
-    #[serde(rename = "type")]
-    pub _type: Type,
-    pub uri: String,
 }
 
 /// Full Albums wrapped by Vec object
@@ -88,3 +80,11 @@ pub struct SavedAlbum {
     pub added_at: DateTime<Utc>,
     pub album: FullAlbum,
 }
+
+/// Album restriction object
+///
+/// [Reference](https://developer.spotify.com/documentation/web-api/reference/#object-albumrestrictionobject)
+#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
+pub struct Restriction {
+    pub reason: RestrictionReason,
+}