omniauth-kit-oauth2 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8529d5736ce74dc031be2f0e5cffc87d20b5c3ce38af408eab6f3b711fb332a8
+  data.tar.gz: 8ef2571312d7fe0b212a85c68160f7c2c0af2faf5c3bdec3650a3315d79fd227
+SHA512:
+  metadata.gz: 1a1155fd0db3d54be69f7d7ac95f5515a0f18128c0d6e4fa31e994733f136e1a4e0a1c25bec71f11edfbb5b3825e15fc30c65eda4d42f00643b380722676037c
+  data.tar.gz: 1dc9fbd6350fb01d12aa91b890f6e67bf871faa261fad44c3c04cadf7d4d4882bc354efe0e7ca19e73a421ae2c5ef87b2b41d23d383bb0991e20ed913619e356

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2025 Kit
+
+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,70 @@
+# OmniAuth Kit OAuth2 Strategy
+
+Strategy to authenticate with Kit via OAuth2 in OmniAuth.
+
+Get your API key at: https://app.kit.com/account_settings/developer_settings Note the Client ID and the Client Secret.
+
+For more details, read the Developer docs: https://developers.kit.com/v4
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-kit-oauth2'
+```
+
+Then `bundle install`.
+
+## 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 :kit_oauth2, client_id: ENV.fetch("KIT_CLIENT_ID"),
+                        client_secret: ENV.fetch("KIT_CLIENT_SECRET")
+end
+```
+
+You can now access the OmniAuth Kit OAuth2 URL: `/auth/kit_oauth2`
+
+## Auth Hash
+
+Here's an example of an authentication hash available in the callback by accessing `request.env['omniauth.auth']`:
+
+```ruby
+{
+  "provider" => "kit_oauth2",
+  "uid" => 1,
+  "info" => {
+    "name" => "Creator",
+    "email" => "creator@example.com"
+  },
+  "credentials" => {
+    "token" => "abc123",
+    "refresh_token" => "def456",
+    "expires_at" => 123,
+    "expires" => true
+  },
+  "extra" => {
+    "raw_info" => {
+      "user" => {
+        "email" => "test@example.com"
+      },
+      "account" => {
+        "name" => "Kit Greetings",
+        "plan_type" => "creator",
+        "primary_email_address" => "test@example.com",
+        "created_at" => "2023-02-17T11:43:55Z",
+        "id" => 26
+      }
+    }
+  }
+}
+```
+
+## Publishing
+
+New versions are automatically published on push to main if
+lib/omniauth/kit_oauth2/version.rb is bumped.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/setup"
+require "bundler/gem_tasks"

data/lib/omniauth/kit_oauth2/version.rb

@@ -0,0 +1,7 @@
+module Omniauth
+  module Kit
+    module Oauth2
+      VERSION = "0.1.3"
+    end
+  end
+end

data/lib/omniauth/strategies/kit_oauth2.rb

@@ -0,0 +1,34 @@
+require "omniauth"
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class KitOauth2 < OmniAuth::Strategies::OAuth2
+      option :name, "kit_oauth2"
+      option :client_options, { site: "https://app.kit.com", api_site: "https://api.kit.com" }
+
+      uid do
+        raw_info["account"]["id"]
+      end
+
+      info do
+        {
+          name: raw_info["account"]["name"],
+          email: raw_info["account"]["primary_email_address"]
+        }
+      end
+
+      extra do
+        { raw_info: }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("#{options["client_options"]["api_site"]}/v4/account").parsed
+      end
+
+      def authorize_params
+        super.merge(tenant_name: request.params["tenant_name"])
+      end
+    end
+  end
+end

data/lib/omniauth-kit-oauth2.rb

@@ -0,0 +1 @@
+require "omniauth/strategies/kit_oauth2"

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-kit-oauth2
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Kit
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+description:
+email:
+- engineering@kit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-kit-oauth2.rb
+- lib/omniauth/kit_oauth2/version.rb
+- lib/omniauth/strategies/kit_oauth2.rb
+homepage: https://developers.kit.com
+licenses: []
+metadata:
+  homepage_uri: https://developers.kit.com
+  source_code_uri: https://github.com/Kit/omniauth-kit-oauth2/
+  changelog_uri: https://github.com/Kit/omniauth-kit-oauth2/
+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.5.22
+signing_key:
+specification_version: 4
+summary: Allows authenticating with Kit V4 API.
+test_files: []