super_good-solidus_taxjar 0.18.2 → 1.0.0

data/spec/jobs/super_good/solidus_taxjar/backfill_transaction_sync_batch_job_spec.rb

@@ -0,0 +1,117 @@
+require "spec_helper"
+
+RSpec.describe SuperGood::SolidusTaxjar::BackfillTransactionSyncBatchJob do
+  describe "#perform" do
+    subject do
+      perform_enqueued_jobs do
+        described_class.new.perform(batch)
+      end
+    end
+
+    let!(:shipped_order) { create :shipped_order }
+    let(:reporting_mock) { instance_double ::SuperGood::SolidusTaxjar::Reporting }
+    let(:test_transaction_id) { "R1234-transaction" }
+    let(:batch) { create :transaction_sync_batch }
+
+    around do |example|
+      ::SuperGood::SolidusTaxjar.test_mode = true
+      example.run
+      ::SuperGood::SolidusTaxjar.test_mode = false
+    end
+
+    before do
+      reported_order = create :shipped_order
+      create(:taxjar_order_transaction, order: reported_order)
+      create :order_ready_to_ship
+
+      unreported_transaction = build(:taxjar_order_transaction, order: shipped_order, transaction_id: test_transaction_id)
+
+      allow(SuperGood::SolidusTaxjar).to receive(:reporting).and_return(reporting_mock)
+      allow(reporting_mock).to receive(:show_or_create_transaction) do
+        unreported_transaction.save!
+        unreported_transaction
+      end
+    end
+
+    it "reports the transaction to TaxJar" do
+      subject
+
+      expect(reporting_mock).to have_received(:show_or_create_transaction).with(shipped_order)
+    end
+
+    it "creates a log of each synced order in the database" do
+      subject
+      expect(batch.transaction_sync_logs.count).to eq(1)
+      expect(batch.transaction_sync_logs.last.order).to eq(shipped_order)
+    end
+
+    it "records the associated order, taxjar transaction, and status on each log" do
+      subject
+      sync_log = batch.transaction_sync_logs.last
+
+      expect(sync_log).to have_attributes(
+        order: shipped_order,
+        status: "success"
+      )
+      expect(sync_log.order_transaction).not_to be_nil
+    end
+
+    context "when the transaction cannot be created on TaxJar" do
+      before do
+        allow(reporting_mock)
+          .to receive(:show_or_create_transaction)
+          .and_raise(Taxjar::Error.new("api down"))
+      end
+
+      it "records a failure status in the log" do
+        subject
+        sync_log = batch.transaction_sync_logs.last
+
+        expect(sync_log).to have_attributes(
+          order: shipped_order,
+          status: "error",
+          error_message: /api down/
+        )
+
+        expect(sync_log.order_transaction).to be_nil
+      end
+    end
+
+    context "batch has start date" do
+      let(:batch) { create :transaction_sync_batch, start_date: 2.days.ago.to_date }
+      let(:start_date) { 2.days.ago.to_date }
+
+      before do
+        old_order = create :shipped_order
+        old_order.update_column(:completed_at, 3.days.ago)
+
+        shipped_order.update_column(:completed_at, Date.today.end_of_day)
+      end
+
+      it "syncs orders in the date range" do
+        subject
+        expect(batch.orders).to contain_exactly(shipped_order)
+      end
+
+    end
+
+    context "batch has start and end date" do
+      let(:batch) { create :transaction_sync_batch, start_date: 3.days.ago.to_date, end_date: 2.days.ago.to_date } 
+
+      before do
+        old_order = create :shipped_order
+        old_order.update_column(:completed_at, 4.days.ago)
+
+        new_order = create :shipped_order
+        new_order.update_column(:completed_at, Date.today.end_of_day)
+
+        shipped_order.update_column(:completed_at, 2.days.ago)
+      end
+
+      it "syncs orders in the date range" do
+        subject
+        expect(batch.orders).to contain_exactly(shipped_order)
+      end
+    end
+  end
+end

data/spec/jobs/super_good/solidus_taxjar/replace_transaction_job_spec.rb

@@ -0,0 +1,95 @@
+require "spec_helper"
+
+RSpec.describe SuperGood::SolidusTaxjar::ReplaceTransactionJob do
+  describe ".perform_later" do
+    subject { described_class.perform_later(order) }
+
+    let(:order) { create :order }
+    let(:mock_reporting) { instance_double ::SuperGood::SolidusTaxjar::Reporting }
+    let(:fake_order_transaction) { create :taxjar_order_transaction }
+    let!(:fake_refund_transaction) { create :taxjar_refund_transaction, order_transaction: fake_order_transaction }
+
+    before do
+      allow(mock_reporting)
+        .to receive(:refund_and_create_new_transaction)
+        .and_return(fake_order_transaction)
+      allow(SuperGood::SolidusTaxjar)
+        .to receive(:reporting)
+        .and_return(mock_reporting)
+    end
+
+    it "enqueues the job" do
+      assert_enqueued_with(job: described_class, args: [order]) do
+        subject
+      end
+    end
+
+    it "replaces the transaction when it performs the job" do
+      perform_enqueued_jobs do
+        subject
+      end
+
+      expect(mock_reporting)
+        .to have_received(:refund_and_create_new_transaction)
+        .with(order)
+    end
+
+    it "creates multiple transaction sync logs with the order transactions and refund transactions" do
+      expect { perform_enqueued_jobs { subject } }
+        .to change { ::SuperGood::SolidusTaxjar::TransactionSyncLog.count }
+        .by(1)
+
+      expect(::SuperGood::SolidusTaxjar::TransactionSyncLog.last)
+        .to have_attributes(
+          status: "success",
+          refund_transaction: fake_refund_transaction,
+          order_transaction: fake_order_transaction
+        )
+    end
+
+    context "when a replacing the transaction has already partially succeeded" do
+      let(:fake_order_transaction) { create :taxjar_order_transaction }
+      let(:fake_refund_transaction) { nil }
+
+      before do
+        allow(mock_reporting)
+          .to receive(:refund_and_create_new_transaction)
+          .and_return(fake_order_transaction)
+      end
+
+      it "creates a transaction sync log with the order transaction" do
+        expect { perform_enqueued_jobs { subject } }
+          .to change { ::SuperGood::SolidusTaxjar::TransactionSyncLog.count }
+          .by(1)
+
+        expect(::SuperGood::SolidusTaxjar::TransactionSyncLog.last)
+          .to have_attributes(
+            status: "success",
+            order_transaction: fake_order_transaction,
+            refund_transaction: nil
+          )
+      end
+    end
+
+    context "when replacing the transaction throws an error" do
+      before do
+        allow(mock_reporting)
+          .to receive(:refund_and_create_new_transaction)
+          .and_raise(Taxjar::Error.new("something bad"))
+      end
+
+      it "creates a transaction sync log with the error message" do
+        expect { perform_enqueued_jobs {subject} }
+          .to change { ::SuperGood::SolidusTaxjar::TransactionSyncLog.count }
+          .from(0)
+          .to(1)
+
+        expect(::SuperGood::SolidusTaxjar::TransactionSyncLog.last)
+          .to have_attributes(
+            status: "error",
+            error_message: "something bad"
+          )
+      end
+    end
+  end
+end

data/spec/jobs/super_good/solidus_taxjar/report_transaction_job_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+RSpec.describe SuperGood::SolidusTaxjar::ReportTransactionJob do
+  describe ".perform_now" do
+    subject { described_class.perform_now(order) }
+
+    let(:order) { create :order }
+    let(:mock_reporting) { instance_double ::SuperGood::SolidusTaxjar::Reporting }
+    let(:fake_order_transaction) { create :taxjar_order_transaction }
+
+    before do
+      allow(mock_reporting)
+        .to receive(:show_or_create_transaction)
+        .and_return(fake_order_transaction)
+      allow(SuperGood::SolidusTaxjar).to receive(:reporting).and_return(mock_reporting)
+    end
+
+    it "reports the transaction when it performs the job" do
+      subject
+
+      expect(mock_reporting).to have_received(:show_or_create_transaction).with(order)
+    end
+
+    it "creates a transaction sync log with the order transaction" do
+      expect { subject }
+        .to change { ::SuperGood::SolidusTaxjar::TransactionSyncLog.count }
+        .from(0)
+        .to(1)
+
+      expect(::SuperGood::SolidusTaxjar::TransactionSyncLog.last)
+        .to have_attributes(
+          status: "success",
+          order_transaction: fake_order_transaction
+        )
+    end
+
+    context "when a transaction sync batch is passed" do
+      subject { described_class.perform_now(order, transaction_sync_batch) }
+
+      let(:transaction_sync_batch) { create :transaction_sync_batch }
+
+      it "creates a transaction sync log associated with the given batch" do
+        expect { subject }
+          .to change { ::SuperGood::SolidusTaxjar::TransactionSyncLog.count }
+          .from(0)
+          .to(1)
+
+        expect(::SuperGood::SolidusTaxjar::TransactionSyncLog.last)
+          .to have_attributes(
+            transaction_sync_batch: transaction_sync_batch
+          )
+      end
+    end
+
+    context "when syncing to taxjar fails" do
+      before do
+        allow(mock_reporting)
+        .to receive(:show_or_create_transaction)
+        .and_raise(Taxjar::Error.new("something bad"))
+      end
+
+      it "creates a transaction sync log with the error message" do
+        expect { subject }
+          .to change { ::SuperGood::SolidusTaxjar::TransactionSyncLog.count }
+          .from(0)
+          .to(1)
+
+        expect(::SuperGood::SolidusTaxjar::TransactionSyncLog.last)
+          .to have_attributes(
+            status: "error",
+            error_message: "something bad"
+          )
+      end
+    end
+  end
+end

data/spec/models/super_good/solidus_taxjar/configuration_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+RSpec.describe SuperGood::SolidusTaxjar::Configuration do
+  describe "is valid" do
+    subject { taxjar_configuration.valid? }
+
+    let(:taxjar_configuration) { create(:taxjar_configuration) }
+
+    it "is valid" do
+      expect(subject).to be_truthy
+    end
+  end
+
+  describe "#preferred_reporting_enabled" do
+    subject { taxjar_configuration.preferred_reporting_enabled }
+
+    let(:taxjar_configuration) { create(:taxjar_configuration) }
+
+    it "has the default value" do
+      expect(subject).to be_falsey
+    end
+
+    context "reporting_enabled_at is set in the past" do
+      let(:taxjar_configuration) { create(:taxjar_configuration, preferred_reporting_enabled_at_integer: DateTime.now.to_i) }
+
+      it "is true" do
+        expect(subject).to be_truthy
+      end
+    end
+
+    context "reporting_enabled_at is set in the future" do
+      let(:taxjar_configuration) { create(:taxjar_configuration, preferred_reporting_enabled_at_integer: (DateTime.now + 1.day).to_i) }
+
+      it "is false" do
+        expect(subject).to be_falsy
+      end
+    end
+  end
+
+  describe "#preferred_reporting_enabled_at" do
+    subject { taxjar_configuration.preferred_reporting_enabled_at }
+
+    let(:taxjar_configuration) { create(:taxjar_configuration, preferred_reporting_enabled_at_integer: datetime_integer) }
+    let(:datetime_integer) { 1675116247 }
+
+    it "parses the integer datetime" do
+      expect(subject).to eq DateTime.parse("Mon, 30 Jan 2023 22:04:07 +0000")
+    end
+  end
+
+  describe ".default" do
+    subject { described_class.default }
+
+    context "configuration exists" do
+      let!(:taxjar_configuration) { create :taxjar_configuration }
+
+      it "returns the default configuration" do
+        expect(subject).to eq(taxjar_configuration)
+      end
+    end
+
+    context "configuration doesn't exist" do
+      it "creates the default config" do
+        expect { subject }.to change { described_class.count }.from(0).to(1)
+      end
+
+      it "returns a config" do
+        expect(subject).to be_instance_of(described_class)
+      end
+
+      context "calling default more than once" do
+        it "creates only one config" do
+          described_class.default
+          expect { subject }.to_not change { described_class.count }.from(1)
+        end
+      end
+    end
+  end
+end

data/spec/models/super_good/solidus_taxjar/order_transaction_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+RSpec.describe SuperGood::SolidusTaxjar::OrderTransaction do
+  describe ".latest_for" do
+    subject { described_class.latest_for(order) }
+
+    let(:order) { create(:order) }
+
+    context "when there are no order transactions" do
+      it { is_expected.to be_nil }
+    end
+
+    context "when there are one or more order transactions" do
+      let(:transaction_date) { 1.day.ago }
+
+      let!(:first_order_transaction) {
+        create(
+          :taxjar_order_transaction,
+          transaction_date: transaction_date,
+          order: order
+        )
+      }
+      let!(:latest_order_transaction) {
+        create(
+          :taxjar_order_transaction,
+          transaction_date: transaction_date,
+          order: order
+        )
+      }
+
+      it "returns the most recent order transaction" do
+        expect(subject).to eq latest_order_transaction
+      end
+    end
+  end
+end

data/spec/models/super_good/solidus_taxjar/transaction_sync_batch_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+RSpec.describe SuperGood::SolidusTaxjar::TransactionSyncBatch do
+  describe "#status" do
+    subject { transaction_sync_batch.status }
+
+    let(:transaction_sync_batch) { create(:transaction_sync_batch, transaction_sync_logs: transaction_sync_logs) }
+
+    context "all logs have status 'success'" do
+      let(:transaction_sync_logs) { build_list(:transaction_sync_log, 2, status: :success) }
+
+      it "returns 'success'" do
+        expect(subject).to eq "success"
+      end
+    end
+
+    context "one or more logs have status 'error'" do
+      let(:transaction_sync_logs) { [
+        build(:transaction_sync_log, status: :success),
+        build(:transaction_sync_log, status: :error)
+      ] }
+
+      it "returns 'error'" do
+        expect(subject).to eq "error"
+      end
+    end
+
+    context "one or more logs have status 'processing'" do
+      let(:transaction_sync_logs) { [
+        build(:transaction_sync_log, status: :success),
+        build(:transaction_sync_log, status: :processing),
+        build(:transaction_sync_log, status: :error)
+      ] }
+
+      it "returns 'processing'" do
+        expect(subject).to eq "processing"
+      end
+    end
+
+    context "with an empty batch" do
+      let(:transaction_sync_logs) { [] }
+
+      it "returns 'success'" do
+        expect(subject).to eq "success"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Admin::OrdersController, :type => :request do
+  include Capybara::RSpecMatchers
+
+  extend Spree::TestingSupport::AuthorizationHelpers::Request
+  stub_authorization!
+
+  describe "#edit" do
+    subject { get spree.edit_admin_order_path(order) }
+
+    let!(:order) { create(:shipped_order) }
+    let(:reporting_enabled_at) { 1.day.ago.to_i }
+
+    around do |example|
+      begin
+        old_value = SuperGood::SolidusTaxjar
+          .configuration
+          .preferred_reporting_enabled_at_integer
+        SuperGood::SolidusTaxjar.configuration.update!(
+          preferred_reporting_enabled_at_integer: reporting_enabled_at
+        )
+        example.run
+      ensure
+        SuperGood::SolidusTaxjar.configuration.update!(
+          preferred_reporting_enabled_at_integer: old_value
+        )
+      end
+    end
+
+    it "displays an empty value for the TaxJar reported at time" do
+      subject
+      expect(response.body).to have_text("Reported to TaxJar at: -", normalize_ws: true)
+    end
+
+    it "displays a 'pending' status" do
+      subject
+      expect(response.body).to have_text("TaxJar Sync: Pending", normalize_ws: true)
+    end
+
+    it "displays a link to view the TaxJar Sync History" do
+      subject
+      expect(response.body).to have_link("TaxJar Sync History", href: spree.taxjar_transactions_admin_order_path(order))
+    end
+
+    context "if the order has reported transactions" do
+      let(:latest_sync_log_status) { :success }
+
+      before do
+        create :transaction_sync_log, :success, order: order, created_at: DateTime.new(2022,01,01,12,12)
+        create(
+          :transaction_sync_log,
+          order: order,
+          created_at: DateTime.new(2022,06,06,12,12),
+          order_transaction: create(:taxjar_order_transaction, order: order),
+          status: latest_sync_log_status
+        )
+      end
+
+      it "displays the date and time of the most recent transaction sync" do
+        subject
+        expect(response.body).to have_text("Reported to TaxJar at: June 06, 2022 12:12 PM", normalize_ws: true)
+      end
+
+      it "displays the status of the transaction sync log" do
+        subject
+        expect(response.body).to have_text("TaxJar Sync: #{latest_sync_log_status.capitalize}", normalize_ws: true)
+      end
+    end
+
+    context "when transaction syncing is turned off" do
+      let(:reporting_enabled_at) { nil }
+
+      it "displays a 'disabled' status" do
+        subject
+        expect(response.body).to have_text("TaxJar Sync: Disabled", normalize_ws: true)
+      end
+
+      context "and a transaction sync log exists" do
+        let(:latest_sync_log_status) { :success }
+
+        before do
+          create(
+            :transaction_sync_log,
+            order: order,
+            created_at: DateTime.new(2022,06,06,12,12),
+            order_transaction: create(:taxjar_order_transaction, order: order),
+            status: latest_sync_log_status
+          )
+        end
+
+        it "displays the status of the transaction sync log" do
+          subject
+          expect(response.body).to have_text("TaxJar Sync: #{latest_sync_log_status.capitalize}", normalize_ws: true)
+        end
+      end
+    end
+  end
+
+  describe "#taxjar_transactions" do
+    subject { get spree.taxjar_transactions_admin_order_path(order) }
+
+    let!(:order) { create(:shipped_order) }
+    let(:order_transaction) { create :taxjar_order_transaction, transaction_id: "Test-123", refund_transaction: refund_transaction}
+    let(:refund_transaction) { create :taxjar_refund_transaction, transaction_id: "Test-123-refund"}
+
+    before do
+      create :transaction_sync_log, order: order, order_transaction: order_transaction, status: :success
+    end
+
+    it "renders the taxjar transactions page for the order" do
+      subject
+      expect(response.body).to have_text(/TaxJar Sync History - #?#{order.number} - Orders/)
+    end
+
+    it "renders the transaction sync logs" do
+      subject
+      expect(response.body).to have_text("#{order.number} Test-123 Test-123-refund Success", normalize_ws: true)
+    end
+  end
+end