omniauth-gust 0.0.2

data/..gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "./version"
+
+Gem::Specification.new do |s|
+  s.name        = "."
+  s.version     = .::VERSION
+  s.authors     = ["Sebastian Rabuini"]
+  s.email       = ["srabuini@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{TODO: Write a gem summary}
+  s.description = %q{TODO: Write a gem description}
+
+  s.rubyforge_project = "."
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/README.md

@@ -0,0 +1,35 @@
+# OmniAuth Gust
+
+This gem contains the Gust strategy for OmniAuth.
+
+Gust uses the OAuth2 flow, you can read about it here: http://angel.co/api/oauth/faq
+
+## How To Use It
+
+So let's say you're using Rails, you need to add the strategy to your `Gemfile`:
+
+    gem 'omniauth-gust'
+
+You can pull them in directly from github e.g.:
+
+    gem 'omniauth-gust', :git => 'https://github.com/wasabit/omniauth-gust.git'
+
+Once these are in, you need to add the following to your `config/initializers/omniauth.rb`:
+
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :gust, "consumer_key", "consumer_secret" 
+    end
+
+You will obviously have to put in your key and secret, which you get when you register your app with Gust (they call them API Key and Secret Key). 
+
+Now just follow the README at: https://github.com/intridea/omniauth
+
+## License
+
+Copyright (c) 2012 by Sebastian Rabuini
+
+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,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/..rb

@@ -0,0 +1,5 @@
+require "./version"
+
+module .
+  # Your code goes here...
+end

data/lib/omniauth/strategies/gust.rb

@@ -0,0 +1,54 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Gust < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = 'read-write'
+
+      option :name, "gust"
+
+      option :client_options, {
+        :site => 'https://alpha.gust.com',
+        :authorize_url => '/r/oauth/authorize',
+        :token_url => '/r/oauth/token'
+      }
+
+      uid { 
+        raw_info['id'] 
+      }
+
+      info do
+        prune!({
+          'name' => raw_info["user_name"],
+          'email' => raw_info["email"],
+          'company_name' => raw_info['company_name'],
+          'urls' => {
+            'profile' => raw_info['profile_url']
+          }
+        })
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        return @raw_info if @raw_info
+        (access_token.options || {}).merge!({:header_format => 'OAuth %s'})
+        @raw_info = access_token.get('/r/oauth/user_details').parsed
+      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

data/lib/omniauth-gust/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Gust
+    VERSION = "0.0.2"
+  end
+end

data/lib/omniauth-gust.rb

@@ -0,0 +1,2 @@
+require "omniauth-gust/version"
+require "omniauth/strategies/gust"

data/omniauth-gust.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-gust/version"
+ 
+Gem::Specification.new do |s|
+  s.name        = "omniauth-gust"
+  s.version     = Omniauth::Gust::VERSION
+  s.authors     = ["Sebastian Rabuini"]
+  s.email       = ["srabuini@gmail.com"]
+  s.homepage    = "https://github.com/wasabit/omniauth-gust"
+  s.summary     = %q{Gust OAuth strategy for OmniAuth}
+  s.description = %q{Gust OAuth strategy for OmniAuth}
+ 
+  s.rubyforge_project = "omniauth-gust"
+ 
+  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_dependency 'omniauth', '~> 1.0'
+  s.add_dependency 'omniauth-oauth2', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 2.7'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'webmock'
+end

data/spec/omniauth/strategies/gust_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+require 'omniauth-gust'
+
+# Based on tests from https://github.com/mkdynamic/omniauth-facebook
+describe OmniAuth::Strategies::Gust do
+  before :each do
+    @request = double('Request')
+    @request.stub(:params) { {} }
+    @request.stub(:cookies) { {} }
+    
+    @client_id = '123'
+    @client_secret = 'aaa'
+  end
+  
+  subject do
+    args = [@client_id, @client_secret, @options].compact
+    OmniAuth::Strategies::Gust.new(nil, *args).tap do |strategy|
+      strategy.stub(:request) { @request }
+    end
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct Gust site' do
+      subject.client.site.should eq('https://alpha.gust.com')
+    end
+
+    it 'has correct authorize url' do
+      subject.client.options[:authorize_url].should eq('/r/oauth/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/r/oauth/token')
+    end
+  end
+
+  describe '#uid' do
+    before :each do
+      subject.stub(:raw_info) { { 'id' => '123' } }
+    end
+
+    it 'returns the id from raw_info' do
+      subject.uid.should eq('123')
+    end
+  end
+
+  describe '#info' do
+    before :each do
+      @raw_info ||= { 'user_name' => 'sebas' }
+      subject.stub(:raw_info) { @raw_info }
+    end
+
+    context 'when data is present in raw info' do
+
+      it 'returns the username as name' do
+        @raw_info['username'] = 'sebas'
+        subject.info['name'].should eq('sebas')
+      end
+
+      it 'returns email as email' do
+        @raw_info['email'] = 'sebas@foob.ar'
+        subject.info['email'].should eq('sebas@foob.ar')
+      end
+
+      it 'returns company_name as company_name' do
+        @raw_info['company_name'] = 'wasabit'
+        subject.info['company_name'].should eq('wasabit')
+      end
+
+      it 'returns the Gust profile page link as the Gust url' do
+        @raw_info['profile_url'] = 'https://alpha.gust.com/c/wasabit'
+        subject.info['urls'].should be_a(Hash)
+        subject.info['urls']['profile'].should eq('https://alpha.gust.com/c/wasabit')
+      end
+
+    end
+  end
+
+  describe '#raw_info' do
+    before :each do
+      @access_token = double('OAuth2::AccessToken')
+      subject.stub(:access_token) { @access_token }
+    end
+
+    it 'performs a GET to https://alpha.gust.com/r/oauth/user_details' do
+      @access_token.stub(:get) { double('OAuth2::Response').as_null_object }
+      @access_token.should_receive('options')
+      @access_token.should_receive(:get).with('/r/oauth/user_details')
+      subject.raw_info
+    end
+
+    it 'returns a Hash' do
+      @access_token.should_receive(:options)
+      @access_token.stub(:get).with('/r/oauth/user_details') do
+        raw_response = double('Faraday::Response')
+        raw_response.stub(:body) { '{ "foo": "bar" }' }
+        raw_response.stub(:status) { 200 }
+        raw_response.stub(:headers) { { 'Content-Type' => 'application/json' } }
+        OAuth2::Response.new(raw_response)
+      end
+      subject.raw_info.should be_a(Hash)
+      subject.raw_info['foo'].should eq('bar')
+    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,156 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-gust
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Sebastian Rabuini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gust OAuth strategy for OmniAuth
+email:
+- srabuini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ..gemspec
+- .gitignore
+- README.md
+- Rakefile
+- lib/..rb
+- lib/omniauth-gust.rb
+- lib/omniauth-gust/version.rb
+- lib/omniauth/strategies/gust.rb
+- omniauth-gust.gemspec
+- spec/omniauth/strategies/gust_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/wasabit/omniauth-gust
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: omniauth-gust
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Gust OAuth strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/gust_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb