workarea-avatax 4.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 154de54ee351747a48c10892cc8ae997fea1584ccc63388295ad304ff35e195e
+  data.tar.gz: 3a06052d7b64aebabc4648482c553ce0b4012a2db1533ec19bf691425477c377
+SHA512:
+  metadata.gz: 6b4e6f1e88d2d040c60b3f0b30b020bb31918fa02ad956ca80b58a9a663e30eaac0ab594f6a60a256ccce531e1710b63818b2d0b1696ce852eae16bde60e7dfb
+  data.tar.gz: 59a9e7d21976bd0b47e5b3c2d2345c89a793e780981a1ee548715bf173145dbf68d9cabc0775630b47b0cf910f3fb278fb2950144225d9ad202c41684b45adfa

data/.editorconfig

@@ -0,0 +1,20 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.rb,*.haml,*.decorator,*.yml,*.yaml,*.jbuilder}]
+indent_size = 2
+indent_style = space
+
+[{*.js,*.jst,*.ejs,*.scss}]
+indent_size = 4
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve Workarea
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+⚠️**Before you create**⚠️
+Please verify the issue you're experiencing is not part of your Workarea project customizations. The best way to do this is with a [vanilla Workarea installation](https://developer.workarea.com/articles/create-a-new-host-application.html). This will help us spend time on fixes/improvements for the whole community. Thank you!
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Workarea Setup (please complete the following information):**
+ - Workarea Version: [e.g. v3.4.6]
+ - Plugins [e.g. workarea-blog, workarea-sitemaps]
+
+**Attachments**
+If applicable, add any attachments to help explain your problem, things like:
+- screenshots
+- Gemfile.lock
+- test cases
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,17 @@
+---
+name: Documentation request
+about: Suggest documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Is your documentation related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm confused by [...]
+
+**Describe the article you'd like**
+A clear and concise description of what would be in the documentation article.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for Workarea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ci.yml

@@ -0,0 +1,66 @@
+name: CI
+on: [push]
+
+jobs:
+  static_analysis:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: workarea-commerce/ci/bundler-audit@v1
+      env:
+        GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_ACCESS_TOKEN }}
+    - uses: workarea-commerce/ci/rubocop@v1
+      env:
+        GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_ACCESS_TOKEN }}
+
+  admin_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:admin
+      env:
+        GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_ACCESS_TOKEN }}
+
+  core_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:core
+      env:
+        GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_ACCESS_TOKEN }}
+
+  storefront_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:storefront
+      env:
+        GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_ACCESS_TOKEN }}
+
+  plugins_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: bin/rails app:workarea:test:plugins
+      env:
+        GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_ACCESS_TOKEN }}

data/.gitignore

@@ -0,0 +1,18 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+test/dummy/public/system/workarea
+Gemfile.lock
+coverage
+.DS_Store
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from:
+  - https://raw.githubusercontent.com/workarea-commerce/workarea/master/.rubocop.yml
+
+AllCops:
+  Exclude:
+    - 'test/dummy/**/*'
+    - 'lib/workarea/payflow_pro.rb'
+    - 'lib/workarea/payflow_pro/**/*'

data/CHANGELOG.md

@@ -0,0 +1,123 @@
+Workarea Avatax 4.2.0 (2019-11-26)
+--------------------------------------------------------------------------------
+
+*   Support tax on non-shipping items
+
+    Since v3.5 supports non-shipping items natively, this checks those to
+    assign taxes from Avalara.
+    Ben Crouse
+
+
+
+Workarea Avatax 4.1.2 (2019-09-17)
+--------------------------------------------------------------------------------
+
+*   Fix when to display taxes in cart
+
+    Display taxes in cart if they have already been calculated.
+
+    AVATAX-38
+    Eric Pigeon
+
+
+
+Workarea Avatax 4.1.1 (2019-07-23)
+--------------------------------------------------------------------------------
+
+*   Pass addresses on order line items in tax request
+
+    Pass the addresses.shipTo adress on order line items when using the
+    split shipping plugin
+
+    AVATAX-34
+    Eric Pigeon
+
+
+
+Workarea Avatax 4.1.0 (2018-12-20)
+--------------------------------------------------------------------------------
+
+*   Add support for partial shippings
+
+    Update the tax request to split up order line items by
+    `Workarea::Shipping#quantities` for orders with multiple shippings
+
+    AVATAX-30
+    Eric Pigeon
+
+
+
+Workarea Avatax 4.0.1 (2018-04-24)
+--------------------------------------------------------------------------------
+
+*   Update seeds for Educational org
+
+    AVATAX-28
+    Eric Pigeon
+
+
+Workarea Avatax 4.0.0 (2018-02-20)
+--------------------------------------------------------------------------------
+
+*   Remove vendored AvaTax code, use gem from RubyGems
+
+    This had the potential to cause some issues when combining usage of the
+    workarea-avatax plugin with that of the workarea-address_verification
+    plugin.
+
+    AVATAX-27
+    Tom Scott
+
+*   Add timeout during pricing calculator
+
+    update vendored avatax gem files
+    add company code to request
+
+    AVATAX-25
+    Eric Pigeon
+
+
+Workarea Avatax 3.0.1 (2017-09-06)
+--------------------------------------------------------------------------------
+
+*   Update vendored version of avatax gem
+
+    Update vendored avatax gem. there's still some problems preventing use
+    of the cut version, notable it returning hashie mash responses instead
+    of faraday responses.  memoize .resposne on a tax request to stop it
+    from creating a transaction everytime the response is accessed.
+
+    AVATAX-22
+    Eric Pigeon
+
+*   Fix bugs with commiting a tax transaction.
+
+    Commit fixes to tax worker to use correct symbolized keys on transaction.
+    fix bug with improper response reference on the invoice worker
+
+    AVATAX-22
+    Jeff Yucis
+
+
+Workarea Avatax 3.0.0 (2017-07-06)
+--------------------------------------------------------------------------------
+
+*   Update configuration and readme
+
+    Allow the endpoint to be set via secrets so apps and easily configure
+    their staging environments.  Fix error sending money object instead of
+    string in rest call.  Add timeout to faraday
+
+    AVATAX-20
+    Eric Pigeon
+
+*   Upgrade avatax for Workarea v3
+
+    Upgrade the avatax to use the newer version 2 rest api.  They haven't
+    publicly released them gem so it's currently vendored into lib/avatax.
+    Update the tax calculator to build from price adjustments on the order
+    and store tax adjustments on the shipping to mirror how it works in
+    version 3.
+
+    AVATAX-20
+    Eric Pigeon

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+View this plugin's code of conduct here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md>

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+View this plugin's contribution guidelines here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CONTRIBUTING.md>

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'workarea', git: 'https://github.com/workarea-commerce/workarea.git'
+gem 'workarea-oms', git: "https://x-access-token:#{ENV['GITHUB_ACCESS_TOKEN']}@github.com/workarea-commerce/workarea-oms.git"
+
+group :test do
+  gem "simplecov"
+end

data/LICENSE.md

@@ -0,0 +1,3 @@
+View this plugin's license here: 
+
+<https://github.com/workarea-commerce/workarea/blob/master/LICENSE.md>

data/README.md

@@ -0,0 +1,57 @@
+# Avatax
+
+Avatax by Avalara provides a centralized service for tracking sales tax bills.
+This plugin integrates that service into the Workarea platform. Instead of using
+the Workarea platform's included sales tax caclulation system, it uses Avatax to
+calculate sales tax. After an order is placed, that order's sales tax bill is
+transmitted to Avatax. Users may choose to commit (save them so that they are
+reflected in tax liability) posted documents either via Workarea platform, or
+via their own order management system.
+
+## Features
+
+### Out of the Box
+
+* Full reporting feature with summarized and detailed reports
+* Constant real time updates with the latest rules and regulations for accuracy
+
+## Requirements
+
+* Avalara Avatax account (These values can be found in your Avalara administration console upon Registration)
+* Account Number
+* License Key
+* API URL
+* Shipping Item Code or Tax Code
+
+## Installation and Configuration
+
+### 1) Add the Application gem to your gemfile in host application
+
+```ruby
+  gem 'workarea-avatax', '~> <version>'
+```
+
+### 2) Add Avatax Secrets
+
+```ruby
+  avatax:
+    username: AVATAX_USERNAME
+    password: AVATAX_PASSWORD
+```
+
+Optionally set the endpoint to sandbox for testing.
+
+### 3) Configure the avatax plugin with the merchant's distribution center inside the host app's `config/initializers/workarea.rb` file
+
+```ruby
+  Workarea::Avatax.configure do |config|
+    config.dist_center = {
+      Line1: '1234 Your St',
+      Line2: '',
+      City: 'YourCity',
+      Region: 'Your State',
+      Country: 'US',
+      PostalCode: '123456'
+    }
+  end
+```

data/Rakefile

@@ -0,0 +1,50 @@
+#!/usr/bin/env rake
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Moneris"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+load "workarea/changelog.rake"
+
+require "rake/testtask"
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path("lib", __dir__)
+require "workarea/avatax/version"
+
+desc "Release version #{Workarea::Avatax::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  Rake::Task["workarea:changelog"].execute
+  system "git add CHANGELOG.md"
+  system 'git commit -m "Update CHANGELOG"'
+  system "git push origin HEAD"
+
+  system "git tag -a v#{Workarea::Avatax::VERSION} -m 'Tagging #{Workarea::Avatax::VERSION}'"
+  system "git push --tags"
+
+  system "gem build workarea-avatax.gemspec"
+  system "gem push workarea-avatax-#{Workarea::Avatax::VERSION}.gem"
+  system "gem push workarea-avatax-#{Workarea::Avatax::VERSION}.gem --host #{host}"
+  system "rm workarea-avatax-#{Workarea::Avatax::VERSION}.gem"
+end

data/app/models/workarea/avatax/usage_type.rb

@@ -0,0 +1,17 @@
+module Workarea
+  module Avatax
+    class UsageType
+      include ApplicationDocument
+
+      field :code,          type: String
+      field :name,          type: String, localize: true
+      field :country_codes, type: Array
+
+      validates_presence_of :code, :name, :country_codes
+
+      def countries
+        country_codes.map { |code| Country[code] }.compact
+      end
+    end
+  end
+end

data/app/models/workarea/pricing/calculators/avalara_tax_calculator.rb

@@ -0,0 +1,105 @@
+module Workarea
+  module Pricing
+    module Calculators
+      # Calculates order/shipping sales tax via the Avalara Avatax API
+      #
+      class AvalaraTaxCalculator
+        include Calculator
+
+        def adjust
+          response = Avatax::TaxRequest.new(
+            order: order,
+            shippings: shippings,
+            **request_options
+          ).response
+
+          return unless response.success?
+
+          shippings.each do |shipping|
+            next unless shipping.address.present?
+
+            price_adjustments_for(shipping).each do |adjustment|
+              tax_line = response.tax_line_for_adjustment adjustment, shipping: shipping
+              next unless tax_line.present?
+
+              adjust_pricing(
+                shipping,
+                tax_line,
+                "order_item_id" => adjustment._parent.id,
+                "adjustment" => adjustment.id
+               )
+            end
+
+            shipping_tax_line = response.tax_line_for_shipping(shipping)
+            adjust_pricing(shipping, shipping_tax_line, "shipping_service_tax" => true)
+          end
+
+          order.items.reject(&:shipping?).each do |non_shipped_item|
+            non_shipped_item.price_adjustments.each do |adjustment|
+              tax_line = response.tax_line_for_adjustment(adjustment)
+              next unless tax_line.present? && tax_line.tax.to_m > 0
+
+              data = {
+                'adjustment' => adjustment.id,
+                'order_item_id' => adjustment._parent.id,
+                'tax_code' => adjustment.data['tax_code']
+              }
+
+              non_shipped_item.adjust_pricing(
+                price: 'tax',
+                calculator: self.class.name,
+                description: 'Item Tax',
+                amount: tax_line.tax.to_m,
+                data: data.merge(find_line_details(tax_line))
+              )
+            end
+          end
+
+        rescue Faraday::Error => error
+          Raven.capture_exception(error) if defined?(Raven)
+          avatax_fallback(error)
+        end
+
+        private
+
+          def request_options
+            { timeout: 2 }
+          end
+
+          def avatax_fallback(_error)
+            Pricing::Calculators::TaxCalculator.new(request).adjust
+          end
+          alias_method :handle_timeout_error, :avatax_fallback
+
+          # If doing split shipping (different items go to different shipping
+          # addresses), decorate this method to return the proper price
+          # adjustments that match the shipping. (This will have to be added to
+          # the UI and saved, probably on the Shipping object)
+          #
+          # @return [PriceAdjustmentSet]
+          #
+          def price_adjustments_for(shipping)
+            order.price_adjustments
+          end
+
+          def adjust_pricing(shipping, tax_line, data = {})
+            return if tax_line.tax.to_m.zero?
+
+            shipping.adjust_pricing(
+              price: "tax",
+              calculator: self.class.name,
+              description: "Sales Tax",
+              amount: tax_line.tax.to_m,
+              data: data.merge(find_line_details(tax_line))
+            )
+          end
+
+          def find_line_details(tax_line)
+            tax_line.details.each_with_object({}) do |detail, memo|
+              memo[detail.taxName] = detail.rate
+            end
+          end
+      end
+    end
+  end
+end

data/app/models/workarea/user.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate User, with: :avatax do
+    decorated do
+      field :customer_usage_type, type: String, default: "TAXABLE"
+    end
+  end
+end

data/app/seeds/workarea/avatax_seeds.rb

@@ -0,0 +1,44 @@
+module Workarea
+  class AvataxSeeds
+    def perform
+      return unless AvaTax.config[:username].present? && AvaTax.config[:password].present?
+      puts "Adding Avalara Usage Types..."
+
+      result = ::AvaTax.list_entity_use_codes
+      raise "Failed to get avatax usage codes from api" unless result.success?
+
+      result.body["value"].each do |entity_use_code|
+        Workarea::Avatax::UsageType.find_or_create_by(
+          code: entity_use_code["code"],
+          name: formatted_names.fetch(entity_use_code["name"], entity_use_code["name"]),
+          country_codes: entity_use_code["validCountries"]
+        )
+      end
+    end
+
+    private
+
+      def formatted_names
+        {
+          "FEDERAL GOV"                   => "Federal Government",
+          "STATE GOV"                     => "State Government",
+          "TRIBAL GOVERNMENT"             => "Tribal Government",
+          "FOREIGN DIPLOMAT"              => "Foreign diplomat",
+          "CHARITABLE/EXEMPT ORG"         => "Charitable or excempt org",
+          "RELIGIOUS ORG"                 => "Religious or educational org",
+          "EDUCATIONAL ORG"               => "Educational org",
+          "RESALE"                        => "Resale",
+          "AGRICULTURE"                   => "Commercial agricultural production",
+          "INDUSTRIAL PROD/MANUFACTURERS" => "Industrial production / manufacturer",
+          "DIRECT PAY"                    => "Direct pay permit",
+          "DIRECT MAIL"                   => "Direct mail",
+          "OTHER/CUSTOM"                  => "Other or custom",
+          "LOCAL GOVERNMENT"              => "Local Government",
+          "COMMERCIAL AQUACULTURE"        => "Commercial aquaculture",
+          "COMMERCIAL FISHERY"            => "Commercial fishery",
+          "NON-RESIDENT"                  => "Non-resident",
+          "NON-EXEMPT TAXABLE CUSTOMER"   => "Non-excempt taxable customer"
+        }
+      end
+  end
+end

data/app/view_models/workarea/admin/user_view_model.decorator

@@ -0,0 +1,21 @@
+module Workarea
+  decorate Admin::UserViewModel, with: :avatax do
+    def avatax_usage_options
+      Avatax::UsageType.all.map do |usage_type|
+        [usage_type_display(usage_type), usage_type.code]
+      end
+    end
+
+    private
+
+    def usage_type_display(usage_type)
+      countries =
+        if usage_type.countries.empty?
+          ""
+        else
+          "(#{usage_type.countries.map(&:local_name).join(', ')})"
+        end
+      [usage_type.name, countries].compact.join(' ')
+    end
+  end
+end

data/app/view_models/workarea/storefront/cart_view_model.decorator

@@ -0,0 +1,7 @@
+module Workarea
+  decorate Storefront::CartViewModel, with: :avatax do
+    def show_taxes?
+      super && tax_total.present?
+    end
+  end
+end

data/app/views/workarea/admin/users/_avatax_properties_fields.html.haml

@@ -0,0 +1,5 @@
+.property
+  = label_tag 'user[customer_usage_type]', nil, class: 'property__name' do
+    %span.property__text= t('workarea.admin.users.edit.avatax_entity_use_code')
+  .value
+    = select_tag 'user[customer_usage_type]', options_for_select(@user.avatax_usage_options, @user.customer_usage_type)