aliyun-cloud_sms 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c00c0863180ad681f861b6213c60d4a3ea5540d1
-  data.tar.gz: b685fc773e38d4448e55e5ab8beee4124cce22f4
+SHA256:
+  metadata.gz: e612e52b12df1e0e0844d6e26c07d64254e4e4d7d1eb08651f42856da2cfe100
+  data.tar.gz: 4b94663bb3d165ca6f2c66bc0cea5cbdda15ee3952fdf6f23e05812dfdccdc34
 SHA512:
-  metadata.gz: 514416b3e09278b240a063416beb3550195ad0af7c0290dc6850491a98163f633d7ba69eb4ecf9d36fc82559ccae1a1fd80fd197fe5d91354ba4f11c49557ce5
-  data.tar.gz: ade522bbe91d14bdce4e9eefa1626b491bd17eccc582dc3fd524516f62e8c2f4b1529aa584882cf79684afb07579c70e49938b10e9cb5c89ab709386247f9524
+  metadata.gz: eba02ca3f118aa4a7763e56680b743fcf92eff86dc5f877337caf70ce94786624d801541117fc19df72b561d327d6380a08d9336abf8c676c228a492a06ab6e7
+  data.tar.gz: 240b77b892f5fa1efbbd988f01fbd73c96a362c806c9c9014f8bf5fd78a63021b636927413c06b022f7ded5d98128c95d56e984640d59387ddec358ff40de3e0

data/README-CN.md

@@ -0,0 +1,76 @@
+# 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"}, {:OutId => '您的业务id', :smsUpExtendCode => '上行短信用的code'} )
+```
+
+## 接口
+
+### 短信发送
+如果是全局客户端， 可以使用：
+```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,8 +1,8 @@
 # Aliyun::CloudSms
 
-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/aliyun/cloud_sms`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is used for sending sms via aliyun sms service, and querying the message status as well.
 
-TODO: Delete this and the text above, and describe your gem
+[中文文档 Chinese document](https://github.com/jerecui/aliyun-cloud_sms/blob/master/README-CN.md)
 
 ## Installation
 
@@ -20,9 +20,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|
@@ -30,23 +30,45 @@ Aliyun::CloudSms.configure do |config|
   config.access_key_id = 'your key id'
   config.sign_name = 'your sign name'
 end
+```
+### 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')
 
+## API
+### Message send
+```ruby
+Aliyun::CloudSms.send_msg(mobile, template_code, template_param).
 ```
-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.
+`template_params` could be a string.
 ```ruby
-client = Aliyun::CloudSms.new('your_access_key_id', 'your_access_key_secret', 'your_sign_name')
+client.send_msg('13800000000', 'SMS_80190090', "{\"customer\":\"jeremy\"}" )
+```
 
-client.send_msg('13800000000', 'SMS_80190090', {"customer": "jere"} )
+#### extended params support
+```ruby
+Aliyun::CloudSms.send_msg('13800000000', 'SMS_80190090', {"customer": "jere"}, {:OutId => 'your system id', :smsUpExtendCode => 'sms up extended code'} )
 ```
 
+
+### Status query
+
+```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
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -55,7 +77,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/aliyun-cloud_sms.gemspec

@@ -6,7 +6,7 @@ require 'aliyun/cloud_sms/version'
 Gem::Specification.new do |spec|
   spec.name          = "aliyun-cloud_sms"
   spec.version       = Aliyun::CloudSms::VERSION
-  spec.authors       = ["Jeremy Cui"]
+  spec.authors       = ["Jere Cui"]
   spec.email         = ["tsuijy@gmail.com"]
 
   spec.summary       = %q{Aliyun SMS service gem.}
@@ -21,9 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "uuid", ">=2.0", "<6.0"
+  spec.add_dependency "uuid", ">=2.0"
+  spec.add_dependency "rest-client", ">=2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "bundler", "> 1.14"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", ">= 3.0"
 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

data/lib/aliyun/cloud_sms/client.rb

@@ -1,8 +1,5 @@
-require 'uuid'
-require 'json'
-require 'cgi'
-require 'openssl'
-require 'base64'
+require 'aliyun/cloud_sms/request/message_send'
+require 'aliyun/cloud_sms/request/message_query'
 
 module Aliyun::CloudSms
   class Client
@@ -14,65 +11,19 @@ module Aliyun::CloudSms
       self.sign_name = sign_name
     end
 
-    SERVICE_URL = "http://dysmsapi.aliyuncs.com/"
 
-    def send_msg(mobile, template_code, template_param)
-      params = dynamic_params(mobile, template_code, template_param).merge(intrinsic_params)
-      q_without_sig = build_url(params)
-      q_full= "Signature=#{sign(q_without_sig)}&#{q_without_sig}"
+    def send_msg(mobile, template_code, template_param, optional_params = {})
+      request = Request::MessageSend.new mobile, template_code, template_param, optional_params
+      request.client = self
 
-      begin
-        response = RestClient.get url
-      rescue RestClient::ExceptionWithResponse => e
-        Rails.logger.error(e.response) if defined? Rails
-      end
+      request.send_request
     end
 
-    private
-      def dynamic_params(mobile, template_code, template_param)
-        {
-          :PhoneNumbers => mobile,
-          :TemplateCode => template_code,
-          :TemplateParam => template_param.to_json.to_s,
-          :Timestamp => timestamp,
-          :SignatureNonce => nonce,
-        }
-      end
+    def query_status(mobile, send_date = "#{Time.now.strftime('%Y%m%d')}", biz_id = nil, page_size = 1, current_page = 1)
+      request = Request::MessageQuery.new mobile, send_date, biz_id, page_size, current_page
+      request.client = self
 
-      def intrinsic_params
-        {
-          :AccessKeyId => self.access_key_id,
-          :SignName => self.sign_name,
-          :Action => Aliyun::CloudSms.action,
-          :Format => Aliyun::CloudSms.format,
-          :RegionId => Aliyun::CloudSms.region_id,
-          :SignatureMethod => Aliyun::CloudSms.signature_method,
-          :SignatureVersion => Aliyun::CloudSms.signature_version,
-          :Version => Aliyun::CloudSms.sms_version
-        }
-      end
-
-      def timestamp
-        Time.now.utc.strftime("%FT%TZ")
-      end
-
-      def nonce
-        UUID.generate
-      end
-
-      def build_url(hash)
-        hash.map{|k,v|"#{encode(k.to_s)}=#{encode(v.to_s)}"}.sort.join('&')
-      end
-
-      def encode(str)
-        CGI.escape(str)
-      end
-
-      def sign(str)
-        str = "GET&#{encode('/')}&#{encode(str)}"
-        ret = OpenSSL::HMAC.digest('sha1', "#{self.access_key_secret}&", str)
-        ret = Base64.encode64(ret)
-        encode(ret.chomp)
-      end
+      request.send_request
+    end
   end
 end

data/lib/aliyun/cloud_sms/configure.rb

@@ -1,6 +1,5 @@
 module Aliyun::CloudSms
   module Configure
-    @@action = "SendSms"
     @@format = "JSON"
     @@region_id = "cn-hangzhou"
     @@signature_method = "HMAC-SHA1"
@@ -27,14 +26,6 @@ module Aliyun::CloudSms
       @@sign_name = sign_name
     end
 
-    def action=(action)
-      @@action = action
-    end
-
-    def action
-      @@action
-    end
-
     def format
       @@format
     end

data/lib/aliyun/cloud_sms/request/base.rb

@@ -0,0 +1,83 @@
+require 'erb'
+require 'uuid'
+require 'json'
+require 'openssl'
+require 'base64'
+require 'rest-client'
+
+module Aliyun
+  module CloudSms
+    module Request
+      class Base
+
+        attr_accessor :client
+
+        SERVICE_URL = "http://dysmsapi.aliyuncs.com/"
+
+        def action
+          ""
+        end
+
+        def get_params
+          custom_params.merge intrinsic_params
+        end
+
+        def send_request
+          q_without_sig = build_url(get_params)
+          q_full= "Signature=#{sign(q_without_sig)}&#{q_without_sig}"
+
+          begin
+            response = RestClient.get "#{SERVICE_URL}?#{q_full}"
+          rescue RestClient::ExceptionWithResponse => e
+            puts e.response
+            Rails.logger.error(e.response) if defined? Rails
+            e.response
+          end
+        end
+
+        protected
+          def custom_params
+            {}
+          end
+
+          def intrinsic_params
+            {
+              :AccessKeyId => client.access_key_id,
+              :SignName => client.sign_name,
+              :Format => Aliyun::CloudSms.format,
+              :RegionId => Aliyun::CloudSms.region_id,
+              :SignatureMethod => Aliyun::CloudSms.signature_method,
+              :SignatureVersion => Aliyun::CloudSms.signature_version,
+              :Timestamp => timestamp,
+              :SignatureNonce => nonce,
+              :Action => action,
+              :Version => Aliyun::CloudSms.sms_version
+            }
+          end
+
+          def timestamp
+            Time.now.utc.strftime("%FT%TZ")
+          end
+
+          def nonce
+            UUID.generate
+          end
+
+          def build_url(hash)
+            hash.map{|k,v|"#{encode(k.to_s)}=#{encode(v.to_s)}"}.sort.join('&')
+          end
+
+          def encode(str)
+            ERB::Util.url_encode str
+          end
+
+          def sign(str)
+            str = "GET&#{encode('/')}&#{encode(str)}"
+            ret = OpenSSL::HMAC.digest('sha1', "#{client.access_key_secret}&", str)
+            ret = Base64.encode64(ret)
+            encode(ret.chomp)
+          end
+      end
+    end
+  end
+end

data/lib/aliyun/cloud_sms/request/message_query.rb

@@ -0,0 +1,34 @@
+module Aliyun
+  module CloudSms
+    module Request
+      class MessageQuery < Base
+        attr_accessor :mobile, :send_date, :biz_id, :page_size, :current_page
+
+        def initialize(mobile, send_date, biz_id, page_size, current_page)
+          self.mobile = mobile
+          self.send_date = send_date
+          self.biz_id = biz_id
+          self.page_size = page_size
+          self.current_page = current_page
+        end
+
+        def action
+          "QuerySendDetails".freeze
+        end
+
+        def custom_params
+          params = {
+            :PhoneNumber => mobile,
+            :SendDate => send_date,
+            :PageSize => page_size,
+            :CurrentPage => current_page
+          }
+
+          params.merge!({:BizId => biz_id}) if biz_id
+
+          params
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/cloud_sms/request/message_send.rb

@@ -0,0 +1,33 @@
+require 'aliyun/cloud_sms/request/base'
+
+module Aliyun
+  module CloudSms
+    module Request
+      class MessageSend < Base
+
+        attr_accessor :mobile, :template_code, :template_param, :optional_params
+
+        def initialize(mobile, template_code, template_param, optional_params = nil)
+          self.mobile = mobile
+          self.template_code = template_code
+          self.template_param = template_param
+          self.optional_params = optional_params || {}
+        end
+
+        def action
+          "SendSms".freeze
+        end
+
+        def custom_params
+          self.template_param = self.template_param.to_json if self.template_param.is_a?(Hash)
+
+          {
+            :PhoneNumbers => self.mobile,
+            :TemplateCode => self.template_code,
+            :TemplateParam => self.template_param.to_s,
+          }.merge!(self.optional_params)
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/cloud_sms/version.rb

@@ -1,5 +1,5 @@
 module Aliyun
   module CloudSms
-    VERSION = "0.1.0"
+    VERSION = "0.2.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aliyun-cloud_sms
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
-- Jeremy Cui
-autorequire: 
+- Jere Cui
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2021-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,49 +24,60 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - "<"
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 description: Send short message via aliyun cloud service.
@@ -85,6 +93,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- README-CN.md
 - README.md
 - Rakefile
 - aliyun-cloud_sms.gemspec
@@ -93,12 +102,15 @@ files:
 - lib/aliyun/cloud_sms.rb
 - lib/aliyun/cloud_sms/client.rb
 - lib/aliyun/cloud_sms/configure.rb
+- lib/aliyun/cloud_sms/request/base.rb
+- lib/aliyun/cloud_sms/request/message_query.rb
+- lib/aliyun/cloud_sms/request/message_send.rb
 - lib/aliyun/cloud_sms/version.rb
 homepage: https://github.com/jerecui/aliyun-cloud_sms
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,9 +125,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Aliyun SMS service gem.
 test_files: []