exetel_sms 1.04 → 1.05

data/CHANGELOG

@@ -1,3 +1,5 @@
+v1.05. Test mode collects sent messages in an array
+
 v1.04. Test API without making HTTP calls. Unit tests.
 
 v1.03. Support message retrieval (check sent status). Update hostname.

data/README

@@ -48,7 +48,7 @@ Credit Check - also useful as a ping before sending
 
  checker = ExetelSms::CreditCheck.new(config)
  if result = checker.get_credit_limit
-   puts "Credit limit is #{result[:limit}}"
+   puts "Credit limit is #{result[:limit]}"
  end
 
 
@@ -62,8 +62,8 @@ Test API - test responses without making actual HTTP calls
  bad = ExetelSms::Client.with_test_api(:fail) { retriever.check_sent('1') }
  bad[:message_status] # => 'Failed'
 
-See test/ for more examples
- 
+Sent messages end up in ExetelSms::Client.sent_messages array. See test/ for more examples. 
+
 
 Contact the author
 ------------------

data/README.textile

@@ -44,20 +44,20 @@ h3. Credit Check: also useful as a ping before sending
 
 bc. checker = ExetelSms::CreditCheck.new(config)
  if result = checker.get_credit_limit
-   puts "Credit limit is #{result[:limit}}"
+   puts "Credit limit is #{result[:limit]}"
  end
 
 
 h3. Test API: test responses without making actual HTTP calls
 
 bc. good = ExetelSms::Client.with_test_api { retriever.check_sent('1') }
- good[:message_status] # => 'Delivered'
+good[:message_status] #=> 'Delivered'
 
 bc. bad = ExetelSms::Client.with_test_api(:fail) { retriever.check_sent('1') }
- bad[:message_status] # => 'Failed'
+bad[:message_status]  #=> 'Failed'
 
+Sent messages end up in ExetelSms::Client.sent_messages array. See test/ for more examples.
 
-See test/ for more examples
 
 
 h3. Contact the author

data/exetel_sms.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{exetel_sms}
-  s.version = "1.04"
+  s.version = "1.05"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Snow"]

data/lib/class_methods.rb

@@ -30,6 +30,9 @@ module ExetelSms
       URI.encode(URI.encode(str), /=|&|\?/)
     end
     
+    def matchurl?(url)
+      url.match(/\/#{api_path}\?/)
+    end
     
     def response_to_hash(fields)
       raise "Missing fields in response body?  Expected #{response_fields.map(&:to_s).join(',')}, got #{fields.inspect}" unless fields.length >= response_fields.length

data/lib/client.rb

@@ -7,7 +7,7 @@ require 'uri'
 module ExetelSms
   class Client
     class << self
-      attr_accessor :test_api
+      attr_accessor :test_api, :sent_messages
       
       def with_test_api(failmode=false)
         old_test_api = @test_api
@@ -20,40 +20,64 @@ module ExetelSms
       def test_api?
         !@test_api.nil?
       end
+      
+      def parse_url_params(url)
+        Hash[
+          *url.split('?').last.split('&').map do |pair|
+            str1, str2 = pair.split('=')
+            [URI.decode(str1).to_sym, URI.decode(str2)]
+          end.flatten
+        ]
+      end
     
       def fake_response(url)
         @counter = (@counter || 0) + 1
-        if url.match(/\/#{Sender.api_path}\?/)
-          test_api != false ? raise(Timeout::Error.new) : "1|0412345678|#{@counter}|#{@counter}|OK"
-        elsif url.match(/\/#{Receiver.api_path}\?/)
+        if Sender.matchurl?(url)
+          body = "1|0412345678|#{@counter}|#{@counter}|OK"
+          if test_api == false
+            @sent_messages << parse_url_params(url)
+            body
+          else
+            raise(Timeout::Error.new)
+          end
+        elsif Receiver.matchurl?(url)
           test_api != false ? '2||||No results returned|' : "1|#{@counter}|0412345678|2011-03-29 23:15:03|OK|Test message"
-        elsif url.match(/\/#{Retriever.api_path}\?/) && (referencenumber = url.match(/referencenumber=(.*)/))
+        elsif Retriever.matchurl?(url) && (referencenumber = url.match(/referencenumber=(.*)/))
           test_api != false ? "1|#{@counter}|#{referencenumber}|0412987654|0412345678||Failed|0.05|OK" : "1|#{@counter}|#{referencenumber}|0412987654|0412345678|2011-03-29 23:15:03|Delivered|0.05|OK"
-        elsif url.match(/\/#{Deleter.api_path}\?/)
+        elsif Deleter.matchurl?(url)
           test_api != false ? '2|No results returned' : "1|OK"
-        elsif url.match(/\/#{CreditCheck.api_path}\?/)
+        elsif CreditCheck.matchurl?(url)
           test_api != false ? '1|0|OK' : '1|100|OK'
         else
-          raise "ExetelSMS test API: Unknown URL"
-        end.split('|',-1).map {|str| str.strip }
+          raise "#{self.class} test API: Unknown URL"
+        end
       end
     
       def request(url)
-        return fake_response(url) if test_api?
-      
-        uri = URI.parse(url)
-        h = Net::HTTP.new(uri.host, uri.port)
-        h.use_ssl = true
-        h.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        #h.set_debug_output $stderr
         body = ''
-        h.start do |http|
-          response = http.request_get(uri.request_uri)
-          body = response.body
+        if test_api?
+          body = fake_response(url)
+        else
+          uri = URI.parse(url)
+          h = Net::HTTP.new(uri.host, uri.port)
+          h.use_ssl = true
+          h.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          #h.set_debug_output $stderr
+          
+          h.start do |http|
+            response = http.request_get(uri.request_uri)
+            body = response.body
+          end
         end
+        
         raise "ExetelSms::Client: No valid body found: #{body.inspect}" unless body && body =~ /|/
+        request_to_array(body)
+      end
+      
+      def request_to_array(body)
         body.chomp.gsub(/<br>$/i, '').split('|',-1).map {|str| str.strip }
       end
     end
+    self.sent_messages ||= []
   end
 end

data/lib/sender.rb

@@ -9,8 +9,8 @@ module ExetelSms
       @config = config
     end
 
-    def send(to_mobile_number, msg, from_mobile_number, reference_number)
-      url = self.class.build_url(
+    def send_request_hash(to_mobile_number, msg, from_mobile_number, reference_number)
+      {
         :username => @config.username,
         :password => @config.password,
         :sender => from_mobile_number,
@@ -18,8 +18,11 @@ module ExetelSms
         :messagetype => 'Text',
         :referencenumber => reference_number,
         :mobilenumber => to_mobile_number
-      )
-      
+      }
+    end
+
+    def send(to_mobile_number, msg, from_mobile_number, reference_number)
+      url = self.class.build_url(send_request_hash(to_mobile_number, msg, from_mobile_number, reference_number))
       self.class.response_to_hash(ExetelSms::Client.request(url))
     end
 

data/test/test_all.rb

@@ -29,8 +29,21 @@ class TestExetelSms < Test::Unit::TestCase
   end
   
   def test_sender_ok
+    assert_equal 0, ExetelSms::Client.sent_messages.length
+
     result = ExetelSms::Client.with_test_api { @sender.send('0412345678', 'Hello?', '0412987654', '1') }
     assert result.success?
+    assert_equal 1, ExetelSms::Client.sent_messages.length
+    
+    request = ExetelSms::Client.sent_messages.first
+    
+    assert_equal '0412345678', request[:mobilenumber]
+    assert_equal '0412987654', request[:sender]
+    assert_equal '1', request[:referencenumber]
+    assert_equal 'Text', request[:messagetype]
+    assert_equal 'Hello?', request[:message]
+    assert_equal 'username', request[:username]
+    assert_equal 'password', request[:password]
   end
 
   def test_sender_exception

metadata

@@ -2,7 +2,7 @@
 name: exetel_sms
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "1.04"
+  version: "1.05"
 platform: ruby
 authors: 
 - Andrew Snow