sms_ctrl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b206d958f801d49703d63ca1792cfc8ee61070a2
+  data.tar.gz: a1f8b2d3b9d783c75ac69d02cb20f14a861165af
+SHA512:
+  metadata.gz: 7ae3d537666693570917ec8ce336c33ba66941a04cd4170f101192655bb4d6a88217c188a00835d2c770a9c0e425593ed6d936a5c8185b3563979555ad7f6bc7
+  data.tar.gz: 7ff016e1427398088cb8ad42328ba1f4f6698733e454f89fc3f0ed061d6fa8cadd8d1b66b648bb7336c66b111108f14a9e61e7e67e8c139b03bb760d8e43d323

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 david
+
+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,79 @@
+# 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
+
+```ruby
+# confing/initializes/sms_ctrl.rb
+
+# 设置debug模式，所有验证码都是123456，不会走sender
+
+SmsCtrl.debug = true
+
+# 设置cache，需要支持 read(key), write(key, expires_in: 10)
+# SmsCtrl.cache = Rails.cache
+
+# 注册一个控制模块
+
+SmsCtrl.register( "register_user", {
+  # retry_limit: 55,
+  # expires: 30 * 60,
+  sender: ->(mobile, code, params) {
+    # 发送逻辑
+  }
+})
+
+SmsCtrl.register( "user_reset_password", {
+  # retry_limit: 55,
+  # expires: 30 * 60,
+  sender: ->(mobile, code, params) {
+    # 发送逻辑
+  }
+})
+
+# 发送验证码
+
+SmsCtrl.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.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](https://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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sms_ctrl"
+
+# 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

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/sms_ctrl/case.rb

@@ -0,0 +1,96 @@
+module SmsCtrl
+  class Case
+    attr_accessor :retry_limit, :expires_in,
+      :mobile_regexp, :sender,
+      :errors
+
+    def 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}" },
+      }
+    end
+
+    def default_errors
+      {
+        illegal_mobile: '请输入正确的手机号码',
+        retry_limit: '操作太频繁，请稍后再试'
+      }
+    end
+
+    def initialize name, options = {}
+      @name = name
+      options = default_options.merge(options)
+
+      self.retry_limit   = options[:retry_limit]
+      self.expires_in    = options[:expires_in]
+      self.mobile_regexp = options[:mobile_regexp]
+      self.sender        = options[:sender]
+
+      if options[:errors]
+        self.errors = default_errors.merge(options[:errors])
+      else
+        self.errors = default_errors
+      end
+    end
+
+    def send_sms mobile, code, params = {}
+      mobile = mobile.to_s
+
+      unless mobile =~ mobile_regexp
+        return {
+          success: false,
+          error: errors[:illegal_mobile],
+          error_type: :illegal_mobile
+        }
+      end
+
+      if retry_limit > 0 && SmsCtrl.cache.read(retry_limit_key(mobile))
+        return {
+          success: false,
+          error: errors[:retry_limit],
+          error_type: :retry_limit }
+      end
+
+      if SmsCtrl.debug
+        code = '123456'
+        data = 'debug send ok'
+      else
+        data = @sender.call(mobile, code, params)
+      end
+
+      result = {
+        success: true,
+        data: data
+      }
+
+      if retry_limit > 0
+        SmsCtrl.cache.write(retry_limit_key(mobile), 'true', expires_in: retry_limit)
+      end
+
+      SmsCtrl.cache.write(code_cache_key(mobile), code, expires_in: expires_in)
+
+      result
+    end
+
+    # check match
+    def check_code mobile, code
+      cache_code = SmsCtrl.cache.read(code_cache_key(mobile.to_s))
+      return false if cache_code.nil?
+      cache_code.to_s == code.to_s
+    end
+
+    private
+
+    # keys
+    def retry_limit_key mobile
+      "sms_ctrl:#{@name}:retry_limit_key:#{mobile}"
+    end
+
+    def code_cache_key mobile
+      "sms_ctrl:#{@name}:code_cache_key:#{mobile}"
+    end
+  end
+end

data/lib/sms_ctrl/version.rb

@@ -0,0 +1,3 @@
+module SmsCtrl
+  VERSION = "0.1.0"
+end

data/lib/sms_ctrl.rb

@@ -0,0 +1,55 @@
+require "sms_ctrl/version"
+require "sms_ctrl/case"
+
+module SmsCtrl
+  @debug_code = '123456'
+  @cases = {}
+
+  class << self
+    attr_accessor :debug, :cache
+
+    # 非线程安全，只应该用在单线程环境中配置，例如rails加载
+    def register name, options
+      name = name.to_s
+
+      new_case = SmsCtrl::Case.new(name, options)
+      @cases[name] = new_case
+
+      @default_case = new_case if @cases.size == 1
+    end
+
+    def clear
+      @cases = {}
+    end
+
+    def get name
+      @cases[name.to_s]
+    end
+
+    alias [] get
+
+    def set_default c
+      @default_case = @cases[c.to_s]
+    end
+
+    def default
+      @default_case
+    end
+
+    def send_sms *args
+      if @default_case
+        @default_case.send_sms(*args)
+      else
+        raise 'no default case'
+      end
+    end
+
+    def check_code *args
+      if @default_case
+        @default_case.check_code(*args)
+      else
+        raise 'no default case'
+      end
+    end
+  end
+end

data/sms_ctrl.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sms_ctrl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sms_ctrl"
+  spec.version       = SmsCtrl::VERSION
+  spec.authors       = ["david"]
+  spec.email         = ["davidqhr@gmail.com"]
+
+  spec.summary       = %q{短信重试、请求次数控制、短信验证码缓存}
+  spec.description   = %q{配置多个短信发送场景，每个场景可以设置短信过期时间，重试时间，正则规则，错误信息，发送规则。本gem中不包含发送短信的sdk，请根据需求配置。}
+  spec.homepage      = "https://github.com/davidqhr/sms_ctrl"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "timecop", '~> 0'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: sms_ctrl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- david
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 配置多个短信发送场景，每个场景可以设置短信过期时间，重试时间，正则规则，错误信息，发送规则。本gem中不包含发送短信的sdk，请根据需求配置。
+email:
+- davidqhr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sms_ctrl.rb
+- lib/sms_ctrl/case.rb
+- lib/sms_ctrl/version.rb
+- sms_ctrl.gemspec
+homepage: https://github.com/davidqhr/sms_ctrl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: 短信重试、请求次数控制、短信验证码缓存
+test_files: []