4info 1.2.5 → 1.3.0

data/4info.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{4info}
-  s.version = "1.2.5"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jack Danger Canty"]
-  s.date = %q{2010-02-11}
+  s.date = %q{2010-02-20}
   s.description = %q{A complete Ruby API for handling SMS messages via 4info.com}
   s.email = %q{gitcommit@6brand.com}
   s.extra_rdoc_files = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
      "VERSION",
      "init.rb",
      "lib/4info.rb",
+     "lib/configuration.rb",
      "lib/contactable.rb",
      "lib/controller.rb",
      "lib/four_info.rb",
@@ -36,7 +37,6 @@ Gem::Specification.new do |s|
      "test/four_info_contactable_test.rb",
      "test/four_info_controller_test.rb",
      "test/four_info_module_test.rb",
-     "test/sms.yml",
      "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/JackDanger/4info}

data/README.markdown

@@ -37,6 +37,22 @@ Because it can be expensive to send TXTs accidentally, it's required that you ma
 
 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|
+      # these two are required:
+      # (replace them with your actual account info)
+      config.client_id = 12345
+      config.client_key = 'ABC123'
+
+      # the rest are optional:
+      config.short_code     = 00001 # if you have a custom short code
+      config.proxy_address  = 'my.proxy.com'
+      config.proxy_port     = '80'
+      config.proxy_username = 'user'
+      config.proxy_password = 'password'
+    end
+
 Phone number formatting
 ---
 
@@ -46,7 +62,7 @@ Whatever is stored in the sms_phone_number_column will be subject to normalized
     user.sms_phone_number # => 2065551234
 
 If you want to preserve the format of the number exactly as the user entered it you'll want
-to save it in a different attribute.
+to save that in a different attribute.
 
 
 Confirming Phone Number And Sending Messages

data/VERSION

@@ -1 +1 @@
-1.2.5
+1.3.0

data/lib/configuration.rb

@@ -0,0 +1,39 @@
+module FourInfo
+  class << self
+    def mode
+      @@mode ||= :test
+    end
+
+    def mode=(new_mode)
+      @@mode = new_mode
+    end
+
+    def configured?
+      return false unless configuration
+      configuration.client_id && configuration.client_key
+    end
+
+    def configuration
+      @@configuration
+    end
+
+    def configure(&block)
+      @@configuration = Configuration.new(&block)
+    end
+  end
+
+  class Configuration
+
+    attr_accessor :client_id
+    attr_accessor :client_key
+    attr_accessor :short_code
+    attr_accessor :proxy_address
+    attr_accessor :proxy_port
+    attr_accessor :proxy_username
+    attr_accessor :proxy_password
+
+    def initialize
+      yield self
+    end
+  end
+end

data/lib/contactable.rb

@@ -79,18 +79,14 @@ module FourInfo
       return true  if sms_confirmed?
       return false if four_info_sms_phone_number.blank?
 
-      response = FourInfo::Request.new.confirm(four_info_sms_phone_number)
-      if response.success?
-        self.four_info_sms_confirmation_code = response.confirmation_code
-        self.four_info_sms_confirmation_attempted = Time.now.utc
-        self.four_info_sms_confirmed_phone_number = nil
-        save
-      else
-        # "Confirmation Failed: #{response['message'].inspect}"
-        false
-      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
     end
 
+
     # Sends an unblock request via xml to the 4info gateway.
     # If request succeeds, changes the contactable record's
     # sms_blocked_column to false.
@@ -125,5 +121,41 @@ module FourInfo
       return false if four_info_sms_confirmed_phone_number.blank?
       four_info_sms_confirmed_phone_number == four_info_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)
+
+        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
+        save
+      end
   end  
 end

data/lib/four_info.rb

@@ -5,13 +5,6 @@ module FourInfo
       URI.parse 'http://gateway.4info.net/msg'
     end
 
-    def mode
-      @@mode ||= :test
-    end
-    def mode=(new_mode)
-      @@mode = new_mode
-    end
-
     def log(msg)
       if defined?(Rails)
         Rails.logger.info msg
@@ -37,9 +30,19 @@ module FourInfo
         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__), 'contactable')
 require File.join(File.dirname(__FILE__), 'controller')
 require File.join(File.dirname(__FILE__), 'request')

data/lib/request.rb

@@ -1,34 +1,19 @@
 module FourInfo
   class Request
 
-    # Haml templates for XML
-    @@templates = Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), 'templates', '*.haml')))
-
-    # YML config files
-    @@test_mode_config_file = File.join(File.dirname(__FILE__), '..', 'test', 'sms.yml')
-    @@likely_config_files = [
-        File.join(File.dirname(__FILE__), '..', 'sms.yml'),
-        defined?(Rails) ? File.join(Rails.root, 'config', 'sms.yml') : '',
-        File.join('config', 'sms.yml'),
-        'sms.yml'
-    ]
-
     attr_accessor :config
     attr_accessor :number
     attr_accessor :message
 
     def initialize
-      config_file = :live == FourInfo.mode.to_sym ?
-                      @@likely_config_files.detect {|f| File.exist?(f) } :
-                      @@test_mode_config_file
-
-      raise "Missing config File! Please add sms.yml to ./config or the 4info directory" unless config_file
-
-      @config = YAML.load(File.read(config_file))['4info'].with_indifferent_access
+      unless FourInfo.configured?
+        raise "You need to configure FourInfo before using it!"
+      end
+      self.config = FourInfo.configuration
     end
 
     def deliver_message(message, number)
-      self.number = FourInfo.internationalize(number)
+      self.number  = FourInfo.internationalize(number)
       self.message = message
 
       xml = template(:deliver).render(self)
@@ -36,7 +21,7 @@ module FourInfo
     end
 
     def confirm(number)
-      self.number = FourInfo.internationalize(number)
+      self.number  = FourInfo.internationalize(number)
 
       xml = template(:confirm).render(self)
       Response.new(perform(xml))
@@ -52,7 +37,9 @@ module FourInfo
     protected
 
       def template(name)
-        file = @@templates.detect {|t| File.basename(t).chomp('.haml').to_sym == name.to_sym }
+        # Haml templates for XML
+        templates = Dir.glob(File.expand_path(File.join(File.dirname(__FILE__), '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
@@ -72,9 +59,13 @@ module FourInfo
       end
 
       def start
-        net = config[:proxy].blank? ?
-                Net::HTTP :
-                Net::HTTP::Proxy(*config[:proxy].split(":"))
+        net = config.proxy_address ?
+                Net::HTTP::Proxy(
+                  config.proxy_address,
+                  config.proxy_port,
+                  config.proxy_username,
+                  config.proxy_password) :
+                Net::HTTP
         net.start(FourInfo.gateway.host, FourInfo.gateway.port) do |http|
           yield http
         end

data/lib/response.rb

@@ -3,9 +3,14 @@ module FourInfo
     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

data/lib/templates/confirm.haml

@@ -1,5 +1,5 @@
 !!! XML
-%request{ :clientId => config[:client_id], :clientKey => config[:client_key], :type => "VALIDATION" }
+%request{ :clientId => config.client_id, :clientKey => config.client_key, :type => "VALIDATION" }
   %validation
     %recipient
       %type= 5

data/lib/templates/deliver.haml

@@ -1,6 +1,10 @@
 !!! XML
-%request{ :clientId => config[:client_id], :clientKey => config[:client_key], :type => "MESSAGE" }
+%request{ :clientId => config.client_id, :clientKey => config.client_key, :type => "MESSAGE" }
   %message
+    - if config.short_code
+      %sender
+        %type= 6
+        %id= config.short_code
     %recipient
       %type= 5
       %id= number

data/lib/templates/unblock.haml

@@ -1,5 +1,5 @@
 !!! XML
-%request{ :clientId => config[:client_id], :clientKey => config[:client_key], :type => "UNBLOCK" }
+%request{ :clientId => config.client_id, :clientKey => config.client_key, :type => "UNBLOCK" }
   %unblock
     %recipient
       %type= 5

data/test/four_info_contactable_test.rb

@@ -140,6 +140,36 @@ class FourInfoContactableTest < ActiveSupport::TestCase
           end
         end
       end
+      context "confirming phone number with a custom short code" do
+        context "with expectations" do
+          setup {
+            FourInfo.configure do |config|
+              config.short_code = '0005'
+              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
+            @user.send_sms_confirmation!
+          }
+        end
+        context "(normal)" do
+          setup {
+            FourInfo.configure do |config|
+              config.short_code = '0005'
+              config.client_id  = 1
+              config.client_key = 'ABC123'
+            end
+            FourInfo::Request.any_instance.stubs(:perform).returns(SendMsgSuccess)
+            @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 {
           FourInfo::Request.any_instance.stubs(:perform).returns(ValidationError)

data/test/four_info_module_test.rb

@@ -36,4 +36,21 @@ class FourInfoModuleTest < ActiveSupport::TestCase
       end
     end
   end
+
+  context "generating codes" do
+    setup { @code = FourInfo.generate_confirmation_code }
+    should "be 6 digits" do
+      assert_equal 6, @code.length
+    end
+  end
+
+  context "confirmation message" do
+    setup {
+      @code = 'ABC123'
+      @message = FourInfo.confirmation_message(@code)
+    }
+    should "include code" do
+      assert @message.include?(@code)
+    end
+  end
 end

data/test/test_helper.rb

@@ -8,6 +8,12 @@ require 'active_support/test_case'
 require 'shoulda'
 require File.join(File.dirname(__FILE__), "..", 'lib', 'four_info')
 
+# default test configuration
+FourInfo.configure do |config|
+  config.client_id  = '1'
+  config.client_key = 'ABCDEF'
+end
+
 FourInfo.mode = :test
 config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
 ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: 4info
 version: !ruby/object:Gem::Version 
-  version: 1.2.5
+  version: 1.3.0
 platform: ruby
 authors: 
 - Jack Danger Canty
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-11 00:00:00 -08:00
+date: 2010-02-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,6 +68,7 @@ files:
 - VERSION
 - init.rb
 - lib/4info.rb
+- lib/configuration.rb
 - lib/contactable.rb
 - lib/controller.rb
 - lib/four_info.rb
@@ -81,7 +82,6 @@ files:
 - test/four_info_contactable_test.rb
 - test/four_info_controller_test.rb
 - test/four_info_module_test.rb
-- test/sms.yml
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/JackDanger/4info

data/test/sms.yml

@@ -1,6 +0,0 @@
-4info:
-  client_id:  1
-  client_key: ABCDEFG
-  proxy: myhost.com:8080
-  # or:
-  # proxy: myhost.com:8080:username:password