super_good-solidus_taxjar 0.15.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 045cc30a313283d465e1252ef957dc484d780e4dcf9eae06263dd9dd1e95f5d7
-  data.tar.gz: fb605130f6c7602f31c4bea0604183df3e77c166bbaad1b7391a7f51ad7e0cff
+  metadata.gz: a31766c3361794c3a8180a0a8f8b6af7f2b8e970929e203fa5a9b02e8b917f5a
+  data.tar.gz: 7f588d8f3f693426ead6eb43ca801a1e1d7cb9151d951d2ec4af11bb666b49f8
 SHA512:
-  metadata.gz: c25108f00d39800dad1bb3d217b71d929e64ce4bf5713f414fa40878b89fc814f5fdac5abdb7e897aebc5fa937edcf84e4e9d25122c2c82dba36427fa968c605
-  data.tar.gz: 06a05cb7a0fdbbbb15c3472353219f0f7db544be35c2d3f5c00dae8537d67e869789b141d526b991365d3af90c19e903cedfc85966fecffae19661f13eae2778
+  metadata.gz: 588484c98a53622a57266891dfc5c504e637c5962071268847bf7bcbab7f6242c32b60f81130cdfe6858acd8d9502272a18ebcb7f7b30ca3d7bf86973e7dc585
+  data.tar.gz: ef6153d10eb4cfd65e19d4ed1805f4b7e30a1190b65ba07fda2602b66ebf3450fb58ab57c2c197e758e4e9d1da2f34c5cc65a8b320fd71225f1059a42fe9ad57

data/.travis.yml

@@ -1,4 +1,5 @@
 ---
+dist: trusty
 sudo: false
 language: ruby
 cache: bundler

data/CHANGELOG.md

@@ -2,6 +2,44 @@
 
 ## master
 
+## v0.17.1
+
+- Fixed bug where shipping calculator was not used for order shipping param. (Thanks @spaghetticode!)
+
+## v0.17.0
+
+- Added `SuperGood::SolidusTaxJar.custom_order_params` to allow for custom overrides to the parameters sent to TaxJar when calculating order taxes. For example, if you needed to send a custom nexus address you could do:
+  ```ruby
+  SuperGood::SolidusTaxJar.custom_order_params = ->(order) {
+    {
+      nexus_addresses: [
+        {
+          id: 'Main Location',
+          country: 'AU',
+          zip: 'NSW 2000',
+          city: 'Sydney',
+          street: '483 George St',
+        }
+      ]
+    }
+  }
+  ```
+  The callback receives the `Spree::Order` that the params are for and the return value can override existing values like the order's ID.
+
+## v0.16.0
+
+- Fix `#incomplete_address?` method to be friendly also to completely blank addresses.
+
+- Added `SuperGood::SolidusTaxJar::TaxRateCalculator` for retrieving the tax rate for a given `Spree::Address`. The calculator follows `TaxCalculator` conventions by relying on address validators and custom exception handling.
+
+## v0.15.2
+
+- Add order number to param logging.
+
+## v0.15.1
+
+- Add support for request/response logging.
+
 ## v0.15.0
 
 - Made sure cache key is a string, instead of a giant nested hash/array structure that probably won't get interpreted by Rails well. Still not happy with the caching behaviour, but it's configurable.

data/README.md

@@ -1,10 +1,8 @@
-## *Warning:* This extension is under active development and not yet at a v1.0 release.
-
 # `SuperGood::SolidusTaxJar` [![Build Status](https://travis-ci.com/SuperGoodSoft/solidus_taxjar.svg?token=rc5QTgHvLLF7cpqkmyfd&branch=master)](https://travis-ci.com/SuperGoodSoft/solidus_taxjar)
 
 `SuperGood::SolidusTaxJar` is a [Solidus](https://github.com/solidusio/solidus) extension that allows Solidus stores to use [TaxJar](https://www.taxjar.com/) for tax calculations.
 
-This is not a fork of [spree_taxjar](https://github.com/vinsol-spree-contrib/spree_taxjar), like [solidus_taxjar](https://github.com/boomerdigital/solidus_taxjar). Instead, `SuperGood::SolidusTaxJar` uses the new configurable tax system [introduced by @adammathys](https://github.com/solidusio/solidus/pull/1892) in Solidus 2.4.
+This is not a fork of [spree_taxjar](https://github.com/vinsol-spree-contrib/spree_taxjar), like [solidus_taxjar](https://github.com/boomerdigital/solidus_taxjar). Instead of using a custom calculator, `SuperGood::SolidusTaxJar` uses the new configurable tax system [by @adammathys](https://github.com/solidusio/solidus/pull/1892) introduced in Solidus v2.4. This maps better to how the TaxJar API itself works.
 
 ## Installation
 
@@ -33,7 +31,7 @@ This is not a fork of [spree_taxjar](https://github.com/vinsol-spree-contrib/spr
    ```ruby
    # Put this in config/initializers/taxjar.rb
 
-   SuperGood::SolidusTaxJar::TaxCalculator.exception_handler = ->(e) {
+   SuperGood::SolidusTaxJar.exception_handler = ->(e) {
      # Report exceptions in here. For example, if you were using the Sentry's
      # raven-ruby gem to report errors, you might do this:
      Raven.capture_exception(e)
@@ -42,6 +40,29 @@ This is not a fork of [spree_taxjar](https://github.com/vinsol-spree-contrib/spr
 
 4. Finally, make sure that the `TAXJAR_API_KEY` environment variable is set to a your TaxJar API key and make sure that you have a `Spree::TaxRate` with the name "Sales Tax". This will be used as the source for the tax adjustments that Solidus creates.
 
+## Project Status
+
+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.
+
+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 [jared@super.gd](mailto:jared@super.gd) or on the official Solidus as `@jared`.
+
+## Features
+
+The extension provides currently two high level `calculator` classes that wrap the low-level Ruby taxjar gem API calls:
+
+* tax calculator
+* tax rate calculator
+
+### TaxCalculator
+
+`SuperGood::SolidusTaxJar::TaxCalculator` allows calculating the full tax breakdown for a given `Spree::Order`. The breakdown includes separate line items taxes and shipment taxes.
+
+### TaxRateCalculator
+
+`SuperGood::SolidusTaxJar::TaxRateCalculator` allows calculating the tax rate for a given `Spree::Address`. It relies on the same low-level Ruby TaxJar API endpoint of the tax calculator in order to provide the most coherent and reliable results. TaxJar support recommends using this endpoint for live calculations.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/super_good/solidus_taxjar.rb

@@ -5,7 +5,9 @@ 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"
 
 module SuperGood
@@ -13,9 +15,11 @@ module SuperGood
     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
+      attr_accessor :logging_enabled
       attr_accessor :shipping_calculator
       attr_accessor :shipping_tax_label_maker
       attr_accessor :taxable_address_check
@@ -24,12 +28,17 @@ module SuperGood
     end
 
     self.cache_duration = 3.hours
-    self.cache_key = ->(order) { APIParams.order_params(order).to_json }
+    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}"
     }
     self.line_item_tax_label_maker = ->(taxjar_line_item, spree_line_item) { "Sales Tax" }
+    self.logging_enabled = false
     self.shipping_calculator = ->(order) { order.shipment_total }
     self.shipping_tax_label_maker = ->(shipment, shipping_tax) { "Sales Tax" }
     self.taxable_address_check = ->(address) { true }

data/lib/super_good/solidus_taxjar/api.rb

@@ -13,7 +13,17 @@ module SuperGood
       end
 
       def tax_for(order)
-        taxjar_client.tax_for_order APIParams.order_params(order)
+        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}"
+          )
+        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)

data/lib/super_good/solidus_taxjar/api_params.rb

@@ -7,7 +7,15 @@ module SuperGood
             .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.(order))
+            .tap do |params|
+              next unless SuperGood::SolidusTaxJar.logging_enabled
+
+              Rails.logger.info(
+                "TaxJar params for #{order.number}: #{params.inspect}"
+              )
+            end
         end
 
         def address_params(address)
@@ -22,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))

data/lib/super_good/solidus_taxjar/calculator_helper.rb

@@ -0,0 +1,44 @@
+module SuperGood
+  module SolidusTaxJar
+    module CalculatorHelper
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def default_api
+          ::SuperGood::SolidusTaxJar::API.new
+        end
+      end
+
+      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.(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/tax_calculator.rb

@@ -1,9 +1,7 @@
 module SuperGood
   module SolidusTaxJar
     class TaxCalculator
-      def self.default_api
-        ::SuperGood::SolidusTaxJar::API.new
-      end
+      include CalculatorHelper
 
       def initialize(order, api: self.class.default_api)
         @order = order
@@ -115,33 +113,14 @@ 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
-      end
-
       def taxable_order?(order)
         SuperGood::SolidusTaxJar.taxable_order_check.(order)
       end
 
-      def taxable_address?(address)
-        SuperGood::SolidusTaxJar.taxable_address_check.(address)
-      end
-
       def shipping_tax_label(shipment, shipping_tax)
         SuperGood::SolidusTaxJar.shipping_tax_label_maker.(
           shipment,
@@ -152,18 +131,6 @@ module SuperGood
       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?)
-      end
     end
   end
 end

data/lib/super_good/solidus_taxjar/tax_rate_calculator.rb

@@ -0,0 +1,36 @@
+module SuperGood
+  module SolidusTaxJar
+    class TaxRateCalculator
+      include CalculatorHelper
+      def initialize(address, api: self.class.default_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 StandardError => e
+        exception_handler.(e)
+        no_rate
+      end
+
+      private
+
+      attr_reader :address, :api
+
+      def no_rate
+        BigDecimal(0)
+      end
+
+      def cache_key
+        SuperGood::SolidusTaxJar.cache_key.(address)
+      end
+    end
+  end
+end

data/lib/super_good/solidus_taxjar/version.rb

@@ -1,5 +1,5 @@
 module SuperGood
   module SolidusTaxJar
-    VERSION = "0.15.0"
+    VERSION = "0.17.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_good-solidus_taxjar
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.1
 platform: ruby
 authors:
 - Jared Norman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-25 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus_core
@@ -171,8 +171,10 @@ files:
 - lib/super_good/solidus_taxjar.rb
 - lib/super_good/solidus_taxjar/api.rb
 - lib/super_good/solidus_taxjar/api_params.rb
+- lib/super_good/solidus_taxjar/calculator_helper.rb
 - lib/super_good/solidus_taxjar/discount_calculator.rb
 - lib/super_good/solidus_taxjar/tax_calculator.rb
+- lib/super_good/solidus_taxjar/tax_rate_calculator.rb
 - lib/super_good/solidus_taxjar/version.rb
 - super_good-solidus_taxjar.gemspec
 homepage: https://github.com/SuperGoodSoft/solidus_taxjar