super_good-solidus_taxjar 0.15.2 → 0.18.2

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

data/lib/super_good/solidus_taxjar/version.rb

@@ -1,5 +1,5 @@
 module SuperGood
-  module SolidusTaxJar
-    VERSION = "0.15.2"
+  module SolidusTaxjar
+    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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("dummy/config/environment.rb", __dir__).tap { |file|
+  # Create the dummy app if it's still missing.
+  system "bin/rake extension:test_app" unless File.exist? file
+}
+
+require "solidus_dev_support/rspec/feature_helper"
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = false
+end

data/spec/super_good/solidus_taxjar/addresses_spec.rb

@@ -0,0 +1,288 @@
+require "spec_helper"
+
+RSpec.describe SuperGood::SolidusTaxjar::Addresses do
+  describe "#normalize" do
+    subject { described_class.new(api: dummy_api).normalize(spree_address) }
+
+    let(:spree_address) {
+      create(
+        :address,
+        address1: "475 North Beverly Drive",
+        city: "Los Angeles",
+        country: country_us,
+        first_name: "Chuck",
+        last_name: "Schuldiner",
+        phone: "1-250-555-4444",
+        state: state_california,
+        zipcode: "90210"
+      )
+    }
+
+    let(:country_us) {
+      Spree::Country.create!(
+        iso3: "USA",
+        iso: "US",
+        iso_name: "UNITED STATES",
+        name: "United States",
+        numcode: 840,
+        states_required: true
+      )
+    }
+
+    let(:state_california) {
+      Spree::State.create!(
+        abbr: "CA",
+        country: country_us,
+        name: "California"
+      )
+    }
+
+    let(:dummy_api) {
+      instance_double ::SuperGood::SolidusTaxjar::Api
+    }
+
+    context "when there are no possibilities for the address" do
+      before do
+        allow(dummy_api)
+          .to receive(:validate_spree_address)
+          .with(spree_address)
+          .and_raise(Taxjar::Error::NotFound)
+      end
+
+      it { is_expected.to be_nil }
+    end
+
+    context "when there is one possibility for the address" do
+      before do
+        allow(dummy_api)
+          .to receive(:validate_spree_address)
+          .with(spree_address)
+          .and_return(results)
+      end
+
+      let(:results) {
+        [
+          Taxjar::Address.new(
+            country: "US",
+            state: "CA",
+            zip: "90210-4606",
+            city: "Beverly Hills",
+            street: "475 N Beverly Dr"
+          )
+        ]
+      }
+
+      it "returns a sanitized address" do
+        expect(subject).to eq(
+          build(
+            :address,
+            address1: "475 N Beverly Dr",
+            city: "Beverly Hills",
+            country: country_us,
+            first_name: "Chuck",
+            last_name: "Schuldiner",
+            phone: "1-250-555-4444",
+            state: state_california,
+            zipcode: "90210-4606"
+          )
+        )
+      end
+    end
+
+    context "when there are multiple possibilities for the address" do
+      before do
+        allow(dummy_api)
+          .to receive(:validate_spree_address)
+          .with(spree_address)
+          .and_return(results)
+      end
+
+      let(:results) {
+        [
+          Taxjar::Address.new(
+            country: "US",
+            state: "CA",
+            zip: "90210-4606",
+            city: "Beverly Hills",
+            street: "475 N Beverly Dr"
+          ),
+          Taxjar::Address.new(
+            country: "US",
+            state: "AZ",
+            zip: "90213-4606",
+            city: "Beverly Hills",
+            street: "475 N Beverly Dr"
+          )
+        ]
+      }
+
+      it "uses the first result to sanitize the addresses" do
+        expect(subject).to eq(
+          build(
+            :address,
+            address1: "475 N Beverly Dr",
+            city: "Beverly Hills",
+            country: country_us,
+            first_name: "Chuck",
+            last_name: "Schuldiner",
+            phone: "1-250-555-4444",
+            state: state_california,
+            zipcode: "90210-4606"
+          )
+        )
+      end
+    end
+  end
+
+  describe "#normalize" do
+    subject { described_class.new(api: dummy_api).possibilities(spree_address) }
+
+    let(:spree_address) {
+      create(
+        :address,
+        address1: "475 North Beverly Drive",
+        city: "Los Angeles",
+        country: country_us,
+        first_name: "Chuck",
+        last_name: "Schuldiner",
+        phone: "1-250-555-4444",
+        state: state_california,
+        zipcode: "90210"
+      )
+    }
+
+    let(:country_us) {
+      Spree::Country.create!(
+        iso3: "USA",
+        iso: "US",
+        iso_name: "UNITED STATES",
+        name: "United States",
+        numcode: 840,
+        states_required: true
+      )
+    }
+
+    let(:state_california) {
+      Spree::State.create!(
+        abbr: "CA",
+        country: country_us,
+        name: "California"
+      )
+    }
+
+    let(:dummy_api) {
+      instance_double ::SuperGood::SolidusTaxjar::Api
+    }
+
+    context "when there are no possibilities for the address" do
+      before do
+        allow(dummy_api)
+          .to receive(:validate_spree_address)
+          .with(spree_address)
+          .and_raise(Taxjar::Error::NotFound)
+      end
+
+      it { is_expected.to be_empty }
+    end
+
+    context "when there is one possibility for the address" do
+      before do
+        allow(dummy_api)
+          .to receive(:validate_spree_address)
+          .with(spree_address)
+          .and_return(results)
+      end
+
+      let(:results) {
+        [
+          Taxjar::Address.new(
+            country: "US",
+            state: "CA",
+            zip: "90210-4606",
+            city: "Beverly Hills",
+            street: "475 N Beverly Dr"
+          )
+        ]
+      }
+
+      it "returns the possibilities" do
+        expect(subject).to eq([
+          build(
+            :address,
+            address1: "475 N Beverly Dr",
+            city: "Beverly Hills",
+            country: country_us,
+            first_name: "Chuck",
+            last_name: "Schuldiner",
+            phone: "1-250-555-4444",
+            state: state_california,
+            zipcode: "90210-4606"
+          )
+        ])
+      end
+    end
+
+    context "when there are multiple possibilities for the address" do
+      before do
+        allow(dummy_api)
+          .to receive(:validate_spree_address)
+          .with(spree_address)
+          .and_return(results)
+      end
+
+      let(:results) {
+        [
+          Taxjar::Address.new(
+            country: "US",
+            state: "CA",
+            zip: "90210-4606",
+            city: "Beverly Hills",
+            street: "475 N Beverly Dr"
+          ),
+          Taxjar::Address.new(
+            country: "US",
+            state: "AZ",
+            zip: "90213-1234",
+            city: "Phoenix",
+            street: "473 N Beverly Dr"
+          )
+        ]
+      }
+
+      let!(:state_arizona) {
+        Spree::State.create!(
+          abbr: "AZ",
+          country: country_us,
+          name: "Arizona"
+        )
+      }
+
+      it "returns all the possibilities" do
+        expect(subject).to eq([
+          build(
+            :address,
+            address1: "475 N Beverly Dr",
+            city: "Beverly Hills",
+            country: country_us,
+            first_name: "Chuck",
+            last_name: "Schuldiner",
+            phone: "1-250-555-4444",
+            state: state_california,
+            zipcode: "90210-4606"
+          ),
+          build(
+            :address,
+            address1: "473 N Beverly Dr",
+            city: "Phoenix",
+            country: country_us,
+            first_name: "Chuck",
+            last_name: "Schuldiner",
+            phone: "1-250-555-4444",
+            state: state_arizona,
+            zipcode: "90213-1234"
+          )
+        ])
+      end
+    end
+  end
+end

data/spec/super_good/solidus_taxjar/api_params_spec.rb

@@ -0,0 +1,434 @@
+require "spec_helper"
+
+RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
+  let(:order) do
+    Spree::Order.create!(
+      additional_tax_total: BigDecimal("9.87"),
+      item_total: BigDecimal("28.00"),
+      line_items: [line_item],
+      number: "R111222333",
+      ship_address: ship_address,
+      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)
+    end
+  end
+  let(:order_total) { BigDecimal("123.45") }
+
+  let(:store) do
+    Spree::Store.create!(
+      cart_tax_country_iso: "US",
+      code: "store",
+      mail_from_address: "contact@example.com",
+      name: "Default Store",
+      url: "https://store.example.com"
+    )
+  end
+
+  let(:ship_address) do
+    Spree::Address.create!(
+      address1: "475 N Beverly Dr",
+      city: "Los Angeles",
+      country: country_us,
+      first_name: "Chuck",
+      last_name: "Schuldiner",
+      phone: "1-250-555-4444",
+      state: state_california,
+      zipcode: "90210"
+    )
+  end
+
+  let(:country_us) do
+    Spree::Country.create!(
+      iso3: "USA",
+      iso: "US",
+      iso_name: "UNITED STATES",
+      name: "United States",
+      numcode: 840,
+      states_required: true
+    )
+  end
+
+  let(:state_california) do
+    Spree::State.create!(
+      abbr: "CA",
+      country: country_us,
+      name: "California"
+    )
+  end
+
+  let(:line_item) do
+    Spree::LineItem.new(
+      additional_tax_total: 4,
+      price: 10,
+      promo_total: -2,
+      quantity: 3,
+      variant: variant
+    )
+  end
+
+  let(:variant) do
+    Spree::Variant.create!(
+      price: 10,
+      product: product,
+      sku: "G00D-PR0DUCT"
+    )
+  end
+
+  let(:product) do
+    Spree::Product.create!(
+      master: master_variant,
+      name: "Product Name",
+      shipping_category: shipping_category,
+      tax_category: tax_category,
+      variants: [master_variant]
+    )
+  end
+
+  let(:shipping_category) do
+    Spree::ShippingCategory.create!(name: "Default Category")
+  end
+
+  let(:tax_category) do
+    Spree::TaxCategory.create!(
+      is_default: true,
+      name: "Default",
+      tax_code: "A_GEN_TAX"
+    )
+  end
+
+  let(:master_variant) do
+    Spree::Variant.new(
+      is_master: true,
+      price: 10
+    )
+  end
+
+  let(:reimbursement) do
+    Spree::Reimbursement.new(
+      number: "RI123123123",
+      order: order,
+      return_items: [
+        Spree::ReturnItem.new(additional_tax_total: 0.33),
+        Spree::ReturnItem.new(additional_tax_total: 33.0)
+      ],
+      total: 333.33
+    )
+  end
+
+  let(:shipment) { Spree::Shipment.create!(cost: BigDecimal("3.01")) }
+
+  describe "#order_params" do
+    subject { described_class.order_params(order) }
+
+    it "returns params for fetching the tax for the order" do
+      expect(subject).to eq(
+        customer_id: "12345",
+        line_items: [{
+          discount: 2.00,
+          id: order.line_items.first.id,
+          product_tax_code: "A_GEN_TAX",
+          quantity: 3,
+          unit_price: 10.00
+        }],
+        shipping: 3.01,
+        to_city: "Los Angeles",
+        to_country: "US",
+        to_state: "CA",
+        to_street: "475 N Beverly Dr",
+        to_zip: "90210"
+      )
+    end
+
+    context "when custom params are used" do
+      around do |example|
+        default = SuperGood::SolidusTaxjar.custom_order_params
+        SuperGood::SolidusTaxjar.custom_order_params = ->(order) {
+          {
+            nexus_addresses: [
+              {
+                id: "Main Location",
+                country: "AU",
+                zip: "NSW 2000",
+                city: "Sydney",
+                street: "483 George St"
+              }
+            ]
+          }
+        }
+        example.run
+        SuperGood::SolidusTaxjar.custom_order_params = default
+      end
+
+      it "returns params for fetching the tax for the order" do
+        expect(subject).to eq(
+          customer_id: "12345",
+          line_items: [{
+            discount: 2.00,
+            id: order.line_items.first.id,
+            product_tax_code: "A_GEN_TAX",
+            quantity: 3,
+            unit_price: 10.00
+          }],
+          nexus_addresses: [{
+            id: "Main Location",
+            country: "AU",
+            zip: "NSW 2000",
+            city: "Sydney",
+            street: "483 George St"
+          }],
+          shipping: 3.01,
+          to_city: "Los Angeles",
+          to_country: "US",
+          to_state: "CA",
+          to_street: "475 N Beverly Dr",
+          to_zip: "90210"
+        )
+      end
+    end
+
+    context "when the line item has zero quantity" do
+      let(:line_item) do
+        Spree::LineItem.new(
+          additional_tax_total: 4,
+          price: 10,
+          promo_total: -2,
+          quantity: 0,
+          variant: variant
+        )
+      end
+
+      it "excludes the line item" do
+        expect(subject).to eq(
+          customer_id: "12345",
+          line_items: [],
+          shipping: 3.01,
+          to_city: "Los Angeles",
+          to_country: "US",
+          to_state: "CA",
+          to_street: "475 N Beverly Dr",
+          to_zip: "90210"
+        )
+      end
+    end
+  end
+
+  describe "#address_params" do
+    subject { described_class.address_params(ship_address) }
+
+    it "returns params for fetching the tax info for that address" do
+      expect(subject).to eq([
+        "90210",
+        {
+          city: "Los Angeles",
+          country: "US",
+          state: "CA",
+          street: "475 N Beverly Dr"
+        }
+      ])
+    end
+  end
+
+  describe "#tax_rate_address_params" do
+    subject { described_class.tax_rate_address_params(ship_address) }
+
+    it "returns params for fetching the tax rate for that address" do
+      expect(subject).to eq(
+        {
+          amount: 100,
+          shipping: 0,
+          to_city: "Los Angeles",
+          to_country: "US",
+          to_state: "CA",
+          to_street: "475 N Beverly Dr",
+          to_zip: "90210"
+        }
+      )
+    end
+  end
+
+  describe "#transaction_params" do
+    subject { described_class.transaction_params(order) }
+
+    it "returns params for creating/updating an order transaction" do
+      expect(subject).to eq({
+        amount: BigDecimal("113.58"),
+        customer_id: "12345",
+        line_items: [{
+          discount: 2,
+          id: line_item.id,
+          product_identifier: "G00D-PR0DUCT",
+          product_tax_code: "A_GEN_TAX",
+          quantity: 3,
+          sales_tax: 4,
+          unit_price: 10
+        }],
+        sales_tax: BigDecimal("9.87"),
+        shipping: BigDecimal("3.01"),
+        to_city: "Los Angeles",
+        to_country: "US",
+        to_state: "CA",
+        to_street: "475 N Beverly Dr",
+        to_zip: "90210",
+        transaction_date: "2018-03-06T12:10:33Z",
+        transaction_id: "R111222333"
+      })
+    end
+
+    context "when the order is adjusted to 0" do
+      let(:order_total) { BigDecimal("0") }
+
+      it "sends the order total as zero" do
+        expect(subject[:amount]).to be_zero
+      end
+
+      it "sends the sales tax total as zero" do
+        expect(subject[:sales_tax]).to be_zero
+      end
+
+      it "sends the sales tax on the line items as zero" do
+        expect(subject[:line_items]).to contain_exactly({
+          discount: 2,
+          id: line_item.id,
+          product_identifier: "G00D-PR0DUCT",
+          product_tax_code: "A_GEN_TAX",
+          quantity: 3,
+          sales_tax: 0,
+          unit_price: 10
+        })
+      end
+    end
+
+    context "when the line item has 0 quantity" do
+      let(:line_item) do
+        Spree::LineItem.new(
+          additional_tax_total: 4,
+          price: 10,
+          promo_total: -2,
+          quantity: 0,
+          variant: variant
+        )
+      end
+
+      it "excludes the line item" do
+        expect(subject).to eq({
+          amount: BigDecimal("113.58"),
+          customer_id: "12345",
+          line_items: [],
+          sales_tax: BigDecimal("9.87"),
+          shipping: BigDecimal("3.01"),
+          to_city: "Los Angeles",
+          to_country: "US",
+          to_state: "CA",
+          to_street: "475 N Beverly Dr",
+          to_zip: "90210",
+          transaction_date: "2018-03-06T12:10:33Z",
+          transaction_id: "R111222333"
+        })
+      end
+    end
+  end
+
+  describe "#refund_params" do
+    subject { described_class.refund_params(reimbursement) }
+
+    it "returns params for creating/updating a refund" do
+      expect(subject).to eq({
+        amount: BigDecimal("300.00"),
+        sales_tax: BigDecimal("33.33"),
+        shipping: 0,
+        to_city: "Los Angeles",
+        to_country: "US",
+        to_state: "CA",
+        to_street: "475 N Beverly Dr",
+        to_zip: "90210",
+        transaction_date: "2018-03-06T12:10:33Z",
+        transaction_id: "RI123123123",
+        transaction_reference_id: "R111222333"
+      })
+    end
+  end
+
+  describe "#validate_address_params" do
+    subject { described_class.validate_address_params(ship_address) }
+
+    it "returns params for validating an address" do
+      expect(subject).to eq({
+        country: "US",
+        state: "CA",
+        zip: "90210",
+        city: "Los Angeles",
+        street: "475 N Beverly Dr"
+      })
+    end
+
+    context "with an address without a state" do
+      let(:ship_address) do
+        Spree::Address.create!(
+          address1: "72 High St",
+          city: "Birmingham",
+          country: country_uk,
+          first_name: "Chuck",
+          last_name: "Schuldiner",
+          phone: "1-250-555-4444",
+          state_name: "West Midlands",
+          zipcode: "B4 7TA"
+        )
+      end
+
+      let(:country_uk) do
+        Spree::Country.create!(
+          iso3: "GBR",
+          iso: "GB",
+          iso_name: "UNITED KINGDOM",
+          name: "United Kingdom",
+          numcode: 826,
+          states_required: false
+        )
+      end
+
+      it "uses the state_name to build address params" do
+        expect(subject).to eq({
+          country: "GB",
+          state: "West Midlands",
+          zip: "B4 7TA",
+          city: "Birmingham",
+          street: "72 High St"
+        })
+      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