ship_compliant 0.1.0

data/spec/fixtures/search_sales_orders.xml

@@ -0,0 +1,52 @@
+<?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:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+  <soap:Header>
+    <wsa:Action>action</wsa:Action>
+    <wsa:MessageID>message-id</wsa:MessageID>
+    <wsa:RelatesTo>relates-to</wsa:RelatesTo>
+    <wsa:To>http://schemas.xmlsoap.org/ws/2004/03/addressing/role/anonymous</wsa:To>
+    <wsse:Security>
+      <wsu:Timestamp wsu:Id="Timestamp-id">
+        <wsu:Created>2014-03-11T15:08:12Z</wsu:Created>
+        <wsu:Expires>2014-03-11T15:13:12Z</wsu:Expires>
+      </wsu:Timestamp>
+    </wsse:Security>
+  </soap:Header>
+  <soap:Body>
+    <SearchSalesOrdersResponse xmlns="http://ws.shipcompliant.com/">
+      <SearchSalesOrdersResult>
+        <CountMoreSalesOrdersAvailable>0</CountMoreSalesOrdersAvailable>
+        <CountSalesOrdersReturned>1</CountSalesOrdersReturned>
+        <PagingCookie>paging-cookie</PagingCookie>
+        <PagingCookieExpires>2014-01-02T09:07:55-06:00</PagingCookieExpires>
+        <ResponseStatus>Success</ResponseStatus>
+        <SalesOrders>
+          <SalesOrderSummary>
+            <PurchaseDate>2014-03-10T00:00:00+00:00</PurchaseDate>
+            <SalesOrderKey>ONL-1</SalesOrderKey>
+            <Shipments>
+              <ShipmentSummary>
+                <ComplianceStatus>LegacyCommitted</ComplianceStatus>
+                <FulfillmentExceptionReason/>
+                <FulfillmentExceptionType>None</FulfillmentExceptionType>
+                <FulfillmentHouse/>
+                <FulfillmentStatus>None</FulfillmentStatus>
+                <Packages/>
+                <RequestedShipDate>2014-03-11T00:00:00+00:00</RequestedShipDate>
+                <ShipDate>2014-03-11T00:00:00+00:00</ShipDate>
+                <ShipmentKey>0</ShipmentKey>
+                <ShipmentStatus>InProcess</ShipmentStatus>
+                <ShipTo>
+                  <FirstName>John</FirstName>
+                  <LastName>Doe</LastName>
+                  <Zip1>90210</Zip1>
+                </ShipTo>
+              </ShipmentSummary>
+            </Shipments>
+            <Tags/>
+          </SalesOrderSummary>
+        </SalesOrders>
+      </SearchSalesOrdersResult>
+    </SearchSalesOrdersResponse>
+  </soap:Body>
+</soap:Envelope>

data/spec/fixtures/void_order_failure.xml

@@ -0,0 +1,31 @@
+<?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:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+  <soap:Header>
+    <wsa:Action>http://ws.shipcompliant.com/VoidSalesOrderResponse</wsa:Action>
+    <wsa:MessageID>uuid:ebdc1f5c-5f39-44b3-92c9-a9986b18fd06</wsa:MessageID>
+    <wsa:RelatesTo>uuid:2859b2a3-d425-46ab-befd-10db2cad7b79</wsa:RelatesTo>
+    <wsa:To>http://schemas.xmlsoap.org/ws/2004/03/addressing/role/anonymous</wsa:To>
+    <wsse:Security>
+      <wsu:Timestamp wsu:Id="Timestamp-0b819aaf-491d-475b-846a-81de016274e9">
+        <wsu:Created>2014-03-12T01:19:43Z</wsu:Created>
+        <wsu:Expires>2014-03-12T01:24:43Z</wsu:Expires>
+      </wsu:Timestamp>
+    </wsse:Security>
+  </soap:Header>
+  <soap:Body>
+    <VoidSalesOrderResponse xmlns="http://ws.shipcompliant.com/">
+      <VoidSalesOrderResult>
+        <Errors>
+          <Error>
+            <Code>200</Code>
+            <Key>ONS-1</Key>
+            <Message>SalesOrder does not exist [ONS-1].</Message>
+            <Target>SalesOrder</Target>
+            <Type>Validation</Type>
+          </Error>
+        </Errors>
+        <ResponseStatus>Failure</ResponseStatus>
+      </VoidSalesOrderResult>
+    </VoidSalesOrderResponse>
+  </soap:Body>
+</soap:Envelope>

data/spec/fixtures/void_order_success.xml

@@ -0,0 +1,22 @@
+<?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:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
+  <soap:Header>
+    <wsa:Action>http://ws.shipcompliant.com/VoidSalesOrderResponse</wsa:Action>
+    <wsa:MessageID>uuid:a894e5e3-90b9-421b-af83-d2b7ed384374</wsa:MessageID>
+    <wsa:RelatesTo>uuid:96461b87-360d-41b6-a626-a00d72e08736</wsa:RelatesTo>
+    <wsa:To>http://schemas.xmlsoap.org/ws/2004/03/addressing/role/anonymous</wsa:To>
+    <wsse:Security>
+      <wsu:Timestamp wsu:Id="Timestamp-adc998a5-2ef8-44ff-8ead-8fae965f5031">
+        <wsu:Created>2014-03-12T01:16:52Z</wsu:Created>
+        <wsu:Expires>2014-03-12T01:21:52Z</wsu:Expires>
+      </wsu:Timestamp>
+    </wsse:Security>
+  </soap:Header>
+  <soap:Body>
+    <VoidSalesOrderResponse xmlns="http://ws.shipcompliant.com/">
+      <VoidSalesOrderResult>
+        <ResponseStatus>Success</ResponseStatus>
+      </VoidSalesOrderResult>
+    </VoidSalesOrderResponse>
+  </soap:Body>
+</soap:Envelope>

data/spec/lib/ship_compliant/add_update_brand_result_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe AddUpdateBrandResult do
+    it_behaves_like "BaseResult"
+  end
+end

data/spec/lib/ship_compliant/add_update_brand_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe AddUpdateBrand do
+
+    before { savon.mock! }
+    after { savon.unmock! }
+
+    let(:message) do
+      {
+        'Request' => {
+          'Security' => {
+            'PartnerKey' => 'abc-123',
+            'Username' => 'bob@example.com',
+            'Password' => 'secret'
+          },
+          'Brand' => {
+            'Key' => 'WNDFL',
+            'Name' => 'Wonderful',
+            'Owner' => {
+              'Name' => 'Sam'
+            }
+          },
+          'UpdateMode' => 'DoWackaDo'
+        }
+      }
+    end
+    let(:response) { File.read('spec/fixtures/add_update_product.xml') }
+    context "brand" do
+
+      it "queries the client with an update mode" do
+        savon.expects(:add_update_brand)
+          .with(message: message).returns(response)
+
+        result = AddUpdateBrand.brand({
+          key: 'WNDFL',
+          name: 'Wonderful',
+          owner: { name: 'Sam' }
+        }, update_mode: 'DoWackaDo')
+
+        result.should be_kind_of(AddUpdateBrandResult)
+      end
+
+      it "update mode defaults to ErrorOnExisting" do
+        message['Request']['UpdateMode'] = 'ErrorOnExisting'
+        savon.expects(:add_update_brand)
+          .with(message: message).returns(response)
+
+        AddUpdateBrand.brand({
+          key: 'WNDFL',
+          name: 'Wonderful',
+          owner: { name: 'Sam' }
+        })
+      end
+    end
+
+  end
+end

data/spec/lib/ship_compliant/add_update_product_result_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe AddUpdateProductResult do
+    it_behaves_like "BaseResult"
+  end
+end

data/spec/lib/ship_compliant/add_update_product_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe AddUpdateProduct do
+
+    before { savon.mock! }
+    after { savon.unmock! }
+
+    let(:message) do
+      {
+        'Request' => {
+          'Security' => {
+            'PartnerKey' => 'abc-123',
+            'Username' => 'bob@example.com',
+            'Password' => 'secret'
+          },
+          'Product' => {
+            'BottleSizeML' => 123,
+            'DefaultWholesaleCasePrice' => 150
+          },
+          'UpdateMode' => 'DoWackaDo'
+        }
+      }
+    end
+    let(:response) { File.read('spec/fixtures/add_update_product.xml') }
+
+    context "product" do
+      it "queries the client with product an update mode" do
+        AddUpdateProduct.stub(:add_update_product) { {} }
+        
+        result = AddUpdateProduct.product({
+          bottle_size_ml: 123,
+          default_wholesale_case_price: 150
+        }, update_mode: 'DoWackaDo')
+
+        result.should be_kind_of(AddUpdateProductResult)
+      end
+
+      it "update mode defaults to ErrorOnExisting" do
+        message['Request']['UpdateMode'] = 'ErrorOnExisting'
+        savon.expects(:add_update_product)
+          .with(message: message).returns(response)
+        
+        AddUpdateProduct.product({
+          bottle_size_ml: 123,
+          default_wholesale_case_price: 150
+        })
+      end
+    end
+
+  end
+end

data/spec/lib/ship_compliant/address/suggested_address_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe SuggestedAddress do
+
+    it { should be_kind_of(Address) }
+
+    context "details" do
+      it "gets the details" do
+        subject.details.should == { address_details: true }
+      end
+    end
+
+    context "parts" do
+      it "gets the parts" do
+        subject.parts.should == { address_parts: true }
+      end
+    end
+
+    subject do
+      SuggestedAddress.new(
+        details: { address_details: true },
+        parts: { address_parts: true }
+      )
+    end
+
+  end
+end

data/spec/lib/ship_compliant/address_spec.rb

@@ -0,0 +1,123 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe Address do
+
+    context "city" do
+      it "gets the city" do
+        subject.city.should == 'A City'
+      end
+    end
+
+    context "county" do
+      it "gets the county" do
+        subject.county.should == 'A County'
+      end
+    end
+
+    context "state" do
+      it "gets the state" do
+        subject.state.should == 'A State'
+      end
+    end
+
+    context "country" do
+      it "gets the country" do
+        subject.country.should == 'A Country'
+      end
+    end
+
+    context "street1" do
+      it "gets street1" do
+        subject.street1.should == 'Street 1'
+      end
+    end
+
+    context "street2" do
+      it "gets street2" do
+        subject.street2.should == 'Street 2'
+      end
+    end
+
+    context "zip1" do
+      it "gets zip1" do
+        subject.zip1.should == 12345
+      end
+    end
+
+    context "zip2" do
+      it "gets zip2" do
+        subject.zip2.should == 1234
+      end
+
+      it "returns nil when empty" do
+        subject.address[:zip2] = nil
+        subject.zip2.should be_nil
+      end
+    end
+
+    context "company" do
+      it "gets company" do
+        subject.company.should == 'Dippin Dots'
+      end
+    end
+
+    context "date_of_birth" do
+      it "gets date_of_birth" do
+        subject.date_of_birth.should == Date.new(1967, 8, 12)
+      end
+    end
+
+    context "email" do
+      it "gets email" do
+        subject.email.should == 'sogood@getdots.com'
+      end
+    end
+
+    context "fax" do
+      it "gets fax" do
+        subject.fax.should == '(555) 123-8901'
+      end
+    end
+    
+    context "phone" do
+      it "gets phone" do
+        subject.phone.should == '(555) 123-4567'
+      end
+    end
+
+    context "first_name" do
+      it "gets first_name" do
+        subject.first_name.should == 'Lt.'
+      end
+    end
+    
+    context "last_name" do
+      it "gets last_name" do
+        subject.last_name.should == 'Columbo'
+      end
+    end
+
+    subject do
+      Address.new(
+        city: 'A City',
+        county: 'A County',
+        country: 'A Country',
+        state: 'A State',
+        street1: 'Street 1',
+        street2: 'Street 2',
+        zip1: '12345',
+        zip2: '1234',
+
+        company: 'Dippin Dots',
+        date_of_birth: Date.new(1967, 8, 12),
+        email: 'sogood@getdots.com',
+        fax: '(555) 123-8901',
+        phone: '(555) 123-4567',
+        first_name: 'Lt.',
+        last_name: 'Columbo'
+      )
+    end
+
+  end
+end

data/spec/lib/ship_compliant/base_result_spec.rb

@@ -0,0 +1,127 @@
+require "spec_helper"
+
+module ShipCompliant
+  class FauxResult < Struct.new(:response)
+    include BaseResult
+  end
+end
+
+module ShipCompliant
+  describe BaseResult do
+
+    let(:success_message) { {response_status: "Success"} }
+    let(:failure_message) do
+      {
+        errors: {
+          error: {
+            code: "404",
+            key: "OrderId",
+            message: "I'm smarter than the average bear, Boo Boo",
+            target: "SalesOrder",
+            type: "Validation"
+          }
+        },
+        response_status: "Failure"
+      }
+    end
+
+    context "success?" do
+      it "returns true for successful response status" do
+        result = FauxResult.new(success_message)
+        result.success?.should be_true
+      end
+
+      it "returns false for failed response status" do
+        result = FauxResult.new(failure_message)
+        result.success?.should be_false
+      end
+    end
+
+    context "failure?" do
+      it "returns opposite of success?" do
+        result = FauxResult.new({})
+        result.stub(:success?) { false }
+        result.failure?.should be_true
+      end
+    end
+
+    context "errors" do
+      it "returns an array of errors" do
+        result = FauxResult.new(failure_message)
+        result.errors.should == [
+          ErrorResult.new({
+              code: "404",
+              key: "OrderId",
+              message: "I'm smarter than the average bear, Boo Boo",
+              target: "SalesOrder",
+              type: "Validation"
+          })
+        ]
+      end
+
+      it "doesn't break when errors is already an array" do
+        result = FauxResult.new({
+          response_status: 'Failure',
+          errors: [
+            {error: { code: '404' }},
+            {error: { code: '500' }}
+          ]
+        })
+
+        result.errors.should == [
+          ErrorResult.new(code: '404'),
+          ErrorResult.new(code: '500')
+        ]
+      end
+
+      it "returns an empty array for successful response" do
+        result = FauxResult.new(success_message)
+        result.errors.should == []
+      end
+    end
+
+    context "errors_count" do
+      it "counts the number of errors" do
+        result = FauxResult.new({})
+        result.stub(:errors) { [1, 2, 3 ] }
+        result.errors_count.should == 3
+      end
+    end
+
+    # context "error_message" do
+    #   it "gets the error message" do
+    #     result = FauxResult.new(failure_message)
+    #     result.error_message.should == "I'm smarter than the average bear, Boo Boo"
+    #   end
+
+    #   it "returns nil when successful" do
+    #     result = FauxResult.new(success_message)
+    #     result.error_message.should be_nil
+    #   end
+    # end
+
+    # context "error_code" do
+    #   it "gets the error code" do
+    #     result = FauxResult.new(failure_message)
+    #     result.error_code.should == 200
+    #   end
+
+    #   it "returns 0 when successful" do
+    #     result = FauxResult.new(success_message)
+    #     result.error_code.should == 0
+    #   end
+    # end
+
+    # context "error_key" do
+    #   it "gets the error key" do
+    #     result = FauxResult.new(failure_message)
+    #     result.error_key.should == "OrderId"
+    #   end
+
+    #   it "returns nil when successful" do
+    #     result = FauxResult.new(success_message)
+    #     result.error_key.should be_nil
+    #   end
+    # end
+  end
+end