ship_compliant 0.1.0

data/spec/lib/ship_compliant/error_result_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe ErrorResult do
+    let(:error) do
+      {
+        code: "404",
+        key: "OrderId",
+        message: "I'm smarter than the average bear, Boo Boo",
+        target: "SalesOrder",
+        type: "Validation"
+      }
+    end
+
+    subject { ErrorResult.new(error) }
+
+    context "code" do
+      it "returns the code as an integer" do
+        subject.code.should == 404
+      end
+    end
+
+    context "key" do
+      it "gets the key" do
+        subject.key.should == "OrderId"
+      end
+    end
+
+    context "message" do
+      it "gets the message" do
+        subject.message.should == "I'm smarter than the average bear, Boo Boo"
+      end
+    end
+
+    context "target" do
+      it "gets the target" do
+        subject.target.should == "SalesOrder"
+      end
+    end
+
+    context "type" do
+      it "gets the type" do
+        subject.type.should == "Validation"
+      end
+    end
+  end
+end

data/spec/lib/ship_compliant/freight_sales_tax_rate_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe FreightSalesTaxRate do
+    it { should be_kind_of(SalesTaxRate) }
+  end
+end

data/spec/lib/ship_compliant/get_inventory_details_result_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+module ShipCompliant
+
+  describe GetInventoryDetailsResult do
+    it_behaves_like "BaseResult"
+
+    context "locations" do
+      it "returns an array of locations" do
+        subject.locations.should == [
+          inventory_location[:inventory_location]
+        ]
+      end
+
+      it "handles a single location" do
+        result = GetInventoryDetailsResult.new({
+          inventory_locations: inventory_location
+        })
+
+        result.locations.should == [
+          inventory_location[:inventory_location]
+        ]
+      end
+    end
+
+    context "location" do
+      it "finds a location" do
+        subject.location('WineShipping').should == inventory_location[:inventory_location]
+      end
+
+      it "returns an empty hash when invalid" do
+        subject.location('toys-r-us').should == {}
+      end
+    end
+
+    context "products_for_location" do
+      it "returns an array of products" do
+        subject.products_for_location('WineShipping').should == [
+          InventoryProduct.new(product_key: 'PRODUCT-KEY', inventory_levels: inventory_level)
+        ]
+      end
+
+      it "returns empty array for invalid location" do
+        subject.products_for_location('toys-r-us').should == []
+      end
+    end
+
+    let(:inventory_level) do
+      {
+        inventory_level: {
+          effective_date: DateTime.new(2014, 3, 13, 18, 0, 6),
+          inventory_type: "Available",
+          quantity: "25",
+          synchronization_date: DateTime.new(2014, 3, 13, 18, 0, 6)
+        }
+      }
+    end
+
+    let(:inventory_location) do
+      {
+        inventory_location: {
+          fulfillment_account: nil,
+          fulfillment_location: "WineShipping",
+          inventory_products: [
+            {
+              inventory_product: {
+                product_key: 'PRODUCT-KEY',
+                inventory_levels: inventory_level
+              }
+            }
+          ],
+          sub_inventory_code: nil,
+          supplier: "ShipC Library Wines"
+        }
+      }
+    end
+
+    subject do
+      GetInventoryDetailsResult.new({
+        inventory_locations: [
+          inventory_location
+        ],
+        response_status: "Success"
+      })
+    end
+  end
+end

data/spec/lib/ship_compliant/get_inventory_details_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+module ShipCompliant
+
+  describe GetInventoryDetails do
+
+    before { savon.mock! }
+    after { savon.unmock! }
+
+    it "gets inventory details" do
+      message = {
+        'Request' => {
+          'Security' => {
+            'PartnerKey' => 'abc-123',
+            'Username' => 'bob@example.com',
+            'Password' => 'secret'
+          },
+          'BrandKey' => 'BRAND-KEY',
+          'FulfillmentLocation' => 'FULFILLMENT-LOCATION',
+        }
+      }
+
+      savon.expects(:get_inventory_details)
+        .with(message: message)
+        .returns(File.read('spec/fixtures/void_order_success.xml'))
+
+      result = GetInventoryDetails.call(
+        brand_key: 'BRAND-KEY',
+        fulfillment_location: 'FULFILLMENT-LOCATION'
+      )
+
+      result.should be_kind_of(GetInventoryDetailsResult)
+    end
+  end
+end

data/spec/lib/ship_compliant/get_sales_order_extended_result_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe GetSalesOrderExtendedResult do
+    it_behaves_like "BaseResult"
+
+    context "shipment_compliance_rules" do
+      it "returns compliance rules as an array" do
+        subject.shipment_compliance_rules.should == [
+          {
+            is_compliant: true,
+            key: 'SHIPMENT-KEY',
+          }
+        ]
+      end
+    end
+
+    context "compliance_rules_for_shipment" do
+      it "finds compliance rules for shipment" do
+        subject.compliance_rules_for_shipment('SHIPMENT-KEY').should == ShipmentCompliance.new({
+          is_compliant: true,
+          key: 'SHIPMENT-KEY'
+        })
+      end
+    end
+
+    context "bill_to" do
+      it "returns an Address" do
+        subject.bill_to.should == Address.new({
+          city: 'Jellystone Park',
+          state: 'WY'
+        })
+      end
+    end
+
+    context "shipments" do
+      it "returns an array of shipments" do
+        subject.shipments.should == [{
+          shipment_key: 'SHIPMENT-KEY',
+          shipment_items: []
+        }]
+      end
+    end
+
+    context "find_shipment" do
+      it "returns the shipment" do
+        subject.find_shipment('SHIPMENT-KEY').should == Shipment.new({
+          shipment_key: 'SHIPMENT-KEY',
+          shipment_items: []
+        })
+      end
+    end
+
+    context "channel_details" do
+      it "returns the details" do
+        subject.channel_details.should == ChannelDetails.new(some_details: 'online sales')
+      end
+    end
+
+    subject do
+      GetSalesOrderExtendedResult.new({
+        compliance_results: {
+          sales_order: {
+            shipments: {shipment_compliance_response: [{ is_compliant: true, key: 'SHIPMENT-KEY' }]}
+          }
+        },
+        sales_order: {
+          bill_to: {
+            city: 'Jellystone Park',
+            state: 'WY'
+          },
+          shipments: [shipment]
+        },
+        order_channel_details: {
+          some_details: 'online sales'
+        }
+      })
+    end
+
+    let(:shipment) do
+      {shipment: { shipment_key: 'SHIPMENT-KEY', shipment_items: [] }}
+    end
+  end
+end

data/spec/lib/ship_compliant/get_sales_order_extended_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe GetSalesOrderExtended do
+
+    before { savon.mock! }
+    after { savon.unmock! }
+
+    let(:message) do
+      {
+        'Request' => {
+          'Security' => {
+            'PartnerKey' => 'abc-123',
+            'Username' => 'bob@example.com',
+            'Password' => 'secret'
+          },
+          'SalesOrderKey' => 'SomeOrderId'
+        }
+      }
+    end
+
+    let(:success_response) { File.read('spec/fixtures/void_order_success.xml') }
+
+    context "by_order_key" do
+      it "queries the client" do
+        savon.expects(:get_sales_order_extended)
+          .with(message: message).returns(success_response)
+        
+        GetSalesOrderExtended.by_order_key('SomeOrderId')
+      end
+
+      it "returns GetSalesOrderExtendedResult" do
+        ShipCompliant.client.stub(:call) { {} }
+        result = GetSalesOrderExtended.by_order_key('order-id')
+        result.should be_kind_of(GetSalesOrderExtendedResult)
+      end
+    end
+  end
+end

data/spec/lib/ship_compliant/inventory_product_spec.rb

@@ -0,0 +1,116 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe InventoryProduct do
+
+    context "default_case" do
+      it "returns the default case" do
+        subject.default_case.should == 'DEFAULT-CASE'
+      end
+    end
+
+    context "description" do
+      it "returns the description" do
+        subject.description.should == 'PRODUCT-DESCRIPTION'
+      end
+    end
+
+    context "fulfillment_sku" do
+      it "returns the fulfillment_sku" do
+        subject.fulfillment_sku.should == 'FULFILLMENT-SKU'
+      end
+    end
+
+    context "percent_alcohol" do
+      it "returns the percent_alcohol" do
+        subject.percent_alcohol.should == 98.43
+      end
+    end
+
+    context "product_key" do
+      it "returns the product_key" do
+        subject.product_key.should == 'PRODUCT-KEY'
+      end
+    end
+
+    context "product_type" do
+      it "returns the product_key" do
+        subject.product_type.should == 'PRODUCT-TYPE'
+      end
+    end
+
+    context "unit_price" do
+      it "returns the unit_price" do
+        subject.unit_price.should == 873.21
+      end
+    end
+
+    context "vintage" do
+      it "returns the vintage" do
+        subject.vintage.should == 1922
+      end
+    end
+
+    context "volume_amount" do
+      it "returns the volume_amount" do
+        subject.volume_amount.should == 944.0
+      end
+    end
+
+    context "volume_ml" do
+      it "returns the volume_ml" do
+        subject.volume_ml.should == 944.0
+      end
+    end
+
+    context "volume_unit" do
+      it "returns the volume_unit" do
+        subject.volume_unit.should == 'Milliliter'
+      end
+    end
+
+    context "inventory_levels" do
+      it "returns a hash of inventory levels" do
+        subject.inventory_levels.should == {
+          available: 100,
+          on_hand: 20,
+          some_amazing_type: 1000
+        }
+      end
+    end
+
+    subject do
+      InventoryProduct.new({
+        default_case: 'DEFAULT-CASE',
+        description: 'PRODUCT-DESCRIPTION',
+        fulfillment_sku: 'FULFILLMENT-SKU',
+        percent_alcohol: '98.43',
+        product_key: 'PRODUCT-KEY',
+        product_type: 'PRODUCT-TYPE',
+        unit_price: '873.21',
+        vintage: '1922',
+        volume_amount: '944',
+        volume_ml: '944',
+        volume_unit: 'Milliliter',
+        inventory_levels: {
+          inventory_level: [
+            {
+              random_key: 'PleaseIgnore',
+              inventory_type: 'Available',
+              quantity: '100'
+            },
+            {
+              inventory_type: 'OnHand',
+              quantity: '20'
+            },
+            {
+              inventory_type: 'SomeAmazingType',
+              quantity: '1000'
+            }
+          ]
+        }
+      })
+    end
+
+  end
+end

data/spec/lib/ship_compliant/order_search_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe OrderSearch do
+
+    context "to_h" do
+      it "converts keys to pascal case" do
+        order = OrderSearch.new(sales_order_key_min: 10)
+        order.to_h.should == {
+          "SalesOrderKeyMin" => 10
+        }
+      end
+
+      it "ignores invalid keys" do
+        order = OrderSearch.new(xyz: 5)
+        order.to_h.should == {}
+      end
+    end
+
+  end
+end

data/spec/lib/ship_compliant/package_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+module ShipCompliant
+  describe Package do
+
+    context "tracking_number" do
+      it "gets the tracking_number" do
+        subject.tracking_number.should == 'tracking-number'
+      end
+    end
+
+    context "tracking_status" do
+      it "gets the tracking_status" do
+        subject.tracking_status.should == 'Lost in Transit'
+      end
+    end
+
+    subject do
+      Package.new(
+        tracking_number: 'tracking-number',
+        tracking_status: 'Lost in Transit'
+      )
+    end
+
+  end
+end