solidus_avatax_certified 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7a887c27e84dad711cddf9d4fb3aeae1f8f218cd
+  data.tar.gz: c0b14deafc45577a96fb16d4245b82e2e986679d
+SHA512:
+  metadata.gz: 0d006929267b836849d0b4a8f552ad79ba1da794045d9b78fcd261051a53b659591374725b3f859930d9228f162c2a4b3fd45cf8273a66ae56fbdbeaccf78f65
+  data.tar.gz: b3f43090df24a9545a291b13e5f5bcce024cc70f74805430fd4f3bd73fc94b68c40acc9a7f528c64bb1796642655c05a979b4fa62e587bd58036dd821a1ec6fa

data/.env_example

@@ -0,0 +1,4 @@
+AVATAX_COMPANY_CODE =
+AVATAX_ENDPOINT = https://development.avalara.net
+AVATAX_ACCOUNT =
+AVATAX_LICENSE_KEY =

data/.gitignore

@@ -0,0 +1,16 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+.env
+log/*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+-f documentation
+-r spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/GEM_VERSION

@@ -0,0 +1 @@
+1.0.0

data/Gemfile

@@ -0,0 +1,18 @@
+source "https://rubygems.org"
+
+branch = ENV.fetch('SOLIDUS_BRANCH', 'v2.0')
+gem "solidus", github: "solidusio/solidus", branch: branch
+gem "solidus_auth_devise", github: "solidusio/solidus_auth_devise"
+
+group :test, :development do
+  gem "pry"
+end
+
+if branch == 'master' || branch >= "v2.0"
+  gem "rails-controller-testing", group: :test
+else
+  gem "rails", '~> 4.2.7' # workaround for bundler resolution issue
+  gem "rails_test_params_backport", group: :test
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2016 [name of plugin creator]
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,27 @@
+SolidusAvataxCertified
+===========
+
+SolidusAvataxCertified is the *only* [officially certified Avatax solution](http://www.avalara.com/avalara-certified/) that integrates with Solidus.  With this extension you can add instantaneous sales tax decisions to your store.
+
+From Avalara's own explanation of the certification program:
+
+> Relax. It’s certified.
+>
+> Our “Certified for AvaTax” Program features integrations that perform at the highest level, providing the best possible customer experience.
+
+> 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 Installation and Setup instructions, please visit our wiki.](https://github.com/boomerdigital/solidus_avatax_certified/wiki)**
+
+Testing
+-------
+
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+
+    $ bundle
+    $ bundle exec rake test_app
+    $ bundle exec rspec spec
+
+Copyright (c) 2016 Boomer Digital LLC, released under the New BSD License
+

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default do
+  if Dir["spec/dummy"].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir("../../")
+  end
+  Rake::Task[:spec].invoke
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus_avatax_certified'
+  Rake::Task['extension:test_app'].invoke
+end

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

@@ -0,0 +1,84 @@
+Spree.ready(function(){
+  validator = new AddressValidator();
+  validator.bindListeners();
+});
+
+function AddressValidator(){
+  this.lineHash = {
+    address1: "Line1",
+    address2: "Line2",
+    city: "City",
+    zipcode: "PostalCode",
+    country: "Country",
+    state: "Region"
+  };
+}
+
+AddressValidator.prototype = {
+  bindListeners: function(){
+    $(".address_validator").on("click", this.validate.bind(this));
+  },
+  validate: function(){
+    event.preventDefault();
+    var address = this.formatAddress();
+
+    $.ajax({
+      url: Spree.routes.validate_address,
+      data: {
+        address: address
+      }
+    }).done(function(data){
+      var controller = this;
+      var wrapper = controller.addressWrapper();
+
+      if (data['ResultCode'] === 'Error') {
+        return this.showFlash(data);
+      }
+
+      $.each(["Line1", "Line2", "City", "PostalCode"], function(index, value){
+        var keyVal = controller.getKeyByValue(value);
+        $(wrapper + " input[id*='" + keyVal + "']").val(data.Address[value]);
+      }.bind(address));
+
+      this.showFlash(data);
+    }.bind(this));
+  },
+  formatAddress: function() {
+    var address = {};
+    controller = this;
+    var wrapper = controller.addressWrapper();
+
+    $(wrapper + " input").not("[name$='name]']").not("[class*=select2]").each(function(){
+      var id = $(this).attr("id");
+      var line = controller.lineHash[id.split("_").pop()];
+      address[line] = $(this).val();
+    });
+
+    $(wrapper + " select.select2").each(function(){
+      var line = controller.lineHash[$(this).attr("id")];
+      address[line] = $(this).select2("val");
+    });
+
+    return address;
+  },
+  getKeyByValue: function(value) {
+    return Object.keys(this.lineHash).find(function(key){ return this[key] === value}.bind(this.lineHash));
+  },
+  showFlash: function(data){
+    var resultCode = data.ResultCode.toLowerCase();
+
+    if(resultCode === "success") {
+      window.show_flash("success", "Address Validation Successful");
+    } else {
+      details = $(data['Messages']).map(function(){return this['Summary']}).get().join(' ');
+      window.show_flash("error", "Address Validation Error: " + details);
+    }
+  },
+  addressWrapper: function(){
+    if($("#shipping").length != 0){
+      return "#shipping";
+    } else {
+      return "#business-address";
+    }
+  }
+}

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

@@ -0,0 +1,5 @@
+//= require spree/backend/use_code_picker
+//= require spree/backend/address_validator
+
+Spree.routes.use_code_search = Spree.pathFor("admin/avalara_entity_use_codes")
+Spree.routes.validate_address = Spree.pathFor("admin/avatax_settings/validate_address")

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

@@ -0,0 +1,51 @@
+$.fn.usecodeAutocomplete = function () {
+  'use strict';
+
+  this.select2({
+    minimumInputLength: 1,
+    multiple: false,
+    initSelection: function (element, callback) {
+      Spree.ajax({
+        url: Spree.routes.use_code_search,
+        data: {
+          ids: element.val()
+        },
+        success: function(data) {
+          callback(data[0]);
+        }
+      })
+    },
+    ajax: {
+      url: Spree.routes.use_code_search,
+      datatype: 'json',
+      data:  function (term) {
+        return {
+          q: term
+        };
+      },
+      results: function (data) {
+        return {
+          results: data
+        };
+      }
+    },
+    formatResult: function (use_codes) {
+      if( !use_codes.use_code ){
+        return "Enter Avalara Entity Use Code"
+      } else {
+        return use_codes.use_code + ') Description: ' + use_codes.use_code_description;
+      }
+    },
+    formatSelection: function (use_codes) {
+      if( !use_codes.use_code ){
+        return "Enter Avalara Entity Use Code"
+      } else {
+        return use_codes.use_code + ') Description: ' + use_codes.use_code_description;
+      }
+    }
+  });
+};
+
+$(document).ready(function () {
+  $('.use_code_picker').usecodeAutocomplete();
+});

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

@@ -0,0 +1,87 @@
+Spree.ready(function(){
+  validator = new AddressValidator();
+  validator.bindListeners();
+});
+
+function AddressValidator(){
+  this.lineHash = {
+    address1: "Line1",
+    address2: "Line2",
+    city: "City",
+    zipcode: "PostalCode",
+    country: "Country",
+    state: "Region"
+  };
+}
+
+AddressValidator.prototype = {
+  bindListeners: function(){
+    $(".address_validator").on("click", this.validate.bind(this));
+  },
+  validate: function(){
+    event.preventDefault();
+    $("#checkout_form_address").validate().form();
+    var address = this.formatAddress();
+
+    $.ajax({
+      url: Spree.routes.validate_address,
+      data: {
+        address: address,
+        state: "address"
+      }
+    }).done(function(data){
+      var controller = this;
+      var wrapper = controller.addressWrapper();
+
+      if (data['ResultCode'] === 'Error') {
+        return this.showFlash(data);
+      }
+
+      $.each(["Line1", "Line2", "City", "PostalCode"], function(index, value){
+        var keyVal = controller.getKeyByValue(value);
+        $(wrapper + " input[id*='" + keyVal + "']").val(data.Address[value]);
+      }.bind(address));
+
+      this.showFlash(data);
+    }.bind(this));
+  },
+  formatAddress: function() {
+    var address = {};
+    controller = this;
+    var wrapper = controller.addressWrapper();
+
+    $(wrapper + " input").not("select").each(function(){
+      var id = $(this).attr("id");
+      var line = controller.lineHash[id.split("_").pop()];
+      address[line] = $(this).val();
+    });
+
+    $(wrapper + " select").each(function(){
+      var id = $(this).attr("id");
+      var line = controller.lineHash[id.slice(0, -3).split("_").pop()];
+      address[line] = $(this).val();
+    });
+
+    return address;
+  },
+  getKeyByValue: function(value) {
+    return Object.keys(this.lineHash).find(function(key){ return this[key] === value}.bind(this.lineHash));
+  },
+  showFlash: function(data){
+    var resultCode = data.ResultCode.toLowerCase();
+
+    if(resultCode === "success") {
+      window.show_flash("success", "Address Validation Successful");
+    } else {
+      details = $(data['Messages']).map(function(){return this['Summary']}).get().join(' ');
+      window.show_flash("error", "Address Validation Error: " + details);
+    }
+  },
+  addressWrapper: function(){
+    if($("#order_use_billing").is(":checked")){
+      return "#billing";
+    } else {
+      return "#shipping";
+    }
+  }
+}

data/app/assets/javascripts/spree/frontend/flash.js.coffee

@@ -0,0 +1,26 @@
+showTime = 5000
+fadeOutTime = 500
+
+Spree.ready ($) ->
+  # Make flash messages dissapear
+  # We only want to target the flash messages which are initially on the page.
+  # Otherwise we risk hiding messages added by show_flash
+  $initialFlash = $(".flash")
+  setTimeout (->
+    $initialFlash.fadeOut(fadeOutTime)
+  ), showTime
+
+window.show_flash = (type, message) ->
+  $addressValidator = $('.address_validator')
+
+  if type == 'success'
+    $addressValidator.attr('disabled', true).text(message).addClass('flash success disabled')
+  else
+    $flashWrapper = $(".js-flash-wrapper")
+    if $flashWrapper.length == 0
+      $addressValidator.before("<div class=\"js-flash-wrapper\" />")
+      $flashWrapper = $(".js-flash-wrapper")
+    $flashWrapper.empty()
+    flash_div = $("<div class='flash " + type + "' />")
+    $flashWrapper.prepend(flash_div)
+    flash_div.html(message).show().delay(showTime).fadeOut(fadeOutTime)

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

@@ -0,0 +1,4 @@
+//= require spree/frontend/address_validator
+//= require spree/frontend/flash
+
+Spree.routes.validate_address = Spree.pathFor("checkout/validate_address")

data/app/assets/stylesheets/spree/backend/solidus_avatax_certified.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

data/app/assets/stylesheets/spree/frontend/solidus_avatax_certified.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

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

@@ -0,0 +1,15 @@
+module Spree
+  module Admin
+    class AvalaraEntityUseCodesController < Spree::Admin::ResourceController
+
+      def index
+        @avalara_entity_use_codes = Spree::AvalaraEntityUseCode.all
+
+        respond_to do |format|
+          format.html
+          format.json { render json: @avalara_entity_use_codes }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+module Spree
+  module Admin
+    class AvataxSettingsController < Spree::Admin::BaseController
+
+      before_action :load_avatax_origin, only: [:show, :edit]
+
+      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"
+      end
+
+      def erase_data
+        File.open("log/#{params['log_name']}.log", 'w') {}
+
+        head :ok
+      end
+
+      def ping_my_service
+        mytax = TaxSvc.new
+        pingResult = mytax.ping
+        if pingResult['ResultCode'] == 'Success'
+          flash[:success] = 'Ping Successful'
+
+        else
+          flash[:error] = 'Ping Error'
+        end
+
+        respond_to do |format|
+          format.js
+        end
+      end
+
+      def validate_address
+        mytax = TaxSvc.new
+        address = permitted_address_validation_attrs
+
+        address['Country'] = Spree::Country.find_by(id: address['Country']).try(:iso)
+        address['Region'] = Spree::State.find_by(id: address['Region']).try(:abbr)
+
+        response = mytax.validate_address(address)
+
+        respond_to do |format|
+          format.json { render json: response }
+        end
+      end
+
+      def update
+        updater = SolidusAvataxCertified::PreferenceUpdater.new(params)
+        if updater.update
+          redirect_to admin_avatax_settings_path
+        else
+          flash[:error] = 'There was an error updating your Avalara Preferences'
+          redirect_to :back
+        end
+      end
+
+      private
+
+      def load_avatax_origin
+        if Spree::AvalaraPreference.origin_address.value.blank?
+          @avatax_origin = {}
+        else
+          @avatax_origin = JSON.parse(Spree::AvalaraPreference.origin_address.value)
+        end
+      end
+
+      def permitted_address_validation_attrs
+        params['address'].permit(:Line1, :Line2, :City, :PostalCode, :Country, :Region).to_h
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+Spree::Admin::UsersController.class_eval do
+  def avalara_information
+    if request.put?
+      if @user.update_attributes(user_params)
+        flash.now[:success] = Spree.t(:account_updated)
+      end
+    end
+
+    render :avalara_information
+  end
+end

data/app/controllers/spree/checkout_controller_decorator.rb

@@ -0,0 +1,22 @@
+Spree::CheckoutController.class_eval do
+  def validate_address
+    mytax = TaxSvc.new
+    address = permitted_address_validation_attrs
+
+    address['Country'] = Spree::Country.find_by(id: address['Country']).try(:iso)
+    address['Region'] = Spree::State.find_by(id: address['Region']).try(:abbr)
+
+    response = mytax.validate_address(address)
+
+    respond_to do |format|
+      format.json { render json: response }
+    end
+  end
+
+
+  private
+
+  def permitted_address_validation_attrs
+    params['address'].permit(:Line1, :Line2, :City, :PostalCode, :Country, :Region).to_h
+  end
+end

data/app/models/solidus_avatax_certified/address.rb

@@ -0,0 +1,95 @@
+require 'json'
+require 'net/http'
+require 'base64'
+require 'logger'
+
+module SolidusAvataxCertified
+  class Address
+    attr_reader :order, :addresses
+
+    def initialize(order)
+      @order = order
+      @ship_address = order.ship_address
+      @origin_address = JSON.parse(Spree::AvalaraPreference.origin_address.value)
+      @addresses = []
+
+      build_addresses
+    end
+
+    def build_addresses
+      origin_address
+      order_ship_address unless @ship_address.nil?
+      origin_ship_addresses
+
+      logger.debug @addresses
+    end
+
+    def origin_address
+      addresses << {
+        AddressCode: 'Orig',
+        Line1: @origin_address['Line1'],
+        Line2: @origin_address['Line2'],
+        City: @origin_address['City'],
+        Region: @origin_address['Region'],
+        PostalCode: @origin_address['PostalCode'],
+        Country: @origin_address['Country']
+      }
+    end
+
+    def order_ship_address
+      addresses << {
+        AddressCode: 'Dest',
+        Line1: @ship_address.address1,
+        Line2: @ship_address.address2,
+        City: @ship_address.city,
+        Region: @ship_address.state_name,
+        Country: @ship_address.country.try(:iso),
+        PostalCode: @ship_address.zipcode
+      }
+    end
+
+    def origin_ship_addresses
+      Spree::StockLocation.where(id: stock_loc_ids).each do |stock_location|
+        addresses << {
+          AddressCode: "#{stock_location.id}",
+          Line1: stock_location.address1,
+          Line2: stock_location.address2,
+          City: stock_location.city,
+          PostalCode: stock_location.zipcode,
+          Country: stock_location.country.try(:iso)
+        }
+      end
+    end
+
+    def validate
+      return 'Address validation disabled' unless @ship_address.validation_enabled?
+      return @ship_address if @ship_address.nil?
+
+      address_hash = {
+        Line1: @ship_address.address1,
+        Line2: @ship_address.address2,
+        City: @ship_address.city,
+        Region: @ship_address.state.try(:abbr),
+        Country: @ship_address.country.try(:iso),
+        PostalCode: @ship_address.zipcode
+      }
+
+      validation_response(address_hash)
+    end
+
+    private
+
+    def validation_response(address)
+      validator = TaxSvc.new
+      validator.validate_address(address)
+    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