clickatell 0.4.1 → 0.5.0

data/History.txt

@@ -1,3 +1,9 @@
+== 0.5.0
+* Added support for mobile originated flag (courtesy Dan Weinand)
+* Added support for WAP push (experimental, courtesy Zhao Lu)
+* Updated specs to use Mocha instead of the built-in RSpec mocking
+* Improved specs in general
+
 == 0.4.1
 * Custom alphanumeric sender would not always be supported by default unless it was explicitly enabled using the req_feat parameter.
 

data/Manifest.txt

@@ -2,6 +2,7 @@ History.txt
 License.txt
 Manifest.txt
 README.txt
+README.textile
 Rakefile
 bin/sms
 lib/clickatell.rb

data/README.textile

@@ -0,0 +1,33 @@
+h1. Clickatell SMS Library
+
+To use this gem, you will need sign up for an account at www.clickatell.com. Once you are registered and logged into your account centre, you should add an HTTP API connection to your account. This will give you your API_ID.
+
+h2. Basic Usage
+
+You will need your API_ID as well as your account username and password.
+
+  require 'rubygems'
+  require 'clickatell'
+  
+  api = Clickatell::API.authenticate('your_api_id', 'your_username', 'your_password')
+  api.send_message('447771234567', 'Hello from clickatell')
+
+  
+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. 
+
+You will need to create a YAML configuration file in your home directory, in a file called .clickatell that resembles the following:
+
+  # ~/.clickatell
+  api_key: your_api_id
+  username: your_username
+  password: your_password
+  
+You can then use the sms utility to send a message to a single recipient:
+
+  sms 447771234567 'Hello from clickatell'
+  
+Alternatively, you can specify the username and password as a command line option. Run +sms+ without any arguments for a full list of options.
+
+See http://clickatell.rubyforge.org for further instructions.  

data/README.txt

@@ -1,11 +1,10 @@
-== Basic Usage
+= Clickatell SMS Library
+
+To use this gem, you will need sign up for an account at www.clickatell.com. Once you are registered and logged into your account centre, you should add an HTTP API connection to your account. This will give you your API_ID.
 
-To use this gem, you will need sign up for an account at www.clickatell.com. 
-Once you are registered and logged into your account centre, you should add 
-an HTTP API connection to your account. This will give you your API_ID.
+== Basic Usage
 
-You can now use the library directly. You will need your API_ID as well as your
-account username and password.
+You will need your API_ID as well as your account username and password.
 
   require 'rubygems'
   require 'clickatell'
@@ -16,11 +15,9 @@ account username and password.
   
 == 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:
+You will need to create a YAML configuration file in your home directory, in a file called .clickatell that resembles the following:
 
   # ~/.clickatell
   api_key: your_api_id
@@ -31,11 +28,6 @@ You can then use the sms utility to send a message to a single recipient:
 
   sms 447771234567 'Hello from clickatell'
   
-Run +sms+ without any arguments for a full list of options.
+Alternatively, you can specify the username and password as a command line option. Run +sms+ without any arguments for a full list of options.
 
 See http://clickatell.rubyforge.org for further instructions.  
- 
- 
- 
- 
- 

data/Rakefile

@@ -48,14 +48,12 @@ DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 
 NAME = "clickatell"
 REV = nil 
-# UNCOMMENT IF REQUIRED: 
-# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
 VERS = Clickatell::VERSION::STRING + (REV ? ".#{REV}" : "")
 CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
 RDOC_OPTS = ['--quiet', '--title', 'clickatell documentation',
     "--opname", "index.html",
     "--line-numbers", 
-    "--main", "README",
+    "--main", "README.txt",
     "--inline-source"]
 
 class Hoe
@@ -129,7 +127,7 @@ task :check_version do
 end
 
 Rake::RDocTask.new('docs') do |rd|
-  rd.main = 'README.txt'
+  rd.main = 'README.textile'
   rd.rdoc_files.include('README.txt', 'History.txt', 'License.txt', 'lib/**/*.rb')
   rd.rdoc_dir = 'doc'
   rd.options << '--style=http://clickatell.rubyforge.org/stylesheets/rdoc.css'
@@ -153,8 +151,8 @@ namespace :spec do
   
   desc "Run the specs in HTML format"
   Spec::Rake::SpecTask.new('html') do |t|
-    t.spec_opts = ['--format', "html"]
     t.spec_files = FileList['spec/*_spec.rb']
+    t.spec_opts = ['--format', "html:website/specs.html"]
   end
 end
 

data/lib/clickatell/api.rb

@@ -36,7 +36,7 @@ module Clickatell
     # a session_id if successful which can be used in subsequent
     # API calls.
     def authenticate(api_id, username, password)
-      response = execute_command('auth',
+      response = execute_command('auth', 'http',
         :api_id => api_id,
         :user => username,
         :password => password
@@ -47,7 +47,7 @@ module Clickatell
     # Pings the service with the specified session_id to keep the
     # session alive.
     def ping(session_id)
-      execute_command('ping', :session_id => session_id)
+      execute_command('ping', 'http', :session_id => session_id)
     end
     
     # Sends a message +message_text+ to +recipient+. Recipient
@@ -57,33 +57,44 @@ module Clickatell
     #
     # Additional options:
     #    :from - the from number/name
+    #    :set_mobile_originated - mobile originated flag
     #
     # Returns a new message ID if successful.
     def send_message(recipient, message_text, opts={})
-      valid_options = opts.only(:from)
+      valid_options = opts.only(:from, :mo)
       valid_options.merge!(:req_feat => '48') if valid_options[:from]
-      response = execute_command('sendmsg',
+      valid_options.merge!(:mo => '1') if opts[:set_mobile_originated]
+      response = execute_command('sendmsg', 'http',
         {:to => recipient, :text => message_text}.merge(valid_options)
       ) 
       parse_response(response)['ID']
     end
+
+    def send_wap_push(recipient, media_url, notification_text='', opts={})
+      valid_options = opts.only(:from)
+      valid_options.merge!(:req_feat => '48') if valid_options[:from]
+      response = execute_command('si_push', 'mms',
+        {:to => recipient, :si_url => media_url, :si_text => notification_text, :si_id => 'foo'}.merge(valid_options)
+      )
+      parse_response(response)['ID']
+    end
     
     # Returns the status of a message. Use message ID returned
     # from original send_message call.
     def message_status(message_id)
-      response = execute_command('querymsg', :apimsgid => message_id)
+      response = execute_command('querymsg', 'http', :apimsgid => message_id)
       parse_response(response)['Status']
     end
     
     # Returns the number of credits remaining as a float.
     def account_balance
-      response = execute_command('getbalance')
+      response = execute_command('getbalance', 'http')
       parse_response(response)['Credit'].to_f
     end
 
     protected
-      def execute_command(command_name, parameters={}) #:nodoc:
-        CommandExecutor.new(auth_hash, self.class.secure_mode, self.class.debug_mode).execute(command_name, parameters)
+      def execute_command(command_name, service, parameters={}) #:nodoc:
+        CommandExecutor.new(auth_hash, self.class.secure_mode, self.class.debug_mode).execute(command_name, service, parameters)
       end
 
       def parse_response(raw_response) #:nodoc:

data/lib/clickatell/api/command.rb

@@ -6,8 +6,9 @@ module Clickatell
     class Command
       API_SERVICE_HOST = 'api.clickatell.com'
 
-      def initialize(command_name, opts={})
+      def initialize(command_name, service = 'http', opts={})
         @command_name = command_name
+        @service = service
         @options = { :secure => false }.merge(opts)
       end
   
@@ -21,7 +22,7 @@ module Clickatell
         def api_service_uri
           protocol = @options[:secure] ? 'https' : 'http'
           port = @options[:secure] ? 443 : 80
-          return "#{protocol}://#{API_SERVICE_HOST}:#{port}/http/"
+          return "#{protocol}://#{API_SERVICE_HOST}:#{port}/#{@service}/"
         end
     end
     

data/lib/clickatell/api/command_executor.rb

@@ -15,15 +15,15 @@ module Clickatell
       # Builds a command object and sends it using HTTP GET. 
       # Will output URLs as they are requested to stdout when 
       # debugging is enabled.
-      def execute(command_name, parameters={})
-        request_uri = command(command_name, parameters)
+      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
       end
       
       protected
-        def command(command_name, parameters) #:nodoc:
-          Command.new(command_name, :secure => @secure).with_params(
+        def command(command_name, service, parameters) #:nodoc:
+          Command.new(command_name, service, :secure => @secure).with_params(
             parameters.merge(@authentication_hash)
           )
         end

data/lib/clickatell/version.rb

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

data/spec/api_spec.rb

@@ -1,6 +1,12 @@
 require File.dirname(__FILE__) + '/spec_helper'
 require File.dirname(__FILE__) + '/../lib/clickatell'
 
+class FakeHttp
+  def start(&block)
+    yield self
+  end
+end
+
 module Clickatell
   
   describe "API Command" do
@@ -21,7 +27,7 @@ module Clickatell
   
   describe "Secure API Command" do
     before do
-      @command = API::Command.new('cmdname', :secure => true)
+      @command = API::Command.new('cmdname', 'http', :secure => true)
     end
     
     it "should use HTTPS" do
@@ -31,28 +37,30 @@ module Clickatell
   end
   
   describe "Command executor" do
-    it "should create an API command with auth params and send it via HTTP get, returning the raw http response" do
+    it "should create an API command with the given params" do
+      executor = API::CommandExecutor.new(:session_id => '12345')
+      executor.stubs(:get_response).returns([])
+      API::Command.expects(:new).with('cmdname', 'http', :secure => false).returns(command = stub('Command'))
+      command.expects(:with_params).with(:param_one => 'foo', :session_id => '12345').returns(stub_everything('URI'))
+      executor.execute('cmdname', 'http', :param_one => 'foo')
+    end
+    
+    it "should send the URI generated by the created command via HTTP get and return the response" do
       executor = API::CommandExecutor.new(:session_id => '12345')
-      API::Command.should_receive(:new).with('cmdname', :secure => false).and_return(cmd=mock('command'))
-      uri = stub('uri', :host => 'example.com', :port => 80, :scheme => 'http', :path => '/foo/bar', :query => 'a=b')
-      cmd.should_receive(:with_params).with(:param_one => 'foo', :session_id => '12345').and_return(uri)
-      Net::HTTP.should_receive(:new).with('example.com', 80).and_return(transport=mock('http'))
-      transport.should_receive(:use_ssl=).with(false)
-      transport.should_receive(:start).and_yield(yielded_transport=mock('http'))
-      yielded_transport.should_receive(:get).with('/foo/bar?a=b').and_return(raw_response=mock('http response'))
-      executor.execute('cmdname', :param_one => 'foo').should == raw_response
+      command_uri = URI.parse('http://clickatell.com:8080/path?foo=bar')
+      API::Command.stubs(:new).returns(command = stub('Command', :with_params => command_uri))
+      Net::HTTP.stubs(:new).with(command_uri.host, command_uri.port).returns(http = FakeHttp.new)
+      http.stubs(:use_ssl=)
+      http.stubs(:get).with('/path?foo=bar').returns([response = stub('HTTP Response'), 'response body'])
+      executor.execute('cmdname', 'http').should == response
     end
     
-    it "should create a secure API command and send command using HTTPS if secure is true" do
-      executor = API::CommandExecutor.new({:session_id => '12345'}, secure=true)
-      API::Command.should_receive(:new).with('cmdname', :secure => true).and_return(cmd=mock('command'))
-      uri = stub('uri', :host => 'example.com', :port => 443, :scheme => 'https', :path => '/foo/bar', :query => 'a=b')
-      cmd.should_receive(:with_params).with(:param_one => 'foo', :session_id => '12345').and_return(uri)
-      Net::HTTP.should_receive(:new).with('example.com', 443).and_return(transport=mock('http'))
-      transport.should_receive(:use_ssl=).with(true)
-      transport.should_receive(:start).and_yield(yielded_transport=mock('http'))
-      yielded_transport.should_receive(:get).with('/foo/bar?a=b').and_return(raw_response=mock('http response'))
-      executor.execute('cmdname', :param_one => 'foo').should == raw_response
+    it "should send the command over a secure HTTPS connection if :secure option is set to true" do
+      executor = API::CommandExecutor.new({:session_id => '12345'}, secure = true)
+      Net::HTTP.stubs(:new).returns(http = mock('HTTP'))
+      http.expects(:use_ssl=).with(true)
+      http.stubs(:start).returns([])
+      executor.execute('cmdname', 'http')
     end
   end
   
@@ -60,82 +68,77 @@ module Clickatell
     before do
       API.debug_mode = false
       API.secure_mode = false
-      API::CommandExecutor.should_receive(:new).with({:session_id => '1234'}, false, false).and_return(@executor = mock('command executor'))
+      @executor = mock('command executor')
       @api = API.new(:session_id => '1234')
+      API::CommandExecutor.stubs(:new).with({:session_id => '1234'}, false, false).returns(@executor)
     end
     
-    it "should return session_id for successful authentication" do
-      @executor.should_receive(:execute).with('auth',
+    it "should use the api_id, username and password to authenticate and return the new session id" do
+      @executor.expects(:execute).with('auth', 'http', 
         :api_id => '1234',
         :user => 'joebloggs',
         :password => 'superpass'
-      ).and_return(response=mock('response'))
-      Response.should_receive(:parse).with(response).and_return('OK' => 'new_session_id')        
+      ).returns(response = stub('response'))
+      Response.stubs(:parse).with(response).returns('OK' => 'new_session_id')        
       @api.authenticate('1234', 'joebloggs', 'superpass').should == 'new_session_id'
     end
     
-    it "should support ping" do
-      @executor.should_receive(:execute).with('ping', :session_id => 'abcdefg').and_return(response=mock('response'))
+    it "should support ping, using the current session_id" do
+      @executor.expects(:execute).with('ping', 'http', :session_id => 'abcdefg').returns(response = stub('response'))
       @api.ping('abcdefg').should == response
     end
     
-    it "should support sending messages, returning the message id" do
-      @executor.should_receive(:execute).with('sendmsg',
+    it "should support sending messages to a specified number, returning the message id" do
+      @executor.expects(:execute).with('sendmsg', 'http', 
         :to => '4477791234567',
         :text => 'hello world'
-      ).and_return(response=mock('response'))
-      Response.should_receive(:parse).with(response).and_return('ID' => 'message_id')      
+      ).returns(response = stub('response'))
+      Response.stubs(:parse).with(response).returns('ID' => 'message_id')      
       @api.send_message('4477791234567', 'hello world').should == 'message_id'
     end
     
-    it "should support sending messages with custom sender, passing the appropriate feature mask, returning the message id" do
-      @executor.should_receive(:execute).with('sendmsg',
-        :to => '4477791234567',
-        :text => 'hello world',
-        :from => 'LUKE',
-        :req_feat => '48'
-      ).and_return(response=mock('response'))
-      Response.should_receive(:parse).with(response).and_return('ID' => 'message_id')
+    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')
       @api.send_message('4477791234567', 'hello world', :from => 'LUKE')
     end
     
-    it "should ignore any invalid parameters when sending message" do
-      @executor.should_receive(:execute).with('sendmsg',
-        :to => '4477791234567',
-        :text => 'hello world',
-        :from => 'LUKE',
-        :req_feat => '48'
-      ).and_return(response=mock('response'))
-      Response.stub!(:parse).and_return('ID' => 'foo')
+    it "should set the :mo flag to 1 when :set_mobile_originated is true when sending a message" do
+      @executor.expects(:execute).with('sendmsg', 'http', has_entry(:mo => '1')).returns(response=mock('response'))
+      Response.stubs(:parse).with(response).returns('ID' => 'message_id')
+      @api.send_message('4477791234567', 'hello world', :set_mobile_originated => true)
+    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'))
+      Response.stubs(:parse).returns('ID' => 'foo')
       @api.send_message('4477791234567', 'hello world', :from => 'LUKE', :any_old_param => 'test')
     end
     
-    it "should support message status query, returning message status" do
-      @executor.should_receive(:execute).with('querymsg',
-        :apimsgid => 'messageid'
-      ).and_return(response=mock('response'))
-      Response.should_receive(:parse).with(response).and_return('ID' => 'message_id', 'Status' => 'message_status')
+    it "should support message status query for a given message id, returning the message status" do
+      @executor.expects(:execute).with('querymsg', 'http', :apimsgid => 'messageid').returns(response = stub('response'))
+      Response.expects(:parse).with(response).returns('ID' => 'message_id', 'Status' => 'message_status')
       @api.message_status('messageid').should == 'message_status'
     end
     
     it "should support balance query, returning number of credits as a float" do
-      @executor.should_receive(:execute).with('getbalance', {}).and_return(response=mock('response'))
-      Response.should_receive(:parse).with(response).and_return('Credit' => '10.0')
+      @executor.expects(:execute).with('getbalance', 'http', {}).returns(response=mock('response'))
+      Response.stubs(:parse).with(response).returns('Credit' => '10.0')
       @api.account_balance.should == 10.0
     end
     
     it "should raise an API::Error if the response parser raises" do
-      @executor.stub!(:execute)
-      Response.stub!(:parse).and_raise(Clickatell::API::Error.new('', ''))
+      @executor.stubs(:execute)
+      Response.stubs(:parse).raises(Clickatell::API::Error.new('', ''))
       proc { @api.account_balance }.should raise_error(Clickatell::API::Error)
     end
   end
   
   describe API, ' when authenticating' do
     it "should authenticate to retrieve a session_id and return a new API instance using that session id" do
-      API.stub!(:new).and_return(api=mock('api'))
-      api.should_receive(:authenticate).with('my_api_key', 'joebloggs', 'mypassword').and_return('new_session_id')
-      api.should_receive(:auth_options=).with(:session_id => 'new_session_id')
+      API.stubs(:new).returns(api = mock('api'))
+      api.stubs(:authenticate).with('my_api_key', 'joebloggs', 'mypassword').returns('new_session_id')
+      api.expects(:auth_options=).with(:session_id => 'new_session_id')
       API.authenticate('my_api_key', 'joebloggs', 'mypassword')
     end
   end
@@ -145,8 +148,8 @@ module Clickatell
       API.debug_mode = false
       API.secure_mode = false
       api = API.new
-      API::CommandExecutor.should_receive(:new).with({}, false, false).and_return(executor=mock('command executor'))
-      executor.stub!(:execute)
+      API::CommandExecutor.stubs(:new).with({}, false, false).returns(executor = stub('command executor'))
+      executor.stubs(:execute)
       api.ping('1234')
     end
   end
@@ -156,8 +159,8 @@ module Clickatell
       API.debug_mode = false
       API.secure_mode = true
       api = API.new
-      API::CommandExecutor.should_receive(:new).with({}, true, false).and_return(executor=mock('command executor'))
-      executor.stub!(:execute)
+      API::CommandExecutor.expects(:new).with({}, true, false).returns(executor = stub('command executor'))
+      executor.stubs(:execute)
       api.ping('1234')
     end
   end

data/spec/response_spec.rb

@@ -5,18 +5,15 @@ module Clickatell
 
   describe "Response parser" do
     before do
-      @raw_response = stub('response')
-      Clickatell::API::Error.stub!(:parse).and_return(Clickatell::API::Error.new('', ''))
+      Clickatell::API::Error.stubs(:parse).returns(Clickatell::API::Error.new('', ''))
     end
     
     it "should return hash for one-line success response" do
-      @raw_response.stub!(:body).and_return('k1: foo k2: bar')
-      Response.parse(@raw_response).should == {'k1' => 'foo', 'k2' => 'bar'}
+      Response.parse(stub('response', :body => 'k1: foo k2: bar')).should == {'k1' => 'foo', 'k2' => 'bar'}
     end
     
     it "should raise API::Error if response contains an error message" do
-      @raw_response.stub!(:body).and_return('ERR: 001, Authentication failed')
-      proc { Response.parse(@raw_response) }.should raise_error(Clickatell::API::Error)
+      proc { Response.parse(stub('response', :body => 'ERR: 001, Authentication failed')) }.should raise_error(Clickatell::API::Error)
     end
   end
   

data/spec/spec_helper.rb

@@ -1,2 +1,7 @@
 require 'rubygems'
 require 'spec'
+require 'mocha'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

data/website/index.html

@@ -16,7 +16,7 @@
   
   <div id="header">
     
-    <h1>Clickatell Ruby API <span class="version">0.4.1</span>
+    <h1>Clickatell Ruby API <span class="version">0.5.0</span>
     <span class="tagline">gem install clickatell</span></h1>
     
   </div>
@@ -37,7 +37,15 @@
 
 <pre><code>$ sudo gem install clickatell</code></pre>
 
-	<p>Getting the latest version from Subversion:</p>
+	<h4>Clickatell on GitHub</h4>
+
+
+	<p>The source repository for clickatell has been <a href="http://github.com/lukeredpath/clickatell/">moved to GitHub</a>.</p>
+
+
+<pre><code>git clone git://github.com/lukeredpath/clickatell.git</code></pre>
+
+	<p>You can still access the old subversion repository although this is unlikely to be updated:</p>
 
 
 <pre><code>$ svn co svn://lukeredpath.co.uk/var/svn/opensource/clickatell/trunk clickatell-trunk</code></pre>
@@ -113,7 +121,7 @@ $ sms -u your_username -p your_password -k your_api_key 447771234567 'Hello from
 	<p>These values will take presedence over any values in your ~/.clickatell file.</p>
 
 
-	<p>You can also specify the name or number that will appear in the &#8220;From&#8221; label on the recipients phone. You can either add a &#8220;from&#8221; key to your .clickatell file or manually using the&#8212;from option:</p>
+	<p>You can also specify a custom Sender ID &#8211; the name or number that will appear in the &#8220;From&#8221; label on the recipients phone. You can either add a &#8220;from&#8221; key to your .clickatell file or manually using the&#8212;from option:</p>
 
 
 <pre><code>
@@ -123,6 +131,12 @@ $ sms --from 'Luke Redpath' 447771234567 'Hello from clickatell'
 	<p>The &#8220;from&#8221; option can either be a 16 digit number or an 11 character alpha-numeric string.</p>
 
 
+	<p><strong>Important note about custom sender IDs:</strong> Since November 2007, Clickatell have implemented a policy whereby all Sender IDs must be registered in your account centre before they can be used (the mobile number that you signed up with will have automatically been registered). If you try to specify a custom sender ID that has not been registered, the <span class="caps">SMS</span> will not be delivered.</p>
+
+
+	<p>In addition, if you do not specify a sender ID, a default Clickatell number will be used instead. If you are using the sms utility to send messages from your own number, make sure you have added the &#8216;from&#8217; field to your .clickatell file otherwise you will need to specify it every time you send a message.</p>
+
+
 	<p>You can also use the <ins>sms</ins> utility to check your Clickatell account balance:</p>
 
 
@@ -161,7 +175,7 @@ $ sms --status 30b7d15bffb38695ba26e77c9c20f4ec
   	<div id="footer">
   	  <p class="copyright">
         <a href="http://rubyforge.org/projects/clickatell">Rubyforge Project Page</a> | 
-        <a href="http://rubyforge.org/frs/?group_id=4295&amp;release_id=13922">Download latest version (0.4.1)</a> | 
+        <a href="http://rubyforge.org/frs/?group_id=4295&amp;release_id=13922">Download latest version (0.5.0)</a> | 
         <a href="rdoc/">RDoc</a>
       </p>
   	</div>

data/website/index.txt

@@ -12,7 +12,13 @@ h3. Installing
 
 <pre><code>$ sudo gem install clickatell</code></pre>
 
-Getting the latest version from Subversion:
+h4. Clickatell on GitHub
+
+The source repository for clickatell has been <a href="http://github.com/lukeredpath/clickatell/">moved to GitHub</a>.
+
+<pre><code>git clone git://github.com/lukeredpath/clickatell.git</code></pre>
+
+You can still access the old subversion repository although this is unlikely to be updated:
 
 <pre><code>$ svn co svn://lukeredpath.co.uk/var/svn/opensource/clickatell/trunk clickatell-trunk</code></pre>
 
@@ -74,7 +80,7 @@ $ sms -u your_username -p your_password -k your_api_key 447771234567 'Hello from
 
 These values will take presedence over any values in your ~/.clickatell file.
 
-You can also specify the name or number that will appear in the "From" label on the recipients phone. You can either add a "from" key to your .clickatell file or manually using the --from option:
+You can also specify a custom Sender ID - the name or number that will appear in the "From" label on the recipients phone. You can either add a "from" key to your .clickatell file or manually using the --from option:
 
 <pre><code>
 $ sms --from 'Luke Redpath' 447771234567 'Hello from clickatell'
@@ -82,6 +88,10 @@ $ sms --from 'Luke Redpath' 447771234567 'Hello from clickatell'
 
 The "from" option can either be a 16 digit number or an 11 character alpha-numeric string.
 
+<strong>Important note about custom sender IDs:</strong> Since November 2007, Clickatell have implemented a policy whereby all Sender IDs must be registered in your account centre before they can be used (the mobile number that you signed up with will have automatically been registered). If you try to specify a custom sender ID that has not been registered, the SMS will not be delivered. 
+
+In addition, if you do not specify a sender ID, a default Clickatell number will be used instead. If you are using the sms utility to send messages from your own number, make sure you have added the 'from' field to your .clickatell file otherwise you will need to specify it every time you send a message.
+
 You can also use the +sms+ utility to check your Clickatell account balance:
 
 <pre><code>

data/website/specs.html

@@ -1,12 +1,11 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html 
+  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
   <title>RSpec results</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <meta http-equiv="Expires" content="-1" />
   <meta http-equiv="Pragma" content="no-cache" />
   <style type="text/css">
@@ -74,7 +73,7 @@ function makeYellow(element_id) {
   font-size: 1.2em;
 }
 
-.behaviour {
+.example_group {
   margin: 0 10px 5px;
   background: #fff;
 }
@@ -177,100 +176,104 @@ a {
 </div>
 
 <div class="results">
-<div class="behaviour">
+<div class="example_group">
   <dl>
-  <dt id="behaviour_1">API Command</dt>
-    <script type="text/javascript">moveProgressBar('4.7');</script>
+  <dt id="example_group_1">API Command</dt>
+    <script type="text/javascript">moveProgressBar('4.3');</script>
     <dd class="spec passed"><span class="passed_spec_name">should return encoded URL for the specified command and parameters</span></dd>
-    <script type="text/javascript">moveProgressBar('9.5');</script>
+    <script type="text/javascript">moveProgressBar('8.6');</script>
     <dd class="spec passed"><span class="passed_spec_name">should URL encode any special characters in parameters</span></dd>
   </dl>
 </div>
-<div class="behaviour">
+<div class="example_group">
   <dl>
-  <dt id="behaviour_2">Secure API Command</dt>
-    <script type="text/javascript">moveProgressBar('14.2');</script>
+  <dt id="example_group_2">Secure API Command</dt>
+    <script type="text/javascript">moveProgressBar('13.0');</script>
     <dd class="spec passed"><span class="passed_spec_name">should use HTTPS</span></dd>
   </dl>
 </div>
-<div class="behaviour">
+<div class="example_group">
   <dl>
-  <dt id="behaviour_3">Command executor</dt>
-    <script type="text/javascript">moveProgressBar('19.0');</script>
-    <dd class="spec passed"><span class="passed_spec_name">should create an API command with auth params and send it via HTTP get, returning the raw http response</span></dd>
-    <script type="text/javascript">moveProgressBar('23.8');</script>
-    <dd class="spec passed"><span class="passed_spec_name">should create a secure API command and send command using HTTPS if secure is true</span></dd>
+  <dt id="example_group_3">Command executor</dt>
+    <script type="text/javascript">moveProgressBar('17.3');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should create an API command with the given params</span></dd>
+    <script type="text/javascript">moveProgressBar('21.7');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should send the URI generated by the created command via HTTP get and return the response</span></dd>
+    <script type="text/javascript">moveProgressBar('26.0');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should send the command over a secure HTTPS connection if :secure option is set to true</span></dd>
   </dl>
 </div>
-<div class="behaviour">
+<div class="example_group">
   <dl>
-  <dt id="behaviour_4">API</dt>
-    <script type="text/javascript">moveProgressBar('28.5');</script>
-    <dd class="spec passed"><span class="passed_spec_name">should return session_id for successful authentication</span></dd>
-    <script type="text/javascript">moveProgressBar('33.3');</script>
-    <dd class="spec passed"><span class="passed_spec_name">should support ping</span></dd>
-    <script type="text/javascript">moveProgressBar('38.0');</script>
-    <dd class="spec passed"><span class="passed_spec_name">should support sending messages, returning the message id</span></dd>
-    <script type="text/javascript">moveProgressBar('42.8');</script>
-    <dd class="spec passed"><span class="passed_spec_name">should support sending messages with custom sender, passing the appropriate feature mask, returning the message id</span></dd>
-    <script type="text/javascript">moveProgressBar('47.6');</script>
-    <dd class="spec passed"><span class="passed_spec_name">should ignore any invalid parameters when sending message</span></dd>
-    <script type="text/javascript">moveProgressBar('52.3');</script>
-    <dd class="spec passed"><span class="passed_spec_name">should support message status query, returning message status</span></dd>
-    <script type="text/javascript">moveProgressBar('57.1');</script>
+  <dt id="example_group_4">API</dt>
+    <script type="text/javascript">moveProgressBar('30.4');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should use the api_id, username and password to authenticate and return the new session id</span></dd>
+    <script type="text/javascript">moveProgressBar('34.7');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should support ping, using the current session_id</span></dd>
+    <script type="text/javascript">moveProgressBar('39.1');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should support sending messages to a specified number, returning the message id</span></dd>
+    <script type="text/javascript">moveProgressBar('43.4');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should set the :from parameter and set the :req_feat to 48 when using a custom from string when sending a message</span></dd>
+    <script type="text/javascript">moveProgressBar('47.8');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should set the :mo flag to 1 when :set_mobile_originated is true when sending a message</span></dd>
+    <script type="text/javascript">moveProgressBar('52.1');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should ignore any invalid parameters when sending a message</span></dd>
+    <script type="text/javascript">moveProgressBar('56.5');</script>
+    <dd class="spec passed"><span class="passed_spec_name">should support message status query for a given message id, returning the message status</span></dd>
+    <script type="text/javascript">moveProgressBar('60.8');</script>
     <dd class="spec passed"><span class="passed_spec_name">should support balance query, returning number of credits as a float</span></dd>
-    <script type="text/javascript">moveProgressBar('61.9');</script>
+    <script type="text/javascript">moveProgressBar('65.2');</script>
     <dd class="spec passed"><span class="passed_spec_name">should raise an API::Error if the response parser raises</span></dd>
   </dl>
 </div>
-<div class="behaviour">
+<div class="example_group">
   <dl>
-  <dt id="behaviour_5">Clickatell::API when authenticating</dt>
-    <script type="text/javascript">moveProgressBar('66.6');</script>
+  <dt id="example_group_5">Clickatell::API when authenticating</dt>
+    <script type="text/javascript">moveProgressBar('69.5');</script>
     <dd class="spec passed"><span class="passed_spec_name">should authenticate to retrieve a session_id and return a new API instance using that session id</span></dd>
   </dl>
 </div>
-<div class="behaviour">
+<div class="example_group">
   <dl>
-  <dt id="behaviour_6">Clickatell::API with no authentication options set</dt>
-    <script type="text/javascript">moveProgressBar('71.4');</script>
+  <dt id="example_group_6">Clickatell::API with no authentication options set</dt>
+    <script type="text/javascript">moveProgressBar('73.9');</script>
     <dd class="spec passed"><span class="passed_spec_name">should build commands with no authentication options</span></dd>
   </dl>
 </div>
-<div class="behaviour">
+<div class="example_group">
   <dl>
-  <dt id="behaviour_7">Clickatell::API in secure mode</dt>
-    <script type="text/javascript">moveProgressBar('76.1');</script>
+  <dt id="example_group_7">Clickatell::API in secure mode</dt>
+    <script type="text/javascript">moveProgressBar('78.2');</script>
     <dd class="spec passed"><span class="passed_spec_name">should execute commands securely</span></dd>
   </dl>
 </div>
-<div class="behaviour">
+<div class="example_group">
   <dl>
-  <dt id="behaviour_8">API Error</dt>
-    <script type="text/javascript">moveProgressBar('80.9');</script>
+  <dt id="example_group_8">API Error</dt>
+    <script type="text/javascript">moveProgressBar('82.6');</script>
     <dd class="spec passed"><span class="passed_spec_name">should parse http response string to create error</span></dd>
   </dl>
 </div>
-<div class="behaviour">
+<div class="example_group">
   <dl>
-  <dt id="behaviour_9">Hash</dt>
-    <script type="text/javascript">moveProgressBar('85.7');</script>
+  <dt id="example_group_9">Hash</dt>
+    <script type="text/javascript">moveProgressBar('86.9');</script>
     <dd class="spec passed"><span class="passed_spec_name">should return only the keys specified</span></dd>
-    <script type="text/javascript">moveProgressBar('90.4');</script>
+    <script type="text/javascript">moveProgressBar('91.3');</script>
     <dd class="spec passed"><span class="passed_spec_name">should return only the keys specified, ignoring keys that do not exist</span></dd>
   </dl>
 </div>
-<div class="behaviour">
+<div class="example_group">
   <dl>
-  <dt id="behaviour_10">Response parser</dt>
-    <script type="text/javascript">moveProgressBar('95.2');</script>
+  <dt id="example_group_10">Response parser</dt>
+    <script type="text/javascript">moveProgressBar('95.6');</script>
     <dd class="spec passed"><span class="passed_spec_name">should return hash for one-line success response</span></dd>
     <script type="text/javascript">moveProgressBar('100.0');</script>
     <dd class="spec passed"><span class="passed_spec_name">should raise API::Error if response contains an error message</span></dd>
   </dl>
 </div>
-<script type="text/javascript">document.getElementById('duration').innerHTML = "Finished in <strong>0.02819 seconds</strong>";</script>
-<script type="text/javascript">document.getElementById('totals').innerHTML = "21 examples, 0 failures";</script>
+<script type="text/javascript">document.getElementById('duration').innerHTML = "Finished in <strong>0.105423 seconds</strong>";</script>
+<script type="text/javascript">document.getElementById('totals').innerHTML = "23 examples, 0 failures";</script>
 </div>
 </div>
 </body>

metadata

@@ -1,38 +1,45 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
-specification_version: 1
 name: clickatell
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
-date: 2007-11-26 00:00:00 +00:00
-summary: Ruby interface to the Clickatell SMS gateway service.
-require_paths: 
-- lib
-email: contact[AT]lukeredpath.co.uk
-homepage: http://clickatell.rubyforge.org
-rubyforge_project: clickatell
-description: Ruby interface to the Clickatell SMS gateway service.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.5.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Luke Redpath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-08-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: Ruby interface to the Clickatell SMS gateway service.
+email: contact[AT]lukeredpath.co.uk
+executables: 
+- sms
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- License.txt
+- Manifest.txt
+- README.txt
+- website/index.txt
 files: 
 - History.txt
 - License.txt
 - Manifest.txt
 - README.txt
+- README.textile
 - Rakefile
 - bin/sms
 - lib/clickatell.rb
@@ -64,22 +71,32 @@ files:
 - website/stylesheets/rdoc.css
 - website/stylesheets/screen.css
 - website/template.rhtml
-test_files: []
-
+has_rdoc: true
+homepage: http://clickatell.rubyforge.org
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
-extra_rdoc_files: 
-- History.txt
-- License.txt
-- Manifest.txt
-- README.txt
-- website/index.txt
-executables: 
-- sms
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: clickatell
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby interface to the Clickatell SMS gateway service.
+test_files: []