omniauth-spotify 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f5ba67667a661c8021303011a181ce6f6e799ce
-  data.tar.gz: ebdb8f5e32baacb6adda30dde560f0bb062ac67e
+  metadata.gz: 92d94e3dcfcaa046bd396de8bb618c84f220878a
+  data.tar.gz: ab561fca5ffd6c811e9d50edbff5ee81e962b191
 SHA512:
-  metadata.gz: 41cec089dc3c39752949b71166adf332f2760e8dbb1ffc15fc70c919d2a06c5aa75c9c872b1041e765412ef8cc2a4d72c1647474e9bb1a94cc369072bc097562
-  data.tar.gz: 67782f6a37093b1f0d348f533aaf5a405160fd0ed110890b2f0f4b4021c0250cd319a736df67cec6ede4a376a2bb165dd9e1826d9e73c06ed7b4722b4081dc40
+  metadata.gz: 40c9be788793aec824631bf5aa291e9a9a42966f3aa9809bb3795dff958cb9e2694e2becd110f9f09bfefa48cd6aa3e9a72d04447b0913ba1f1f73248ebf5515
+  data.tar.gz: aaf6ffdfbd199142ffcfcf9c941cbc7fd23a9ffd077b6a85c9df7b19af4a4966d4be2c8acb000c429c84156b2ea1e6f8c9e53b3a8a545118f3b3539384d6b254

data/README.md

@@ -1,6 +1,6 @@
 # Spotify OmniAuth Strategy
 
-This gem provides a simple way to authenticate to Spotify using OmniAuth with OAuth2.
+This gem provides a simple way to authenticate to Spotify Web API using OmniAuth with OAuth2.
 
 ## Installation
 
@@ -18,7 +18,74 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You'll need to register an app on Spotify, you can do this here - https://developer.spotify.com/my-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
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :spotify, 'app_id', 'app_secret', scope: 'playlist-read-private user-read-private user-read-email'
+end
+```
+
+Please replace the example `scope` provided with your own.
+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'
+```
+
+## Auth Hash Schema
+
+Here's an example auth hash, available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => "spotify",
+  :uid => "1111111111",
+  :info => {
+    :name => nil,
+    :email => "claudio@icorete.ch"
+  },
+  :credentials => {
+    :token => "xxxx",
+    :refresh_token => "xxxx",
+    :expires_at => 1403021232,
+    :expires => true
+  },
+  :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"
+    }
+  }
+}
+
+```
+
+## More
+
+This gem is brought to you by the [AudioBox](https://audiobox.fm) guys.
+Enjoy!
 
 ## Contributing
 

data/lib/omniauth-spotify.rb

@@ -23,7 +23,7 @@ module OmniAuth
 
       info do
         {
-          :name => raw_info['name'],
+          :name => raw_info['display_name'],
           :email => raw_info['email']
         }
       end

data/lib/omniauth-spotify/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Spotify
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-spotify
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Claudio Poli