omniauth-octobat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca7bf1054407693fbe9bd9b7a82f01deada5fb76
+  data.tar.gz: 63ac68c261785bc37bce920e3bb4ebd4d042d230
+SHA512:
+  metadata.gz: 143a16de568af02f692935a230c10e8bd2c9ec5c4794cef4e061f7f1a291ae44597a1547c0f4e0266c1b92d6206b6a61e3b0c0c709698dff8a18d92f8c887ac9
+  data.tar.gz: 1506021aeec8451eb7896b6c3e8459be44e8bafab2a527292efd6a8bd35ff50ae4600a946fc6d0e31d9f489efa6f76e42ede4f01d37a5dff9e5fd21f80b7425e

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gem 'rake'
+
+# Specify your gem's dependencies in omniauth-stripe-connect.gemspec
+gemspec
+
+group :test do
+  gem 'rspec', '>= 2.14'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2020 Octobat SAS
+
+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,113 @@
+# OmniAuth::Octobat
+
+Octobat OAuth2 Strategy for OmniAuth 1.0.
+
+Supports the OAuth 2.0 server-side and client-side flows.
+Read the Octobat Plaza docs for more details: https://www.octobat.com/developers/plaza-quickstart
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'omniauth-octobat'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install omniauth-octobat
+
+## Usage
+
+OmniAuth::Strategies::Octobat is simply a Rack middleware. Read the OmniAuth
+1.0 docs for detailed instructions: https://github.com/intridea/omniauth.
+
+### Non-Devise
+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 :octobat, ENV['OCTOBAT_APP_CLIENT_ID'], ENV['OCTOBAT_APP_SECRET']
+end
+```
+
+### Devise
+
+You need to declare the provider in your `config/initializers/devise.rb`:
+
+```ruby
+config.omniauth :octobat, "OCTOBAT_APP_CLIENT_ID", "OCTOBAT_APP_SECRET"
+```
+
+You'll also need to add some configuration to your devise model (e.g. User in `app/models/user.rb`) along with any other OmniAuth providers you might have:
+```ruby
+:omniauthable, :omniauth_providers => [:octobat]
+```
+
+### General Usage
+
+Your `OCTOBAT_APP_CLIENT_ID` is application-specific and your `OCTOBAT_APP_SECRET` is account-specific and may also be known as your Octobat application secret.
+
+Edit your `routes.rb` file to have:
+`devise_for :users, :controllers => { :omniauth_callbacks => "omniauth_callbacks" }`
+
+And create a file called `omniauth_callbacks_controller.rb` which should have this inside:
+```ruby
+class OmniauthCallbacksController < Devise::OmniauthCallbacksController
+
+  def octobat
+    # Delete the code inside of this method and write your own.
+    # The code below is to show you where to access the data.
+    raise request.env["omniauth.auth"].to_yaml
+  end
+end
+```
+
+Make sure to go to Octobat's Developers Settings > Applications and set your Redirect URL to:
+`http://localhost:3003/users/auth/octobat/callback`
+
+The Callback URL will be something similar:
+`http://www.yourdomain.com/users/auth/octobat/callback`
+
+Then you can hit `/auth/octobat`
+
+If you hit `/auth/octobat` with any query params, they will be passed along to Octobat API. You can access these params from `request.env['omniauth.params']`. Read [Octobat's OAuth Reference](https://www.octobat.com/developers/plaza-quickstart) for more information.
+
+## Auth Hash
+
+Here is an example of the Auth Hash you get back from calling `request.env['omniauth.auth']`:
+
+```ruby
+{
+  "provider"=>"octobat",
+  "uid"=>"<OCTOBAT_ACCOUNT_ID>",
+  "info"=> {
+    "livemode"=>false
+  },
+  "credentials"=> {
+    "token"=>"<OCTOBAT_ACCESS_TOKEN>",
+  },
+  "extra"=> {
+    "raw_info"=> {
+      "token_type"=>"bearer",
+      "octobat_account_id"=>"<OCTOBAT_ACCOUNT_ID>",
+      "livemode"=>false
+    },
+    "extra_info"=> {
+      "country"=>"US",
+    }
+  }
+}
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/lib/omniauth/octobat.rb

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

data/lib/omniauth/strategies/octobat.rb

@@ -0,0 +1,61 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Octobat < OmniAuth::Strategies::OAuth2
+      option :name, :octobat
+
+      option :client_options, {
+        :site => 'https://auth.octobat.com',
+        :authorize_path => '/oauth/authorize',
+        :access_token_path => '/oauth/token'
+      }
+
+      def raw_info
+        @raw_info ||= deep_symbolize(access_token.params)
+      end
+
+      def extra_info
+        @extra_info ||= deep_symbolize(access_token.get('/oauth/account').parsed)
+      end
+
+      uid { raw_info[:octobat_account_id] }
+
+      info do
+        { livemode: raw_info[:livemode] }
+      end
+
+      extra do
+        {
+          raw_info: raw_info,
+          extra_info: extra_info
+        }
+      end
+
+
+      #option :authorize_options, [:scope, :landing, :always_prompt]
+      #option :provider_ignores_state, true
+
+
+      # info do
+      #   {
+      #     :name => extra_info[:display_name] || extra_info[:business_name] || extra_info[:email],
+      #     :email => extra_info[:email],
+      #     :nickname => extra_info[:display_name],
+      #     :scope => raw_info[:scope],
+      #     :livemode => raw_info[:livemode],
+      #     :stripe_publishable_key => raw_info[:stripe_publishable_key]
+      #   }
+      # end
+      #
+      # extra do
+      #   e = {
+      #     :raw_info => raw_info
+      #   }
+      #   e[:extra_info] = extra_info unless skip_info?
+      #
+      #   e
+      # end
+    end
+  end
+end

data/lib/omniauth-octobat/version.rb

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

data/lib/omniauth-octobat.rb

@@ -0,0 +1,2 @@
+require "omniauth-octobat/version"
+require 'omniauth/octobat'

data/omniauth-octobat.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth-octobat/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gaultier Laperche"]
+  gem.email         = ["gaultier@octobat.com"]
+  gem.description   = %q{Octobat OAuth2 Strategy for OmniAuth 1.0.}
+  gem.summary       = %q{
+Supports the OAuth 2.0 server-side and client-side flows.
+Read the Octobat Plaza docs for more details: https://www.octobat.com/developers/plaza-quickstart
+}
+  gem.homepage      = "https://www.octobat.com/developers/plaza-quickstart"
+
+  gem.files         = `git ls-files | grep -v example`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "omniauth-octobat"
+  gem.require_paths = ["lib"]
+  gem.version       = OmniAuth::Octobat::VERSION
+  gem.license       = "MIT"
+
+  gem.add_dependency 'omniauth', '~> 1.3'
+  gem.add_dependency 'omniauth-oauth2', '~> 1.4'
+end

data/spec/omniauth/strategies/octobat_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe OmniAuth::Strategies::Octobat do
+  let(:fresh_strategy) { Class.new(OmniAuth::Strategies::Octobat) }
+
+
+  before(:each) do
+    OmniAuth.config.test_mode = true
+    @old_host = OmniAuth.config.full_host
+  end
+
+  after(:each) do
+    OmniAuth.config.full_host = @old_host
+    OmniAuth.config.test_mode = false
+  end
+
+  describe '#authorize_params' do
+    subject { fresh_strategy }
+
+    it 'should include redirect_uri if full_host is set' do
+      OmniAuth.config.full_host = 'https://foo.com/'
+      instance = subject.new('abc', 'def')
+
+      instance.authorize_params[:redirect_uri].should =~ /\Ahttps:\/\/foo\.com/
+    end
+
+    it 'should include redirect_uri if callback_path is set' do
+      # TODO: It would be nice to grab this from the request URL
+      # instead of setting it on the config
+      OmniAuth.config.full_host = 'https://foo.com/'
+      instance = subject.new('abc', 'def', :callback_path => 'bar/baz')
+
+      instance.authorize_params[:redirect_uri].should == 'https://foo.com/bar/baz'
+    end
+
+    it 'should not include redirect_uri by default' do
+      instance = subject.new('abc', 'def')
+
+      expect(instance.authorize_params[:redirect_uri]).to be_nil
+    end
+  end
+
+  describe '#token_params' do
+    subject { fresh_strategy }
+
+    # NOTE: We call authorize_params first in each of these methods
+    # since the OAuth2 gem uses it to setup some state for testing
+
+    it 'should include redirect_uri if full_host is set' do
+      OmniAuth.config.full_host = 'https://foo.com/'
+      instance = subject.new('abc', 'def')
+
+      instance.authorize_params
+      instance.token_params[:redirect_uri].should =~ /\Ahttps:\/\/foo\.com/
+    end
+
+    it 'should include redirect_uri if callback_path is set' do
+      # TODO: It would be nice to grab this from the request URL
+      # instead of setting it on the config
+      OmniAuth.config.full_host = 'https://foo.com/'
+      instance = subject.new('abc', 'def', :callback_path => 'bar/baz')
+
+      instance.authorize_params
+      instance.token_params[:redirect_uri].should == 'https://foo.com/bar/baz'
+    end
+
+    it 'should not include redirect_uri by default' do
+      instance = subject.new('abc', 'def')
+
+      instance.authorize_params
+      expect(instance.token_params[:redirect_uri]).to be_nil
+    end
+  end
+
+  describe '#callback_url' do
+    subject { fresh_strategy }
+    OmniAuth.config.full_host = 'https://foo.com/'
+
+    it 'returns a url with the host and path' do
+      instance = subject.new('abc', 'def', :callback_path => 'bar/baz')
+      instance.authorize_params
+      expect(instance.callback_url).to eq 'https://foo.com/bar/baz'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'omniauth-octobat'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-octobat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gaultier Laperche
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-15 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.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Octobat OAuth2 Strategy for OmniAuth 1.0.
+email:
+- gaultier@octobat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-octobat.rb
+- lib/omniauth-octobat/version.rb
+- lib/omniauth/octobat.rb
+- lib/omniauth/strategies/octobat.rb
+- omniauth-octobat.gemspec
+- spec/omniauth/strategies/octobat_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.octobat.com/developers/plaza-quickstart
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: 'Supports the OAuth 2.0 server-side and client-side flows. Read the Octobat
+  Plaza docs for more details: https://www.octobat.com/developers/plaza-quickstart'
+test_files:
+- spec/omniauth/strategies/octobat_spec.rb
+- spec/spec_helper.rb