omniauth-heap 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 555bf332f8e204e27a2534cd5f1eff604a00a8a836a633fd85503d9b6fd116ee
+  data.tar.gz: 492e30d8ae6119b76d94ea2fd81c8ca05677bf43ed83e2e861a7d76e91472084
+SHA512:
+  metadata.gz: 6384e8e59fce88a5da7bb21ea3806ee2d63eba2bec41db5432459800f576826c4a53d838c93369477157e37162a6b0c26601526fcc3310a00edba32653060090
+  data.tar.gz: 46785f37081a0a38af66ab933b1bbdb0ccc91f68df5c28a67fc2cfc67fbe25f597dbf6efd0acb4254846cb97d2a6ae3fe2e95230b1079a6e373a58882e1f42c6

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2021 Chameleon (Brian Norton)
+
+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,59 @@
+# OmniAuth Heap
+
+Heap OAuth2 Strategy for OmniAuth.
+
+Read the [Heap OAuth docs](https://github.com/heap/heap-partner-api-reference) for more details:
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-heap'
+```
+
+Then `bundle install`.
+
+## Usage
+
+`OmniAuth::Strategies::Heap` 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 :heap, ENV['OAUTH_HEAP_KEY'], ENV['OAUTH_HEAP_SECRET'], scope: 'segment'
+end
+```
+
+`segment` is the only currently supported Scope
+
+To start the authentication process with Heap you simply need to access `/auth/heap` route.
+
+## Callback URL
+
+You define a callback URL in Heap that is matched 1-1 (no query string parameters allowed).
+To make sure the value entered into Heap matches exactly, define the callback URL as and environment variable.
+
+```
+OAUTH_HEAP_CALLBACK_URL="https://auth.example.com/auth/heap/callback"
+```
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => 'heap',
+  :uid => nil,
+  :info => {
+    :name => nil
+  },
+  :credentials => {
+    :token => 'ehJy6IkiOiJFUzUxGcGnR5cMiXVCJ9.eyJqdGk47eiOiIc209c5eiJod431ce3272dd213a9...',
+    :expires => false
+  },
+  :extra => { }
+}
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+desc "Build the gem"
+task :build do
+  system "gem build omniauth-heap.gemspec"
+end
+
+desc "Build and release the gem"
+task :release => :build do
+  system "gem push omniauth-heap-#{OmniAuth::Heap::VERSION}.gem"
+end

data/lib/omniauth/heap/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Heap
+    VERSION = '0.1.2'
+  end
+end

data/lib/omniauth/heap.rb

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

data/lib/omniauth/strategies/heap.rb

@@ -0,0 +1,25 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Heap < OmniAuth::Strategies::OAuth2
+      option :name, 'heap'
+
+      args [:client_id, :client_secret]
+
+      option :client_options, {
+        site: 'https://heapanalytics.com',
+        authorize_url: 'https://heapanalytics.com/api/partner/oauth/authorize',
+        token_url: 'https://heapanalytics.com/api/partner/oauth/token'
+      }
+
+      option :auth_token_params, {
+        grant_type: 'authorization_code'
+      }
+
+      def callback_url
+        ENV['OAUTH_HEAP_CALLBACK_URL'] || (full_host + script_name + callback_path)
+      end
+    end
+  end
+end

data/lib/omniauth-heap.rb

@@ -0,0 +1 @@
+require 'omniauth/heap'

data/omniauth-heap.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/omniauth/heap/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'omniauth'
+  gem.add_dependency 'oauth2'
+  gem.add_dependency 'omniauth-oauth2'
+
+  gem.authors       = ['Brian Norton']
+  gem.email         = ['brian@trychameleon.com']
+  gem.description   = %q{An OmniAuth strategy for authenticating with the Heap API.}
+  gem.summary       = %q{OmniAuth strategy for authenticating with Heap.}
+  gem.homepage      = 'https://github.com/chamaeleonidae/omniauth-heap'
+  gem.license       = 'MIT'
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = 'omniauth-heap'
+  gem.require_paths = ['lib']
+  gem.version       = OmniAuth::Heap::VERSION
+end
+

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-heap
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Brian Norton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An OmniAuth strategy for authenticating with the Heap API.
+email:
+- brian@trychameleon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-heap.rb
+- lib/omniauth/heap.rb
+- lib/omniauth/heap/version.rb
+- lib/omniauth/strategies/heap.rb
+- omniauth-heap.gemspec
+homepage: https://github.com/chamaeleonidae/omniauth-heap
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: OmniAuth strategy for authenticating with Heap.
+test_files: []