omniauth-kick 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ac59985ea17ac5c8be6cdc5312f15de8bdab09c056c5fd7b96c3212545c1d5c
+  data.tar.gz: 5240afc89c5d218eca8d590c6cb98c7b6010a83c8cf7a3f5ba8da6ae95bd3ef9
+SHA512:
+  metadata.gz: 3e5a5799ca4fec5f51b57c2e9a0818e8ecd7aa27836d0ea265b9762a8e23a02ccc2592ffccbd4b8a1d12eba895732e31405b5e909251f16910a45ff0a54211cc
+  data.tar.gz: 8833cc385fbfd7af93cd0004d4aec74661723f48e1e0579eb6e3bcd3f7ecd5904b191e912f8c2d38528856833c343f1cce8de9d8d7a911107748d9a8ae9a6a12

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in omniauth-twitch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2025 Dean Perry
+
+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,44 @@
+# OmniAuth::Kick
+
+A OmniAuth strategy for Kick
+
+## Installation
+
+Add the OmniAuth Kick and OmniAuth `rails_csrf_protection` gems to your Gemfile
+
+```ruby
+gem 'omniauth-kick'
+gem 'omniauth-rails_csrf_protection'
+```
+
+## 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 :kick, ENV["KICK_CLIENT_ID"], ENV["KICK_CLIENT_SECRET"]
+end
+```
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  provider: 'kick',
+  uid: '12345678',
+  info: {
+    name: 'JohnDoe',
+    email: 'johndoe@gmail.com',
+    image: 'https://kick.com/img/default-profile-pictures/default-avatar-6.webp',
+    url: 'https://kick.com/johndoe'
+  },
+  credentials: {
+    token: 'asdfghjklasdfghjklasdfghjkl', # OAuth 2.0 access_token, which you may wish to store
+    expires: false # this will always be false,
+    refresh_token: 'asdschbjh24h23yfsjfhbsjdc3a' # OAuth 2.0 refresh token, to renew the access token when it expires
+  }
+}
+```

data/Rakefile

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

data/lib/omniauth/kick/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Kick
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/kick.rb

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

data/lib/omniauth/strategies/kick.rb

@@ -0,0 +1,117 @@
+require 'omniauth-oauth2'
+require 'securerandom'
+require 'digest'
+
+module OmniAuth
+  module Strategies
+    class Kick < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "user:read".freeze
+
+      option :name, "kick"
+
+      option :client_options, {
+        site: "https://id.kick.com",
+        authorize_url: "/oauth/authorize",
+        token_url: "/oauth/token"
+      }
+
+      option :access_token_options, {
+        header_format: "Bearer %s",
+        param_name: "access_token"
+      }
+
+      option :authorize_options, [:scope]
+
+      def request_phase
+        redirect client.auth_code.
+          authorize_url({ redirect_uri: callback_url }.merge(authorize_params)).
+          gsub(/%2[b,B]/, "+")
+      end
+
+      credentials do
+        hash = { "token" => access_token.token }
+        if access_token.refresh_token
+          hash["refresh_token"] = access_token.refresh_token
+        end
+        hash["expires_at"] = access_token.expires_at if access_token.expires?
+        hash["expires"] = access_token.expires?
+        hash
+      end
+
+      uid { raw_info["user_id"] }
+
+      info do
+        {
+          name: raw_info["name"],
+          email: raw_info["email"],
+          image: raw_info["profile_picture"],
+          url: "https://kick.com/#{raw_info['name']}"
+        }
+      end
+
+      def raw_info
+        @raw_info ||=
+          access_token.get("https://api.kick.com/public/v1/users").parsed.
+          fetch("data").fetch(0)
+      end
+
+      def build_access_token
+        verifier = code_verifier
+        client.auth_code.get_token(
+          request.params['code'],
+          {
+            redirect_uri: callback_url,
+            code_verifier: verifier
+          }.merge(token_params),
+          deep_symbolize(options.auth_token_params)
+        )
+      end
+
+      def access_token_options
+        options.access_token_options.inject({}) { |h,(k,v)| h[k.to_sym] = v; h }
+      end
+
+      def callback_url
+        return options[:redirect_uri] unless options[:redirect_uri].nil?
+        full_host + script_name + callback_path
+      end
+
+      def authorize_params
+        super.tap do |params|
+          options[:authorize_options].each do |k|
+            params[k] = request.params[k.to_s] unless [nil, ''].include?(request.params[k.to_s])
+          end
+          params[:scope] = params[:scope] || DEFAULT_SCOPE
+          params[:code_challenge] = generate_code_challenge
+          params[:code_challenge_method] = "S256"
+        end
+      end
+
+      private
+
+      def generate_code_challenge
+        verifier = code_verifier
+        Digest::SHA256.base64digest(verifier).tr('+/', '-_').tr('=', '')
+      end
+
+      def code_verifier
+        "To verify PKCE challenge code created"
+      end
+
+      def token_params
+        {
+          grant_type: 'authorization_code',
+          client_id: client.id,
+          client_secret: client.secret,
+          redirect_uri: callback_url
+        }
+      end
+
+      def deep_symbolize(hash)
+        hash.each_with_object({}) do |(key, value), result|
+          result[key.to_sym] = value.is_a?(Hash) ? deep_symbolize(value) : value
+        end
+      end
+    end
+  end
+end

data/lib/omniauth-kick.rb

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

data/omniauth-kick.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/kick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-kick"
+  spec.version       = OmniAuth::Kick::VERSION
+  spec.authors       = ["Dean Perry"]
+  spec.email         = ["dean@deanpcmad.com"]
+  spec.summary       = "Kick OAuth2 Strategy for OmniAuth"
+  spec.homepage      = "https://github.com/deanpcmad/omniauth-kick"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth-oauth2', '~> 1.8'
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-kick
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+bindir: bin
+cert_chain: []
+date: 1980-01-02 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.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-kick.rb
+- lib/omniauth/kick.rb
+- lib/omniauth/kick/version.rb
+- lib/omniauth/strategies/kick.rb
+- omniauth-kick.gemspec
+homepage: https://github.com/deanpcmad/omniauth-kick
+licenses:
+- MIT
+metadata: {}
+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.6.9
+specification_version: 4
+summary: Kick OAuth2 Strategy for OmniAuth
+test_files: []