channeladvisor 0.1.0

data/spec/lib/channeladvisor/services/shipping_service_spec.rb

@@ -0,0 +1,288 @@
+require 'spec_helper'
+require 'timecop'
+
+module ChannelAdvisor
+  module Services
+    describe ShippingService do
+      describe ".ping" do
+        use_vcr_cassette "responses/shipping_service/ping/success", :allow_playback_repeats => true
+
+        before(:each) do
+          @last_request, @last_response = nil
+
+          ShippingService.client.config.hooks.define(:ping, :soap_request) do |callback, request|
+            @last_request = request.http
+            @last_response = callback.call
+          end
+        end
+
+        it "sends a valid SOAP request" do
+          ShippingService.ping
+          @last_request.should match_valid_xml_body_for :ping
+        end
+
+        it "returns a SOAP response" do
+          soap_response = ShippingService.ping
+          soap_response.should be_a Savon::SOAP::Response
+        end
+      end # .ping
+
+      describe ".submit_order_shipment_list" do
+        use_vcr_cassette "responses/shipping_service/submit_order_shipment_list", :allow_playback_repeats => true
+
+        before(:each) do
+          @last_request, @last_response = nil
+
+          ShippingService.client.config.hooks.define(:submit_order_shipment_list, :soap_request) do |callback, request|
+            @last_request = request.http
+            @last_response = callback.call
+          end
+        end
+
+        context "with full shipments" do
+          let(:full_shipment) do
+            {
+              :order_id => 123456,
+              :client_order_id => "ABCD1234",
+              :type => "Full",
+              :date => DateTime.new(2012,05,19),
+              :carrier => "UPS",
+              :class => "GND",
+              :tracking_number => "1ZABCE09813473497",
+              :seller_id => "999999",
+              :cost => "5.99",
+              :tax => "1.99",
+              :insurance => "2.99"
+            }
+          end
+
+          it "returns a SOAP response" do
+            soap_response = ShippingService.submit_order_shipment_list([full_shipment])
+            soap_response.should be_a Savon::SOAP::Response
+          end
+
+          context "with one full shipment" do
+            it "sends a valid SOAP request with full shipment data" do
+              ShippingService.submit_order_shipment_list([full_shipment])
+              @last_request.should match_valid_xml_body_for "submit_order_shipment_list/full_shipment/with_one_shipment"
+            end
+
+            context "without a client order ID" do
+              it "sends a valid SOAP request without the client order ID" do
+                full_shipment.delete(:client_order_id)
+                ShippingService.submit_order_shipment_list([full_shipment])
+                @last_request.should match_valid_xml_body_for "submit_order_shipment_list/full_shipment/without_client_order_id"
+              end
+            end
+
+            context "without a carrier code" do
+              it "sends a valid SOAP request without the carrier code" do
+                full_shipment.delete(:carrier)
+                ShippingService.submit_order_shipment_list([full_shipment])
+                @last_request.should match_valid_xml_body_for "submit_order_shipment_list/full_shipment/without_carrier_code"
+              end
+            end
+
+            context "without a class code" do
+              it "sends a valid SOAP request without the class code" do
+                full_shipment.delete(:class)
+                ShippingService.submit_order_shipment_list([full_shipment])
+                @last_request.should match_valid_xml_body_for "submit_order_shipment_list/full_shipment/without_class_code"
+              end
+            end
+
+            context "without a tracking number" do
+              it "sends a valid SOAP request without the tracking number" do
+                full_shipment.delete(:tracking_number)
+                ShippingService.submit_order_shipment_list([full_shipment])
+                @last_request.should match_valid_xml_body_for "submit_order_shipment_list/full_shipment/without_tracking_number"
+              end
+            end
+
+            context "without a seller fulfillment ID" do
+              it "sends a valid SOAP request without the seller fulfillment ID" do
+                full_shipment.delete(:seller_id)
+                ShippingService.submit_order_shipment_list([full_shipment])
+                @last_request.should match_valid_xml_body_for "submit_order_shipment_list/full_shipment/without_seller_id"
+              end
+            end
+          end # with one full shipment
+
+          context "with two full shipments" do
+            it "sends a valid SOAP request with two full shipments" do
+              shipments = []
+              second_shipment = {
+                :order_id => 567890,
+                :client_order_id => "EFGH1234",
+                :type => "Full",
+                :date => DateTime.new(2012,05,21),
+                :carrier => "FEDEX",
+                :class => "GROUND",
+                :tracking_number => "1234567890",
+                :seller_id => "555555",
+                :cost => "7.50",
+                :tax => "1.50",
+                :insurance => "2.50"
+              }
+              shipments << full_shipment
+              shipments << second_shipment
+              ShippingService.submit_order_shipment_list(shipments)
+              @last_request.should match_valid_xml_body_for "submit_order_shipment_list/full_shipment/with_two_shipments"
+            end
+          end # with two full shipments
+        end # with full shipments
+
+        context "with partial shipments" do
+          let(:partial_shipment) do
+            {
+              :order_id => 123456,
+              :client_order_id => "ABCD1234",
+              :type => "Partial",
+              :line_items => [{:sku => "ABCD", :quantity => 5}],
+              :date => DateTime.new(2012,05,19),
+              :carrier => "UPS",
+              :class => "GND",
+              :tracking_number => "1ZABCE09813473497",
+              :seller_id => "999999",
+              :cost => "5.99",
+              :tax => "1.99",
+              :insurance => "2.99"
+            }
+          end
+
+          context "with one partial shipment" do
+            context "with one line item" do
+              it "sends a valid SOAP request with one line item" do
+                ShippingService.submit_order_shipment_list([partial_shipment])
+                @last_request.should match_valid_xml_body_for "submit_order_shipment_list/partial_shipment/with_one_line_item"
+              end
+
+              context "without a carrier code" do
+                it "sends a valid SOAP request without the carrier code" do
+                  partial_shipment.delete(:carrier)
+                  ShippingService.submit_order_shipment_list([partial_shipment])
+                  @last_request.should match_valid_xml_body_for "submit_order_shipment_list/partial_shipment/without_carrier_code"
+                end
+              end
+
+              context "without a class code" do
+                it "sends a valid SOAP request without the class code" do
+                  partial_shipment.delete(:class)
+                  ShippingService.submit_order_shipment_list([partial_shipment])
+                  @last_request.should match_valid_xml_body_for "submit_order_shipment_list/partial_shipment/without_class_code"
+                end
+              end
+
+              context "without a tracking number" do
+                it "sends a valid SOAP request without the tracking number" do
+                  partial_shipment.delete(:tracking_number)
+                  ShippingService.submit_order_shipment_list([partial_shipment])
+                  @last_request.should match_valid_xml_body_for "submit_order_shipment_list/partial_shipment/without_tracking_number"
+                end
+              end
+
+              context "without a seller fulfillment ID" do
+                it "sends a valid SOAP request without the seller fulfillment ID" do
+                  partial_shipment.delete(:seller_id)
+                  ShippingService.submit_order_shipment_list([partial_shipment])
+                  @last_request.should match_valid_xml_body_for "submit_order_shipment_list/partial_shipment/without_seller_id"
+                end
+              end
+            end
+
+            context "with two line items" do
+              it "sends a valid SOAP request with two line items" do
+                partial_shipment[:line_items] << {:sku => "EFGH", :quantity => 3}
+                ShippingService.submit_order_shipment_list([partial_shipment])
+                @last_request.should match_valid_xml_body_for "submit_order_shipment_list/partial_shipment/with_two_line_items"
+              end
+            end
+          end # with one partial shipment
+
+          context "with two partial shipments" do
+            it "sends a valid SOAP request with two partial shipments" do
+              shipments = []
+              second_shipment = {
+                :order_id => 567890,
+                :client_order_id => "EFGH1234",
+                :type => "Partial",
+                :line_items => [{:sku => "EFGH", :quantity => 3}],
+                :date => DateTime.new(2012,05,21),
+                :carrier => "FEDEX",
+                :class => "GROUND",
+                :tracking_number => "1234567890",
+                :seller_id => "555555",
+                :cost => "7.50",
+                :tax => "1.50",
+                :insurance => "2.50"
+              }
+              shipments << partial_shipment
+              shipments << second_shipment
+              ShippingService.submit_order_shipment_list(shipments)
+              @last_request.should match_valid_xml_body_for "submit_order_shipment_list/partial_shipment/with_two_shipments"
+            end
+          end # with two partial shipments
+        end # with partial shipments
+
+        context "with both partial and full shipments" do
+          it "sends a valid SOAP request with two partial shipments" do
+            shipments = []
+            full_shipment = {
+              :order_id => 123456,
+              :client_order_id => "ABCD1234",
+              :type => "Full",
+              :date => DateTime.new(2012,05,19),
+              :carrier => "UPS",
+              :class => "GND",
+              :tracking_number => "1ZABCE09813473497",
+              :seller_id => "999999",
+              :cost => "5.99",
+              :tax => "1.99",
+              :insurance => "2.99"
+            }
+            partial_shipment = {
+              :order_id => 567890,
+              :client_order_id => "EFGH1234",
+              :type => "Partial",
+              :line_items => [{:sku => "EFGH", :quantity => 3}],
+              :date => DateTime.new(2012,05,21),
+              :carrier => "FEDEX",
+              :class => "GROUND",
+              :tracking_number => "1234567890",
+              :seller_id => "555555",
+              :cost => "7.50",
+              :tax => "1.50",
+              :insurance => "2.50"
+            }
+            shipments << full_shipment
+            shipments << partial_shipment
+            ShippingService.submit_order_shipment_list(shipments)
+            @last_request.should match_valid_xml_body_for "submit_order_shipment_list/with_partial_and_full_shipments"
+          end
+        end # with both full and partial shipments
+      end # .submit_order_shipment_list
+
+      describe ".get_shipping_carrier_list" do
+        use_vcr_cassette "responses/shipping_service/get_shipping_carrier_list", :allow_playback_repeats => true
+        before(:each) do
+          @last_request, @last_response = nil
+
+          ShippingService.client.config.hooks.define(:get_shipping_carrier_list, :soap_request) do |callback, request|
+            @last_request = request.http
+            @last_response = callback.call
+          end
+        end
+
+        it "sends a valid SOAP request" do
+          ShippingService.get_shipping_carrier_list
+          @last_request.should match_valid_xml_body_for :get_shipping_carrier_list
+        end
+
+        it "returns a SOAP response" do
+          soap_response = ShippingService.get_shipping_carrier_list
+          soap_response.should be_a Savon::SOAP::Response
+        end
+      end # .get_shipping_carrier_list
+    end # ShippingService
+  end # Services
+end # ChannelAdvisor

data/spec/lib/channeladvisor/shipment_spec.rb

@@ -0,0 +1,257 @@
+require 'spec_helper'
+require 'timecop'
+
+module ChannelAdvisor
+  describe Shipment do
+    describe ".new" do
+      before(:each) do
+        @attrs = {
+          :shipping_carrier => "UPS",
+          :shipping_class => "GND",
+          :tracking_number => "1234567890"
+        }
+        @shipment = Shipment.new(@attrs)
+      end
+
+      it "sets @shipping_carrier" do
+        @shipment.shipping_carrier.should == @attrs[:shipping_carrier]
+      end
+
+      it "sets @shipping_class" do
+        @shipment.shipping_class.should == @attrs[:shipping_class]
+      end
+
+      it "sets @tracking_number" do
+        @shipment.tracking_number.should == @attrs[:tracking_number]
+      end
+    end # .new
+
+    describe ".submit" do
+      use_vcr_cassette "responses/shipment/submit", :allow_playback_repeats => true
+      before { stub.proxy(Services::ShippingService).submit_order_shipment_list }
+
+      let(:original_shipment) do
+        {
+          :order_id => 123456,
+          :client_order_id => "ABCD1234",
+          :date => DateTime.new(2012,05,19),
+          :carrier => "UPS",
+          :class => "GND",
+          :tracking_number => "1ZABCE09813473497",
+          :seller_id => "999999",
+          :cost => 5.99,
+          :tax => 1.99,
+          :insurance => 2.99
+        }
+      end
+
+      context "with one shipment" do
+        use_vcr_cassette "responses/shipment/submit/one_shipment"
+
+        let(:actual_shipment) { original_shipment.dup }
+        before do
+          actual_shipment[:type]       = "Full"
+          actual_shipment[:cost]       = "%.2f" % actual_shipment[:cost]
+          actual_shipment[:tax]        = "%.2f" % actual_shipment[:tax]
+          actual_shipment[:insurance]  = "%.2f" % actual_shipment[:insurance]
+        end
+
+        it "sends one shipment to the shipping service" do
+          Shipment.submit(original_shipment)
+          Services::ShippingService.should have_received.submit_order_shipment_list([actual_shipment])
+        end
+
+        it "returns a boolean result" do
+          response = Shipment.submit(original_shipment)
+          response.should be_a_boolean
+        end
+
+        context "without a ship date" do
+          it "sends a shipment with the current date" do
+            original_shipment.delete(:date)
+            ::Timecop.freeze(DateTime.now) do
+              actual_shipment[:date] = DateTime.now
+              Shipment.submit(original_shipment)
+              Services::ShippingService.should have_received.submit_order_shipment_list([actual_shipment])
+            end
+          end
+        end
+
+        context "without a ship cost" do
+          it "sends a shipment with a shipping cost of 0.00" do
+            original_shipment.delete(:cost)
+            actual_shipment[:cost] = "0.00"
+            Shipment.submit(original_shipment)
+            Services::ShippingService.should have_received.submit_order_shipment_list([actual_shipment])
+          end
+        end
+
+        context "without a tax cost" do
+          it "sends a shipment with a tax cost of 0.00" do
+            original_shipment.delete(:tax)
+            actual_shipment[:tax] = "0.00"
+            Shipment.submit(original_shipment)
+            Services::ShippingService.should have_received.submit_order_shipment_list([actual_shipment])
+          end
+        end
+
+        context "without an insurance cost" do
+          it "sends a shipment with an insurance cost of 0.00" do
+            original_shipment.delete(:insurance)
+            actual_shipment[:insurance] = "0.00"
+            Shipment.submit(original_shipment)
+            Services::ShippingService.should have_received.submit_order_shipment_list([actual_shipment])
+          end
+        end
+
+        context "with line items" do
+          it "sends a partial shipment" do
+            actual_shipment[:line_items] = original_shipment[:line_items] = [{:sku => "ABCD", :quantity => 5}]
+            actual_shipment[:type] = "Partial"
+            Shipment.submit(original_shipment)
+            Services::ShippingService.should have_received.submit_order_shipment_list([actual_shipment])
+          end
+        end
+      end # with one shipment
+
+      context "with two shipments" do
+        use_vcr_cassette "responses/shipment/submit/two_shipments", :allow_playback_repeats => true
+
+        let(:shipment1) { original_shipment.dup }
+        let(:shipment2) do
+          {
+            :order_id => 567890,
+            :client_order_id => "EFGH1234",
+            :date => DateTime.new(2012,05,19),
+            :carrier => "USPS",
+            :class => "PRIORITY",
+            :tracking_number => "99999000000000",
+            :seller_id => "555555",
+            :cost => 5.99,
+            :tax => 1.99,
+            :insurance => 2.99
+          }
+        end
+        let(:shipments) { [shipment1, shipment2] }
+
+        it "sends two shipments to the shipping service" do
+          Shipment.submit(shipments)
+          Services::ShippingService.should have_received.submit_order_shipment_list(shipments)
+        end
+
+        it "returns hash of boolean results" do
+          results = Shipment.submit(shipments)
+          shipments.map { |shipment| shipment[:order_id].to_s }.each do |order_id|
+            results[order_id].should be_a_boolean
+          end
+        end
+      end # with two shipments
+
+      context "with a Failure status" do
+        use_vcr_cassette "responses/shipment/submit/failure", :allow_playback_repeats => true
+
+        it "raises a ServiceFailure error" do
+          expect { Shipment.submit(original_shipment) }.to raise_error ServiceFailure
+        end
+      end
+
+      context "with a SOAP fault" do
+        use_vcr_cassette "responses/soap_fault", :match_requests_on => [:method], :allow_playback_repeats => true
+
+        it "raises a SOAP fault error" do
+          expect { Shipment.submit(original_shipment) }.to raise_error SOAPFault, "Server was unable to process request. Authentication failed."
+        end
+
+        it "stores the SOAP fault code" do
+          begin
+            Shipment.submit(original_shipment)
+          rescue SOAPFault => fault
+            fault.code.should == "soap:Server"
+          end
+        end
+      end # with a SOAP Fault
+
+      context "with an HTTP error" do
+        http_status = {:code => 500, :message => "Internal Server Error"}
+        use_vcr_cassette "responses/http_error", :match_requests_on => [:method], :erb => http_status, :allow_playback_repeats => true
+
+        it "raises an HTTP error" do
+          expect { Shipment.submit(original_shipment) }.to raise_error HTTPError, "Failed with HTTP error #{http_status[:code]}"
+        end
+
+        it "stores the HTTP status code" do
+          begin
+            Shipment.submit(original_shipment)
+          rescue HTTPError => error
+            error.code.should == http_status[:code]
+          end
+        end
+      end # with an HTTP error
+    end # .submit
+
+    describe ".get_carriers" do
+      use_vcr_cassette "responses/shipment/get_carriers", :allow_playback_repeats => true
+
+      it "calls the get_shipping_carrier_list" do
+        stub.proxy(Services::ShippingService).get_shipping_carrier_list
+        Shipment.get_carriers
+        Services::ShippingService.should have_received.get_shipping_carrier_list
+      end
+
+      it "returns an array of shipping carrier hashes" do
+        results = Shipment.get_carriers
+        results.each do |carrier_data|
+          carrier_data.should include(
+            :carrier_id,
+            :class_id,
+            :carrier_name,
+            :carrier_code,
+            :class_code,
+            :class_name
+          )
+        end
+      end
+
+      context "with a Failure status" do
+        use_vcr_cassette "responses/shipment/get_carriers/failure", :allow_playback_repeats => true
+
+        it "raises a ServiceFailure error" do
+          expect { Shipment.get_carriers }.to raise_error ServiceFailure
+        end
+      end
+
+      context "with a SOAP fault" do
+        use_vcr_cassette "responses/soap_fault", :match_requests_on => [:method], :allow_playback_repeats => true
+
+        it "raises a SOAP fault error" do
+          expect { Shipment.get_carriers }.to raise_error SOAPFault, "Server was unable to process request. Authentication failed."
+        end
+
+        it "stores the SOAP fault code" do
+          begin
+            Shipment.get_carriers
+          rescue SOAPFault => fault
+            fault.code.should == "soap:Server"
+          end
+        end
+      end # with a SOAP Fault
+
+      context "with an HTTP error" do
+        http_status = {:code => 500, :message => "Internal Server Error"}
+        use_vcr_cassette "responses/http_error", :match_requests_on => [:method], :erb => http_status, :allow_playback_repeats => true
+
+        it "raises an HTTP error" do
+          expect { Shipment.get_carriers }.to raise_error HTTPError, "Failed with HTTP error #{http_status[:code]}"
+        end
+
+        it "stores the HTTP status code" do
+          begin
+            Shipment.get_carriers
+          rescue HTTPError => error
+            error.code.should == http_status[:code]
+          end
+        end
+      end # with an HTTP error
+    end # .get_carriers
+  end # Shipment
+end # ChannelAdvisor