OmniAuth Kakao

This is the OmniAuth strategy for authenticating to Kakao. To use it, you'll need to sign up for an REST API Key on the Kakao Developers Page. For more information, please refer to Create New Application page.

카카오 인증을 위한 OmniAuth strategy 입니다. 카카오 개발자 페이지에서 REST API 키를 생성한 뒤 이용해 주세요. 자세한 사항은 시작하기 - 앱 생성 페이지를 참고하시기 바랍니다.

Installing

Add to your Gemfile:

Gemfile에 다음의 코드를 넣어주세요.

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에서 미들웨어(Middleware)를 레일즈 어플리케이션에 넣어주세요.

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :kakao, ENV['KAKAO_CLIENT_ID']

  # 또는 Redirect Path를 설정하고 싶다면(or if you want to customize your Redirect Path)
  # provider :kakao, ENV['KAKAO_CLIENT_ID'], {:redirect_path => ENV['REDIRECT_PATH']}
end

Then go to My Application page, select your current application and add your domain address(ex: http://localhost:3000/) to 'Setting - Platform - Web - Site Domain'.

그리고 내 어플리케이션에서 현재 어플리케이션을 선택하고, '설정 - 플랫폼 - 웹 - 사이트 도메인'에 도메인 주소(예: http://localhost:3000/)를 넣어주세요.

For more information, please read the OmniAuth docs for detailed instructions.

더 자세한 사항은 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.

주의: 내 어플리케이션 의 '설정된 플랫폼 - 웹 - 사이트 도메인'에 http://localhost:4567/을 넣는 걸 잊지 마세요.

Auth Hash

Here's an example Auth Hash available in request.env['omniauth.auth']:

request.env['omniauth.auth'] 안에 들어있는 Auth Hash 는 다음과 같습니다.

{
  :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

Contribute

Fork the repository.
Create a new branch for each feature or improvement.
Add tests for it. This is important!
Send a pull request from each feature branch.

저장소를 Fork해 주세요.
새로운 기능(또는 개선할 부분)마다 브랜치를 만들어 주세요.
테스트를 작성해주세요. 이는 매우 중요합니다!
브랜치를 pull request로 보내주세요.

License

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.