shipwire 0.0.5 → 2.0.0

data/spec/features/products_spec.rb

@@ -0,0 +1,282 @@
+require 'spec_helper'
+
+RSpec.describe "Product", type: :feature, vcr: true do
+  context "list" do
+    context "without params" do
+      it "is successful" do
+        VCR.use_cassette("products_list") do
+          response = Shipwire::Products.new.list
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+
+    context "with params" do
+      it "is successful" do
+        VCR.use_cassette("products_list_with_params") do
+          response = Shipwire::Products.new.list(
+            sku: "TEST-PRODUCT"
+          )
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+  end
+
+  context "management" do
+    let!(:product) do
+      VCR.use_cassette("product") do
+        Shipwire::Products.new.create(product_payload)
+      end
+    end
+
+    context "create" do
+      context "multiple products types" do
+        it "is successful" do
+          VCR.use_cassette("product_multiple_create_success") do
+            payload = [
+              product_payload,
+              product_payload("insert"),
+              product_payload("kit"),
+              product_payload("virtual_kit")
+            ]
+
+            response = Shipwire::Products.new.create(payload)
+
+            expect(response.ok?).to be_truthy
+            expect(response.body["resource"]["items"].count).to eq 4
+
+            # Retire products just created
+            items = response.body["resource"]["items"]
+            retire_array = items.each_with_object([]) do |item, hsh|
+              hsh << item["resource"]["id"]
+            end
+            Shipwire::Products.new.retire(retire_array)
+          end
+        end
+
+        it "parts fail when classification is wrong" do
+          VCR.use_cassette("product_multiple_create_fail") do
+            payload = [
+              product_payload,
+              product_payload("insert"),
+              product_payload("kit"),
+              product_payload("virtual_kit")
+            ]
+
+            payload[0].deeper_merge!(
+              classification: "fake"
+            )
+
+            response = Shipwire::Products.new.create(payload)
+
+            expect(response.ok?).to be_falsy
+            expect(response.body["resource"]["items"].count).to eq 3
+            expect(response.validation_errors.first).to include(
+              "message" =>
+                "Product Classification not detected. " +
+                "Please pass classification for each product."
+            )
+
+            # Retire products just created
+            items = response.body["resource"]["items"]
+            retire_array = items.each_with_object([]) do |item, hsh|
+              hsh << item["resource"]["id"]
+            end
+            Shipwire::Products.new.retire(retire_array)
+          end
+        end
+      end
+
+      it "fails when classification is not valid" do
+        VCR.use_cassette("product_create_fail_with_invalid_classification") do
+          payload = product_payload.deeper_merge!(
+            classification: "fake"
+          )
+
+          response = Shipwire::Products.new.create(payload)
+
+          expect(response.ok?).to be_falsy
+          expect(response.validation_errors.first).to include(
+            "message" =>
+              "Product Classification not detected. " +
+              "Please pass classification for each product."
+          )
+        end
+      end
+    end
+
+    context "find" do
+      it "is successful" do
+        VCR.use_cassette("product_find") do
+          product_id = product.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Products.new.find(product_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("product_find_fail") do
+          response = Shipwire::Products.new.find(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Product not found.'
+        end
+      end
+    end
+
+    context "update" do
+      it "is successful" do
+        VCR.use_cassette("product_update") do
+          product_id = product.body["resource"]["items"].first["resource"]["id"]
+
+          payload = product_payload.deeper_merge!(
+            description: "Super awesome description"
+          )
+
+          response = Shipwire::Products.new.update(product_id, payload)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("product_update_fail") do
+          payload = product_payload.deeper_merge!(
+            description: "Super awesome description"
+          )
+
+          response = Shipwire::Products.new.update(0, payload)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Product not found.'
+        end
+      end
+    end
+
+    context "retire" do
+      context "with string passed" do
+        it "is successful" do
+          VCR.use_cassette("product_retire_id") do
+            product_id =
+              product.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Products.new.retire(product_id)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      context "with array passed" do
+        it "is successful" do
+          VCR.use_cassette("product_retire_id") do
+            product_id =
+              product.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Products.new.retire([product_id, 0])
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      context "when product does not exist" do
+        it "is successful" do
+          VCR.use_cassette("product_retire_nonexistent") do
+            response = Shipwire::Products.new.retire(0)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+    end
+
+    # NOTE: This is ugly and massive and I know it. I'm down to change it.
+    def product_payload(type = "base")
+      payload = {
+        sku: FFaker::Product.model,
+        externalId: FFaker::Product.model,
+        description: FFaker::Product.product,
+        classification: "baseProduct",
+        category: "OTHER",
+        batteryConfiguration: "NOBATTERY",
+        values: {
+          costValue: 1,
+          retailValue: 4
+        },
+        dimensions: {
+          length: 1,
+          width: 1,
+          height: 1,
+          weight: 1
+        },
+        flags: {
+          isPackagedReadyToShip: 1,
+          isFragile: 0,
+          isDangerous: 0,
+          isPerishable: 0,
+          isLiquid: 0,
+          isMedia: 0,
+          isAdult: 0,
+          hasInnerPack: 0,
+          hasMasterCase: 0,
+          hasPallet: 0
+        }
+      }
+
+      product_contents = [
+        {
+          externalId: "TEST-PRODUCT",
+          quantity: 1
+        },
+        {
+          externalId: "TEST-PRODUCT2",
+          quantity: 1
+        }
+      ]
+
+      case type
+      when "insert"
+        payload.deeper_merge!(
+          classification: "marketingInsert",
+          dimensions: {
+            height: 0.1,
+            weight: 0.1
+          },
+          masterCase: {
+            individualItemsPerCase: 1,
+            sku: FFaker::Product.model,
+            description: FFaker::Product.product,
+            dimensions: {
+              length: 1,
+              width: 1,
+              height: 1,
+              weight: 1
+            }
+          },
+          inclusionRules: {
+            insertWhenWorthCurrency: "USD"
+          }
+        )
+      when "kit"
+        payload.deeper_merge!(
+          classification: "kit",
+          kitContent: product_contents
+        )
+
+      when "virtual_kit"
+        payload.deeper_merge!(
+          classification: "virtualKit",
+          virtualKitContent: product_contents
+        )
+      end
+
+      payload
+    end
+  end
+end

data/spec/features/rate_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+RSpec.describe "Rate", type: :feature, vcr: true do
+  context "find" do
+    it "is successful with existing items" do
+      VCR.use_cassette("rate_find") do
+        response = Shipwire::Rate.new.find(payload)
+
+        expect(response.ok?).to be_truthy
+        expect(response.body["resource"]["rates"].count).to be >= 1
+      end
+    end
+
+    it "fails with non existing items" do
+      VCR.use_cassette("rate_find_fail") do
+        bad_payload = payload
+        bad_payload[:order][:items][0][:sku] = 'FAKE-PRODUCT'
+
+        response = Shipwire::Rate.new.find(bad_payload)
+
+        expect(response.ok?).to be_falsy
+        expect(response.validation_errors.first).to include(
+          "message" => "unknown SKU 'FAKE-PRODUCT'"
+        )
+      end
+    end
+
+    def payload
+      {
+        options: {
+          currency: "USD",
+          groupBy: "all"
+        },
+        order: {
+          shipTo: {
+            address1: "540 West Boylston St.",
+            city: "Worcester",
+            postalCode: "01606",
+            region: "MA",
+            country: "US"
+          },
+          items: [{
+            sku: "TEST-PRODUCT",
+            quantity: 1
+          }]
+        }
+      }
+    end
+  end
+end

data/spec/features/receivings_spec.rb

@@ -0,0 +1,333 @@
+require 'spec_helper'
+require 'date'
+
+RSpec.describe "Receivings", type: :feature, vcr: true do
+  # Creating, updating, and canceling take an uncommonly long time on Shipwire's
+  # end. Update the timeout to be safe.
+  before { Shipwire.configuration.timeout = 10 }
+
+  context "list" do
+    context "without params" do
+      it "is successful" do
+        VCR.use_cassette("receivings_list") do
+          response = Shipwire::Receivings.new.list
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+
+    context "using params" do
+      it "is successful" do
+        VCR.use_cassette("receivings_list_with_params") do
+          response = Shipwire::Receivings.new.list(
+            status: "canceled"
+          )
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+  end
+
+  context "management" do
+    let!(:receiving) do
+      VCR.use_cassette("receiving") do
+        Shipwire::Receivings.new.create(payload)
+      end
+    end
+
+    context "find" do
+      context "without params" do
+        it "is successful" do
+          VCR.use_cassette("receiving_find") do
+            receiving_id =
+              receiving.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Receivings.new.find(receiving_id)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      context "using params" do
+        it "is successful" do
+          VCR.use_cassette("receiving_find_with_params") do
+            receiving_id =
+              receiving.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Receivings.new.find(receiving_id,
+                                                    expand: "holds")
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("receiving_find_fail") do
+          response = Shipwire::Receivings.new.find(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Receiving Order not found.'
+        end
+      end
+    end
+
+    context "update" do
+      context "without params" do
+        it "is successful" do
+          VCR.use_cassette("receiving_update") do
+            receiving_id =
+              receiving.body["resource"]["items"].first["resource"]["id"]
+
+            payload_updates = { shipFrom: { email: FFaker::Internet.email } }
+            payload_update  = payload.deeper_merge(payload_updates)
+
+            response = Shipwire::Receivings.new.update(receiving_id,
+                                                      payload_update)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      context "using params" do
+        it "is successful" do
+          VCR.use_cassette("receiving_update_with_params") do
+            receiving_id =
+              receiving.body["resource"]["items"].first["resource"]["id"]
+
+            payload_updates = { shipFrom: { email: FFaker::Internet.email } }
+            payload_update  = payload.deeper_merge(payload_updates)
+
+            response = Shipwire::Receivings.new.update(receiving_id,
+                                                      payload_update,
+                                                      expand: "all")
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("receiving_update_fail") do
+          payload_updates = { shipFrom: { email: FFaker::Internet.email } }
+          payload_update  = payload.deeper_merge(payload_updates)
+
+          response = Shipwire::Receivings.new.update(0, payload_update)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq(
+            "Order ID not detected. Please make a POST if you wish to create "\
+            "an order."
+          )
+        end
+      end
+    end
+
+    context "labels_cancel" do
+      it "is successful" do
+        VCR.use_cassette("receiving_cancel_label") do
+          receiving_id =
+            receiving.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Receivings.new.labels_cancel(receiving_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "is successful even when id does not exist" do
+        VCR.use_cassette("receiving_cancel_label_nonexistent") do
+          response = Shipwire::Receivings.new.labels_cancel(0)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+
+    context "holds" do
+      context "without params" do
+        it "is successful" do
+          VCR.use_cassette("receiving_holds") do
+            receiving_id =
+              receiving.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Receivings.new.holds(receiving_id)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      context "using params" do
+        it "is successful" do
+          VCR.use_cassette("receiving_holds_with_params") do
+            receiving_id =
+              receiving.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Receivings.new.holds(receiving_id,
+                                                     includeCleared: 0)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("receiving_holds_fail") do
+          response = Shipwire::Receivings.new.holds(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Receiving Order not found.'
+        end
+      end
+    end
+
+    context "instructions_recipients" do
+      it "is successful" do
+        VCR.use_cassette("receiving_instructions_recipients") do
+          receiving_id =
+            receiving.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Receivings.new.instructions(receiving_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("receiving_instructions_recipients_fail") do
+          response = Shipwire::Receivings.new.instructions(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Receiving Order not found.'
+        end
+      end
+    end
+
+    context "items" do
+      it "is successful" do
+        VCR.use_cassette("receiving_items") do
+          receiving_id =
+            receiving.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Receivings.new.items(receiving_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("receiving_items_fail") do
+          response = Shipwire::Receivings.new.items(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Receiving Order not found.'
+        end
+      end
+    end
+
+    context "shipments" do
+      it "is successful" do
+        VCR.use_cassette("receiving_shipments") do
+          receiving_id =
+            receiving.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Receivings.new.shipments(receiving_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("receiving_shipments_fail") do
+          response = Shipwire::Receivings.new.shipments(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Receiving Order not found.'
+        end
+      end
+    end
+
+    context "trackings" do
+      it "is successful" do
+        VCR.use_cassette("receiving_tracking") do
+          receiving_id =
+            receiving.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Receivings.new.trackings(receiving_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("receiving_tracking_fail") do
+          response = Shipwire::Receivings.new.trackings(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Receiving Order not found.'
+        end
+      end
+    end
+
+    context "cancel" do
+      it "is successful" do
+        VCR.use_cassette("receiving_cancel") do
+          receiving_id =
+            receiving.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Receivings.new.cancel(receiving_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("receiving_cancel") do
+          response = Shipwire::Receivings.new.cancel(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Receiving not found'
+        end
+      end
+    end
+
+    def payload
+      {
+        externalId: FFaker::Product.model,
+        expectedDate: DateTime.now.to_s,
+        arrangement: {
+          type: "none"
+        },
+        items: [{
+          sku: "TEST-PRODUCT",
+          quantity: 5
+        }],
+        shipments: [{
+          length: 1,
+          width: 1,
+          height: 1,
+          weight: 1,
+          type: "box"
+        }],
+        options: {
+          warehouseRegion: "LAX"
+        },
+        shipFrom: {
+          email: FFaker::Internet.email,
+          name: FFaker::Name.name,
+          address1: "540 West Boylston St.",
+          city: "Worcester",
+          state: "MA",
+          postalCode: "01606",
+          country: "US",
+          phone: FFaker::PhoneNumber.short_phone_number
+        }
+      }
+    end
+  end
+end