omniauth-clef 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmI5NTMwMmU3NDExNTZlZjE5NTEzN2EyZDk3M2QyODQ3NmNkY2I2Mw==
+  data.tar.gz: !binary |-
+    NjgzOGUzYTY5NzRlYzViN2EwNzJiMDZmODE3MmYwMjFkYTUwNWI0Zg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    N2UwZTc4YjczMGM1ZTEyYmM5M2Q1MWU1NjBmOTE3ZmE0OWY3MmU5ZTY3MzFl
+    NTUzNDY1YjJiNzMzNjM0MzZmOGMxMzhlZTFmOWFiYWIwNWM3M2NhYzQwYjAw
+    MzVlODA5OThmMDZiZjE3NWRjOWJmYmE1NzIxYWQ4ZTdhYzc5ZDk=
+  data.tar.gz: !binary |-
+    NTNlY2U5MjRlNzhmOGI0NWY5N2E4N2VhMDM4MjVkOWUwYzU0NDQ5Y2M2M2Jj
+    ZWYzMWM4MzQ2NWY3ODMxZDRlYTJmYzJlM2RhNDViZjY4ZGZiMmNjNzRiMjQ2
+    ZWU5OGYzODVhMDk4MzJhOTJjOWE2NDZjMzBhYzc1Y2Q5NzcyMDU=

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+.rspec
+/Gemfile.lock
+pkg/*
+.powenv
+tmp
+bin

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+gemspec
+
+gem 'jruby-openssl', :platform => :jruby

data/README.md

@@ -0,0 +1,83 @@
+# OmniAuth Clef
+
+The official Clef OAuth2 Strategy for OmniAuth 1.0.
+
+For details on the client side authentication scheme for Clef, refer to the documentation at: http://docs.clef.io
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth'
+gem 'omniauth-clef'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::Clef` is simply a Rack middleware. Read the OmniAuth 1.0 docs for detailed instructions: https://github.com/intridea/omniauth.
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :clef, ENV['CLEF_ID'], ENV['CLEF_SECRET']
+end
+```
+
+### Custom Callback URL/Path
+
+You can set a custom `callback_url` or `callback_path` option to override the default value. See [OmniAuth::Strategy#callback_url](https://github.com/intridea/omniauth/blob/master/lib/omniauth/strategy.rb#L411) for more details on the default.
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => 'clef',
+  :uid => '1234567',
+  :info => {
+    :email => 'test@example.com',
+    :first_name => 'Clef',
+    :last_name => 'User',
+    :phone_number => '2021119999'
+  },
+  :extra => {
+    :raw_info => {
+      :id => '1234567',
+      :first_name => 'Clef',
+      :last_name => 'User',
+      :email => 'test@example.com',
+      :phone_number => '2021119999'
+    }
+  }
+}
+```
+
+## Supported Rubies
+
+Actively tested with the following Ruby versions:
+
+- MRI 1.9.3
+- MRI 1.9.2
+- MRI 1.8.7
+- JRuby 1.6.5
+
+*NB.* For JRuby, you'll need to install the `jruby-openssl` gem. There's no way to automatically specify this in a Rubygem gemspec, so you need to manually add it your project's own Gemfile:
+
+```ruby
+gem 'jruby-openssl', :platform => :jruby
+```
+
+## License
+
+Copyright (c) 2012 by Jesse Pollak
+
+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,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.libs << 'test'
+end
+
+task :default => :test

data/lib/omniauth-clef.rb

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

data/lib/omniauth/clef.rb

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

data/lib/omniauth/clef/version.rb

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

data/lib/omniauth/strategies/clef.rb

@@ -0,0 +1,65 @@
+require 'omniauth-oauth2'
+require 'pry'
+
+module OmniAuth
+  module Strategies
+    class Clef < OmniAuth::Strategies::OAuth2
+
+      option :name, "clef"
+      option :client_options, {
+        :site => 'https://clef.io/api/v1',
+        :request_url => "https://clef.io/iframes/qr",
+        :token_url => 'authorize'
+      }
+      option :provider_ignores_state, true
+      option :auth_token_params, {
+        param_name: 'access_token',
+        mode: :query
+      }
+
+      uid { raw_info['id'] }
+
+      info do
+        prune!({
+          'email' => raw_info['email'],
+          'first_name' => raw_info['first_name'],
+          'last_name' => raw_info['last_name'],
+          'phone_number' => raw_info['phone_number'],
+        })
+      end
+
+      extra do
+        hash = {}
+        hash['raw_info'] = raw_info unless skip_info?
+        prune! hash
+      end
+
+      def request_phase
+        url = options.client_options.request_url
+        url << "?app_id=#{options.client_id}"
+        url << "&redirect_url=#{callback_url}"
+        redirect url
+      end
+
+      def build_access_token
+        verifier = request.params['code']
+        client.auth_code.get_token(verifier, {:redirect_uri => callback_url}.merge(token_params.to_hash(:symbolize_keys => true)), deep_symbolize(options.auth_token_params))
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('info').parsed || {}
+        @raw_info = @raw_info['info'] if !@raw_info['info'].nil?
+        @raw_info
+      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/omniauth-clef.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/clef/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-clef'
+  s.version  = OmniAuth::Clef::VERSION
+  s.authors  = ['Jesse Pollak']
+  s.email    = ['jpollak92@gmail.com']
+  s.summary  = 'Clef strategy for OmniAuth'
+  s.homepage = 'https://github.com/jessepollak/omniauth-clef'
+
+  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.1'
+  s.add_runtime_dependency 'pry'
+
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'rake'
+end

data/test/helper.rb

@@ -0,0 +1,54 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'omniauth/strategies/clef'
+
+OmniAuth.config.test_mode = true
+
+module BlockTestHelper
+  def test(name, &blk)
+    method_name = "test_#{name.gsub(/\s+/, '_')}"
+    raise "Method already defined: #{method_name}" if instance_methods.include?(method_name.to_sym)
+    define_method method_name, &blk
+  end
+end
+
+module CustomAssertions
+  def assert_has_key(key, hash, msg = nil)
+    msg = message(msg) { "Expected #{hash.inspect} to have key #{key.inspect}" }
+    assert hash.has_key?(key), msg
+  end
+
+  def refute_has_key(key, hash, msg = nil)
+    msg = message(msg) { "Expected #{hash.inspect} not to have key #{key.inspect}" }
+    refute hash.has_key?(key), msg
+  end
+end
+
+class TestCase < MiniTest::Unit::TestCase
+  extend BlockTestHelper
+  include CustomAssertions
+end
+
+class StrategyTestCase < TestCase
+  def setup
+    @request = stub('Request')
+    @request.stubs(:params).returns({})
+    @request.stubs(:cookies).returns({})
+    @request.stubs(:env).returns({})
+
+    @client_id = '123'
+    @client_secret = '53cr3tz'
+  end
+
+  def strategy
+    @strategy ||= begin
+      args = [@client_id, @client_secret, @options].compact
+      OmniAuth::Strategies::Clef.new(nil, *args).tap do |strategy|
+        strategy.stubs(:request).returns(@request)
+      end
+    end
+  end
+end
+
+Dir[File.expand_path('../support/**/*', __FILE__)].each &method(:require)

data/test/support/shared_examples.rb

@@ -0,0 +1,70 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+module OAuth2StrategyTests
+  def self.included(base)
+    base.class_eval do
+      include ClientTests
+      include AuthorizeParamsTests
+      include CSRFAuthorizeParamsTests
+      include TokenParamsTests
+    end
+  end
+
+  module ClientTests
+    extend BlockTestHelper
+
+    test 'should be initialized with symbolized client_options' do
+      @options = { :client_options => { 'authorize_url' => 'https://example.com' } }
+      assert_equal 'https://example.com', strategy.client.options[:authorize_url]
+    end
+  end
+
+  module AuthorizeParamsTests
+    extend BlockTestHelper
+
+    test 'should include any authorize params passed in the :authorize_params option' do
+      @options = { :authorize_params => { :foo => 'bar', :baz => 'zip' } }
+      assert_equal 'bar', strategy.authorize_params['foo']
+      assert_equal 'zip', strategy.authorize_params['baz']
+    end
+
+    test 'should include top-level options that are marked as :authorize_options' do
+      @options = { :authorize_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      assert_equal 'bar', strategy.authorize_params['scope']
+      assert_equal 'baz', strategy.authorize_params['foo']
+    end
+
+    test 'should exclude top-level options that are not passed' do
+      @options = { :authorize_options => [:bar] }
+      refute_has_key :bar, strategy.authorize_params
+      refute_has_key 'bar', strategy.authorize_params
+    end
+  end
+
+  module CSRFAuthorizeParamsTests
+    extend BlockTestHelper
+
+    test 'should store random state in the session when none is present in authorize or request params' do
+      assert_includes strategy.authorize_params.keys, 'state'
+      refute_empty strategy.authorize_params['state']
+      refute_empty strategy.session['omniauth.state']
+      assert_equal strategy.authorize_params['state'], strategy.session['omniauth.state']
+    end
+
+  end
+
+  module TokenParamsTests
+    extend BlockTestHelper
+
+    test 'should include any authorize params passed in the :token_params option' do
+      @options = { :token_params => { :foo => 'bar', :baz => 'zip' } }
+      assert_equal 'bar', strategy.token_params['foo']
+      assert_equal 'zip', strategy.token_params['baz']
+    end
+
+    test 'should include top-level options that are marked as :token_options' do
+      @options = { :token_options => [:scope, :foo], :scope => 'bar', :foo => 'baz' }
+      assert_equal 'bar', strategy.token_params['scope']
+      assert_equal 'baz', strategy.token_params['foo']
+    end
+  end
+end

data/test/test.rb

@@ -0,0 +1,106 @@
+require 'helper'
+require 'omniauth-clef'
+
+class StrategyTest < StrategyTestCase
+  include OAuth2StrategyTests
+end
+
+class ClientTest < StrategyTestCase
+  test 'has correct Clef site' do
+    assert_equal 'https://clef.io/api/v1', strategy.client.site
+  end
+
+  test 'has correct token url' do
+    assert_equal 'authorize', strategy.client.options[:token_url]
+  end
+end
+
+class UidTest < StrategyTestCase
+  def setup
+    super
+    strategy.stubs(:raw_info).returns({ 'id' => '123' })
+  end
+
+  test 'returns the id from raw_info' do
+    assert_equal '123', strategy.uid
+  end
+end
+
+class InfoTestOptionalDataPresent < StrategyTestCase
+  def setup
+    super
+    @raw_info ||= { 'email' => 'test@example.com' }
+    strategy.stubs(:raw_info).returns(@raw_info)
+  end
+
+  test 'returns the email' do
+    assert_equal 'test@example.com', strategy.info['email']
+  end
+
+  test 'returns the first name' do
+    @raw_info['first_name'] = 'Fred'
+    assert_equal 'Fred', strategy.info['first_name']
+  end
+
+  test 'returns the last name' do
+    @raw_info['last_name'] = 'Smith'
+    assert_equal 'Smith', strategy.info['last_name']
+  end
+
+  test 'returns the phone number' do
+    @raw_info['phone_number'] = '1119991111'
+    assert_equal '1119991111', strategy.info['phone_number']
+  end
+end
+
+class InfoTestOptionalDataNotPresent < StrategyTestCase
+  def setup
+    super
+    @raw_info ||= { 'email' => 'test@example.com' }
+    strategy.stubs(:raw_info).returns(@raw_info)
+  end
+
+  test 'has no first name key' do
+    refute_has_key 'first_name', strategy.info
+  end
+
+  test 'has no last name key' do
+    refute_has_key 'last_name', strategy.info
+  end
+
+  test 'has no phone number key' do
+    refute_has_key 'phone_number', strategy.info
+  end
+end
+
+class RawInfoTest < StrategyTestCase
+  def setup
+    super
+    @access_token = stub('OAuth2::AccessToken')
+  end
+
+  test 'performs a GET to https://clef.io/api/v1/info' do
+    strategy.stubs(:access_token).returns(@access_token)
+    @access_token.expects(:get).with('info').returns(stub_everything('OAuth2::Response'))
+    strategy.raw_info
+  end
+
+  test 'returns a Hash' do
+    strategy.stubs(:access_token).returns(@access_token)
+    raw_response = stub('Faraday::Response')
+    raw_response.stubs(:body).returns('{ "ohai": "thar" }')
+    raw_response.stubs(:status).returns(200)
+    raw_response.stubs(:headers).returns({'Content-Type' => 'application/json' })
+    oauth2_response = OAuth2::Response.new(raw_response)
+    @access_token.stubs(:get).with('info').returns(oauth2_response)
+    assert_kind_of Hash, strategy.raw_info
+    assert_equal 'thar', strategy.raw_info['ohai']
+  end
+
+  test 'returns an empty hash when the response is false' do
+    strategy.stubs(:access_token).returns(@access_token)
+    oauth2_response = stub('OAuth2::Response', :parsed => false)
+    @access_token.stubs(:get).with('info').returns(oauth2_response)
+    assert_kind_of Hash, strategy.raw_info
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-clef
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jesse Pollak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jpollak92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-clef.rb
+- lib/omniauth/clef.rb
+- lib/omniauth/clef/version.rb
+- lib/omniauth/strategies/clef.rb
+- omniauth-clef.gemspec
+- test/helper.rb
+- test/support/shared_examples.rb
+- test/test.rb
+homepage: https://github.com/jessepollak/omniauth-clef
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Clef strategy for OmniAuth
+test_files:
+- test/helper.rb
+- test/support/shared_examples.rb
+- test/test.rb