ship_compliant 0.1.0

data/features/step_definitions/compliance_check/missing_product_steps.rb

@@ -0,0 +1,102 @@
+When(/^I check compliance with a missing product$/) do
+  VCR.use_cassette('compliance_missing_product') do
+    @compliance_status = ShipCompliant::CheckCompliance.of_sales_order({
+      'AddressOption' => {
+        'IgnoreStreetLevelErrors' => true,
+        'RejectIfAddressSuggested' => 'false'
+      },
+      'IncludeSalesTaxRates' => true,
+      'PersistOption' => 'Null',
+      'SalesOrder' => {
+        'BillTo' => {
+          'City' => 'Boulder',
+          'Company' => 'ShipCompliant',
+          'Country' => 'US',
+          'DateOfBirth' => DateTime.new(1987, 8, 6),
+          'Email' => 'emily@six88.com',
+          'FirstName' => 'Emily',
+          'LastName' => 'Sheehan',
+          'Phone' => '303-996-1626',
+          'State' => 'CO',
+          'Street1' => '1877 Broadway St',
+          'Street2' => 'SUITE 703',
+          'Zip1' => 80304
+        },
+        'CustomerKey' => 'd23c963b',
+        'Discounts' => nil,
+        'FulfillmentType' => 'Daily',
+        'OrderType' => 'Internet',
+        'Payments' => nil,
+        'PurchaseDate' => DateTime.new(2014, 3, 12),
+        'RegisterId' => 'cf3ee9',
+        'SalesOrderKey' => '1006891',
+        'SalesTaxCollected' => 0,
+        'Shipments' => {
+          'Shipment' => {
+            'Discounts' => nil,
+            'FulfillmentHouse' => 'InHouse',
+            'Handling' => 0,
+            'InsuredAmount' => 0,
+            'LicenseRelationship' => 'Default',
+            'Packages' => nil,
+            'ShipDate' => DateTime.new(2014, 3, 15),
+            'ShippingService' => 'UPS',
+            'ShipmentItems' => [
+              {
+                'ShipmentItem' => {
+                  'BrandKey' => 'DEN',
+                  'Discounts' => nil,
+                  'ProductKey' => '04CHRCAB75',
+                  'ProductQuantity' => 6,
+                  'ProductUnitPrice' => 76
+                }
+              },
+              {
+                'ShipmentItem' => {
+                  'BrandKey' => 'DEN',
+                  'Discounts' => nil,
+                  'ProductKey' => 'Shoe',
+                  'ProductQuantity' => 1,
+                  'ProductUnitPrice' => 84.99
+                }
+              }
+            ],
+            'ShipmentKey' => 1,
+            'ShipmentStatus' => 'SentToFulfillment',
+            'Shipping' => 15,
+            'ShipTo' => {
+              'City' => 'New York',
+              'Company' => nil,
+              'Country' => 'US',
+              'County' => nil,
+              'DateOfBirth' => DateTime.new(1987, 8, 6),
+              'Email' => 'emily@six88.com',
+              'Fax' => nil,
+              'FirstName' => 'Emily',
+              'LastName' => 'Sheehan',
+              'Phone' => '7209375005',
+              'State' => 'NY',
+              'Street1' => '253 Broadway Ave',
+              'Street2' => 'Floor 9',
+              'Zip1' => 10007,
+              'Zip2' => nil
+            }
+          }
+        },
+        'Tags' => nil
+      }
+    })
+  end
+end
+
+Then(/^I should receive a product key error$/) do
+  @compliance_status.failure?.should be_true
+  @compliance_status.error_count.should == 1
+  error = @compliance_status.errors.first
+
+  error.code.should == 201
+  error.key.should == '1'
+  error.message.should == 'Product matching given BrandKey/ProductKey does not exist [DEN,Shoe].'
+  error.target.should == 'Shipment'
+  error.type.should == 'Validation'
+end

data/features/step_definitions/compliance_check/noncompliant_product.rb

@@ -0,0 +1,102 @@
+When(/^I check compliance with a non\-compliant product$/) do
+  VCR.use_cassette('compliance_noncompliant_product') do
+    @compliance_status = ShipCompliant::CheckCompliance.of_sales_order({
+      'AddressOption' => {
+        'IgnoreStreetLevelErrors' => true,
+        'RejectIfAddressSuggested' => 'false'
+      },
+      'IncludeSalesTaxRates' => true,
+      'PersistOption' => 'Null',
+      'SalesOrder' => {
+        'BillTo' => {
+          'City' => 'Boulder',
+          'Company' => 'ShipCompliant',
+          'Country' => 'US',
+          'DateOfBirth' => DateTime.new(1987, 8, 6),
+          'Email' => 'emily@six88.com',
+          'FirstName' => 'Emily',
+          'LastName' => 'Sheehan',
+          'Phone' => '303-996-1626',
+          'State' => 'CO',
+          'Street1' => '1877 Broadway St',
+          'Street2' => 'SUITE 703',
+          'Zip1' => 80304
+        },
+        'CustomerKey' => 'd23c963b',
+        'Discounts' => nil,
+        'FulfillmentType' => 'Daily',
+        'OrderType' => 'Internet',
+        'Payments' => nil,
+        'PurchaseDate' => DateTime.new(2014, 3, 12),
+        'RegisterId' => 'cf3ee9',
+        'SalesOrderKey' => '1006898',
+        'SalesTaxCollected' => 0,
+        'Shipments' => {
+          'Shipment' => {
+            'Discounts' => nil,
+            'FulfillmentHouse' => 'WineShipping',
+            'Handling' => 0,
+            'InsuredAmount' => 0,
+            'LicenseRelationship' => 'Default',
+            'Packages' => nil,
+            'ShipDate' => DateTime.new(2014, 3, 15),
+            'ShippingService' => 'UPS',
+            'ShipmentItems' => [
+              {
+                'ShipmentItem' => {
+                  'BrandKey' => 'DEN',
+                  'Discounts' => nil,
+                  'ProductKey' => '09OTBC75',
+                  'ProductQuantity' => 2,
+                  'ProductUnitPrice' => 15.99
+                }
+              },
+              {
+                'ShipmentItem' => {
+                  'BrandKey' => 'DEN',
+                  'Discounts' => nil,
+                  'ProductKey' => 'SNFL13',
+                  'ProductQuantity' => 2,
+                  'ProductUnitPrice' => 22.99
+                }
+              }
+            ],
+            'ShipmentKey' => 1,
+            'ShipmentStatus' => 'SentToFulfillment',
+            'Shipping' => 15,
+            'ShipTo' => {
+              'City' => 'Meridian',
+              'Company' => 'SMITH HOUSING',
+              'Country' => 'US',
+              'DateOfBirth' => DateTime.new(1987, 1, 1),
+              'Email' => 'bob.smith@smith.com',
+              'FirstName' => 'J Robert',
+              'LastName' => 'Love',
+              'Phone' => '770-551-0007',
+              'State' => 'ID',
+              'Street1' => '405 E Fairview Ave',
+              'Zip1' => 83642,
+            }
+          }
+        },
+        'Tags' => nil
+      }
+    })
+  end
+end
+
+Then(/^I should receive error messages$/) do
+  @compliance_status.compliant?.should be_false
+  shipment = @compliance_status.compliance_rules_for_shipment('1')
+  errors = shipment.rules.select { |r| !r.compliant? }
+
+  errors.map(&:rule_description).should == [
+    'Shipments to this region require an excise tax of $.45 per 1 gallon on offsite sales of wine due within 20 days after every month. For a summary of the taxes in the state, click here.',
+    'Shipments to this region for offsite sales require the following shipping label: Alcoholic Beverages - Cannot deliver to intoxicated persons.',
+    'Shipments to this region require sales tax for offsite sales shipments. For a summary of the taxes in the state, click here.',
+    'Shipments to this region have a per customer volume limit of 24 cases per individual per calendar year. The volume will be calculated from combined onsite and offsite sales.',
+    'A license is required for shipping offsite sales and must be renewed every 1 year. The cost of this license is $50.00. Note: Renewal fee is $25..',
+    'Suppliers shipping to this region must submit reporting data for offsite sales due within 1 month after every year. This region requires a periodic report even if no shipments have been made. The following information should be included within the report:  ShipTo Name, ShipTo Address, BillTo Name, Type of Product (Eg: Wine, Sparkling Wine..), Volume of Product, Unit Price, Date of Purchase, Date of Shipment, Invoice Number. .',
+    'Only wines of your own production or bottling are allowed to be shipped to this region. Note: Authorized direct shipping includes "sales by a winery of wine produced or bottled by the winery."..'
+  ]
+end

data/features/step_definitions/credential_steps.rb

@@ -0,0 +1,8 @@
+Given(/^I've added my credentials$/) do
+  ShipCompliant.configure do |c|
+    c.partner_key = ENV.fetch('SHIP_COMPLIANT_KEY')
+    c.username = ENV.fetch('SHIP_COMPLIANT_USER')
+    c.password = ENV.fetch('SHIP_COMPLIANT_PASS')
+    c.log = false
+  end
+end

data/features/step_definitions/inventory_steps.rb

@@ -0,0 +1,36 @@
+When(/^I get inventory details with everthing$/) do
+  VCR.use_cassette('inventory_details_for_everything') do
+    @inventory_results = ShipCompliant::GetInventoryDetails.call({
+      brand_key: 'DEN',
+      fulfillment_location: 'WineShipping',
+      inventory_type: 'All',
+      product_key: '04CHRCAB75'
+    })
+  end
+end
+
+Then(/^I should be able to get the product information$/) do
+  @inventory_results.products_for_location('WineShipping').should be_kind_of(Array)
+  @inventory_results.products_for_location('WineShipping').length.should == 1
+  product = @inventory_results.products_for_location('WineShipping').first
+
+  product.default_case.should == '12x750 mL'
+  product.description.should == 'Capital Hill Reserve Cabernet'
+  product.fulfillment_sku.should == '04CHRCAB75'
+  product.percent_alcohol.should == 13
+  product.product_key.should == '04CHRCAB75'
+  product.product_type.should == 'Wine'
+  product.unit_price.should == 0
+  product.vintage.should == 2011
+  product.volume_amount.should == 750
+  product.volume_ml.should == 750
+  product.volume_unit.should == 'Milliliter'
+end
+
+Then(/^I should inventory levels for a product$/) do
+  product = @inventory_results.products_for_location('WineShipping').first
+  product.inventory_levels.should == {
+    available: 25,
+    reserved: 25
+  }
+end

data/features/step_definitions/product_steps.rb

@@ -0,0 +1,140 @@
+When(/^I add a new product with invalid brand$/) do
+  VCR.use_cassette('product_invalid_brand') do
+    @product_response = ShipCompliant::AddUpdateProduct.product({
+      bottle_size_ms: 750,
+      brand_key: 'DENSNW',
+      default_case: 12,
+      default_wholesale_case_price: 270,
+      description: 'Denver Snow Flake Cab 2013',
+      percent_alcohol: 14.1,
+      product_distribution: 'Both',
+      product_key: 'SNFL13',
+      product_type: 'Wine',
+      unit_price: 49.99,
+      varietal: 'Cabernet Sauvignon',
+      vintage: 2013,
+      volume_amount: 750,
+      volume_unit: 'milliliter'
+    }, update_mode: 'ErrorOnExisting')
+  end
+end
+
+When(/^I add a new product$/) do
+  VCR.use_cassette('product_valid_brand') do
+    @product_response = ShipCompliant::AddUpdateProduct.product({
+      bottle_size_ms: 750,
+      brand_key: 'DEN',
+      default_case: 12,
+      default_wholesale_case_price: 270,
+      description: 'Denver Snow Flake Cab 2013',
+      percent_alcohol: 14.1,
+      product_distribution: 'Both',
+      product_key: 'SNFL13',
+      product_type: 'Wine',
+      unit_price: 49.99,
+      varietal: 'Cabernet Sauvignon',
+      vintage: 2013,
+      volume_amount: 750,
+      volume_unit: 'milliliter'
+    }, update_mode: 'ErrorOnExisting')
+  end
+end
+
+When(/^I add a product that already exists$/) do
+  VCR.use_cassette('product_already_exists') do
+    @product_response = ShipCompliant::AddUpdateProduct.product({
+      bottle_size_ms: 750,
+      brand_key: 'DEN',
+      default_case: 12,
+      default_wholesale_case_price: 270,
+      description: 'Denver Snow Flake Cab 2013',
+      percent_alcohol: 14.1,
+      product_distribution: 'Both',
+      product_key: 'SNFL13',
+      product_type: 'Wine',
+      unit_price: 49.99,
+      varietal: 'Cabernet Sauvignon',
+      vintage: 2013,
+      volume_amount: 750,
+      volume_unit: 'milliliter'
+    }, update_mode: 'ErrorOnExisting')
+  end
+end
+
+When(/^I update a product$/) do
+  VCR.use_cassette('update_product') do
+    @product_response = ShipCompliant::AddUpdateProduct.product({
+      bottle_size_ms: 750,
+      brand_key: 'DEN',
+      default_case: 12,
+      default_wholesale_case_price: 270,
+      description: 'Denver Snow Flake Cab 2013',
+      percent_alcohol: 14.1,
+      product_distribution: 'Both',
+      product_key: 'SNFL13',
+      product_type: 'Wine',
+      unit_price: 49.99,
+      varietal: 'Cabernet Sauvignon',
+      vintage: 2013,
+      volume_amount: 750,
+      volume_unit: 'milliliter'
+    }, update_mode: 'UpdateExisting')
+  end
+end
+
+When(/^I ignore existing product on update$/) do
+  VCR.use_cassette('ignore_existing_product') do
+    @product_response = ShipCompliant::AddUpdateProduct.product({
+      bottle_size_ms: 750,
+      brand_key: 'DEN',
+      default_case: 12,
+      default_wholesale_case_price: 270,
+      description: 'Denver Snow Flake Cab 2013',
+      percent_alcohol: 14.1,
+      product_distribution: 'Both',
+      product_key: 'SNFL13',
+      product_type: 'Wine',
+      unit_price: 49.99,
+      varietal: 'Cabernet Sauvignon',
+      vintage: 2013,
+      volume_amount: 750,
+      volume_unit: 'milliliter'
+    }, update_mode: 'IgnoreExisting')
+  end
+end
+
+Then(/^the product should have been created$/) do
+  @product_response.success?.should be_true
+end
+
+Then(/^I should get a message that the product was updated$/) do
+  @product_response.success?.should be_true
+end
+
+Then(/^I should get an error message for the missing brand$/) do
+  product_response.failure?.should be_true
+  product_response.errors_count.should == 1
+  
+  error = product_response.errors[0]
+  error.code.should == 100
+  error.key.should == 'SNFL13'
+  error.message.should == 'Brand does not exist [DENSNW].'
+  error.target.should == 'Product'
+  error.type.should == 'Validation'
+end
+
+Then(/^I should get an error for already defined product$/) do
+  product_response.failure?.should be_true
+  product_response.errors_count.should == 1
+  
+  error = product_response.errors[0]
+  error.code.should == 2707
+  error.key.should == 'SNFL13'
+  error.message.should == 'Product already exists.'
+  error.target.should == 'Product'
+  error.type.should == 'Validation'
+end
+
+def product_response
+  @product_response #.to_hash[:add_update_product_response][:add_update_product_result]
+end

data/features/step_definitions/sales_order_extended_steps.rb

@@ -0,0 +1,79 @@
+When(/^I search for order information$/) do
+  VCR.use_cassette('sales_order_extended') do
+    @order_result = ShipCompliant::GetSalesOrderExtended.by_order_key('1006890')
+  end
+end
+
+When(/^I search for an invalid order$/) do
+  VCR.use_cassette('sales_order_missing') do
+    @order_result = ShipCompliant::GetSalesOrderExtended.by_order_key('order-404')
+  end
+end
+
+Then(/^I should receive shipment compliance statuses$/) do
+  shipment_compliance = @order_result.compliance_rules_for_shipment('1')
+  shipment_compliance.compliant?.should be_true
+  shipment_compliance.rules.should == []
+end
+
+Then(/^I should receive billing information$/) do
+  billing = @order_result.bill_to
+  billing.should be_kind_of(ShipCompliant::Address)
+
+  billing.city.should == 'St. Paul'
+  billing.company.should == 'SMITH HOUSING'
+  billing.country.should == 'US'
+  billing.county.should be_nil
+  billing.date_of_birth.should == DateTime.new(1987, 1, 1)
+  billing.email.should == 'bob.smith@smith.com'
+  billing.fax.should be_nil
+  billing.first_name.should == 'J Robert'
+  billing.last_name.should == 'Love'
+  billing.phone.should == '(770) 551-0007'
+  billing.state.should == 'MN'
+  billing.street1.should == '444 Cedar Street'
+  billing.street2.should be_nil
+  billing.zip1.should == 55101
+  billing.zip2.should be_nil
+end
+
+Then(/^I should receive shipment information$/) do
+  shipment = @order_result.find_shipment('1')
+  
+  shipment.fulfillment_house.should == 'WineShipping'
+  shipment.fulfillment_exception_reason.should be_nil
+  shipment.fulfillment_exception_type.should == 'None'
+  shipment.fulfillment_status.should == 'Accepted'
+
+  shipment.handling.should == 0
+  shipment.insured_amount.should == 0
+  shipment.shipping.should == 30
+
+  shipment.ship_date.should == DateTime.new(2014, 2, 20, 20, 6)
+  shipment.shipment_status.should == 'Delivered'
+  shipment.shipping_service.should == 'UP2'
+  shipment.special_instructions.should be_nil
+  
+  # Shipment Packages
+  package = shipment.packages.first
+  package.tracking_number.should == '1Z875F62A890362872'
+  package.tracking_status.should == 'Delivered'
+
+  # Ship To Address
+  shipment.ship_to.should be_kind_of(ShipCompliant::Address)
+end
+
+Then(/^I should receive order channel details$/) do
+  details = @order_result.channel_details
+  details.order_channel.should == 'MyOrders'
+end
+
+Then(/^I should receive an error that the order doesn't exist$/) do
+  @order_result.failure?.should be_true
+  error = @order_result.errors.first
+
+  error.code.should == 200
+  error.message.should == 'SalesOrder does not exist [order-404].'
+  error.target.should == 'Null'
+  error.type.should == 'Validation'
+end