dingxin-sms 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 +145 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/dingxin-sms.gemspec +30 -0
- data/lib/dingxin/sms.rb +64 -0
- data/lib/dingxin/sms/version.rb +5 -0
- metadata +111 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 71eadaf01c5a9ab48cea43ba0c546329079cad30ccf8e6f411e955672a83dc28
|
4
|
+
data.tar.gz: 35c6246ba4b89fec3f51e2c4342e0f9a481a431197ec46fe0e94ea3a95a84296
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: fabc3c2eea30d505b0d357e2cf94d63547b6f67f75b27c89cc40d556e27badc0eede5f499dc951a40841498695f04b6f156f0881df595cb8a6ed59391b380147
|
7
|
+
data.tar.gz: f3d11077a7ae102e8d0e5163105d4c699dc866a0d06bdc8a6673dade4cbece4f23f24cd651474025d01a57f8b9d1cf3d2d488b568dc829a8d76488aa96fbf570
|
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,145 @@
|
|
1
|
+
# Dingxin::Sms
|
2
|
+
### 鼎信科技-短信通知服务 Ruby Gem dingxin-sms
|
3
|
+
|
4
|
+
## 使用前提
|
5
|
+
|
6
|
+
使用 dingxin-sms 前,您必须已经是阿里云注册用户,申请开通了“鼎信科技_短信通知API服务
|
7
|
+
”,并且获得了以下关键参数:
|
8
|
+
|
9
|
+
AppCode: 阿里云应用密钥。
|
10
|
+
|
11
|
+
## Installation 安装
|
12
|
+
|
13
|
+
### Ruby 通用安装方法
|
14
|
+
在命令行中输入命令(电脑已经安装 gems 命令行工具)
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
gem install dingxin-sms
|
18
|
+
```
|
19
|
+
|
20
|
+
### Rails 应用安装方法
|
21
|
+
|
22
|
+
在应用的 Gemfile 文件中添加 Ruby Gems 安装源:
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
gem 'dingxin-sms' # 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/dingxin-sms.git
|
40
|
+
|
41
|
+
cd dingxin-sms
|
42
|
+
|
43
|
+
rake build
|
44
|
+
|
45
|
+
rake install
|
46
|
+
```
|
47
|
+
|
48
|
+
### 安装可能遇到的问题及其解决方式
|
49
|
+
|
50
|
+
安装后,如果在 irb 命令行输入命令
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
require 'dingxin/sms'
|
54
|
+
```
|
55
|
+
|
56
|
+
后,无法正确获取 Gem 引用,或者在 Rails 启动时报错提示如下:
|
57
|
+
|
58
|
+
> ./config/initializers/dingxin-sms.rb:1:in `<top (required)>': uninitialized constant Dingxin::Sms (NameError)
|
59
|
+
|
60
|
+
可以改为 Github 安装源,例如 Rails Gemfile 文件引用可以改为下面格式,即可正确安装。
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
gem 'dingxin-sms', '0.0.1', git: 'https://github.com/kejincan0527/dingxin-sms.git'
|
64
|
+
```
|
65
|
+
|
66
|
+
## Usage 使用
|
67
|
+
|
68
|
+
### Ruby 程序通用方法(irb命令行示例)
|
69
|
+
|
70
|
+
#### 第一步:
|
71
|
+
|
72
|
+
```bash
|
73
|
+
$ require 'dingxin/sms'
|
74
|
+
```
|
75
|
+
|
76
|
+
```bash
|
77
|
+
=> true
|
78
|
+
```
|
79
|
+
|
80
|
+
#### 第二步:
|
81
|
+
|
82
|
+
参数设置:
|
83
|
+
|
84
|
+
```ruby
|
85
|
+
> Dingxin::Sms.configure do |config|
|
86
|
+
config.app_code = APP_CODE # 阿里云应用密钥,在阿里云控制台获取
|
87
|
+
end
|
88
|
+
|
89
|
+
```
|
90
|
+
返回
|
91
|
+
|
92
|
+
```ruby
|
93
|
+
=> "67hbft5iouyhnjkio975rfh"
|
94
|
+
```
|
95
|
+
|
96
|
+
#### 第三步:
|
97
|
+
|
98
|
+
发送短信:
|
99
|
+
|
100
|
+
$ Dingxin::Sms.send(mobile, tpl_id, param)
|
101
|
+
|
102
|
+
参数说明:
|
103
|
+
|
104
|
+
1. mobile: 接收短信的手机号,必须为字符型,例如 '057112345678';
|
105
|
+
2. tpl\_id: 短信模板id,必须为字符型,联系客服人员申请;
|
106
|
+
3. param: 请求字符串,向短信模版提供参数,例如 'asin:B01E7LLKT2';
|
107
|
+
|
108
|
+
### Rails 应用使用方法
|
109
|
+
|
110
|
+
#### 第一步:
|
111
|
+
|
112
|
+
在 Rails 应用目录 config/initializers/ 下创建脚本文件 dingxin-sms.rb,在文件中加入以下内容:
|
113
|
+
|
114
|
+
config/initializers/dingxin-sms.rb
|
115
|
+
|
116
|
+
```ruby
|
117
|
+
Dingxin::Sms.configure do |config|
|
118
|
+
config.app_code = APP_CODE # 阿里云应用密钥,在阿里云控制台获取
|
119
|
+
end
|
120
|
+
```
|
121
|
+
之后,重新启动 Rails,加载配置。
|
122
|
+
|
123
|
+
#### 第二步:
|
124
|
+
|
125
|
+
在 Rails 应用中调用短信发送代码:
|
126
|
+
|
127
|
+
```ruby
|
128
|
+
...
|
129
|
+
mobile = '15912345678'
|
130
|
+
tpl_id = 'TP1711063'
|
131
|
+
param = 'asin:B01E7LLKT2'
|
132
|
+
Dingxin::Sms.send(mobile, tpl_id, param)
|
133
|
+
...
|
134
|
+
```
|
135
|
+
|
136
|
+
## Development 开发
|
137
|
+
|
138
|
+
按照阿里云市场[鼎信科技官方接口文档](https://market.aliyun.com/products/56928004/cmapi023305.html)提供的 SMS 样例做了 spect 测试,可以 clone 项目后,在根目录下用命令行运行以下命令测试:
|
139
|
+
|
140
|
+
$ bundle exec rspec spec
|
141
|
+
|
142
|
+
|
143
|
+
## License 许可
|
144
|
+
|
145
|
+
MIT 协议下的开源项目。 [MIT License](http://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "dingxin/sms"
|
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/dingxin-sms.gemspec
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 "dingxin/sms/version"
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "dingxin-sms"
|
8
|
+
spec.version = Dingxin::Sms::VERSION
|
9
|
+
spec.authors = ["Wells Muker"]
|
10
|
+
spec.email = ["wellsmuker@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{A Ruby Gem for using dingxin sms service.}
|
13
|
+
spec.description = %q{适用于鼎信科技提供的短信通知API服务。}
|
14
|
+
spec.homepage = "https://github.com/kejincan0527/dingxin-sms"
|
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 "typhoeus"
|
30
|
+
end
|
data/lib/dingxin/sms.rb
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
require "dingxin/sms/version"
|
2
|
+
require "openssl"
|
3
|
+
require "typhoeus"
|
4
|
+
require "erb"
|
5
|
+
|
6
|
+
include ERB::Util
|
7
|
+
|
8
|
+
module Dingxin
|
9
|
+
module Sms
|
10
|
+
class Configuration
|
11
|
+
attr_accessor :app_code
|
12
|
+
|
13
|
+
def initialize
|
14
|
+
@app_code = ''
|
15
|
+
end
|
16
|
+
end # class Configuration
|
17
|
+
|
18
|
+
class << self
|
19
|
+
attr_writer :configuration
|
20
|
+
|
21
|
+
def configuration
|
22
|
+
@configuration ||= Configuration.new
|
23
|
+
end
|
24
|
+
|
25
|
+
def configure
|
26
|
+
yield(configuration)
|
27
|
+
end
|
28
|
+
|
29
|
+
def send(mobile, tpl_id, param)
|
30
|
+
Typhoeus.post(get_url({
|
31
|
+
'mobile' => mobile,
|
32
|
+
'tpl_id' => tpl_id,
|
33
|
+
'param' => param
|
34
|
+
}),
|
35
|
+
headers: { "Authorization" => "APPCODE #{configuration.app_code}" })
|
36
|
+
end
|
37
|
+
|
38
|
+
def get_url(params)
|
39
|
+
coded_params = canonicalized_query_string(params)
|
40
|
+
url = 'http://dingxin.market.alicloudapi.com/dx/sendSms?' + coded_params
|
41
|
+
end
|
42
|
+
|
43
|
+
# 对字符串进行 PERCENT 编码
|
44
|
+
# https://apidock.com/ruby/ERB/Util/url_encode
|
45
|
+
def encode(input)
|
46
|
+
output = url_encode(input)
|
47
|
+
end
|
48
|
+
|
49
|
+
# 规范化参数
|
50
|
+
def canonicalized_query_string(params)
|
51
|
+
cqstring = ''
|
52
|
+
params.sort_by{|key, val| key}.each do |key, value|
|
53
|
+
if cqstring.empty?
|
54
|
+
cqstring += "#{encode(key)}=#{encode(value)}"
|
55
|
+
else
|
56
|
+
cqstring += "&#{encode(key)}=#{encode(value)}"
|
57
|
+
end
|
58
|
+
end
|
59
|
+
cqstring
|
60
|
+
end
|
61
|
+
|
62
|
+
end # class << self
|
63
|
+
end # module Sms
|
64
|
+
end # module Dingxin
|
metadata
ADDED
@@ -0,0 +1,111 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: dingxin-sms
|
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-03-22 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: typhoeus
|
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: 适用于鼎信科技提供的短信通知API服务。
|
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
|
+
- bin/console
|
84
|
+
- bin/setup
|
85
|
+
- dingxin-sms.gemspec
|
86
|
+
- lib/dingxin/sms.rb
|
87
|
+
- lib/dingxin/sms/version.rb
|
88
|
+
homepage: https://github.com/kejincan0527/dingxin-sms
|
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 dingxin sms service.
|
111
|
+
test_files: []
|