corgibytes-tax_cloud 0.9.0

data/test/helper.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require 'tax_cloud'
+require 'json'
+
+# If not included then no test reports are generated
+# for Circle CI builds.
+require 'minitest/ci'
+
+
+Savon.configure do |config|
+  config.log = false
+end
+
+HTTPI.log = false
+
+require 'vcr_setup'
+require 'test_setup'

data/test/test_address.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+class TestAddress < TestSetup
+  def setup
+    super
+    @address = TaxCloud::Address.new address1: '888 6th Ave', city: 'New York', state: 'New York', zip5: '10001'
+  end
+
+  def test_initialize
+    assert_equal '888 6th Ave', @address.address1
+    assert_equal nil, @address.address2
+    assert_equal 'New York', @address.city
+    assert_equal 'New York', @address.state
+    assert_equal '10001', @address.zip5
+    assert_equal nil, @address.zip4
+  end
+
+  def test_zip
+    assert_equal '10001', @address.zip
+    # 9-digit zip
+    @address.zip4 = '1234'
+    assert_equal '10001-1234', @address.zip
+    # only 4-digit zip, which is invalid
+    @address.zip5 = nil
+    assert_equal nil, @address.zip
+  end
+
+  def test_address_respond_to_verify
+    assert_respond_to @address, :verify
+  end
+
+  def test_verify_good_address
+    VCR.use_cassette('verify good address') do
+      verified = @address.verify
+      assert_instance_of TaxCloud::Address, verified
+      assert_equal '888 6TH AVE', verified.address1
+      assert_equal nil, verified.address2
+      assert_equal 'NEW YORK', verified.city
+      assert_equal 'NY', verified.state
+      assert_equal '10001', verified.zip5
+      assert_equal '3502', verified.zip4
+    end
+  end
+
+  def test_verify_bad_address
+    e = assert_raises TaxCloud::Errors::ApiError do
+      VCR.use_cassette('verify bad address') do
+        bad_address = TaxCloud::Address.new address1: '10001 Test Street', city: 'New York', state: 'New York', zip5: '99999'
+        bad_address.verify
+      end
+    end
+    assert_equal e.problem, 'Invalid Zip Code.'
+  end
+end

data/test/test_cart_item.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+class TestCartItem < Minitest::Test
+  def setup
+    @cart_item = TaxCloud::CartItem.new index: 0, item_id: 'SKU-100', tic: '0000', price: 50.00, quantity: 3
+  end
+
+  def test_variables
+    assert_equal 0, @cart_item.index
+    assert_equal 'SKU-100', @cart_item.item_id
+    assert_equal '0000', @cart_item.tic
+    assert_equal 50.00, @cart_item.price
+    assert_equal 3, @cart_item.quantity
+  end
+end

data/test/test_client.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class TestClient < TestSetup
+  def test_ping_with_invalid_credentials
+    assert_raises TaxCloud::Errors::ApiError do
+      VCR.use_cassette('ping_with_invalid_credentials') do
+        TaxCloud.client.ping
+      end
+    end
+  end
+
+  def test_ping_with_invalid_response
+    e = assert_raises TaxCloud::Errors::UnexpectedSoapResponse do
+      VCR.use_cassette('ping_with_invalid_response') do
+        TaxCloud.client.ping
+      end
+    end
+    assert_equal 'Expected a value for `ping_result` in `ping_response/ping_result/response_type` in the TaxCloud response.', e.problem
+  end
+
+  def test_ping
+    VCR.use_cassette('ping') do
+      response = TaxCloud.client.ping
+      assert_equal 'OK', response
+    end
+  end
+end

data/test/test_configuration_optional_keys.rb

@@ -0,0 +1,42 @@
+require 'helper'
+
+describe 'TaxCloud::Configuration' do
+  def request
+    TaxCloud.client.instance_variable_get('@wsdl').request
+  end
+
+  def reset_and_configure(options = {})
+    TaxCloud.reset!
+    TaxCloud.configure do |config|
+      config.api_key = 'stubbed_api_key'
+      config.api_login_id = 'stubbed_api_login_id'
+      options.each do |key, value|
+        config.public_send("#{key}=", value)
+      end
+    end
+  end
+
+  describe 'open_timeout option' do
+    it 'has set default to 2' do
+      reset_and_configure
+      assert_equal 2, request.open_timeout
+    end
+
+    it 'can be changed via configuration' do
+      reset_and_configure(open_timeout: 3)
+      assert_equal 3, request.open_timeout
+    end
+  end
+
+  describe 'read_timeout option' do
+    it 'has set default to 2' do
+      reset_and_configure
+      assert_equal 2, request.read_timeout
+    end
+
+    it 'can be changed via configuration' do
+      reset_and_configure(read_timeout: 3)
+      assert_equal 3, request.read_timeout
+    end
+  end
+end

data/test/test_configuration_required_keys.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+class TestConfigurationRequiredKeys < Minitest::Test
+  def setup
+    TaxCloud.reset!
+  end
+
+  def test_missing_configuration
+    assert_raises TaxCloud::Errors::MissingConfig do
+      TaxCloud.client.request :dummy, body: {}
+    end
+  end
+
+  def test_mising_api_login_id
+    TaxCloud.configure do |config|
+      config.api_key = 'taxcloud_api_key'
+    end
+    assert_raises TaxCloud::Errors::MissingConfigOption do
+      TaxCloud.client.request :dummy, body: {}
+    end
+  end
+
+  def test_mising_api_key
+    TaxCloud.configure do |config|
+      config.api_login_id = 'taxcloud_api_login_id'
+    end
+    assert_raises TaxCloud::Errors::MissingConfigOption do
+      TaxCloud.client.request :dummy, body: {}
+    end
+  end
+end

data/test/test_lookup_response.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+class TestLookupResponse < TestSetup
+  class MockLookup < TaxCloud::Responses::Lookup
+    def initialize; end
+  end
+
+  def test_tax_amount_handles_decimal_addition_properly
+    response = TestLookupResponse::MockLookup.new
+
+    # `tax_amount`s chosen to provoke floating point arithmetic error
+    mock_savon_cart_items = [
+      { cart_item_index: '0', tax_amount: '0.35' },
+      { cart_item_index: '1', tax_amount: '0.7' }
+    ]
+    response.cart_items = mock_savon_cart_items.map { |i| TaxCloud::Responses::CartItem.new(i) }
+
+    assert_equal 1.05, response.tax_amount
+  end
+end

data/test/test_setup.rb

@@ -0,0 +1,17 @@
+class TestSetup < Minitest::Test
+  def default_test
+    # placeholder to avoid error under Ruby 1.8.7
+  end
+
+  def setup
+    TaxCloud.configure do |config|
+      config.api_login_id = ENV['TAXCLOUD_API_LOGIN_ID'] || 'taxcloud_api_login_id'
+      config.api_key = ENV['TAXCLOUD_API_KEY'] || 'taxcloud_api_key'
+      config.usps_username = ENV['TAXCLOUD_USPS_USERNAME'] || 'usps_username'
+    end
+  end
+
+  def teardown
+    TaxCloud.reset!
+  end
+end

data/test/test_soap.rb

@@ -0,0 +1,11 @@
+require 'helper'
+
+class TestSoap < TestSetup
+  def test_invalid_soap_call
+    assert_raises TaxCloud::Errors::SoapError do
+      VCR.use_cassette('invalid_soap_call') do
+        TaxCloud.client.request :invalid, body: {}
+      end
+    end
+  end
+end

data/test/test_tax_code_groups.rb

@@ -0,0 +1,29 @@
+require 'helper'
+
+class TestTaxCodeGroups < TestSetup
+  def test_all
+    VCR.use_cassette('get_tic_groups') do
+      assert TaxCloud::TaxCode::Groups.all.count > 0
+    end
+  end
+
+  def test_lookup
+    VCR.use_cassette('get_tic_groups') do
+      tax_code_group = TaxCloud::TaxCode::Groups[TaxCloud::TaxCode::Groups::SCHOOL_RELATED_PRODUCTS]
+      assert_equal TaxCloud::TaxCode::Groups::SCHOOL_RELATED_PRODUCTS, tax_code_group.group_id
+      assert_equal 'School Related Products', tax_code_group.description
+    end
+  end
+
+  def test_lookup_tax_codes
+    tax_code_group = VCR.use_cassette('get_tic_groups') do
+      TaxCloud::TaxCode::Groups[TaxCloud::TaxCode::Groups::SCHOOL_RELATED_PRODUCTS]
+    end
+    VCR.use_cassette('get_tics_by_group') do
+      assert tax_code_group.tax_codes.count > 0
+      tax_code = tax_code_group[TaxCloud::TaxCodes::SCHOOL_INSTRUCTIONAL_MATERIAL]
+      assert_equal TaxCloud::TaxCodes::SCHOOL_INSTRUCTIONAL_MATERIAL, tax_code.ticid
+      assert_equal 'School instructional material', tax_code.description
+    end
+  end
+end

data/test/test_tax_codes.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class TestTaxCode < TestSetup
+  def test_all
+    VCR.use_cassette('get_tics') do
+      assert TaxCloud::TaxCodes.all.count > 0
+    end
+  end
+
+  def test_lookup
+    VCR.use_cassette('get_tics') do
+      tax_code = TaxCloud::TaxCodes[TaxCloud::TaxCodes::DIRECT_MAIL_RELATED]
+      assert_equal TaxCloud::TaxCodes::DIRECT_MAIL_RELATED, tax_code.ticid
+      assert_equal 'Direct-mail related', tax_code.description
+    end
+  end
+end

data/test/test_transaction.rb

@@ -0,0 +1,78 @@
+require 'helper'
+
+class TestTransaction < TestSetup
+  def setup
+    super
+    origin = TaxCloud::Address.new(address1: '162 East Avenue', address2: 'Third Floor', city: 'Norwalk', state: 'CT', zip5: '06851')
+    destination = TaxCloud::Address.new(address1: '3121 West Government Way', address2: 'Suite 2B', city: 'Seattle', state: 'WA', zip5: '98199')
+    cart_items = []
+    cart_items << TaxCloud::CartItem.new(index: 0, item_id: 'SKU-TEST', tic: TaxCloud::TaxCodes::GENERAL, quantity: 1, price: 50.00)
+    cart_items << TaxCloud::CartItem.new(index: 1, item_id: 'SKU-TEST1', tic: TaxCloud::TaxCodes::GENERAL, quantity: 1, price: 100.00)
+    @transaction = TaxCloud::Transaction.new(customer_id: 42, cart_id: rand(18_446_744_073_709_551_616), order_id: rand(18_446_744_073_709_551_616), cart_items: cart_items, origin: origin, destination: destination)
+  end
+
+  def test_lookup
+    VCR.use_cassette('lookup') do
+      result = @transaction.lookup
+      assert_instance_of TaxCloud::Responses::Lookup, result
+      assert_equal 2, result.cart_items.count
+      result.cart_items.first.tap do |item|
+        assert_equal 0, item.cart_item_index
+        assert_equal 4.75, item.tax_amount
+      end
+      result.cart_items.last.tap do |item|
+        assert_equal 1, item.cart_item_index
+        assert_equal 9.5, item.tax_amount
+      end
+      assert_equal 14.25, result.tax_amount
+    end
+  end
+
+  def test_authorized
+    VCR.use_cassette('authorized') do
+      @transaction.lookup
+      result = @transaction.authorized
+      assert_equal 'OK', result
+    end
+  end
+
+  class LocalizedDate < Date
+    def to_s
+      strftime '%d/%m/%Y'
+    end
+  end
+
+  def test_authorized_with_localized_date
+    VCR.use_cassette('authorized_with_localized_time') do
+      @transaction.lookup
+      result = @transaction.authorized(date_authorized: LocalizedDate.civil(2013, 2, 1))
+      assert_equal 'OK', result
+    end
+  end
+
+  def test_captured
+    VCR.use_cassette('captured') do
+      @transaction.lookup
+      @transaction.authorized
+      result = @transaction.captured
+      assert_equal 'OK', result
+    end
+  end
+
+  def test_authorized_with_capture
+    VCR.use_cassette('authorized_with_capture') do
+      @transaction.lookup
+      result = @transaction.authorized_with_capture
+      assert_equal 'OK', result
+    end
+  end
+
+  def test_returned
+    VCR.use_cassette('returned') do
+      @transaction.lookup
+      @transaction.authorized_with_capture
+      result = @transaction.returned
+      assert_equal 'OK', result
+    end
+  end
+end

data/test/test_transaction_ny.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+class TestTransactionNy < TestSetup
+  def setup
+    super
+    origin = TaxCloud::Address.new address1: '888 6th Ave', city: 'New York', state: 'NY', zip5: '10001'
+    destination = TaxCloud::Address.new address1: '888 6th Ave', city: 'New York', state: 'NY', zip5: '10001'
+    cart_items = [TaxCloud::CartItem.new(index: 0, item_id: 'SKU-TEST', tic: TaxCloud::TaxCodes::GENERAL, quantity: 1, price: 50.00)]
+    @transaction = TaxCloud::Transaction.new(customer_id: 42, cart_id: 708, order_id: rand(18_446_744_073_709_551_616), cart_items: cart_items, origin: origin, destination: destination)
+  end
+
+  def test_lookup_non_ssuta_state
+    VCR.use_cassette('lookup_ny') do
+      result = @transaction.lookup
+      assert_instance_of TaxCloud::Responses::Lookup, result
+      assert_equal '708', result.cart_id
+      assert_equal 1, result.cart_items.count
+      result.cart_items.first.tap do |item|
+        assert_equal 0, item.cart_item_index
+        assert_equal 0, item.tax_amount
+      end
+      assert_equal 0, result.tax_amount
+    end
+  end
+end

data/test/vcr_setup.rb

@@ -0,0 +1,9 @@
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/cassettes'
+  c.hook_into :webmock
+  c.filter_sensitive_data('api-login-id')  { TaxCloud.configuration.api_login_id }
+  c.filter_sensitive_data('api-key')       { TaxCloud.configuration.api_key }
+  c.filter_sensitive_data('usps-username') { TaxCloud.configuration.usps_username }
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: corgibytes-tax_cloud
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Corgibytes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Calculate sales tax using the TaxCloud.net API
+email:
+- info@corgibytes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .circleci/config.yml
+- .circleci/setup-rubygems.sh
+- .gitignore
+- .rubocop.yml
+- .rubocop_todo.yml
+- .travis.yml
+- CHANGELOG.rdoc
+- CONTRIBUTORS.txt
+- Dockerfile
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- docker-compose.yml
+- examples/.env.example
+- examples/lookup_example.rb
+- lib/config/locales/en.yml
+- lib/hash.rb
+- lib/savon_soap_xml.rb
+- lib/tasks/tax_cloud.rake
+- lib/tasks/tax_code_groups.rake
+- lib/tasks/tax_codes.rake
+- lib/tax_cloud.rb
+- lib/tax_cloud/address.rb
+- lib/tax_cloud/cart_item.rb
+- lib/tax_cloud/client.rb
+- lib/tax_cloud/configuration.rb
+- lib/tax_cloud/errors.rb
+- lib/tax_cloud/errors/api_error.rb
+- lib/tax_cloud/errors/missing_config_error.rb
+- lib/tax_cloud/errors/missing_config_option_error.rb
+- lib/tax_cloud/errors/soap_error.rb
+- lib/tax_cloud/errors/tax_cloud_error.rb
+- lib/tax_cloud/errors/unexpected_soap_response_error.rb
+- lib/tax_cloud/record.rb
+- lib/tax_cloud/responses.rb
+- lib/tax_cloud/responses/authorized.rb
+- lib/tax_cloud/responses/authorized_with_capture.rb
+- lib/tax_cloud/responses/base.rb
+- lib/tax_cloud/responses/captured.rb
+- lib/tax_cloud/responses/cart_item.rb
+- lib/tax_cloud/responses/generic.rb
+- lib/tax_cloud/responses/lookup.rb
+- lib/tax_cloud/responses/ping.rb
+- lib/tax_cloud/responses/returned.rb
+- lib/tax_cloud/responses/tax_code_groups.rb
+- lib/tax_cloud/responses/tax_codes.rb
+- lib/tax_cloud/responses/tax_codes_by_group.rb
+- lib/tax_cloud/responses/verify_address.rb
+- lib/tax_cloud/tax_code.rb
+- lib/tax_cloud/tax_code_constants.rb
+- lib/tax_cloud/tax_code_group.rb
+- lib/tax_cloud/tax_code_group_constants.rb
+- lib/tax_cloud/tax_code_groups.rb
+- lib/tax_cloud/tax_codes.rb
+- lib/tax_cloud/transaction.rb
+- lib/tax_cloud/version.rb
+- tax_cloud.gemspec
+- test/cassettes/authorized.yml
+- test/cassettes/authorized_with_capture.yml
+- test/cassettes/authorized_with_localized_time.yml
+- test/cassettes/captured.yml
+- test/cassettes/get_tic_groups.yml
+- test/cassettes/get_tics.yml
+- test/cassettes/get_tics_by_group.yml
+- test/cassettes/invalid_soap_call.yml
+- test/cassettes/lookup.yml
+- test/cassettes/lookup_ny.yml
+- test/cassettes/ping.yml
+- test/cassettes/ping_with_invalid_credentials.yml
+- test/cassettes/ping_with_invalid_response.yml
+- test/cassettes/returned.yml
+- test/cassettes/verify_bad_address.yml
+- test/cassettes/verify_good_address.yml
+- test/helper.rb
+- test/test_address.rb
+- test/test_cart_item.rb
+- test/test_client.rb
+- test/test_configuration_optional_keys.rb
+- test/test_configuration_required_keys.rb
+- test/test_lookup_response.rb
+- test/test_setup.rb
+- test/test_soap.rb
+- test/test_tax_code_groups.rb
+- test/test_tax_codes.rb
+- test/test_transaction.rb
+- test/test_transaction_ny.rb
+- test/vcr_setup.rb
+homepage: https://github.com/corgibytes/tax_cloud
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Calculate sales tax using TaxCloud
+test_files: []