devise-twilio-verify 0.1.0

data/lib/devise-twilio-verify/models/twilio_verify_authenticatable.rb

@@ -0,0 +1,21 @@
+require 'devise-twilio-verify/hooks/twilio_verify_authenticatable'
+module Devise
+  module Models
+    module TwilioVerifyAuthenticatable
+      extend ActiveSupport::Concern
+
+      def with_twilio_verify_authentication?(request)
+        self.twilio_verify_enabled?
+      end
+
+      module ClassMethods
+        def find_by_mobile_phone(mobile_phone)
+          where(mobile_phone: mobile_phone).first
+        end
+
+        Devise::Models.config(self, :twilio_verify_remember_device, :twilio_verify_enable_qr_code)
+      end
+    end
+  end
+end
+

data/lib/devise-twilio-verify/models/twilio_verify_lockable.rb

@@ -0,0 +1,43 @@
+module Devise
+
+  module Models
+
+    # Handles blocking a user access after a certain number of attempts.
+    # Requires proper configuration of the Devise::Models::Lockable module.
+    #
+    module TwilioVerifyLockable
+
+      extend ActiveSupport::Concern
+
+      # Public: Determine if this is a lockable resource, via Devise::Models::Lockable.
+      # Returns true
+      # Raises an error if the Devise::Models::Lockable module is not configured.
+      def lockable?
+        raise 'Devise lockable extension required' unless respond_to? :lock_access!
+        Devise.lock_strategy == :failed_attempts
+      end
+
+      # Public: Handle a failed 2FA attempt. If the resource is lockable via
+      # Devise::Models::Lockable module then enforce that setting.
+      #
+      # Returns true if the user is locked out.
+      def invalid_twilio_verify_attempt!
+        return false unless lockable?
+
+        self.failed_attempts ||= 0
+        self.failed_attempts += 1
+
+        if attempts_exceeded?
+          lock_access! unless access_locked?
+          true
+        else
+          save validate: false
+          false
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/devise-twilio-verify/rails.rb

@@ -0,0 +1,16 @@
+module DeviseTwilioVerify
+  class Engine < ::Rails::Engine
+    ActiveSupport.on_load(:action_controller) do
+      include DeviseTwilioVerify::Controllers::Helpers
+    end
+    ActiveSupport.on_load(:action_view) do
+      include DeviseTwilioVerify::Views::Helpers
+    end
+
+    # extend mapping with after_initialize because it's not reloaded
+    config.after_initialize do
+      Devise::Mapping.send :prepend, DeviseTwilioVerify::Mapping
+    end
+  end
+end
+

data/lib/devise-twilio-verify/routes.rb

@@ -0,0 +1,21 @@
+module ActionDispatch::Routing
+  class Mapper
+    protected
+
+    def devise_twilio_verify(mapping, controllers)
+      match "/#{mapping.path_names[:verify_twilio_verify]}", :controller => controllers[:devise_twilio_verify], :action => :GET_verify_twilio_verify, :as => :verify_twilio_verify, :via => :get
+      match "/#{mapping.path_names[:verify_twilio_verify]}", :controller => controllers[:devise_twilio_verify], :action => :POST_verify_twilio_verify, :as => nil, :via => :post
+
+      match "/#{mapping.path_names[:enable_twilio_verify]}", :controller => controllers[:devise_twilio_verify], :action => :GET_enable_twilio_verify, :as => :enable_twilio_verify, :via => :get
+      match "/#{mapping.path_names[:enable_twilio_verify]}", :controller => controllers[:devise_twilio_verify], :action => :POST_enable_twilio_verify, :as => nil, :via => :post
+
+      match "/#{mapping.path_names[:disable_twilio_verify]}", :controller => controllers[:devise_twilio_verify], :action => :POST_disable_twilio_verify, :as => :disable_twilio_verify, :via => :post
+
+      match "/#{mapping.path_names[:verify_twilio_verify_installation]}", :controller => controllers[:devise_twilio_verify], :action => :GET_verify_twilio_verify_installation, :as => :verify_twilio_verify_installation, :via => :get
+      match "/#{mapping.path_names[:verify_twilio_verify_installation]}", :controller => controllers[:devise_twilio_verify], :action => :POST_verify_twilio_verify_installation, :as => nil, :via => :post
+
+      match "/#{mapping.path_names[:request_sms]}", :controller => controllers[:devise_twilio_verify], :action => :request_sms, :as => :request_sms, :via => :post
+    end
+  end
+end
+

data/lib/devise-twilio-verify/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DeviseTwilioVerify
+  VERSION = '0.1.0'
+end

data/lib/devise-twilio-verify.rb

@@ -0,0 +1,32 @@
+require 'active_support/concern'
+require 'active_support/core_ext/integer/time'
+require 'devise'
+require 'twilio-ruby'
+
+module Devise
+  mattr_accessor :twilio_verify_remember_device, :twilio_verify_enable_qr_code
+  @@twilio_verify_remember_device = 1.month
+  @@twilio_verify_enable_qr_code = false
+end
+
+module DeviseTwilioVerify
+  autoload :Mapping, 'devise-twilio-verify/mapping'
+
+  module Controllers
+    autoload :Passwords, 'devise-twilio-verify/controllers/passwords'
+    autoload :Helpers, 'devise-twilio-verify/controllers/helpers'
+  end
+
+  module Views
+    autoload :Helpers, 'devise-twilio-verify/controllers/view_helpers'
+  end
+end
+
+require 'devise-twilio-verify/routes'
+require 'devise-twilio-verify/rails'
+require 'devise-twilio-verify/models/twilio_verify_authenticatable'
+require 'devise-twilio-verify/models/twilio_verify_lockable'
+require 'devise-twilio-verify/version'
+
+Devise.add_module :twilio_verify_authenticatable, :model => 'devise-twilio-verify/models/twilio_verify_authenticatable', :controller => :devise_twilio_verify, :route => :twilio_verify
+Devise.add_module :twilio_verify_lockable,        :model => 'devise-twilio-verify/models/twilio_verify_lockable'

data/lib/generators/active_record/devise_twilio_verify_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators/active_record'
+
+module ActiveRecord
+  module Generators
+    class DeviseTwilioVerifyGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_devise_migration
+        migration_template "migration.rb", "db/migrate/devise_twilio_verify_add_to_#{table_name}.rb", migration_version: migration_version
+      end
+
+      private
+
+      def versioned_migrations?
+        Rails::VERSION::MAJOR >= 5
+      end
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if versioned_migrations?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+class DeviseTwilioVerifyAddTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    change_table :<%= table_name %> do |t|
+      t.string    :authy_id
+      t.datetime  :last_sign_in_with_twilio_verify
+      t.boolean   :twilio_verify_enabled, :default => false
+    end
+
+    add_index :<%= table_name %>, :authy_id
+  end
+
+  def self.down
+    change_table :<%= table_name %> do |t|
+      t.remove :authy_id, :last_sign_in_with_twilio_verify, :twilio_verify_enabled
+    end
+  end
+end
+

data/lib/generators/devise_twilio_verify/devise_twilio_verify_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DeviseTwilioVerify
+  module Generators
+    class DeviseTwilioVerifyGenerator < Rails::Generators::NamedBase
+      namespace "devise_twilio_verify"
+
+      desc "Add :twilio_verify_authenticatable directive in the given model, plus accessors. Also generate migration for ActiveRecord"
+
+      def inject_devise_twilio_verify_content
+        path = File.join(destination_root, "app", "models", "#{file_path}.rb")
+        if File.exist?(path) &&
+           !File.read(path).include?("twilio_verify_authenticatable")
+          inject_into_file(path,
+                           "twilio_verify_authenticatable, :",
+                           :after => "devise :")
+        end
+
+        if File.exist?(path) &&
+           !File.read(path).include?(":authy_id")
+          inject_into_file(path,
+                           ":authy_id, :last_sign_in_with_twilio_verify, ",
+                           :after => "attr_accessible ")
+        end
+      end
+
+      hook_for :orm
+    end
+  end
+end

data/lib/generators/devise_twilio_verify/install_generator.rb

@@ -0,0 +1,80 @@
+require "rails/generators"
+
+module DeviseTwilioVerify
+  module Generators
+    # Install Generator
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      class_option :haml, :type => :boolean, :required => false, :default => false, :desc => "Generate views in Haml"
+      class_option :sass, :type => :boolean, :required => false, :default => false, :desc => "Generate stylesheet in Sass"
+
+      desc "Install the devise twilio verify extension"
+
+      def add_configs
+        inject_into_file "config/initializers/devise.rb", "\n" +
+        "  # ==> Devise Twilio Verify Authentication Extension\n" +
+        "  # How long should the user's device be remembered for.\n" +
+        "  # config.twilio_verify_remember_device = 1.month\n\n" +
+        "  # Should generating QR codes for other authenticator apps be enabled?\n" +
+        "  # Note: you need to enable this in your Twilio console.\n" +
+        "  # config.twilio_verify_enable_qr_code = false\n\n", :after => "Devise.setup do |config|\n"
+      end
+
+      def add_initializer
+        initializer("twilio_verify.rb") do
+          "# TODO"
+        end
+      end
+
+      def copy_locale
+        copy_file "../../../config/locales/en.yml", "config/locales/devise.twilio_verify.en.yml"
+      end
+
+      def copy_views
+        if options.haml?
+          copy_file '../../../app/views/devise/enable_twilio_verify.html.haml', 'app/views/devise/devise_twilio_verify/enable_twilio_verify.html.haml'
+          copy_file '../../../app/views/devise/verify_twilio_verify.html.haml', 'app/views/devise/devise_twilio_verify/verify_twilio_verify.html.haml'
+          copy_file '../../../app/views/devise/verify_twilio_verify_installation.html.haml', 'app/views/devise/devise_twilio_verify/verify_twilio_verify_installation.html.haml'
+        else
+          copy_file '../../../app/views/devise/enable_twilio_verify.html.erb', 'app/views/devise/devise_twilio_verify/enable_twilio_verify.html.erb'
+          copy_file '../../../app/views/devise/verify_twilio_verify.html.erb', 'app/views/devise/devise_twilio_verify/verify_twilio_verify.html.erb'
+          copy_file '../../../app/views/devise/verify_twilio_verify_installation.html.erb', 'app/views/devise/devise_twilio_verify/verify_twilio_verify_installation.html.erb'
+        end
+      end
+
+      def copy_assets
+        if options.sass?
+          copy_file '../../../app/assets/stylesheets/devise_twilio_verify.sass', 'app/assets/stylesheets/devise_twilio_verify.sass'
+        else
+          copy_file '../../../app/assets/stylesheets/devise_twilio_verify.css', 'app/assets/stylesheets/devise_twilio_verify.css'
+        end
+        copy_file '../../../app/assets/javascripts/devise_twilio_verify.js', 'app/assets/javascripts/devise_twilio_verify.js'
+      end
+
+      def inject_assets_in_layout
+        {
+          :haml => {
+            :before => %r{%body\s*$},
+            :content => %@
+    =javascript_include_tag "https://www.authy.com/form.authy.min.js"
+    =stylesheet_link_tag "https://www.authy.com/form.authy.min.css"
+@
+          },
+          :erb => {
+            :before => %r{\s*<\/\s*head\s*>\s*},
+            :content => %@
+  <%=javascript_include_tag "https://www.authy.com/form.authy.min.js" %>
+  <%=stylesheet_link_tag "https://www.authy.com/form.authy.min.css" %>
+@
+          }
+        }.each do |extension, opts|
+          file_path = File.join(destination_root, "app", "views", "layouts", "application.html.#{extension}")
+          if File.exist?(file_path) && !File.read(file_path).include?("form.twilio_verify.min.js")
+            inject_into_file(file_path, opts.delete(:content), opts)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,343 @@
+--- !ruby/object:Gem::Specification
+name: devise-twilio-verify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jay Wolff
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  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: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.74'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.74'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.11.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !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: 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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+description: Twilio Verify plugin to add two factor authentication to Devise. This
+  gem is meant to make migrating from authy to twilio verify as simple as possible,
+  please see the README for details.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".rspec"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/devise_twilio_verify.js
+- app/assets/stylesheets/devise_twilio_verify.css
+- app/assets/stylesheets/devise_twilio_verify.sass
+- app/controllers/devise/devise_twilio_verify_controller.rb
+- app/controllers/devise_twilio_verify/passwords_controller.rb
+- app/services/twilio_verify_service.rb
+- app/views/devise/enable_twilio_verify.html.erb
+- app/views/devise/enable_twilio_verify.html.haml
+- app/views/devise/verify_twilio_verify.html.erb
+- app/views/devise/verify_twilio_verify.html.haml
+- app/views/devise/verify_twilio_verify_installation.html.erb
+- app/views/devise/verify_twilio_verify_installation.html.haml
+- config.ru
+- config/locales/en.yml
+- devise-twilio-verify.gemspec
+- gemfiles/.bundle/config
+- gemfiles/rails_5_2.gemfile
+- gemfiles/rails_6.gemfile
+- lib/devise-twilio-verify.rb
+- lib/devise-twilio-verify/controllers/helpers.rb
+- lib/devise-twilio-verify/controllers/view_helpers.rb
+- lib/devise-twilio-verify/hooks/twilio_verify_authenticatable.rb
+- lib/devise-twilio-verify/mapping.rb
+- lib/devise-twilio-verify/models/twilio_verify_authenticatable.rb
+- lib/devise-twilio-verify/models/twilio_verify_lockable.rb
+- lib/devise-twilio-verify/rails.rb
+- lib/devise-twilio-verify/routes.rb
+- lib/devise-twilio-verify/version.rb
+- lib/generators/active_record/devise_twilio_verify_generator.rb
+- lib/generators/active_record/templates/migration.rb
+- lib/generators/devise_twilio_verify/devise_twilio_verify_generator.rb
+- lib/generators/devise_twilio_verify/install_generator.rb
+homepage: https://github.com/jayywolff/twilio-verify-devise
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/jayywolff/twilio-verify-devise/issues
+  change_log_uri: https://github.com/jayywolff/twilio-verify-devise/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/jayywolff/twilio-verify-devise
+  homepage_uri: https://github.com/jayywolff/twilio-verify-devise
+  source_code_uri: https://github.com/jayywolff/twilio-verify-devise
+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: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Twilio Verify plugin to add two factor authentication to Devise.
+test_files: []