omniauth-soundcloud 1.0.0

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec
+
+gem 'omniauth-oauth2', :git => 'git://github.com/intridea/omniauth-oauth2.git'

data/README.md

@@ -0,0 +1,33 @@
+# OmniAuth SoundCloud
+
+This gem contains the SoundCloud strategy for OmniAuth 1.0.
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-soundcloud', '~> 1.0.0'
+```
+
+Then `bundle install`.
+
+## Basic Usage
+
+    use OmniAuth::Builder do
+    	provider "soundcloud", ENV['SOUNDCLOUD_CLIENT_ID'], ENV['SOUNDCLOUD_SECRET']
+    end
+
+## Supported Flows
+
+Supports the Server-side Flow as described in the the [SoundCloud docs](http://developers.soundcloud.com/docs/api/authentication#authorization-code-flow).
+
+## License
+
+Copyright (c) 2011 by Lee Martin and SoundCloud
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/example/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gem 'sinatra'
+gem 'omniauth-soundcloud', :path => '../'

data/example/config.ru

@@ -0,0 +1,27 @@
+require 'bundler/setup'
+require 'sinatra/base'
+require 'omniauth-soundcloud'
+
+class App < Sinatra::Base
+  get '/' do
+    redirect '/auth/soundcloud'
+  end
+
+  get '/auth/:provider/callback' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+  
+  get '/auth/failure' do
+    content_type 'application/json'
+    MultiJson.encode(request.env)
+  end
+end
+
+use Rack::Session::Cookie
+
+use OmniAuth::Builder do
+  provider :soundcloud, ENV['APP_ID'], ENV['APP_SECRET'], :scope => 'non-expiring'
+end
+
+run App.new

data/lib/omniauth-soundcloud.rb

@@ -0,0 +1 @@
+require 'omniauth/soundcloud'

data/lib/omniauth/soundcloud.rb

@@ -0,0 +1,2 @@
+require 'omniauth/soundcloud/version'
+require 'omniauth/strategies/soundcloud'

data/lib/omniauth/soundcloud/version.rb

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

data/lib/omniauth/strategies/soundcloud.rb

@@ -0,0 +1,82 @@
+require 'omniauth/strategies/oauth2'
+
+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'],
+          'name' => raw_info['full_name'],
+          'image' => raw_info['avatar_url'],
+          'description' => raw_info['description'],
+          'urls' => {
+            'Website' => raw_info['website']
+          },
+          '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)
+        end
+      end
+
+      def access_token_options
+        options.access_token_options.inject({}) { |h,(k,v)| h[k.to_sym] = v; h }
+      end
+
+      def authorize_params
+        super.tap do |params|
+          # params.merge!(:display => request.params['display']) if request.params['display']
+          params[:scope] ||= DEFAULT_SCOPE
+        end
+      end
+      
+      private
+      
+      def prune!(hash)
+        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
+
+OmniAuth.config.add_camelization 'soundcloud', 'SoundCloud'

data/omniauth-soundcloud.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/soundcloud/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-soundcloud'
+  s.version  = OmniAuth::SoundCloud::VERSION
+  s.authors  = ['Lee Martin']
+  s.email    = ['lee@soundcloud.com']
+  s.summary  = 'SoundCloud strategy for OmniAuth'
+  s.homepage = 'https://github.com/soundcloud/omniauth-soundcloud'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  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_development_dependency 'rspec', '~> 2.7.0'
+  s.add_development_dependency 'rake'
+end

data/spec/omniauth/strategies/soundcloud_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'omniauth-soundcloud'
+
+describe OmniAuth::Strategies::SoundCloud do
+  subject do
+    OmniAuth::Strategies::SoundCloud.new(nil, @options || {})
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'should have the correct SoundCloud site' do
+      subject.client.site.should eq("https://api.soundcloud.com")
+    end
+
+    it 'should have the correct authorization url' do
+      subject.client.options[:authorize_url].should eq("/connect")
+    end
+
+    it 'should have the correct token url' do
+      subject.client.options[:token_url].should eq('/oauth2/token')
+    end
+  end
+
+  describe '#callback_path' do
+    it 'should have the correct callback path' do
+      subject.callback_path.should eq('/auth/soundcloud/callback')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'rspec'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,37 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+shared_examples 'an oauth2 strategy' do
+  describe '#client' do
+    it 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      subject.client.options[:authorize_url].should == 'https://example.com'
+    end
+  end
+
+  describe '#authorize_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.authorize_params['foo'].should eq('bar')
+      subject.authorize_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :authorize_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.authorize_params['scope'].should eq('bar')
+      subject.authorize_params['foo'].should eq('baz')
+    end
+  end
+
+  describe '#token_params' do
+    it 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      subject.token_params['foo'].should eq('bar')
+      subject.token_params['baz'].should eq('zip')
+    end
+
+    it 'should include top-level options that are marked as :authorize_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      subject.token_params['scope'].should eq('bar')
+      subject.token_params['foo'].should eq('baz')
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-soundcloud
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Lee Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: &70219109416760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70219109416760
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70219109416200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70219109416200
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70219109415560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70219109415560
+description: 
+email:
+- lee@soundcloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- example/Gemfile
+- example/config.ru
+- lib/omniauth-soundcloud.rb
+- lib/omniauth/soundcloud.rb
+- lib/omniauth/soundcloud/version.rb
+- lib/omniauth/strategies/soundcloud.rb
+- omniauth-soundcloud.gemspec
+- spec/omniauth/strategies/soundcloud_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/soundcloud/omniauth-soundcloud
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !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
+signing_key: 
+specification_version: 3
+summary: SoundCloud strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/soundcloud_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb