omniauth-kakao 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d408aa8b09df76d9027300b309cc1d72fe2d7099
-  data.tar.gz: df858be392f2b9910f478073da3965e004be0a4d
+  metadata.gz: 7c204a8a6c343b6b8115eae40980433176e2e899
+  data.tar.gz: ed3208ce20e5ec41eaffaaabe6175f40ab3d26e2
 SHA512:
-  metadata.gz: afa6411ff7e30b91d58f43d20993062fbf15d94b657968127f212cd4378266e899d237fa83909a852a912333086cddb3a15c2b0b0afdd334229a54871fcc0ee1
-  data.tar.gz: f46f477f9de2d92ff48090b7c17b6c23a67ffceca63d68174f1e23498cfcde6baa6a5f3ffd05fc51a28d48d12d0727f607d2ca749f1322b43006d36f47758a11
+  metadata.gz: 55f45f5dd0469c6c0544c232d3a96ff5a31fd720a5d1ad1dd86d23df02402dc0754c648d8c5fc87aec1441783302951c52b3def30e219b9b1c35f730696759fa
+  data.tar.gz: e485c7959f343ef18d723b4cfa0e116f8a554ce57c84f809edca9cb298274cdef94bafc36d9498a8c5492d6f158d5cb08efaa2974f193b9dd7a2cdc77738bdb3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    omniauth-kakao (0.0.1)
+    omniauth-kakao (0.0.2)
       omniauth (~> 1.0)
       omniauth-oauth2 (~> 1.1)
 

data/README.md

@@ -3,35 +3,71 @@
 This is the OmniAuth strategy for authenticating to [Kakao](http://www.kakao.com/). To
 use it, you'll need to sign up for an REST API Key on the [Kakao Developers Page](http://developers.kakao.com). For more information, please refer to [Create New Application](https://developers.kakao.com/docs/restapi#시작하기-앱-생성) page.
 
-[카카오](http://www.kakao.com/) 인증을 위한 OmniAuth strategy 입니다.
-[카카오 개발자 페이지](http://developers.kakao.com) 에서 REST API 키를 생성한 뒤 이용할 수 있습니다. 자세한 사항은 [앱 생성](https://developers.kakao.com/docs/restapi#시작하기-앱-생성) 페이지를 참조해 주세요.
+[카카오](http://www.kakao.com/) 인증을 위한 OmniAuth strategy 입니다. [카카오 개발자 페이지](http://developers.kakao.com)에서 REST API 키를 생성한 뒤 이용해 주세요. 자세한 사항은 [시작하기 - 앱 생성](https://developers.kakao.com/docs/restapi#시작하기-앱-생성) 페이지를 참조하시기 바랍니다.
 
 ## Installing
 
 Add to your `Gemfile`:
 
+`Gemfile`에 다음의 코드를 넣어주세요.
+
 ```ruby
 gem 'omniauth-kakao'
 ```
 
 Then `bundle install`.
 
+이후 `bundle install` 을 실행해 주세요.
+
 ## Usage
 
 Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
 
+다음은 간단한 예제입니다. `config/initializers/omniauth.rb`에서 미들웨어를 레일즈 어플리케이션에 넣어주세요.
+
+
 ```ruby
 Rails.application.config.middleware.use OmniAuth::Builder do
   provider :kakao, ENV['KAKAO_CLIENT_ID']
 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
+```
+
+Then open `http://localhost:4567/` in your browser.
+
+이후 `http://localhost:4567/`로 접속하시면 됩니다.
+
+Warning: Do not forgot to add `http://localhost:4567/` in your [Application Setting](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',
@@ -63,6 +99,14 @@ Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
 1. Add tests for it. This is important!
 1. Send a pull request from each feature branch.
 
+***
+
+1. 저장소를 Fork해 주세요.
+1. 새로운 기능(또는 개선할 부분)마다 브랜치를 만들어 주세요.
+1. 테스트를 작성해주세요. 이는 매우 중요합니다!
+1. 브랜치를 pull request로 보내주세요.
+
+
 ## License
 
 Copyright (c) 2014 [Shayne Sung-Hee Kang](http://medium.com/@shaynekang).

data/example/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'sinatra', '~> 1.4.5'
+gem 'omniauth-kakao', :path => '../'

data/example/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: ../
+  specs:
+    omniauth-kakao (0.0.2)
+      omniauth (~> 1.0)
+      omniauth-oauth2 (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    hashie (2.1.1)
+    jwt (0.1.12)
+    multi_json (1.10.0)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    omniauth (1.2.1)
+      hashie (>= 1.2, < 3)
+      rack (~> 1.0)
+    omniauth-oauth2 (1.1.2)
+      faraday (>= 0.8, < 0.10)
+      multi_json (~> 1.3)
+      oauth2 (~> 0.9.3)
+      omniauth (~> 1.2)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    tilt (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-kakao!
+  sinatra (~> 1.4.5)

data/example/app.rb

@@ -0,0 +1,135 @@
+require 'bundler/setup'
+require 'sinatra'
+require 'omniauth-kakao'
+
+client_id = ENV['KAKAO_CLIENT_ID']
+if client_id == nil
+  class NoClientIDError < StandardError; end
+  raise NoClientIDError, "KAKAO_CLIENT_ID is nil. Please run example like `KAKAO_CLIENT_ID='<your-kakako-client-id>' ruby app.rb`"
+end
+
+use Rack::Session::Cookie
+
+use OmniAuth::Builder do
+  provider :kakao, client_id
+end
+
+helpers do
+  def yaml_to_html(yaml)
+    display = yaml.split("\n")
+    display = display.map do |e|
+      e.gsub!("  ", "&nbsp;&nbsp;&nbsp;&nbsp;")
+      "<p>#{e}</p>"
+    end.join
+  end
+end
+
+get '/' do
+  erb :index
+end
+
+get '/auth/:provider/callback' do
+  @modal = {
+    title: "Success!",
+    body: yaml_to_html(request.env['omniauth.auth'].to_yaml)
+  }
+
+  erb :index
+end
+
+get '/auth/failure' do
+  @modal = {
+    title: "Failure",
+    body: "Error: #{params[:message]}"
+  }
+
+  erb :index
+end
+
+__END__
+@@ index
+<html>
+  <head>
+    <title>Test Application for Omniauth Kakao</title>
+    <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap.min.css">
+    <link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.1.1/css/bootstrap-theme.min.css">
+    <script src="https://code.jquery.com/jquery-2.1.0.min.js"></script>
+    <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
+    <style>
+      #login-form {
+        margin-top: 30px;
+        text-align: center;
+      }
+
+      #login-form.panel-primary {
+        border-color: #FFEB00;
+      }
+
+      #login-form.panel-primary > .panel-heading {
+        background-image: -webkit-linear-gradient(top, #FFEB00 0, #FFEB00 100%);
+        background-image: -moz-linear-gradient(top, #FFEB00 0, #FFEB00 100%);
+        background-image: -o-linear-gradient(top, #FFEB00 0, #FFEB00 100%);
+        background-image: linear-gradient(top, #FFEB00 0, #FFEB00 100%);
+        background-color: #FFEB00;
+        border-color: #FFEB00;
+        color: #3D1D12;
+      }
+
+      .btn-kakao {
+        display: inline-block;
+        background-image: url("https://kauth.kakao.com/public/widget/login/kr/kr_02_medium.png");
+
+        width: 222px;
+        height: 49px;
+
+        line-height: 0;
+        font-size: 0;
+        color: transparent;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <div class="row">
+        <div class="col-md-6 col-md-offset-3">
+          <div id="login-form" class="panel panel-primary">
+            <div class="panel-heading">
+              <h3 class="panel-title">Test Application for Omniauth Kakao</h3>
+            </div>
+
+            <div class="panel-body">
+              <a href="/auth/kakao" class="btn-kakao">카카오 계정으로 로그인</a>
+            </div>
+          </div>
+        </div>
+
+        <% if @modal %>
+          <div class="modal fade" id="auth-modal" tabindex="-1" role="dialog" aria-labelledby="auth-modal-label" aria-hidden="true">
+            <div class="modal-dialog modal-lg">
+              <div class="modal-content">
+                <div class="modal-header">
+                  <button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button>
+                  <h4 class="modal-title" id="myModalLabel"><%= @modal[:title] %></h4>
+                </div>
+
+                <div class="modal-body">
+                  <%= @modal[:body] %>
+                </div>
+
+                <div class="modal-footer">
+                  <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
+                </div>
+              </div>
+            </div>
+          </div>
+
+          <script>
+            $(function(){
+              $('#auth-modal').modal('show');
+            });
+          </script>
+        <% end %>
+      </div>
+    </div>
+  </body>
+</html>

data/lib/omniauth-kakao/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Kakao
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/omniauth/strategies/kakao.rb

@@ -30,7 +30,9 @@ module OmniAuth
       end
 
       def callback_phase
-        @env["PATH_INFO"] = "/auth/kakao/callback"
+        previous_callback_path = options.delete(:callback_path)
+        @env["PATH_INFO"] = callback_path
+        options[:callback_path] = previous_callback_path
         super
       end
 

data/omniauth-kakao.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Shayne Sung-Hee Kang"]
   s.email       = ["shayne.kang@gmail.com"]
-  s.homepage    = "http://medium.com/@shaynekang"
+  s.homepage    = "https://github.com/shaynekang/omniauth-kakao"
   s.summary     = %q{OmniAuth strategy for Kakao}
   s.description = %q{OmniAuth strategy for Kakao(http://developers.kakao.com/)}
   s.license     = "MIT"

data/spec/omniauth/strategies/kakao_spec.rb

@@ -19,7 +19,7 @@ describe OmniAuth::Strategies::Kakao do
     end
   end
 
-  def generate_request(url, opts={})
+  def make_request(url, opts={})
     Rack::MockRequest.env_for(url, {
       'rack.session' => {},
       'SERVER_NAME' => SERVER_NAME,
@@ -28,9 +28,10 @@ describe OmniAuth::Strategies::Kakao do
 
   describe "GET /auth/kakao" do
     it "should redirect to authorize page" do
-      request = generate_request('/auth/kakao')
+      request = make_request('/auth/kakao')
 
       code, env = middleware.call(request)
+
       code.should == 302
 
       expect_url = <<-EXPECT
@@ -38,11 +39,10 @@ describe OmniAuth::Strategies::Kakao do
           ?client_id=#{CLIENT_ID}
           &redirect_uri=http://#{SERVER_NAME}/oauth
           &response_type=code
-      EXPECT
-      expect_url = expect_url.gsub(/(\n|\t|\s)/, '')
+        EXPECT
+        .gsub(/(\n|\t|\s)/, '')
 
-      actual_url = URI.decode(env['Location'])
-      actual_url = actual_url.split("&state")[0]
+      actual_url = URI.decode(env['Location'].split("&state")[0])
 
       actual_url.should == expect_url
     end
@@ -54,7 +54,7 @@ describe OmniAuth::Strategies::Kakao do
     ACCESS_TOKEN = "dummy-access-token"
     REFRESH_TOKEN = "dummy-refresh-token"
 
-    it "should request access token and user information" do
+    before do
       FakeWeb.register_uri(:post, "https://kauth.kakao.com/oauth/token",
         :content_type => "application/json;charset=UTF-8",
         :parameters => {
@@ -84,30 +84,33 @@ describe OmniAuth::Strategies::Kakao do
           }
         }.to_json
       )
+    end
 
-      request = generate_request("/oauth?code=#{CODE}&state=#{STATE}", {
+    it "should request access token and user information" do
+      request = make_request("/oauth?code=#{CODE}&state=#{STATE}", {
         'rack.session' => {
           'omniauth.state' => STATE
         },
       })
 
       code, env = middleware.call(request)
+
       code.should == 200
 
-      result = env['omniauth.auth']
+      response = env['omniauth.auth']
 
-      result.provider.should == "kakao"
-      result.uid.should == "123456789"
+      response.provider.should == "kakao"
+      response.uid.should == "123456789"
 
-      information = result.info
+      information = response.info
       information.name.should == "John Doe"
       information.image.should == "http://xxx.kakao.com/.../aaa.jpg"
 
-      credentials = result.credentials
+      credentials = response.credentials
       credentials.token.should == ACCESS_TOKEN
       credentials.refresh_token.should == REFRESH_TOKEN
 
-      properties = result.extra.properties
+      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"

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@
 #
 # 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__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-kakao
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Shayne Sung-Hee Kang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -94,13 +94,16 @@ files:
 - Gemfile.lock
 - Guardfile
 - README.md
+- example/Gemfile
+- example/Gemfile.lock
+- example/app.rb
 - lib/omniauth-kakao.rb
 - lib/omniauth-kakao/version.rb
 - lib/omniauth/strategies/kakao.rb
 - omniauth-kakao.gemspec
 - spec/omniauth/strategies/kakao_spec.rb
 - spec/spec_helper.rb
-homepage: http://medium.com/@shaynekang
+homepage: https://github.com/shaynekang/omniauth-kakao
 licenses:
 - MIT
 metadata: {}