yx-smart_sms 0.1.2

data/lib/smart_sms/message_service.rb

@@ -0,0 +1,98 @@
+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'
+
+      # 发送短信到手机, 默认使用模板发送, 提供通用接口支持
+      #
+      # * 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]
+        else
+          options[:code] = content
+          message = parse_content options
+          tpl_id = options[:tpl_id] || SmartSMS.config.template_id
+          Request.post 'sms/tpl_send.json', tpl_id: tpl_id, mobile: phone, tpl_value: message
+        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
+
+      # 查询黑名单词语, 用于预先测试可能无法通过审核的模板
+      #
+      def get_black_word(text = '')
+        Request.post 'sms/get_black_word.json', text: text
+      end
+
+      # 查询用户回复的短信, 参见 `find_messages` 方法
+      def get_reply(options = {})
+        find_messages 'sms/get_reply.json', options
+      end
+
+      private
+
+      # 批量查短信, 参数:
+      #
+      # * start_time: 短信提交开始时间
+      # * end_time: 短信提交结束时间
+      # * page_num: 页码，从1开始
+      # * page_size: 每页个数，最大100个
+      # * mobile: 接收短信的手机号
+      #
+      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])
+        options[:start_time] = parse_time(options[:start_time])
+        options[:page_num]  ||= SmartSMS.config.page_num
+        options[:page_size] ||= SmartSMS.config.page_size
+        Request.post api, options
+      end
+
+      # 解析日期时间
+      # 格式可以是 `2014-05-01 08:40:20`, 也可以是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 = {})
+        options[:code] ||= ''
+        options[:company] ||= SmartSMS.config.company
+        SmartSMS.config.template_value.map do |key|
+          "##{key}#=#{options[key]}"
+        end.join('&')
+      end
+    end
+  end
+end

data/lib/smart_sms/model/message.rb

@@ -0,0 +1,9 @@
+module SmartSMS
+  # Message model to store sms messages
+  #
+  class Message < ::ActiveRecord::Base
+    self.table_name = 'smart_sms_messages'
+    belongs_to :smsable, polymorphic: true
+    attr_accessible :sid, :uid, :mobile, :send_time, :text, :code, :send_status, :report_status, :fee, :user_receive_time, :error_msg if SmartSMS.active_record_protected_attributes?
+  end
+end

data/lib/smart_sms/request.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require 'net/http'
+require 'active_support/json'
+
+module SmartSMS
+  # Module that manage requests
+  module Request
+    # Method that use `Net::HTTP.post_form` to perform `POST` action
+    #
+    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
+
+    # Method that use `Net::HTTP.get` to perform `GET` action
+    #
+    def get(api, options = {})
+      options[:apikey] = SmartSMS.config.api_key
+      uri = URI.join(base_url, api)
+      result Net::HTTP.get(uri, options)
+    end
+
+    private
+
+    # Method that parse JSON to Hash
+    #
+    def result(body)
+      begin
+        ActiveSupport::JSON.decode body
+      rescue => e
+        {
+          code: 502,
+          msg: '内容解析错误',
+          detail: e.to_s
+        }
+      end
+    end
+
+    # Base uri for yunpian API
+    def base_url
+      "http://yunpian.com/#{SmartSMS.config.api_version}/"
+    end
+
+    module_function :post, :get, :result, :base_url
+  end
+end

data/lib/smart_sms/template.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module SmartSMS
+  # module that handle `Template`
+  module Template
+    module_function
+
+    # 取默认模板
+    # 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
+  end
+end

data/lib/smart_sms/version.rb

@@ -0,0 +1,3 @@
+module SmartSMS
+  VERSION = '0.1.2'
+end

data/smart_sms.gemspec

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smart_sms/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'yx-smart_sms'
+  s.version       = SmartSMS::VERSION
+  s.authors       = ['lyfeyaj']
+  s.email         = ['lyfeyaj@gmail.com']
+  s.description   = %q{A smart sms verification tool}
+  s.summary       = %q{A smart sms verification tool used in China and integrate with yunpian.com}
+  s.homepage      = 'https://github.com/lyfeyaj/smart_sms'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activerecord', ['>= 3.0']
+  s.add_dependency 'activesupport', ['>= 3.0']
+
+  s.add_development_dependency 'bundler', ['>= 1.0.0']
+  s.add_development_dependency 'rake', ['>= 0']
+  s.add_development_dependency 'rspec-rails', ['>= 3.0.0']
+  s.add_development_dependency 'rspec-its', ['>= 1.0.0']
+  s.add_development_dependency 'database_cleaner', ['~> 1.2.0']
+  s.add_development_dependency 'webmock', ['~> 1.17.0']
+  s.add_development_dependency 'rails', ['>= 3.1.0']
+  s.add_development_dependency 'sqlite3', ['>= 0']
+  s.add_development_dependency 'pry', ['>= 0']
+  s.add_development_dependency 'sdoc', ['>= 0']
+end

data/spec/account_spec.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe SmartSMS::Template do
+
+  describe '#info' do
+    let(:url) { 'http://yunpian.com/v1/user/get.json' }
+    subject { SmartSMS::Account.info }
+
+    before do
+      stub_request(:post, url).with(
+        body: {
+          'apikey' => SmartSMS.config.api_key
+        },
+        headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      ).to_return(
+        body: {
+          'code' => 0,
+          'msg'  => 'OK',
+          'user' => {
+            'nick'              => 'LYFEYAJ',
+            'gmt_created'       => '2014-04-01 14:00:52',
+            'mobile'            => '13096953122',
+            'email'             => 'lyfeyaj@gmail.com',
+            'ip_whitelist'      => nil,
+            'api_version'       => 'v1',
+            'alarm_balance'     => 150,
+            'emergency_contact' => '',
+            'emergency_mobile'  => '',
+            'balance'           => 676
+          }
+        }.to_json
+      )
+    end
+
+    its(['code']) { should eq 0 }
+    its(['msg']) { should eq 'OK' }
+    its(:keys) { should include 'user' }
+  end
+
+  describe '#set' do
+    let(:url) { 'http://yunpian.com/v1/user/set.json' }
+    let(:emergency_contact) { 'Felix Liu' }
+    let(:emergency_mobile)  { '13394738283' }
+    let(:alarm_balance)     { '100' }
+    subject do
+      SmartSMS::Account.set(
+        emergency_contact: emergency_contact,
+        emergency_mobile: emergency_mobile,
+        alarm_balance: alarm_balance
+      )
+    end
+
+    before do
+      stub_request(:post, url).with(
+        body: {
+          'apikey'            => SmartSMS.config.api_key,
+          'emergency_contact' => emergency_contact,
+          'emergency_mobile'  => emergency_mobile,
+          'alarm_balance'     => alarm_balance
+        },
+        headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      ).to_return(
+        body: {
+          'code'   => 0,
+          'msg'    => 'OK',
+          'detail' => nil
+        }.to_json
+      )
+    end
+
+    its(['code']) { should eq 0 }
+    its(['msg']) { should eq 'OK' }
+    its(:keys) { should include 'detail' }
+  end
+end

data/spec/config/config_spec.rb

@@ -0,0 +1,172 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe SmartSMS::Configuration do
+  subject { SmartSMS.config }
+
+  describe 'api_key' do
+    context 'by_default' do
+      its(:api_key) { should == 'fake_api_key' }
+    end
+    context 'configured via config block' do
+      before do
+        SmartSMS.configure { |c| c.api_key = 'fdswerfsffsdfdvdsrr23432' }
+      end
+      its(:api_key) { should == 'fdswerfsffsdfdvdsrr23432' }
+      after do
+        SmartSMS.configure { |c| c.api_key = 'fake_api_key'  }
+      end
+    end
+  end
+
+  describe 'api_version' do
+    context 'by_default' do
+      its(:api_version) { should == :v1 }
+    end
+    context 'configured via config block' do
+      before do
+        SmartSMS.configure { |c| c.api_version = :v2 }
+      end
+      its(:api_version) { should == :v2 }
+      after do
+        SmartSMS.configure { |c| c.api_version = :v1 }
+      end
+    end
+  end
+
+  describe 'template_id' do
+    context 'by_default' do
+      its(:template_id) { should == '2' }
+    end
+    context 'configured via config block' do
+      before do
+        SmartSMS.configure { |c| c.template_id = '1' }
+      end
+      its(:template_id) { should == '1' }
+      after do
+        SmartSMS.configure { |c| c.template_id = '2' }
+      end
+    end
+  end
+
+  describe 'template_value' do
+    context 'by_default' do
+      its(:template_value) { should == [:code, :company] }
+    end
+    context 'configured via config block' do
+      before do
+        SmartSMS.configure { |c| c.template_value = [:code] }
+      end
+      its(:template_value) { should == [:code] }
+      after do
+        SmartSMS.configure { |c| c.template_value = [:code, :company] }
+      end
+    end
+  end
+
+  describe 'page_num' do
+    context 'by_default' do
+      its(:page_num) { should == 1 }
+    end
+    context 'configured via config block' do
+      before do
+        SmartSMS.configure { |c| c.page_num = 2 }
+      end
+      its(:page_num) { should == 2 }
+      after do
+        SmartSMS.configure { |c| c.page_num = 1 }
+      end
+    end
+  end
+
+  describe 'page_size' do
+    context 'by_default' do
+      its(:page_size) { should == 20 }
+    end
+    context 'configured via config block' do
+      before do
+        SmartSMS.configure { |c| c.page_size = 50 }
+      end
+      its(:page_size) { should == 50 }
+      after do
+        SmartSMS.configure { |c| c.page_size = 20 }
+      end
+    end
+  end
+
+  describe 'company' do
+    context 'by_default' do
+      its(:company) { should == 'Smart SMS' }
+    end
+    context 'configured via config block' do
+      before do
+        SmartSMS.configure { |c| c.company = 'Edgepeek' }
+      end
+      its(:company) { should == 'Edgepeek' }
+      after do
+        SmartSMS.configure { |c| c.company = 'Smart SMS' }
+      end
+    end
+  end
+
+  describe 'expires_in' do
+    context 'by_default' do
+      its(:expires_in) { should == 1.hour }
+    end
+    context 'configured via config block' do
+      before do
+        SmartSMS.configure { |c| c.expires_in = 45.minutes }
+      end
+      its(:expires_in) { should == 45.minutes }
+      after do
+        SmartSMS.configure { |c| c.expires_in = 1.hour }
+      end
+    end
+  end
+
+  describe 'default_interval' do
+    context 'by_default' do
+      its(:default_interval) { should == 1.day }
+    end
+    context 'configured via config block' do
+      before do
+        SmartSMS.configure { |c| c.default_interval = 2.day }
+      end
+      its(:default_interval) { should == 2.day }
+      after do
+        SmartSMS.configure { |c| c.default_interval = 1.day }
+      end
+    end
+  end
+
+  describe 'store_sms_in_local' do
+    context 'by_default' do
+      its(:store_sms_in_local) { should == true }
+    end
+    context 'configured via config block' do
+      before do
+        SmartSMS.configure { |c| c.store_sms_in_local = false }
+      end
+      its(:store_sms_in_local) { should == false }
+      after do
+        SmartSMS.configure { |c| c.store_sms_in_local = true }
+      end
+    end
+  end
+
+  describe 'verification_code_algorithm' do
+    context 'by_default' do
+      its(:verification_code_algorithm) { should == :simple }
+    end
+    context 'configured via config block' do
+      before do
+        SmartSMS.configure { |c| c.verification_code_algorithm = :middle }
+      end
+      its(:verification_code_algorithm) { should == :middle }
+      after do
+        SmartSMS.configure { |c| c.verification_code_algorithm = :simple }
+      end
+    end
+  end
+end