solidus_avatax 0.2.0

data/app/models/spree_avatax/short_ship_return_invoice_inventory_unit.rb

@@ -0,0 +1,11 @@
+class SpreeAvatax::ShortShipReturnInvoiceInventoryUnit < ActiveRecord::Base
+  belongs_to(
+    :short_ship_return_invoice,
+    class_name: 'SpreeAvatax::ShortShipReturnInvoice',
+    inverse_of: :short_ship_return_invoice_inventory_units,
+  )
+  belongs_to :inventory_unit, class_name: 'Spree::InventoryUnit'
+
+  validates :short_ship_return_invoice, presence: true
+  validates :inventory_unit, presence: true
+end

data/bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_avatax/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/circle.yml

@@ -0,0 +1,6 @@
+machine:
+  ruby:
+    version: 2.1.5
+test:
+  pre:
+    - bundle exec rake test_app

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+---
+en:
+  spree:
+    avatax_description: No Op Avatax Calculator
+    avatax_label: Tax

data/db/migrate/20140122165618_add_avatax_response_at_to_orders.rb

@@ -0,0 +1,5 @@
+class AddAvataxResponseAtToOrders < ActiveRecord::Migration
+  def change
+    add_column :spree_orders, :avatax_response_at, :datetime
+  end
+end

data/db/migrate/20140214153139_add_avatax_invoice_at_to_orders.rb

@@ -0,0 +1,5 @@
+class AddAvataxInvoiceAtToOrders < ActiveRecord::Migration
+  def change 
+    add_column :spree_orders, :avatax_invoice_at, :datetime
+  end
+end

data/db/migrate/20140617222244_close_all_tax_adjustments.rb

@@ -0,0 +1,5 @@
+class CloseAllTaxAdjustments < ActiveRecord::Migration
+  def up
+    Spree::Adjustment.tax.update_all(finalized: true)
+  end
+end

data/db/migrate/20140701144237_update_avatax_calculator_type.rb

@@ -0,0 +1,17 @@
+class UpdateAvataxCalculatorType < ActiveRecord::Migration
+  def up
+    Spree::Calculator.where(
+      type: "SpreeAvatax::Calculator"
+    ).update_all(
+      type: "Spree::Calculator::Avatax"
+    )
+  end
+
+  def down
+    Spree::Calculator.where(
+      type: "Spree::Calculator::Avatax"
+    ).update_all(
+      type: "SpreeAvatax::Calculator"
+    )
+  end
+end

data/db/migrate/20140801132302_create_spree_avatax_return_invoices.rb

@@ -0,0 +1,19 @@
+class CreateSpreeAvataxReturnInvoices < ActiveRecord::Migration
+  def change
+    create_table :spree_avatax_return_invoices do |t|
+      t.integer :reimbursement_id
+      t.boolean :committed
+      t.string  :doc_id
+      t.string  :doc_code
+      t.date    :doc_date
+      t.decimal :pre_tax_total, precision: 10, scale: 2
+      t.decimal :additional_tax_total, precision: 10, scale: 2
+
+      t.timestamps null: true
+    end
+
+    add_index :spree_avatax_return_invoices, :reimbursement_id, unique: true
+    add_index :spree_avatax_return_invoices, :doc_id, unique: true
+    add_index :spree_avatax_return_invoices, :doc_code, unique: true
+  end
+end

data/db/migrate/20140903135132_create_spree_avatax_sales_orders.rb

@@ -0,0 +1,15 @@
+class CreateSpreeAvataxSalesOrders < ActiveRecord::Migration
+  def change
+    create_table :spree_avatax_sales_orders do |t|
+      t.integer :order_id,             null: false
+      t.string  :doc_code,             null: false
+      t.date    :doc_date,             null: false
+      t.decimal :pre_tax_total,        precision: 10, scale: 2
+      t.decimal :additional_tax_total, precision: 10, scale: 2
+
+      t.timestamps null: true
+    end
+
+    add_index :spree_avatax_sales_orders, :order_id
+  end
+end

data/db/migrate/20140903135357_create_spree_avatax_sales_invoices.rb

@@ -0,0 +1,19 @@
+class CreateSpreeAvataxSalesInvoices < ActiveRecord::Migration
+  def change
+    create_table :spree_avatax_sales_invoices do |t|
+      t.integer  :order_id,             null: false
+      t.datetime :committed_at
+      t.string   :doc_id,               null: false
+      t.string   :doc_code,             null: false
+      t.date     :doc_date,             null: false
+      t.decimal  :pre_tax_total,        precision: 10, scale: 2
+      t.decimal  :additional_tax_total, precision: 10, scale: 2
+
+      t.timestamps null: true
+    end
+
+    add_index :spree_avatax_sales_invoices, :order_id, unique: true
+    add_index :spree_avatax_sales_invoices, :doc_id, unique: true
+    add_index :spree_avatax_sales_invoices, :doc_code, unique: true
+  end
+end

data/db/migrate/20140904171341_generate_uncommitted_sales_invoices.rb

@@ -0,0 +1,31 @@
+class GenerateUncommittedSalesInvoices < ActiveRecord::Migration
+  def up
+    scope = Spree::Order.
+      where(state: 'confirm').
+      joins('left join spree_avatax_sales_invoices on spree_orders.id = spree_avatax_sales_invoices.order_id').
+      where(:spree_avatax_sales_invoices => {id: nil}).
+      readonly(false)
+
+    say "Orders to migrate: #{scope.count}"
+
+    # batch size of 1 to avoid grabbing stale rows
+    scope.find_each(batch_size: 1) do |order|
+      say "generating an uncommitted sales invoice for order id=#{order.id} number=#{order.number} created_at=#{order.created_at.to_s(:db).inspect}"
+
+      begin
+        SpreeAvatax::SalesInvoice.generate(order)
+      rescue => e
+        say ""
+        say "************************ ERROR on Order #{order.number} ***************************"
+        say "ERROR: #{e.class} #{e.message}"
+        say e.backtrace.join("\n")
+        say "***********************************************************************************"
+        say ""
+      end
+    end
+  end
+
+  def down
+    # not reversible
+  end
+end

data/db/migrate/20140911214414_add_transaction_id_to_sales_orders_and_sales_invoices.rb

@@ -0,0 +1,6 @@
+class AddTransactionIdToSalesOrdersAndSalesInvoices < ActiveRecord::Migration
+  def change
+    add_column :spree_avatax_sales_orders, :transaction_id, :string
+    add_column :spree_avatax_sales_invoices, :transaction_id, :string
+  end
+end

data/db/migrate/20140911215422_add_canceled_at_and_cancel_transaction_id_to_sales_invoices.rb

@@ -0,0 +1,6 @@
+class AddCanceledAtAndCancelTransactionIdToSalesInvoices < ActiveRecord::Migration
+  def change
+    add_column :spree_avatax_sales_invoices, :canceled_at, :datetime
+    add_column :spree_avatax_sales_invoices, :cancel_transaction_id, :string
+  end
+end

data/db/migrate/20150427154942_create_spree_avatax_short_ship_return_invoices.rb

@@ -0,0 +1,44 @@
+class CreateSpreeAvataxShortShipReturnInvoices < ActiveRecord::Migration
+  def change
+    create_table :spree_avatax_short_ship_return_invoices do |t|
+      t.boolean :committed, null: false
+      t.string  :doc_id, null: false
+      t.string  :doc_code, null: false
+      t.date    :doc_date, null: false
+
+      t.timestamps null: true
+    end
+
+    create_table :spree_avatax_short_ship_return_invoice_inventory_units do |t|
+      t.references :short_ship_return_invoice, null: false
+      t.references :inventory_unit, null: false
+    end
+
+    # The default index names for these are too long for sqlite/mysql/postgres
+
+    add_index(
+      :spree_avatax_short_ship_return_invoice_inventory_units,
+      :short_ship_return_invoice_id,
+      unique: true,
+      name: 'index_spree_avatax_short_ships_on_invoice_id',
+    )
+    add_index(
+      :spree_avatax_short_ship_return_invoice_inventory_units,
+      :inventory_unit_id,
+      unique: true,
+      name: 'index_spree_avatax_short_ships_on_unit_id',
+    )
+    add_index(
+      :spree_avatax_short_ship_return_invoices,
+      :doc_id,
+      unique: true,
+      name: 'index_spree_avatax_short_invoices_on_doc_id',
+    )
+    add_index(
+      :spree_avatax_short_ship_return_invoices,
+      :doc_code,
+      unique: true,
+      name: 'index_spree_avatax_short_invoices_on_doc_code',
+    )
+  end
+end

data/db/migrate/20150518172627_fix_avatax_short_ship_index.rb

@@ -0,0 +1,30 @@
+class FixAvataxShortShipIndex < ActiveRecord::Migration
+  def up
+    remove_index(
+      :spree_avatax_short_ship_return_invoice_inventory_units,
+      name: 'index_spree_avatax_short_ships_on_invoice_id',
+    )
+
+    # Was previously set as unique, which was not correct -- A short ship return
+    # invoice may have multiple units associated with it
+    add_index(
+      :spree_avatax_short_ship_return_invoice_inventory_units,
+      :short_ship_return_invoice_id,
+      name: 'index_spree_avatax_short_ships_on_invoice_id',
+    )
+  end
+
+  def down
+    remove_index(
+      :spree_avatax_short_ship_return_invoice_inventory_units,
+      name: 'index_spree_avatax_short_ships_on_invoice_id',
+    )
+
+    add_index(
+      :spree_avatax_short_ship_return_invoice_inventory_units,
+      :short_ship_return_invoice_id,
+      unique: true,
+      name: 'index_spree_avatax_short_ships_on_invoice_id',
+    )
+  end
+end

data/lib/generators/solidus_avatax/install/install_generator.rb

@@ -0,0 +1,31 @@
+module SolidusAvatax
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def self.source_paths
+        paths = self.superclass.source_paths
+        paths << File.expand_path('../templates', __FILE__)
+        paths.flatten
+      end
+
+      def add_initializer
+        template 'config/initializers/avatax.rb', 'config/initializers/avatax.rb'
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_avatax'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/generators/solidus_avatax/install/templates/config/initializers/avatax.rb

@@ -0,0 +1,18 @@
+# Avatax Setup
+SpreeAvatax::Config.username = ENV["AVATAX_USERNAME"]
+SpreeAvatax::Config.password = ENV["AVATAX_PASSWORD"]
+SpreeAvatax::Config.company_code = ENV["AVATAX_COMPANY_CODE"]
+if Rails.env.production?
+  SpreeAvatax::Config.service_url = "https://avatax.avalara.net"
+else
+  SpreeAvatax::Config.service_url = "https://development.avalara.net"
+end
+
+# Use Avatax to compute return invoice tax amounts
+Spree::Reimbursement.reimbursement_tax_calculator = lambda do |reimbursement|
+  SpreeAvatax::ReturnInvoice.generate(reimbursement)
+end
+# Finalize the avatax return invoice after a reimubursement completes successfully
+Spree::Reimbursement.reimbursement_success_hooks << lambda do |reimbursement|
+  SpreeAvatax::ReturnInvoice.finalize(reimbursement)
+end

data/lib/solidus_avatax.rb

@@ -0,0 +1,4 @@
+require 'spree_core'
+require "spree_avatax/config"
+require 'spree_avatax/engine'
+require 'avatax_taxservice'

data/lib/spree_avatax/config.rb

@@ -0,0 +1,16 @@
+module SpreeAvatax
+  class Config
+    class << self
+      attr_accessor :username
+      attr_accessor :password
+      attr_accessor :company_code
+      attr_accessor :service_url
+      # These error handlers should be objects that respond to "call" and accept an order and an
+      # exception as arguments.  This allows you to ignore certain errors or handle them in
+      # specific ways.
+      attr_accessor :sales_invoice_generate_error_handler
+      attr_accessor :sales_invoice_commit_error_handler
+      attr_accessor :sales_invoice_cancel_error_handler
+    end
+  end
+end

data/lib/spree_avatax/engine.rb

@@ -0,0 +1,29 @@
+module SpreeAvatax
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace SpreeAvatax
+    engine_name 'spree_avatax'
+
+    initializer 'spree_avatax.register.calculators', after: 'spree.register.calculators' do |app|
+      app.config.spree.calculators.tax_rates << SpreeAvatax::Calculator
+      app.config.spree.calculators.shipping_methods << SpreeAvatax::Calculator
+    end
+
+    initializer 'spree_avatax.promo.register.promotion.calculators', after: 'spree.promo.register.promotion.calculators' do |app|
+      app.config.spree.calculators.promotion_actions_create_adjustments << SpreeAvatax::Calculator
+    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/factories.rb

@@ -0,0 +1,25 @@
+FactoryGirl.define do
+  sequence(:doc_id) { |n| n.to_s.rjust(16, '0') }
+
+  factory :avatax_tax_calculator, class: SpreeAvatax::Calculator do
+  end
+
+  factory :avatax_sales_invoice, class: SpreeAvatax::SalesInvoice do
+    association :order, factory: :shipped_order
+    doc_id { generate(:doc_id) }
+    doc_code { order.number }
+    doc_date { order.completed_at.try(:to_date) || 1.day.ago }
+    pre_tax_total { order.line_items.sum(:pre_tax_amount) }
+    additional_tax_total { order.line_items.sum(:additional_tax_total) }
+  end
+
+  factory :return_invoice, class: SpreeAvatax::ReturnInvoice do
+    association :reimbursement
+    committed false
+    doc_id { generate(:doc_id) }
+    doc_code { reimbursement.number }
+    doc_date { reimbursement.order.avatax_invoice_at.try(:to_date) || reimbursement.order.completed_at.to_date }
+    pre_tax_total { reimbursement.return_items.sum(:pre_tax_amount) }
+    additional_tax_total { reimbursement.return_items.sum(:additional_tax_total) }
+  end
+end

data/lib/tasks/commit_backfill.rake

@@ -0,0 +1,119 @@
+require 'pp'
+
+namespace :spree_avatax do
+
+  desc <<-DESC
+    Backfill all existing SalesInvoice records with Commit=true.
+    The "start_id" and "end_id" parameters are order ids and are optional.
+    Use this if you used spree_avatax prior to Commit=true being passed to Avatax.
+    i.e. before this: https://github.com/bonobos/spree_avatax/pull/25
+  DESC
+  task(:commit_sales_invoices, [:start_id, :end_id] => :environment) do |t, args|
+
+    puts 'Committing SalesInvoices for orders with an "avatax_invoice_at" value'
+
+    # CONFIGURE OPTIONS
+
+    scope = Spree::Order.where.not(avatax_invoice_at: nil)
+    batch_options = {}
+
+    if args[:start_id]
+      batch_options[:start] = args[:start_id]
+      puts "Beginning at order id #{args[:start_id]}"
+    end
+
+    if args[:end_id]
+      scope = scope.where('spree_orders.id <= ?', args[:end_id])
+      puts "Will stop at order id #{args[:end_id]}"
+    end
+
+    # PREP TO ITERATE OVER ORDERS
+
+    tax_svc = AvaTax::TaxService.new({
+      username:               SpreeAvatax::Config.username,
+      password:               SpreeAvatax::Config.password,
+      service_url:            SpreeAvatax::Config.service_url,
+      clientname:             'Spree::Avatax',
+    })
+
+    handle_result_errors = ->(result, order, request_method) do
+      puts
+      puts "** Error on order id=#{order.id} number=#{order.number} **"
+      puts "Avatax #{request_method} result code: #{result[:result_code]}"
+      puts 'messages:'
+      pp result[:messages]
+      puts
+    end
+
+    # ITERATE OVER ORDERS
+
+    error_count = 0
+    update_count = 0
+    skip_count = 0
+
+    scope.find_each(batch_options) do |order|
+      puts "processing order id=#{order.id} number=#{order.number}"
+
+      # CHECK CURRENT AVATAX STATUS
+
+      history_request = {
+        companycode: SpreeAvatax::Config.company_code,
+        doctype:     'SalesInvoice',
+        doccode:     order.number,
+        detaillevel: 'Tax',
+      }
+
+      history_result = tax_svc.gettaxhistory(history_request)
+
+      if history_result[:result_code] != 'Success'
+        error_count += 1
+        handle_result_errors.call(history_result, order, :gettaxhistory)
+        next
+      end
+
+      if history_result[:get_tax_result][:doc_status] == 'Committed'
+        skip_count += 1
+        next # already committed. skip it.
+      end
+
+      # POST AND COMMIT
+
+      post_request = {
+        companycode: SpreeAvatax::Config.company_code,
+        doctype:     'SalesInvoice',
+        doccode:     order.number,
+
+        commit:      true,
+
+        docdate:     order.avatax_invoice_at.to_date,
+        # sanity checks for avatax
+        totalamount: history_result[:get_tax_result][:total_amount],
+        totaltax:    history_result[:get_tax_result][:total_tax],
+      }
+
+      post_result = tax_svc.posttax(post_request)
+
+      if post_result[:result_code] != 'Success'
+        error_count += 1
+        handle_result_errors.call(post_result, order, :posttax)
+        next
+      end
+
+      update_count += 1
+    end
+
+    # PRINT RESULTS
+
+    puts
+    puts "Update complete."
+    puts "Update count: #{update_count}. Skip count: #{skip_count}. Error count: #{error_count}."
+
+    if error_count > 0
+      puts
+      puts '***********************************************'
+      puts "* WARNING: #{error_count} errors encountered"
+      puts '***********************************************'
+    end
+  end
+
+end