omniauth-boletosimples 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb69873f0a79171d7ae771a54063aded5bb12994
+  data.tar.gz: c8ff225473b4b67b9cafa22430cc34c0c1f6bccf
+SHA512:
+  metadata.gz: 66d1540bf4eb0adf976d5ce16ae1b0dbd301a1cb0c97bc965d80593f91bd1b3ae09a35ad2840c024d477f7083b039909104b6c5ffbaf7924d5c7d1af2b3f7b6d
+  data.tar.gz: ef8dc9ea47a69b755a67f470e9b3bc9ebe631b740fa8b7d92844c709e970b3ef07a76268688b89162cf10cfdbaf2a401d1b82c15696fd16895b031aecb619855

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.ruby-gemset

@@ -0,0 +1 @@
+omniauth-boletosimples

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.0.1 (Unreleased)
+
+### features
+
+### improvements
+
+### bug fixes

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing
+
+We love pull requests. Here's a quick guide:
+
+1. Fork the repo.
+
+2. Create your feature branch (`git checkout -b my-new-feature`)
+
+3. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate: `bundle && rake`
+
+4. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+5. Make the test pass.
+
+6. Update [CHANGELOG.md](https://github.com/BoletoSimples/omniauth-boletosimples/blob/master/CHANGELOG.md) with a brief description of your changes under the `unreleased` heading.
+
+7. Commit your changes (`git commit -am 'Added some feature'`)
+
+8. Push to the branch (`git push origin my-new-feature`)
+
+9. Create new Pull Request
+
+At this point you're waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted,
+taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one, examples elsewhere, guides,
+  whatever is affected by your contribution
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+* a = b and not a=b.
+* Follow the conventions you see used in the source already.
+
+And in case we didn't emphasize it enough: we love tests!

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'omniauth-oauth2', "~>1.1.1", :git => 'git://github.com/intridea/omniauth-oauth2.git'
+gem 'json'

data/Gemfile.lock

@@ -0,0 +1,58 @@
+GIT
+  remote: git://github.com/intridea/omniauth-oauth2.git
+  revision: a022bc00f5cc08c69043317673f9b8d0542ba15c
+  specs:
+    omniauth-oauth2 (1.1.2)
+      faraday (>= 0.8, < 0.10)
+      multi_json (~> 1.3)
+      oauth2 (~> 0.9.3)
+      omniauth (~> 1.2)
+
+PATH
+  remote: .
+  specs:
+    omniauth-boletosimples (0.0.1)
+      omniauth-oauth2 (~> 1.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    hashie (2.1.0)
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    omniauth (1.2.1)
+      hashie (>= 1.2, < 3)
+      rack (~> 1.0)
+    rack (1.5.2)
+    rake (10.2.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json
+  omniauth-boletosimples!
+  omniauth-oauth2 (~> 1.1.1)!
+  rake
+  rspec (~> 2.14)

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rafael Lima
+
+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,102 @@
+# OmniAuth BoletoSimples
+
+This gem contains the Log In With Boleto Simples strategy for OmniAuth.
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem "omniauth-boletosimples"
+```
+
+Then:
+
+		$ bundle install
+
+## Usage
+
+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 :boletosimples, ENV['APP_ID'], ENV['APP_TOKEN'], sandbox: true, scope: "profile email"
+end
+```
+
+## Attributes and Scopes
+
+The possible attributes to be returned at the moment are:
+
+```ruby
+info['name']
+info['email']
+
+extra['raw_info']
+```
+
+The actual set of attributes returned depends on the scopes set. The currently available scopes are:
+
+```
+profile
+email
+write
+read
+webhook
+```
+
+## Registering for an API key
+
+To register your application for Log In With Boleto Simples [open a ticket](http://suporte.boletosimples.com.br) asking for credentials to your app.
+
+## Example of result auth hash
+With all scopes requested.
+
+```yaml
+provider: boletosimples
+uid: 1
+info:
+  person_type: 'individual'
+  person_name: 'Henry Renato Leonardo Barros'
+  email: 'henry@example.com'
+  cnpj_cpf: '139.586.432-21'
+credentials:
+  token: <token>
+  refresh_token: <refresh token>
+  expires_at: 1355082790
+  expires: true
+extra:
+  address_street_name: 'Rua AS 3'
+  address_number: '349'
+  address_complement: 'apto 101'
+  address_state: 'GO'
+  address_city_name: 'Rio Verde'
+  address_neighborhood: 'Residencial Água Santa'
+  address_postal_code: '75909-517'
+  phone_number: '6336151015'
+  banking_bank_number: '237'
+  banking_agency_number: '3290'
+  banking_account_number: '1028'
+  banking_account_digit: '9'
+  banking_person_type: 'individual'
+  banking_person_name: 'Henry Renato Leonardo Barros'
+  banking_cnpj_cpf: '139.586.432-21'
+  paypal_account: 'henry@example.com'
+```
+
+## Issues
+
+If you have problems, please create a [Github Issue](https://github.com/BoletoSimples/omniauth-boletosimples/issues).
+
+## Contributing
+
+Please see [CONTRIBUTING.md](https://github.com/BoletoSimples/omniauth-boletosimples/blob/master/CONTRIBUTING.md) for details.
+
+## Credits
+
+OmniAuth BoletoSimples was originally written by [Rafael Lima](http://rafael.adm.br) based on [omniauth-paypal](https://github.com/datariot/omniauth-paypal)
+Thank you to all the [contributors](https://github.com/BoletoSimples/omniauth-boletosimples/graphs/contributors).
+
+## License
+
+OmniAuth BoletoSimples is Copyright © 2014 Rafael Lima. It is free software, and may be redistributed under the terms specified in the [LICENSE](https://github.com/BoletoSimples/omniauth-boletosimples/blob/master/LICENSE) file.

data/Rakefile

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

data/lib/omniauth/boletosimples/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module BoletoSimples
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth/boletosimples.rb

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

data/lib/omniauth/strategies/boletosimples.rb

@@ -0,0 +1,81 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class BoletoSimples < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "profile"
+      ENVIRONMENTS = {
+        development: 'http://localhost:5000',
+        sandbox: 'https://sandbox.boletosimples.com.br',
+        production: 'https://boletosimples.com.br',
+      }
+      option :name, 'boletosimples'
+      option :client_options, {
+        :token_url     => '/api/v1/oauth2/token',
+        :setup         => true
+      }
+
+      option :authorize_options, [:scope, :response_type]
+      option :provider_ignores_state, true
+      option :sandbox, false
+
+      uid { raw_info['id'] }
+
+      info do
+        {
+          person_type: raw_info['person_type'],
+          person_name: raw_info['person_name'],
+          email: raw_info['email'],
+          cnpj_cpf: raw_info['cnpj_cpf']
+        }
+      end
+
+      extra do
+        {
+          address_street_name: raw_info['address_street_name'],
+          address_number: raw_info['address_number'],
+          address_complement: raw_info['address_complement'],
+          address_state: raw_info['address_state'],
+          address_city_name: raw_info['address_city_name'],
+          address_neighborhood: raw_info['address_neighborhood'],
+          address_postal_code: raw_info['address_postal_code'],
+          phone_number: raw_info['phone_number'],
+          banking_bank_number: raw_info['banking_bank_number'],
+          banking_agency_number: raw_info['banking_agency_number'],
+          banking_account_number: raw_info['banking_account_number'],
+          banking_account_digit: raw_info['banking_account_digit'],
+          banking_person_type: raw_info['banking_person_type'],
+          banking_person_name: raw_info['banking_person_name'],
+          banking_cnpj_cpf: raw_info['banking_cnpj_cpf'],
+          paypal_account: raw_info['paypal_account'],
+        }
+      end
+
+      def setup_phase
+        environment = options.environment || :production
+        options.client_options[:site] = ENVIRONMENTS[environment.to_sym]
+        options.client_options[:authorize_url] = "#{ENVIRONMENTS[environment.to_sym]}/api/v1/oauth2/authorize"
+      end
+
+      def raw_info
+        @raw_info ||= load_identity
+      end
+
+      def authorize_params
+        super.tap do |params|
+          params[:scope] ||= DEFAULT_SCOPE
+        end
+      end
+
+      private
+        def load_identity
+          access_token.options[:mode] = :query
+          access_token.options[:param_name] = :access_token
+          access_token.options[:grant_type] = :authorization_code
+          access_token.get('/api/v1/userinfo').parsed
+        end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'boletosimples', 'BoletoSimples'

data/lib/omniauth-boletosimples.rb

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

data/omniauth-boletosimples.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'omniauth/boletosimples/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'omniauth-boletosimples'
+  s.version  = OmniAuth::BoletoSimples::VERSION
+  s.authors  = ['Rafael Lima']
+  s.email    = ['contato@rafael.adm.br']
+  s.summary  = 'BoletoSimples strategy for OmniAuth'
+  s.homepage = 'https://github.com/BielSystems/omniauth-boletosimples'
+  s.license  = 'MIT'
+
+  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.0'
+
+  s.add_development_dependency 'rspec', '~> 2.14'
+  s.add_development_dependency 'rake'
+end

data/spec/omniauth/strategies/boletosimples_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+require 'omniauth-boletosimples'
+
+describe OmniAuth::Strategies::BoletoSimples do
+  subject do
+    OmniAuth::Strategies::BoletoSimples.new(nil, @options || {})
+  end
+
+  it_should_behave_like 'an oauth2 strategy'
+
+  describe '#client' do
+    it 'has correct BoletoSimples site' do
+      subject.setup_phase
+      subject.client.site.should eq('https://boletosimples.com.br')
+    end
+
+    it 'has correct BoletoSimples sandbox site' do
+      @options = { :environment => :sandbox }
+      subject.setup_phase
+      subject.client.site.should eq('https://sandbox.boletosimples.com.br')
+    end
+
+    it 'has correct authorize url' do
+      subject.setup_phase
+      subject.client.options[:authorize_url].should eq('https://boletosimples.com.br/api/v1/oauth2/authorize')
+    end
+
+    it 'has correct sandbox authorize url' do
+      @options = { :environment => :sandbox }
+      subject.setup_phase
+      subject.client.options[:authorize_url].should eq('https://sandbox.boletosimples.com.br/api/v1/oauth2/authorize')
+    end
+
+    it 'has correct token url' do
+      subject.client.options[:token_url].should eq('/api/v1/oauth2/token')
+    end
+  end
+
+  describe '#callback_path' do
+    it "has the correct callback path" do
+      subject.callback_path.should eq('/auth/boletosimples/callback')
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'rspec'
+require 'omniauth'
+Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  OmniAuth.config.test_mode = true
+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 token params passed in the :token_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 :token_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,107 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-boletosimples
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rafael Lima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-08 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !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:
+- contato@rafael.adm.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-boletosimples.rb
+- lib/omniauth/boletosimples.rb
+- lib/omniauth/boletosimples/version.rb
+- lib/omniauth/strategies/boletosimples.rb
+- omniauth-boletosimples.gemspec
+- spec/omniauth/strategies/boletosimples_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb
+homepage: https://github.com/BielSystems/omniauth-boletosimples
+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: BoletoSimples strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/boletosimples_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared_examples.rb