omniauth-pandadoc 1.0.0rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06cfebe1fad2882a1c9e1b3fe1f2e1e0e957c881
+  data.tar.gz: f74be53f1ea9e5dc7346472466323b0e655bfb01
+SHA512:
+  metadata.gz: 2fb588e165a4858fb0fbac0fee960e6531d52507f6789d3b5662c72d197e7de0229148a9c3f5bc69a9fcb0cf5b0cc5fe1b8a13a419251ed6b2016d8f4ee104ed
+  data.tar.gz: 278f165a6e9f7fd414c7a8d99edd16d9cb581049b8f07e126ee094790c7462daf5c9cd71e17318a447c1fc91153811f465a45aa10d4d6a919fd22d6e944ad3dc

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-gemset
+.ruby-version
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.powenv
+.idea/

data/.rubocop.yml

@@ -0,0 +1,23 @@
+ClassLength:
+  Enabled: false
+Layout/IndentHeredoc:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Naming:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+before_install:
+  - gem update bundler
+  - bundle --version
+  - gem update --system
+  - gem --version
+rvm:
+  - 2.5
+  - 2.4
+  - 2.3
+  - 2.2

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+## 1.0.0.rc1 (2018-07-12)
+
+  - first public gem release (@euanlau)

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# OmniAuth Pandadoc  [![Build Status](https://secure.travis-ci.org/CatchRelease/omniauth-pandadoc.svg?branch=master)](https://travis-ci.org/CatchRelease/omniauth-pandadoc) [![Gem Version](https://img.shields.io/gem/v/omniauth-pandadoc.svg)](https://rubygems.org/gems/omniauth-pandadoc)
+
+Pandadoc Strategy for OmniAuth.
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-pandadoc'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::Pandadoc` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.
+
+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 :pandadoc, ENV['PANDADOC_CLIENT_ID'], ENV['PANDADOC_CLIENT_SECRET']
+end
+```
+
+## Supported Rubies
+
+- Ruby MRI (2.2+)
+
+## License
+
+Copyright (c) 2018 by Euan Lau, Mike Carey
+
+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/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require File.join('bundler', 'gem_tasks')
+require File.join('rspec', 'core', 'rake_task')
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/omniauth-pandadoc.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth/pandadoc'

data/lib/omniauth/pandadoc.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'omniauth/pandadoc/version'
+require 'omniauth/strategies/pandadoc'

data/lib/omniauth/pandadoc/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Pandadoc
+    VERSION = '1.0.0rc1'
+  end
+end

data/lib/omniauth/strategies/pandadoc.rb

@@ -0,0 +1,22 @@
+require 'omniauth'
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    # Main class for Pandadoc OAuth2 strategy.
+    class Pandadoc < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = 'read+write'
+
+      option :client_options,
+             site: 'https://api.pandadoc.com/public/v1',
+             authorize_url: 'https://app.pandadoc.com/oauth2/authorize',
+             token_url: 'https://api.pandadoc.com/oauth2/access_token'
+
+      option :provider_ignores_state, true # this is needed for local testing
+
+      def request_phase
+        redirect client.auth_code.authorize_url({ redirect_uri: callback_url }.merge(options.authorize_params))
+      end
+    end
+  end
+end

data/omniauth-pandadoc.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require File.expand_path(
+  File.join('..', 'lib', 'omniauth', 'pandadoc', 'version'),
+  __FILE__
+)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-pandadoc'
+  gem.version       = OmniAuth::Pandadoc::VERSION
+  gem.license       = 'MIT'
+  gem.summary       = %(Pandadoc Strategy for OmniAuth)
+  gem.authors       = ['Mike Carey', 'Euan Lau']
+  gem.email         = ['euanlau@gmail.com']
+  gem.homepage      = 'https://github.com/catchandrelease/omniauth-pandadoc'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 2.2'
+
+  gem.add_runtime_dependency 'jwt', '~> 1.5'
+  gem.add_runtime_dependency 'omniauth', '~> 1.2'
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.5'
+
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'rspec', '~> 3.7'
+  gem.add_development_dependency 'rubocop', '~> 0.58'
+end

data/spec/omniauth/strategies/pandadoc_spec.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'json'
+require 'omniauth-pandadoc'
+
+describe OmniAuth::Strategies::Pandadoc do
+  let(:request) { double('Request', params: {}, cookies: {}, env: {}) }
+  let(:app) do
+    lambda do
+      [200, {}, ['Hello.']]
+    end
+  end
+
+  subject do
+    OmniAuth::Strategies::Pandadoc.new(app, 'appid', 'secret', @options || {}).tap do |strategy|
+      allow(strategy).to receive(:request) do
+        request
+      end
+    end
+  end
+
+  before do
+    OmniAuth.config.test_mode = true
+  end
+
+  after do
+    OmniAuth.config.test_mode = false
+  end
+
+  describe '#client_options' do
+    it 'has correct site' do
+      expect(subject.client.site).to eq('https://api.pandadoc.com/public/v1')
+    end
+
+    it 'has correct authorize_url' do
+      expect(subject.client.options[:authorize_url]).to eq('https://app.pandadoc.com/oauth2/authorize')
+    end
+
+    it 'has correct token_url' do
+      expect(subject.client.options[:token_url]).to eq('https://api.pandadoc.com/oauth2/access_token')
+    end
+
+    describe 'overrides' do
+      context 'as strings' do
+        it 'should allow overriding the site' do
+          @options = { client_options: { 'site' => 'https://example.com' } }
+          expect(subject.client.site).to eq('https://example.com')
+        end
+
+        it 'should allow overriding the authorize_url' do
+          @options = { client_options: { 'authorize_url' => 'https://example.com' } }
+          expect(subject.client.options[:authorize_url]).to eq('https://example.com')
+        end
+
+        it 'should allow overriding the token_url' do
+          @options = { client_options: { 'token_url' => 'https://example.com' } }
+          expect(subject.client.options[:token_url]).to eq('https://example.com')
+        end
+      end
+
+      context 'as symbols' do
+        it 'should allow overriding the site' do
+          @options = { client_options: { site: 'https://example.com' } }
+          expect(subject.client.site).to eq('https://example.com')
+        end
+
+        it 'should allow overriding the authorize_url' do
+          @options = { client_options: { authorize_url: 'https://example.com' } }
+          expect(subject.client.options[:authorize_url]).to eq('https://example.com')
+        end
+
+        it 'should allow overriding the token_url' do
+          @options = { client_options: { token_url: 'https://example.com' } }
+          expect(subject.client.options[:token_url]).to eq('https://example.com')
+        end
+      end
+    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' } }
+      expect(subject.token_params['foo']).to eq('bar')
+      expect(subject.token_params['baz']).to eq('zip')
+    end
+  end
+
+  describe '#token_options' do
+    it 'should include top-level options that are marked as :token_options' do
+      @options = { token_options: %i[scope foo], scope: 'bar', foo: 'baz', bad: 'not_included' }
+      expect(subject.token_params['scope']).to eq('bar')
+      expect(subject.token_params['foo']).to eq('baz')
+      expect(subject.token_params['bad']).to eq(nil)
+    end
+  end
+
+  describe '#callback_path' do
+    it 'has the correct default callback path' do
+      expect(subject.callback_path).to eq('/auth/pandadoc/callback')
+    end
+
+    it 'should set the callback_path parameter if present' do
+      @options = { callback_path: '/auth/foo/callback' }
+      expect(subject.callback_path).to eq('/auth/foo/callback')
+    end
+  end
+end

data/spec/rubocop_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'spec_helper'
+
+describe 'Rubocop' do
+  it 'should pass with no offenses detected' do
+    expect(`rubocop`).to include('no offenses detected')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require File.join('bundler', 'setup')
+require 'rspec'

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-pandadoc
+version: !ruby/object:Gem::Version
+  version: 1.0.0rc1
+platform: ruby
+authors:
+- Mike Carey
+- Euan Lau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  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: 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.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+description: 
+email:
+- euanlau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/omniauth-pandadoc.rb
+- lib/omniauth/pandadoc.rb
+- lib/omniauth/pandadoc/version.rb
+- lib/omniauth/strategies/pandadoc.rb
+- omniauth-pandadoc.gemspec
+- spec/omniauth/strategies/pandadoc_spec.rb
+- spec/rubocop_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/catchandrelease/omniauth-pandadoc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Pandadoc Strategy for OmniAuth
+test_files: []