sms_voice_flash 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6c268dcde2706767003495096d63a729899a989
-  data.tar.gz: b594798d9e9dc02b699b65c2464640ea60a9aab3
+  metadata.gz: ad33a9887f9a9e386f652c328595322a3bdfca1b
+  data.tar.gz: 50498cf226e02895d17d3f223bcff0e1eb4b4039
 SHA512:
-  metadata.gz: 400834cfb92481ee0a8f2aedb653642b5cf48904c62df302710cb4bd96abf7fa94b0412bad70142574c4463e5e0bbe883a0545e0fd116daa160235b2abdcb0a6
-  data.tar.gz: be6d1132880ef3b351b129ca45422b56dbe1b47703a4aa575dd0f36f425cb50d19cc5b2fd4e86a8fbebd870e5cfe6f39f5654e9d68fc856ac6cad3010d1fe979
+  metadata.gz: eb8ecae9b6ecf603e7de0e28f4e4041b6c18b4890557bf58a203745e2c45382a9c65a4addf73fd57a7cacbd9060c9dd3096e20cd83f2abab3f44fa058ebcce8d
+  data.tar.gz: 87cd47a4b835b765f1f70052fb5e69ed32f4fad877e7b436ae3e25e7b6dd6e23fe9b624cf6509a677aaed44e564a19ace5c6a1a8d631bb5b7d0778e9c3a61600

data/README.md

@@ -1,28 +1,79 @@
 # SmsVoiceFlash
 
-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/sms_voice_flash`. To experiment with that code, run `bin/console` for an interactive prompt.
+一种快速接入中国移动，中国联通，中国电信的短信、语音、闪信服务平台的服务接口
 
-TODO: Delete this and the text above, and describe your gem
+使开发者，能够非常方便，快捷，高效地给用户发送短信、语音、闪信通知
 
-## Installation
+## 安装步骤
 
-Add this line to your application's Gemfile:
+在Gemfile文件中，添加下面这一行
 
 ```ruby
 gem 'sms_voice_flash'
 ```
 
-And then execute:
+然后执行
 
     $ bundle
 
-Or install it yourself as:
+或者手动安装
 
     $ gem install sms_voice_flash
 
-## Usage
+## 参数及使用说明
+
+### 参数介绍
+传入参数:
+- key是服务商提供给的一串字符，为不同客户的身份凭证
+- sign为短信尾巴的签名，最大10个字符长度，如: "中国快递",并需要向服商提前报备
+- mobile 用户手机号，支持单条发送，也支持以数组的形式发送
+- content 发送内容
+
+### 发送短信 
+```ruby
+#初始化服务
+#假定 key = "LKiw2STo1NvouhQ4OKOw6hrdp" sign = "中国快递"
+
+SmsVoiceFlash.set(key,sign)
+
+#单条发送短信
+#假定mobile = "13512345678" content = "我爱Ruby"
+
+SmsVoiceFlash.sms(mobile,content)
+
+#多条发送
+#假定 mobile = ["13512345678","13612345678","18612345678"],content="我爱ruby"
+
+SmsVoiceFlash.sms(mobile,content)
+
+```
+### 返回值说明
+返回值为json格式
+- code    返回码
+- message 信息描述
+- uid     本条消息唯一识别码，请保留用来跟跟消息的后续状态。
+
+返回值 
+- 正常返回 {"code":0,"message":"正在发送","uid":"iSrXps3QHYCt9CeoEySPrvUo6Lhr1MIg"}
+- 异常返回
+ - {"message": "Your authentication credentials are invalid"}
+ - {"message":"API rate limit exceeded"} 默认发送速率为，5条每秒，如果超过上限会提示这个错误
+ - {"code":2,"message":"手机号码不正确","uid":""}
+ - {"code":3,"message":"ts参数错误,注意是秒单位，误差不能超过5分钟","uid":""}
+ - {"code":4,"message":"发送内容不正确","uid":""}
+ - {"code":5,"message":"签名信息不正确","uid":""}
+
+### 获取返回值
+
+```ruby
+result = SmsVoiceFlash.sms(mobile,content)
+
+code    = result.code
+message = result.code
+uid     = result.code
+
+```
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -32,8 +83,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sms_voice_flash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+```ruby
+git clone git@github.com:luolinae86/sms_voice_flash.git
+cd sms_voice_flash
+bundle console # 请不要使用 irb，可能会有依赖问题
+```
 
 ## License
 

data/lib/sms_voice_flash/version.rb

@@ -1,3 +1,3 @@
 module SmsVoiceFlash
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/sms_voice_flash.rb

@@ -14,8 +14,12 @@ module SmsVoiceFlash
   end
 
   def sms(mobile,content)
+    #如果用户输入的为数组，则将数组内的元素用逗号分隔成字符串
+    if mobile.kind_of?(Array)
+      mobile = mobile.map{|number| number.strip}.join(",")
+    end
     url = URI.encode("#{SmsUrl}?apikey=#{@key}&mobile=#{mobile}&content=#{content}&ts=#{Time.now.to_i}&sign=#{@sign}")
-    result = JSON.parse(RestClient.get(url).body,symbolize_names: true)
+    result = JSON.parse(RestClient.get(url).body,object_class: OpenStruct)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sms_voice_flash
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - luolin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-28 00:00:00.000000000 Z
+date: 2018-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler