omniauth-soundcloud 1.0.0 → 1.0.1

data/README.md

@@ -22,6 +22,50 @@ Then `bundle install`.
 
 Supports the Server-side Flow as described in the the [SoundCloud docs](http://developers.soundcloud.com/docs/api/authentication#authorization-code-flow).
 
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+```ruby
+{
+  "provider" => "soundcloud",
+  "uid" => 12345678,
+  "info" => {
+    "name" => "Soundcloud User",
+    "nickname" => "soundclouder",
+    "image" => "https://the.image.url",
+    "location" => "Soundcloud Town"
+  },
+  "credentials" => {
+    "token" => "123-321",
+    "expires" => false
+  },
+  "extra" => {
+    "raw_info" => {
+      "id" => 12345678,
+      "kind" => "user",
+      "permalink" => "soundclouder",
+      "username" => "soundclouder",
+      "full_name" => "Soundcloud User",
+      "uri" => "https://api.soundcloud.com/users/12345678",
+      "permalink_url" => "http://soundcloud.com/soundclouder",
+      "avatar_url" => "https://the.image.url",
+      "country" => "United States",
+      "city" => "Soundcloud Town",
+      "online" => true,
+      "track_count" => 23,
+      "playlist_count" => 12,
+      "public_favorites_count" => 123,
+      "followers_count" => 321,
+      "followings_count" => 234,
+      "plan" => "Free",
+      "private_tracks_count" => 0,
+      "private_playlists_count" => 0,
+      "primary_email_confirmed" => true
+    }
+  }
+}
+```
+
 ## License
 
 Copyright (c) 2011 by Lee Martin and SoundCloud

data/lib/omniauth/soundcloud/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module SoundCloud
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/omniauth/strategies/soundcloud.rb

@@ -4,22 +4,22 @@ module OmniAuth
   module Strategies
     class SoundCloud < OmniAuth::Strategies::OAuth2
       DEFAULT_SCOPE = 'non-expiring'
-      
+
       option :name, "soundcloud"
-      
+
       option :client_options, {
         :site => 'https://api.soundcloud.com',
         :authorize_url => '/connect',
         :token_url => '/oauth2/token'
       }
-      
+
       option :access_token_options, {
         :header_format => 'OAuth %s',
         :param_name => 'access_token'
       }
-      
+
       uid { raw_info['id'] }
-      
+
       info do
         prune!({
           'nickname' => raw_info['username'],
@@ -32,24 +32,24 @@ module OmniAuth
           'location' => raw_info['city']
         })
       end
-      
+
       credentials do
         prune!({
           'expires' => access_token.expires?,
           'expires_at' => access_token.expires_at
         })
       end
-      
+
       extra do
         prune!({
           'raw_info' => raw_info
         })
       end
-      
+
       def raw_info
         @raw_info ||= access_token.get('/me.json').parsed
       end
-      
+
       def build_access_token
         super.tap do |token|
           token.options.merge!(access_token_options)
@@ -62,19 +62,19 @@ module OmniAuth
 
       def authorize_params
         super.tap do |params|
-          # params.merge!(:display => request.params['display']) if request.params['display']
+          %w[display state scope].each { |v| params[v.to_sym] = request.params[v] if request.params[v] }
           params[:scope] ||= DEFAULT_SCOPE
         end
       end
-      
+
       private
-      
+
       def prune!(hash)
-        hash.delete_if do |_, value| 
+        hash.delete_if do |_, value|
           prune!(value) if value.is_a?(Hash)
           value.nil? || (value.respond_to?(:empty?) && value.empty?)
         end
-      end      
+      end
     end
   end
 end

data/omniauth-soundcloud.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.0.0'
+  s.add_runtime_dependency 'omniauth-oauth2', '~> 1.1.0'
 
   s.add_development_dependency 'rspec', '~> 2.7.0'
   s.add_development_dependency 'rake'

data/spec/omniauth/strategies/soundcloud_spec.rb

@@ -2,8 +2,17 @@ require 'spec_helper'
 require 'omniauth-soundcloud'
 
 describe OmniAuth::Strategies::SoundCloud do
+  let(:request) do
+    double('request',
+            :params => {},
+            :cookies => {},
+            :env => {})
+  end
+
   subject do
-    OmniAuth::Strategies::SoundCloud.new(nil, @options || {})
+    OmniAuth::Strategies::SoundCloud.new(nil, @options || {}).tap do |strategy|
+      strategy.stub(:request => request)
+    end
   end
 
   it_should_behave_like 'an oauth2 strategy'
@@ -27,4 +36,24 @@ describe OmniAuth::Strategies::SoundCloud do
       subject.callback_path.should eq('/auth/soundcloud/callback')
     end
   end
+
+   describe '#authorize_params' do
+    it 'includes display parameter from request when present' do
+      request.stub(:params) { { 'display' => 'touch' } }
+      subject.authorize_params.should be_a(Hash)
+      subject.authorize_params[:display].should eq('touch')
+    end
+
+    it 'includes state parameter from request when present' do
+      request.stub(:params) { { 'state' => 'some_state' } }
+      subject.authorize_params.should be_a(Hash)
+      subject.authorize_params[:state].should eq('some_state')
+    end
+
+    it 'overrides default scope with parameter passed from request' do
+      request.stub(:params) { { 'scope' => 'email' } }
+      subject.authorize_params.should be_a(Hash)
+      subject.authorize_params[:scope].should eq('email')
+    end
+   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-soundcloud
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,27 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-28 00:00:00.000000000Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
-  requirement: &70219109416760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70219109416760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70219109416200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70219109416200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70219109415560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +53,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70219109415560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - lee@soundcloud.com
@@ -76,21 +91,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1733435778679222157
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1733435778679222157
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: SoundCloud strategy for OmniAuth