devise_sms_confirmable 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7da634ddbe05a536e69cfc4223581ca87f6f22e7aa35e6bbaaa8f8927d16cce
-  data.tar.gz: e779c465edf5eda673f6a90cd50b5273309c903adaebc272e3a500df3526e50d
+  metadata.gz: '049bae282e2af2b808e51365d2477664439dc89e7847b92f3242c8b6334843fe'
+  data.tar.gz: d0b596cfe10169aaa6cd38aaf9009600d102990519c25b24baaa22c5a11a139c
 SHA512:
-  metadata.gz: 85925719b646dd4e7482c4d1bc9b8889a7249416504e0884fbead9dc0b4b08499791061552250e5fa326d7789da8a7d108621e521f6c7f27b6a65e071fea60fc
-  data.tar.gz: d87a5c77aef9b90a4e07e29629cc91ce841395538d67e30b80b7ea507ef2686f6f8636c059f688181a2125389c977232d94579b01a59dd614bcb3f5ec5395d29
+  metadata.gz: a35a12708450aa0d22d91a220487964df17219393ceac24110819d9bbffa2657cb4f8a562ea0854b4fcdc3461492d04bae947de3defbd252a26c7b32f4f2d46c
+  data.tar.gz: 6734e8771b51f17a7763af0fe16d8f28fb792d4ad00829e90f9db8b562ae1c59ca120e3c69199a671c2976540aebeab407c03273a199f1034978f9b77eda43f5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devise_sms_confirmable (0.1.2)
+    devise_sms_confirmable (0.1.3)
       devise (>= 4.6.2)
       rails (~> 5.1.4)
       textris (~> 0.7)

data/README.md

@@ -1,15 +1,15 @@
 # DeviseSmsConfirmable
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/devise_sms_confirmable`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+DeviseSmsConfirmable is a module provide SMS confirmation. The user will receive an SMS with a token that can be entered on the site to activate the account. You can handle SMS's Message template as Devise handles ActionMailer's template.
 
 ## Installation
-
-Add this line to your application's Gemfile:
+Installation for Rails ~> 5.1.4 and Devise ~> 4.6.2
+Add this line to your application's Gemfile (and Devise and TwilioRuby if you weren't using them):
 
 ```ruby
+gem 'devise'
 gem 'devise_sms_confirmable'
+gem 'twilio-ruby'
 ```
 
 And then execute:
@@ -21,14 +21,75 @@ Or install it yourself as:
     $ gem install devise_sms_confirmable
 
 ## Usage
+To use it, simply specify your DeviseSmsConfirmable configuration in ```config/initializers/devise.rb```:
+
+```ruby
+# Load the module for SMS confirmation
+require 'devise_sms_confirmable'
+# Default source phone number
+config.sms_sender = 'some_e164_phone_number'
+```
+
+### Configuring Models
+Add :sms_confirmable option to The Devise method in your models.
+
+```ruby
+devise :database_authenticatable, :sms_confirmable
+
+``` 
+
+### Add columns to model
+```ruby
+t.string   :phone,              null: false, default: ""
+t.string   :sms_confirmation_token
+t.datetime :sms_confirmed_at
+t.datetime :sms_confirmation_sent_at
+# t.string   :unconfirmed_phone # Only if using reconfirmable
+```
+
+### Allow models to sign in using their phone number
+
+```ruby
+config.authentication_keys = [:phone]
+```
+
+## Configuring twilio-ruby 
+
+config/initializers/twilio.rb
+
+### Choosing and chaining delivery methods
+devise_sms_confirmable use [textris](https://github.com/visualitypl/textris) for the delivery system. See textris for details.
+The following is a sample (quoted from textris) using twilio.
 
-TODO: Write usage instructions here
+```ruby
+# Send messages via the Twilio REST API
+config.textris_delivery_method = :twilio
+
+# Don't send anything, log messages into Rails logger
+config.textris_delivery_method = :log
+
+# Don't send anything, access your messages via Textris::Base.deliveries
+config.textris_delivery_method = :test
+```
 
-## Development
+### Twilio
+textris connects with the Twilio API using twilio-ruby gem. It does not, however, install the gem for you. If you don't have it yet, add the twilio-ruby gem to Gemfile:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+gem 'twilio-ruby'
+```
+
+Then, pre-configure the twilio-ruby settings by creating the config/initializers/twilio.rb file:
+
+```ruby
+
+Twilio.configure do |config|
+  config.account_sid = 'some_sid'
+  config.auth_token  = 'some_auth_token'
+end
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To use Twilio's Copilot use twilio_messaging_service_sid in place of from when sending a text or setting defaults.
 
 ## Contributing
 

data/app/texters/devise/texter.rb

@@ -2,7 +2,6 @@
 
 if defined?(Textris)
   class Devise::Texter < Textris::Base
-    default from: "+48666777888"
 
     def confirmation_instructions(record, token, opts={})
       @token = token
@@ -10,7 +9,7 @@ if defined?(Textris)
 
       headers = { to: @resource.phone }.merge(opts)
 
-      text to: headers[:to]
+      send_sms(headers)
     end
 
     def reset_password_instructions(record, token, opts={})
@@ -19,7 +18,7 @@ if defined?(Textris)
 
       headers = { to: @resource.phone }.merge(opts)
 
-      text to: headers[:to]
+      send_sms(headers)
     end
 
     def unlock_instructions(record, token, opts={})
@@ -28,7 +27,7 @@ if defined?(Textris)
 
       headers = { to: @resource.phone }.merge(opts)
 
-      text to: headers[:to]
+      send_sms(headers)
     end
 
     def phone_changed(record, token, opts={})
@@ -37,7 +36,7 @@ if defined?(Textris)
 
       headers = { to: @resource.phone }.merge(opts)
 
-      text to: headers[:to]
+      send_sms(headers)
     end
 
     def password_change(record, token, opts={})
@@ -46,7 +45,11 @@ if defined?(Textris)
 
       headers = { to: @resource.phone }.merge(opts)
 
-      text to: headers[:to]
+      send_sms(headers)
+    end
+
+    def send_sms(headers)
+      text(to: headers[:to], from: Devise.sms_sender)
     end
   end
 end

data/devise_sms_confirmable.gemspec

@@ -5,11 +5,11 @@ require "devise_sms_confirmable/version"
 Gem::Specification.new do |spec|
   spec.name          = "devise_sms_confirmable"
   spec.version       = DeviseSmsConfirmable::VERSION
-  spec.authors       = ["matsutani"]
+  spec.authors       = ["uuushiro"]
   spec.email         = ["yushiro.ma2ta2.21@gmail.com"]
 
-  spec.summary       = %q{Module provide sms confirmation.}
-  spec.description   = %q{Module provide sms confirmation.}
+  spec.summary       = %q{Module provide sms confirmation.You can handle SMS Message template  as Devise handles ActionMailer template.}
+  spec.description   = %q{Module provide sms confirmation.You can handle SMS Message template  as Devise handles ActionMailer template.}
   spec.homepage      = "https://github.com/uuushiro/devise_sms_confirmable"
   spec.license       = "MIT"
 

data/lib/devise_sms_confirmable/version.rb

@@ -1,3 +1,3 @@
 module DeviseSmsConfirmable
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_sms_confirmable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
-- matsutani
+- uuushiro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: devise
@@ -150,7 +150,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Module provide sms confirmation.
+description: Module provide sms confirmation.You can handle SMS Message template  as
+  Devise handles ActionMailer template.
 email:
 - yushiro.ma2ta2.21@gmail.com
 executables: []
@@ -205,5 +206,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Module provide sms confirmation.
+summary: Module provide sms confirmation.You can handle SMS Message template  as Devise
+  handles ActionMailer template.
 test_files: []