rspotify 0.11.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d036fdc4740624c2fbb316884229f8e36910b12
-  data.tar.gz: 10ac95732e3035d833761359d7315bc6ee262fbf
+  metadata.gz: 2d7f28937ceecdffd0ec686f189c65158444bb57
+  data.tar.gz: 77e683c22e6504e964dcb72b52ff96b0fd9afe0f
 SHA512:
-  metadata.gz: 81c76cb23d53a4fa2f5fac2a08533301656e3c54c07df43c9339bef21b25384e2bec3770a7672db67eb076a53a0c3319f46ea14be6cd79fe000702cda798c61a
-  data.tar.gz: bf69b0fa697e50e686c57beb3c4375e53684219ddbd9ad87086ff8c5b8bf36bfca961602bf2e03ce3e1acd240866f01e40e7325e134ee3815af5d3b188cb2e30
+  metadata.gz: d07731312cd48df3a44650a99043cc47be1280830d118f63150930a53fe1f6ee7b9f0c4ab9912ceabb7f3eb25df673d863f56e45e1a729f0065f695dbd6dd364
+  data.tar.gz: e952d461b1b57602732edc183c3d8ae09f1382f0fac8e007fa6a10fdb31250e46cae6f32c09aded69d932bdcb363ca51485f5b41c1da3b49797d794c2583910b

data/README.md

@@ -111,9 +111,17 @@ You'll may want your application to access an user's Spotify account.
 
 For instance, suppose you want your app to create playlists for the user based on his taste, or to add a feature that syncs user's playlists with some external app.
 
-If so, just add the following to `config/initializers/omniauth.rb` (Remember to [get your credentials](https://developer.spotify.com/my-applications))
+If so, add the following lines to your application (Remember to [get your credentials](https://developer.spotify.com/my-applications))
 
 ```ruby
+# config/application.rb
+
+RSpotify::authenticate("<your_client_id>", "<your_client_secret>")
+```
+
+```ruby
+# config/initializers/omniauth.rb
+
 Rails.application.config.middleware.use OmniAuth::Builder do
   provider :spotify, "<your_client_id>", "<your_client_secret>", scope: 'user-read-email playlist-modify'
 end
@@ -121,7 +129,7 @@ end
 
 You should replace the scope values for the ones your own app will require from the user. You can see the list of available scopes in [here](https://developer.spotify.com/web-api/using-scopes).
 
-Then just make a link so the user can log in with his Spotify account:
+Next, make a link so the user can log in with his Spotify account:
 
 ```ruby
 <%= link_to 'Sign in with Spotify', '/auth/spotify' %>
@@ -160,7 +168,20 @@ class UsersController < ApplicationController
 end
 ```
 
-**Note**: You might also like to add `RSpotify::authenticate("<your_client_id>", "<your_client_secret>")` to your `config/application.rb`. This will allow extra calls to be made.
+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.
+
+RSpotify provides a way to easy persistance:
+
+```ruby
+hash = spotify_user.to_hash
+# hash containing all user attributes, including access tokens
+
+# Use the hash to persist the data the way you prefer...
+
+# Then recover the Spotify user whenever you like
+spotify_user = RSpotify::User.new(hash)
+spotify_user.create_playlist!('my_awesome_playlist') # automatically refreshes token
+```
 
 ## Notes
 

data/lib/rspotify/album.rb

@@ -34,8 +34,8 @@ 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.
-    # @param offset [Integer] The index of the first album to return. Use with limit to get the next set of albums.
+    # @param limit  [Integer] Maximum number of albums to return. Minimum: 1. 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>]
     #
     # @example
@@ -44,10 +44,10 @@ module RSpotify
     #           albums.first.class #=> RSpotify::Album
     #           albums.first.name  #=> "AM"
     #
-    #           albums = RSpotify::Base.search('AM', 10)
+    #           albums = RSpotify::Base.search('AM', limit: 10)
     #           albums.size #=> 10
-    def self.search(query, limit = 20, offset = 0)
-      super(query, 'album', limit, offset)
+    def self.search(query, limit: 20, offset: 0)
+      super(query, 'album', limit: limit, offset: offset)
     end
 
     def initialize(options = {})

data/lib/rspotify/artist.rb

@@ -27,8 +27,8 @@ 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.
-    # @param offset [Integer] The index of the first artist to return. Use with limit to get the next set of artists.
+    # @param limit  [Integer] Maximum number of artists to return. Minimum: 1. 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>]
     #
     # @example
@@ -37,10 +37,10 @@ module RSpotify
     #           artists.first.class #=> RSpotify::Artist
     #           artists.first.name  #=> "Arctic Monkeys"
     #
-    #           artists = RSpotify::Artist.search('Arctic', 10)
+    #           artists = RSpotify::Artist.search('Arctic', limit: 10)
     #           artists.size #=> 10
-    def self.search(query, limit = 20, offset = 0)
-      super(query, 'artist', limit, offset)
+    def self.search(query, limit: 20, offset: 0)
+      super(query, 'artist', limit: limit, offset: offset)
     end
 
     def initialize(options = {})

data/lib/rspotify/base.rb

@@ -63,8 +63,8 @@ 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.
-    # @param offset [Integer] The index of the first object to return. Use with limit to get the next set of objects.
+    # @param limit  [Integer] Maximum number of objects to return. Minimum: 1. 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>]
     #
     # @example
@@ -73,9 +73,9 @@ module RSpotify
     #           artists.first.class #=> RSpotify::Artist
     #           artists.first.name  #=> "Arctic Monkeys"
     #
-    #           albums = RSpotify::Base.search('AM', 'album', 10)
+    #           albums = RSpotify::Base.search('AM', 'album', limit: 10)
     #           albums.size #=> 10
-    def self.search(query, types, limit = 20, offset = 0)
+    def self.search(query, types, limit: 20, offset: 0)
       if limit < 1 || limit > 50
         warn 'Limit must be between 1 and 50'
         return false

data/lib/rspotify/playlist.rb

@@ -77,7 +77,7 @@ module RSpotify
       url = "users/#{@owner.id}/playlists/#{@id}/tracks?uris=#{track_uris}"
       url << "&position=#{position}" if position
       
-      RSpotify.post(url, {}, User.send(:oauth_header, @owner.id))
+      User.oauth_post(@owner.id, url, {})
       @tracks = nil
     end
 
@@ -97,7 +97,7 @@ module RSpotify
       credentials = (credentials_defined ? User.class_variable_get('@@users_credentials') : nil)
 
       if credentials && credentials[@owner.id]
-        initialize RSpotify.get(url, User.send(:oauth_header, @owner.id))
+        initialize User.oauth_get(@owner.id, url)
       else
         initialize RSpotify.auth_get(url)
       end

data/lib/rspotify/track.rb

@@ -34,8 +34,8 @@ 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.
-    # @param offset [Integer] The index of the first track to return. Use with limit to get the next set of tracks.
+    # @param limit  [Integer] Maximum number of tracks to return. Minimum: 1. 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>]
     #
     # @example
@@ -44,10 +44,10 @@ module RSpotify
     #           tracks.first.class #=> RSpotify::Track
     #           tracks.first.name  #=> "Thriller"
     #
-    #           tracks = RSpotify::Track.search('Thriller', 10)
+    #           tracks = RSpotify::Track.search('Thriller', limit: 10)
     #           tracks.size #=> 10
-    def self.search(query, limit = 20, offset = 0)
-      super(query, 'track', limit, offset)
+    def self.search(query, limit: 20, offset: 0)
+      super(query, 'track', limit: limit, offset: offset)
     end
 
     def initialize(options = {})

data/lib/rspotify/user.rb

@@ -27,14 +27,43 @@ module RSpotify
       false
     end
 
+    def self.refresh_token(user_id)
+      request_body = {
+        grant_type: 'refresh_token',
+        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']
+    end
+    private_class_method :refresh_token
+
     def self.oauth_header(user_id)
-      { 
+      {
         'Authorization' => "Bearer #{@@users_credentials[user_id]['token']}",
         'Content-Type'  => 'application/json'
       }
     end
     private_class_method :oauth_header
 
+    def self.oauth_send(user_id, verb, path, *params)
+      RSpotify.send(verb, path, *params)
+    rescue RestClient::Unauthorized => e
+      raise e if e.response !~ /access token expired/
+      refresh_token(user_id)
+      params[-1] = oauth_header(user_id)
+      RSpotify.send(verb, path, *params)
+    end
+    private_class_method :oauth_header
+
+    # User::oauth_{get,post}
+    RSpotify::VERBS.each do |verb|
+      define_singleton_method "oauth_#{verb}" do |user_id, path, *params|
+        params << oauth_header(user_id)
+        oauth_send(user_id, verb, path, *params)
+      end
+    end
+
     def initialize(options = {})
       credentials = options['credentials']
       options     = options['info'] if options['info']
@@ -72,7 +101,7 @@ module RSpotify
     def create_playlist!(name, public: true)
       url = "users/#{@id}/playlists"
       request_data = %Q({"name":"#{name}", "public":#{public}})
-      Playlist.new RSpotify.post(url, request_data, User.send(:oauth_header, @id))
+      Playlist.new User.oauth_post(@id, url, request_data)
     end
 
     # Returns all playlists from user

data/lib/rspotify/version.rb

@@ -1,3 +1,3 @@
 module RSpotify
-  VERSION = '0.11.0'
+  VERSION = '1.0.0'
 end

data/spec/lib/rspotify/album_spec.rb

@@ -66,5 +66,19 @@ describe RSpotify::Album do
       expect(albums.first)       .to be_an RSpotify::Album
       expect(albums.map(&:name)) .to include('AM', 'Am I Wrong', 'A.M.', 'Melody AM')
     end
+
+    it 'should accept additional options' do
+      albums = RSpotify::Album.search('AM', limit: 10)
+      expect(albums.size)        .to eq 10
+      expect(albums.map(&:name)) .to include('AM', 'Am I Wrong')
+
+      albums = RSpotify::Album.search('AM', offset: 10)
+      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)
+      expect(albums.size)        .to eq 10
+      expect(albums.map(&:name)) .to include('Melody AM')
+    end
   end
 end

data/spec/lib/rspotify/artist_spec.rb

@@ -59,7 +59,21 @@ describe RSpotify::Artist do
       expect(artists)             .to be_an Array
       expect(artists.size)        .to eq 20
       expect(artists.first)       .to be_an RSpotify::Artist
-      expect(artists.map(&:name)) .to include('Arctic Monkeys', 'Arctic Moon', 'Arctic', 'Arctic Quest')
+      expect(artists.map(&:name)) .to include('Arctic Monkeys', 'Arctic', 'Arctic Warbler', 'Arctic Express')
+    end
+
+    it 'should accept additional options' do
+      artists = RSpotify::Artist.search('Arctic', limit: 10)
+      expect(artists.size)        .to eq 10
+      expect(artists.map(&:name)) .to include('Arctic Monkeys', 'Arctic')
+
+      artists = RSpotify::Artist.search('Arctic', offset: 10)
+      expect(artists.size)        .to eq 20
+      expect(artists.map(&:name)) .to include('Arctic Flame', 'James Arctic')
+
+      artists = RSpotify::Artist.search('Arctic', limit: 10, offset: 10)
+      expect(artists.size)        .to eq 10
+      expect(artists.map(&:name)) .to include('Arctic Flame')
     end
   end
 end

data/spec/lib/rspotify/track_spec.rb

@@ -63,7 +63,21 @@ describe RSpotify::Track do
       expect(tracks)             .to be_an Array
       expect(tracks.size)        .to eq 20
       expect(tracks.first)       .to be_an RSpotify::Track
-      expect(tracks.map(&:name)) .to include('Do I Wanna Know?', 'Wanna Know', 'Never Wanna Know')
+      expect(tracks.map(&:name)) .to include('Do I Wanna Know?', 'I Wanna Know', 'Never Wanna Know')
+    end
+
+    it 'should accept additional options' do
+      tracks = RSpotify::Track.search('Wanna Know', limit: 10)
+      expect(tracks.size)        .to eq 10
+      expect(tracks.map(&:name)) .to include('Do I Wanna Know?', 'I Wanna Know')
+
+      tracks = RSpotify::Track.search('Wanna Know', offset: 10)
+      expect(tracks.size)        .to eq 20
+      expect(tracks.map(&:name)) .to include('They Wanna Know', 'Say I Wanna Know')
+
+      tracks = RSpotify::Track.search('Wanna Know', limit: 10, offset: 10)
+      expect(tracks.size)        .to eq 10
+      expect(tracks.map(&:name)) .to include('They Wanna Know')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Guilherme Sad