shipwire 0.0.5 → 2.0.0

data/spec/features/returns_spec.rb

@@ -0,0 +1,239 @@
+require 'spec_helper'
+
+RSpec.describe "Returns", type: :feature, vcr: true do
+  context "list" do
+    context "without params" do
+      it "is successful" do
+        VCR.use_cassette("returns_list") do
+          response = Shipwire::Returns.new.list
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+
+    context "using params" do
+      it "is successful" do
+        VCR.use_cassette("returns_list_with_params") do
+          response = Shipwire::Returns.new.list(
+            status: "canceled"
+          )
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+  end
+
+  context "management" do
+    # Took me WAY too long to realize I can't use the variable `return`
+    let!(:return_order) do
+      VCR.use_cassette("return") do
+        items = [{
+          sku: "TEST-PRODUCT",
+          quantity: 1
+        }]
+
+        order = Shipwire::Orders.new.create(
+          orderNo: FFaker::Product.model,
+          items: items,
+          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
+          }
+        )
+
+        order_id = order.body["resource"]["items"].first["resource"]["id"]
+
+        # There is an issue with returns. You can't create an order, then
+        # immediately return it. This is the functionality that a test would be
+        # doing. There is some kind of processing that needs to happen on
+        # Shipwire's end. Whatever needs to happen on their end takes time. The
+        # only way I was ever able to get the returns to work was to put a
+        # `binding.pry` between the part where it create an order and the part
+        # where it returns the order. Let it sit for about 5 minutes. Take a
+        # restroom break. Eat a snack. Then let the tests continue as normal.
+        Shipwire::Returns.new.create(
+          originalOrder: {
+            id: order_id
+          },
+          items: items,
+          options: {
+            emailCustomer: 0
+          }
+        )
+      end
+    end
+
+    context "find" do
+      context "without params" do
+        it "is successful" do
+          VCR.use_cassette("return_find") do
+            return_id =
+              return_order.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Returns.new.find(return_id)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      context "using params" do
+        it "is successful" do
+          VCR.use_cassette("return_find_with_params") do
+            return_id =
+              return_order.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Returns.new.find(return_id, expand: "items")
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("return_find_fail") do
+          response = Shipwire::Returns.new.find(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Receiving Order not found.'
+        end
+      end
+    end
+
+    context "holds" do
+      context "without params" do
+        it "is successful" do
+          VCR.use_cassette("return_holds") do
+            return_id =
+              return_order.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Returns.new.holds(return_id)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      context "using params" do
+        it "is successful" do
+          VCR.use_cassette("return_holds_with_params") do
+            return_id =
+              return_order.body["resource"]["items"].first["resource"]["id"]
+
+            response = Shipwire::Returns.new.holds(return_id, includeCleared: 0)
+
+            expect(response.ok?).to be_truthy
+          end
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("return_holds_fail") do
+          response = Shipwire::Returns.new.holds(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("return_items") do
+          return_id =
+            return_order.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Returns.new.items(return_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("return_items_fail") do
+          response = Shipwire::Returns.new.items(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("return_trackings") do
+          return_id =
+            return_order.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Returns.new.trackings(return_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("return_trackings_fail") do
+          response = Shipwire::Returns.new.trackings(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Receiving Order not found.'
+        end
+      end
+    end
+
+    context "labels" do
+      it "is successful" do
+        VCR.use_cassette("return_labels") do
+          return_id =
+            return_order.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Returns.new.labels(return_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("return_labels_fail") do
+          response = Shipwire::Returns.new.labels(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Receiving Label not found.'
+        end
+      end
+    end
+
+    context "cancel" do
+      it "is successful" do
+        VCR.use_cassette("return_cancel") do
+          return_id =
+            return_order.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Returns.new.cancel(return_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("return_cancel_fail") do
+          response = Shipwire::Returns.new.cancel(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Return Order not found.'
+        end
+      end
+    end
+  end
+end

data/spec/features/secret_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+RSpec.describe "Secret", type: :feature, vcr: true do
+  context "list" do
+    it "is successful" do
+      VCR.use_cassette("secret_list") do
+        response = Shipwire::Secret.new.list
+
+        expect(response.ok?).to be_truthy
+      end
+    end
+  end
+
+  context "management" do
+    let!(:secret) do
+      VCR.use_cassette("secret") do
+        Shipwire::Secret.new.create
+      end
+    end
+
+    context "find" do
+      it "is successful" do
+        VCR.use_cassette("secret_find") do
+          secret_id = secret.body["resource"]["id"]
+
+          response = Shipwire::Secret.new.find(secret_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("secret_find_fail") do
+          # ID 0 returns data for an existing secret at index 0 instead of a
+          # not found. Shipwire considers this an unintended feature or shortcut
+          # rather than a bug. So use 1 instead of 0.
+          response = Shipwire::Secret.new.find(1)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Not found'
+        end
+      end
+    end
+
+    context "remove" do
+      it "is successful" do
+        VCR.use_cassette("secret_remove") do
+          secret_id = secret.body["resource"]["id"]
+
+          response = Shipwire::Secret.new.remove(secret_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+  end
+end

data/spec/features/stock_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+RSpec.describe "Stock", type: :feature, vcr: true do
+  context "list" do
+    context "without params" do
+      it "is successful" do
+        VCR.use_cassette("stock_without_params") do
+          response = Shipwire::Stock.new.list
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+
+    context "with params" do
+      it "is successful" do
+        VCR.use_cassette("stock_with_params") do
+          response = Shipwire::Stock.new.list(
+            sku: "TEST-PRODUCT"
+          )
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+
+    context "with params and non-existant SKU" do
+      it "is successful" do
+        # Returns a successful result. There is just no records in the result
+        # set because they were all filtered out. There are no errors.
+        VCR.use_cassette("stock_with_params_no_sku") do
+          response = Shipwire::Stock.new.list(
+            sku: "FAKE-PRODUCT"
+          )
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+  end
+end

data/spec/features/webhooks_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+RSpec.describe "Webhooks", type: :feature, vcr: true do
+  context "list" do
+    it "is successful" do
+      VCR.use_cassette("webhooks_list") do
+        response = Shipwire::Webhooks.new.list
+
+        expect(response.ok?).to be_truthy
+      end
+    end
+  end
+
+  context "management" do
+    let(:webhook_topic)      { "order.created" }
+    let(:webhook_url)        { "https://www.shipwire.com/" }
+    let(:webhook_url_update) { "https://www.shipwire.com/about/" }
+
+    let!(:webhook) do
+      VCR.use_cassette("webhook") do
+        Shipwire::Webhooks.new.create(
+          topic: webhook_topic,
+          url:   webhook_url
+        )
+      end
+    end
+
+    context "create" do
+      it "fails with non-https callback URL" do
+        VCR.use_cassette("webhooks_create_insecure") do
+          response = Shipwire::Webhooks.new.create(
+            topic: webhook_topic,
+            url:   "http://www.reddit.com/"
+          )
+
+          expect(response.ok?).to be_falsy
+          expect(response.validation_errors).to include('Invalid URL')
+        end
+      end
+    end
+
+    context "find" do
+      it "is successful" do
+        VCR.use_cassette("webhooks_find") do
+          webhook_id = webhook.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Webhooks.new.find(webhook_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("webhooks_find_fail") do
+          response = Shipwire::Webhooks.new.find(0)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq 'Subscription not found.'
+        end
+      end
+    end
+
+    context "update" do
+      it "is successful" do
+        VCR.use_cassette("webhooks_update") do
+          webhook_id = webhook.body["resource"]["items"].first["resource"]["id"]
+
+          payload = {
+            topic: webhook_topic,
+            url:   webhook_url_update
+          }
+
+          response = Shipwire::Webhooks.new.update(webhook_id, payload)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+
+      it "fails when id does not exist" do
+        VCR.use_cassette("webhooks_update_fail") do
+          payload = {
+            topic: webhook_topic,
+            url:   webhook_url_update
+          }
+
+          response = Shipwire::Webhooks.new.update(0, payload)
+
+          expect(response.ok?).to be_falsy
+          expect(response.error_summary).to eq "Invalid request"
+        end
+      end
+    end
+
+    context "remove" do
+      it "is successful" do
+        VCR.use_cassette("webhooks_remove") do
+          webhook_id = webhook.body["resource"]["items"].first["resource"]["id"]
+
+          response = Shipwire::Webhooks.new.remove(webhook_id)
+
+          expect(response.ok?).to be_truthy
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,20 +1,41 @@
-require 'rspec'
-require 'mocha/api'
-require 'shipwire'
+# Coverage report
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+# Environment
+ENV['RAILS_ENV'] = 'test'
 
-require 'dotenv'
+require 'rspec'
+require 'ffaker'
 require 'pry'
-Dotenv.load
 
-Shipwire.configure do |config|
-  config.endpoint = ENV['SHIPWIRE_ENDPOINT']
-  config.server = ENV['SHIPWIRE_SERVER']
-  config.username = ENV['SHIPWIRE_USERNAME']
-  config.password = ENV['SHIPWIRE_PASSWORD']
-end
+require 'shipwire'
 
 Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
 
 RSpec.configure do |config|
-  config.mock_framework = :mocha
+  config.deprecation_stream = 'rspec.log'
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.disable_monkey_patching!
+
+  config.warnings = false
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  # config.profile_examples = 10
 end