coolsms 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f52a524a302cc3d6653fdde9fb70e1e8d2efbe89
-  data.tar.gz: 6765fb553000d881ecdec70043c56df876d9fc70
+  metadata.gz: 4cab4ba648eedb4fe24d415f8c57af8ab6e934a8
+  data.tar.gz: 2bb0e491b9d014f713e005ba0e2f21178782a30e
 SHA512:
-  metadata.gz: d2d6e965c70181d437488a8aa44218a9f4cd23f85d0b4128a8d096cc0ab05baaaa2689d5279b88e353405c30d175be39a376fd97cd13dc221b5944b0d7a3b3c8
-  data.tar.gz: a99d662f40ead49670d3ad35b6ac310151d4275701fb2bba42b564ea8dd9b5e01faecae54e7eba1fd8a167a79180c38d685cb71806f6c0aa04db81bbd1df5f57
+  metadata.gz: 160fd4c42243b57250e047d62c91b23918ed8344104e30a8b5a3ea91f10f47020d44f9d1d1536165050aaa8ea3323526ab8da00690a94567ffd1b213a2932131
+  data.tar.gz: 355d180a5701ab164066fe67bccb609c11b61dc2c3e12bda401f60a6a8db376fa51030415a5d5fdad1532b9cc3fa6910e7691745bd0a16490e5d0cceee27c8b6

data/README.md

@@ -12,11 +12,21 @@ gem 'coolsms'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install coolsms
+```
+$ gem install coolsms
+```
+
+Test
+
+```
+$ ruby test/coolsms_test.rb -v
+```
 
 ## Configuration
 
@@ -24,97 +34,119 @@ Or install it yourself as:
 
 ## Usage 
 
-- ####Send < Applications
-
-        COOLSMS_SEND = Coolsms::SMS::Send.new( { options } )
-        COOLSMS_SEND.send( from, to, text)
-        COOLSMS_SEND.set_field( { options} )
-    Options
-    - type
-    - charset
-    - datetime
-    - delay
-    - refname
-    - country
-    - subject
-    - srk
-    - mode
-    - extension
-    - force_sms
-
-    Methods
-    - send
-    - set_field
-    
-- ####Balance
+####Send < Applications
+
+```ruby
+COOLSMS_SEND = Coolsms::SMS::Send.new( { options } )
+COOLSMS_SEND.send( from, to, text)
+COOLSMS_SEND.set_field( { options} )
+```
 
-        COOLSMS_BALANCE = Coolsms::SMS::Balance.new
-        COOLSMS_BALANCE.balance
+* Options
+  - type
+  - image
+  - image_encoding
+  - refname
+  - country
+  - datetime
+  - subject
+  - charset
+  - srk
+  - mode
+  - extension
+  - delay
+  - force_sms
+  - os_platform
+  - dev_lang
+  - sdk_version
+  - app_version
+  - sender_key
+  - template_code
+
+* Methods
+  - send
+  - set_field
     
-    Methods
-    - balance
-
-- ####Status < Applications
-
-        COOLSMS_STATUS = Coolsms::SMS::Status.new( options )
-        COOLSMS_STATUS.status
-    Options
-    - count
-    - unit
-    - date
-    - channel
+####Balance
+
+```ruby
+COOLSMS_BALANCE = Coolsms::SMS::Balance.new
+COOLSMS_BALANCE.balance
+```
+
+* Methods
+  - balance
+
+####Status < Applications
+
+```ruby
+COOLSMS_STATUS = Coolsms::SMS::Status.new( options )
+COOLSMS_STATUS.status
+```
+
+* Options
+  - count
+  - unit
+  - date
+  - channel
     
-    Methods
-    - status
-
-- ####Sent < Applications
-
-        COOLSMS_SENT = Coolsms::SMS::Sent.new( options )
-        COOLSMS_SENT.sent
-    Options
-    - count
-    - page
-    - rcpt
-    - start
-    - end
-    - status
-    - resultcode
-    - notin_resultcode
-    - mid
-    - gid
+* Methods
+  - status
+
+####Sent < Applications
+
+```ruby
+COOLSMS_SENT = Coolsms::SMS::Sent.new( options )
+COOLSMS_SENT.sent
+```
+
+* Options
+  - count
+  - page
+  - rcpt
+  - start
+  - end
+  - status
+  - resultcode
+  - notin_resultcode
+  - mid
+  - gid
     
-    Methods
-    - sent
+* Methods
+  - sent
 
-- ####Cancel < Applications
- 
-        COOLSMS_CANCEL = Coolsms::SMS::Cancel.new( options )
-        COOLSMS_CANCEL.cancel
+####Cancel < Applications
+
+```ruby
+COOLSMS_CANCEL = Coolsms::SMS::Cancel.new( options )
+COOLSMS_CANCEL.cancel
+```
 
-    Options
-    - mid
-    - gid
+* Options
+  - mid
+  - gid
     
-    Methods
-    - cancel
+* Methods
+  - cancel
     
-- ####Applications
+#### Applications
 
-    Methods
-    - set_fields
-    - fields
+* Methods
+  - set_fields
+  - fields
     
-- ####TODO
+#### TODO
 
-    - [O] Send
-    - [O] Sent
-    - [O] Cancel
-    - [O] Balance
-    - [O] Status
+- [x] Send
+- [x] Sent
+- [x] Cancel
+- [x] Balance
+- [x] Status
 
 ## Coolsms Rest API Document
 
-http://www.coolsms.co.kr/REST_API_Global
+* [Coolsms REST API](http://www.coolsms.co.kr/REST_API)
+* Support API version : 1.5
 
 ## Contributing
 

data/lib/coolsms.rb

@@ -1,16 +1,16 @@
 # @name                Coolsms Rest API Helper
 # @author              JunSangPil
-# @version             0.1.1
+# @version             0.1.2
 # @url                 http://github.com/jun85664396/coolsms
 # @license             MIT License
 
-require "coolsms/version"
 require 'securerandom'
 require 'net/http'
 require 'json'
+require_relative 'coolsms/version'
 require_relative 'coolsms/applications'
-require_relative "coolsms/auth"
-require_relative "coolsms/request"
+require_relative 'coolsms/auth'
+require_relative 'coolsms/request'
 require_relative 'coolsms/send'
 require_relative 'coolsms/balance'
 require_relative 'coolsms/status'
@@ -19,12 +19,10 @@ require_relative 'coolsms/cancel'
 
 module Coolsms
   class SMS
-
     Send = Class.new(Send)
     Balance = Class.new(Balance)
     Status = Class.new(Status)
     Sent = Class.new(Sent)
     Cancel = Class.new(Cancel)
-
   end
 end

data/lib/coolsms/applications.rb

@@ -15,5 +15,4 @@ class Applications
     end
     return field
   end
-
 end

data/lib/coolsms/auth.rb

@@ -1,15 +1,15 @@
 class Auth
 
-  #Time Default : now
+  # Time Default : now
   attr_accessor :timestamp
 
-  #Salt
+  # Salt
   attr_accessor :salt
 
-  #API KEY
+  # API KEY
   attr_accessor :api_key
 
-  #API SECRET KEY
+  # API SECRET KEY
   attr_accessor :api_secret
 
   def initialize
@@ -27,5 +27,4 @@ class Auth
   def auth
     { api_key: self.api_key, signature: self.signature, timestamp: self.timestamp, salt: self.salt }
   end
-
 end

data/lib/coolsms/balance.rb

@@ -11,5 +11,4 @@ class Balance
       { ret: false, code: res.code }
     end
   end
-
 end

data/lib/coolsms/cancel.rb

@@ -20,5 +20,4 @@ class Cancel < Applications
       { ret: res.code == "200", message: JSON.parse(res.body) }
     end
   end
-
 end

data/lib/coolsms/request.rb

@@ -1,6 +1,6 @@
 class Request
 
-  #URI
+  # URI
   attr_accessor :uri
 
   def initialize
@@ -8,13 +8,12 @@ class Request
   end
 
   def post(key, fields = {})
-    res = Net::HTTP.post_form( self.uri+"/1/#{key}", fields )
+    res = Net::HTTP.post_form(self.uri+"/sms/1.5/#{key}", fields)
   end
 
   def get(key, fields = {})
-    uri = URI( self.uri+"/1/#{key}")
-    uri.query = URI.encode_www_form( fields )
-    res = Net::HTTP.get_response( uri )
+    uri = URI(self.uri+"/sms/1.5/#{key}")
+    uri.query = URI.encode_www_form(fields)
+    res = Net::HTTP.get_response(uri)
   end
-
 end

data/lib/coolsms/send.rb

@@ -1,53 +1,105 @@
 class Send < Applications
 
-  #SMS Type default : SMS
+  # Message Type : SMS(default), LMS, MMS, ATA
+  # If not +82, force SMS
   attr_accessor :type
 
-  #Charset
-  attr_accessor :charset
+  # Image
+  # JPEG, PNG, GIF < 300KB, 2048x2048 px
+  attr_accessor :image
 
-  #Datetime Format YYYYMMDDHHMISS
-  attr_accessor :datetime
+  # Image encoding
+  # binary(default), base64
+  attr_accessor :image_encoding
 
-  #Delay
-  attr_accessor :delay
-
-  #Refname
+  # Reference name
   attr_accessor :refname
 
-  #Country Korea => 82, Japan => 81, China => 86, USA => 1
+  # Country
+  # Korea : +82 (default)
   attr_accessor :country
 
-  #Subject
+  # Schedule datetime.
+  # Format: YYYYMMDDHHMISS
+  attr_accessor :datetime
+
+  # MMS, LMS subject
   attr_accessor :subject
 
-  #Srk
+  # Charset encoding
+  # default: utf8
+  attr_accessor :charset
+
+  # Srk
   attr_accessor :srk
 
-  #Mode
+  # Mode
+  # if 'test'
+  #   from_num : '010000000'
+  #   datetime is ignore
+  #   return_value : 60
+  #   recharge
   attr_accessor :mode
 
-  #Extension
+  # Extension
+  # JSON data
   attr_accessor :extension
 
-  #Force_sms
+  # Delay
+  # value : 0 ~ 20
+  attr_accessor :delay
+
+  # Force SMS
+  # true or false
   attr_accessor :force_sms
 
+  # Client OS and platform
+  attr_accessor :os_platform
+
+  # Development language
+  attr_accessor :dev_lang
+
+  # SDK version
+  attr_accessor :sdk_version
+
+  # Application version
+  attr_accessor :app_version
+
+  # AlarmTalk sender Key
+  attr_accessor :sender_key
+
+  # AlarmTalk template code
+  attr_accessor :template_code
+
   def initialize(options = {})
     self.set_fields(options)
   end
 
   def send(from, to, text)
-    fields = self.fields( :type, :charset, :datetime, :delay, :refname, :country, :subject, :srk, :mode, :extension, :force_sms )
-    fields = fields.merge(from: from, to: to, text: text, type: self.type )
+    fields = self.fields(
+      :type, :image, :image_encoding, :refname, :country,
+      :datetime, :subject, :charset, :srk, :mode,
+      :extension, :delay, :force_sms, :os_platform, :dev_lang,
+      :sdk_version, :app_version, :sender_key, :template_code
+    )
+
+    fields = fields.merge( from: from, to: to, text: text, type: self.type )
+
     res = Request.new.post( "send", fields )
 
     if res.code == "200"
       body = JSON.parse(res.body)
-      { ret: body['result_code'] == "00", message: body['result_message'], code: res.code }
+      {
+        ret: body['result_code'] == "00",
+        message: body['result_message'],
+        code: res.code,
+        gid: body['group_id']
+      }
     else
-      { ret: false, code: res.code }
+      {
+        ret: false,
+        code: res.code
+      }
     end
-  end 
-
+  end
 end

data/lib/coolsms/sent.rb

@@ -1,9 +1,12 @@
 class Sent < Applications
 
+  # Message count
+  # defualt: 20
   attr_accessor :count
 
   attr_accessor :page
 
+  # Search for to number
   attr_accessor :rcpt
 
   # Date Format YYYY-MM-DD HH:MI:SS
@@ -12,14 +15,18 @@ class Sent < Applications
   # DateFormat YYYY-MM-DD HH:MI:SS
   attr_accessor :end
 
+  # Message status
   attr_accessor :status
 
+  # Sending result code
   attr_accessor :resultcode
 
   attr_accessor :notin_resultcode
 
+  # Message ID
   attr_accessor :mid
 
+  # Group ID
   attr_accessor :gid
 
   def initialize(options={})
@@ -27,7 +34,10 @@ class Sent < Applications
   end
 
   def sent
-    fields = self.fields( :count, :page, :rcpt, :start, :end, :status, :resultcode, :notin_resultcode, :mid, :gid )
+    fields = self.fields(
+      :count, :page, :rcpt, :start, :end,
+      :status, :resultcode, :notin_resultcode, :mid, :gid
+    )
     res = Request.new.get( "sent", fields )
 
     if res.code == "200"
@@ -37,5 +47,4 @@ class Sent < Applications
       { ret: false, code: res.code }
     end
   end
-
 end

data/lib/coolsms/status.rb

@@ -25,5 +25,4 @@ class Status < Applications
       { ret: false, code: res.code }
     end
   end
-
 end

data/lib/coolsms/version.rb

@@ -1,3 +1,3 @@
 module Coolsms
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/coolsms_test.rb

@@ -1,5 +1,4 @@
 require_relative 'test_helper'
-require 'coolsms'
 
 describe "Coolsms" do
   before do
@@ -9,25 +8,33 @@ describe "Coolsms" do
 
   it "Send" do
     send = Coolsms::SMS::Send.new(mode: "test")
-    res = send.send("010-8566-4396", "010-8566-4396", "Test Message")
+    res = send.send("01012345678", "01000000000", "Test Message")
+    p res
+
     assert_equal res[:code], "200"
   end
 
   it "Balance" do
     balance = Coolsms::SMS::Balance.new
     res = balance.balance
+    p res
+
     assert_equal res[:code], "200" 
   end
 
   it "Status" do
     status = Coolsms::SMS::Status.new
     res = status.status
+    p res
+
     assert_equal res[:code], "200" 
   end
 
   it "Sent" do
     sent = Coolsms::SMS::Sent.new
     res = sent.sent
+    p res
+
     assert_equal res[:code], "200" 
   end
 

data/test/test_helper.rb

@@ -1,2 +1,3 @@
 # encoding: utf-8
 require 'minitest/autorun'
+require_relative '../lib/coolsms'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coolsms
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - JunSangPil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2016-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler