omniauth-naver-oauth2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5988ca4f5682fd21412569391012c86db939345e7381abc63778319888ffb1b0
+  data.tar.gz: 5006fb708013581c4eaa39ecff14b2dfec07aa265910ed3cb0bb29c60a7ffa0d
+SHA512:
+  metadata.gz: 66728cd6df8bc18c26db47908fccaa0615b0211192d03d8b0ddcc993e1d2d14452c6b2eacf1d2064c0ccd15878b3149f0c8cd3e2136e79f15cdcb4d9c6eb0f3d
+  data.tar.gz: 85393b5ae92773333b1bda8b6634ffacb1f8721f7854adf5e6faa60cdd8c3ff7a1e202799d2503129a6b5e1b787914e651dd40d6b19fdf52f56de437af4764b3

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.vscode/tasks.json

@@ -0,0 +1,13 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Test Naver OAuth2 Gem",
+      "type": "shell",
+      "command": "bundle exec rake test",
+      "group": "test",
+      "isBackground": false,
+      "problemMatcher": []
+    }
+  ]
+}

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+## [Unreleased]
+
+## [1.0.0] - 2025-08-05
+
+### Added
+- Initial release of omniauth-naver-oauth2
+- Modern OmniAuth OAuth2 strategy for Naver authentication
+- Customizable scope support (profile, email)
+- Comprehensive user information extraction
+- Gender normalization and image URL cleaning
+- Bilingual documentation (Korean/English)
+- Ruby 3.1+ support
+- Full test coverage with CI/CD pipeline
+- Rails integration examples
+
+### Features
+- Standard OmniAuth provider syntax: `provider :naver, client_id, client_secret, options`
+- Scope customization: Choose specific user data to request
+- Clean image URLs: Removes size parameters for higher quality images
+- Gender normalization: Converts 'M'/'F' to 'male'/'female'
+- Comprehensive user info: name, email, nickname, image, gender, age, birthday, birthyear
+- Modern Ruby and Rails compatibility

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 GoCoder
+
+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,68 @@
+# OmniAuth Naver OAuth2
+
+네이버 인증을 위한 현대적인 OmniAuth OAuth2 strategy를 제공하는 Ruby gem입니다. 기존 omniauth-naver와 달리 스코프 설정이 가능하고 최신 OAuth2 표준을 따릅니다.
+
+
+## 설치
+```shell
+gem install omniauth-naver-oauth2
+```
+
+## 사용법
+
+### Rails 설정
+
+```ruby
+# config/initializers/omniauth.rb
+Rails.application.config.middleware.use OmniAuth::Builder do
+  # 기본
+  provider :naver, ENV['NAVER_CLIENT_ID'], ENV['NAVER_CLIENT_SECRET']
+  
+  # + Options
+  provider :naver, ENV['NAVER_CLIENT_ID'], ENV['NAVER_CLIENT_SECRET'], {
+    scope: 'profile,email',
+    redirect_url: 'http://localhost:3000/auth/naver/callback'
+  }
+
+end
+```
+
+
+### 인증 해시
+
+```ruby
+# request.env['omniauth.auth']
+{
+  provider: 'naver',
+  uid: '48436401',
+  info: {
+    name: '홍길동',
+    email: 'example@naver.com',
+    nickname: '길동',
+    image: 'https://phinf.pstatic.net/contactthumb/52/2014/8/4/example.jpg',
+    gender: 'male', # 'male', 'female', or nil
+    age: '30-39',
+    birthday: '01-08',
+    birthyear: '1990'
+  },
+  credentials: {
+    token: 'ACCESS_TOKEN',
+    expires_at: 1234567890,
+    expires: true
+  },
+  extra: {
+    raw_info: { ... },
+    response: { ... }
+  }
+}
+```
+
+
+## Contribute
+
+버그 신고와 PR은 https://github.com/GoCoder7/omniauth-naver-oauth2 로 부탁드립니다.
+
+
+## License
+
+[MIT](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/examples/rails_integration.rb

@@ -0,0 +1,86 @@
+# Rails Integration Example for omniauth-naver-oauth2
+# Rails에서 omniauth-naver-oauth2 사용 예제
+
+# Gemfile에 추가 | Add to Gemfile
+# gem 'omniauth-naver-oauth2'
+# gem 'omniauth-rails_csrf_protection'
+
+# config/initializers/omniauth.rb
+Rails.application.config.middleware.use OmniAuth::Builder do
+  # 기본 사용법 | Basic usage
+  provider :naver, ENV['NAVER_CLIENT_ID'], ENV['NAVER_CLIENT_SECRET']
+  
+  # 스코프 설정 | With custom scopes
+  provider :naver, ENV['NAVER_CLIENT_ID'], ENV['NAVER_CLIENT_SECRET'], {
+    scope: 'profile,email'
+  }
+  
+  # 옵션과 함께 사용 | With options
+  provider :naver, ENV['NAVER_CLIENT_ID'], ENV['NAVER_CLIENT_SECRET'], {
+    scope: 'profile,email',
+    redirect_url: 'http://localhost:3000/auth/naver/callback'
+  }
+end
+
+# config/routes.rb
+Rails.application.routes.draw do
+  get '/auth/naver/callback', to: 'sessions#omniauth'
+  # 기타 라우트들...
+end
+
+# app/controllers/sessions_controller.rb
+class SessionsController < ApplicationController
+  def omniauth
+    auth = request.env['omniauth.auth']
+    
+    # 사용자 찾기 또는 생성 | Find or create user
+    user = User.find_or_create_by(uid: auth.uid, provider: auth.provider) do |u|
+      u.name = auth.info.name
+      u.email = auth.info.email
+      u.nickname = auth.info.nickname
+      u.image = auth.info.image
+      u.gender = auth.info.gender
+      u.age = auth.info.age
+      u.birthday = auth.info.birthday
+      u.birthyear = auth.info.birthyear
+    end
+    
+    if user.persisted?
+      session[:user_id] = user.id
+      redirect_to root_path, notice: '네이버 로그인이 완료되었습니다!'
+    else
+      redirect_to login_path, alert: '로그인 중 오류가 발생했습니다.'
+    end
+  end
+end
+
+# app/models/user.rb
+class User < ApplicationRecord
+  validates :uid, presence: true
+  validates :provider, presence: true
+  validates :email, presence: true, uniqueness: true
+  
+  def self.from_naver_omniauth(auth)
+    where(uid: auth.uid, provider: auth.provider).first_or_create! do |user|
+      user.name = auth.info.name
+      user.email = auth.info.email
+      user.nickname = auth.info.nickname
+      user.image = auth.info.image
+      user.gender = auth.info.gender
+      user.age = auth.info.age
+      user.birthday = auth.info.birthday
+      user.birthyear = auth.info.birthyear
+    end
+  end
+end
+
+# 마이그레이션 예제 | Migration example
+# rails generate migration CreateUsers uid:string provider:string name:string email:string nickname:string image:string gender:string age:string birthday:string birthyear:string
+# rails db:migrate
+
+# 환경 변수 설정 예제 (.env 파일)
+# NAVER_CLIENT_ID=your_naver_client_id
+# NAVER_CLIENT_SECRET=your_naver_client_secret
+
+# 뷰 예제 | View example
+# <%= link_to "네이버로 로그인", "/auth/naver", method: :post, class: "btn btn-success" %>

data/lib/omniauth/naver/oauth2/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Omniauth
+  module Naver
+    module Oauth2
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/omniauth/naver/oauth2.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "oauth2/version"
+
+module Omniauth
+  module Naver
+    module Oauth2
+      class Error < StandardError; end
+      # Your code goes here...
+    end
+  end
+end

data/lib/omniauth/strategies/naver_oauth2.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    # OmniAuth OAuth2 strategy for Naver authentication
+    # This strategy supports customizable scopes and modern OAuth2 practices
+    class NaverOauth2 < OmniAuth::Strategies::OAuth2
+      option :name, :naver
+
+      option :client_options,
+             site: "https://nid.naver.com",
+             authorize_url: "/oauth2.0/authorize",
+             token_url: "/oauth2.0/token"
+
+      option :scope, "profile"
+
+      # User ID from Naver
+      uid { raw_info["response"]["id"].to_s }
+
+      # User information mapping
+      info do
+        response = raw_info["response"] || {}
+        {
+          name: response["name"],
+          email: response["email"],
+          nickname: response["nickname"],
+          image: clean_image_url(response["profile_image"]),
+          gender: normalize_gender(response["gender"]),
+          age: response["age"],
+          birthday: response["birthday"],
+          birthyear: response["birthyear"]
+        }
+      end
+
+      # Extra information
+      extra do
+        {
+          raw_info: raw_info,
+          response: raw_info["response"]
+        }
+      end
+
+      private
+
+      # Get user information from Naver API
+      def raw_info
+        @raw_info ||= access_token.get("https://openapi.naver.com/v1/nid/me").parsed
+      end
+
+      # Clean up image URL by removing size parameters for higher quality
+      def clean_image_url(image_url)
+        return nil if image_url.nil? || image_url.include?("nodata_33x33.gif")
+        
+        # Remove type parameter to get original size image
+        image_url.sub(/\?type=\w+/, "")
+      end
+
+      # Normalize gender format from Naver API
+      def normalize_gender(gender)
+        case gender
+        when "M"
+          "male"
+        when "F"
+          "female"
+        else
+          gender
+        end
+      end
+
+      # Callback URL for OAuth flow
+      def callback_url
+        options.redirect_url || (full_host + callback_path)
+      end
+    end
+  end
+end
+
+# Register the strategy with OmniAuth
+OmniAuth.config.add_camelization "naver", "NaverOauth2"

data/lib/omniauth-naver-oauth2.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "omniauth/naver/oauth2/version"
+require_relative "omniauth/strategies/naver_oauth2"
+
+module Omniauth
+  module Naver
+    module Oauth2
+      class Error < StandardError; end
+    end
+  end
+end

data/sig/omniauth/naver/oauth2.rbs

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

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-naver-oauth2
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- GoCoder
+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.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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: A Ruby gem providing OmniAuth OAuth2 strategy for Naver authentication.
+  Supports modern OAuth2 practices with customizable scopes and proper error handling.
+email:
+- gocoder7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".vscode/tasks.json"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/rails_integration.rb
+- lib/omniauth-naver-oauth2.rb
+- lib/omniauth/naver/oauth2.rb
+- lib/omniauth/naver/oauth2/version.rb
+- lib/omniauth/strategies/naver_oauth2.rb
+- sig/omniauth/naver/oauth2.rbs
+homepage: https://github.com/GoCoder7/omniauth-naver-oauth2
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/GoCoder7/omniauth-naver-oauth2
+  source_code_uri: https://github.com/GoCoder7/omniauth-naver-oauth2
+  changelog_uri: https://github.com/GoCoder7/omniauth-naver-oauth2/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.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: OmniAuth OAuth2 strategy for Naver with proper scope handling
+test_files: []