omniauth-hubspot-full 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3bba68321e58b233f0d7c03dee5fddd9e0ed3282
+  data.tar.gz: acc52268337f08654f3c9daa145914638b9e8c18
+SHA512:
+  metadata.gz: 8964b02fd174693824cbe67b4857c3c4e3c47bb98b455486004242b1ef981764db46ad83daaa864b023686d890dac883f9d78aafabd84858b59467b193e94048
+  data.tar.gz: 00bc3a728afb06e17ad1b2dc205a313caea2c9a05f74f533ced3a92fbddc3255a784ddaf66f9c06fd8d4b3bba554c2e13a9fd42353b63e5dde2ff4be83e1689f

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2018 romanos
+
+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,80 @@
+# Omniauth::Hubspot
+
+This Gem contains the Hubspot strategy for OmniAuth.
+
+## Before You Begin
+
+You should have already installed OmniAuth into your app; if not, read the [OmniAuth README](https://github.com/omniauth/omniauth) to get started.
+
+Now sign into the [Hubspot Developer Dashboard](https://developers.hubspot.com/) and create an application. Take note of your API keys.
+
+
+## Using This Strategy
+
+First start by adding this gem to your Gemfile:
+
+```ruby
+gem 'omniauth-hubspot-full'
+```
+
+If you need to use the latest HEAD version, you can do so with:
+
+```ruby
+gem 'omniauth-hubspot-full', github: 'romanos/omniauth-hubspot'
+```
+
+Next, tell OmniAuth about this provider. For a Rails app, your `config/initializers/omniauth.rb` file should look like this:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :hubspot, 'API_KEY', 'API_SECRET', scope: 'contacts timeline'
+end
+```
+
+Replace `'API_KEY'` and `'API_SECRET'` with the appropriate values you obtained earlier.
+
+If you are using [Devise](https://github.com/plataformatec/devise) then it will look like this:
+
+```ruby
+Devise.setup do |config|
+  # other stuff...
+
+  config.omniauth :hubspot, ENV['HUBSPOT_APP_ID'], ENV['HUBSPOT_APP_SECRET'], scope: 'contacts timeline'
+
+  # other stuff...
+end
+```
+
+
+## Scopes
+Hubspot lets you choose from a [few different scopes](https://developers.hubspot.com/docs/methods/oauth2/initiate-oauth-integration#scopes).
+
+## Hubspot Information
+
+Querying the access token endpoint as defined [here](https://developers.hubspot.com/docs/methods/oauth2/get-access-token-information) returns a basic hash of user info and allowed scopes.
+
+```json
+{
+  "token": "CJSP5qf1KhICAQEYs-gDIIGOBii1hQIyGQAf3xBKmlwHjX7OIpuIFEavB2-qYAGQsF4",
+  "user": "test@hubspot.com",
+  "hub_domain": "demo.hubapi.com",
+  "scopes": [
+    "contacts",
+    "automation",
+    "oauth"
+  ],
+  "hub_id": 62515,
+  "app_id": 456,
+  "expires_in": 21588,
+  "user_id": 123,
+  "token_type": "access"
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |task|
+  task.libs << "test"
+end
+
+task :default => :test

data/lib/omniauth-hubspot-full.rb

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

data/lib/omniauth-hubspot/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Hubspot
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth/strategies/hubspot.rb

@@ -0,0 +1,96 @@
+require 'omniauth/strategies/oauth2'
+require 'uri'
+require 'rack/utils'
+
+module OmniAuth
+  module Strategies
+    class Hubspot < OmniAuth::Strategies::OAuth2
+      option :name, 'hubspot'
+
+      option :authorize_options, [:scope]
+
+      option :client_options, {
+        site:           'https://api.hubapi.com',
+        authorize_url:  'https://app.hubspot.com/oauth/authorize',
+        token_url:      '/oauth/v1/token'
+      }
+
+      option :auth_token_params, {
+        mode: :query,
+        param_name: 'token'
+      }
+
+      # User ID is not guaranteed to be globally unique across all Hubspot users.
+      # The combination of user ID and Hub ID, on the other hand, is guaranteed
+      # to be globally unique.
+      uid { "#{identity['user_id']}-#{identity['hub_id']}" }
+
+      # Make sure to record refresh token
+      credentials do
+        {
+          token:          access_token.token,
+          refresh_token:  access_token.refresh_token,
+          expires_at:     access_token.expires_at,
+          expires_in:     access_token.expires_in,
+          expires:        access_token.expires?
+        }
+      end
+
+      # {
+      #   "token": "CJSP5qf1KhICAQEYs-gDIIGOBii1hQIyGQAf3xBKmlwHjX7OIpuIFEavB2-qYAGQsF4",
+      #   "user": "test@hubspot.com",
+      #   "hub_domain": "demo.hubapi.com",
+      #   "scopes": [
+      #     "contacts",
+      #     "automation",
+      #     "oauth"
+      #   ],
+      #   "hub_id": 62515,
+      #   "app_id": 456,
+      #   "expires_in": 21588,
+      #   "user_id": 123,
+      #   "token_type": "access"
+      # }
+
+      info do
+        {
+          user_id:    identity['user_id'],
+          user:       identity['user'],    
+          hub_id:     identity['hub_id'],
+          hub_domain: identity['image_48'], 
+          app_id:     identity['app_id'],
+          scopes:     identity['scopes']
+
+        }
+      end
+
+      extra do
+        {
+          raw_info: {
+            identity: identity
+          }
+        }
+      end
+
+      def authorize_params
+        super.tap do |params|
+          %w[scope].each do |v|
+            if request.params[v]
+              params[v.to_sym] = request.params[v]
+            end
+          end
+        end
+      end
+
+      def identity
+        @identity ||= access_token.get("/oauth/v1/access-tokens/#{access_token.token}").parsed
+      end
+
+      #private
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+    end
+  end
+end

data/omniauth-hubspot-full.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+require File.expand_path('../lib/omniauth-hubspot/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-hubspot-full"
+  spec.version       = Omniauth::Hubspot::VERSION
+  spec.authors       = ["romanos"]
+  spec.email         = ["romanos@jargon.ai"]
+  spec.description   = %q{OmniAuth strategy for Hubspot (borrowed heavily from @kmrshntr)}
+  spec.summary       = %q{OmniAuth strategy for Hubspot (borrowed heavily from @kmrshntr)}
+  spec.homepage      = "https://github.com/romanos/omniauth-hubspot.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth-oauth2', "~> 1.5"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
+end

data/test/helper.rb

@@ -0,0 +1,57 @@
+require "bundler/setup"
+require "minitest/autorun"
+require "mocha/setup"
+require "omniauth/strategies/hubspot"
+
+OmniAuth.config.test_mode = true
+
+module BlockTestHelper
+  def test(name, &blk)
+    method_name = "test_#{name.gsub(/\s+/, "_")}"
+    raise "Method already defined: #{method_name}" if instance_methods.include?(method_name.to_sym)
+    define_method method_name, &blk
+  end
+end
+
+module CustomAssertions
+  def assert_has_key(key, hash, msg = nil)
+    msg = message(msg) { "Expected #{hash.inspect} to have key #{key.inspect}" }
+    assert hash.has_key?(key), msg
+  end
+
+  def refute_has_key(key, hash, msg = nil)
+    msg = message(msg) { "Expected #{hash.inspect} not to have key #{key.inspect}" }
+    refute hash.has_key?(key), msg
+  end
+end
+
+class TestCase < Minitest::Test
+  extend BlockTestHelper
+  include CustomAssertions
+end
+
+class StrategyTestCase < TestCase
+  def setup
+    @request = stub("Request")
+    @request.stubs(:params).returns({})
+    @request.stubs(:cookies).returns({})
+    @request.stubs(:env).returns({})
+    @request.stubs(:scheme).returns({})
+    @request.stubs(:ssl?).returns(false)
+
+    @client_id = "123"
+    @client_secret = "53cr3tz"
+    @options = {}
+  end
+
+  def strategy
+    @strategy ||= begin
+      args = [@client_id, @client_secret, @options].compact
+      OmniAuth::Strategies::Hubspot.new(nil, *args).tap do |strategy|
+        strategy.stubs(:request).returns(@request)
+      end
+    end
+  end
+end
+
+Dir[File.expand_path("../support/**/*", __FILE__)].each(&method(:require))

data/test/support/shared_examples.rb

@@ -0,0 +1,85 @@
+# NOTE it would be useful if this lived in omniauth-oauth2 eventually
+module OAuth2StrategyTests
+  def self.included(base)
+    base.class_eval do
+      include ClientTests
+      include AuthorizeParamsTests
+      include CSRFAuthorizeParamsTests
+      include TokenParamsTests
+    end
+  end
+
+  module ClientTests
+    extend BlockTestHelper
+
+    test "should be initialized with symbolized client_options" do
+      @options = { :client_options => { "authorize_url" => "https://example.com" } }
+      assert_equal "https://example.com", strategy.client.options[:authorize_url]
+    end
+  end
+
+  module AuthorizeParamsTests
+    extend BlockTestHelper
+
+    test "should include any authorize params passed in the :authorize_params option" do
+      @options = { :authorize_params => { :foo => "bar", :baz => "zip" } }
+      assert_equal "bar", strategy.authorize_params["foo"]
+      assert_equal "zip", strategy.authorize_params["baz"]
+    end
+
+    test "should include top-level options that are marked as :authorize_options" do
+      @options = { :authorize_options => [:scope, :foo], :scope => "bar", :foo => "baz" }
+      assert_equal "bar", strategy.authorize_params["scope"]
+      assert_equal "baz", strategy.authorize_params["foo"]
+    end
+
+    test "should exclude top-level options that are not passed" do
+      @options = { :authorize_options => [:bar] }
+      refute_has_key :bar, strategy.authorize_params
+      refute_has_key "bar", strategy.authorize_params
+    end
+  end
+
+  module CSRFAuthorizeParamsTests
+    extend BlockTestHelper
+
+    test "should store random state in the session when none is present in authorize or request params" do
+      assert_includes strategy.authorize_params.keys, "state"
+      refute_empty strategy.authorize_params["state"]
+      refute_empty strategy.session["omniauth.state"]
+      assert_equal strategy.authorize_params["state"], strategy.session["omniauth.state"]
+    end
+
+    test "should not store state in the session when present in authorize params vs. a random one" do
+      @options = { :authorize_params => { :state => "bar" } }
+      refute_empty strategy.authorize_params["state"]
+      refute_equal "bar", strategy.authorize_params[:state]
+      refute_empty strategy.session["omniauth.state"]
+      refute_equal "bar", strategy.session["omniauth.state"]
+    end
+
+    test "should not store state in the session when present in request params vs. a random one" do
+      @request.stubs(:params).returns({ "state" => "foo" })
+      refute_empty strategy.authorize_params["state"]
+      refute_equal "foo", strategy.authorize_params[:state]
+      refute_empty strategy.session["omniauth.state"]
+      refute_equal "foo", strategy.session["omniauth.state"]
+    end
+  end
+
+  module TokenParamsTests
+    extend BlockTestHelper
+
+    test "should include any authorize params passed in the :token_params option" do
+      @options = { :token_params => { :foo => "bar", :baz => "zip" } }
+      assert_equal "bar", strategy.token_params["foo"]
+      assert_equal "zip", strategy.token_params["baz"]
+    end
+
+    test "should include top-level options that are marked as :token_options" do
+      @options = { :token_options => [:scope, :foo], :scope => "bar", :foo => "baz" }
+      assert_equal "bar", strategy.token_params["scope"]
+      assert_equal "baz", strategy.token_params["foo"]
+    end
+  end
+end

data/test/test.rb

@@ -0,0 +1,118 @@
+require "helper"
+require "omniauth-hubspot-full"
+
+class StrategyTest < StrategyTestCase
+  include OAuth2StrategyTests
+end
+
+class ClientTest < StrategyTestCase
+  test "has correct Hubspot API site" do
+    assert_equal "https://api.hubapi.com", strategy.client.site
+  end
+
+  test "has correct authorize url" do
+    assert_equal "https://app.hubspot.com/oauth/authorize", strategy.client.options[:authorize_url]
+  end
+
+  test "has correct token url" do
+    assert_equal "/oauth/v1/token", strategy.client.options[:token_url]
+  end
+end
+
+class CallbackUrlTest < StrategyTestCase
+  test "returns the default callback url" do
+    url_base = "http://auth.request.com"
+    @request.stubs(:url).returns("#{url_base}/some/page")
+    strategy.stubs(:script_name).returns("") # as not to depend on Rack env
+    assert_equal "#{url_base}/auth/hubspot/callback", strategy.callback_url
+  end
+
+  test "returns path from callback_path option" do
+    @options = { :callback_path => "/auth/hubspot/done"}
+    url_base = "http://auth.request.com"
+    @request.stubs(:url).returns("#{url_base}/page/path")
+    strategy.stubs(:script_name).returns("") # as not to depend on Rack env
+    assert_equal "#{url_base}/auth/hubspot/done", strategy.callback_url
+  end
+end
+
+class UidTest < StrategyTestCase
+  def setup
+    super
+    strategy.stubs(:identity).returns({"user_id" => "U123", "hub_id" => "H456"})
+  end
+
+  test "returns the user ID from user_identity" do
+    assert_equal "U123-H456", strategy.uid
+  end
+end
+
+class CredentialsTest < StrategyTestCase
+  def setup
+    super
+    @access_token = stub("OAuth2::AccessToken")
+    @access_token.stubs(:token)
+    @access_token.stubs(:expires?)
+    @access_token.stubs(:expires_at)
+    @access_token.stubs(:expires_in)
+    @access_token.stubs(:refresh_token)
+    strategy.stubs(:access_token).returns(@access_token)
+  end
+
+  test "returns a Hash" do
+    assert_kind_of Hash, strategy.credentials
+  end
+
+  test "returns the token" do
+    @access_token.stubs(:token).returns("123")
+    assert_equal "123", strategy.credentials["token"]
+  end
+
+  test "returns the expiry status" do
+    @access_token.stubs(:expires?).returns(true)
+    assert strategy.credentials["expires"]
+
+    @access_token.stubs(:expires?).returns(false)
+    refute strategy.credentials["expires"]
+  end
+
+  test "returns the refresh token and expiry time when expiring" do
+    ten_mins_from_now = (Time.now + 600).to_i
+    @access_token.stubs(:expires?).returns(true)
+    @access_token.stubs(:refresh_token).returns("321")
+    @access_token.stubs(:expires_at).returns(ten_mins_from_now)
+    assert_equal "321", strategy.credentials["refresh_token"]
+    assert_equal ten_mins_from_now, strategy.credentials["expires_at"]
+  end
+
+  test "does not return the refresh token when test is nil and expiring" do
+    @access_token.stubs(:expires?).returns(true)
+    @access_token.stubs(:refresh_token).returns(nil)
+    assert_nil strategy.credentials["refresh_token"]
+    refute_has_key "refresh_token", strategy.credentials
+  end
+
+  test "does not return the refresh token when not expiring" do
+    @access_token.stubs(:expires?).returns(false)
+    @access_token.stubs(:refresh_token).returns("XXX")
+    assert_nil strategy.credentials["refresh_token"]
+    refute_has_key "refresh_token", strategy.credentials
+  end
+end
+
+class UserInfoTest < StrategyTestCase
+
+  def setup
+    super
+    @access_token = stub("OAuth2::AccessToken")
+    @access_token.stubs(:token).returns("1234")
+    strategy.stubs(:access_token).returns(@access_token)
+  end
+
+  test "performs a GET to https://api.hubapi.com/oauth/v1/access-tokens/" do
+    @access_token.expects(:get).with("/oauth/v1/access-tokens/#{@access_token.token}")
+      .returns(stub_everything("OAuth2::Response"))
+    strategy.identity
+  end
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-hubspot-full
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- romanos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-05 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OmniAuth strategy for Hubspot (borrowed heavily from @kmrshntr)
+email:
+- romanos@jargon.ai
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-hubspot-full.rb
+- lib/omniauth-hubspot/version.rb
+- lib/omniauth/strategies/hubspot.rb
+- omniauth-hubspot-full.gemspec
+- test/helper.rb
+- test/support/shared_examples.rb
+- test/test.rb
+homepage: https://github.com/romanos/omniauth-hubspot.git
+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.13
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for Hubspot (borrowed heavily from @kmrshntr)
+test_files:
+- test/helper.rb
+- test/support/shared_examples.rb
+- test/test.rb