rspotify 2.8.0 → 2.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc84ae149d3f5b010bdbcb003b757f62f59c3a1deaac10de9ce6c56d0cf0380
-  data.tar.gz: e138e3f06dca550ffe532fc602916de472cbbc2bf7da823ebd34b5cd1ff38c52
+  metadata.gz: d19f6d23158c4ece9b8ede71d1b0ed2ed71598baad04895b62dc209f0147f556
+  data.tar.gz: 0c3b328c9b8f3ff4d87041c0d749fef09689bf922b4f7f4c9f5aa958a2d27587
 SHA512:
-  metadata.gz: f5bcfac52c8847d66d6ee5847194fdedf8540fade7e17a2a42b3357f4aac2cf416292dcc049a8fc25ca9ad596f83aef7b490a95c347be1a7cd58247a9309bce0
-  data.tar.gz: afd9f4b87df52ed78102be3b78202261e6838ae88cac00241683c21496530dcfefbfd181554f82042e507c8450443e2976f1e053062f04844cf58a90385f90fe
+  metadata.gz: 636252d2d8d95caf3f8b07187b97fcefe22f6e6a052400d48ab200c2db47451934e37e7c4b25aa08bfddf1c0c1daf6b61fc7b0f2af19e54f25edcc0836da8731
+  data.tar.gz: fed825f00b36af6c3c9e2df6a6312b09219ea6d68b8136085b13ddcfa0764b747b1489a7afb1d73236a769f2fe1571617c49d709e199f7e58f1990a9bb4272e9

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+custom: https://www.buymeacoffee.com/guilhermesad

data/Gemfile

@@ -1,3 +1,3 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec

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/base.rb

@@ -125,9 +125,9 @@ module RSpotify
 
     # Generate an embed code for an album, artist or track.
     # @param [Hash] options
-    # @option options [Fixnum] :width the width of the frame
-    # @option options [Fixnum] :height the height of the frame
-    # @option options [Fixnum] :frameborder the frameborder of the frame
+    # @option options [Integer] :width the width of the frame
+    # @option options [Integer] :height the height of the frame
+    # @option options [Integer] :frameborder the frameborder of the frame
     # @option options [Boolean] :allowtransparency toggle frame transparency
     # @option options [nil|String|Symbol] :view specific view option for iframe
     # @option options [nil|String|Symbol] :theme specific theme option for iframe

data/lib/rspotify/connection.rb

@@ -67,7 +67,7 @@ module RSpotify
       rescue RestClient::Unauthorized => e
         raise e if request_was_user_authenticated?(*params)
 
-        raise MissingAuthentication unless @client_token
+        raise MissingAuthentication unless @client_id && @client_secret
 
         authenticate(@client_id, @client_secret)
 

data/lib/rspotify/player.rb

@@ -9,6 +9,8 @@ module RSpotify
       @progress               = options['progress_ms']
       @is_playing             = options['is_playing']
       @currently_playing_type = options['currently_playing_type']
+      @context_type           = options.dig('context', 'type')
+      @context_uri            = options.dig('context', 'uri')
 
       @track = if options['track']
         Track.new options['track']
@@ -71,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

@@ -303,7 +303,7 @@ module RSpotify
     #           positions = [0,3,8]
     #           playlist.remove_tracks!(positions, snapshot_id: '0ZvtH...')
     def remove_tracks!(tracks, snapshot_id: nil)
-      positions = tracks if tracks.first.is_a? Fixnum
+      positions = tracks if tracks.first.is_a? Integer
 
       tracks = tracks.map do |track|
         next { uri: track.uri } if track.is_a? Track
@@ -390,7 +390,7 @@ module RSpotify
     def replace_tracks!(tracks)
       track_uris = tracks.map(&:uri).join(',')
       url = "#{@path}/tracks?uris=#{track_uris}"
-      User.oauth_put(@owner.id, url, {})
+      User.oauth_put(@owner.id, url, {}.to_json)
 
       @total = tracks.size
       @tracks_cache = nil

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
@@ -104,6 +114,8 @@ module RSpotify
     # Creates a playlist in user's Spotify account. This method is only available when the current
     # user has granted access to the *playlist-modify-public* and *playlist-modify-private* scopes.
     #
+    # @note To create a collaborative playlist the public option must be set to false.
+    #
     # @param name [String] The name for the new playlist
     # @param public [Boolean] Whether the playlist is public or private. Default: true
     # @return [Playlist]
@@ -116,10 +128,14 @@ module RSpotify
     #           playlist = user.create_playlist!('my-second-playlist', public: false)
     #           playlist.name   #=> "my-second-playlist"
     #           playlist.public #=> false
-    def create_playlist!(name, public: true)
+    def create_playlist!(name, description: nil, public: true, collaborative: false)
       url = "users/#{@id}/playlists"
-      request_data = { name: name, public: public }.to_json
-
+      request_data = {
+        name: name,
+        public: public,
+        description: description,
+        collaborative: collaborative
+      }.to_json
       response = User.oauth_post(@id, url, request_data)
       return response if RSpotify.raw_response
       Playlist.new response
@@ -133,7 +149,7 @@ module RSpotify
       url = "me/player"
       response = User.oauth_get(@id, url)
       return response if RSpotify.raw_response
-      response.present? ? Player.new(self, response) : nil
+      response ? Player.new(self, response) : Player.new(self)
     end
 
     # Get the current user’s recently played tracks. Requires the *user-read-recently-played* scope.

data/lib/rspotify/version.rb

@@ -1,3 +1,3 @@
 module RSpotify
-  VERSION = '2.8.0'.freeze
+  VERSION = '2.10.1'.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.8.0
+  version: 2.10.1
 platform: ruby
 authors:
 - Guilherme Sad
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-27 00:00:00.000000000 Z
+date: 2020-12-03 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
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - gorgulhoguilherme@gmail.com
 executables: []
@@ -144,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -260,7 +261,7 @@ homepage: http://rubygems.org/gems/rspotify
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -276,7 +277,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A ruby wrapper for the Spotify Web API
 test_files: