super_good-solidus_taxjar 0.18.2 → 1.0.0

data/spec/super_good/solidus_taxjar/addresses_spec.rb

@@ -10,8 +10,6 @@ RSpec.describe SuperGood::SolidusTaxjar::Addresses do
         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"
@@ -79,8 +77,6 @@ RSpec.describe SuperGood::SolidusTaxjar::Addresses do
             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"
@@ -123,8 +119,6 @@ RSpec.describe SuperGood::SolidusTaxjar::Addresses do
             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"
@@ -143,8 +137,6 @@ RSpec.describe SuperGood::SolidusTaxjar::Addresses do
         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"
@@ -212,8 +204,6 @@ RSpec.describe SuperGood::SolidusTaxjar::Addresses do
             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"
@@ -264,8 +254,6 @@ RSpec.describe SuperGood::SolidusTaxjar::Addresses do
             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"
@@ -275,8 +263,6 @@ RSpec.describe SuperGood::SolidusTaxjar::Addresses do
             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"

data/spec/super_good/solidus_taxjar/api_params_spec.rb

@@ -2,24 +2,27 @@ 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],
+    create(:order,
       number: "R111222333",
       ship_address: ship_address,
+      line_items: line_items_attributes.map { |attributes| build(:line_item, attributes) },
       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
+      user_id: 12345,
+      completed_at: DateTime.new(2018, 3, 6, 12, 10, 33),
+      payments: payments).tap do |order|
+        order.update_columns(additional_tax_total: 9.87, item_total: 28.00, total: order_total)
+        order.line_items.each_with_index do |line_item, idx|
+          line_item.update_columns(line_items_attributes[idx])
+        end
+      end
   end
   let(:order_total) { BigDecimal("123.45") }
+  let(:payments) { build_list(:payment, 1, :completed, amount: 110.45) }
 
   let(:store) do
-    Spree::Store.create!(
+    create(
+      :store,
       cart_tax_country_iso: "US",
       code: "store",
       mail_from_address: "contact@example.com",
@@ -28,58 +31,70 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
     )
   end
 
-  let(:ship_address) do
-    Spree::Address.create!(
+  let!(:ship_address) do
+    create(
+      :address,
       address1: "475 N Beverly Dr",
+      address2: nil,
       city: "Los Angeles",
       country: country_us,
-      first_name: "Chuck",
-      last_name: "Schuldiner",
       phone: "1-250-555-4444",
-      state: state_california,
+      state_code: "CA",
       zipcode: "90210"
     )
   end
 
   let(:country_us) do
-    Spree::Country.create!(
-      iso3: "USA",
+    create(
+      :country,
       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"
-    )
+  let(:line_items_attributes) do
+    [
+      attributes_for(
+        :line_item,
+        additional_tax_total: 4,
+        price: 10,
+        promo_total: -2,
+        quantity: 3,
+        variant_id: variant.id
+      )
+    ]
   end
 
-  let(:line_item) do
-    Spree::LineItem.new(
-      additional_tax_total: 4,
+  let(:variant) do
+    create(
+      :variant,
       price: 10,
-      promo_total: -2,
-      quantity: 3,
-      variant: variant
+      product: product,
+      sku: "G00D-PR0DUCT",
+      option_values: [option_value]
     )
   end
 
-  let(:variant) do
-    Spree::Variant.create!(
-      price: 10,
-      product: product,
-      sku: "G00D-PR0DUCT"
+  let(:option_value) do
+    create(
+      :option_value,
+      name: "Red",
+      presentation: "red",
+      option_type: option_type
+    )
+  end
+
+  let(:option_type) do
+    create(
+      :option_type,
+      name: "Color",
+      presentation: "color"
     )
   end
 
   let(:product) do
-    Spree::Product.create!(
+    create(
+      :product,
       master: master_variant,
       name: "Product Name",
       shipping_category: shipping_category,
@@ -88,12 +103,11 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
     )
   end
 
-  let(:shipping_category) do
-    Spree::ShippingCategory.create!(name: "Default Category")
-  end
+  let(:shipping_category){ create(:shipping_category) }
 
   let(:tax_category) do
-    Spree::TaxCategory.create!(
+    create(
+      :tax_category,
       is_default: true,
       name: "Default",
       tax_code: "A_GEN_TAX"
@@ -101,29 +115,52 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
   end
 
   let(:master_variant) do
-    Spree::Variant.new(
+    build(
+      :variant,
       is_master: true,
       price: 10
     )
   end
 
   let(:reimbursement) do
-    Spree::Reimbursement.new(
+    build(
+      :reimbursement,
       number: "RI123123123",
       order: order,
       return_items: [
-        Spree::ReturnItem.new(additional_tax_total: 0.33),
-        Spree::ReturnItem.new(additional_tax_total: 33.0)
+        build(:return_item, additional_tax_total: 0.33),
+        build(:return_item, additional_tax_total: 33.0)
       ],
       total: 333.33
     )
   end
 
-  let(:shipment) { Spree::Shipment.create!(cost: BigDecimal("3.01")) }
+  let(:shipment) { create(:shipment, cost: BigDecimal("3.01")) }
+
+  before do
+    create :state, state_code: "CA"
+    create :state, state_code: "NY"
 
-  describe "#order_params" do
+
+  end
+
+  describe ".order_params" do
     subject { described_class.order_params(order) }
 
+    before do
+      # The discount calculator relies on the line item adjustments existing in
+      # order to calculate the correct discount amount for TaxJar.
+      create(
+        :adjustment,
+        order: order,
+        adjustable: order.line_items.first,
+        amount: line_items_attributes.first[:promo_total],
+        source_type: "Spree::Promotion::Action::CreateItemAdjustments",
+        label: "Promo",
+        finalized: true # Prevents this adjustment from being recalculated.
+      )
+    end
+
     it "returns params for fetching the tax for the order" do
       expect(subject).to eq(
         customer_id: "12345",
@@ -191,14 +228,17 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
     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
-        )
+      let(:line_items_attributes) do
+        [
+          attributes_for(
+            :line_item,
+            additional_tax_total: 4,
+            price: 10,
+            promo_total: -2,
+            quantity: 0,
+            variant_id: variant.id
+          )
+        ]
       end
 
       it "excludes the line item" do
@@ -216,7 +256,7 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
     end
   end
 
-  describe "#address_params" do
+  describe ".address_params" do
     subject { described_class.address_params(ship_address) }
 
     it "returns params for fetching the tax info for that address" do
@@ -232,7 +272,7 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
     end
   end
 
-  describe "#tax_rate_address_params" do
+  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
@@ -250,17 +290,32 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
     end
   end
 
-  describe "#transaction_params" do
+  describe ".transaction_params" do
     subject { described_class.transaction_params(order) }
 
+    before do
+      # The discount calculator relies on the line item adjustments existing in
+      # order to calculate the correct discount amount for TaxJar.
+      create(
+        :adjustment,
+        order: order,
+        adjustable: order.line_items.first,
+        amount: line_items_attributes.first[:promo_total],
+        source_type: "Spree::Promotion::Action::CreateItemAdjustments",
+        label: "Promo",
+        finalized: true # Prevents this adjustment from being recalculated.
+      )
+    end
+
     it "returns params for creating/updating an order transaction" do
       expect(subject).to eq({
-        amount: BigDecimal("113.58"),
+        amount: BigDecimal("100.58"),
         customer_id: "12345",
         line_items: [{
           discount: 2,
-          id: line_item.id,
+          id: order.line_items.first.id,
           product_identifier: "G00D-PR0DUCT",
+          description: "Product Name - color: red",
           product_tax_code: "A_GEN_TAX",
           quantity: 3,
           sales_tax: 4,
@@ -280,6 +335,7 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
 
     context "when the order is adjusted to 0" do
       let(:order_total) { BigDecimal("0") }
+      let(:payments) { [] }
 
       it "sends the order total as zero" do
         expect(subject[:amount]).to be_zero
@@ -292,8 +348,9 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
       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,
+          id: order.line_items.first.id,
           product_identifier: "G00D-PR0DUCT",
+          description: "Product Name - color: red",
           product_tax_code: "A_GEN_TAX",
           quantity: 3,
           sales_tax: 0,
@@ -303,19 +360,22 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
     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
-        )
+      let(:line_items_attributes) do
+        [
+          attributes_for(
+            :line_item,
+            additional_tax_total: 4,
+            price: 10,
+            promo_total: -2,
+            quantity: 0,
+            variant_id: variant.id
+          )
+        ]
       end
 
       it "excludes the line item" do
         expect(subject).to eq({
-          amount: BigDecimal("113.58"),
+          amount: BigDecimal("100.58"),
           customer_id: "12345",
           line_items: [],
           sales_tax: BigDecimal("9.87"),
@@ -330,6 +390,87 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
         })
       end
     end
+
+    context "with an optional transaction_id specified" do
+      subject {
+        described_class.transaction_params(order, custom_transaction_id)
+      }
+
+      let(:custom_transaction_id) { "R0123456789" }
+
+      it "uses the specified transaction_id" do
+        expect(subject).to include(transaction_id: "R0123456789")
+      end
+    end
+
+    context "when all line items have been returned and reimbursed" do
+      let(:reimbursement_total) { 10 }
+      let(:reimbursement_tax) { 1.02 }
+
+      before do
+        reimbursement = create(:reimbursement)
+        reimbursement.return_items.first.update_columns(additional_tax_total: reimbursement_tax)
+        refund = create(:refund, reimbursement: reimbursement, payment: order.payments.first)
+        reimbursement.update_columns(order_id: order.id, total: reimbursement_total + reimbursement_tax)
+        order.line_items.first.inventory_units.update_all(state: "returned")
+      end
+
+      it "excludes returned line items" do
+        expect(subject).to match(hash_including({ line_items: [] }))
+      end
+
+      it "removes the reimbursed tax from the sales tax amount" do
+        expect(subject[:sales_tax]).to eq(9.87 - reimbursement_tax)
+      end
+
+      it "removes the reimbursements without tax from the total amount" do
+        expect(subject[:amount]).to eq(100.58 - reimbursement_total)
+      end
+    end
+
+    context "when some line items have been returned and reimbursed" do
+      let(:reimbursement_total) { 10 }
+      let(:reimbursement_tax) { 1.02 }
+
+      before do
+        reimbursement = create(:reimbursement)
+        reimbursement.return_items.first.update_columns(additional_tax_total: reimbursement_tax)
+        refund = create(:refund, reimbursement: reimbursement, payment: order.payments.first)
+        reimbursement.update_columns(order_id: order.id, total: reimbursement_total + reimbursement_tax)
+        first_inventory_unit = order.line_items.first.inventory_units.first
+        first_inventory_unit.update(state: "returned")
+        return_item = create(:return_item, amount: 34, additional_tax_total: reimbursement_tax / 4)
+        return_item.update_columns(inventory_unit_id: first_inventory_unit.id, reimbursement_id: reimbursement.id)
+      end
+
+      it "removes the reimbursed tax from the specific line item" do
+        expect(subject[:line_items].first[:sales_tax]).to eq(order.line_items.first.additional_tax_total - (reimbursement_tax / 4))
+      end
+    end
+
+
+    context "when a refund without a reimbursement exists" do
+      let(:refund_amount) { 10 }
+
+      before do
+        create(:refund, payment: order.payments.first, amount: refund_amount)
+      end
+
+      it "removes the orphaned refunds from the total amount" do
+        expect(subject[:amount]).to eq(100.58 - refund_amount)
+      end
+    end
+
+    context "part of a line item has been returned" do
+      before do
+        order.line_items.first.inventory_units.first.update(state: "returned")
+        order.line_items.first.inventory_units.second.update(state: "canceled")
+      end
+
+      it "adjusts the line item quanity" do
+        expect(subject).to match(hash_including({ line_items: [hash_including({quantity:1})] }))
+      end
+    end
   end
 
   describe "#refund_params" do
@@ -352,6 +493,44 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
     end
   end
 
+  describe "#refund_transaction_params" do
+    subject { described_class.refund_transaction_params(order, taxjar_order) }
+
+    let(:taxjar_line_item) {  {id: 1, quantity: 2, unit_price: 2.00, discount: 0.50, sales_tax: 0.80} }
+    let(:taxjar_order) {
+      Taxjar::Order.new(
+        transaction_id: "R111222333-1",
+        amount: 123.45,
+        sales_tax: 33.33,
+        shipping: 3.01,
+        line_items: [taxjar_line_item]
+      )
+    }
+
+    it "returns params for creating/updating a refund" do
+      expect(subject).to include({
+        amount: -123.45,
+        sales_tax: -33.33,
+        shipping: -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_reference_id: "R111222333-1",
+        transaction_id: "R111222333-1-REFUND",
+        line_items: [{
+          id: 1,
+          quantity: 2,
+          unit_price: -2.00,
+          discount: -0.50,
+          sales_tax: -0.80
+        }]
+      })
+    end
+  end
+
   describe "#validate_address_params" do
     subject { described_class.validate_address_params(ship_address) }
 
@@ -366,26 +545,24 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
     end
 
     context "with an address without a state" do
-      let(:ship_address) do
-        Spree::Address.create!(
+      let!(:ship_address) do
+        create(
+          :address,
           address1: "72 High St",
+          address2: nil,
           city: "Birmingham",
           country: country_uk,
-          first_name: "Chuck",
-          last_name: "Schuldiner",
           phone: "1-250-555-4444",
+          state: nil,
           state_name: "West Midlands",
           zipcode: "B4 7TA"
         )
       end
 
       let(:country_uk) do
-        Spree::Country.create!(
-          iso3: "GBR",
+        create(
+          :country,
           iso: "GB",
-          iso_name: "UNITED KINGDOM",
-          name: "United Kingdom",
-          numcode: 826,
           states_required: false
         )
       end
@@ -402,20 +579,15 @@ RSpec.describe SuperGood::SolidusTaxjar::ApiParams do
     end
 
     context "an address with address2" do
-      let(:ship_address) do
-        Spree::Address.create!(
+      let!(:ship_address) do
+        create(
+          :address,
           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"
-          ),
+          state_code: "NY",
           zipcode: "10007"
         )
       end