4info 1.3.4 → 2.0.0

data/lib/{four_info.rb → txter.rb}

@@ -1,10 +1,12 @@
-module FourInfo
+module Txter
   class << self
     def gateway
-      require 'net/http'
-      URI.parse 'http://gateway.4info.net/msg'
+      Txter::Gateway.current
     end
 
+    delegate :deliver, :to => :gateway
+    delegate :unblock, :to => :gateway
+
     def log(msg)
       if defined?(Rails)
         Rails.logger.info msg
@@ -43,7 +45,6 @@ module FourInfo
 end
 
 require File.join(File.dirname(__FILE__), 'configuration')
+require File.join(File.dirname(__FILE__), 'gateway')
 require File.join(File.dirname(__FILE__), 'contactable')
 require File.join(File.dirname(__FILE__), 'controller')
-require File.join(File.dirname(__FILE__), 'request')
-require File.join(File.dirname(__FILE__), 'response')

data/test/gateway_4info_test.rb

@@ -0,0 +1,75 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Gateway4infoTest < ActiveSupport::TestCase
+
+  Error = Txter::Gateway4info::Response.new('<?xml version="1.0" encoding="UTF-8"?>
+<response>
+  <status>
+    <id>4</id>
+    <message>Error</message>
+  </status>
+</response>')
+  Success = Txter::Gateway4info::Response.new('<?xml version="1.0" ?>
+<response>
+  <requestId>F81D4FAE-7DEC-11D0-A765-00A0C91E6BF6</requestId>
+  <status>
+    <id>1</id>
+    <message>Success</message>
+  </status>
+</response>')
+
+  context "with 4info gateway" do
+    setup {
+      Txter.configure do |config|
+        config.client_id  = 12345
+        config.client_key = 'ABC123'
+        config.gateway    = '4info'
+      end
+    }
+    context "with stubbed success" do
+      setup {
+        Txter::Gateway4info.stubs(:perform).returns(Success)
+      }
+      should "generate a success response object" do
+        assert Txter.deliver("msg", "1-555-867-5309").success?
+      end
+    end
+    context "with stubbed error" do
+      setup {
+        Txter::Gateway4info.stubs(:perform).returns(Error)
+      }
+      should "generate a success response object" do
+        assert !Txter.deliver("msg", "1-555-867-5309").success?
+      end
+    end
+    should "create proper xml for delivery" do
+      expected = <<-EOXML
+<?xml version='1.0' encoding='utf-8' ?>
+<request clientId='12345' clientKey='ABC123' type='MESSAGE'>
+  <message>
+    <recipient>
+      <type>5</type>
+      <id>+15558675309</id>
+    </recipient>
+    <text>msg</text>
+  </message>
+</request>
+EOXML
+      assert_equal expected, Txter::Gateway4info::Request.new.deliver_message("msg", "1-555-867-5309")
+    end
+    should "create proper xml for unblock" do
+      expected = <<-EOXML
+<?xml version='1.0' encoding='utf-8' ?>
+<request clientId='12345' clientKey='ABC123' type='UNBLOCK'>
+  <unblock>
+    <recipient>
+      <type>5</type>
+      <id>+15558675309</id>
+    </recipient>
+  </unblock>
+</request>
+EOXML
+      assert_equal expected, Txter::Gateway4info::Request.new.unblock("1-555-867-5309")
+    end
+  end
+end

data/test/gateway_twilio_test.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class Gateway4infoTest < ActiveSupport::TestCase
+
+  context "with twilio gateway" do
+    setup {
+      Txter.configure do |config|
+        config.client_id  = 12345
+        config.client_key = 'ABC123'
+        config.gateway    = 'twilio'
+      end
+    }
+    # TODO: figure out what's left to test
+  end
+end

data/test/test_helper.rb

@@ -6,15 +6,16 @@ require 'active_support'
 require 'active_record'
 require 'active_support/test_case'
 require 'shoulda'
-require File.join(File.dirname(__FILE__), "..", 'lib', 'four_info')
+require File.join(File.dirname(__FILE__), "..", 'lib', 'txter')
 
 # default test configuration
-FourInfo.configure do |config|
+Txter.configure do |config|
   config.client_id  = '1'
   config.client_key = 'ABCDEF'
+  config.gateway    = 'test'
 end
 
-FourInfo.mode = :test
+Txter.mode = :test
 config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
 ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
 ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite3'])
@@ -32,11 +33,11 @@ ActiveRecord::Schema.define(:version => 1) do
 end
 
 class User < ActiveRecord::Base
-  include FourInfo::Contactable
+  include Txter::Contactable
 end
 
 # kill all network access
-module FourInfo
+module Txter
   class Request
     def start
       raise "You forgot to stub out your net requests!"

data/test/{four_info_contactable_test.rb → txter_contactable_test.rb}

@@ -1,45 +1,21 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
-class FourInfoContactableTest < ActiveSupport::TestCase
+class TxterContactableTest < ActiveSupport::TestCase
 
-  ValidationError = '<?xml version="1.0" encoding="UTF-8"?>
-<response>
-  <status>
-    <id>4</id>
-    <message>Validation Error</message>
-  </status>
-</response>'
-  ValidationSuccess = '<?xml version=”1.0” ?>
-<response>
-  <requestId>F81D4FAE-7DEC-11D0-A765-00A0C91E6BF6</requestId>
-  <confCode>123ABC</confCode>
-  <status>
-    <id>1</id>
-    <message>Success</message>
-  </status>
-</response>'
-  SendMsgSuccess = '<?xml version="1.0" ?>
-<response>
-  <requestId>F81D4FAE-7DEC-11D0-A765-00A0C91E6BF6</requestId>
-  <status>
-    <id>1</id>
-    <message>Success</message>
-  </status>
-</response>'
-  UnblockSuccess = '<?xml version=”1.0” ?>
-<response>
-  <status>
-    <id>1</id>
-    <message>Success</message>
-  </status>
-</response>'
+  Success = Txter::Gateway::Response.new(:status => :success)
+  Error   = Txter::Gateway::Response.new(:status => :error)
 
   context "contactable class" do
     setup {
       @klass = Class.new
-      @klass.send :include, FourInfo::Contactable
+      @klass.send :include, Txter::Contactable
+      Txter.configure do |config|
+        config.client_id  = 12345
+        config.client_key = 'ABC123'
+        config.gateway    = 'test'
+      end
     }
-    FourInfo::Contactable::Attributes.each do |attribute|
+    Txter::Contactable::Attributes.each do |attribute|
       should "begin with appropriate default for #{attribute}_column" do
         assert_equal attribute, @klass.send("#{attribute}_column")
       end
@@ -58,10 +34,10 @@ class FourInfoContactableTest < ActiveSupport::TestCase
     }
 
     should "normalize phone number" do
-      assert_equal '5551234567', @user.four_info_sms_phone_number
+      assert_equal '5551234567', @user.txter_sms_phone_number
     end
     context "when phone number is blank" do
-      setup { @user.four_info_sms_phone_number = nil}
+      setup { @user.txter_sms_phone_number = nil}
       context "confirming phone number" do
         setup { @user.send_sms_confirmation! }
         should_not_change "any attributes" do
@@ -70,7 +46,7 @@ class FourInfoContactableTest < ActiveSupport::TestCase
       end
       context "sending message" do
         setup {
-          FourInfo::Request.any_instance.stubs(:perform).returns(SendMsgSuccess)
+          Txter.gateway.stubs(:perform).returns(Success)
           @worked = @user.send_sms!('message')
         }
         should "not work" do assert !@worked end
@@ -81,45 +57,45 @@ class FourInfoContactableTest < ActiveSupport::TestCase
     end
 
     context "when phone number exists" do
-      setup { @user.four_info_sms_phone_number = "206-555-5555"}
+      setup { @user.txter_sms_phone_number = "206-555-5555"}
       context "confirming phone number" do
         setup {
-          FourInfo::Request.any_instance.stubs(:perform).returns(ValidationSuccess)
+          Txter::Request.any_instance.stubs(:perform).returns(Success)
           @worked = @user.send_sms_confirmation!
         }
         should "work" do assert @worked end
         should "save confirmation number in proper attribute" do
-          assert_equal '123ABC', @user.four_info_sms_confirmation_code
+          assert @user.txter_sms_confirmation_code
         end
         should "set confirmation attempted time" do
-          assert @user.four_info_sms_confirmation_attempted > 3.minutes.ago
+          assert @user.txter_sms_confirmation_attempted > 3.minutes.ago
         end
         should_change "stored code" do
-          @user.four_info_sms_confirmation_code
+          @user.txter_sms_confirmation_code
         end
         should "not have number confirmed yet" do
           assert !@user.sms_confirmed?
         end
         context "calling sms_confirm_with(right_code)" do
-          setup { @user.sms_confirm_with(@user.four_info_sms_confirmation_code) }
+          setup { @user.sms_confirm_with(@user.txter_sms_confirmation_code) }
           should "work" do
             assert @worked
           end
           should "save the phone number into the confirmed attribute" do
-            assert_equal @user.four_info_sms_confirmed_phone_number,
-                         @user.four_info_sms_phone_number
+            assert_equal @user.txter_sms_confirmed_phone_number,
+                         @user.txter_sms_phone_number
           end
           should_change "confirmed phone number attribute" do
-            @user.four_info_sms_confirmed_phone_number
+            @user.txter_sms_confirmed_phone_number
           end
           context "and then attempting to confirm another number" do
             setup {
-              @user.four_info_sms_phone_number = "206-555-5555"
-              FourInfo::Request.any_instance.expects(:perform).returns(ValidationSuccess).once
+              @user.txter_sms_phone_number = "206-555-5555"
+              Txter.stubs(:deliver).returns(Success).once
               @user.send_sms_confirmation!
             }
             should "eliminate the previous confirmed phone number" do
-              assert @user.four_info_sms_confirmed_phone_number.blank?
+              assert @user.txter_sms_confirmed_phone_number.blank?
             end
             should "un-confirm the record" do
               assert !@user.sms_confirmed?
@@ -128,19 +104,19 @@ class FourInfoContactableTest < ActiveSupport::TestCase
         end
         context "calling sms_confirm_with(right code, wrong case)" do
           setup {
-            @downcased_code = @user.four_info_sms_confirmation_code.downcase
+            @downcased_code = @user.txter_sms_confirmation_code.downcase
             @worked = @user.sms_confirm_with(@downcased_code)
           }
           should "have good test data" do
             assert_not_equal @downcased_code,
-                             @user.four_info_sms_confirmation_code
+                             @user.txter_sms_confirmation_code
           end
           should "work" do
             assert @worked
           end
           should "save the phone number into the confirmed attribute" do
-            assert_equal @user.four_info_sms_confirmed_phone_number,
-                         @user.four_info_sms_phone_number
+            assert_equal @user.txter_sms_confirmed_phone_number,
+                         @user.txter_sms_phone_number
           end
         end
         context "calling sms_confirm_with(wrong_code)" do
@@ -149,37 +125,39 @@ class FourInfoContactableTest < ActiveSupport::TestCase
             assert !@worked
           end
           should "not save the phone number into the confirmed attribute" do
-            assert_not_equal @user.four_info_sms_confirmed_phone_number,
-                             @user.four_info_sms_phone_number
+            assert_not_equal @user.txter_sms_confirmed_phone_number,
+                             @user.txter_sms_phone_number
           end
           should_not_change "confirmed phone number attribute" do
-            @user.reload.four_info_sms_confirmed_phone_number
+            @user.reload.txter_sms_confirmed_phone_number
           end
         end
       end
       context "confirming phone number with a custom short code" do
         context "with expectations" do
           setup {
-            FourInfo.configure do |config|
+            Txter.configure do |config|
               config.short_code = '0005'
+              config.gateway    = 'test'
               config.client_id  = 1
               config.client_key = 'ABC123'
             end
             message = "long message blah blah MYCODE blah"
-            FourInfo.expects(:generate_confirmation_code).returns('MYCODE').once
-            FourInfo.expects(:confirmation_message).returns(message).once
-            FourInfo::Request.any_instance.expects(:deliver_message).with(message, @user.four_info_sms_phone_number).once
+            Txter.expects(:generate_confirmation_code).returns('MYCODE').once
+            Txter.expects(:confirmation_message).returns(message).once
+            Txter::Request.any_instance.expects(:deliver_message).with(message, @user.txter_sms_phone_number).once
             @user.send_sms_confirmation!
           }
         end
         context "(normal)" do
           setup {
-            FourInfo.configure do |config|
+            Txter.configure do |config|
               config.short_code = '0005'
+              config.gateway    = 'test'
               config.client_id  = 1
               config.client_key = 'ABC123'
             end
-            FourInfo::Request.any_instance.stubs(:perform).returns(SendMsgSuccess)
+            Txter::Request.any_instance.stubs(:perform).returns(Success)
             @worked = @user.send_sms_confirmation!
           }
           should "work" do
@@ -189,15 +167,15 @@ class FourInfoContactableTest < ActiveSupport::TestCase
       end
       context "confirming phone number when the confirmation fails for some reason" do
         setup {
-          FourInfo::Request.any_instance.stubs(:perform).returns(ValidationError)
+          Txter.stubs(:deliver).returns(Error)
           @worked = @user.send_sms_confirmation!
         }
         should "not work" do assert !@worked end
         should "not save confirmation number" do
-          assert @user.four_info_sms_confirmation_code.blank?
+          assert @user.txter_sms_confirmation_code.blank?
         end
         should_not_change "stored code" do
-          @user.four_info_sms_confirmation_code
+          @user.txter_sms_confirmation_code
         end
       end
     end
@@ -205,7 +183,7 @@ class FourInfoContactableTest < ActiveSupport::TestCase
     context "when the number is not confirmed" do
       context "sending a message" do
         setup {
-          FourInfo::Request.any_instance.stubs(:perform).returns(SendMsgSuccess)
+          Txter::Request.any_instance.stubs(:perform).returns(Success)
           @result = @user.send_sms!('message')
         }
         should "send send no messages" do
@@ -215,7 +193,7 @@ class FourInfoContactableTest < ActiveSupport::TestCase
     end
     context "when the number is blocked" do
       setup {
-        @user.four_info_sms_blocked = true
+        @user.txter_sms_blocked = true
         @user.save!
       }
       context "sending a message" do
@@ -227,13 +205,13 @@ class FourInfoContactableTest < ActiveSupport::TestCase
     end
     context "when the number is confirmed" do
       setup {
-        FourInfo::Request.any_instance.stubs(:perform).returns(SendMsgSuccess)
+        Txter::Request.any_instance.stubs(:perform).returns(Success)
         @user.stubs(:sms_confirmed?).returns(true)
       }
       context "sending a message" do
         setup { @result = @user.send_sms!('message') }
-        should "send send exactly one message messages" do
-          assert_equal [true], @result
+        should "send send exactly one message" do
+          assert_equal [7], @result
         end
       end
       context "sending a blank message" do
@@ -253,7 +231,7 @@ class FourInfoContactableTest < ActiveSupport::TestCase
         context "with the allow_multiple flag" do
           setup { @result = @user.send_sms!("A"*200, true) }
           should "send multiple messages" do
-            assert_equal [true, true], @result
+            assert_equal [160, 40], @result
           end
         end
       end
@@ -261,7 +239,7 @@ class FourInfoContactableTest < ActiveSupport::TestCase
 
     context "when the number is not blocked" do
       setup {
-        FourInfo::Request.any_instance.expects(:perform).never
+        Txter::Request.any_instance.expects(:perform).never
       }
       context "unblocking" do
         setup { @worked = @user.unblock_sms! }
@@ -275,7 +253,7 @@ class FourInfoContactableTest < ActiveSupport::TestCase
     end
     context "when the number is blocked" do
       setup {
-        FourInfo::Request.any_instance.stubs(:perform).returns(UnblockSuccess)
+        Txter::Request.any_instance.stubs(:perform).returns(Success)
         @user.update_attributes!(:sms_blocked => true)
       }
       context "unblocking" do

data/test/{four_info_controller_test.rb → txter_controller_test.rb}

@@ -5,13 +5,13 @@ require 'shoulda/action_controller'
 require 'shoulda/action_controller/macros'
 require 'shoulda/action_controller/matchers'
 
-class FourInfoController < ActionController::Base
-  include FourInfo::Controller
+class TxterController < ActionController::Base
+  include Txter::Controller
 
   sms_contactable User
 end
 ActionController::Routing::Routes.draw do |map|
-  map.route '*:url', :controller => 'four_info', :action => :index
+  map.route '*:url', :controller => 'txter', :action => :index
 end
 
 class UserWithSMSReceiving < User
@@ -19,7 +19,7 @@ class UserWithSMSReceiving < User
   end
 end
 
-class FourInfoControllerTest < ActionController::TestCase
+class TxterControllerTest < ActionController::TestCase
 
   context "with a user" do
     setup {
@@ -36,10 +36,10 @@ class FourInfoControllerTest < ActionController::TestCase
       }
       should_respond_with :success
       should "block user" do
-        assert @user.reload.four_info_sms_blocked?
+        assert @user.reload.txter_sms_blocked?
       end
       should_change "user block status" do
-        @user.reload.four_info_sms_blocked?
+        @user.reload.txter_sms_blocked?
       end
     end
     context "receiving MESSAGE" do
@@ -55,7 +55,7 @@ class FourInfoControllerTest < ActionController::TestCase
         }
         should_respond_with :success
         should "not block user" do
-          assert !@user.reload.four_info_sms_blocked?
+          assert !@user.reload.txter_sms_blocked?
         end
       end
       context "when the user is set up to receive" do
@@ -68,7 +68,7 @@ class FourInfoControllerTest < ActionController::TestCase
         }
         should_respond_with :success
         should "not block user" do
-          assert !@new_user.reload.four_info_sms_blocked?
+          assert !@new_user.reload.txter_sms_blocked?
         end
       end
     end