action_sms 0.0.3 → 0.1.0

data/lib/action_sms/connection_adapters/abstract_adapter.rb

@@ -1,11 +1,46 @@
 require 'net/https'
 
-module ActionSms #:nodoc:
-  module ConnectionAdapters #:nodoc:
+module ActionSms
+  module ConnectionAdapters
     # All the concrete gateway adapters follow the interface laid down in this
-    # class.  You can use this interface directly by borrowing the gateway
+    # class. You can use this interface directly by borrowing the gateway
     # connection from the Base with Base.connection.
     class AbstractAdapter
+      require 'uri'
+
+      def initialize(config = {}) #:nodoc:
+        @config = config
+      end
+
+      def authenticate(params)
+        params["authentication_key"] == @config[:authentication_key] ?
+          params.delete("authentication_key") : nil
+      end
+
+      def authentication_key=(value)
+        @config[:authentication_key] = value
+      end
+
+      def authentication_key
+        @config[:authentication_key]
+      end
+
+      def configuration
+        @config
+      end
+
+      def configuration=(value)
+        @config = value
+      end
+
+      def use_ssl
+        @config[:use_ssl]
+      end
+
+      def use_ssl=(value)
+        @config[:use_ssl] = value
+      end
+
       protected
         # Helper method to send an HTTP POST request to +url+ with paramaters
         # specified by the +params+ hash.
@@ -16,11 +51,18 @@ module ActionSms #:nodoc:
 
           http = Net::HTTP.new(uri.host, uri.port)
           http.use_ssl = true if uri.scheme == 'https'
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
           resp = http.start do
             http.request(req)
           end
           resp.body
         end
+
+        def service_url(service_uri)
+          service_uri = URI.parse(service_uri)
+          service_uri.scheme = @config[:use_ssl] ? "https" : "http"
+          service_uri.to_s
+        end
     end
   end
 end

data/lib/action_sms/connection_adapters/sms_global_adapter.rb

@@ -0,0 +1,76 @@
+require 'action_sms/connection_adapters/abstract_adapter'
+
+module ActionSms
+  class Base
+    def self.sms_global_connection(config) #:nodoc:
+      if config[:environment].to_s == "test"
+        test_helper = File.expand_path(File.dirname(__FILE__) + '/test_helpers/sms_global')
+        if File.exists?("#{test_helper}.rb")
+          require test_helper
+          ConnectionAdapters::SMSGlobalAdapter.class_eval do
+            include ActionSms::ConnectionAdapters::TestHelpers::SMSGlobal
+          end
+        end
+      end
+      ConnectionAdapters::SMSGlobalAdapter.new(config)
+    end
+  end
+
+  module ConnectionAdapters
+    # All the concrete gateway adapters follow the interface laid down in this
+    # class. You can use this interface directly by borrowing the gateway
+    # connection from the Base with Base.connection.
+    class SMSGlobalAdapter < AbstractAdapter
+
+      SERVICE_URL = "http://smsglobal.com.au/http-api.php"
+
+      def deliver(sms, options = {})
+        params = {
+          :action   => 'sendsms',
+          :user     => @config[:user],
+          :password => @config[:password],
+          :maxsplit => @config[:maxsplit] || "19",
+          :from     => sms.respond_to?(:from) ? sms.from : "reply2email",
+          :to       => sms.recipient,
+          :text     => (sms.body || "")
+        }
+        params.merge!(
+          :userfield => sms.userfield
+        ) if sms.respond_to?(:userfield)
+        send_http_request(service_url, params)
+      end
+
+      def delivery_request_successful?(gateway_response)
+        gateway_response =~ /^OK/
+      end
+
+      def message_id(data)
+        sms_global_message_id_prefix = "SMSGlobalMsgID:"
+        if data.is_a?(Hash)
+          message_id = data["msgid"]
+          sms_global_message_id_prefix + message_id if message_id
+        elsif data.is_a?(String)
+          match = /#{sms_global_message_id_prefix}\s*(\d+)/.match(data)
+          sms_global_message_id_prefix + $1 if $1
+        end
+      end
+
+      def message_text(params)
+        params["msg"]
+      end
+
+      def sender(params)
+        params["from"]
+      end
+
+      def service_url
+        super(SERVICE_URL)
+      end
+
+      def status(delivery_receipt)
+        delivery_receipt["dlrstatus"]
+      end
+    end
+  end
+end
+

data/lib/action_sms/connection_adapters/test_helpers/sms_global.rb

@@ -0,0 +1,68 @@
+module ActionSms
+  module ConnectionAdapters
+    module TestHelpers
+      module SMSGlobal
+
+        def sample_configuration(options = {})
+          config = {
+            :adapter => "sms_global",
+            :user => "SMSGlobal Username",
+            :password => "SMSGlobal Password"
+          }
+          config.merge!(
+            :authentication_key => "My Unique Authentication Key"
+          ) if options[:authentication_key]
+          config
+        end
+
+        def sample_delivery_receipt(options = {})
+          options[:message_id] ||= "6942744494999745"
+          options[:message_id].gsub!("SMSGlobalMsgID:", "")
+          options[:status] ||= "DELIVRD"
+          options[:error] ||= "000"
+          options[:date] ||= "1005132312"
+          {
+            "msgid"=> options[:message_id],
+            "dlrstatus"=> options[:status],
+            "dlr_err"=> options[:error],
+            "donedate"=> options[:date]
+          }
+        end
+
+        def sample_delivery_response(options = {})
+          options[:failed] ||= false
+          options[:message_id] ||= "6942744494999745"
+          options[:failed] ? "ERROR: No action requested" : "OK: 0; Sent queued message ID: 86b1a945370734f4 #{sample_message_id(:message_id => options[:message_id])}"
+        end
+
+        def sample_delivery_response_with_message_id(message_id, options = {})
+          options.merge!(:message_id => message_id)
+          sample_delivery_response(options)
+        end
+
+        def sample_incoming_sms(options = {})
+          options[:message] ||= "Endia kasdf ofeao"
+          options[:to]      ||= "61447100308"
+          options[:from]    ||= "61447100399"
+          options[:date]    ||= "2010-05-13 23:59:11"
+          sample = {
+            "to" => options[:to],
+            "from" => options[:from],
+            "msg"=> options[:message],
+            "date" => options[:date]
+          }
+          sample.merge!(
+            "authentication_key" => @config[:authentication_key]
+          ) if options[:authentic]
+          sample
+        end
+
+        def sample_message_id(options = {})
+          options[:message_id] ||= "6942744494999745"
+          "SMSGlobalMsgID:#{options[:message_id]}"
+        end
+      end
+    end
+  end
+end
+

data/lib/action_sms/connection_adapters/test_helpers/tropo.rb

@@ -0,0 +1,67 @@
+module ActionSms
+  module ConnectionAdapters
+    module TestHelpers
+      module Tropo
+
+        def sample_configuration(options = {})
+          config = {
+            :adapter => "tropo",
+            :outgoing_token => "Tropo Outgoing Token"
+          }
+          config.merge!(
+            :authentication_key => "My Unique Authentication Key"
+          ) if options[:authentication_key]
+          config
+        end
+
+        def sample_delivery_response(options = {})
+          options[:failed] ? "<session><success>false</success><token></token><reason>FAILED TO ROUTE TOKEN</reason></session>" : "<session><success>true</success></session>"
+        end
+
+        def sample_incoming_sms(options = {})
+          options[:message] ||= "Endia kasdf ofeao"
+          options[:to]      ||= "61447100308"
+          options[:from]    ||= "61447100399"
+          options[:date]    ||= "Mon Oct 11 09:21:38 UTC 2010"
+          params = {
+            "session" => {
+              "id"=>"12349516546e59746d6a89a990466789",
+              "account_id"=>"12345",
+              "timestamp"=> options[:date],
+              "user_type"=>"HUMAN",
+              "initial_text"=> options[:message],
+              "call_id"=>"123e71195545ad204bdd99f2070a7d86",
+              "to"=>{
+                "id"=> options[:to],
+                "name"=>"unknown",
+                "channel"=>"TEXT",
+                "network"=>"SMS"
+              },
+              "from" => {
+                "id"=> options[:from],
+                "name"=>"unknown",
+                "channel"=>"TEXT",
+                "network"=>"SMS"
+              },
+              "headers" => {
+                "_max-_forwards"=>"70",
+                "_content-_length"=>"124",
+                "_contact"=>"<sip:11.8.93.101:5066;transport=udp>",
+                "_to"=>"<sip:1231454582@10.6.69.203:5061;to=#{options[:to]}>",
+                "_c_seq"=>"1 INVITE",
+                "_via"=>"SIP/2.0/UDP 11.8.93.101:5066;branch=h0hG4bKk5sy1e",
+                "_call-_i_d"=>"ieeg18",
+                "_content-_type"=>"application/sdp",
+
+          "_from"=>"<sip:15EB6BAB-99DF-44C2-871DFBA75C319776@11.8.93.201;channel=private;user=#{options[:to]};msg=#{options[:message]};network=SMS;step=1>;tag=zm13kt"
+              }
+            }
+          }
+          params.merge!("authentication_key" => @config[:authentication_key]) unless options[:authentic] == false
+          params
+        end
+      end
+    end
+  end
+end
+

data/lib/action_sms/connection_adapters/tropo_adapter.rb

@@ -0,0 +1,73 @@
+require 'action_sms/connection_adapters/abstract_adapter'
+
+module ActionSms
+  class Base
+    def self.tropo_connection(config) #:nodoc:
+      if config[:environment].to_s == "test"
+        test_helper = File.expand_path(File.dirname(__FILE__) + '/test_helpers/tropo')
+        if File.exists?("#{test_helper}.rb")
+          require test_helper
+          ConnectionAdapters::TropoAdapter.class_eval do
+            include ActionSms::ConnectionAdapters::TestHelpers::Tropo
+          end
+        end
+      end
+      ConnectionAdapters::TropoAdapter.new(config)
+    end
+  end
+
+  module ConnectionAdapters
+    # All the concrete gateway adapters follow the interface laid down in this
+    # class.  You can use this interface directly by borrowing the gateway
+    # connection from the Base with Base.connection.
+    class TropoAdapter < AbstractAdapter
+      require 'tropo_message'
+
+      SERVICE_URL = "http://api.tropo.com/1.0/sessions"
+
+      def deliver(sms, options = {})
+        tropo_message = Tropo::Message.new
+        tropo_message.to = sms.recipient
+        tropo_message.text = sms.body || ""
+        tropo_message.from = sms.from if sms.respond_to?(:from)
+        tropo_message.token = @config[:outgoing_token]
+        response = send_http_request(service_url, tropo_message.request_xml)
+        options[:filter_response] ? filter_response(response) : response
+      end
+
+      def delivery_request_successful?(gateway_response)
+        gateway_response =~ /\<success\>true\<\/success\>/
+      end
+
+      def message_id(data)
+        # this method is supposed to return nil
+      end
+
+      def message_text(params)
+        session(params)["initial_text"]
+      end
+
+      def sender(params)
+        session(params)["from"]["id"]
+      end
+
+      def service_url
+        super(SERVICE_URL)
+      end
+
+      def status(delivery_receipt)
+        # this method is supposed to return nil
+      end
+
+      private
+        def session(params)
+          params["session"]
+        end
+
+        def filter_response(raw_response)
+          raw_response.gsub(/\<token\>\w+\<\/token\>/, "")
+        end
+    end
+  end
+end
+

data/lib/action_sms/version.rb

@@ -0,0 +1,4 @@
+module ActionSms
+  VERSION = "0.1.0"
+end
+

data/lib/generators/action_sms/initializer/initializer_generator.rb

@@ -5,8 +5,35 @@ module ActionSms
        @source_root ||= File.join(File.dirname(__FILE__), 'templates')
     end
 
-    def copy_conversation_file
-      copy_file "action_sms.rb", "config/initializers/action_sms.rb"
+    def copy_initializer
+      template "action_sms.rb", "config/initializers/action_sms.rb"
+    end
+
+    private
+
+    def built_in_adapter_configurations
+      output = ""
+      adapters = ActionSms::Base.adapters(
+        :sample_configuration, :environment => "test"
+      )
+      adapters.each do |adapter|
+        config = adapter.sample_configuration
+        output << "## " << config[:adapter].titleize << "\n\n" <<
+        "# ActionSms::Base.establish_connection(" << "\n" <<
+          pretty_print_adapter_configuration(config) << "\n" <<
+        "# )"
+        output << "\n\n" unless adapters.last == adapter
+      end
+      output
+    end
+
+    def pretty_print_adapter_configuration(config)
+      output = ""
+      config.each do |key, value|
+        output << "#   " << ":#{key}" << " => " << "\"#{value}\""
+        output << ",\n" unless config.keys.last == key
+      end
+      output
     end
   end
 end

data/lib/generators/action_sms/initializer/templates/action_sms.rb

@@ -1,11 +1,31 @@
-# see http://github.com/dwilkie/action_sms_gateways
-# for preconfigured sms gateways and more details on how to make your own adapter
+# see also http://github.com/dwilkie/action_sms
+# for more configuration options and details on how to make your own adapter
 
-# Then uncomment the following code and replace :adapter with your adapter
+# Built In Adapters
 
-#ActionSms::Base.establish_connection(
-#  :adapter => 'your_adapter',
-#  :username => '[username]',
-#  :password => '[password]'
-#)
+<%= built_in_adapter_configurations %>
+
+# Custom Adapters
+
+# ActionSms::Base.establish_connection(
+#   :adapter => "your_adapter"
+#   # adapter specific configuration...
+# )
+
+# Incoming Message Authentication
+
+# Using an authentication key in conjunction with a secure connection helps protect you against someone faking incoming messages to your server.
+
+# ActionSms::Base.establish_connection(
+#   :use_ssl => true,
+#   :authentication_key => "my_secret"
+# )
+
+# Testing
+
+# Setting: `:environment => "test"` gives you get some additional test helpers useful for testing
+
+# ActionSms::Base.establish_connection(
+#   :environment => "test"
+# )
 

data/spec/base_spec.rb

@@ -0,0 +1,649 @@
+require 'spec_helper'
+
+describe ActionSms::Base do
+
+  describe "#adapters" do
+    let(:adapter) {mock "gateway_adapter"}
+    before do
+      ActionSms::Base.stub!(:methods).and_return(
+        [:gateway_adapter_connection]
+      )
+      ActionSms::Base.stub!(:gateway_adapter_connection).and_return(adapter)
+    end
+    context "an adapter responds to 'adapter_method'" do
+      before do
+        adapter.stub!(:adapter_method)
+      end
+      it "should include the adapter" do
+        ActionSms::Base.adapters(
+          :adapter_method
+        ).should include(adapter)
+      end
+      context "config = {}" do
+        context "and there's a current connection" do
+          before do
+            ActionSms::Base.stub!(:connected?).and_return(true)
+          end
+          let(:active_adapter_config) { {:adapter_name => "some_adapter"} }
+          before do
+            ActionSms::Base.stub!(:connection).and_return(mock(
+              "active_adapter",
+              :configuration => active_adapter_config
+            ))
+          end
+          it "should set the adapter's config to that of the current connection's" do
+            ActionSms::Base.should_receive(
+              :gateway_adapter_connection
+            ).with(active_adapter_config)
+            ActionSms::Base.adapters(:adapter_method)
+          end
+        end
+        context "but there's no current connection" do
+          it "should set the adapter's config to: '{}'" do
+            ActionSms::Base.should_receive(
+              :gateway_adapter_connection
+            ).with({})
+            ActionSms::Base.adapters(:adapter_method)
+          end
+        end
+      end
+      context "config = {:some_config => 'something'}" do
+        let(:config) { {:some_config => 'something'} }
+        it "should set the adapter's config to the passed in config" do
+          ActionSms::Base.should_receive(
+            :gateway_adapter_connection
+          ).with(config)
+          ActionSms::Base.adapters(:adapter_method, config)
+        end
+      end
+    end
+    context "an adapter does not respond to 'adapter_method'" do
+      it "should not include the adapter" do
+        ActionSms::Base.adapters(
+          :adapter_method
+        ).should_not include(:adapter)
+      end
+    end
+  end
+
+  describe "#connection" do
+    it "should set the connection" do
+      adapter = mock("adapter")
+      ActionSms::Base.connection = adapter
+      ActionSms::Base.connection.should == adapter
+      ActionSms::Base.should be_connected
+    end
+  end
+
+  describe "#establish_connection" do
+    context "adapter is specified in the configuration" do
+      let (:adapter_name) { "my_adapter" }
+      let (:adapter_connection) { adapter_name + "_connection" }
+      context "and is defined" do
+        let (:adapter) { mock("adapter") }
+        before do
+          ActionSms::Base.stub!(:respond_to?).with(
+            adapter_connection
+          ).and_return(true)
+          ActionSms::Base.stub!(
+            adapter_connection
+          ).and_return(adapter)
+        end
+        it "should be connected" do
+          ActionSms::Base.establish_connection(:adapter => adapter_name)
+          ActionSms::Base.should be_connected
+        end
+      end
+      context "but is not defined" do
+        before do
+          ActionSms::Base.stub!(:respond_to?).with(
+            adapter_connection
+          ).and_return(false)
+        end
+        it "should raise and 'AdapterNotFound' error" do
+          expect {
+            ActionSms::Base.establish_connection(:adapter => adapter_name)
+          }.to raise_error(ActionSms::AdapterNotFound)
+        end
+      end
+    end
+    context "adapter is not specified in the configuration" do
+      it "should raise an 'AdapterNotSpecified' error" do
+        expect {
+          ActionSms::Base.establish_connection({})
+        }.to raise_error(ActionSms::AdapterNotSpecified)
+      end
+    end
+  end
+
+  context "adapter helper methods" do
+    let(:active_adapter) {
+      mock("active_adapter")
+    }
+
+    let(:another_adapter) {
+      mock("another_adapter")
+    }
+
+    before do
+      ActionSms::Base.stub!(
+        :connection
+      ).and_return(active_adapter)
+
+      ActionSms::Base.stub!(
+        :methods
+      ).and_return([:another_adapter_connection])
+
+      ActionSms::Base.stub!(
+        :another_adapter_connection
+      ).and_return(another_adapter)
+
+      active_adapter.stub!(:configuration)
+    end
+
+    describe "#authenticate" do
+      before do
+        active_adapter.stub!(:respond_to?).with(
+          :authenticate
+        ).and_return(true)
+      end
+      context "active connection authenticates the message" do
+        before do
+          active_adapter.stub!(
+            :authenticate
+          ).and_return("something")
+        end
+        it "should return the active connection's response" do
+          ActionSms::Base.authenticate("anything").should == "something"
+        end
+      end
+      context "active connection does not authenticate the message" do
+        before do
+          active_adapter.stub!(:authenticate)
+        end
+        context "another adapter authenticates the message" do
+          before do
+            another_adapter.stub!(
+              :authenticate
+             ).and_return("something else")
+          end
+          it "should return the other adapter's response" do
+            ActionSms::Base.authenticate("anything").should == "something else"
+          end
+        end
+        context "no other adapter authenticates the message" do
+          it "should return nil" do
+            ActionSms::Base.authenticate("anything").should be_nil
+          end
+        end
+      end
+    end
+
+    describe "#authentication_key" do
+      it "should call 'authentication_key' on the connection" do
+        active_adapter.should_receive(:authentication_key)
+        ActionSms::Base.authentication_key
+      end
+    end
+
+    describe "#authentication_key=" do
+      it "should call 'authentication_key=' on the connection" do
+        active_adapter.should_receive(
+          :authentication_key=
+        ).with("something")
+        ActionSms::Base.authentication_key = "something"
+      end
+    end
+
+    describe "#deliver" do
+      it "should call 'deliver' on the connection" do
+        sms = mock("sms")
+        options = {:my_options => "something"}
+        active_adapter.should_receive(:deliver).with(sms, options)
+        ActionSms::Base.deliver(sms, options)
+      end
+    end
+
+    describe "#delivery_request_successful?" do
+      it "should call 'delivery_request_successful?' on the connection" do
+        gateway_response = mock("gateway_response")
+        active_adapter.should_receive(
+          :delivery_request_successful?
+        ).with(gateway_response)
+        ActionSms::Base.delivery_request_successful?(gateway_response)
+      end
+    end
+
+    describe "#message_id" do
+      before do
+        active_adapter.stub!(:respond_to?).with(
+          :message_id
+        ).and_return(true)
+      end
+      context "active connection returns the message id" do
+        before do
+          active_adapter.stub!(
+            :message_id
+          ).and_return("something")
+        end
+        it "should return the active connection's response" do
+          ActionSms::Base.message_id("anything").should == "something"
+        end
+      end
+      context "active connection does not return the message id" do
+        before do
+          active_adapter.stub!(:message_id)
+        end
+        context "another adapter returns the message id" do
+          before do
+            another_adapter.stub!(
+              :message_id
+             ).and_return("something else")
+          end
+
+          it "should return the other adapter's response" do
+            ActionSms::Base.message_id("anything").should == "something else"
+          end
+        end
+
+        context "no other adapter returns the message id" do
+          it "should return nil" do
+            ActionSms::Base.message_id("anything").should be_nil
+          end
+        end
+      end
+    end
+
+    describe "#message_text" do
+      before do
+        active_adapter.stub!(:respond_to?).with(
+          :message_text
+        ).and_return(true)
+      end
+      context "active connection returns the message text" do
+        before do
+          active_adapter.stub!(
+            :message_text
+          ).and_return("something")
+        end
+        it "should return the active connection's response" do
+          ActionSms::Base.message_text("anything").should == "something"
+        end
+      end
+      context "active connection does not return the message text" do
+        before do
+          active_adapter.stub!(:message_text)
+        end
+        context "another adapter returns the message text" do
+          before do
+            another_adapter.stub!(
+              :message_text
+             ).and_return("something else")
+          end
+
+          it "should return the other adapter's response" do
+            ActionSms::Base.message_text("anything").should == "something else"
+          end
+        end
+
+        context "no other adapter returns the message text" do
+          it "should return nil" do
+            ActionSms::Base.message_text("anything").should be_nil
+          end
+        end
+      end
+    end
+
+    describe "#sender" do
+      before do
+        active_adapter.stub!(:respond_to?).with(
+          :sender
+        ).and_return(true)
+      end
+      context "active connection returns the sender" do
+        before do
+          active_adapter.stub!(
+            :sender
+          ).and_return("something")
+        end
+        it "should return the active connection's response" do
+          ActionSms::Base.sender("anything").should == "something"
+        end
+      end
+      context "active connection does not return the sender" do
+        before do
+          active_adapter.stub!(:sender)
+        end
+        context "another adapter returns the sender" do
+          before do
+            another_adapter.stub!(
+              :sender
+             ).and_return("something else")
+          end
+
+          it "should return the other adapter's response" do
+            ActionSms::Base.sender("anything").should == "something else"
+          end
+        end
+
+        context "no other adapter return the sender" do
+          it "should return nil" do
+            ActionSms::Base.sender("anything").should be_nil
+          end
+        end
+      end
+    end
+
+    describe "#service_url" do
+      it "should call 'service_url' on the connection" do
+        active_adapter.should_receive(:service_url)
+        ActionSms::Base.service_url
+      end
+    end
+
+    describe "#status" do
+      before do
+        active_adapter.stub!(:respond_to?).with(
+          :status
+        ).and_return(true)
+      end
+      context "active connection returns the status" do
+        before do
+          active_adapter.stub!(
+            :status
+          ).and_return("something")
+        end
+        it "should return the active connection's response" do
+          ActionSms::Base.status("anything").should == "something"
+        end
+      end
+      context "active connection does not return the status" do
+        before do
+          active_adapter.stub!(:status)
+        end
+        context "another adapter returns the status" do
+          before do
+            another_adapter.stub!(
+              :status
+             ).and_return("something else")
+          end
+          it "should return the other adapter's response" do
+            ActionSms::Base.status("anything").should == "something else"
+          end
+        end
+        context "no adapters return the status" do
+          it "should return nil" do
+            ActionSms::Base.status("anything").should be_nil
+          end
+        end
+      end
+    end
+
+    describe "#use_ssl" do
+      it "should call 'use_ssl' on the connection" do
+        active_adapter.should_receive(:use_ssl)
+        ActionSms::Base.use_ssl
+      end
+    end
+
+    describe "#use_ssl=" do
+      it "should call 'use_ssl=' on the connection" do
+        active_adapter.should_receive(
+          :use_ssl=
+        ).with("something")
+        ActionSms::Base.use_ssl = "something"
+      end
+    end
+
+    # Test Helper Methods
+
+    describe "#sample_configuration" do
+      it "should call 'sample_configuration' on the connection" do
+        active_adapter.should_receive(:sample_configuration)
+        ActionSms::Base.sample_configuration
+      end
+      context "with options" do
+        it "should pass on the options" do
+          options = {:my_option => "12345"}
+          active_adapter.should_receive(
+            :sample_configuration
+          ).with(options)
+          ActionSms::Base.sample_configuration(options)
+        end
+      end
+    end
+
+    describe "#sample_delivery_receipt" do
+      shared_examples_for "another adapter's sample_delivery_receipt" do
+        context "but another adapter responds to 'sample_delivery_receipt'" do
+          before do
+            another_adapter.stub!(:sample_delivery_receipt)
+          end
+          context "and returns one" do
+            before do
+              another_adapter.stub!(
+                :sample_delivery_receipt
+              ).and_return("something else")
+            end
+            it "should return the other adapter's response" do
+              ActionSms::Base.sample_delivery_receipt.should == "something else"
+            end
+          end
+          context "but also returns nil" do
+            it "should return nil" do
+              ActionSms::Base.sample_delivery_receipt.should be_nil
+            end
+          end
+        end
+        context "and no other adapter responds to 'sample_delivery_receipt'" do
+          it "should return nil" do
+            ActionSms::Base.sample_delivery_receipt.should be_nil
+          end
+        end
+      end
+      context "active connection responds to 'sample_delivery_receipt'" do
+        before do
+          active_adapter.stub!(:sample_delivery_receipt)
+        end
+        context "and returns a sample delivery receipt" do
+          before do
+            active_adapter.stub!(
+              :sample_delivery_receipt
+            ).and_return("something")
+          end
+          it "should return the active connection's response" do
+            ActionSms::Base.sample_delivery_receipt.should == "something"
+          end
+        end
+        context "but returns nil" do
+          before do
+            active_adapter.stub!(:sample_delivery_receipt)
+          end
+          it_behaves_like "another adapter's sample_delivery_receipt"
+        end
+      end
+      context "active connection does not respond to 'sample_delivery_receipt'" do
+        it_behaves_like "another adapter's sample_delivery_receipt"
+      end
+    end
+
+    describe "#sample_delivery_response" do
+      it "should call 'sample_delivery_response' on the connection" do
+        active_adapter.should_receive(:sample_delivery_response)
+        ActionSms::Base.sample_delivery_response
+      end
+      context "with options" do
+        it "should pass on the options" do
+          options = {:my_option => "12345"}
+          active_adapter.should_receive(
+            :sample_delivery_response
+          ).with(options)
+          ActionSms::Base.sample_delivery_response(options)
+        end
+      end
+    end
+
+    describe "#sample_delivery_response_with_message_id" do
+      shared_examples_for "another adapter's sample_delivery_response_with_message_id" do
+        context "but another adapter responds to 'sample_delivery_response_with_message_id'" do
+          before do
+            another_adapter.stub!(:sample_delivery_response_with_message_id)
+          end
+          context "and returns one" do
+            before do
+              another_adapter.stub!(
+                :sample_delivery_response_with_message_id
+              ).and_return("something else")
+            end
+            it "should return the other adapter's response" do
+              ActionSms::Base.sample_delivery_response_with_message_id("12345") == "something else"
+            end
+          end
+          context "but also returns nil" do
+            it "should return nil" do
+              ActionSms::Base.sample_delivery_response_with_message_id("12345").should be_nil
+            end
+          end
+        end
+        context "and no other adapter responds to 'sample_delivery_response_with_message_id'" do
+          it "should return nil" do
+            ActionSms::Base.sample_delivery_response_with_message_id("12345").should be_nil
+          end
+        end
+      end
+      context "active connection responds to 'sample_delivery_response_with_message_id'" do
+        before do
+          active_adapter.stub!(:sample_delivery_response_with_message_id)
+        end
+        context "and returns a sample delivery response with message id" do
+          before do
+            active_adapter.stub!(
+              :sample_delivery_response_with_message_id
+            ).and_return("something")
+          end
+          it "should return the active connection's response" do
+            ActionSms::Base.sample_delivery_response_with_message_id("12345").should == "something"
+          end
+        end
+        context "but returns nil" do
+          before do
+            active_adapter.stub!(:sample_delivery_response_with_message_id)
+          end
+          it_behaves_like "another adapter's sample_delivery_response_with_message_id"
+        end
+      end
+      context "active connection does not respond to 'sample_delivery_response_with_message_id'" do
+        it_behaves_like "another adapter's sample_delivery_response_with_message_id"
+      end
+    end
+
+    describe "#sample_incoming_sms" do
+      shared_examples_for "another adapter's sample_incoming_sms" do
+        context "but another adapter responds to 'sample_incoming_sms'" do
+          before do
+            another_adapter.stub!(:sample_incoming_sms)
+          end
+          context "and returns one" do
+            before do
+              another_adapter.stub!(
+                :sample_incoming_sms
+              ).and_return("something else")
+            end
+            it "should return the other adapter's response" do
+              ActionSms::Base.sample_incoming_sms.should == "something else"
+            end
+          end
+          context "but also returns nil" do
+            it "should return nil" do
+              ActionSms::Base.sample_incoming_sms.should be_nil
+            end
+          end
+        end
+        context "and no other adapter responds to 'sample_incoming_sms'" do
+          it "should return nil" do
+            ActionSms::Base.sample_incoming_sms.should be_nil
+          end
+        end
+      end
+      context "active connection responds to 'sample_incoming_sms'" do
+        before do
+          active_adapter.stub!(:sample_incoming_sms)
+        end
+        context "and returns a sample incoming sms" do
+          before do
+            active_adapter.stub!(
+              :sample_incoming_sms
+            ).and_return("something")
+          end
+          it "should return the active connection's response" do
+            ActionSms::Base.sample_incoming_sms.should == "something"
+          end
+        end
+        context "but returns nil" do
+          before do
+            active_adapter.stub!(:sample_incoming_sms)
+          end
+          it_behaves_like "another adapter's sample_incoming_sms"
+        end
+      end
+      context "active connection does not respond to 'sample_incoming_sms'" do
+        it_behaves_like "another adapter's sample_incoming_sms"
+      end
+    end
+
+    describe "#sample_message_id" do
+      shared_examples_for "another adapter's sample_message_id" do
+        context "but another adapter responds to 'sample_message_id'" do
+          before do
+            another_adapter.stub!(:sample_message_id)
+          end
+          context "and returns one" do
+            before do
+              another_adapter.stub!(
+                :sample_message_id
+              ).and_return("something else")
+            end
+            it "should return the other adapter's response" do
+              ActionSms::Base.sample_message_id.should == "something else"
+            end
+          end
+          context "but also returns nil" do
+            it "should return nil" do
+              ActionSms::Base.sample_message_id.should be_nil
+            end
+          end
+        end
+        context "and no other adapter responds to 'sample_message_id'" do
+          it "should return nil" do
+            ActionSms::Base.sample_message_id.should be_nil
+          end
+        end
+      end
+      context "active connection responds to 'sample_message_id'" do
+        before do
+          active_adapter.stub!(:sample_message_id)
+        end
+        context "and returns a sample message id" do
+          before do
+            active_adapter.stub!(
+              :sample_message_id
+            ).and_return("something")
+          end
+          it "should return the active connection's response" do
+            ActionSms::Base.sample_message_id.should == "something"
+          end
+        end
+        context "but returns nil" do
+          before do
+            active_adapter.stub!(:sample_message_id)
+          end
+          it_behaves_like "another adapter's sample_message_id"
+        end
+      end
+      context "active connection does not respond to 'sample_message_id'" do
+        it_behaves_like "another adapter's sample_message_id"
+      end
+    end
+  end
+end
+