omniauth-twitchtv2 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: edb0c195f852ffc1186501076e8565298175e186b2ef74f4626517096d17d9ab
+  data.tar.gz: 57fa18c318d73e4a7f6880712a087a0814f039f88795f63897eac2c113b7c5bf
+SHA512:
+  metadata.gz: 32045c9a362321cb4930da29cd5af652a097650fc6850962145702dbdd619982bf75311f5bbc0ae264b2a37048d4cf1669cfd0bfcec9c11b0d8383b6551aab9d
+  data.tar.gz: 8d7adc1af4b7ca7033da65fa04bbd0fef8b5c97dcf824ee12b83661337305c63b2ce8df5d8c5bf96aa389a6636f464c86ab88989eb5aad399c9dfd0e4477facf

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Claudio Poli
+
+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,104 @@
+# OmniAuth Twitchtv2 Strategy
+
+[![Test](https://github.com/icoretech/omniauth-twitchtv2/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/icoretech/omniauth-twitchtv2/actions/workflows/test.yml?query=branch%3Amain)
+[![Gem Version](https://img.shields.io/gem/v/omniauth-twitchtv2.svg)](https://rubygems.org/gems/omniauth-twitchtv2)
+
+`omniauth-twitchtv2` provides a Twitch OAuth2 strategy for OmniAuth.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-twitchtv2'
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+## Usage
+
+Configure OmniAuth in your Rack/Rails app:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :twitchtv,
+           ENV.fetch('TWITCH_CLIENT_ID'),
+           ENV.fetch('TWITCH_CLIENT_SECRET'),
+           scope: 'user:read:email'
+end
+```
+
+## Auth Hash
+
+Example payload from `request.env['omniauth.auth']` (realistic shape, anonymized):
+
+```json
+{
+  "uid": "12345678",
+  "info": {
+    "name": "sample_user",
+    "nickname": "sample_user",
+    "email": "sample@example.test",
+    "image": "https://static-cdn.jtvnw.net/jtv_user_pictures/example-profile_image-300x300.png",
+    "description": "Streaming something cool",
+    "urls": {
+      "twitchtv": "https://www.twitch.tv/sample_user"
+    }
+  },
+  "credentials": {
+    "token": "sample-access-token",
+    "refresh_token": "sample-refresh-token",
+    "expires_at": 1710000000,
+    "expires": true
+  },
+  "extra": {
+    "raw_info": {
+      "id": "12345678",
+      "login": "sample_user",
+      "display_name": "sample_user",
+      "type": "",
+      "broadcaster_type": "",
+      "description": "Streaming something cool",
+      "profile_image_url": "https://static-cdn.jtvnw.net/jtv_user_pictures/example-profile_image-300x300.png",
+      "offline_image_url": "",
+      "view_count": 42,
+      "email": "sample@example.test",
+      "created_at": "2020-01-01T00:00:00Z"
+    }
+  }
+}
+```
+
+`info.email` is returned only when your app requests a scope that exposes email (for example `user:read:email`).
+
+## Development
+
+```bash
+bundle install
+bundle exec rake
+```
+
+Run Rails integration tests with an explicit Rails version:
+
+```bash
+RAILS_VERSION='~> 8.1.0' bundle install
+RAILS_VERSION='~> 8.1.0' bundle exec rake test_rails_integration
+```
+
+## Compatibility
+
+- Ruby: `>= 3.2` (tested on `3.2`, `3.3`, `3.4`, `4.0`)
+- `omniauth-oauth2`: `>= 1.8`, `< 1.9`
+- Rails integration lanes: `~> 7.1.0`, `~> 7.2.0`, `~> 8.0.0`, `~> 8.1.0`
+
+## Release
+
+Tag releases as `vX.Y.Z`; GitHub Actions publishes the gem to RubyGems.
+
+## License
+
+MIT

data/lib/omniauth/strategies/twitchtv.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    # OmniAuth strategy for Twitch OAuth2.
+    class Twitchtv < OmniAuth::Strategies::OAuth2
+      option :name, 'twitchtv'
+
+      option :client_options,
+             site: 'https://api.twitch.tv',
+             authorize_url: 'https://id.twitch.tv/oauth2/authorize',
+             token_url: 'https://id.twitch.tv/oauth2/token',
+             auth_scheme: :request_body,
+             connection_opts: {
+               headers: {
+                 user_agent: 'icoretech-omniauth-twitchtv2 gem',
+                 accept: 'application/json',
+                 content_type: 'application/json'
+               }
+             }
+
+      option :authorize_options, %i[scope force_verify]
+
+      uid { raw_info['id'].to_s }
+
+      info do
+        {
+          name: raw_info['display_name'] || raw_info['login'],
+          nickname: raw_info['login'],
+          email: raw_info['email'],
+          image: raw_info['profile_image_url'],
+          description: blank_to_nil(raw_info['description']),
+          urls: profile_url ? { twitchtv: profile_url } : nil
+        }.compact
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= begin
+          response = access_token.get('helix/users', headers: { 'Client-Id' => options.client_id })
+          users = response.parsed.fetch('data', [])
+          users.first || {}
+        end
+      end
+
+      def profile_url
+        login = raw_info['login']
+        return nil if login.to_s.empty?
+
+        "https://www.twitch.tv/#{login}"
+      end
+
+      # Ensure token exchange uses a stable callback URI that matches provider config.
+      def callback_url
+        options[:callback_url] || super
+      end
+
+      # Prevent authorization response params from being appended to redirect_uri.
+      def query_string
+        return '' if request.params['code']
+
+        super
+      end
+
+      private
+
+      def blank_to_nil(value)
+        return nil if value.respond_to?(:empty?) && value.empty?
+
+        value
+      end
+    end
+
+    Twitchtv2 = Twitchtv
+  end
+end
+
+OmniAuth.config.add_camelization 'twitchtv', 'Twitchtv'

data/lib/omniauth/twitchtv2/version.rb

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

data/lib/omniauth/twitchtv2.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'omniauth/twitchtv2/version'
+require 'omniauth/strategies/twitchtv'

data/lib/omniauth-twitchtv/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'omniauth-twitchtv2/version'
+
+module Omniauth
+  module Twitchtv
+    VERSION = OmniAuth::Twitchtv2::VERSION unless const_defined?(:VERSION)
+  end
+end

data/lib/omniauth-twitchtv.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'omniauth-twitchtv2'
+
+module Omniauth
+  module Twitchtv
+    class TwitchtvError < OmniAuth::Error; end unless const_defined?(:TwitchtvError)
+  end
+end

data/lib/omniauth-twitchtv2/version.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'omniauth/twitchtv2/version'
+
+# Backward compatibility for historical constant usage.
+module Omniauth
+  module Twitchtv2
+    VERSION = OmniAuth::Twitchtv2::VERSION unless const_defined?(:VERSION)
+  end
+
+  module Twitchtv
+    VERSION = OmniAuth::Twitchtv2::VERSION unless const_defined?(:VERSION)
+  end
+end

data/lib/omniauth-twitchtv2.rb

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

data/omniauth-twitchtv2.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omniauth/twitchtv2/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'omniauth-twitchtv2'
+  spec.version = OmniAuth::Twitchtv2::VERSION
+  spec.authors = ['Claudio Poli']
+  spec.email = ['masterkain@gmail.com']
+
+  spec.summary = 'OmniAuth strategy for Twitch OAuth2 authentication.'
+  spec.description = 'OAuth2 strategy for OmniAuth that authenticates users with Twitch and exposes account metadata.'
+  spec.homepage = 'https://github.com/icoretech/omniauth-twitchtv2'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2'
+
+  spec.metadata['source_code_uri'] = 'https://github.com/icoretech/omniauth-twitchtv2'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/icoretech/omniauth-twitchtv2/issues'
+  spec.metadata['changelog_uri'] = 'https://github.com/icoretech/omniauth-twitchtv2/releases'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir[
+    'lib/**/*.rb',
+    'README*',
+    'LICENSE*',
+    '*.gemspec'
+  ]
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'cgi', '>= 0.3.6'
+  spec.add_dependency 'omniauth-oauth2', '>= 1.8', '< 1.9'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-twitchtv2
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Claudio Poli
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.6
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: OAuth2 strategy for OmniAuth that authenticates users with Twitch and
+  exposes account metadata.
+email:
+- masterkain@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/omniauth-twitchtv.rb
+- lib/omniauth-twitchtv/version.rb
+- lib/omniauth-twitchtv2.rb
+- lib/omniauth-twitchtv2/version.rb
+- lib/omniauth/strategies/twitchtv.rb
+- lib/omniauth/twitchtv2.rb
+- lib/omniauth/twitchtv2/version.rb
+- omniauth-twitchtv2.gemspec
+homepage: https://github.com/icoretech/omniauth-twitchtv2
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/icoretech/omniauth-twitchtv2
+  bug_tracker_uri: https://github.com/icoretech/omniauth-twitchtv2/issues
+  changelog_uri: https://github.com/icoretech/omniauth-twitchtv2/releases
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: OmniAuth strategy for Twitch OAuth2 authentication.
+test_files: []