textmagic 0.3.3 → 0.4.0

data/.gitignore

@@ -1,5 +1,6 @@
 *.sw?
 .DS_Store
+.rvmrc
 coverage
 rdoc
 pkg

data/README.rdoc

@@ -145,8 +145,8 @@ to all of the gem's features. Run
 
 from your console to see help on its usage.
 
-<i>Note: This has only been tested on a Mac. If you have any troubles using this
-utility, contact the author (or submit a patch).</i>
+<i>Note: This has only been tested on a Mac with Ruby 1.8.7 and 1.9.1. If you have any troubles
+using this gem, contact the author (or submit a patch).</i>
 
 == Copyright
 

data/Rakefile

@@ -1,9 +1,13 @@
-require 'rubygems'
-require 'rake'
-require 'sdoc'
+# encoding: utf-8
+
+require "rubygems"
+require "rake"
+require "yaml"
+require "rake/testtask"
+require "rake/rdoctask"
 
 begin
-  require 'jeweler'
+  require "jeweler"
   Jeweler::Tasks.new do |gem|
     gem.name = "textmagic"
     gem.summary = %Q{Ruby interface to the TextMagic's Bulk SMS Gateway}
@@ -17,10 +21,11 @@ begin
     gem.homepage = "http://github.com/bobes/textmagic"
     gem.authors = ["Vladimír Bobeš Tužinský"]
     gem.rubyforge_project = "textmagic"
-    gem.add_runtime_dependency "httparty", ">= 0.4.3"
-    gem.add_development_dependency "mocha", ">= 0.9.5"
-    gem.add_development_dependency "fakeweb", ">= 1.2.2"
-    gem.add_development_dependency "jeremymcanally-matchy", ">= 0.1.0"
+    gem.add_runtime_dependency "httparty", ">= 0.5.2"
+    gem.add_development_dependency "mocha", ">= 0.9.8"
+    gem.add_development_dependency "shoulda", ">= 2.10.3"
+    gem.add_development_dependency "fakeweb", ">= 1.2.8"
+    gem.add_development_dependency "mcmire-matchy", ">= 0.5.2"
   end
 
   Jeweler::RubyforgeTasks.new
@@ -28,18 +33,18 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
-require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
   test.verbose = true
 end
+task :default => :test
 
 begin
-  require 'rcov/rcovtask'
+  require "rcov/rcovtask"
   Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
+    test.libs << "test"
+    test.pattern = "test/**/test_*.rb"
     test.verbose = true
   end
 rescue LoadError
@@ -48,13 +53,9 @@ rescue LoadError
   end
 end
 
-
-task :default => :test
-
-require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
+  if File.exist?("VERSION.yml")
+    config = YAML.load(File.read("VERSION.yml"))
     version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
   else
     version = ""
@@ -88,7 +89,7 @@ task :doc => :rerdoc do
   git push origin gh-pages
   EOS
 
-  system cmd.split(/\n\s*/).join(' && ')
+  system cmd.split(/\n\s*/).join(" && ")
 
   system <<-EOS
   echo 'Checking out master'

data/VERSION.yml

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

data/lib/api.rb

@@ -12,7 +12,7 @@ module TextMagic
     #
     # Example usage:
     #
-    #   api = TextMagic::API.new('fred', 'secret')
+    #   api = TextMagic::API.new("fred", "secret")
     def initialize(username, password)
       @username = username
       @password = password
@@ -30,7 +30,7 @@ module TextMagic
     #  api.account.balance
     #  # => 314.15
     def account
-      hash = Executor.execute('account', @username, @password)
+      hash = Executor.execute("account", @username, @password)
       TextMagic::API::Response.account(hash)
     end
 
@@ -58,43 +58,43 @@ module TextMagic
     #
     # Example usage:
     #
-    #  api.send('Hi Wilma', '999314159265')
-    #  # => '141421'
-    #  response = api.send('Hello everybody', '999314159265', '999271828182', :max_length => 2)
-    #  # => { '999314159265' => '141421', '999271828182' => '173205' }
+    #  api.send("Hi Wilma", "999314159265")
+    #  # => "141421"
+    #  response = api.send("Hello everybody", "999314159265", "999271828182", :max_length => 2)
+    #  # => { "999314159265" => "141421", "999271828182" => "173205" }
     #  response.parts_count
     #  # => 1
     #
     # Multiple phone numbers can be supplied as an array or as a list of arguments:
     #
-    #  api.send('Hello everybody', ['999314159265', '999271828182'])
-    #  api.send('Hello everybody', '999314159265', '999271828182')
+    #  api.send("Hello everybody", ["999314159265", "999271828182"])
+    #  api.send("Hello everybody", "999314159265", "999271828182")
     #
     # If you want to send a message to a single phone number but still
     # want to get a hash response, put the phone number in an array:
     #
-    #  api.send('Hi Barney', ['999271828182'])
+    #  api.send("Hi Barney", ["999271828182"])
     #
     # Postponed sending:
     #
-    #  api.send('Two hours later', '999314159265', :send_time => Time.now.to_i + 7200)
+    #  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?
+      raise Error.new(1, "Message text is empty") if text.nil? || text.blank?
       options = args.last.is_a?(Hash) ? args.pop : {}
       unicode = API.is_unicode(text)
       options[:unicode] = case options[:unicode]
-      when 1, true: 1
-      when 0, false: 0
-      when nil: unicode ? 1 : 0
+      when 1, true then 1
+      when 0, false then 0
+      when nil then unicode ? 1 : 0
       else raise Error.new(10, "Wrong parameter value #{options[:unicode]} for parameter unicode")
       end
-      raise Error.new(6, 'Message contains invalid characters') if unicode && options[:unicode] == 0
-      raise Error.new(7, 'Message too long') unless API.validate_text_length(text, unicode)
+      raise Error.new(6, "Message contains invalid characters") if unicode && options[:unicode] == 0
+      raise Error.new(7, "Message too long") unless API.validate_text_length(text, unicode)
       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)
+      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(',')))
+      hash = Executor.execute("send", @username, @password, options.merge(:text => text, :phone => phones.join(",")))
       TextMagic::API::Response.send(hash, single)
     end
 
@@ -111,37 +111,37 @@ module TextMagic
     #
     # Example usage:
     #
-    #  status = api.message_status('141421')
-    #  # => 'd'
+    #  status = api.message_status("141421")
+    #  # => "d"
     #  status.completed_time
     #  # => Fri May 22 10:10:18 +0200 2009
     #
     # Example with multiple ids:
     #
-    #  statuses = api.message_status('141421', '173205')
-    #  # => { '141421' => 'r', '173205' => 'd' }
-    #  statuses['141421'].text
-    #  # => 'Hi Wilma'
-    #  statuses['173205'].created_time
+    #  statuses = api.message_status("141421", "173205")
+    #  # => { "141421" => "r", "173205" => "d" }
+    #  statuses["141421"].text
+    #  # => "Hi Wilma"
+    #  statuses["173205"].created_time
     #  # => Thu May 28 16:41:45 +0200 2009
     #
     # Multiple ids can be supplied as an array or as a list of arguments:
     #
-    #  api.send('Hello everybody', ['999314159265', '999271828182'])
-    #  api.send('Hello everybody', '999314159265', '999271828182')
+    #  api.send("Hello everybody", ["999314159265", "999271828182"])
+    #  api.send("Hello everybody", "999314159265", "999271828182")
     #
     # If you want to request status for a single message but still want to get
     # a hash response, put the id in an array:
     #
-    #  api.message_status(['141421'])
+    #  api.message_status(["141421"])
     #
     # <b>It is strongly encouraged to setup callbacks to receive updates on message status
     # instead of using this method.</b>
     def message_status(*ids)
       single = ids.size == 1 && ids.first.is_a?(String)
       ids.flatten!
-      raise TextMagic::API::Error.new(4, 'Insufficient parameters') if ids.empty?
-      hash = Executor.execute('message_status', @username, @password, :ids => ids.join(','))
+      raise TextMagic::API::Error.new(4, "Insufficient parameters") if ids.empty?
+      hash = Executor.execute("message_status", @username, @password, :ids => ids.join(","))
       TextMagic::API::Response.message_status(hash, single)
     end
     alias :status :message_status
@@ -162,20 +162,20 @@ module TextMagic
     # Example usage:
     #
     #  replies = api.receive
-    #  # => ['999271828182: Hello Fred', '999314159265: Good day']
+    #  # => ["999271828182: Hello Fred", "999314159265: Good day"]
     #  replies.first.text
-    #  # => 'Hello Fred'
+    #  # => "Hello Fred"
     #  replies.first.from
-    #  # => '999314159265'
+    #  # => "999314159265"
     #  replies.last.message_id
-    #  # => '223606'
-    #  api.receive '223606'
+    #  # => "223606"
+    #  api.receive "223606"
     #  # => []
     #
     # <b>It is strongly encouraged to setup callbacks to receive replies instead of
     # using this method.</b>
     def receive(last_retrieved_id = nil)
-      hash = Executor.execute('receive', @username, @password, :last_retrieved_id => last_retrieved_id)
+      hash = Executor.execute("receive", @username, @password, :last_retrieved_id => last_retrieved_id)
       TextMagic::API::Response.receive(hash)
     end
 
@@ -188,14 +188,14 @@ module TextMagic
     #
     # Example usage:
     #
-    #  api.delete_reply('141421')
-    #  api.delete_reply('173205', '223606')
-    #  api.delete_reply(['244948', '264575'])
+    #  api.delete_reply("141421")
+    #  api.delete_reply("173205", "223606")
+    #  api.delete_reply(["244948", "264575"])
     def delete_reply(*ids)
       single = ids.size == 1 && ids.first.is_a?(String)
       ids.flatten!
-      raise TextMagic::API::Error.new(4, 'Insufficient parameters') if ids.empty?
-      Executor.execute('delete_reply', @username, @password, :ids => ids.join(','))
+      raise TextMagic::API::Error.new(4, "Insufficient parameters") if ids.empty?
+      Executor.execute("delete_reply", @username, @password, :ids => ids.join(","))
       true
     end
     alias :delete :delete_reply
@@ -212,34 +212,34 @@ module TextMagic
     #
     # Example usage:
     #
-    #  check = api.check_number('447624800500')
+    #  check = api.check_number("447624800500")
     #  check.price
     #  # => 0.8
     #  check.country
-    #  # => 'GB'
+    #  # => "GB"
     #
     # Example with multiple phone numbers:
     #
-    #  check = api.check_number('447624800500', '61428102137')
-    #  check['447624800500'].price
+    #  check = api.check_number("447624800500", "61428102137")
+    #  check["447624800500"].price
     #  # => 0.8
-    #  check['61428102137'].country
-    #  # => 'AU'
+    #  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')
+    #  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'])
+    #  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(','))
+      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

data/lib/charset.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 module TextMagic
 
   class API
@@ -21,7 +23,7 @@ module TextMagic
       end
 
       def real_length(text, unicode)
-        text.size + (unicode ? 0 : text.scan(/[\{\}\\\~\[\]\|\€]/).size)
+        text.size + (unicode ? 0 : text.scan(/[\{\}\\~\[\]\|€]/).size)
       end
     end
   end

data/lib/error.rb

@@ -10,10 +10,10 @@ module TextMagic
       # can be supplied as arguments or in a hash.
       #
       #  TextMagic::API::Error.new(code, message)
-      #  TextMagic::API::Error.new('error_code' => code, 'error_message' => message)
+      #  TextMagic::API::Error.new("error_code" => code, "error_message" => message)
       def initialize(*args)
         if args.first.is_a?(Hash)
-          @code, @message = args.first['error_code'], args.first['error_message']
+          @code, @message = args.first["error_code"], args.first["error_message"]
         else
           @code, @message = args
         end

data/lib/executor.rb

@@ -13,21 +13,21 @@ module TextMagic
       # directly.
       #
       # Parameters specified in the +options+ hash will be added to the
-      # HTTP POST request's body together with command, username and
+      # HTTP POST request"s body together with command, username and
       # password.
       #
-      # Returns a hash with values parsed from the server's response if
+      # Returns a hash with values parsed from the server"s response if
       # the command was successfully executed. In case the server replies
       # with error, this method raises a TextMagic::API::Error.
       def self.execute(command, username, password, options = {})
-        raise TextMagic::API::Error.new(3, 'Command is undefined') if command.nil? || command.blank?
+        raise TextMagic::API::Error.new(3, "Command is undefined") if command.nil? || command.blank?
         if username.nil? || username.blank? || password.nil? || password.blank?
-          raise TextMagic::API::Error.new(5, 'Invalid username & password combination')
+          raise TextMagic::API::Error.new(5, "Invalid username & password combination")
         end
         options.merge!(:username => username, :password => password, :cmd => command)
         options.delete_if { |key, value| key.nil? || key.to_s.blank? || value.nil? || value.to_s.blank? }
-        response = self.post('/api', :body => options, :format => :json)
-        raise Error.new(response) if response && response['error_code']
+        response = self.post("/api", :body => options, :format => :json)
+        raise Error.new(response) if response && response["error_code"]
         response
       end
     end

data/lib/response.rb

@@ -1,4 +1,4 @@
-require 'ostruct'
+require "ostruct"
 
 module TextMagic
 
@@ -16,49 +16,49 @@ module TextMagic
       def self.send(hash, single)
         response = nil
         if single
-          response = hash['message_id'].keys.first.dup
+          response = hash["message_id"].keys.first.dup
         else
-          response = hash['message_id'].invert
+          response = hash["message_id"].invert
         end
         metaclass = class << response; self; end
         metaclass.send :attr_accessor, :sent_text, :parts_count, :message_id
-        response.sent_text = hash['sent_text']
-        response.parts_count = hash['parts_count']
-        response.message_id = hash['message_id']
+        response.sent_text = hash["sent_text"]
+        response.parts_count = hash["parts_count"]
+        response.message_id = hash["message_id"]
         response
       end
 
       def self.message_status(hash, single)
         response = {}
         hash.each do |message_id, message_hash|
-          status = message_hash['status'].dup
+          status = message_hash["status"].dup
           metaclass = class << status; self; end
           metaclass.send :attr_accessor, :text, :credits_cost, :reply_number, :message_status, :created_time, :completed_time
-          status.text = message_hash['text']
-          status.credits_cost = message_hash['credits_cost']
-          status.reply_number = message_hash['reply_number']
-          status.message_status = message_hash['message_status']
-          status.created_time = Time.at(message_hash['created_time'].to_i) if message_hash['created_time']
-          status.completed_time = Time.at(message_hash['completed_time'].to_i) if message_hash['completed_time']
+          status.text = message_hash["text"]
+          status.credits_cost = message_hash["credits_cost"]
+          status.reply_number = message_hash["reply_number"]
+          status.message_status = message_hash["message_status"]
+          status.created_time = Time.at(message_hash["created_time"].to_i) if message_hash["created_time"]
+          status.completed_time = Time.at(message_hash["completed_time"].to_i) if message_hash["completed_time"]
           response[message_id] = status
         end
         single ? response.values.first : response
       end
 
       def self.receive(hash)
-        response = hash['messages'].collect do |message_hash|
-          message = "#{message_hash['from']}: #{message_hash['text']}"
+        response = hash["messages"].collect do |message_hash|
+          message = "#{message_hash["from"]}: #{message_hash["text"]}"
           metaclass = class << message; self; end
           metaclass.send :attr_accessor, :timestamp, :message_id, :text, :from
-          message.text = message_hash['text']
-          message.from = message_hash['from']
-          message.message_id = message_hash['message_id']
-          message.timestamp = Time.at(message_hash['timestamp'].to_i)
+          message.text = message_hash["text"]
+          message.from = message_hash["from"]
+          message.message_id = message_hash["message_id"]
+          message.timestamp = Time.at(message_hash["timestamp"].to_i)
           message
         end
         metaclass = class << response; self; end
         metaclass.send :attr_accessor, :unread
-        response.unread = hash['unread']
+        response.unread = hash["unread"]
         response
       end