solidus_avatax_certified 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a887c27e84dad711cddf9d4fb3aeae1f8f218cd
-  data.tar.gz: c0b14deafc45577a96fb16d4245b82e2e986679d
+  metadata.gz: 88d7c785ac3c5a75d216e1ceb29f7a541579be6c
+  data.tar.gz: 6d5b6363588951eeef89cbe13a747ee4c4ae29c2
 SHA512:
-  metadata.gz: 0d006929267b836849d0b4a8f552ad79ba1da794045d9b78fcd261051a53b659591374725b3f859930d9228f162c2a4b3fd45cf8273a66ae56fbdbeaccf78f65
-  data.tar.gz: b3f43090df24a9545a291b13e5f5bcce024cc70f74805430fd4f3bd73fc94b68c40acc9a7f528c64bb1796642655c05a979b4fa62e587bd58036dd821a1ec6fa
+  metadata.gz: 4831e98ede6e7d067b7d889184553261726f04faeac142133c7b53cddd19f46d1179b2ee680baf93dafbcbfd633c5edab8bcca6fc25104c96480d8d12b90067d
+  data.tar.gz: f4a2e6f51878e652053d1c2bc4f951e592a441cdf7f85cff13409a4d28403154b395304d3625991396509bf57410db61e6249612893b538bf4f5085eb7fa5308

data/.travis.yml

@@ -0,0 +1,28 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install:
+  - rvm @default,@global do gem uninstall bundler -x
+  - gem install bundler --version '~> 1.13.0'
+  - bundle --version
+before_script:
+  - sh -e /etc/init.d/xvfb start
+  - export DISPLAY=:99.0
+  - bundle exec rake test_app
+script:
+  - bundle exec rspec
+env:
+  matrix:
+    - SOLIDUS_BRANCH=v1.0 DB=postgres
+    - SOLIDUS_BRANCH=v1.1 DB=postgres
+    - SOLIDUS_BRANCH=v1.2 DB=postgres
+    - SOLIDUS_BRANCH=v1.3 DB=postgres
+    - SOLIDUS_BRANCH=v1.4 DB=postgres
+    - SOLIDUS_BRANCH=v2.0 DB=postgres
+    - SOLIDUS_BRANCH=v1.0 DB=mysql
+    - SOLIDUS_BRANCH=v1.1 DB=mysql
+    - SOLIDUS_BRANCH=v1.2 DB=mysql
+    - SOLIDUS_BRANCH=v1.3 DB=mysql
+    - SOLIDUS_BRANCH=v1.4 DB=mysql
+    - SOLIDUS_BRANCH=v2.0 DB=mysql

data/Gemfile

@@ -15,4 +15,7 @@ else
   gem "rails_test_params_backport", group: :test
 end
 
+gem 'pg'
+gem 'mysql2'
+
 gemspec

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/boomerdigital/solidus_avatax_certified.svg?branch=master)](https://travis-ci.org/boomerdigital/solidus_avatax_certified)
+
 SolidusAvataxCertified
 ===========
 
@@ -12,6 +14,8 @@ From Avalara's own explanation of the certification program:
 > Avalara’s partners who have created certified integrations for AvaTax have demonstrated that those integrations contain elements which are essential to providing customers with easy-to-use software that gives accurate sales tax calculations. The certification criteria used to demonstrate these elements are based on Avalara’s years of experience integrating into ERP, ecommerce and point-of-sale applications.
 
 
+**For Solidus versions v2.1 and up, please use branch v2.1**
+
 **[For Installation and Setup instructions, please visit our wiki.](https://github.com/boomerdigital/solidus_avatax_certified/wiki)**
 
 Testing

data/app/assets/javascripts/spree/backend/address_validator.js

@@ -37,7 +37,7 @@ AddressValidator.prototype = {
 
       $.each(["Line1", "Line2", "City", "PostalCode"], function(index, value){
         var keyVal = controller.getKeyByValue(value);
-        $(wrapper + " input[id*='" + keyVal + "']").val(data.Address[value]);
+        $(wrapper + " input[id*='" + keyVal + "']").val(data.result.Address[value]);
       }.bind(address));
 
       this.showFlash(data);

data/app/assets/javascripts/spree/frontend/address_validator.js

@@ -39,7 +39,7 @@ AddressValidator.prototype = {
 
       $.each(["Line1", "Line2", "City", "PostalCode"], function(index, value){
         var keyVal = controller.getKeyByValue(value);
-        $(wrapper + " input[id*='" + keyVal + "']").val(data.Address[value]);
+        $(wrapper + " input[id*='" + keyVal + "']").val(data.result.Address[value]);
       }.bind(address));
 
       this.showFlash(data);

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

@@ -7,20 +7,12 @@ module Spree
       def show
       end
 
-      def get_file_txt_tax_svc
-        send_file "#{Rails.root}/log/tax_svc.log"
-      end
-
-      def get_file_post_order_to_avalara
-        send_file "#{Rails.root}/log/post_order_to_avalara.log"
-      end
-
-      def get_file_avalara_order
-        send_file "#{Rails.root}/log/avalara_order.log"
+      def download_avatax_log
+        send_file "#{Rails.root}/log/avatax.log"
       end
 
       def erase_data
-        File.open("log/#{params['log_name']}.log", 'w') {}
+        File.open("log/avatax.log", 'w') {}
 
         head :ok
       end
@@ -67,10 +59,10 @@ module Spree
       private
 
       def load_avatax_origin
-        if Spree::AvalaraPreference.origin_address.value.blank?
+        if Spree::Avatax::Config.origin.blank?
           @avatax_origin = {}
         else
-          @avatax_origin = JSON.parse(Spree::AvalaraPreference.origin_address.value)
+          @avatax_origin = JSON.parse(Spree::Avatax::Config.origin)
         end
       end
 

data/app/models/solidus_avatax_certified/address.rb

@@ -10,7 +10,7 @@ module SolidusAvataxCertified
     def initialize(order)
       @order = order
       @ship_address = order.ship_address
-      @origin_address = JSON.parse(Spree::AvalaraPreference.origin_address.value)
+      @origin_address = JSON.parse(Spree::Avatax::Config.origin)
       @addresses = []
 
       build_addresses
@@ -20,8 +20,6 @@ module SolidusAvataxCertified
       origin_address
       order_ship_address unless @ship_address.nil?
       origin_ship_addresses
-
-      logger.debug @addresses
     end
 
     def origin_address
@@ -81,15 +79,11 @@ module SolidusAvataxCertified
 
     def validation_response(address)
       validator = TaxSvc.new
-      validator.validate_address(address)
+      validator.validate_address(address).validation_result
     end
 
     def stock_loc_ids
       order.shipments.pluck(:stock_location_id).uniq
     end
-
-    def logger
-      @logger ||= SolidusAvataxCertified::AvataxLog.new('avalara_order_addresses', 'SolidusAvataxCertified::Address', "Building Addresses for Order#: #{order.number}")
-    end
   end
 end

data/app/models/solidus_avatax_certified/avatax_log.rb

@@ -1,9 +1,9 @@
 module SolidusAvataxCertified
   class AvataxLog
-    def initialize(path_name, file_name, log_info = nil, schedule = nil)
-      if !Spree::AvalaraPreference.log_to_stdout.is_true?
+    def initialize(file_name, log_info = nil, schedule = nil)
+      if !Spree::Avatax::Config.log_to_stdout
         schedule = 'weekly' unless schedule != nil
-        @logger ||= Logger.new("#{Rails.root}/log/#{path_name}.log", schedule)
+        @logger ||= Logger.new("#{Rails.root}/log/avatax.log", schedule)
         progname(file_name.split('/').last.chomp('.rb'))
         info(log_info) unless log_info.nil?
       else
@@ -17,7 +17,7 @@ module SolidusAvataxCertified
     end
 
     def enabled?
-      Spree::AvalaraPreference.log.is_true? || Spree::AvalaraPreference.log_to_stdout.is_true?
+      Spree::Avatax::Config.log || Spree::Avatax::Config.log_to_stdout
     end
 
     def progname(progname = nil)
@@ -26,11 +26,9 @@ module SolidusAvataxCertified
       end
     end
 
-    def info(log_info = nil)
+    def info(message, obj = nil)
       if enabled?
-        unless log_info.nil?
-          logger.info "[AVATAX] #{log_info}"
-        end
+        logger.info "[AVATAX] #{message} #{obj}"
       end
     end
 
@@ -46,23 +44,15 @@ module SolidusAvataxCertified
     end
 
 
-    def debug(obj, text = nil)
+    def debug(obj, message='')
       if enabled?
-        logger.debug "[AVATAX] #{obj.inspect}"
-        if text.nil?
-          obj
-        else
-          logger.debug "[AVATAX] text"
-          text
-        end
+        logger.debug "[AVATAX] #{message} #{obj.inspect}"
       end
     end
 
-    def error(log_info = nil)
+    def error(obj, message='')
       if enabled?
-        unless log_info.nil?
-          logger.error "[AVATAX] #{log_info}"
-        end
+        logger.error "[AVATAX] #{message} #{obj}"
       end
     end
   end

data/app/models/solidus_avatax_certified/line.rb

@@ -18,8 +18,6 @@ module SolidusAvataxCertified
         item_lines_array
         shipment_lines_array
       end
-
-      logger.debug @lines
     end
 
     def item_line(line_item)
@@ -133,10 +131,6 @@ module SolidusAvataxCertified
       line_item.adjustments.promotion.eligible.any? || order.adjustments.promotion.eligible.any?
     end
 
-    def logger
-      @logger ||= SolidusAvataxCertified::AvataxLog.new('avalara_order_lines', 'SolidusAvataxCertified::Line', "Building Lines for Order#: #{order.number}")
-    end
-
     def tax_included_in_price?(item)
       # Need better error handling
       # if no tax rates, raise error tax rates needs to be set up

data/app/models/solidus_avatax_certified/preference_updater.rb

@@ -7,56 +7,39 @@ module SolidusAvataxCertified
     end
 
     def update
+      update_storable_settings
+      update_boolean_settings
       update_validation_enabled_countries
       update_origin_address
-      update_stored_preferences
-      update_boolean_preferences
     end
 
     private
 
-    def update_stored_preferences
-      Spree::AvalaraPreference.storable_envs.each do |preference|
-        if !ENV["AVATAX_#{preference.name.upcase}"].blank?
-          update_value(preference, ENV["AVATAX_#{preference.name.upcase}"])
-        else
-          update_value(preference, @avatax_preferences[preference.name.downcase])
-        end
+    def update_boolean_settings
+      Spree::AvataxConfiguration.boolean_preferences.each do |key|
+        Spree::Avatax::Config[key.to_sym] = @avatax_preferences[key] || false
       end
     end
 
-    def update_boolean_preferences
-      Spree::AvalaraPreference.booleans.each do |boolean|
-        if !@avatax_preferences[boolean.name].nil?
-          update_value(boolean, 'true')
-        else
-          update_value(boolean, 'false')
-        end
+    def update_storable_settings
+      Spree::AvataxConfiguration.storable_env_preferences.each do |key|
+        Spree::Avatax::Config[key.to_sym] = @avatax_preferences[key] || ENV["AVATAX_#{key.upcase}"]
       end
     end
 
+
     def update_origin_address
       set_region
       set_country
-      update_value(Spree::AvalaraPreference.origin_address, @avatax_origin.to_json)
+      Spree::Avatax::Config.origin = @avatax_origin.to_json
     end
 
     def update_validation_enabled_countries
       if @avatax_preferences['address_validation_enabled_countries'].present?
-        update_value(Spree::AvalaraPreference.validation_enabled_countries, @avatax_preferences['address_validation_enabled_countries'].join(','))
-      end
-    end
-
-    def update_value(preference, param)
-      if value_changed?(preference, param)
-        preference.update_attributes(value: param)
+        Spree::Avatax::Config.address_validation_enabled_countries = @avatax_preferences['address_validation_enabled_countries']
       end
     end
 
-    def value_changed?(preference, param)
-      preference.value != param
-    end
-
     def set_region
       region = @avatax_origin['Region']
       unless region.blank?

data/app/models/solidus_avatax_certified/request/base.rb

@@ -0,0 +1,64 @@
+module SolidusAvataxCertified
+  module Request
+    class Base
+      attr_reader :order, :request
+
+      def initialize(order, opts={})
+        @order = order
+        @doc_type = opts[:doc_type]
+        @commit = opts[:commit]
+        @request = {}
+      end
+
+      def generate
+        raise 'Method needs to be implemented in subclass.'
+      end
+
+      protected
+
+      def base_tax_hash
+        {
+          CustomerCode: customer_code,
+          CompanyCode: company_code,
+          CustomerUsageType: order.customer_usage_type,
+          ExemptionNo: order.user.try(:exemption_number),
+          Client:  avatax_client_version,
+          ReferenceCode: order.number,
+          DetailLevel: 'Tax',
+          CurrencyCode: order.currency
+        }
+      end
+
+       # If there is a vat id, set BusinessIdentificationNo
+      def check_vat_id
+        if !business_id_no.blank?
+          @request[:BusinessIdentificationNo] = business_id_no
+        end
+      end
+
+      def address_lines
+        @address_lines ||= SolidusAvataxCertified::Address.new(order).addresses
+      end
+
+      def sales_lines
+        @sales_lines ||= SolidusAvataxCertified::Line.new(order, @doc_type).lines
+      end
+
+      def company_code
+        @company_code ||= Spree::Avatax::Config.company_code
+      end
+
+      def business_id_no
+        order.user.try(:vat_id)
+      end
+
+      def customer_code
+        order.user ? order.user.id : order.email
+      end
+
+      def avatax_client_version
+        AVATAX_CLIENT_VERSION || 'a0o33000004FH8l'
+      end
+    end
+  end
+end

data/app/models/solidus_avatax_certified/request/cancel_tax.rb

@@ -0,0 +1,14 @@
+module SolidusAvataxCertified
+  module Request
+    class CancelTax < SolidusAvataxCertified::Request::Base
+      def generate
+        @request = {
+          CompanyCode: company_code,
+          DocType: @doc_type,
+          DocCode: order.number,
+          CancelCode: 'DocVoided'
+        }
+      end
+    end
+  end
+end

data/app/models/solidus_avatax_certified/request/get_tax.rb

@@ -0,0 +1,27 @@
+module SolidusAvataxCertified
+  module Request
+    class GetTax < SolidusAvataxCertified::Request::Base
+      def generate
+        @request = {
+          DocCode: order.number,
+          DocDate: doc_date,
+          Discount: order.all_adjustments.promotion.eligible.sum(:amount).abs.to_s,
+          Commit: @commit,
+          DocType: @doc_type ? @doc_type : 'SalesOrder',
+          Addresses: address_lines,
+          Lines: sales_lines
+        }.merge(base_tax_hash)
+
+        check_vat_id
+
+        @request
+      end
+
+      protected
+
+      def doc_date
+        order.completed? ? order.completed_at.strftime('%F') : Date.today.strftime('%F')
+      end
+    end
+  end
+end

data/app/models/solidus_avatax_certified/request/return_tax.rb

@@ -0,0 +1,50 @@
+module SolidusAvataxCertified
+  module Request
+    class ReturnTax < SolidusAvataxCertified::Request::Base
+
+      def initialize(order, opts={})
+        super
+        @refund = opts[:refund]
+      end
+
+      def generate
+        @request = {
+          DocCode: order.number.to_s + '.' + @refund.id.to_s,
+          DocDate: Date.today.strftime('%F'),
+          Commit: @commit,
+          DocType: @doc_type ? @doc_type : 'ReturnOrder',
+          Addresses: address_lines,
+          Lines: sales_lines
+        }.merge(base_tax_hash)
+
+        check_vat_id
+
+        @request
+      end
+
+      protected
+
+      def doc_date
+        Date.today.strftime('%F')
+      end
+
+      def base_tax_hash
+        super.merge(tax_override)
+      end
+
+      def tax_override
+        {
+          TaxOverride: {
+            TaxOverrideType: 'TaxDate',
+            Reason: @refund.try(:reason).try(:name).limit(255) || 'Return',
+            TaxDate: order.completed_at.strftime('%F')
+          }
+        }
+      end
+
+      def sales_lines
+        @sales_lines ||= SolidusAvataxCertified::Line.new(order, @doc_type, @refund).lines
+      end
+    end
+  end
+end

data/app/models/solidus_avatax_certified/response/address_validation.rb

@@ -0,0 +1,11 @@
+module SolidusAvataxCertified
+  module Response
+    class AddressValidation < SolidusAvataxCertified::Response::Base
+      alias :validation_result :result
+
+      def description
+        'Address Validation'
+      end
+    end
+  end
+end

data/app/models/solidus_avatax_certified/response/base.rb

@@ -0,0 +1,25 @@
+module SolidusAvataxCertified
+  module Response
+    class Base
+      attr_accessor :result
+      # To Do
+      # 1. Create way to display errors cleanly
+
+      def initialize(result)
+        @result = result
+      end
+
+      def success?
+        result['ResultCode'] == 'Success'
+      end
+
+      def error?
+        !success? rescue true
+      end
+
+      def description
+        raise 'Method needs to be implemented in subclass.'
+      end
+    end
+  end
+end

data/app/models/solidus_avatax_certified/response/cancel_tax.rb

@@ -0,0 +1,15 @@
+module SolidusAvataxCertified
+  module Response
+    class CancelTax < SolidusAvataxCertified::Response::Base
+      alias :tax_result :result
+
+      def initialize(result)
+        @result = result['CancelTaxResult']
+      end
+
+      def description
+        'Cancel Tax'
+      end
+    end
+  end
+end

data/app/models/solidus_avatax_certified/response/get_tax.rb

@@ -0,0 +1,11 @@
+module SolidusAvataxCertified
+  module Response
+    class GetTax < SolidusAvataxCertified::Response::Base
+      alias :tax_result :result
+
+      def description
+        'Get Tax'
+      end
+    end
+  end
+end

data/app/models/spree/address_decorator.rb

@@ -1,6 +1,6 @@
 Spree::Address.class_eval do
   def validation_enabled?
-    Spree::AvalaraPreference.address_validation.is_true? && country_validation_enabled?
+    Spree::Avatax::Config.address_validation && country_validation_enabled?
   end
 
   def country_validation_enabled?
@@ -8,6 +8,6 @@ Spree::Address.class_eval do
   end
 
   def self.validation_enabled_countries
-    Spree::AvalaraPreference.validation_enabled_countries_array
+    Spree::Avatax::Config.address_validation_enabled_countries
   end
 end

data/app/models/spree/adjustment_decorator.rb

@@ -1,6 +1,4 @@
 Spree::Adjustment.class_eval do
-  scope :not_tax, -> { where.not(source_type: 'Spree::TaxRate') }
-
   def avatax_cache_key
     key = ['Spree::Adjustment']
     key << self.id