solidus_avatax_certified 1.0.0

data/lib/solidus_avatax_certified/preference_seeder.rb

@@ -0,0 +1,69 @@
+module SolidusAvataxCertified
+  class PreferenceSeeder
+    BOOLEAN_PREFERENCES = ['log', 'address_validation', 'tax_calculation', 'document_commit', 'log_to_stdout', 'refuse_checkout_address_validation_error', 'customer_can_validate'].freeze
+    STORABLE_ENV_PREFERENCES = ['company_code', 'endpoint', 'account', 'license_key'].freeze
+
+    class << self
+
+      def seed!(print_messages=true)
+        @print_messages = print_messages
+        stored_env_prefs
+        boolean_prefs
+        enabled_countries_pref
+        origin_address
+      end
+
+      protected
+
+      def stored_env_prefs
+        STORABLE_ENV_PREFERENCES.each do |env|
+          if !ENV["AVATAX_#{env.upcase}"].blank?
+            value = ENV["AVATAX_#{env.upcase}"]
+          else
+            value = nil
+          end
+
+          pref = Spree::AvalaraPreference.new(name: env, value: value, object_type: 'string')
+
+          save_preference(pref)
+        end
+      end
+
+      def boolean_prefs
+        BOOLEAN_PREFERENCES.each do |preference|
+          if ['refuse_checkout_address_validation_error', 'log_to_stdout'].include?(preference)
+            pref = Spree::AvalaraPreference.new(name: preference, value: 'false', object_type: 'boolean')
+          else
+            pref = Spree::AvalaraPreference.new(name: preference, value: 'true', object_type: 'boolean')
+          end
+
+          save_preference(pref)
+        end
+      end
+
+      def enabled_countries_pref
+        pref = Spree::AvalaraPreference.new(name: 'address_validation_enabled_countries', value: 'United States,Canada', object_type: 'array')
+        save_preference(pref)
+      end
+
+      def origin_address
+        pref = Spree::AvalaraPreference.find_or_create_by(name: 'origin_address', object_type: 'json')
+        pref.value = "{}" if pref.value.nil?
+
+        save_preference(pref)
+      end
+
+      def save_preference(preference)
+        if preference.save
+          success_message(preference) if @print_messages
+        else
+          puts "#{preference.errors.full_messages.to_sentence}"
+        end
+      end
+
+      def success_message(preference)
+        puts "Created: #{preference.name} - #{preference.value ? preference.value : 'Please input value in avalara settings!'}"
+      end
+    end
+  end
+end

data/lib/solidus_avatax_certified/seeder.rb

@@ -0,0 +1,117 @@
+module SolidusAvataxCertified
+  class Seeder
+    class << self
+
+      def seed!
+        create_use_codes
+        create_tax
+        add_tax_category_to_shipping_methods
+        add_tax_category_to_products
+        populate_default_stock_location
+
+        puts "***** SOLIDUS AVATAX CERTIFIED *****"
+        puts ""
+        puts "Please remember to:"
+        puts "- Add tax category to all shipping methods that need to be taxed."
+        puts "- Don't assign anything default tax."
+        puts "- Assign proper Tax Category to each product"
+        puts "- Fill in Stock Location Address."
+        puts "- Fill Origin Address in Avatax Settings."
+        puts ""
+        puts "***** SOLIDUS AVATAX CERTIFIED *****"
+      end
+
+      def seed_use_codes!
+        create_use_codes
+        puts "***** SOLIDUS AVATAX CERTIFIED: Use Codes Seeded"
+      end
+
+      def create_tax
+        default_tax_category = Spree::TaxCategory.find_by(name: 'Default')
+        default_tax_rate = Spree::TaxRate.find_by(name: 'North America')
+
+        default_tax_category.destroy if default_tax_category
+        default_tax_rate.destroy if default_tax_rate
+
+        clothing = Spree::TaxCategory.find_or_create_by(name: 'Clothing')
+        clothing.update_attributes(tax_code: 'P0000000')
+        tax_zone = Spree::Zone.find_or_create_by(name: 'North America')
+        tax_calculator = Spree::Calculator::AvalaraTransaction.create!
+        sales_tax = Spree::TaxRate.find_or_create_by(name: 'Tax') do |tax_rate|
+          # default values for the create
+          tax_rate.amount = BigDecimal.new('0')
+          tax_rate.calculator = tax_calculator
+          tax_rate.tax_category = clothing
+        end
+        sales_tax.update!(tax_category: clothing, name: 'Tax', amount: BigDecimal.new('0'), zone: tax_zone, show_rate_in_label: false, calculator: tax_calculator)
+
+        shipping = Spree::TaxCategory.find_or_create_by(name: 'Shipping', tax_code: 'FR000000')
+        shipping_tax = Spree::TaxRate.find_or_create_by(name: 'Shipping Tax') do |shipping_tax|
+          shipping_tax.tax_category = shipping
+          shipping_tax.amount = BigDecimal.new('0')
+          shipping_tax.zone = tax_zone
+          shipping_tax.show_rate_in_label = false
+        end
+        shipping_tax.update!(tax_category: shipping, amount: BigDecimal.new('0'), zone: Spree::Zone.find_by_name('North America'), show_rate_in_label: false, calculator: Spree::Calculator::AvalaraTransaction.create!)
+      end
+
+      def add_tax_category_to_shipping_methods
+        Spree::ShippingMethod.update_all(tax_category_id: Spree::TaxCategory.find_by(name: 'Shipping').id)
+      end
+
+      def add_tax_category_to_products
+        Spree::Product.update_all(tax_category_id: Spree::TaxCategory.find_by(name: 'Clothing').id)
+      end
+
+      def populate_default_stock_location
+        default = Spree::StockLocation.find_or_create_by(name: 'default')
+
+        return unless default.zipcode.nil? || default.address1.nil?
+
+        state = Spree::State.find_by(name: 'Alabama')
+
+        address = {
+          address1: '915 S Jackson St',
+          city: 'Montgomery',
+          state: state,
+          country: state.country,
+          zipcode: '36104',
+          default: true,
+          name: 'default',
+          backorderable_default: true
+        }
+
+        default.update_attributes(address)
+      end
+
+      def create_use_codes
+        unless Spree::AvalaraEntityUseCode.count >= 16
+          use_codes.each do |key, value|
+            Spree::AvalaraEntityUseCode.find_or_create_by(use_code: key, use_code_description: value)
+          end
+        end
+      end
+
+      def use_codes
+        {
+          "A" => "Federal government",
+          "B" => "State government",
+          "C" => "Tribe/Status Indian/Indian Band",
+          "D" => "Foreign diplomat",
+          "E" => "Charitable or benevolent organization",
+          "F" => "Religious or educational organization",
+          "G" => "Resale",
+          "H" => "Commercial agricultural production",
+          "I" => "Industrial production/manufacturer",
+          "J" => "Direct pay permit",
+          "K" => "Direct mail",
+          "L" => "Other",
+          "N" => "Local government",
+          "P" => "Commercial aquaculture (Canada only)",
+          "Q" => "Commercial fishery (Canada only)",
+          "R" => "Non-resident (Canada only)"
+        }
+      end
+    end
+  end
+end

data/lib/solidus_avatax_certified.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'solidus_avatax_certified/engine'

data/lib/tasks/load_seeds.rake

@@ -0,0 +1,15 @@
+namespace :solidus_avatax_certified do
+  desc "Loads seed data."
+  task load_seeds: :environment do
+    SolidusAvataxCertified::Seeder.seed!
+    SolidusAvataxCertified::PreferenceSeeder.seed!
+  end
+
+  task load_preferences: :environment do
+    SolidusAvataxCertified::PreferenceSeeder.seed!
+  end
+
+  task load_use_codes: :environment do
+    SolidusAvataxCertified::Seeder.seed_use_codes!
+  end
+end

data/setup.md

@@ -0,0 +1,12 @@
+Setup Steps
+===========
+
+* Setup Avalara gem
+* Create config/initializer/avalara.rb
+* Set up avalara username, password, endpoint, and avatax origin
+
+Avatax Gem Setup
+================
+* bundle exec rails g solidus_avatax_certified:install
+* Stock location needs to be set up in order for gem to work
+* Fill in Avalara Settings information

data/solidus_avatax_certified.gemspec

@@ -0,0 +1,42 @@
+# encoding: UTF-8
+gem_version = File.read(File.expand_path('../GEM_VERSION',__FILE__)).strip
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'solidus_avatax_certified'
+  s.version     = gem_version
+  s.summary     = 'Solidus extension for Avalara tax calculation.'
+  s.description = 'Solidus extension for Avalara tax calculation.'
+  s.required_ruby_version = '>= 2.1'
+
+  s.author    = 'Allison Reilly'
+  s.email     = 'acreilly3@gmail.com'
+  s.homepage  = 'http://www.boomer.digital'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = "lib"
+  s.requirements << "none"
+
+  s.add_dependency "solidus_core", [">= 1.0.0", "< 2.1.0"]
+  s.add_dependency "json", "~> 1.8"
+  s.add_dependency "addressable", "~> 2.4"
+  s.add_dependency "rest-client", "~> 1.7"
+  s.add_dependency "logging", "~> 2.0"
+
+  s.add_development_dependency "dotenv"
+  s.add_development_dependency "rspec-rails", "~> 3.2"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "sass-rails"
+  s.add_development_dependency "coffee-rails"
+  s.add_development_dependency "factory_girl"
+  s.add_development_dependency "selenium-webdriver", "~> 2.53.4"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "capybara-screenshot"
+  s.add_development_dependency 'capybara-accessible'
+  s.add_development_dependency "database_cleaner"
+  s.add_development_dependency 'shoulda-matchers', '~> 2.7'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'webmock'
+end

data/spec/controllers/spree/admin/avalara_entity_use_codes_controller_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe Spree::Admin::AvalaraEntityUseCodesController do
+  let(:avalara_entity_use_code) { FactoryGirl.create(:avalara_entity_use_code) }
+
+  stub_authorization!
+
+  before :each do
+    DatabaseCleaner.clean
+  end
+
+  describe '#index' do
+    subject { get :index }
+
+    it { is_expected.to be_success }
+  end
+
+  describe '#show' do
+    subject { get :show, params: { id: avalara_entity_use_code.id } }
+
+    it { is_expected.to be_success }
+  end
+
+  describe '#new' do
+    subject { get :new }
+
+    it { is_expected.to be_success }
+  end
+
+  describe '#edit' do
+    subject { get :edit, params: { id: avalara_entity_use_code.id} }
+
+    it { is_expected.to be_success }
+  end
+
+  describe '#update' do
+    let(:params) do
+      {
+        id: avalara_entity_use_code.to_param,
+        avalara_entity_use_code: {
+          use_code: '55',
+        }
+      }
+    end
+    subject { put :update, params: params }
+
+    it { is_expected.to redirect_to(spree.admin_avalara_entity_use_codes_path) }
+
+    it 'should update use_code' do
+      expect{subject}.to change { avalara_entity_use_code.reload.use_code }.from('A').to('55')
+    end
+  end
+end

data/spec/controllers/spree/admin/avatax_settings_controller_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Spree::Admin::AvataxSettingsController, :type => :controller do
+
+  stub_authorization!
+
+  describe '/avatax_settings' do
+    subject { get :show }
+    it { should be_success }
+  end
+
+  describe '/avatax_settings/edit' do
+    subject { get :edit }
+    it { should be_success }
+  end
+
+  describe '/avatax_settings/get_file_post_order_to_avalara' do
+    before { File.new("#{Rails.root}/log/post_order_to_avalara.log", 'w') }
+    after { File.delete("#{Rails.root}/log/post_order_to_avalara.log") }
+
+    subject { get :get_file_post_order_to_avalara }
+    it { should be_success }
+  end
+
+  describe '/avatax_settings/erase_data' do
+    it 'erases the log' do
+      Dir.mkdir('log') unless Dir.exist?('log')
+      file = File.open("log/test.log", 'w') { |f| f.write('Hyah!') }
+
+      expect(File.read('log/test.log')).to eq('Hyah!')
+
+      get :erase_data, params: { log_name: 'test' }
+
+      expect(File.read('log/test.log')).to eq('')
+    end
+  end
+
+  describe '/avatax_settings/ping_my_service' do
+    it 'flashes message' do
+      subject { get :ping_my_service }
+      response.should be_success
+      flash.should_not be_nil
+    end
+  end
+
+  describe '#update' do
+    let(:params) do
+      {
+        address: {
+          Line1: "",
+          Line2: "",
+          City: "",
+          Region: "",
+          PostalCode: "",
+          Country: ""
+        },
+        settings: {
+          account: '123456789',
+          address_validation_enabled_countries: []
+        }
+      }
+    end
+    subject { put :update, params: params }
+
+    it { is_expected.to redirect_to(spree.admin_avatax_settings_path) }
+  end
+end

data/spec/factories/avalara_entity_use_code_factory.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :avalara_entity_use_code, class: Spree::AvalaraEntityUseCode do
+    use_code 'A'
+    use_code_description 'Federal government'
+  end
+end

data/spec/factories/avalara_factories.rb

@@ -0,0 +1,76 @@
+FactoryGirl.define do
+  factory :request_hash, class: Hash do
+    Commit false
+    CustomerCode '1'
+    DocDate '2014-11-03'
+    CompanyCode '54321'
+    CustomerUsageType ''
+    ExemptionNo nil
+    Client AVATAX_CLIENT_VERSION
+    DocCode 'R731071205'
+    ReferenceCode 'R731071205'
+    DetailLevel 'Tax'
+    DocType 'SalesOrder'
+    Discount '0.00'
+    Addresses [{:AddressCode=>'9', :Line1=>'31 South St', :City=>'Morristown', :PostalCode=>'07960', :Country=>'US'},{:AddressCode=>'Dest', :Line1=>'73 Glenmere Drive', :Line2=>'', :City=>'Chatham', :Region=>'NJ', :Country=>'US', :PostalCode=>'07928'},{:AddressCode=>'Orig', :Line1=>'73 Glenmere Drive', :City=>'Chatham', :PostalCode=>'07928', :Country=>'United States'}]
+    Lines [{:LineNo=>'1-LI', :ItemCode=>'ROR-00013', :Qty=>3, :Amount=>62.97, :OriginCode=>'9', :DestinationCode=>'Dest', :Description=>'Ruby on Rails Jr. Spaghetti', :TaxCode=>'P0000000', :Discounted=>false}]
+  end
+
+  factory :avalara_transaction_calculator, class: Spree::Calculator::AvalaraTransaction do
+  end
+end
+
+FactoryGirl.modify do
+  factory :tax_category, class: Spree::TaxCategory do
+    name { "TaxCategory - #{rand(999999)}" }
+    tax_code { 'PC030000' }
+  end
+
+  factory :address, class: Spree::Address do
+    transient do
+      country_iso_code 'US'
+      state_code 'AL'
+    end
+
+    firstname 'John'
+    lastname 'Doe'
+    company 'Company'
+    address1 '915 S Jackson St'
+    address2 ''
+    city 'Montgomery'
+    state_name 'Alabama'
+    zipcode '36104'
+    phone '555-555-0199'
+    alternative_phone '555-555-0199'
+
+    state do |address|
+      if !Spree::State.find_by(name: address.state_name).nil?
+        Spree::State.find_by(name: address.state_name)
+      else
+         address.association(:state)
+      end
+    end
+
+    country do |address|
+      if address.state
+        address.state.country
+      else
+        address.association(:country, iso: country_iso_code)
+      end
+    end
+
+  end
+
+  factory :ship_address, parent: :address do
+    address1 '915 S Jackson St'
+  end
+
+  # Adding this modifier since US country name changes between solidus versions
+  factory :country, class: Spree::Country do
+    iso_name 'UNITED STATES'
+    name 'United States'
+    iso 'US'
+    iso3 'USA'
+    numcode 840
+  end
+end

data/spec/factories/avalara_order_factory.rb

@@ -0,0 +1,62 @@
+FactoryGirl.define do
+  factory :avalara_order, class: Spree::Order do
+    user
+    bill_address
+    ship_address
+    completed_at nil
+    email { user.email }
+    store
+    state 'delivery'
+
+    transient do
+      line_items_price BigDecimal.new(10)
+      line_items_count 1
+      line_items_quantity 1
+      shipment_cost 5
+      tax_category Spree::TaxCategory.first
+      tax_included false
+    end
+
+    before(:create) do |order, evaluator|
+      if Spree::Country.count == 0
+        create(:country)
+      end
+      if Spree::Zone.find_by(name: 'GlobalZone').nil?
+        create(:global_zone, default_tax: true)
+      end
+      if Spree::TaxCategory.first.nil?
+        create(:clothing_tax_rate, tax_category: create(:tax_category), included_in_price: evaluator.tax_included)
+      else
+        create(:clothing_tax_rate, tax_category: Spree::TaxCategory.first, included_in_price: evaluator.tax_included)
+      end
+    end
+
+    after(:create) do |order, evaluator|
+      create_list(:line_item, evaluator.line_items_count, order: order, price: evaluator.line_items_price, tax_category: evaluator.tax_category, quantity: evaluator.line_items_quantity)
+      order.line_items.reload
+
+      create(:avalara_shipment, order: order, cost: evaluator.shipment_cost, tax_included: evaluator.tax_included)
+      order.shipments.reload
+
+      order.update!
+      order.next
+    end
+
+    factory :completed_avalara_order do
+      shipment_state 'shipped'
+      payment_state 'paid'
+
+      after(:create) do |order|
+        # order.refresh_shipment_rates
+        order.update_column(:completed_at, Time.now)
+        order.update_column(:state, 'complete')
+        payment = create(:credit_card_payment, amount: order.total, order: order, state: 'completed')
+
+        order.update!
+        order.next
+
+        payment.avalara_finalize
+      end
+    end
+  end
+end

data/spec/factories/avalara_preference_factory.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :avalara_preference, class: Spree::AvalaraPreference do
+    name { "AvalaraPreference - #{rand(999999)}" }
+    value '54321'
+    object_type 'string'
+  end
+end

data/spec/factories/avalara_shipment_factory.rb

@@ -0,0 +1,27 @@
+FactoryGirl.define do
+  factory :avalara_shipment, class: Spree::Shipment do
+    tracking 'U10000'
+    cost BigDecimal.new(10)
+    state 'pending'
+    order
+    stock_location
+
+    transient do
+      tax_included false
+    end
+
+    after(:create) do |shipment, evalulator|
+      shipment.add_shipping_method(create(:avalara_shipping_method, tax_included: evalulator.tax_included), true)
+
+      shipment.order.line_items.each do |line_item|
+        line_item.quantity.times do
+          shipment.inventory_units.create(
+            order_id: shipment.order_id,
+            variant_id: line_item.variant_id,
+            line_item_id: line_item.id
+          )
+        end
+      end
+    end
+  end
+end

data/spec/factories/avalara_shipping_method_factory.rb

@@ -0,0 +1,23 @@
+FactoryGirl.define do
+  factory :avalara_shipping_method, class: Spree::ShippingMethod do
+    zones { |a| [Spree::Zone.find_by(name: 'GlobalZone') || create(:zone, :with_country, default_tax: true)] }
+    name 'Avalara Ground'
+    code 'Avalara_Ground'
+    association(:calculator, factory: :shipping_calculator, strategy: :create)
+
+    transient do
+      tax_included false
+    end
+
+    before(:create) do |shipping_method, evaluator|
+      if Spree::Country.count == 0
+        create(:country)
+      end
+      shipping_tax_rate = create(:shipping_tax_rate, included_in_price: evaluator.tax_included)
+      shipping_method.tax_category = shipping_tax_rate.tax_category
+      if shipping_method.shipping_categories.empty?
+        shipping_method.shipping_categories << (Spree::ShippingCategory.first || create(:shipping_category))
+      end
+    end
+  end
+end

data/spec/factories/tax_rate_factory.rb

@@ -0,0 +1,19 @@
+FactoryGirl.define do
+  factory :clothing_tax_rate, class: Spree::TaxRate do
+    name 'Tax'
+    amount 0.0
+    tax_category { Spree::TaxCategory.find_by(tax_code: 'PC030000') || create(:tax_category) }
+    association(:calculator, factory: :avalara_transaction_calculator)
+    zone { Spree::Zone.find_or_create_by(name: 'GlobalZone') }
+    show_rate_in_label false
+  end
+
+  factory :shipping_tax_rate, class: Spree::TaxRate do
+    name 'Shipping Tax'
+    amount 0.0
+    tax_category { Spree::TaxCategory.find_by(tax_code: 'FR000000') || create(:tax_category, tax_code: 'FR000000') }
+    association(:calculator, factory: :avalara_transaction_calculator)
+    zone { Spree::Zone.find_or_create_by(name: 'GlobalZone') }
+    show_rate_in_label false
+  end
+end