omniauth-gong 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed1c0269bb97b31f7c699e195e46bb5ba470be7830901953523e9c6c3cc493e9
+  data.tar.gz: bff5d9ff8c2c85234c7edb3c6f6dc5cd25113eeca6f3f3d9b1313f54f7e58613
+SHA512:
+  metadata.gz: 4ccd484f7713a73df8f407dbe3959a21e28b3908a601e84349e3fc4bfc9060c006c74dcd586b18030888d9357a5b816e889124d68e792cb848dc5a8dba36d895
+  data.tar.gz: 8087fb9bc669fab8902b1984f061984845d91ff44026afefe1f6081c4eb04a507c10813c802ba9debe7f6f4c5465444e1e2408564343ffa856ef884211751344

data/.github/worflows/main.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - name: Install dependencies
+      run: bundle install
+    - name: Run rubocop
+      run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.rubocop.yml

@@ -0,0 +1,3 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.2

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.2

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    omniauth-gong (1.0.0)
+      omniauth (~> 2.0)
+      omniauth-oauth2 (~> 1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashie (5.0.0)
+    json (2.6.3)
+    jwt (2.6.0)
+    multi_xml (0.6.0)
+    oauth2 (2.0.9)
+      faraday (>= 0.17.3, < 3.0)
+      jwt (>= 1.0, < 3.0)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0)
+      version_gem (~> 1.1)
+    omniauth (2.1.1)
+      hashie (>= 3.4.6)
+      rack (>= 2.2.3)
+      rack-protection
+    omniauth-oauth2 (1.8.0)
+      oauth2 (>= 1.4, < 3)
+      omniauth (~> 2.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rack (3.0.4.1)
+    rack-protection (3.0.5)
+      rack
+    rainbow (3.1.1)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rubocop (1.43.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    snaky_hash (2.0.1)
+      hashie
+      version_gem (~> 1.1, >= 1.1.1)
+    unicode-display_width (2.4.2)
+    version_gem (1.1.1)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  omniauth-gong!
+  rubocop (~> 1.42)
+
+BUNDLED WITH
+   2.3.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Matija Čupić
+
+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,62 @@
+[![Gem Version](https://badge.fury.io/rb/omniauth-gong.svg)](https://badge.fury.io/rb/omniauth-gong)
+
+# OmniAuth Gong Strategy
+
+Strategy to authenticate with Gong via OAuth2 in OmniAuth.
+
+You can get your OAuth app client id and secret from - <https://us-55616.app.gong.io/company/api-authentication>
+
+Gong OAuth app docs - <https://help.gong.io/hc/en-us/articles/360056677792-Create-an-app-for-Gong>
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-gong'
+```
+
+Then `bundle install`.
+
+## Gong API Setup
+
+* Go to [`https://us-55616.app.gong.io/company/api-authentication`](https://us-55616.app.gong.io/company/api-authentication)
+* Follow the instructions in <https://help.gong.io/hc/en-us/articles/360056677792-Create-an-app-for-Gong>
+
+## Usage
+
+Here's an example for adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :gong,
+    Rails.application.credentials.dig(:gong, :client_id),
+    Rails.application.credentials.dig(:gong, :client_secret),
+    scope: 'api:calls:read:basic'
+end
+```
+
+You can now access the OmniAuth Gong URL: `/auth/gong`
+
+NOTE: While developing your application, if you change the scope in the initializer you will need to restart your app server.
+
+## Configuration
+
+You can configure several options, which you pass in to the `provider` method via a hash:
+
+* `scope`: A space-separated list of permissions you want to request from the user.
+
+Here's an example of a possible configuration 
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :gong,
+    Rails.application.credentials.dig(:gong, :client_id),
+    Rails.application.credentials.dig(:gong, :client_secret),
+    scope: 'api:calls:read:extensive api:calls:read:media-url'
+end
+```
+
+## License
+
+See [LICENSE](LICENSE)

data/lib/omniauth/gong/version.rb

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

data/lib/omniauth/gong.rb

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

data/lib/omniauth/strategies/gong.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    # Authentication strategy for connecting with APIs constructed using
+    # the [OAuth 2.0 Specification](http://tools.ietf.org/html/draft-ietf-oauth-v2-10).
+    # You must generally register your application with the provider and
+    # utilize an application id and secret in order to authenticate using
+    # OAuth 2.0.
+    class Gong < OmniAuth::Strategies::OAuth2
+      option :name, 'gong'
+      option :client_options, { site: 'https://app.gong.io', authorize_url: '/oauth2/authorize', token_url: '/oauth2/generate-token' }
+      option :pkce, false
+
+      private
+
+      def callback_url
+        full_host + callback_path
+      end
+
+      def token_params
+        auth_header = "Basic #{Base64.strict_encode64("#{options.client_id}:#{options.client_secret}")}"
+        super.merge(headers: { Authorization: auth_header })
+      end
+    end
+  end
+end

data/lib/omniauth_gong.rb

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

data/omniauth-gong.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require File.expand_path(
+  File.join('..', 'lib', 'omniauth', 'gong', 'version'),
+  __FILE__
+)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'omniauth-gong'
+  gem.version       = OmniAuth::Gong::VERSION
+  gem.license       = 'MIT'
+  gem.summary       = %(A Gong OAuth2 strategy for OmniAuth 1.x)
+  gem.description   = %(A Gong OAuth2 strategy for OmniAuth 1.x. This allows you to login to Gong with your ruby app.)
+  gem.authors       = ['Matija Čupić']
+  gem.email         = ['matteeyah@gmail.com']
+  gem.homepage      = 'https://github.com/matteeyah/omniauth-gong'
+
+  gem.metadata['rubygems_mfa_required'] = 'true'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '>= 2.2'
+
+  gem.add_runtime_dependency 'omniauth', '~> 2.0'
+  gem.add_runtime_dependency 'omniauth-oauth2', '~> 1.7'
+
+  gem.add_development_dependency 'rubocop', '~> 1.42'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-gong
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matija Čupić
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.42'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.42'
+description: A Gong OAuth2 strategy for OmniAuth 1.x. This allows you to login to
+  Gong with your ruby app.
+email:
+- matteeyah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/worflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/omniauth/gong.rb
+- lib/omniauth/gong/version.rb
+- lib/omniauth/strategies/gong.rb
+- lib/omniauth_gong.rb
+- omniauth-gong.gemspec
+homepage: https://github.com/matteeyah/omniauth-gong
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+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: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A Gong OAuth2 strategy for OmniAuth 1.x
+test_files: []