aliyun-sms-with-10dlc 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd02ed1b93a9fbee135f358b391473a37fcef678aaf295a94315beec236b8c2b
-  data.tar.gz: 20eea8754b8a3506c32fe2f045099c744845f42ef6ea625747af6279a1cdf53f
+  metadata.gz: d272ca1805496d72543154e043c15d4695b7e036fbcce72549bc4c41fce5b2ec
+  data.tar.gz: 341d250d9ed464dac6a8d50c83a98235f056ab651280abec25b09ec7e03be092
 SHA512:
-  metadata.gz: f9b629ab606c4ecae623ec09cae57782328ce6739ce8ff652b0e9160d710e61a6b23a2955e8eb6f32b50a362830681579187f28192009caae2ee9fc34d099dd6
-  data.tar.gz: be9f013e364d3896d1b33bd30cef1b56d099e8254ad4b12b277003a0d5934ba84b8f37ee14bbed40869d26a245b39b3f5a114aa16a84da1fd40cf7d2a17b4755
+  metadata.gz: 333e1fc712ee266e56b82eddebaf6fdb59ef0d8b713ac209c9a84b8c20d03054131fc8f0231ae86e76e462b1cbeccf285570ee83aeac76e8f32ec79eda5eecfb
+  data.tar.gz: 96ed0f35602a3f5b0337803f3376e0315930d7cec865616b3eb5e8b9a369c273f2cdf02c7a17375da9f877733eb9b726db3d31579c1ef03388985e01edf2b2d2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at victor-luo@outlook.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in aliyun-sms.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 VICTOR LUO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,210 @@
+## [中文说明](./README.zh-CN.md)
+
+# 添加10DLC的接口
+文档地址：https://help.aliyun.com/document_detail/164194.html
+
+``` ruby
+#发送号码
+mobile = '1646xxxxxxx'
+#内容
+text = 'code is 19384'
+#发送类型
+type = 'OTP'
+#10DLC号码
+from = '1xxxxxxxxxx'
+Aliyun::Sms.send_globle(mobile, text, from, type)
+```
+
+# Aliyun::Sms  Ruby Gem for Aliyun Short Message Service(aliyun-sms)
+
+**Comfortable to aliyun sms  *2017-05-25 version* api**
+
+## Notice
+
+Currently, aliyun has three services of short message，named：
+
+1. ali-dayu(阿里大于)
+2. aliyun-mq(阿里云消息队列)
+3. aliyun-sms(阿里云短信服务)
+
+They all are usable, and will merge togather in future. But before merged, they are Independent, and every user only use one between them.
+
+**This gem only for aliyun-sms(阿里云短信服务), and you must confirm that you just use it. If you can't confirm, please see the document [阿里云短信业务说明](https://help.aliyun.com/document_detail/63097.html?spm=a2c4g.11186623.6.542.6fZlRU) to get guidance.**
+
+## Before
+
+Before use aliyun-sms, you must apply and open the aliyun-sms, and get the parameters as follows:
+
+1. ACCESS\_KEY\_SECRET：   apply on aliyun console
+2. ACCESS\_KEY\_ID：       apply on aliyun console
+3. SIGN\_NAME：            get when open the aliyun-sms
+4. TEMPLATE\_CODE：        get when open the aliyun-sms
+
+## Installation
+
+### Ruby Common Method
+
+
+```ruby
+gem install aliyun-sms
+```
+
+### Rails Method
+
+Add in Gemfile :
+
+```ruby
+gem 'aliyun-sms'   # Ruby Gems 安装源
+```
+
+Run command:
+
+```ruby
+bundle
+```
+
+### Download Method
+
+Clone and install by rake.
+
+```bash
+git clone https://github.com/VICTOR-LUO-F/aliyun-sms.git
+
+cd aliyun-sms
+
+rake build
+
+rake install
+```
+
+### Problem and Resolve
+
+```ruby
+require 'aliyun/sms'
+```
+
+If you get a error as follows, when running above command：
+
+> ./config/initializers/aliyun-sms.rb:1:in `<top (required)>': uninitialized constant Aliyun::Sms (NameError)
+
+You could switch to github resource, and modify the the Rails Gemfile to:
+
+```ruby
+gem 'aliyun-sms', '1.1.1', git: 'https://github.com/VICTOR-LUO-F/aliyun-sms.git'
+```
+
+## Usage
+
+### Ruby Common Program（irb）
+
+#### First Step：
+
+```bash
+$ require 'aliyun/sms'
+```
+
+return
+
+```bash
+=> true
+```
+
+#### Second Step：
+
+
+```ruby
+$ Aliyun::Sms.configure do |config|
+    config.access_key_secret = ACCESS_KEY_SECRET
+    config.access_key_id = ACCESS_KEY_ID
+    config.action = 'SendSms'                       # default value
+    config.format = 'XML'                           # http return format, value is 'JSON' or 'XML'
+    config.region_id = 'cn-hangzhou'                # default value
+    config.sign_name = SIGN_NAME
+    config.signature_method = 'HMAC-SHA1'           # default value
+    config.signature_version = '1.0'                # default value
+    config.version = '2017-05-25'                   # default value
+  end
+
+```
+return
+
+```ruby
+  => "2017-05-25"
+```
+
+#### Third Step：
+
+Send message：
+
+    $ Aliyun::Sms.send(phone_numbers, template_code, template_param, out_id)
+
+Explanation：
+
+1. phone_numbers： the phone number, string type, such as '1234567890'. You can use multiple phone numbers devided by comma, such as '1234567890,12388888888'.
+2. template\_code： message template code, string type, such as 'SMS_12345678'.
+3. template_param： message template params, tring type, such as '{"code":"666666", "product":"content" }'.
+4. out_id：out extension id，string type，could be null。
+
+
+### Rails Application
+
+#### First Step：
+
+In Rails direction 'config/initializers/', create file 'aliyun-sms.rb', and add code：
+
+
+config/initializers/aliyun-sms.rb
+
+```ruby
+Aliyun::Sms.configure do |config|
+  config.access_key_secret = ACCESS_KEY_SECRET
+  config.access_key_id = ACCESS_KEY_ID
+  config.action = 'SendSms'                       # default value
+  config.format = 'XML'                           # http return format, value is 'JSON' or 'XML'
+  config.region_id = 'cn-hangzhou'                # default value
+  config.sign_name = SIGN_NAME
+  config.signature_method = 'HMAC-SHA1'           # default value
+  config.signature_version = '1.0'                # default value
+  config.version = '2017-05-25'                   # default value
+end
+```
+then, restart Rails application。
+
+#### Second Step：
+
+Send message in your program：
+
+```ruby
+Aliyun::Sms.send(phone_numbers, template_code, template_param, out_id)
+```
+
+Explanation：
+
+1. phone_numbers： the phone number, string type, such as '1234567890'. You can use multiple phone numbers devided by comma, such as '1234567890,12388888888'.
+2. template\_code： message template code, string type, such as 'SMS_12345678'.
+3. template_param： message template params, tring type, such as '{"code":"666666", "product":"content" }'.
+4. out_id：out extension id，string type，could be null。
+
+Specially：
+
+In Rails application program, you could organize your message content as a hash, and trans it bo be a param of Aliyun::Sms.send by to_json method. For instance:
+
+```ruby
+...
+phone_number = '1234567890'
+template_code = 'SMS_12345678'
+template_param = {"code"=>"666666", "product"=>"conten" }.to_json
+Aliyun::Sms.send(phone_numbers, template_code, template_param)
+...
+```
+
+## Development
+
+According to [Aliyun Official Document](https://help.aliyun.com/document_detail/56189.html?spm=a2c4g.11186623.6.580.o8Fm0S) example, I had written spect test. You could run the test after clone as follows:
+
+    $ bundle exec rspec spec
+
+
+## License
+
+MIT License。 [MIT License](http://opensource.org/licenses/MIT).

data/README.zh-CN.md

@@ -0,0 +1,215 @@
+## [ENGLISH README](./README.md)
+
+# 添加10DLC的接口
+文档地址：https://help.aliyun.com/document_detail/164194.html
+
+``` ruby
+#发送号码
+mobile = '1646xxxxxxx'
+#内容
+text = 'code is 19384'
+#发送类型
+type = 'OTP'
+#10DLC号码
+from = '1xxxxxxxxxx'
+Aliyun::Sms.send_globle(mobile, text, from, type)
+```
+
+# Aliyun::Sms 阿里云短信服务 Ruby Gem aliyun-sms
+
+**适用于阿里云短信服务最新的 *2017-05-25* 版接口**
+
+## 特别说明
+
+目前阿里云通信提供三个短信产品，分别是：
+
+1. 原阿里大于
+2. 阿里云消息服务
+3. 阿里云短信服务
+
+这三个短信服务均可使用，并将最终深度融合，综合为一个产品。在合并之前，请注意以下几点：
+
+* 各短信产品账号独立、资金独立；
+* 各短信产品内使用数据独立；
+* 各短信产品具有自己的 API&SDK，不可兼容使用；
+* 同一账号只可使用其中一个产品，不可使用多个产品。
+
+**这个 gem 针对的是前面所述的第 3 个短信产品，即“阿里云短信服务”。请您在使用 aliyun-sms 前，确认自己申请的阿里云短信产品是“阿里云短信服务”，如果无法确定，请参考官方说明文档[阿里云短信业务说明](https://help.aliyun.com/document_detail/63097.html?spm=a2c4g.11186623.6.542.6fZlRU)进行区分。**
+
+## 使用前提
+
+使用 aliyun-sms 前，您必须已经是阿里云注册用户，申请开通了“阿里云短信服务”，并且获得了以下几个关键参数：
+
+1. ACCESS\_KEY\_SECRET：   阿里云用户密钥，在阿里云控制台申请获取。
+2. ACCESS\_KEY\_ID：       阿里云用户 ID， 在阿里云控制台申请获取。
+3. SIGN\_NAME：            短信签名，在阿里云申请开通短信服务时获取。
+4. TEMPLATE\_CODE：        短信模版代码，在阿里云申请开通短信服务时申请获取。
+
+## Installation 安装
+
+### Ruby 通用安装方法
+在命令行中输入命令（电脑已经安装 gems 命令行工具）
+
+```ruby
+gem install aliyun-sms
+```
+
+### Rails 应用安装方法
+
+在应用的 Gemfile 文件中添加 Ruby Gems 安装源:
+
+```ruby
+gem 'aliyun-sms'   # Ruby Gems 安装源
+```
+
+应用的根目录下运行:
+
+```ruby
+bundle
+```
+
+### 下载后安装
+
+使用 Git 将代码克隆到本地后使用 Rake 命令安装
+
+```bash
+git clone https://github.com/VICTOR-LUO-F/aliyun-sms.git
+
+cd aliyun-sms
+
+rake build
+
+rake install
+```
+
+### 安装可能遇到的问题及其解决方式
+
+安装后，如果在 irb 命令行输入命令
+
+```ruby
+require 'aliyun/sms'
+```
+
+后，无法正确获取 Gem 引用，或者在 Rails 启动时报错提示如下：
+
+> ./config/initializers/aliyun-sms.rb:1:in `<top (required)>': uninitialized constant Aliyun::Sms (NameError)
+
+可以改为 Github 安装源，例如 Rails Gemfile 文件引用可以改为下面格式，即可正确安装。
+
+```ruby
+gem 'aliyun-sms', '1.1.1', git: 'https://github.com/VICTOR-LUO-F/aliyun-sms.git'
+```
+
+## Usage 使用
+
+### Ruby 程序通用方法（irb命令行示例）
+
+#### 第一步：
+
+```bash
+$ require 'aliyun/sms'
+```
+
+```bash
+=> true
+```
+
+#### 第二步：
+
+参数设置：
+
+```ruby
+$ Aliyun::Sms.configure do |config|
+    config.access_key_secret = ACCESS_KEY_SECRET    # 阿里云接入密钥，在阿里云控制台申请
+    config.access_key_id = ACCESS_KEY_ID            # 阿里云接入 ID, 在阿里云控制台申请
+    config.action = 'SendSms'                       # 默认设置
+    config.format = 'XML'                           # 短信推送返回信息格式，可以填写 'JSON'或者'XML'
+    config.region_id = 'cn-hangzhou'                # 默认设置，如果没有特殊需要，可以不改
+    config.sign_name = SIGN_NAME                    # 短信签名，在阿里云申请开通短信服务时申请获取
+    config.signature_method = 'HMAC-SHA1'           # 加密算法，默认设置
+    config.signature_version = '1.0'                # 签名版本，默认设置，不用修改
+    config.version = '2017-05-25'                   # 服务版本，默认设置，不用修改
+  end
+
+```
+返回
+
+```ruby
+  => "2017-05-25"
+```
+
+#### 第三步：
+
+发送短信：
+
+    $ Aliyun::Sms.send(phone_numbers, template_code, template_param, out_id)
+
+参数说明：
+
+1. phone_numbers： 接收短信的手机号，必须为字符型，例如 '1234567890'，如果有多个号码，中间用","隔开，例如：'1234567890,12388888888'；
+2. template\_code： 短信模版代码，必须为字符型，申请开通短信服务后，由阿里云提供，例如 'SMS_12345678'；
+3. template_param： 请求字符串，向短信模版提供参数，必须是转为字符串的json格式对象，例如 '{"code":"666666", "product":"测试网站" }'；
+4. out_id：外部流水扩展字段，必须为字符型，可以为空。
+
+
+### Rails 应用使用方法
+
+#### 第一步：
+
+在 Rails 应用目录 config/initializers/ 下创建脚本文件 aliyun-sms.rb，在文件中加入以下内容：
+
+config/initializers/aliyun-sms.rb
+
+```ruby
+Aliyun::Sms.configure do |config|
+  config.access_key_secret = ACCESS_KEY_SECRET    # 阿里云接入密钥，在阿里云控制台申请
+  config.access_key_id = ACCESS_KEY_ID            # 阿里云接入 ID, 在阿里云控制台申请
+  config.action = 'SendSms'                       # 默认设置
+  config.format = 'XML'                           # 短信推送返回信息格式，可以填写 'JSON'或者'XML'
+  config.region_id = 'cn-hangzhou'                # 默认设置，如果没有特殊需要，可以不改
+  config.sign_name = SIGN_NAME                    # 短信签名，在阿里云申请开通短信服务时申请获取
+  config.signature_method = 'HMAC-SHA1'           # 加密算法，默认设置
+  config.signature_version = '1.0'                # 签名版本，默认设置，不用修改
+  config.version = '2017-05-25'                   # 服务版本，默认设置，不用修改
+end
+```
+之后，重新启动 Rails，加载配置。
+
+#### 第二步：
+
+在 Rails 应用中调用短信发送代码：
+
+```ruby
+Aliyun::Sms.send(phone_numbers, template_code, template_param, out_id)
+```
+
+参数说明：
+
+1. phone_numbers： 接收短信的手机号，必须为字符型，例如 '1234567890'，如果有多个号码，中间用","隔开，例如：'1234567890,12388888888'；
+2. template\_code： 短信模版代码，必须为字符型，申请开通短信服务后，由阿里云提供，例如 'SMS_12345678'；
+3. template_param： 请求字符串，向短信模版提供参数，必须是转为字符串的json格式对象，例如 '{"code":"666666", "product":"测试网站" }'；
+4. out_id：外部流水扩展字段，必须为字符型，可以为空。
+
+特别说明：
+
+在程序中可以先用 HASH 组织 template\_param 内容，再使用 to_json 方法转换为 json 格式字符串，例如：
+
+```ruby
+...
+phone_number = '1234567890'
+template_code = 'SMS_12345678'
+template_param = {"code"=>"666666", "product"=>"测试网站" }.to_json
+Aliyun::Sms.send(phone_numbers, template_code, template_param)
+...
+```
+
+## Development 开发
+
+按照阿里云[官方接口文档](https://help.aliyun.com/document_detail/56189.html?spm=a2c4g.11186623.6.580.o8Fm0S)提供的 SMS 样例做了 spect 测试，可以 clone 项目后，在根目录下用命令行运行以下命令测试：
+
+    $ bundle exec rspec spec
+
+
+## License 许可
+
+MIT 协议下的开源项目。 [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/aliyun-sms.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aliyun/sms/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aliyun-sms-with-10dlc"
+  spec.version       = Aliyun::Sms::VERSION
+  spec.authors       = ["kun"]
+  spec.email         = ["zhukun6150909@outlook.com"]
+
+  spec.summary       = %q{A Ruby Gem for using aliyun sms service, in accordance with aliyun sms 2017-05-25 version api. 适用于阿里云短信服务最新的 2017-05-25 版接口.}
+  spec.description   = %q{A Ruby Gem for using aliyun sms service, in accordance with aliyun sms 2017-05-25 version api. 适用于阿里云短信服务最新的 2017-05-25 版接口.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "typhoeus"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "aliyun/sms"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/aliyun/sms/version.rb

@@ -0,0 +1,5 @@
+module Aliyun
+  module Sms
+    VERSION = "1.1.4"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aliyun-sms-with-10dlc
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - kun
@@ -74,7 +74,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- README.zh-CN.md
+- Rakefile
+- aliyun-sms.gemspec
+- bin/console
+- bin/setup
 - lib/aliyun/sms.rb
+- lib/aliyun/sms/version.rb
 homepage: ''
 licenses:
 - MIT