rspotify 2.5.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e109369a08f44ff26605781f94c334eabf9adebb
-  data.tar.gz: 052a974c33f640fd724830308517f55a87496f8b
+SHA256:
+  metadata.gz: bd4464a0bd9145130472ed8f8abe11c595e3e5065a44e083d7a41ef26a315dad
+  data.tar.gz: a81d26ab41cfb8ff340eb30a39f6d878503481378757ca4cc480db89c147bd07
 SHA512:
-  metadata.gz: 38acfebceb65b64f604ec374f25798d7c8a825e3ca8b4e04b76c0f51a3c8d60e1ba44d6263cad3422dacbd8b9b58b7fdf28a2d6ee58eae224fb5d4e07d254d22
-  data.tar.gz: dcb54349b342b67acd931ca7ac57e7ef9d02b30d958f56b898db88388aa9407729b1cbead35307142a996346e61ae8f5a05e912f8629947c0cc71293ef3c213c
+  metadata.gz: 23d30c3094d7c243733190ca8e02231159968027a3d3b30eb72c0d8fb0694ecde85bb0b7c3327b86021a624bfa96890f33315d8acb134f67396124068c4bcee2
+  data.tar.gz: ec899b94e25402f6a22ba6e9ecca3be4ced60f763ed4108d3f206d6f054449ce3f6d3b3b1eab4b4cc47053532c3320756d382d5a11bc2c41b966c51fbaf6be3c

data/lib/rspotify/base.rb

@@ -30,7 +30,6 @@ module RSpotify
           warn 'Spotify API does not support finding several users simultaneously'
           return false
         end
-        limit = (type == 'album' ? 20 : 50)
         find_many(ids, type, market: market)
       when String
         id = ids
@@ -126,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
@@ -143,7 +142,7 @@ module RSpotify
         frameborder: 0,
         allowtransparency: true,
         view: nil,
-        theme: nil,
+        theme: nil
       }
       options = default_options.merge(options)
 

data/lib/rspotify/connection.rb

@@ -9,7 +9,7 @@ module RSpotify
   API_URI       = 'https://api.spotify.com/v1/'.freeze
   AUTHORIZE_URI = 'https://accounts.spotify.com/authorize'.freeze
   TOKEN_URI     = 'https://accounts.spotify.com/api/token'.freeze
-  VERBS         = %w(get post put delete)
+  VERBS         = %w[get post put delete].freeze
 
   class << self
     attr_accessor :raw_response

data/lib/rspotify/player.rb

@@ -4,18 +4,19 @@ module RSpotify
     def initialize(user, options = {})
       @user = user
 
-      @repeat_state  = options['repeat_state']
-      @shuffle_state = options['shuffle_state']
-      @progress      = options['progress_ms']
-      @is_playing    = options['is_playing']
+      @repeat_state           = options['repeat_state']
+      @shuffle_state          = options['shuffle_state']
+      @progress               = options['progress_ms']
+      @is_playing             = options['is_playing']
+      @currently_playing_type = options['currently_playing_type']
 
       @track = if options['track']
-                 Track.new options['track']
-               end
+        Track.new options['track']
+      end
 
       @device = if options['device']
-                  Device.new options['device']
-                end
+        Device.new options['device']
+      end
     end
 
     def playing?
@@ -28,7 +29,7 @@ module RSpotify
     # @example
     #           player = user.player
     #           player.play_context(nil,"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT")
-    def play_context(device_id=nil, uri)
+    def play_context(device_id = nil, uri)
       params = {"context_uri": uri}
       play(device_id, params)
     end
@@ -40,7 +41,7 @@ module RSpotify
     #           player = user.player
     #           tracks_uris = ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "spotify:track:1301WleyT98MSxVHPZCA6M"]
     #           player.play_tracks(nil, tracks_uris)
-    def play_tracks(device_id=nil, uris)
+    def play_tracks(device_id = nil, uris)
       params = {"uris": uris}
       play(device_id, params)
     end
@@ -52,7 +53,7 @@ module RSpotify
     #           player = user.player
     #           player.play_track(nil, "spotify:track:4iV5W9uYEdYUVa79Axb7Rh")
     #           # User must be a premium subscriber for this feature to work.
-    def play_track(device_id=nil, uri)
+    def play_track(device_id = nil, uri)
       params = {"uris": [uri]}
       play(device_id, params)
     end
@@ -65,11 +66,31 @@ module RSpotify
     #           player.play
     def play(device_id = nil, params = {})
       url = "me/player/play"
-      url = device_id.nil? ? url : url+"?device_id=#{device_id}"
+      url = device_id.nil? ? url : "#{url}?device_id=#{device_id}"
 
       User.oauth_put(@user.id, url, params.to_json)
     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.
+    #
+    # @see https://developer.spotify.com/documentation/web-api/reference/player/set-repeat-mode-on-users-playback/
+    #
+    # @param [String] device_id the ID of the device to set the repeat state on.
+    # @param [String] state     the repeat state. Defaults to the current play context.
+    #
+    # @example
+    #          player = user.player
+    #          player.repeat(state: 'track')
+    def repeat(device_id: nil, state: "context")
+      url = "me/player/repeat"
+      url += "?state=#{state}"
+      url += "&device_id=#{device_id}" if device_id
+
+      User.oauth_put(@user.id, url, {})
+    end
+
     # Pause the user's currently active player
     #
     # @example
@@ -80,6 +101,26 @@ module RSpotify
       User.oauth_put(@user.id, url, {})
     end
 
+    # Toggle the current user's shuffle status.
+    # If `device_id` is not passed, the currently active spotify app will be triggered.
+    # If `state` is not passed, shuffle mode will be turned on.
+    #
+    # @see https://developer.spotify.com/documentation/web-api/reference/player/toggle-shuffle-for-users-playback/
+    #
+    # @param [String] device_id the ID of the device to set the shuffle state on.
+    # @param [String] state     the shuffle state. Defaults to turning the shuffle behavior on.
+    #
+    # @example
+    #          player = user.player
+    #          player.shuffle(state: false)
+    def shuffle(device_id: nil, state: true)
+      url = "me/player/shuffle"
+      url += "?state=#{state}"
+      url += "&device_id=#{device_id}" if device_id
+
+      User.oauth_put(@user.id, url, {})
+    end
+
     # Skip User’s Playback To Next Track
     #
     # @example

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

data/lib/rspotify/user.rb

@@ -104,6 +104,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 +118,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
@@ -139,14 +145,21 @@ module RSpotify
     # Get the current user’s recently played tracks. Requires the *user-read-recently-played* scope.
     #
     # @param limit  [Integer] Optional. The number of entities to return. Default: 20. Minimum: 1. Maximum: 50.
+    # @param after  [String] Optional. A Unix timestamp in milliseconds. Returns all items after (but not including) this cursor position. If after is specified, before must not be specified.
+    # @param before [String] Optional. A Unix timestamp in milliseconds. Returns all items before (but not including) this cursor position. If before is specified, after must not be specified.
     # @return [Array<Track>]
     #
     # @example
     #           recently_played = user.recently_played
     #           recently_played.size       #=> 20
     #           recently_played.first.name #=> "Ice to Never"
-    def recently_played(limit: 20)
+    #           user.recently_played(limit: 50)
+    #           user.recently_played(after: '1572561234', before: '1572562369')
+    def recently_played(limit: 20, after: nil, before: nil)
       url = "me/player/recently-played?limit=#{limit}"
+      url << "&after=#{after}" if after
+      url << "&before=#{before}" if before
+
       response = RSpotify.resolve_auth_request(@id, url)
       return response if RSpotify.raw_response
 
@@ -300,14 +313,16 @@ module RSpotify
     #
     # @param limit  [Integer] Maximum number of tracks to return. Maximum: 50. Minimum: 1. Default: 20.
     # @param offset [Integer] The index of the first track to return. Use with limit to get the next set of tracks. Default: 0.
+    # @param market [String]  Optional. An {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}.
     # @return [Array<Track>]
     #
     # @example
     #           tracks = user.saved_tracks
     #           tracks.size       #=> 20
     #           tracks.first.name #=> "Do I Wanna Know?"
-    def saved_tracks(limit: 20, offset: 0)
+    def saved_tracks(limit: 20, offset: 0, market: nil)
       url = "me/tracks?limit=#{limit}&offset=#{offset}"
+      url << "&market=#{market}" if market
       response = User.oauth_get(@id, url)
       json = RSpotify.raw_response ? JSON.parse(response) : response
 
@@ -375,14 +390,16 @@ module RSpotify
     #
     # @param limit  [Integer] Maximum number of albums to return. Maximum: 50. Minimum: 1. Default: 20.
     # @param offset [Integer] The index of the first album to return. Use with limit to get the next set of albums. Default: 0.
+    # @param market [String]  Optional. An {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}.
     # @return [Array<Album>]
     #
     # @example
     #           albums = user.saved_albums
     #           albums.size       #=> 20
     #           albums.first.name #=> "Launeddas"
-    def saved_albums(limit: 20, offset: 0)
+    def saved_albums(limit: 20, offset: 0, market: nil)
       url = "me/albums?limit=#{limit}&offset=#{offset}"
+      url << "&market=#{market}" if market
       response = User.oauth_get(@id, url)
       json = RSpotify.raw_response ? JSON.parse(response) : response
 

data/lib/rspotify/version.rb

@@ -1,3 +1,3 @@
 module RSpotify
-  VERSION = '2.5.0'
+  VERSION = '2.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.9.0
 platform: ruby
 authors:
 - Guilherme Sad
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-28 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -136,7 +136,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - gorgulhoguilherme@gmail.com
 executables: []
@@ -260,7 +260,7 @@ homepage: http://rubygems.org/gems/rspotify
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -275,9 +275,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: A ruby wrapper for the Spotify Web API
 test_files:
@@ -368,4 +367,3 @@ test_files:
 - spec/vcr_cassettes/user_find_spotify.yml
 - spec/vcr_cassettes/user_find_wizzler.yml
 - spec/vcr_cassettes/user_wizzler_playlists_limit_20_offset_0.yml
-has_rdoc: