aliyun-cloud_sms 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9e8061ed6c6581a5e2faeba0f8cdafa0a2e38f5
-  data.tar.gz: e6a75766439fd59feddf91a5dfb05373afb8e637
+  metadata.gz: 11d78bf025f601b8bea4127c55db87ef68307c5a
+  data.tar.gz: 95f9e07fb0caeffe2941443e7ce513ad1f39f6a9
 SHA512:
-  metadata.gz: 30fcb044dc0f740470ae4e6ca72b38ef2e6184ec3928e072409d3be4f82f58a374de591d6cedb42c29b3cdcb0a2305bf457ac04915b010137622dea204515ee9
-  data.tar.gz: 9094e31061055b6d446152c165b5ffefbd42d9d8b59c1c1d779ef8720dec7e4a1c9b517d8c111d6e33948e45b2b94d1e48482b7555f50b82380ba285640e8755
+  metadata.gz: 317b1c814f11d02a947cd63313c5e9ffddb2ffe6271d4b3cdd00396143a35a0fb513c81a62f2df5dc39adc2b7528e74984f18b2a2a1ce456c90bf94a67f32628
+  data.tar.gz: 200d2db45fd2edc3c973668f3f7d29f5f7ca296ab460836ee78d73f4148d2bee3c58502bb3e2b2ed2375e6691275eb350b1c079d2508a64ec8ea56977637bba4

data/README.md

@@ -1,8 +1,6 @@
 # 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.
-
-TODO: Delete this and the text above, and describe your gem
+This gem is used for sending sms via aliyun sms service, and querying the message status as well.
 
 ## Installation
 
@@ -47,6 +45,22 @@ client = Aliyun::CloudSms.new('your_access_key_id', 'your_access_key_secret', 'y
 client.send_msg('13800000000', 'SMS_80190090', {"customer": "jere"} )
 ```
 
+`template_params` can be a string as well.
+```ruby
+client.send_msg('13800000000', 'SMS_80190090', "{\"customer\":\"jeremy\"}" )
+```
+
+## Message 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.

data/aliyun-cloud_sms.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "uuid", ">=2.0", "<6.0"
+  spec.add_dependency "rest-client", ">=2.0", "<6.0"
 
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"

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}"
+      request = Request::MessageSend.new mobile, template_code, template_param
+      request.client = self
 
-      begin
-        response = RestClient.get "#{SERVICE_URL}?#{q_full}"
-      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 'uuid'
+require 'json'
+require 'cgi'
+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)
+            CGI.escape(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"
+        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,32 @@
+require 'aliyun/cloud_sms/request/base'
+
+module Aliyun
+  module CloudSms
+    module Request
+      class MessageSend < Base
+
+        attr_accessor :mobile, :template_code, :template_param
+
+        def initialize(mobile, template_code, template_param)
+          self.mobile = mobile
+          self.template_code = template_code
+          self.template_param = template_param
+        end
+
+        def action
+          "SendSms"
+        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,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/aliyun/cloud_sms/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aliyun-cloud_sms
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeremy Cui
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-03 00:00:00.000000000 Z
+date: 2017-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -30,6 +30,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +113,9 @@ 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: