omniauth-freshbooks-oauth2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58911d48ea8425c35b9b3c595beca0110b0a4cd5
+  data.tar.gz: bbffa187581950a51deffe7044e19f2f9ea7e1d7
+SHA512:
+  metadata.gz: bb752abc8243ce861aec620dc91cf066791429c4c8a2d24600c3d6ade7d1028bc8eb5e7ef48e9c3a459891623e8b4ab189f05b5465c71fa81a83891f00256f66
+  data.tar.gz: dd5fcdec9f2c64baa7d0e84697d6ee9c2e9cca67d762ef773bed85ecbfe566b5ee674ad0b9d85a1741114e33c488ab4017cc4a2c03dc05f72ba4256fb6f0d713

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/*.gem

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :development do
+  gem 'rubocop', '> 0.25'
+end
+
+group :test do
+  gem 'coveralls', :require => false
+  gem 'rack-test'
+  gem 'rspec', '~> 3.1.0'
+  gem 'simplecov', :require => false
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    omniauth-freshbooks-oauth2 (0.0.1)
+      omniauth (~> 1.2)
+      omniauth-oauth2 (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    coveralls (0.8.15)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (>= 1.6.0, < 2)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.12.2)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.5.7)
+    json (2.0.2)
+    jwt (1.5.6)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.8.1)
+      hashie (>= 3.4.6, < 3.6.0)
+      rack (>= 1.6.2, < 3)
+    omniauth-oauth2 (1.5.0)
+      oauth2 (~> 1.1)
+      omniauth (~> 1.2)
+    parser (2.3.1.4)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rainbow (2.1.0)
+    rake (11.3.0)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    rubocop (0.43.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.4.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.12.0)
+    unicode-display_width (1.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  omniauth-freshbooks-oauth2!
+  rack-test
+  rake
+  rspec (~> 3.1.0)
+  rubocop (> 0.25)
+  simplecov
+
+BUNDLED WITH
+   1.16.0

data/README.md

@@ -0,0 +1,19 @@
+# OmniAuth FreshBooks OAuth2
+
+This is the OmniAuth OAuth2 strategy for authentication to [FreshBooks](https://www.freshbooks.com/api/authentication).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-freshbooks-oauth2'
+```
+
+And then, you need to add the following to your `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :freshbooks, ENV['FRESHBOOKS_KEY'], ENV['FRESHBOOKS_SECRET'] 
+end
+```

data/Rakefile

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  task :rubocop do
+    $stderr.puts 'Rubocop is disabled'
+  end
+end
+
+task :default => [:spec, :rubocop]

data/lib/omniauth-freshbooks.rb

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

data/lib/omniauth/freshbooks/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Freshbooks
+    VERSION = '0.0.1'
+  end
+end

data/lib/omniauth/strategies/freshbooks.rb

@@ -0,0 +1,65 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Freshbooks < OmniAuth::Strategies::OAuth2
+      API_VERSION = 'alpha'.freeze
+
+      option :name, 'freshbooks'
+
+      option :client_options, {
+        site: 'https://api.freshbooks.com',
+        authorize_url: 'https://my.freshbooks.com/service/auth/oauth/authorize',
+        token_url: 'https://api.freshbooks.com/auth/oauth/token'
+      }
+
+      option :token_params, {
+        headers: { 'Api-Version' => API_VERSION }
+      }
+
+      uid { raw_info['id'] }
+
+      info do
+        {
+          email: raw_info['email'],
+          first_name: raw_info['name'],
+          last_name: raw_info['name']
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token
+                        .get('auth/api/v1/users/me', { headers: { 'Api-Version' => API_VERSION } })
+                        .parsed['response']
+      end
+
+      def callback_url(include_query_string = true)
+        url = full_host + script_name + callback_path
+
+        # Optional inclusion of query_string ensure the access token request redirect_uri is an exact match to the
+        # authorized redirect URI defined in FreshBooks
+        url += query_string if include_query_string
+
+        # Ensure valid request for localhost because FreshBooks doesn't authorize non ssl callbacks.
+        # The ssl response can then be altered from https:// to http:// manually for the purpose of testing.
+        # This is limitation is noted in "Redirect URI Limitations" section of their documentation:
+        # https://www.freshbooks.com/api/authentication
+        url.gsub('http://localhost', 'https://localhost')
+      end
+
+      def build_access_token
+        client.auth_code.get_token(
+          request.params["code"],
+          { redirect_uri: callback_url(false) }.merge(token_params.to_hash(symbolize_keys: true)),
+          deep_symbolize(options.auth_token_params)
+        )
+      end
+    end
+  end
+end

data/omniauth-freshbooks-oauth2.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'omniauth/freshbooks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'omniauth-freshbooks-oauth2'
+  spec.version       = OmniAuth::Freshbooks::VERSION
+  spec.authors       = ['Kevin Pheasey']
+  spec.email         = ['kevin@kpheasey.com']
+  spec.summary       = 'FreshBooks OAuth2 strategy for OmniAuth'
+  spec.description   = 'FreshBooks OAuth2 strategy for OmniAuth using the new FreshBooks API'
+  spec.homepage      = 'https://github.com/kp-software/omniauth-freshbooks-oauth2'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth', '~> 1.2'
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.1'
+
+  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-freshbooks-oauth2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Pheasey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: FreshBooks OAuth2 strategy for OmniAuth using the new FreshBooks API
+email:
+- kevin@kpheasey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/omniauth-freshbooks.rb
+- lib/omniauth/freshbooks/version.rb
+- lib/omniauth/strategies/freshbooks.rb
+- omniauth-freshbooks-oauth2.gemspec
+homepage: https://github.com/kp-software/omniauth-freshbooks-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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: FreshBooks OAuth2 strategy for OmniAuth
+test_files: []