super_good-solidus_taxjar 0.15.2 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b31e03589ed5699fa26ba2b8f2b5ccb99fe64af208fce5c15eba8ccec10366a
-  data.tar.gz: 63bb0d2f537723e15feaae9785090f6903c4bf6b7d2763915f22f5668dff6e89
+  metadata.gz: ea057c858aee853bafe0e6510d678028c46db7e1640383348ada09adbedcf8dc
+  data.tar.gz: 9e18d2dce1ed09754a6de1c8eecaac84af5f579fb9ebe8120d26fad646beb3d0
 SHA512:
-  metadata.gz: a09644d7afc6976fc173bd000137424ac398057db518491bbfdfd544cf66b046347959388d3c913016ee3c1b0c43211adcb2a83692c96e2a4b66cf20dc5acc45
-  data.tar.gz: a723866885f456c418004f0642ccd7351e371c288a3f8d81cdb9b7a7179d655b738ac41f2a85b5878cc5da17ebf8a3af8697a3e02270008882d1da0ac0735a64
+  metadata.gz: 9c042476951882510a92dd96ae09d0a8da6406a7d05edd93be023c1b6dfdc84d7a31a5c3fdc7904ea1c9115a04fe3a0d22c74d4520824ed02bd3ef0cf274c5c6
+  data.tar.gz: 66cf84615dd4b4bd478494bd464464e5d25bd02c5a49029c080c180ca5bd791fff6bb09108e4a597cdd4d7df8fc6cbff247d37476917fe5306288a5ae5e66707

data/.circleci/config.yml

@@ -0,0 +1,16 @@
+version: 2.1
+orbs:
+  solidusio_extensions: solidusio/extensions@0.2.24
+
+jobs:
+  run-specs-with-postgres:
+    executor: solidusio_extensions/postgres
+    steps:
+      - checkout
+      - solidusio_extensions/run-tests-solidus-older
+      - solidusio_extensions/store-test-results
+
+workflows:
+  "Run specs on supported Solidus versions":
+    jobs:
+      - run-specs-with-postgres

data/.gitignore

@@ -1,14 +1,20 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
+*.gem
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
 Gemfile.lock
-/spec/dummy
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+spec/examples.txt
+/sandbox
+.rvmrc
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -1,12 +1,19 @@
 ---
+dist: trusty
 sudo: false
 language: ruby
 cache: bundler
-rvm:
-  - 2.3.7
-env:
-  matrix:
-    - SOLIDUS_BRANCH=v2.4 DB=postgres RAILS_VERSION="~> 5.1.0"
+addons:
+  postgresql: "9.3"
+jobs:
+  include:
+    - rvm: 2.5.8
+      env: SOLIDUS_BRANCH=v2.9 DB=postgresql RAILS_VERSION="~> 5.1.0"
+    - rvm: 2.6.6
+      env: SOLIDUS_BRANCH=v2.10 DB=postgresql RAILS_VERSION="~> 5.2.0"
+    - rvm: 2.6.6
+      env: SOLIDUS_BRANCH=v2.10 DB=postgresql RAILS_VERSION="~> 6.0.0"
+
 before_install:
   - gem update --system
   - gem install bundler

data/CHANGELOG.md

@@ -1,6 +1,77 @@
 # Changelog
 
 ## master
+## v0.18.2
+
+- [#71](https://github.com/SuperGoodSoft/solidus_taxjar/pull/69) Unlock ExecJS version. This reverts the temporary fix introduced in #69
+- [#79](https://github.com/SuperGoodSoft/solidus_taxjar/pull/79) Relax Ruby required version to support Ruby 3.0+
+- [#51](https://github.com/SuperGoodSoft/solidus_taxjar/pull/51) Add nexus regions method to API
+- [#58](https://github.com/SuperGoodSoft/solidus_taxjar/pull/58) Take shipping promotions into account in default calculator
+- [#59](https://github.com/SuperGoodSoft/solidus_taxjar/pull/59) Add pry debugging tools
+- [#69](https://github.com/SuperGoodSoft/solidus_taxjar/pull/69) Lock ExecJS version
+- [#37](https://github.com/SuperGoodSoft/solidus_taxjar/pull/37) Added a basic Taxjar settings admin interface which displays placeholder text.
+- [#64](https://github.com/SuperGoodSoft/solidus_taxjar/pull/64) Provide Spree::Address.address2 to TaxJar address validation if it is present.
+- [#80](https://github.com/SuperGoodSoft/solidus_taxjar/pull/80) Support order_recalculated event in < 2.11
+
+## v0.18.1
+
+[#52](https://github.com/supergoodsoft/solidus_taxjar/pull/52) fixes a critical bug in the API class that was released in `v0.18.0`. Please upgrade.
+
+- [#47](https://github.com/SuperGoodSoft/solidus_taxjar/pull/47) Fixed bug in `validate_address_params` for addresses without a state
+- [#52](https://github.com/supergoodsoft/solidus_taxjar/pull/52) Fixed critical bug in API class
+
+## ~~v0.18.0~~
+`v0.18.0` was removed due to a regression in the API class that was fixed in [#52](https://github.com/SuperGoodSoft/solidus_taxjar/pull/52) and `v0.18.1`
+
+- [#21](https://github.com/SuperGoodSoft/solidus_taxjar/pull/21) Migrated project to `solidus_dev_support`
+- [#22](https://github.com/SuperGoodSoft/solidus_taxjar/pull/22) Added support for TaxJar address validation API through `SuperGood::SolidusTaxJar::Addresses` class
+- [#34](https://github.com/SuperGoodSoft/solidus_taxjar/pull/34) Include API version in request headers
+- [#38](https://github.com/SuperGoodSoft/solidus_taxjar/pull/38) Added a rails engine to support future solidus backend UI
+- [#43](https://github.com/SuperGoodSoft/solidus_taxjar/pull/43) Support zeitwerk loading
+
+**Breaking Changes**:
+
+- Module name `SolidusTaxJar` renamed to `SolidusTaxjar`
+- Class name `API` renamed to `Api`
+- Class name `APIParams` renamed to `ApiParams`
+
+### Upgrading from 0.17.X to 0.18.X
+
+If you're currently using version 0.17.X and want to upgrade to 0.18.X, follow these steps:
+
+- Rename any instances of the module `SolidusTaxJar` to `SolidusTaxjar`
+- Rename any instances of the class `API` to `Api`
+- Rename any instances of the class `APIParams` to `ApiParams`
+
+## 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
 

data/Gemfile

@@ -6,16 +6,34 @@ branch = ENV.fetch('SOLIDUS_BRANCH', 'master')
 
 gem "solidus", github: "solidusio/solidus", branch: branch
 
-if ENV['RAILS_VERSION']
-  gem "rails", ENV['RAILS_VERSON']
-end
+# Needed to help Bundler figure out how to resolve dependencies,
+# otherwise it takes forever to resolve them.
+# See https://github.com/bundler/bundler/issues/6677
+gem "rails", ENV.fetch("RAILS_VERSION") { ">0.a" }
+
+# Provides basic authentication functionality for testing parts of your engine
+gem "solidus_auth_devise"
 
-if ENV.fetch('DB') == 'postgres'
-  gem 'pg'
+case ENV["DB"]
+when "mysql"
+  gem "mysql2"
+when "postgresql"
+  gem "pg"
+else
+  gem "sqlite3"
 end
 
 group :development, :test do
   gem "pry"
+  gem "pry-stack_explorer"
+  gem "pry-byebug"
 end
 
 gemspec
+
+# Use a local Gemfile to include development dependencies that might not be
+# relevant for the project or for other contributors, e.g. pry-byebug.
+#
+# We use `send` instead of calling `eval_gemfile` to work around an issue with
+# how Dependabot parses projects: https://github.com/dependabot/dependabot-core/issues/1658.
+send(:eval_gemfile, "Gemfile-local") if File.exist? "Gemfile-local"

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2020 Super Good Software, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Solidus nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+What is the goal of this PR?
+---
+
+
+
+How do you manually test these changes? (if applicable)
+---
+
+1. Do a thing
+    * [ ] Assert a result
+
+Merge Checklist
+---
+
+- [ ] Run the manual tests
+- [ ] Update the changelog
+- [ ] Run a sandbox app and verify taxes are being calculated
+
+Screenshots
+---

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` [![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.
 
-`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
 
@@ -24,7 +22,7 @@ This is not a fork of [spree_taxjar](https://github.com/vinsol-spree-contrib/spr
    # Put this in config/initializers/solidus.rb
 
    Spree.config do |config|
-     config.tax_calculator_class = SuperGood::SolidusTaxJar::TaxCalculator
+     config.tax_calculator_class = SuperGood::SolidusTaxjar::TaxCalculator
    end
    ```
 
@@ -33,18 +31,45 @@ 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)
    }
    ```
 
-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.
+5. 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
+
+The extension requires the `order_recalculated` event which is not supported on Solidus < 2.11, so this extension provides a [compatibility layer](app/decorators/super_good/solidus_taxjar/spree/order_updater/fire_recalculated_event.rb).
+
+### 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.
+Before installing dependencies, make sure your environment variables are setup. Our CI uses something like this: `SOLIDUS_BRANCH=v2.10 DB=postgresql RAILS_VERSION="~> 5.2.0`. These environment variables need to be set when installing dependencies and running specs, so set them before the command like this: `SOLIDUS_BRANCH=v2.10 DB=postgresql RAILS_VERSION="~> 5.2.0 bin/setup`
+
+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.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -1,19 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require 'spree/testing_support/extension_rake'
+# frozen_string_literal: true
 
-RSpec::Core::RakeTask.new(:spec)
+require 'solidus_dev_support/rake_tasks'
+SolidusDevSupport::RakeTasks.install
 
-task :default do
-  if Dir["spec/dummy"].empty?
-    Rake::Task[:test_app].invoke
-    Dir.chdir("../../")
-  end
-  Rake::Task[:spec].invoke
-end
-
-desc 'Generates a dummy app for testing'
-task :test_app do
-  ENV['LIB_NAME'] = 'super_good/solidus_taxjar'
-  Rake::Task['extension:test_app'].invoke
-end
+task default: 'extension:specs'

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

@@ -0,0 +1,8 @@
+module Spree
+  module Admin
+    class TaxjarSettingsController < Spree::Admin::BaseController
+      def show
+      end
+    end
+  end
+end

data/app/decorators/super_good/solidus_taxjar/spree/order_updater/fire_recalculated_event.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SuperGood
+  module SolidusTaxjar
+    module Spree
+      module OrderUpdater
+        module FireRecalculatedEvent
+          def persist_totals
+            ::Spree::Event.fire 'order_recalculated', order: order
+            super
+          end
+
+          ::Spree::OrderUpdater.prepend(self) if ::Spree.solidus_gem_version < Gem::Version.new('2.11.0')
+        end
+      end
+    end
+  end
+end

data/app/overrides/spree/admin/shared/_configuration_menu.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+Deface::Override.new(
+  virtual_path: 'spree/admin/shared/_taxes_tabs',
+  name: 'add_taxjar_admin_menu_links',
+  insert_bottom: "[data-hook='admin_settings_taxes_tabs']"
+) do
+  <<-HTML
+    <%= configurations_sidebar_menu_item "TaxJar Settings", admin_taxjar_settings_path %>
+  HTML
+end

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

@@ -0,0 +1,13 @@
+<%= render 'spree/admin/shared/taxes_tabs' %>
+
+<% content_for :page_title do %>
+  <%= "Taxjar Settings" %>
+<% end %>
+
+<% if ENV["TAXJAR_API_KEY"] %>
+  <table>
+  </table>
+<% else %>
+  <p>You must provide a TaxJar API token to use this extension. You can sign up for TaxJar <%= link_to "here", "https://app.taxjar.com/api_sign_up", target: "_blank", rel: "noreferrer" %>. Please see the extension documentation for details on providing this token to the extension.</p>
+  <p><i>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" %></i></p>
+<% end %>

data/bin/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/bin/rails-engine

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/solidus_taxjar/engine", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

data/bin/rails-sandbox

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+app_root = "sandbox"
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn "Creating the sandbox app..."
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+      warn "Automatic creation of the sandbox app failed"
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec "bin/rails", *ARGV