rspotify 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1082adbe732bf14bc527e73ba174a6f6ff13af16
-  data.tar.gz: 2d82ce44c497c38d87f1c37d21164f0d355ed3b4
+  metadata.gz: d7a369b00096dcefd7060c3d6d802dbd84c47891
+  data.tar.gz: 72766cf26e96b3cb2fe24df568b70a64d5683021
 SHA512:
-  metadata.gz: be541f01c62b9c4185a116bcd04c52b9becde49cd5616dcd7ea02f9a9d56be7651f3bfc5bc83c88f10fba09a1e681b68cae9482bcea187f3d0bb289291a20802
-  data.tar.gz: 479718f76a3c2e38e319ff53087a41f4d0f4a9ff5e5b9303655a80646addaddcdde7ba54bafdf2fe154537364ca5bc1a5a2d7949a9793275ab0c948cc2cafee0
+  metadata.gz: b0b1c1b3a0e4651cb1fdf10c158f1ce89276450294dd18799fd72ed7006598c12f39b9220cf0a985a8e92752f37d2815ff2567f0fa7c85f5d5caa709716fe838
+  data.tar.gz: 8c15b7aa0844acd020380670247505ae83bff813062c12918cab4a43a1595c85921dc1f3ee711eab3575b9dc744bcb6873138e62cfb7362fbd098a42cc7f2907

data/lib/rspotify/album.rb

@@ -44,8 +44,8 @@ module RSpotify
     def self.new_releases(limit: 20, offset: 0, country: nil)
       url = "browse/new-releases?limit=#{limit}&offset=#{offset}"
       url << "&country=#{country}" if country
-      json = RSpotify.get(url)
-      json['albums']['items'].map { |i| Album.new i }
+      response = RSpotify.get(url)
+      response['albums']['items'].map { |i| Album.new i }
     end
 
     # Returns array of Album objects matching the query, ordered by popularity. It's also possible to find the total number of search results for the query
@@ -105,8 +105,8 @@ module RSpotify
       end
 
       url = "albums/#{@id}/tracks?limit=#{limit}&offset=#{offset}"
-      json = RSpotify.get(url)
-      tracks = json['items'].map { |i| Track.new i }
+      response = RSpotify.get(url)
+      tracks = response['items'].map { |i| Track.new i }
       @tracks_cache = tracks if limit == 50 && offset == 0
       tracks
     end

data/lib/rspotify/artist.rb

@@ -16,7 +16,7 @@ module RSpotify
     #           artist = RSpotify::Artist.find('7Ln80lUS6He07XvHI8qqHH')
     #           artist.class #=> RSpotify::Artist
     #           artist.name  #=> "Arctic Monkeys"
-    #           
+    #
     #           ids = %w(7Ln80lUS6He07XvHI8qqHH 3dRfiJ2650SZu6GbydcHNb)
     #           artists = RSpotify::Artist.find(ids)
     #           artists.class       #=> Array
@@ -72,8 +72,8 @@ module RSpotify
         url << "&#{filter_name}=#{filter_value}"
       end
 
-      json = RSpotify.get(url)
-      json['items'].map { |i| Album.new i }
+      response = RSpotify.get(url)
+      response['items'].map { |i| Album.new i }
     end
 
     # Returns array of similar artists. Similarity is based on analysis of the Spotify community’s {http://news.spotify.com/se/2010/02/03/related-artists listening history}.
@@ -88,8 +88,8 @@ module RSpotify
     #           related_artists.first.name #=> "Miles Kane"
     def related_artists
       return @related_artists unless @related_artists.nil?
-      json = RSpotify.get("artists/#{@id}/related-artists")
-      @related_artists = json['artists'].map { |a| Artist.new a }
+      response = RSpotify.get("artists/#{@id}/related-artists")
+      @related_artists = response['artists'].map { |a| Artist.new a }
     end
 
     # Returns artist's 10 top tracks by country.
@@ -104,8 +104,8 @@ module RSpotify
     #           top_tracks.first.class #=> RSpotify::Track
     def top_tracks(country)
       return @top_tracks[country] unless @top_tracks[country].nil?
-      json = RSpotify.get("artists/#{@id}/top-tracks?country=#{country}")
-      @top_tracks[country] = json['tracks'].map { |t| Track.new t }
+      response = RSpotify.get("artists/#{@id}/top-tracks?country=#{country}")
+      @top_tracks[country] = response['tracks'].map { |t| Track.new t }
     end
   end
 end

data/lib/rspotify/base.rb

@@ -17,7 +17,7 @@ module RSpotify
     #           user = RSpotify::Base.find('wizzler', 'user')
     #           user.class #=> RSpotify::User
     #           user.id    #=> "wizzler"
-    #           
+    #
     #           ids = %w(2UzMpPKPhbcC8RbsmuURAZ 7Jzsc04YpkRwB1zeyM39wE)
     #           tracks = RSpotify::Base.find(ids, 'track')
     #           tracks.class       #=> Array
@@ -40,23 +40,23 @@ module RSpotify
     def self.find_many(ids, type)
       type_class = RSpotify.const_get(type.capitalize)
       path = "#{type}s?ids=#{ids.join ','}"
-      json = RSpotify.get path
-      json["#{type}s"].map { |t| type_class.new t }
+      response = RSpotify.get path
+      response["#{type}s"].map { |t| type_class.new t }
     end
     private_class_method :find_many
 
     def self.find_one(id, type)
       type_class = RSpotify.const_get(type.capitalize)
       path = "#{type}s/#{id}"
-      json = RSpotify.get path
-      type_class.new json
+      response = RSpotify.get path
+      type_class.new response
     end
     private_class_method :find_one
 
-    def self.insert_total(result, types, json)
+    def self.insert_total(result, types, response)
       result.instance_eval do
         @total = types.map do |type|
-          json["#{type}s"]['total']
+          response["#{type}s"]['total']
         end.reduce(:+)
 
         define_singleton_method :total do
@@ -89,7 +89,7 @@ module RSpotify
       url = "search?q=#{query}&type=#{types}"\
             "&limit=#{limit}&offset=#{offset}"
 
-      json = if market.is_a? Hash
+      response = if market.is_a? Hash
         url << '&market=from_token'
         User.oauth_get(market[:from].id, url)
       else
@@ -100,10 +100,10 @@ module RSpotify
       types = types.split(',')
       result = types.flat_map do |type|
         type_class = RSpotify.const_get(type.capitalize)
-        json["#{type}s"]['items'].map { |i| type_class.new i }
+        response["#{type}s"]['items'].map { |i| type_class.new i }
       end
 
-      insert_total(result, types, json)
+      insert_total(result, types, response)
       result
     end
 
@@ -117,7 +117,7 @@ module RSpotify
 
     # When an object is obtained undirectly, Spotify usually returns a simplified version of it.
     # This method updates it into a full object, with all attributes filled.
-    # 
+    #
     # @note It is seldom necessary to use this method explicitly, since RSpotify takes care of it automatically when needed (see {#method_missing})
     #
     # @example
@@ -156,9 +156,9 @@ module RSpotify
       return true if instance_variable_defined? attr
       super
     end
-    
+
     protected
-    
+
     def hash_for(tracks, field)
       return nil unless tracks
       pairs = tracks.map do |track|

data/lib/rspotify/category.rb

@@ -29,8 +29,8 @@ module RSpotify
         url << '&' unless index == options.size-1
       end
 
-      json = RSpotify.get(url)
-      Category.new json
+      response = RSpotify.get(url)
+      Category.new response
     end
 
     # Get a list of categories used to tag items in Spotify
@@ -50,8 +50,8 @@ module RSpotify
       options.each do |option, value|
         url << "&#{option}=#{value}"
       end
-      json = RSpotify.get(url)
-      json['categories']['items'].map { |i| Category.new i }
+      response = RSpotify.get(url)
+      response['categories']['items'].map { |i| Category.new i }
     end
 
     # Spotify does not support search for categories.
@@ -91,8 +91,8 @@ module RSpotify
         url << "&#{option}=#{value}"
       end
 
-      json = RSpotify.get(url)
-      json['playlists']['items'].map { |i| Playlist.new i }
+      response = RSpotify.get(url)
+      response['playlists']['items'].map { |i| Playlist.new i }
     end
   end
 end

data/lib/rspotify/connection.rb

@@ -52,7 +52,14 @@ module RSpotify
 
     def send_request(verb, path, *params)
       url = path.start_with?("http") ? path : API_URI + path
-      response = RestClient.send(verb, url, *params)
+      begin
+        response = RestClient.send(verb, url, *params)
+      rescue RestClient::Unauthorized
+        if @client_token
+          authenticate(@client_id, @client_secret)
+          response = RestClient.send(verb, url, *params)
+        end
+      end
       JSON.parse response unless response.empty?
     end
 

data/lib/rspotify/playlist.rb

@@ -7,7 +7,7 @@ module RSpotify
   # @attr [String]      name            The name of the playlist
   # @attr [User]        owner           The user who owns the playlist
   # @attr [Boolean]     public          true if the playlist is not marked as secret
-  # @attr [String]      snapshot_id     The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version
+  # @attr [String]      snapshot_id     The version identifier for the current playlist. This attribute gets updated every time the playlist changes and can be supplied in other requests to target a specific playlist version
   # @attr [Integer]     total           The total number of tracks in the playlist
   # @attr [Hash]        tracks_added_at A hash containing the date and time each track was added to the playlist. Note: the hash is updated only when {#tracks} is used.
   # @attr [Hash]        tracks_added_by A hash containing the user that added each track to the playlist. Note: the hash is updated only when {#tracks} is used.
@@ -32,8 +32,8 @@ module RSpotify
       options.each do |option, value|
         url << "&#{option}=#{value}"
       end
-      json = RSpotify.get(url)
-      json['playlists']['items'].map { |i| Playlist.new i }
+      response = RSpotify.get(url)
+      response['playlists']['items'].map { |i| Playlist.new i }
     end
 
     # Returns Playlist object with user_id and id provided. If id is "starred", returns starred playlist from user.
@@ -52,8 +52,8 @@ module RSpotify
       else
         "users/#{user_id}/playlists/#{id}"
       end
-      json = RSpotify.resolve_auth_request(user_id, url)
-      Playlist.new json
+      response = RSpotify.resolve_auth_request(user_id, url)
+      Playlist.new response
     end
 
     # Returns array of Playlist objects matching the query. It's also possible to find the total number of search results for the query
@@ -130,10 +130,11 @@ module RSpotify
       url = "#{@href}/tracks?uris=#{track_uris}"
       url << "&position=#{position}" if position
 
-      User.oauth_post(@owner.id, url, {})
+      response = User.oauth_post(@owner.id, url, {})
+      @snapshot_id = response['snapshot_id']
+
       @total += tracks.size
       @tracks_cache = nil
-
       tracks
     end
 
@@ -157,6 +158,7 @@ module RSpotify
       data.each do |field, value|
         instance_variable_set("@#{field}", value)
       end
+      @snapshot_id = nil
       self
     end
 
@@ -222,8 +224,8 @@ module RSpotify
       end
 
       url = "#{@href}/tracks?limit=#{limit}&offset=#{offset}"
-      json = RSpotify.resolve_auth_request(@owner.id, url)
-      tracks = json['items'].select { |i| i['track'] }
+      response = RSpotify.resolve_auth_request(@owner.id, url)
+      tracks = response['items'].select { |i| i['track'] }
 
       @tracks_added_at = hash_for(tracks, 'added_at') do |added_at|
         Time.parse added_at
@@ -242,6 +244,52 @@ module RSpotify
       tracks
     end
 
+    # Remove one or more tracks from a user’s playlist. Removing from a public playlist requires the
+    # *playlist-modify-public* scope; removing from a private playlist requires the *playlist-modify-private* scope.
+    #
+    # @param tracks [Array<Track,Hash>, Array<Integer>] Tracks to be removed. Maximum: 100 per request
+    # @param snapshot_id [String] Optional. The playlist's snapshot ID against which you want to make the changes.
+    # @return [Playlist]
+    #
+    # @example
+    #           # Remove all occurrences of one or more tracks
+    #           love_tracks = RSpotify::Track.search('Love')
+    #           playlist.remove_tracks!(love_tracks)
+    #
+    #           # Remove specific occurrences of one or more tracks
+    #           track = RSpotify::Track.find('tR3oH...')
+    #           playlist.remove_tracks!([{track: track, positions: [0,3]}, other_track])
+    #
+    #           # Remove tracks based only on their positions (requires snapshot id)
+    #           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
+
+      tracks = tracks.map do |track|
+        next { uri: track.uri } if track.is_a? Track
+        {
+          uri: track[:track].uri,
+          positions: track[:positions]
+        }
+      end unless positions
+
+      params = {
+        method: :delete,
+        url: "#{@href}/tracks",
+        headers: User.send(:oauth_header, @owner.id),
+        payload: positions ? { positions: positions } : { tracks: tracks }
+      }
+
+      params[:payload][:snapshot_id] = snapshot_id if snapshot_id
+      params[:payload] = params[:payload].to_json
+      response = RestClient::Request.execute(params)
+
+      @snapshot_id = JSON.parse(response)['snapshot_id']
+      @tracks_cache = nil
+      self
+    end
+
     # Reorder a track or a group of tracks in a playlist. Changing a public playlist requires the
     # *playlist-modify-public* scope; changing a private playlist requires the *playlist-modify-private* scope.
     #
@@ -283,11 +331,11 @@ module RSpotify
     def replace_tracks!(tracks)
       track_uris = tracks.map(&:uri).join(',')
       url = "#{@href}/tracks?uris=#{track_uris}"
-
       User.oauth_put(@owner.id, url, {})
+
       @total = tracks.size
       @tracks_cache = nil
-
+      @snapshot_id = nil
       tracks
     end
 

data/lib/rspotify/user.rb

@@ -36,8 +36,8 @@ module RSpotify
         refresh_token: @@users_credentials[user_id]['refresh_token']
       }
       response = RestClient.post(TOKEN_URI, request_body, RSpotify.send(:auth_header))
-      json = JSON.parse(response)
-      @@users_credentials[user_id]['token'] = json['access_token']
+      response = JSON.parse(response)
+      @@users_credentials[user_id]['token'] = response['access_token']
     end
     private_class_method :refresh_token
 
@@ -144,6 +144,29 @@ module RSpotify
       followed
     end
 
+    # Get the current user’s followed artists or users. Requires the *user-follow-read* scope.
+    #
+    # @note The current Spotify API implementation only supports getting followed *artists*
+    #
+    # @param type  [String]  The ID type: currently only "artist" is supported
+    # @param limit [Integer] Maximum number of items to return. Maximum: 50. Minimum: 1. Default: 20.
+    # @param after [String]  Optional. The last artist ID retrieved from the previous request.
+    # @return [Array<Artist>]
+    #
+    # @example
+    #           followed_artists = user.following(type: 'artist')
+    #           followed_artists.first.class #=> RSpotify::Artist
+    #
+    #           followed_artists = user.following(type: 'artist', limit: 50)
+    def following(type: nil, limit: 20, after: nil)
+      type_class = RSpotify.const_get(type.capitalize)
+      url = "me/following?type=#{type}&limit=#{limit}"
+      url << "&after=#{after}" if after
+
+      response = User.oauth_get(@id, url)
+      response["#{type}s"]['items'].map { |i| type_class.new i }
+    end
+
     # Check if the current user is following one or more artists or other Spotify users. This method
     # is only available when the current user has granted access to the *user-follow-read* scope.
     #
@@ -179,8 +202,8 @@ module RSpotify
     #           playlists.first.name  #=> "Movie Soundtrack Masterpieces"
     def playlists(limit: 20, offset: 0)
       url = "users/#{@id}/playlists?limit=#{limit}&offset=#{offset}"
-      json = RSpotify.resolve_auth_request(@id, url)
-      json['items'].map { |i| Playlist.new i }
+      response = RSpotify.resolve_auth_request(@id, url)
+      response['items'].map { |i| Playlist.new i }
     end
 
     # Remove tracks from the user’s “Your Music” library.
@@ -232,9 +255,9 @@ module RSpotify
     #           tracks.first.name #=> "Do I Wanna Know?"
     def saved_tracks(limit: 20, offset: 0)
       url = "me/tracks?limit=#{limit}&offset=#{offset}"
-      json = User.oauth_get(@id, url)
+      response = User.oauth_get(@id, url)
 
-      tracks = json['items'].select { |i| i['track'] }
+      tracks = response['items'].select { |i| i['track'] }
       @tracks_added_at = hash_for(tracks, 'added_at') do |added_at|
         Time.parse added_at
       end

data/lib/rspotify/version.rb

@@ -1,3 +1,3 @@
 module RSpotify
-  VERSION = '1.14.0'
+  VERSION = '1.15.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Guilherme Sad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-21 00:00:00.000000000 Z
+date: 2015-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2