twilio_contactable 0.8.4 → 0.8.5

data/README.markdown

@@ -1,13 +1,13 @@
 Twilio Contactable
 =====
 
-Twilio makes voice and SMS interactions easy. But if you want to be able to seamlessly validate your user's phone numbers for
-both voice and text there's a lot of work you'll have to do in your Rails app. Unless you use this gem.
+Twilio makes voice and SMS interactions easy. But if you want to ensure that your user's phone numbers really belong
+to them there's a lot of buggy code you'll have to add in your Ruby app. Unless you use this gem.
 
 Don't Write Twilio Ruby Code Like It's PHP
 ==
 
-You don't want to be passing strings around and writing procedural code in your Ruby app. This gem lets you ask for a phone number from your users (or any ActiveRecord model), confirm their ownership of it via SMS or Voice or both, and keep track of whether the number is still validated whenever the number is edited.
+You don't want to be passing strings around between multiple web requests and writing procedural code in your Ruby app. Not for such a simple feature. This gem lets you ask for a phone number from your users (or any ActiveRecord-like Ruby class), confirm their ownership of it via SMS or Voice (or both), and automatically handle number invalidation.
 
 
 Install It
@@ -15,8 +15,14 @@ Install It
 
 Install TwilioContactable as a gem:
 
-    gem install twilio_contactable
-    # then add this gem to your project in .gems or in environment.rb
+    $ gem install twilio_contactable
+    
+    # For Rails add it in environment.rb:
+    config.gem 'twilio_contactable'
+
+    # then edit your .gems file or run
+    $ rake gems:unpack
+    # to unpack the gem into your vendor/gems directory
 
 Or as a Plugin:
 
@@ -27,7 +33,7 @@ Connect This Code To Your App
 ==
 
 
-Include Twilio::Contactable into your User class or whatever you're using to represent an entity with a phone number. 
+Include Twilio::Contactable into your User class or whatever you're using to represent an entity with a contactable phone number.
 
     class User < ActiveRecord::Base
 
@@ -37,7 +43,7 @@ Include Twilio::Contactable into your User class or whatever you're using to rep
 
     end
 
-If you're using custom column names you can easily overwrite any of them:
+If you're using custom column names you can easily overwrite any of them by passing in a configuration block:
 
     class User < ActiveRecord::Base
 
@@ -77,8 +83,8 @@ You'll need to add those columns to your database table using a migration that l
       t.string    :voice_confirmed_phone_number
     end
 
-You don't necessarily need all those columns though. Say you have users that are notified by SMS but business locations that
-just need to have their retail phone number validated:
+You don't necessarily need all those columns though. Say you have users that want to use SMS and business locations that
+just need to have their retail phone number to confirm their identity:
 
     change_table :users do |t|
       t.string    :phone_number
@@ -99,21 +105,23 @@ just need to have their retail phone number validated:
 
 Both the User and the BusinessLocation models are now prepared for SMS and Voice confirmation, respectively.
 
-You'll also need to create a controller that is capable of receiving connections from Twilio.com:
+You'll also need to create a controller that is capable of receiving connections from Twilio.com. You can reuse an existing controller or
+create a new one just for this task. TwilioContactable will guess the path from the controller name, so if you include it into a class called CheckPhoneNumbersController:
 
-    # app/controllers/twilio_contactable_controller.rb
-    class TwilioContactableController < ActionController::Base
+    # app/controllers/check_phone_numbers_controller.rb
+    class CheckPhoneNumbersController < ActionController::Base
       include TwilioContactable::Controller
 
       # any models that you want to have phone numbers confirmed for:
       twilio_contactable User, BusinessLocation
     end
 
+then Twilio.com would try to contact your site at '/check_phone_numbers'. As long as that route works then you don't need to configure anything else.
 
-Configure It With Twilio Account Info
+Configure It With Your Twilio Account Info
 ==
 
-Because it can be expensive to send TXTs or make calls accidentally, it's required that you manually configure TwilioContactable in your app. Put this line in config/environments/production.rb or anything that loads _only_ in your production environment:
+Because it can be expensive to send TXTs or make calls accidentally, it's required that you manually set TwilioContactable.mode in your app. Put this line in config/environments/production.rb or anything that loads _only_ in your production environment:
 
     TwilioContactable.mode = :live
 
@@ -203,12 +211,9 @@ Make sure Twilio.com knows to POST all SMS messages and block notices to you at:
 
 This gem will handle all those incoming messages automatically. Now if your users reply to an SMS with 'STOP' or 'BLOCK' the appropriate record in your database will be updated so that sms messages no longer can be sent to them (i.e.: @user.sms_blocked? will be true)
 
-All other incoming TXTs (besides 'BLOCK' and 'STOP') from a user will automatically be sent to that user's record:
+All other incoming TXTs (besides 'BLOCK' and 'STOP') from a user will automatically be sent to that user's record. If "I love you!" is sent to you from a user with the phone number "555-111-9999" then the following will be executed:
 
-   # If "I love you!" is sent to you from a user with
-   # the phone number "555-111-9999"
-   # then the following will be executed:
-   User.find_by_formatted_phone_number('+15551119999').receive_sms("I love you!")
+    User.find_by_formatted_phone_number('+15551119999').receive_sms("I love you!")
 
 It's up to you to implement the 'receive_sms' method on User.
 

data/VERSION

@@ -1 +1 @@
-0.8.4
+0.8.5

data/lib/contactable.rb

@@ -79,7 +79,7 @@ module TwilioContactable
 
     def has_valid_phone_number?
       format_phone_number
-      _TC_formatted_phone_number =~ /^\+[\d]{11,12}$/
+      _TC_formatted_phone_number =~ /^\+[\d]{10,12}$/
     end
 
     # Sends an SMS validation request through the gateway
@@ -89,7 +89,14 @@ module TwilioContactable
       return false if _TC_phone_number.blank?
 
       format_phone_number
-      confirmation_code = TwilioContactable.generate_confirmation_code
+      confirmation_code =
+        if sms_confirmation_attempted &&
+           sms_confirmation_code &&
+           sms_confirmation_attempted > Time.now.utc - 60*5
+          sms_confirmation_code
+        else
+          TwilioContactable.generate_confirmation_code
+        end
 
       # Use this class' confirmation_message method if it
       # exists, otherwise use the generic message
@@ -118,7 +125,14 @@ module TwilioContactable
       return false if _TC_phone_number.blank?
 
       format_phone_number
-      confirmation_code = TwilioContactable.generate_confirmation_code
+      confirmation_code =
+        if voice_confirmation_attempted &&
+           voice_confirmation_code &&
+           voice_confirmation_attempted > Time.now.utc - 60*5
+          voice_confirmation_code
+        else
+          TwilioContactable.generate_confirmation_code
+        end
 
       response = TwilioContactable::Gateway.initiate_voice_call(self, _TC_formatted_phone_number)
 

data/lib/twilio_contactable.rb

@@ -9,10 +9,8 @@ module TwilioContactable
       case number.size
       when 10
         "+1#{number}"
-      when 11
+      when 11,12
         "+#{number}"
-      when 12
-        number =~ /\+\d(11)/ ? number : nil
       else
         nil
       end

data/test/twilio_contactable_contactable_test.rb

@@ -34,6 +34,40 @@ class TwilioContactableContactableTest < ActiveSupport::TestCase
     should "normalize phone number" do
       assert_equal '+15551234567', @user.formatted_phone_number
     end
+    context "has_valid_phone_number?" do
+      context "with a two-digit country code" do
+        setup {
+          @user.update_attribute :phone_number, '+11 (222) 333-7777'
+        }
+        should "be valid" do
+          assert @user.has_valid_phone_number?
+        end
+      end
+      context "with a one-digit country code" do
+        setup {
+          @user.update_attribute :phone_number, '+1 (222) 333-7777'
+        }
+        should "be valid" do
+          assert @user.has_valid_phone_number?
+        end
+      end
+      context "with no country code" do
+        setup {
+          @user.update_attribute :phone_number, '(222) 333-7777'
+        }
+        should "be valid" do
+          assert @user.has_valid_phone_number?
+        end
+      end
+      context "with no area code" do
+        setup {
+          @user.update_attribute :phone_number, '333-7777'
+        }
+        should "not be valid" do
+          assert !@user.has_valid_phone_number?
+        end
+      end
+    end
     context "when phone number is blank" do
       setup { @user._TC_phone_number = nil}
       context "confirming phone number" do

data/twilio_contactable.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{twilio_contactable}
-  s.version = "0.8.4"
+  s.version = "0.8.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jack Danger Canty"]
-  s.date = %q{2010-09-02}
+  s.date = %q{2010-09-03}
   s.description = %q{Does all the hard work with letting you confirm your user's phone numbers for Voice or TXT over the Twilio API}
   s.email = %q{gitcommit@6brand.com}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: twilio_contactable
 version: !ruby/object:Gem::Version 
-  hash: 55
   prerelease: false
   segments: 
   - 0
   - 8
-  - 4
-  version: 0.8.4
+  - 5
+  version: 0.8.5
 platform: ruby
 authors: 
 - Jack Danger Canty
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-02 00:00:00 -07:00
+date: 2010-09-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 5
         segments: 
         - 2
         - 0
@@ -42,7 +40,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -56,7 +53,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -102,7 +98,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -111,7 +106,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"