smart_sms 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b9fa8f3418d450f565df408ff794eb83a960b58
-  data.tar.gz: 4490c8952972f86e02148eb6ae2777a44a36df80
+  metadata.gz: 325ca64649f2a85722659b93eae872bb20b1c5b9
+  data.tar.gz: 5d44ed9d5c466c8884ddc8dbdee257423dcbaa50
 SHA512:
-  metadata.gz: dad9f7408a3e13c4808d4c20fc1edf1a9103a5a2d4c22d6c07ba38e136c9a44506986d545957408d965b4e182acceecfc90ec36ca8086092665ac1309845cf06
-  data.tar.gz: b79133e1dded6dea4467b313dbb3f6ea63db595eaf918eb3ae9839f0a45ab43a5d97aa7761693dd7607583416bea6bb5fcfe7cfd454d9a23b6516e48ff39b2f5
+  metadata.gz: 6956d9f1b4b1948f149340a9214095d42b5d1307d6f0a410f0c752e32a3d2077acb81c34b76026f2de3adc25129240f1e8c6a9e28acacb8daacaa6a89daa9d8a
+  data.tar.gz: a81043483f4b9c4e010a6793672fa17dacd9c841f0e3d3751791e2f060ac82d989f5f3709257f791e7bd9b62a75537cb28ba639ce71ec8c32a4d3a8d8be8dcc7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smart_sms (0.0.1)
+    smart_sms (0.0.2)
       activerecord (>= 3.0, < 5.0)
       activesupport (>= 3.0, < 5.0)
 
@@ -24,9 +24,10 @@ GEM
     builder (3.0.4)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
+    database_cleaner (1.2.0)
     diff-lcs (1.2.5)
     i18n (0.6.1)
-    multi_json (1.8.4)
+    multi_json (1.9.2)
     rake (10.2.2)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
@@ -37,7 +38,7 @@ GEM
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
     safe_yaml (1.0.1)
-    tzinfo (0.3.38)
+    tzinfo (0.3.39)
     webmock (1.17.4)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
@@ -46,8 +47,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.2)
+  bundler (>= 1.0.0)
+  database_cleaner (~> 1.2.0)
   rake
   rspec
   smart_sms!
-  webmock
+  webmock (~> 1.17.0)

data/README.md

@@ -1,4 +1,38 @@
-SmartSMS 短信认证或校验服务
-=========
+SmartSMS [![Build Status](https://travis-ci.org/lyfeyaj/smart_sms.png?branch=master)](https://travis-ci.org/lyfeyaj/smart_sms) [![Code Climate](https://codeclimate.com/github/lyfeyaj/smart_sms.png)](https://codeclimate.com/github/lyfeyaj/smart_sms)
+===================================
+
+提供在中国境内发送短信, 校验, 以及 ActiveRecord 集成功能
+
+功能特点
+--------
+
+* 集成了 [云片网络](http://www.yunpian.com) 的所有短信服务API
+  - 发送, 查询模板短信, 通用短信
+  - 查询, 修改用户信息
+  - 查询默认模板, 自定义模板
+  - 新增, 修改, 删除自定义模板
+  - 查询用户短信回复
+* 集成了 ActiveRecord 支持
+* 集成了方便的验证码生成工具
+* 强大的配置选项, 几行代码即可集成所有功能
+
+## 安装
+
+    gem install smart_sms
+
+### 或者从 `github` 安装最新的开发版本
+
+    git clone http://github.com/lyfeyaj/smart_sms.git
+    cd smart_sms
+    rake install
+
+## 使用
+
+### 结合 Rails 使用
+
+### 其他
+
+## 使用方法和例子
+
+
 
-集成了 [云片网络](http://www.yunpian.com) 的短信服务

data/Rakefile

@@ -1 +1,11 @@
-require "bundler/gem_tasks"
+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/templates/smart_sms_config.rb

@@ -8,6 +8,7 @@ SmartSMS.configure do |config|
   # 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

data/lib/smart_sms/account.rb

@@ -14,7 +14,7 @@ module SmartSMS
     #   emergency_mobile:  紧急联系人手机号
     #   alarm_balance:     短信余额提醒阈值。一天只提示一次
     def set options = {}
-      Request.post 'tpl/get.json', options
+      Request.post 'user/set.json', options
     end
   end
 end

data/lib/smart_sms/config.rb

@@ -26,7 +26,8 @@ module SmartSMS
     config_accessor :page_num # 获取信息时, 指定默认的页数
     config_accessor :page_size # 获取信息时, 一页包含信息数量
     config_accessor :company # 默认公司名称
-    config_accessor :default_interval   # 查询短信时的时间段: end_time - start_time
+    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
@@ -39,6 +40,7 @@ module SmartSMS
     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

data/lib/smart_sms/has_sms_verification.rb

@@ -18,7 +18,7 @@ module SmartSMS
       # :class_name   自定义的Message类名称. 默认是 `::SmartSMS::Message`
       # :messages     自定义的Message关联名称.  默认是 `:versions`.
       #
-      def has_sms_verification moible_column, verification_column, options = {}
+      def has_sms_verification moible_column = :phone, verification_column = :verified_at, options = {}
         send :include, InstanceMethods
 
         # 用于判断是否已经验证的字段, Datetime 类型, 例如 :verified_at
@@ -29,7 +29,7 @@ module SmartSMS
         self.sms_mobile_column = moible_column
 
         class_attribute :verify_regexp
-        self.verify_regexp = /(【.+】|[^a-zA-Z0-9\.\-\+_])/
+        self.verify_regexp = /(【.+】|[^a-zA-Z0-9\.\-\+_])/ # 用于抽取校验码, 如若修改过模板, 可能需要修改这个这正则
 
         if SmartSMS.config.store_sms_in_local
 
@@ -55,6 +55,7 @@ module SmartSMS
 
       module InstanceMethods
 
+        # 非安全verify!方法, 验证成功后会存储成功的结果到数据表中
         def verify! code
           result = verify code
           if result
@@ -63,6 +64,8 @@ module SmartSMS
           end
         end
 
+        # 安全verify方法, 用于校验短信验证码是否正确, 返回: true 或 false
+        #
         def verify code
           sms = latest_message
           return false if sms.blank?
@@ -73,33 +76,45 @@ module SmartSMS
           end
         end
 
+        # 判断是否已经验证成功
+        #
         def verified?
-          self[self.class.sms_verification_column].present?
+          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 # the verification code will be expired within 1 hour
           if SmartSMS.config.store_sms_in_local
-            self.send(self.class.messages_association_name).last
+            self.send(self.class.messages_association_name)
+                .where("send_time >= ? and send_time <= ?", start_time, end_time)
+                .last
           else
-            SmartSMS.find(
-              start_time: (Time.now - 1.hour),
-              end_time: Time.now,
+            result = SmartSMS.find(
+              start_time: start_time,
+              end_time: end_time,
               mobile: self.send(self.class.sms_mobile_column),
               page_size: 1
-            )['sms'].first
+            )
+            result['sms'].first
           end
         end
 
-        def deliver text = random_verification_code
+        # 发送短信至手机
+        #
+        def deliver text = SmartSMS::VerificationCode.random
           result = SmartSMS.deliver self.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.send_time = Time.parse sms['send_time']
               message.code = text
               message.save
             else
@@ -111,17 +126,6 @@ module SmartSMS
           end
         end
 
-        def random_verification_code
-          case SmartSMS.config.verification_code_algorithm
-          when :simple
-            SmartSMS::VerificationCode.simple
-          when :middle
-            SmartSMS::VerificationCode.middle
-          when :complex
-            SmartSMS::VerificationCode.complex
-          end
-        end
-
       end
     end
   end

data/lib/smart_sms/helper/verification_code.rb

@@ -3,12 +3,26 @@ require 'securerandom'
 module SmartSMS
   module VerificationCode
     extend self
+
+    REGISTERED_ALGORITHMS = [: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
+        raise NoMethodError
+      end
+    end
+
+    private
+
     def simple
       SecureRandom.random_number.to_s.slice(-6..-1)
     end
 
     def middle
-      SecureRandom.base64.slice(1..6).downcase
+      SecureRandom.base64.gsub!(/[^0-9a-zA-Z]/,'').slice(1..6).downcase
     end
 
     def complex

data/lib/smart_sms/message_service.rb

@@ -9,6 +9,13 @@ module SmartSMS
 
       DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S"
 
+      # 发送短信到手机, 默认使用模板发送, 提供通用接口支持
+      # phone:   需要接受短信的手机号码
+      # content: 短信验证内容
+      #
+      # Options:
+      # :method 如若要使用通用短信接口, 需要 :method => :general
+      # :tpl_id 选择发送短信的模板, 默认是2
       def deliver phone, content, options = {}
         if options[:method] == :general
           Request.post 'sms/send.json', mobile: phone, text: content, extend: options[:extend]
@@ -20,10 +27,13 @@ module SmartSMS
         end
       end
 
+      # 根据sid来查询短信记录
+      #
       def find_by_sid sid
         Request.post 'sms/get.json', sid: sid
       end
 
+      # 参见 `find_messages` 方法
       def find options = {}
         find_messages 'sms/get.json', options
       end

data/lib/smart_sms/template.rb

@@ -1,22 +1,39 @@
+# encoding: utf-8
+
 module SmartSMS
   module Template
     extend self
+
+    # 取默认模板
+    # Options:
+    #   tpl_id: 指定tpl_id时返回tpl_id对应的默认模板. 未指定时返回所有默认模板
+    #
     def find_default tpl_id = ''
       Request.post 'tpl/get_default.json', tpl_id: tpl_id
     end
 
+    # 取自定义模板
+    # Options:
+    #   tpl_id: 指定tpl_id时返回tpl_id对应的自定义模板. 未指定时返回所有自定义模板
+    #
     def find tpl_id = ''
       Request.post 'tpl/get.json', tpl_id: tpl_id
     end
 
+    # 创建新模板
+    # 规则请参见: <http://www.yunpian.com/api/tpl.html>
+    #
     def create tpl_content = ''
       Request.post 'tpl/add.json', tpl_content: tpl_content
     end
 
+    # 更新模板, 需指定id和content
+    #
     def update tpl_id = '', tpl_content = ''
       Request.post 'tpl/update.json', tpl_id: tpl_id, tpl_content: tpl_content
     end
 
+    # 删除模板, 需指定id
     def destroy tpl_id = ''
       Request.post 'tpl/del.json', tpl_id: tpl_id
     end

data/lib/smart_sms/version.rb

@@ -1,3 +1,3 @@
 module SmartSMS
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/smart_sms.gemspec

@@ -22,8 +22,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'activerecord', ['>= 3.0', '< 5.0']
   s.add_dependency 'activesupport', ['>= 3.0', '< 5.0']
 
-  s.add_development_dependency "bundler", "~> 1.2"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "webmock"
+  s.add_development_dependency 'bundler', ['>= 1.0.0']
+  s.add_development_dependency 'rake', ['>= 0']
+  s.add_development_dependency 'rspec', ['>= 0']
+  s.add_development_dependency 'database_cleaner', ['~> 1.2.0']
+  s.add_development_dependency "webmock", ['~> 1.17.0']
 end

data/spec/spec_helper.rb

@@ -5,6 +5,8 @@ require 'bundler/setup'
 require 'webmock/rspec'
 require 'smart_sms'
 
+require 'database_cleaner'
+
 #WebMock.allow_net_connect!
 RSpec.configure do |config|
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_sms
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - lyfeyaj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-04 00:00:00.000000000 Z
+date: 2014-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -54,16 +54,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -92,20 +92,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.17.0
 description: A smart sms verification tool
 email:
 - lyfeyaj@gmail.com