workarea-avatax 4.2.0

data/app/workers/workarea/avatax/tax_invoice_worker.rb

@@ -0,0 +1,29 @@
+module Workarea
+  module Avatax
+    class TaxInvoiceWorker
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: {
+          Workarea::Order => :place,
+          ignore_if: -> { Avatax.config.order_handling == :none }
+        }
+      )
+
+      def perform(order_id)
+        order = Workarea::Order.find(order_id)
+        shippings = Workarea::Shipping.where(order_id: order.id).to_a
+
+        response = Avatax::TaxRequest.new(
+          order: order,
+          shippings: shippings,
+          type: "SalesInvoice",
+          commit: Avatax.commit?
+        ).response
+
+        raise "Failed to invoice tax for order: #{order.id}" unless response.success?
+      end
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("../..", __FILE__)
+ENGINE_PATH = File.expand_path("../../lib/workarea/avatax/engine", __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+require "rails/test_unit/railtie"
+require "sprockets/railtie"
+
+require "rails/engine/commands"

data/config/initializers/appends.rb

@@ -0,0 +1,4 @@
+Workarea.append_partials(
+  "admin.user_properties",
+  "workarea/admin/users/avatax_properties_fields"
+)

data/config/initializers/avatax.rb

@@ -0,0 +1,14 @@
+Workarea.config.pricing_calculators.swap(
+  "Workarea::Pricing::Calculators::TaxCalculator",
+  "Workarea::Pricing::Calculators::AvalaraTaxCalculator"
+)
+
+if Rails.application.secrets.avatax.present?
+  avatax_sercrets = Rails.application.secrets.avatax.deep_symbolize_keys
+  AvaTax.configure do |config|
+    config.username = avatax_sercrets[:username]
+    config.password = avatax_sercrets[:password]
+  end
+end
+
+Workarea::Avatax.auto_configure_gateway

data/config/initializers/seeds.rb

@@ -0,0 +1 @@
+Workarea.config.seeds.append("Workarea::AvataxSeeds")

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  workarea:
+    admin:
+      users:
+        edit:
+          avatax_entity_use_code: AvaTax Entity/Use Code

data/lib/avatax/api.decorator

@@ -0,0 +1,52 @@
+module AvaTax
+  decorate API, with: :workarea_avatax do
+    def request(method, path, model, options = {})
+      timeout = options.delete(:timeout)
+
+      connection.send(method) do |request|
+        request.options.timeout = timeout if timeout
+
+        case method
+        when :get, :delete
+          request.url("#{URI.encode(path)}?#{URI.encode_www_form(options)}")
+        when :post, :put
+          request.path = ("#{URI.encode(path)}?#{URI.encode_www_form(options)}")
+          request.headers["Content-Type"] = "application/json"
+          request.body = model.to_json unless model.empty?
+        end
+      end
+    end
+
+    private
+
+    # NOTE: Remove this decoration when
+    #       https://github.com/avadev/AvaTax-REST-V2-Ruby-SDK/issues/16 is
+    #       resolved and merged in.
+    def connection
+      client_id = "#{app_name};#{app_version};RubySdk;#{AvaTax::VERSION.dup};#{machine_name}"
+      options = {
+        :headers =>
+          {
+           'Accept' => "application/json; charset=utf-8",
+           'User-Agent' => user_agent,
+           'X-Avalara-Client' => client_id
+          },
+        :url => endpoint,
+        :proxy => proxy,
+      }.merge(connection_options)
+
+      Faraday.new(options) do |faraday|
+        faraday.response :oj, content_type: /\bjson$/
+        faraday.basic_auth(username, password)
+
+        if logger
+          faraday.response :logger do |logger|
+            logger.filter(/(Authorization\:\ \"Basic\ )(\w+)\=/, '\1[REMOVED]')
+          end
+        end
+
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/workarea/avatax/bogus_gateway/bogus_create_transaction.rb

@@ -0,0 +1,187 @@
+module Workarea
+  module Avatax
+    class BogusGateway::BogusCreateTransaction < BogusGateway::BogusResponse
+      attr_reader :request_body
+
+      def initialize(request_body)
+        @request_body = request_body
+      end
+
+      def response
+        env = Faraday::Env.new(
+          :post,
+          response_body,
+          URI("https://sandbox-rest.avatax.com/api/v2/transactions/create"),
+          Faraday::RequestOptions.new,
+          request_headers,
+          Faraday::SSLOptions.new(true),
+          nil,
+          nil,
+          nil,
+          response_headers,
+          201,
+          "Created"
+        )
+        Faraday::Response.new(env)
+      end
+
+      private
+
+        def response_body
+          {
+            "id"        => 0,
+            "code"      => "0B41518F49",
+            "companyId" => 0,
+            "status"    => "Temporary",
+            "type"      => "SalesOrder",
+            "totalTax"  => lines.sum { |line| line["tax"] },
+            "lines"     => lines
+          }
+        end
+
+        def lines
+          @lines ||= request_body[:lines].map.with_index(1) do |line, number|
+            if Rails.env.test?
+              test_like_line(line, number)
+            else
+              api_like_line(line, number)
+            end
+          end.compact
+        end
+
+        def api_like_line(line, number)
+          {
+            "id"             => 0,
+            "transactionId"  => 0,
+            "lineNumber"     => number.to_s,
+            "description"    => "",
+            "discountAmount" => 0.0,
+            "exemptAmount"   => 0.0,
+            "exemptCertId"   => 0,
+            "isItemTaxable"  => true,
+            "itemCode"       => "",
+            "lineAmount"     => line[:amount],
+            "quantity"       => 0.0,
+            "reportingDate"  => "2017-06-08",
+            "tax"            => (line[:amount].to_m * 0.08).to_s,
+            "taxableAmount"  => line[:amount],
+            "taxCalculated"  => (line[:amount].to_m * 0.08).to_s,
+            "taxCode"        => "P0000000",
+            "taxDate"        => "2017-06-08",
+            "taxIncluded"    => false,
+            "details"        => [
+              {
+                "id"                 => 0,
+                "transactionLineId"  => 0,
+                "transactionId"      => 0,
+                "country"            => "US",
+                "region"             => "PA",
+                "exemptAmount"       => 0.0,
+                "jurisCode"          => "42",
+                "jurisName"          => "PENNSYLVANIA",
+                "stateAssignedNo"    => "",
+                "jurisType"          => "STA",
+                "nonTaxableAmount"   => 0.0,
+                "rate"               => 0.06,
+                "tax"                => (line[:amount].to_m * 0.06).to_s,
+                "taxableAmount"      => line[:amount],
+                "taxType"            => "Sales",
+                "taxName"            => "PA STATE TAX",
+                "taxAuthorityTypeId" => 45,
+                "taxCalculated"      => (line[:amount].to_m * 0.06).to_s,
+                "rateType"           => "General",
+                "rateTypeCode"       => "G"
+              },
+              {
+                "id"                 => 0,
+                "transactionLineId"  => 0,
+                "transactionId"      => 0,
+                "country"            => "US",
+                "region"             => "PA",
+                "exemptAmount"       => 0.0,
+                "jurisCode"          => "101",
+                "jurisName"          => "PHILADELPHIA",
+                "stateAssignedNo"    => "51",
+                "jurisType"          => "CTY",
+                "nonTaxableAmount"   => 0.0,
+                "rate"               => 0.02,
+                "tax"                => (line[:amount].to_m * 0.02).to_s,
+                "taxableAmount"      => line[:amount],
+                "taxType"            => "Sales",
+                "taxName"            => "PA COUNTY TAX",
+                "taxAuthorityTypeId" => 45,
+                "taxCalculated"      => (line[:amount].to_m * 0.02).to_s,
+                "rateType"           => "General",
+                "rateTypeCode"       => "G"
+              }
+            ]
+          }
+        end
+
+        def test_like_line(line, number)
+          request_address = request_body[:addresses][:shipTo] ||
+            request_body[:addresses][:singleLocation]
+
+          address =
+            if request_address.blank?
+              Workarea::Address.new
+            else
+              # need to underscore keys and duck a workarea::address
+              Hashie::Mash.new(Hash[request_address.map { |k, v| [k.to_s.underscore, v] }])
+            end
+
+          tax_rate = Workarea::Tax.find_rate(
+            line[:taxCode],
+            line[:amount].to_m,
+            address
+          )
+
+          return unless tax_rate.present?
+          {
+            "id"             => 0,
+            "transactionId"  => 0,
+            "lineNumber"     => number.to_s,
+            "description"    => "",
+            "discountAmount" => 0.0,
+            "exemptAmount"   => 0.0,
+            "exemptCertId"   => 0,
+            "isItemTaxable"  => true,
+            "itemCode"       => "",
+            "lineAmount"     => line[:amount],
+            "quantity"       => 0.0,
+            "reportingDate"  => "2017-06-08",
+            "tax"            => (line[:amount].to_m * tax_rate.percentage).to_s,
+            "taxableAmount"  => line[:amount],
+            "taxCalculated"  => (line[:amount].to_m * tax_rate.percentage).to_s,
+            "taxCode"        => "P0000000",
+            "taxDate"        => "2017-06-08",
+            "taxIncluded"    => false,
+            "details"        => [
+              {
+                "id"                 => 0,
+                "transactionLineId"  => 0,
+                "transactionId"      => 0,
+                "country"            => "US",
+                "region"             => "PA",
+                "exemptAmount"       => 0.0,
+                "jurisCode"          => "42",
+                "jurisName"          => "PENNSYLVANIA",
+                "stateAssignedNo"    => "",
+                "jurisType"          => "STA",
+                "nonTaxableAmount"   => 0.0,
+                "rate"               => tax_rate.percentage,
+                "tax"                => (line[:amount].to_m * tax_rate.percentage).to_s,
+                "taxableAmount"      => line[:amount],
+                "taxType"            => "Sales",
+                "taxName"            => "PA STATE TAX",
+                "taxAuthorityTypeId" => 45,
+                "taxCalculated"      => (line[:amount].to_m * tax_rate.percentage).to_s,
+                "rateType"           => "General",
+                "rateTypeCode"       => "G"
+              }
+            ]
+          }
+        end
+    end
+  end
+end

data/lib/workarea/avatax/bogus_gateway.rb

@@ -0,0 +1,34 @@
+module Workarea
+  module Avatax
+    class BogusGateway
+      class BogusResponse
+        private
+
+          def request_headers
+            {
+              "Accept"        => "application/json; charset=utf-8",
+              "User-Agent"    => "AvaTax Ruby Gem 17.5.0",
+              "Content-Type"  => "application/json",
+              "Authorization" => "Basic ZXBpZ2VvbkB3ZWJsaW5jLmNvbTo2NDhCMEE5ODUx"
+            }
+          end
+
+          def response_headers
+            {
+              "transfer-encoding" => "chunked",
+              "content-type"      => "application/json; charset=utf-8",
+              "server"            => "Kestrel",
+              "serverduration"    => "00:00:00.0937524",
+              "databasecalls"     => "4",
+              "databaseduration"  => "00:00:00.0156261",
+              "date"              => "Thu, 08 Jun 2017 19:04:38 GMT"
+            }
+          end
+      end
+
+      def create_transaction(body, options = {})
+        BogusCreateTransaction.new(body).response
+      end
+    end
+  end
+end

data/lib/workarea/avatax/engine.rb

@@ -0,0 +1,36 @@
+module Workarea
+  module Avatax
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+
+      isolate_namespace Workarea::Avatax
+
+      #Workarea::Avatax.configure do |config|
+      #  config.valid_service_urls = [
+      #    "https://development.avalara.net",   # development
+      #    "https://avatax.avalara.net"         # production
+      #  ]
+      #end
+
+      initializer "workarea.avatax.templates" do
+        #Plugin.append_partials(
+        #  "admin.store_menu",
+        #  "workarea/admin/menus/avatax_settings"
+        #)
+
+        #Plugin.append_partials(
+        #  "admin.user_permissions",
+        #  "workarea/admin/users/avatax_settings"
+        #)
+        #Plugin.append_partials(
+        #  "admin.user_properties",
+        #  "workarea/admin/users/user_properties_fields"
+        #)
+      end
+
+      #initializer "workarea.avatax.listeners" do
+      #  Workarea::Publisher.add_listener(Workarea::Avatax::InvoiceListener)
+      #end
+    end
+  end
+end

data/lib/workarea/avatax/tax_request/addresses.rb

@@ -0,0 +1,35 @@
+module Workarea
+  module Avatax
+    class TaxRequest::Addresses
+      attr_reader :tax_request
+
+      def initialize(tax_request:)
+        @tax_request = tax_request
+      end
+
+      def hash
+        return { singleLocation: ship_from } unless ship_to.present?
+
+        { shipFrom: ship_from, shipTo: ship_to }
+      end
+
+      private
+
+        def ship_from
+          Avatax.config.distribution_center
+        end
+
+        def ship_to
+          return unless address = tax_request.shippings.first.try(:address)
+          {
+            line1:      address.street,
+            line2:      address.street_2,
+            city:       address.city,
+            region:     address.region,
+            country:    address.country.alpha2,
+            postalCode: address.postal_code
+          }
+        end
+    end
+  end
+end

data/lib/workarea/avatax/tax_request/line_item.rb

@@ -0,0 +1,47 @@
+module Workarea
+  module Avatax
+    class TaxRequest::LineItem
+      attr_accessor :line_number
+
+      def initialize(**)
+        @line_number = 0
+      end
+
+      def hash
+        {
+          quantity:    quantity,
+          amount:      amount.to_s,
+          itemCode:    item_code,
+          taxCode:     tax_code,
+          description: description,
+          number:      line_number,
+          addresses:   addresses
+        }.compact
+      end
+
+      private
+
+        def quantity
+          raise NotImplementedError, "#{self.class.name} must implement #quantity"
+        end
+
+        def amount
+          raise NotImplementedError, "#{self.class.name} must implement #amount"
+        end
+
+        def item_code
+          raise NotImplementedError, "#{self.class.name} must implement #item_code"
+        end
+
+        def tax_code
+          raise NotImplementedError, "#{self.class.name} must implement #tax_code"
+        end
+
+        def description
+          raise NotImplementedError, "#{self.class.name} must implement #description_code"
+        end
+
+        def addresses; end
+    end
+  end
+end

data/lib/workarea/avatax/tax_request/order_line_item.rb

@@ -0,0 +1,64 @@
+module Workarea
+  module Avatax
+    class TaxRequest::OrderLineItem < TaxRequest::LineItem
+      attr_reader :order_item, :adjustment, :shipping
+
+      def initialize(order_item:, adjustment:, adjustment_set:, quantity: nil, shipping: nil)
+        @order_item = order_item
+        @adjustment = adjustment
+        @adjustment_set = adjustment_set
+        @quantity = quantity
+        @shipping = shipping
+      end
+
+      private
+
+        def addresses
+          return unless address = shipping&.address
+
+          {
+            shipTo: {
+              line1:      address.street,
+              line2:      address.street_2,
+              city:       address.city,
+              region:     address.region,
+              country:    address.country.alpha2,
+              postalCode: address.postal_code
+            }
+          }
+        end
+
+        def quantity
+          @quantity || adjustment.quantity
+        end
+
+        def amount
+          total = @adjustment_set.taxable_share_for adjustment
+          if shipping.present? && shipping.partial?
+            total *= quantity / order_item.quantity.to_f
+          end
+          total
+        end
+
+        def item_code
+          order_item.sku
+        end
+
+        def tax_code
+          adjustment.data["tax_code"]
+        end
+
+        def product
+          @product ||= Mongoid::Factory.from_db(
+            Catalog::Product,
+            order_item.product_attributes
+          )
+        end
+
+        def description
+          return if order_item.product_attributes.empty?
+          product.name
+        end
+    end
+  end
+end

data/lib/workarea/avatax/tax_request/order_lines.rb

@@ -0,0 +1,70 @@
+module Workarea
+  module Avatax
+    class TaxRequest::OrderLines
+      attr_reader :order, :shippings
+
+      def initialize(order, shippings)
+        @order = order
+        @shippings = shippings
+      end
+
+      def order_line_items
+        @order_line_items ||=
+          if shippings.any?(&:partial?)
+            split_shipping_lines
+          else
+            single_shipping_lines
+          end.map.with_index(1) { |line, index| line.tap { |li| li.line_number = index } }
+      end
+
+      def shipping_line_items
+        @shipping_line_item ||= shippings.map { |shipping| TaxRequest::ShippingLineItem.new(shipping: shipping) }
+      end
+
+      def lines
+        (order_line_items + shipping_line_items).map.with_index(1) do |line_item, index|
+          line_item.tap { |li| li.line_number = index }
+        end
+      end
+
+      private
+
+        def order_price_adjustments
+          order.price_adjustments
+        end
+
+        def grouped_order_price_adjustments
+          order_price_adjustments.grouped_by_parent
+        end
+
+        def single_shipping_lines
+          grouped_order_price_adjustments.flat_map do |item, set|
+            set.map do |adjustment|
+              next unless adjustment.data["tax_code"].present?
+
+              TaxRequest::OrderLineItem.new(order_item: item, adjustment: adjustment, adjustment_set: set)
+            end
+          end.compact
+        end
+
+        def split_shipping_lines
+          shippings.flat_map do |shipping|
+            shipping.quantities.flat_map do |order_item_id, quantity|
+              item = order.items.detect { |oi| oi.id.to_s == order_item_id }
+              adjustment_set = grouped_order_price_adjustments[item]
+
+              adjustment_set.map do |adjustment|
+                TaxRequest::OrderLineItem.new(
+                  order_item: item,
+                  adjustment: adjustment,
+                  adjustment_set: adjustment_set,
+                  quantity: quantity,
+                  shipping: shipping
+                )
+              end
+            end
+          end
+        end
+    end
+  end
+end

data/lib/workarea/avatax/tax_request/response.rb

@@ -0,0 +1,49 @@
+module Workarea
+  module Avatax
+    class TaxRequest::Response
+      attr_reader :response, :request_order_line_items, :request_shipping_line_items
+      delegate :success?, to: :response
+
+      def initialize(response:, request_order_line_items:, request_shipping_line_items:)
+        @response = response
+        @request_order_line_items = request_order_line_items
+        @request_shipping_line_items = request_shipping_line_items
+      end
+
+      def body
+        @body ||= Hashie::Mash.new response.body
+      end
+
+      def tax_line_for_adjustment(price_adjustment, shipping: nil)
+        return unless success?
+
+        line_number =
+          if shipping&.partial?
+            request_order_line_items
+              .detect { |line_item| line_item.adjustment == price_adjustment && line_item.shipping == shipping }
+              .try(:line_number)
+          else
+            request_order_line_items
+              .detect { |line_item| line_item.adjustment == price_adjustment }
+              .try(:line_number)
+          end
+
+        return unless line_number
+
+        body.lines.detect { |line| line.lineNumber.to_i == line_number }
+      end
+
+      def tax_line_for_shipping(shipping)
+        return unless success?
+
+        line_number = request_shipping_line_items
+          .detect { |line_item| line_item.shipping.id == shipping.id }
+          .try(:line_number)
+
+        return unless line_number
+
+        body.lines.detect { |line| line.lineNumber.to_i == line_number }
+      end
+    end
+  end
+end