spree_avatax_official 1.9.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d13bf7b694d8c9b6efe525686532f59b7e31549b53f0bd117f26b5064b95f70c
-  data.tar.gz: c54628d389689c43ef49bb7e408bc4dad98a2a19a6b9478f53b4ee1b71df2fe4
+  metadata.gz: dbc764902a265aa63189cd4bd388a9d527c6dde67864a039519978c868adf4de
+  data.tar.gz: 9c3fca8394ddbd9b8191a97ca939a2ac0c3ac76945e15ed47b096001b5d1ae1b
 SHA512:
-  metadata.gz: 8cc63f004da79486591e5f6ae4a55b9a412e9eb3bd0be3210d37eb24eca10c19654896fd7400b698a893c390c112869b256496d17122965e02519086d0cb5d61
-  data.tar.gz: ae4c87f21dcc95427abeedd6c9000ce29717c47604518c93626bc60e0d9acd9684777ab131a8c1820cf7c6eb098007de37608f089e05d2817f4584c2e51c9a13
+  metadata.gz: 3fef2a3753c92f98eee99edf803d4796487427b41a58d842e1c81d6925cbc60d4c072d6f71f845c6ac2ca7a3553831432f58aade0a83b7d5cd4b45ae11933b2b
+  data.tar.gz: 75e78335343ca45ff5c1b178e8db0baf5a3dc52d57bc5652b4cad96425299425a374b3602845682fae6af02bd17b109b554c2600cdd71ec65032484e84c5643a

data/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "mcp__claude_ai_Spree_Commerce_Docs_MCP__search_spree_commerce_documentation",
+      "mcp__claude_ai_Spree_Commerce_Docs_MCP__get_page_spree_commerce_documentation"
+    ]
+  }
+}

data/.env-sample

@@ -1,4 +1,4 @@
 AVATAX_ENDPOINT=https://sandbox-rest.avatax.com
-AVATAX_USERNAME=
-AVATAX_PASSWORD=
-AVATAX_COMPANY_CODE=
+AVATAX_ACCOUNT_NUMBER=
+AVATAX_LICENSE_KEY=
+AVATAX_COMPANY_CODE=test1

data/.gem_release.yml

@@ -0,0 +1,2 @@
+bump:
+  file: "lib/spree_avatax_official/version.rb"

data/.github/workflows/ci.yml

@@ -0,0 +1,80 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  tests_postgres:
+    name: Tests (PostgreSQL)
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    env:
+      DB: postgres
+      DB_HOST: localhost
+      DB_USERNAME: postgres
+      DB_PASSWORD: postgres
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install libvips
+        run: sudo apt-get update && sudo apt-get install -y libvips
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+      - name: Create test app
+        run: bundle exec rake test_app
+      - name: Run tests
+        run: bundle exec rspec --format documentation
+
+  tests_mysql:
+    name: Tests (MySQL)
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql:8.0
+        env:
+          MYSQL_ALLOW_EMPTY_PASSWORD: yes
+        ports:
+          - 3306:3306
+        options: >-
+          --health-cmd "mysqladmin ping -h 127.0.0.1"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    env:
+      DB: mysql
+      DB_HOST: 127.0.0.1
+      DB_USERNAME: root
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install libvips
+        run: sudo apt-get update && sudo apt-get install -y libvips
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+      - name: Create test app
+        run: bundle exec rake test_app
+      - name: Run tests
+        run: bundle exec rspec --format documentation

data/.gitignore

@@ -20,3 +20,4 @@ public/spree
 .ruby-version
 .ruby-gemset
 gemfiles/*.gemfile.lock
+.env

data/Gemfile

@@ -6,20 +6,26 @@ git_source(:github) do |repo_name|
 end
 
 gem 'rails-controller-testing'
-gem 'spree', github: 'spree/spree', branch: 'main'
-gem 'spree_backend', github: 'spree/spree_backend', branch: 'main'
-gem 'spree_emails', github: 'spree/spree', branch: 'main'
-gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'main'
+
+spree_opts = if ENV['SPREE_PATH']
+               { 'path': ENV['SPREE_PATH'] }
+             else
+               { 'github': 'spree/spree', 'branch': 'main', 'glob': 'spree/**/*.gemspec' }
+             end
+gem 'spree', spree_opts
+gem 'spree_core', spree_opts
+gem 'spree_admin', spree_opts
+
 
 if ENV['DB'] == 'mysql'
   gem 'mysql2'
 elsif ENV['DB'] == 'postgres'
   gem 'pg'
 else
-  gem 'sqlite3', '~> 1.4'
+  gem 'sqlite3'
 end
 
-gem 'webdrivers'
+gem 'propshaft'
 gem 'pry'
 
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # Spree Avalara AvaTax official extension
 
-[![Build Status](https://travis-ci.org/spree-contrib/spree_avatax_official.svg?branch=master)](https://travis-ci.org/spree-contrib/spree_avatax_official)
+[![CI](https://github.com/spree/spree_avatax_official/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/spree/spree_avatax_official/actions/workflows/ci.yml)
 
 The new officially supported Avalara AvaTax extension for [Spree Commerce](https://spreecommerce.org/) using [Avalara REST API v2](https://developer.avalara.com/api-reference/avatax/rest/v2/).
 * [Introduction](#introduction)

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

@@ -1,60 +1,24 @@
 module Spree
   module Admin
-    class AvalaraEntityUseCodesController < Spree::Admin::BaseController
-      before_action :load_use_code, only: %i[edit update destroy]
+    class AvalaraEntityUseCodesController < ResourceController
+      include Spree::Admin::SettingsConcern
 
-      def index
-        @use_codes = SpreeAvataxOfficial::EntityUseCode.all.order(code: :asc)
-        respond_with(@use_codes)
-      end
-
-      def new
-        @use_code = SpreeAvataxOfficial::EntityUseCode.new
-      end
-
-      def edit; end
-
-      def update
-        if @use_code.update(entity_use_codes_params)
-          redirect_to admin_avalara_entity_use_codes_path, success: Spree.t('spree_avatax_official.entity_use_code_updated')
-        else
-          redirect_to edit_admin_avalara_entity_use_code_path(@use_code), error: @use_code.errors.full_messages.to_sentence
-        end
-      end
+      private
 
-      def create
-        @use_code = SpreeAvataxOfficial::EntityUseCode.new(entity_use_codes_params)
-        if @use_code.save
-          redirect_to admin_avalara_entity_use_codes_path, success: Spree.t('spree_avatax_official.entity_use_code_created')
-        else
-          redirect_to new_admin_avalara_entity_use_code_path, error: @use_code.errors.full_messages.to_sentence
-        end
+      def model_class
+        SpreeAvataxOfficial::EntityUseCode
       end
 
-      def destroy
-        if @use_code.destroy
-          flash[:success] = Spree.t('spree_avatax_official.entity_use_code_removed')
-        else
-          flash[:error] = @use_code.errors.full_messages.to_sentence
-        end
-
-        respond_with(@use_code) do |format|
-          format.html { redirect_to admin_avalara_entity_use_codes_path }
-          format.js   { render_js_for_destroy }
-        end
+      def permitted_resource_params
+        params.require(:avalara_entity_use_code).permit(:code, :name, :description)
       end
 
-      private
-
-      def load_use_code
-        @use_code ||= SpreeAvataxOfficial::EntityUseCode.find(params[:id])
-      rescue ActiveRecord::RecordNotFound => e
-        flash[:error] = e.message
-        redirect_to admin_avalara_entity_use_codes_path
+      def collection_url(options = {})
+        spree.admin_avalara_entity_use_codes_url(options)
       end
 
-      def entity_use_codes_params
-        params.require(:entity_use_code).permit(:code, :name, :description)
+      def new_object_url(options = {})
+        spree.new_admin_avalara_entity_use_code_url(options)
       end
     end
   end

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

@@ -0,0 +1,43 @@
+module Spree
+  module Admin
+    class AvataxCustomerSettingsController < Spree::Admin::BaseController
+      helper_method :object_url
+
+      before_action :load_user
+      before_action :load_entity_use_codes, only: %i[edit update]
+
+      def edit; end
+
+      def update
+        if @user.update(permitted_resource_params)
+          flash[:success] = flash_message_for(@user, :successfully_updated)
+          redirect_to spree.admin_user_path(@user), status: :see_other
+        else
+          render :edit, status: :unprocessable_entity
+        end
+      end
+
+      private
+
+      def load_user
+        @user = Spree.user_class.find_by_prefix_id!(params[:user_id])
+        authorize! :update, @user
+
+        @object = @user
+        @resource = Spree::Admin::Resource.new(controller_path, controller_name, nil)
+      end
+
+      def object_url
+        spree.admin_user_avatax_customer_settings_path(@user)
+      end
+
+      def load_entity_use_codes
+        @entity_use_codes = SpreeAvataxOfficial::EntityUseCode.order(:code)
+      end
+
+      def permitted_resource_params
+        params.require(:avatax_customer_setting).permit(:avatax_entity_use_code_id, :exemption_number, :vat_id)
+      end
+    end
+  end
+end

data/app/controllers/spree_avatax_official/admin/base_controller_decorator.rb

@@ -0,0 +1,11 @@
+module SpreeAvataxOfficial
+  module Admin
+    module BaseControllerDecorator
+      def self.prepended(base)
+        base.helper SpreeAvataxOfficial::AvalaraIntegrationHelper
+      end
+    end
+  end
+end
+
+::Spree::Admin::BaseController.prepend(::SpreeAvataxOfficial::Admin::BaseControllerDecorator) if defined?(::Spree::Admin::BaseController)

data/app/helpers/spree_avatax_official/avalara_integration_helper.rb

@@ -0,0 +1,10 @@
+module SpreeAvataxOfficial
+  module AvalaraIntegrationHelper
+    def avalara_endpoint_options
+      [
+        [::Spree.t('spree_avatax_official.endpoint_sandbox'),    ::Spree::Integrations::Avalara::SANDBOX_ENDPOINT],
+        [::Spree.t('spree_avatax_official.endpoint_production'), ::Spree::Integrations::Avalara::PRODUCTION_ENDPOINT]
+      ]
+    end
+  end
+end

data/app/helpers/spree_avatax_official/tax_adjustment_label_helper.rb

@@ -10,7 +10,8 @@ module SpreeAvataxOfficial
 
       format_adjustment_label(
         ::Spree.t("spree_avatax_official.create_tax_adjustments.#{item_class}_tax_adjustment_default_label", included_label: included_label(item)),
-        rate
+        rate,
+        item.order
       )
     end
 
@@ -18,13 +19,14 @@ module SpreeAvataxOfficial
       item.included_in_price ? 'Included ' : ''
     end
 
-    def format_adjustment_label(adjustment_default_label, rate)
+    def format_adjustment_label(adjustment_default_label, rate, order)
       rate_in_percents = number_to_percentage(
         rate * 100.0,
         precision:                 PRECISION_OF_PERCENT_VALUE,
         strip_insignificant_zeros: STRIP_INSIGNIFICANT_ZEROS
       )
-      SpreeAvataxOfficial::Config.show_rate_in_label ? "#{adjustment_default_label} (#{rate_in_percents})" : adjustment_default_label
+      show_rate = order.avalara_integration&.preferred_show_rate_in_label || false
+      show_rate ? "#{adjustment_default_label} (#{rate_in_percents})" : adjustment_default_label
     end
   end
 end

data/app/models/spree/integrations/avalara.rb

@@ -0,0 +1,61 @@
+module Spree
+  module Integrations
+    class Avalara < Spree::Integration
+      SANDBOX_ENDPOINT = 'https://sandbox-rest.avatax.com'.freeze
+      PRODUCTION_ENDPOINT = 'https://rest.avatax.com'.freeze
+
+      preference :account_number, :string
+      preference :license_key, :password
+      preference :endpoint, :string, default: SANDBOX_ENDPOINT
+      preference :company_code, :string
+
+      preference :address_validation_enabled, :boolean, default: false
+      preference :commit_transaction_enabled, :boolean, default: true
+      preference :show_rate_in_label, :boolean, default: false
+
+      validates :preferred_account_number, :preferred_license_key, :preferred_company_code, presence: true
+
+      def self.integration_group
+        'tax'
+      end
+
+      def self.icon_path
+        'integration_icons/avalara-logo.png'
+      end
+
+      def can_connect?
+        response = avatax_client.ping
+        body     = response.respond_to?(:body) ? response.body : response
+
+        return true if body.is_a?(Hash) && body['authenticated']
+
+        @connection_error_message =
+          if body.is_a?(Hash) && body.key?('authenticated')
+            'Invalid credentials'
+          elsif body.is_a?(Hash) && body['error'].is_a?(Hash)
+            body['error']['message'].presence || 'Could not connect to AvaTax'
+          else
+            'Could not connect to AvaTax'
+          end
+
+        false
+      rescue StandardError => e
+        @connection_error_message = e.message
+        false
+      end
+
+      def avatax_client
+        AvaTax::Client.new(
+          app_name:           SpreeAvataxOfficial::Base::APP_NAME,
+          app_version:        SpreeAvataxOfficial::Base::APP_VERSION,
+          connection_options: SpreeAvataxOfficial::Base::CONNECTION_OPTIONS,
+          logger:             SpreeAvataxOfficial::Config.log,
+          faraday_response:   true,
+          endpoint:           preferred_endpoint,
+          username:           preferred_account_number,
+          password:           preferred_license_key
+        )
+      end
+    end
+  end
+end

data/app/models/spree_avatax_official/calculator/avatax_transaction_calculator.rb

@@ -9,9 +9,6 @@ module SpreeAvataxOfficial
         raise 'Tax adjustments should be calculated on line item or shipment level'
       end
 
-      # Following lines require this recalculation:
-      # https://github.com/spree/spree/blob/master/core/app/models/spree/adjustment.rb#L104
-      # https://github.com/spree/spree/blob/master/core/app/models/spree/line_item.rb#L159
       def compute_line_item(line_item)
         line_item.adjustments.tax.sum(:amount)
       end

data/app/models/spree_avatax_official/configuration.rb

@@ -3,7 +3,6 @@ module SpreeAvataxOfficial
     preference :address_validation_enabled, :boolean, default: false
     preference :company_code,               :string,  default: ''
     preference :enabled,                    :boolean, default: false
-    preference :ship_from_address,          :hash,    default: {}
     preference :log,                        :boolean, default: true
     preference :log_to_stdout,              :boolean, default: false
     preference :log_file_name,              :string,  default: 'avatax.log'

data/app/models/spree_avatax_official/entity_use_code.rb

@@ -1,7 +1,8 @@
 module SpreeAvataxOfficial
-  class EntityUseCode < ::Spree::Base
-    with_options presence: true do
-      validates :code, :name, uniqueness: true
-    end
+  class EntityUseCode < ::Spree.base_class
+    self.whitelisted_ransackable_attributes = %w[code name description]
+
+    validates :code, presence: true, uniqueness: { scope: spree_base_uniqueness_scope }
+    validates :name, presence: true, uniqueness: { scope: spree_base_uniqueness_scope }
   end
 end

data/app/models/spree_avatax_official/spree/address_decorator.rb

@@ -2,20 +2,14 @@ module SpreeAvataxOfficial
   module Spree
     module AddressDecorator
       def self.prepended(base)
-        base.around_save :recalculate_avatax_taxes
+        base.after_commit :recalculate_avatax_taxes, on: %i[update]
         base.const_set   'OBSERVABLE_FIELDS', %w[address1 address2 city zipcode state_id country_id].freeze
       end
 
       private
 
       def recalculate_avatax_taxes
-        return yield unless SpreeAvataxOfficial::Config.enabled
-
-        observed_fields_changed = self.class::OBSERVABLE_FIELDS & changed
-
-        yield # around_save requires yield to perform save operation
-
-        return unless observed_fields_changed.any? && persisted?
+        return unless (self.class::OBSERVABLE_FIELDS & saved_changes.keys).any?
 
         address_sym = ::Spree::Config.tax_using_ship_address ? :ship_address : :bill_address
         order       = ::Spree::Order.incomplete.find_by(address_sym => self)

data/app/models/spree_avatax_official/spree/line_item_decorator.rb

@@ -8,13 +8,7 @@ module SpreeAvataxOfficial
       end
 
       def included_in_price
-        tax_zone.try(:included_in_price) || false
-      end
-
-      def update_tax_charge
-        return super unless SpreeAvataxOfficial::Config.enabled
-
-        SpreeAvataxOfficial::CreateTaxAdjustmentsService.call(order: order)
+        order.market&.tax_inclusive || false
       end
 
       def avatax_tax_code

data/app/models/spree_avatax_official/spree/order_decorator.rb

@@ -13,6 +13,17 @@ module SpreeAvataxOfficial
         base.state_machine.before_transition to: :delivery, do: :validate_tax_address, if: :address_validation_enabled?
         base.state_machine.after_transition to: :canceled, do: :void_in_avatax
         base.state_machine.after_transition to: :complete, do: :commit_in_avatax
+
+        # Recalculate when the order's address changes (selecting an existing address from the address book).
+        base.after_update :recalculate_avatax_taxes_on_address_change
+      end
+
+      def avalara_integration
+        store&.integrations&.active&.find_by(type: 'Spree::Integrations::Avalara')
+      end
+
+      def avatax_enabled?
+        avalara_integration.present?
       end
 
       def taxable_items
@@ -20,17 +31,17 @@ module SpreeAvataxOfficial
       end
 
       def avatax_tax_calculation_required?
-        tax_address&.persisted? && line_items.any?
+        return false unless tax_address&.persisted?
+        return false unless line_items.any?
+        return false if delivery_required? && shipments.empty?
+
+        true
       end
 
       def avatax_discount_amount
         adjustments.promotion.eligible.sum(:amount).abs
       end
 
-      def avatax_ship_from_address
-        SpreeAvataxOfficial::Config.ship_from_address
-      end
-
       def line_items_discounted_in_avatax?
         adjustments.promotion.eligible.any?
       end
@@ -39,14 +50,16 @@ module SpreeAvataxOfficial
         ::Spree::Config.tax_using_ship_address ? :ship_address : :bill_address
       end
 
+      # We need to override this so the default Spree tax calculation is not triggered.
+      # The actual tax calculation by Avalara is done in #recalculate_avatax_taxes
       def create_tax_charge!
-        return super unless SpreeAvataxOfficial::Config.enabled
+        return if avatax_enabled?
 
-        SpreeAvataxOfficial::CreateTaxAdjustmentsService.call(order: self)
+        super
       end
 
       def recalculate_avatax_taxes
-        return unless SpreeAvataxOfficial::Config.enabled
+        return unless avatax_enabled?
 
         SpreeAvataxOfficial::CreateTaxAdjustmentsService.call(order: self)
         update_totals
@@ -55,12 +68,14 @@ module SpreeAvataxOfficial
 
       def validate_tax_address
         response = SpreeAvataxOfficial::Address::Validate.call(
-          address: tax_address
+          address: tax_address,
+          order: self
         )
 
         return if response.success?
 
-        error_message = response.value.body['messages'].map { |message| message['summary'] }.join('. ')
+        messages = response.value&.body&.dig('messages')
+        error_message = messages.present? ? messages.map { |message| message['summary'] }.join('. ') : 'Address validation failed'
 
         errors.add(:base, error_message)
 
@@ -68,19 +83,26 @@ module SpreeAvataxOfficial
       end
 
       def address_validation_enabled?
-        SpreeAvataxOfficial::Config.address_validation_enabled
+        avalara_integration&.preferred_address_validation_enabled || false
       end
 
       private
 
+      def recalculate_avatax_taxes_on_address_change
+        return unless avatax_enabled?
+        return unless (%w[ship_address_id bill_address_id] & saved_changes.keys).any?
+
+        recalculate_avatax_taxes
+      end
+
       def commit_in_avatax
-        return unless SpreeAvataxOfficial::Config.enabled && SpreeAvataxOfficial::Config.commit_transaction_enabled
+        return unless avatax_enabled? && avalara_integration.preferred_commit_transaction_enabled
 
         SpreeAvataxOfficial::Transactions::CreateService.call(order: self)
       end
 
       def void_in_avatax
-        return unless SpreeAvataxOfficial::Config.enabled
+        return unless avatax_enabled?
 
         SpreeAvataxOfficial::Transactions::VoidService.call(order: self)
       end

data/app/models/spree_avatax_official/spree/refund_decorator.rb

@@ -5,13 +5,13 @@ module SpreeAvataxOfficial
         base.after_create :refund_in_avatax
 
         base.delegate :order,                    to: :payment
-        base.delegate :inventory_units, :number, to: :order, prefix: true
+        base.delegate :number, to: :order, prefix: true
       end
 
       private
 
       def refund_in_avatax
-        return unless SpreeAvataxOfficial::Config.enabled && SpreeAvataxOfficial::Config.commit_transaction_enabled
+        return unless order.avatax_enabled? && order.avalara_integration.preferred_commit_transaction_enabled
 
         SpreeAvataxOfficial::Transactions::RefundService.call(refundable: self)
       end

data/app/models/spree_avatax_official/spree/shipment_decorator.rb

@@ -8,7 +8,7 @@ module SpreeAvataxOfficial
       end
 
       def included_in_price
-        tax_zone.try(:included_in_price) || false
+        order.market&.tax_inclusive || false
       end
 
       def tax_category
@@ -18,6 +18,13 @@ module SpreeAvataxOfficial
       def avatax_tax_code
         tax_category.try(:tax_code).presence || ::Spree::TaxCategory::DEFAULT_TAX_CODES['Shipment']
       end
+
+      def selected_shipping_rate_id=(id)
+        super
+        return if order.nil? || order.completed?
+
+        order.recalculate_avatax_taxes
+      end
     end
   end
 end

data/app/models/spree_avatax_official/spree/user_decorator.rb

@@ -8,4 +8,4 @@ module SpreeAvataxOfficial
   end
 end
 
-Spree.user_class.prepend ::SpreeAvataxOfficial::Spree::UserDecorator
+Spree.user_class.prepend(::SpreeAvataxOfficial::Spree::UserDecorator) if Spree.user_class

data/app/models/spree_avatax_official/transaction.rb

@@ -1,5 +1,5 @@
 module SpreeAvataxOfficial
-  class Transaction < ActiveRecord::Base
+  class Transaction < ::Spree.base_class
     SALES_ORDER               = 'SalesOrder'.freeze
     SALES_INVOICE             = 'SalesInvoice'.freeze
     RETURN_INVOICE            = 'ReturnInvoice'.freeze
@@ -12,8 +12,9 @@ module SpreeAvataxOfficial
 
     belongs_to :order, class_name: 'Spree::Order'
 
+    validates :code, presence: true, uniqueness: { scope: spree_base_uniqueness_scope }
+
     with_options presence: true do
-      validates :code, uniqueness: true
       validates :order
       validates :transaction_type
     end