rspotify 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4976cbb938eca04f4a36e3084052c4ed1fb0d119
-  data.tar.gz: 0f6d2a0a7a6a5a73eda3d8e5a26ca4e6070c0de1
+  metadata.gz: 64b0804e1886e1ffa8bb5d5df377e8d25ddfeb50
+  data.tar.gz: 462a1211c106279de90490fa58ef1c7340122019
 SHA512:
-  metadata.gz: fa34c1e3e875b2bf8d34a65d0f524473a5d28aaf7b997da6f30b2c7d0de4024bf965523cf23f9ff1368138042eaee4702fcc561012746b8f155687533f9ac3f4
-  data.tar.gz: 7d3a74a7c1308fcabb2297f6968f9e6bebb87c88d4175305b971682f4116f8db37de6ad900676be3e61f79ad7db4ac4c665ab9a52cd156a7aab5842d67864283
+  metadata.gz: b1d02142eacd40743e3681e7b87858f4390738e12a2fc3383f48dcf977ca705f985ac101195de3411f6627a609f308b523e787b54e9010910fadd09e9ad9526c
+  data.tar.gz: 4819abd8af5a198e89c4fce6f781d33c2051b25817f8f2122d50976e31b1d44017ef026dd9099bf574d4dbea331a69bd448174e8304569ee30e8459ce8196883

data/README.md

@@ -2,6 +2,12 @@
 
 This is a ruby wrapper for the [new Spotify Web API](https://developer.spotify.com/web-api), released in June 17, 2014.
 
+## Features
+
+* [Full documentation](http://rdoc.info/github/guilhermesad/rspotify/master/frames)
+* Full API Endpoint coverage
+* OAuth and other authorization flows
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -97,13 +103,55 @@ RSpotify focuses on objects behaviour so you can forget the API and worry about
 
 It is possible to write things like `playlist.tracks.sort_by(&:popularity).last.album` without having to think what API calls must be done. RSpotify fills the gaps for you.
 
-Full documentation can be found [here](http://rdoc.info/github/guilhermesad/rspotify/master/frames).
+Check the [documentation](http://rdoc.info/github/guilhermesad/rspotify/master/frames) for all attributes and methods of albums, artists, etc.
+
+## Rails + OAuth
+
+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))
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :spotify, "<your_client_id>", "<your_client_secret>", scope: 'user-read-email playlist-modify'
+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:
 
-## Notes
+```ruby
+<%= link_to 'Sign in with Spotify', '/auth/spotify' %>
+```
+
+And create a route to receive the callback:
 
-This gem uses [client credentials](https://developer.spotify.com/web-api/authorization-guide/#client_credentials_flow) to authenticate your access. This means you can get all public data you want, but it's not possible to access private playlists or to create new ones. For that you would want to use [authorization code flow](https://developer.spotify.com/web-api/authorization-guide/#authorization_code_flow).
+```ruby
+# config/routes.rb
+
+get '/auth/spotify/callback', to: 'users#spotify'
+```
+
+Remember you need to tell Spotify this address is white-listed. You can do this by adding it to the Redirect URIs list in your [application page](https://developer.spotify.com/my-applications). An example of Redirect URI would be http://localhost:3000/auth/spotify/callback.
+
+Finally, create a new RSpotify User with the token received:
+
+```ruby
+class UsersController < ApplicationController
+  def spotify
+    spotify_user = RSpotify::User.new(request.env['omniauth.auth'])
+    # Now you can create playlists for the user and much more!
+
+    spotify_user.create_playlist!('my-awesome-playlist') 
+    # Directly creates playlist in user's Spotify account
+  end
+end
+```
 
-RSpotify focuses on simplicity of use and straight access to data, so the authorization code flow is not supported at the moment. If you really feel the need to use it, please leave a issue for it to be implemented.
+**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.
 
 ## Contributing
 

data/lib/rspotify.rb

@@ -1,14 +1,13 @@
-require 'rspotify/version'
-
 require 'base64'
 require 'json'
 require 'restclient'
 
 module RSpotify
 
-  API_URI   = 'https://api.spotify.com/v1/'
-  TOKEN_URI = 'https://accounts.spotify.com/api/token'
-  VERBS     = %w(get post put delete)
+  API_URI       = 'https://api.spotify.com/v1/'
+  AUTHORIZE_URI = 'https://accounts.spotify.com/authorize'
+  TOKEN_URI     = 'https://accounts.spotify.com/api/token'
+  VERBS         = %w(get post put delete)
 
   autoload :Album,    'rspotify/album'
   autoload :Artist,   'rspotify/artist'
@@ -40,3 +39,6 @@ module RSpotify
     end
   end
 end
+
+require 'rspotify/oauth'
+require 'rspotify/version'

data/lib/rspotify/album.rb

@@ -15,7 +15,7 @@ module RSpotify
 
     # Returns Album object(s) with id(s) provided
     #
-    # @param ids [String, Array]
+    # @param ids [String, Array] Maximum: 20 IDs
     # @return [Album, Array<Album>]
     #
     # @example
@@ -33,9 +33,9 @@ module RSpotify
 
     # Returns array of Album objects matching the query, ordered by popularity
     #
-    # @param query [String]
-    # @param limit [Integer]
-    # @param offset [Integer]
+    # @param query  [String]  The search query's keywords.
+    # @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.
     # @return [Array<Album>]
     #
     # @example

data/lib/rspotify/artist.rb

@@ -8,7 +8,7 @@ module RSpotify
 
     # Returns Artist object(s) with id(s) provided
     #
-    # @param ids [String, Array]
+    # @param ids [String, Array] Maximum: 50 IDs
     # @return [Artist, Array<Artist>]
     #
     # @example
@@ -26,9 +26,9 @@ module RSpotify
 
     # Returns array of Artist objects matching the query, ordered by popularity
     #
-    # @param query [String]
-    # @param limit [Integer]
-    # @param offset [Integer]
+    # @param query  [String]  The search query's keywords.
+    # @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.
     # @return [Array<Artist>]
     #
     # @example

data/lib/rspotify/base.rb

@@ -23,14 +23,19 @@ module RSpotify
     #           tracks.class       #=> Array
     #           tracks.first.class #=> RSpotify::Track
     def self.find(ids, type)
-      case ids.class.to_s
-      when 'Array'
+      case ids
+      when Array
         if type == 'user'
           warn 'Spotify API does not support finding several users simultaneously'
           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'
+      when String
         id = ids
         find_one(id, type)
       end
@@ -74,7 +79,7 @@ module RSpotify
     #           albums.size #=> 10
     def self.search(query, type, limit = 20, offset = 0)
       if limit < 1 || limit > 50
-        warn "Limit must be between 1 and 50"
+        warn 'Limit must be between 1 and 50'
         return false
       end
 

data/lib/rspotify/oauth.rb

@@ -0,0 +1,19 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Spotify < OmniAuth::Strategies::OAuth2
+      option :name, 'spotify'
+
+      option :client_options, {
+        site:          RSpotify::API_URI,
+        authorize_url: RSpotify::AUTHORIZE_URI,
+        token_url:     RSpotify::TOKEN_URI,
+      }
+
+      info do
+        access_token.get('me').parsed
+      end
+    end
+  end
+end

data/lib/rspotify/track.rb

@@ -15,7 +15,7 @@ module RSpotify
 
     # Returns Track object(s) with id(s) provided
     #
-    # @param ids [String, Array]
+    # @param ids [String, Array] Maximum: 50 IDs
     # @return [Track, Array<Track>]
     #
     # @example
@@ -33,9 +33,9 @@ module RSpotify
 
     # Returns array of Track objects matching the query, ordered by popularity
     #
-    # @param query [String]
-    # @param limit [Integer]
-    # @param offset [Integer]
+    # @param query  [String]  The search query's keywords.
+    # @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.
     # @return [Array<Track>]
     #
     # @example

data/lib/rspotify/user.rb

@@ -4,7 +4,7 @@ module RSpotify
 
     # Returns User object with id provided
     #
-    # @param ids [String]
+    # @param id [String]
     # @return [User]
     #
     # @example
@@ -22,9 +22,28 @@ module RSpotify
     end
 
     def initialize(options = {})
+      @credentials ||= options['credentials']
+      options = options['info'] if options['info']
+
+      @country      ||= options['country']
+      @display_name ||= options['display_name']
+      @email        ||= options['email']
+      @images       ||= options['images']
+      @product      ||= options['product']
+
       super(options)
     end
 
+    def create_playlist!(name, public: true)
+      headers  = { 
+        'Authorization' => "Bearer #{@credentials['token']}",
+        'Content-Type'  => 'application/json'
+      }
+      request_data = %Q({"name":"#{name}", "public":#{public}})
+
+      RSpotify.post("users/#{@id}/playlists", request_data, headers)
+    end
+
     # Returns all playlists from user
     #
     # @return [Array<Playlist>]
@@ -35,9 +54,8 @@ module RSpotify
     #           playlists.first.class #=> RSpotify::Playlist
     #           playlists.first.name  #=> "Movie Soundtrack Masterpieces"
     def playlists
-      return @playlists unless @playlists.nil?
       playlists = RSpotify.auth_get("users/#{@id}/playlists")['items']
-      @playlists = playlists.map { |p| Playlist.new p }
+      playlists.map { |p| Playlist.new p }
     end
   end
 end

data/lib/rspotify/version.rb

@@ -1,3 +1,3 @@
 module RSpotify
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

data/rspotify.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^spec\//)
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'omniauth-oauth2', '~> 1.1'
   spec.add_dependency 'rest_client', '~> 1.7'
 
   spec.add_development_dependency 'bundler'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspotify
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Guilherme Sad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rest_client
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +126,7 @@ files:
 - lib/rspotify/album.rb
 - lib/rspotify/artist.rb
 - lib/rspotify/base.rb
+- lib/rspotify/oauth.rb
 - lib/rspotify/playlist.rb
 - lib/rspotify/track.rb
 - lib/rspotify/user.rb