super_good-solidus_taxjar 0.18.2 → 1.0.0

data/spec/requests/spree/admin/taxjar_settings_request_spec.rb

@@ -0,0 +1,198 @@
+require "spec_helper"
+
+RSpec.describe 'Admin TaxJar Settings', :vcr, type: :request do
+  extend Spree::TestingSupport::AuthorizationHelpers::Request
+  stub_authorization!
+  let(:dummy_api) { instance_double(SuperGood::SolidusTaxjar::Api) }
+
+  around do |example|
+    original = ActionController::Base.allow_forgery_protection
+    ActionController::Base.allow_forgery_protection = false
+    example.run
+    ActionController::Base.allow_forgery_protection = original
+  end
+
+  describe "GET #sync_nexus_regions" do
+    subject { get spree.admin_taxjar_settings_sync_nexus_regions_path }
+
+    context "Taxjar API token is set" do
+      let(:api_token) { ENV.fetch("TAXJAR_API_KEY", "fake_token") }
+
+      before do
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("TAXJAR_API_KEY").and_return(api_token)
+        allow(SuperGood::SolidusTaxjar).to receive(:api).and_return(dummy_api)
+        allow(dummy_api).to receive(:nexus_regions).and_return([])
+      end
+
+      it "makes a request for the nexus regions" do
+        subject
+        expect(dummy_api).to have_received(:nexus_regions)
+      end
+
+      it "redirects back to TaxJar settings" do
+        subject
+        expect(response).to redirect_to "/admin/taxjar_settings"
+      end
+
+      context "Taxjar call is successful" do
+        it "flashes a success alert" do
+          subject
+
+          expect(flash[:success]).to eq("Updated with new Nexus Regions")
+        end
+      end
+
+      context "Taxjar responds with an error" do
+        before do
+          allow(dummy_api).to receive(:nexus_regions).and_raise(Taxjar::Error, "fake error message")
+        end
+
+        it "flashes an error alert" do
+          subject
+
+          expect(flash[:error]).to eq("Failed to complete request to TaxJar: fake error message")
+        end
+      end
+    end
+
+    context "Taxjar API token is not set" do
+      before do
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("TAXJAR_API_KEY").and_return(nil)
+      end
+
+      it "doesn't make a request for the nexus regions" do
+        subject
+        expect(flash[:error]).to eq "Failed to complete request to TaxJar: Not authorized for route 'GET /v2/nexus/regions'"
+      end
+    end
+  end
+
+  describe "GET #sync_tax_categories" do
+    subject { get spree.admin_taxjar_settings_sync_tax_categories_path }
+
+    context "Taxjar API token is set" do
+      let(:api_token) { ENV.fetch("TAXJAR_API_KEY", "fake_token") }
+
+      before do
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("TAXJAR_API_KEY").and_return(api_token)
+        allow(SuperGood::SolidusTaxjar).to receive(:api).and_return(dummy_api)
+        allow(dummy_api).to receive(:tax_categories).and_return([])
+      end
+
+      it "makes a request for the tax categories" do
+        subject
+        expect(dummy_api).to have_received(:tax_categories)
+      end
+
+      it "redirects back to TaxJar settings" do
+        subject
+        expect(response).to redirect_to "/admin/taxjar_settings"
+      end
+
+      context "Taxjar call is successful" do
+        it "flashes a success alert" do
+          subject
+
+          expect(flash[:success]).to eq("Updated with new tax categories")
+        end
+      end
+
+      context "Taxjar responds with an error" do
+        before do
+          allow(dummy_api).to receive(:tax_categories).and_raise(Taxjar::Error, "fake error message")
+        end
+
+        it "flashes an error alert" do
+          subject
+
+          expect(flash[:error]).to eq("Failed to complete request to TaxJar: fake error message")
+        end
+      end
+    end
+
+    context "Taxjar API token is not set" do
+      before do
+        allow(ENV).to receive(:[]).and_call_original
+        allow(ENV).to receive(:[]).with("TAXJAR_API_KEY").and_return(nil)
+      end
+
+      it "doesn't make a request for the tax categories" do
+        subject
+        expect(flash[:error]).to eq "Failed to complete request to TaxJar: Not authorized for route 'GET /v2/categories'"
+      end
+    end
+  end
+
+  describe "PUT #update" do
+    subject { put spree.admin_taxjar_settings_path params: params }
+
+    context "updating TaxJar settings" do
+      let(:taxjar_configuration) { create :taxjar_configuration, :reporting_disabled }
+      let(:params) { {super_good_solidus_taxjar_configuration: {"preferred_reporting_enabled" => "1"}} }
+
+      it "redirects back to TaxJar settings" do
+        subject
+        expect(response).to redirect_to "/admin/taxjar_settings"
+      end
+
+      it "shows a flash message" do
+        subject
+        expect(flash[:success]).to eq "TaxJar settings updated!"
+      end
+
+      it "enables reporting" do
+        expect { subject }
+          .to change { taxjar_configuration.reload.preferred_reporting_enabled }
+            .from(false)
+            .to(true)
+          .and change { taxjar_configuration.reload.preferred_reporting_enabled_at_integer }
+            .from(nil)
+            .to(kind_of(Integer))
+      end
+
+      context "reporting is enabled" do
+        let(:taxjar_configuration) { create :taxjar_configuration, :reporting_enabled }
+        let(:params) { {super_good_solidus_taxjar_configuration: {"preferred_reporting_enabled" => "0"}} }
+
+        it "disables reporting" do
+          expect { subject }
+            .to change { taxjar_configuration.reload.preferred_reporting_enabled }
+              .from(true)
+              .to(false)
+            .and change { taxjar_configuration.reload.preferred_reporting_enabled_at_integer }
+              .from(kind_of(Integer))
+              .to(nil)
+        end
+      end
+
+      context "update fails" do
+        before do
+          allow(SuperGood::SolidusTaxjar).to receive(:configuration).and_return(taxjar_configuration)
+          allow(taxjar_configuration).to receive(:update).and_return(false)
+        end
+
+        it "redirects back to TaxJar settings" do
+          subject
+          expect(response).to redirect_to "/admin/taxjar_settings"
+        end
+
+        it "shows a flash message" do
+          subject
+          expect(flash[:alert]).to eq "Failed to update settings!"
+        end
+      end
+    end
+
+    context "updating a tax category" do
+      let(:tax_category) { create(:tax_category, name: "Bibles", tax_code: "123") }
+      let(:params) { {tax_category: {name: "Bibles", tax_code: "123", id: tax_category.id}, tax_code_id: "81121"} }
+
+      it "updates the tax code" do
+        expect { subject }.to change { tax_category.reload.tax_code }.from("123").to("81121")
+      end
+    end
+  end
+end

data/spec/requests/spree/admin/taxjar_transactions_request_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+RSpec.describe Spree::Admin::TaxjarTransactionsController, type: :request do
+  extend Spree::TestingSupport::AuthorizationHelpers::Request
+
+  stub_authorization!
+
+  let(:dummy_taxjar_client) {
+    instance_double Taxjar::Client,
+      nexus_regions: "fake-value"
+  }
+  let(:order) { with_events_disabled { create :shipped_order } }
+
+  before do
+    create :taxjar_configuration,
+      preferred_reporting_enabled_at_integer: 1.hour.ago
+
+    allow(SuperGood::SolidusTaxjar::Api)
+      .to receive(:default_taxjar_client)
+      .and_return(dummy_taxjar_client)
+  end
+
+  describe "POST #retry" do
+    subject { post "/admin/orders/#{order.number}/taxjar_transaction/retry" }
+
+    context "when the order has TaxJar order transactions" do
+      before do
+        order.taxjar_order_transactions << create(
+          :taxjar_order_transaction,
+          order: order,
+          transaction_id: order.number
+        )
+      end
+
+      let(:dummy_taxjar_order) { instance_double ::Taxjar::Order }
+
+      it "replaces the latest order transaction" do
+        allow(::SuperGood::SolidusTaxjar.api)
+          .to receive(:show_latest_transaction_for)
+          .with(order)
+          .once
+
+        allow(dummy_taxjar_client)
+          .to receive(:show_order)
+          .with(order.taxjar_order_transactions.first.transaction_id)
+          .and_return(instance_double ::Taxjar::Order, amount: "fake-amount")
+
+        expect { subject }
+          .to have_enqueued_job(SuperGood::SolidusTaxjar::ReplaceTransactionJob)
+          .once
+      end
+    end
+
+    context "when the order does not have TaxJar order transactions" do
+      it "reports the initial order transaction" do
+        expect { subject }
+          .to have_enqueued_job(SuperGood::SolidusTaxjar::ReportTransactionJob)
+          .once
+      end
+    end
+  end
+end

data/spec/requests/spree/admin/transaction_sync_batches_request_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::TransactionSyncBatchesController, :vcr, :type => :request do
+  extend Spree::TestingSupport::AuthorizationHelpers::Request
+  stub_authorization!
+
+  around do |example|
+    original = ActionController::Base.allow_forgery_protection
+    ActionController::Base.allow_forgery_protection = false
+    example.run
+    ActionController::Base.allow_forgery_protection = original
+  end
+
+  describe "#create" do
+    subject { post spree.admin_transaction_sync_batches_path }
+
+    let!(:order) { create(:shipped_order) }
+
+    it "creates a batch" do
+      perform_enqueued_jobs do
+        expect { subject }
+          .to change { SuperGood::SolidusTaxjar::TransactionSyncBatch.count }
+          .from(0)
+          .to(1)
+        batch = SuperGood::SolidusTaxjar::TransactionSyncBatch.last
+        expect(batch).to have_attributes({start_date: nil, end_date: nil})
+      end
+    end
+
+    it "creates a log in the batch with an order" do
+      perform_enqueued_jobs do
+        subject
+
+        batch = SuperGood::SolidusTaxjar::TransactionSyncBatch.last
+        expect(batch.transaction_sync_logs.last.order).to eq order
+      end
+    end
+
+    context "user supplies a start date" do
+      subject { post spree.admin_transaction_sync_batches_path, params: {start_date: 1.day.ago.to_date.to_s} }
+
+      it "creates a batch" do
+        perform_enqueued_jobs do
+          expect { subject }
+            .to change { SuperGood::SolidusTaxjar::TransactionSyncBatch.count }
+            .from(0)
+            .to(1)
+          batch = SuperGood::SolidusTaxjar::TransactionSyncBatch.last
+          expect(batch).to have_attributes({start_date: 1.day.ago.to_date, end_date: nil})
+        end
+      end
+
+      context "user supplies start and end date" do
+        subject { post spree.admin_transaction_sync_batches_path, params: {start_date: 1.day.ago.to_date.to_s, end_date: Date.today.to_s} }
+
+        it "creates a batch" do
+          perform_enqueued_jobs do
+            expect { subject }
+              .to change { SuperGood::SolidusTaxjar::TransactionSyncBatch.count }
+              .from(0)
+              .to(1)
+            batch = SuperGood::SolidusTaxjar::TransactionSyncBatch.last
+            expect(batch).to have_attributes({start_date: 1.day.ago.to_date, end_date: Date.today})
+          end
+        end
+      end
+    end
+  end
+
+  describe "#show" do
+    subject { get spree.admin_transaction_sync_batch_path(transaction_sync_batch) }
+
+    let(:error_message) { "Uh Oh" }
+    let(:transaction_sync_batch) { create :transaction_sync_batch, transaction_sync_logs: [transaction_sync_log] }
+    let(:transaction_sync_log) { build :transaction_sync_log, error_message: error_message }
+
+    it "renders the transaction sync log error message" do
+      subject
+      expect(response.body).to include(error_message)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -10,11 +10,54 @@ require File.expand_path("dummy/config/environment.rb", __dir__).tap { |file|
 
 require "solidus_dev_support/rspec/feature_helper"
 
-# Requires supporting ruby files with custom matchers and macros, etc,
-# in spec/support/ and its subdirectories.
-Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }
+require "vcr"
+require "selenium-webdriver"
+
+chrome_options = Selenium::WebDriver::Chrome::Options.new.tap do |options|
+  options.add_argument("--window-size=#{CAPYBARA_WINDOW_SIZE.join(',')}")
+  options.add_argument("--headless") unless ENV["HEADED"]
+  options.add_argument("--disable-gpu")
+end
+
+version = Capybara::Selenium::Driver.load_selenium
+options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+
+Capybara.register_driver :solidus_chrome_headless do |app|
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options_key => chrome_options)
+end
+
+SolidusDevSupport::TestingSupport::Factories.load_for(SuperGoodSolidusTaxjar::Engine)
+
+require "support/solidus_events_helper"
+require "support/checkoutable_store_shared_context"
 
 RSpec.configure do |config|
+  config.include SolidusEventsHelper
   config.infer_spec_type_from_file_location!
   config.use_transactional_fixtures = false
+
+  config.before do
+    Rails.cache.clear
+    if RSpec.current_example.metadata[:js] && page.driver.browser.respond_to?(:url_blacklist)
+      page.driver.browser.url_blacklist = ['https://fonts.googleapis.com']
+    end
+  end
+end
+
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/fixtures/cassettes'
+  config.ignore_localhost = true
+  config.configure_rspec_metadata!
+  config.hook_into :webmock
+  config.ignore_hosts(
+    "chromedriver.storage.googleapis.com",
+    "googlechromelabs.github.io",
+    "edgedl.me.gvt1.com"
+  )
+  config.filter_sensitive_data('<BEARER_TOKEN>') { |interaction|
+    auths = interaction.request.headers['Authorization'].first
+    if (match = auths.match /^Bearer\s+([^,\s]+)/ )
+      match.captures.first
+    end
+  }
 end

data/spec/subscribers/super_good/solidus_taxjar/spree/reporting_subscriber_spec.rb

@@ -0,0 +1,278 @@
+require "spec_helper"
+
+# These tests will excercise either the `ReportingSubscriber` or the
+# `LegacyReportingSubscriber` depending on the version of Solidus they are
+# run against. The loading of the correct subscriber is handled by the
+# initializer added by this extension's install generator.
+RSpec.describe "ReportingSubscriber" do
+  before do
+    create(:taxjar_configuration, preferred_reporting_enabled_at_integer: reporting_enabled_at.to_i)
+  end
+
+  let(:order_factory) { :shipped_order }
+  let(:order) { with_events_disabled { create order_factory } }
+
+  let(:reporting) { instance_spy ::SuperGood::SolidusTaxjar::Reporting }
+  let(:reporting_enabled_at) { 1.hour.ago }
+
+  describe "order_recalculated is fired" do
+    subject do
+      SolidusSupport::LegacyEventCompat::Bus.publish(
+        :order_recalculated,
+        order: order
+      )
+    end
+
+    context "when the order is completed" do
+      context "when the order has not been shipped" do
+        let(:order) {
+          with_events_disabled { create :completed_order_with_totals }
+        }
+
+        it "does nothing" do
+          subject
+
+          assert_no_enqueued_jobs
+        end
+      end
+
+      context "when the order's payment state is 'credit_owed'" do
+        before { order.update(payment_state: "credit_owed") }
+
+        it "does nothing" do
+          subject
+
+          assert_no_enqueued_jobs
+        end
+      end
+
+      context "when the order's payment state is 'paid'" do
+        context "when a TaxJar transaction already exists on the order" do
+          let!(:taxjar_transaction) { create(:taxjar_order_transaction, order: order) }
+
+          let(:dummy_client) { instance_double Taxjar::Client }
+          let(:dummy_response) {
+            instance_double(
+              ::Taxjar::Order,
+              amount: 110.00,
+              line_items: [
+                Taxjar::LineItem.new(
+                  discount: 0,
+                  sales_tax: 9999,
+                  unit_price: 9999
+                )
+              ],
+              sales_tax: 9999999,
+              shipping: 99999,
+              transaction_id: order.number,
+              transaction_date: "2015-05-15T00:00:00Z"
+            )
+          }
+
+          let(:new_dummy_response) {
+            instance_double(
+              ::Taxjar::Order,
+              amount: 333.00,
+              transaction_id: "#{order.number}-1",
+              transaction_date: "2015-05-16T00:00:00Z"
+            )
+          }
+
+          before do
+            allow(SuperGood::SolidusTaxjar::Api)
+              .to receive(:default_taxjar_client)
+              .and_return(dummy_client)
+
+            allow(dummy_client)
+              .to receive(:show_order)
+              .with(taxjar_transaction.transaction_id)
+              .and_return(dummy_response)
+
+            allow(dummy_client)
+              .to receive(:create_refund)
+              .with(
+                SuperGood::SolidusTaxjar::ApiParams
+                  .refund_transaction_params(order, dummy_response)
+              )
+          end
+
+          context "when the TaxJar transaction is up-to-date" do
+            it "does nothing" do
+              subject
+
+              assert_no_enqueued_jobs
+            end
+
+            context "when the order was completed before reporting was enabled" do
+              before do
+                order.update_column(:completed_at, 2.hours.ago)
+              end
+
+              it "does nothing" do
+                expect { subject }.not_to change(
+                  ActiveJob::Base.queue_adapter.enqueued_jobs,
+                  :count
+                )
+              end
+
+              it "creates a sync log" do
+                expect { subject }.to change { order.taxjar_transaction_sync_logs.count }
+                  .from(0).to(1)
+                expect(order.taxjar_transaction_sync_logs.last.status).to eq "error"
+                expect(order.taxjar_transaction_sync_logs.last.error_message)
+                  .to include "Order cannot be synced because it was completed before TaxJar reporting was enabled"
+              end
+            end
+          end
+
+          context "when the TaxJar transaction is not up-to-date" do
+            before do
+              allow(dummy_client).to receive(:nexus_regions)
+              allow(dummy_client).to receive(:tax_for_order)
+              with_events_disabled {
+                customer_return = create :customer_return_with_accepted_items, shipped_order: order
+                reimbursement = create :reimbursement, customer_return: customer_return, total: 10
+                create :refund, reimbursement: reimbursement, payment: order.payments.first, amount: 10
+                order.recalculate
+              }
+            end
+
+            it "enqueues a job to refund and create a new transaction" do
+              assert_enqueued_with(
+                job: SuperGood::SolidusTaxjar::ReplaceTransactionJob,
+                args: [order]
+              ) do
+                subject
+              end
+            end
+
+            context "when the order was completed before reporting was enabled" do
+              before do
+                order.update_column(:completed_at, 2.hours.ago)
+              end
+
+              it "does nothing" do
+                expect { subject }.not_to change(
+                  ActiveJob::Base.queue_adapter.enqueued_jobs,
+                  :count
+                )
+              end
+
+              it "creates a sync log" do
+                expect { subject }.to change { order.taxjar_transaction_sync_logs.count }.from(0).to(1)
+                expect(order.taxjar_transaction_sync_logs.last.status).to eq "error"
+                expect(order.taxjar_transaction_sync_logs.last.error_message).to include "Order cannot be synced because it was completed before TaxJar reporting was enabled"
+              end
+            end
+          end
+        end
+
+        context "when a TaxJar transaction does not exist on the order" do
+          it "enqueues a job to report the transaction" do
+            assert_enqueued_with(
+              job: SuperGood::SolidusTaxjar::ReportTransactionJob,
+              args: [order]
+            ) do
+              subject
+            end
+          end
+        end
+      end
+
+      context "when the order's payment state is 'balance_due'" do
+        let(:order_factory) { :completed_order_with_pending_payment }
+
+        it "does nothing" do
+          subject
+
+          assert_no_enqueued_jobs
+        end
+      end
+    end
+
+    context "when the order is not completed" do
+      let(:order_factory) { :order_with_totals }
+
+      it "does nothing" do
+        subject
+
+        assert_no_enqueued_jobs
+      end
+    end
+  end
+
+  describe "shipment is shipped" do
+    subject { shipment.ship! }
+
+    let(:shipment) { order.shipments.first }
+    let(:order) {
+      with_events_disabled { create :order_ready_to_ship }
+    }
+    let(:reporting) { instance_spy(::SuperGood::SolidusTaxjar::Reporting) }
+
+    context "reporting is enabled" do
+      it "enqueues job to report transaction" do
+        assert_enqueued_with(
+          job: SuperGood::SolidusTaxjar::ReportTransactionJob,
+          args: [shipment.order]
+        ) do
+          subject
+        end
+      end
+
+      it "does not enqueue the replace transaction job" do
+        expect { subject }
+          .to_not have_enqueued_job(SuperGood::SolidusTaxjar::ReplaceTransactionJob)
+      end
+    end
+
+    context "when the order was completed before reporting was enabled" do
+      let(:reporting_enabled_at) { 1.hour.ago }
+      let(:exception_handler) { double }
+
+      before do
+        allow(exception_handler).to receive(:call)
+        order.update_column(:completed_at, 2.hours.ago)
+      end
+
+      around do |example|
+        original_handler = SuperGood::SolidusTaxjar.exception_handler
+        SuperGood::SolidusTaxjar.exception_handler = exception_handler
+        SuperGood::SolidusTaxjar.test_mode = true
+        example.call
+        SuperGood::SolidusTaxjar.test_mode = false
+        SuperGood::SolidusTaxjar.exception_handler = original_handler
+      end
+
+      it "doesn't queue job to report the transaction" do
+        expect { subject }
+          .to_not have_enqueued_job(SuperGood::SolidusTaxjar::ReportTransactionJob)
+      end
+
+      it "doesn't queue job to replace the transaction" do
+        expect { subject }
+          .to_not have_enqueued_job(SuperGood::SolidusTaxjar::ReplaceTransactionJob)
+      end
+
+      it "creates a sync log" do
+        expect { subject }.to change { order.taxjar_transaction_sync_logs.count }.from(0).to(1)
+        expect(order.taxjar_transaction_sync_logs.last.status).to eq "error"
+        expect(order.taxjar_transaction_sync_logs.last.error_message)
+          .to include(
+            "Order cannot be synced because it was completed before " \
+            "TaxJar reporting was enabled"
+          )
+      end
+
+      it "calls the exception handler" do
+        subject
+        expect(exception_handler).to have_received(:call)
+          .with(
+            RuntimeError.new(
+              "Order cannot be synced because it was completed before TaxJar " \
+              "reporting was enabled")
+          )
+      end
+    end
+  end
+end