clickatell 0.5.0 → 0.6.0

data/History.txt

@@ -1,10 +1,20 @@
+== 0.6.0
+
+* API host can now be customized (John Gibbons)
+* Fixed bug with the ampersands in messages, they are now escaped properly (John Brice)
+* Removed reliance on Object#blank? which was causing some compatibility issues (Greg Bell)
+* Added :callback option support (Greg Bell)
+* Added new test mode (Pivotal Labs)
+
 == 0.5.0
+
 * Added support for mobile originated flag (courtesy Dan Weinand)
 * Added support for WAP push (experimental, courtesy Zhao Lu)
 * Updated specs to use Mocha instead of the built-in RSpec mocking
 * Improved specs in general
 
 == 0.4.1
+
 * Custom alphanumeric sender would not always be supported by default unless it was explicitly enabled using the req_feat parameter.
 
 == 0.4.0

data/lib/clickatell/api.rb

@@ -20,7 +20,18 @@ module Clickatell
       
       # Enable secure mode (SSL)
       attr_accessor :secure_mode
+
+      # Allow customizing URL
+      attr_accessor :api_service_host
+
+      # Set to true to test message sending; this will not actually send 
+      # messages but will collect sent messages in a testable collection. 
+      # (off by default)
+      attr_accessor :test_mode
     end
+    self.debug_mode = false
+    self.secure_mode = false
+    self.test_mode = false
     
     # Creates a new API instance using the specified +auth options+.
     # +auth_options+ is a hash containing either a :session_id or 
@@ -61,7 +72,7 @@ module Clickatell
     #
     # Returns a new message ID if successful.
     def send_message(recipient, message_text, opts={})
-      valid_options = opts.only(:from, :mo)
+      valid_options = opts.only(:from, :mo, :callback)
       valid_options.merge!(:req_feat => '48') if valid_options[:from]
       valid_options.merge!(:mo => '1') if opts[:set_mobile_originated]
       response = execute_command('sendmsg', 'http',
@@ -91,10 +102,19 @@ module Clickatell
       response = execute_command('getbalance', 'http')
       parse_response(response)['Credit'].to_f
     end
+    
+    def sms_requests
+      @sms_requests ||= []
+    end
 
-    protected
+    protected      
       def execute_command(command_name, service, parameters={}) #:nodoc:
-        CommandExecutor.new(auth_hash, self.class.secure_mode, self.class.debug_mode).execute(command_name, service, parameters)
+        executor = CommandExecutor.new(auth_hash, self.class.secure_mode, self.class.debug_mode, self.class.test_mode)
+        result = executor.execute(command_name, service, parameters)
+        
+        (sms_requests << executor.sms_requests).flatten! if self.class.test_mode
+        
+        result
       end
 
       def parse_response(raw_response) #:nodoc:
@@ -123,4 +143,4 @@ end
     
 ).each do |lib|
     require File.join(File.dirname(__FILE__), lib)
-end
+end

data/lib/clickatell/api/command.rb

@@ -1,3 +1,4 @@
+require "cgi"
 module Clickatell
   class API
 
@@ -14,17 +15,17 @@ module Clickatell
   
       # Returns a URL for the given parameters (a hash).
       def with_params(param_hash)
-        param_string = '?' + param_hash.map { |key, value| "#{key}=#{value}" }.sort.join('&')
-        return URI.parse(File.join(api_service_uri, @command_name + URI.encode(param_string)))
+        param_string = '?' + param_hash.map { |key, value| "#{::CGI.escape(key.to_s)}=#{::CGI.escape(value.to_s)}" }.sort.join('&')
+        return URI.parse(File.join(api_service_uri, @command_name + param_string))
       end
 
       protected
         def api_service_uri
           protocol = @options[:secure] ? 'https' : 'http'
-          port = @options[:secure] ? 443 : 80
-          return "#{protocol}://#{API_SERVICE_HOST}:#{port}/#{@service}/"
+          api_service_host = ((Clickatell::API.api_service_host.nil? || Clickatell::API.api_service_host.empty?) ? API_SERVICE_HOST : Clickatell::API.api_service_host)
+          return "#{protocol}://#{api_service_host}/#{@service}/"
         end
     end
     
   end
-end
+end

data/lib/clickatell/api/command_executor.rb

@@ -4,12 +4,25 @@ require 'net/https'
 module Clickatell
   class API
    
+   class FakeHttpResponse
+     def body
+       "test"
+     end
+   end
+   
     # Used to run commands agains the Clickatell gateway.
     class CommandExecutor
-      def initialize(authentication_hash, secure=false, debug=false)
+      def initialize(authentication_hash, secure=false, debug=false, test_mode=false)
         @authentication_hash = authentication_hash
         @debug = debug
         @secure = secure
+        @test_mode = test_mode
+        
+        allow_request_recording if @test_mode
+      end
+      
+      def in_test_mode?
+        @test_mode
       end
       
       # Builds a command object and sends it using HTTP GET. 
@@ -29,12 +42,27 @@ module Clickatell
         end
         
         def get_response(uri)
-          http = Net::HTTP.new(uri.host, uri.port)
-          http.use_ssl = (uri.scheme == 'https')
-          http.start do |http|
-            resp, body = http.get([uri.path, uri.query].join('?'))
+          if in_test_mode?
+            sms_requests << uri
+            [FakeHttpResponse.new]
+          else
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.use_ssl = (uri.scheme == 'https')
+            http.start do |http|
+              resp, body = http.get([uri.path, uri.query].join('?'))
+            end
           end
         end
+        
+      private
+      
+      def allow_request_recording
+        class << self
+          define_method :sms_requests do
+            @sms_requests ||= []
+          end
+        end
+      end
     end 
   
   end

data/lib/clickatell/response.rb

@@ -10,6 +10,8 @@ module Clickatell
       
       # Returns the HTTP response body data as a hash.
       def parse(http_response)
+        return { 'OK' => 'session_id' } if API.test_mode
+        
         if http_response.body.scan(/ERR/).any?
           raise Clickatell::API::Error.parse(http_response.body)
         end

data/lib/clickatell/version.rb

@@ -1,7 +1,7 @@
 module Clickatell #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 5
+    MINOR = 6
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/spec/api_spec.rb

@@ -14,14 +14,36 @@ module Clickatell
       @command = API::Command.new('cmdname')
     end
     
+    after do
+      Clickatell::API.api_service_host = nil
+    end
+    
     it "should return encoded URL for the specified command and parameters" do
       url = @command.with_params(:param_one => 'abc', :param_two => '123')
       url.should == URI.parse("http://api.clickatell.com/http/cmdname?param_one=abc&param_two=123")
     end
     
     it "should URL encode any special characters in parameters" do
-      url = @command.with_params(:param_one => 'abc', :param_two => 'hello world')
-      url.should == URI.parse("http://api.clickatell.com/http/cmdname?param_one=abc&param_two=hello%20world")
+      url = @command.with_params(:param_one => 'abc', :param_two => 'hello world & goodbye cruel world <grin>')
+      url.should == URI.parse("http://api.clickatell.com/http/cmdname?param_one=abc&param_two=hello+world+%26+goodbye+cruel+world+%3Cgrin%3E")
+    end
+    
+    it "should use a custom host when constructing command URLs if specified" do
+      Clickatell::API.api_service_host = 'api.clickatell-custom.co.uk'
+      url = @command.with_params(:param_one => 'abc', :param_two => '123')
+      url.should == URI.parse("http://api.clickatell-custom.co.uk/http/cmdname?param_one=abc&param_two=123")
+    end
+    
+    it "should use the default host if specified custom host is nil" do
+      Clickatell::API.api_service_host = nil
+      url = @command.with_params(:param_one => 'abc', :param_two => '123')
+      url.should == URI.parse("http://api.clickatell.com/http/cmdname?param_one=abc&param_two=123")
+    end
+    
+    it "should use the default host if specified custom host is an empty string" do
+      Clickatell::API.api_service_host = ''
+      url = @command.with_params(:param_one => 'abc', :param_two => '123')
+      url.should == URI.parse("http://api.clickatell.com/http/cmdname?param_one=abc&param_two=123")
     end
   end
   
@@ -35,7 +57,7 @@ module Clickatell
       url.should == URI.parse("https://api.clickatell.com/http/cmdname?param_one=abc&param_two=123")
     end
   end
-  
+    
   describe "Command executor" do
     it "should create an API command with the given params" do
       executor = API::CommandExecutor.new(:session_id => '12345')
@@ -68,9 +90,11 @@ module Clickatell
     before do
       API.debug_mode = false
       API.secure_mode = false
+      API.test_mode = false
+      
       @executor = mock('command executor')
       @api = API.new(:session_id => '1234')
-      API::CommandExecutor.stubs(:new).with({:session_id => '1234'}, false, false).returns(@executor)
+      API::CommandExecutor.stubs(:new).with({:session_id => '1234'}, false, false, false).returns(@executor)
     end
     
     it "should use the api_id, username and password to authenticate and return the new session id" do
@@ -91,10 +115,10 @@ module Clickatell
     it "should support sending messages to a specified number, returning the message id" do
       @executor.expects(:execute).with('sendmsg', 'http', 
         :to => '4477791234567',
-        :text => 'hello world'
+        :text => 'hello world & goodbye'
       ).returns(response = stub('response'))
       Response.stubs(:parse).with(response).returns('ID' => 'message_id')      
-      @api.send_message('4477791234567', 'hello world').should == 'message_id'
+      @api.send_message('4477791234567', 'hello world & goodbye').should == 'message_id'
     end
     
     it "should set the :from parameter and set the :req_feat to 48 when using a custom from string when sending a message" do
@@ -109,6 +133,12 @@ module Clickatell
       @api.send_message('4477791234567', 'hello world', :set_mobile_originated => true)
     end
     
+    it "should set the callback flag to the number passed in the options hash" do
+      @executor.expects(:execute).with('sendmsg', 'http', has_entry(:callback => 1)).returns(response=mock('response'))
+      Response.stubs(:parse).with(response).returns('ID' => 'message_id')
+      @api.send_message('4477791234567', 'hello world', :callback => 1)
+    end
+    
     it "should ignore any invalid parameters when sending a message" do
       @executor.expects(:execute).with('sendmsg', 'http', Not(has_key(:any_old_param))).returns(response = stub('response'))
       Response.stubs(:parse).returns('ID' => 'foo')
@@ -145,10 +175,8 @@ module Clickatell
   
   describe API, ' with no authentication options set' do
     it "should build commands with no authentication options" do
-      API.debug_mode = false
-      API.secure_mode = false
       api = API.new
-      API::CommandExecutor.stubs(:new).with({}, false, false).returns(executor = stub('command executor'))
+      API::CommandExecutor.stubs(:new).with({}, false, false, false).returns(executor = stub('command executor'))
       executor.stubs(:execute)
       api.ping('1234')
     end
@@ -156,10 +184,9 @@ module Clickatell
   
   describe API, ' in secure mode' do
     it "should execute commands securely" do
-      API.debug_mode = false
       API.secure_mode = true
       api = API.new
-      API::CommandExecutor.expects(:new).with({}, true, false).returns(executor = stub('command executor'))
+      API::CommandExecutor.expects(:new).with({}, true, false, false).returns(executor = stub('command executor'))
       executor.stubs(:execute)
       api.ping('1234')
     end
@@ -174,4 +201,30 @@ module Clickatell
     end
   end
   
+  describe API, "#test_mode" do
+    before(:each) do
+      API.secure_mode = false
+      API.test_mode = true
+      @api = API.new
+    end
+    
+    it "should create a new CommandExecutor with test_mode parameter set to true" do
+      API::CommandExecutor.expects(:new).with({}, false, false, true).once.returns(executor = mock('command executor'))
+      executor.stubs(:execute)
+      executor.stubs(:sms_requests).returns([])
+      @api.ping('1234')
+    end
+    
+    it "should record all commands" do
+      @api.ping('1234')
+      @api.sms_requests.should_not be_empty
+    end
+    
+    it "should return the recorded commands in a flattened array" do
+      @api.ping('1234')
+      @api.sms_requests.size.should == 1
+      @api.sms_requests.first.should_not be_instance_of(Array)
+    end
+  end
+  
 end

data/spec/command_executor_spec.rb

@@ -0,0 +1,75 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/clickatell'
+
+module Clickatell
+  describe "API::CommandExecutor" do
+    it "should have test mode" do
+      executor = API::CommandExecutor.new({}, false, false, :test_mode)
+      executor.should be_in_test_mode
+    end
+    
+    it "should default to not test mode" do
+      executor = API::CommandExecutor.new({})
+      executor.should_not be_in_test_mode
+    end
+
+    describe "#execute" do
+      describe "in non-test mode" do
+        before(:each) do
+          @executor = API::CommandExecutor.new({})
+        end
+        
+        it "should not record requests" do
+          @executor.should_not respond_to(:sms_requests)
+        end
+      end
+      
+      describe "in test mode" do
+        before(:each) do
+          @params = {:foo => 1, :bar => 2}
+          @executor = API::CommandExecutor.new(@params, false, false, :test_mode)
+        end
+        
+        it "should not make any network calls" do
+          Net::HTTP.expects(:new).never
+          @executor.execute("foo", "http")
+        end
+        
+        it "should start with an empty request collection" do
+          @executor.sms_requests.should be_empty
+        end
+        
+        it "should record sms requests" do
+          @executor.execute("bar", "http")
+          @executor.sms_requests.should_not be_empty
+        end
+        
+        it "should record a request for each call" do
+          @executor.execute("wibble", "http")
+          @executor.sms_requests.size.should == 1
+          @executor.execute("foozle", "http")
+          @executor.sms_requests.size.should == 2
+        end
+        
+        it "should return a response that approximates a true Net::HttpResponse" do
+          response = @executor.execute("throat-warbler", "http")
+          response.body.should == "test"
+        end
+        
+        describe "each recorded request" do
+          it "should return the command information" do
+            command = "rum_tum_tum"
+            @executor.execute(command, "http")
+            
+            uri = @executor.sms_requests.first
+            uri.host.should == "api.clickatell.com"
+            uri.path.should include(command)
+            @params.collect { |k, v| "#{k}=#{v}"}.each do |query_parameter|
+              uri.query.should include(query_parameter)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/response_spec.rb

@@ -8,6 +8,10 @@ module Clickatell
       Clickatell::API::Error.stubs(:parse).returns(Clickatell::API::Error.new('', ''))
     end
     
+    before(:each) do
+      API.test_mode = false
+    end
+    
     it "should return hash for one-line success response" do
       Response.parse(stub('response', :body => 'k1: foo k2: bar')).should == {'k1' => 'foo', 'k2' => 'bar'}
     end
@@ -15,6 +19,16 @@ module Clickatell
     it "should raise API::Error if response contains an error message" do
       proc { Response.parse(stub('response', :body => 'ERR: 001, Authentication failed')) }.should raise_error(Clickatell::API::Error)
     end
+    
+    describe "in test mode" do
+      before(:each) do
+        API.test_mode = true
+      end
+      
+      it "should return something approximating a session_id" do
+      Response.parse("pretty much anything").should == { 'OK' => 'session_id' }
+      end
+    end
   end
   
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'spec'
 require 'mocha'
+require 'test/unit'
 
 Spec::Runner.configure do |config|
   config.mock_with :mocha

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: clickatell
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Luke Redpath
@@ -9,74 +9,62 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-19 00:00:00 +01:00
-default_executable: 
+date: 2009-06-25 00:00:00 +01:00
+default_executable: sms
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: rspec
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: "0"
     version: 
-description: Ruby interface to the Clickatell SMS gateway service.
-email: contact[AT]lukeredpath.co.uk
+description: 
+email: luke@lukeredpath.co.uk
 executables: 
 - sms
 extensions: []
 
 extra_rdoc_files: 
+- RDOC_README.txt
 - History.txt
 - License.txt
-- Manifest.txt
-- README.txt
-- website/index.txt
 files: 
 - History.txt
 - License.txt
-- Manifest.txt
-- README.txt
+- RDOC_README.txt
 - README.textile
-- Rakefile
 - bin/sms
-- lib/clickatell.rb
-- lib/clickatell/api.rb
+- spec/api_spec.rb
+- spec/command_executor_spec.rb
+- spec/hash_ext_spec.rb
+- spec/response_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- lib/clickatell
+- lib/clickatell/api
 - lib/clickatell/api/command.rb
 - lib/clickatell/api/command_executor.rb
 - lib/clickatell/api/error.rb
 - lib/clickatell/api/message_status.rb
+- lib/clickatell/api.rb
 - lib/clickatell/response.rb
-- lib/clickatell/utility.rb
+- lib/clickatell/utility
 - lib/clickatell/utility/options.rb
+- lib/clickatell/utility.rb
 - lib/clickatell/version.rb
+- lib/clickatell.rb
+- lib/core-ext
 - lib/core-ext/hash.rb
-- scripts/txt2html
-- setup.rb
-- spec/api_spec.rb
-- spec/hash_ext_spec.rb
-- spec/response_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- website/images/footer_bg.gif
-- website/index.html
-- website/index.txt
-- website/javascripts/codehighlighter/code_highlighter.js
-- website/javascripts/codehighlighter/ruby.js
-- website/javascripts/rounded_corners_lite.inc.js
-- website/specs.html
-- website/stylesheets/limechoc.css
-- website/stylesheets/rdoc.css
-- website/stylesheets/screen.css
-- website/template.rhtml
 has_rdoc: true
 homepage: http://clickatell.rubyforge.org
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- RDOC_README.txt
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -94,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: clickatell
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: Ruby interface to the Clickatell SMS gateway service.