twsms2 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 604e4232d10dd76ea6064e215fae633f8b020746
-  data.tar.gz: 5585e90bff7241bdd4bafdf2562e4e3848b6fed6
+  metadata.gz: 7c9b64329c26980a4442660b5d63122cf0e0f716
+  data.tar.gz: d9c410f2c1024f1c2debc649d1ece684e1856427
 SHA512:
-  metadata.gz: 3268a918b026b4f3ff830ffede2457a0a9cd05815121e26a4a7af4164424bc39866026d9b7dd925ddfb43bffb0f486295334aa25fa9a0deaac6670d4726cacc7
-  data.tar.gz: bf60f687de9713a89c52bba76200254aad1da2558ae405581f58a3ded581eead607441e49154c4b619af32189cedfc3fcf4e321f273fc6ef5d13281435be237c
+  metadata.gz: 4a604ca2daab6d18ce54609f2b0c85aa877d7c03c11a2bc7a55b540a4fb08711b79d3d5845fe43b48161df8cc68b2650a34fca050ab907ffcc0480d873a55e59
+  data.tar.gz: d85225365844f09670f052985419df9d43615bf77c728d170c3e22c45c723fe61340e374fbc3b139182d4682b9cb95e23c55fedb47226e49bc84a9038a7444f0

data/README.md

@@ -38,14 +38,23 @@ gem 'twsms2', '~> 1.1.0'
 
 本 API 套件，提供幾組以下方法來方便您開發簡訊相關服務
 
-但要使用前，需要先[註冊台灣簡訊的會員][twsms_signup]，否則您的程式無法存取台灣簡訊的 API 管道
+基本執行範例如下，但要使用前，需要先[註冊台灣簡訊的會員][twsms_signup]，否則無法存取相關服務
 
 ```ruby
 require 'twsms2'
 
-# Twsms2 是走 https 的方式進行系統操作
+# 程式將會以 SSL 的方式，走 https 連線到簡訊商的系統
+sms_client = Twsms2::Client.new(username: '會員帳號', password: '會員密碼')
+```
+
+也可以加入 agent ( user-agent ) 跟 timeout ( 逾時時間/秒 ) 參數 至 client 物件
+
+```ruby
 sms_client = Twsms2::Client.new(
-  username: '會員帳號', password: '會員密碼', agent: "Mozilla/5.0 (可自訂 user-agent)"
+  username: '會員帳號',
+  password: '會員密碼',
+  agent: "Mozilla/5.0 ( Hello World )",
+  timeout: 10
 )
 ```
 
@@ -60,8 +69,6 @@ sms_client = Twsms2::Client.new(
 sms_client.account_is_available
 ```
 
-----
-
 ### 發送簡訊
 
 #### 一般使用
@@ -169,6 +176,28 @@ message_quota 則是簡訊餘額，代表你還剩幾封可以用，若為 0 就
 {:access_success=>false, :message_quota=>0, :error=>"TWSMS:00010"}
 ```
 
+----
+
+例外狀況的處理
+--------
+
+在某些情況下，程式會擲出一些例外給 ruby 去處理，你可以先用 Twsms2 自帶的 Error 來先做 rescue
+
+```ruby
+
+begin
+  sms_client.account_is_available
+rescue Twsms2::ClientError
+  'Client 物件有內部錯誤'
+rescue Twsms2::ServerError => error
+  "伺服器端有一些無法處理的狀況 #{error.message}"
+rescue Twsms2::ClientTimeoutError
+  "發生 Timeout 囉"
+rescue Twsms2::Error => error
+  "發生非預期的錯誤 #{error.message}"
+end
+
+```
 
 LICENSE
 --------

data/lib/twsms2/exception.rb

@@ -2,4 +2,5 @@ module Twsms2
   class Error < StandardError; end
   class ClientError < Error; end
   class ServerError < Error; end
+  class ClientTimeoutError < Error; end
 end

data/lib/twsms2/formatter.rb

@@ -17,6 +17,49 @@ module Twsms2
       asia_taipei_time
     end
 
+    def message_status_sanitize(original_text)
+      new_text = case original_text
+                 when 'DELIVRD'  then 'delivered'
+                 when 'EXPIRED'  then 'expired'
+                 when 'DELETED'  then 'deleted'
+                 when 'UNDELIV'  then 'undelivered'
+                 when 'ACCEPTD'  then 'transmitting'
+                 when 'UNKNOWN'  then 'unknown'
+                 when 'REJECTD'  then 'rejected'
+                 when 'SYNTAXE'  then 'incorrect_sms_system_syntax'
+                 when 'MOBERROR' then 'incorrect_phone_number'
+                 when 'MSGERROR' then 'incorrect_content'
+                 when 'OTHERROR' then 'sms_system_other_error'
+                 when 'REJERROR' then 'illegal_content'
+                 else 'status_undefined'
+                 end
+
+      new_text
+    end
+
+    def format_message_status(original_info)
+      new_info = {
+        access_success: false,
+        is_delivered: false,
+        message_status: nil,
+        error: nil
+      }
+
+      code_text  = match_string(/<code>(?<code>\w+)<\/code>/, original_info)
+      status_text = match_string(/<statustext>(?<status>\w+)<\/statustext>/, original_info)
+
+      new_info[:access_success] = !code_text.nil? && !status_text.nil? && code_text == '00000'
+
+      if new_info[:access_success]
+        new_info[:message_status] = message_status_sanitize(status_text)
+        new_info[:is_delivered]   = new_info[:message_status] == 'delivered'
+      else
+        new_info[:error] = code_text.nil? ? "TWSMS:CODE_NOT_FOUND" : "TWSMS:#{code_text}".upcase
+      end
+
+      new_info
+    end
+
     def format_send_message_info(original_info)
       new_info = {
         access_success: false,

data/lib/twsms2/network.rb

@@ -21,6 +21,8 @@ module Twsms2
         raise ClientError, "#{http_response.code} response from #{host}"
       when Net::HTTPServerError
         raise ServerError, "#{http_response.code} response from #{host}"
+      when 'READ_TIMEOUT'
+        raise ClientTimeoutError, "Read Timeout from #{host}"
       else
         raise Error, "#{http_response.code} response from #{host}"
       end
@@ -28,8 +30,11 @@ module Twsms2
 
     def request(uri, message)
       http = Net::HTTP.new(uri.host, Net::HTTP.https_default_port)
+      http.read_timeout = @timeout
       http.use_ssl = true
       http.request(message)
+    rescue Net::ReadTimeout
+      'READ_TIMEOUT'
     end
 
     def query_string(params)

data/lib/twsms2/version.rb

@@ -1,3 +1,3 @@
 module Twsms2
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/lib/twsms2.rb

@@ -13,6 +13,7 @@ module Twsms2
       @api_host   = options.fetch(:host) { 'api.twsms.com' }
       @username   = options.fetch(:username) { ENV.fetch('TWSMS_USERNAME') }
       @password   = options.fetch(:password) { ENV.fetch('TWSMS_PASSWORD') }
+      @timeout    = options.fetch(:timeout) { 10 }
     end
 
     def account_is_available
@@ -37,5 +38,15 @@ module Twsms2
 
       format_balance_info(response)
     end
+
+    def get_message_status(options={})
+      options[:message_id] ||= nil
+      options[:phone_number] ||= nil
+
+      response = get(@api_host, '/smsQuery.php', mobile: options[:phone_number], msgid: options[:message_id])
+
+      format_message_status(response)
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twsms2
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Guanting Chen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-04 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler