sb-omniauth-kakao 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77c1345c76240dd09af334a012ffb81c043287b98643240f35de32343db8f1b8
+  data.tar.gz: c752d5bc9a586418d427dc0335cb01e01f41a74503b8c70a7962f44ac09863c2
+SHA512:
+  metadata.gz: 35f4fd5bb3ec8ac00b694c36694d89c489a5c82e0f7a16d8282060de5e002c3caf1000362104b5bce09820d2d987ebefe1fb48d77759c06f65dcc455520ee0c8
+  data.tar.gz: f1981fdb8050d211d835c0a80ddacb34c32be3c2e0fe5a0988b81578e11ac2be5460468913e02dcfe31bec2b356dea59326da8073ecf62a9d74fd135960b45dc

data/.github/workflows/gem-push.yml

@@ -0,0 +1,59 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build-publish-gh-packages:
+    name: Build + Publish - GithubPackages
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby matrix
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+
+    - name: Publish to Github Packages
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+
+  build-publish-rubygems:
+    name: Build + Publish - Rubygems
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby matrix
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+
+# runtime
+.env
+tmp-result-*.json
+Gemfile.lock
+
+# IDE
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, :cmd => "bundle exec rspec spec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,109 @@
+# SB OmniAuth Kakao
+
+omniauth-kakao을 쓰려고 보니 에러나는데 업데이트가 안되는 것 같아서 수정
+하다보니 ommniauth도 이상한 것 같아서 보다보니 끝이 없다.
+oauth2는 다 좋은데 왜 로깅이 안되는걸까
+
+[카카오](http://www.kakao.com/) 인증을 위한 OmniAuth strategy 입니다. [카카오 개발자 페이지](http://developers.kakao.com)에서 REST API 키를 생성한 뒤 이용해 주세요. 자세한 사항은 [시작하기 - 앱 생성](https://developers.kakao.com/docs/restapi#시작하기-앱-생성) 페이지를 참고하시기 바랍니다.
+
+## Installation
+
+Add to your `Gemfile`:
+```ruby
+gem 'sb-omniauth-kakao', git: git@github.com:ScriptonBasestar/sb-omniauth-kakao.git
+
+or
+
+gem "sb-omniauth-kakao", "0.3.0", source: "https://rubygems.pkg.github.com/scriptonbasestar"
+
+or
+
+# https://github.com/ScriptonBasestar/sb-omniauth-kakao/pkgs/rubygems/sb-omniauth-kakao
+source "https://rubygems.pkg.github.com/scriptonbasestar" do
+  gem "sb-omniauth-kakao", "0.3.0"
+end
+```
+
+Then `bundle install`.
+
+## Usage
+
+### Rails
+
+Rails Middleware 편집
+
+`config/initializers/omniauth.rb`:
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  # 3 중 1
+  provider :kakao, ENV['KAKAO_CLIENT_ID']
+  provider :kakao, ENV['KAKAO_CLIENT_ID'], ENV['KAKAO_CLIENT_SECRET']
+  provider :kakao, ENV['KAKAO_CLIENT_ID'], {:redirect_path => ENV['REDIRECT_PATH']}
+end
+```
+
+Then go to [My Application](https://developers.kakao.com/apps) page, select your current application and add your domain address(ex: http://localhost:3000/) to  'Setting - Platform - Web - Site Domain'.
+
+그리고 [내 어플리케이션](https://developers.kakao.com/apps)에서 현재 어플리케이션을 선택하고, '설정 - 플랫폼 - 웹 - 사이트 도메인'에  도메인 주소(예: http://localhost:3000/)를 넣어주세요.
+
+![이미지](https://developers.kakao.com/assets/images/dashboard/dev_011.png)
+
+For more information, please read the [OmniAuth](https://github.com/intridea/omniauth) docs for detailed instructions.
+
+더 자세한 사항은 [OmniAuth](https://github.com/intridea/omniauth)의 문서를 참고해 주세요.
+
+## Example
+
+You can test omniauth-kakao in the `example/` folder.
+
+`example/` 폴더에 있는 예제를 통해 omniauth-kakao를 테스트해볼 수 있습니다.
+
+```
+cd example/
+bundle install
+KAKAO_CLIENT_ID='<your-kakako-client-id>' ruby app.rb
+
+# 또는 Redirect Path를 설정하고 싶다면(or if you want to customize your Redirect Path)
+# KAKAO_CLIENT_ID='<your-kakako-client-id>' REDIRECT_PATH='<your-redirect-path>' ruby app.rb
+```
+
+Then open `http://localhost:4567/` in your browser.
+
+이후 `http://localhost:4567/`로 접속하시면 됩니다.
+
+Warning: Do not forgot to add `http://localhost:4567/` in [My Application](https://developers.kakao.com/apps).
+
+주의: [내 어플리케이션](https://developers.kakao.com/apps) 의 '설정된 플랫폼 - 웹 - 사이트 도메인'에 `http://localhost:4567/`을 넣는 걸 잊지 마세요.
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+`request.env['omniauth.auth']` 안에 들어있는 *Auth Hash* 는 다음과 같습니다.
+
+```ruby
+{
+  :provider => 'kakao',
+  :uid => '123456789',
+  :info => {
+    :name => 'Hong Gil-Dong',
+    :image => 'http://xxx.kakao.com/.../aaa.jpg',
+  },
+  :credentials => {
+    :token => 'ABCDEF...', # OAuth 2.0 access_token, which you may wish to store.
+    :refresh_token => 'OPQRST...', # OAuth 2.0 refresh_token.
+    :expires_at => 1321747205, # when the access token expires (it always will)
+    :expires => true # this will always be true
+  },
+  :extra => {
+    :properties => {
+      :nickname => 'Hong Gil-Dong',
+      :thumbnail_image => 'http://xxx.kakao.com/.../aaa.jpg'
+      :profile_image => 'http://xxx.kakao.com/.../bbb.jpg'
+    }
+  }
+}
+```
+
+## Contributors
+Issue or Fork PR

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/example/.env.sample

@@ -0,0 +1,11 @@
+KAKAO_CLIENT_ID=your_kakao_client_id
+KAKAO_CLIENT_SECRET=your_kakao_client_secret
+KAKAO_CLIENT_SCOPE=profile,account_email
+KAKAO_REDIRECT_URL=http://localhost:3000/auth/kakao/callback
+
+GOOGLE_CLIENT_ID=your_google_client_id
+GOOGLE_CLIENT_SECRET=your_google_client_secret
+
+RACK_COOKIE_SECRET=a3f5e6d7c8b9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5
+
+OAUTH_DEBUG=true

data/example/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+group :development, :test do
+  gem "growl"
+  gem "guard"
+  gem "guard-bundler"
+  gem "guard-rspec"
+  gem "rb-fsevent"
+
+  gem "dotenv"
+
+  gem "sb-omniauth-kakao", path: "../"
+
+  gem "byebug"
+
+  gem "sinatra"
+
+  gem "puma"
+  gem "rackup"
+
+  gem "rerun"
+end

data/example/Makefile

@@ -0,0 +1,12 @@
+setup:
+	cp .env.sample .env
+	ruby -e "require 'securerandom'; puts SecureRandom.hex(32)"
+
+start:
+	ruby app.rb
+	# rackup config.ru
+	bundle exec rackup -p 3000
+
+dev:
+	# https://github.com/alexch/rerun
+	rerun -- rackup --port 3000 config.ru

data/example/config.ru

@@ -0,0 +1,298 @@
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler"
+require "sinatra"
+require "omniauth"
+require "faraday"
+require "logger"
+require "byebug"
+
+require "sb-omniauth-kakao"
+
+require "dotenv"
+Dotenv.load
+
+# Do not use for production code.
+# This is only to make setup easier when running through the sample.
+#
+# If you do have issues with certs in production code, this could help:
+# http://railsapps.github.io/openssl-certificate-verify-failed.html
+# OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE
+
+class App < Sinatra::Base
+  configure do
+    set :sessions, true
+    set :inline_templates, true
+
+    # STDOUT의 sync 활성화로 버퍼링 방지
+    STDOUT.sync = true
+
+    # 로깅 설정
+    $logger = Logger.new(STDOUT)
+    $logger.level = Logger::DEBUG
+
+    # Sinatra 로깅 활성화
+    enable :logging
+    set :logger, $logger
+  end
+
+  before do
+    env["rack.logger"] = $logger
+  end
+
+  use Rack::Session::Cookie, secret: ENV.fetch("RACK_COOKIE_SECRET", "a3f5e6d7c8b9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5")
+
+  # OAuth2 클라이언트의 로거를 Sinatra의 로거로 설정
+  OAuth2::Client.class_eval do
+    define_method(:logger) { $logger }
+  end
+  OmniAuth.config.logger = $logger
+  use OmniAuth::Builder do
+    # provider :kakao, ENV.fetch("KAKAO_CLIENT_ID", nil), ENV.fetch("KAKAO_CLIENT_SECRET", nil), access_type: "offline", prompt: "consent", provider_ignores_state: true, scope: "account_email,profile", :strategy_class => OmniAuth::Strategies::KakaoOauth2
+    # provider :kakao, ENV.fetch("KAKAO_CLIENT_ID", nil), ENV.fetch("KAKAO_CLIENT_SECRET", nil),
+    #          scope: ENV.fetch("KAKAO_CLIENT_SCOPE", "profile"),
+    #          client_options: {
+    #            connection_build: lambda do |builder|
+    #              builder.request :url_encoded
+    #              builder.response :logger, $logger
+    #              builder.adapter Faraday.default_adapter
+    #            end
+    #          }
+    provider :kakao, ENV.fetch("KAKAO_CLIENT_ID", nil), ENV.fetch("KAKAO_CLIENT_SECRET", nil),
+             scope: ENV.fetch("KAKAO_CLIENT_SCOPE", "profile"), redirect_url: ENV.fetch("KAKAO_REDIRECT_URL") do |builder|
+      builder.client_options.connection_build do |conn|
+        conn.request :url_encoded
+        conn.response :logger, $logger, { headers: true, bodies: { request: false, response: true }, errors: true }
+        conn.adapter Faraday.default_adapter
+      end
+      # connection_build
+
+      # provider :kakao, "bcf75d0d9b0781ac4305d8750972ce25", "W7oQ3tX4Z9wj9gPJRqFlJ2waVVLTLfY8",
+      #  scope: "profile,account_email" do |builder|
+      # builder.request :url_encoded
+      # # builder.response :logger, $logger, bodies: true
+      # builder.response :logger, $logger, { headers: true, bodies: { request: false, response: true }, errors: true }
+      # builder.adapter Faraday.default_adapter
+    end
+    # before_request_phase do |env|
+    #   puts "before_request_phase >>>>>>>>>>"
+    #   puts env["rack.session"]
+    #   puts env["rack.session"]["user_params"]
+    #   puts env["rack.request.form_hash"]["user"]
+    #   request_env = env['omniauth.auth']
+    #   print request_env
+    #   puts "before_request_phase <<<<<<<<<<"
+    # end
+    # before_callback_phase do |env|
+    #   puts "before_callback_phase >>>>>>>>>>"
+    #   request_env = env['omniauth.auth']
+    #   puts "=== OmniAuth Request ==="
+    #   puts request_env.to_hash if request_env
+    #
+    #   # puts env["rack.session"]
+    #   # puts env["rack.session"]["user_params"]
+    #   # puts env["rack.request.form_hash"]["user"]
+    #   puts "before_callback_phase <<<<<<<<<<"
+    # end
+    puts "OmniAuth::Strategies::KakaoOauth2"
+    puts "KAKAO_CLIENT_ID: #{ENV.fetch("KAKAO_CLIENT_ID", nil)}"
+    puts "KAKAO_CLIENT_SECRET: #{ENV.fetch("KAKAO_CLIENT_SECRET", nil)}"
+    # on_failure do |env|
+    #   error = env["omniauth.error"]
+    #   puts "OmniAuth error: #{error.inspect}"
+    #   OmniAuth::FailureEndpoint.new(env).redirect_to_failure
+    # end
+  end
+
+  get "/" do
+    logger.info "========================================================"
+    logger.debug "========================================================"
+    logger.info "route GET /"
+    <<-HTML
+    <!DOCTYPE html>
+    <html>
+      <head>
+        <title>Kakao OAuth2 Example</title>
+        <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
+        <script>
+          jQuery(function() {
+            return $.ajax({
+              url: 'https://apis.google.com/js/client:plus.js?onload=gpAsyncInit',
+              dataType: 'script',
+              cache: true
+            });
+          });
+
+          window.gpAsyncInit = function() {
+            gapi.auth.authorize({
+              immediate: true,
+              response_type: 'code',
+              cookie_policy: 'single_host_origin',
+              client_id: "#{ENV.fetch("KAKAO_CLIENT_ID", nil)}",
+              scope: 'account_email profile'
+            }, function(response) {
+              return;
+            });
+            $('.kakao-login').click(function(e) {
+              e.preventDefault();
+              gapi.auth.authorize({
+                immediate: false,
+                response_type: 'code',
+                cookie_policy: 'single_host_origin',
+                client_id: "#{ENV.fetch("KAKAO_CLIENT_ID", nil)}",
+                # scope: 'account_email profile'
+                scope: 'profile'
+              }, function(response) {
+                if (response && !response.error) {
+                  // kakao authentication succeed, now post data to server.
+                  jQuery.ajax({type: 'POST', url: "/auth/kakao/callback", data: response,
+                    success: function(data) {
+                      // Log the data returning from kakao.
+                      console.log(data)
+                    }
+                  });
+                } else {
+                  // kakao authentication failed.
+                  console.log("FAILED")
+                }
+              });
+            });
+          };
+        </script>
+      </head>
+      <body>
+      <ul>
+        <li>
+          <form method='post' action='/auth/kakao'>
+            <input type="hidden" name="authenticity_token" value="#{request.env["rack.session"]["csrf"]}">
+            <button type='submit'>Login with Kakao</button>
+          </form>
+        </li>
+        <li><a href='#' class="kakao-login">Sign in with Kakao via AJAX</a></li>
+      </ul>
+      </body>
+    </html>
+    HTML
+  end
+
+  helpers do
+    def render_callback_page(auth, url)
+      <<-HTML
+      <!DOCTYPE html>
+      <html lang="en">
+      <head>
+          <meta charset="UTF-8">
+          <meta name="viewport" content="width=device-width, initial-scale=1.0">
+          <title>OmniAuth Callback - #{url}</title>
+          <style>
+              body {
+                  font-family: Arial, sans-serif;
+                  margin: 0;
+                  padding: 0;
+                  background-color: #f9f9f9;
+                  color: #333;
+              }
+              header {
+                  background-color: #4CAF50;
+                  color: white;
+                  padding: 1rem;
+                  text-align: center;
+              }
+              .container {
+                  max-width: 800px;
+                  margin: 2rem auto;
+                  padding: 1rem;
+                  background: white;
+                  border-radius: 8px;
+                  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+              }
+              h1 {
+                  font-size: 1.5rem;
+                  margin-bottom: 1rem;
+              }
+              pre {
+                  background: #f4f4f4;
+                  padding: 1rem;
+                  border-radius: 8px;
+                  overflow-x: auto;
+                  font-size: 0.9rem;
+              }
+          </style>
+      </head>
+      <body>
+          <header>
+              <h1>OmniAuth Callback - #{url}</h1>
+          </header>
+          <div class="container">
+              <h1>#{params[:provider].capitalize} Callback Success</h1>
+              <p>The callback from <strong>#{params[:provider].capitalize}</strong> was successful. Below is the data received:</p>
+              <pre>#{JSON.pretty_generate(auth)}</pre>
+          </div>
+      </body>
+      </html>
+      HTML
+    end
+  end
+
+  post "/auth/:provider/callback" do
+    logger.info "========================================================"
+    logger.info "route POST /auth/:provider/callback"
+    # content_type "text/plain"
+    begin
+      logger.info "begin"
+      auth = request.env["omniauth.auth"]
+      logger.info auth
+      logger.info auth.to_hash
+      # request.env["omniauth.auth"].to_hash.inspect
+
+      render_callback_page(auth, request.url)
+    rescue StandardError
+      "No Data"
+    end
+  end
+
+  get "/auth/:provider/callback" do
+    logger.info "========================================================"
+    logger.info "route GET /auth/:provider/callback"
+    # content_type "text/plain"
+    begin
+      logger.info "begin"
+      auth = request.env["omniauth.auth"]
+      logger.info auth
+      logger.info auth.to_hash
+      # request.env["omniauth.auth"].to_hash.inspect
+
+      render_callback_page(auth, request.url)
+    rescue StandardError
+      "No Data"
+    end
+  end
+
+  get "/auth/failure" do
+    logger.info "========================================================"
+    logger.info "route GET /auth/failure"
+    begin
+      logger.info "begin"
+      logger.info request.env["omniauth.auth"]
+      logger.info request.env["omniauth.auth"].to_hash
+      request.env["omniauth.auth"].to_hash.inspect
+    rescue StandardError
+      <<-HTML
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <title>Kakao OAuth2 Example</title>
+        </head>
+        <body>
+          <h1>No Data</h1>
+          <p>Request Params: #{request.params.inspect}</p>
+        </body>
+      </html>
+      HTML
+    end
+  end
+end
+
+use Rack::CommonLogger, $logger
+run App.new

data/lib/omniauth/strategies/kakao.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class Kakao < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "account_email,profile".freeze
+
+      BASE_URL = "https://kauth.kakao.com".freeze
+      AUTHORIZE_URL = "/oauth/authorize".freeze
+      AUTHORIZE_TOKEN_URL = "/oauth/token".freeze
+
+      TOKEN_INFO_URL = "/oauth/tokeninfo".freeze
+
+      OPENID_CONFIG_URL = "https://kauth.kakao.com/.well-known/openid-configuration".freeze
+
+      # USER_INFO_URL = 'v1/oidc/userinfo'
+      USER_INFO_URL = "https://kapi.kakao.com/v2/user/me".freeze
+
+      option :name, :kakao
+
+      option :client_options,
+             site: BASE_URL,
+             authorize_url: AUTHORIZE_URL,
+             token_url: AUTHORIZE_TOKEN_URL
+
+      uid {
+        OmniAuth.logger.send :debug, "uid >>>>>>>>>>"
+        raw_info["id"].to_s
+      }
+
+      info do
+        OmniAuth.logger.send :debug, "info >>>>>>>>>>"
+        hash = {
+          name: raw_info["properties"]["nickname"],
+          username: raw_info["kakao_account"]["email"],
+          image: raw_info["properties"]["thumbnail_image"]
+        }
+        if raw_info["kakao_account"]["has_email"] && raw_info["kakao_account"]["is_email_verified"] && raw_info["kakao_account"]["is_email_valid"]
+          hash[:email] = raw_info["kakao_account"]["email"]
+        end
+        hash
+      end
+
+      extra do
+        OmniAuth.logger.send :debug, "extra >>>>>>>>>>"
+        { raw_info: raw_info }
+      end
+
+      def callback_url
+        options.redirect_url || (full_host + callback_path)
+      end
+
+      # def authorize_params
+      #   options.authorize_params[:state] = SecureRandom.hex(24)
+      #
+      #   if OmniAuth.config.test_mode
+      #     @env ||= {}
+      #     @env["rack.session"] ||= {}
+      #   end
+      #
+      #   params = options.authorize_params
+      #                   .merge(options_for("authorize"))
+      #                   .merge(pkce_authorize_params)
+      #
+      #   params[:client_id] = options.client_id  # client_id 추가
+      #
+      #   session["omniauth.pkce.verifier"] = options.pkce_verifier if options.pkce
+      #   session["omniauth.state"] = params[:state]
+      #
+      #   params
+      # end
+
+      def auth_token_params
+        verifier = session.delete("omniauth.pkce.verifier")
+        params = {
+          code: request.params["code"],
+          client_id: options.client_id,
+          client_secret: options.client_secret,
+          redirect_uri: callback_url,
+          grant_type: "authorization_code"
+        }
+        params[:code_verifier] = verifier if verifier
+        params
+      end
+
+      def build_access_token
+        verifier = request.params["code"]
+        token = client.auth_code.get_token(verifier, {
+          redirect_uri: callback_url,
+          client_id: options.client_id,
+          # client_secret: options.client_secret
+        }.merge(token_params.to_hash(symbolize_keys: true)), deep_symbolize(options.auth_token_params))
+        token
+      end
+
+      private
+
+      def raw_info
+        @raw_info ||= access_token.get(USER_INFO_URL).parsed
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization "kakao", "Kakao"

data/lib/sb-omniauth-kakao/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module Kakao
+    VERSION = "0.3.0"
+  end
+end

data/lib/sb-omniauth-kakao.rb

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

data/sb-omniauth-kakao.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "sb-omniauth-kakao/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "sb-omniauth-kakao"
+  spec.version     = Omniauth::Kakao::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ["archmagece"]
+  spec.email       = ["archmagece@userspec.noreply.github.com"]
+
+  spec.homepage    = "https://github.com/ScriptonBasestar/sb-omniauth-kakao"
+  spec.summary     = %q{OmniAuth strategy for Kakao}
+  spec.description = %q{OmniAuth strategy for Kakao(http://developerspec.kakao.com/)}
+  spec.license     = "MIT"
+
+  spec.rubyforge_project = "sb-omniauth-kakao"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'omniauth', '~> 1.9'
+  spec.add_dependency 'omniauth-oauth2', '~> 1.3'
+
+  spec.add_development_dependency "bundler", "~> 2.6"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'fakeweb', '~> 1.3'
+  spec.add_development_dependency "minitest", "~> 5.25"
+end

data/spec/omniauth/strategies/kakao_spec.rb

@@ -0,0 +1,193 @@
+require 'spec_helper'
+require 'omniauth'
+require 'sb-omniauth-kakao'
+
+describe OmniAuth::Strategies::Kakao do
+  CLIENT_ID = '<<your-client-id>>'
+  SERVER_NAME = 'www.example.com'
+
+  before do
+    OmniAuth.config.logger.level = 5
+  end
+
+  def make_middleware(client_id, opts={})
+    app = ->(env) { [200, env, "app"] }
+
+    middleware = OmniAuth::Strategies::Kakao.new(app, opts)
+    middleware.tap do |middleware|
+      middleware.options.client_id = client_id
+    end
+  end
+
+  def make_request(url, opts={})
+    Rack::MockRequest.env_for(url, {
+      'rack.session' => {},
+      'SERVER_NAME' => SERVER_NAME,
+    }.merge(opts))
+  end
+
+  describe "GET /auth/kakao" do
+    it "should redirect to authorize page" do
+      request = make_request('/auth/kakao')
+      middleware = make_middleware(CLIENT_ID)
+
+      code, env = middleware.call(request)
+
+      code.should == 302
+
+      expect_url = <<-EXPECT
+        https://kauth.kakao.com/oauth/authorize
+          ?client_id=#{CLIENT_ID}
+          &redirect_uri=http://#{SERVER_NAME}/oauth
+          &response_type=code
+        EXPECT
+        .gsub(/(\n|\t|\s)/, '')
+
+      actual_url = URI.decode(env['Location'].split("&state")[0])
+
+      actual_url.should == expect_url
+    end
+
+    it "should customize redirect path" do
+      request = make_request('/auth/kakao')
+      middleware = make_middleware(CLIENT_ID, redirect_path: '/auth/kakao/callback')
+
+      code, env = middleware.call(request)
+
+      code.should == 302
+
+      expect_url = <<-EXPECT
+        https://kauth.kakao.com/oauth/authorize
+          ?client_id=#{CLIENT_ID}
+          &redirect_uri=http://#{SERVER_NAME}/auth/kakao/callback
+          &response_type=code
+        EXPECT
+        .gsub(/(\n|\t|\s)/, '')
+
+      actual_url = URI.decode(env['Location'].split("&state")[0])
+
+      actual_url.should == expect_url
+    end
+  end
+
+  describe "GET /oauth" do
+    CODE = "dummy-code"
+    STATE = "dummy-state"
+    ACCESS_TOKEN = "dummy-access-token"
+    REFRESH_TOKEN = "dummy-refresh-token"
+
+    before do
+      FakeWeb.register_uri(:post, "https://kauth.kakao.com/oauth/token",
+        :content_type => "application/json;charset=UTF-8",
+        :parameters => {
+          :grant_type => 'authorization_code',
+          :client_id => CLIENT_ID,
+          :redirect_uri => URI.encode("http://#{SERVER_NAME}/oauth"),
+          :code => CODE
+        },
+        :body => {
+          :access_token => ACCESS_TOKEN,
+          :token_type => "bearer",
+          :refresh_token => REFRESH_TOKEN,
+          :expires_in => 99999,
+          :scope => "Basic_Profile"
+        }.to_json
+      )
+
+      FakeWeb.register_uri(:get, "https://kapi.kakao.com/v1/user/me",
+        :content_type => "application/json;charset=UTF-8",
+        :"Authorization" => "Bearer #{ACCESS_TOKEN}",
+        :body => {
+          :id => 123456789,
+          :properties => {
+            :nickname => "John Doe",
+            :thumbnail_image => "http://xxx.kakao.com/.../aaa.jpg",
+            :profile_image => "http://xxx.kakao.com/.../bbb.jpg",
+          }
+        }.to_json
+      )
+    end
+
+    it "should request access token and user information" do
+      request = make_request("/oauth?code=#{CODE}&state=#{STATE}", {
+        'rack.session' => {
+          'omniauth.state' => STATE
+        },
+      })
+
+      middleware = make_middleware(CLIENT_ID)
+
+      code, env = middleware.call(request)
+
+      code.should == 200
+
+      response = env['omniauth.auth']
+
+      response.provider.should == "kakao"
+      response.uid.should == "123456789"
+
+      information = response.info
+      information.name.should == "John Doe"
+      information.image.should == "http://xxx.kakao.com/.../aaa.jpg"
+
+      credentials = response.credentials
+      credentials.token.should == ACCESS_TOKEN
+      credentials.refresh_token.should == REFRESH_TOKEN
+
+      properties = response.extra.properties
+      properties.nickname.should == "John Doe"
+      properties.thumbnail_image.should == "http://xxx.kakao.com/.../aaa.jpg"
+      properties.profile_image.should == "http://xxx.kakao.com/.../bbb.jpg"
+    end
+  end
+
+  context "test environment" do
+    before do
+      OmniAuth.config.test_mode = true
+      OmniAuth.config.add_mock(:kakao, {
+        provider: "kakao",
+        uid: "123456789",
+        info: {
+          name: "John Doe",
+          image: "http://xxx.kakao.com/.../aaa.jpg"
+        }
+      })
+    end
+
+    describe "GET /auth/kakao" do
+      it "should redirect to callback url (/auth/kakao/callback)" do
+        request = make_request("/auth/kakao")
+        middleware = make_middleware(CLIENT_ID)
+        code, env = middleware.call(request)
+
+        code.should == 302
+
+        actual_path = URI(env["Location"]).path
+        actual_path.should == "/auth/kakao/callback"
+      end
+    end
+
+    describe "GET /oauth" do
+      it "should request registered mock" do
+        request = make_request("/oauth")
+        middleware = make_middleware(CLIENT_ID)
+        code, env = middleware.call(request)
+
+        code.should == 200
+
+        response = env["omniauth.auth"]
+
+        response.provider.should == "kakao"
+        response.uid.should == "123456789"
+
+        information = response.info
+        information.name.should == "John Doe"
+        information.image.should == "http://xxx.kakao.com/.../aaa.jpg"
+      end
+    end
+
+    after do
+      OmniAuth.config.test_mode = false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'fakeweb'
+require 'json'
+
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: sb-omniauth-kakao
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- archmagece
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !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: 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: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+description: OmniAuth strategy for Kakao(http://developerspec.kakao.com/)
+email:
+- archmagece@userspec.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- example/.env.sample
+- example/Gemfile
+- example/Makefile
+- example/config.ru
+- lib/omniauth/strategies/kakao.rb
+- lib/sb-omniauth-kakao.rb
+- lib/sb-omniauth-kakao/version.rb
+- sb-omniauth-kakao.gemspec
+- spec/omniauth/strategies/kakao_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ScriptonBasestar/sb-omniauth-kakao
+licenses:
+- MIT
+metadata: {}
+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: OmniAuth strategy for Kakao
+test_files: []