rspotify 2.10.0 → 2.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2f3f63fb69d7fdea96a15bab0671af1bf613156372db785367769cd0ef57e5f
-  data.tar.gz: 84de02a228ae2466a06115d51cbee51a5e305249b2ee41966ff526101557e525
+  metadata.gz: d19f6d23158c4ece9b8ede71d1b0ed2ed71598baad04895b62dc209f0147f556
+  data.tar.gz: 0c3b328c9b8f3ff4d87041c0d749fef09689bf922b4f7f4c9f5aa958a2d27587
 SHA512:
-  metadata.gz: c62e8935afb2c34db840a322d225be296b6be4b39011f4f7e42eeaabe0f8b4fde08ed1c6ba26d66fe10127988e5ac799e3facceffb4799cec5044b0adbd91a32
-  data.tar.gz: e68cede2897703d01e27fd9ce6154fc9a6dca1a39540c905f66449acc1c8c2a95b47af132689019095be90f01678de21acd6fbd323405b0c8a16a4e88da574ba
+  metadata.gz: 636252d2d8d95caf3f8b07187b97fcefe22f6e6a052400d48ab200c2db47451934e37e7c4b25aa08bfddf1c0c1daf6b61fc7b0f2af19e54f25edcc0836da8731
+  data.tar.gz: fed825f00b36af6c3c9e2df6a6312b09219ea6d68b8136085b13ddcfa0764b747b1489a7afb1d73236a769f2fe1571617c49d709e199f7e58f1990a9bb4272e9

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/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.10.0'.freeze
+  VERSION = '2.10.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.10.1
 platform: ruby
 authors:
 - Guilherme Sad
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2