channeladvisor 0.1.0

data/spec/fixtures/responses/shipping_service/submit_order_shipment_list.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.channeladvisor.com/ChannelAdvisorAPI/v6/ShippingService.asmx
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="UTF-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:tns="http://api.channeladvisor.com/webservices/"
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ins0="http://api.channeladvisor.com/webservices/"
+        xmlns:ins1="http://api.channeladvisor.com/datacontracts/ShippingService"><env:Header><ins0:APICredentials><ins0:DeveloperKey>$$DEVELOPER_KEY$$</ins0:DeveloperKey><ins0:Password>$$PASSWORD$$</ins0:Password></ins0:APICredentials></env:Header><env:Body><ins0:SubmitOrderShipmentList><ins0:accountID>$$ACCOUNT_ID$$</ins0:accountID><ins0:ShipmentList><ins0:ShipmentList><ins0:OrderShipment><ins0:OrderId>123456</ins0:OrderId><ins0:ClientOrderIdentifier>ABCD1234</ins0:ClientOrderIdentifier><ins0:ShipmentType>Full</ins0:ShipmentType><ins0:FullShipment><ins0:dateShippedGMT>2012-05-19T00:00:00+00:00</ins0:dateShippedGMT><ins0:carrierCode>UPS</ins0:carrierCode><ins0:classCode>GND</ins0:classCode><ins0:trackingNumber>1ZABCE09813473497</ins0:trackingNumber><ins0:sellerFulfillmentID>999999</ins0:sellerFulfillmentID><ins0:shipmentCost>5.99</ins0:shipmentCost><ins0:shipmentTaxCost>1.99</ins0:shipmentTaxCost><ins0:insuranceCost>2.99</ins0:insuranceCost></ins0:FullShipment></ins0:OrderShipment></ins0:ShipmentList></ins0:ShipmentList></ins0:SubmitOrderShipmentList></env:Body></env:Envelope>
+    headers:
+      soapaction:
+      - ! '"http://api.channeladvisor.com/webservices/SubmitOrderShipmentList"'
+      content-type:
+      - text/xml;charset=UTF-8
+      content-length:
+      - '1439'
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Tue, 12 Jun 2012 20:24:11 GMT
+      server:
+      - Microsoft-IIS/6.0
+      x-servername:
+      - RDU-IISWEB-04
+      x-powered-by:
+      - ASP.NET
+      x-aspnet-version:
+      - 4.0.30319
+      cache-control:
+      - private, max-age=0
+      content-type:
+      - text/xml; charset=utf-8
+      content-length:
+      - '888'
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="utf-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><soap:Body><SubmitOrderShipmentListResponse
+        xmlns="http://api.channeladvisor.com/webservices/"><SubmitOrderShipmentListResult><Status>Success</Status><MessageCode>0</MessageCode><ResultData><ShipmentResponse><Success
+        xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">false</Success><Message
+        xmlns="http://api.channeladvisor.com/datacontracts/ShippingService">An unexpected
+        error occurred involving Order 123456.  Please make sure sufficient unshipped
+        quantity exists on the order and that the Carrier and Class Codes are valid.</Message></ShipmentResponse></ResultData></SubmitOrderShipmentListResult></SubmitOrderShipmentListResponse></soap:Body></soap:Envelope>
+    http_version: '1.1'
+  recorded_at: Tue, 12 Jun 2012 20:24:11 GMT
+recorded_with: VCR 2.2.0

data/spec/fixtures/responses/soap_fault.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.channeladvisor.com/ChannelAdvisorAPI/v6/OrderService.asmx
+    body:
+      encoding: US-ASCII
+      string: <?xml version="1.0" encoding="UTF-8"?><soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+        xmlns:web="http://api.channeladvisor.com/webservices/" xmlns:ord="http://api.channeladvisor.com/datacontracts/orders"><soap:Header><web:APICredentials><web:DeveloperKey>WRONG</web:DeveloperKey><web:Password>$$PASSWORD$$</web:Password></web:APICredentials></soap:Header><soap:Body><web:Ping/></soap:Body></soap:Envelope>
+    headers:
+      soapaction:
+      - ! '"http://api.channeladvisor.com/webservices/Ping"'
+      content-type:
+      - text/xml;charset=UTF-8
+      content-length:
+      - '523'
+      accept:
+      - ! '*/*'
+      user-agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      date:
+      - Tue, 22 May 2012 06:07:16 GMT
+      server:
+      - Microsoft-IIS/6.0
+      x-servername:
+      - RDU-IISWEB-08
+      x-powered-by:
+      - ASP.NET
+      x-aspnet-version:
+      - 4.0.30319
+      cache-control:
+      - private
+      content-type:
+      - text/xml; charset=utf-8
+      content-length:
+      - '517'
+    body:
+      encoding: US-ASCII
+      string: ! "<soap:Envelope xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'>\r\n
+        \                          <soap:Body>\r\n                              <soap:Fault>\r\n
+        \                                <faultcode>soap:Server</faultcode>\r\n                                 <faultstring>Server
+        was unable to process request. Authentication failed.</faultstring>\r\n                                 <detail/>\r\n
+        \                             </soap:Fault>\r\n                           </soap:Body>\r\n
+        \                       </soap:Envelope>"
+    http_version: '1.1'
+  recorded_at: Tue, 22 May 2012 06:07:16 GMT
+recorded_with: VCR 2.1.1

data/spec/lib/channeladvisor/address_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+module ChannelAdvisor
+  describe Address do
+      before(:each) do
+        @attrs = {
+          :address_line1 => "12345 Some Pl.",
+          :address_line2 => "Ste. 1",
+          :city => "Somewhere",
+          :region => "NY",
+          :region_description => "New York",
+          :postal_code => "10003",
+          :country_code => "US",
+          :company_name => "Some Company",
+          :job_title  => "President",
+          :title => "Mr.",
+          :first_name => "Some",
+          :last_name => "Body",
+          :suffix => "Sr.",
+          :phone_number_day => "999-999-9999",
+          :phone_number_evening => "555-555-5555"
+        }
+        @address = Address.new(@attrs)
+      end
+
+    describe ".new" do
+      it "sets @line1" do
+        @address.line1.should == @attrs[:address_line1]
+      end
+
+      it "sets @line2" do
+        @address.line2.should == @attrs[:address_line2]
+      end
+
+      it "sets @city" do
+        @address.city.should == @attrs[:city]
+      end
+
+      it "sets @region" do
+        @address.region.should == @attrs[:region]
+      end
+
+      it "sets @region_description" do
+        @address.region_description.should == @attrs[:region_description]
+      end
+
+      it "sets @postal_code" do
+        @address.postal_code.should == @attrs[:postal_code]
+      end
+
+      it "sets @country_code" do
+        @address.country_code.should == @attrs[:country_code]
+      end
+
+      it "sets @company_name" do
+        @address.company_name.should == @attrs[:company_name]
+      end
+
+      it "sets @job_title" do
+        @address.job_title.should == @attrs[:job_title]
+      end
+
+      it "sets @title" do
+        @address.title.should == @attrs[:title]
+      end
+
+      it "sets @first_name" do
+        @address.first_name.should == @attrs[:first_name]
+      end
+
+      it "sets @last_name" do
+        @address.last_name.should == @attrs[:last_name]
+      end
+
+      it "sets @suffix" do
+        @address.suffix.should == @attrs[:suffix]
+      end
+
+      it "sets @daytime_phone" do
+        @address.daytime_phone.should == @attrs[:phone_number_day]
+      end
+
+      it "sets @evening_phone" do
+        @address.evening_phone.should == @attrs[:phone_number_evening]
+      end
+    end
+
+    describe "#full_name" do
+      it "returns a full name string" do
+        @address.full_name.should == "Mr. Some Body, Sr."
+      end
+    end
+
+    describe "#formatted" do
+      it "returns a formatted address" do
+        @address.formatted.should == <<-EOF
+        Mr. Some Body, Sr.
+        President
+        12345 Some Pl.
+        Ste. 1
+        Somewhere, NY 10003
+        US
+        EOF
+      end
+    end
+  end
+end

data/spec/lib/channeladvisor/admin_spec.rb

@@ -0,0 +1,216 @@
+require 'spec_helper'
+
+module ChannelAdvisor
+  describe Admin do
+    describe ".ping" do
+      context "with a success status" do
+        use_vcr_cassette "responses/admin/ping/success"
+
+        it "records the last response" do
+          Admin.ping
+          Admin.last_response[:ping_response].should_not be_nil
+        end
+
+        it "returns true" do
+          Admin.ping.should be_true
+        end
+      end
+
+      context "with a failure status" do
+        failure = {:message => "Service Unavailable"}
+        use_vcr_cassette "responses/admin/ping/failure", :erb => failure
+
+        it "raises a ServiceFailure error" do
+          expect { Admin.ping }.to raise_error ServiceFailure, failure[:message]
+        end
+      end
+
+      context "with a SOAP fault" do
+        use_vcr_cassette "responses/soap_fault", :match_requests_on => [:method]
+        
+        it "raises a SOAP fault error" do
+          ChannelAdvisor.configure { |c| c.developer_key = "WRONG" }
+          expect { Admin.ping }.to raise_error SOAPFault, "Server was unable to process request. Authentication failed."
+        end
+
+        it "stores the SOAP fault code" do
+          begin
+            Admin.ping
+          rescue SOAPFault => fault
+            fault.code.should == "soap:Server"
+          end
+        end
+      end
+
+      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
+       
+        it "raises an HTTP error" do
+          expect { Admin.ping }.to raise_error HTTPError, "Failed with HTTP error #{http_status[:code]}"
+        end
+
+        it "stores the HTTP status code" do
+          begin
+            Admin.ping
+          rescue HTTPError => error
+            error.code.should == http_status[:code]
+          end
+        end
+      end
+    end
+
+    describe ".request_access" do
+      let(:local_id) { sensitive_data["local_ids"].first }
+
+      context "with a success status" do
+        use_vcr_cassette "responses/admin/request_access/success"
+
+        it "records the last response" do
+          Admin.request_access(local_id)
+          Admin.last_response[:request_access_response].should_not be_nil
+        end
+
+        it "returns true" do
+          Admin.request_access(local_id).should be_true
+        end
+      end
+
+      context "with a failure status" do
+        use_vcr_cassette "responses/admin/request_access/failure"
+
+        it "raises a ServiceFailure error" do
+          expect { Admin.request_access(local_id) }.to raise_error ServiceFailure, "An Authorization for the specified ID [$$LOCAL_ID$$] already exists!"
+        end
+      end
+
+      context "with a SOAP fault" do
+        use_vcr_cassette "responses/soap_fault", :match_requests_on => [:method]
+        
+        it "raises a SOAP fault error" do
+          ChannelAdvisor.configure { |c| c.developer_key = "WRONG" }
+          expect { Admin.request_access(local_id) }.to raise_error SOAPFault, "Server was unable to process request. Authentication failed."
+        end
+
+        it "stores the SOAP fault code" do
+          begin
+            Admin.request_access(local_id)
+          rescue SOAPFault => fault
+            fault.code.should == "soap:Server"
+          end
+        end
+      end
+
+      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
+       
+        it "raises an HTTP error" do
+          expect { Admin.request_access(local_id) }.to raise_error HTTPError, "Failed with HTTP error #{http_status[:code]}"
+        end
+
+        it "stores the HTTP status code" do
+          begin
+            Admin.request_access(local_id)
+          rescue HTTPError => error
+            error.code.should == http_status[:code]
+          end
+        end
+      end
+    end
+
+    describe ".get_authorization_list" do
+      let(:local_id) { sensitive_data["local_ids"].first }
+
+      context "with a success status" do
+        use_vcr_cassette "responses/admin/get_authorization_list/success"
+
+        it "records the last response" do
+          Admin.get_authorization_list(local_id)
+          Admin.last_response[:get_authorization_list_response].should_not be_nil
+        end
+
+        context "with no authorizations" do
+          use_vcr_cassette "responses/admin/get_authorization_list/no_authorizations", :exclusive => true
+
+          it "should return an array" do
+            Admin.get_authorization_list(local_id).should be_an Array
+          end
+
+          it "returns an empty array" do
+            Admin.get_authorization_list(local_id).should have(0).items
+          end
+        end
+
+        context "with one authorization" do
+          use_vcr_cassette "responses/admin/get_authorization_list/one_authorization", :exclusive => true
+
+          it "should be an array with one element" do
+            Admin.get_authorization_list(local_id).should have(1).item
+          end
+
+          it "should have an array containing an AccountAuthorization object" do
+            Admin.get_authorization_list(local_id).first.should be_an AccountAuthorization
+          end
+        end
+
+        context "with two authorizations" do
+          use_vcr_cassette "responses/admin/get_authorization_list/two_authorizations", :exclusive => true
+
+          it "should be an array with two elements" do
+            Admin.get_authorization_list.should have(2).items
+          end
+
+          it "should have an array containing AccountAuthorization objects" do
+            account_authorizations = Admin.get_authorization_list(local_id)
+            account_authorizations.each do |account_authorization|
+              account_authorization.should be_an AccountAuthorization
+            end
+          end
+        end
+      end
+
+      context "with a failure status" do
+        use_vcr_cassette "responses/admin/get_authorization_list/failure"
+
+        it "raises a ServiceFailure error" do
+          expect { Admin.get_authorization_list("WRONG") }.to raise_error ServiceFailure, "Input string was not in a correct format."
+        end
+      end
+
+      context "with a SOAP fault" do
+        use_vcr_cassette "responses/soap_fault", :match_requests_on => [:method]
+        
+        it "raises a SOAP fault error" do
+          ChannelAdvisor.configure { |c| c.developer_key = "WRONG" }
+          expect { Admin.get_authorization_list(local_id) }.to raise_error SOAPFault, "Server was unable to process request. Authentication failed."
+        end
+
+        it "stores the SOAP fault code" do
+          begin
+            Admin.get_authorization_list(local_id)
+          rescue SOAPFault => fault
+            fault.code.should == "soap:Server"
+          end
+        end
+      end
+
+      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, :erb => http_status
+       
+        it "raises an HTTP error" do
+          expect { Admin.get_authorization_list(local_id) }.to raise_error HTTPError, "Failed with HTTP error #{http_status[:code]}"
+        end
+
+        it "stores the HTTP status code" do
+          begin
+            Admin.get_authorization_list(local_id)
+          rescue HTTPError => error
+            error.code.should == http_status[:code]
+          end
+        end
+      end
+    end # get_authorization_list
+  end # Admin
+end # ChannelAdvisor

data/spec/lib/channeladvisor/line_item_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+
+module ChannelAdvisor
+	describe LineItem do
+		let(:attrs) do
+      {
+      	:line_item_type => "SKU",
+        :unit_price => "6.9900",
+        :line_item_id => "17293910",
+        :allow_negative_quantity => false,
+        :quantity => "5",
+        :item_sale_source => "DIRECT_SALE",
+        :sku => "FAKE001",
+        :title => "Fake Item No. 1",
+        :buyer_user_id => "test@example.com",
+        :buyer_feedback_rating => "0",
+        :sales_source_id => "37081357",
+        :vat_rate => "0",
+        :tax_cost => "0.0000",
+        :shipping_cost => "0.0000",
+        :shipping_tax_cost => "0.0000",
+        :gift_wrap_cost => "0.0000",
+        :gift_wrap_tax_cost => "0.0000",
+        :gift_message => "Example gift message",
+        :gift_wrap_level => "Some Level",
+        :recycling_fee => "0.0000",
+        :unit_weight => "1.2",
+        :warehouse_location => "A14",
+        :user_name => "somebody",
+        :distribution_center_code => "ABC",
+        :is_fba => false,
+        :promo_code => "ABC123",
+        :"@xsi:type" => "q1:OrderLineItemItemResponse"
+      }
+		end
+
+		before(:each) do
+		  @line_item = LineItem.new(attrs)
+		end
+
+		describe ".new" do
+		  it "sets @type" do
+		    @line_item.type.should == attrs[:line_item_type]
+		  end
+
+		  it "sets @id" do
+		    @line_item.id.should == attrs[:line_item_id]
+		  end
+
+		  it "sets @unit_price" do
+		    @line_item.unit_price.should == attrs[:unit_price].to_f
+		  end
+
+		  it "sets @allow_negative_quantity" do
+		    @line_item.allow_negative_quantity.should == attrs[:allow_negative_quantity]
+		  end
+
+		  it "sets @quantity" do
+		    @line_item.quantity.should == attrs[:quantity].to_i
+		  end
+
+		  it "sets @sale_source" do
+		    @line_item.sale_source.should == attrs[:item_sale_source]
+		  end
+
+		  it "sets @sku" do
+		    @line_item.sku.should == attrs[:sku]
+		  end
+
+		  it "sets @title" do
+		    @line_item.title.should == attrs[:title]
+		  end
+
+		  it "sets @buyer_user_id" do
+		    @line_item.buyer_user_id.should == attrs[:buyer_user_id]
+		  end
+
+		  it "sets @buyer_feedback_rating" do
+		  	@line_item.buyer_feedback_rating.should == attrs[:buyer_feedback_rating] 
+		  end
+
+		  it "sets @sales_source_id" do
+		    @line_item.sales_source_id.should == attrs[:sales_source_id]
+		  end
+
+		  it "sets @vat_rate" do
+		    @line_item.vat_rate.should == attrs[:vat_rate].to_f
+		  end
+
+		  it "sets @tax_cost" do
+		    @line_item.tax_cost.should == attrs[:tax_cost].to_f
+		  end
+
+		  it "sets @shipping_cost" do
+		    @line_item.shipping_cost.should == attrs[:shipping_cost].to_f
+		  end
+
+		  it "sets @shipping_tax_cost" do
+		    @line_item.shipping_tax_cost.should == attrs[:shipping_tax_cost].to_f
+		  end
+
+		  it "sets @gift_wrap_cost" do
+		    @line_item.gift_wrap_cost.should == attrs[:gift_wrap_cost].to_f
+		  end
+
+		  it "sets @gift_wrap_tax_cost" do
+		    @line_item.gift_wrap_tax_cost.should == attrs[:gift_wrap_tax_cost].to_f
+		  end
+
+		  it "sets @gift_message" do
+		    @line_item.gift_message.should == attrs[:gift_message]
+		  end
+
+		  it "sets @gift_wrap_level" do
+		    @line_item.gift_wrap_level.should == attrs[:gift_wrap_level]
+		  end
+
+		  it "sets @recycling_fee" do
+		    @line_item.recycling_fee.should == attrs[:recycling_fee].to_f
+		  end
+
+		  it "sets @unit_weight" do
+		    @line_item.unit_weight.should == attrs[:unit_weight].to_f
+		  end
+
+		  it "sets @warehouse_location" do
+		    @line_item.warehouse_location.should == attrs[:warehouse_location]
+		  end
+
+		  it "sets @user_name" do
+		    @line_item.user_name.should == attrs[:user_name]
+		  end
+
+		  it "sets @distribution_center_code" do
+		    @line_item.distribution_center.should == attrs[:distribution_center_code]
+		  end
+
+		  it "sets @is_fba" do
+		    @line_item.is_fba.should == attrs[:is_fba]
+		  end
+
+		  it "sets @promo_code" do
+		    @line_item.promo_code.should == attrs[:promo_code]
+		  end
+		end
+	end # LineItem
+end # ChannelAdvisor