yunpian_sms 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a34e72affc14403a0c3618e90e754f4ce4e7c6b4
-  data.tar.gz: 7434efcaef5f9fc729d8f5f02f23dcf7166bde5b
+  metadata.gz: 592ae1d97ddb7d46310c7a6230466fb11951642f
+  data.tar.gz: 383e2e594d8c8366d0fc4fadd3d40352e3cc849d
 SHA512:
-  metadata.gz: 34bfeaa8a83180d56f68298ae24145b65b509bc1ebb6a8abdff7bf7e8de4b570a4717bfae0fae4902fa655ca225620b88c963685caa9db8e2ebc4f585af5a011
-  data.tar.gz: b483585943c34c5b3f8b0fc12b05d1c2e6ebe107f4caf99c6565738be94fcc1a4832829166aa560b25480ce3a91bdb5d990e7a3e81c7b0c467719d939392296d
+  metadata.gz: 84ffe34b6aa1abb362b2c5b0e5ae9dc6b8c79a9f76f9dcb8c44c9ba98d0ce84ef0823fa5d8e68e027419d45e8c61806d62f914dccf2f1e9ded31156c402165ef
+  data.tar.gz: 271b2a6979c0c00a84b65a5d74dac323db8255756462552af1def012a4a3a8f62bb4caf6518ce177e05239a0064dfb5e228ea8d1e014755d5e6df8195f8b5eb5

data/README.md

@@ -1,7 +1,11 @@
 YunPian SMS Ruby SDK
 =========
 
-[云片短信](https://www.yunpian.com/doc/zh_CN/introduction/brief.html) Ruby SDK, 非官方。
+[云片短信](https://www.yunpian.com/doc/zh_CN/introduction/brief.html) Ruby SDK, 非官方，使用 v2 api, 支持以下功能:
+
+* 获取账号所属所有短信模板
+* 模板发送单条短信
+* 模板群发短信并获取发送成功/失败列表以及总费用
 
 Table of Contents
 -----------------
@@ -32,7 +36,7 @@ require 'yunpian_sms'
 
 YunPianSMS.api_key = 'your api key'
 
-# template examples
+# 获取短信模板
 result = YunPianSMS::Template.all
 if result.successful
   result.body.each do |element|
@@ -42,6 +46,33 @@ if result.successful
 else
   # raise error
 end
+
+# 模板单条发送短信
+YunPianSMS.api_key = api_key
+template_id = 'xxxxxx'
+mobile_no = configuration['single_mobile_no']
+# 【智能通勤】车辆变更提醒: 尊敬的乘客您好, 您所乘坐的#keyword1#由于#keyword2#, 车牌号变更为#keyword3#, 变更日期范围为#keyword4#, 请提前到乘车站点候车以免耽误您的行程，谢谢。
+params = {
+  keyword1: '横琴号十号线',
+  keyword2: '车辆定期维修',
+  keyword3: '粤C66666',
+  keyword4: '2019-05-20 至 2019-05-22'
+}
+result = YunPianSMS::Sender.template_single_send(template_id, mobile_no, params)
+
+# 模板群发短信
+YunPianSMS.api_key = api_key
+template_id = 'xxxxxx'
+mobile_nos = configuration['batch_mobile_nos']
+# 【智能通勤】车辆变更提醒: 尊敬的乘客您好, 您所乘坐的#keyword1#由于#keyword2#, 车牌号变更为#keyword3#, 变更日期范围为#keyword4#, 请提前到乘车站点候车以免耽误您的行程，谢谢。
+params = {
+  keyword1: '横琴号十号线',
+  keyword2: '车辆定期维修',
+  keyword3: '粤C66666',
+  keyword4: '2019-05-20 至 2019-05-22'
+}
+start_time = Time.now
+batch_result = YunPianSMS::Sender.template_batch_send(template_id, mobile_nos, params)
 ~~~
 
 

data/lib/yunpian_sms.rb

@@ -1,7 +1,7 @@
 module YunPianSMS
 
   @debug_mode = true
-  @server = "https://sms.yunpian.com/v2"
+  @server = "https://sms.yunpian.com"
 
   class<< self
     attr_accessor :logger, :debug_mode, :api_key
@@ -9,5 +9,6 @@ module YunPianSMS
   end
   
   require 'yunpian_sms/template'
-  
+  require 'yunpian_sms/sender'
+
 end

data/lib/yunpian_sms/batch_result.rb

@@ -0,0 +1,23 @@
+class YunPianSMS::BatchResult
+
+  attr_reader :successful_count # 总发送成功条数, 一条短信超过 70 字会被拆分成多条
+  attr_reader :successful_people # 发送成功列表
+  attr_reader :failed_people # 发送失败列表
+  attr_reader :total_fee # 总花费金额
+  attr_reader :details # 发送明细
+
+  def initialize(
+    successful_count,
+    successful_people,
+    failed_people,
+    total_fee,
+    details)
+
+    @successful_count = successful_count
+    @successful_people = successful_people
+    @failed_people = failed_people
+    @total_fee = total_fee
+    @details = details
+  end
+
+end

data/lib/yunpian_sms/sender.rb

@@ -0,0 +1,68 @@
+require 'net/http'
+require 'json'
+require 'yunpian_sms/result'
+require 'yunpian_sms/batch_result'
+
+class YunPianSMS::Sender
+
+  # 云片网群发 api 最多支持同时发 1000 个号码, 超过 1000 个需要分批发
+  MAX_RECIPIENT_NUMBER = 1000
+
+  def self.template_single_send template_id, mobile, params
+    uri = URI("#{YunPianSMS.server}/v2/sms/tpl_single_send.json")
+    send_internal uri, template_id, mobile, params
+  end
+
+  def self.template_batch_send template_id, mobile_nos, params
+    successful_count = 0
+    successful_people = []
+    failed_people = []
+    total_fee = 0.0
+    uri = URI("#{YunPianSMS.server}/v2/sms/tpl_batch_send.json")
+
+    details = mobile_nos.each_slice(MAX_RECIPIENT_NUMBER).map do |sliced_mobile_nos|
+      mobile = sliced_mobile_nos.join(',')
+      result = send_internal(uri, template_id, mobile, params)
+      successful_count += result.body['total_count']
+      total_fee += result.body['total_fee'].to_f
+      result.body['data'].each do |data|
+        mobile = data['mobile']
+        if data['code'] == 0
+          successful_people << mobile
+        else
+          failed_people << mobile
+        end
+      end
+      result
+    end
+
+    YunPianSMS::BatchResult.new(successful_count, successful_people, failed_people, total_fee, details)
+  end
+
+  private
+
+  def self.send_internal uri, template_id, mobile, params
+    res = Net::HTTP.post_form(
+        uri,
+        apikey: YunPianSMS.api_key,
+        tpl_id: template_id,
+        mobile: mobile,
+        tpl_value: encode(params)
+    )
+    if YunPianSMS.debug_mode && YunPianSMS.logger
+      YunPianSMS.logger.debug "Sms sending response code #{res.code} body #{res.body}"
+    end
+    json = JSON.parse(res.body)
+    successful = res.kind_of?(Net::HTTPSuccess)
+    YunPianSMS::Result.new(successful, json.to_hash)
+  end
+
+  def self.encode params
+    encoded = params.map {|k, v| "##{URI::encode(k.to_s)}#=#{URI::encode(v)}"}.join('&')
+    if YunPianSMS.debug_mode && YunPianSMS.logger
+      YunPianSMS.logger.debug "Encoded tpl value #{encoded}"
+    end
+    encoded
+  end
+
+end

data/lib/yunpian_sms/template.rb

@@ -15,7 +15,7 @@ class YunPianSMS::Template
   private
 
   def self.get_templates(params)
-    uri = URI.parse("#{YunPianSMS.server}/tpl/get.json")
+    uri = URI.parse("#{YunPianSMS.server}/v2/tpl/get.json")
     if YunPianSMS.debug_mode && YunPianSMS.logger
       YunPianSMS.logger.debug "Requesting uri #{uri}..."
     end

data/lib/yunpian_sms/version.rb

@@ -1,3 +1,3 @@
 module YunPianSMS 
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/spec/yunpian_sms_spec.rb

@@ -7,7 +7,8 @@ require 'logger'
 describe YunPianSMS do            
   
   subject(:logger) { Logger.new STDOUT  }
-  subject(:api_key) { YAML.load_file('./spec/fixtures/configuration.yml')['api_key']  }
+  subject(:configuration) { YAML.load_file('./spec/fixtures/configuration.yml') }
+  subject(:api_key) { configuration['api_key']  }
 
   before do
     YunPianSMS.debug_mode = true                     
@@ -31,7 +32,69 @@ describe YunPianSMS do
         template_id = element["tpl_id"]
         template_result = YunPianSMS::Template.find template_id
         expect(template_result.successful).to be true
-        logger.debug "template #{template_result.body}"
+        logger.debug "template #{template_result.inspect}"
+      end
+    end
+
+  end
+
+  context 'messages' do
+
+    it 'should send single message with template 1 successfully' do
+      YunPianSMS.api_key = api_key
+      template_id = '2697618'
+      mobile_no = configuration['single_mobile_no']
+      # 【智能通勤】车辆变更提醒: 尊敬的乘客您好, 您所乘坐的#keyword1#由于#keyword2#, 车牌号变更为#keyword3#, 变更日期范围为#keyword4#, 请提前到乘车站点候车以免耽误您的行程，谢谢。
+      params = {
+          keyword1: '横琴号十号线',
+          keyword2: '车辆定期维修',
+          keyword3: '粤C66666',
+          keyword4: '2019-05-20 至 2019-05-22'
+      }
+      result = YunPianSMS::Sender.template_single_send(template_id, mobile_no, params)
+      # expect(result.successful).to be true
+      logger.debug "result #{result.inspect}"
+    end
+
+    it 'should send single message with template 2 successfully' do
+      YunPianSMS.api_key = api_key
+      template_id = '2834228'
+      mobile_no = configuration['single_mobile_no']
+      # 【智能通勤】您有一张车票 #reserved_method_ticket_no# 距乘车时间小于#reserved_value# 分钟，线路: #reserved_method_bus_line_full_name#，乘车时间: #reserved_method_departure_at_with_day#， 起点： #reserved_method_source_station_name#， 终点: #reserved_method_destination_station_name#， 车牌号: #reserved_method_bus_plate_number#， 请提前到乘车站点候车以免耽误您的出行。
+      params = {
+          reserved_method_ticket_no: 'L251201905291617ZFBGVQ11',
+          reserved_value: '30',
+          reserved_method_bus_line_full_name: '横琴号十号线',
+          reserved_method_departure_at_with_day: '2019-05-20 18:00',
+          reserved_method_source_station_name: '横琴创意谷',
+          reserved_method_destination_station_name: '西江月',
+          reserved_method_bus_plate_number: '粤C66666'
+      }
+      result = YunPianSMS::Sender.template_single_send(template_id, mobile_no, params)
+      # expect(result.successful).to be true
+      logger.debug "result #{result.inspect}"
+    end
+
+    it 'should batch send messages successfully' do
+      YunPianSMS.api_key = api_key
+      template_id = '2697618'
+      mobile_nos = configuration['batch_mobile_nos']
+      # 【智能通勤】车辆变更提醒: 尊敬的乘客您好, 您所乘坐的#keyword1#由于#keyword2#, 车牌号变更为#keyword3#, 变更日期范围为#keyword4#, 请提前到乘车站点候车以免耽误您的行程，谢谢。
+      params = {
+        keyword1: '横琴号十号线',
+        keyword2: '车辆定期维修',
+        keyword3: '粤C66666',
+        keyword4: '2019-05-20 至 2019-05-22'
+      }
+      start_time = Time.now
+      batch_result = YunPianSMS::Sender.template_batch_send(template_id, mobile_nos, params)
+      elapsed_time = Time.now - start_time
+      logger.debug "elapsed_time #{elapsed_time.to_i}"
+      logger.debug batch_result.inspect
+      batch_result.details.each do |result|
+        result.body['data'].each do |data|
+          logger.debug "#{data['code']} #{data['msg']}"
+        end
       end
     end
 

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: yunpian_sms
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- LCola
+- James Wang
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -33,7 +33,9 @@ files:
 - LICENSE.md
 - README.md
 - lib/yunpian_sms.rb
+- lib/yunpian_sms/batch_result.rb
 - lib/yunpian_sms/result.rb
+- lib/yunpian_sms/sender.rb
 - lib/yunpian_sms/template.rb
 - lib/yunpian_sms/version.rb
 - spec/yunpian_sms_spec.rb