solidus_tax_cloud 1.0.0

data/spec/models/tax_cloud_api_spec.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# This spec ensures that the low-level TaxCloud API returns the values specified by the TaxCloud Implementation Guide.
+# If any errors are found in the Solidus-related feature specs, this will serve as a means for verifying whether the errors
+# are coming from the TaxCloud gem or API, or whether they are related to the Solidus integration specifically.
+
+describe 'Models' do
+  origin = TaxCloud::Address.new(address1: '3121 West Government Way', city: 'Seattle', state: 'WA', zip5: '98199', zip4: '1402')
+
+  it 'TaxCloud Test Case 1a: Verify Address with error' do
+    destination = TaxCloud::Address.new(address1: '1 3rd Street', city: 'Seattle', state: 'WA', zip5: '98001')
+    cart_items = []
+    cart_items << TaxCloud::CartItem.new(index: 0, item_id: 'TestItem1', tic: '00000', quantity: 1, price: 10.00)
+    transaction = test_transaction(cart_items, origin, destination)
+
+    result = transaction.lookup
+
+    # From TaxCloud:
+    # This address will not verify correctly (the VerifyAddress API call will return an error).
+    # That is okay. Occasionally an address cannot be verified. When that happens, pass the
+    # destination address as originally entered to Lookup. The address can still be passed to
+    # Lookup. The only error that should prevent an order from proceeding is when a customer
+    # provided zip code does not exist within the customer provided state (discussed later in Test
+    # Case 7, Handling Errors).
+
+    expect { destination.verify }.to raise_error(TaxCloud::Errors::ApiError)
+
+    expect(result.cart_items.size).to eq 1
+    expect(result.cart_items.first.cart_item_index).to eq 0
+    expect(result.cart_items.first.tax_amount).to eq 0.99
+  end
+
+  it 'TaxCloud Test Case 1b: Verify Address without error' do
+    destination = TaxCloud::Address.new(address1: '16422 SE 128th St', city: 'Renton', state: 'WA', zip5: '98059')
+    cart_items = []
+    cart_items << TaxCloud::CartItem.new(index: 0, item_id: 'TestItem2', tic: '00000', quantity: 1, price: 10.00)
+    transaction = test_transaction(cart_items, origin, destination)
+
+    result = transaction.lookup
+
+    # From TaxCloud:
+    # The destination address used as-is will not give the most accurate rate ($1.00 in tax).
+    # The verified address will have a Plus4 Zip Code of 98059-8625 give a correct result
+    # ($0.86 in tax).
+
+    expect(result.cart_items.size).to eq 1
+    expect(result.cart_items.first.cart_item_index).to eq 0
+    expect(result.cart_items.first.tax_amount).to eq 0.86
+  end
+
+  it 'TaxCloud Test Case 2a: If all items in cart are tax exempt, shipping is not taxed (in some states)' do
+    destination = TaxCloud::Address.new(address1: '75 Rev Martin Luther King Jr Drive', city: 'St. Paul', state: 'MN', zip5: '55155')
+    cart_items = []
+    cart_items << TaxCloud::CartItem.new(index: 0, item_id: 'Shirt001', tic: '20010', quantity: 1, price: 10.00)
+    cart_items << TaxCloud::CartItem.new(index: 1, item_id: 'Shipping', tic: '11010', quantity: 1, price: 10.00)
+    transaction = test_transaction(cart_items, origin, destination)
+
+    result = transaction.lookup
+
+    expect(result.cart_items.size).to eq 2
+    expect(result.cart_items.detect { |i| i.cart_item_index == 0 }.tax_amount).to eq 0
+    expect(result.cart_items.detect { |i| i.cart_item_index == 1 }.tax_amount).to eq 0
+
+    # capture = transaction.authorized_with_capture
+    # expect(capture).to eq('OK')
+  end
+
+  it 'TaxCloud Test Case 2b: With both taxable and tax exempt items, shipping is taxable' do
+    destination = TaxCloud::Address.new(address1: '75 Rev Martin Luther King Jr Drive', city: 'St. Paul', state: 'MN', zip5: '55155')
+    cart_items = []
+    cart_items << TaxCloud::CartItem.new(index: 0, item_id: 'Shirt001', tic: '20010', quantity: 1, price: 10.00)
+    cart_items << TaxCloud::CartItem.new(index: 1, item_id: 'Gadget001', tic: '00000', quantity: 1, price: 10.00)
+    cart_items << TaxCloud::CartItem.new(index: 2, item_id: 'Shipping', tic: '11010', quantity: 1, price: 10.00)
+    transaction = test_transaction(cart_items, origin, destination)
+
+    result = transaction.lookup
+
+    expect(result.cart_items.size).to eq 3
+    expect(result.cart_items.detect { |i| i.cart_item_index == 0 }.tax_amount).to eq 0
+    expect(result.cart_items.detect { |i| i.cart_item_index == 1 }.tax_amount).to eq 0.79
+    expect(result.cart_items.detect { |i| i.cart_item_index == 2 }.tax_amount).to eq 0.79
+
+    # capture = transaction.authorized_with_capture
+    # expect(capture).to eq('OK')
+  end
+
+  it 'TaxCloud Test Case 3: Item taxable, shipping not taxable' do
+    destination = TaxCloud::Address.new(address1: '2300 N Lincoln Blvd', city: 'Oklahoma City', state: 'OK', zip5: '73105')
+    cart_items = []
+    cart_items << TaxCloud::CartItem.new(index: 0, item_id: 'Shirt002', tic: '20010', quantity: 1, price: 10.00)
+    cart_items << TaxCloud::CartItem.new(index: 1, item_id: 'Shipping', tic: '11010', quantity: 1, price: 10.00)
+    transaction = test_transaction(cart_items, origin, destination)
+
+    result = transaction.lookup
+
+    expect(result.cart_items.size).to eq 2
+    expect(result.cart_items.detect { |i| i.cart_item_index == 0 }.tax_amount).to eq 0.86
+    expect(result.cart_items.detect { |i| i.cart_item_index == 1 }.tax_amount).to eq 0
+
+    # capture = transaction.authorized_with_capture
+    # expect(capture).to eq('OK')
+  end
+
+  skip 'TaxCloud Test Case 4: Return all items in previous order' do
+    # TODO
+  end
+
+  skip 'TaxCloud Test Case 5: Return single item in previous order' do
+    # TODO
+  end
+
+  it 'TaxCloud Test Case 6: Item and shipping taxable' do
+    destination = TaxCloud::Address.new(address1: '384 Northyards Blvd NW', city: 'Atlanta', state: 'GA', zip5: '30313')
+    cart_items = []
+    cart_items << TaxCloud::CartItem.new(index: 0, item_id: 'Shirt003', tic: '20010', quantity: 1, price: 10.00)
+    cart_items << TaxCloud::CartItem.new(index: 1, item_id: 'Shipping', tic: '11010', quantity: 1, price: 10.00)
+    transaction = test_transaction(cart_items, origin, destination)
+
+    result = transaction.lookup
+
+    expect(result.cart_items.size).to eq 2
+    expect(result.cart_items.detect { |i| i.cart_item_index == 0 }.tax_amount).to eq 0.89
+    expect(result.cart_items.detect { |i| i.cart_item_index == 1 }.tax_amount).to eq 0.89
+  end
+
+  it 'TaxCloud Test Case 7: Handling errors' do
+    destination = TaxCloud::Address.new(address1: '384 Northyards Blvd NW', city: 'Atlanta', state: 'GA', zip5: '30313', zip4: '2440')
+    cart_items = []
+    cart_items << TaxCloud::CartItem.new(index: 0, item_id: 'Gadget002', tic: '00000', quantity: 1, price: -5.00)
+    transaction = test_transaction(cart_items, origin, destination)
+
+    expect { transaction.lookup }.to raise_error(TaxCloud::Errors::ApiError)
+
+    begin
+      transaction.lookup
+    rescue StandardError => e
+      expect(e.problem).to eq('Cart Item 0 has a negative Price (-5).  Only positive values can be used')
+    end
+  end
+
+  context 'with discounts' do
+    it 'TaxCloud Test Case 3, with item discount' do
+      destination = TaxCloud::Address.new(address1: '2300 N Lincoln Blvd', city: 'Oklahoma City', state: 'OK', zip5: '73105')
+      cart_items = []
+      cart_items << TaxCloud::CartItem.new(index: 0, item_id: 'Shirt002', tic: '20010', quantity: 1, price: 5.00)
+      cart_items << TaxCloud::CartItem.new(index: 1, item_id: 'Shipping', tic: '11010', quantity: 1, price: 10.00)
+      transaction = test_transaction(cart_items, origin, destination)
+
+      result = transaction.lookup
+
+      expect(result.cart_items.size).to eq 2
+      expect(result.cart_items.detect { |i| i.cart_item_index == 0 }.tax_amount).to eq 0.43
+      expect(result.cart_items.detect { |i| i.cart_item_index == 1 }.tax_amount).to eq 0
+
+      # capture = transaction.authorized_with_capture
+      # expect(capture).to eq('OK')
+    end
+
+    it 'TaxCloud Test Case 3, with item discount, multiple items' do
+      destination = TaxCloud::Address.new(address1: '2300 N Lincoln Blvd', city: 'Oklahoma City', state: 'OK', zip5: '73105')
+      cart_items = []
+      cart_items << TaxCloud::CartItem.new(index: 0, item_id: 'Shirt002', tic: '20010', quantity: 2, price: 7.50)
+      cart_items << TaxCloud::CartItem.new(index: 1, item_id: 'Shipping', tic: '11010', quantity: 2, price: 20.00)
+      transaction = test_transaction(cart_items, origin, destination)
+
+      result = transaction.lookup
+
+      expect(result.cart_items.size).to eq 2
+      expect(result.cart_items.detect { |i| i.cart_item_index == 0 }.tax_amount).to eq 1.29
+      expect(result.cart_items.detect { |i| i.cart_item_index == 1 }.tax_amount).to eq 0
+
+      # capture = transaction.authorized_with_capture
+      # expect(capture).to eq('OK')
+    end
+
+    it 'TaxCloud Test Case 6, with shipping promotion' do
+      destination = TaxCloud::Address.new(address1: '384 Northyards Blvd NW', city: 'Atlanta', state: 'GA', zip5: '30313')
+      cart_items = []
+      cart_items << TaxCloud::CartItem.new(index: 0, item_id: 'Shirt003', tic: '20010', quantity: 1, price: 10.00)
+      cart_items << TaxCloud::CartItem.new(index: 1, item_id: 'Shipping', tic: '11010', quantity: 1, price: 0.00)
+      transaction = test_transaction(cart_items, origin, destination)
+
+      result = transaction.lookup
+
+      expect(result.cart_items.size).to eq 2
+      expect(result.cart_items.detect { |i| i.cart_item_index == 0 }.tax_amount).to eq 0.89
+      expect(result.cart_items.detect { |i| i.cart_item_index == 1 }.tax_amount).to eq 0.00
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+# Run Coverage report
+require 'solidus_dev_support/rspec/coverage'
+
+require File.expand_path('dummy/config/environment.rb', __dir__).tap { |file|
+  # Create the dummy app if it's still missing.
+  system 'bin/rake extension:test_app' unless File.exist? file
+}
+
+# Requires factories and other useful helpers defined in spree_core.
+require 'solidus_dev_support/rspec/feature_helper'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+# Requires factories defined in lib/solidus_tax_cloud/factories.rb
+require 'solidus_tax_cloud/factories'
+
+RSpec.configure do |config|
+  config.infer_spec_type_from_file_location!
+  config.use_transactional_fixtures = false
+end

data/spec/support/capybara.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spree
+  module TestingSupport
+    module CapybaraHelpers
+      def sign_in_as!(user)
+        visit spree.login_path
+        within '#new_spree_user' do
+          fill_in 'Email', with: user.email
+          fill_in 'Password', with: user.password
+        end
+        click_button 'Login'
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Spree::TestingSupport::CapybaraHelpers, type: :feature
+end

data/spec/support/tax_cloud.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  # Official verification and test harness login credentials provided 7/8/14
+  # by David Campbell of The Federal Tax Authority.
+  # This account is configured to collect sales tax in the 24 SSUTA states:
+  # AR, GA, IN, IA, KS, KY, MI, MN, NE, NV, NJ, NC, ND, OH, OK, RI, SD, TN, UT, VT, WA, WV, WI, and WY
+  # The account does not collect sales tax in the remaining sales tax states:
+  # AL, AK, AZ, CA, CO, CT, DC, FL, HI, ID, IL, LA, ME, MD, MA, MS, MO, NM, NY, PA, SC, TX, and VA
+  config.before :suite do
+    TaxCloud.configure do |config|
+      config.api_login_id = '2D7D820'
+      config.api_key = '0946110C-2AA9-4387-AD5C-4E1C551B8D0C'
+    end
+  end
+
+  config.before do
+    stub_spree_preferences(taxcloud_default_product_tic: '00000', taxcloud_shipping_tic: '11010')
+  end
+end

data/spec/support/transactions.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+def test_transaction(cart_items, origin, destination)
+  TaxCloud::Transaction.new(customer_id: SecureRandom.hex(8), cart_id: SecureRandom.hex(8), order_id: SecureRandom.hex(8), cart_items: cart_items, origin: origin, destination: destination)
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: solidus_tax_cloud
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jerrold Thompson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: solidus_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: tax_cloud
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: solidus_dev_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Solidus extension providing Tax Cloud services
+email: jet@whidbey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gem_release.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TaxCloudImplementationVerificationGuide.pdf
+- app/assets/javascripts/spree/backend/solidus_tax_cloud.js
+- app/assets/javascripts/spree/frontend/solidus_tax_cloud.js
+- app/assets/stylesheets/spree/backend/solidus_tax_cloud.css
+- app/assets/stylesheets/spree/backend/solidus_tax_cloud.scss
+- app/assets/stylesheets/spree/frontend/solidus_tax_cloud.css
+- app/decorators/models/solidus_tax_cloud/spree/app_configuration_decorator.rb
+- app/decorators/models/solidus_tax_cloud/spree/line_item_decorator.rb
+- app/decorators/models/solidus_tax_cloud/spree/order_decorator.rb
+- app/decorators/models/solidus_tax_cloud/spree/product_decorator.rb
+- app/decorators/models/solidus_tax_cloud/spree/shipment_decorator.rb
+- app/models/spree/calculator/tax_cloud_calculator.rb
+- app/models/spree/tax_cloud.rb
+- app/overrides/spree/admin/products/_form.rb
+- app/overrides/spree/admin/shared/_configuration_menu.rb
+- bin/console
+- bin/r
+- bin/rails
+- bin/rake
+- bin/sandbox
+- bin/sandbox_rails
+- bin/setup
+- config/initializers/tax_cloud_usps_username.rb
+- config/locales/en.yml
+- config/routes.rb
+- db/migrate/20121220192438_create_spree_tax_cloud_transactions.rb
+- db/migrate/20121220193944_create_spree_tax_cloud_cart_items.rb
+- db/migrate/20130829215819_fix_scale_of_cart_item_prices.rb
+- db/migrate/20140623225628_add_tic_to_products.rb
+- lib/assets/javascripts/spree/frontend/solidus_tax_cloud.js.erb
+- lib/assets/stylesheets/spree/frontend/solidus_tax_cloud.css.erb
+- lib/controllers/backend/spree/admin/tax_cloud_settings_controller.rb
+- lib/decorators/backend/controllers/solidus_tax_cloud/spree/admin/orders_controller_decorator.rb
+- lib/decorators/frontend/controllers/solidus_tax_cloud/spree/checkout_controller_decorator.rb
+- lib/generators/solidus_tax_cloud/install/install_generator.rb
+- lib/generators/solidus_tax_cloud/templates/ca-bundle.crt
+- lib/solidus_tax_cloud.rb
+- lib/solidus_tax_cloud/engine.rb
+- lib/solidus_tax_cloud/error.rb
+- lib/solidus_tax_cloud/factories.rb
+- lib/solidus_tax_cloud/version.rb
+- lib/tasks/.gitkeep
+- lib/tasks/tax_cloud.rake
+- lib/views/backend/spree/admin/products/_edit_tax_cloud_tic.html.erb
+- lib/views/backend/spree/admin/tax_cloud_settings/edit.html.erb
+- solidus_tax_cloud.gemspec
+- spec/features/checkout_spec.rb
+- spec/models/tax_cloud_api_spec.rb
+- spec/spec_helper.rb
+- spec/support/capybara.rb
+- spec/support/tax_cloud.rb
+- spec/support/transactions.rb
+homepage: https://github.com/solidusio-contrib/solidus_tax_cloud
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://github.com/solidusio-contrib/solidus_tax_cloud
+  source_code_uri: https://github.com/solidusio-contrib/solidus_tax_cloud
+  changelog_uri: https://github.com/solidusio-contrib/solidus_tax_cloud/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Solidus extension providing Tax Cloud services
+test_files:
+- spec/features/checkout_spec.rb
+- spec/models/tax_cloud_api_spec.rb
+- spec/spec_helper.rb
+- spec/support/capybara.rb
+- spec/support/tax_cloud.rb
+- spec/support/transactions.rb