solidus_avatax_certified 1.0.0

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,85 @@
+require 'logger'
+
+Spree::Order.class_eval do
+
+  has_one :avalara_transaction, dependent: :destroy
+
+  self.state_machine.before_transition :to => :canceled,
+                                      :do => :cancel_avalara,
+                                      :if => :avalara_tax_enabled?
+  self.state_machine.before_transition :to => :delivery,
+                                      :do => :validate_ship_address,
+                                      :if => :address_validation_enabled?
+
+  def avalara_tax_enabled?
+    Spree::AvalaraPreference.tax_calculation.is_true?
+  end
+
+  def cancel_avalara
+    return nil unless avalara_transaction.present?
+    self.avalara_transaction.cancel_order
+  end
+
+  def avalara_capture
+    logger.debug 'avalara capture'
+
+    create_avalara_transaction if avalara_transaction.nil?
+    line_items.reload
+
+    @rtn_tax = self.avalara_transaction.commit_avatax('SalesOrder')
+
+    logger.info_and_debug('tax amount', @rtn_tax)
+    @rtn_tax
+  end
+
+  def avalara_capture_finalize
+    logger.debug 'avalara capture finalize'
+
+    create_avalara_transaction if avalara_transaction.nil?
+    line_items.reload
+
+    @rtn_tax = avalara_transaction.commit_avatax_final('SalesInvoice')
+
+    logger.info_and_debug('tax amount', @rtn_tax)
+    @rtn_tax
+  end
+
+  def validate_ship_address
+    avatax_address = SolidusAvataxCertified::Address.new(self)
+    response = avatax_address.validate
+
+    return response if response['ResultCode'] == 'Success'
+    return response if !Spree::AvalaraPreference.refuse_checkout_address_validation_error.is_true?
+
+    messages = response['Messages'].each do |message|
+      errors.add(:address_validation_failure, message['Summary'])
+    end
+   return false
+  end
+
+  def avatax_cache_key
+    key = ['Spree::Order']
+    key << self.number
+    key << self.promo_total
+    key.join('-')
+  end
+
+  def customer_usage_type
+    user ? user.avalara_entity_use_code.try(:use_code) : ''
+  end
+
+  def stock_locations
+    stock_loc_ids = shipments.pluck(:stock_location_id).uniq
+    Spree::StockLocation.where(id: stock_loc_ids)
+  end
+
+  def address_validation_enabled?
+    return false if ship_address.nil?
+
+    ship_address.validation_enabled?
+  end
+
+  def logger
+    @logger ||= SolidusAvataxCertified::AvataxLog.new('avalara_order', 'order class', 'start order processing')
+  end
+end

data/app/models/spree/payment_decorator.rb

@@ -0,0 +1,23 @@
+Spree::Payment.class_eval do
+  self.state_machine.before_transition to: :completed, do: :avalara_finalize
+  self.state_machine.after_transition to: :void, do: :cancel_avalara
+
+  def avalara_tax_enabled?
+    Spree::AvalaraPreference.tax_calculation.is_true?
+  end
+
+  def cancel_avalara
+    order.avalara_transaction.cancel_order unless order.avalara_transaction.nil?
+  end
+
+  def avalara_finalize
+    return unless avalara_tax_enabled?
+
+    if self.amount != order.total
+      self.update_attributes(amount: order.total)
+      order.avalara_capture_finalize
+    else
+      order.avalara_capture_finalize
+    end
+  end
+end

data/app/models/spree/refund_decorator.rb

@@ -0,0 +1,30 @@
+require 'logger'
+
+Spree::Refund.class_eval do
+  has_one :avalara_transaction
+  after_create :avalara_capture_finalize, if: :avalara_tax_enabled?
+
+  def avalara_tax_enabled?
+    Spree::AvalaraPreference.tax_calculation.is_true?
+  end
+
+  def avalara_capture_finalize
+    logger.debug 'avalara capture refund avalara_capture_finalize'
+    begin
+      avalara_transaction_refund = self.payment.order.avalara_transaction
+
+      @rtn_tax = avalara_transaction_refund.commit_avatax_final('ReturnInvoice', self)
+
+      logger.info 'tax amount'
+      logger.debug @rtn_tax
+      @rtn_tax
+    rescue => e
+      logger.debug e
+      logger.debug 'error in avalara capture refund finalize'
+    end
+  end
+
+  def logger
+    @logger ||= SolidusAvataxCertified::AvataxLog.new('refund', 'refund class')
+  end
+end

data/app/models/spree/shipment_decorator.rb

@@ -0,0 +1,28 @@
+Spree::Shipment.class_eval do
+
+  def avatax_cache_key
+    key = ['Spree::Shipment']
+    key << self.id
+    key << self.cost
+    key << self.stock_location.try(:cache_key)
+    key << self.promo_total
+    key.join('-')
+  end
+
+  def avatax_line_code
+    'FR'
+  end
+
+  def shipping_method_tax_code
+    tax_code = shipping_method.tax_category.try(:tax_code)
+    if tax_code.nil?
+      ''
+    else
+      tax_code
+    end
+  end
+
+  def tax_category
+    selected_shipping_rate.try(:tax_rate).try(:tax_category) || shipping_method.try(:tax_category)
+  end
+end

data/app/models/spree/shipping_rate_decorator.rb

@@ -0,0 +1,25 @@
+Spree::ShippingRate.class_eval do
+  def tax_rate
+    Spree::TaxRate.find(tax_rate_id) if tax_rate_id
+  end
+
+  # Solidusv1.0-v1.2 uses display_amount while newer versions use display_base_price
+  def display_price
+    price = if respond_to?(:display_amount)
+      display_amount
+    else
+      display_base_price
+    end.to_s
+
+    return price if Spree::AvalaraPreference.tax_calculation.is_true?
+    return price if taxes.empty? || amount == 0
+
+    tax_explanations = taxes.map(&:label).join(tax_label_separator)
+
+    Spree.t :display_price_with_explanations,
+             scope: 'shipping_rate.display_price',
+             price: price,
+             explanations: tax_explanations
+  end
+  alias_method :display_cost, :display_price
+end

data/app/models/spree/user_decorator.rb

@@ -0,0 +1,3 @@
+Spree.user_class.class_eval do
+  belongs_to :avalara_entity_use_code
+end

data/app/models/tax_svc.rb

@@ -0,0 +1,143 @@
+require 'json'
+require 'net/http'
+require 'addressable/uri'
+require 'base64'
+require 'rest-client'
+require 'logging'
+
+# Avatax tax calculation API calls
+class TaxSvc
+  def get_tax(request_hash)
+    log(__method__, request_hash)
+    RestClient.log = logger.logger
+    res = response('get', request_hash)
+    logger.info_and_debug('RestClient call', res)
+
+    if res['ResultCode'] != 'Success'
+      logger.info 'Avatax Error'
+      logger.debug res, 'error in Tax'
+      raise 'error in Tax'
+    else
+      res
+    end
+  rescue => e
+    logger.info 'Rest Client Error'
+    logger.debug e, 'error in Tax'
+    'error in Tax'
+  end
+
+  def cancel_tax(request_hash)
+    log(__method__, request_hash)
+    res = response('cancel', request_hash)['CancelTaxResult']
+    logger.debug res
+
+    if res['ResultCode'] != 'Success'
+      logger.info_and_debug("Avatax Error: Order ##{res['Messages'][0]['Details']}", res)
+    end
+
+    res
+  rescue => e
+    logger.debug e, 'Error in Cancel Tax'
+    'Error in Cancel Tax'
+  end
+
+  def estimate_tax(coordinates, sale_amount)
+    if tax_calculation_enabled?
+      log(__method__)
+
+      return nil if coordinates.nil?
+      sale_amount = 0 if sale_amount.nil?
+      coor = coordinates[:latitude].to_s + ',' + coordinates[:longitude].to_s
+
+      uri = URI(service_url + coor + '/get?saleamount=' + sale_amount.to_s)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      http.open_timeout = 1
+      http.read_timeout = 1
+
+      res = http.get(uri.request_uri, 'Authorization' => credential, 'Content-Type' => 'application/json')
+      JSON.parse(res.body)
+    end
+  rescue => e
+    logger.debug e, 'error in Estimate Tax'
+    'error in Estimate Tax'
+  end
+
+  def ping
+    logger.info 'Ping Call'
+    estimate_tax({ latitude: '40.714623', longitude: '-74.006605' }, 0)
+  end
+
+  def validate_address(address)
+    uri = URI(address_service_url + address.to_query)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    http.open_timeout = 1
+    http.read_timeout = 1
+    res = http.get(uri.request_uri, 'Authorization' => credential)
+
+    logger.debug res
+
+    JSON.parse(res.body)
+  rescue => e
+    "error in address validation: #{e}"
+  end
+
+  protected
+
+  def logger
+    SolidusAvataxCertified::AvataxLog.new('tax_svc', 'tax_service', 'call to tax service')
+  end
+
+  private
+
+  def tax_calculation_enabled?
+    Spree::AvalaraPreference.tax_calculation.is_true?
+  end
+
+  def credential
+    'Basic ' + Base64.encode64(account_number + ':' + license_key)
+  end
+
+  def service_url
+    Spree::AvalaraPreference.endpoint.value + AVATAX_SERVICEPATH_TAX
+  end
+
+  def address_service_url
+    Spree::AvalaraPreference.endpoint.value + AVATAX_SERVICEPATH_ADDRESS + 'validate?'
+  end
+
+  def license_key
+    Spree::AvalaraPreference.license_key.value
+  end
+
+  def account_number
+    Spree::AvalaraPreference.account.value
+  end
+
+  def response(uri, request_hash)
+    res = RestClient::Request.execute(method: :post,
+                                timeout: 1,
+                                open_timeout: 1,
+                                url: service_url + uri,
+                                payload:  JSON.generate(request_hash),
+                                headers: {
+                                  authorization: credential,
+                                  content_type: 'application/json'
+                                }
+    )  do |response, request, result|
+      response
+    end
+
+    JSON.parse(res)
+  end
+
+  def log(method, request_hash = nil)
+    logger.info method.to_s + ' call'
+    return if request_hash.nil?
+    logger.debug request_hash
+    logger.debug JSON.generate(request_hash)
+  end
+end

data/app/overrides/spree/admin/shared/_configuration_menu.rb

@@ -0,0 +1,10 @@
+Deface::Override.new(
+  virtual_path:  'spree/admin/shared/_taxes_tabs',
+  name:          'add_avalara_admin_menu_links',
+  insert_bottom: "[data-hook='admin_settings_taxes_tabs']"
+) do
+  <<-HTML
+    <%= configurations_sidebar_menu_item Spree.t(:avalara_settings), admin_avatax_settings_path %>
+    <%= configurations_sidebar_menu_item Spree.t(:avalara_entity_use_codes), admin_avalara_entity_use_codes_path %>
+  HTML
+end

data/app/overrides/spree/admin/users/sidebar.rb

@@ -0,0 +1,8 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/users/_sidebar',
+  name:         'add avalara information link',
+  insert_bottom:   '[data-hook="admin_user_tab_options"]',
+  text: "<li>
+        <%= link_to 'avalara information', avalara_information_admin_user_path(@user) %>
+      </li>"
+)

data/app/overrides/spree/admin/users/validation_button.rb

@@ -0,0 +1,6 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/users/_addresses_form',
+  name:         'add validator button',
+  insert_bottom:   '[data-hook="ship_address_wrapper"]',
+  text: "<a href='#'' class='button address_validator' style='float: right;'>Validate Ship Address</a>"
+)

data/app/views/spree/admin/avalara_entity_use_codes/_form.html.erb

@@ -0,0 +1,27 @@
+<div class="row">
+  <div class="sixteen columns">
+    <fieldset class="no-border-bottom">
+      <% if @avalara_entity_use_code.errors.any? %>
+          <div id="error_explanation">
+            <h2><%= pluralize(@use_code.errors.count, "error") %> prohibited this "Use Code" from being saved:</h2>
+
+            <ul>
+              <% @use_code.errors.full_messages.each do |msg| %>
+                  <li><%= msg %></li>
+              <% end %>
+            </ul>
+          </div>
+      <% end %>
+
+      <div class="field alpha eight columns">
+        <%= f.label :use_code %><br>
+        <%= f.text_field :use_code, class: 'fullwidth' %>
+      </div>
+      <div class="field omega eight columns">
+        <%= f.label :use_code_description %><br>
+        <%= f.text_field :use_code_description, class: 'fullwidth' %>
+      </div>
+    </fieldset>
+  </div>
+
+</div>

data/app/views/spree/admin/avalara_entity_use_codes/edit.html.erb

@@ -0,0 +1,16 @@
+<%= render 'spree/admin/shared/taxes_tabs' %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:editing_avalara_entity_use_code) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <li><%= link_to_with_icon 'arrow-left', Spree.t(:back_to_avalara_entity_use_codes_list), admin_avalara_entity_use_codes_path, :class => 'button' %></li>
+<% end %>
+
+<%= render 'spree/shared/error_messages', :target => @avalara_entity_use_code %>
+
+<%= form_for [:admin, @avalara_entity_use_code], :method => :put do |f| %>
+    <%= render :partial => 'form', :locals => { :f => f } %>
+    <p class="form-buttons" data-hook="buttons"><%= button Spree.t(:update) %></p>
+<% end %>

data/app/views/spree/admin/avalara_entity_use_codes/index.html.erb

@@ -0,0 +1,33 @@
+<%= render 'spree/admin/shared/taxes_tabs' %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:avalara_entity_use_codes) %>
+<% end %>
+
+<% content_for :page_actions do %>
+    <li>
+      <%= button_link_to Spree.t(:new_avalara_entity_use_code), new_object_url, :icon => 'plus', :id => 'admin_new_avalara_entity_use_code_link' %>
+    </li>
+<% end %>
+
+<table class="index" id="listing_sale_events" data-hook>
+  <thead>
+  <tr data-hook="admin_sale_events_index_headers">
+    <th><%= Spree.t(:use_code) %></th>
+    <th ><%= Spree.t(:use_code_description) %></th>
+    <tH data-hook="admin_sale_events_index_header_actions"></tH>
+  </tr>
+  </thead>
+  <tbody>
+  <% @avalara_entity_use_codes.each do |use_code|%>
+      <tr id="<%= dom_id use_code %>" data-hook="admin_sale_events_index_rows">
+        <td><%=link_to use_code.use_code, object_url(use_code) %></td>
+        <td><%=use_code.use_code_description %></td>
+        <td data-hook="admin_avalara_entity_use_codes_index_row_actions">
+          <%= link_to_edit use_code, :class => 'edit' %> &nbsp;
+          <%= link_to_delete use_code %>
+        </td>
+      </tr>
+  <% end %>
+  </tbody>
+</table>

data/app/views/spree/admin/avalara_entity_use_codes/new.html.erb

@@ -0,0 +1,17 @@
+<%= render 'spree/admin/shared/taxes_tabs' %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:new_avalara_entity_use_code) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <li><%= link_to_with_icon 'arrow-left', Spree.t(:back_to_avalara_entity_use_codes_list), admin_avalara_entity_use_codes_path, :class => 'button' %></li>
+<% end %>
+
+
+<%= render 'spree/shared/error_messages', :target => @avalara_entity_use_code %>
+
+<%= form_for [:admin, @avalara_entity_use_code] , :html => { :multipart => true } do |f| %>
+    <%= render :partial => 'form', :locals => { :f => f } %>
+    <%= render :partial => 'spree/admin/shared/new_resource_links' %>
+<% end %>

data/app/views/spree/admin/avalara_entity_use_codes/show.html.erb

@@ -0,0 +1,24 @@
+<%= render 'spree/admin/shared/taxes_tabs' %>
+
+<h1><%= t(:avalara_entity_use_code) %></h1>
+
+<table>
+  <tr data-hook="name">
+    <th><%= t(:use_code) %></th>
+    <td>
+      <%= @avalara_entity_use_code.use_code %>
+    </td>
+  </tr>
+  <tr data-hook="description">
+    <th><%= t(:description) %></th>
+    <td>
+      <%= @avalara_entity_use_code.use_code_description %>
+    </td>
+  </tr>
+
+</table>
+
+<p>
+  <%= link_to_edit @avalara_entity_use_code, :class => 'edit_avalara_entity_use_code' %> <%= t(:or) %>
+  <%= link_to t(:back), collection_url %>
+</p>