lookout-clickatell 0.8.3

data/spec/cli_options_spec.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/clickatell/utility'
+
+describe "CLI options" do
+
+  context "when sending a message" do
+    it "should allow single recipients" do
+      options = Clickatell::Utility::Options.parse(%w{07944123456 testing})
+      options.recipient.should include("07944123456")
+    end
+
+    it "should allow multiple, comma-separated recipients" do
+      options = Clickatell::Utility::Options.parse(%w{07944123456,07944123457 testing})
+      options.recipient.should include(*%w{07944123456 07944123457})
+    end
+
+    it "should strip + symbols from the beginning of numbers" do
+      options = Clickatell::Utility::Options.parse(%w{+447944123456 testing})
+      options.recipient.should include("447944123456")
+    end
+  end
+
+  context "when checking balance" do
+    it "should not require a recipient" do
+      options = Clickatell::Utility::Options.parse(%w{-b})
+      options.recipient.should be_nil
+    end
+  end
+
+end

data/spec/command_executor_spec.rb

@@ -0,0 +1,120 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/clickatell'
+
+module Clickatell
+  describe "API::CommandExecutor" do
+    it "should default to not test mode" do
+      executor = API::CommandExecutor.new({})
+      executor.should_not be_in_test_mode
+    end
+
+    it "should have test mode" do
+      API.test_mode = true
+      executor = API::CommandExecutor.new({})
+      executor.should be_in_test_mode
+    end
+
+    describe "#execute" do
+      describe "in non-test mode" do
+        before(:each) do
+          API.test_mode = false
+          @executor = API::CommandExecutor.new({})
+        end
+        
+        it "should not record requests" do
+          @executor.should_not respond_to(:sms_requests)
+        end
+
+        describe "without a proxy" do
+          before do
+            @http = mock()
+            @http.expects(:use_ssl=).with(false)
+            @http.expects(:start).returns([])
+            Net::HTTP.expects(:new).with(API::Command::API_SERVICE_HOST, 80).returns(@http)
+          end
+
+          it "should execute commands through the proxy" do
+            @executor.execute("foo", "http")
+          end
+        end
+
+        describe "with a proxy" do
+          before do
+            API.proxy_host     = @proxy_host     = "proxy.example.com"
+            API.proxy_port     = @proxy_port     = "1234"
+            API.proxy_username = @proxy_username = "joeschlub"
+            API.proxy_password = @proxy_password = "secret"
+
+            @http = mock()
+            @http.expects(:start).with(API::Command::API_SERVICE_HOST).returns([])
+            @http.expects(:use_ssl=)
+            Net::HTTP.expects(:Proxy).with(@proxy_host, @proxy_port, @proxy_username, @proxy_password).returns(@http)
+          end
+
+          it "should execute commands through the proxy" do
+            @executor.execute("foo", "http")
+          end
+          
+          describe "when in secure_mode" do 
+            before do 
+              API.secure_mode = true
+              @http.expects(:ca_path=)
+              @http.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_PEER)
+            end
+            it "should execute commands through the proxy using ssl" do
+              @executor.execute("foo", "http")
+            end
+          end
+        end
+      end
+      
+      describe "in test mode" do
+        before(:each) do
+          @params = {:foo => 1, :bar => 2}
+          API.test_mode = true
+          @executor = API::CommandExecutor.new(@params)
+        end
+        
+        it "should not make any network calls" do
+          Net::HTTP.expects(:new).never
+          @executor.execute("foo", "http")
+        end
+        
+        it "should start with an empty request collection" do
+          @executor.sms_requests.should be_empty
+        end
+        
+        it "should record sms requests" do
+          @executor.execute("bar", "http")
+          @executor.sms_requests.should_not be_empty
+        end
+        
+        it "should record a request for each call" do
+          @executor.execute("wibble", "http")
+          @executor.sms_requests.size.should == 1
+          @executor.execute("foozle", "http")
+          @executor.sms_requests.size.should == 2
+        end
+        
+        it "should return a response that approximates a true Net::HttpResponse" do
+          response = @executor.execute("throat-warbler", "http")
+          response.body.should == "test"
+        end
+        
+        describe "each recorded request" do
+          it "should return the command information" do
+            command = "rum_tum_tum"
+            @executor.execute(command, "http")
+            
+            uri = @executor.sms_requests.first
+            uri.host.should == "api.clickatell.com"
+            uri.path.should include(command)
+            @params.collect { |k, v| "#{k}=#{v}"}.each do |query_parameter|
+              uri.query.should include(query_parameter)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/hash_ext_spec.rb

@@ -0,0 +1,14 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/clickatell'
+
+describe Hash do
+  it "should return only the keys specified" do
+    hash = {:a => 'foo', :b => 'bar', :c => 'baz'}
+    hash.only(:a, :b).should == {:a => 'foo', :b => 'bar'}
+  end
+  
+  it "should return only the keys specified, ignoring keys that do not exist" do
+    hash = {:a => 'foo', :b => 'bar', :c => 'baz'}
+    hash.only(:a, :d).should == {:a => 'foo'}
+  end
+end

data/spec/response_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/clickatell'
+
+module Clickatell
+
+  describe "Response parser" do
+    before do
+      Clickatell::API::Error.stubs(:parse).returns(Clickatell::API::Error.new('', ''))
+    end
+    
+    before(:each) do
+      API.test_mode = false
+    end
+    
+    it "should return hash for one-line success response" do
+      Response.parse(stub('response', :body => 'k1: foo k2: bar')).should == {'k1' => 'foo', 'k2' => 'bar'}
+    end
+    
+    it "should return array of hashes for multi-line success response" do
+      Response.parse(stub('response', :body => "k1: foo\nk2: bar")).should == [{'k1' => 'foo'}, {'k2' => 'bar'}]
+    end
+    
+    it "should raise API::Error if response contains an error message" do
+      proc { Response.parse(stub('response', :body => 'ERR: 001, Authentication failed')) }.should raise_error(Clickatell::API::Error)
+    end
+
+    {
+      '001' => 1, '002' => 2,  '003' => 3,  '004' => 4,
+      '005' => 5, '006' => 6,  '007' => 7,  '008' => 8,
+      '009' => 9, '010' => 10, '011' => 11, '012' => 12
+    }.each do |status_str, status_int|
+      it "should parse a message status code of #{status_int} when the response body contains a status code of #{status_str}" do
+        Response.parse(stub('response', :body => "ID: 0d1d7dda17d5a24edf1555dc0b679d0e Status: #{status_str}")).should == {'ID' => '0d1d7dda17d5a24edf1555dc0b679d0e', 'Status' => status_int}
+      end
+    end
+    
+    describe "in test mode" do
+      before(:each) do
+        API.test_mode = true
+      end
+      
+      it "should return something approximating a session_id" do
+      Response.parse("pretty much anything").should == { 'OK' => 'session_id' }
+      end
+    end
+  end
+  
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'spec'
+require 'mocha'
+require 'test/unit'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: lookout-clickatell
+version: !ruby/object:Gem::Version
+  version: 0.8.3
+  prerelease: 
+platform: ruby
+authors:
+- Luke Redpath
+- Kyle Barton
+- R. Tyler Croy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-06 00:00:00.000000000Z
+dependencies: []
+description: Ruby interface to the Clickatell SMS gateway service.
+email:
+- luke@lukeredpath.co.uk
+executables:
+- sms
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- History.txt
+- License.txt
+- RDOC_README.txt
+- README.textile
+- Rakefile
+- bin/sms
+- clickatell.gemspec
+- lib/clickatell.rb
+- lib/clickatell/api.rb
+- lib/clickatell/api/command.rb
+- lib/clickatell/api/command_executor.rb
+- lib/clickatell/api/error.rb
+- lib/clickatell/api/message_status.rb
+- lib/clickatell/response.rb
+- lib/clickatell/utility.rb
+- lib/clickatell/utility/options.rb
+- lib/clickatell/version.rb
+- lib/core-ext/hash.rb
+- scripts/txt2html
+- spec/api_spec.rb
+- spec/cli_options_spec.rb
+- spec/command_executor_spec.rb
+- spec/hash_ext_spec.rb
+- spec/response_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- website/images/footer_bg.gif
+- website/index.txt
+- website/javascripts/codehighlighter/code_highlighter.js
+- website/javascripts/codehighlighter/ruby.js
+- website/javascripts/rounded_corners_lite.inc.js
+- website/stylesheets/limechoc.css
+- website/stylesheets/rdoc.css
+- website/stylesheets/screen.css
+- website/template.rhtml
+homepage: https://github.com/lookout/clickatell
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 784157112864947881
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 784157112864947881
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby interface to the Clickatell SMS gateway service.
+test_files:
+- spec/api_spec.rb
+- spec/cli_options_spec.rb
+- spec/command_executor_spec.rb
+- spec/hash_ext_spec.rb
+- spec/response_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb