super_good-solidus_taxjar 0.18.2 → 1.0.0

data/app/controllers/spree/admin/taxjar_settings_controller.rb

@@ -1,7 +1,92 @@
 module Spree
   module Admin
     class TaxjarSettingsController < Spree::Admin::BaseController
-      def show
+      helper_method :taxjar_tax_category_option
+
+      def edit
+        if ENV["TAXJAR_API_KEY"].blank?
+          flash[:error] = "You must provide a TaxJar API token to use this extension."
+          render "edit_no_api_key"
+        else
+          @configuration = SuperGood::SolidusTaxjar.configuration
+          @nexus_regions = cached_api.nexus_regions || []
+          @tax_categories = cached_tax_categories
+        end
+      end
+
+      def update
+        configuration_update if params[:super_good_solidus_taxjar_configuration]
+        tax_category_update if params[:tax_category]
+        redirect_back(fallback_location: spree.admin_taxjar_settings_path)
+      end
+
+      def sync_nexus_regions
+        api_sync do
+          cached_api.nexus_regions(refresh: true)
+          flash[:success] = "Updated with new Nexus Regions"
+        end
+      end
+
+      def sync_tax_categories
+        api_sync do
+          cached_tax_categories
+          flash[:success] = "Updated with new tax categories"
+        end
+      end
+
+      private
+
+      def cached_api
+        SuperGood::SolidusTaxjar::CachedApi.new
+      end
+
+      def configuration_params
+        params_hash = params.require(:super_good_solidus_taxjar_configuration).permit(:preferred_reporting_enabled, :preferred_reporting_enabled_at_integer)
+        {
+          preferred_reporting_enabled_at_integer: params_hash[:preferred_reporting_enabled] == "1" ? DateTime.now.to_i : nil
+        }
+      end
+
+      def tax_category_params
+        params.require(:tax_category)
+      end
+
+      def api_sync
+        begin
+          yield
+        rescue Taxjar::Error => exception
+          flash[:error] = "Failed to complete request to TaxJar: #{exception.message}"
+        end
+        redirect_back(fallback_location: spree.admin_taxjar_settings_path)
+      end
+
+      def cached_tax_categories
+        Rails.cache.fetch(
+          :tax_categories,
+          expires_in: 30.days
+        ) { SuperGood::SolidusTaxjar.api.tax_categories }
+      end
+
+      def configuration_update
+        if SuperGood::SolidusTaxjar.configuration.update(configuration_params)
+          flash[:success] = "TaxJar settings updated!"
+        else
+          flash[:alert] = "Failed to update settings!"
+        end
+      end
+
+      def tax_category_update
+        if Spree::TaxCategory.find(tax_category_params[:id]).update(tax_code: params[:tax_code_id])
+          flash[:success] = "Tax category #{tax_category_params[:name]} tax code updated with #{params[:tax_code_id]}!"
+        else
+          flash[:alert] = "Failed to update tax category #{tax_category_params[:name]}!"
+        end
+      end
+
+      def taxjar_tax_category_option(tax_code)
+        selected_tax_category = @tax_categories.detect{|taxjar_tax_category| taxjar_tax_category.product_tax_code == tax_code}
+        return unless selected_tax_category
+        ["#{selected_tax_category.name} (#{selected_tax_category.product_tax_code})", selected_tax_category.product_tax_code]
       end
     end
   end

data/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

data/app/controllers/spree/admin/transaction_sync_batches_controller.rb

@@ -0,0 +1,18 @@
+module Spree
+  module Admin
+    class TransactionSyncBatchesController < Spree::Admin::BaseController
+      def index
+        @batches = SuperGood::SolidusTaxjar::TransactionSyncBatch.all.page(params[:page]).per(params[:per_page])
+      end
+
+      def show
+        @batch = SuperGood::SolidusTaxjar::TransactionSyncBatch.find(params[:id])
+      end
+
+      def create
+        batch = ::SuperGood::SolidusTaxjar::BackfillTransactions.new.call(start_date: params[:start_date], end_date: params[:end_date])
+        redirect_to spree.admin_transaction_sync_batch_path(batch)
+      end
+    end
+  end
+end

data/app/jobs/super_good/solidus_taxjar/backfill_transaction_sync_batch_job.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SuperGood
+  module SolidusTaxjar
+    class BackfillTransactionSyncBatchJob < ApplicationJob
+      queue_as { SuperGood::SolidusTaxjar.job_queue }
+
+      def perform(transaction_sync_batch)
+        complete_orders = ::Spree::Order.complete.where(shipment_state: 'shipped')
+        if transaction_sync_batch.start_date
+          complete_orders = complete_orders.where("completed_at >= ?", transaction_sync_batch.start_date.beginning_of_day)
+        end
+        if transaction_sync_batch.end_date
+          complete_orders = complete_orders.where("completed_at <= ?", transaction_sync_batch.end_date.end_of_day)
+        end
+        complete_orders.find_each do |order|
+          next if order.taxjar_order_transactions.any?
+          SuperGood::SolidusTaxjar::ReportTransactionJob.perform_later(order, transaction_sync_batch)
+        end
+      end
+    end
+  end
+end

data/app/jobs/super_good/solidus_taxjar/replace_transaction_job.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module SuperGood
+  module SolidusTaxjar
+    class ReplaceTransactionJob < ApplicationJob
+      queue_as { SuperGood::SolidusTaxjar.job_queue }
+
+      def perform(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
+end

data/app/jobs/super_good/solidus_taxjar/report_transaction_job.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SuperGood
+  module SolidusTaxjar
+    class ReportTransactionJob < ApplicationJob
+      queue_as { SuperGood::SolidusTaxjar.job_queue }
+
+      def perform(order, transaction_sync_batch = nil)
+        transaction_sync_log = SuperGood::SolidusTaxjar::TransactionSyncLog.create!(
+          transaction_sync_batch: transaction_sync_batch,
+          order: order
+        )
+        begin
+          order_transaction = SuperGood::SolidusTaxjar.reporting.show_or_create_transaction(order)
+          transaction_sync_log.update!(order_transaction: order_transaction, status: :success)
+        rescue StandardError => exception
+          transaction_sync_log.update!(status: :error, error_message: exception.message)
+        end
+      end
+    end
+  end
+end

data/app/models/super_good/solidus_taxjar/configuration.rb

@@ -0,0 +1,27 @@
+require 'spree/preferences/persistable'
+
+module SuperGood
+  module SolidusTaxjar
+    class Configuration < ::Spree::Base
+      include ::Spree::Preferences::Persistable
+
+      self.table_name = 'solidus_taxjar_configuration'
+      preference :reporting_enabled_at_integer, :integer, default: nil
+
+      def preferred_reporting_enabled
+        preferred_reporting_enabled_at_integer.present? &&
+          DateTime.current.after?(preferred_reporting_enabled_at)
+      end
+
+      def preferred_reporting_enabled_at
+        Time.at(SuperGood::SolidusTaxjar.configuration.preferred_reporting_enabled_at_integer).to_datetime
+      end
+
+      class << self
+        def default
+          first || create
+        end
+      end
+    end
+  end
+end

data/app/models/super_good/solidus_taxjar/order_transaction.rb

@@ -0,0 +1,16 @@
+module SuperGood
+  module SolidusTaxjar
+    class OrderTransaction < ActiveRecord::Base
+      belongs_to :order, class_name: "Spree::Order"
+
+      has_one :refund_transaction
+
+      validates_presence_of :transaction_id
+      validates_presence_of :transaction_date
+
+      def self.latest_for(order)
+        where(order: order).order(transaction_date: :desc, created_at: :desc).limit(1).first
+      end
+    end
+  end
+end

data/app/models/super_good/solidus_taxjar/refund_transaction.rb

@@ -0,0 +1,13 @@
+module SuperGood
+  module SolidusTaxjar
+    class RefundTransaction < ActiveRecord::Base
+      belongs_to :order_transaction
+
+      delegate :order, to: :order_transaction
+
+      validates_presence_of :order_transaction
+      validates_presence_of :transaction_id
+      validates_presence_of :transaction_date
+    end
+  end
+end

data/app/models/super_good/solidus_taxjar/transaction_sync_batch.rb

@@ -0,0 +1,11 @@
+class SuperGood::SolidusTaxjar::TransactionSyncBatch < ApplicationRecord
+  has_many :transaction_sync_logs
+  has_many :orders, through: :transaction_sync_logs
+
+  def status
+    return 'processing' if transaction_sync_logs.processing.any?
+    return 'error' if transaction_sync_logs.error.any?
+
+    'success'
+  end
+end

data/app/models/super_good/solidus_taxjar/transaction_sync_log.rb

@@ -0,0 +1,8 @@
+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]
+end

data/app/overrides/spree/admin/orders_controller_override.rb

@@ -0,0 +1,12 @@
+module Spree
+  module Admin
+    module OrdersControllerOverride
+      # FIXME: Move this to TaxJar transactions controller.
+      def taxjar_transactions
+        load_order
+      end
+
+      Spree::Admin::OrdersController.prepend self
+    end
+  end
+end

data/app/overrides/spree/admin/shared/_order_submenu/add_taxjar_sync_history_tab.html.erb.deface

@@ -0,0 +1,6 @@
+
+<!-- insert_bottom "[data-hook='admin_order_tabs']" -->
+
+<li class="<%= "active" if current == "TaxJar Sync History" %>" data-hook='admin_order_tabs_order_details'>
+  <%= link_to "TaxJar Sync History", spree.taxjar_transactions_admin_order_path(@order) %>
+</li>

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

@@ -0,0 +1,30 @@
+
+<!-- insert_bottom "[id='order_tab_summary'] > .additional-info" -->
+
+<% content_for :head do %>
+  <style>
+    .pill-success {
+      background: #c8d8e8;
+    }
+  </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_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
+      last_sync_log.status
+    else
+      SuperGood::SolidusTaxjar.configuration.preferred_reporting_enabled ?
+        "pending" :
+        "disabled"
+    end
+  %>
+  <span class="pill pill-<%= last_sync_log_status %>">
+    <%= last_sync_log_status.capitalize %>
+  </span>
+</dd>
+<dt><%= link_to("TaxJar Sync History", spree.taxjar_transactions_admin_order_path(@order)) %></dt>

data/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 %>

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

@@ -0,0 +1,21 @@
+module SuperGood
+  module SolidusTaxjar
+    module Spree
+      module OrderOverride
+        def self.prepended(base)
+          base.has_many :taxjar_order_transactions,
+            class_name: "SuperGood::SolidusTaxjar::OrderTransaction",
+            dependent: :destroy,
+            inverse_of: :order
+
+          base.has_many :taxjar_transaction_sync_logs,
+            -> { order(:created_at) },
+            class_name: "SuperGood::SolidusTaxjar::TransactionSyncLog",
+            inverse_of: :order
+        end
+
+        ::Spree::Order.prepend self
+      end
+    end
+  end
+end

data/app/views/spree/admin/orders/taxjar_transactions.html.erb

@@ -0,0 +1,4 @@
+<%= render partial: 'spree/admin/shared/order_tabs', locals: { current: 'TaxJar Sync History' } %>
+<% admin_breadcrumb("TaxJar Sync History") %>
+
+<%= render 'spree/admin/shared/transaction_sync_log_table', transaction_sync_logs: @order.taxjar_transaction_sync_logs %>

data/app/views/spree/admin/shared/_transaction_sync_log_table.html.erb

@@ -0,0 +1,35 @@
+<table id="transaction_sync_logs" class="index">
+  <thead>
+    <tr>
+      <th>Log ID</th>
+      <th class="wrap-text">Order</th>
+      <th class="wrap-text">Txn ID</th>
+      <th class="wrap-text">Refund Txn ID</th>
+      <th class="wrap-text">Status</th>
+      <th class="wrap-text">Error</th>
+      <th class="wrap-text">Created at</th>
+      <th class="wrap-text">Updated at</th>
+      <th class="wrap-text"></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% transaction_sync_logs.each.with_index(1) do |log, index| %>
+      <tr>
+        <td><%= log.id %></td>
+        <td><%= link_to log.order.number, spree.edit_admin_order_path(log.order) %></td>
+        <td><%= log.order_transaction&.transaction_id || "-" %></td>
+        <td><%= log.refund_transaction&.transaction_id || "-" %></td>
+        <td><%= log.status.capitalize %></td>
+        <td style="white-space: pre-wrap; width: 150px; overflow-wrap: anywhere;"><%= log.error_message %></td>
+        <td><%= log.created_at %></td>
+        <td><%= log.updated_at %></td>
+        <td class="actions">
+          <% # If the latest log is an error show a retry. %>
+          <% if log.error? && transaction_sync_logs.count == index %>
+            <%= link_to_with_icon('repeat', "Retry", admin_order_taxjar_transaction_retry_path(log.order), {method: :post}) %>
+          <% end %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/spree/admin/taxjar_settings/_nexus_regions.html.erb

@@ -0,0 +1,23 @@
+<fieldset>
+  <legend>Nexus Regions</legend>
+  <table>
+  <thead>
+    <tr>
+      <th>Country Code</th>
+      <th>Country</th>
+      <th>Region Code</th>
+      <th>Region</th>
+    </tr>
+  </thead>
+  <% @nexus_regions.each do |region| %>
+    <tr>
+      <td><%= region.country_code %></td>
+      <td><%= region.country %></td>
+      <td><%= region.region_code %></td>
+      <td><%= region.region %></td>
+    </tr>
+  <% end %>
+  </table>
+  <a class="btn btn-primary" href="<%= spree.admin_taxjar_settings_sync_nexus_regions_path %>">Sync Nexus Regions</a>
+  <a class="btn btn-outline-primary" href="https://app.taxjar.com/account#states">Go to TaxJar to configure states</a>
+</fieldset>

data/app/views/spree/admin/taxjar_settings/_tax_categories.html.erb

@@ -0,0 +1,41 @@
+<fieldset>
+  <legend>Tax Categories</legend>
+  <p>Select TaxJar tax codes and apply them to your Solidus tax categories.</p>
+  <table data-hook="admin_taxjar_tax_categories_sync">
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Tax Code</th>
+        <th class="align-right">TaxJar Tax Code</th>
+        <th></th>
+      </tr>
+    </thead>
+    <% Spree::TaxCategory.all.each do |category| %>
+      <%= form_for category, url: admin_taxjar_settings_path, method: :put, local: true do |form| %>
+        <tr>
+          <td>
+            <%= category.name %>
+            <%= form.hidden_field(:name) %>
+          </td>
+          <td>
+            <%= category.tax_code %>
+            <%= form.hidden_field(:tax_code) %>
+            <%= form.hidden_field(:id) %>
+          </td>
+          <td class="align-right">
+            <%= select_tag "tax_code_id",
+                options_for_select(
+                  @tax_categories.map{|taxjar_tax_category|
+                    taxjar_tax_category_option(taxjar_tax_category.product_tax_code)
+                  },
+                  category.tax_code
+                ),
+                prompt: "Select New Tax Code",
+                class: "select2" %>
+            <%= form.submit %>
+          </td>
+        </tr>
+      <% end %>
+    <% end %>
+  </table>
+</fieldset>

data/app/views/spree/admin/taxjar_settings/edit.html.erb

@@ -0,0 +1,17 @@
+<%= render 'spree/admin/shared/taxes_tabs' %>
+
+<% content_for :page_title do %>
+  <%= "Taxjar Settings" %>
+<% end %>
+
+<%= render 'nexus_regions' %>
+<%= render 'tax_categories' %>
+<%= form_with model: @configuration, url: admin_taxjar_settings_path, method: :put, local: true do |form| %>
+  <%= render "spree/admin/shared/preference_fields/boolean",
+        attribute:  :preferred_reporting_enabled,
+        label: "Transaction Sync",
+        form: form
+  %>
+  <p>Sync orders and refund with TaxJar for automated sales tax reporting and filing. Complete and closed transactions sync automatically on update.</p>
+  <%= form.submit %>
+<% end %>

data/app/views/spree/admin/taxjar_settings/edit_no_api_key.html.erb

@@ -0,0 +1,21 @@
+<p>
+  You must provide a TaxJar API token to use this extension.
+
+  <%= link_to "Sign up for TaxJar",
+    "https://app.taxjar.com/api_sign_up",
+    rel: "noreferrer",
+    target: "_blank" %>
+
+  and provide your API key. See the extension documentation for details on
+  providing this token to the extension.
+</p>
+<p>
+  <emph>
+    For more help in aquiring a TaxJar API token, see
+
+    <%= link_to "How do I get a TaxJar sales tax API token?",
+      "https://support.taxjar.com/article/160-how-do-i-get-a-sales-tax-api-token",
+      target: "_blank",
+      rel: "noreferrer" %>
+  </emph>
+</p>

data/app/views/spree/admin/transaction_sync_batches/index.html.erb

@@ -0,0 +1,50 @@
+<%= render 'spree/admin/shared/taxes_tabs' %>
+
+<% content_for :page_title do %>
+  <%= "Transaction Sync Batches" %>
+<% end %>
+
+<%= form_with url: admin_transaction_sync_batches_path, method: :post, local: true do |f| %>
+  <div class="row" style="margin-bottom: 20px;">
+    <div class="col-3">
+      <%= f.label :start_date %>
+      <%= f.date_field :start_date %>
+    </div>
+    <div class="col-3">
+      <%= f.label :end_date %>
+      <%= f.date_field :end_date %>
+    </div>
+    <div class="col-3" style="align-self: flex-end;">
+      <%= f.submit "Backfill Transactions", class: "btn btn-primary" %>
+    </div>
+  </div>
+<% end %>
+
+<table id="transaction_sync_batches">
+  <thead>
+    <tr>
+      <th>Batch ID</th>
+      <th>Created at</th>
+      <th>Updated at</th>
+      <th>Processed Orders</th>
+      <th>Status</th>
+      <th></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @batches.each do |batch| %>
+      <tr>
+        <td><%= batch.id %></td>
+        <td><%= batch.created_at %></td>
+        <td><%= batch.updated_at %></td>
+        <td><%= batch.transaction_sync_logs.not_processing.count %>/<%= batch.transaction_sync_logs.count %></td>
+        <td><%= batch.status.capitalize %></td>
+        <td class='actions align-center'>
+          <%= link_to_edit_url admin_transaction_sync_batch_path(batch), title: "admin_transaction_sync_batch_show_#{dom_id(batch)}", no_text: true %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<%= paginate @batches, theme: "solidus_admin" %>

data/app/views/spree/admin/transaction_sync_batches/show.html.erb

@@ -0,0 +1,7 @@
+<%= render 'spree/admin/shared/taxes_tabs' %>
+
+<% content_for :page_title do %>
+  <%= "Transaction Sync Batch #{@batch.id}" %>
+<% end %>
+
+<%= render 'spree/admin/shared/transaction_sync_log_table', transaction_sync_logs: @batch.transaction_sync_logs %>

data/bin/console

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require "bundler/setup"
 require "super_good/solidus_taxjar"
 require "pry"

data/bin/rails-engine

@@ -3,7 +3,7 @@
 # installed from the root of your application.
 
 ENGINE_ROOT = File.expand_path("..", __dir__)
-ENGINE_PATH = File.expand_path("../lib/solidus_taxjar/engine", __dir__)
+ENGINE_PATH = File.expand_path("../lib/super_good-solidus_taxjar", __dir__)
 
 # Set up gems listed in the Gemfile.
 ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)