yx-smart_sms 0.1.2

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: 'spec:all'

data/lib/generators/smart_sms/config_generator.rb

@@ -0,0 +1,16 @@
+module SmartSms
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      desc <<-DESC
+Description:
+    Copies SmartSMS configuration file to your application's initializer directory.
+DESC
+
+      def copy_config_file
+        template 'smart_sms_config.rb', 'config/initializers/smart_sms_config.rb'
+      end
+    end
+  end
+end

data/lib/generators/smart_sms/install_generator.rb

@@ -0,0 +1,36 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module SmartSms
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+    desc <<-EOF
+Generates (but does not run) a migration to add a messages table.
+You need to set `store_sms_in_local` to `true` in your config file
+before running this command
+  EOF
+
+    def create_migration_file
+      return unless SmartSMS.config.store_sms_in_local
+      add_smart_sms_migration('create_smart_sms_messages')
+      add_smart_sms_migration('add_uid_to_smart_sms_messages')
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    protected
+
+    def add_smart_sms_migration(template)
+      migration_dir = File.expand_path('db/migrate')
+
+      unless self.class.migration_exists?(migration_dir, template)
+        migration_template "#{template}.rb", "db/migrate/#{template}.rb"
+      end
+    end
+  end
+end

data/lib/generators/smart_sms/templates/add_uid_to_smart_sms_messages.rb

@@ -0,0 +1,6 @@
+class AddUidToSmartSmsMessages < ActiveRecord::Migration
+  def change
+    add_column :smart_sms_messages, :uid, :string
+    add_index :smart_sms_messages, :uid
+  end
+end

data/lib/generators/smart_sms/templates/create_smart_sms_messages.rb

@@ -0,0 +1,19 @@
+class CreateSmartSmsMessages < ActiveRecord::Migration
+  def change
+    create_table :smart_sms_messages do |t|
+      t.string :sid
+      t.string :mobile
+      t.datetime :send_time
+      t.text :text
+      t.string :code
+      t.string :send_status
+      t.string :report_status
+      t.string :fee
+      t.datetime :user_receive_time
+      t.text :error_msg
+      t.belongs_to :smsable, polymorphic: true
+    end
+    add_index :smart_sms_messages, :sid
+    add_index :smart_sms_messages, [:smsable_id, :smsable_type]
+  end
+end

data/lib/generators/smart_sms/templates/smart_sms_config.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+SmartSMS.configure do |config|
+  # config.api_key = nil
+  # config.api_version = :v1
+  # config.template_id = '2'
+  # config.template_value = [:code, :company]
+  # config.page_num = 1
+  # config.page_size = 20
+  # config.company = '云片网'
+  # config.expires_in = 1.hour
+  # config.default_interval = 1.day
+  # config.store_sms_in_local = false
+  # config.verification_code_algorithm = :simple
+end

data/lib/smart_sms.rb

@@ -0,0 +1,35 @@
+require 'smart_sms/config'
+require 'smart_sms/request'
+require 'smart_sms/template'
+require 'smart_sms/helpers/fake_sms'
+require 'smart_sms/helpers/verification_code'
+require 'smart_sms/message_service'
+require 'smart_sms/account'
+
+unless defined? ActiveRecord
+  begin
+    require 'active_record'
+  rescue LoadError; end
+end
+
+module SmartSMS
+  include SmartSMS::MessageService
+
+  def self.active_record_protected_attributes?
+    @active_record_protected_attributes ||= ::ActiveRecord::VERSION::MAJOR < 4 || !!defined?(ProtectedAttributes)
+  end
+end
+
+# Ensure `ProtectedAttributes` gem gets required if it is available before the `Message` class gets loaded in
+unless SmartSMS.active_record_protected_attributes?
+  SmartSMS.send(:remove_instance_variable, :@active_record_protected_attributes)
+  begin
+    require 'protected_attributes'
+  rescue LoadError; end # will rescue if `ProtectedAttributes` gem is not available
+end
+
+require 'smart_sms/has_sms_verification'
+
+ActiveSupport.on_load(:active_record) do
+  include SmartSMS::HasSmsVerification
+end

data/lib/smart_sms/account.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module SmartSMS
+  # Module that handle user information
+  #
+  module Account
+    module_function
+
+    # 获取用户信息
+    #
+    def info
+      Request.post 'user/get.json'
+    end
+
+    # 设置用户信息
+    #
+    #   * emergency_contact: 紧急联系人
+    #   * emergency_mobile:  紧急联系人手机号
+    #   * alarm_balance:     短信余额提醒阈值。一天只提示一次
+    #
+    def set(options = {})
+      Request.post 'user/set.json', options
+    end
+  end
+end

data/lib/smart_sms/config.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+require 'active_support/configurable'
+require 'active_support/core_ext'
+
+module SmartSMS
+  # Configures global settings for SmartSMS
+  #   SmartSMS.configure do |config|
+  #     config.api_key = 'd63124354422b046081a44466'
+  #   end
+  def self.configure(&block)
+    yield @config ||= SmartSMS::Configuration.new
+  end
+
+  # Global settings for SmartSMS
+  def self.config
+    @config
+  end
+
+  # Configuration class
+  #
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    config_accessor :api_key                     # 授权 API KEY
+    config_accessor :api_version                 # API 的版本, 当前仅有v1
+    config_accessor :template_id                 # 指定发送信息时使用的模板
+    config_accessor :template_value              # 用于指定信息文本中的可替换内容, 数组形势: [:code, :company]
+    config_accessor :page_num                    # 获取信息时, 指定默认的页数
+    config_accessor :page_size                   # 获取信息时, 一页包含信息数量
+    config_accessor :company                     # 默认公司名称
+    config_accessor :expires_in                  # 短信验证过期时间
+    config_accessor :default_interval            # 查询短信时的默认时间段: end_time - start_time
+    config_accessor :store_sms_in_local          # 是否存储SMS信息在本地: true or false
+    config_accessor :verification_code_algorithm # :simple, :middle, :complex
+  end
+
+  configure do |config|
+    config.api_key                     = nil
+    config.api_version                 = :v1
+    config.template_id                 = '2'
+    config.template_value              = [:code, :company]
+    config.page_num                    = 1
+    config.page_size                   = 20
+    config.company                     = '云片网'
+    config.expires_in                  = 1.hour
+    config.default_interval            = 1.day
+    config.store_sms_in_local          = false
+    config.verification_code_algorithm = :simple
+  end
+end

data/lib/smart_sms/has_sms_verification.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+require File.expand_path(File.join(File.dirname(__FILE__), 'model/message'))
+
+module SmartSMS
+  # Module that will be hooked into ActiveRecord to provide magic methods
+  #
+  module HasSmsVerification
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    # Class methods that will be extended
+    module ClassMethods
+
+      # 在您的Model里面声明这个方法, 以添加SMS短信验证功能
+      #
+      # * moible_column:       mobile 绑定的字段, 用于发送短信, 默认 :phone
+      # * verification_column: 验证绑定的字段, 用于判断是否已验证, 默认 :verified_at
+      #
+      # Options:
+      #   * :class_name   自定义的Message类名称. 默认是 `::SmartSMS::Message`
+      #   * :messages     自定义的Message关联名称.  默认是 `:messages`.
+      #
+      def has_sms_verification(moible_column = :phone, verification_column = :verified_at, options = {})
+        send :include, InstanceMethods
+
+        # 用于判断是否已经验证的字段, Datetime 类型, 例如 :verified_at
+        class_attribute :sms_verification_column
+        self.sms_verification_column = verification_column
+
+        class_attribute :sms_mobile_column
+        self.sms_mobile_column = moible_column
+
+        class_attribute :verify_regexp
+        self.verify_regexp = /(【.+】|[^a-zA-Z0-9\.\-\+_])/ # 用于抽取校验码, 如若修改过模板, 可能需要修改这个这正则
+
+        if SmartSMS.config.store_sms_in_local
+
+          class_attribute :messages_association_name
+          self.messages_association_name = options[:messages] || :messages
+
+          class_attribute :message_class_name
+          self.message_class_name = options[:class_name] || '::SmartSMS::Message'
+
+          if ::ActiveRecord::VERSION::MAJOR >= 4 # Rails 4 的 `has_many` 中定义order lambda的新语法
+            has_many messages_association_name,
+              -> { order('send_time ASC') },
+              class_name: message_class_name,
+              as:         :smsable
+          else
+            has_many messages_association_name,
+              class_name: message_class_name,
+              as:         :smsable,
+              order:      'send_time ASC'
+          end
+
+        end
+      end
+
+      # Instance methods
+      #
+      module InstanceMethods
+        # 非安全verify!方法, 验证成功后会存储成功的结果到数据表中
+        #
+        def verify!(code)
+          result = verify code
+          if result
+            send("#{self.class.sms_verification_column}=", Time.now)
+            save(validate: false)
+          end
+        end
+
+        # 安全verify方法, 用于校验短信验证码是否正确, 返回: true 或 false
+        #
+        def verify(code)
+          sms = latest_message
+          return false if sms.blank?
+          if SmartSMS.config.store_sms_in_local
+            sms.code == code.to_s
+          else
+            sms['text'].gsub(self.class.verify_regexp, '') == code.to_s
+          end
+        end
+
+        # 判断是否已经验证成功
+        #
+        def verified?
+          verified_at.present?
+        end
+
+        def verified_at
+          self[self.class.sms_verification_column]
+        end
+
+        # 获取最新的一条有效短信记录
+        #
+        def latest_message
+          end_time = Time.now
+          start_time = end_time - SmartSMS.config.expires_in
+          if SmartSMS.config.store_sms_in_local
+            send(self.class.messages_association_name)
+              .where('send_time >= ? and send_time <= ?', start_time, end_time)
+              .last
+          else
+            result = SmartSMS.find(
+              start_time: start_time,
+              end_time: end_time,
+              mobile: send(self.class.sms_mobile_column),
+              page_size: 1
+            )
+            result['sms'].first
+          end
+        end
+
+        # 发送短信至手机
+        #
+        def deliver(text = SmartSMS::VerificationCode.random)
+          result = SmartSMS.deliver send(self.class.sms_mobile_column), text
+          if result['code'] == 0
+            sms = SmartSMS.find_by_sid(result['result']['sid'])['sms']
+            save_or_return_message sms, text
+          else
+            errors.add :deliver, result
+            false
+          end
+        end
+
+        def deliver_fake_sms(text = SmartSMS::VerificationCode.random)
+          mobile = send(self.class.sms_mobile_column)
+          company = SmartSMS.config.company
+          sms = SmartSMS::FakeSMS.build_fake_sms mobile, text, company
+          save_or_return_message sms, text
+        end
+
+        private
+
+        def save_or_return_message(sms, text)
+          if SmartSMS.config.store_sms_in_local
+            message = send(self.class.messages_association_name).build sms
+            message.code = text
+            message.save
+          else
+            sms
+          end
+        end
+      end
+    end
+  end
+end

data/lib/smart_sms/helpers/fake_sms.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+module SmartSMS
+  # Module that contains methods to generate fake message
+  #
+  module FakeSMS
+    module_function
+
+    # This will generate fake sms with all necessary attributes
+    #
+    # Options:
+    #
+    #   * mobile: mobile number
+    #   * code:   verification code
+    #   * company: assigned company, format is【company】
+    #
+    def build_fake_sms(mobile, code, company)
+      {
+        'sid'               => SecureRandom.uuid,
+        'mobile'            => mobile,
+        'send_time'         => Time.zone.now,
+        'text'              => "您的验证码是#{code}。如非本人操作，请忽略本短信【#{company}】",
+        'send_status'       => 'SUCCESS',
+        'report_status'     => 'UNKNOWN',
+        'fee'               => 1,
+        'user_receive_time' => nil,
+        'error_msg'         => nil
+      }
+    end
+  end
+end

data/lib/smart_sms/helpers/verification_code.rb

@@ -0,0 +1,42 @@
+require 'securerandom'
+
+module SmartSMS
+  # This module provides some methods to generate random verification code
+  #
+  # Algorithm:
+  #
+  #   * short:    Generate short code with 4 numbers
+  #   * simple:   Generate simple code with 6 numbers
+  #   * middle:   Generate middle complex code of 6 charactors with mixed numbers and letters
+  #   * complex:  Generate complex code of 8 charactors with mixed numbers, letters or special charactors
+  module VerificationCode
+    module_function
+
+    REGISTERED_ALGORITHMS = [:short, :simple, :middle, :complex]
+
+    def random(algorithm = '')
+      algorithm = SmartSMS.config.verification_code_algorithm if algorithm.blank?
+      if REGISTERED_ALGORITHMS.include? algorithm
+        SmartSMS::VerificationCode.send algorithm
+      else
+        fail NoMethodError
+      end
+    end
+
+    def short
+      SecureRandom.random_number.to_s.slice(-4..-1)
+    end
+
+    def simple
+      SecureRandom.random_number.to_s.slice(-6..-1)
+    end
+
+    def middle
+      SecureRandom.base64.gsub!(/[^0-9a-zA-Z]/, '').slice(1..6).downcase
+    end
+
+    def complex
+      SecureRandom.base64.slice(1..8).downcase
+    end
+  end
+end