omniauth-quickbooks-oauth2 0.1.0.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a102d5bb79949e3b8a6904ffdfa4546696e0609c
+  data.tar.gz: 4a129d7ce33b4bcbc810b4b3839b8fb70b594c28
+SHA512:
+  metadata.gz: 8c9301e2b126abde32b20bca556ca687881a6f3e40126f264d579f2a926c1f1799c60c0d616f54f4e9a6b7a3fe05625629d961840bfaf75be9f137eb033451e8
+  data.tar.gz: d214f87a0d96f29e49be0800162f38d8972622bd4a387ef93d1756662da4544188f73e9074bd44f031147e8b7697a80e017dbd3a9eeaff82c3b9affa79c53f1f

data/.gitignore

@@ -0,0 +1,5 @@
+*~
+/vendor
+# OS X
+.DS_STORE
+.bundle/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Abe Land
+
+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,49 @@
+# omniauth-quickbooks-oauth2
+
+This gem provides an Omniauth strategy to connect with Quickbooks (via Intuit) using OAuth2.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-quickbooks-oauth2'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-quickbooks-oauth2
+
+## Usage
+
+In your omniauth initializer file (e.g. `config/initializers/omniauth.rb`), you will want to add the following:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  ...
+  provider(
+    :quickbooks_oauth2,
+    ENV['INTUIT_CLIENT_ID'],
+    ENV['INTUIT_CLIENT_SECRET'],
+    scope: 'com.intuit.quickbooks.accounting openid profile email phone address',
+    sandbox: Rails.env.development?,
+  )
+  ...
+end
+```
+
+**NOTE: The above environment variable names and scope are just what I use in my particular project. The environment variables can be named whatever and you should consult [Intuit's documentation](https://developer.intuit.com/docs/00_quickbooks_online/2_build/10_authentication_and_authorization/10_oauth_2.0#/Initiating_the_authorization_request) to figure out which scopes your application should ask for.**
+
+**ALSO NOTE: If the `sandbox` parameter is not explicitly set to `false`, then the strategy will default to using the sandbox endpoints for Intuit's API.**
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abeland/omniauth-quickbooks-oauth2.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/omniauth-quickbooks-oauth2.rb

@@ -0,0 +1,2 @@
+require 'omniauth-quickbooks-oauth2/version'
+require 'omniauth/strategies/quickbooks_oauth2'

data/lib/omniauth-quickbooks-oauth2/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module QuickbooksOauth2
+    VERSION = '0.1.0.alpha'.freeze
+  end
+end

data/lib/omniauth/strategies/quickbooks_oauth2.rb

@@ -0,0 +1,42 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class QuickbooksOauth2 < OmniAuth::Strategies::OAuth2
+      option :name, :quickbooks_oauth2
+
+      option(
+        :client_options,
+        {
+          site: 'https://appcenter.intuit.com/connect/oauth2',
+          authorize_url: 'https://appcenter.intuit.com/connect/oauth2',
+          token_url: 'https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer',
+        },
+      )
+
+      uid { request.params['realmId'] }
+
+      info do
+        raw_info
+      end
+
+      extra do
+        { raw_info: raw_info }
+      end
+
+      def raw_info
+        @raw_info ||= JSON.parse(access_token.get("https://#{accounts_domain}/v1/openid_connect/userinfo").body)
+      end
+
+      def callback_url
+        options[:redirect_uri] || (full_host + script_name + callback_path)
+      end
+
+      private
+
+      def accounts_domain
+        false == options.sandbox ? 'accounts.platform.intuit.com' : 'sandbox-accounts.platform.intuit.com'
+      end
+    end
+  end
+end

data/omniauth-quickbooks-oauth2.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "omniauth-quickbooks-oauth2/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-quickbooks-oauth2"
+  spec.version       = OmniAuth::QuickbooksOauth2::VERSION
+  spec.authors       = ["Abe Land"]
+  spec.email         = ["codeclimbcoffee@gmail.com"]
+
+  spec.summary       = 'OAuth2 Omniauth strategy for Quickbooks.'
+  spec.description   = 'OAuth2 Omniauth straetgy for Quickbooks (Intuit) API.'
+  spec.homepage      = 'https://github.com/abeland/omniauth-quickbooks-oauth2'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'omniauth', '~>1.3'
+  spec.add_dependency 'omniauth-oauth2', '~>1.5'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+end

data/spec/omniauth/strategies/quickbooks_oauth2_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe OmniAuth::Strategies::QuickbooksOauth2 do
+  context 'sandbox' do
+    it 'should default to sandbox' do
+      strat = OmniAuth::Strategies::QuickbooksOauth2.new('foo', 'bar')
+      expect(strat.send(:accounts_domain)).to eq('sandbox-accounts.platform.intuit.com')
+    end
+
+    it 'should respect the sandbox option' do
+      strat = OmniAuth::Strategies::QuickbooksOauth2.new('foo', 'bar', sandbox: true)
+      expect(strat.send(:accounts_domain)).to eq('sandbox-accounts.platform.intuit.com')
+
+      strat = OmniAuth::Strategies::QuickbooksOauth2.new('foo', 'bar', sandbox: false)
+      expect(strat.send(:accounts_domain)).to eq('accounts.platform.intuit.com')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'omniauth-quickbooks-oauth2'

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-quickbooks-oauth2
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha
+platform: ruby
+authors:
+- Abe Land
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  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'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: OAuth2 Omniauth straetgy for Quickbooks (Intuit) API.
+email:
+- codeclimbcoffee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-quickbooks-oauth2.rb
+- lib/omniauth-quickbooks-oauth2/version.rb
+- lib/omniauth/strategies/quickbooks_oauth2.rb
+- omniauth-quickbooks-oauth2.gemspec
+- spec/omniauth/strategies/quickbooks_oauth2_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/abeland/omniauth-quickbooks-oauth2
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: OAuth2 Omniauth strategy for Quickbooks.
+test_files: []