channeladvisor 0.1.0

data/spec/lib/channeladvisor/order_status_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+module ChannelAdvisor
+  describe OrderStatus do
+  	describe ".new" do
+  		before(:each) do
+        @attrs = {
+		      :checkout_status => "Completed",
+	        :checkout_date_gmt => DateTime.new(2012,05,17),
+	        :payment_status => "Cleared",
+	        :payment_date_gmt => DateTime.new(2012,05,17),
+	        :shipping_status => "Shipped",
+	        :shipping_date_gmt => DateTime.new(2012,05,21),
+	        :order_refund_status => "NoRefunds"
+      	}
+      	@order_status = OrderStatus.new(@attrs)
+  		end
+
+  	  it "sets @checkout to an array of status and date" do
+  	    @order_status.checkout.should == [@attrs[:checkout_status], @attrs[:checkout_date_gmt]]
+  	  end
+
+  	  it "sets @payment to an array of status and date" do
+  	    @order_status.payment.should == [@attrs[:payment], @attrs[:payment_date_gmt]]
+  	  end
+
+  	  it "sets @shipping to an array of status and date" do
+  	    @order_status.shipping.should == [@attrs[:shipping], @attrs[:shipping_date_gmt]]
+  	  end
+
+  	  it "sets @refund to the refund status" do
+  	    @order_status.refund.should == @attrs[:order_refund_status]
+  	  end
+  	end
+  end
+end

data/spec/lib/channeladvisor/payment_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module ChannelAdvisor
+	describe Payment do
+		describe ".new" do
+			before(:each) do
+        @attrs = {
+          :payment_type => "Credit Card",
+          :credit_card_last4 => "1234",
+          :pay_pal_id => "ABCDEFG123456",
+          :merchant_reference_number => "99999",
+          :payment_transaction_id => "XYZ999999999"
+        }
+        @payment = Payment.new(@attrs)
+			end
+
+		  it "sets @type" do
+		    @payment.type.should == @attrs[:payment_type]
+		  end
+
+		  it "sets @credit_card_last4" do
+		    @payment.credit_card_number.should == @attrs[:credit_card_last4]
+		  end
+
+		  it "sets @paypal_id" do
+		    @payment.paypal_id.should == @attrs[:pay_pal_id]
+		  end
+
+		  it "sets @merchant_reference_number" do
+		    @payment.merchant_reference_number.should == @attrs[:merchant_reference_number]
+		  end
+
+		  it "sets @payment_transaction_id" do
+		    @payment.transaction_id.should == @attrs[:payment_transaction_id]
+		  end
+		end
+	end
+end

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

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+module ChannelAdvisor
+  module Services
+    describe AdminService do
+      subject { AdminService }
+      let(:local_id) { sensitive_data["local_ids"].first }
+
+      describe "#ping" do
+        context "when successful" do
+          use_vcr_cassette "responses/admin_service/ping/success"
+          before(:each) { AdminService.ping }
+
+          its(:last_request)  { should match_valid_xml_body_for :ping }
+          its(:last_request)  { should be_an HTTPI::Request }
+          its(:last_response) { should be_a Savon::SOAP::Response }
+        end
+
+        context "when unsuccessful" do
+          use_vcr_cassette "responses/admin_service/ping/failure"
+          before(:each) do
+            ChannelAdvisor.configure { |config| config.password = "wrong password" }
+          end
+
+          it "should raise a SOAP Fault error" do
+            expect { AdminService.ping }.to raise_error Savon::SOAP::Fault
+          end
+        end
+      end # ping
+        
+      describe "#request_access" do
+        context "when successful" do
+          use_vcr_cassette "responses/admin_service/request_access/success"
+          before(:each) { AdminService.request_access(local_id) }
+
+          its(:last_request)  { should match_valid_xml_body_for :request_access }
+          its(:last_request)  { should be_an HTTPI::Request }
+          its(:last_response) { should be_a Savon::SOAP::Response }
+        end
+      end # request_access
+
+      describe "#get_authorization_list" do
+        context "without Local ID" do
+          use_vcr_cassette "responses/admin_service/get_authorization_list/without_local_id/success"
+          before(:each) { AdminService.get_authorization_list }
+
+          its(:last_request)  { should match_valid_xml_body_for :get_authorization_list }
+          its(:last_request)  { should be_an HTTPI::Request }
+          its(:last_response) { should be_a Savon::SOAP::Response }
+        end
+
+        context "with Local ID" do
+          context "when successful" do
+            use_vcr_cassette "responses/admin_service/get_authorization_list/with_local_id/success"
+            before(:each) { AdminService.get_authorization_list(local_id) }
+
+            its(:last_request)  { should match_valid_xml_body_for :get_authorization_list_with_local_id }
+            its(:last_request)  { should be_an HTTPI::Request }
+            its(:last_response) { should be_a Savon::SOAP::Response }
+          end
+        end
+      end # get_authorization_list
+    end # AdminService
+  end # Services
+end # ChannelAdvisor

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

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+module ChannelAdvisor
+  module Services
+    describe BaseService do
+      subject { BaseService }
+      its(:last_request)  { should be_nil }
+      its(:last_response) { should be_nil }
+    end
+  end
+end

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

@@ -0,0 +1,214 @@
+require 'spec_helper'
+
+module ChannelAdvisor
+  module Services
+    describe InventoryService do
+      describe ".ping" do
+        use_vcr_cassette "responses/inventory_service/ping", :allow_playback_repeats => true
+
+        before(:each) do
+          @last_request, @last_response = nil
+
+          InventoryService.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
+          InventoryService.ping
+          @last_request.should match_valid_xml_body_for :ping
+        end
+
+        it "returns a SOAP response" do
+          soap_response = InventoryService.ping
+          soap_response.should be_a Savon::SOAP::Response
+        end
+      end # .ping
+
+      describe ".update_inventory_item_quantity_and_price" do
+        use_vcr_cassette "responses/inventory_service/update_inventory_item_quantity_and_price", :allow_playback_repeats => true
+
+        let(:quantity_info) do
+          {
+            :update_type  => "Absolute",
+            :total        => 5000
+          }
+        end
+
+        let(:price_info) do
+          {
+            :cost                       => 2.99,
+            :retail_price               => 11.99,
+            :starting_price             => 5.99,
+            :reserve_price              => 7.99,
+            :take_it_price              => 9.99,
+            :second_chance_offer_price  => 8.99,
+            :store_price                => 9.49
+          }
+        end
+
+        before(:each) do
+          @last_request, @last_response = nil
+
+          InventoryService.client.config.hooks.define(:update_inventory_item_quantity_and_price, :soap_request) do |callback, request|
+            @last_request = request.http
+            @last_response = callback.call
+          end
+        end
+
+        it "returns a SOAP response" do
+          soap_response = InventoryService.update_inventory_item_quantity_and_price("FAKE001", :quantity_info => quantity_info, :price_info => price_info)
+          soap_response.should be_a Savon::SOAP::Response
+        end # returns a SOAP response
+
+        context "with only quantity info" do
+          use_vcr_cassette "responses/inventory_service/update_inventory_item_quantity_and_price/quantity_only"
+
+          it "sends a valid SOAP request with only quantity info" do
+            InventoryService.update_inventory_item_quantity_and_price("FAKE001", :quantity_info => quantity_info)
+            @last_request.should match_valid_xml_body_for :update_item_quantity
+          end
+        end # with only quantity info
+
+        context "with only price info" do
+          use_vcr_cassette "responses/inventory_service/update_inventory_item_quantity_and_price/price_only"
+
+          it "sends a valid SOAP request with only price info" do
+            InventoryService.update_inventory_item_quantity_and_price("FAKE001", :price_info => price_info)
+            @last_request.should match_valid_xml_body_for :update_item_price
+          end
+        end # with only price info
+
+        context "with both quantity and price info" do
+          use_vcr_cassette "responses/inventory_service/update_inventory_item_quantity_and_price/quantity_and_price"
+
+          it "sends a valid SOAP request with both quantity and price info" do
+            InventoryService.update_inventory_item_quantity_and_price("FAKE001", :quantity_info => quantity_info, :price_info => price_info)
+            @last_request.should match_valid_xml_body_for :update_item_quantity_and_price
+          end
+        end # with both quantity and price info
+      end # .update_inventory_item_quantity_and_price
+
+      describe ".update_inventory_item_quantity_and_price_list" do
+        use_vcr_cassette "responses/inventory_service/update_inventory_item_quantity_and_price_list", :allow_playback_repeats => true
+
+        let(:item1) do
+          {
+            :sku => "FAKE001",
+            :quantity_info => {
+              :update_type  => "Absolute",
+              :total        => 5000
+            },
+            :price_info => {
+              :cost                       => 2.99,
+              :retail_price               => 11.99,
+              :starting_price             => 5.99,
+              :reserve_price              => 7.99,
+              :take_it_price              => 9.99,
+              :second_chance_offer_price  => 8.99,
+              :store_price                => 9.49
+            }
+          }
+        end
+
+        let(:item2) do
+          {
+            :sku => "FAKE002",
+            :quantity_info => {
+              :update_type  => "Absolute",
+              :total        => 7500
+            },
+            :price_info => {
+              :cost                       => 3.99,
+              :retail_price               => 10.99,
+              :starting_price             => 4.99,
+              :reserve_price              => 7.99,
+              :take_it_price              => 8.99,
+              :second_chance_offer_price  => 6.99,
+              :store_price                => 8.49
+            }
+          }
+        end
+
+        before(:each) do
+          @last_request, @last_response = nil
+
+          InventoryService.client.config.hooks.define(:update_inventory_item_quantity_and_price_list, :soap_request) do |callback, request|
+            @last_request = request.http
+            @last_response = callback.call
+          end
+        end
+
+        it "returns a SOAP response" do
+          soap_response = InventoryService.update_inventory_item_quantity_and_price_list([item1])
+          soap_response.should be_a Savon::SOAP::Response
+        end # returns a SOAP response
+
+        context "with one item" do
+          context "with only quantity info" do
+            use_vcr_cassette "responses/inventory_service/update_inventory_item_quantity_and_price_list/with_one_item/quantity_only"
+
+            it "sends a valid SOAP request with only quantity info" do
+              item1.delete(:price_info)
+              InventoryService.update_inventory_item_quantity_and_price_list([item1])
+              @last_request.should match_valid_xml_body_for "update_inventory_item_quantity_and_price_list/with_one_item/quantity_only"
+            end
+          end # with only quantity info
+
+          context "with only price info" do
+            use_vcr_cassette "responses/inventory_service/update_inventory_item_quantity_and_price_list/with_one_item/price_only"
+
+            it "sends a valid SOAP request with only price info" do
+              item1.delete(:quantity_info)
+              InventoryService.update_inventory_item_quantity_and_price_list([item1])
+              @last_request.should match_valid_xml_body_for "update_inventory_item_quantity_and_price_list/with_one_item/price_only"
+            end
+          end # with only price info
+
+          context "with both quantity and price info" do
+            use_vcr_cassette "responses/inventory_service/update_inventory_item_quantity_and_price_list/with_one_item/quantity_and_price"
+
+            it "sends a valid SOAP request with both quantity and price info" do
+              InventoryService.update_inventory_item_quantity_and_price_list([item1])
+              @last_request.should match_valid_xml_body_for "update_inventory_item_quantity_and_price_list/with_one_item/quantity_and_price"
+            end
+          end # with both quantity and price info
+        end # with one item
+
+        context "with two items" do
+          context "with only quantity info" do
+            use_vcr_cassette "responses/inventory_service/update_inventory_item_quantity_and_price_list/with_two_items/quantity_only"
+
+            it "sends a valid SOAP request with only quantity info" do
+              item1.delete(:price_info)
+              item2.delete(:price_info)
+              InventoryService.update_inventory_item_quantity_and_price_list([item1, item2])
+              @last_request.should match_valid_xml_body_for "update_inventory_item_quantity_and_price_list/with_two_items/quantity_only"
+            end
+          end # with only quantity info
+
+          context "with only price info" do
+            use_vcr_cassette "responses/inventory_service/update_inventory_item_quantity_and_price_list/with_two_items/price_only"
+
+            it "sends a valid SOAP request with only price info" do
+              item1.delete(:quantity_info)
+              item2.delete(:quantity_info)
+              InventoryService.update_inventory_item_quantity_and_price_list([item1, item2])
+              @last_request.should match_valid_xml_body_for "update_inventory_item_quantity_and_price_list/with_two_items/price_only"
+            end
+          end # with only price info
+
+          context "with both quantity and price info" do
+            use_vcr_cassette "responses/inventory_service/update_inventory_item_quantity_and_price_list/with_two_items/quantity_and_price"
+
+            it "sends a valid SOAP request with both quantity and price info" do
+              InventoryService.update_inventory_item_quantity_and_price_list([item1, item2])
+              @last_request.should match_valid_xml_body_for "update_inventory_item_quantity_and_price_list/with_two_items/quantity_and_price"
+            end
+          end # with both quantity and price info
+        end # with two items
+      end # .update_inventory_item_quantity_and_price_list
+    end # InventoryService
+  end # Services
+end # ChannelAdvisor

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

@@ -0,0 +1,267 @@
+require 'spec_helper'
+
+module ChannelAdvisor
+	module Services
+		describe OrderService do
+			subject { OrderService }
+			
+			describe "#ping" do
+				context "when successful" do
+					use_vcr_cassette "responses/order_service/ping/success"
+					before(:each) { OrderService.ping }
+
+	        its(:last_request)  { should match_valid_xml_body_for :ping }
+	        its(:last_request)  { should be_an HTTPI::Request }
+	        its(:last_response) { should be_a Savon::SOAP::Response }
+				end
+
+				context "when unsuccessful" do
+					use_vcr_cassette "responses/order_service/ping/failure"
+
+					it "should raise a SOAP Fault error" do
+						ChannelAdvisor.configure { |config| config.password = "wrong password" }
+						expect { OrderService.ping }.to raise_error Savon::SOAP::Fault
+					end
+				end
+			end # ping
+
+			describe "#get_order_list" do
+				context "without order criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/without_order_criteria"
+					before(:each) { OrderService.get_order_list }
+
+	        its(:last_request)  { should be_an HTTPI::Request }
+	        its(:last_response) { should be_a Savon::SOAP::Response }
+				
+					it "sends a valid SOAP request with no order criteria" do
+						OrderService.last_request.should match_valid_xml_body_for 'get_order_list/without_order_criteria'
+					end
+				end
+
+				context "with created from date criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_created_from_date"
+
+				  it "sends a valid SOAP request with the created from date" do
+				  	order_criteria = {:created_from => DateTime.new(2012,05,14)}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_created_from_date'
+				  end
+				end
+
+				context "with created to date criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_created_to_date"
+
+				  it "sends a valid SOAP request with the created to date" do
+				  	order_criteria = {:created_to => DateTime.new(2012,05,15)}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_created_to_date'
+				  end
+				end
+
+				context "with updated from date criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_updated_from_date"
+
+					it "sends a valid SOAP request with the updated from date" do
+					  order_criteria = {:updated_from => DateTime.new(2012,05,14)}
+					  OrderService.get_order_list(order_criteria)
+						OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_updated_from_date'				  
+					end
+				end
+
+				context "with updated to date criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_updated_to_date"
+
+					it "sends a valid SOAP request with the updated to date" do
+					  order_criteria = {:updated_to => DateTime.new(2012,05,15)}
+					  OrderService.get_order_list(order_criteria)
+						OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_updated_to_date'				  
+					end
+				end
+
+				context "with join dates criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_join dates"
+				  
+				  it "sends a valid SOAP request with the join dates" do
+				  	order_criteria = {
+				  		:created_from => DateTime.new(2012,05,14),
+				  		:created_to => DateTime.new(2012,05,15),
+				  		:updated_from => DateTime.new(2012,05,14),
+				  		:updated_to => DateTime.new(2012,05,15),
+				  		:join_dates => true
+				  	}
+				    
+				    OrderService.get_order_list(order_criteria)
+				    OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_join_dates'
+				  end
+				end
+
+				context "with detail level criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_detail_level"
+
+				  it "sends a valid SOAP request with a detail level" do
+				  	order_criteria = {:detail_level => "Low"}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_detail_level'
+				  end
+				end
+
+				context "with export state criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_export_state"
+
+				  it "sends a valid SOAP request with an export state" do
+				  	order_criteria = {:export_state => "NotExported"}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_export_state'
+				  end
+				end
+
+				context "with one Order ID" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_one_order_id"
+
+					it "sends a valid SOAP request with one Order ID" do
+						order_criteria = {:order_ids => [14162751]}
+						OrderService.get_order_list(order_criteria)
+						OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_one_order_id'
+					end
+				end
+
+				context "with two Order IDs" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_two_order_ids"
+
+					it "sends a valid SOAP request with two Order IDs" do
+						order_criteria = {:order_ids => [14162751, 14161613]}
+						OrderService.get_order_list(order_criteria)
+						OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_two_order_ids'
+					end
+				end
+
+				context "with one Client ID" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_one_client_order_id"
+
+					it "sends a valid SOAP request with one Client ID" do
+						order_criteria = {:client_order_ids => ['ABCD1234']}
+						OrderService.get_order_list(order_criteria)
+						OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_one_client_order_id'
+					end
+				end
+
+				context "with two Client IDs" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_two_client_order_ids"
+
+					it "sends a valid SOAP request with one Client ID" do
+						order_criteria = {:client_order_ids => ['ABCD1234', 'EFGH5678']}
+						OrderService.get_order_list(order_criteria)
+						OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_two_client_order_ids'
+					end
+				end
+
+				context "with order state criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_order_state_filter"
+
+				  it "sends a valid SOAP request with an order state" do
+				  	order_criteria = {:state => "Active"}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_order_state_filter'
+				  end
+				end
+
+				context "with payment status criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_payment_status_filter"
+
+				  it "sends a valid SOAP request with a payment status" do
+				  	order_criteria = {:payment_status => "NoChange"}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_payment_status_filter'
+				  end
+				end
+
+				context "with checkout status criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_checkout_status_filter"
+
+				  it "sends a valid SOAP request with an checkout status" do
+				  	order_criteria = {:checkout_status => "NoChange"}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_checkout_status_filter'
+				  end
+				end
+
+				context "with shipping status criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_shipping_status_filter"
+
+				  it "sends a valid SOAP request with a shipping status" do
+				  	order_criteria = {:shipping_status => "NoChange"}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_shipping_status_filter'
+				  end
+				end
+
+				context "with refund status criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_refund_status_filter"
+
+				  it "sends a valid SOAP request with an refund status" do
+				  	order_criteria = {:refund_status => "NoChange"}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_refund_status_filter'
+				  end
+				end
+
+				context "with distribution center criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_distribution_center_code"
+
+				  it "sends a valid SOAP request with a distribution center code" do
+				  	order_criteria = {:distribution_center => "ABC"}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_distribution_center_code'
+				  end
+				end
+
+				context "with page number criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_page_number_filter"
+
+				  it "sends a valid SOAP request with a page number" do
+				  	order_criteria = {:page_number => 1}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_page_number_filter'
+				  end
+				end
+
+				context "with page size criteria" do
+					use_vcr_cassette "responses/order_service/get_order_list/with_page_size"
+
+				  it "sends a valid SOAP request with a page size" do
+				  	order_criteria = {:page_size => 20}
+				  	OrderService.get_order_list(order_criteria)
+				  	OrderService.last_request.should match_valid_xml_body_for 'get_order_list/with_page_size'
+				  end
+				end
+			end # get_order_list
+
+			describe "#set_orders_export_status" do
+				context "with one Client Order ID" do
+					use_vcr_cassette "responses/order_service/set_orders_export_status/with_one_client_order_id"
+					before(:each) do
+				  	client_order_ids = ["ABCD1234"]
+				    OrderService.set_orders_export_status(client_order_ids, true)
+					end
+
+				  its(:last_request)  { should be_an HTTPI::Request }
+					its(:last_response) { should be_an Savon::SOAP::Response }
+
+				  it "sends a valid SOAP request with one Client Order ID" do
+				    OrderService.last_request.should match_valid_xml_body_for "set_orders_export_status/with_one_client_order_id"
+				  end
+				end
+
+				context "with two Client Order IDs" do
+					use_vcr_cassette "responses/order_service/set_orders_export_status/with_two_client_order_id"
+
+				  it "sends a valid SOAP request with two Client Order IDs" do
+				    client_order_ids = ["ABCD1234", "EFGH5678"]
+				    OrderService.set_orders_export_status(client_order_ids, true)
+				    OrderService.last_request.should match_valid_xml_body_for "set_orders_export_status/with_two_client_order_ids"
+				  end
+				end
+			end # set_orders_export_status
+		end # OrderService
+	end # Services
+end # ChannelAdvisor