SmsCtrl

发送短信，间隔限制，过期控制

Installation

Add this line to your application's Gemfile:

gem 'sms_ctrl'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sms_ctrl

Usage

# confing/initializes/sms_ctrl.rb

# 设置debug模式，调用send_sms后，不会执行真正的sender，可以直接使用123456当作验证码
SmsCtrl.debug = true

# 设置cache，需要支持 read(key), write(key, expires_in: 10)
SmsCtrl.cache = Rails.cache

# 设置默认配置，可以在case配置中覆盖
SmsCtrl.default_options = {
  retry_limit: 55,
  expires_in: 30 * 60,
  mobile_regexp: /^1[3|4|5|7|8]\d{9}$/,
  sender: -> (mobile, code, params) { warn "No message sender set for case #{@name}" },
}

# 设置默认错误，可以在case配置中覆盖
SmsCtrl.default_errors = {
  illegal_mobile: '请输入正确的手机号码',
  retry_limit: '操作太频繁，请稍后再试'
}

# 注册控制模块
SmsCtrl.register( "register_user", {
  # retry_limit: 55,
  # expires_in: 30 * 60,
  sender: ->(mobile, code, params) {
    # 发送逻辑
  }
})

SmsCtrl.register( "user_reset_password", {
  # retry_limit: 55,
  # expires_in: 30 * 60,
  sender: ->(mobile, code, params) {
    # 发送逻辑
  }
})

# 发送验证码
SmsCtrl["register_user"].send_sms(mobile, code, params)
SmsCtrl["user_reset_password"].send_sms(mobile, code, params)

# 检查验证码是否匹配
SmsCtrl["register_user"].check_code "13000000000", '231232'
SmsCtrl["user_reset_password"].check_code "13000000000", '231232'

# 设置默认
SmsCtrl.set_default("register_user")
SmsCtrl.send_sms(mobile, code, params)
SmsCtrl.check_code "13000000000", '231232'

Development

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.

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/davidqhr/sms_ctrl.

License

The gem is available as open source under the terms of the MIT License.