kakao_push 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4b8321a4fa65fa0a6dfda30ef3b4ca2abd1c980
+  data.tar.gz: 4442e21c9ceb76b11368cf5f0dd78ef8ff7b11d6
+SHA512:
+  metadata.gz: 7b947d916c75ab047457fdfc2063a545b91562ad6faa3f2d1456258ecccaa76928c8b4acf570c7f928bd2c6b704e401e83075b9dc52f642df0e69fde938b6abd
+  data.tar.gz: ac308a07831049dab17dbb3b29ce7cd6271d16b0905bf5ef2336a2031f739d7cf35c05ebee7cddee8e2ccd190b2892afcb67083a6d60cf4e0398c9d9087a4089

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 N42Corp
+
+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,105 @@
+# KakaoPush [![Gem Version](https://badge.fury.io/rb/kakao_push.svg)](https://badge.fury.io/rb/kakao_push)
+
+카카오 플랫폼 API에서 제공하는 [푸시알림](https://developers.kakao.com/features/platform#푸시-알림)을 호출하는 젬입니다. iOS, 안드로이드 사용자에게 푸시를 보낼때 유용한 카카오 푸시알림은 REST API로만 제공되고 있기에 이를 젬으로 만들어 봤습니다.
+
+[당근마켓](https://www.daangn.com/)([아이폰](https://itunes.apple.com/kr/app/pangyojangteo/id1018769995?l=ko&ls=1&mt=8), [안드로이드](https://play.google.com/store/apps/details?id=com.towneers.www))에서 사용하던 코드를 젬으로 만들었습니다.
+
+주의: 이 젬은 카카오에서 공식적으로 제공하는 젬이 아닙니다. 이점 유의 하시기 바랍니다.
+
+## 설치
+
+Gemfile 파일에 다음과 같이 추가하고:
+
+```ruby
+gem 'kakao_push', '~> 0.0.1'
+```
+
+아래 명령어를 실행합니다:
+
+    $ bundle
+
+혹은 젬을 직접 설치할 수 있습니다:
+
+    $ gem install kakao_push
+
+## 사용법
+
+### 클라이언트 객체 생성
+
+```ruby
+client = KakaoPush::Client.new(rest_api_key: 'kakao_admin_key')
+```
+
+### 토큰 등록
+
+파라미터 및 응답에 관한 자세한 정보는 [카카오 REST API 개발가이드 - 푸시알림](https://developers.kakao.com/docs/restapi#푸시-알림) 참고
+
+```ruby
+res = client.register(uuid: 1, push_type: 'apns', device_id: 'device_id', push_token: 'push_token')
+
+res.success? # 등록에 성공한 경우 true
+res.fail? # 등록에 실패한 경우 true
+res.data # 등록에 성공한 경우 숫자 30 반환. 30일 후에 해당 토큰이 만료됨을 의미
+=> 30
+```
+
+### 토큰 조회
+
+파라미터 및 응답에 관한 자세한 정보는 [카카오 REST API 개발가이드 - 푸시알림](https://developers.kakao.com/docs/restapi#푸시-알림) 참고
+
+```ruby
+res = client.tokens(uuid: 1)
+
+res.success? # 조희에 성공한 경우 true
+res.fail? # 조회에 실패한 경우 true
+res.data # 조회에 성공한 경우 데이터 반환. 배열로 반환되지만 배열 객체는 1개 뿐이므로 유의
+=> [{"user_id":"1","device_id":"a","push_type":"apns","push_token":"aaa","created_at":"2015-12-11T11:34:17Z","updated_at":"2015-12-11T11:34:17Z"}]
+```
+
+### 토큰 삭제
+
+파라미터 및 응답에 관한 자세한 정보는 [카카오 REST API 개발가이드 - 푸시알림](https://developers.kakao.com/docs/restapi#푸시-알림) 참고
+
+```ruby
+res = client.deregister(uuid: 1, push_type: 'apns', device_id: 'device_id')
+res.success? # 삭제에 성공한 경우 true
+res.fail? # 삭제에 실패한 경우 true
+```
+
+### 푸시 전송
+
+파라미터 및 응답에 관한 자세한 정보는 [카카오 REST API 개발가이드 - 푸시알림](https://developers.kakao.com/docs/restapi#푸시-알림) 참고
+
+```ruby
+apns = KakaoPush::Apns.new(badge: nil, sound: 'default', push_alert: true, message: nil, custom_field: nil, push_token: nil)
+gcm = KakaoPush::Gcm.new(collapse: nil, delay_while_idle: nil, return_url: nil, custom_field: 'data', push_token: nil)
+res = client.send(uuids: [1], apns: apns, gcm: gcm, bypass: false)
+
+res.success? # 전송에 성공한 경우 true
+res.fail? # 전송에 실패한 경우 true
+```
+
+success? 결과가 true이더라도 실제 사용자에 디바이스에 전송되었음을 보장하지 않음. 메시지 포맷이 다르거나 맞지 않아도 success? 값이 true로 반환되기도 하므로 실제 전송 유무는 디바이스에서 테스트가 필요합니다.
+
+### 서버에 저장할 값
+
+디바이스로부터 받은 토큰, 푸쉬 타입(apns, gcm)은 서버에 저장하는것이 좋다. 토큰 삭제를 안할거라면 푸쉬 타입은 굳이 저장할 필요 없습니다. 푸쉬 토큰은 30일이 지나면 토큰 조회 API를 통해서도 조회 할 수 없으므로 될수 있으면 저장하는 편이 좋다고 생각합니다.
+
+예를 들어보자면 디바이스로부터 받은 토큰과 카카오 푸쉬 만료 예정일을 서버에 저장하고 푸쉬 만료 예정일이 되기 전에 다시 토큰 등록 API를 호출하는 사례도 있습니다.
+
+## 에러 상황
+
+정상적인 파라미터를 제공 했음에도 아래와 같은 오류가 발생 한다면 Kakao Developers 사이트에서 앱 설정의 '푸시 알림'을 활성화 하고 gcm, apns 설정을 잘 했는지 확인해야 합니다. 설정하지 않은 경우 아래와 같이 파라미터가 잘못됬다고 에러 메시지가 반환됩니다.
+
+```
+{"code":-2,"msg":"[appName] Invalid Kpusher Param. ( appName=1111, uid=1234, did=dlskjflsk3ksdjfl, pushType=apns, pushToken=lqO_NIwaoAcI0MssA )"}%
+```
+
+## 도움 주신 분들
+
+- [@marocchino](https://github.com/marocchino) : 테스트 코드에서 막혀 있을때 도움 주셨습니다.
+- [@shia](https://github.com/riseshia) : 응답 및 푸시 메시지 구조를 잡는데 도움 주셨습니다. 
+
+## Contributing
+
+버그 레포팅과 풀리퀘스트는 GitHub에 남겨주세요. https://github.com/n42corp/kakao_push

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kakao_push"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kakao_push.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kakao_push/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kakao_push"
+  spec.version       = KakaoPush::VERSION
+  spec.authors       = ["ChangHoon Jung"]
+  spec.email         = ["iamseapy@gmail.com"]
+
+  spec.summary       = %q{카카오 플랫폼 API에서 제공하는 푸시알림을 호출하는 젬입니다.}
+  spec.description   = %q{카카오 플랫폼 API에서 제공하는 푸시알림을 호출하는 젬입니다. iOS, 안드로이드 사용자에게 푸시를 보낼때 유용한 카카오 푸시알림은 REST API로만 제공되고 있기에 이를 젬으로 만들어 봤습니다.}
+  spec.homepage      = "https://github.com/n42corp/kakao_push"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|example)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "multi_json"
+  spec.add_dependency "faraday", "~> 0.9.2"
+  spec.add_dependency "faraday_middleware", "~> 0.10.0"
+  
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/kakao_push/apns.rb

@@ -0,0 +1,23 @@
+module KakaoPush
+  class Apns
+    def initialize(badge: nil, sound: nil, push_alert: nil, message: nil, custom_field: nil, push_token: nil)
+      @badge = badge
+      @sound = sound
+      @push_alert = push_alert
+      @message = message
+      @custom_field = custom_field
+      @push_token = push_token
+    end
+
+    def to_hash
+      for_apns = {}
+      for_apns['badge'] = @badge if !@badge.nil?
+      for_apns['sound'] = @sound if !@sound.nil?
+      for_apns['push_alert'] = @push_alert if !@push_alert.nil?
+      for_apns['message'] = @message if !@message.nil?
+      for_apns['custom_field'] = @custom_field if !@custom_field.nil?
+      for_apns['push_token'] = @push_token if !@push_token.nil?
+      for_apns
+    end
+  end
+end

data/lib/kakao_push/client.rb

@@ -0,0 +1,103 @@
+module KakaoPush
+  class Client
+    API_HOST = "https://kapi.kakao.com"
+
+    attr_accessor :rest_api_key
+
+    def initialize(rest_api_key:)
+      @rest_api_key = rest_api_key
+
+      self.connection = build_connection
+    end
+
+    def register(uuid:, push_type:, device_id:, push_token:)
+      body = {
+        'uuid' => uuid,
+        'device_id' => device_id,
+        'push_type' => push_type,
+        'push_token' => push_token
+      }
+
+      KakaoPush::Response.new(
+        connection.post do |req|
+          req.url url_for('/register')
+          req.body = body
+        end
+      )
+    end
+
+    def deregister(uuid:, push_type:, device_id:)
+      body = {
+        'uuid' => uuid,
+        'device_id' => device_id,
+        'push_type' => push_type
+      }
+
+      KakaoPush::Response.new(
+        connection.post do |req|
+          req.url url_for('/deregister')
+          req.body = body
+        end
+      )
+    end
+
+    def tokens(uuid:)
+      KakaoPush::Response.new(
+        connection.get do |req|
+          req.url url_for('/tokens')
+          req.params['uuid'] = uuid
+        end
+      )
+    end
+
+    def send(uuids: [], apns:, gcm:, bypass: false)
+      body = {
+        'uuids': uuids.to_json,
+        'push_message': build_message(apns: apns, gcm: gcm).to_json,
+        'bypass': bypass
+      }
+
+      KakaoPush::Response.new(
+        connection.post do |req|
+          req.url url_for('/send')
+          req.body = body
+        end
+      )
+    end
+
+    def build_connection(&block)
+      Faraday.new(faraday_client_options) do |builder|
+        builder.request :url_encoded
+        if block.nil?
+          builder.adapter Faraday.default_adapter
+        else
+          block.call(builder)
+        end
+      end
+    end
+
+    private
+
+    attr_accessor :connection
+
+    def faraday_client_options
+      {
+        headers: {
+          "Authorization" => "KakaoAK #{@rest_api_key}"
+        },
+        url: API_HOST
+      }
+    end
+
+    def url_for(path)
+      "/v1/push#{path}"
+    end
+
+    def build_message(apns:, gcm:)
+      {
+        "for_apns" => apns.to_hash,
+        "for_gcm" => gcm.to_hash
+      }
+    end
+  end
+end

data/lib/kakao_push/gcm.rb

@@ -0,0 +1,21 @@
+module KakaoPush
+  class Gcm
+    def initialize(collapse: nil, delay_while_idle: nil, return_url: nil, custom_field: nil, push_token: nil)
+      @collapse = collapse
+      @delay_while_idle = delay_while_idle
+      @return_url = return_url
+      @custom_field = custom_field
+      @push_token = push_token
+    end
+
+    def to_hash
+      for_gcm = {}
+      for_gcm['collapse'] = @collapse if !@collapse.nil?
+      for_gcm['delay_while_idle'] = @delay_while_idle if !@delay_while_idle.nil?
+      for_gcm['return_url'] = @return_url if !@return_url.nil?
+      for_gcm['custom_field'] = @custom_field if !@custom_field.nil?
+      for_gcm['push_token'] = @push_token if !@push_token.nil?
+      for_gcm
+    end
+  end
+end

data/lib/kakao_push/response.rb

@@ -0,0 +1,57 @@
+require 'multi_json'
+
+module KakaoPush
+  class Response
+    def initialize(faraday_response)
+      @raw_body = faraday_response.body
+      @raw_status = faraday_response.status
+    end
+
+    def body
+      @body ||= MultiJson.load(@raw_body) if !@raw_body.nil? && !@raw_body.empty?
+    end
+
+    def status
+      @raw_status
+    end
+
+    def success?
+      status == 200
+    end
+
+    def fail?
+      !success?
+    end
+
+    def data
+      success? ? body : nil
+    end
+
+    def error_code
+      if fail? && body.is_a?(Hash) && body.has_key?('code')
+        return body['code']
+      end
+      nil
+    end
+
+    def error_message
+      if fail? && body.is_a?(Hash) && body.has_key?('msg')
+        return body['msg']
+      end
+      nil
+    end
+
+    def to_s
+      <<-EOS
+KakaoPush::Response
+status : #{status}
+success? : #{success?}
+fail? : #{fail?}
+data : #{data}
+error_code : #{error_code}
+error_message : #{error_message}
+
+      EOS
+    end
+  end
+end

data/lib/kakao_push/version.rb

@@ -0,0 +1,3 @@
+module KakaoPush
+  VERSION = "0.1.1"
+end

data/lib/kakao_push.rb

@@ -0,0 +1,13 @@
+require "faraday"
+require "faraday_middleware"
+require "json"
+
+require "kakao_push/response"
+require "kakao_push/client"
+require "kakao_push/apns"
+require "kakao_push/gcm"
+require "kakao_push/version"
+
+module KakaoPush
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: kakao_push
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- ChangHoon Jung
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "카카오 플랫폼 API에서 제공하는 푸시알림을 호출하는 젬입니다. iOS, 안드로이드 사용자에게 푸시를 보낼때 유용한 카카오
+  푸시알림은 REST API로만 제공되고 있기에 이를 젬으로 만들어 봤습니다."
+email:
+- iamseapy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kakao_push.gemspec
+- lib/kakao_push.rb
+- lib/kakao_push/apns.rb
+- lib/kakao_push/client.rb
+- lib/kakao_push/gcm.rb
+- lib/kakao_push/response.rb
+- lib/kakao_push/version.rb
+homepage: https://github.com/n42corp/kakao_push
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: "카카오 플랫폼 API에서 제공하는 푸시알림을 호출하는 젬입니다."
+test_files: []