clickatell 0.1.0

data/spec/api_spec.rb

@@ -0,0 +1,98 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/clickatell'
+
+module Clickatell
+  
+  describe "API Command" do
+    it "should return encoded URL for the specified command and parameters" do
+      command = API::Command.new('cmdname')
+      url = command.with_params(:param_one => 'abc', :param_two => '123')
+      url.should == URI.parse("http://api.clickatell.com/http/cmdname?param_one=abc&param_two=123")
+    end
+    
+    it "should URL encode any special characters in parameters" do
+      command = API::Command.new('cmdname')
+      url = command.with_params(:param_one => 'abc', :param_two => 'hello world')
+      url.should == URI.parse("http://api.clickatell.com/http/cmdname?param_one=abc&param_two=hello%20world")
+    end
+    
+    it "should support non-secure api commands" do
+      command = API::Command.new('cmdname', :secure => true)
+      url = command.with_params(:param_one => 'abc', :param_two => '123')
+      url.should == URI.parse("https://api.clickatell.com/http/cmdname?param_one=abc&param_two=123")
+    end
+  end
+  
+  describe "Command executor" do
+    it "should create an API command and send it via HTTP get" do
+      API::Command.should_receive(:new).with('cmdname').and_return(cmd=mock('command'))
+      cmd.should_receive(:with_params).with(:param_one => 'foo').and_return(uri=mock('uri'))
+      Net::HTTP.should_receive(:get_response).with(uri).and_return(raw_response=mock('http response'))
+      API.send(:execute_command, 'cmdname', :param_one => 'foo').should == raw_response
+    end
+  end
+  
+  describe "API" do
+    it "should return session_id for successful authentication" do
+      API.should_receive(:execute_command).with('auth',
+        :api_id => '1234',
+        :user => 'joebloggs',
+        :password => 'superpass'
+      ).and_return(response=mock('response'))
+      Response.should_receive(:parse).with(response).and_return('OK' => 'new_session_id')        
+      API.authenticate('1234', 'joebloggs', 'superpass').should == 'new_session_id'
+    end
+    
+    it "should support ping" do
+      API.should_receive(:execute_command).with('ping', :session_id => 'abcdefg').and_return(response=mock('response'))
+      API.ping('abcdefg').should == response
+    end
+    
+    it "should support sending messages with authentication, returning the message id" do
+      API.should_receive(:execute_command).with('sendmsg',
+        :api_id => '1234',
+        :user => 'joebloggs',
+        :password => 'superpass',
+        :to => '4477791234567',
+        :text => 'hello world'
+      ).and_return(response=mock('response'))
+      Response.should_receive(:parse).with(response).and_return('ID' => 'message_id')      
+      API.send_message('4477791234567', 'hello world',
+        :username => 'joebloggs', :password => 'superpass', :api_key => '1234'
+      ).should == 'message_id'
+    end
+    
+    it "should support sending messages with pre-auth, returning the message id" do
+      API.should_receive(:execute_command).with('sendmsg',
+        :session_id => 'abcde',
+        :to => '4477791234567',
+        :text => 'hello world'
+      ).and_return(response=mock('response'))
+      Response.should_receive(:parse).with(response).and_return('ID' => 'message_id')
+      API.send_message('4477791234567', 'hello world', :session_id => 'abcde').should == 'message_id'
+    end
+    
+    it "should support message status query with authentication, returning message status" do
+      API.should_receive(:execute_command).with('querymsg',
+        :api_id => '1234',
+        :user => 'joebloggs',
+        :password => 'superpass',
+        :apimsgid => 'messageid'
+      ).and_return(response=mock('response'))
+      Response.should_receive(:parse).with(response).and_return('ID' => 'message_id', 'Status' => 'message_status')
+      API.message_status('messageid',
+        :username => 'joebloggs', :password => 'superpass', :api_key => '1234'
+      ).should == 'message_status'
+    end
+    
+    it "should support message status query with pre-auth" do
+      API.should_receive(:execute_command).with('querymsg',
+        :session_id => 'abcde',
+        :apimsgid => 'messageid'
+      ).and_return(response=mock('response'))
+      Response.should_receive(:parse).with(response).and_return('ID' => 'message_id', 'Status' => 'message_status')
+      API.message_status('messageid', :session_id => 'abcde').should == 'message_status'
+    end
+  end
+  
+end

data/spec/connection_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/clickatell'
+
+module Clickatell
+
+  describe Connection, ' when unauthenticated' do
+    it "should authenticate and store session_id before sending command" do
+      connection = Connection.new('my_api_key', 'myusername', 'mypassword')
+      API.should_receive(:authenticate).with('my_api_key', 'myusername', 'mypassword').and_return('new_session_id')
+      API.should_receive(:send_message).with('4477791234567', 'hello world', :session_id => 'new_session_id')
+      connection.send_message('4477791234567', 'hello world')
+    end
+  end
+  
+  describe Connection, ' when authenticated' do
+    it "should send command with session_id without re-authenticating" do
+      connection = Connection.new('my_api_key', 'myusername', 'mypassword')
+      connection.stub!(:session_id).and_return('session_id')
+      API.should_receive(:authenticate).never
+      API.should_receive(:send_message).with('4477791234567', 'hello world', :session_id => 'session_id')
+      connection.send_message('4477791234567', 'hello world')
+    end
+  end
+  
+end

data/spec/response_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/clickatell'
+
+module Clickatell
+
+  describe "Response parser" do
+    it "should return hash for one-line success response" do
+      raw_response = stub('response')
+      raw_response.stub!(:body).and_return('k1: foo k2: bar')
+      Response.parse(raw_response).should == {'k1' => 'foo', 'k2' => 'bar'}
+    end
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'spec'

data/website/index.html

@@ -0,0 +1,111 @@
+<!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>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <link rel="stylesheet" href="stylesheets/limechoc.css" type="text/css" media="screen" />
+  <script type="text/javascript" charset="utf-8" src="javascripts/codehighlighter/code_highlighter.js"></script>
+  <script type="text/javascript" charset="utf-8" src="javascripts/codehighlighter/ruby.js"></script>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>Clickatell Ruby API</title>
+</head>
+<body>
+  
+<div id="wrapper">
+  <div id="container">
+  
+  <div id="header">
+    
+    <h1>Clickatell Ruby API 0.1.0
+    <span class="tagline">gem install clickatell</span></h1>
+    
+  </div>
+  
+  <div id="content">
+    <div class="article"><h3>What is it?</h3>
+
+
+	<p>A Ruby interface to the <a href="http://www.clickatell.com">Clickatell</a> SMS gateway <span class="caps">API</span>.</p>
+
+
+	<h3>Installing</h3>
+
+
+<p>Download the <a href="http://rubyforge.org/projects/clickatell">latest version of gem</a> or install using RubyGems</p>
+
+<pre><code>$ sudo gem install clickatell</code></pre>
+
+	<h3>The basics</h3>
+
+
+	<p>To use this gem, you will need sign up for an account at <a href="http://www.clickatell.com">the Clickatell website</a>. 
+Once you are registered and logged into your account centre, you should add 
+an <span class="caps">HTTP API</span> connection to your account. This will give you your <span class="caps">API</span>_ID.</p>
+
+
+	<h3>Demonstration of usage</h3>
+
+
+	<p>You can now use the library directly. You will need your <span class="caps">API</span>_ID as well as your
+account username and password.</p>
+
+
+<pre><code class="ruby">
+require 'rubygems'
+require 'clickatell'
+
+connection = Clickatell::Connection.new('your_api_id', 'your_username', 'your_password')
+connection.send_message('447771234567', 'Hello from clickatell')
+</code></pre>
+
+	<h4>Command-line <span class="caps">SMS</span> Utility</h4>
+
+
+	<p>The Clickatell gem also comes with a command-line utility that will allow you
+to send an <span class="caps">SMS</span> directly from the command-line.</p>
+
+
+	<p>You will need to create a <span class="caps">YAML</span> configuration file in your home directory, in a 
+file called .clickatell that resembles the following:</p>
+
+
+<pre><code>
+# ~/.clickatell
+api_key: your_api_id
+username: your_username
+password: your_password
+</code></pre>
+
+	<p>You can then use the sms utility to send a message to a single recipient:</p>
+
+
+<pre><code>
+$ sms 447771234567 'Hello from clickatell'
+</code></pre>
+
+	<h3>License</h3>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+	<h3>Contact</h3>
+
+
+	<p>Comments are welcome. Send an email to <a href="mailto:contact@lukeredpath.co.uk">Luke Redpath</a> email.</p></div>
+  </div>
+    
+  </div>
+  
+  <div id="footer_wrapper">
+  	<div id="footer">
+  	  <p class="copyright">
+        <a href="http://rubyforge.org/projects/clickatell">Rubyforge Project Page</a> | 
+        <a href="http://rubyforge.org/projects/clickatell">Download latest version (0.1.0)</a>
+      </p>
+  	</div>
+  </div>
+</div>
+
+</body>
+</html>

data/website/index.txt

@@ -0,0 +1,59 @@
+h1. Clickatell Ruby API
+
+h3. What is it?
+
+A Ruby interface to the "Clickatell":http://www.clickatell.com SMS gateway API.
+
+h3. Installing
+
+<p>Download the <a href="http://rubyforge.org/projects/clickatell">latest version of gem</a> or install using RubyGems</p>
+
+<pre><code>$ sudo gem install clickatell</code></pre>
+
+h3. The basics
+
+To use this gem, you will need sign up for an account at "the Clickatell website":http://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.
+
+h3. Demonstration of usage
+
+You can now use the library directly. You will need your API_ID as well as your
+account username and password.
+
+<pre><code class="ruby">
+require 'rubygems'
+require 'clickatell'
+
+connection = Clickatell::Connection.new('your_api_id', 'your_username', 'your_password')
+connection.send_message('447771234567', 'Hello from clickatell')
+</code></pre>
+  
+h4. 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:
+
+<pre><code>
+# ~/.clickatell
+api_key: your_api_id
+username: your_username
+password: your_password
+</code></pre>
+
+You can then use the sms utility to send a message to a single recipient:
+
+<pre><code>
+$ sms 447771234567 'Hello from clickatell'
+</code></pre>
+
+h3. License
+
+This code is free to use under the terms of the MIT license. 
+
+h3. Contact
+
+Comments are welcome. Send an email to "Luke Redpath":mailto:contact@lukeredpath.co.uk email.

data/website/javascripts/codehighlighter/code_highlighter.js

@@ -0,0 +1,188 @@
+/* Unobtrustive Code Highlighter By Dan Webb 11/2005
+   Version: 0.4
+	
+	Usage:
+		Add a script tag for this script and any stylesets you need to use
+		to the page in question, add correct class names to CODE elements, 
+		define CSS styles for elements. That's it! 
+	
+	Known to work on:
+		IE 5.5+ PC
+		Firefox/Mozilla PC/Mac
+		Opera 7.23 + PC
+		Safari 2
+		
+	Known to degrade gracefully on:
+		IE5.0 PC
+	
+	Note: IE5.0 fails due to the use of lookahead in some stylesets.  To avoid script errors
+	in older browsers use expressions that use lookahead in string format when defining stylesets.
+	
+	This script is inspired by star-light by entirely cunning Dean Edwards
+	http://dean.edwards.name/star-light/.  
+*/
+
+// replace callback support for safari.
+if ("a".replace(/a/, function() {return "b"}) != "b") (function(){
+  var default_replace = String.prototype.replace;
+  String.prototype.replace = function(search,replace){
+	// replace is not function
+	if(typeof replace != "function"){
+		return default_replace.apply(this,arguments)
+	}
+	var str = "" + this;
+	var callback = replace;
+	// search string is not RegExp
+	if(!(search instanceof RegExp)){
+		var idx = str.indexOf(search);
+		return (
+			idx == -1 ? str :
+			default_replace.apply(str,[search,callback(search, idx, str)])
+		)
+	}
+	var reg = search;
+	var result = [];
+	var lastidx = reg.lastIndex;
+	var re;
+	while((re = reg.exec(str)) != null){
+		var idx  = re.index;
+		var args = re.concat(idx, str);
+		result.push(
+			str.slice(lastidx,idx),
+			callback.apply(null,args).toString()
+		);
+		if(!reg.global){
+			lastidx += RegExp.lastMatch.length;
+			break
+		}else{
+			lastidx = reg.lastIndex;
+		}
+	}
+	result.push(str.slice(lastidx));
+	return result.join("")
+  }
+})();
+
+var CodeHighlighter = { styleSets : new Array };
+
+CodeHighlighter.addStyle = function(name, rules) {
+	// using push test to disallow older browsers from adding styleSets
+	if ([].push) this.styleSets.push({
+		name : name, 
+		rules : rules,
+		ignoreCase : arguments[2] || false
+	})
+	
+	function setEvent() {
+		// set highlighter to run on load (use LowPro if present)
+		if (typeof Event != 'undefined' && typeof Event.onReady == 'function') 
+		  return Event.onReady(CodeHighlighter.init.bind(CodeHighlighter));
+		
+		var old = window.onload;
+		
+		if (typeof window.onload != 'function') {
+			window.onload = function() { CodeHighlighter.init() };
+		} else {
+			window.onload = function() {
+				old();
+				CodeHighlighter.init();
+			}
+		}
+	}
+	
+	// only set the event when the first style is added
+	if (this.styleSets.length==1) setEvent();
+}
+
+CodeHighlighter.init = function() {
+	if (!document.getElementsByTagName) return; 
+	if ("a".replace(/a/, function() {return "b"}) != "b") return; // throw out Safari versions that don't support replace function
+	// throw out older browsers
+	
+	var codeEls = document.getElementsByTagName("CODE");
+	// collect array of all pre elements
+	codeEls.filter = function(f) {
+		var a =  new Array;
+		for (var i = 0; i < this.length; i++) if (f(this[i])) a[a.length] = this[i];
+		return a;
+	} 
+	
+	var rules = new Array;
+	rules.toString = function() {
+		// joins regexes into one big parallel regex
+		var exps = new Array;
+		for (var i = 0; i < this.length; i++) exps.push(this[i].exp);
+		return exps.join("|");
+	}
+	
+	function addRule(className, rule) {
+		// add a replace rule
+		var exp = (typeof rule.exp != "string")?String(rule.exp).substr(1, String(rule.exp).length-2):rule.exp;
+		// converts regex rules to strings and chops of the slashes
+		rules.push({
+			className : className,
+			exp : "(" + exp + ")",
+			length : (exp.match(/(^|[^\\])\([^?]/g) || "").length + 1, // number of subexps in rule
+			replacement : rule.replacement || null 
+		});
+	}
+	
+	function parse(text, ignoreCase) {
+		// main text parsing and replacement
+		return text.replace(new RegExp(rules, (ignoreCase)?"gi":"g"), function() {
+			var i = 0, j = 1, rule;
+			while (rule = rules[i++]) {
+				if (arguments[j]) {
+					// if no custom replacement defined do the simple replacement
+					if (!rule.replacement) return "<span class=\"" + rule.className + "\">" + arguments[0] + "</span>";
+					else {
+						// replace $0 with the className then do normal replaces
+						var str = rule.replacement.replace("$0", rule.className);
+						for (var k = 1; k <= rule.length - 1; k++) str = str.replace("$" + k, arguments[j + k]);
+						return str;
+					}
+				} else j+= rule.length;
+			}
+		});
+	}
+	
+	function highlightCode(styleSet) {
+		// clear rules array
+		var parsed, clsRx = new RegExp("(\\s|^)" + styleSet.name + "(\\s|$)");
+		rules.length = 0;
+		
+		// get stylable elements by filtering out all code elements without the correct className	
+		var stylableEls = codeEls.filter(function(item) { return clsRx.test(item.className) });
+		
+		// add style rules to parser
+		for (var className in styleSet.rules) addRule(className, styleSet.rules[className]);
+		
+			
+		// replace for all elements
+		for (var i = 0; i < stylableEls.length; i++) {
+			// EVIL hack to fix IE whitespace badness if it's inside a <pre>
+			if (/MSIE/.test(navigator.appVersion) && stylableEls[i].parentNode.nodeName == 'PRE') {
+				stylableEls[i] = stylableEls[i].parentNode;
+				
+				parsed = stylableEls[i].innerHTML.replace(/(<code[^>]*>)([^<]*)<\/code>/i, function() {
+					return arguments[1] + parse(arguments[2], styleSet.ignoreCase) + "</code>"
+				});
+				parsed = parsed.replace(/\n( *)/g, function() { 
+					var spaces = "";
+					for (var i = 0; i < arguments[1].length; i++) spaces+= "&nbsp;";
+					return "\n" + spaces;  
+				});
+				parsed = parsed.replace(/\t/g, "&nbsp;&nbsp;&nbsp;&nbsp;");
+				parsed = parsed.replace(/\n(<\/\w+>)?/g, "<br />$1").replace(/<br \/>[\n\r\s]*<br \/>/g, "<p><br></p>");
+				
+			} else parsed = parse(stylableEls[i].innerHTML, styleSet.ignoreCase);
+			
+			stylableEls[i].innerHTML = parsed;
+		}
+	}
+	
+	// run highlighter on all stylesets
+	for (var i=0; i < this.styleSets.length; i++) {
+		highlightCode(this.styleSets[i]);  
+	}
+}