super_good-solidus_taxjar 0.15.1 → 0.18.1

data/lib/super_good-solidus_taxjar.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "super_good/solidus_taxjar"
+require "super_good/engine"

data/lib/super_good/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SuperGoodSolidusTaxjar
+  class Engine < Rails::Engine
+    isolate_namespace Spree
+    engine_name 'super_good_solidus_taxjar'
+  end
+end

data/lib/super_good/solidus_taxjar.rb

@@ -1,18 +1,22 @@
-require 'solidus_core'
-require 'solidus_support'
-require 'taxjar'
+require "solidus_core"
+require "solidus_support"
+require "taxjar"
 
 require "super_good/solidus_taxjar/version"
 require "super_good/solidus_taxjar/api_params"
 require "super_good/solidus_taxjar/api"
+require "super_good/solidus_taxjar/calculator_helper"
 require "super_good/solidus_taxjar/tax_calculator"
+require "super_good/solidus_taxjar/tax_rate_calculator"
 require "super_good/solidus_taxjar/discount_calculator"
+require "super_good/solidus_taxjar/addresses"
 
 module SuperGood
-  module SolidusTaxJar
+  module SolidusTaxjar
     class << self
       attr_accessor :cache_duration
       attr_accessor :cache_key
+      attr_accessor :custom_order_params
       attr_accessor :discount_calculator
       attr_accessor :exception_handler
       attr_accessor :line_item_tax_label_maker
@@ -22,11 +26,19 @@ module SuperGood
       attr_accessor :taxable_address_check
       attr_accessor :taxable_order_check
       attr_accessor :test_mode
+
+      def api
+        ::SuperGood::SolidusTaxjar::Api.new
+      end
     end
 
     self.cache_duration = 3.hours
-    self.cache_key = ->(order) { APIParams.order_params(order).to_json }
-    self.discount_calculator = ::SuperGood::SolidusTaxJar::DiscountCalculator
+    self.cache_key = ->(record) {
+      record_type = record.class.name.demodulize.underscore
+      ApiParams.send("#{record_type}_params", record).to_json
+    }
+    self.custom_order_params = ->(order) { {} }
+    self.discount_calculator = ::SuperGood::SolidusTaxjar::DiscountCalculator
     self.exception_handler = ->(e) {
       Rails.logger.error "An error occurred while fetching TaxJar tax rates - #{e}: #{e.message}"
     }

data/lib/super_good/solidus_taxjar/addresses.rb

@@ -0,0 +1,63 @@
+module SuperGood
+  module SolidusTaxjar
+    class Addresses
+      class << self
+        def normalize(spree_address)
+          new.normalize(spree_address)
+        end
+
+        def possibilities(spree_address)
+          new.possibilities(spree_address)
+        end
+      end
+
+      def initialize(api: ::SuperGood::SolidusTaxjar.api)
+        @api = api
+      end
+
+      def normalize(spree_address)
+        taxjar_address = taxjar_addresses(spree_address).first
+
+        return if taxjar_address.nil?
+
+        Spree::Address.immutable_merge(spree_address, {
+          country: us, # TaxJar only supports the US currently.
+          state: state(taxjar_address.state),
+          zipcode: taxjar_address.zip,
+          city: taxjar_address.city,
+          address1: taxjar_address.street
+        })
+      end
+
+      def possibilities(spree_address)
+        taxjar_addresses(spree_address).map { |taxjar_address|
+          Spree::Address.immutable_merge(spree_address, {
+            country: us, # TaxJar only supports the US currently.
+            state: state(taxjar_address.state),
+            zipcode: taxjar_address.zip,
+            city: taxjar_address.city,
+            address1: taxjar_address.street
+          })
+        }
+      end
+
+      private
+
+      attr_reader :api
+
+      def taxjar_addresses(spree_address)
+        api.validate_spree_address(spree_address)
+      rescue Taxjar::Error::NotFound
+        []
+      end
+
+      def us
+        Spree::Country.find_by iso: "US"
+      end
+
+      def state(abbr)
+        us.states.find_by_abbr abbr
+      end
+    end
+  end
+end

data/lib/super_good/solidus_taxjar/api.rb

@@ -1,11 +1,16 @@
 module SuperGood
-  module SolidusTaxJar
-    class API
+  module SolidusTaxjar
+    class Api
       def self.default_taxjar_client
-        ::Taxjar::Client.new(
+        client = ::Taxjar::Client.new(
           api_key: ENV.fetch("TAXJAR_API_KEY"),
-          api_url: ENV.fetch("TAXJAR_API_URL") { 'https://api.taxjar.com' } # Sandbox URL: https://api.sandbox.taxjar.com
+          api_url: ENV.fetch("TAXJAR_API_URL") { "https://api.taxjar.com" } # Sandbox URL: https://api.sandbox.taxjar.com
         )
+        client.set_api_config('headers', {
+          'x-api-version' => '2020-08-07',
+          'plugin' => 'supergoodsolidustaxjar'
+        })
+        client
       end
 
       def initialize(taxjar_client: self.class.default_taxjar_client)
@@ -13,8 +18,8 @@ module SuperGood
       end
 
       def tax_for(order)
-        taxjar_client.tax_for_order(APIParams.order_params(order)).tap do |taxes|
-          next unless SuperGood::SolidusTaxJar.logging_enabled
+        taxjar_client.tax_for_order(ApiParams.order_params(order)).tap do |taxes|
+          next unless SuperGood::SolidusTaxjar.logging_enabled
 
           Rails.logger.info(
             "TaxJar response for #{order.number}: #{taxes.to_h.inspect}"
@@ -22,16 +27,20 @@ module SuperGood
         end
       end
 
+      def tax_rate_for(address)
+        taxjar_client.tax_for_order(ApiParams.tax_rate_address_params(address)).rate
+      end
+
       def tax_rates_for(address)
-        taxjar_client.rates_for_location(*APIParams.address_params(address))
+        taxjar_client.rates_for_location(*ApiParams.address_params(address))
       end
 
       def create_transaction_for(order)
-        taxjar_client.create_order APIParams.transaction_params(order)
+        taxjar_client.create_order ApiParams.transaction_params(order)
       end
 
       def update_transaction_for(order)
-        taxjar_client.update_order APIParams.transaction_params(order)
+        taxjar_client.update_order ApiParams.transaction_params(order)
       end
 
       def delete_transaction_for(order)
@@ -39,7 +48,11 @@ module SuperGood
       end
 
       def create_refund_for(reimbursement)
-        taxjar_client.create_refund APIParams.refund_params(reimbursement)
+        taxjar_client.create_refund ApiParams.refund_params(reimbursement)
+      end
+
+      def validate_spree_address(spree_address)
+        taxjar_client.validate_address ApiParams.validate_address_params(spree_address)
       end
 
       private

data/lib/super_good/solidus_taxjar/api_params.rb

@@ -1,18 +1,19 @@
 module SuperGood
-  module SolidusTaxJar
-    module APIParams
+  module SolidusTaxjar
+    module ApiParams
       class << self
         def order_params(order)
           {}
             .merge(customer_params(order))
             .merge(order_address_params(order.tax_address))
             .merge(line_items_params(order.line_items))
-            .merge(shipping: order.shipment_total)
+            .merge(shipping: shipping(order))
+            .merge(SuperGood::SolidusTaxjar.custom_order_params.call(order))
             .tap do |params|
-              next unless SuperGood::SolidusTaxJar.logging_enabled
+              next unless SuperGood::SolidusTaxjar.logging_enabled
 
               Rails.logger.info(
-                "TaxJar params: #{params.inspect}"
+                "TaxJar params for #{order.number}: #{params.inspect}"
               )
             end
         end
@@ -29,6 +30,13 @@ module SuperGood
           ]
         end
 
+        def tax_rate_address_params(address)
+          {
+            amount: 100,
+            shipping: 0
+          }.merge(order_address_params(address))
+        end
+
         def transaction_params(order)
           {}
             .merge(customer_params(order))
@@ -58,12 +66,22 @@ module SuperGood
             )
         end
 
+        def validate_address_params(spree_address)
+          {
+            country: spree_address.country&.iso,
+            state: spree_address.state&.abbr || spree_address.state_name,
+            zip: spree_address.zipcode,
+            city: spree_address.city,
+            street: spree_address.address1
+          }
+        end
+
         private
 
         def customer_params(order)
           return {} unless order.user_id
 
-          { customer_id: order.user_id.to_s }
+          {customer_id: order.user_id.to_s}
         end
 
         def order_address_params(address)
@@ -72,7 +90,7 @@ module SuperGood
             to_zip: address.zipcode,
             to_city: address.city,
             to_state: address&.state&.abbr || address.state_name,
-            to_street: address.address1,
+            to_street: address.address1
           }
         end
 
@@ -115,11 +133,11 @@ module SuperGood
         end
 
         def discount(line_item)
-          ::SuperGood::SolidusTaxJar.discount_calculator.new(line_item).discount
+          ::SuperGood::SolidusTaxjar.discount_calculator.new(line_item).discount
         end
 
         def shipping(order)
-          SuperGood::SolidusTaxJar.shipping_calculator.(order)
+          SuperGood::SolidusTaxjar.shipping_calculator.call(order)
         end
 
         def sales_tax(order)

data/lib/super_good/solidus_taxjar/calculator_helper.rb

@@ -0,0 +1,38 @@
+module SuperGood
+  module SolidusTaxjar
+    module CalculatorHelper
+      extend ActiveSupport::Concern
+
+      def incomplete_address?(address)
+        return true if address.is_a?(Spree::Tax::TaxLocation)
+
+        [
+          address.address1,
+          address.city,
+          address.state&.abbr || address.state_name,
+          address.zipcode,
+          address.country&.iso
+        ].any?(&:blank?)
+      end
+
+      def taxable_address?(address)
+        SuperGood::SolidusTaxjar.taxable_address_check.call(address)
+      end
+
+      def cache
+        if !Rails.env.test?
+          Rails.cache.fetch(
+            cache_key,
+            expires_in: SuperGood::SolidusTaxjar.cache_duration
+          ) { yield }
+        else
+          yield
+        end
+      end
+
+      def exception_handler
+        SuperGood::SolidusTaxjar.exception_handler
+      end
+    end
+  end
+end

data/lib/super_good/solidus_taxjar/discount_calculator.rb

@@ -1,5 +1,5 @@
 module SuperGood
-  module SolidusTaxJar
+  module SolidusTaxjar
     class DiscountCalculator
       def initialize(line_item)
         @line_item = line_item

data/lib/super_good/solidus_taxjar/tax_calculator.rb

@@ -1,17 +1,15 @@
 module SuperGood
-  module SolidusTaxJar
+  module SolidusTaxjar
     class TaxCalculator
-      def self.default_api
-        ::SuperGood::SolidusTaxJar::API.new
-      end
+      include CalculatorHelper
 
-      def initialize(order, api: self.class.default_api)
+      def initialize(order, api: SuperGood::SolidusTaxjar.api)
         @order = order
         @api = api
       end
 
       def calculate
-        return no_tax if SuperGood::SolidusTaxJar.test_mode
+        return no_tax if SuperGood::SolidusTaxjar.test_mode
         return no_tax if incomplete_address?(order.tax_address) || order.line_items.none?
         return no_tax unless taxable_order? order
         return no_tax unless taxable_address? order.tax_address
@@ -25,8 +23,8 @@ module SuperGood
             shipment_taxes: shipment_taxes
           )
         end
-      rescue StandardError => e
-        exception_handler.(e)
+      rescue => e
+        exception_handler.call(e)
         no_tax
       end
 
@@ -36,7 +34,7 @@ module SuperGood
 
       def line_item_taxes
         @line_item_taxes ||=
-          taxjar_breakdown.line_items.map do |taxjar_line_item|
+          taxjar_breakdown.line_items.map { |taxjar_line_item|
             spree_line_item_id = taxjar_line_item.id.to_i
 
             # Searching in memory because this association is loaded and most
@@ -50,13 +48,13 @@ module SuperGood
               amount: taxjar_line_item.tax_collectable,
               included_in_price: false
             )
-          end
+          }
       end
 
       def shipment_taxes
         @shipment_taxes ||=
           if taxjar_breakdown.shipping? &&
-            (total_shipping_tax = taxjar_breakdown.shipping.tax_collectable) != 0
+              (total_shipping_tax = taxjar_breakdown.shipping.tax_collectable) != 0
 
             # Distribute shipping tax across shipments:
             # TaxJar does not provide a breakdown of shipping taxes, so we have
@@ -115,54 +113,23 @@ module SuperGood
         Spree::TaxRate.find_by(name: "Sales Tax")
       end
 
-      def cache
-        if !Rails.env.test?
-          Rails.cache.fetch(
-            cache_key,
-            expires_in: SuperGood::SolidusTaxJar.cache_duration
-          ) { yield }
-        else
-          yield
-        end
-      end
-
       def cache_key
-        SuperGood::SolidusTaxJar.cache_key.(order)
-      end
-
-      def exception_handler
-        SuperGood::SolidusTaxJar.exception_handler
+        SuperGood::SolidusTaxjar.cache_key.call(order)
       end
 
       def taxable_order?(order)
-        SuperGood::SolidusTaxJar.taxable_order_check.(order)
-      end
-
-      def taxable_address?(address)
-        SuperGood::SolidusTaxJar.taxable_address_check.(address)
+        SuperGood::SolidusTaxjar.taxable_order_check.call(order)
       end
 
       def shipping_tax_label(shipment, shipping_tax)
-        SuperGood::SolidusTaxJar.shipping_tax_label_maker.(
+        SuperGood::SolidusTaxjar.shipping_tax_label_maker.call(
           shipment,
           shipping_tax
         )
       end
 
       def line_item_tax_label(taxjar_line_item, spree_line_item)
-        SuperGood::SolidusTaxJar.line_item_tax_label_maker.(taxjar_line_item, spree_line_item)
-      end
-
-      def incomplete_address?(tax_address)
-        return true if tax_address.is_a?(Spree::Tax::TaxLocation)
-
-        [
-          tax_address.address1,
-          tax_address.city,
-          tax_address&.state&.abbr || tax_address.state_name,
-          tax_address.zipcode,
-          tax_address.country.iso
-        ].any?(&:blank?)
+        SuperGood::SolidusTaxjar.line_item_tax_label_maker.call(taxjar_line_item, spree_line_item)
       end
     end
   end

data/lib/super_good/solidus_taxjar/tax_rate_calculator.rb

@@ -0,0 +1,35 @@
+module SuperGood
+  module SolidusTaxjar
+    class TaxRateCalculator
+      include CalculatorHelper
+      def initialize(address, api: SuperGood::SolidusTaxjar.api)
+        @address = address
+        @api = api
+      end
+
+      def calculate
+        return no_rate if SuperGood::SolidusTaxjar.test_mode
+        return no_rate if incomplete_address?(address)
+        return no_rate unless taxable_address?(address)
+        cache do
+          api.tax_rate_for(address).to_d
+        end
+      rescue => e
+        exception_handler.call(e)
+        no_rate
+      end
+
+      private
+
+      attr_reader :address, :api
+
+      def no_rate
+        BigDecimal(0)
+      end
+
+      def cache_key
+        SuperGood::SolidusTaxjar.cache_key.call(address)
+      end
+    end
+  end
+end