bobes-textmagic 0.3.1 → 0.3.2

data/History.txt

@@ -1,3 +1,10 @@
+== unreleased features
+
+* Fixed message length validation to count escaped characters twice for non-unicode messages.
+* Aliased message_status as status and delete_reply as delete.
+* Account command returns balance as Fixnum if possible.
+* Added a command line utility.
+
 == 0.3.1 2009-05-30
 
 * Sending POST requests instead of GET.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Vladimir Bobes Tuzinsky
+Copyright (c) 2009 Vladimír Bobeš Tužinský
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -94,8 +94,9 @@ you'll get a hash with message ids as keys:
 
 See TextMagic::API.message_status for more information on +message_status+ method.
 
-<b>It is strongly encouraged to setup callbacks to receive updates on message status
-instead of using this method.</b>
+<b>It is strongly recommended to setup callbacks to receive updates on message status
+instead of using this method. Learn more about callbacks at
+{TextMagic API}[http://api.textmagic.com/https-api] site</b>
 
 === Receiving replies
 
@@ -108,7 +109,7 @@ To receive all available replies, run:
   replies.last.from
   # => '999314159265'
   replies.last.message_id
-  # => '223606'
+  # => '178082'
 
 To prevent receiving old replies again, supply +last_retrieved_id+ argument:
 
@@ -117,8 +118,9 @@ To prevent receiving old replies again, supply +last_retrieved_id+ argument:
 
 See TextMagic::API.receive for more information on +message_status+ method.
 
-<b>It is strongly encouraged to setup callbacks to receive replies instead of
-using this method.</b>
+<b>It is strongly recommended to setup callbacks to receive replies instead of
+using this method. Learn more about callbacks at
+{TextMagic API}[http://api.textmagic.com/https-api] site</b>
 
 === Deleting retrieved replies
 
@@ -130,6 +132,18 @@ After you retrieve replies, you can delete them from server by running:
 See TextMagic::API.delete_reply for more information on +message_status+ method.
 
 
+== Command-line utility
+
+The +textmagic+ gem also features a handy command-line utility. It gives you access
+to all of the gem's features. Run
+
+  tm
+
+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>
+
 == Copyright
 
 Copyright (c) 2009 Vladimír Bobeš Tužinský. See LICENSE for details.

data/Rakefile

@@ -7,9 +7,15 @@ begin
   Jeweler::Tasks.new do |gem|
     gem.name = "textmagic"
     gem.summary = %Q{Ruby interface to the TextMagic's Bulk SMS Gateway}
+    gem.description = %Q{
+      textmagic is a Ruby interface to the TextMagic's Bulk SMS Gateway.
+      It can be used to easily integrate SMS features into your application.
+      It supports sending messages, receiving replies and more.
+      You need to have a valid TextMagic account to use this gem. You can get one at http://www.textmagic.com.
+    }
     gem.email = "vladimir.tuzinsky@gmail.com"
     gem.homepage = "http://github.com/bobes/textmagic"
-    gem.authors = ["Vladimir Bobes Tuzinsky"]
+    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"
@@ -57,6 +63,8 @@ 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: 1
+:patch: 2

data/bin/tm

@@ -0,0 +1,111 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+lib = File.join(File.dirname(__FILE__), '..', 'lib', 'textmagic')
+
+if File.exist?("#{lib}.rb")
+  require lib
+else
+  require 'rubygems'
+  require 'textmagic'
+end
+
+filename = File.join(ENV['HOME'], '.textmagic')
+options = YAML.load_file(filename) if File.exist?(filename)
+options ||= {}
+
+parser = OptionParser.new do |opts|
+  opts.banner = 'Usage:'
+  opts.separator " "
+  opts.separator [
+    "tm account",
+    'tm send PHONE[,PHONE2[,PHONE3 ...]] MESSAGE',
+    'tm status MESSAGE_ID',
+    'tm receive [LAST_RETREIVED_ID]',
+    'tm delete MESSAGE_ID [MESSAGE_ID2 [MESSAGE_ID3 ...]]'
+  ]
+
+  opts.separator " "
+  opts.separator "Specific options:"
+
+  opts.on('-u', '--username USERNAME',
+    "Specify your TextMagic API username (overrides ~/.textmagic setting)") do |username|
+    options['username'] = username
+  end
+
+  opts.on('-p', '--password PASSWORD',
+    "Specify your TextMagic API password (overrides ~/.textmagic setting)") do |password|
+    options['password'] = password
+  end
+
+  opts.on_tail('-h', '--help', "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+parser.parse!
+
+if ARGV.empty?
+  puts parser
+  exit
+end
+
+command = ARGV.shift
+
+unless options['username']
+  puts "Username not specified. Use --help option to find out details"
+  exit 1
+end
+
+unless options['password']
+  puts "Password not specified. Use --help option to find out details"
+  exit 1
+end
+
+api = TextMagic::API.new(options['username'], options['password'])
+
+begin
+  case command
+  when 'account':
+    puts "Your account's balance: #{api.account.balance} credits"
+  when 'send':
+    unless phones = ARGV.shift
+      puts "Phone number(s) and message not specified. Use --help option to find out details"
+      exit 1
+    end
+    if (text = ARGV.join(' ')).empty?
+      puts "Message not specified. Use --help option to find out details"
+      exit 1
+    end
+    response = api.send(text, phones.split(','))
+    puts "Sent text: #{response.sent_text}"
+    puts "Parts: #{response.parts_count}"
+    response.each do |phone, message_id|
+      puts "Message id (#{phone}): #{message_id}"
+    end
+  when   'status':
+    if ARGV.empty?
+      puts "Message id(s) not specified. Use --help option to find out details"
+      exit 1
+    end
+    api.status(ARGV).each do |message_id, status|
+      puts "Status (#{message_id}): #{status}"
+    end
+  when   'receive':
+    response = api.receive(ARGV.first)
+    response.each do |message|
+      puts "#{message} [#{message.message_id}, #{message.timestamp}]"
+    end
+    puts 'No new messages' if response.empty?
+  when   'delete':
+    api.delete(ARGV)
+    puts 'Message(s) deleted'
+  else
+    puts "Unknown command #{command}. Use --help option to find out details"
+    exit 1
+  end
+rescue TextMagic::API::Error => e
+  puts e
+  exit 1
+end

data/lib/api.rb

@@ -135,6 +135,7 @@ module TextMagic
       hash = Executor.execute('message_status', @username, @password, :ids => ids.join(','))
       TextMagic::API::Response.message_status(hash, single)
     end
+    alias :status :message_status
 
     # Executes a receive command by sending a request to the TextMagic's
     # SMS gateway.
@@ -188,5 +189,6 @@ module TextMagic
       Executor.execute('delete_reply', @username, @password, :ids => ids.join(','))
       true
     end
+    alias :delete :delete_reply
   end
 end

data/lib/charset.rb

@@ -5,6 +5,7 @@ module TextMagic
     module Charset
 
       GSM_CHARSET = "@£$¥èéùìòÇ\nØø\rÅåΔ_ΦΓΛΩΠΨΣΘΞ\e\f^{}\\[~]|€ÆæßÉ !\"#¤%&'()*+,-./0123456789:;<=>?¡ABCDEFGHIJKLMNOPQRSTUVWXYZÄÖÑܧ¿abcdefghijklmnopqrstuvwxyzäöñüà".scan(/./u)
+      ESCAPED_CHARS = "{}\\~[]|€"
 
       # Returns +true+ if the supplied text contains only characters from
       # GSM 03.38 charset, otherwise it returns +false+.
@@ -18,6 +19,10 @@ module TextMagic
       def is_unicode(text)
         !is_gsm(text)
       end
+
+      def real_length(text, unicode)
+        text.size + (unicode ? 0 : text.scan(/[\{\}\\\~\[\]\|\€]/).size)
+      end
     end
   end
 end

data/lib/response.rb

@@ -9,6 +9,7 @@ module TextMagic
       def self.account(hash)
         response = OpenStruct.new(hash)
         response.balance = response.balance.to_f
+        response.balance = response.balance.to_i if response.balance % 1 == 0
         response
       end
 

data/lib/textmagic.rb

@@ -1,12 +1,9 @@
 require 'rubygems'
 gem 'httparty'
 require 'httparty'
-require 'charset'
-require 'validation'
-require 'api'
-require 'response'
-require 'executor'
-require 'error'
+%w[charset validation api response executor error].each do |lib|
+  require File.join(File.dirname(__FILE__), lib)
+end
 
 module TextMagic #:nodoc:
 end

data/lib/validation.rb

@@ -17,7 +17,7 @@ module TextMagic
       # 70, 134 and 201 respectively.</em>
       def validate_text_length(text, unicode, parts = 3)
         max_text_length = (unicode ? MAX_LENGTH_UNICODE : MAX_LENGTH_GSM)[parts - 1]
-        text.size <= max_text_length
+        real_length(text, unicode) <= max_text_length
       end
 
       # Validates a list of phone numbers. Returns +true+ if the list is not empty

data/test/test_charset.rb

@@ -25,4 +25,21 @@ class CharsetTest < Test::Unit::TestCase
       TextMagic::API.is_gsm('Thai: สวัสดี').should == false
     end
   end
+
+  context 'real_length method' do
+
+    should 'count escaped characters as two and all others as one for non-unicode text' do
+      escaped = "{}\\~[]|€"
+      unescaped = random_string
+      text = "#{escaped}#{unescaped}".scan(/./).sort_by { rand }.join
+      TextMagic::API.real_length(text, false).should == unescaped.size + escaped.size * 2
+    end
+
+    should 'count all characters as one for unicode text' do
+      escaped = "{}\\~[]|€"
+      unescaped = random_string
+      text = "#{escaped}#{unescaped}".scan(/./).sort_by { rand }.join
+      TextMagic::API.real_length(text, true).should == unescaped.size + escaped.size
+    end
+  end
 end

data/test/test_helper.rb

@@ -13,7 +13,7 @@ require 'textmagic'
 class Test::Unit::TestCase
 end
 
-def random_string(legth = 5)
+def random_string(legth = 5 + rand(10))
   Array.new(legth) { rand(36).to_s(36) }.join
 end
 

data/test/test_validation.rb

@@ -5,6 +5,12 @@ class ValidationTest < Test::Unit::TestCase
 
   context 'validate_text_length method for non-unicode texts' do
 
+    should 'use real_length method to determine the real length of the message' do
+      text = random_string
+      TextMagic::API.expects(:real_length).with(text, false).returns(0)
+      TextMagic::API.validate_text_length(text, false, 1)
+    end
+
     should 'return true if parts limit is set to 1 and text length is less than or equal to 160' do
       TextMagic::API.validate_text_length(random_string(160), false, 1).should == true
     end
@@ -34,6 +40,12 @@ class ValidationTest < Test::Unit::TestCase
 
   context 'validate_text_length method for unicode texts' do
 
+    should 'use real_length method to determine the real length of the message' do
+      text = random_string
+      TextMagic::API.expects(:real_length).with(text, true).returns(0)
+      TextMagic::API.validate_text_length(text, true, 1)
+    end
+
     should 'return true if parts limit is set to 1 and text length is less than or equal to 70' do
       TextMagic::API.validate_text_length(random_string(70), true, 1).should == true
     end

data/textmagic.gemspec

@@ -2,12 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{textmagic}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Vladimir Bobes Tuzinsky"]
-  s.date = %q{2009-05-30}
+  s.authors = ["Vladim\303\255r Bobe\305\241 Tu\305\276insk\303\275"]
+  s.date = %q{2009-06-07}
+  s.default_executable = %q{tm}
+  s.description = %q{
+      textmagic is a Ruby interface to the TextMagic's Bulk SMS Gateway.
+      It can be used to easily integrate SMS features into your application.
+      It supports sending messages, receiving replies and more.
+      You need to have a valid TextMagic account to use this gem. You can get one at http://www.textmagic.com.
+    }
   s.email = %q{vladimir.tuzinsky@gmail.com}
+  s.executables = ["tm"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -20,6 +28,7 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION.yml",
+     "bin/tm",
      "lib/api.rb",
      "lib/charset.rb",
      "lib/error.rb",

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: bobes-textmagic
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
-- Vladimir Bobes Tuzinsky
+- "Vladim\xC3\xADr Bobe\xC5\xA1 Tu\xC5\xBEinsk\xC3\xBD"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-05-30 00:00:00 -07:00
-default_executable: 
+date: 2009-06-07 00:00:00 -07:00
+default_executable: tm
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httparty
@@ -52,10 +52,10 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.1.0
     version: 
-description: 
+description: textmagic is a Ruby interface to the TextMagic's Bulk SMS Gateway. It can be used to easily integrate SMS features into your application. It supports sending messages, receiving replies and more. You need to have a valid TextMagic account to use this gem. You can get one at http://www.textmagic.com.
 email: vladimir.tuzinsky@gmail.com
-executables: []
-
+executables: 
+- tm
 extensions: []
 
 extra_rdoc_files: 
@@ -69,6 +69,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION.yml
+- bin/tm
 - lib/api.rb
 - lib/charset.rb
 - lib/error.rb