super_good-solidus_taxjar 0.18.1 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 977d3ededff1e9bd56c37b6dda9228545160525fed6f7667e194e0ab45486ce8
-  data.tar.gz: 10466dec877f8de3eadb843929ec93173bc30fd7ab58be34c5ff08d5de4214b2
+  metadata.gz: ea057c858aee853bafe0e6510d678028c46db7e1640383348ada09adbedcf8dc
+  data.tar.gz: 9e18d2dce1ed09754a6de1c8eecaac84af5f579fb9ebe8120d26fad646beb3d0
 SHA512:
-  metadata.gz: 46ffc2f0a1c52205acdf91a12ec2a3b1806bca174450a1a763e03ba1c54add5a7c82ac538b04bca72c31fa7d295fc2cd9a040e719cd58ddaf7233a1af7655b35
-  data.tar.gz: 3186b598fb5d11dd0cab75e145d8e088e6563562767acab012e4127544428fa6e4ac927adb2cc1c9ccbd7dfc831e7bdde1e402462596230736045bb970d54c6e
+  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/CHANGELOG.md

@@ -1,15 +1,26 @@
 # Changelog
 
 ## master
+## v0.18.2
 
-## v0.18.1 
+- [#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~~
 `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`

data/Gemfile

@@ -25,6 +25,8 @@ end
 
 group :development, :test do
   gem "pry"
+  gem "pry-stack_explorer"
+  gem "pry-byebug"
 end
 
 gemspec

data/PULL_REQUEST_TEMPLATE.md

@@ -14,6 +14,7 @@ Merge Checklist
 
 - [ ] Run the manual tests
 - [ ] Update the changelog
+- [ ] Run a sandbox app and verify taxes are being calculated
 
 Screenshots
 ---

data/README.md

@@ -16,14 +16,7 @@ This is not a fork of [spree_taxjar](https://github.com/vinsol-spree-contrib/spr
 
        $ bundle
 
-2. Install and run the necessary migrations:
-
-   ```shell
-   bundle exec rails g super_good:solidus_taxjar:install
-   bundle exec rake db:migrate
-   ```
-
-3. Next, configure Solidus to use this gem:
+2. Next, configure Solidus to use this gem:
 
    ```ruby
    # Put this in config/initializers/solidus.rb
@@ -33,7 +26,7 @@ This is not a fork of [spree_taxjar](https://github.com/vinsol-spree-contrib/spr
    end
    ```
 
-4. Also, configure your error handling:
+3. Also, configure your error handling:
 
    ```ruby
    # Put this in config/initializers/taxjar.rb
@@ -62,6 +55,8 @@ The extension provides currently two high level `calculator` classes that wrap t
 * 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.

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/config/routes.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Spree::Core::Engine.routes.draw do
+  namespace :admin do
+    resource :taxjar_settings, only: [:show]
+  end
+end

data/lib/super_good/engine.rb

@@ -4,5 +4,7 @@ module SuperGoodSolidusTaxjar
   class Engine < Rails::Engine
     isolate_namespace Spree
     engine_name 'super_good_solidus_taxjar'
+
+    include SolidusSupport::EngineExtensions
   end
 end

data/lib/super_good/solidus_taxjar.rb

@@ -44,7 +44,7 @@ module SuperGood
     }
     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_calculator = ->(order) { order.shipments.sum(&:total_before_tax) }
     self.shipping_tax_label_maker = ->(shipment, shipping_tax) { "Sales Tax" }
     self.taxable_address_check = ->(address) { true }
     self.taxable_order_check = ->(order) { true }

data/lib/super_good/solidus_taxjar/addresses.rb

@@ -20,7 +20,7 @@ module SuperGood
 
         return if taxjar_address.nil?
 
-        Spree::Address.immutable_merge(spree_address, {
+        ::Spree::Address.immutable_merge(spree_address, {
           country: us, # TaxJar only supports the US currently.
           state: state(taxjar_address.state),
           zipcode: taxjar_address.zip,
@@ -31,7 +31,7 @@ module SuperGood
 
       def possibilities(spree_address)
         taxjar_addresses(spree_address).map { |taxjar_address|
-          Spree::Address.immutable_merge(spree_address, {
+          ::Spree::Address.immutable_merge(spree_address, {
             country: us, # TaxJar only supports the US currently.
             state: state(taxjar_address.state),
             zipcode: taxjar_address.zip,
@@ -52,7 +52,7 @@ module SuperGood
       end
 
       def us
-        Spree::Country.find_by iso: "US"
+        ::Spree::Country.find_by iso: "US"
       end
 
       def state(abbr)

data/lib/super_good/solidus_taxjar/api.rb

@@ -55,6 +55,10 @@ module SuperGood
         taxjar_client.validate_address ApiParams.validate_address_params(spree_address)
       end
 
+      def nexus_regions
+        taxjar_client.nexus_regions
+      end
+
       private
 
       attr_reader :taxjar_client

data/lib/super_good/solidus_taxjar/api_params.rb

@@ -72,7 +72,7 @@ module SuperGood
             state: spree_address.state&.abbr || spree_address.state_name,
             zip: spree_address.zipcode,
             city: spree_address.city,
-            street: spree_address.address1
+            street: [spree_address.address1, spree_address.address2].compact.join(' ')
           }
         end
 

data/lib/super_good/solidus_taxjar/calculator_helper.rb

@@ -4,7 +4,7 @@ module SuperGood
       extend ActiveSupport::Concern
 
       def incomplete_address?(address)
-        return true if address.is_a?(Spree::Tax::TaxLocation)
+        return true if address.is_a?(::Spree::Tax::TaxLocation)
 
         [
           address.address1,

data/lib/super_good/solidus_taxjar/tax_calculator.rb

@@ -17,7 +17,7 @@ module SuperGood
         cache do
           next no_tax unless taxjar_breakdown
 
-          Spree::Tax::OrderTax.new(
+          ::Spree::Tax::OrderTax.new(
             order_id: order.id,
             line_item_taxes: line_item_taxes,
             shipment_taxes: shipment_taxes
@@ -41,7 +41,7 @@ module SuperGood
             # orders aren't going to have a huge number of line items.
             spree_line_item = order.line_items.find { |li| li.id == spree_line_item_id }
 
-            Spree::Tax::ItemTax.new(
+            ::Spree::Tax::ItemTax.new(
               item_id: spree_line_item_id,
               label: line_item_tax_label(taxjar_line_item, spree_line_item),
               tax_rate: tax_rate,
@@ -102,7 +102,7 @@ module SuperGood
       end
 
       def no_tax
-        Spree::Tax::OrderTax.new(
+        ::Spree::Tax::OrderTax.new(
           order_id: order.id,
           line_item_taxes: [],
           shipment_taxes: []
@@ -110,7 +110,7 @@ module SuperGood
       end
 
       def tax_rate
-        Spree::TaxRate.find_by(name: "Sales Tax")
+        ::Spree::TaxRate.find_by(name: "Sales Tax")
       end
 
       def cache_key

data/lib/super_good/solidus_taxjar/version.rb

@@ -1,5 +1,5 @@
 module SuperGood
   module SolidusTaxjar
-    VERSION = "0.18.1"
+    VERSION = "0.18.2"
   end
 end

data/spec/features/spree/admin/taxjar_settings_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+RSpec.feature 'Admin TaxJar Settings', js: true do
+  stub_authorization!
+
+  background do
+    create :store, default: true
+  end
+
+  describe "Taxjar settings tab" do
+    before do
+      allow(ENV).to receive(:[]).and_call_original
+      allow(ENV).to receive(:[]).with("TAXJAR_API_KEY").and_return(api_token)
+    end
+
+    context "Taxjar API token is set" do
+      let(:api_token) { "token" }
+
+      it "shows a blank settings page" do
+
+        visit "/admin"
+        click_on "Settings"
+        expect(page).to have_content("Taxes")
+        click_on "Taxes"
+        expect(page).to have_content("TaxJar Settings")
+        click_on "TaxJar Settings"
+        expect(page).not_to have_content "You must provide a TaxJar API token"
+      end
+    end
+
+    context "Taxjar API token isn't set" do
+      let(:api_token) { nil }
+
+      it "shows a descriptive error message" do
+        visit "/admin"
+        click_on "Settings"
+        expect(page).to have_content("Taxes")
+        click_on "Taxes"
+        expect(page).to have_content("TaxJar Settings")
+        click_on "TaxJar Settings"
+        expect(page).to have_content "You must provide a TaxJar API token"
+
+        expect(page).to have_link(href: "https://app.taxjar.com/api_sign_up")
+        expect(page).to have_link(href: "https://support.taxjar.com/article/160-how-do-i-get-a-sales-tax-api-token")
+      end
+    end
+  end
+end

data/spec/models/spree/order_updater_spec.rb

@@ -0,0 +1,12 @@
+RSpec.describe Spree::OrderUpdater do
+  describe '#update' do
+    it 'fires the order_recalculated event exactly once' do
+      stub_const('Spree::Event', class_spy(Spree::Event))
+      order = create(:order)
+
+      described_class.new(order).update
+
+      expect(Spree::Event).to have_received(:fire).with('order_recalculated', order: order).once
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ require File.expand_path("dummy/config/environment.rb", __dir__).tap { |file|
   system "bin/rake extension:test_app" unless File.exist? file
 }
 
-require "solidus_dev_support/rspec/rails_helper"
+require "solidus_dev_support/rspec/feature_helper"
 
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.

data/spec/super_good/solidus_taxjar/api_params_spec.rb

@@ -8,9 +8,9 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
       line_items: [line_item],
       number: "R111222333",
       ship_address: ship_address,
-      shipment_total: BigDecimal("3.01"),
       store: store,
       total: order_total,
+      shipments: [shipment],
       user_id: 12345
     ).tap do |order|
       order.update! completed_at: DateTime.new(2018, 3, 6, 12, 10, 33)
@@ -119,6 +119,8 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
     )
   end
 
+  let(:shipment) { Spree::Shipment.create!(cost: BigDecimal("3.01")) }
+
   describe "#order_params" do
     subject { described_class.order_params(order) }
 
@@ -398,5 +400,35 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
         })
       end
     end
+
+    context "an address with address2" do
+      let(:ship_address) do
+        Spree::Address.create!(
+          address1: "1 World Trade CTR",
+          address2: "STE 45A",
+          city: "New York",
+          country: country_us,
+          first_name: "Chuck",
+          last_name: "Schuldiner",
+          phone: "1-250-555-4444",
+          state: Spree::State.create!(
+            abbr: "NY",
+            country: country_us,
+            name: "New York"
+          ),
+          zipcode: "10007"
+        )
+      end
+
+      it "concatenates address1 and address2 into the street parameter" do
+        expect(subject).to eq({
+          country: "US",
+          state: "NY",
+          zip: "10007",
+          city: "New York",
+          street: "1 World Trade CTR STE 45A"
+        })
+      end
+    end
   end
 end

data/spec/super_good/solidus_taxjar/api_spec.rb

@@ -5,7 +5,8 @@ RSpec.describe SuperGood::SolidusTaxjar::Api do
     subject { described_class.new }
 
     before do
-      ENV["TAXJAR_API_KEY"] = 'taxjar_api_token'
+      allow(ENV).to receive(:fetch).and_call_original
+      allow(ENV).to receive(:fetch).with("TAXJAR_API_KEY").and_return("taxjar_api_token")
     end
 
     it "sets the correct headers" do
@@ -21,7 +22,8 @@ RSpec.describe SuperGood::SolidusTaxjar::Api do
     subject { described_class.default_taxjar_client }
 
     before do
-      ENV["TAXJAR_API_KEY"] = 'taxjar_api_token'
+      allow(ENV).to receive(:fetch).and_call_original
+      allow(ENV).to receive(:fetch).with("TAXJAR_API_KEY").and_return("taxjar_api_token")
     end
 
     it "returns an instance of the TaxJar client" do
@@ -202,4 +204,19 @@ RSpec.describe SuperGood::SolidusTaxjar::Api do
 
     it { is_expected.to eq({some_kind_of: "response"}) }
   end
+
+  describe "#nexus_regions" do
+    subject { api.nexus_regions }
+
+    let(:api) { described_class.new(taxjar_client: dummy_client) }
+    let(:dummy_client) { instance_double ::Taxjar::Client }
+
+    before do
+      allow(dummy_client)
+        .to receive(:nexus_regions)
+        .and_return({some_kind_of: "response"})
+    end
+
+    it { is_expected.to eq({some_kind_of: "response"}) }
+  end
 end

data/spec/super_good/solidus_taxjar_spec.rb

@@ -73,5 +73,20 @@ RSpec.describe SuperGood::SolidusTaxjar do
       let(:spree_line_item) { Spree::LineItem.new }
       it { is_expected.to eq "Sales Tax" }
     end
+
+    describe ".shipping_calculator" do
+      subject { described_class.shipping_calculator.call(order) }
+
+      let(:order) { create :order }
+      let(:shipment) { create :shipment, order: order, cost: 20 }
+
+      before do
+        create :adjustment, order: order, adjustable: shipment, amount: -10, eligible: true, source: create(:shipping_rate, shipment: shipment)
+      end
+
+      it "returns the shipment total including promotions" do
+        expect(subject).to eq(10)
+      end
+    end
   end
 end

data/super_good-solidus_taxjar.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage = "https://github.com/SuperGoodSoft/solidus_taxjar"
   spec.license = 'BSD-3-Clause'
 
-  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+  spec.required_ruby_version = ">= 2.5.0"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_good-solidus_taxjar
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.18.2
 platform: ruby
 authors:
 - Jared Norman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solidus_core
@@ -157,6 +157,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -167,6 +168,10 @@ files:
 - PULL_REQUEST_TEMPLATE.md
 - README.md
 - Rakefile
+- app/controllers/spree/admin/taxjar_settings_controller.rb
+- app/decorators/super_good/solidus_taxjar/spree/order_updater/fire_recalculated_event.rb
+- app/overrides/spree/admin/shared/_configuration_menu.rb
+- app/views/spree/admin/taxjar_settings/show.html.erb
 - bin/console
 - bin/rails
 - bin/rails-engine
@@ -174,6 +179,7 @@ files:
 - bin/rake
 - bin/sandbox
 - bin/setup
+- config/routes.rb
 - lib/super_good-solidus_taxjar.rb
 - lib/super_good/engine.rb
 - lib/super_good/solidus_taxjar.rb
@@ -185,6 +191,8 @@ files:
 - lib/super_good/solidus_taxjar/tax_calculator.rb
 - lib/super_good/solidus_taxjar/tax_rate_calculator.rb
 - lib/super_good/solidus_taxjar/version.rb
+- spec/features/spree/admin/taxjar_settings_spec.rb
+- spec/models/spree/order_updater_spec.rb
 - spec/spec_helper.rb
 - spec/super_good/solidus_taxjar/addresses_spec.rb
 - spec/super_good/solidus_taxjar/api_params_spec.rb
@@ -204,20 +212,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Support for using TaxJar to handle tax calculations in Solidus
 test_files:
+- spec/features/spree/admin/taxjar_settings_spec.rb
+- spec/models/spree/order_updater_spec.rb
 - spec/spec_helper.rb
 - spec/super_good/solidus_taxjar/addresses_spec.rb
 - spec/super_good/solidus_taxjar/api_params_spec.rb