exetel_sms 1.03 → 1.04

data/CHANGELOG

@@ -1,3 +1,5 @@
+v1.04. Test API without making HTTP calls. Unit tests.
+
 v1.03. Support message retrieval (check sent status). Update hostname.
 
 v1.02. Fixed requirements for gem

data/Manifest

@@ -6,9 +6,11 @@ Rakefile
 lib/class_methods.rb
 lib/client.rb
 lib/config.rb
+lib/credit_check.rb
 lib/deleter.rb
 lib/exetel_sms.rb
 lib/receiver.rb
 lib/retriever.rb
 lib/sender.rb
+test/test_all.rb
 Manifest

data/README

@@ -38,6 +38,31 @@ Receiving messages from a Virtual Mobile Number
  if result = receiver.receive('my virtual mobile number')
    puts "Received from #{result[:from_mobile_number]}: #{result[:message]}"
  end
+
+Then you can delete the messages with ExetelSms::Deleter
+
+
+
+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}}"
+ end
+
+
+
+Test API - test responses without making actual HTTP calls
+----------------------------------------------------------
+
+ good = ExetelSms::Client.with_test_api { retriever.check_sent('1') }
+ good[:message_status] # => 'Delivered'
+
+ bad = ExetelSms::Client.with_test_api(:fail) { retriever.check_sent('1') }
+ bad[:message_status] # => 'Failed'
+
+See test/ for more examples
  
 
 Contact the author
@@ -45,4 +70,5 @@ Contact the author
 
 Andrew Snow <andrew@modulus.org>
 Andys^ on irc.freenode.net
+@andy_snow on Twitter
 

data/README.textile

@@ -37,12 +37,34 @@ bc. receiver = ExetelSms::Receiver.new(config)
  if result = receiver.receive('my virtual mobile number')
    puts "Received from #{result[:from_mobile_number]}: #{result[:message]}"
  end
- 
 
+Then you can delete the messages with ExetelSms::Deleter
+
+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}}"
+ 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'
+
+bc. bad = ExetelSms::Client.with_test_api(:fail) { retriever.check_sent('1') }
+ bad[:message_status] # => 'Failed'
+
+
+See test/ for more examples
 
 
 h3. Contact the author
 
 Andrew Snow <andrew@modulus.org>
 Andys^ on irc.freenode.net
+@andy_snow on Twitter
+
+
 

data/exetel_sms.gemspec

@@ -2,24 +2,24 @@
 
 Gem::Specification.new do |s|
   s.name = %q{exetel_sms}
-  s.version = "1.03"
+  s.version = "1.04"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Snow"]
-  s.date = %q{2011-01-28}
+  s.date = %q{2011-03-30}
   s.description = %q{Ruby gem to send and receive SMS via Exetel's API}
   s.email = %q{andrew@modulus.org}
-  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "README.textile", "lib/class_methods.rb", "lib/client.rb", "lib/config.rb", "lib/deleter.rb", "lib/exetel_sms.rb", "lib/receiver.rb", "lib/retriever.rb", "lib/sender.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "README", "README.textile", "Rakefile", "lib/class_methods.rb", "lib/client.rb", "lib/config.rb", "lib/deleter.rb", "lib/exetel_sms.rb", "lib/receiver.rb", "lib/retriever.rb", "lib/sender.rb", "Manifest", "exetel_sms.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "README.textile", "lib/class_methods.rb", "lib/client.rb", "lib/config.rb", "lib/credit_check.rb", "lib/deleter.rb", "lib/exetel_sms.rb", "lib/receiver.rb", "lib/retriever.rb", "lib/sender.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "README", "README.textile", "Rakefile", "lib/class_methods.rb", "lib/client.rb", "lib/config.rb", "lib/credit_check.rb", "lib/deleter.rb", "lib/exetel_sms.rb", "lib/receiver.rb", "lib/retriever.rb", "lib/sender.rb", "test/test_all.rb", "Manifest", "exetel_sms.gemspec"]
   s.homepage = %q{}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Exetel_sms", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{exetel_sms}
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.6.2}
   s.summary = %q{Ruby gem to send and receive SMS via Exetel's API}
+  s.test_files = ["test/test_all.rb"]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then

data/lib/class_methods.rb

@@ -2,7 +2,17 @@
 require 'uri'
 
 module ExetelSms
+  module ResultHashMethods
+    def success?
+      self[:status] == '1'
+    end
+  end
+
   module ClassMethods
+    def exetel_url
+      "https://smsgw.exetel.com.au/sendsms/#{api_path}?"
+    end
+  
     def new_reference_number(ident='')
       @@counter ||= 0
       @@counter += 1
@@ -20,17 +30,13 @@ module ExetelSms
       URI.encode(URI.encode(str), /=|&|\?/)
     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
       ret = {}
       response_fields.each {|field| ret[field] = fields.shift }
       ret[:other] = fields
-      class << ret
-        def success?
-          self[:status] == '1'
-        end
-      end
-      ret
+      ret.extend ResultHashMethods
     end
       
   end

data/lib/client.rb

@@ -7,8 +7,40 @@ require 'uri'
 module ExetelSms
   class Client
     class << self
+      attr_accessor :test_api
+      
+      def with_test_api(failmode=false)
+        old_test_api = @test_api
+        @test_api = failmode
+        retval = yield
+        @test_api = old_test_api
+        retval
+      end
+      
+      def test_api?
+        !@test_api.nil?
+      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}\?/)
+          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=(.*)/))
+          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}\?/)
+          test_api != false ? '2|No results returned' : "1|OK"
+        elsif url.match(/\/#{CreditCheck.api_path}\?/)
+          test_api != false ? '1|0|OK' : '1|100|OK'
+        else
+          raise "ExetelSMS test API: Unknown URL"
+        end.split('|',-1).map {|str| str.strip }
+      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
@@ -19,7 +51,7 @@ module ExetelSms
           response = http.request_get(uri.request_uri)
           body = response.body
         end
-        raise "No body" unless body && body =~ /|/
+        raise "ExetelSms::Client: No valid body found: #{body.inspect}" unless body && body =~ /|/
         body.chomp.gsub(/<br>$/i, '').split('|',-1).map {|str| str.strip }
       end
     end

data/lib/config.rb

@@ -9,5 +9,6 @@ module ExetelSms
       @password = password
       @mvn = mvn
     end  
+    
   end
 end

data/lib/credit_check.rb

@@ -0,0 +1,35 @@
+
+module ExetelSms
+  
+  class CreditCheck
+    extend ExetelSms::ClassMethods
+  
+    attr_reader :config
+    def initialize(config)
+      @config = config
+    end
+    
+    def get_credit_limit
+      url = self.class.build_url(
+        :username => @config.username,
+        :password => @config.password
+      )
+      
+      self.class.response_to_hash(ExetelSms::Client.request(url))
+    end
+    
+    class << self
+      def response_fields
+        [:status, :limit, :notes]
+      end
+      
+      def request_fields
+        [:username, :password]
+      end
+
+      def api_path
+        'api_sms_credit.php'
+      end
+    end
+  end
+end

data/lib/deleter.rb

@@ -17,11 +17,10 @@ module ExetelSms
         :messageid => message_id
       )
       
-      response_to_hash(ExetelSms::Client.request(url))
+      self.class.response_to_hash(ExetelSms::Client.request(url))
     end
     
     class << self
-      
       def response_fields
         [:status, :notes]
       end
@@ -30,10 +29,9 @@ module ExetelSms
         [:username, :password, :mobilenumber, :messageid]
       end
 
-      def exetel_url
-        'https://smsgw.exetel.com.au/sendsms/api_sms_mvn_delete.php?'
+      def api_path
+        'api_sms_mvn_delete.php'
       end
-
     end
   end
 end

data/lib/exetel_sms.rb

@@ -1,5 +1,5 @@
 
-['client', 'class_methods', 'sender', 'config', 'receiver', 'deleter', 'retriever'].each do |x|
+['class_methods', 'client', 'sender', 'config', 'receiver', 'deleter', 'retriever', 'credit_check'].each do |x|
   require("#{File.dirname(__FILE__)}/" + x)
 end
 

data/lib/receiver.rb

@@ -29,8 +29,8 @@ module ExetelSms
         [:username, :password, :mobilenumber]
       end
 
-      def exetel_url
-        'https://smsgw.exetel.com.au/sendsms/api_sms_mvn_inbox.php?'
+      def api_path
+        'api_sms_mvn_inbox.php'
       end
 
     end

data/lib/retriever.rb

@@ -8,7 +8,7 @@ module ExetelSms
     def initialize(config)
       @config = config
     end
-    
+
     def check_sent(reference_number)
       url = self.class.build_url(
         :username => @config.username,
@@ -29,8 +29,8 @@ module ExetelSms
         [:username, :password, :referencenumber]
       end
 
-      def exetel_url
-        'https://smsgw.exetel.com.au/sendsms/api_sms_detail.php?'
+      def api_path
+        'api_sms_detail.php'
       end
 
     end

data/lib/sender.rb

@@ -8,7 +8,7 @@ module ExetelSms
     def initialize(config)
       @config = config
     end
-    
+
     def send(to_mobile_number, msg, from_mobile_number, reference_number)
       url = self.class.build_url(
         :username => @config.username,
@@ -33,9 +33,8 @@ module ExetelSms
         [:username, :password, :mobilenumber, :message, :sender, :messagetype, :referencenumber]
       end
 
-      def exetel_url
-        'https://smsgw.exetel.com.au/sendsms/api_sms.php?'
-        #username=xxxxxxxx&password=xxxxxxxx&mobilenumber=xxxxxxxx&message=xxxxxxxx&sender=xxxxxxxxx&messagetype=Text&referencenumber=xxxxxx'
+      def api_path
+        'api_sms.php'
       end
 
     end

data/test/test_all.rb

@@ -0,0 +1,79 @@
+
+require 'test/unit'
+require "./#{File.dirname(__FILE__)}/../lib/exetel_sms.rb"
+
+class TestExetelSms < Test::Unit::TestCase
+
+  def setup
+    config = ExetelSms::Config.new('username', 'password')
+    @sender = ExetelSms::Sender.new(config)
+    @retriever = ExetelSms::Retriever.new(config)
+    @receiver = ExetelSms::Receiver.new(config)
+    @deleter = ExetelSms::Deleter.new(config)
+    @credit_check = ExetelSms::CreditCheck.new(config)
+  end
+  
+  def teardown
+  end
+  
+  def test_credit_check_ok
+    result = ExetelSms::Client.with_test_api { @credit_check.get_credit_limit }
+    assert result.success?
+    assert result[:limit].to_f > 0
+  end
+
+  def test_credit_check_fail
+    result = ExetelSms::Client.with_test_api(:fail) { @credit_check.get_credit_limit }
+    assert result.success?
+    assert_equal 0, result[:limit].to_f
+  end
+  
+  def test_sender_ok
+    result = ExetelSms::Client.with_test_api { @sender.send('0412345678', 'Hello?', '0412987654', '1') }
+    assert result.success?
+  end
+
+  def test_sender_exception
+    assert_raises(Timeout::Error) do
+      ExetelSms::Client.with_test_api(:fail) { @sender.send('0412345678', 'Hello?', '0412987654', '1') }
+    end
+  end
+
+  def test_receiver_ok
+    result = ExetelSms::Client.with_test_api { @receiver.receive('0412345678') }
+    assert result.success?
+    assert_not_equal '', result[:message]
+  end
+
+  def test_receiver_fail
+    result = ExetelSms::Client.with_test_api(:fail) { @receiver.receive('0412345678') }
+    assert !result.success?
+    assert_equal '', result[:message]
+  end
+
+  def test_retriever_ok
+    result = ExetelSms::Client.with_test_api { @retriever.check_sent('1') }
+    assert result.success?
+    assert_equal 'Delivered', result[:message_status]
+  end
+
+  def test_retriever_fail
+    result = ExetelSms::Client.with_test_api(:fail) { @retriever.check_sent('1') }
+    assert result.success?
+    assert_equal 'Failed', result[:message_status]
+  end
+
+  def test_deleter_ok
+    result = ExetelSms::Client.with_test_api { @deleter.delete('0412345678', '1') }
+    assert result.success?
+  end
+
+  def test_deleter_fail
+    result = ExetelSms::Client.with_test_api(:fail) { @deleter.delete('0412345678', '1') }
+    assert !result.success?
+  end
+  
+  
+end
+
+

metadata

@@ -1,11 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: exetel_sms
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 3
-  version: "1.03"
+  prerelease: 
+  version: "1.04"
 platform: ruby
 authors: 
 - Andrew Snow
@@ -13,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-28 00:00:00 +11:00
+date: 2011-03-30 00:00:00 +11:00
 default_executable: 
 dependencies: []
 
@@ -31,6 +28,7 @@ extra_rdoc_files:
 - lib/class_methods.rb
 - lib/client.rb
 - lib/config.rb
+- lib/credit_check.rb
 - lib/deleter.rb
 - lib/exetel_sms.rb
 - lib/receiver.rb
@@ -45,11 +43,13 @@ files:
 - lib/class_methods.rb
 - lib/client.rb
 - lib/config.rb
+- lib/credit_check.rb
 - lib/deleter.rb
 - lib/exetel_sms.rb
 - lib/receiver.rb
 - lib/retriever.rb
 - lib/sender.rb
+- test/test_all.rb
 - Manifest
 - exetel_sms.gemspec
 has_rdoc: true
@@ -71,24 +71,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 2
       version: "1.2"
 requirements: []
 
 rubyforge_project: exetel_sms
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Ruby gem to send and receive SMS via Exetel's API
-test_files: []
-
+test_files: 
+- test/test_all.rb