rspotify 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fd61ef8b246df135f26baba22ee01c8c8b95aea
-  data.tar.gz: 2e9b132363b9250147ef8e1f94dd6c5a1ed4b79f
+  metadata.gz: c7f112a228d4a745e4a0856808fdcb5c9380f852
+  data.tar.gz: b13cbfa86d18bcd1f747ed8767fb710e19249381
 SHA512:
-  metadata.gz: c30d2c943bd75df12a5215cb1f459bbef43298c740513f0757a0b0e49475047ef6e5758c47f5a98a25972e1f6ce6afb10cac8d43d6ab807c6e66bc08e9d2bad6
-  data.tar.gz: ec69eab471a3dbd4149f48bc2d319c229a3333671467f74bae73cb13b2db3c4367a2bd0d1fe676e1c7a630e3c45a61e29aad5df24e3133112c6bcc62e22d940f
+  metadata.gz: 75306911e3e1cb4c6b2c156fa97a106e0cb205711d4ea913878dbc725f8ef6bc767d6a5d07bbba68128252ecd04c671130baea05f096327c83c562ec20d43f65
+  data.tar.gz: f3422f96d4299b9ef58399a843c2bbbf43a4df3ce99126e0d636b1605d2e8759280cc424ab2ba4fabfd04514f545b2a29ae6e6fd644d1692f4e3a1ebea4d9d86

data/lib/rspotify/album.rb

@@ -10,7 +10,6 @@ module RSpotify
   # @attr [Integer]       popularity             The popularity of the album. The value will be between 0 and 100, with 100 being the most popular
   # @attr [String]        release_date           The date the album was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12"
   # @attr [String]        release_date_precision The precision with which release_date value is known: "year", "month", or "day"
-  # @attr [Array<Track>]  tracks                 The tracks of the album.
   class Album < Base
 
     # Returns Album object(s) with id(s) provided
@@ -34,7 +33,7 @@ module RSpotify
     # Returns array of Album objects matching the query, ordered by popularity
     #
     # @param query  [String]  The search query's keywords. See the q description in {https://developer.spotify.com/web-api/search-item here} for details.
-    # @param limit  [Integer] Maximum number of albums to return. Minimum: 1. Maximum: 50. Default: 20.
+    # @param limit  [Integer] Maximum number of albums to return. Maximum: 50. 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.
     # @return [Array<Album>]
     #
@@ -65,11 +64,33 @@ module RSpotify
         options['artists'].map { |a| Artist.new a }
       end
 
-      @tracks = if options['tracks'] && options['tracks']['items']
-        options['tracks']['items'].map { |t| Track.new t }
+      @tracks_cache = if options['tracks'] && options['tracks']['items']
+        options['tracks']['items'].map { |i| Track.new i }
       end
 
       super(options)
     end
+
+    # Returns array of tracks from the album
+    #
+    # @param limit  [Integer] Maximum number of tracks to return. Maximum: 50. Default: 50.
+    # @param offset [Integer] The index of the first track to return. Use with limit to get the next set of objects. Default: 0.
+    # @return [Array<Track>]
+    #
+    # @example
+    #           album = RSpotify::Album.find('41vPD50kQ7JeamkxQW7Vuy')
+    #           album.tracks.first.name #=> "Do I Wanna Know?"
+    def tracks(limit: 50, offset: 0)
+      last_track = offset + limit - 1
+      if @tracks_cache && last_track < 50
+        return @tracks_cache[offset..last_track]
+      end
+
+      url = "albums/#{@id}/tracks?limit=#{limit}&offset=#{offset}"
+      json = RSpotify.get(url)
+      tracks = json['items'].map { |i| Track.new i }
+      @tracks_cache = tracks if limit == 50 && offset == 0
+      tracks
+    end
   end
 end

data/lib/rspotify/artist.rb

@@ -27,7 +27,7 @@ module RSpotify
     # Returns array of Artist objects matching the query, ordered by popularity
     #
     # @param query  [String]  The search query's keywords. See the q description in {https://developer.spotify.com/web-api/search-item here} for details.
-    # @param limit  [Integer] Maximum number of artists to return. Minimum: 1. Maximum: 50. Default: 20.
+    # @param limit  [Integer] Maximum number of artists to return. Maximum: 50. Default: 20.
     # @param offset [Integer] The index of the first artist to return. Use with limit to get the next set of artists. Default: 0.
     # @return [Array<Artist>]
     #
@@ -65,10 +65,10 @@ module RSpotify
     def albums
       return @albums unless @albums.nil?
       json = RSpotify.get("artists/#{@id}/albums")
-      @albums = json['items'].map { |a| Album.new a }
+      @albums = json['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}
+    # 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}.
     #
     # @return [Array<Artist>]
     #

data/lib/rspotify/base.rb

@@ -30,10 +30,6 @@ module RSpotify
           return false
         end
         limit = (type == 'album' ? 20 : 50)
-        if ids.size > limit
-          warn "Too many ids requested. Maximum: #{limit} for #{type}"
-          return false
-        end
         find_many(ids, type)
       when String
         id = ids
@@ -43,7 +39,6 @@ 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 }
@@ -52,7 +47,6 @@ module RSpotify
 
     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
@@ -63,7 +57,7 @@ module RSpotify
     #
     # @param query  [String]  The search query's keywords. See the q description in {https://developer.spotify.com/web-api/search-item here} for details.
     # @param type   [String]  Valid types are: album, artist and track. Separate multiple types with commas.
-    # @param limit  [Integer] Maximum number of objects to return. Minimum: 1. Maximum: 50. Default: 20.
+    # @param limit  [Integer] Maximum number of objects to return. Maximum: 50. Default: 20.
     # @param offset [Integer] The index of the first object to return. Use with limit to get the next set of objects. Default: 0.
     # @return [Array<Base>]
     #
@@ -76,11 +70,6 @@ module RSpotify
     #           albums = RSpotify::Base.search('AM', 'album', limit: 10)
     #           albums.size #=> 10
     def self.search(query, types, limit: 20, offset: 0)
-      if limit < 1 || limit > 50
-        warn 'Limit must be between 1 and 50'
-        return false
-      end
-
       types.gsub!(/\s+/, '')
 
       json = RSpotify.get 'search',
@@ -93,7 +82,7 @@ module RSpotify
 
       types.split(',').flat_map do |type|
         type_class = RSpotify.const_get(type.capitalize)
-        json["#{type}s"]['items'].map { |item| type_class.new item }
+        json["#{type}s"]['items'].map { |i| type_class.new i }
       end
     end
 

data/lib/rspotify/playlist.rb

@@ -7,7 +7,6 @@ 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 [Array<Track>] tracks        The tracks of the playlist
   class Playlist < Base
 
     # Returns Playlist object with user_id and id provided
@@ -43,10 +42,10 @@ module RSpotify
         User.new options['owner']
       end
 
-      @tracks = if options['tracks'] && options['tracks']['items']
-        options['tracks']['items'].map { |t| Track.new t['track'] }
+      @tracks_cache = if options['tracks'] && options['tracks']['items']
+        options['tracks']['items'].map { |i| Track.new i['track'] }
       end
-
+      
       super(options)
     end
 
@@ -68,11 +67,6 @@ module RSpotify
     #           playlist.add_tracks!(tracks, position: 20)
     #           playlist.tracks[20].name #=> "Somebody That I Used To Know"
     def add_tracks!(tracks, position: nil)
-      if tracks.size > 100
-        warn 'Too many tracks requested. Maximum: 100'
-        return false
-      end
-
       track_uris = tracks.map(&:uri).join(',')
       url = "users/#{@owner.id}/playlists/#{@id}/tracks?uris=#{track_uris}"
       url << "&position=#{position}" if position
@@ -94,14 +88,48 @@ module RSpotify
     #           playlist.instance_variable_get("@description") #=> "Iconic soundtracks..."
     def complete!
       url = "users/#{@owner.id}/playlists/#{@id}"
-      credentials_defined = User.class_variable_defined?('@@users_credentials')
-      credentials = (credentials_defined ? User.class_variable_get('@@users_credentials') : nil)
 
-      if credentials && credentials[@owner.id]
+      if users_credentials && users_credentials[@owner.id]
         initialize User.oauth_get(@owner.id, url)
       else
         initialize RSpotify.auth_get(url)
       end
     end
+
+    # Returns array of tracks from the playlist
+    #
+    # @param limit  [Integer] Maximum number of tracks to return. Maximum: 100. Default: 100.
+    # @param offset [Integer] The index of the first track to return. Use with limit to get the next set of objects. Default: 0.
+    # @return [Array<Track>]
+    #
+    # @example
+    #           playlist = RSpotify::Playlist.find('wizzler', '00wHcTN0zQiun4xri9pmvX')
+    #           playlist.tracks.first.name #=> "Main Theme from Star Wars - Instrumental"
+    def tracks(limit: 100, offset: 0)
+      last_track = offset + limit - 1
+      if @tracks_cache && last_track < 100
+        return @tracks_cache[offset..last_track]
+      end
+
+      url = "users/#{@owner.id}/playlists/#{@id}/tracks" \
+            "?limit=#{limit}&offset=#{offset}"
+
+      json = if users_credentials && users_credentials[@owner.id]
+        User.oauth_get(@owner.id, url)
+      else
+        RSpotify.auth_get(url)
+      end
+
+      tracks = json['items'].map { |i| Track.new i['track'] }
+      @tracks_cache = tracks if limit == 100 && offset == 0
+      tracks
+    end
+
+    private
+
+    def users_credentials
+      credentials_defined = User.class_variable_defined?('@@users_credentials')
+      User.class_variable_get('@@users_credentials') if credentials_defined
+    end
   end
 end

data/lib/rspotify/track.rb

@@ -34,7 +34,7 @@ module RSpotify
     # Returns array of Track objects matching the query, ordered by popularity
     #
     # @param query  [String]  The search query's keywords. See the q description in {https://developer.spotify.com/web-api/search-item here} for details.
-    # @param limit  [Integer] Maximum number of tracks to return. Minimum: 1. Maximum: 50. Default: 20.
+    # @param limit  [Integer] Maximum number of tracks to return. Maximum: 50. 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.
     # @return [Array<Track>]
     #

data/lib/rspotify/user.rb

@@ -114,7 +114,7 @@ module RSpotify
     #           playlists.first.name  #=> "Movie Soundtrack Masterpieces"
     def playlists
       json = RSpotify.auth_get("users/#{@id}/playlists")
-      json['items'].map { |p| Playlist.new p }
+      json['items'].map { |i| Playlist.new i }
     end
 
     # Remove tracks from the user’s “Your Music” library.
@@ -156,7 +156,7 @@ module RSpotify
 
     # Returns the tracks saved in the Spotify user’s “Your Music” library
     #
-    # @param limit  [Integer] Maximum number of tracks to return. Minimum: 1. Maximum: 50. Default: 20.
+    # @param limit  [Integer] Maximum number of tracks to return. Maximum: 50. 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.
     # @return [Array<Track>]
     #
@@ -167,7 +167,7 @@ module RSpotify
     def saved_tracks(limit: 20, offset: 0)
       url = "me/tracks?limit=#{limit}&offset=#{offset}"
       json = User.oauth_get(@id, url)
-      json['items'].map { |t| Track.new t['track'] }
+      json['items'].map { |i| Track.new i['track'] }
     end
 
     # Check if tracks are already saved in the Spotify user’s “Your Music” library

data/lib/rspotify/version.rb

@@ -1,3 +1,3 @@
 module RSpotify
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/rspotify.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'vcr', '~> 2.9'
 end

data/spec/lib/rspotify/album_spec.rb

@@ -4,7 +4,9 @@ describe RSpotify::Album do
 
     before(:each) do
       # Get Arctic Monkeys's AM album as a testing sample
-      @album = RSpotify::Album.find('5bU1XKYxHhEwukllT20xtk')
+      @album = VCR.use_cassette('album:find:5bU1XKYxHhEwukllT20xtk') do
+        RSpotify::Album.find('5bU1XKYxHhEwukllT20xtk')
+      end
     end
 
     it 'should find album with correct attributes' do
@@ -44,13 +46,17 @@ describe RSpotify::Album do
   describe 'Album::find receiving array of ids' do
     it 'should find the right albums' do
       ids = ['2agWNCZl5Ts9W05mij8EPh']
-      albums = RSpotify::Album.find(ids)
+      albums = VCR.use_cassette('album:find:2agWNCZl5Ts9W05mij8EPh') do 
+        RSpotify::Album.find(ids)
+      end
       expect(albums)            .to be_an Array
       expect(albums.size)       .to eq 1
       expect(albums.first.name) .to eq 'The Next Day Extra'
 
       ids << '3JquYMWj5wrzuZCNAvOYN9'
-      albums = RSpotify::Album.find(ids)
+      albums = VCR.use_cassette('album:find:3JquYMWj5wrzuZCNAvOYN9') do 
+        RSpotify::Album.find(ids)
+      end
       expect(albums)            .to be_an Array
       expect(albums.size)       .to eq 2
       expect(albums.first.name) .to eq 'The Next Day Extra'
@@ -60,7 +66,9 @@ describe RSpotify::Album do
 
   describe 'Album::search' do
     it 'should search for the right albums' do
-      albums = RSpotify::Album.search('AM')
+      albums = VCR.use_cassette('album:search:AM') do 
+        RSpotify::Album.search('AM')
+      end
       expect(albums)             .to be_an Array
       expect(albums.size)        .to eq 20
       expect(albums.first)       .to be_an RSpotify::Album
@@ -68,15 +76,21 @@ describe RSpotify::Album do
     end
 
     it 'should accept additional options' do
-      albums = RSpotify::Album.search('AM', limit: 10)
+      albums = VCR.use_cassette('album:search:AM:limit:10') do 
+        RSpotify::Album.search('AM', limit: 10)
+      end
       expect(albums.size)        .to eq 10
       expect(albums.map(&:name)) .to include('AM', 'Am I Wrong')
 
-      albums = RSpotify::Album.search('AM', offset: 10)
+      albums = VCR.use_cassette('album:search:AM:offset:10') do 
+        RSpotify::Album.search('AM', offset: 10)
+      end
       expect(albums.size)        .to eq 20
       expect(albums.map(&:name)) .to include('Melody AM', 'I Am')
 
-      albums = RSpotify::Album.search('AM', limit: 10, offset: 10)
+      albums = VCR.use_cassette('album:search:AM:offset:10:limit:10') do 
+        RSpotify::Album.search('AM', limit: 10, offset: 10)
+      end
       expect(albums.size)        .to eq 10
       expect(albums.map(&:name)) .to include('Melody AM')
     end

data/spec/lib/rspotify/artist_spec.rb

@@ -4,7 +4,9 @@ describe RSpotify::Artist do
 
     before(:each) do
       # Get Arctic Monkeys as a testing sample
-      @artist = RSpotify::Artist.find('7Ln80lUS6He07XvHI8qqHH')
+      @artist = VCR.use_cassette('artist:find:7Ln80lUS6He07XvHI8qqHH') do 
+        RSpotify::Artist.find('7Ln80lUS6He07XvHI8qqHH')
+      end
     end
 
     it 'should find artist with correct attributes' do
@@ -20,7 +22,9 @@ describe RSpotify::Artist do
     end
 
     it 'should find artist with correct albums' do
-      albums = @artist.albums
+      albums = VCR.use_cassette('artist:7Ln80lUS6He07XvHI8qqHH:albums') do 
+        @artist.albums
+      end
       expect(albums)             .to be_an Array
       expect(albums.size)        .to eq 20
       expect(albums.first)       .to be_an RSpotify::Album
@@ -28,7 +32,9 @@ describe RSpotify::Artist do
     end
 
     it 'should find artist with correct top tracks' do
-      top_tracks = @artist.top_tracks(:US)
+      top_tracks = VCR.use_cassette('artist:7Ln80lUS6He07XvHI8qqHH:top_tracks:US') do 
+        @artist.top_tracks(:US)
+      end
       expect(top_tracks)             .to be_an Array
       expect(top_tracks.size)        .to eq 10
       expect(top_tracks.first)       .to be_an RSpotify::Track
@@ -36,7 +42,9 @@ describe RSpotify::Artist do
     end
 
     it 'should find artist with correct related artists' do
-      related_artists = @artist.related_artists
+      related_artists = VCR.use_cassette('artist:7Ln80lUS6He07XvHI8qqHH:related_artists') do 
+        @artist.related_artists
+      end
       expect(related_artists)             .to be_an Array
       expect(related_artists.size)        .to eq 20
       expect(related_artists.first)       .to be_an RSpotify::Artist
@@ -47,13 +55,17 @@ describe RSpotify::Artist do
   describe 'Artist::find receiving array of ids' do
     it 'should find the right artists' do
       ids = ['0oSGxfWSnnOXhD2fKuz2Gy']
-      artists = RSpotify::Artist.find(ids)
+      artists = VCR.use_cassette('artist:find:0oSGxfWSnnOXhD2fKuz2Gy') do 
+        RSpotify::Artist.find(ids)
+      end
       expect(artists)            .to be_an Array
       expect(artists.size)       .to eq 1
       expect(artists.first.name) .to eq 'David Bowie'
 
       ids << '3dBVyJ7JuOMt4GE9607Qin'
-      artists = RSpotify::Artist.find(ids)
+      artists = VCR.use_cassette('artist:find:3dBVyJ7JuOMt4GE9607Qin') do 
+        RSpotify::Artist.find(ids)
+      end
       expect(artists)            .to be_an Array
       expect(artists.size)       .to eq 2
       expect(artists.first.name) .to eq 'David Bowie'
@@ -63,7 +75,9 @@ describe RSpotify::Artist do
 
   describe 'Artist::search' do
     it 'should search for the right artists' do
-      artists = RSpotify::Artist.search('Arctic')
+      artists = VCR.use_cassette('artist:search:Arctic') do 
+        RSpotify::Artist.search('Arctic')
+      end
       expect(artists)             .to be_an Array
       expect(artists.size)        .to eq 20
       expect(artists.first)       .to be_an RSpotify::Artist
@@ -71,17 +85,23 @@ describe RSpotify::Artist do
     end
 
     it 'should accept additional options' do
-      artists = RSpotify::Artist.search('Arctic', limit: 10)
+      artists = VCR.use_cassette('artist:search:Arctic:limit:10') do 
+        RSpotify::Artist.search('Arctic', limit: 10)
+      end
       expect(artists.size)        .to eq 10
       expect(artists.map(&:name)) .to include('Arctic Monkeys', 'Arctic')
 
-      artists = RSpotify::Artist.search('Arctic', offset: 10)
+      artists = VCR.use_cassette('artist:search:Arctic:offset:10') do 
+        RSpotify::Artist.search('Arctic', offset: 10)
+      end
       expect(artists.size)        .to eq 20
-      expect(artists.map(&:name)) .to include('Arctic Light', 'Arctic Night')
+      expect(artists.map(&:name)) .to include('Arctic Flame', 'Arctic Night')
 
-      artists = RSpotify::Artist.search('Arctic', limit: 10, offset: 10)
+      artists = VCR.use_cassette('artist:search:Arctic:offset:10:limit:10') do 
+        RSpotify::Artist.search('Arctic', limit: 10, offset: 10)
+      end
       expect(artists.size)        .to eq 10
-      expect(artists.map(&:name)) .to include('Arctic Light')
+      expect(artists.map(&:name)) .to include('Arctic Flame')
     end
   end
 end

data/spec/lib/rspotify/playlist_spec.rb

@@ -6,10 +6,15 @@ describe RSpotify::Playlist do
       # Keys generated specifically for the tests. Should be removed in the future
       client_id     = '5ac1cda2ad354aeaa1ad2693d33bb98c'
       client_secret = '155fc038a85840679b55a1822ef36b9b'
-      RSpotify.authenticate(client_id, client_secret)
+
+      VCR.use_cassette('authenticate:5ac1cda2ad354aeaa1ad2693d33bb98c') do 
+        RSpotify.authenticate(client_id, client_secret)
+      end
 
       # Get wizzler's "Movie Soundtrack Masterpieces" playlist as a testing sample
-      @playlist = RSpotify::Playlist.find('wizzler', '00wHcTN0zQiun4xri9pmvX')
+      @playlist = VCR.use_cassette('playlist:find:wizzler:00wHcTN0zQiun4xri9pmvX') do 
+        RSpotify::Playlist.find('wizzler', '00wHcTN0zQiun4xri9pmvX')
+      end
     end
 
     it 'should find playlist with correct attributes' do