omniauth-qiita-v2 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a90625468134bcc53ef80ece9eb86fb4af2ead2ee299c6984f574a2f9d5ed13
+  data.tar.gz: 20e949b5096f0ed4ea1a6c53aa79a2452539c9914fd4a71c380a0011edb122f3
+SHA512:
+  metadata.gz: 2f1b320bc2142f79b5b6351ca54d74538ab2826af33ddc7f7789108d532a5d1b543fa90db7f6d4f6b183dc8bab3ddde94120273fc254674bfe18442558d87847
+  data.tar.gz: c175f42b745e6108ad6e552b5045e1d8fc3557d6d1ab401b2ded3e24c5f00e52b0e55f981dd986573d6d5426b622cd0c5522807459513430278ea8799a387c24

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## [0.0.0] - 2025-07-13
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Masahiro
+
+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,139 @@
+# OmniauthQiitaV2
+
+[![License](https://img.shields.io/github/license/cadenza-tech/omniauth-qiita-v2?label=License&labelColor=343B42&color=blue)](https://github.com/cadenza-tech/omniauth-qiita-v2/blob/main/LICENSE.txt) [![Tag](https://img.shields.io/github/tag/cadenza-tech/omniauth-qiita-v2?label=Tag&logo=github&labelColor=343B42&color=2EBC4F)](https://github.com/cadenza-tech/omniauth-qiita-v2/blob/main/CHANGELOG.md) [![Release](https://github.com/cadenza-tech/omniauth-qiita-v2/actions/workflows/release.yml/badge.svg)](https://github.com/cadenza-tech/omniauth-qiita-v2/actions?query=workflow%3Arelease) [![Test](https://github.com/cadenza-tech/omniauth-qiita-v2/actions/workflows/test.yml/badge.svg)](https://github.com/cadenza-tech/omniauth-qiita-v2/actions?query=workflow%3Atest) [![Lint](https://github.com/cadenza-tech/omniauth-qiita-v2/actions/workflows/lint.yml/badge.svg)](https://github.com/cadenza-tech/omniauth-qiita-v2/actions?query=workflow%3Alint)
+
+Qiita strategy for OmniAuth.
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Rails Configuration with Devise](#rails-configuration-with-devise)
+  - [Configuration Options](#configuration-options)
+  - [Auth Hash](#auth-hash)
+- [Changelog](#changelog)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+- [Sponsor](#sponsor)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add omniauth-qiita-v2
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install omniauth-qiita-v2
+```
+
+## Usage
+
+### Rails Configuration with Devise
+
+Add the following to `config/initializers/devise.rb`:
+
+```ruby
+# config/initializers/devise.rb
+Devise.setup do |config|
+  config.omniauth :qiita_v2, ENV['QIITA_CLIENT_ID'], ENV['QIITA_CLIENT_SECRET']
+end
+```
+
+Add the OmniAuth callbacks routes to `config/routes.rb`:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }
+end
+```
+
+Add the OmniAuth configuration to your Devise model:
+
+```ruby
+class User < ApplicationRecord
+  devise :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :validatable,
+         :omniauthable, omniauth_providers: %i[qiita_v2]
+end
+```
+
+### Configuration Options
+
+You can configure several options:
+
+```ruby
+# config/initializers/devise.rb
+Devise.setup do |config|
+  config.omniauth :qiita_v2, ENV['QIITA_CLIENT_ID'], ENV['QIITA_CLIENT_SECRET'],
+    {
+      scope: 'read_qiita write_qiita', # Specify OAuth scopes
+      callback_path: '/custom/qiita_v2/callback' # Custom callback path
+    }
+end
+```
+
+Available scopes:
+
+- `read_qiita` - Access to read data from Qiita
+- `write_qiita` - Access to write data to Qiita
+
+### Auth Hash
+
+After successful authentication, the auth hash will be available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  provider: 'qiita_v2',
+  uid: 'example_qiita_user_john_doe',
+  info: {
+    name: 'John Doe',
+    nickname: 'example_qiita_user_john_doe',
+    image: 'https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/...',
+    description: 'Software Developer',
+    location: 'Tokyo, Japan',
+    followees_count: 50,
+    followers_count: 100,
+    items_count: 30,
+    urls: {
+      website: 'https://example.com',
+      twitter: 'https://x.com/...',
+      facebook: 'https://facebook.com/...',
+      linkedin: 'https://www.linkedin.com/in/...',
+      github: 'https://github.com/...'
+    }
+  },
+  credentials: {
+    token: 'access_token_here',
+    expires: false
+  },
+  extra: {
+    raw_info: {
+      # Complete user information from Qiita API
+    }
+  }
+}
+```
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/cadenza-tech/omniauth-qiita-v2/blob/main/CHANGELOG.md).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cadenza-tech/omniauth-qiita-v2. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/cadenza-tech/omniauth-qiita-v2/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://github.com/cadenza-tech/omniauth-qiita-v2/blob/main/LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the OmniauthQiitaV2 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cadenza-tech/omniauth-qiita-v2/blob/main/CODE_OF_CONDUCT.md).
+
+## Sponsor
+
+You can sponsor this project on [Patreon](https://patreon.com/CadenzaTech).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ['--format', ENV['RUBOCOP_FORMAT']] if ENV['RUBOCOP_FORMAT']
+end

data/lib/omniauth/qiita_v2/version.rb

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

data/lib/omniauth/strategies/qiita_v2.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class QiitaV2 < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = 'read_qiita'
+      USER_INFO_URL = '/api/v2/authenticated_user'
+
+      option :name, 'qiita_v2'
+
+      option :client_options, {
+        site: 'https://qiita.com',
+        authorize_url: '/api/v2/oauth/authorize',
+        token_url: '/api/v2/access_tokens'
+      }
+
+      option :token_params, { parse: :json }
+
+      option :authorize_options, [:scope, :state]
+
+      option :scope, DEFAULT_SCOPE
+
+      uid { raw_info['id'] }
+
+      info do
+        prune!({
+          name: raw_info['name'],
+          nickname: raw_info['id'],
+          email: nil, # Qiita API v2 does not provide email
+          description: raw_info['description'],
+          image: raw_info['profile_image_url'],
+          location: raw_info['location'],
+          followees_count: raw_info['followees_count'],
+          followers_count: raw_info['followers_count'],
+          items_count: raw_info['items_count'],
+          urls: {
+            website: raw_info['website_url'],
+            twitter: raw_info['twitter_screen_name'] ? "https://x.com/#{raw_info['twitter_screen_name']}" : nil,
+            facebook: raw_info['facebook_id'] ? "https://facebook.com/#{raw_info['facebook_id']}" : nil,
+            linkedin: raw_info['linkedin_id'] ? "https://www.linkedin.com/in/#{raw_info['linkedin_id']}" : nil,
+            github: raw_info['github_login_name'] ? "https://github.com/#{raw_info['github_login_name']}" : nil
+          }.compact
+        })
+      end
+
+      extra do
+        hash = {}
+        hash[:raw_info] = raw_info unless skip_info?
+        prune!(hash)
+      end
+
+      credentials do
+        hash = { token: access_token.token }
+        hash[:expires] = access_token.expires?
+        hash[:expires_at] = access_token.expires_at if access_token.expires?
+        hash[:refresh_token] = access_token.refresh_token if access_token.refresh_token
+        hash
+      end
+
+      def raw_info # rubocop:disable Metrics/AbcSize
+        @raw_info ||= begin
+          access_token.get(USER_INFO_URL).parsed || {}
+        rescue ::OAuth2::Error => e
+          case e.response.status
+          when 401
+            log :error, '401 Unauthorized - Invalid access token'
+            raise ::OmniAuth::NoSessionError.new('Invalid access token')
+          when 403
+            log :error, '403 Forbidden - Insufficient permissions'
+            raise ::OmniAuth::NoSessionError.new('Insufficient permissions')
+          when 404
+            log :error, '404 Not Found - User not found'
+            raise ::OmniAuth::NoSessionError.new('User not found')
+          else
+            log :error, "API Error: #{e.response.status} - #{e.message}"
+            raise e
+          end
+        rescue ::Errno::ETIMEDOUT
+          log :error, 'Connection timed out'
+          raise ::OmniAuth::NoSessionError.new('Connection timed out')
+        rescue ::SocketError => e
+          log :error, "Network error: #{e.message}"
+          raise ::OmniAuth::NoSessionError.new('Network error')
+        end
+      end
+
+      def callback_url
+        options[:redirect_uri] || (full_host + script_name + callback_path)
+      end
+
+      def authorize_params
+        super.tap do |params|
+          ['scope', 'state'].each do |v|
+            params[v.to_sym] = request.params[v] if request.params[v]
+          end
+          params[:scope] ||= DEFAULT_SCOPE
+          session['omniauth.state'] = params[:state] if params[:state]
+        end
+      end
+
+      private
+
+      def prune!(hash)
+        hash.delete_if do |_, value|
+          prune!(value) if value.is_a?(Hash)
+          value.nil? || (value.respond_to?(:empty?) && value.empty?)
+        end
+      end
+
+      def build_access_token
+        verifier = request.params['code']
+        token_params = {
+          redirect_uri: callback_url,
+          client_id: options.client_id,
+          client_secret: options.client_secret
+        }.merge(token_params_from_options)
+        client.auth_code.get_token(verifier, token_params, deep_symbolize(options.auth_token_params))
+      rescue ::OAuth2::Error => e
+        log :error, "Failed to build access token: #{e.message}"
+        fail!(:invalid_credentials, e)
+      rescue ::Timeout::Error, ::Errno::ETIMEDOUT => e
+        log :error, "Timeout during token exchange: #{e.message}"
+        fail!(:timeout, e)
+      end
+
+      def token_params_from_options
+        return {} unless options.token_params
+
+        if options.token_params.is_a?(Hash)
+          params = options.token_params
+        else
+          params = options.token_params.to_hash
+        end
+        params.transform_keys(&:to_sym)
+      end
+    end
+  end
+end

data/lib/omniauth-qiita-v2.rb

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

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-qiita-v2
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Masahiro
+bindir: exe
+cert_chain: []
+date: 1980-01-02 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.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Qiita strategy for OmniAuth
+email:
+- watanabe@cadenza-tech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-qiita-v2.rb
+- lib/omniauth/qiita_v2/version.rb
+- lib/omniauth/strategies/qiita_v2.rb
+homepage: https://github.com/cadenza-tech/omniauth-qiita-v2/tree/v0.0.0
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/cadenza-tech/omniauth-qiita-v2/tree/v0.0.0
+  source_code_uri: https://github.com/cadenza-tech/omniauth-qiita-v2/tree/v0.0.0
+  changelog_uri: https://github.com/cadenza-tech/omniauth-qiita-v2/blob/v0.0.0/CHANGELOG.md
+  bug_tracker_uri: https://github.com/cadenza-tech/omniauth-qiita-v2/issues
+  documentation_uri: https://rubydoc.info/gems/omniauth-qiita-v2/0.0.0
+  funding_uri: https://patreon.com/CadenzaTech
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Qiita strategy for OmniAuth
+test_files: []