clickatell 0.7.1 → 0.8.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.8
+
+* Added fix for Ruby 1.9 (Ahmed Al Hafoudh)
+* Fixed a bug handling error codes above 008 (Sean Kibler)
+* Added HTTP proxy support (Josh Bassett)
+
+
 == 0.7.1
 
 * Fixed broken -b (balance) command

data/README.textile

@@ -6,35 +6,68 @@ h2. Basic Usage
 
 You will need your API_ID as well as your account username and password.
 
+<pre>
+<code>
   require 'rubygems'
   require 'clickatell'
-  
+
   api = Clickatell::API.authenticate('your_api_id', 'your_username', 'your_password')
   api.send_message('447771234567', 'Hello from clickatell')
+</code>
+</pre>
 
 To send a message to multiple recipients, simply pass in an array of numbers.
 
+<pre>
+<code>
   api.send_message(['447771234567', '447771234568'], 'Hello from clickatell')
-  
+</code>
+</pre>
+
+h2. HTTP Proxy
+
+You can configure the library to use a HTTP proxy when communicating with Clickatell.
+
+<pre>
+<code>
+  Clickatell::API.proxy_host     = 'my.proxy.com'
+  Clickatell::API.proxy_port     = 1234
+  Clickatell::API.proxy_username = 'joeschlub'
+  Clickatell::API.proxy_password = 'secret'
+</code>
+</pre>
+
 h2. Command-line SMS Utility
 
-The Clickatell gem also comes with a command-line utility that will allow you to send an SMS directly from the command-line. 
+The Clickatell gem also comes with a command-line utility that will allow you to send an SMS directly from the command-line.
 
 You will need to create a YAML configuration file in your home directory, in a file called .clickatell that resembles the following:
 
+<pre>
+<code>
   # ~/.clickatell
   api_key: your_api_id
   username: your_username
   password: your_password
-  
+</code>
+</pre>
+
 You can then use the sms utility to send a message to a single recipient:
 
+<pre>
+<code>
   sms 447771234567 'Hello from clickatell'
-  
+</code>
+</pre>
+
 Alternatively, you can specify the username and password as a command line option. Run +sms+ without any arguments for a full list of options.
 
 The sms utility also supports multiple, comma-separated recipients (up to 100).
 
+<pre>
+<code>
   sms 447771111111,447772222222 "Hello everyone"
+</code>
+</pre>
 
-See http://clickatell.rubyforge.org for further instructions.  
+See http://clickatell.rubyforge.org for further instructions.

data/clickatell.gemspec

@@ -0,0 +1,84 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{clickatell}
+  s.version = "0.8.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Luke Redpath"]
+  s.date = %q{2010-07-26}
+  s.default_executable = %q{sms}
+  s.email = %q{luke@lukeredpath.co.uk}
+  s.executables = ["sms"]
+  s.extra_rdoc_files = [
+    "History.txt",
+     "License.txt",
+     "RDOC_README.txt"
+  ]
+  s.files = [
+    ".gitignore",
+     "History.txt",
+     "License.txt",
+     "RDOC_README.txt",
+     "README.textile",
+     "Rakefile",
+     "bin/sms",
+     "clickatell.gemspec",
+     "lib/clickatell.rb",
+     "lib/clickatell/api.rb",
+     "lib/clickatell/api/command.rb",
+     "lib/clickatell/api/command_executor.rb",
+     "lib/clickatell/api/error.rb",
+     "lib/clickatell/api/message_status.rb",
+     "lib/clickatell/response.rb",
+     "lib/clickatell/utility.rb",
+     "lib/clickatell/utility/options.rb",
+     "lib/clickatell/version.rb",
+     "lib/core-ext/hash.rb",
+     "scripts/txt2html",
+     "spec/api_spec.rb",
+     "spec/cli_options_test.rb",
+     "spec/command_executor_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.txt",
+     "website/javascripts/codehighlighter/code_highlighter.js",
+     "website/javascripts/codehighlighter/ruby.js",
+     "website/javascripts/rounded_corners_lite.inc.js",
+     "website/stylesheets/limechoc.css",
+     "website/stylesheets/rdoc.css",
+     "website/stylesheets/screen.css",
+     "website/template.rhtml"
+  ]
+  s.homepage = %q{http://clickatell.rubyforge.org}
+  s.rdoc_options = ["--main", "RDOC_README.txt"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Ruby interface to the Clickatell SMS gateway service.}
+  s.test_files = [
+    "spec/api_spec.rb",
+     "spec/cli_options_test.rb",
+     "spec/command_executor_spec.rb",
+     "spec/hash_ext_spec.rb",
+     "spec/response_spec.rb",
+     "spec/spec_helper.rb",
+     "test/clickatell_api_test.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
+    else
+    end
+  else
+  end
+end
+

data/lib/clickatell/api.rb

@@ -24,6 +24,9 @@ module Clickatell
       # Allow customizing URL
       attr_accessor :api_service_host
 
+      # Set to your HTTP proxy details (off by default)
+      attr_accessor :proxy_host, :proxy_port, :proxy_username, :proxy_password
+
       # 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)
@@ -69,12 +72,13 @@ module Clickatell
     # Additional options:
     #    :from - the from number/name
     #    :set_mobile_originated - mobile originated flag
-    #
+    #    :client_message_id - user specified message id that can be used in place of Clickatell issued API message ID for querying message
     # Returns a new message ID if successful.
     def send_message(recipient, message_text, opts={})
-      valid_options = opts.only(:from, :mo, :callback)
+      valid_options = opts.only(:from, :mo, :callback, :climsgid)
       valid_options.merge!(:req_feat => '48') if valid_options[:from]
       valid_options.merge!(:mo => '1') if opts[:set_mobile_originated]
+      valid_options.merge!(:climsgid => opts[:client_message_id]) if opts[:client_message_id]
       recipient = recipient.join(",")if recipient.is_a?(Array)
       response = execute_command('sendmsg', 'http',
         {:to => recipient, :text => message_text}.merge(valid_options)
@@ -98,6 +102,11 @@ module Clickatell
       response = execute_command('querymsg', 'http', :apimsgid => message_id)
       parse_response(response)['Status']
     end
+
+    def message_charge(message_id)
+      response = execute_command('getmsgcharge', 'http', :apimsgid => message_id)
+      parse_response(response)['charge'].to_f
+    end
     
     # Returns the number of credits remaining as a float.
     def account_balance

data/lib/clickatell/api/command_executor.rb

@@ -31,7 +31,11 @@ module Clickatell
       def execute(command_name, service, parameters={})
         request_uri = command(command_name, service, parameters)
         puts "[debug] Sending request to #{request_uri}" if @debug
-        get_response(request_uri).first
+        result = get_response(request_uri)
+        if result.is_a?(Array)
+          result = result.first
+        end
+        result
       end
       
       protected
@@ -46,10 +50,19 @@ module Clickatell
             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('?'))
+            request = [uri.path, uri.query].join('?')
+
+            if API.proxy_host
+              http = Net::HTTP::Proxy(API.proxy_host, API.proxy_port, API.proxy_username, API.proxy_password)
+              http.start(uri.host) do |http|
+                resp, body = http.get(request)
+              end
+            else
+              http = Net::HTTP.new(uri.host, uri.port)
+              http.use_ssl = (uri.scheme == 'https')
+              http.start do |http|
+                resp, body = http.get(request)
+              end
             end
           end
         end

data/lib/clickatell/api/message_status.rb

@@ -3,18 +3,18 @@ module Clickatell
    
     class MessageStatus
       STATUS_MAP = {
-        1  => 'Message unknown',
-        2  => 'Message queued',
-        3  => 'Delivered to gateway',
-        4  => 'Received by recipient',
-        5  => 'Error with message',
-        6  => 'User cancelled messaged delivery',
-        7  => 'Error delivering message',
-        8  => 'OK',
-        9  => 'Routing error',
-        10 => 'Message expired',
-        11 => 'Message queued for later delivery',
-        12 => 'Out of credit'
+        '001'  => 'Message unknown',
+        '002'  => 'Message queued',
+        '003'  => 'Delivered to gateway',
+        '004'  => 'Received by recipient',
+        '005'  => 'Error with message',
+        '006'  => 'User cancelled messaged delivery',
+        '007'  => 'Error delivering message',
+        '008'  => 'OK',
+        '009'  => 'Routing error',
+        '010' => 'Message expired',
+        '011' => 'Message queued for later delivery',
+        '012' => 'Out of credit'
       }
       
       def self.[](code)

data/lib/clickatell/version.rb

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

data/spec/api_spec.rb

@@ -147,6 +147,12 @@ module Clickatell
       Response.stubs(:parse).with(response).returns('ID' => 'message_id')
       @api.send_message('4477791234567', 'hello world', :callback => 1)
     end
+
+    it "should set the client message id to the number passed in the options hash" do
+      @executor.expects(:execute).with('sendmsg', 'http', has_entry(:climsgid => 12345678)).returns(response=mock('response'))
+      Response.stubs(:parse).with(response).returns('ID' => 'message_id')
+      @api.send_message('4477791234567', 'hello world', :client_message_id => 12345678)
+    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'))

data/spec/command_executor_spec.rb

@@ -22,6 +22,36 @@ module Clickatell
         it "should not record requests" do
           @executor.should_not respond_to(:sms_requests)
         end
+
+        describe "without a proxy" do
+          before do
+            @http = mock()
+            @http.expects(:use_ssl=).with(false)
+            @http.expects(:start).returns([])
+            Net::HTTP.expects(:new).with(API::Command::API_SERVICE_HOST, 80).returns(@http)
+          end
+
+          it "should execute commands through the proxy" do
+            @executor.execute("foo", "http")
+          end
+        end
+
+        describe "with a proxy" do
+          before do
+            API.proxy_host     = @proxy_host     = "proxy.example.com"
+            API.proxy_port     = @proxy_port     = "1234"
+            API.proxy_username = @proxy_username = "joeschlub"
+            API.proxy_password = @proxy_password = "secret"
+
+            @http = mock()
+            @http.expects(:start).with(API::Command::API_SERVICE_HOST).returns([])
+            Net::HTTP.expects(:Proxy).with(@proxy_host, @proxy_port, @proxy_username, @proxy_password).returns(@http)
+          end
+
+          it "should execute commands through the proxy" do
+            @executor.execute("foo", "http")
+          end
+        end
       end
       
       describe "in test mode" do

data/test/clickatell_api_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+require 'clickatell/api'
+
+class ClickatellApiTest < Test::Unit::TestCase
+
+  context "Clickatell::API" do
+    setup do
+      @client = mock('client')
+      @client.stubs(:session_id).returns('dummy_session_id')
+      
+      @api = Clickatell::API.new(@client)
+    end
+    
+    context "#ping" do
+      should "perform the ping command with the current session id" do
+        @client.expects(:perform_command).with('ping', 
+          has_entry(:session_id => 'dummy_session_id')).returns(stub_response)
+        @api.ping
+      end
+      
+      should "return true when successful" do
+        @client.stubs(:perform_command).with('ping', anything).returns(stub_response("OK:"))
+        assert @api.ping
+      end
+      
+      should "return false when failed" do
+        @client.stubs(:perform_command).with('ping', anything).returns(stub_response("ERR:"))
+        assert !@api.ping
+      end
+    end
+  
+    context "#send_message with a single recipient" do
+      should "perform the sendmsg command with the correct options" do
+        @client.expects(:perform_command).with('sendmsg', 
+          has_entries(:to => '07999000000', :text => 'testing')).returns(stub_response)
+          
+        @api.send_message('07999000000', 'testing')
+      end
+      
+      should "allow a custom sender to be set" do
+        @client.expects(:perform_command).with('sendmsg', 
+          has_entry(:from => 'SENDER')).returns(stub_response)
+          
+        @api.send_message('07999000000', 'testing', :from => 'SENDER')
+      end
+      
+      should "set the req_feat parameter when specifying a custom sender" do
+        @client.expects(:perform_command).with('sendmsg', 
+          has_entry(:req_feat => '48')).returns(stub_response)
+
+        @api.send_message('07999000000', 'testing', :from => 'SENDER')
+      end
+      
+      should "set the mobile originated flag if specified" do
+        @client.expects(:perform_command).with('sendmsg', 
+          has_entry(:mo => '1')).returns(stub_response)
+
+        @api.send_message('07999000000', 'testing', :set_mobile_originated => true)
+      end
+      
+      should "return a single message ID" do
+        @client.stubs(:perform_command).returns(stub_response(%{
+          ID: 99999123
+        }))
+        assert_equal %w{99999123}, @api.send_message('07999000000', 'testing')
+      end
+    end
+    
+    context "#send_message with multiple recipients" do
+      should "perform the sendmsg command with a comma-separated list of recipients" do
+        @client.expects(:perform_command).with('sendmsg', 
+          has_entry(:to => '07999000000,07999000001,07999000002')).returns(stub_response)
+          
+        @api.send_message(%w{07999000000 07999000001 07999000002}, 'testing')
+      end
+      
+      should "return an array of message IDs" do
+        @client.stubs(:perform_command).returns(stub_response(%{
+          ID: 0000001
+          ID: 0000002
+          ID: 0000003
+        }))
+        expected = %w{0000001 0000002 0000003}
+        assert_equal expected, @api.send_message(%w{07999000000 07999000001 07999000002}, 'testing')
+      end
+    end
+  end
+  
+  private
+  
+  def stub_response(body = '', code = 200)
+    stub('Net::HTTP::Response', :code => 200, :body => body)
+  end
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: clickatell
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
+  hash: 63
+  prerelease: false
+  segments: 
+  - 0
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Luke Redpath
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-01 00:00:00 +00:00
+date: 2010-07-26 00:00:00 +01:00
 default_executable: sms
 dependencies: []
 
@@ -31,6 +37,7 @@ files:
 - README.textile
 - Rakefile
 - bin/sms
+- clickatell.gemspec
 - lib/clickatell.rb
 - lib/clickatell/api.rb
 - lib/clickatell/api/command.rb
@@ -59,6 +66,7 @@ files:
 - website/stylesheets/rdoc.css
 - website/stylesheets/screen.css
 - website/template.rhtml
+- test/clickatell_api_test.rb
 has_rdoc: true
 homepage: http://clickatell.rubyforge.org
 licenses: []
@@ -70,21 +78,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby interface to the Clickatell SMS gateway service.
@@ -95,3 +109,4 @@ test_files:
 - spec/hash_ext_spec.rb
 - spec/response_spec.rb
 - spec/spec_helper.rb
+- test/clickatell_api_test.rb