4info 1.3.4 → 2.0.0

data/README.markdown

@@ -8,16 +8,16 @@ If you're using 4info.com as your SMS gateway this gem will give you a painless
 Setting Up Your Model
 =====
 
-Include FourInfo::Contactable into your User class or whatever you're using to represent an entity with a phone number. 
+Include Txter::Contactable into your User class or whatever you're using to represent an entity with a phone number. 
 
     class User < ActiveRecord::Base
-      include FourInfo::Contactable
+      include Txter::Contactable
     end
 
 You can also specify which attributes you'd like to use instead of the defaults
 
     class User < ActiveRecord::Base
-      include FourInfo::Contactable
+      include Txter::Contactable
 
       sms_phone_number_column            :mobile_number
       sms_blocked_column                 :is_sms_blocked
@@ -31,15 +31,15 @@ You can also specify which attributes you'd like to use instead of the defaults
 Turning the thing on
 ---
 
-Because it can be expensive to send TXTs accidentally, it's required that you manually configure FourInfo 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 accidentally, it's required that you manually configure Txter in your app. Put this line in config/environments/production.rb or anything that loads _only_ in your production environment:
 
-    FourInfo.mode = :live
+    Txter.mode = :live
 
 Skipping this step (or adding any other value) will prevent TXTs from actually being sent.
 
 You'll also want to configure your setup with your client_id and client_key. Put this in the same file as above or in a separate initializer if you wish:
 
-    FourInfo.configure do |config|
+    Txter.configure do |config|
       # these two are required:
       # (replace them with your actual account info)
       config.client_id = 12345
@@ -93,19 +93,19 @@ Receiving Messages From 4info.com
 ====
 
 You can also receive data posted to you from 4info.com. This is how you'll receive messages and notices that users have been blocked.
-All you need is to create a bare controller and include FourInfo::Controller into it. Then specify which Ruby class you're using as a contactable user model (likely User)
+All you need is to create a bare controller and include Txter::Controller into it. Then specify which Ruby class you're using as a contactable user model (likely User)
 
 
     class SMSController < ApplicationController
-      include FourInfo::Controller
+      include Txter::Controller
 
-      sms_contactable User # or whichever class you included FourInfo::Contactable into
+      sms_contactable User # or whichever class you included Txter::Contactable into
     end
 
 And hook this up in your routes.rb file like so:
 
     ActionController::Routing::Routes.draw do |map|
-      map.route '4info', :controller => 'four_info', :action => :index
+      map.route '4info', :controller => 'txter', :action => :index
     end
 
 Now just tell 4info.com to POST messages and block notices to you at:

data/VERSION

@@ -1 +1 @@
-1.3.4
+2.0.0

data/init.rb

@@ -1,3 +1,3 @@
 # Include hook code here
 
-require 'four_info'
+require 'txter'

data/lib/configuration.rb

@@ -1,4 +1,4 @@
-module FourInfo
+module Txter
   class << self
     def mode
       @@mode ||= :test
@@ -26,7 +26,9 @@ module FourInfo
 
     attr_accessor :client_id
     attr_accessor :client_key
+    attr_accessor :gateway
     attr_accessor :short_code
+    attr_accessor :default_from_phone_number
     attr_accessor :proxy_address
     attr_accessor :proxy_port
     attr_accessor :proxy_username

data/lib/contactable.rb

@@ -1,4 +1,4 @@
-module FourInfo
+module Txter
   module Contactable
 
     Attributes = [  :sms_phone_number,
@@ -27,14 +27,14 @@ module FourInfo
         # provide helper methods to access the right value
         # no matter which column it's stored in.
         #
-        # e.g.: @user.four_info_sms_confirmation_code
+        # e.g.: @user.txter_sms_confirmation_code
         #       == @user.send(User.sms_confirmation_code_column)
         model.class_eval "
-          def four_info_#{attribute}
+          def txter_#{attribute}
             send self.class.#{attribute}_column
           end
-          alias_method :four_info_#{attribute}?, :four_info_#{attribute}
-          def four_info_#{attribute}=(value)
+          alias_method :txter_#{attribute}?, :txter_#{attribute}
+          def txter_#{attribute}=(value)
             send self.class.#{attribute}_column.to_s+'=', value
           end
         "
@@ -47,7 +47,7 @@ module FourInfo
         model.before_save :normalize_sms_phone_number
         model.class_eval do
           def normalize_sms_phone_number
-            self.four_info_sms_phone_number = FourInfo.numerize(four_info_sms_phone_number)
+            self.txter_sms_phone_number = Txter.numerize(txter_sms_phone_number)
           end
         end
       end
@@ -62,28 +62,44 @@ module FourInfo
       if msg.to_s.size > 160 && !allow_multiple
         raise ArgumentError, "SMS Message is too long. Either specify that you want multiple messages or shorten the string."
       end
-      return false if msg.to_s.strip.blank? || four_info_sms_blocked?
+      return false if msg.to_s.strip.blank? || txter_sms_blocked?
       return false unless sms_confirmed?
 
       # split into pieces that fit as individual messages.
       msg.to_s.scan(/.{1,160}/m).map do |text|
-        FourInfo::Request.new.deliver_message(text, four_info_sms_phone_number).success?
+        if Txter.deliver(text, txter_sms_phone_number).success?
+          text.size
+        else
+          false
+        end
       end
     end
 
-    # Sends an SMS validation request via xml to the 4info gateway.
-    # If request succeeds the 4info-generated confirmation code is saved
-    # in the contactable record.
+    # Sends an SMS validation request through the gateway
     def send_sms_confirmation!
-      return false if four_info_sms_blocked?
+      return false if txter_sms_blocked?
       return true  if sms_confirmed?
-      return false if four_info_sms_phone_number.blank?
+      return false if txter_sms_phone_number.blank?
+
+      confirmation_code = Txter.generate_confirmation_code
+
+      # Use this class' confirmation_message method if it
+      # exists, otherwise use the generic message
+      message = (self.class.respond_to?(:confirmation_message) ?
+                   self.class :
+                   Txter).confirmation_message(confirmation_code)
+
+      if message.to_s.size > 160
+        raise ArgumentError, "SMS Confirmation Message is too long. Limit it to 160 characters of unescaped text."
+      end
 
-      # If we're using a custom short code we'll
-      # need to create a custom configuration message
-      FourInfo.configuration.short_code ?
-        confirm_four_info_sms_with_custom_message :
-        confirm_four_info_sms_with_default_message
+      response = Txter.deliver(message, txter_sms_phone_number)
+
+      if response.success?
+        update_txter_sms_confirmation confirmation_code
+      else
+        false
+      end
     end
 
 
@@ -91,11 +107,11 @@ module FourInfo
     # If request succeeds, changes the contactable record's
     # sms_blocked_column to false.
     def unblock_sms!
-      return false unless four_info_sms_blocked?
+      return false unless txter_sms_blocked?
 
-      response = FourInfo::Request.new.unblock(four_info_sms_phone_number)
+      response = Txter.unblock(txter_sms_phone_number)
       if response.success?
-        self.four_info_sms_blocked = 'false'
+        self.txter_sms_blocked = 'false'
         save
       else
         false
@@ -106,9 +122,9 @@ module FourInfo
     # code. If they match then the current phone number is set
     # as confirmed by the user.
     def sms_confirm_with(code)
-      if four_info_sms_confirmation_code.to_s.downcase == code.downcase
+      if txter_sms_confirmation_code.to_s.downcase == code.downcase
         # save the phone number into the 'confirmed phone number' attribute
-        self.four_info_sms_confirmed_phone_number = four_info_sms_phone_number
+        self.txter_sms_confirmed_phone_number = txter_sms_phone_number
         save
       else
         false
@@ -118,47 +134,16 @@ module FourInfo
     # Returns true if the current phone number has been confirmed by
     # the user for recieving TXT messages.
     def sms_confirmed?
-      return false if four_info_sms_confirmed_phone_number.blank?
-      four_info_sms_confirmed_phone_number == four_info_sms_phone_number
+      return false if txter_sms_confirmed_phone_number.blank?
+      txter_sms_confirmed_phone_number == txter_sms_phone_number
     end
 
     protected
-      def confirm_four_info_sms_with_custom_message
-        confirmation_code = FourInfo.generate_confirmation_code
-
-        # Use this class' confirmation_message method if it
-        # exists, otherwise use the generic message
-        message = (self.class.respond_to?(:confirmation_message) ?
-                     self.class :
-                     FourInfo).confirmation_message(confirmation_code)
-
-        if message.to_s.size > 160
-          raise ArgumentError, "SMS Confirmation Message is too long. Limit it to 160 characters of unescaped text."
-        end
-
-        response = FourInfo::Request.new.deliver_message(message, four_info_sms_phone_number)
-
-        if response.success?
-          update_four_info_sms_confirmation confirmation_code
-        else
-          false
-        end
-      end
-
-      def confirm_four_info_sms_with_default_message
-        response = FourInfo::Request.new.confirm(four_info_sms_phone_number)
-
-        if response.success?
-          update_four_info_sms_confirmation response.confirmation_code
-        else
-          false
-        end
-      end
 
-      def update_four_info_sms_confirmation(new_code)
-        self.four_info_sms_confirmation_code = new_code
-        self.four_info_sms_confirmation_attempted = Time.now.utc
-        self.four_info_sms_confirmed_phone_number = nil
+      def update_txter_sms_confirmation(new_code)
+        self.txter_sms_confirmation_code = new_code
+        self.txter_sms_confirmation_attempted = Time.now.utc
+        self.txter_sms_confirmed_phone_number = nil
         save
       end
   end  

data/lib/controller.rb

@@ -1,4 +1,4 @@
-module FourInfo
+module Txter
   module Controller
 
     def self.included(controller)
@@ -25,7 +25,7 @@ module FourInfo
       def recieve_xml
 
         unless defined?(@@contactable_class)
-          raise RuntimeError, "Please define your user class in the FourInfo controller via the 'sms_contactable' method"
+          raise RuntimeError, "Please define your user class in the Txter controller via the 'sms_contactable' method"
         end
 
         request = params[:request]
@@ -33,7 +33,7 @@ module FourInfo
         case request['type']
         when 'BLOCK'
           @contactable = find_contactable(request[:block][:recipient][:id])
-          @contactable.four_info_sms_blocked = true
+          @contactable.txter_sms_blocked = true
           @contactable.save!
         when 'MESSAGE'
           @contactable = find_contactable(request[:message][:sender][:id])

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