omniauth-spotify 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdf552ae9587eab9fc42d3a29e18839e01fb4bd0
-  data.tar.gz: 8b654a7a9799d359e68992d7bcd1243e3b8f1628
+  metadata.gz: 7b52e324f0a69229ce9d430055f440b5f86a69a3
+  data.tar.gz: 5c8f140624660c6af633a4e14f4f844e2fdc0170
 SHA512:
-  metadata.gz: 91fd126d70e10c98765f4ca945bcbe4a03d90b7104757123215367d52ae097ada9ab62808a4b2c1a171d57bbf3bbe7954abd481a2f30a90b3c16fc8b9e4cca92
-  data.tar.gz: 6bc427de60012737366b591719f6c228aed37e6404b8a5d826d6b12d9006dcd6120c4fb54b758a64bc644ea2025cce5b7d0404000e5bfa59feec4aa6ad67d6b6
+  metadata.gz: 1a4146f276e7678cf06522c51ff7a947abb220afc0c1853c09380c9b05564f014a4a4aa4cadf79c334cf93cfd6965d2848b19d0d176987a51ac2cc069c6a5da8
+  data.tar.gz: 2caa8f99d2a67d023283f3d359bd2ead3ca0e97b2fc6ae3b8c763973b9b26b1eb649a4a01ee1f89c11554da3845ceaeed194619d293f1e1c6b575bc441207f4b

data/README.md

@@ -1,6 +1,6 @@
 # Spotify OmniAuth Strategy
 
-This gem provides a simple way to authenticate to Spotify Web API using OmniAuth with OAuth2.
+This gem provides a simple way to authenticate to the Spotify Web API using OmniAuth with OAuth2.
 
 ## Installation
 
@@ -18,14 +18,16 @@ Or install it yourself as:
 
 ## Usage
 
-You'll need to register an app on Spotify, you can do this here - https://developer.spotify.com/my-applications/#!/
+You'll need to register an app on Spotify, you can do this here - https://developer.spotify.com/my-applications/#!/applications
 
 Usage of the gem is very similar to other OmniAuth strategies.
 You'll need to add your app credentials to `config/initializers/omniauth.rb`:
 
 ```ruby
+keys = Rails.application.secrets
+
 Rails.application.config.middleware.use OmniAuth::Builder do
-  provider :spotify, 'app_id', 'app_secret', scope: 'playlist-read-private user-read-private user-read-email'
+  provider :spotify, keys.spotify['client_id'], keys.spotify['client_secret'], scope: 'playlist-read-private user-read-private user-read-email'
 end
 ```
 
@@ -35,60 +37,84 @@ Read more about scopes here: https://developer.spotify.com/web-api/using-scopes/
 Or with Devise in `config/initializers/devise.rb`:
 
 ```ruby
-config.omniauth :spotify, 'app_id', 'app_secret', scope: 'playlist-read-private user-read-private user-read-email'
+keys = Rails.application.secrets
+
+config.omniauth :spotify, keys.spotify['client_id'], keys.spotify['client_secret'], scope: 'playlist-read-private user-read-private user-read-email'
 ```
 
+## Forcing a Permission-Request Dialog
+
+If a user has given permission for an app to access a scope, that permission won't be asked again unless the user revokes access.
+In these cases, authorization sequences proceed without user interation.
+
+To force a permission dialog being shown to the user, which also makes it possible for them to switch Spotify accounts,
+set either `request.env['rack.session'][:ommiauth_spotify_force_approval?]` or `flash[:ommiauth_spotify_force_approval?]` (Rails apps only)
+to a truthy value on the request that performs the Omniauth redirection. 
+
 ## Auth Hash Schema
 
-Here's an example auth hash, available in `request.env['omniauth.auth']`:
+* Authorization data is available in the `request.env['omniauth.auth'].credentials` -- a hash that also responds to
+the `token`, `refresh_token`, `expires_at`, and `expires` methods.
 
-Some of this fields depend on what scopes you ask, namely
+```ruby
+ {
+    "token" => "xxxx",
+    "refresh_token" => "xxxx",
+    "expires_at" => 1403021232,
+    "expires" => true
+ }
+```
 
-* `user-read-email` affects the presence of the `email` field
-* `user-read-private` affects the value of `name` (if the scope is
-  missing it will reflect `username`) and the presence of
- `image`
+* Information about the authorized Spotify user is available in the `request.env['omniauth.auth'].info` hash. e.g.
 
 ```ruby
-{
-  :provider => "spotify",
-  :uid => "1111111111",
-  :info => {
+ {
     :name => "Claudio Poli",
-    :nickname => 'SomeName',
+    :nickname => "SomeName",
     :email => "claudio@icorete.ch",
-    :urls => {:spotify => "https://open.spotify.com/user/1111111111"},
-    :image => 'https://fbcdn-profile-a.akamaihd.net/hprofile-ak-xfp1/t1.0-1/s320x320/301234_1962753760624_625151598_n.jpg'
+    :urls => {"spotify" => "https://open.spotify.com/user/1111111111"},
+    :image => "https://fbcdn-profile-a.akamaihd.net/hprofile-ak-xfp1/t1.0-1/s320x320/301234_1962753760624_625151598_n.jpg",
+    :birthdate => Mon, 01 Mar 1993, # Date class
+    :country_code => "IT",
+    :product => "open",
+    :follower_count => 10
+  }
+```
+
+The username/nickname is also available via a call to `request.env['omniauth.auth'].uid`.
+
+  * Unless the `user-read-private` scope is included, the `birthdate`, `country`, `image`, and `product` fields may be `nil`,
+    and the `name` field will be set to the username/nickname instead of the display name.
+  * The email field will be nil if the 'user-read-email' scope isn't included.
+
 
+* The raw response to the `me` endpoint call is also available in  `request.env['omniauth.auth'].extra['raw_info']`. e.g.
+
+```ruby
+{
+  "country" => "IT",
+  "display_name" => "Claudio Poli",
+  "birthdate" => "1993-03-01",
+  "email" => "claudio@icorete.ch",
+  "external_urls" => {
+    "spotify" => "https://open.spotify.com/user/1111111111"
   },
-  :credentials => {
-    :token => "xxxx",
-    :refresh_token => "xxxx",
-    :expires_at => 1403021232,
-    :expires => true
+  "followers" => {
+    "href" => nil,
+    "total" => 10
   },
-  :extra => {
-    :raw_info => {
-      :country => "IT",
-      :display_name => "Claudio Poli",
-      :email => "claudio@icorete.ch",
-      :external_urls => {
-        :spotify => "https://open.spotify.com/user/1111111111"
-      },
-      :href => "https://api.spotify.com/v1/users/1111111111",
-      :id => "1111111111",
-      :images => [
-        {
-          "height" => nil,
-          "url" => "https://fbcdn-profile-a.akamaihd.net/hprofile-ak-xfp1/t1.0-1/s320x320/301234_1962753760624_625151598_n.jpg",
-          "width" => nil
-        }
-      ],
-      :product => "open",
-      :type => "user",
-      :uri => "spotify:user:1111111111"
+  "href" => "https://api.spotify.com/v1/users/1111111111",
+  "id" => "1111111111",
+  "images" => [
+    {
+      "height" => nil,
+      "url" => "https://fbcdn-profile-a.akamaihd.net/hprofile-ak-xfp1/t1.0-1/s320x320/301234_1962753760624_625151598_n.jpg",
+      "width" => nil
     }
-  }
+  ],
+  "product" => "open",
+  "type" => "user",
+  "uri" => "spotify:user:1111111111"
 }
 
 ```

data/lib/omniauth-spotify.rb

@@ -1,10 +1,13 @@
 require 'omniauth/strategies/oauth2'
+require 'date'
 
 module OmniAuth
   module Strategies
     class Spotify < OmniAuth::Strategies::OAuth2
       # Give your strategy a name.
       option :name, 'spotify'
+      
+      FORCE_APPROVAL_KEY = 'ommiauth_spotify_force_approval?'.freeze
 
       # This is where you pass the options you would pass when
       # initializing your consumer from the OAuth gem.
@@ -23,13 +26,19 @@ module OmniAuth
 
       info do
         {
-          # display_name may be empty if user does not request
-          #  'user-read-private'
+          # Unless the 'user-read-private' scope is included, the birthdate, country, image, and product fields may be nil,
+          # and the name field will be set to the username/nickname instead of the display name.
+          # The email field will be nil if the 'user-read-email' scope isn't included.
+          #
           :name => raw_info['display_name'] || raw_info['id'],
           :nickname => raw_info['id'],
           :email => raw_info['email'],
           :urls => raw_info['external_urls'],
-          :image => image_url
+          :image => image_url,
+          :birthdate => raw_info['birthdate'] && Date.parse(raw_info['birthdate']),
+          :country_code => raw_info['country'],
+          :product => raw_info['product'],
+          :follower_count => raw_info['followers']['total']
         }
       end
 
@@ -50,6 +59,10 @@ module OmniAuth
       def raw_info
         @raw_info ||= access_token.get('me').parsed
       end
+      
+      def authorize_params
+        super.tap { |params| params[:show_dialog] = true if session.delete(FORCE_APPROVAL_KEY) || defined?(Rails) && session[:flash]['flashes'][FORCE_APPROVAL_KEY] } 
+      end
 
       def callback_url
         if @authorization_code_from_signed_request_in_cookie

data/lib/omniauth-spotify/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Spotify
-    VERSION = "0.0.10"
+    VERSION = "0.0.11"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-spotify
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Claudio Poli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -60,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: OmniAuth strategy for Spotify