clickatell 0.6.0 → 0.7.0

data/History.txt

@@ -1,3 +1,7 @@
+== 0.7.0
+
+* Added support for sending SMS to multiple recipients.
+
 == 0.6.0
 
 * API host can now be customized (John Gibbons)

data/README.textile

@@ -12,6 +12,9 @@ You will need your API_ID as well as your account username and password.
   api = Clickatell::API.authenticate('your_api_id', 'your_username', 'your_password')
   api.send_message('447771234567', 'Hello from clickatell')
 
+To send a message to multiple recipients, simply pass in an array of numbers.
+
+  api.send_message(['447771234567', '447771234568'], 'Hello from clickatell')
   
 h2. Command-line SMS Utility
 
@@ -30,4 +33,8 @@ You can then use the sms utility to send a message to a single recipient:
   
 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).
+
+  sms 447771111111,447772222222 "Hello everyone"
+
 See http://clickatell.rubyforge.org for further instructions.  

data/bin/sms

@@ -30,11 +30,11 @@ begin
     puts "Status: #{Clickatell::API::MessageStatus[status]} (##{status})."
     exit 0
   else
-    puts "Sending '#{options.message}' to #{options.recipient}..."
+    puts "Sending '#{options.message}' to #{[options.recipient].flatten.join(", ")}..."
     additional_opts = {}
     additional_opts[:from] = options.from if options.from
     msg_id = api.send_message(options.recipient, options.message, additional_opts)
-    puts "Message sent successfully (message id: #{msg_id})."
+    puts "Message sent successfully (message id: #{[msg_id].flatten.join(", ")})."
     exit 0
   end
   

data/lib/clickatell/api.rb

@@ -75,10 +75,12 @@ module Clickatell
       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]
+      recipient = recipient.join(",")if recipient.is_a?(Array)
       response = execute_command('sendmsg', 'http',
         {:to => recipient, :text => message_text}.merge(valid_options)
       ) 
-      parse_response(response)['ID']
+      response = parse_response(response)
+      response.is_a?(Array) ? response.map { |r| r['ID'] } : response['ID']
     end
 
     def send_wap_push(recipient, media_url, notification_text='', opts={})

data/lib/clickatell/response.rb

@@ -15,7 +15,15 @@ module Clickatell
         if http_response.body.scan(/ERR/).any?
           raise Clickatell::API::Error.parse(http_response.body)
         end
-        YAML.load(http_response.body.scan(PARSE_REGEX).join("\n"))
+        results = http_response.body.split("\n").map do |line|
+          # YAML.load converts integer strings that have leading zeroes into integers
+          # using octal rather than decimal.  This isn't what we want, so we'll strip out any
+          # leading zeroes in numbers here.
+          response_fields = line.scan(PARSE_REGEX)
+          response_fields = response_fields.collect { |field| field.gsub(/\b0+(\d+)\b/, '\1') }
+          YAML.load(response_fields.join("\n"))
+        end
+        results.length == 1 ? results.first : results
       end
       
     end

data/lib/clickatell/utility/options.rb

@@ -9,7 +9,8 @@ module Clickatell
         def parse(args)
           @options = self.default_options
           parser = OptionParser.new do |opts|
-            opts.banner = "Usage: sms [options] recipient message"
+            opts.banner = "Usage: sms [options] recipient(s) message"
+            opts.separator "  Recipients can be a comma-separated list, up to 100 max."
             opts.separator ""
             opts.separator "Specific options:"
           
@@ -73,6 +74,8 @@ module Clickatell
             puts parser
             exit
           end
+          
+          @options.recipient = @options.recipient.split(",")
 
           return @options
         

data/lib/clickatell/version.rb

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

data/spec/api_spec.rb

@@ -121,6 +121,15 @@ module Clickatell
       @api.send_message('4477791234567', 'hello world & goodbye').should == 'message_id'
     end
     
+    it "should support sending messages to a multiple numbers, returning the message ids" do
+      @executor.expects(:execute).with('sendmsg', 'http', 
+        :to => '4477791234567,447779999999',
+        :text => 'hello world & goodbye'
+      ).returns(response = stub('response'))
+      Response.stubs(:parse).with(response).returns([{'ID' => 'message_1_id'}, {'ID' => 'message_2_id'}])
+      @api.send_message(['4477791234567', '447779999999'], 'hello world & goodbye').should == ['message_1_id', 'message_2_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
       @executor.expects(:execute).with('sendmsg', 'http', has_entries(:from => 'LUKE', :req_feat => '48')).returns(response = stub('response'))
       Response.stubs(:parse).with(response).returns('ID' => 'message_id')

data/spec/response_spec.rb

@@ -16,9 +16,23 @@ module Clickatell
       Response.parse(stub('response', :body => 'k1: foo k2: bar')).should == {'k1' => 'foo', 'k2' => 'bar'}
     end
     
+    it "should return array of hashes for multi-line success response" do
+      Response.parse(stub('response', :body => "k1: foo\nk2: bar")).should == [{'k1' => 'foo'}, {'k2' => 'bar'}]
+    end
+    
     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
+
+    {
+      '001' => 1, '002' => 2,  '003' => 3,  '004' => 4,
+      '005' => 5, '006' => 6,  '007' => 7,  '008' => 8,
+      '009' => 9, '010' => 10, '011' => 11, '012' => 12
+    }.each do |status_str, status_int|
+      it "should parse a message status code of #{status_int} when the response body contains a status code of #{status_str}" do
+        Response.parse(stub('response', :body => "ID: 0d1d7dda17d5a24edf1555dc0b679d0e Status: #{status_str}")).should == {'ID' => '0d1d7dda17d5a24edf1555dc0b679d0e', 'Status' => status_int}
+      end
+    end
     
     describe "in test mode" do
       before(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: clickatell
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Luke Redpath
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-25 00:00:00 +01:00
+date: 2009-10-07 00:00:00 +01:00
 default_executable: sms
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,23 +44,21 @@ files:
 - 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
 - lib/clickatell/utility/options.rb
 - lib/clickatell/utility.rb
 - lib/clickatell/version.rb
 - lib/clickatell.rb
-- lib/core-ext
 - lib/core-ext/hash.rb
 has_rdoc: true
 homepage: http://clickatell.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -82,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: clickatell
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: Ruby interface to the Clickatell SMS gateway service.