spree_avatax_official 1.7.1

data/lib/generators/spree_avatax_official/install/templates/config/initializers/spree_avatax_official.rb

@@ -0,0 +1,9 @@
+# Optional configuration fields
+SpreeAvataxOfficial::Config.log                        = true
+SpreeAvataxOfficial::Config.log_to_stdout              = false
+SpreeAvataxOfficial::Config.log_file_name              = 'avatax.log'
+SpreeAvataxOfficial::Config.log_frequency              = 'weekly'
+SpreeAvataxOfficial::Config.max_retries                = 2
+SpreeAvataxOfficial::Config.open_timeout               = 2.0
+SpreeAvataxOfficial::Config.read_timeout               = 6.0
+SpreeAvataxOfficial::Config.show_rate_in_label         = false

data/lib/spree_avatax_official.rb

@@ -0,0 +1,5 @@
+require 'spree_core'
+require 'spree_backend'
+require 'spree_extension'
+require 'spree_avatax_official/engine'
+require 'spree_avatax_official/version'

data/lib/spree_avatax_official/engine.rb

@@ -0,0 +1,32 @@
+module SpreeAvataxOfficial
+  class Engine < Rails::Engine
+    require 'spree/core'
+    require 'avatax'
+
+    isolate_namespace SpreeAvataxOfficial
+    engine_name 'spree_avatax_official'
+
+    config.autoload_paths += %W[#{config.root}/lib]
+
+    initializer 'spree_avatax_official.environment', before: :load_config_initializers do |_app|
+      SpreeAvataxOfficial::Config = SpreeAvataxOfficial::Configuration.new
+    end
+
+    initializer 'spree.avatax_certified.calculators', after: 'spree.register.calculators' do |_app|
+      Rails.application.config.spree.calculators.tax_rates << SpreeAvataxOfficial::Calculator::AvataxTransactionCalculator
+    end
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/spree_avatax_official/factories.rb

@@ -0,0 +1,9 @@
+FACTORY_BOT_CLASS = defined?(FactoryGirl) ? FactoryGirl : FactoryBot
+
+FACTORY_BOT_CLASS.define do
+  GEM_ROOT = File.dirname(File.dirname(File.dirname(__FILE__)))
+
+  Dir[File.join(GEM_ROOT, 'spec', 'factories', '**', '*.rb')].each do |factory|
+    require(factory)
+  end
+end

data/lib/spree_avatax_official/seeder.rb

@@ -0,0 +1,51 @@
+module SpreeAvataxOfficial
+  class Seeder
+    def seed!
+      create_default_tax_category
+      create_and_assign_shipping_tax_category
+      create_entry_use_codes
+    end
+
+    private
+
+    def create_default_tax_category
+      ::Spree::TaxCategory.find_or_create_by!(name: 'Clothing')
+                          .update!(tax_code: ::Spree::TaxCategory::DEFAULT_TAX_CODES['LineItem'], is_default: true)
+    end
+
+    def create_and_assign_shipping_tax_category
+      shipping_tax_category = ::Spree::TaxCategory.find_or_create_by!(name: 'Shipping')
+      shipping_tax_category.update!(tax_code: ::Spree::TaxCategory::DEFAULT_TAX_CODES['Shipment'])
+
+      ::Spree::ShippingMethod.update_all(tax_category_id: shipping_tax_category.id)
+    end
+
+    def create_entry_use_codes
+      use_codes.each do |key, val|
+        SpreeAvataxOfficial::EntityUseCode.find_or_create_by!(code: key, name: val)
+      end
+    end
+
+    def use_codes
+      {
+        'A': 'FEDERAL GOV',
+        'B': 'STATE GOV',
+        'C': 'TRIBAL GOVERNMENT',
+        'D': 'FOREIGN DIPLOMAT',
+        'E': 'CHARITABLE/EXEMPT ORG',
+        'F': 'RELIGIOUS ORG',
+        'G': 'RESALE',
+        'H': 'AGRICULTURE',
+        'I': 'INDUSTRIAL PROD/MANUFACTURERS',
+        'J': 'DIRECT PAY',
+        'K': 'DIRECT MAIL',
+        'L': 'OTHER/CUSTOM',
+        'N': 'EDUCATIONAL ORG',
+        'P': 'COMMERCIAL AQUACULTURE',
+        'Q': 'COMMERCIAL FISHERY',
+        'R': 'NON-RESIDENT',
+        'TAXABLE': 'NON-EXEMPT TAXABLE CUSTOMER'
+      }
+    end
+  end
+end

data/lib/spree_avatax_official/version.rb

@@ -0,0 +1,11 @@
+module SpreeAvataxOfficial
+  VERSION = '1.7.1'.freeze
+
+  module_function
+
+  # Returns the version of the currently loaded SpreeAvataxOfficial as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION
+  end
+end

data/lib/tasks/load_seeds.rake

@@ -0,0 +1,6 @@
+namespace :spree_avatax_official do
+  desc 'Migrate from SpreeAvataxCertified and create initial data.'
+  task load_seeds: :environment do
+    SpreeAvataxOfficial::Seeder.new.seed!
+  end
+end

data/spec/.rubocop.yml

@@ -0,0 +1,36 @@
+require: rubocop-rspec
+
+inherit_from: ../.rubocop.yml
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Enabled: false
+
+RSpec/NamedSubject:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/LetSetup:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MessageChain:
+  Enabled: false
+
+RSpec/LeakyConstantDeclaration:
+  Enabled: false

data/spec/factories/canada_address_factory.rb

@@ -0,0 +1,23 @@
+require 'spree/testing_support/factories'
+
+unless FACTORY_BOT_CLASS.factories.registered?(:canada_address)
+  FACTORY_BOT_CLASS.define do
+    factory :canada_address, class: Spree::Address do
+      firstname         { FFaker::Name.first_name }
+      lastname          { FFaker::Name.last_name }
+      address1          { '298 Pinetree' }
+      address2          { '' }
+      city              { 'BEACONSFIELD' }
+      zipcode           { 'H9W 5E1' }
+      phone             { FFaker::PhoneNumberAU.mobile_phone_number }
+      alternative_phone { FFaker::PhoneNumberAU.mobile_phone_number }
+      state             { |address| Spree::State.where(name: 'Quebec', abbr: 'QC', country: address.country).first_or_create }
+
+      country do
+        canada_attributes = { name: 'Canada', iso_name: 'CANADA', iso: 'CA', iso3: 'CAN' }
+
+        Spree::Country.find_by(canada_attributes) || create(:country, canada_attributes)
+      end
+    end
+  end
+end

data/spec/factories/europe_address_factory.rb

@@ -0,0 +1,22 @@
+require 'spree/testing_support/factories'
+
+unless FACTORY_BOT_CLASS.factories.registered?(:europe_address)
+  FACTORY_BOT_CLASS.define do
+    factory :europe_address, class: Spree::Address do
+      firstname         { FFaker::Name.first_name }
+      lastname          { FFaker::Name.last_name }
+      address1          { '10 Paternoster Sq' }
+      address2          { '' }
+      city              { 'London' }
+      zipcode           { 'EC4M 7LS' }
+      phone             { FFaker::PhoneNumberAU.mobile_phone_number }
+      alternative_phone { FFaker::PhoneNumberAU.mobile_phone_number }
+
+      country do
+        uk_attributes = { name: 'United Kingdom', iso_name: 'UNITED KINGDOM', iso: 'GB', iso3: 'GBR' }
+
+        Spree::Country.find_by(uk_attributes) || create(:country, uk_attributes)
+      end
+    end
+  end
+end

data/spec/factories/spree/avatax_global_zone_factory.rb

@@ -0,0 +1,16 @@
+FACTORY_BOT_CLASS.define do
+  factory :avatax_global_zone, class: Spree::Zone do
+    name        { 'GlobalZone' }
+    description { 'Description' }
+    default_tax { true }
+
+    after(:create) do |zone|
+      create(:country) if Spree::Country.count.zero?
+
+      Spree::Country.all.each do |country|
+        # Spree < 3.1 is missing zone_member factory
+        Spree::ZoneMember.create!(zone: zone, zoneable: country)
+      end
+    end
+  end
+end

data/spec/factories/spree/avatax_order_factory.rb

@@ -0,0 +1,69 @@
+FACTORY_BOT_CLASS.define do
+  factory :avatax_order, class: Spree::Order do
+    user
+    bill_address
+    ship_address { create(:usa_address) }
+    completed_at { nil }
+    email        { user.email }
+    state        { 'cart' }
+
+    transient do
+      line_items_price           { 10.0 }
+      line_items_count           { 0 }
+      line_items_quantity        { 1 }
+      with_shipment              { false }
+      with_shipping_tax_category { true }
+      shipment_cost              { 5.0 }
+      tax_category               { Spree::TaxCategory.find_by(name: 'Clothing') }
+    end
+
+    before(:create) do |_order, evaluator|
+      Spree::Zone.find_by(name: 'GlobalZone') || create(:avatax_global_zone)
+      Spree::TaxCategory.find_by(name: 'Clothing') || create(:avatax_tax_category, :clothing)
+      Spree::TaxCategory.find_by(name: 'Shipping') || create(:avatax_tax_category, :shipping)
+      Spree::ShippingMethod.find_by(name: 'AvaTax Ground') || create(:avatax_shipping_method, with_tax_category: evaluator.with_shipping_tax_category)
+    end
+
+    after(:create) do |order, evaluator|
+      evaluator.line_items_count.times do
+        create(
+          :line_item,
+          price:        evaluator.line_items_price,
+          tax_category: evaluator.tax_category || Spree::TaxCategory.find_by(name: 'Clothing'),
+          quantity:     evaluator.line_items_quantity,
+          order:        order
+        )
+      end
+      order.line_items.reload
+
+      if evaluator.with_shipment
+        create(:avatax_shipment, order: order, cost: evaluator.shipment_cost)
+        order.shipments.reload
+      end
+
+      order.updater.update
+    end
+
+    trait :shipped do
+      after(:create) do |order|
+        create(:line_item, order: order)
+        create(:avatax_shipment, order: order, state: :shipped)
+
+        order.inventory_units.update_all(state: :shipped)
+        order.update(ship_address: create(:usa_address), completed_at: Time.current)
+      end
+    end
+
+    trait :completed do
+      shipment_state { 'shipped' }
+      payment_state  { 'paid' }
+
+      after(:create) do |order|
+        order.update_column(:completed_at, Time.current)
+        order.update_column(:state, 'complete')
+        create(:payment, amount: order.total, order: order, state: 'completed')
+        order.updater.update
+      end
+    end
+  end
+end

data/spec/factories/spree/avatax_shipment_factory.rb

@@ -0,0 +1,31 @@
+FACTORY_BOT_CLASS.define do
+  factory :avatax_shipment, class: Spree::Shipment do
+    tracking { 'U10000' }
+    cost     { 100.00 }
+    state    { 'pending' }
+    order
+    stock_location
+
+    before(:create) do |shipment|
+      uuid = '6a9efefa-0c6c-4e63-ab43-f43f1d7b2e22'
+
+      shipment.avatax_uuid = uuid if Spree::Shipment.find_by(avatax_uuid: uuid).nil?
+    end
+
+    after(:create) do |shipment|
+      Spree::TaxCategory.find_by(name: 'Shipping') || create(:avatax_tax_category, :shipping)
+      shipping_method = Spree::ShippingMethod.find_by(name: 'AvaTax Ground') || create(:avatax_shipping_method)
+      shipment.add_shipping_method(shipping_method, true)
+
+      shipment.order.line_items.each do |line_item|
+        line_item.quantity.times do
+          shipment.inventory_units.create(
+            order_id:     shipment.order_id,
+            variant_id:   line_item.variant_id,
+            line_item_id: line_item.id
+          )
+        end
+      end
+    end
+  end
+end

data/spec/factories/spree/avatax_shipping_method_factory.rb

@@ -0,0 +1,35 @@
+FACTORY_BOT_CLASS.define do
+  factory :avatax_shipping_method, class: Spree::ShippingMethod do
+    zones      { [Spree::Zone.find_by(name: 'GlobalZone') || create(:avatax_global_zone, default_tax: true)] }
+    name       { 'AvaTax Ground' }
+    display_on { 'both' }
+
+    transient do
+      tax_included      { false }
+      with_tax_category { true }
+    end
+
+    before(:create) do |shipping_method, evaluator|
+      create(:country) if Spree::Country.count.zero?
+
+      shipping_tax_rate              = create(:avatax_tax_rate, :shipping_tax_rate, included_in_price: evaluator.tax_included)
+      shipping_method.tax_category   = shipping_tax_rate.tax_category if evaluator.with_tax_category
+      shipping_method.calculator     = if Gem::Version.new(Spree.version) >= Gem::Version.new('2.3.0')
+                                         build(:shipping_calculator, calculable: shipping_method, preferences: { currency: 'USD', amount: 10.0 })
+                                       else
+                                         build(:shipping_calculator, calculable: shipping_method)
+                                       end
+
+      if shipping_method.shipping_categories.empty?
+        shipping_method.shipping_categories << (Spree::ShippingCategory.first || create(:shipping_category))
+      end
+    end
+
+    if Gem::Version.new(Spree.version) < Gem::Version.new('2.3.0')
+      after(:create) do |shipping_method|
+        shipping_method.calculator.preferred_currency = 'USD'
+        shipping_method.calculator.preferred_amount   = 10.0
+      end
+    end
+  end
+end

data/spec/factories/spree/avatax_tax_category_factory.rb

@@ -0,0 +1,17 @@
+FACTORY_BOT_CLASS.define do
+  factory :avatax_tax_category, class: Spree::TaxCategory do
+    name        { 'Tax category name' }
+    description { 'Tax category description' }
+
+    trait :clothing do
+      name       { 'Clothing' }
+      tax_code   { ::Spree::TaxCategory::DEFAULT_TAX_CODES['LineItem'] }
+      is_default { true }
+    end
+
+    trait :shipping do
+      name     { 'Shipping' }
+      tax_code { ::Spree::TaxCategory::DEFAULT_TAX_CODES['Shipment'] }
+    end
+  end
+end

data/spec/factories/spree/avatax_tax_rate_factory.rb

@@ -0,0 +1,23 @@
+FACTORY_BOT_CLASS.define do
+  factory :avatax_tax_rate, class: Spree::TaxRate do
+    name               { 'Default AvaTax tax rate' }
+    amount             { 0.0 }
+    zone               { Spree::Zone.find_by(name: 'GlobalZone') || create(:avatax_global_zone) }
+    show_rate_in_label { false }
+    tax_category do
+      Spree::TaxCategory.find_by(tax_code: ::Spree::TaxCategory::DEFAULT_TAX_CODES['LineItem']) ||
+        create(:avatax_tax_category, :clothing)
+    end
+
+    trait :shipping_tax_rate do
+      tax_category do
+        Spree::TaxCategory.find_by(tax_code: ::Spree::TaxCategory::DEFAULT_TAX_CODES['Shipment']) ||
+          create(:avatax_tax_category, :shipping)
+      end
+    end
+
+    before(:create) do |tax_rate|
+      tax_rate.calculator = build(:avatax_transaction_calculator, calculable: tax_rate)
+    end
+  end
+end

data/spec/factories/spree/line_item_factory.rb

@@ -0,0 +1,13 @@
+require 'spree/testing_support/factories'
+
+if FACTORY_BOT_CLASS.factories.registered?(:line_item)
+  FACTORY_BOT_CLASS.modify do
+    factory :line_item, class: Spree::LineItem do
+      before(:create) do |line_item|
+        uuid = 'a844605f-e114-4933-a0cf-7a434ac83cdf'
+
+        line_item.avatax_uuid = uuid if Spree::LineItem.find_by(avatax_uuid: uuid).nil?
+      end
+    end
+  end
+end

data/spec/factories/spree/promotion_factory.rb

@@ -0,0 +1,35 @@
+require 'spree/testing_support/factories'
+
+# According to documentation it's not possible to modify traits, what forces definition of new
+# trait that covers differences between Spree versions. Link:
+# https://github.com/thoughtbot/factory_bot/blob/master/GETTING_STARTED.md#modifying-factories
+if FACTORY_BOT_CLASS.factories.registered?(:promotion)
+  FACTORY_BOT_CLASS.modify do
+    factory :promotion, class: Spree::Promotion do
+      trait :avatax_with_order_adjustment do
+        transient do
+          weighted_order_adjustment_amount { 10 }
+        end
+
+        after(:create) do |promotion, evaluator|
+          calculator = Spree::Calculator::FlatRate.new(preferred_amount: evaluator.weighted_order_adjustment_amount)
+          Spree::Promotion::Actions::CreateAdjustment.create!(calculator: calculator, promotion: promotion)
+        end
+      end
+    end
+  end
+end
+
+unless FACTORY_BOT_CLASS.factories.registered?(:free_shipping_promotion)
+  FACTORY_BOT_CLASS.define do
+    factory :free_shipping_promotion, class: Spree::Promotion do
+      name { 'Free Shipping Promotion' }
+
+      after(:create) do |promotion|
+        action           = Spree::Promotion::Actions::FreeShipping.new
+        action.promotion = promotion
+        action.save
+      end
+    end
+  end
+end