aliyun-dysms 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +15 -0
- data/.rspec +3 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/LICENSE.txt +21 -0
- data/README.md +149 -0
- data/Rakefile +2 -0
- data/aliyun-dysms.gemspec +30 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/aliyun/dysms.rb +62 -0
- data/lib/aliyun/dysms/version.rb +5 -0
- metadata +111 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 7e914670b8041bfb2c1639676ce08f5feeaa102b2a8dc010d887670bae47bc95
|
4
|
+
data.tar.gz: 1e06b33272fc719c89dd7895ff846087db93fa4f93b90912195554749f82de8f
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: e9f46d98707ba1dc708fbe0913bbeece580e4a959aa9b25c2aba5f4173ed7b9b9bc0b36dc1963ee3fd6d5fe01dc80f4303238d21393fbabdbd02c4a03936375d
|
7
|
+
data.tar.gz: 3840d128f31c10be310b30b203b3e7432db4b390093794a186b6d5c2c4091cbcbbfdeb67a99b8425475058a19552964af730d3227d84d6481a48cd6d4a94ff5f
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at wellsmuker@gmail.com. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: http://contributor-covenant.org
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2019 Wells Muker
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,149 @@
|
|
1
|
+
# Aliyun::Dysms
|
2
|
+
### 阿里云-短信通知服务 Ruby Gem aliyun-dysms
|
3
|
+
|
4
|
+
## 使用前提
|
5
|
+
|
6
|
+
使用 aliyun-dysms 前,您必须已经是阿里云注册用户,申请开通了“阿里云_短信服务
|
7
|
+
”,并且获得了以下关键参数:
|
8
|
+
|
9
|
+
AppCode: 阿里云应用密钥。
|
10
|
+
|
11
|
+
## Installation 安装
|
12
|
+
|
13
|
+
### Ruby 通用安装方法
|
14
|
+
在命令行中输入命令(电脑已经安装 gems 命令行工具)
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
gem install aliyun-dysms
|
18
|
+
```
|
19
|
+
|
20
|
+
### Rails 应用安装方法
|
21
|
+
|
22
|
+
在应用的 Gemfile 文件中添加 Ruby Gems 安装源:
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
gem 'aliyun-dysms' # Ruby Gems 安装源
|
26
|
+
```
|
27
|
+
|
28
|
+
应用的根目录下运行:
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
bundle
|
32
|
+
```
|
33
|
+
|
34
|
+
### 下载后安装
|
35
|
+
|
36
|
+
使用 Git 将代码克隆到本地后使用 Rake 命令安装
|
37
|
+
|
38
|
+
```bash
|
39
|
+
git clone https://github.com/kejincan0527/aliyun-dysms.git
|
40
|
+
|
41
|
+
cd aliyun-dysms
|
42
|
+
|
43
|
+
rake build
|
44
|
+
|
45
|
+
rake install
|
46
|
+
```
|
47
|
+
|
48
|
+
### 安装可能遇到的问题及其解决方式
|
49
|
+
|
50
|
+
安装后,如果在 irb 命令行输入命令
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
require 'aliyun/dysms'
|
54
|
+
```
|
55
|
+
|
56
|
+
后,无法正确获取 Gem 引用,或者在 Rails 启动时报错提示如下:
|
57
|
+
|
58
|
+
> ./config/initializers/aliyun-dysms.rb:1:in `<top (required)>': uninitialized constant Aliyun::Dysms (NameError)
|
59
|
+
|
60
|
+
可以改为 Github 安装源,例如 Rails Gemfile 文件引用可以改为下面格式,即可正确安装。
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
gem 'aliyun-dysms', '0.0.1', git: 'https://github.com/kejincan0527/aliyun-dysms.git'
|
64
|
+
```
|
65
|
+
|
66
|
+
## Usage 使用
|
67
|
+
|
68
|
+
### Ruby 程序通用方法(irb命令行示例)
|
69
|
+
|
70
|
+
#### 第一步:
|
71
|
+
|
72
|
+
```bash
|
73
|
+
$ require 'aliyun/dysms'
|
74
|
+
```
|
75
|
+
|
76
|
+
```bash
|
77
|
+
=> true
|
78
|
+
```
|
79
|
+
|
80
|
+
#### 第二步:
|
81
|
+
|
82
|
+
参数设置:
|
83
|
+
|
84
|
+
```ruby
|
85
|
+
> Aliyun::Dysms.configure do |config|
|
86
|
+
config.access_key_id = ACCESS_KEY_ID # 阿里云应用ID
|
87
|
+
config.access_key_secret = ACCESS_KEY_SECRET # 阿里云应用密钥
|
88
|
+
config.sign_name = SIGN_NAME # 阿里云短信签名
|
89
|
+
end
|
90
|
+
```
|
91
|
+
返回
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
=> "新橙科技"
|
95
|
+
```
|
96
|
+
|
97
|
+
#### 第三步:
|
98
|
+
|
99
|
+
发送短信:
|
100
|
+
|
101
|
+
$ Aliyun::Dysms.send(phone_numbers, template_code, template_param)
|
102
|
+
|
103
|
+
参数说明:
|
104
|
+
|
105
|
+
1. phone_numbers: 接收短信的手机号码。支持对多个手机号码发送短信,手机号码之间以英文逗号(,)分隔;
|
106
|
+
2. template_code: 短信模板ID。请在控制台模板管理页面模板CODE一列查看。
|
107
|
+
3. template_param: 短信模板变量对应的实际值,JSON格式。
|
108
|
+
|
109
|
+
### Rails 应用使用方法
|
110
|
+
|
111
|
+
#### 第一步:
|
112
|
+
|
113
|
+
在 Rails 应用目录 config/initializers/ 下创建脚本文件 aliyun-dysms.rb,在文件中加入以下内容:
|
114
|
+
|
115
|
+
config/initializers/aliyun-dysms.rb
|
116
|
+
|
117
|
+
```ruby
|
118
|
+
Aliyun::Dysms.configure do |config|
|
119
|
+
config.access_key_id = ACCESS_KEY_ID # 阿里云应用ID
|
120
|
+
config.access_key_secret = ACCESS_KEY_SECRET # 阿里云应用密钥
|
121
|
+
config.sign_name = SIGN_NAME # 阿里云短信签名
|
122
|
+
end
|
123
|
+
```
|
124
|
+
之后,重新启动 Rails,加载配置。
|
125
|
+
|
126
|
+
#### 第二步:
|
127
|
+
|
128
|
+
在 Rails 应用中调用短信发送代码:
|
129
|
+
|
130
|
+
```ruby
|
131
|
+
...
|
132
|
+
phone_numbers = "15912345678"
|
133
|
+
template_code = "SMS_176030000"
|
134
|
+
template_param = {code: "1234"}.to_json
|
135
|
+
|
136
|
+
Aliyun::Dysms.send(phone_numbers, template_code, template_param)
|
137
|
+
...
|
138
|
+
```
|
139
|
+
|
140
|
+
## Development 开发
|
141
|
+
|
142
|
+
按照阿里云[阿里云官方接口文档](https://help.aliyun.com/product/44282.html)提供的 SMS 样例做了 spect 测试,可以 clone 项目后,在根目录下用命令行运行以下命令测试:
|
143
|
+
|
144
|
+
$ bundle exec rspec spec
|
145
|
+
|
146
|
+
|
147
|
+
## License 许可
|
148
|
+
|
149
|
+
MIT 协议下的开源项目。 [MIT License](http://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
@@ -0,0 +1,30 @@
|
|
1
|
+
|
2
|
+
lib = File.expand_path("../lib", __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require "aliyun/dysms/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "aliyun-dysms"
|
8
|
+
spec.version = Aliyun::Dysms::VERSION
|
9
|
+
spec.authors = ["Wells Muker"]
|
10
|
+
spec.email = ["wellsmuker@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{A Ruby Gem for using aliyun dysms service.}
|
13
|
+
spec.description = %q{适用于阿里云官方提供的短信服务。}
|
14
|
+
spec.homepage = "https://github.com/kejincan0527/aliyun-dysms"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
# Specify which files should be added to the gem when it is released.
|
18
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
19
|
+
spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
|
20
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
21
|
+
end
|
22
|
+
spec.bindir = "exe"
|
23
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
24
|
+
spec.require_paths = ["lib"]
|
25
|
+
|
26
|
+
spec.add_development_dependency "bundler"
|
27
|
+
spec.add_development_dependency "rake"
|
28
|
+
spec.add_development_dependency "rspec"
|
29
|
+
spec.add_dependency "aliyunsdkcore"
|
30
|
+
end
|
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "aliyun/dysms"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
data/lib/aliyun/dysms.rb
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
require "aliyun/dysms/version"
|
2
|
+
require "aliyunsdkcore"
|
3
|
+
|
4
|
+
module Aliyun
|
5
|
+
module Dysms
|
6
|
+
class Configuration
|
7
|
+
attr_accessor :access_key_id, :access_key_secret, :action,
|
8
|
+
:region_id, :sign_name, :api_version
|
9
|
+
|
10
|
+
def initialize
|
11
|
+
@access_key_id = ""
|
12
|
+
@access_key_secret = ""
|
13
|
+
@sign_name = ""
|
14
|
+
@action = "SendSms"
|
15
|
+
@region_id = "cn-hangzhou"
|
16
|
+
@api_version = "2017-05-25"
|
17
|
+
end
|
18
|
+
end # class Configuration
|
19
|
+
|
20
|
+
class << self
|
21
|
+
attr_writer :configuration
|
22
|
+
|
23
|
+
def configuration
|
24
|
+
@configuration ||= Configuration.new
|
25
|
+
end
|
26
|
+
|
27
|
+
def configure
|
28
|
+
yield(configuration)
|
29
|
+
end
|
30
|
+
|
31
|
+
def send(phone_numbers, template_code, template_param, out_id = "")
|
32
|
+
@response = client.request(
|
33
|
+
action: configuration.action,
|
34
|
+
params: {
|
35
|
+
"RegionId": configuration.region_id,
|
36
|
+
"SignName": configuration.sign_name,
|
37
|
+
"PhoneNumbers": phone_numbers,
|
38
|
+
"TemplateCode": template_code,
|
39
|
+
"TemplateParam": template_param,
|
40
|
+
"OutId": out_id
|
41
|
+
},
|
42
|
+
opts: {
|
43
|
+
method: "POST"
|
44
|
+
}
|
45
|
+
)
|
46
|
+
end
|
47
|
+
|
48
|
+
def client
|
49
|
+
@client ||= RPCClient.new(
|
50
|
+
access_key_id: configuration.access_key_id,
|
51
|
+
access_key_secret: configuration.access_key_secret,
|
52
|
+
api_version: configuration.api_version,
|
53
|
+
endpoint: "https://dysmsapi.aliyuncs.com"
|
54
|
+
)
|
55
|
+
end
|
56
|
+
|
57
|
+
def response
|
58
|
+
@response
|
59
|
+
end
|
60
|
+
end # class << self
|
61
|
+
end # module Dysms
|
62
|
+
end # module Aliyun
|
metadata
ADDED
@@ -0,0 +1,111 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: aliyun-dysms
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Wells Muker
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-10-19 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rspec
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - ">="
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: aliyunsdkcore
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :runtime
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
description: 适用于阿里云官方提供的短信服务。
|
70
|
+
email:
|
71
|
+
- wellsmuker@gmail.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".rspec"
|
78
|
+
- CODE_OF_CONDUCT.md
|
79
|
+
- Gemfile
|
80
|
+
- LICENSE.txt
|
81
|
+
- README.md
|
82
|
+
- Rakefile
|
83
|
+
- aliyun-dysms.gemspec
|
84
|
+
- bin/console
|
85
|
+
- bin/setup
|
86
|
+
- lib/aliyun/dysms.rb
|
87
|
+
- lib/aliyun/dysms/version.rb
|
88
|
+
homepage: https://github.com/kejincan0527/aliyun-dysms
|
89
|
+
licenses:
|
90
|
+
- MIT
|
91
|
+
metadata: {}
|
92
|
+
post_install_message:
|
93
|
+
rdoc_options: []
|
94
|
+
require_paths:
|
95
|
+
- lib
|
96
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
97
|
+
requirements:
|
98
|
+
- - ">="
|
99
|
+
- !ruby/object:Gem::Version
|
100
|
+
version: '0'
|
101
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
102
|
+
requirements:
|
103
|
+
- - ">="
|
104
|
+
- !ruby/object:Gem::Version
|
105
|
+
version: '0'
|
106
|
+
requirements: []
|
107
|
+
rubygems_version: 3.0.1
|
108
|
+
signing_key:
|
109
|
+
specification_version: 4
|
110
|
+
summary: A Ruby Gem for using aliyun dysms service.
|
111
|
+
test_files: []
|