smart_sms 0.0.3 → 0.1.0

data/lib/generators/smart_sms/install_generator.rb

@@ -7,7 +7,11 @@ module SmartSms
 
     source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
 
-    desc 'Generates (but does not run) a migration to add a message table.'
+    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
       add_smart_sms_migration('create_smart_sms_messages') if SmartSMS.config.store_sms_in_local
@@ -18,10 +22,11 @@ module SmartSms
     end
 
     protected
+
     def add_smart_sms_migration(template)
       migration_dir = File.expand_path('db/migrate')
 
-      if !self.class.migration_exists?(migration_dir, template)
+      unless self.class.migration_exists?(migration_dir, template)
         migration_template "#{template}.rb", "db/migrate/#{template}.rb"
       end
     end

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

@@ -12,4 +12,4 @@ SmartSMS.configure do |config|
   # config.default_interval = 1.day
   # config.store_sms_in_local = false
   # config.verification_code_algorithm = :simple
-end
+end

data/lib/smart_sms.rb

@@ -6,7 +6,7 @@ require 'smart_sms/helpers/verification_code'
 require 'smart_sms/message_service'
 require 'smart_sms/account'
 
-if !defined? ActiveRecord
+unless defined? ActiveRecord
   begin
     require 'active_record'
   rescue LoadError; end
@@ -32,4 +32,4 @@ require 'smart_sms/has_sms_verification'
 
 ActiveSupport.on_load(:active_record) do
   include SmartSMS::HasSmsVerification
-end
+end

data/lib/smart_sms/account.rb

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

data/lib/smart_sms/config.rb

@@ -1,9 +1,8 @@
-#encoding: utf-8
+# 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'
@@ -17,6 +16,8 @@ module SmartSMS
     @config
   end
 
+  # Configuration class
+  #
   class Configuration #:nodoc:
     include ActiveSupport::Configurable
     config_accessor :api_key # 授权 API KEY
@@ -45,4 +46,4 @@ module SmartSMS
     config.store_sms_in_local = false
     config.verification_code_algorithm = :simple
   end
-end
+end

data/lib/smart_sms/has_sms_verification.rb

@@ -2,23 +2,25 @@
 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 绑定的字段, 用于发送短信
-      # verification_column: 验证绑定的字段, 用于判断是否以验证
+      # verification_column: 验证绑定的字段, 用于判断是否已验证
       #
       # Options:
       # :class_name   自定义的Message类名称. 默认是 `::SmartSMS::Message`
       # :messages     自定义的Message关联名称.  默认是 `:versions`.
       #
-      def has_sms_verification moible_column = :phone, verification_column = :verified_at, options = {}
+      def has_sms_verification(moible_column = :phone, verification_column = :verified_at, options = {})
         send :include, InstanceMethods
 
         # 用于判断是否已经验证的字段, Datetime 类型, 例如 :verified_at
@@ -40,33 +42,34 @@ module SmartSMS
           self.message_class_name = options[:class_name] || '::SmartSMS::Message'
 
           if ::ActiveRecord::VERSION::MAJOR >= 4 # Rails 4 里面, 在 `has_many` 声明中定义order lambda的语法
-            has_many self.messages_association_name,
-              lambda { order("send_time ASC") },
-              :class_name => self.message_class_name, :as => :smsable
+            has_many messages_association_name,
+              -> { order('send_time ASC') },
+              class_name: message_class_name,
+              as:         :smsable
           else
-            has_many self.messages_association_name,
-              :class_name => self.message_class_name,
-              :as         => :smsable,
-              :order      => "send_time ASC"
+            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
+        def verify!(code)
           result = verify code
           if result
-            self.send("#{self.class.sms_verification_column}=", Time.now)
-            self.save(validate: false)
+            send("#{self.class.sms_verification_column}=", Time.now)
+            save(validate: false)
           end
         end
 
         # 安全verify方法, 用于校验短信验证码是否正确, 返回: true 或 false
         #
-        def verify code
+        def verify(code)
           sms = latest_message
           return false if sms.blank?
           if SmartSMS.config.store_sms_in_local
@@ -90,16 +93,16 @@ module SmartSMS
         #
         def latest_message
           end_time = Time.now
-          start_time = end_time - SmartSMS.config.expires_in # the verification code will be expired within 1 hour
+          start_time = end_time - SmartSMS.config.expires_in
           if SmartSMS.config.store_sms_in_local
-            self.send(self.class.messages_association_name)
-                .where("send_time >= ? and send_time <= ?", start_time, end_time)
-                .last
+            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: self.send(self.class.sms_mobile_column),
+              mobile: send(self.class.sms_mobile_column),
               page_size: 1
             )
             result['sms'].first
@@ -108,27 +111,29 @@ module SmartSMS
 
         # 发送短信至手机
         #
-        def deliver text = SmartSMS::VerificationCode.random
-          result = SmartSMS.deliver self.send(self.class.sms_mobile_column), text
+        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']
-            if SmartSMS.config.store_sms_in_local
-              message = self.send(self.messages_association_name).build sms
-              message.code = text
-              message.save
-            else
-              sms
-            end
+            save_or_return_message sms, text
           else
-            self.errors.add :deliver, result
+            errors.add :deliver, result
             false
           end
         end
 
-        def deliver_fake_sms text = SmartSMS::VerificationCode.random
-          sms = SmartSMS::FakeSMS.build_fake_sms self.send(self.class.sms_mobile_column), text, SmartSMS.config.company
+        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 = self.send(self.messages_association_name).build sms
+            message = send(self.class.messages_association_name).build sms
             message.code = text
             message.save
           else
@@ -138,4 +143,4 @@ module SmartSMS
       end
     end
   end
-end
+end

data/lib/smart_sms/helpers/fake_sms.rb

@@ -1,22 +1,23 @@
 # encoding: utf-8
 
 module SmartSMS
+  # This will generate fake sms
+  #
   module FakeSMS
-    extend self
+    module_function
 
-    def build_fake_sms mobile, code, 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
+        '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
+end

data/lib/smart_sms/helpers/verification_code.rb

@@ -1,32 +1,40 @@
 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
-    extend self
+    module_function
 
-    REGISTERED_ALGORITHMS = [:simple, :middle, :complex]
+    REGISTERED_ALGORITHMS = [:short, :simple, :middle, :complex]
 
-    def random algorithm = ''
+    def random(algorithm = '')
       algorithm = SmartSMS.config.verification_code_algorithm if algorithm.blank?
       if REGISTERED_ALGORITHMS.include? algorithm
         SmartSMS::VerificationCode.send algorithm
       else
-        raise NoMethodError
+        fail NoMethodError
       end
     end
 
-    private
+    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
+      SecureRandom.base64.gsub!(/[^0-9a-zA-Z]/, '').slice(1..6).downcase
     end
 
     def complex
       SecureRandom.base64.slice(1..8).downcase
     end
   end
-end
+end

data/lib/smart_sms/message_service.rb

@@ -1,13 +1,13 @@
 module SmartSMS
+  # Message service: methods that are used to manage messages
   module MessageService
-
     def self.included(base)
       base.send :extend, ClassMethods
     end
 
+    # Class methods
     module ClassMethods
-
-      DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S"
+      DATETIME_FORMAT = '%Y-%m-%d %H:%M:%S'
 
       # 发送短信到手机, 默认使用模板发送, 提供通用接口支持
       # phone:   需要接受短信的手机号码
@@ -16,7 +16,7 @@ module SmartSMS
       # Options:
       # :method 如若要使用通用短信接口, 需要 :method => :general
       # :tpl_id 选择发送短信的模板, 默认是2
-      def deliver phone, content, options = {}
+      def deliver(phone, content, options = {})
         if options[:method] == :general
           Request.post 'sms/send.json', mobile: phone, text: content, extend: options[:extend]
         else
@@ -29,20 +29,20 @@ module SmartSMS
 
       # 根据sid来查询短信记录
       #
-      def find_by_sid sid
+      def find_by_sid(sid)
         Request.post 'sms/get.json', sid: sid
       end
 
       # 参见 `find_messages` 方法
-      def find options = {}
+      def find(options = {})
         find_messages 'sms/get.json', options
       end
 
-      def get_black_word text = ''
+      def get_black_word(text = '')
         Request.post 'sms/get_black_word.json', text: text
       end
 
-      def get_reply options = {}
+      def get_reply(options = {})
         find_messages 'sms/get_reply.json', options
       end
 
@@ -55,7 +55,7 @@ module SmartSMS
       #   page_size: 每页个数，最大100个
       #   mobile: 接收短信的手机号
       #
-      def find_messages api, options = {}
+      def find_messages(api, options = {})
         options[:end_time]   = Time.now if options[:end_time].blank?
         options[:start_time] = options[:end_time] - SmartSMS.config.default_interval if options[:start_time].blank?
         options[:end_time]   = parse_time(options[:end_time])
@@ -65,21 +65,23 @@ module SmartSMS
         Request.post api, options
       end
 
-      def parse_time time = ''
+      def parse_time(time = '')
         if time.present? && time.is_a?(Time)
           time.strftime DATETIME_FORMAT
+        elsif time.is_a? String
+          time
         else
           ''
         end
       end
 
-      def parse_content options = {}
+      def parse_content(options = {})
         options[:code] ||= ''
         options[:company] ||= SmartSMS.config.company
         SmartSMS.config.template_value.map do |key|
-          "##{key.to_s}#=#{options[key]}"
+          "##{key}#=#{options[key]}"
         end.join('&')
       end
     end
   end
-end
+end

data/lib/smart_sms/model/message.rb

@@ -1,4 +1,6 @@
 module SmartSMS
+  # Message model to store sms messages
+  #
   class Message < ::ActiveRecord::Base
     self.table_name = 'smart_sms_messages'
     belongs_to :smsable, polymorphic: true

data/lib/smart_sms/request.rb

@@ -3,17 +3,16 @@ require 'net/http'
 require 'active_support/json'
 
 module SmartSMS
+  # Module that manage requests
   module Request
-    extend self
-
-    def post api, options = {}
+    def post(api, options = {})
       options[:apikey] = SmartSMS.config.api_key
       uri = URI.join(base_url, api)
       res = Net::HTTP.post_form(uri, options)
       result res.body
     end
 
-    def get api, options = {}
+    def get(api, options = {})
       options[:apikey] = SmartSMS.config.api_key
       uri = URI.join(base_url, api)
       result Net::HTTP.get(uri, options)
@@ -21,20 +20,22 @@ module SmartSMS
 
     private
 
-    def result body
+    def result(body)
       begin
         ActiveSupport::JSON.decode body
       rescue => e
         {
           code: 502,
-          msg: "内容解析错误",
+          msg: '内容解析错误',
           detail: e.to_s
         }
       end
     end
 
     def base_url
-      "http://yunpian.com/#{SmartSMS.config.api_version.to_s}/"
+      "http://yunpian.com/#{SmartSMS.config.api_version}/"
     end
+
+    module_function :post, :get, :result, :base_url
   end
-end
+end