omniauth-braintree-auth 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fcb64826d70f5ae6149befcdd8039f62581e6095
+  data.tar.gz: c72a91dddb46120d492f6595d7662a5da1dd9df8
+SHA512:
+  metadata.gz: f3aacede0a4f2ff7be4d51d6d8c715fc66a487bec49e99e2486b25d2832431115a023060c8dfd187eba5715e01d66f4de02122ada54a5edd082c80b5d484a92f
+  data.tar.gz: bffe9306e5a2686ee411aac504802997ba69be897d5c59becf4094025f34157af118ceedbd88ce819590a77007705ef8e6ce203dd11894f1aa1ec481182c5ea8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'pry'
+end
+
+# Specify your gem's dependencies in omniauth-braintree-auth.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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,132 @@
+# OmniAuth Braintree Auth
+
+An [OmniAuth](https://github.com/intridea/omniauth) strategy for [Braintree Auth](https://www.braintreepayments.com/products-and-features/braintree-auth).
+
+Braintree Auth is currently in closed beta, use the link above to request access.
+## Installation
+
+Add it to your application's Gemfile:
+
+```ruby
+gem 'omniauth-braintree-auth'
+```
+
+And then run:
+
+    $ bundle
+
+## Usage
+
+It's helpful to have a general understanding of how OmniAuth works and what it provides before diving into a particular strategy. I recommend checking out the [OmniAuth documentation](https://github.com/intridead/omniauth) for more information.
+
+The Braintree Auth strategy allows you pass a `client_id`, `client_secret`, `redirect_uri`, `scope`, `environment`, and `landing_page` as configuration options.  Example usage in a Rack application:
+
+```ruby
+use OmniAuth::Builder do
+  provider :braintree_auth,
+    "your_client_id", "your_client_secret",
+    :scope => "read_write",                                                # required
+    :redirect_uri => "http://localhost:4567/auth/braintree_auth/callback", # required
+    :landing_page => "login"                                               # optional, one of 'signup' or 'login'
+    :environment => "production"                                           # optional, defaults to sandbox
+end
+```
+
+or, in Rails:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :braintree_auth,
+    "your_client_id", "your_client_secret",
+    :scope => "read_write",                                                # required
+    :redirect_uri => "http://localhost:4567/auth/braintree_auth/callback", # required
+    :landing_page => "login"                                               # optional, one of 'signup' or 'login'
+    :environment => "production"                                           # optional, defaults to sandbox
+end
+```
+
+### Environment
+
+The Braintree Auth strategy makes requests against Braintree's sandbox environment by default, which is useful for testing your integration. When you are ready to go live, be sure to specify `environment => "production"` when building your strategy.
+
+### Redirect
+
+To send your users to Braintree, simply point them to `/auth/braintree_auth` in your application.  It's best practice to have your users click the "Connect with Braintree" button provided by Braintree to kick off this redirect.
+
+```
+<a href="/auth/braintree_auth">
+  <img src="https://s3-us-west-1.amazonaws.com/bt-partner-assets/connect-braintree.png" alt="Connect with Braintree" width="328" height="44">
+</a>
+```
+
+### Callback
+
+After signing up with Braintree or authorizing access to an existing account, the user will be sent back to your site to the redirect URI you provided.  For OmniAuth, this must be at the path `/auth/braintree_auth/callback`.  Be sure that this URI is whitelisted under your OAuth Application configuration in the Braintree Control Panel (Settings > OAuth Applications).
+
+Once redirected, the Braintree merchant ID, access token, and refresh token will be available in `request.env['omniauth.auth']`
+
+Here is an example auth hash provided in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  uid: "braintree_merchant_id",
+  info: { merchant_id: "braintree_merchant_id" },
+  credentials: {
+    access_token: "access_token$sandbox$example_access_token"
+    refresh_token: "access_token$sandbox$refresh_token"
+    expires_at: "2026-06-14 19:49:02 UTC"
+  }
+}
+```
+
+you can then use this information in your application:
+
+```ruby
+
+get '/auth/braintree_auth/callback do
+  auth_hash = request.env['omniauth.auth']
+
+  access_token = auth_hash['credentials']['access_token']
+end
+```
+
+## Example
+
+Here is a full example Sinatra application using `omniauth-braintree-auth`. It simply displays the user's access token after they are redirected.
+
+```ruby
+require 'sinatra/base'
+require 'omniauth-braintree-auth'
+
+class TestApp < Sinatra::Base
+  enable :method_override
+  enable :sessions
+
+  use Rack::Session::Cookie
+
+  use OmniAuth::Builder do
+    provider :braintree_auth,
+      ENV['BRAINTREE_AUTH_CLIENT_ID'], ENV['BRAINTREE_AUTH_CLIENT_SECRET']
+      :scope => "read_write",
+      :redirect_uri => "http://127.0.0.1:4567/auth/braintree_auth/callback",
+      :landing_page => "login",
+      :environment => "sandbox",
+  end
+
+  get '/' do                                                                                                                                     
+    '<a href="/auth/braintree_auth">                                                                                                             
+      <img src="https://s3-us-west-1.amazonaws.com/bt-partner-assets/connect-braintree.png" alt="Connect with Braintree" width="328" height="44">
+    </a>'                                                                                                                                        
+  end                                                                                                                                            
+                                                                                                                                                
+  get '/auth/braintree_auth/callback' do                                                                                                         
+    auth_hash = request.env['omniauth.auth']                                                                                                     
+    merchant_id = auth_hash['uid']                                                                                                               
+    access_token = auth_hash['credentials']['access_token']                                                                                      
+                                                                                                                                                
+    "#{access_token} can be used to access merchant #{merchant_id}"                                                                              
+  end                                                                                                                                            
+end
+
+TestApp.run!
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/braintree/auth"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth/braintree_auth.rb

@@ -0,0 +1 @@
+require 'omniauth/strategies/braintree_auth'

data/lib/omniauth/strategies/braintree_auth.rb

@@ -0,0 +1,64 @@
+require 'omniauth-oauth2'
+require 'base64'
+
+module OmniAuth
+  module Strategies
+    class BraintreeAuth < OmniAuth::Strategies::OAuth2
+      option :name, :braintree_auth
+      option :environment, "sandbox"
+
+      option :client_options, {
+        :authorize_url => "/oauth/connect",
+        :site => "https://api.sandbox.braintreegateway.com",
+        :token_url => "/oauth/access_tokens",
+        :raise_errors => false,
+      }
+
+      option :authorize_options, [:scope, :redirect_uri, :landing_page]
+
+      credentials do
+        access_token.params["credentials"]
+      end
+
+      uid do
+        request.params["merchantId"]
+      end
+
+      info do
+        {"merchant_id" => request.params["merchantId"]}
+      end
+
+      def setup_phase
+        options.client_options.site = "https://api.braintreegateway.com" if options.environment == "production"
+
+        # application/xml content type is not recognized as XML by OAuth2 gem, so we must register it manually
+        # https://github.com/intridea/oauth2/pull/255 would add it as a registered content type
+        ::OAuth2::Response.register_parser(:xml, "application/xml") { |body| MultiXml.parse(body) }
+      end
+
+      def request_phase
+        # Braintree requires a custom signature for authorization requests
+        base_url = client.auth_code.authorize_url(authorize_params)
+        signature = compute_signature(base_url)
+        authorize_url = "#{base_url}&signature=#{signature}&algorithm=SHA256"
+        redirect authorize_url
+      end
+
+      def build_access_token
+        options.token_params.merge!(:headers => authorization_header)
+        super
+      end
+
+      private
+
+      def authorization_header
+        {"Authorization" => "Basic #{::Base64.strict_encode64("#{options[:client_id]}:#{options[:client_secret]}")}"}
+      end
+
+      def compute_signature(url)
+        key_digest = OpenSSL::Digest::SHA256.digest(options["client_secret"])
+        OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA256.new, key_digest, url)
+      end
+    end
+  end
+end

data/lib/omniauth-braintree-auth/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module BraintreeAuth
+    VERSION = "1.0.1"
+  end
+end

data/lib/omniauth-braintree-auth.rb

@@ -0,0 +1,2 @@
+require 'omniauth-braintree-auth/version'
+require 'omniauth/braintree_auth'

data/omniauth-braintree-auth.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth-braintree-auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-braintree-auth"
+  spec.version       = OmniAuth::BraintreeAuth::VERSION
+  spec.authors       = ["Alex Kowalczuk"]
+  spec.email         = ["askowalczuk93@gmail.com"]
+
+  spec.summary       = "OmniAuth Strategy for Braintree Auth"
+  spec.description   = "OmniAuth Strategy for Braintree Auth, allows easy integration with the Braintree Auth API through Omniauth"
+  spec.homepage      = "https://github.com/akowalz/omniauth-braintree-auth"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'omniauth', '~> 1.0'
+  spec.add_dependency 'faraday_middleware', '~> 0.10.0'
+  spec.add_dependency 'omniauth-oauth2', '~> 1.3'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-braintree-auth
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Alex Kowalczuk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: OmniAuth Strategy for Braintree Auth, allows easy integration with the
+  Braintree Auth API through Omniauth
+email:
+- askowalczuk93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-braintree-auth.rb
+- lib/omniauth-braintree-auth/version.rb
+- lib/omniauth/braintree_auth.rb
+- lib/omniauth/strategies/braintree_auth.rb
+- omniauth-braintree-auth.gemspec
+homepage: https://github.com/akowalz/omniauth-braintree-auth
+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.4.8
+signing_key: 
+specification_version: 4
+summary: OmniAuth Strategy for Braintree Auth
+test_files: []
+has_rdoc: