omniauth-gohighlevel 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 00cb7b9008f98ec5ebb612a83d4d9dfac417aec37c8b3832b07820cc3f7925b6
+  data.tar.gz: a35c144c8d913c2ebea23a0a625ca185ffa39052095c6563dbf0d7c12da03938
+SHA512:
+  metadata.gz: 4519c2ba3a39f31e7bf97acb6bb20b1ea0fdb61edc443dd20d213c1c3f557863a1c05beff389393cf69d82d60af5a194aeafd37d5229194b59841634f757c094
+  data.tar.gz: 26c837359b748c87cab336900906a41747e0dae9581006550881334a5b745144166a239c53c99c457a235612082293834b3a9eb4a653440ea0a65c7111d6953b

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 2.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Michael Koper
+
+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,45 @@
+# Omniauth::Gohighlevel
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/omniauth/gohighlevel`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-gohighlevel'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install omniauth-gohighlevel
+
+## Usage
+
+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 :gohighlevel, ENV['GOHIGHLEVEL_CLIENT_ID'], ENV['GOHIGHLEVEL_CLIENT_SECRET'], {
+    scope: "contacts.write contacts.readonly invoices.readonly invoices.write products.readonly locations.readonly"
+  }
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/michaelkoper/omniauth-gohighlevel.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/omniauth/gohighlevel/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Omniauth
+  module Gohighlevel
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/gohighlevel.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative "gohighlevel/version"
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class Gohighlevel < OmniAuth::Strategies::OAuth2
+      option :name, "gohighlevel"
+
+      option :client_options, {
+        site: "https://marketplace.gohighlevel.com",
+        authorize_url: "https://marketplace.gohighlevel.com/oauth/chooselocation",
+        token_url: "https://services.leadconnectorhq.com/oauth/token"
+      }
+
+      option :authorize_params, {
+        response_type: "code",
+        user_type: "Location"
+      }
+
+      def build_access_token
+        verifier = request.params["code"]
+        @token = client.auth_code.get_token(
+          verifier,
+          {
+            redirect_uri: callback_url,
+            client_id: options.client_id,
+            client_secret: options.client_secret,
+            grant_type: "authorization_code",
+            user_type: "Location"
+          },
+          {headers: {"Accept" => "application/json"}}
+        )
+        @token
+      rescue ::OAuth2::Error => e
+        Rails.logger.error "OAuth2 Error: #{e.code} - #{e.description}"
+        Rails.logger.error "Response body: #{e.response.body}" if e.response
+        raise e
+      rescue => e
+        Rails.logger.error "Error during token exchange: #{e.class.name} - #{e.message}"
+        Rails.logger.error e.backtrace.join("\n")
+        raise e
+      end
+
+      def callback_phase
+        if request.params["error"] || request.params["error_reason"]
+          raise CallbackError.new(request.params["error"],
+            request.params["error_description"] || request.params["error_reason"], request.params["error_uri"])
+        elsif !request.params["code"]
+          fail!(:missing_code, OmniAuth::Error.new("Missing code parameter"))
+        else
+          options.token_params["redirect_uri"] = callback_url
+          super
+        end
+      rescue CallbackError => e
+        fail!(:invalid_credentials, e)
+      rescue ::OAuth2::Error, CallbackError => e
+        fail!(:invalid_credentials, e)
+      rescue ::Timeout::Error, ::Errno::ETIMEDOUT => e
+        fail!(:timeout, e)
+      rescue ::SocketError => e
+        fail!(:failed_to_connect, e)
+      end
+
+      def authorize_params
+        super.tap do |params|
+          params[:scope] = request.params["scope"] if request.params["scope"]
+          params[:user_type] = "Location"
+        end
+      end
+
+      uid { @token.params[:user_id] }
+
+      info do
+        {
+          user_id: raw_info["user_id"],
+          location_id: raw_info["location_id"]
+        }
+      end
+
+      extra do
+        {
+          "raw_info" => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.params.slice("company_id", "location_id", "user_id", "user_type")
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+    end
+  end
+end

data/omniauth-gohighlevel.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'lib/omniauth/gohighlevel/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'omniauth-gohighlevel'
+  spec.version = Omniauth::Gohighlevel::VERSION
+  spec.authors = ['Michael Koper']
+  spec.email = ['hello@michaelkoper.com']
+
+  spec.summary = 'Omniauth strategy for Gohighlevels'
+  spec.homepage = 'https://github.com/michaelkoper/omniauth-gohighlevels'
+  spec.description = spec.homepage
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'omniauth-oauth2', '~> 1.7.0'
+  spec.add_development_dependency 'standardrb'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/omniauth/gohighlevel.rbs

@@ -0,0 +1,6 @@
+module Omniauth
+  module Gohighlevel
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-gohighlevel
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Koper
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-16 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.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  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: https://github.com/michaelkoper/omniauth-gohighlevels
+email:
+- hello@michaelkoper.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth/gohighlevel.rb
+- lib/omniauth/gohighlevel/version.rb
+- omniauth-gohighlevel.gemspec
+- sig/omniauth/gohighlevel.rbs
+homepage: https://github.com/michaelkoper/omniauth-gohighlevels
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/michaelkoper/omniauth-gohighlevels
+  source_code_uri: https://github.com/michaelkoper/omniauth-gohighlevels
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Omniauth strategy for Gohighlevels
+test_files: []