devise-twilio-verify 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 474f80f30182d50c461662ac4927abeb8a7e896b7f2bc92b538073e1538db06f
-  data.tar.gz: 27dfc2219f247de90a1bfb7d32546050cfb505f1f0afefe1b5d442ce00500a6b
+  metadata.gz: 6e2dc87050d08efb2621ee7de3931552c37b008a8dc4173ab7703bbf93ae6ee2
+  data.tar.gz: 944943aafe21f00cdd7ac4eb6dfdd0cca830449915ad6d055cbbc46377e6d80b
 SHA512:
-  metadata.gz: 5c553ebfcecf53b015eb4767c4ff3acba7386eb861ad1854ee9c712d53b7d20f1fdf37e6a657837730ffa7a60c2fc4cd604b7cd3c49dadc4854b14427659fe01
-  data.tar.gz: 2b31f9e9319e89a49db84b6aa6cf34e022c781dba6ed14d185ebf37446928e37379589b42c5ced9f4b939124896c9ca6a76e6a37ca140681b47d379697eb20c9
+  metadata.gz: aee70ac3e6df7704c3415a29b15725ecf367a026b56e8a983acf9b40a81cc53421443bdae113a4aac03531742216c63878fb4de5b08208649effcc6b575e48ff
+  data.tar.gz: 847f60d57d832ce3414e8080db98bff200ac3a79223fc76686e6cf8bd20fe524a3ac5fb2fe22570975301ad4c6f63c9360ee223c33b38061798f7b80a1b34f6c

data/.gitignore

@@ -37,6 +37,7 @@ gemfiles/*.lock
 .rvmrc
 
 **/*.sqlite
+**/*.sqlite-*
 **/*.log
 
 initializers/twilio_verify.rb

data/Appraisals

@@ -3,9 +3,9 @@ appraise "rails-5-2" do
   gem "sqlite3", "~> 1.3.13"
 
   group :development, :test do
-    gem 'factory_girl_rails', :require => false
-    gem 'rspec-rails', "~>4.0.0.beta3", :require => false
-    gem 'database_cleaner', :require => false
+    gem 'factory_girl_rails', require: false
+    gem 'rspec-rails', "~> 5.0.0", require: false
+    gem 'database_cleaner', require: false
   end
 end if RUBY_VERSION.to_f < 3.0
 
@@ -15,8 +15,32 @@ appraise "rails-6" do
   gem "net-smtp"
 
   group :development, :test do
-    gem 'factory_girl_rails', :require => false
-    gem 'rspec-rails', "~>4.0.0.beta3", :require => false
-    gem 'database_cleaner', :require => false
+    gem 'factory_girl_rails', require: false
+    gem 'rspec-rails', "~> 5.0.0", require: false
+    gem 'database_cleaner', require: false
   end
-end if RUBY_VERSION.to_f >= 2.5
+end if RUBY_VERSION.to_f >= 2.5
+
+appraise "rails-7" do
+  gem "rails", "~> 7.0.8"
+  gem "sqlite3", "~> 1.4"
+  gem "net-smtp"
+
+  group :development, :test do
+    gem 'factory_girl_rails', require: false
+    gem 'rspec-rails', "~> 7.0.0", require: false
+    gem 'database_cleaner', require: false
+  end
+end if RUBY_VERSION.to_f >= 2.7
+
+appraise "rails-7-1" do
+  gem "rails", "~> 7.1.5"
+  gem "sqlite3", "~> 1.4"
+  gem "net-smtp"
+
+  group :development, :test do
+    gem 'factory_girl_rails', require: false
+    gem 'rspec-rails', "~> 7.1.0", require: false
+    gem 'database_cleaner', require: false
+  end
+end if RUBY_VERSION.to_f >= 2.7

data/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.2.2] - 2024-12-29
+
+### Changed
+
+- Updated gemspec summary/description 
+
+## [0.2.1] - 2024-12-29
+
+### Changed
+
+- Added apprasials for testing against Rails 7 and Rails 7.1
+- Bump rspec-rails version from "~>4.0.0.beta3" to "~> 5.0.0" for Rails 5.2 and Rails 6 testing
+- Updated README to move the authy migration instructions a bit below the README gem introduction / instructions
+
 ## [0.2.0] - 2024-12-21
 
 ### Changed

data/README.md

@@ -1,45 +1,4 @@
-# Migrate Authy to Twilio Verify API (for SMS and TOTP 2FA)
-
-### This gem is meant to be a drop-in replacement for devise-authy in a Rails app (minus the following features)
-- Currently only support mobile phones with US country codes
-- Removed Onetouch support
-- Removed ability to request a phone call
-
-### Just follow the steps below to migrate:
-- Swap out `devise-authy` in your Gemfile with `devise-twilio-verify`
-- `gem 'devise-twilio-verify'
-- Setup a Twilio Verify account
-- Add env vars and/or Rails credentials for:
-  - `TWILIO_AUTH_TOKEN`
-  - `TWILIO_ACCOUNT_SID`
-  - `TWILIO_VERIFY_SERVICE_SID`
-- Create/run a migration to rename  and add the following columns
-  ```ruby
-    class MigrateAuthyToTwilioVerify < ActiveRecord::Migration[6.1]
-      def change
-        rename_column :users, :authy_sms, :twilio_verify_sms
-        rename_column :users, :authy_enabled, :twilio_verify_enabled
-        rename_column :users, :last_sign_in_with_authy, :last_sign_in_with_twilio_verify
-        add_column :users, :twilio_totp_factor_sid, :string
-      end
-    end
-
-  ```
-- you can also delete the `users.authy_id` column if you choose
-- Twilio Verify service sms will be sent to `users.mobile_phone`, so make sure you store the users 2fa phone number in this column, can make this field name dynamic in the future
-- Do a project code wide search & replace of these terms
-  - `devise-authy` -> `devise-twilio-verify`
-  - `authy_` -> `twilio_verify_`
-  -  `_authy` -> `_twilio_verify`
-  -  `authy-` -> `twilio-verify-`
-  -  `-authy` -> `-twilio-verify`
-  -  `Authy` -> `TwilioVerify`
-- Do a project file search & replace of any file with authy in the name (here's a few examples to replace)
-  - app/javascript/src/deviseTwilioVerify.js
-  - app/assets/stylesheets/devise_twilio_verify.scss
-  - config/locales/devise.twilio_verify.en.yml
-
-# Twilio Verify Devise [![Build Status](https://github.com/twilio/authy-devise/workflows/build/badge.svg)](https://github.com/twilio/authy-devise/actions)
+# Twilio Verify Devise [![Build Status](https://github.com/jayywolff/twilio-verify-devise/workflows/build/badge.svg)](https://github.com/jayywolff/twilio-verify-devise/actions)
 
 This is a [Devise](https://github.com/heartcombo/devise) extension to add [Two-Factor Authentication with Twilio Verify](https://www.twilio.com/docs/verify) to your Rails application.
 
@@ -48,10 +7,9 @@ Please visit the Twilio Docs for more information:
 * [Verify + Ruby (Rails) quickstart](https://www.twilio.com/docs/verify/quickstarts/ruby-rails)
 * [Twilio Ruby helper library](https://www.twilio.com/docs/libraries/ruby)
 * [Verify API reference](https://www.twilio.com/docs/verify/api)
-
-
+* [Migrate Authy to Twilio Verify API](#migrate-authy-to-twilio-verify-api)
 * [Pre-requisites](#pre-requisites)
-* [Demo](#demo)
+* [Demo (TODO)](#demo)
 * [Getting started](#getting-started)
   * [Configuring Models](#configuring-models)
     * [With the generator](#with-the-generator)
@@ -246,7 +204,7 @@ This will display a QR code on the verification screen (you still need to take a
 
 In Rails 5 `protect_from_forgery` is no longer prepended to the `before_action` chain. If you call `authenticate_user` before `protect_from_forgery` your request will result in a "Can't verify CSRF token authenticity" error.
 
-To remedy this, add `prepend: true` to your `protect_from_forgery` call, like in this example from the [Twilio Verify Devise demo app](https://github.com/twilio/authy-devise-demo):
+To remedy this, add `prepend: true` to your `protect_from_forgery` call
 
 ```ruby
 class ApplicationController < ActionController::Base
@@ -262,5 +220,47 @@ Run the following command:
 $ bundle exec rspec
 ```
 
+## Migrate Authy to Twilio Verify API
+
+### This gem is meant to be a drop-in replacement for devise-authy in a Rails app (minus the following features)
+- Currently supports SMS and TOTP 2FA
+- Currently only support mobile phones with US country codes
+- Removed Onetouch support
+- Removed ability to request a phone call
+
+### Just follow the steps below to migrate:
+- Swap out `devise-authy` in your Gemfile with `devise-twilio-verify`
+- `gem 'devise-twilio-verify'
+- Setup a Twilio Verify account
+- Add env vars and/or Rails credentials for:
+  - `TWILIO_AUTH_TOKEN`
+  - `TWILIO_ACCOUNT_SID`
+  - `TWILIO_VERIFY_SERVICE_SID`
+- Create/run a migration to rename  and add the following columns
+  ```ruby
+    class MigrateAuthyToTwilioVerify < ActiveRecord::Migration[6.1]
+      def change
+        rename_column :users, :authy_sms, :twilio_verify_sms
+        rename_column :users, :authy_enabled, :twilio_verify_enabled
+        rename_column :users, :last_sign_in_with_authy, :last_sign_in_with_twilio_verify
+        add_column :users, :twilio_totp_factor_sid, :string
+      end
+    end
+
+  ```
+- you can also delete the `users.authy_id` column if you choose
+- Twilio Verify service sms will be sent to `users.mobile_phone`, so make sure you store the users 2fa phone number in this column, can make this field name dynamic in the future
+- Do a project code wide search & replace of these terms
+  - `devise-authy` -> `devise-twilio-verify`
+  - `authy_` -> `twilio_verify_`
+  -  `_authy` -> `_twilio_verify`
+  -  `authy-` -> `twilio-verify-`
+  -  `-authy` -> `-twilio-verify`
+  -  `Authy` -> `TwilioVerify`
+- Do a project file search & replace of any file with authy in the name (here's a few examples to replace)
+  - app/javascript/src/deviseTwilioVerify.js
+  - app/assets/stylesheets/devise_twilio_verify.scss
+  - config/locales/devise.twilio_verify.en.yml
+
 ## Copyright
 See LICENSE.txt for further details.

data/devise-twilio-verify.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.version       = DeviseTwilioVerify::VERSION
   spec.authors       = ["Jay Wolff"]
 
-  spec.summary       = %q{Twilio Verify plugin to add two factor authentication to Devise.}
-  spec.description   = %q{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.}
+  spec.summary       = %q{Devise-Twilio-Verify is a Devise extension that adds two-factor authentication (2FA) support using SMS and/or TOTP via the Twilio Verify API}
+  spec.description   = %q{The devise-twilio-verify gem integrates the Twilio Verify API with Twilio's two-factor authentication (2FA) capabilities with the popular Ruby on Rails authentication framework, Devise. This gem allows you to easily add phone number verification via SMS using Twilio to your Devise-powered application. It provides seamless integration for sending one-time passcodes (OTPs) to users' mobile phones and verifies them during sign-in or account registration. The gem supports customizable settings, ensuring a secure and user-friendly authentication experience by utilizing Twilio's reliable messaging infrastructure. This gem is meant to make migrating from authy to twilio verify as simple as possible, please see the README for details.}
   spec.homepage      = "https://github.com/jayywolff/twilio-verify-devise"
   spec.license       = "MIT"
 

data/gemfiles/rails_5_2.gemfile

@@ -7,7 +7,7 @@ gem "sqlite3", "~> 1.3.13"
 
 group :development, :test do
   gem "factory_girl_rails", require: false
-  gem "rspec-rails", "~>4.0.0.beta3", require: false
+  gem "rspec-rails", "~> 5.0.0", require: false
   gem "database_cleaner", require: false
 end
 

data/gemfiles/rails_6.gemfile

@@ -8,7 +8,7 @@ gem "net-smtp"
 
 group :development, :test do
   gem "factory_girl_rails", require: false
-  gem "rspec-rails", "~>4.0.0.beta3", require: false
+  gem "rspec-rails", "~> 5.0.0", require: false
   gem "database_cleaner", require: false
 end
 

data/gemfiles/rails_7.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.0.8"
+gem "sqlite3", "~> 1.4"
+gem "net-smtp"
+
+group :development, :test do
+  gem "factory_girl_rails", require: false
+  gem "rspec-rails", "~> 7.0.0", require: false
+  gem "database_cleaner", require: false
+end
+
+gemspec path: "../"

data/gemfiles/rails_7_1.gemfile

@@ -0,0 +1,15 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 7.1.5"
+gem "sqlite3", "~> 1.4"
+gem "net-smtp"
+
+group :development, :test do
+  gem "factory_girl_rails", require: false
+  gem "rspec-rails", "~> 7.1.0", require: false
+  gem "database_cleaner", require: false
+end
+
+gemspec path: "../"

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise-twilio-verify
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Jay Wolff
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-22 00:00:00.000000000 Z
+date: 2024-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -304,9 +304,15 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.2
-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.
+description: The devise-twilio-verify gem integrates the Twilio Verify API with Twilio's
+  two-factor authentication (2FA) capabilities with the popular Ruby on Rails authentication
+  framework, Devise. This gem allows you to easily add phone number verification via
+  SMS using Twilio to your Devise-powered application. It provides seamless integration
+  for sending one-time passcodes (OTPs) to users' mobile phones and verifies them
+  during sign-in or account registration. The gem supports customizable settings,
+  ensuring a secure and user-friendly authentication experience by utilizing Twilio's
+  reliable messaging infrastructure. 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: []
@@ -340,6 +346,8 @@ files:
 - gemfiles/.bundle/config
 - gemfiles/rails_5_2.gemfile
 - gemfiles/rails_6.gemfile
+- gemfiles/rails_7.gemfile
+- gemfiles/rails_7_1.gemfile
 - lib/devise-twilio-verify.rb
 - lib/devise-twilio-verify/controllers/helpers.rb
 - lib/devise-twilio-verify/controllers/view_helpers.rb
@@ -381,5 +389,6 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Twilio Verify plugin to add two factor authentication to Devise.
+summary: Devise-Twilio-Verify is a Devise extension that adds two-factor authentication
+  (2FA) support using SMS and/or TOTP via the Twilio Verify API
 test_files: []