kth-alimtalk 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53ab3651239b2a57c18e3488dfb39d9da826fc5b
-  data.tar.gz: 975a53153fcbed945b2ee72ba7679429f0f42a59
+  metadata.gz: 32c7e0ab55cd53ef5cd15079ae4a3f40d9d3630c
+  data.tar.gz: 91a8c007c57a04d433effdd08e1f2124a2d60c8c
 SHA512:
-  metadata.gz: 68118e5364b4dd03fb2c89dd0fc63bde1f3ac38a692f945b66f8f766fa8d823e98abbd0767067d023ae7bef6c5bbcd9f9879fd638c0dcf6232294d17b07e286f
-  data.tar.gz: aa8f639609bb373daf3c993a32ca1669b61eea4e5bef09428c685a44cad1fa32ccc0e16086497b531ce6333d34b8ce2616893e3a29547002570caf6d5f3c166b
+  metadata.gz: 918c4ee819df53f2ca0a4e83d389a6538a75432e8b10118124dcd732588e7296569c4a0d961fa1e9238e3d15915dd5bf703449a1953488ea5ca74c6a3810a209
+  data.tar.gz: 2dde03ecd93115b5377c813ea8f9b33ea6378ba559040850c4c826e8cda09aa115a3758b83e39c2628748826f5ec2608c0fb7bde8b41026a61969f386820cd0a

data/README.md

@@ -1,9 +1,6 @@
 # Kth::Alimtalk
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kth/alimtalk`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
+API스토어(https://www.apistore.co.kr/api/apiViewPrice.do?service_seq=558)에서 제공하는 카카오톡 알림톡 API를 구현한 gem.
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,7 +19,74 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create a client variable with your "API스토어ID" and "API Store Key".
+```ruby
+c = Kth::Alimtalk::Client.new("API스토어ID", "API STORE KEY")
+```
+
+### 알림톡 발송
+
+```ruby
+# phone_number: 수신할 핸드폰 번호
+# callback: 발신자 전화번호
+# msg: 전송할 메세지
+# template_code: 카카오톡 알림톡 템플릿 코드
+# failed_type: 전송 실패시 발송할 메세지 형태 (ex. SMS, LMS, N)
+# options: {
+#   request_date: 발송시간 (Time.new(2017, 07, 17, 19, 00, 00))
+#   url: 알림톡 버튼 타입 URL (승인된 template 과 불일치시 전송실패)
+#   url_button_text: 알림톡 버튼 타입 버튼 TEXT (승인된 template과 불일치시 전송실패)
+#   failed_subject: 카카오알림톡 전송 실패 시 전송할 제목 (SMS 미사용)
+#   failed_msg: 카카오알림톡 전송 실패 시 전송할 내용
+#   params['REQDATE'] = options['request_date'].strftime("%Y%m%d%H%M%S") if options['request_date']
+# }
+c.send_message(phone_number, callback, msg, template_code, failed_type, options)
+```
+
+### 리포트 조회
+
+```ruby
+# cmid: 서버에서 생성한 request를 식별할 수 있는 유일한 키
+c.report(cmid)
+```
+
+### 템플릿 조회
+
+```ruby
+# options: {
+#   template_code: 템플릿코드 – 입력 안 할경우 전체 리스트 반환
+#   status: 검수상태 – 입력 안 할경우 전체 리스트 반 환
+#            등록(1) / 검수요청(2)
+#            승인(3) / 반려(4) / 승인중단(5)
+# }
+c.templates(options)
+```
+
+### 발신번호 인증/등록
+
+```ruby
+# send_phone_number: 등록할 발신 번호
+# comment: 메모 (200자)
+# pin_type: 인증방법 (SMS. VMS 중 1개 선택)
+c.register_callback(send_phone_number, comment, pin_type)
+
+
+# 인증번호 확인 후 
+
+# send_phone_number: 등록할 발신 번호
+# comment: 메모 (200자)
+# pin_type: 인증방법 (SMS. VMS 중 1개 선택)
+# pin_code: 인증번호 (SMS 인증번호(6자리), VMS인증번호 (2자리))
+c.verify_callback(send_phone_number, comment, pin_type, pin_code)
+```
+
+### 발신번호 리스트 조회
+
+```ruby
+# send_phone_number: 발신번호(“-“제외) – 입력 안 할경우 전체 리 스트 반환
+c.callbacks(send_phone_number)
+```
+
 
 ## Development
 

data/lib/kth/alimtalk/version.rb

@@ -1,5 +1,5 @@
 module Kth
   module Alimtalk
-    VERSION = "0.1.6"
+    VERSION = "0.1.7"
   end
 end

data/lib/kth/alimtalk.rb

@@ -41,7 +41,7 @@ module Kth
         send_get_request request_url
       end
 
-      def templates(options)
+      def templates(options = {})
         request_url = "/kko/1/tamplate/list/#{client_id}?"
         if options.present?
           request_url += "TEMPLATE_CODE=##{options['template_code']}&" if options['template_code']
@@ -53,16 +53,27 @@ module Kth
 
       def register_callback(send_phone_number, comment, pin_type = 'SMS')
         phone_number = send_phone_number.gsub("-", "")
-        request_url = "/kko/1/sendnumber/save/#{client_id}?sendnumber=#{phone_number}&comment=#{comment}&pintype=#{pin_type}"
+        request_url = "/kko/1/sendnumber/save/#{client_id}"
+        params = {
+          'sendnumber' => phone_number,
+          'comment' => comment,
+          'pintype' => pin_type
+        }
 
-        send_get_request request_url
+        send_post_request request_url, params
       end
 
       def verify_callback(send_phone_number, comment, pin_type, pin_code)
         phone_number = send_phone_number.gsub("-", "")
-        request_url = "/kko/1/sendnumber/save/#{client_id}?sendnumber=#{phone_number}&comment=#{comment}&pintype=#{pin_type}&pincode=#{pin_code}"
+        request_url = "/kko/1/sendnumber/save/#{client_id}"
+        params = {
+          'sendnumber' => phone_number,
+          'comment' => comment,
+          'pintype' => pin_type,
+          'pincode' => pin_code
+        }
 
-        send_get_request request_url
+        send_post_request request_url, params
       end
 
       def callbacks(send_phone_number = '')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kth-alimtalk
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Kyoungwon Lee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-17 00:00:00.000000000 Z
+date: 2017-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler