aliyun-cloud_sms 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11d78bf025f601b8bea4127c55db87ef68307c5a
-  data.tar.gz: 95f9e07fb0caeffe2941443e7ce513ad1f39f6a9
+  metadata.gz: d801f060e22842e6726d6f755f13f289b0114bff
+  data.tar.gz: b9f615593957ea58f0201cdc7692c5101f3ffa69
 SHA512:
-  metadata.gz: 317b1c814f11d02a947cd63313c5e9ffddb2ffe6271d4b3cdd00396143a35a0fb513c81a62f2df5dc39adc2b7528e74984f18b2a2a1ce456c90bf94a67f32628
-  data.tar.gz: 200d2db45fd2edc3c973668f3f7d29f5f7ca296ab460836ee78d73f4148d2bee3c58502bb3e2b2ed2375e6691275eb350b1c079d2508a64ec8ea56977637bba4
+  metadata.gz: 702d40bfee904899db53dab5fa07407e0edfb62476789beedf1d42919df8e28f9539e0ca4e5f9eccc389fad14af4cf3bb304eae25c5dd901167e34d5bcc45d7c
+  data.tar.gz: 1b30f86058602e632c30dc88684a06f078e5c830aaf0074d9fdb0d10b87f5f4f94d837b3149399d10af08cdb913d9524968c5ac1c9854ae9c3e8776e920f531d

data/README-CN.md

@@ -0,0 +1,71 @@
+# Aliyun::CloudSms
+
+基于阿里短信服务接口，支持短信发送与状态查询。
+
+## Installation
+
+在项目的Gemfile里添加下面一行
+
+```ruby
+gem 'aliyun-cloud_sms'
+```
+
+执行
+
+    $ bundle
+
+或者你也可以
+
+    $ gem install aliyun-cloud_sms
+
+## 构建客户端
+
+### 全局客户端
+在config/initializers目录添加一个文件`aliyun-cloud_sms.rb`
+
+``` ruby
+Aliyun::CloudSms.configure do |config|
+  config.access_key_secret = 'your key secret'
+  config.access_key_id = 'your key id'
+  config.sign_name = 'your sign name'
+end
+```
+
+### 多账户支持
+有的服务可能会需要给不同的应用发送。
+```ruby
+client = Aliyun::CloudSms.new('your_access_key_id', 'your_access_key_secret', 'your_sign_name')
+
+client.send_msg('13800000000', 'SMS_80190090', {"customer": "jere"} )
+```
+
+## 接口
+
+### 短信发送
+如果是全局客户端， 可以使用：
+```ruby
+Aliyun::CloudSms.send_msg('13800000000', 'SMS_80190090', {"customer": "jere"} )
+```
+
+`template_params`可以传字符串，以多账户支持为例：
+```ruby
+client.send_msg('13800000000', 'SMS_80190090', "{\"customer\":\"jeremy\"}" )
+```
+### 状态查询
+```ruby
+client.query_status(mobile, send_date = "#{Time.now.strftime('%Y%m%d')}", biz_id = nil, page_size = 1, current_page = 1)
+
+# e.g.
+client.query_status '13800000000'
+client.query_status '13800000000', '20170806'
+client.query_status '13800000000', '20170806', '109177619494^4112265203597'
+client.query_status '13800000000', '20170806', nil, 10
+client.query_status '13800000000', '20170806', nil, 10, 2
+```
+## 贡献
+
+欢迎PR。
+
+
+## License
+[MIT License](http://opensource.org/licenses/MIT).

data/README.md

@@ -1,6 +1,7 @@
 # Aliyun::CloudSms
 
 This gem is used for sending sms via aliyun sms service, and querying the message status as well.
+[中文文档 Chinese document](https://github.com/jerecui/aliyun-cloud_sms/blob/master/README-CN.md)
 
 ## Installation
 
@@ -18,9 +19,9 @@ Or install it yourself as:
 
     $ gem install aliyun-cloud_sms
 
-## Usage
+## Construct a client
 
-### Global message client
+### Global account
 Create file aliyun-cloud_sms.rb to your config/initializers.
 ``` ruby
 Aliyun::CloudSms.configure do |config|
@@ -28,29 +29,29 @@ Aliyun::CloudSms.configure do |config|
   config.access_key_id = 'your key id'
   config.sign_name = 'your sign name'
 end
-
-```
-If you want to send message, Aliyun::CloudSms.send_msg(mobile, template_code, template_param).
-e.g.
-```ruby
-Aliyun::CloudSms.send_msg('13800000000', 'SMS_80190090', {"customer": "jere"} )
 ```
-The param is not a string, is a hash instead.
-
 ### Multiple account support
 If you want to send message with multiple sign name, you can build your own message sender client.
 ```ruby
 client = Aliyun::CloudSms.new('your_access_key_id', 'your_access_key_secret', 'your_sign_name')
 
-client.send_msg('13800000000', 'SMS_80190090', {"customer": "jere"} )
+## API
+### Message send
+```ruby
+Aliyun::CloudSms.send_msg(mobile, template_code, template_param).
+```
+e.g.
+```ruby
+Aliyun::CloudSms.send_msg('13800000000', 'SMS_80190090', {"customer": "jere"} )
 ```
 
-`template_params` can be a string as well.
+`template_params` could be a string.
 ```ruby
 client.send_msg('13800000000', 'SMS_80190090', "{\"customer\":\"jeremy\"}" )
 ```
 
-## Message query
+### Status query
+
 ```ruby
 client.query_status(mobile, send_date = "#{Time.now.strftime('%Y%m%d')}", biz_id = nil, page_size = 1, current_page = 1)
 
@@ -69,7 +70,8 @@ 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]/aliyun-cloud_sms. 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.
+Welcome pull request.
+Hope help.
 
 
 ## License

data/lib/aliyun/cloud_sms/version.rb

@@ -1,5 +1,5 @@
 module Aliyun
   module CloudSms
-    VERSION = "0.2.0"
+    VERSION = "0.2.1"
   end
 end

data/lib/aliyun/cloud_sms.rb

@@ -10,6 +10,10 @@ module Aliyun
       default_client.send_msg mobile, template_code, template_param
     end
 
+    def self.query_status(mobile, send_date = "#{Time.now.strftime('%Y%m%d')}", biz_id = nil, page_size = 1, current_page = 1)
+      default_client.query_status mobile, send_date, biz_id, page_size, current_page
+    end
+
     def self.client(access_key_id, access_key_secret, sign_name)
       Aliyun::Client.new access_key_id, access_key_secret, sign_name
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aliyun-cloud_sms
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Jeremy Cui
@@ -105,6 +105,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- README-CN.md
 - README.md
 - Rakefile
 - aliyun-cloud_sms.gemspec