devise_mobile_confirmable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70b185da869661a090f223f60487c8a5791e22e8
+  data.tar.gz: a9203ce3809bbe2cbcccf872fe4fa880cf15c803
+SHA512:
+  metadata.gz: 7fece75fb675368adc6dc5e6cd52567047e72f7c1e01bec7b41d865636665fabbd1b1e8750ace80abc6ea0564b41537cf65fb23f7b5b7c8cb5c65bd95c128443
+  data.tar.gz: 6cfaf568eb838d54c135fe6ac9c9e7cc567d338f7b63f9724dd3ac44b6adcdf7ab250f5c437a91bf913153511476d528da0f18cb4b441c5e3bb6e0eec6d2555d

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chen, Yi-Cyuan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# devise_mobile_confirmable
+
+[![Build Status](https://api.travis-ci.org/emn178/devise_mobile_confirmable.png)](https://travis-ci.org/emn178/devise_mobile_confirmable)
+[![Coverage Status](https://coveralls.io/repos/emn178/devise_mobile_confirmable/badge.svg?branch=master)](https://coveralls.io/r/emn178/devise_mobile_confirmable?branch=master)
+
+It adds support to devise for confirming users' mobile by SMS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'devise_mobile_confirmable'
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install devise_mobile_confirmable
+
+Run the following generator to add DeviseMobileConfirmable's configuration option into the Devise configuration file (config/initializers/devise.rb):
+
+    rails g devise_mobile_confirmable:install
+
+## Requirements
+
+[devise](https://github.com/plataformatec/devise)  
+[SMS Carrier](https://github.com/emn178/sms_carrier)
+
+## Usage
+Add DeviseMobileConfirmable to your Devise models using the following generator:
+
+    rails g devise_mobile_confirmable MODEL
+
+For example
+
+    rails g devise_mobile_confirmable user
+
+And you can use following methods:
+```Ruby
+user.mobile_confirmed?             # true if confirmed
+user.change_mobile '+886987654321' # send SMS with token to user
+user.confirm_mobile_token '123456' # user input the token and confirm his mobile phone
+user.mobile                        # eg. '+886987654321'
+
+# return how many seconds to enable next SMS request, equal or less than 0 will unlock
+user.seconds_to_unlock_mobile_confirmation_token
+```
+You can overwrite token generating method, in model class:
+```Ruby
+def generate_mobile_confirmation_token
+  # return your token
+end
+```
+
+## Configuration
+You can set options in devise.rb
+```Ruby
+  # ==> Configuration for :mobile_confirmable
+  # Specify mobile field in table.
+  # Default: :mobile
+  # config.mobile_field = :mobile
+
+  # Prevent too many requests for sending token by SMS.
+  # Default: 60.seconds
+  # config.throttle_mobile_confirmation_token = 60.seconds
+
+  # Expire token if too many retries. This is for preventing from brute force attack. 
+  # Set to 0 to disable this feature.
+  # Default: 3
+  # config.max_mobile_confirmation_failure = 3
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contact
+The project's website is located at https://github.com/emn178/devise_mobile_confirmable  
+Author: Chen, Yi-Cyuan (emn178@gmail.com)

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DeviseMobileConfirmable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/config/locales/en.yml

@@ -0,0 +1,8 @@
+en:
+  errors:
+    messages:
+      indifferent: is indifferent
+      retry_later: Please retry later
+  devise:
+    carrier:
+      mobile_confirmation_token: Your token is %{token}

data/config/spring.rb

@@ -0,0 +1 @@
+Spring.application_root = './spec/dummy'

data/lib/devise_mobile_confirmable.rb

@@ -0,0 +1,18 @@
+require 'devise'
+require 'devise_mobile_confirmable/engine'
+
+module DeviseMobileConfirmable
+end
+
+module Devise
+  mattr_accessor :mobile_field
+  @@mobile_field = :mobile
+
+  mattr_accessor :throttle_mobile_confirmation_token
+  @@throttle_mobile_confirmation_token = 60.seconds
+
+  mattr_accessor :max_mobile_confirmation_failure
+  @@max_mobile_confirmation_failure = 3
+end
+
+Devise.add_module :mobile_confirmable, :model => 'devise_mobile_confirmable/model'

data/lib/devise_mobile_confirmable/engine.rb

@@ -0,0 +1,4 @@
+module DeviseMobileConfirmable
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/devise_mobile_confirmable/model.rb

@@ -0,0 +1,91 @@
+require 'sms_carrier'
+
+module Devise
+  module Models
+    module MobileConfirmable
+      def mobile_confirmed?
+        mobile_confirmed_at.present?
+      end
+
+      def change_mobile(new_mobile)
+        errors.add(self.class.mobile_field, :blank) if new_mobile.blank?
+        errors.add(self.class.mobile_field, :indifferent) if mobile == new_mobile
+        errors.add(:base, :retry_later) unless can_send_mobile_confirmation_token?
+        return false unless errors.empty?
+
+        self.unconfirmed_mobile = new_mobile
+        if mobile_confirmation_token_expired?
+          self.mobile_confirmation_token = generate_mobile_confirmation_token
+          self.mobile_confirmation_failure = 0
+        end
+        self.mobile_confirmation_sent_at = Time.now
+        return false unless save
+        send_mobile_confirmation_token
+        errors.empty?
+      end
+
+      def confirm_mobile_token(token)
+        errors.add(:mobile_confirmation_token, :blank) if token.blank?
+        errors.add(:mobile_confirmation_token, :expired) if mobile_confirmation_token_expired?
+        return false unless errors.empty?
+        if mobile_confirmation_token != token
+          update(:mobile_confirmation_failure => mobile_confirmation_failure + 1)
+          errors.add(:mobile_confirmation_token, :invalid)
+          return false
+        end
+        self.mobile = unconfirmed_mobile
+        self.unconfirmed_mobile = nil
+        self.mobile_confirmation_token = nil
+        self.mobile_confirmed_at = Time.now
+        self.mobile_confirmation_failure = 0
+        save
+      end
+
+      def seconds_to_unlock_mobile_confirmation_token
+        return 0 if mobile_confirmation_sent_at.nil?
+        self.class.throttle_mobile_confirmation_token - (Time.now - mobile_confirmation_sent_at).to_i
+      end
+
+      def can_send_mobile_confirmation_token?
+        seconds_to_unlock_mobile_confirmation_token <= 0
+      end
+
+      def mobile_confirmation_token_expired?
+        mobile_confirmation_token.nil? ||
+        mobile_confirmation_failure >= self.class.max_mobile_confirmation_failure && self.class.max_mobile_confirmation_failure != 0
+      end
+
+      def mobile
+        if self.class.mobile_field == :mobile
+          super
+        else
+          self.send(self.class.mobile_field)
+        end
+      end
+
+      def mobile=(value)
+        if self.class.mobile_field == :mobile
+          super
+        else
+          self.send(self.class.mobile_field.to_s + '=', value)
+        end
+      end
+
+      protected
+
+      def send_mobile_confirmation_token
+        SmsCarrier::Base.sms(:to => unconfirmed_mobile, :body => I18n.t('devise.carrier.mobile_confirmation_token', :token => mobile_confirmation_token)).deliver_now
+      end
+
+      def generate_mobile_confirmation_token
+        rand(100000..999999)
+      end
+
+      module ClassMethods
+        Devise::Models.config(self, :mobile_field)
+        Devise::Models.config(self, :throttle_mobile_confirmation_token)
+        Devise::Models.config(self, :max_mobile_confirmation_failure)
+      end
+    end
+  end
+end

data/lib/devise_mobile_confirmable/version.rb

@@ -0,0 +1,3 @@
+module DeviseMobileConfirmable
+  VERSION = "0.1.0"
+end

data/lib/generators/active_record/devise_mobile_confirmable_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class DeviseMobileConfirmableGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_devise_migration
+        migration_template "migration.rb", "db/migrate/devise_mobile_confirmable_add_to_#{table_name}.rb"
+      end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,20 @@
+class DeviseMobileConfirmableAddTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def up
+    change_table :<%= table_name %> do |t|
+      t.string     :mobile
+      t.string     :unconfirmed_mobile
+      t.string     :mobile_confirmation_token
+      t.datetime   :mobile_confirmed_at
+      t.datetime   :mobile_confirmation_sent_at
+      t.integer    :mobile_confirmation_failure, default: 0, null: false
+    end
+    # remove unique: true if it's allowed
+    add_index :<%= table_name %>, :mobile, unique: true
+  end
+
+  def down
+    change_table :<%= table_name %> do |t|
+      t.remove :mobile_confirmation_token, :mobile_confirmed_at, :mobile_confirmation_sent_at, :unconfirmed_mobile, :mobile_confirmation_failure
+    end
+  end
+end

data/lib/generators/devise_mobile_confirmable/devise_mobile_confirmable_generator.rb

@@ -0,0 +1,16 @@
+module DeviseMobileConfirmable
+  module Generators
+    class DeviseMobileConfirmableGenerator < Rails::Generators::NamedBase
+      namespace "devise_mobile_confirmable"
+
+      desc "Add :mobile_confirmable directive in the given model. Also generate migration for ActiveRecord"
+
+      def inject_devise_invitable_content
+        path = File.join(destination_root, "app", "models", "#{file_path}.rb")
+        inject_into_file(path, "mobile_confirmable, :", :after => "devise :") if File.exists?(path)
+      end
+
+      hook_for :orm
+    end
+  end
+end

data/lib/generators/devise_mobile_confirmable/install_generator.rb

@@ -0,0 +1,42 @@
+module DeviseMobileConfirmable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../", __FILE__)
+      desc "Add DeviseMobileConfirmable config variables to the Devise initializer and copy DeviseMobileConfirmable locale files to your application."
+
+      def add_config_options_to_initializer
+        devise_initializer_path = File.join(destination_root, "config" , "initializers", "devise.rb")
+        if File.exist?(devise_initializer_path)
+          old_content = File.read(devise_initializer_path)
+
+          if old_content.include?('# ==> Configuration for :mobile_confirmable')
+            false
+          else
+            inject_into_file(devise_initializer_path, :before => "  # ==> Configuration for :confirmable\n") do
+<<-CONTENT
+  # ==> Configuration for :mobile_confirmable
+  # Specify mobile field in table.
+  # Default: :mobile
+  # config.mobile_field = :mobile
+
+  # Prevent too many requests for sending token by SMS.
+  # Default: 60.seconds
+  # config.throttle_mobile_confirmation_token = 60.seconds
+
+  # Expire token if too many retries. This is for preventing from brute force attack. 
+  # Set to 0 to disable this feature.
+  # Default: 3
+  # config.max_mobile_confirmation_failure = 3
+
+CONTENT
+            end
+          end
+        end
+      end
+
+      def copy_locale
+        copy_file "config/locales/en.yml", "config/locales/devise_mobile_confirmable.en.yml"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: devise_mobile_confirmable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chen, Yi-Cyuan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sms_carrier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It adds support to devise for confirming users' mobile by SMS.
+email:
+- emn178@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/locales/en.yml
+- config/spring.rb
+- lib/devise_mobile_confirmable.rb
+- lib/devise_mobile_confirmable/engine.rb
+- lib/devise_mobile_confirmable/model.rb
+- lib/devise_mobile_confirmable/version.rb
+- lib/generators/active_record/devise_mobile_confirmable_generator.rb
+- lib/generators/active_record/templates/migration.rb
+- lib/generators/devise_mobile_confirmable/devise_mobile_confirmable_generator.rb
+- lib/generators/devise_mobile_confirmable/install_generator.rb
+homepage: https://github.com/emn178/devise_mobile_confirmable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: It adds support to devise for confirming users' mobile by SMS.
+test_files: []