bobes-textmagic 0.3.2 → 0.3.3

data/History.txt

@@ -1,4 +1,9 @@
-== unreleased features
+== 0.3.3 2009-06-13
+
+* Added support for send_time parameter for send command.
+* Added support for check_number command.
+
+== 0.3.2 2009-06-07
 
 * Fixed message length validation to count escaped characters twice for non-unicode messages.
 * Aliased message_status as status and delete_reply as delete.

data/README.rdoc

@@ -68,6 +68,10 @@ of parts, specify an optional +max_length+ parameter:
 
   api.send 'Very very long message...', '999314159265', :max_length => 2
 
+If you want to postpone message delivery, specify a +send_time+ parameter:
+
+  api.send 'Two hours later', '999314159265', :send_time => Time.now.to_i + 7200
+
 See TextMagic::API.send for more information on +send+ method.
 
 === Checking sent message status

data/Rakefile

@@ -63,8 +63,6 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "textmagic #{version}"
   rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('LICENSE')
-  rdoc.rdoc_files.include('History*')
   rdoc.rdoc_files.include('lib/**/*.rb')
   rdoc.options << '--charset' << 'utf8'
   rdoc.options << '--fmt' << 'shtml'

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 3
-:patch: 2
+:patch: 3

data/lib/api.rb

@@ -51,6 +51,10 @@ module TextMagic
     #   the text.
     # * +max_length+: accepted values are +nil+, +1+, +2+ and +3+, defaults to nil.
     #   If not specified, the SMS gateway will apply its own default value.
+    # * +send_time+: allows you to postpone sending of the message. Note that the message
+    #   will be sent to the SMS gateway immediately and will wait there until the specified
+    #   time. You can either supply a numeric value denoting number of seconds since
+    #   1.1.1970, or a Time object.
     #
     # Example usage:
     #
@@ -70,6 +74,10 @@ module TextMagic
     # want to get a hash response, put the phone number in an array:
     #
     #  api.send('Hi Barney', ['999271828182'])
+    #
+    # Postponed sending:
+    #
+    #  api.send('Two hours later', '999314159265', :send_time => Time.now.to_i + 7200)
     def send(text, *args)
       raise Error.new(1, 'Message text is empty') if text.nil? || text.blank?
       options = args.last.is_a?(Hash) ? args.pop : {}
@@ -85,6 +93,7 @@ module TextMagic
       single = args.size == 1 && args.first.is_a?(String)
       phones = args.flatten
       raise Error.new(9, 'Invalid phone number format') unless API.validate_phones(phones)
+      options[:send_time] = options[:send_time].to_i if options[:send_time]
       hash = Executor.execute('send', @username, @password, options.merge(:text => text, :phone => phones.join(',')))
       TextMagic::API::Response.send(hash, single)
     end
@@ -190,5 +199,49 @@ module TextMagic
       true
     end
     alias :delete :delete_reply
+
+    # Executes a check_number command by sending a request to the TextMagic's
+    # SMS gateway.
+    #
+    # If called with a single phone number, this method returns an OpenStruct instance
+    # with credit price and country code for the given phone number. If called with
+    # multiple phone numbers, the method returns a hash of such instances with phone
+    # numbers as keys.
+    # In case the request to the SMS gateway is not successful or the server returns
+    # an error response, an Error is raised.
+    #
+    # Example usage:
+    #
+    #  check = api.check_number('447624800500')
+    #  check.price
+    #  # => 0.8
+    #  check.country
+    #  # => 'GB'
+    #
+    # Example with multiple phone numbers:
+    #
+    #  check = api.check_number('447624800500', '61428102137')
+    #  check['447624800500'].price
+    #  # => 0.8
+    #  check['61428102137'].country
+    #  # => 'AU'
+    #
+    # Multiple phone number can be supplied as an array or as a list of arguments:
+    #
+    #  api.check_number(['447624800500', '61428102137'])
+    #  api.check_number('447624800500', '61428102137')
+    #
+    # If you want to check a single phone number but still want to get
+    # a hash response, put the number in an array:
+    #
+    #  api.check_number(['447624800500'])
+    def check_number(*phones)
+      single = phones.size == 1 && phones.first.is_a?(String)
+      phones.flatten!
+      raise TextMagic::API::Error.new(4, 'Insufficient parameters') if phones.empty?
+      hash = Executor.execute('check_number', @username, @password, :phone => phones.join(','))
+      TextMagic::API::Response.check_number(hash, single)
+    end
+    alias :check :check_number
   end
 end

data/lib/response.rb

@@ -61,6 +61,14 @@ module TextMagic
         response.unread = hash['unread']
         response
       end
+
+      def self.check_number(hash, single)
+        response = {}
+        hash.each do |phone, check_hash|
+          response[phone] = OpenStruct.new(check_hash)
+        end
+        single ? response.values.first : response
+      end
     end
   end
 end

data/test/test_api.rb

@@ -102,6 +102,18 @@ class APITest < Test::Unit::TestCase
       lambda { @api.send(@text, @phone) }.should raise_error(TextMagic::API::Error)
     end
 
+    should 'support send_time option' do
+      time = Time.now + rand
+      TextMagic::API::Executor.expects(:execute).with('send', @username, @password, :text => @text, :phone => @phone, :unicode => 0, :send_time => time.to_i).returns(@response)
+      @api.send(@text, @phone, :send_time => time.to_i)
+    end
+
+    should 'convert send_time to Fixnum' do
+      time = Time.now + rand
+      TextMagic::API::Executor.expects(:execute).with('send', @username, @password, :text => @text, :phone => @phone, :unicode => 0, :send_time => time.to_i).returns(@response)
+      @api.send(@text, @phone, :send_time => time)
+    end
+
     should 'call Response.send method to process the response hash (single phone)' do
       processed_response = rand
       TextMagic::API::Response.expects(:send).with(@response, true).returns(processed_response)
@@ -228,4 +240,50 @@ class APITest < Test::Unit::TestCase
       @api.delete_reply(random_string).should == true
     end
   end
+
+  context 'Check number command' do
+
+    setup do
+      @username, @password = random_string, random_string
+      @api = TextMagic::API.new(@username, @password)
+      @response = random_string
+      @processed_response = random_string
+      TextMagic::API::Executor.stubs(:execute).returns(@response)
+      TextMagic::API::Response.stubs(:check_number).returns(@processed_response)
+    end
+
+    should 'call Executor execute with correct arguments' do
+      phone = random_phone
+      TextMagic::API::Executor.expects(:execute).with('check_number', @username, @password, :phone => phone)
+      @api.check_number(phone)
+    end
+
+    should 'join phones supplied as array' do
+      phones = Array.new(3) { random_phone }
+      TextMagic::API::Executor.expects(:execute).with('check_number', @username, @password, :phone => phones.join(','))
+      @api.check_number(phones)
+    end
+
+    should 'join phones supplied as arguments' do
+      phones = Array.new(3) { random_phone }
+      TextMagic::API::Executor.expects(:execute).with('check_number', @username, @password, :phone => phones.join(','))
+      @api.check_number(*phones)
+    end
+
+    should 'not call execute and should raise an exception if no phones are specified' do
+      TextMagic::API::Executor.expects(:execute).never
+      lambda { @api.check_number }.should raise_error(TextMagic::API::Error)
+    end
+
+    should 'call Response.check_number method to process the response hash (single phone)' do
+      TextMagic::API::Response.expects(:check_number).with(@response, true).returns(@processed_response)
+      @api.check_number(random_string).should == @processed_response
+    end
+
+    should 'call Response.check_number method to process the response hash (mulitple phones)' do
+      TextMagic::API::Response.expects(:check_number).with(@response, false).returns(@processed_response).twice
+      @api.check_number([random_string]).should == @processed_response
+      @api.check_number(random_string, random_string).should == @processed_response
+    end
+  end
 end

data/test/test_response.rb

@@ -121,7 +121,7 @@ class ResponseTest < Test::Unit::TestCase
       @response.credits_cost.should be_close(@credits_cost, 1e-10)
     end
   end
-  
+
   context 'Response to message_status command with multiple ids' do
 
     setup do
@@ -209,7 +209,7 @@ class ResponseTest < Test::Unit::TestCase
       @response.first.timestamp.should == Time.at(@timestamp)
     end
 
-    should 'have from for allmessages' do
+    should 'have from for all messages' do
       @response.first.from.should == @phone
     end
 
@@ -221,4 +221,68 @@ class ResponseTest < Test::Unit::TestCase
       @response.first.message_id.should == @message_id
     end
   end
+
+  context 'Response to check_number command with single phone' do
+
+    setup do
+      @phone = random_phone
+      @price = rand
+      @country = random_string
+      @hash = {
+        @phone => {
+          'price' => @price,
+          'country' => @country
+        }
+      }
+      @response = TextMagic::API::Response.check_number(@hash, true)
+    end
+
+    should 'be an OpenStruct instance' do
+      @response.class.should == OpenStruct
+    end
+
+    should 'have price' do
+      @response.price.should be_close(@price, 1e-10)
+    end
+
+    should 'have country' do
+      @response.country.should == @country
+    end
+  end
+
+  context 'Response to check_number command with multiple phones' do
+
+    setup do
+      @phone = random_phone
+      @price = rand
+      @country = random_string
+      @hash = {
+        @phone => {
+          'price' => @price,
+          'country' => @country
+        }
+      }
+      @response = TextMagic::API::Response.check_number(@hash, false)
+    end
+
+    should 'be a hash' do
+      @response.class.should == Hash
+    end
+
+    should 'have phones as keys' do
+      @response.keys.should == [@phone]
+    end
+
+    should 'contain OpenStruct instances' do
+      @response.values.first.class.should == OpenStruct
+    end
+
+    should 'have price for all phones' do
+      @response.values.first.price.should be_close(@price, 1e-10)
+    end
+
+    should 'have country for all phones' do
+      @response.values.first.country.should == @country
+    end
+  end
 end

data/textmagic.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{textmagic}
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Vladim\303\255r Bobe\305\241 Tu\305\276insk\303\275"]
-  s.date = %q{2009-06-07}
+  s.date = %q{2009-06-13}
   s.default_executable = %q{tm}
   s.description = %q{
       textmagic is a Ruby interface to the TextMagic's Bulk SMS Gateway.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bobes-textmagic
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors: 
 - "Vladim\xC3\xADr Bobe\xC5\xA1 Tu\xC5\xBEinsk\xC3\xBD"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-07 00:00:00 -07:00
+date: 2009-06-13 00:00:00 -07:00
 default_executable: tm
 dependencies: 
 - !ruby/object:Gem::Dependency