sms_ctrl 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +10 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +79 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/sms_ctrl/case.rb +96 -0
- data/lib/sms_ctrl/version.rb +3 -0
- data/lib/sms_ctrl.rb +55 -0
- data/sms_ctrl.gemspec +26 -0
- metadata +113 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b206d958f801d49703d63ca1792cfc8ee61070a2
|
4
|
+
data.tar.gz: a1f8b2d3b9d783c75ac69d02cb20f14a861165af
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7ae3d537666693570917ec8ce336c33ba66941a04cd4170f101192655bb4d6a88217c188a00835d2c770a9c0e425593ed6d936a5c8185b3563979555ad7f6bc7
|
7
|
+
data.tar.gz: 7ff016e1427398088cb8ad42328ba1f4f6698733e454f89fc3f0ed061d6fa8cadd8d1b66b648bb7336c66b111108f14a9e61e7e67e8c139b03bb760d8e43d323
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 david
|
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,79 @@
|
|
1
|
+
# SmsCtrl
|
2
|
+
|
3
|
+
发送短信,间隔限制,过期控制
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
|
10
|
+
gem 'sms_ctrl'
|
11
|
+
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install sms_ctrl
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
# confing/initializes/sms_ctrl.rb
|
25
|
+
|
26
|
+
# 设置debug模式,所有验证码都是123456,不会走sender
|
27
|
+
|
28
|
+
SmsCtrl.debug = true
|
29
|
+
|
30
|
+
# 设置cache,需要支持 read(key), write(key, expires_in: 10)
|
31
|
+
# SmsCtrl.cache = Rails.cache
|
32
|
+
|
33
|
+
# 注册一个控制模块
|
34
|
+
|
35
|
+
SmsCtrl.register( "register_user", {
|
36
|
+
# retry_limit: 55,
|
37
|
+
# expires: 30 * 60,
|
38
|
+
sender: ->(mobile, code, params) {
|
39
|
+
# 发送逻辑
|
40
|
+
}
|
41
|
+
})
|
42
|
+
|
43
|
+
SmsCtrl.register( "user_reset_password", {
|
44
|
+
# retry_limit: 55,
|
45
|
+
# expires: 30 * 60,
|
46
|
+
sender: ->(mobile, code, params) {
|
47
|
+
# 发送逻辑
|
48
|
+
}
|
49
|
+
})
|
50
|
+
|
51
|
+
# 发送验证码
|
52
|
+
|
53
|
+
SmsCtrl.send_sms(mobile, code, params)
|
54
|
+
|
55
|
+
# 检查验证码是否匹配
|
56
|
+
|
57
|
+
SmsCtrl["register_user"].check_code "13000000000", '231232'
|
58
|
+
SmsCtrl["user_reset_password"].check_code "13000000000", '231232'
|
59
|
+
|
60
|
+
# SmsCtrl.set_default("register_user")
|
61
|
+
# SmsCtrl.check_code "13000000000", '231232'
|
62
|
+
|
63
|
+
```
|
64
|
+
|
65
|
+
## Development
|
66
|
+
|
67
|
+
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.
|
68
|
+
|
69
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
70
|
+
|
71
|
+
## Contributing
|
72
|
+
|
73
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/davidqhr/sms_ctrl.
|
74
|
+
|
75
|
+
|
76
|
+
## License
|
77
|
+
|
78
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
79
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "sms_ctrl"
|
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
|
data/bin/setup
ADDED
@@ -0,0 +1,96 @@
|
|
1
|
+
module SmsCtrl
|
2
|
+
class Case
|
3
|
+
attr_accessor :retry_limit, :expires_in,
|
4
|
+
:mobile_regexp, :sender,
|
5
|
+
:errors
|
6
|
+
|
7
|
+
def default_options
|
8
|
+
{
|
9
|
+
retry_limit: 55,
|
10
|
+
expires_in: 30 * 60,
|
11
|
+
mobile_regexp: /^1[3|4|5|7|8]\d{9}$/,
|
12
|
+
sender: -> (mobile, code, params) { warn "No message sender set for case #{@name}" },
|
13
|
+
}
|
14
|
+
end
|
15
|
+
|
16
|
+
def default_errors
|
17
|
+
{
|
18
|
+
illegal_mobile: '请输入正确的手机号码',
|
19
|
+
retry_limit: '操作太频繁,请稍后再试'
|
20
|
+
}
|
21
|
+
end
|
22
|
+
|
23
|
+
def initialize name, options = {}
|
24
|
+
@name = name
|
25
|
+
options = default_options.merge(options)
|
26
|
+
|
27
|
+
self.retry_limit = options[:retry_limit]
|
28
|
+
self.expires_in = options[:expires_in]
|
29
|
+
self.mobile_regexp = options[:mobile_regexp]
|
30
|
+
self.sender = options[:sender]
|
31
|
+
|
32
|
+
if options[:errors]
|
33
|
+
self.errors = default_errors.merge(options[:errors])
|
34
|
+
else
|
35
|
+
self.errors = default_errors
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
def send_sms mobile, code, params = {}
|
40
|
+
mobile = mobile.to_s
|
41
|
+
|
42
|
+
unless mobile =~ mobile_regexp
|
43
|
+
return {
|
44
|
+
success: false,
|
45
|
+
error: errors[:illegal_mobile],
|
46
|
+
error_type: :illegal_mobile
|
47
|
+
}
|
48
|
+
end
|
49
|
+
|
50
|
+
if retry_limit > 0 && SmsCtrl.cache.read(retry_limit_key(mobile))
|
51
|
+
return {
|
52
|
+
success: false,
|
53
|
+
error: errors[:retry_limit],
|
54
|
+
error_type: :retry_limit }
|
55
|
+
end
|
56
|
+
|
57
|
+
if SmsCtrl.debug
|
58
|
+
code = '123456'
|
59
|
+
data = 'debug send ok'
|
60
|
+
else
|
61
|
+
data = @sender.call(mobile, code, params)
|
62
|
+
end
|
63
|
+
|
64
|
+
result = {
|
65
|
+
success: true,
|
66
|
+
data: data
|
67
|
+
}
|
68
|
+
|
69
|
+
if retry_limit > 0
|
70
|
+
SmsCtrl.cache.write(retry_limit_key(mobile), 'true', expires_in: retry_limit)
|
71
|
+
end
|
72
|
+
|
73
|
+
SmsCtrl.cache.write(code_cache_key(mobile), code, expires_in: expires_in)
|
74
|
+
|
75
|
+
result
|
76
|
+
end
|
77
|
+
|
78
|
+
# check match
|
79
|
+
def check_code mobile, code
|
80
|
+
cache_code = SmsCtrl.cache.read(code_cache_key(mobile.to_s))
|
81
|
+
return false if cache_code.nil?
|
82
|
+
cache_code.to_s == code.to_s
|
83
|
+
end
|
84
|
+
|
85
|
+
private
|
86
|
+
|
87
|
+
# keys
|
88
|
+
def retry_limit_key mobile
|
89
|
+
"sms_ctrl:#{@name}:retry_limit_key:#{mobile}"
|
90
|
+
end
|
91
|
+
|
92
|
+
def code_cache_key mobile
|
93
|
+
"sms_ctrl:#{@name}:code_cache_key:#{mobile}"
|
94
|
+
end
|
95
|
+
end
|
96
|
+
end
|
data/lib/sms_ctrl.rb
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
require "sms_ctrl/version"
|
2
|
+
require "sms_ctrl/case"
|
3
|
+
|
4
|
+
module SmsCtrl
|
5
|
+
@debug_code = '123456'
|
6
|
+
@cases = {}
|
7
|
+
|
8
|
+
class << self
|
9
|
+
attr_accessor :debug, :cache
|
10
|
+
|
11
|
+
# 非线程安全,只应该用在单线程环境中配置,例如rails加载
|
12
|
+
def register name, options
|
13
|
+
name = name.to_s
|
14
|
+
|
15
|
+
new_case = SmsCtrl::Case.new(name, options)
|
16
|
+
@cases[name] = new_case
|
17
|
+
|
18
|
+
@default_case = new_case if @cases.size == 1
|
19
|
+
end
|
20
|
+
|
21
|
+
def clear
|
22
|
+
@cases = {}
|
23
|
+
end
|
24
|
+
|
25
|
+
def get name
|
26
|
+
@cases[name.to_s]
|
27
|
+
end
|
28
|
+
|
29
|
+
alias [] get
|
30
|
+
|
31
|
+
def set_default c
|
32
|
+
@default_case = @cases[c.to_s]
|
33
|
+
end
|
34
|
+
|
35
|
+
def default
|
36
|
+
@default_case
|
37
|
+
end
|
38
|
+
|
39
|
+
def send_sms *args
|
40
|
+
if @default_case
|
41
|
+
@default_case.send_sms(*args)
|
42
|
+
else
|
43
|
+
raise 'no default case'
|
44
|
+
end
|
45
|
+
end
|
46
|
+
|
47
|
+
def check_code *args
|
48
|
+
if @default_case
|
49
|
+
@default_case.check_code(*args)
|
50
|
+
else
|
51
|
+
raise 'no default case'
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
data/sms_ctrl.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'sms_ctrl/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "sms_ctrl"
|
8
|
+
spec.version = SmsCtrl::VERSION
|
9
|
+
spec.authors = ["david"]
|
10
|
+
spec.email = ["davidqhr@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{短信重试、请求次数控制、短信验证码缓存}
|
13
|
+
spec.description = %q{配置多个短信发送场景,每个场景可以设置短信过期时间,重试时间,正则规则,错误信息,发送规则。本gem中不包含发送短信的sdk,请根据需求配置。}
|
14
|
+
spec.homepage = "https://github.com/davidqhr/sms_ctrl"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
18
|
+
spec.bindir = "exe"
|
19
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
20
|
+
spec.require_paths = ["lib"]
|
21
|
+
|
22
|
+
spec.add_development_dependency "bundler", "~> 1.12"
|
23
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
24
|
+
spec.add_development_dependency "rspec", "~> 3.0"
|
25
|
+
spec.add_development_dependency "timecop", '~> 0'
|
26
|
+
end
|
metadata
ADDED
@@ -0,0 +1,113 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: sms_ctrl
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- david
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-08-05 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: '1.12'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.12'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.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: '3.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '3.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: timecop
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
description: 配置多个短信发送场景,每个场景可以设置短信过期时间,重试时间,正则规则,错误信息,发送规则。本gem中不包含发送短信的sdk,请根据需求配置。
|
70
|
+
email:
|
71
|
+
- davidqhr@gmail.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".rspec"
|
78
|
+
- ".travis.yml"
|
79
|
+
- Gemfile
|
80
|
+
- LICENSE.txt
|
81
|
+
- README.md
|
82
|
+
- Rakefile
|
83
|
+
- bin/console
|
84
|
+
- bin/setup
|
85
|
+
- lib/sms_ctrl.rb
|
86
|
+
- lib/sms_ctrl/case.rb
|
87
|
+
- lib/sms_ctrl/version.rb
|
88
|
+
- sms_ctrl.gemspec
|
89
|
+
homepage: https://github.com/davidqhr/sms_ctrl
|
90
|
+
licenses:
|
91
|
+
- MIT
|
92
|
+
metadata: {}
|
93
|
+
post_install_message:
|
94
|
+
rdoc_options: []
|
95
|
+
require_paths:
|
96
|
+
- lib
|
97
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
98
|
+
requirements:
|
99
|
+
- - ">="
|
100
|
+
- !ruby/object:Gem::Version
|
101
|
+
version: '0'
|
102
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
103
|
+
requirements:
|
104
|
+
- - ">="
|
105
|
+
- !ruby/object:Gem::Version
|
106
|
+
version: '0'
|
107
|
+
requirements: []
|
108
|
+
rubyforge_project:
|
109
|
+
rubygems_version: 2.5.1
|
110
|
+
signing_key:
|
111
|
+
specification_version: 4
|
112
|
+
summary: 短信重试、请求次数控制、短信验证码缓存
|
113
|
+
test_files: []
|