action_sms 0.0.3 → 0.1.0

data/spec/connection_adapters/abstract_adapter_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe ActionSms::ConnectionAdapters::AbstractAdapter do
+  let(:adapter) { ActionSms::ConnectionAdapters::AbstractAdapter.new }
+
+  # Interesting methods
+
+  describe "#authenticate" do
+    let (:request_params) { {} }
+    context "the incoming message's 'authentication_key' query parameter value is the same as the adapter's authentication key" do
+      before do
+        adapter.authentication_key = "my_secret_key"
+        request_params["authentication_key"] = "my_secret_key"
+      end
+      it "should not be nil" do
+        adapter.authenticate(request_params).should_not be_nil
+      end
+      it "should remove the key from the request params hash" do
+        adapter.authenticate(request_params)
+        request_params["userfield"].should be_nil
+      end
+    end
+    context "the incoming message's 'authentication_key' query parameter value is different from the adapter's authentication key" do
+      before do
+        request_params["authentication_key"] = "invalid_key"
+      end
+      it "should return nil" do
+        adapter.authenticate(request_params).should be_nil
+      end
+      it "should not remove the key from the request params hash" do
+        adapter.authenticate(request_params)
+        request_params["authentication_key"].should_not be_nil
+      end
+    end
+  end
+
+  describe "#authentication_key" do
+    it "should set the authentication key" do
+      adapter.authentication_key = "my_secret_key"
+      adapter.authentication_key.should == "my_secret_key"
+    end
+  end
+
+  describe "#configuration" do
+    it "should set the configuration" do
+      adapter.configuration = {:config_key => "some config value"}
+      adapter.configuration.should == {:config_key => "some config value"}
+    end
+  end
+
+  describe "#use_ssl" do
+    it "it should use ssl" do
+      adapter.use_ssl = true
+      adapter.use_ssl.should == true
+    end
+  end
+end
+

data/spec/connection_adapters/sms_global_adapter_spec.rb

@@ -0,0 +1,259 @@
+require 'spec_helper'
+
+describe ActionSms::ConnectionAdapters::SMSGlobalAdapter do
+  let(:adapter) { ActionSms::ConnectionAdapters::SMSGlobalAdapter.new }
+
+  describe "#deliver" do
+    let(:sms) { mock("sms").as_null_object }
+    before do
+      adapter.stub!(:send_http_request)
+    end
+
+    it "should try to send the sms to the correct url" do
+      adapter.should_receive(:send_http_request).with(
+        "http://smsglobal.com.au/http-api.php",
+        anything
+      )
+      adapter.deliver(sms)
+    end
+
+    it "should try to send the sms with the correct 'action' value" do
+      adapter.should_receive(:send_http_request).with(
+        anything,
+        hash_including(:action => "sendsms")
+      )
+      adapter.deliver(sms)
+    end
+
+    it "should try to send the sms with the 'user' configuration value" do
+      adapter.should_receive(:send_http_request).with(
+        anything,
+        hash_including(:user)
+      )
+      adapter.deliver(sms)
+    end
+
+    it "should try to send the sms with the 'password' configuration value" do
+      adapter.should_receive(:send_http_request).with(
+        anything,
+        hash_including(:password)
+      )
+      adapter.deliver(sms)
+    end
+
+    it "should try to send the sms with the correct 'maxsplit' value" do
+      adapter.should_receive(:send_http_request).with(
+        anything,
+        hash_including(:maxsplit => "19")
+      )
+      adapter.deliver(sms)
+    end
+
+    context "sms' responds to '#from'" do
+      before do
+        sms.stub!(:from).and_return("anybody")
+      end
+      it "should try to send the sms with the result from 'sms#from'" do
+        adapter.should_receive(:send_http_request).with(
+          anything,
+          hash_including(:from => "anybody")
+        )
+        adapter.deliver(sms)
+      end
+    end
+
+    context "sms does not respond to '#from'" do
+      before do
+        sms.stub!(:respond_to?).and_return(false)
+      end
+      it "should try to send the sms with 'from' set to 'reply2email'" do
+        adapter.should_receive(:send_http_request).with(
+          anything,
+          hash_including(:from => "reply2email")
+        )
+        adapter.deliver(sms)
+      end
+    end
+
+    it "should try to send the sms with the result from 'sms#recipient'" do
+      adapter.should_receive(:send_http_request).with(
+        anything,
+        hash_including(:to)
+      )
+      adapter.deliver(sms)
+    end
+
+    context "sms#body is not nil" do
+      it "should try to send the sms with the sms' body" do
+        adapter.should_receive(:send_http_request).with(
+          anything,
+          hash_including(:text)
+        )
+        adapter.deliver(sms)
+      end
+    end
+
+    context "sms#body is nil" do
+      before do
+        sms.stub!(:body).and_return(nil)
+      end
+
+      it "should try to send the sms with blank text" do
+        adapter.should_receive(:send_http_request).with(
+          anything,
+          hash_including(:text => "")
+        )
+        adapter.deliver(sms)
+      end
+    end
+
+    context "sms responds to #userfield" do
+      it "should try to send the sms with the result from 'sms#userfield'" do
+        adapter.should_receive(:send_http_request).with(
+          anything,
+          hash_including(:userfield)
+        )
+        adapter.deliver(sms)
+      end
+    end
+
+    context "sms does not respond to #userfield" do
+      before do
+        sms.stub!(:respond_to?).and_return(false)
+      end
+      it "should try to send the sms with the 'userfield' parameter" do
+        adapter.should_receive(:send_http_request).with(
+          anything,
+          hash_not_including(:userfield)
+        )
+        adapter.deliver(sms)
+      end
+    end
+  end
+
+  describe "#delivery_request_successful?" do
+    context "the gateway response was successful" do
+      let (:delivery_response) {
+        "OK: 0; Sent queued message ID: 86b1a945370734f4 SMSGlobalMsgID: 6942744494999745"
+      }
+      it "should not return nil" do
+        adapter.delivery_request_successful?(delivery_response).should_not be_nil
+      end
+    end
+    context "the gateway response was not successful" do
+      let (:delivery_response) { "ERROR: No action requested" }
+      it "should return nil" do
+        adapter.delivery_request_successful?(delivery_response).should be_nil
+      end
+    end
+  end
+
+  describe "#message_id" do
+    context "argument is a String" do
+      context "and includes an SMSGlobal message id" do
+        it "should return the message id with an SMSGlobal prefix" do
+          adapter.message_id("Blah blah blah SMSGlobalMsgID:  123556blah").should == "SMSGlobalMsgID:123556"
+        end
+      end
+      context "but does not include an SMSGlobal message id" do
+        it "should return nil" do
+          adapter.message_id("Blah blah blah SMSGlobalMsID:  123556blah").should be_nil
+        end
+      end
+    end
+    context "argument is a Hash" do
+      context "that includes an SMSGlobal message id" do
+        it "should return the message id with the SMSGlobal prefix" do
+          adapter.message_id(
+            {
+              "msgid" => "12345"
+            }
+          ).should == "SMSGlobalMsgID:12345"
+        end
+      end
+      context "that does not include an SMSGlobal message id" do
+        it "should return nil" do
+          adapter.message_id(
+            {
+              "something" => "12345"
+            }
+          ).should be_nil
+        end
+      end
+    end
+  end
+
+  describe "#message_text" do
+    let (:request_params) { {} }
+    context "given valid incoming message request params" do
+      before do
+        request_params["msg"] = "ANYTHING"
+      end
+      it "should return the message" do
+        adapter.message_text(request_params).should_not be_nil
+      end
+    end
+    context "given invalid incoming message request params" do
+      it "should return nil" do
+        adapter.message_text(request_params).should be_nil
+      end
+    end
+  end
+
+  describe "#sender" do
+    let (:request_params) { {} }
+    context "given valid incoming message request params" do
+      before do
+        request_params["from"] = "ANYTHING"
+      end
+      it "should return the message" do
+        adapter.sender(request_params).should_not be_nil
+      end
+    end
+    context "given invalid incoming message request params" do
+      it "should return nil" do
+        adapter.sender(request_params).should be_nil
+      end
+    end
+  end
+
+  describe "#service_url" do
+    it "should be the SMS Global service url" do
+      adapter.service_url.should == "http://smsglobal.com.au/http-api.php"
+    end
+    context "#use_ssl=false" do
+      before do
+        adapter.use_ssl = false
+      end
+      it "should be 'http'" do
+        URI.parse(adapter.service_url).scheme.should == "http"
+      end
+    end
+    context "#use_ssl=true" do
+      before do
+        adapter.use_ssl = true
+      end
+      it "should be 'https'" do
+        URI.parse(adapter.service_url).scheme.should == "https"
+      end
+    end
+  end
+
+  describe "#status" do
+    let (:delivery_receipt) { {} }
+    context "given a valid delivery receipt" do
+      before do
+        delivery_receipt["dlrstatus"] = "ANYTHING"
+      end
+      it "should return the delivery status" do
+        adapter.status(delivery_receipt).should_not be_nil
+      end
+    end
+    context "given a invalid delivery receipt" do
+      it "should return nil" do
+        adapter.status(delivery_receipt).should be_nil
+      end
+    end
+  end
+end
+

data/spec/connection_adapters/test_helpers/sms_global_spec.rb

@@ -0,0 +1,204 @@
+require 'spec_helper'
+
+describe ActionSms::ConnectionAdapters::SMSGlobalAdapter do
+  let (:adapter_name) { "sms_global" }
+  context "is not in test mode" do
+    let(:adapter) {
+      ActionSms::Base.sms_global_connection(
+        :adapter => adapter_name
+      )
+    }
+
+    it "should not respond to #sample_configuration" do
+      adapter.should_not be_respond_to(:sample_configuration)
+    end
+
+    it "should not respond to #sample_delivery_receipt" do
+      adapter.should_not be_respond_to(:sample_delivery_receipt)
+    end
+
+    it "should not respond to #sample_delivery_response" do
+      adapter.should_not be_respond_to(:sample_delivery_response)
+    end
+
+    it "should not respond to #sample_delivery_response_with_message_id" do
+      adapter.should_not be_respond_to(:sample_delivery_response_with_message_id)
+    end
+
+    it "should not respond to #sample_incoming_sms" do
+      adapter.should_not be_respond_to(:sample_incoming_sms)
+    end
+
+    it "should not respond to #sample_message_id" do
+      adapter.should_not be_respond_to(:sample_message_id)
+    end
+  end
+
+  context "is in test mode" do
+    let(:adapter) {
+      ActionSms::Base.sms_global_connection(
+        :adapter => adapter_name,
+        :environment => "test"
+      )
+    }
+
+    # Additional methods available in test mode
+
+    describe "#sample_configuration" do
+      it "should contain SMSGlobal specific configuration" do
+        adapter.sample_configuration.should include(
+          :user, :password
+        )
+      end
+      it "should contain the correct adapter name" do
+        adapter.sample_configuration.should include(
+          :adapter => "sms_global"
+        )
+      end
+      context "with options" do
+        context "authentication_key => true" do
+          it "should contain an authentication key" do
+            adapter.sample_configuration(
+              :authentication_key => true
+            ).should include(:authentication_key)
+          end
+        end
+      end
+    end
+
+    describe "#sample_delivery_receipt" do
+      context "with no options" do
+        it "should return the default values" do
+          adapter.sample_delivery_receipt.should include(
+            "msgid", "dlrstatus", "dlr_err", "donedate"
+          )
+        end
+      end
+      context "with options" do
+        context "'message_id'" do
+          it "should include the option" do
+            adapter.sample_delivery_receipt(
+              :message_id => "SMSGlobalMsgID:12345"
+            ).should include("msgid" => "12345")
+          end
+        end
+        context "'status'" do
+          it "should include the option" do
+            adapter.sample_delivery_receipt(
+              :status => "no good"
+            ).should include("dlrstatus" => "no good")
+          end
+        end
+        context "'error'" do
+          it "should include the option" do
+            adapter.sample_delivery_receipt(
+              :error => "some error"
+            ).should include("dlr_err" => "some error")
+          end
+        end
+        context "'date'" do
+          it "should include the option" do
+            adapter.sample_delivery_receipt(
+              :date => "today"
+            ).should include("donedate" => "today")
+          end
+        end
+      end
+    end
+
+    describe "#sample_delivery_response" do
+      context "with no options" do
+        it "should return a successful delivery response" do
+          adapter.sample_delivery_response.should == "OK: 0; Sent queued message ID: 86b1a945370734f4 SMSGlobalMsgID:6942744494999745"
+        end
+      end
+      context "with options" do
+        context ":failed => true" do
+          it "should return a failed delivery response" do
+            adapter.sample_delivery_response(:failed => true).should == "ERROR: No action requested"
+          end
+        end
+        context "'message_id' => 'anything'" do
+          it "should include the option" do
+            adapter.sample_delivery_response(:message_id => "12345").should =~ /SMSGlobalMsgID:12345/
+          end
+        end
+      end
+    end
+
+    describe "#sample_delivery_response_with_message_id" do
+      it "should call sample_delivery_response with the message id" do
+        options = {:my_option => "some option"}
+        adapter.should_receive(:sample_message_id).with(
+          hash_including(:message_id => "12345")
+        )
+        adapter.sample_delivery_response_with_message_id(
+          "12345", options
+        )
+      end
+    end
+
+    describe "#sample_incoming_sms" do
+      context "with no options" do
+        it "should return the default values" do
+          adapter.sample_incoming_sms.should include(
+            "msg", "to", "from", "date"
+          )
+        end
+      end
+      context "with options" do
+        context "'authentic'" do
+          it "should include an authentication key" do
+            adapter.sample_incoming_sms(:authentic => true).should include(
+              "authentication_key"
+            )
+          end
+        end
+        context "'message'" do
+          it "should include the option" do
+            adapter.sample_incoming_sms(:message => "hello").should include(
+              "msg" => "hello"
+            )
+          end
+        end
+        context "'to'" do
+          it "should include the option" do
+            adapter.sample_incoming_sms(:to => "someone").should include(
+              "to" => "someone"
+            )
+          end
+        end
+        context "'from'" do
+          it "should include the option" do
+            adapter.sample_incoming_sms(:from => "anyone").should include(
+              "from" => "anyone"
+            )
+          end
+        end
+        context "'date'" do
+          it "should include the option" do
+            adapter.sample_incoming_sms(:date => "today").should include(
+              "date" => "today"
+            )
+          end
+        end
+      end
+    end
+
+    describe "#sample_message_id" do
+      context "with no options" do
+        it "should return a default message id" do
+          adapter.sample_message_id.should == "SMSGlobalMsgID:6942744494999745"
+        end
+      end
+      context "with options" do
+        context "'message_id'" do
+          it "should include the option" do
+            adapter.sample_message_id(:message_id => "12345").should == "SMSGlobalMsgID:12345"
+          end
+        end
+      end
+    end
+  end
+end
+