omniauth-bonofa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c28e3bcb7b2d0c6ef314922f2118ee9a51b40fd
+  data.tar.gz: ee85c4806ff91bdb39d4531d5ee3e6c26b6a212c
+SHA512:
+  metadata.gz: 4a07f44233d04d325e482003911d1d95368ef76ff7f511d9f1a93f9cd1ba63616cfcf8f82d7b0e72e76230331231463c2a76e96964fc2b7e801aad71501e47c2
+  data.tar.gz: 2e93bdca83a45673cd40ce13857f0f22bc708699eb70131b97101a1a7d2a60b8e3fcefde03ddb2bd59e8f328ebf74402b3de295aafe5b2b2860257c37b186dfd

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-bonofa.gemspec
+gem 'minitest-rg', :require => "minitest/rg"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    omniauth-bonofa (0.0.1)
+      omniauth-oauth2 (~> 1.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    hashie (2.1.1)
+    jwt (1.0.0)
+    metaclass (0.0.4)
+    minitest (5.3.4)
+    minitest-rg (5.1.0)
+      minitest (~> 5.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (0.9.4)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    omniauth (1.2.1)
+      hashie (>= 1.2, < 3)
+      rack (~> 1.0)
+    omniauth-oauth2 (1.1.2)
+      faraday (>= 0.8, < 0.10)
+      multi_json (~> 1.3)
+      oauth2 (~> 0.9.3)
+      omniauth (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  minitest
+  minitest-rg
+  mocha
+  omniauth-bonofa!
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ruo
+
+MIT License
+
+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/README.md

@@ -0,0 +1,101 @@
+# Omniauth Bonofa
+
+[Bonofa Shop](http://www.opportunity-2014.com) is an international Sales-Platform with all the functions and aspects of a social network.
+ 
+This gem contains the Bonofa strategy for OmniAuth.
+
+Bonofa uses OAuth 2. This strategy implements the browser variant of the "Sign in with Bonofa" flow.
+
+## Before You Begin
+
+You should have already installed OmniAuth into your app; if not, read the [OmniAuth README](https://github.com/intridea/omniauth) to get started.
+
+Now contact administrator of Bonofa to create an application. Then you should get application_id and secret_key from him.  
+Make sure to send a callback URL to administrator or else you may get authentication errors. (It doesn't matter what it is, just that it is set.)
+
+## Usage
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-bonofa'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-bonofa
+
+Next, tell OmniAuth about this provider. For a Rails app, your `config/initializers/omniauth.rb` file should look like this:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :bonofa, "APPLICATION_ID", "SECRET_KEY"
+end
+```
+
+or
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :bonofa, "APPLICATION_ID", "SECRET_KEY", {
+    site: 'http://www.opportunity-2014.com',
+    authorize_url: '/oauth/authorize',
+  }
+end
+```
+
+Replace APPLICATION_ID and SECRET_KEY with the appropriate values you obtained from administrator earlier.
+
+## Authentication Hash
+
+An example auth hash available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  "provider"=>:bonofa_shop,
+  "uid"=>1,
+  "info"=>
+  {
+    "email"             => "info@bonofa.com",
+    "first_name"        => "Alexander",
+    "last_name"         => "Bierbrauer",
+    "promotion_code"    => "bonofa",
+    "profile_image_url" => "http://www.opportunity-2014.com/assets/profile_image_thumb.png",
+    "language"          => "en",
+  },
+  "credentials"=>
+  {
+    "token"=>"e8d6f6685e08ca8e3874a36d421de0020d6f714a3576c2c543726b18d5c3ce89",
+    "expires_at"=>1391245607,
+    "expires"=>true
+  },
+  "extra"=>{
+    "raw_info"=>
+    {
+      "id"                => 1,
+      "email"             => "info@bonofa.com",
+      "first_name"        => "Alexander",
+      "second_name"       => "Bierbrauer",
+      "promotion_code"    => "bonofa",
+      "profile_image_url" => "http://www.opportunity-2014.com/assets/profile_image_thumb.png",
+      "language"          => "en",
+    }
+  }
+}
+```
+
+## Supported Rubies
+
+OmniAuth Bonofa is tested under 1.8.7, 1.9.2, 1.9.3, 2.0.0, and Ruby Enterprise Edition.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+task :console do
+  puts "Loading development console..."
+  system("irb -r omniauth-bonofa")
+end
+
+task :help do
+  puts "Available rake tasks: "
+  puts "rake console - Run a IRB console with all enviroment loaded"
+  puts "rake test - Run tests"
+end
+
+task :test do
+  Dir.chdir('tests')
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << '../lib'
+  t.libs << '../tests'
+  t.test_files = FileList['*_test.rb']
+  t.verbose = false
+end
+
+task :default => :test

data/lib/omniauth/bonofa/configuration.rb

@@ -0,0 +1,36 @@
+module Omniauth
+  module Bonofa
+    class << self
+      attr_reader :configuration
+    end
+
+    def self.configuration
+      @@configuration ||= Configuration.instance
+    end
+
+    def self.configure
+      yield(self.configuration) if block_given?
+    end
+
+    class Configuration
+      attr_writer :site, :authorize_url
+      include Singleton
+
+      def site
+        @site || "http://www.opportunity-2014.com"
+      end
+
+      def authorize_url
+        @authorize_url || "/oauth/authorize"
+      end
+
+      def client_options
+        {
+          :site           => self.site,
+          :authorize_url  => self.authorize_url
+        }
+      end
+
+    end
+  end
+end

data/lib/omniauth/bonofa/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Bonofa
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth/bonofa.rb

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

data/lib/omniauth/strategies/bonofa.rb

@@ -0,0 +1,35 @@
+require "omniauth/bonofa/configuration"
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Bonofa < OmniAuth::Strategies::OAuth2
+      option :name, :bonofa
+
+      uid { raw_info["id"] }
+
+      info do
+        {
+          :email              => raw_info["email"],
+          :first_name         => raw_info["first_name"],
+          :last_name          => raw_info["last_name"],
+          :language           => raw_info["shop_language"],
+          :promotion_code     => raw_info["promotion_code"],
+          :profile_image_url  => raw_info["profile_image_url"],
+        }
+      end
+
+      extra do
+        { :raw_info => raw_info }
+      end
+
+      def client
+        ::OAuth2::Client.new(options.client_id, options.client_secret, deep_symbolize(Omniauth::Bonofa.configuration.client_options))
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v1/me.json').parsed
+      end
+    end
+  end
+end

data/lib/omniauth-bonofa.rb

@@ -0,0 +1,2 @@
+require "omniauth/bonofa/configuration"
+require "omniauth/bonofa"

data/omniauth-bonofa.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/bonofa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-bonofa"
+  spec.version       = Omniauth::Bonofa::VERSION
+  spec.authors       = ["Ruo"]
+  spec.email         = ["siera04@gmail.com"]
+  spec.description   = "Bonofa strategy for Omniauth"
+  spec.summary       = "Bonofa strategy for Omniauth"
+  spec.homepage      = "https://github.com/c7devteam/bonofa_main_omniauth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.1.1'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'mocha'
+end

data/tests/bonofa_test.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+require 'omniauth-bonofa'
+require 'openssl'
+require 'base64'
+
+class StrategyTest < StrategyTestCase
+  include OAuth2StrategyTests
+end
+
+class ClientTest < StrategyTestCase
+  test 'has correct Bonofa site' do
+    assert_equal 'http://www.opportunity-2014.com', strategy.client.site
+  end
+
+  test 'has correct authorize url' do
+    assert_equal '/oauth/authorize', strategy.client.options[:authorize_url]
+  end
+
+  test 'has correct token url' do
+    assert_equal '/oauth/token', strategy.client.options[:token_url]
+  end
+end

data/tests/configuration_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+require 'omniauth-bonofa'
+
+class StrategyTest < StrategyTestCase
+  include OAuth2StrategyTests
+end
+
+class ConfigurationTest < StrategyTestCase
+  test "should set the configuration vars from site url" do
+    Omniauth::Bonofa.configure do |config|
+      config.site = "http://www.opportunity-2014.com"
+    end
+    assert_equal Omniauth::Bonofa.configuration.site, "http://www.opportunity-2014.com"
+    assert_equal 'http://www.opportunity-2014.com', strategy.client.site
+  end
+
+  test "should set configuration vars" do
+    Omniauth::Bonofa.configure do |config|
+      config.authorize_url = "/oauth/authorize"
+    end
+    assert_equal Omniauth::Bonofa.configuration.authorize_url, "/oauth/authorize"
+  end
+end

data/tests/support/shared_examples.rb

@@ -0,0 +1,69 @@
+# 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/tests/test_helper.rb

@@ -0,0 +1,57 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/rg'
+require 'mocha/setup'
+require 'omniauth/strategies/bonofa'
+
+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::Test
+  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({})
+    @request.stubs(:ssl?).returns(false)
+
+    @client_id = '123'
+    @client_secret = '53cr3tz'
+  end
+
+  def strategy
+    @strategy ||= begin
+      args = [@client_id, @client_secret, @options].compact
+      OmniAuth::Strategies::Bonofa.new(nil, *args).tap do |strategy|
+        strategy.stubs(:request).returns(@request)
+      end
+    end
+  end
+end
+
+Dir[File.expand_path('../support/**/*', __FILE__)].each &method(:require)

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-bonofa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ruo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-06 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.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !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'
+description: Bonofa strategy for Omniauth
+email:
+- siera04@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-bonofa.rb
+- lib/omniauth/bonofa.rb
+- lib/omniauth/bonofa/configuration.rb
+- lib/omniauth/bonofa/version.rb
+- lib/omniauth/strategies/bonofa.rb
+- omniauth-bonofa.gemspec
+- tests/bonofa_test.rb
+- tests/configuration_test.rb
+- tests/support/shared_examples.rb
+- tests/test_helper.rb
+homepage: https://github.com/c7devteam/bonofa_main_omniauth
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Bonofa strategy for Omniauth
+test_files: []
+has_rdoc: