rspotify 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7f112a228d4a745e4a0856808fdcb5c9380f852
-  data.tar.gz: b13cbfa86d18bcd1f747ed8767fb710e19249381
+  metadata.gz: 5d9e31b9626c059235d8ae9a280d2aeda3401bdb
+  data.tar.gz: d31cd52b6f9f42267a7eeac70a166f3386bb8cf5
 SHA512:
-  metadata.gz: 75306911e3e1cb4c6b2c156fa97a106e0cb205711d4ea913878dbc725f8ef6bc767d6a5d07bbba68128252ecd04c671130baea05f096327c83c562ec20d43f65
-  data.tar.gz: f3422f96d4299b9ef58399a843c2bbbf43a4df3ce99126e0d636b1605d2e8759280cc424ab2ba4fabfd04514f545b2a29ae6e6fd644d1692f4e3a1ebea4d9d86
+  metadata.gz: 9e27b5891b2c93c8bd0a0d291372eb563e765020adfb4cd3de1da96525b835a99830fef3020706a6de841e33767880bcd06f8c4a6d91734085740667e77ebcdb
+  data.tar.gz: e5f1595da9fef102f1ccd0047336f23435d59bc3a510e689c1d38b781c8dd0336d3228ad23e210cd18f3f95b885db8948d4b26a958d8b7c524a21e618b4fd697

data/lib/rspotify/artist.rb

@@ -53,19 +53,26 @@ module RSpotify
       super(options)
     end
 
-    # Returns all albums from artist
+    # Returns array of albums from artist
     #
+    # @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.
+    # @param album_type [String]  A comma-separated list of keywords that will be used to filter the response. If not supplied, all album types will be returned. Valid values are: album; single; appears_on; compilation.
+    # @param market     [String]  (synonym: country). An {http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO 3166-1 alpha-2 country code}. Supply this parameter to limit the response to one particular geographical market. If not supplied, results will be returned for all markets. Note if you do not provide this field, you are likely to get duplicate results per album, one for each market in which the album is available.
     # @return [Array<Album>]
     #
     # @example
-    #           albums = artist.albums
-    #           albums.class       #=> Array
-    #           albums.first.class #=> RSpotify::Album
-    #           albums.first.name  #=> "AM"
-    def albums
-      return @albums unless @albums.nil?
-      json = RSpotify.get("artists/#{@id}/albums")
-      @albums = json['items'].map { |i| Album.new i }
+    #           artist.albums
+    #           artist.albums(album_type: 'single,compilation')
+    #           artist.albums(limit: 50, country: 'US')
+    def albums(limit: 20, offset: 0, **filters)
+      url = "artists/#{@id}/albums?limit=#{limit}&offset=#{offset}"
+      filters.each do |filter_name, filter_value|
+        url << "&#{filter_name}=#{filter_value}"
+      end
+
+      json = RSpotify.get(url)
+      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}.

data/lib/rspotify/base.rb

@@ -56,7 +56,7 @@ module RSpotify
     # Returns array of RSpotify 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 type   [String]  Valid types are: album, artist and track. Separate multiple types with commas.
+    # @param types  [String]  Valid types are: album, artist and track. Separate multiple types with commas.
     # @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>]

data/lib/rspotify/user.rb

@@ -105,6 +105,8 @@ module RSpotify
 
     # Returns all playlists from user
     #
+    # @param limit  [Integer] Maximum number of playlists to return. Maximum: 50. Default: 20.
+    # @param offset [Integer] The index of the first playlist to return. Use with limit to get the next set of playlists. Default: 0.
     # @return [Array<Playlist>]
     #
     # @example
@@ -112,8 +114,13 @@ module RSpotify
     #           playlists.class       #=> Array
     #           playlists.first.class #=> RSpotify::Playlist
     #           playlists.first.name  #=> "Movie Soundtrack Masterpieces"
-    def playlists
-      json = RSpotify.auth_get("users/#{@id}/playlists")
+    def playlists(limit: 20, offset: 0)
+      url = "users/#{@id}/playlists?limit=#{limit}&offset=#{offset}"
+      json = if @credentials.nil?
+        RSpotify.auth_get(url)
+      else
+        User.oauth_get(@id, url)
+      end
       json['items'].map { |i| Playlist.new i }
     end
 

data/lib/rspotify/version.rb

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

data/spec/lib/rspotify/artist_spec.rb

@@ -22,7 +22,7 @@ describe RSpotify::Artist do
     end
 
     it 'should find artist with correct albums' do
-      albums = VCR.use_cassette('artist:7Ln80lUS6He07XvHI8qqHH:albums') do 
+      albums = VCR.use_cassette('artist:7Ln80lUS6He07XvHI8qqHH:albums:limit:20:offset:0') do 
         @artist.albums
       end
       expect(albums)             .to be_an Array

data/spec/lib/rspotify/user_spec.rb

@@ -21,12 +21,11 @@ describe RSpotify::User do
       # Keys generated specifically for the tests. Should be removed in the future
       client_id     = '5ac1cda2ad354aeaa1ad2693d33bb98c'
       client_secret = '155fc038a85840679b55a1822ef36b9b'
-      VCR.use_cassette('authenticate:5ac1cda2ad354aeaa1ad2693d33bb98c') do 
+      VCR.use_cassette('authenticate:5ac1cda2ad354aeaa1ad2693d33bb98c') do
         RSpotify.authenticate(client_id, client_secret)
       end
 
-
-      playlists = VCR.use_cassette('user:wizzler:playlists') do 
+      playlists = VCR.use_cassette('user:wizzler:playlists:limit:20:offset:0') do
         @user.playlists
       end
       expect(playlists)             .to be_an Array

data/spec/vcr_cassettes/{artist_7Ln80lUS6He07XvHI8qqHH_albums.yml → artist_7Ln80lUS6He07XvHI8qqHH_albums_limit_20_offset_0.yml}

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.spotify.com/v1/artists/7Ln80lUS6He07XvHI8qqHH/albums
+    uri: https://api.spotify.com/v1/artists/7Ln80lUS6He07XvHI8qqHH/albums?limit=20&offset=0
     body:
       encoding: US-ASCII
       string: ''

data/spec/vcr_cassettes/{user_wizzler_playlists.yml → user_wizzler_playlists_limit_20_offset_0.yml}

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.spotify.com/v1/users/wizzler/playlists
+    uri: https://api.spotify.com/v1/users/wizzler/playlists?limit=20&offset=0
     body:
       encoding: US-ASCII
       string: ''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Guilherme Sad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -161,7 +161,7 @@ files:
 - spec/vcr_cassettes/album_search_AM_limit_10.yml
 - spec/vcr_cassettes/album_search_AM_offset_10.yml
 - spec/vcr_cassettes/album_search_AM_offset_10_limit_10.yml
-- spec/vcr_cassettes/artist_7Ln80lUS6He07XvHI8qqHH_albums.yml
+- spec/vcr_cassettes/artist_7Ln80lUS6He07XvHI8qqHH_albums_limit_20_offset_0.yml
 - spec/vcr_cassettes/artist_7Ln80lUS6He07XvHI8qqHH_related_artists.yml
 - spec/vcr_cassettes/artist_7Ln80lUS6He07XvHI8qqHH_top_tracks_US.yml
 - spec/vcr_cassettes/artist_find_0oSGxfWSnnOXhD2fKuz2Gy.yml
@@ -181,7 +181,7 @@ files:
 - spec/vcr_cassettes/track_search_Wanna_Know_limit_10_offset_10.yml
 - spec/vcr_cassettes/track_search_Wanna_Know_offset_10.yml
 - spec/vcr_cassettes/user_find_wizzler.yml
-- spec/vcr_cassettes/user_wizzler_playlists.yml
+- spec/vcr_cassettes/user_wizzler_playlists_limit_20_offset_0.yml
 homepage: http://rubygems.org/gems/rspotify
 licenses:
 - MIT
@@ -221,7 +221,7 @@ test_files:
 - spec/vcr_cassettes/album_search_AM_limit_10.yml
 - spec/vcr_cassettes/album_search_AM_offset_10.yml
 - spec/vcr_cassettes/album_search_AM_offset_10_limit_10.yml
-- spec/vcr_cassettes/artist_7Ln80lUS6He07XvHI8qqHH_albums.yml
+- spec/vcr_cassettes/artist_7Ln80lUS6He07XvHI8qqHH_albums_limit_20_offset_0.yml
 - spec/vcr_cassettes/artist_7Ln80lUS6He07XvHI8qqHH_related_artists.yml
 - spec/vcr_cassettes/artist_7Ln80lUS6He07XvHI8qqHH_top_tracks_US.yml
 - spec/vcr_cassettes/artist_find_0oSGxfWSnnOXhD2fKuz2Gy.yml
@@ -241,5 +241,5 @@ test_files:
 - spec/vcr_cassettes/track_search_Wanna_Know_limit_10_offset_10.yml
 - spec/vcr_cassettes/track_search_Wanna_Know_offset_10.yml
 - spec/vcr_cassettes/user_find_wizzler.yml
-- spec/vcr_cassettes/user_wizzler_playlists.yml
+- spec/vcr_cassettes/user_wizzler_playlists_limit_20_offset_0.yml
 has_rdoc: