omniauth-kakao 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb5a75b470abb1ff60e97711d9d7d092ea9090b6
-  data.tar.gz: f81819bcad8d02a12042af027c9c8ea2ed5bb854
+  metadata.gz: d408aa8b09df76d9027300b309cc1d72fe2d7099
+  data.tar.gz: df858be392f2b9910f478073da3965e004be0a4d
 SHA512:
-  metadata.gz: d4bafbc60cbbb7b280a1050326ba73c7b4bec0cbfc9e2783403c78c095454806783f85acf54a99a1c490053afec8733b2bca0ffa710195ea564549f87009d6c6
-  data.tar.gz: 10ef7e0e3bcc4e050aaff082506451d447848e152502722a8ae5092ae369da81eed28d9517ba154d30f028e4db09150290f1d1a7c5a06c741f99a0e4c440a669
+  metadata.gz: afa6411ff7e30b91d58f43d20993062fbf15d94b657968127f212cd4378266e899d237fa83909a852a912333086cddb3a15c2b0b0afdd334229a54871fcc0ee1
+  data.tar.gz: f46f477f9de2d92ff48090b7c17b6c23a67ffceca63d68174f1e23498cfcde6baa6a5f3ffd05fc51a28d48d12d0727f607d2ca749f1322b43006d36f47758a11

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rspec

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

data/CHANGELOG

@@ -1,3 +1,7 @@
+## v0.0.2
+
+* 개발 완료
+
 ## v0.0.1
 
 * 릴리즈 준비

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    omniauth-kakao (0.0.1)
+      omniauth (~> 1.0)
+      omniauth-oauth2 (~> 1.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    celluloid-io (0.15.0)
+      celluloid (>= 0.15.0)
+      nio4r (>= 0.5.0)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    fakeweb (1.3.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.6.0)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.2.8)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    hashie (2.1.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    listen (2.7.4)
+      celluloid (>= 0.15.2)
+      celluloid-io (>= 0.15.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.5)
+    method_source (0.8.2)
+    multi_json (1.9.3)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nio4r (1.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)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.4)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    slop (3.5.0)
+    thor (0.19.1)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb (~> 1.3.0)
+  guard-rspec (~> 4.2.8)
+  omniauth-kakao!
+  rspec (~> 2.14.1)

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

@@ -1,4 +1,74 @@
-omniauth-kakao
-==============
+# OmniAuth Kakao
 
-OmniAuth strategy for Kakao(under construction)
+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#시작하기-앱-생성) 페이지를 참조해 주세요.
+
+## Installing
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'omniauth-kakao'
+```
+
+Then `bundle install`.
+
+## Usage
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :kakao, ENV['KAKAO_CLIENT_ID']
+end
+```
+
+For more information, please read the [OmniAuth](https://github.com/intridea/omniauth) docs for detailed instructions.
+
+## Auth Hash
+
+Here's an example *Auth Hash* available in `request.env['omniauth.auth']`:
+
+```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'
+    }
+  }
+}
+```
+
+## Contribute
+
+1. Fork the repository.
+1. Create a new branch for each feature or improvement.
+1. Add tests for it. This is important!
+1. Send a pull request from each feature branch.
+
+## License
+
+Copyright (c) 2014 [Shayne Sung-Hee Kang](http://medium.com/@shaynekang).
+
+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/lib/omniauth-kakao.rb

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

data/lib/omniauth-kakao/version.rb

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

data/lib/omniauth/strategies/kakao.rb

@@ -0,0 +1,49 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Kakao < OmniAuth::Strategies::OAuth2
+      option :name, 'kakao'
+
+      option :client_options, {
+        :site => 'https://kauth.kakao.com',
+        :authorize_path => '/oauth/authorize',
+        :token_url => '/oauth/token',
+      }
+
+      uid { raw_info['id'].to_s }
+
+      info do
+        {
+          'name' => raw_properties['nickname'],
+          'image' => raw_properties['thumbnail_image'],
+        }
+      end
+
+      extra do
+        {'properties' => raw_properties}
+      end
+
+      def initialize(app, *args, &block)
+        super
+        options[:callback_path] = "/oauth"
+      end
+
+      def callback_phase
+        @env["PATH_INFO"] = "/auth/kakao/callback"
+        super
+      end
+
+    private
+      def raw_info
+        @raw_info ||= access_token.get('https://kapi.kakao.com/v1/user/me', {}).parsed || {}
+      end
+
+      def raw_properties
+        @raw_properties ||= raw_info['properties']
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization 'kakao', 'Kakao'

data/omniauth-kakao.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "omniauth-kakao/version"
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-kakao"
+  s.version     = Omniauth::Kakao::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Shayne Sung-Hee Kang"]
+  s.email       = ["shayne.kang@gmail.com"]
+  s.homepage    = "http://medium.com/@shaynekang"
+  s.summary     = %q{OmniAuth strategy for Kakao}
+  s.description = %q{OmniAuth strategy for Kakao(http://developers.kakao.com/)}
+  s.license     = "MIT"
+
+  s.rubyforge_project = "omniauth-kakao"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'omniauth', '~> 1.0'
+  s.add_dependency 'omniauth-oauth2', '~> 1.1'
+
+  s.add_development_dependency 'rspec', '~> 2.14.1'
+  s.add_development_dependency 'guard-rspec', '~> 4.2.8'
+  s.add_development_dependency 'fakeweb', '~> 1.3.0'
+end

data/spec/omniauth/strategies/kakao_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+require 'omniauth'
+require '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
+
+  let(:middleware) do
+    app = ->(env) { [200, env, "app"] }
+
+    middleware = OmniAuth::Strategies::Kakao.new(app)
+    middleware.tap do |middleware|
+      middleware.options.client_id = CLIENT_ID
+    end
+  end
+
+  def generate_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 = generate_request('/auth/kakao')
+
+      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
+      expect_url = expect_url.gsub(/(\n|\t|\s)/, '')
+
+      actual_url = URI.decode(env['Location'])
+      actual_url = actual_url.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"
+
+    it "should request access token and user information" 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
+      )
+
+      request = generate_request("/oauth?code=#{CODE}&state=#{STATE}", {
+        'rack.session' => {
+          'omniauth.state' => STATE
+        },
+      })
+
+      code, env = middleware.call(request)
+      code.should == 200
+
+      result = env['omniauth.auth']
+
+      result.provider.should == "kakao"
+      result.uid.should == "123456789"
+
+      information = result.info
+      information.name.should == "John Doe"
+      information.image.should == "http://xxx.kakao.com/.../aaa.jpg"
+
+      credentials = result.credentials
+      credentials.token.should == ACCESS_TOKEN
+      credentials.refresh_token.should == REFRESH_TOKEN
+
+      properties = result.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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# 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'
+
+$:.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

@@ -1,26 +1,106 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-kakao
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Shayne Sung-Hee Kang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-04 00:00:00.000000000 Z
-dependencies: []
-description: OmniAuth strategy for Kakao(under construction)
+date: 2014-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.8
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: OmniAuth strategy for Kakao(http://developers.kakao.com/)
 email:
 - shayne.kang@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .rspec
 - CHANGELOG
+- Gemfile
+- Gemfile.lock
+- Guardfile
 - README.md
+- lib/omniauth-kakao.rb
 - lib/omniauth-kakao/version.rb
-homepage: http://www.medium.com/shaynekang
+- lib/omniauth/strategies/kakao.rb
+- omniauth-kakao.gemspec
+- spec/omniauth/strategies/kakao_spec.rb
+- spec/spec_helper.rb
+homepage: http://medium.com/@shaynekang
 licenses:
 - MIT
 metadata: {}
@@ -44,4 +124,6 @@ rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: OmniAuth strategy for Kakao
-test_files: []
+test_files:
+- spec/omniauth/strategies/kakao_spec.rb
+- spec/spec_helper.rb