shipwire 0.0.5 → 2.0.0

data/spec/features/orders_spec.rb

@@ -0,0 +1,280 @@
+require 'spec_helper'
+
+RSpec.describe "Orders", type: :feature, vcr: true do
+  context "list" do
+    context "without params" do
+      it "is successful" do
+        VCR.use_cassette("orders_list") do
+          response = Shipwire::Orders.new.list
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+
+    context "with params" do
+      it "is successful" do
+        VCR.use_cassette("orders_list_with_params") do
+          response = Shipwire::Orders.new.list(
+            status: "canceled"
+          )
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+  end
+
+  context "management" do
+    let(:payload) do
+      order_number = (0...8).map { (65 + rand(26)).chr }.join
+
+      {
+        orderNo: order_number,
+        externalId: order_number,
+        items: [
+          {
+            sku: "TEST-PRODUCT",
+            quantity: 1
+          }
+        ],
+        options: {
+          currency: "USD"
+        },
+        shipTo: {
+          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
+
+    let(:payload_update) do
+      payload.deeper_merge(options: { currency: "MXN" })
+    end
+
+    let!(:order) do
+      VCR.use_cassette("order") do
+        Shipwire::Orders.new.create(payload)
+      end
+    end
+
+    context "create with warnings" do
+      it "is successful" do
+        VCR.use_cassette("order_with_warnings") do
+          response = Shipwire::Orders.new.create(payload)
+
+          expect(response.ok?).to be_truthy
+          expect(response.has_warnings?).to be_truthy
+          expect(response.warnings).to include(
+            "Order was marked residential; now marked commercial"
+          )
+
+          # Cancel the order
+          order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+          Shipwire::Orders.new.cancel(order_id)
+        end
+      end
+    end
+
+    context "find" do
+      context "without params" do
+        it "is successful" do
+          VCR.use_cassette("order_find") do
+            order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Orders.new.find(order_id)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      context "with params" do
+        it "is successful" do
+          VCR.use_cassette("order_find_with_params") do
+            order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Orders.new.find(order_id, expand: "trackings")
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("order_find_fail") do
+          response = Shipwire::Orders.new.find(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Order not found.'
+        end
+      end
+    end
+
+    context "update" do
+      context "without params" do
+        it "is successful" do
+          VCR.use_cassette("order_update") do
+            order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Orders.new.update(order_id, payload_update)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      context "with params" do
+        it "is successful" do
+          VCR.use_cassette("order_update_with_params") do
+            order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Orders.new.update(order_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("order_update_fail") do
+          response = Shipwire::Orders.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 "items" do
+      it "is successful" do
+        VCR.use_cassette("order_items") do
+          order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Orders.new.items(order_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("order_items_fail") do
+          response = Shipwire::Orders.new.items(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Order not found.'
+        end
+      end
+    end
+
+    context "holds" do
+      context "without params" do
+        it "is successful" do
+          VCR.use_cassette("order_holds") do
+            order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Orders.new.holds(order_id)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      context "with params" do
+        it "is successful" do
+          VCR.use_cassette("order_holds_with_params") do
+            order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Orders.new.holds(order_id, includeCleared: 1)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("order_holds_fail") do
+          response = Shipwire::Orders.new.holds(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Order not found.'
+        end
+      end
+    end
+
+    context "returns" do
+      it "is successful" do
+        VCR.use_cassette("order_returns") do
+          order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Orders.new.returns(order_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("order_returns_fail") do
+          response = Shipwire::Orders.new.returns(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Order not found.'
+        end
+      end
+    end
+
+    context "trackings" do
+      it "is successful" do
+        VCR.use_cassette("order_trackings") do
+          order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Orders.new.trackings(order_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("order_trackings_fail") do
+          response = Shipwire::Orders.new.trackings(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Order not found.'
+        end
+      end
+    end
+
+    context "cancel" do
+      it "is successful" do
+        VCR.use_cassette("order_cancel") do
+          order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Orders.new.cancel(order_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("order_cancel_fail") do
+          response = Shipwire::Orders.new.cancel(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Order not found'
+        end
+      end
+    end
+  end
+end

data/spec/features/product_types_spec.rb

@@ -0,0 +1,219 @@
+require 'spec_helper'
+
+RSpec.describe "Product", type: :feature, vcr: true do
+  %w(base insert kit virtual_kit).each do |product_type|
+    context "type #{product_type}" do
+      let(:product_class) do
+        type = Shipwire::Utility.camelize(product_type)
+
+        Object.const_get("Shipwire::Products::#{type}")
+      end
+
+      context "list" do
+        context "without params" do
+          it "is successful" do
+            VCR.use_cassette("products_#{product_type}_list") do
+              response = product_class.new.list
+
+              expect(response.ok?).to be_truthy
+            end
+          end
+        end
+
+        context "with params" do
+          it "is successful" do
+            VCR.use_cassette("products_#{product_type}_list_with_params") do
+              response = product_class.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_#{product_type}") do
+            product_class.new.create(payload(product_type))
+          end
+        end
+
+        context "find" do
+          it "is successful" do
+            VCR.use_cassette("product_#{product_type}_find") do
+              product_id =
+                product.body["resource"]["items"].first["resource"]["id"]
+
+              response = product_class.new.find(product_id)
+
+              expect(response.ok?).to be_truthy
+            end
+          end
+
+          it "fails when id does not exist" do
+            VCR.use_cassette("product_#{product_type}_find_fail") do
+              response = product_class.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_#{product_type}_update") do
+              product_id =
+                product.body["resource"]["items"].first["resource"]["id"]
+
+              payload = payload(product_type).deeper_merge!(
+                description: "Super awesome description"
+              )
+
+              response = product_class.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_#{product_type}_update_fail") do
+              payload = payload(product_type).deeper_merge!(
+                description: "Super awesome description"
+              )
+
+              response = product_class.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_#{product_type}_retire_id") do
+                product_id =
+                  product.body["resource"]["items"].first["resource"]["id"]
+
+                response = product_class.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_#{product_type}_retire_id") do
+                product_id =
+                  product.body["resource"]["items"].first["resource"]["id"]
+
+                response = product_class.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_#{product_type}_retire_nonexistent") do
+                response = product_class.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 payload(type)
+          payload = {
+            sku: FFaker::Product.model,
+            externalId: FFaker::Product.model,
+            description: FFaker::Product.product,
+            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
+            }
+          }
+
+          # First of all, to create a Kit or Virtual Kit, the base products HAVE
+          # to exist. They will not be created here. Kits require 2 ore more
+          # products.
+          # Next, `externalId` is NOT the same as the product SKU. An externalId
+          # currently cannot be set using the Shipwire website. It can only be
+          # set by creating a product through the API or updating an existing
+          # product using the API and setting a value for externalID.
+          # Otherwise instead of `externalID` you can use `productID` which is
+          # the unique Shipwire ID for that product
+          product_contents = [
+            {
+              externalId: "TEST-PRODUCT",
+              quantity: 1
+            },
+            {
+              externalId: "TEST-PRODUCT2",
+              quantity: 1
+            }
+          ]
+
+          case type
+          when "insert"
+            payload.deeper_merge!(
+              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!(kitContent: product_contents)
+
+          when "virtual_kit"
+            payload.deeper_merge!(virtualKitContent: product_contents)
+          end
+
+          payload
+        end
+      end
+    end
+  end
+end