Andrey/adnan/solidus 4.0

.circleci/config.yml

@@ -21,7 +21,7 @@ jobs:
   run-specs-solidus-older:
     executor:
       name: solidusio_extensions/postgres
-      ruby_version: "2.7"
+      ruby_version: "3.0"
     steps:
       - checkout
       - browser-tools/install-browser-tools

CHANGELOG.md

@@ -1,8 +1,17 @@
 # Changelog
+All notable changes to this project will be documented in this file.
 
-## master
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+- Nothing yet.
+
+## v1.0.0
+
+### Added
 
-- [#193](https://github.com/SuperGoodSoft/solidus_taxjar/pull/193) Bump version requirement for `solidus_support` to ">= 0.9.0", and as a result drop support for Rails 5.2.
 - [#190](https://github.com/SuperGoodSoft/solidus_taxjar/pull/190) Add transaction sync batch show page
 - [#188](https://github.com/SuperGoodSoft/solidus_taxjar/pull/188) Show transaction sync batches in user interface
 - [#185](https://github.com/SuperGoodSoft/solidus_taxjar/pull/185) Backfill transactions in batches
@@ -12,23 +21,16 @@
 - [#158](https://github.com/SuperGoodSoft/solidus_taxjar/pull/158) Update sandbox bin stub for `solidus@3`
 - [#88](https://github.com/SuperGoodSoft/solidus_taxjar/pull/88) Fire `shipment_shipped` event when any shipment on an order ships.
 - [#81](https://github.com/SuperGoodSoft/solidus_taxjar/pull/81) Add install generator
-- [#95](https://github.com/SuperGoodSoft/solidus_taxjar/pull/95) Only require "state" for Canadian and US addresses
 - [#98](https://github.com/SuperGoodSoft/solidus_taxjar/pull/98) Add generator for TaxJar transaction IDs
 - [#103](https://github.com/SuperGoodSoft/solidus_taxjar/pull/103) Add `reporting_enabled` configuration option
 - [#97](https://github.com/SuperGoodSoft/solidus_taxjar/pull/97) Add public API method to request the latest transaction associated with a solidus order.
 - [#100](https://github.com/SuperGoodSoft/solidus_taxjar/pull/100) Add public API method to post a taxjar refund transaction for a solidus order.
 - [#102](https://github.com/SuperGoodSoft/solidus_taxjar/pull/102) Add description to transaction line item params
-- [#107](https://github.com/SuperGoodSoft/solidus_taxjar/pull/107) Fix rails-engine binstub to point to correct engine entry point
 - [#108](https://github.com/SuperGoodSoft/solidus_taxjar/pull/108) Add new model associated with a `Spree::Order` to represent taxjar order creation transactions
-- [#117](https://github.com/SuperGoodSoft/solidus_taxjar/pull/117) Fix migration install
 - [#114](https://github.com/SuperGoodSoft/solidus_taxjar/pull/114) Add new model associated with a `SuperGood::SolidusTaxjar::OrderTransaction` to represent taxjar refund creation transactions
 - [#116](https://github.com/SuperGoodSoft/solidus_taxjar/pull/116) Update the `OrderTransaction` model to record the transaction date.
-- [#120](https://github.com/SuperGoodSoft/solidus_taxjar/pull/120) Change default `SOLIDUS_BRANCH` and `RAILS_VERSION`
 - [#109](https://github.com/SuperGoodSoft/solidus_taxjar/pull/109) Save `OrderTransaction` after API call to TaxJar
-- [#119](https://github.com/SuperGoodSoft/solidus_taxjar/pull/119) Move the install generator into the correct path so that it will be installed in the dummy app.
 - [#111](https://github.com/SuperGoodSoft/solidus_taxjar/pull/111) Create a new taxjar transaction when a shipment is shipped.
-- [#137](https://github.com/SuperGoodSoft/solidus_taxjar/pull/137) Only run tests against solidus 2.11. This also represents the drop of official support for solidus 2.9 and 2.10.
-- [#137](https://github.com/SuperGoodSoft/solidus_taxjar/pull/137) Run tests against the most up to date versions of solidus.
 - [#141](https://github.com/SuperGoodSoft/solidus_taxjar/pull/141) Handle unimplemented reporting features
 - [#129](https://github.com/SuperGoodSoft/solidus_taxjar/pull/129) Report transaction asynchronously when a shipment is shipped.
 - [#127](https://github.com/SuperGoodSoft/solidus_taxjar/pull/127) Add acceptance test for calculating taxes with the extension.
@@ -38,29 +40,68 @@
 - [#174](https://github.com/SuperGoodSoft/solidus_taxjar/pull/174) Provide a link to Taxjar state settings
 - [#177](https://github.com/SuperGoodSoft/solidus_taxjar/pull/177) Make nexus caching configurable
 - [#169](https://github.com/SuperGoodSoft/solidus_taxjar/pull/169) Add basic backfill transaction functionality
-- [#181](https://github.com/SuperGoodSoft/solidus_taxjar/pull/181) Take all non-tax adjustment types into account when calculating a line item's discount
-- [#182](https://github.com/SuperGoodSoft/solidus_taxjar/pull/182) Automatically create default Tax Rate
 - [#176](https://github.com/SuperGoodSoft/solidus_taxjar/pull/176) Create refund transaction database models when reporting refunds.
 - [#192](https://github.com/SuperGoodSoft/solidus_taxjar/pull/192) Handle failures that occur in the middle of refunding a transaction.
 - [#194](https://github.com/SuperGoodSoft/solidus_taxjar/pull/194) Move the transaction backfill button to it's own unique page
 - [#198](https://github.com/SuperGoodSoft/solidus_taxjar/pull/198) Don't create zero dollar transactions when an order is fully refunded.
 - [#195](https://github.com/SuperGoodSoft/solidus_taxjar/pull/195) Run transaction backfills asynchronously
-- [#200](https://github.com/SuperGoodSoft/solidus_taxjar/pull/200) Expand solidus gem into dependencies to support Solidus 3.2+
+- [#200](https://github.com/SuperGoodSoft/solidus_taxjar/pull/200) Expand `solidus` gem into dependencies to support Solidus 3.2+
 - [#183](https://github.com/SuperGoodSoft/solidus_taxjar/pull/183) Add ability to fetch tax codes from TaxJar and assign to tax categories in admin
 - [#200](https://github.com/SuperGoodSoft/solidus_taxjar/pull/200) Render error message when backfilling transactions fails
 - [#203](https://github.com/SuperGoodSoft/solidus_taxjar/pull/203) Remove outdated backfill button
 - [#202](https://github.com/SuperGoodSoft/solidus_taxjar/pull/202) Add TaxJar transaction sync status to order show page
 - [#204](https://github.com/SuperGoodSoft/solidus_taxjar/pull/204) Add page to render an orders TaxJar transactions
 - [#201](https://github.com/SuperGoodSoft/solidus_taxjar/pull/201) Allow transaction backfills to be filtered by date range
+- [#244](https://github.com/SuperGoodSoft/solidus_taxjar/pull/244) Let admins manually retry syncing failed TaxJar transactions
+- [#255](https://github.com/SuperGoodSoft/solidus_taxjar/pull/255) Add a delay before reporting transactions
+- [#253](https://github.com/SuperGoodSoft/solidus_taxjar/pull/253) Fix various bugs with reporting refund transactions
+
+### Changed
+
+- [#95](https://github.com/SuperGoodSoft/solidus_taxjar/pull/95) Only require "state" for Canadian and US addresses
+- [#181](https://github.com/SuperGoodSoft/solidus_taxjar/pull/181) Take all non-tax adjustment types into account when calculating a line item's discount
+- [#182](https://github.com/SuperGoodSoft/solidus_taxjar/pull/182) Automatically create default Tax Rate
 - [#205](https://github.com/SuperGoodSoft/solidus_taxjar/pull/205) Use nexus regions for taxable address checks
 - [#218](https://github.com/SuperGoodSoft/solidus_taxjar/pull/218) Removed `order_recalculated` event backport
 - [#216](https://github.com/SuperGoodSoft/solidus_taxjar/pull/216) Add `deface` as a dependency.
 - [#217](https://github.com/SuperGoodSoft/solidus_taxjar/pull/217) Handle updates to orders that have not been reported
 - [#227](https://github.com/SuperGoodSoft/solidus_taxjar/pull/227) Fix reporting for orders with refunds
+- [#226](https://github.com/SuperGoodSoft/solidus_taxjar/pull/226) Refactor reporting subscriber logic
+- [#238](https://github.com/SuperGoodSoft/solidus_taxjar/pull/238) Drop support for loading of reporting subscriber for Solidus < 2.11
+- [#237](https://github.com/SuperGoodSoft/solidus_taxjar/pull/237) Sort order transactions by `created_at`
+- [#236](https://github.com/SuperGoodSoft/solidus_taxjar/pull/236) Don't send cancelled or returned line items
+- [#225](https://github.com/SuperGoodSoft/solidus_taxjar/pull/225) Create sync logs for replace transaction jobs
+- [#231](https://github.com/SuperGoodSoft/solidus_taxjar/pull/231) Load Solidus factories using new conventions
+- [#246](https://github.com/SuperGoodSoft/solidus_taxjar/pull/246) Fix bugs with sync retries when reporting or replacing a transaction fails
+
+### Removed
+
+- [#137](https://github.com/SuperGoodSoft/solidus_taxjar/pull/137) Only run tests against Solidus 2.11. This also represents the drop of official support for Solidus 2.9 and 2.10.
+- [#193](https://github.com/SuperGoodSoft/solidus_taxjar/pull/193) Bump version requirement for `solidus_support` to ">= 0.9.0", and as a result drop support for Rails 5.2.
+
+### Fixed
+
+- [#107](https://github.com/SuperGoodSoft/solidus_taxjar/pull/107) Fix rails-engine binstub to point to correct engine entry point
+- [#117](https://github.com/SuperGoodSoft/solidus_taxjar/pull/117) Fix migration install
+- [#119](https://github.com/SuperGoodSoft/solidus_taxjar/pull/119) Move the install generator into the correct path so that it will be installed in the dummy app.
+- [#250](https://github.com/SuperGoodSoft/solidus_taxjar/pull/250) Improve error handling for `ReportTransactionJob`
+- [#254](https://github.com/SuperGoodSoft/solidus_taxjar/pull/254) Get tests and binstubs working against Solidus `main`
+
+### Development Changes
+
+These changes only affect the development of this extension.
+
+- [#120](https://github.com/SuperGoodSoft/solidus_taxjar/pull/120) Change default `SOLIDUS_BRANCH` and `RAILS_VERSION`
+- [#137](https://github.com/SuperGoodSoft/solidus_taxjar/pull/137) Run tests against the most up to date versions of Solidus
+- [#249](https://github.com/SuperGoodSoft/solidus_taxjar/pull/249) Don't depend on `webdrivers` gem
 
-## Upgrading Instructions
+### Upgrading from 0.18.x to 1.0.0
 
-* If you had previously configured a `Spree::TaxRate` with the name "Sales Tax", it can be deleted after upgrading, as a new `Spree::TaxRate` with the name "Solidus TaxJar Rate" will automatically be created. Alternatively, you can rename your existing `Spree::TaxRate` from "Sales Tax" to "Solidus TaxJar Rate". [#182](https://github.com/SuperGoodSoft/solidus_taxjar/pull/182)
+If you had previously configured a `Spree::TaxRate` with the name "Sales Tax",
+it can be deleted after upgrading, as a new `Spree::TaxRate` with the name
+"Solidus TaxJar Rate" will automatically be created. Alternatively, you can
+rename your existing `Spree::TaxRate` from "Sales Tax" to "Solidus TaxJar
+Rate". [#182](https://github.com/SuperGoodSoft/solidus_taxjar/pull/182)
 
 ## v0.18.2
 

Gemfile

@@ -1,5 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
+source "https://rubygems.org"
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 branch = ENV.fetch("SOLIDUS_BRANCH", "v3.1")
@@ -35,6 +36,13 @@ group :development, :test do
   gem "pry"
   gem "pry-stack_explorer"
   gem "pry-byebug"
+
+  # FIXME:
+  # Once a new version of `solidus_dev_support` is released to RubyGems, we can
+  # use that.
+  gem "solidus_dev_support",
+    github: "solidusio/solidus_dev_support",
+    branch: "main"
 end
 
 gemspec

README.md

@@ -1,5 +1,5 @@
 # `SuperGood::SolidusTaxjar`
-
+[![Gem Version](https://badge.fury.io/rb/super_good-solidus_taxjar.svg)](https://badge.fury.io/rb/super_good-solidus_taxjar)
 [![CircleCI build status](https://circleci.com/gh/SuperGoodSoft/solidus_taxjar/tree/master.svg?style=shield)](https://circleci.com/gh/SuperGoodSoft/solidus_taxjar/tree/master)
 
 `SuperGood::SolidusTaxjar` is a [Solidus](https://github.com/solidusio/solidus)
@@ -50,7 +50,7 @@ about using the Solidus TaxJar extension after it has been installed.
 4. Finally, make sure that the `TAXJAR_API_KEY` environment variable is set to
    your TaxJar API key.
 
-### Warning: Installing on production
+### Warning: Installing on Production
 
 Before you install this extension in your production environment, **we strongly
 recommend that you install and configure a supported ActiveJob backend**.
@@ -68,20 +68,7 @@ particularly helpful.
 [active-job-basics]: https://edgeguides.rubyonrails.org/active_job_basics.html
 [active-job-execution]: https://edgeguides.rubyonrails.org/active_job_basics.html#job-execution
 
-## Project Status
-
-<!-- FIXME: Modify the following paragraph for the v1.0 release. -->
-
-This extension is under active development and not yet at a v1.0 release, but
-it's currently being used in production by multiple Solidus stores.
-
-Requirements for TaxJar integrations vary as some stores also need reporting,
-which isn't provided out of the box by this extension. This is because
-individual stores will be using different background job frameworks or runners
-(Sidekiq, delayed_job, ActiveJob, etc.) and a reliable integration will rely on
-one of these. Because this part of the integration is small, we've chosen to
-provide the transaction reporting functionality, but have skipped directly
-integrating it.
+## Developer Support
 
 If you're having trouble integrating this extension with your store and would
 like some assistance, please reach out to Jared via e-mail at [[email protected]](mailto:[email protected])
@@ -104,9 +91,12 @@ that event to your applicaiton.
 This extension also supports:
 
 * syncing orders to TaxJar's reporting dashboard
-* syncing nexus regions as configured in the connected TaxJar account
+* syncing nexus regions as configured in the connected TaxJar account (including
+  automatic _and_ manual sync)
 * connecting your Solidus store's tax categories to TaxJar's tax categories (U.S. tax codes)
 
+**Note that reporting is turned off by default.**
+
 ### TaxCalculator
 
 `SuperGood::SolidusTaxjar::TaxCalculator` allows calculating the full tax
@@ -240,7 +230,13 @@ Developers can configure the following settings in an initializer:
 
   Default value: `false`
 
-### Exception handling
+### Taxable Orders
+
+Note that the configuration setting `taxable_order_check` can be customized if
+there is specific criteria that make some orders taxable and other orders not
+taxable. By default this extension considers all orders taxable.
+
+### Exception Handling
 
 You can configure your own exception handler in an initializer. using the
 `exception_handler` configuration point:
@@ -310,6 +306,15 @@ and `SOLIDUS_BRANCH` environment variables, respectively. See the
 The database vendor can also be changed from the default (`sqlite3`) by setting
 the `DB` environment variable.
 
+### Testing the Extension
+
+When testing your application's integration with this extension you may use its factories.
+You can load Solidus core factories along with this extension's factories using this statement:
+
+```ruby
+SolidusDevSupport::TestingSupport::Factories.load_for(SuperGoodSolidusTaxjar::Engine)
+```
+
 ## Releasing a New Version
 
 1. Update the `master` header in changelog to the version that you're releasing.

Rakefile

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "bundler/gem_tasks"
 require 'solidus_dev_support/rake_tasks'
 SolidusDevSupport::RakeTasks.install
 

app/controllers/spree/admin/taxjar_transactions_controller.rb

@@ -0,0 +1,37 @@
+module Spree
+  module Admin
+    class TaxjarTransactionsController < Spree::Admin::BaseController
+      include SuperGood::SolidusTaxjar::Reportable
+
+      def retry
+        order = Spree::Order.find_by number: params[:order_id]
+
+        if transaction_replaceable? order
+          replace_transaction order
+          flash[:notice] = "Queued transaction sync job"
+        elsif order_reportable? order
+          report_transaction order
+          flash[:notice] = "Queued transaction sync job"
+        else
+          flash[:error] = "Could not retry sync successfully"
+        end
+
+        redirect_to taxjar_transactions_admin_order_path(params[:order_id])
+      end
+
+      private
+
+      def report_transaction(order)
+        with_reportable(order) do
+          SuperGood::SolidusTaxjar::ReportTransactionJob.perform_later(order)
+        end
+      end
+
+      def replace_transaction(order)
+        with_replaceable(order) do
+          SuperGood::SolidusTaxjar::ReplaceTransactionJob.perform_later(order)
+        end
+      end
+    end
+  end
+end

app/jobs/super_good/solidus_taxjar/replace_transaction_job.rb

@@ -6,7 +6,20 @@ class ReplaceTransactionJob < ApplicationJob
       queue_as { SuperGood::SolidusTaxjar.job_queue }
 
       def perform(order)
-        SuperGood::SolidusTaxjar.reporting.refund_and_create_new_transaction(order)
+        order_transaction = SuperGood::SolidusTaxjar.reporting.refund_and_create_new_transaction(order)
+
+        SuperGood::SolidusTaxjar::TransactionSyncLog.create!(
+          order: order,
+          order_transaction: order_transaction,
+          status: :success
+        )
+
+      rescue Taxjar::Error => exception
+        SuperGood::SolidusTaxjar::TransactionSyncLog.create!(
+          order: order,
+          status: :error,
+          error_message: exception.message
+        )
       end
     end
   end

app/jobs/super_good/solidus_taxjar/report_transaction_job.rb

@@ -13,7 +13,7 @@ def perform(order, transaction_sync_batch = nil)
         begin
           order_transaction = SuperGood::SolidusTaxjar.reporting.show_or_create_transaction(order)
           transaction_sync_log.update!(order_transaction: order_transaction, status: :success)
-        rescue Taxjar::Error => exception
+        rescue StandardError => exception
           transaction_sync_log.update!(status: :error, error_message: exception.message)
         end
       end

app/models/super_good/solidus_taxjar/order_transaction.rb

@@ -9,7 +9,7 @@ class OrderTransaction < ActiveRecord::Base
       validates_presence_of :transaction_date
 
       def self.latest_for(order)
-        where(order: order).order(transaction_date: :desc).limit(1).first
+        where(order: order).order(transaction_date: :desc, created_at: :desc).limit(1).first
       end
     end
   end

app/models/super_good/solidus_taxjar/transaction_sync_log.rb

@@ -2,6 +2,7 @@ class SuperGood::SolidusTaxjar::TransactionSyncLog < ApplicationRecord
   belongs_to :transaction_sync_batch, optional: true
   belongs_to :order, class_name: "Spree::Order"
   belongs_to :order_transaction, optional: true
+  delegate :refund_transaction, to: :order_transaction, :allow_nil => true
 
-  enum status: [:processing, :success, :error]
+  enum status [:processing, :success, :error]
 end

app/overrides/spree/admin/orders_controller_override.rb

@@ -1,6 +1,7 @@
 module Spree
   module Admin
     module OrdersControllerOverride
+      # FIXME: Move this to TaxJar transactions controller.
       def taxjar_transactions
         load_order
       end

app/overrides/spree/admin/shared/_order_summary/add_taxjar_reported_at.html.erb.deface

@@ -9,9 +9,10 @@
   </style>
 <% end %>
 
+<% last_success_sync_log = @order.taxjar_transaction_sync_logs.success.order(:created_at).last %>
 <% last_sync_log = @order.taxjar_transaction_sync_logs.order(:created_at).last %>
 <dt>Reported to TaxJar at:</dt>
-<dd> <%= last_sync_log ? pretty_time(last_sync_log.created_at) : "-" %></dd>
+<dd> <%= last_success_sync_log ? pretty_time(last_success_sync_log.created_at) : "-" %></dd>
 <dt>TaxJar Sync: </dt>
 <dd>
   <% last_sync_log_status = if last_sync_log
@@ -26,3 +27,4 @@
     <%= last_sync_log_status.capitalize %>
   </span>
 </dd>
+<dt><%= link_to("TaxJar Sync History", spree.taxjar_transactions_admin_order_path(@order)) %></dt>

app/overrides/spree/admin/shared/_taxes_tabs/add_configuration_menu_items.html.erb.deface

@@ -0,0 +1,5 @@
+<!--  insert_bottom "[data-hook='admin_settings_taxes_tabs']" -->
+
+<%= configurations_sidebar_menu_item "TaxJar Settings", edit_admin_taxjar_settings_path %>
+
+<%= configurations_sidebar_menu_item "TaxJar Backfill", admin_transaction_sync_batches_path %>

app/overrides/super_good/solidus_taxjar/spree/order_override.rb

@@ -9,6 +9,7 @@ def self.prepended(base)
             inverse_of: :order
 
           base.has_many :taxjar_transaction_sync_logs,
+            -> { order(:created_at) },
             class_name: "SuperGood::SolidusTaxjar::TransactionSyncLog",
             inverse_of: :order
         end