smart_sms 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6657970a00f52d9f254456d29b60fd0d69e73bf
-  data.tar.gz: 8aefe4480f4df68eceb9ce68503badf6ba6e0e7b
+  metadata.gz: ae8bc61edbbcbc8ae6fdb4e185d1ec9b96d49dd7
+  data.tar.gz: 5cf87b214f8541f14a99ad9a6a6e7ad5249c7432
 SHA512:
-  metadata.gz: c07ba9e1dbaff74a199f2809844594969775a5feaa2981b33c9603f70c491d5f76c26ad1e24cbea047127e1d6d291034048bfee30f933b26b253fcc9c4fab556
-  data.tar.gz: a2d90862fe00c430dc8c4b98650cc5d9bb644c494740ef22b0d4d4b0d57a9d0655a9bb4a2a12344ed01bb0e92bd2a2634f862297277c69bd2435a3a337dbdbe6
+  metadata.gz: 929a55ac72a38ff5cbfab959ca8c3fcbefa75ef6f7cd2094c0601810c3d909b57afb7eb6755644bc7d1b80f8e4b8d87cc29beaa6d7585281f1d7783fe6b67e8b
+  data.tar.gz: 56190a364c5fa08f8c938ae206a4d62e64243e827e608963ce0a07d8b6a7a52d2b14d1fdd4784e9519a4f9a7436dfa5db5a197a22d5aed72ca3b172d84781857

data/.gitignore

@@ -32,3 +32,4 @@ build/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+spec/fake_app/log/

data/.travis.yml

@@ -6,4 +6,4 @@ rvm:
   - 2.1.0
 
 script:
-  - bundle exec rspec spec
+  - bundle exec rspec spec --format documentation

data/Gemfile

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

data/Gemfile.lock

@@ -1,44 +1,114 @@
 PATH
   remote: .
   specs:
-    smart_sms (0.0.3)
+    smart_sms (0.1.0)
       activerecord (>= 3.0, < 5.0)
       activesupport (>= 3.0, < 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (3.2.13)
-      activesupport (= 3.2.13)
-      builder (~> 3.0.0)
-    activerecord (3.2.13)
-      activemodel (= 3.2.13)
-      activesupport (= 3.2.13)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
-      multi_json (~> 1.0)
+    actionmailer (4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
+      mail (~> 2.5.4)
+    actionpack (4.1.1)
+      actionview (= 4.1.1)
+      activesupport (= 4.1.1)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+    activerecord (4.1.1)
+      activemodel (= 4.1.1)
+      activesupport (= 4.1.1)
+      arel (~> 5.0.0)
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
     addressable (2.3.6)
-    arel (3.0.3)
-    builder (3.0.4)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    coderay (1.1.0)
     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.9.2)
-    rake (10.2.2)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.9)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (5.3.3)
+    multi_json (1.10.0)
+    polyglot (0.3.4)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.1)
+      actionmailer (= 4.1.1)
+      actionpack (= 4.1.1)
+      actionview (= 4.1.1)
+      activemodel (= 4.1.1)
+      activerecord (= 4.1.1)
+      activesupport (= 4.1.1)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.1)
+      sprockets-rails (~> 2.0)
+    railties (4.1.1)
+      actionpack (= 4.1.1)
+      activesupport (= 4.1.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.1)
     rspec-core (2.14.8)
     rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
-    safe_yaml (1.0.1)
-    tzinfo (0.3.39)
+    rspec-rails (2.14.2)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    safe_yaml (1.0.3)
+    slop (3.5.0)
+    sprockets (2.12.1)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.1.0)
+      thread_safe (~> 0.1)
     webmock (1.17.4)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
@@ -49,7 +119,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (>= 1.0.0)
   database_cleaner (~> 1.2.0)
+  pry
+  rails (>= 3.1.0)
   rake
-  rspec
+  rspec-rails
   smart_sms!
+  sqlite3
   webmock (~> 1.17.0)

data/README.md

@@ -1,7 +1,7 @@
 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)), 校验, 集成 ActiveRecord
 
 功能特点
 --------
@@ -30,9 +30,251 @@ SmartSMS [![Build Status](https://travis-ci.org/lyfeyaj/smart_sms.png?branch=mas
 
 ### 结合 Rails 使用
 
-### 其他
+##### 安装
 
-## 使用方法和例子
+在您的 `Gemfile` 里面添加:
 
+```
+gem 'smart_sms'
+```
 
+然后, 在 console 中执行下面的代码:
 
+``` bash
+# 安装gem
+bundle
+
+rails g smart_sms:config # 将会拷贝配置文件至 `config/initializers/smart_sms_config.rb`
+
+# 如果, 需要将所有短信都在本地存储, 则需要将配置文件中的 `store_sms_in_local` 设置为 true, 然后运行
+rails g smart_sms:install # 程序将会拷贝相应的 migration 文件到 `db/migrate` 目录下
+rake db:migrate
+```
+
+##### 配置
+
+``` ruby
+SmartSMS.configure do |config|
+  config.api_key = nil # 授权 API KEY
+  config.api_version = :v1 # API 的版本, 当前仅有v1
+  config.template_id = '2' # 指定发送信息时使用的模板
+  config.template_value = [:code, :company] # 用于指定信息文本中的可替换内容, 数组形势: [:code, :company]
+  config.page_num = 1 # 获取信息时, 指定默认的页数
+  config.page_size = 20 # 获取信息时, 一页包含信息数量
+  config.company = '云片网' # 默认公司名称
+  config.expires_in = 1.hour # 短信验证过期时间
+  config.default_interval = 1.day # 查询短信时的默认时间段: end_time - start_time
+  config.store_sms_in_local = false # 是否存储SMS信息在本地: true or false
+  config.verification_code_algorithm = :simple # 提供三种形式的验证码: `:simple, :middle, :complex`
+end
+```
+
+##### API 汇总(ActiveRecord)
+
+当在您现有的 model 中声明 `has_sms_verification` 的时候, 您将获得以下方法:
+``` ruby
+class User < ActiveRecord::Base
+  # 在您的Model里面声明这个方法, 以添加SMS短信验证功能
+  # moible_column:       mobile 绑定的字段, 用于获取发送短信所需的手机号码, 默认是 :phone
+  # verification_column: 验证绑定的字段, 用于判断是否已验证, 
+  #
+  # Options:
+  #   :class_name   自定义的Message类名称. 默认是 `SmartSMS::Message`
+  #   :messages     自定义的Message关联名称.  默认是 `:messages`.
+  #
+  has_sms_verification
+end
+
+# 发送短信验证码
+user.deliver # 将会生成一个随机的验证码发送至手机, 并保存在messages表中
+user.deliver '内容' # 可以发送指定内容至手机
+
+# 查询历史短信记录
+user.messages
+
+# 查询是否已经验证
+user.verified? # ture : false
+
+# 校验验证码
+user.verify '123456'  # 返回 true 或者 false, 不修改数据库的 verified_at 关联字段
+user.verify! '123456' # 返回 true 或者 false, 同时修改数据库的 verified_at 关联字段为当前时间
+
+# 查询验证日期
+user.verified_at
+
+# 查询最新的一条有效短信记录
+user.latest_message # 返回有效期内的最近一条短信, 若无则返回nil
+
+# 发送假信息, 方便非国内用户测试用
+user.deliver_fake_sms # messages中会保存一条新的短信记录, 但是不会发送短信到手机
+```
+
+### 基本用法(不依赖Rails)
+
+##### 设置api_key
+``` ruby
+SmartSMS.configure { |c| c.api_key = 'fure8423n4324uoj432n4324' }
+```
+
+##### 短信
+
+``` ruby
+
+# 发送短信到手机, 默认使用模板发送, 提供通用接口支持
+  # phone:   需要接受短信的手机号码
+  # content: 短信验证内容
+  #
+  # Options:
+  # :method 如若要使用通用短信接口, 需要 method: :general
+  # :tpl_id 选择发送短信的模板, 默认是2
+SmartSMS.deliver 13522948742, 'SmartSMS WOW!'
+SmartSMS.deliver 13522948742, 'SmartSMS WOW!', tpl_id: 1
+SmartSMS.deliver 13522948742, 'SmartSMS WOW!', method: :general # 使用通用短信发送方式, 需申请
+
+# 根据sid来查询短信记录
+SmartSMS.find_by_sid 13232
+# => {"code"=>0,
+# "msg"=>"OK",
+# "sms"=>
+#  {"sid"=>13232,
+#   "mobile"=>"13522948742",
+#   "send_time"=>"2014-04-06 13:29:33",
+#   "text"=>"您的验证码是668965。如非本人操作，请忽略本短信【SmartSMS】",
+#   "send_status"=>"SUCCESS",
+#   "report_status"=>"SUCCESS",
+#   "fee"=>1,
+#   "user_receive_time"=>"2014-04-06 13:29:49",
+#   "error_msg"=>nil}}
+
+# 批量查短信, 参数:
+#   start_time: 短信提交开始时间
+#   end_time: 短信提交结束时间
+#   page_num: 页码，从1开始
+#   page_size: 每页个数，最大100个
+#   mobile: 接收短信的手机号
+SmartSMS.find
+SmartSMS.find start_time: Time.now.yesterday, end_time: Time.now
+SmartSMS.find start_time: Time.now.yesterday, end_time: Time.now, mobile: 13522948742
+
+# 查询屏蔽词
+SmartSMS.get_black_word '这是一条测试短信'
+# => {"code"=>0, "msg"=>"OK", "result"=>{"black_word"=>"测试"}}
+
+# 查回复的短信, 参数与批量查短信一致, 可以查询用户回复的短信
+SmartSMS.get_reply
+SmartSMS.get_reply start_time: Time.now.yesterday, end_time: Time.now
+SmartSMS.get_reply start_time: Time.now.yesterday, end_time: Time.now, mobile: 13522948742
+
+```
+
+##### 账户
+
+``` ruby
+
+# 获取用户信息
+SmartSMS::Account.info
+# =>
+#{
+#  "code" => 0,
+#  "msg" => "OK",
+#  "user" => {
+#    "nick" => "Jacky",
+#    "gmt_created" => "2012-09-11 15:14:00",
+#    "mobile" => "13764071479",
+#    "email" => "jacky@taovip.com",
+#    "ip_whitelist" => null,                 //IP白名单，推荐使用
+#    "api_version" => "v1",                  //api版本号
+#    "send_count" => 0,                      //当天已发送的短信数
+#    "balance" => 0,                         //短信剩余条数
+#    "alarm_balance" => 0,                   //剩余条数低于该值时提醒
+#    "emergency_contact" => "张三",           //紧急联系人
+#    "emergency_mobile" => "13812341234"     //紧急联系人电话
+#  }
+#}
+
+# 设置用户信息
+#  emergency_contact: 紧急联系人
+#  emergency_mobile:  紧急联系人手机号
+#  alarm_balance:     短信余额提醒阈值。一天只提示一次
+SmartSMS::Account.set emergency_contact: 13764071479
+# =>
+#{
+#  "code" => 0,
+#  "msg" => "OK",
+#  "detail" => null
+#}
+
+```
+
+##### 模板
+
+``` ruby
+
+# 获取系统默认模板
+# Options:
+#   tpl_id: 指定tpl_id时返回tpl_id对应的默认模板. 未指定时返回所有默认模板
+#
+SmartSMS::Template.find_default
+SmartSMS::Template.find_default 2
+
+# 获取自定义模板
+# Options:
+#   tpl_id: 指定tpl_id时返回tpl_id对应的自定义模板. 未指定时返回所有自定义模板
+#
+SmartSMS::Template.find
+SmartSMS::Template.find 3252
+
+# 创建新模板
+# 规则请参见: <http://www.yunpian.com/api/tpl.html>
+#
+SmartSMS::Template.create '您的验证码是: #code#'
+
+# 更新模板, 需指定id和content
+#
+SmartSMS::Template.update 3252, '您的验证码是: #code#, 【SmartSMS】'
+
+# 删除模板, 需指定id
+#
+SmartSMS::Template.destroy 3252
+
+```
+
+##### 校验码
+
+``` ruby
+
+# 生成随机校验码
+  # 三个选项:
+  #   simple:   6位随机数字, 默认
+  #   middle:   6位随机字母, 数字组合
+  #   complex:  8位随机字母, 数字, 特殊字符组合
+
+SmartSMS::VerificationCode.random          # => "141068"
+SmartSMS::VerificationCode.random :middle  # => "xey7id"
+SmartSMS::VerificationCode.random :complex # => "x+rkag6a"
+
+SmartSMS::VerificationCode.simple  # => "141068"
+SmartSMS::VerificationCode.middle  # => "xey7id"
+SmartSMS::VerificationCode.complex # => "x+rkag6a"
+
+```
+
+## 贡献
+
++ Fork
++ 创建分支 (git checkout -b my-new-feature)
++ 保存代码 (git commit -am 'Added some feature')
++ 上传到分支 (git push origin my-new-feature)
++ 创建一个新的合并请求
+
+## LICENCE
+
+MIT
+
+## 作者
+
+[Felix Liu](https://github.com/lyfeyaj)
+
+## TODO
+
++ 增加测试用例覆盖率

data/Rakefile

@@ -8,4 +8,4 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task :default => "spec:all"
+task default: 'spec:all'