smart_sms 0.0.3 → 0.1.0

data/lib/smart_sms/template.rb

@@ -1,14 +1,15 @@
 # encoding: utf-8
 
 module SmartSMS
+  # module that handle `Template`
   module Template
-    extend self
+    module_function
 
     # 取默认模板
     # Options:
     #   tpl_id: 指定tpl_id时返回tpl_id对应的默认模板. 未指定时返回所有默认模板
     #
-    def find_default tpl_id = ''
+    def find_default(tpl_id = '')
       Request.post 'tpl/get_default.json', tpl_id: tpl_id
     end
 
@@ -16,26 +17,26 @@ module SmartSMS
     # Options:
     #   tpl_id: 指定tpl_id时返回tpl_id对应的自定义模板. 未指定时返回所有自定义模板
     #
-    def find 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 = ''
+    def create(tpl_content = '')
       Request.post 'tpl/add.json', tpl_content: tpl_content
     end
 
     # 更新模板, 需指定id和content
     #
-    def update tpl_id = '', tpl_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 = ''
+    def destroy(tpl_id = '')
       Request.post 'tpl/del.json', tpl_id: tpl_id
     end
   end
-end
+end

data/lib/smart_sms/version.rb

@@ -1,3 +1,3 @@
 module SmartSMS
-  VERSION = '0.0.3'
-end
+  VERSION = '0.1.0'
+end

data/smart_sms.gemspec

@@ -5,26 +5,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'smart_sms/version'
 
 Gem::Specification.new do |s|
-  s.name          = "smart_sms"
+  s.name          = 'smart_sms'
   s.version       = SmartSMS::VERSION
-  s.authors       = ["lyfeyaj"]
-  s.email         = ["lyfeyaj@gmail.com"]
+  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.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.require_paths = ['lib']
 
   s.add_dependency 'activerecord', ['>= 3.0', '< 5.0']
   s.add_dependency 'activesupport', ['>= 3.0', '< 5.0']
 
   s.add_development_dependency 'bundler', ['>= 1.0.0']
   s.add_development_dependency 'rake', ['>= 0']
-  s.add_development_dependency 'rspec', ['>= 0']
+  s.add_development_dependency 'rspec-rails', ['>= 0']
   s.add_development_dependency 'database_cleaner', ['~> 1.2.0']
-  s.add_development_dependency "webmock", ['~> 1.17.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']
 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

data/spec/fake_app/active_record/config.rb

@@ -0,0 +1,9 @@
+# Database
+ActiveRecord::Base.configurations = {
+  'test' => {
+    adapter: 'sqlite3',
+    database: ':memory:'
+  }
+}
+
+ActiveRecord::Base.establish_connection(:test)

data/spec/fake_app/active_record/models.rb

@@ -0,0 +1,42 @@
+# Model
+class User < ActiveRecord::Base
+  has_sms_verification
+end
+
+# Model with customized columns
+class Account < ActiveRecord::Base
+  has_sms_verification :mobile, :confirmed_at
+end
+
+# Migrations
+class CreateAllTables < ActiveRecord::Migration
+  def self.up
+    create_table(:users) do |t|
+      t.string :phone
+      t.datetime :verified_at
+    end
+
+    create_table(:accounts) do |t|
+      t.string :mobile
+      t.datetime :confirmed_at
+    end
+
+    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
+ActiveRecord::Migration.verbose = false
+CreateAllTables.up

data/spec/fake_app/initializers/smart_sms.rb

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

data/spec/fake_app/rails_app.rb

@@ -0,0 +1,23 @@
+# require 'rails/all'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+require 'fake_app/active_record/config' if defined? ActiveRecord
+
+# Config
+app = Class.new(Rails::Application)
+app.config.secret_token = '3b7cd727ee24e8444053437c36cc66c4'
+app.config.session_store :cookie_store, key: '_myapp_session'
+app.config.active_support.deprecation = :log
+app.config.eager_load = false
+
+# Rais.root
+app.config.root = File.dirname(__FILE__)
+Rails.backtrace_cleaner.remove_silencers!
+app.initialize!
+
+# Initializer
+require 'fake_app/initializers/smart_sms'
+
+# Model
+require 'fake_app/active_record/models' if defined? ActiveRecord

data/spec/has_sms_verificaton_spec.rb

@@ -0,0 +1,275 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe 'SmartSMS::HasSmsVerification' do
+  let(:user) { User.create phone: '13764071479' }
+  let(:account) { Account.create mobile: '13764071479' }
+
+  context '#verify!' do
+    let(:verification_code) { SmartSMS::VerificationCode.simple }
+
+    describe 'Model User with default columns' do
+      before do
+        3.times { user.deliver_fake_sms }
+        user.deliver_fake_sms verification_code
+      end
+
+      context 'with correct verification_code' do
+        before { user.verify! verification_code }
+
+        it 'should be verified' do
+          expect { user.verify! verification_code }.to be_true
+          expect(user.reload.verified?).to be_true
+        end
+
+        it 'should have right verification code' do
+          expect(user.latest_message.code).to eq verification_code
+        end
+
+        it 'should have 4 messages' do
+          expect(user.messages.count).to eq 4
+        end
+
+        it 'should not be verified by using expired verification code' do
+          user.verified_at = nil
+          user.save
+          expect(user.verify!(user.messages.first.code)).to be_nil
+        end
+
+        it 'should be the latest_message' do
+          expect(user.latest_message).to eq user.messages.last
+        end
+      end
+
+      context 'with incorrect verification_code' do
+        before { user.verify! 'kfdsfd' }
+
+        it 'should not be verified' do
+          expect(user.verify!('kfdsfd')).to be_nil
+          expect(user.reload.verified?).to be_false
+        end
+
+        it 'should not have right verification code' do
+          expect(user.latest_message.code).not_to eq 'kfdsfd'
+        end
+
+        it 'should have 4 messages' do
+          expect(user.messages.count).to eq 4
+        end
+
+        it 'should not be verified by using expired verification code' do
+          user.verified_at = nil
+          user.save
+          expect(user.verify!(user.messages.first.code)).to be_nil
+        end
+
+        it 'should be the latest_message' do
+          expect(user.latest_message).to eq user.messages.last
+        end
+      end
+    end
+
+    describe 'Model Account with custom columns' do
+      before do
+        3.times { account.deliver_fake_sms }
+        account.deliver_fake_sms verification_code
+      end
+
+      context 'with correct verification_code' do
+        before { account.verify! verification_code }
+
+        it 'should be verified' do
+          expect { account.verify! verification_code }.to be_true
+          expect(account.reload.verified?).to be_true
+        end
+
+        it 'should have right verification code' do
+          expect(account.latest_message.code).to eq verification_code
+        end
+
+        it 'should have 4 messages' do
+          expect(account.messages.count).to eq 4
+        end
+
+        it 'should not be verified by using expired verification code' do
+          account.confirmed_at = nil
+          account.save
+          expect(account.verify!(account.messages.first.code)).to be_nil
+        end
+
+        it 'should be the latest_message' do
+          expect(account.latest_message).to eq account.messages.last
+        end
+
+        it 'should be the same value for verified_at and confirmed_at' do
+          expect(account.verified_at).to eq account.confirmed_at
+        end
+      end
+
+      context 'with incorrect verification_code' do
+        before { account.verify! 'kfdsfd' }
+
+        it 'should not be verified' do
+          expect(account.verify!('kfdsfd')).to be_nil
+          expect(account.reload.verified?).to be_false
+        end
+
+        it 'should not have right verification code' do
+          expect(account.latest_message.code).not_to eq 'kfdsfd'
+        end
+
+        it 'should have 4 messages' do
+          expect(account.messages.count).to eq 4
+        end
+
+        it 'should not be verified by using expired verification code' do
+          account.confirmed_at = nil
+          account.save
+          expect(account.verify!(account.messages.first.code)).to be_nil
+        end
+
+        it 'should be the latest_message' do
+          expect(account.latest_message).to eq account.messages.last
+        end
+
+        it 'should be the same value for verified_at and confirmed_at' do
+          expect(account.verified_at).to eq account.confirmed_at
+        end
+      end
+    end
+  end
+
+  context '#verify' do
+    let(:verification_code) { SmartSMS::VerificationCode.simple }
+
+    describe 'Model User with default columns' do
+      before do
+        3.times { user.deliver_fake_sms }
+        user.deliver_fake_sms verification_code
+      end
+
+      context 'with correct verification_code' do
+        before { user.verify verification_code }
+
+        it 'should be verified' do
+          expect { user.verify verification_code }.to be_true
+          expect(user.reload.verified?).to be_false
+        end
+
+        it 'should have right verification code' do
+          expect(user.latest_message.code).to eq verification_code
+        end
+
+        it 'should have 4 messages' do
+          expect(user.messages.count).to eq 4
+        end
+
+        it 'should not be verified by using expired verification code' do
+          user.verified_at = nil
+          user.save
+          expect(user.verify(user.messages.first.code)).to be_false
+        end
+
+        it 'should be the latest_message' do
+          expect(user.latest_message).to eq user.messages.last
+        end
+      end
+
+      context 'with incorrect verification_code' do
+        before { user.verify 'kfdsfd' }
+
+        it 'should not be verified' do
+          expect(user.verify('kfdsfd')).to be_false
+          expect(user.reload.verified?).to be_false
+        end
+
+        it 'should not have right verification code' do
+          expect(user.latest_message.code).not_to eq 'kfdsfd'
+        end
+
+        it 'should have 4 messages' do
+          expect(user.messages.count).to eq 4
+        end
+
+        it 'should not be verified by using expired verification code' do
+          user.verified_at = nil
+          user.save
+          expect(user.verify(user.messages.first.code)).to be_false
+        end
+
+        it 'should be the latest_message' do
+          expect(user.latest_message).to eq user.messages.last
+        end
+      end
+    end
+
+    describe 'Model Account with custom columns' do
+      before do
+        3.times { account.deliver_fake_sms }
+        account.deliver_fake_sms verification_code
+      end
+
+      context 'with correct verification_code' do
+        before { account.verify verification_code }
+
+        it 'should be verified' do
+          expect { account.verify verification_code }.to be_true
+          expect(account.reload.verified?).to be_false
+        end
+
+        it 'should have right verification code' do
+          expect(account.latest_message.code).to eq verification_code
+        end
+
+        it 'should have 4 messages' do
+          expect(account.messages.count).to eq 4
+        end
+
+        it 'should not be verified by using expired verification code' do
+          account.confirmed_at = nil
+          account.save
+          expect(user.verify(account.messages.first.code)).to be_false
+        end
+
+        it 'should be the latest_message' do
+          expect(account.latest_message).to eq account.messages.last
+        end
+
+        it 'should be the same value for verified_at and confirmed_at' do
+          expect(account.verified_at).to eq account.confirmed_at
+        end
+      end
+
+      context 'with incorrect verification_code' do
+        before { account.verify 'kfdsfd' }
+
+        it 'should not be verified' do
+          expect(account.verify('kfdsfd')).to be_false
+          expect(account.reload.verified?).to be_false
+        end
+
+        it 'should not have right verification code' do
+          expect(account.latest_message.code).not_to eq 'kfdsfd'
+        end
+
+        it 'should have 4 messages' do
+          expect(account.messages.count).to eq 4
+        end
+
+        it 'should not be verified by using expired verification code' do
+          account.confirmed_at = nil
+          account.save
+          expect(account.verify(account.messages.first.code)).to be_false
+        end
+
+        it 'should be the latest_message' do
+          expect(account.latest_message).to eq account.messages.last
+        end
+
+        it 'should be the same value for verified_at and confirmed_at' do
+          expect(account.verified_at).to eq account.confirmed_at
+        end
+      end
+    end
+  end
+end