aliyun_sms_ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04b9443bcc94bde6a6a76a53b3514396f5534dbfa7d8d6b4a1fd92d63979d922
-  data.tar.gz: 31e66adb1673f8408487bc9abda71c289aae370a017b1d917e0323cc8df69f36
+  metadata.gz: 7fd197eeee2199a24d181857c325458664f00da977c3613064eb6804384a6543
+  data.tar.gz: f15bea60e663b7c6410f8d8423d11ae5c4ca4f80ac6aa24e3931821b0464c3a7
 SHA512:
-  metadata.gz: dc0ec467f5bd494f7b721d2e84be02642576334282fa5e379746f74c050d836f2af5ac937f22c2fb870d200408865ea8132ae303da042fb26fe723f102fea4c6
-  data.tar.gz: b6c0db9d718bb6f52bf71f3b6492e728219994ae6803a1b486d418085f10010689078b75da6e477da5ded671ed0979dda6ac93657e43a9d94228393830f515fb
+  metadata.gz: f0f26a9128ac5db19534fabd4abd5ad91b0a842ee826964aa2cc2912dea010e32ed395132a59361c3aafced6c3ee05d900bb0dc09c7238ac5c6c76767f961d1d
+  data.tar.gz: a7cb468c7dde07529de0579272ee1cc8dec9a54a7069e9c9ff257eb0cdbbc2c50d973a818289d2a281991ba5dd268bfe6e1209ccb1c434f8606b171f1d745b4c

data/README.md

@@ -0,0 +1,64 @@
+# AliyunSmsRuby
+This gem use for Aliyun message send and status query.
+
+Add 10DLC support
+
+## Installation
+
+```ruby
+gem 'aliyun_sms_ruby'
+```
+
+## Config
+Add aliyun_sms_ruby.rb to config/initializers.
+
+```ruby
+AliyunSmsRuby.configure do |config|
+  config.access_key_secret = ENV['ALIYUN_SMS_ACCESS_KEY_SECRET']
+  config.access_key_id = ENV['ALIYUN_SMS_ACCESS_KEY_ID']
+  config.sign_name = ENV['ALIYUN_SMS_SIGN_NAME']
+end
+```
+
+## Use
+
+### Message send
+Aliyun doc: https://next.api.aliyun.com/document/Dysmsapi/2017-05-25/SendSms
+
+``` ruby
+phone_number = '151********'
+template_code = 'SMS_182823232'
+template_param = { code: "10001" }
+AliyunSmsRuby.send_message(phone_number, template_code, template_param)
+```
+
+### Global message send(can not query message send status)
+**Important: After register the 10 DLC number, you need ask the Aliyun support team add your account to their white list. Or you will receive a forbidden error.**
+
+```
+{
+  "Code": "Forbidden.Operation",
+  "Message":"You are not authorized to perform the operation."
+}
+```
+
+Aliyun doc: https://help.aliyun.com/document_detail/164194.html
+
+``` ruby
+phone_number = '151********'
+text = 'code is 19384'
+type = 'OTP'
+# need register from Aliyun support
+from = '18884060817'
+AliyunSmsRuby.send_global_message(phone_number, text, from, type)
+```
+
+### Message status query
+Aliyun doc: https://next.api.aliyun.com/document/Dysmsapi/2017-05-25/QuerySendDetails
+
+``` ruby
+phone_number = '151********'
+send_date = Time.now.strftime('%Y%m%d')
+biz_id = '940902739667766114^0'
+AliyunSmsRuby.send_query_request(phone_number, send_date, biz_id, page_size = 1, current_page = 1)
+```

data/README.zh-CN.md

@@ -0,0 +1,62 @@
+# AliyunSmsRuby
+阿里云的短信服务，支持短信发送状态查询，10DLC
+
+## 安装
+
+```ruby
+gem 'aliyun_sms_ruby'
+```
+
+## 配置
+添加文件 aliyun_sms_ruby.rb 到 config/initializers.
+
+```ruby
+AliyunSmsRuby.configure do |config|
+  config.access_key_secret = ENV['ALIYUN_SMS_ACCESS_KEY_SECRET']
+  config.access_key_id = ENV['ALIYUN_SMS_ACCESS_KEY_ID']
+  config.sign_name = ENV['ALIYUN_SMS_SIGN_NAME']
+end
+```
+
+## 使用
+
+### 短信发送
+文档地址: https://next.api.aliyun.com/document/Dysmsapi/2017-05-25/SendSms
+
+``` ruby
+phone_number = '151********'
+template_code = 'SMS_182823232'
+template_param = { code: "10001" }
+AliyunSmsRuby.send_message(phone_number, template_code, template_param)
+```
+
+### 国际短信发送（不可查询发送状态）
+**重要: 注册完10DLC 后需要找阿里云的工单支持把当前的账号加入到阿里云的白名单里才行, 不然就会收到下面的错误**
+
+```
+{
+  "Code": "Forbidden.Operation",
+  "Message":"You are not authorized to perform the operation."
+}
+```
+
+文档地址: https://help.aliyun.com/document_detail/164194.html
+
+``` ruby
+phone_number = '151********'
+text = 'code is 19384'
+type = 'OTP'
+# need register from Aliyun support
+from = '18884060817'
+AliyunSmsRuby.send_global_message(phone_number, text, from, type)
+```
+
+### 短信状态查询
+文档地址: https://next.api.aliyun.com/document/Dysmsapi/2017-05-25/QuerySendDetails
+
+``` ruby
+phone_number = '151********'
+send_date = Time.now.strftime('%Y%m%d')
+biz_id = '940902739667766114^0'
+AliyunSmsRuby.send_query_request(phone_number, send_date, biz_id, page_size = 1, current_page = 1)
+```

data/aliyun_sms_ruby.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Aliyun sms ruby sdk}
   spec.description   = %q{Aliyun sms ruby sdk}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/Zkuns/aliyun_sms_ruby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/aliyun_sms_ruby/configuration.rb

@@ -6,12 +6,12 @@ module AliyunSmsRuby
     def initialize
       @access_key_secret = ''
       @access_key_id = ''
-      @format = ''
-      @region_id = ''
+      @format = 'JSON'
+      @region_id = 'cn-hangzhou'
       @sign_name = ''
-      @signature_method = ''
-      @signature_version = ''
-      @version = ''
+      @signature_method = 'HMAC-SHA1'
+      @signature_version = '1.0'
+      @version = '2017-05-25'
     end
   end
 end

data/lib/aliyun_sms_ruby/request/query_request.rb

@@ -3,6 +3,32 @@ require 'aliyun_sms_ruby/request/base_request'
 module AliyunSmsRuby
   module Request
     class QueryRequest < BaseRequest
+      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

data/lib/aliyun_sms_ruby/version.rb

@@ -1,3 +1,3 @@
 module AliyunSmsRuby
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/aliyun_sms_ruby.rb

@@ -2,6 +2,7 @@ require 'aliyun_sms_ruby/configuration'
 require 'aliyun_sms_ruby/client'
 require 'aliyun_sms_ruby/request/message_request'
 require 'aliyun_sms_ruby/request/message_global_request'
+require 'aliyun_sms_ruby/request/query_request'
 
 module AliyunSmsRuby
   class << self
@@ -25,6 +26,11 @@ module AliyunSmsRuby
       client.send_request request
     end
 
+    def send_query_request(mobile, send_date, biz_id, page_size, current_page)
+      request = AliyunSmsRuby::Request::QueryRequest.new(mobile, send_date, biz_id, page_size, current_page)
+      client.send_request request
+    end
+
     private
     def client
       @client ||= AliyunSmsRuby::Client.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aliyun_sms_ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Zkun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-13 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- README.zh-CN.md
 - aliyun_sms_ruby.gemspec
 - lib/aliyun_sms_ruby.rb
 - lib/aliyun_sms_ruby/client.rb
@@ -97,7 +98,7 @@ files:
 - lib/aliyun_sms_ruby/request/message_request.rb
 - lib/aliyun_sms_ruby/request/query_request.rb
 - lib/aliyun_sms_ruby/version.rb
-homepage: ''
+homepage: https://github.com/Zkuns/aliyun_sms_ruby
 licenses:
 - MIT
 metadata: {}