devise_phone 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bcb01262a5e91e8368c10a98a3693a528c53abdb
+  data.tar.gz: 9e43d108a7ed7225c60375c27ece4e9d02aaef88
+SHA512:
+  metadata.gz: 66429d68ca92ad9c7ede79c87e1ef239709008f557770d3f370f713c56c45d9496fc82cf2ec1ba455c00b1a87d0262034a321e8a55f708ea176f142916e3e506
+  data.tar.gz: 47b1c752d7e2b932ea08d83a7d9f0efb1c757a14bc1a7c93427cd919a167994de4d00bbb7c0c40a3bac7d90eae09fef0ca6ee25c6c0025b9c8de6f4c777a8ab8

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,45 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# gem generated
+*.gem
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+#
+# For TextMate
+*.tmproj
+tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+

data/Gemfile.lock

@@ -0,0 +1,8 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Hubert Theodore
+
+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.rdoc

@@ -0,0 +1,73 @@
+= devise_sms_confirmation
+
+Devise Phone is a snap-in for Devise that will make any resource activable via SMS.
+The user will receive an SMS with a token that can be entered on the site to activate the account.
+Ask the user his phone (and phone confirmation to double check) on registration and the token will be sended automagically.
+
+== Installation for Rails >= 3.0 and Devise >= 1.1
+
+Install DevisePhone gem, it will also install dependencies (such as devise and warden):
+
+  gem install devise_phone
+
+Add DevisePhone to your Gemfile (and Devise and TwilioRuby if you weren't using them):
+
+  gem 'devise', 			'~> 3.4.1'
+  gem 'twilio-ruby', 	'~> 4.2.0'
+  gem 'devise_phone', '~> 0.0.1'
+
+=== Automatic installation
+
+Run the following generator to add DevisePhone’s configuration option in the Devise configuration file (config/initializers/devise.rb) and the sms sender class in your lib folder:
+
+  rails generate devise_phone:install
+
+When you are done, you are ready to add DevisePhone to any of your Devise models using the following generator:
+
+  rails generate devise_phone MODEL
+
+Replace MODEL by the class name you want to add DevisePhone, like User, Admin, etc. This will add the :phone flag to your model's Devise modules. The generator will also create a migration file (if your ORM support them). Continue reading this file to understand exactly what the generator produces and how to use it.
+
+== Configuring views
+
+All the views are packaged inside the gem. If you'd like to customize the views, invoke the following generator and it will copy all the views to your application:
+
+  rails generate devise_phone:views
+
+You can also use the generator to generate scoped views:
+
+  rails generate devise_phone:views users
+
+Please refer to {Devise's README}[http://github.com/plataformatec/devise] for more information about views.
+
+== Usage
+
+The model is specular to the Devise's own Confirmable model. It only requires the user to supply a valid phone number.
+
+On registration it will send an SMS with a token to be inserted to complete activation process.
+By default users MUST activate by SMS before entering.
+If you want something more "relaxed" just override <tt>sms_confirmation_required?</tt> in your model and make it your way.
+You can use the convenience filter <tt>require_sms_activated!</tt> in your controller to block sms-unactive users from specific pages.
+
+== Controller filter
+
+DevisePhone extends your controllers with a <tt>require_sms_activated!</tt> method. Use it to restrict part of the site to "confirmed users" only
+
+== I18n
+
+DevisePhone installs a localizable file in your config/locales folder.
+
+== Contributing to devise_phone
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2015 Hubert Theodore. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,21 @@
+require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc 'Default: run tests for all ORMs.'
+task :default => :tests
+
+desc 'Run Devise tests for all ORMs.'
+task :tests do
+  Dir[File.join(File.dirname(__FILE__), 'test', 'orm', '*.rb')].each do |file|
+    orm = File.basename(file).split(".").first
+    system "rake test DEVISE_ORM=#{orm}"
+  end
+end

data/app/controllers/devise/phone_verifications_controller.rb

@@ -0,0 +1,51 @@
+class Devise::PhoneVerificationsController < DeviseController
+
+  # GET /resource/phone_verification/new
+  def new
+    build_resource({})
+    render :new
+  end
+
+  # POST /resource/phone_verification
+  def create
+
+    self.send_verification_code
+
+    # self.resource = resource_class.send_verification_code
+    
+    # if resource.errors.empty?
+    #   set_flash_message :notice, :send_token, :phone => self.resource.phone
+    #   redirect_to new_session_path(resource_name)
+    # else
+    #   render :new
+    # end
+  end
+  
+  # GET /resource/phone_verification/insert
+  def insert
+    build_resource({})
+  end
+  
+  # GET or POST /resource/phone_verification/consume?sms_token=abcdef
+  def consume
+    
+    self.verify_phone_number_with_code_entered(params[:code_entered])
+
+    # self.resource = resource_class.verify_phone_number_with_code_entered(params[:code_entered])
+
+    # if resource.errors.empty?
+    #   set_flash_message :notice, :confirmed
+    #   sign_in_and_redirect(resource_name, resource)
+    # else
+    #   render :new
+    # end
+
+  end
+  
+  protected
+  
+    def build_resource(hash = nil)
+      self.resource = resource_class.new
+    end
+
+end

data/app/views/devise/sms_activations/insert.html.erb

@@ -0,0 +1,11 @@
+<h2>Activate Phone Number</h2>
+
+<%= form_for(resource, :as => resource_name, :url => consume_phone_verification_path(resource_name), :html => { :method => :post }) do |f| %>
+  
+  <p><%=label_tag :code_entered %><br />
+  <%=text_field_tag :code_entered, "" %></p>
+ 
+  <p><%= f.submit "Activate" %></p>
+<% end %>
+
+<%= render :partial => "devise/shared/links" %>

data/app/views/devise/sms_activations/new.html.erb

@@ -0,0 +1,12 @@
+<h2>Resend Phone Verification Code</h2>
+
+<%= form_for(resource, :as => resource_name, :url => phone_verification_path(resource_name), :html => { :method => :post }) do |f| %>
+  <%= devise_error_messages! %>
+
+  <p><%= f.label :email %><br />
+  <%= f.email_field :email %></p>
+
+  <p><%= f.submit "Resend Phone Verification Code" %></p>
+<% end %>
+
+<%= render :partial => "devise/shared/links" %>

data/config/locales/en.yml

@@ -0,0 +1,15 @@
+en:
+  errors:
+     messages:
+       no_phone_associated: "No phone associated"
+       sms_already_confirmed: "This token has been already used"
+       sms_token_invalid: "was not locked"
+  devise:
+    sms_activations:
+      send_token: 'An activation token was sent by SMS to %{phone}.'
+      sms_token_invalid: 'The sms token provided is not valid!'
+      confirmed: 'Your account has been activated. You are now signed in.'
+      sms_activation_required: 'SMS Activation is required'
+      sms_body: 'Your Activation Token is %{sms_confirmation_token}.'
+      unconfirmed_sms: 'Your account need to be activated with an SMS token'
+      

data/devise_phone.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'devise_phone/version'
+
+Gem::Specification.new do |s|
+  s.name         = "devise_phone"
+  s.version      = DevisePhone::VERSION
+  s.authors      = ["Hubert Theodore"]
+  s.email        = ["htheodore@gmail.com"]
+  s.homepage     = "https://github.com/tjhubert/devise_phone"
+  s.license      = "MIT"
+  s.summary      = "Send SMS to verify phone number"
+  s.description  = "It sends verification code via SMS (using Twilio). User enters the code to confirm the phone number."
+  s.files        = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # s.files        = Dir["{app,config,lib}/**/*"] + %w[LICENSE README.rdoc]
+  # s.require_path = "lib"
+  # s.rdoc_options = ["--main", "README.rdoc", "--charset=UTF-8"]
+
+  # s.required_ruby_version     = '>= 1.8.6'
+  # s.required_rubygems_version = '>= 1.3.6'
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  {
+    'bundler'     => '~> 1.10',
+    # 'rspec',
+    'rake'        => '~> 10.0'
+  }.each do |lib, version|
+    s.add_development_dependency(lib, version)
+  end
+
+  {
+    'rails'  => '>= 4.0.0',
+    'devise' => '>= 3.0.0',
+    'twilio-ruby' => '>= 4.0.0'
+  }.each do |lib, version|
+    s.add_runtime_dependency(lib, version)
+  end
+
+end

data/lib/devise_phone.rb

@@ -0,0 +1,31 @@
+require "devise"
+require "twilio-ruby"
+
+$: << File.expand_path("..", __FILE__)
+
+require "devise_phone/routes"
+require "devise_phone/schema"
+require 'devise_phone/controllers/url_helpers'
+require 'devise_phone/controllers/helpers'
+require 'devise_phone/rails'
+
+module Devise
+  # mattr_accessor :sms_confirm_within
+  # @@sms_confirm_within = 2.days
+  # mattr_accessor :sms_confirmation_keys
+  # @@sms_confirmation_keys = [:email]
+  
+  # Get the sms sender class from the mailer reference object.
+  def self.sms_sender
+    @@sms_sender_ref.get
+  end
+
+  # Set the smser reference object to access the smser.
+  def self.sms_sender=(class_name)
+    @@sms_sender_ref = ActiveSupport::Dependencies.reference(class_name)
+  end
+  
+  self.sms_sender = "Devise::SmsSender"
+end
+
+Devise.add_module :phone, :model => "models/phone", :controller => :phone_verifications, :route => :phone_verification

data/lib/devise_phone/controllers/helpers.rb

@@ -0,0 +1,12 @@
+module DeviseSmsPhone::Controllers::Helpers
+  protected
+  
+  # Convenience helper to check if user has confirmed the token (and the phone) or not.
+  def require_sms_activated!
+    if(send(:"authenticate_#{resource_name}!"))
+      res=send(:"current_#{resource_name}")
+      fail!(:sms_activation_required) if (!res) || (!res.sms_confirmed?)
+    end
+  end
+end
+ActionController::Base.send :include, DeviseSmsPhone::Controllers::Helpers

data/lib/devise_phone/controllers/url_helpers.rb

@@ -0,0 +1,24 @@
+module DevisePhone
+  module Controllers
+    module UrlHelpers
+      [:path, :url].each do |path_or_url|
+        [nil, :new_, :create_, :activate_].each do |action|
+          class_eval <<-URL_HELPERS, __FILE__, __LINE__ + 1
+            def #{action}phone_verification_#{path_or_url}(resource, *args)
+              resource = case resource
+                when Symbol, String
+                  resource
+                when Class
+                  resource.name.underscore
+                else
+                  resource.class.name.underscore
+              end
+              
+              send("#{action}\#{resource}_phone_verification_#{path_or_url}", *args)
+            end
+          URL_HELPERS
+        end
+      end
+    end
+  end
+end

data/lib/devise_phone/hooks.rb

@@ -0,0 +1,11 @@
+# Deny user access whenever his account is not active yet. All strategies that inherits from
+# Devise::Strategies::Authenticatable and uses the validate already check if the user is active?
+# before actively signing him in. However, we need this as hook to validate the user activity
+# in each request and in case the user is using other strategies beside Devise ones.
+Warden::Manager.after_set_user do |record, warden, options|
+  if record && record.respond_to?(:active?) && !record.active?
+    scope = options[:scope]
+    warden.logout(scope)
+    throw :warden, :scope => scope, :message => record.inactive_message
+  end
+end

data/lib/devise_phone/rails.rb

@@ -0,0 +1,12 @@
+module DeviseInvitable
+  class Engine < ::Rails::Engine
+
+    ActiveSupport.on_load(:action_controller) { include DevisePhone::Controllers::UrlHelpers }
+    ActiveSupport.on_load(:action_view)       { include DevisePhone::Controllers::UrlHelpers }
+
+    config.after_initialize do
+    
+    end
+
+  end
+end

data/lib/devise_phone/routes.rb

@@ -0,0 +1,13 @@
+module ActionDispatch::Routing
+  class Mapper
+    
+    protected
+      def devise_phone(mapping, controllers)
+        resource :phone_verification, :only => [:new, :create], :path => mapping.path_names[:phone_verification], :controller => controllers[:phone_verifications] do
+          match :consume, :path => mapping.path_names[:consume], :as => :consume
+          get :insert, :path => mapping.path_names[:insert], :as => :insert
+        end
+      end
+
+  end
+end

data/lib/devise_phone/schema.rb

@@ -0,0 +1,14 @@
+module DevisePhone
+  module Schema
+
+    def phone
+      apply_devise_schema :phone_number,   String
+      apply_devise_schema :phone_number_verified,   Boolean
+      apply_devise_schema :phone_verification_code,   String, :limit => 6
+      apply_devise_schema :phone_verification_code_sent_at, DateTime
+      apply_devise_schema :phone_verified_at, DateTime
+    end
+  end
+end
+
+#Devise::Schema.send :include, DeviseSmsActivable::Schema

data/lib/devise_phone/version.rb

@@ -0,0 +1,3 @@
+module DevisePhone
+  VERSION = "0.0.1".freeze
+end

data/lib/generators/active_record/devise_phone_generator.rb

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

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

@@ -0,0 +1,11 @@
+class DevisePhoneAddTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+      add_column :<%= table_name %>, :phone_number, :string
+      add_column :<%= table_name %>, :phone_number_verified, :boolean
+      add_column :<%= table_name %>, :phone_verification_code, :string, :limit => 6
+      add_column :<%= table_name %>, :phone_verification_code_sent_at, :datetime
+      add_column :<%= table_name %>, :phone_verified_at, :datetime
+
+      add_index 	:<%= table_name %>, :phone_number, unique: true
+  end
+end

data/lib/generators/devise_phone/devise_phone_generator.rb

@@ -0,0 +1,20 @@
+module DevisePhone
+  module Generators
+    class DevisePhoneGenerator < Rails::Generators::NamedBase
+      namespace "devise_phone"
+
+      desc "Add :phone_number directive in the given model. Also generate migration for ActiveRecord"
+
+      # def devise_generate_model
+      #   invoke "devise", [name]
+      # end
+
+      def inject_devise_phone_content
+        path = File.join("app", "models", "#{file_path}.rb")
+        inject_into_file(path, "phone_number, :", :after => "devise :") if File.exists?(path)
+      end
+
+      hook_for :orm
+    end
+  end
+end

data/lib/generators/devise_phone/install_generator.rb

@@ -0,0 +1,52 @@
+module DevisePhone
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Add DevisePhone config variables to the Devise initializer and copy DeviseSms locale files to your application."
+      
+      # def devise_install
+      #   invoke "devise:install"
+      # end
+      
+      def add_config_options_to_initializer
+        devise_initializer_path = "config/initializers/devise.rb"
+        if File.exist?(devise_initializer_path)
+          old_content = File.read(devise_initializer_path)
+          
+          if old_content.match(Regexp.new(/^\s# ==> Configuration for :phone\n/))
+            false
+          else
+            inject_into_file(devise_initializer_path, :before => "  # ==> Configuration for :confirmable\n") do
+<<-CONTENT
+  # ==> Configuration for :sms_activable
+  # The period the generated sms token is valid, after
+  # this period, the user won't be able to activate.
+  # config.sms_confirm_within = 0.days
+
+  # The keys searched for confirmation values.
+  # config.sms_confirmation_keys = [:email]
+  
+  # Your SmsSender class. The provided one uses 
+  # moonshado-sms gem so install it and configure
+  # if you want to use it.
+  # A simple instance of the class has been copied in your lib folder
+  # For further informations on using and configuring moonshado-sms gem check
+  # https://github.com/moonshado/moonshado-sms
+  # config.sms_sender = "Devise::SmsSender"
+  
+CONTENT
+            end
+          end
+        end
+      end
+      
+      def copy_locale
+        copy_file "../../../config/locales/en.yml", "config/locales/devise_phone.en.yml"
+      end
+      
+      def copy_default_smser
+        copy_file "lib/sms_sender.rb", "lib/devise_sms_sender.rb"
+      end
+    end
+  end
+end

data/lib/generators/devise_phone/views_generator.rb

@@ -0,0 +1,10 @@
+require 'generators/devise/views_generator'
+
+module DevisePhone
+  module Generators
+    class ViewsGenerator < Devise::Generators::ViewsGenerator
+      source_root File.expand_path("../../../../app/views", __FILE__)
+      desc 'Copies all DevisePhone views to your application.'
+    end
+  end
+end

data/lib/generators/mongoid/devise_phone_generator.rb

@@ -0,0 +1,8 @@
+require 'generators/devise/orm_helpers'
+
+module Mongoid
+  module Generators
+    class DevisePhoneGenerator < Rails::Generators::NamedBase
+    end
+  end
+end

data/lib/generators/templates/lib/sms_sender.rb

@@ -0,0 +1,19 @@
+	class Devise::SmsSender
+  #Actually sends the sms token. feel free to modify and adapt to your provider and/or gem
+  def send_sms_verification_code_to(user)
+    number_to_send_to = user.phone_number
+    verification_code = user.phone_verification_code
+
+    twilio_sid = "ACd35391c08cde7926e2295d1812ada918"
+    twilio_token = "44d79a36adb3d54cc15711d94d149119"
+    twilio_phone_number = "6502810746"
+
+    @twilio_client = Twilio::REST::Client.new twilio_sid, twilio_token
+ 
+    @twilio_client.account.sms.messages.create(
+      :from => "+1#{twilio_phone_number}",
+      :to => number_to_send_to,
+      :body => "Hi! This is MathCrunch. Your verification code is #{verification_code}"
+    )
+  end
+end

data/lib/models/phone.rb

@@ -0,0 +1,215 @@
+require "devise_phone/hooks"
+
+module Devise
+  module Models
+    # SmsActivable is responsible to verify if an account is already confirmed to
+    # sign in, and to send sms with confirmation instructions.
+    # Confirmation instructions are sent to the user phone after creating a
+    # record and when manually requested by a new confirmation instruction request.
+    #
+    # == Options
+    #
+    # Confirmable adds the following options to devise_for:
+    #
+    #   * +sms_confirm_within+: the time you want to allow the user to access his account
+    #     before confirming it. After this period, the user access is denied. You can
+    #     use this to let your user access some features of your application without
+    #     confirming the account, but blocking it after a certain period (ie 7 days).
+    #     By default confirm_within is 0 days, so the user must confirm before entering.
+    #     If you want to allow user to use parts of the site and block others override 
+    #     sms_confirmation_required? and check manually on selected pages using the
+    #     require_sms_activated! helper or sms_confirmed? property on record
+    #
+    # == Examples
+    #
+    #   User.find(1).sms_confirm!      # returns true unless it's already confirmed
+    #   User.find(1).sms_confirmed?    # true/false
+    #   User.find(1).send_sms_token # manually send token
+    #
+    module Phone
+      extend ActiveSupport::Concern
+
+      included do
+        before_create :set_phone_attributes, :if => :phone_verification_needed?
+        after_create  :generate_verification_code_and_send_sms, :if => :phone_verification_needed?
+      end
+
+      # # Confirm a user by setting it's sms_confirmed_at to actual time. If the user
+      # # is already confirmed, add en error to email field
+      # def confirm_sms!
+      #   unless_sms_confirmed do
+      #     self.sms_confirmation_token = nil
+      #     self.sms_confirmed_at = Time.now
+      #     save(:validate => false)
+      #   end
+      # end
+
+      # # Verifies whether a user is sms-confirmed or not
+      # def confirmed_sms?
+      #   !!sms_confirmed_at
+      # end
+
+      # Send confirmation token by sms
+      def generate_verification_code_and_send_sms
+        if(self.phone_number?)
+          self.phone_verification_code = generate_phone_verification_code
+          ::Devise.sms_sender.send_sms_verification_code_to(self)
+        else
+          # self.errors.add(:sms_confirmation_token, :no_phone_associated)
+          false
+        end
+      end
+
+      # # Resend sms confirmation token. This method does not need to generate a new token.
+      # def resend_sms_token
+      #   unless_sms_confirmed { send_sms_token }
+      # end
+
+      # Overwrites active? from Devise::Models::Activatable for sms confirmation
+      # by verifying whether a user is active to sign in or not. If the user
+      # is already confirmed, it should never be blocked. Otherwise we need to
+      # calculate if the confirm time has not expired for this user.
+
+      # def active?
+      #   !sms_confirmation_required? || confirmed_sms? || confirmation_sms_period_valid?
+      # end
+
+      # # The message to be shown if the account is inactive.
+      # def inactive_message
+      #   !confirmed_sms? ? I18n.t(:"devise.sms_activations.unconfirmed_sms") : super
+      # end
+
+      # # If you don't want confirmation to be sent on create, neither a code
+      # # to be generated, call skip_sms_confirmation!
+      # def skip_sms_confirmation!
+      #   self.sms_confirmed_at = Time.now
+      # end
+
+      protected
+
+        # Callback to overwrite if an sms confirmation is required or not.
+        def phone_verification_needed?
+          phone_number.present? && !phone_number_verified
+        end
+
+        # def sms_confirmation_required?
+        #   !confirmed_sms?
+        # end
+
+        # Checks if the confirmation for the user is within the limit time.
+        # We do this by calculating if the difference between today and the
+        # confirmation sent date does not exceed the confirm in time configured.
+        # Confirm_in is a model configuration, must always be an integer value.
+        #
+        # Example:
+        #
+        #   # sms_confirm_within = 1.day and sms_confirmation_sent_at = today
+        #   confirmation_period_valid?   # returns true
+        #
+        #   # sms_confirm_within = 5.days and sms_confirmation_sent_at = 4.days.ago
+        #   confirmation_period_valid?   # returns true
+        #
+        #   # sms_confirm_within = 5.days and sms_confirmation_sent_at = 5.days.ago
+        #   confirmation_period_valid?   # returns false
+        #
+        #   # sms_confirm_within = 0.days
+        #   confirmation_period_valid?   # will always return false
+        #
+        # def confirmation_sms_period_valid?
+        #   sms_confirmation_sent_at && sms_confirmation_sent_at.utc >= self.class.sms_confirm_within.ago
+        # end
+
+        # # Checks whether the record is confirmed or not, yielding to the block
+        # # if it's already confirmed, otherwise adds an error to email.
+        # def unless_sms_confirmed
+        #   unless confirmed_sms?
+        #     yield
+        #   else
+        #     self.errors.add(:sms_confirmation_token, :sms_already_confirmed)
+        #     false
+        #   end
+        # end
+
+        # Generates a new random token for confirmation, and stores the time
+        # this token is being generated
+        def set_phone_attributes
+
+          self.phone_number_verified = false
+          self.phone_verification_code_sent_at = DateTime.now
+          self.phone_verified_at = nil
+          # removes all white spaces, hyphens, and parenthesis
+          self.phone_number.gsub!(/[\s\-\(\)]+/, '')
+        end
+
+        def generate_phone_verification_code
+          # begin
+          verification_code = SecureRandom.hex(3)
+          # end while self.class.exists?(phone_verification_code: verification_code)
+          verification_code
+        end
+
+        # def generate_sms_token!
+        #   generate_sms_token && save(:validate => false)
+        # end
+
+        module ClassMethods
+          # # Attempt to find a user by it's email. If a record is found, send a new
+          # # sms token instructions to it. If not user is found, returns a new user
+          # # with an email not found error.
+          # # Options must contain the user email
+          # def send_sms_token(attributes={})
+          #   sms_confirmable = find_or_initialize_with_errors(sms_confirmation_keys, attributes, :not_found)
+          #   sms_confirmable.resend_sms_token if sms_confirmable.persisted?
+          #   sms_confirmable
+          # end
+
+          # # Find a user by it's sms confirmation token and try to confirm it.
+          # # If no user is found, returns a new user with an error.
+          # # If the user is already confirmed, create an error for the user
+          # # Options must have the sms_confirmation_token
+          # def confirm_by_sms_token(sms_confirmation_token)
+          #   sms_confirmable = find_or_initialize_with_error_by(:sms_confirmation_token, sms_confirmation_token)
+          #   sms_confirmable.confirm_sms! if sms_confirmable.persisted?
+          #   sms_confirmable
+          # end
+
+          def mark_phone_as_verified!
+            update!(phone_number_verified: true,
+                   phone_verification_code: nil,
+                   phone_verification_code_sent_at: nil,
+                   phone_verified_at: DateTime.now)
+          end 
+
+          def verify_phone_number_with_code_entered(code_entered)
+            if self.phone_verification_code == code_entered
+              mark_phone_as_verified!
+            end
+          end
+
+          def send_verification_code
+            self.set_phone_attributes
+            if self.save!
+              send_sms_for_phone_verification
+            end
+          end
+
+          # # Generates a small token that can be used conveniently on SMS's.
+          # # The token is 5 chars long and uppercased.
+
+          # def generate_small_token(column)
+          #   loop do
+          #     token = Devise.friendly_token[0,5].upcase
+          #     break token unless to_adapter.find_first({ column => token })
+          #   end
+          # end
+
+          # # Generate an sms token checking if one does not already exist in the database.
+          # def sms_confirmation_token
+          #   generate_small_token(:sms_confirmation_token)
+          # end
+
+          # Devise::Models.config(self, :sms_confirm_within, :sms_confirmation_keys)
+        end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require 'devise'
+
+$: << File.expand_path("..", __FILE__)
+
+require 'lib/devise_phone'

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: devise_phone
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hubert Theodore
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: It sends verification code via SMS (using Twilio). User enters the code
+  to confirm the phone number.
+email:
+- htheodore@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- app/controllers/devise/phone_verifications_controller.rb
+- app/views/devise/sms_activations/insert.html.erb
+- app/views/devise/sms_activations/new.html.erb
+- config/locales/en.yml
+- devise_phone.gemspec
+- lib/devise_phone.rb
+- lib/devise_phone/controllers/helpers.rb
+- lib/devise_phone/controllers/url_helpers.rb
+- lib/devise_phone/hooks.rb
+- lib/devise_phone/rails.rb
+- lib/devise_phone/routes.rb
+- lib/devise_phone/schema.rb
+- lib/devise_phone/version.rb
+- lib/generators/active_record/devise_phone_generator.rb
+- lib/generators/active_record/templates/migration.rb
+- lib/generators/devise_phone/devise_phone_generator.rb
+- lib/generators/devise_phone/install_generator.rb
+- lib/generators/devise_phone/views_generator.rb
+- lib/generators/mongoid/devise_phone_generator.rb
+- lib/generators/templates/lib/sms_sender.rb
+- lib/models/phone.rb
+- rails/init.rb
+homepage: https://github.com/tjhubert/devise_phone
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Send SMS to verify phone number
+test_files: []