txter 2.0.2

data/lib/gateway.rb

@@ -0,0 +1,45 @@
+module Txter
+  class Gateway
+    class Request
+    end
+
+    class Response
+      def initialize(*args)
+        @options = args.last
+      end
+
+      def success?
+        :success == @options[:status]
+      end
+    end
+    Success = Txter::Gateway::Response.new(:status => :success)
+    Error   = Txter::Gateway::Response.new(:status => :error)
+
+    def self.deliver(*args)
+      # subclasses should actually do something here
+      Success 
+    end
+
+    def self.unblock(*args)
+      # subclasses should actually do something here
+      Success 
+    end
+
+    def self.current
+      case Txter.configuration.gateway
+      when 'twilio'
+        gem 'twiliolib'
+        require 'twiliolib'
+        GatewayTwilio
+      when '4info'
+        Gateway4info
+      when 'test'
+        Txter::Gateway
+      else
+        raise "You need to specify your Txter gateway!"
+      end
+    end
+  end
+end
+require File.join File.dirname(__FILE__), 'gateway_4info'
+require File.join File.dirname(__FILE__), 'gateway_twilio'

data/lib/gateway_4info.rb

@@ -0,0 +1,114 @@
+module Txter
+  class Gateway4info < Txter::Gateway
+
+    API = 'http://gateway.4info.net/msg'
+
+    def self.deliver(message, number)
+      Gateway4info.perform Request.new.deliver_message(message, number)
+    end
+
+    def self.perform(body)
+      if :live == Txter.mode
+        require 'net/http'
+        uri = URI.parse API
+        body = start do |http|
+          http.post(
+                     uri.path,
+                     body,
+                     {'Content-Type' => 'text/xml'}
+          ).read_body
+        end
+        Response.new(body)
+      else
+        Txter.log "Would have sent to 4info.net: #{body}"
+      end
+    end
+      
+    protected
+
+      def self.start
+        c = Txter.configuration
+        net = c.proxy_address ?
+                Net::HTTP::Proxy(
+                  c.proxy_address,
+                  c.proxy_port,
+                  c.proxy_username,
+                  c.proxy_password) :
+                Net::HTTP
+        uri = URI.parse API
+        net.start(uri.host, uri.port) do |http|
+          yield http
+        end
+      end
+
+    class Response < Txter::Gateway::Response
+      def initialize(xml)
+        gem 'hpricot'
+        require 'hpricot'
+        @xml  = xml
+        @body = Hpricot.parse(xml)
+      end
+
+      def inspect
+        @xml.to_s
+      end
+
+      def [](name)
+        nodes = (@body/name)
+        1 == nodes.size ? nodes.first : nodes
+      end
+
+      def success?
+        'Success' == self['message'].inner_text
+      end
+
+      def confirmation_code
+        self[:confcode].inner_text
+      end
+    end
+
+    class Request < Txter::Gateway::Request
+
+      attr_accessor :number
+      attr_accessor :message
+      attr_accessor :config
+
+      def initialize
+        unless Txter.configured?
+          raise "You need to configure Txter before using it!"
+        end
+        self.config = Txter.configuration
+      end
+
+      def deliver_message(message, number)
+        self.number  = Txter.internationalize(number)
+        self.message = message
+
+        template(:deliver).render(self)
+      end
+
+      def confirm(number)
+        self.number  = Txter.internationalize(number)
+
+        template(:confirm).render(self)
+      end
+
+      def unblock(number)
+        self.number = Txter.internationalize(number)
+
+        template(:unblock).render(self)
+      end
+
+      protected
+
+        def template(name)
+          # Haml templates for XML
+          require 'cgi'
+          templates = Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), '4info_templates', '*.haml')))
+          file = templates.detect {|t| File.basename(t).chomp('.haml').to_sym == name.to_sym }
+          raise ArgumentError, "Missing 4Info template: #{name}" unless file
+          Haml::Engine.new(File.read(file))
+        end
+    end
+  end
+end

data/lib/gateway_twilio.rb

@@ -0,0 +1,45 @@
+module Txter
+  class GatewayTwilio < Txter::Gateway
+
+    API_VERSION   = '2008-08-01'
+
+    class << self
+
+      def deliver(message, to, from = nil)
+
+        from ||= Txter.configuration.default_from_phone_number
+        raise "'From' number required for Twilio" unless from
+
+        response = post 'To'   => to,
+                       'From' => from,
+                       'Body' => message
+
+        Net::HTTPCreated == response.code_type ?
+                              Txter::Gateway::Success :
+                              Txter::Gateway::Error
+      end
+
+      def account
+        @account ||= begin
+          if Txter.configuration.client_id.blank? ||
+             Txter.configuration.client_key.blank?
+             raise "Add your Twilio account id (as client_id) and token (as client_key) to the Txter.configure block"
+          end
+
+          Twilio::RestAccount.new(
+                      Txter.configuration.client_id,
+                      Txter.configuration.client_key
+                    )
+        end
+      end
+
+      protected
+
+        def post(data = {})
+          account.request "/#{API_VERSION}/Accounts/#{Txter.configuration.client_id}/SMS/Messages",
+                          "POST",
+                          data
+        end
+    end
+  end           
+end

data/lib/txter.rb

@@ -0,0 +1,50 @@
+module Txter
+  class << self
+    def gateway
+      Txter::Gateway.current
+    end
+
+    delegate :deliver, :to => :gateway
+    delegate :unblock, :to => :gateway
+
+    def log(msg)
+      if defined?(Rails)
+        Rails.logger.info msg
+      else
+        STDOUT.puts msg
+      end
+    end
+
+    def numerize(numberish)
+      numberish.to_s.scan(/\d+/).join
+    end
+
+    def internationalize(given_number)
+      number = numerize(given_number)
+      case number.size
+      when 10
+        "+1#{number}"
+      when 11
+        "+#{number}"
+      when 12
+        number =~ /\+\d(11)/ ? number : nil
+      else
+        nil
+      end
+    end
+
+    def confirmation_message(confirmation_code)
+      "4INFO alert confirm. code: #{confirmation_code} Enter code on web to verify phone. Msg&data rates may apply. Freq set by u. T&C & support at www.4info.com. Txt HELP for help"
+    end
+
+    def generate_confirmation_code
+      chars = (0..9).to_a + ('A'..'Z').to_a
+      (0...6).collect { chars[Kernel.rand(chars.length)] }.join
+    end
+  end
+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')

data/test/.gitignore

@@ -0,0 +1 @@
+debug.log

data/test/database.yml

@@ -0,0 +1,18 @@
+sqlite:
+  :adapter: sqlite
+  :database: plugin.sqlite.db
+sqlite3:
+  :adapter: sqlite3
+  :database: ":memory:"
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: plugin_test
+  :min_messages: ERROR
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: rails
+  :password:
+  :database: plugin_test

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

@@ -0,0 +1,46 @@
+require 'rubygems'
+gem 'test-unit'
+require 'test/unit'
+require 'mocha'
+require 'active_support'
+require 'active_record'
+require 'active_support/test_case'
+require 'shoulda'
+require File.join(File.dirname(__FILE__), "..", 'lib', 'txter')
+
+# default test configuration
+Txter.configure do |config|
+  config.client_id  = '1'
+  config.client_key = 'ABCDEF'
+  config.gateway    = 'test'
+end
+
+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'])
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.column :sms_phone_number,           :string
+    t.column :sms_confirmed_phone_number, :string
+    t.column :sms_blocked,                :boolean
+    t.column :sms_confirmation_attempted, :datetime
+    t.column :sms_confirmation_code,      :string
+
+    t.column :type, :string
+  end
+end
+
+class User < ActiveRecord::Base
+  include Txter::Contactable
+end
+
+# kill all network access
+module Txter
+  class Request
+    def start
+      raise "You forgot to stub out your net requests!"
+    end
+  end
+end

data/test/txter_contactable_test.rb

@@ -0,0 +1,270 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class TxterContactableTest < ActiveSupport::TestCase
+
+  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, Txter::Contactable
+      Txter.configure do |config|
+        config.client_id  = 12345
+        config.client_key = 'ABC123'
+        config.gateway    = 'test'
+      end
+    }
+    Txter::Contactable::Attributes.each do |attribute|
+      should "begin with appropriate default for #{attribute}_column" do
+        assert_equal attribute, @klass.send("#{attribute}_column")
+      end
+      should "allow setting #{attribute}_column" do
+        new_column_name = :custom_column
+        @klass.send "#{attribute}_column", new_column_name
+        assert_equal new_column_name, @klass.send("#{attribute}_column")
+      end
+    end
+  end
+
+  context "contactable instance" do
+    setup {
+      User.delete_all
+      @user = User.create! User.sms_phone_number_column => '(555) 123-4567'
+    }
+
+    should "normalize phone number" do
+      assert_equal '5551234567', @user.txter_sms_phone_number
+    end
+    context "when phone number is blank" do
+      setup { @user.txter_sms_phone_number = nil}
+      context "confirming phone number" do
+        setup { @user.send_sms_confirmation! }
+        should_not_change "any attributes" do
+          @user.attributes.inspect
+        end
+      end
+      context "sending message" do
+        setup {
+          Txter.gateway.stubs(:perform).returns(Success)
+          @worked = @user.send_sms!('message')
+        }
+        should "not work" do assert !@worked end
+        should_not_change "any attributes" do
+          @user.attributes.inspect
+        end
+      end
+    end
+
+    context "when phone number exists" do
+      setup { @user.txter_sms_phone_number = "206-555-5555"}
+      context "confirming phone number" do
+        setup {
+          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 @user.txter_sms_confirmation_code
+        end
+        should "set confirmation attempted time" do
+          assert @user.txter_sms_confirmation_attempted > 3.minutes.ago
+        end
+        should_change "stored code" do
+          @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.txter_sms_confirmation_code) }
+          should "work" do
+            assert @worked
+          end
+          should "save the phone number into the confirmed attribute" do
+            assert_equal @user.txter_sms_confirmed_phone_number,
+                         @user.txter_sms_phone_number
+          end
+          should_change "confirmed phone number attribute" do
+            @user.txter_sms_confirmed_phone_number
+          end
+          context "and then attempting to confirm another number" do
+            setup {
+              @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.txter_sms_confirmed_phone_number.blank?
+            end
+            should "un-confirm the record" do
+              assert !@user.sms_confirmed?
+            end
+          end
+        end
+        context "calling sms_confirm_with(right code, wrong case)" do
+          setup {
+            @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.txter_sms_confirmation_code
+          end
+          should "work" do
+            assert @worked
+          end
+          should "save the phone number into the confirmed attribute" do
+            assert_equal @user.txter_sms_confirmed_phone_number,
+                         @user.txter_sms_phone_number
+          end
+        end
+        context "calling sms_confirm_with(wrong_code)" do
+          setup { @worked = @user.sms_confirm_with('wrong_code') }
+          should "not work" do
+            assert !@worked
+          end
+          should "not save the phone number into the confirmed attribute" do
+            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.txter_sms_confirmed_phone_number
+          end
+        end
+      end
+      context "confirming phone number with a custom short code" do
+        context "with expectations" do
+          setup {
+            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"
+            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 {
+            Txter.configure do |config|
+              config.short_code = '0005'
+              config.gateway    = 'test'
+              config.client_id  = 1
+              config.client_key = 'ABC123'
+            end
+            Txter::Request.any_instance.stubs(:perform).returns(Success)
+            @worked = @user.send_sms_confirmation!
+          }
+          should "work" do
+            assert @worked
+          end
+        end
+      end
+      context "confirming phone number when the confirmation fails for some reason" do
+        setup {
+          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.txter_sms_confirmation_code.blank?
+        end
+        should_not_change "stored code" do
+          @user.txter_sms_confirmation_code
+        end
+      end
+    end
+
+    context "when the number is not confirmed" do
+      context "sending a message" do
+        setup {
+          Txter::Request.any_instance.stubs(:perform).returns(Success)
+          @result = @user.send_sms!('message')
+        }
+        should "send send no messages" do
+          assert_equal false, @result
+        end
+      end
+    end
+    context "when the number is blocked" do
+      setup {
+        @user.txter_sms_blocked = true
+        @user.save!
+      }
+      context "sending a message" do
+        setup { @result = @user.send_sms!('message') }
+        should "send nothing" do
+          assert_equal false, @result
+        end
+      end
+    end
+    context "when the number is confirmed" do
+      setup {
+        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" do
+          assert_equal [7], @result
+        end
+      end
+      context "sending a blank message" do
+        setup { @result = @user.send_sms!('') }
+        should "send send zero messages" do
+          assert_equal false, @result
+        end
+      end
+      context "sending a huge message" do
+        context "without the allow_multiple flag" do
+          should "raise an error" do
+            assert_raises ArgumentError do
+              @user.send_sms!("A"*200)
+            end
+          end
+        end
+        context "with the allow_multiple flag" do
+          setup { @result = @user.send_sms!("A"*200, true) }
+          should "send multiple messages" do
+            assert_equal [160, 40], @result
+          end
+        end
+      end
+    end
+
+    context "when the number is not blocked" do
+      setup {
+        Txter::Request.any_instance.expects(:perform).never
+      }
+      context "unblocking" do
+        setup { @worked = @user.unblock_sms! }
+        should "not do anything" do
+          assert !@worked
+        end
+        should_not_change "any attributes" do
+          @user.attributes.inspect
+        end
+      end
+    end
+    context "when the number is blocked" do
+      setup {
+        Txter::Request.any_instance.stubs(:perform).returns(Success)
+        @user.update_attributes!(:sms_blocked => true)
+      }
+      context "unblocking" do
+        setup { @worked = @user.unblock_sms! }
+        should "work" do
+          assert @worked
+        end
+        should_change "blocked attribute" do
+          @user.reload.sms_blocked
+        end
+      end
+    end
+  end
+end