rspotify 2.9.2 → 2.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c165c5081e4cca893c47dc2cd8f4f14575ab64aee6afd554124c3b0b36f3d9b6
-  data.tar.gz: 851456edf9def81e75378588216daf83145afbc4aa5ea53d6f3efdb75bff3d73
+  metadata.gz: 95783cbdc5ca066a1454219ff9afd451ee730efa2f65547c3694b7e06ae71893
+  data.tar.gz: dfb2ba9eee5180070d7fb000ab1c832a5ff6f8adea379f6598fca967f96da53a
 SHA512:
-  metadata.gz: f060beaba6b8c8995b23952d503703943dd89d765f4c23224dc7a4a05d34849f30a4ab551aea64c0f9bbd193014d524dd593f99cb5a9099a4c71084ecce8e3b0
-  data.tar.gz: 3b877fc32c3ec4caf9aa31c72e7b4541e4b0bd432469e74ec6b33765eea1c90fa005bfc478dd70152b0da9260b98699c756541397fa1686d9bdc9d6f6de77607
+  metadata.gz: ec01dac8afbd2c6411b31c9df4fd8eac38d6ce5fa468f9e7bb49a8297d64bf9b852220de763258c5d3af0f3e0341166279a116d7667d274cf5b45914f2fe03bb
+  data.tar.gz: '09b20a9b1d6becae29c27050213aa55f49408e44575f7669875a0a3a28ca9659e09488459ec9b39466255479d4143959f92ae3071cccf5c54e5c98d643b77b6f'

data/README.md

@@ -217,7 +217,40 @@ class UsersController < ApplicationController
 end
 ```
 
-The user's access token is automatically refreshed by RSpotify when needed. This is specially useful if you persist the user data on a database: this way he only needs to log in to Spotify once in his entire use of your application.
+## Refreshing the access token
+
+The user's access token is automatically refreshed by RSpotify when needed. This is especially useful if you persist
+the user data on a database. This way, the user only need log in to Spotify once during the use of the application.
+
+Additionally, you can store a proc that is invoked when a new access token is generated. This give you the
+opportunity to persist the new access token for future use. The proc will be invoked with two arguments: the
+new access token and the lifetime of the token in seconds. For example, if lifetime value returned from
+Spotify is 3600, you know that the token will be good for one hour.
+
+In the sample code below, the credentials have been retrieved from some persistent store such as
+AWS SecretsManager.
+
+```ruby
+
+callback_proc = Proc.new { |new_access_token, token_lifetime |
+   now = Time.now.utc.to_i  # seconds since 1/1/1970, midnight UTC
+   deadline = now+token_lifetime
+   #puts("new access token will expire at #{Time.at(deadline).utc.to_s}")
+   self.save_new_access_token(new_access_token)
+ }
+
+spotify_user = RSpotify::User.new(
+  {
+    'credentials' => {
+       "token" => self.credentials["access_token"],
+       "refresh_token" => self.credentials["refresh_token"],
+       "access_refresh_callback" => callback_proc
+    } ,
+    'id' => self.credentials["user_id"]
+  })
+
+
+```
 
 RSpotify provides a way to facilitate persistence:
 
@@ -232,6 +265,7 @@ spotify_user = RSpotify::User.new(hash)
 spotify_user.create_playlist!('my_awesome_playlist') # automatically refreshes token
 ```
 
+
 ## Getting raw response
 
 To get the raw response from Spotify API requests, just toggle the `raw_response` variable:

data/lib/rspotify/oauth.rb

@@ -18,6 +18,11 @@ module OmniAuth
       def raw_info
         @raw_info ||= access_token.get('me').parsed
       end
+      
+      # Fix for: https://github.com/guilhermesad/rspotify/issues/189
+      def callback_url
+        full_host + script_name + callback_path
+      end
     end
   end
 end

data/lib/rspotify/player.rb

@@ -73,6 +73,21 @@ module RSpotify
       User.oauth_put(@user.id, url, params.to_json)
     end
 
+    # Add an item to the end of the user’s current playback queue
+    # If `device_id` is not passed, the currently active spotify app will be triggered
+    # 
+    # @param [String] device_id the ID of the device to set the repeat state on.
+    # @param [String] uri       the spotify uri of the track to be queued
+    #
+    # @example
+    #           player = user.player
+    #           player.queue("spotify:track:4iV5W9uYEdYUVa79Axb7Rh")
+    def queue(device_id = nil, uri)
+      url = "me/player/queue?uri=#{uri}"
+      url = device_id.nil? ? url : "#{url}&device_id=#{device_id}"
+      User.oauth_post(@user.id, url, {})
+    end
+
     # Toggle the current user's player repeat status.
     # If `device_id` is not passed, the currently active spotify app will be triggered.
     # If `state` is not passed, the currently active context will be set to repeat.

data/lib/rspotify/playlist.rb

@@ -315,7 +315,7 @@ module RSpotify
 
       params = {
         method: :delete,
-        url: URI::encode(RSpotify::API_URI + @path + '/tracks'),
+        url: Addressable::URI.encode(RSpotify::API_URI + @path + '/tracks'),
         headers: User.send(:oauth_header, @owner.id),
         payload: positions ? { positions: positions } : { tracks: tracks }
       }

data/lib/rspotify/user.rb

@@ -38,6 +38,16 @@ module RSpotify
       response = RestClient.post(TOKEN_URI, request_body, RSpotify.send(:auth_header))
       response = JSON.parse(response)
       @@users_credentials[user_id]['token'] = response['access_token']
+      access_refresh_proc = @@users_credentials[user_id]['access_refresh_callback']
+      # If the access token expires and a new one is granted via the refresh
+      # token, then this proc will be called with two parameters:
+      # new_access_token and token_lifetime (in seconds)
+      # The purpose is to allow the calling environment to invoke some action,
+      # such as persisting the new access token somewhere, when the new token
+      # is generated.
+      if (access_refresh_proc.respond_to? :call)
+        access_refresh_proc.call(response['access_token'], response['expires_in'])
+      end
     rescue RestClient::BadRequest => e
       raise e if e.response !~ /Refresh token revoked/
     end

data/lib/rspotify/version.rb

@@ -1,3 +1,3 @@
 module RSpotify
-  VERSION = '2.9.2'.freeze
+  VERSION = '2.10.3'.freeze
 end

data/rspotify.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^spec\//)
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'omniauth-oauth2', '~> 1.5.0'
+  spec.add_dependency 'omniauth-oauth2', '>= 1.6'
   spec.add_dependency 'rest-client', '~> 2.0.2'
   spec.add_dependency 'addressable', '~> 2.5.2'
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 2.9.2
+  version: 2.10.3
 platform: ruby
 authors:
 - Guilherme Sad
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-23 00:00:00.000000000 Z
+date: 2021-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement