tax_cloud 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dce34f03969027431c16d3504d5f02106ae8c086
-  data.tar.gz: c55d7e4fa58df6cc206994e42ad2f0bfff8ead2b
+SHA256:
+  metadata.gz: 55a0579c5212968283b84a2e6a87921e8d741d182e4f23337d480435c26dbec6
+  data.tar.gz: 7cb858801bc88041e2b402962c5dc05d91afb6b52dc3fe793c4a943014b7d1bc
 SHA512:
-  metadata.gz: 4c0b46885a58ebf4ba0d807d32e7b342d57b5057824d024cc60ab699e32ec5ff9ea2f815ad466362d91e468f962c1bb9b198052052adfed99b74829d4308efc7
-  data.tar.gz: 4b909e99313bfcb962d44d124cdaf1b8d2d4c27d1d067549ad00f823d474fbd1c6fe0ffc5912f3fc38aeb7cd6da9677cf89637844c7870b9bdd709642bfb1521
+  metadata.gz: efc17316081884f02aebf3d1064e81df78515e5b8ee9355c224d8be53ef7529833648295c692ab332d35018092c940b2c21d2356450fa67761db7cd563b472ca
+  data.tar.gz: b256cb07f74161ad04c869c258e75549fbed0920c2ce3a030e60a126518df9d32111df50afaba455b69682a31fc64f8cf30960b0c9e6c660da64f4b3c72fc994

data/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+# Reference https://github.com/actions/starter-workflows/blob/main/ci/ruby.yml
+name: test
+on: [push, pull_request]
+jobs:
+  lint:
+    name: RuboCop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7
+          bundler-cache: true
+      - name: Run RuboCop
+        run: bundle exec rubocop
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7']
+    name: test (${{ matrix.ruby-version }})
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake test
+

data/.rubocop.yml

@@ -1,29 +1,13 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
-  Excludes:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  Exclude:
     - vendor/**
+    - vendor/bundle/**/*
     - bin/**
 
-LineLength:
-  Enabled: false
-
-MethodLength:
-  Enabled: false
-
-ClassLength:
-  Enabled: false
-
-Documentation:
-  # don't require classes to be documented
-  Enabled: false
-
-NumericLiterals:
-  # don't separate numeric literals with _
-  Enabled: false
-
-RaiseArgs:
-  # don't need to provide an exception class and message, SoapError takes care of that
-  Enabled: false
-
-Encoding:
-  # missing UTF-8 comment
-  Enabled: false
+Style/NumericLiteralPrefix:
+  Enabled: true
+  EnforcedOctalStyle: zero_only

data/.rubocop_todo.yml

@@ -0,0 +1,47 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-10-14 20:47:01 UTC using RuboCop version 0.93.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Lint/MissingSuper:
+  Exclude:
+    - 'test/test_lookup_response.rb'
+
+# Offense count: 3
+# Configuration parameters: IgnoredMethods.
+Metrics/AbcSize:
+  Max: 23
+
+# Offense count: 5
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 39
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 261
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/tax_cloud/tax_codes.rb'
+
+# Offense count: 61
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 235

data/CHANGELOG.md

@@ -0,0 +1,85 @@
+### 0.5.0 (7/21/2023)
+
+*   Update README, CHANGELOG, and LICENSE from RDoc to Markdown -
+    @brchristian.
+*   Migrate from Travis CI to GitHub Actions -
+    @rchekaluk.
+*   Update WSDL endpoint URL as recommended by TaxCloud to
+    https://api.taxcloud.com/1.0/?wsdl - @mrmarcondes.
+
+
+### 0.4.0 (12/7/2020)
+
+*   Add `open_timeout` and `read_timeout` options into configuration -
+    @ka8725.
+*   Switch to using BigDecimal for `tax_amount` to avoid floating point
+    arithmetic errors - @paulhenrich.
+*   Require ruby 2.6.0+
+*   Upgrade to rubocop latest
+    *   Add `TargetRubyVersion: 2.6` to rubocop config (based on
+        https://www.ruby-lang.org/en/downloads/branches/ oldest "normal
+        maintenance" version)
+    *   Add `required_ruby_version` to gemspec
+    *   addresses rubocop violations
+
+*   Update WSDL endpoint URL as recommended by TaxCloud to
+    https://asmx.taxcloud.com/1.0/?wsdl - @brchristian.
+
+
+### 0.3.0 (1/9/2014)
+
+*   #19: Support Savon 2 - @drewtempelmeyer.
+*   Implemented Rubocop, Ruby style linter - @dblock.
+*   Ruby 1.8.7 and 1.9.2 are no longer supported - @dblock.
+
+
+### 0.2.2 (4/29/2013)
+
+*   Relaxed thirdparty gem dependency versions - @mperham.
+
+
+### 0.2.1 (3/3/2013)
+
+*   Fixed date formatting in API requests with localized applications -
+    @soulcutter.
+
+
+### 0.2.0 (11/26/2012)
+
+*   The gem is now licensed under the MIT license - @dblock.
+*   Raise specialized configuration and SOAP errors - @dblock.
+*   Added `TaxCloud::Client.ping` - @dblock.
+*   Returning a verified `TaxCloud::Address` from `TaxCloud::Address.verify` -
+    @dblock.
+*   Added `TaxCloud::Address.zip` that returns a 9-digit address zip code,
+    when available - @dblock.
+*   Returning a `TaxCloud::Responses::Lookup` from
+    `TaxCloud::Transaction.lookup` - @dblock.
+*   Returning transaction state, ie. `"OK"` from all other TaxCloud
+    transactions. Exceptions are raised on error - @dblock.
+*   Added support for tax codes and tax code groups lookup with
+    `TaxCloud::TaxCodes` and `TaxCloud::TaxCode::Groups` - @dblock.
+
+
+### 0.1.5 (5/9/2012)
+
+*   Fixed compatibility with Ruby 1.8.7 and 1.9.3, removed super from
+    constructors for classes which inherit from `Object` - @gfmurphy.
+
+
+### 0.1.4 (10/20/2011)
+
+*   Upgraded rdoc - @drewtempelmeyer.
+*   Fixed `.gemspec` dependency declaration for savon - @drewtempelmeyer.
+
+
+### 0.1.3 (9/19/2011)
+
+*   Added support for the "returned" request - @danielmorrison.
+*   Refactoreted tests to use vcr and webmock - @danielmorrison.
+
+
+### 0.1.0 (8/23/2011)
+
+*   Initial public release - @drewtempelmeyer.
+

data/CONTRIBUTORS.txt

@@ -21,3 +21,6 @@ Contributors
 
 * Bradley Schaefer
   * Github: soulcutter
+
+* Gary Hepting
+  * Github: ghepting

data/Gemfile

@@ -1,9 +1,19 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 gemspec
 
-platform :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'racc'
-  gem 'iconv'
+group :development do
+  gem 'rubocop', '~> 0.93.1'
+end
+
+group :test do
+  gem 'minitest'
+  gem 'vcr'
+  gem 'webmock'
+end
+
+group :development, :test do
+  gem 'rake', '~>12.2.1'
 end

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2011-2020 Drew Tempelmeyer & Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,200 @@
+# TaxCloud
+
+[![Build Status](https://github.com/txcrb/tax_cloud/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/txcrb/tax_cloud/actions)
+
+[TaxCloud](http://www.taxcloud.com) is a free service to calculate sales tax
+and generate tax reports. The `tax_cloud` gem allows you to easily integrate
+with TaxCloud's API.
+
+### Getting Started
+Create a [TaxCloud](http://www.taxcloud.com) merchant account at
+http://www.taxcloud.net. Add a website to your account under
+[Locations](https://taxcloud.net/account/locations). This will generate an API
+ID and API Key that you will need to use the service.
+
+[TaxCloud](http://www.taxcloud.com) also offers an optional address
+verification API. To use it, you need a USPS (United States Postal Service)
+Address API Username. To obtain your USPS Username:
+1.  Go through the Web Tools API Portal registration process at
+    https://registration.shippingapis.com/
+2.  Once you have registered for your account, you will receive an email with
+    your USPS username and password.
+3.  Enter your USPS username in your TaxCloud initializer (see below).
+
+
+### Setup
+Add the gem to your Gemfile.
+
+```ruby
+gem 'tax_cloud'
+```
+
+Configure your environment. For example, create an initializer in Rails in
+`config/initializers/tax_cloud.rb`.
+
+```ruby
+TaxCloud.configure do |config|
+  config.api_login_id = 'your_tax_cloud_api_login_id'
+  config.api_key = 'your_tax_cloud_api_key'
+  config.usps_username = 'your_usps_username' # optional
+  config.open_timeout = 1 # optional
+  config.read_timeout = 1 # optional
+end
+```
+
+The `open_timeout` and `read_timeout` options are used to specify waiting time
+for the TaxCloud web service response in seconds. Default values:
+`open_timeout = 2` and `read_timeout = 2`.
+
+### Using TaxCloud
+Define the destination and origin addresses using `TaxCloud::Address`.
+
+```ruby
+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'
+)
+```
+
+Create your Transaction and set up your cart items
+
+```ruby
+transaction = TaxCloud::Transaction.new(
+  customer_id: '1',
+  cart_id: '1',
+  origin: origin,
+  destination: destination
+)
+transaction.cart_items << TaxCloud::CartItem.new(
+  index: 0,
+  item_id: 'SKU-100',
+  tic: TaxCloud::TaxCodes::GENERAL,
+  price: 10.00,
+  quantity: 1
+)
+lookup = transaction.lookup # this will return a TaxCloud::Responses::Lookup instance
+lookup.tax_amount # total tax amount
+lookup.cart_items.each do |cart_item|
+  cart_item.tax_amount # tax for a single item
+end
+```
+
+After you've authorized and captured the transaction via your merchant
+account, you should do the same with TaxCloud for maintaining accurate tax
+information.
+
+```ruby
+transaction.order_id = 100
+transaction.authorized_with_capture # returns "OK" or raises an error
+```
+
+Later, you may need to mark some cart items as returned. TaxCloud will ignore
+any cart items that you don't include.
+
+```ruby
+transaction.order_id = 100
+transaction.cart_items << TaxCloud::CartItem.new(
+  index: 0,
+  item_id: 'SKU-100',
+  tic: TaxCloud::TaxCodes::GENERAL,
+  price: 10.00,
+  quantity: 1
+)
+transaction.returned # returns "OK" or raises an error
+```
+
+### Verifying Addresses
+
+[TaxCloud](http://www.taxcloud.com) optionally integrates with the USPS
+Address API. An address can be verified, which can also yield a 9-digit zip
+code that helps determine a more accurate tax rate.
+
+```ruby
+address = TaxCloud::Address.new({
+                                  address1: '888 6th Ave',
+                                  city: 'New York',
+                                  state: 'New York',
+                                  zip5: '10001'
+                                })
+
+verified_address = address.verify
+verified_address.zip5 # 10001
+verified_address.zip4 # 3502
+verified_address.zip # 10001-3502
+```
+
+### Tax Codes
+[TaxCloud](http://www.taxcloud.com) maintains a list of all Taxability
+Information Codes or TICs, which can be found at https://taxcloud.net/tic.
+
+You can obtain all tax codes as well as lookup a tax code by ID.
+
+```ruby
+TaxCloud::TaxCodes.all # a hash of all codes
+tax_code = TaxCloud::TaxCodes[TaxCloud::TaxCodes::DIRECT_MAIL_RELATED]
+tax_code.ticid # 11000 or TaxCloud::TaxCodes::DIRECT_MAIL_RELATED
+tax_code.description # "Direct-mail related"
+```
+
+Tax codes are organized in groups.
+
+```ruby
+TaxCloud::TaxCode::Groups.all # a hash of all groups
+tax_code_group = TaxCloud::TaxCode::Groups[TaxCloud::TaxCode::Groups::SCHOOL_RELATED_PRODUCTS]
+tax_code_group.group_id # 3 or TaxCloud::TaxCode::Groups::SCHOOL_RELATED_PRODUCTS
+tax_code_group.description # School Related Products
+tax_code_group.tax_codes # a hash of all codes in this group
+```
+
+Tax code constants are defined in `tax_code_constants.rb` and tax code group
+constants in `tax_code_group_constants.rb`. These files can be generated by
+running the following rake tasks.
+
+```
+TAXCLOUD_API_LOGIN_ID=... TAXCLOUD_API_KEY=... TAXCLOUD_USPS_USERNAME=... tax_cloud:tax_codes
+TAXCLOUD_API_LOGIN_ID=... TAXCLOUD_API_KEY=... TAXCLOUD_USPS_USERNAME=... tax_cloud:tax_code_groups
+```
+
+### Tax States
+TaxCloud manages a list of states in which you can calculate sales tax. The
+default setup will only have SSUTA (Streamlined Sales and Use Tax Agreement)
+states enabled. All other states will return $0 for tax values. To enable
+other states, go to https://taxcloud.com/go/states-management/. You can find
+more information about SSUTA
+[here](http://www.streamlinedsalestax.org/index.php?page=About-Us).
+
+### Running Tests
+*   VCR and WebMock are used to replay requests and avoid hitting the API each
+    time. To refresh the mocks, simply delete the `test/cassettes` directory.
+*   Run tests.
+        rake test
+
+*   If you need to record new requests against TaxCloud, set your keys first.
+        TAXCLOUD_API_LOGIN_ID=... TAXCLOUD_API_KEY=... TAXCLOUD_USPS_USERNAME=... rake test
+
+    The mocks will filter out your configuration details.
+
+
+### Bugs, fixes, etc
+*   Fork.
+*   Write test(s).
+*   Fix.
+*   Commit.
+*   Submit pull request.
+
+
+### License
+
+Copyright Drew Tempelmeyer and contributors, 2011-2020.
+
+This gem is licensed under the MIT license.

data/Rakefile

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'rdoc/task'
-
-gemspec = eval(File.read(Dir["*.gemspec"].first))
+require 'vcr'
 
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -10,26 +10,12 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = false
 end
 
-RDoc::Task.new do |rd|
-  README = 'README.rdoc'
-  rd.main = README
-  rd.rdoc_files.include(README, 'CHANGELOG.rdoc', 'LICENSE.rdoc', "lib/**/*.rb")
-  rd.rdoc_dir = 'doc'
-  rd.title = 'tax_cloud'
-end
-
-desc "Validate the gemspec."
-task :gemspec do
-  puts gemspec.validate
-end
-
 load 'lib/tasks/tax_cloud.rake'
 load 'lib/tasks/tax_codes.rake'
 load 'lib/tasks/tax_code_groups.rake'
-
 load 'vcr/tasks/vcr.rake'
 
 require 'rubocop/rake_task'
-Rubocop::RakeTask.new(:rubocop)
+RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :test]
+task default: %i[rubocop test]

data/lib/config/locales/en.yml

@@ -16,7 +16,7 @@ en:
             \_\_end\n"
         missing_config_option:
           message: "Missing configuration option: %{name}."
-          summary: "A configuration option was not provided when configuration TaxCloud."
+          summary: "A configuration option was not provided when configuring TaxCloud."
           resolution: "Review your `TaxCloud.configure` code. Are you using an environment
           variable that has not been set?"
         soap_error:
@@ -31,4 +31,4 @@ en:
         api_error:
           message: "%{message}"
           summary: "The TaxCloud server returned an error in the response: `%{raw}`"
-          resolution: "Check the request parameters."
+          resolution: "Check the request parameters."

data/lib/hash.rb

@@ -1,9 +1,8 @@
+# frozen_string_literal: true
+
 class Hash #:nodoc: all
   # Downcase the keys. Use this because <tt>TaxCloud::Address.verify</tt> requires downcased keys
   def downcase_keys
-    reduce({}) do |h, (k, v)|
-      h[k.downcase] = v
-      h
-    end
+    transform_keys(&:downcase)
   end
 end

data/lib/tasks/tax_cloud.rake

@@ -1,20 +1,20 @@
+# frozen_string_literal: true
+
 require 'tax_cloud'
 
 namespace :tax_cloud do
-
-  desc "Configure TaxCloud."
+  desc 'Configure TaxCloud.'
   task :configure do
     unless TaxCloud.configured?
       TaxCloud.configure do |config|
         config.api_login_id = ENV['TAXCLOUD_API_LOGIN_ID']
         config.api_key = ENV['TAXCLOUD_API_KEY']
         config.usps_username = ENV['TAXCLOUD_USPS_USERNAME']
-      end  
+      end
       Savon.configure do |config|
         config.log = false
       end
       HTTPI.log = false
     end
   end
-
 end

data/lib/tasks/tax_code_groups.rake

@@ -1,13 +1,14 @@
-namespace :tax_cloud do
+# frozen_string_literal: true
 
-  desc "Generate tax code groups."
-  task :tax_code_groups => :configure do
-    filename = "lib/tax_cloud/tax_code_group_constants.rb"
+namespace :tax_cloud do
+  desc 'Generate tax code groups.'
+  task tax_code_groups: :configure do
+    filename = 'lib/tax_cloud/tax_code_group_constants.rb'
 
     begin
       groups = TaxCloud::TaxCode::Groups.all.values
 
-      File.open filename, "wt" do |f|
+      File.open filename, 'wt' do |f|
         f.write "module TaxCloud\n"
         f.write "  class TaxCode\n"
         f.write "    # Tax Code Groups.\n"
@@ -16,9 +17,9 @@ namespace :tax_cloud do
         groups.each do |group|
           puts " #{group.description}"
           code = group.description.upcase
-          code.gsub! /[^A-Z0-9]/, '_'
-          code.gsub! /_$/, ''
-          code.gsub! /\_+/, '_'
+          code.gsub!(/[^A-Z0-9]/, '_')
+          code.gsub!(/_$/, '')
+          code.gsub!(/_+/, '_')
           f.write "      \# #{group.description}\n"
           f.write "      #{code} = #{group.group_id}\n"
         end
@@ -29,11 +30,10 @@ namespace :tax_cloud do
       end
 
       puts "Done, #{filename}."
-    rescue => e
-      puts "ERROR: Unable to generate a new list of tax codes."
+    rescue StandardError => e
+      puts 'ERROR: Unable to generate a new list of tax codes.'
       puts e.message
       raise e
     end
   end
-
 end

data/lib/tasks/tax_codes.rake

@@ -1,15 +1,16 @@
-namespace :tax_cloud do
+# frozen_string_literal: true
 
-  desc "Generate tax codes."
-  task :tax_codes => :configure do
-    filename = "lib/tax_cloud/tax_code_constants.rb"
+namespace :tax_cloud do
+  desc 'Generate tax codes.'
+  task tax_codes: :configure do
+    filename = 'lib/tax_cloud/tax_code_constants.rb'
 
     begin
       groups = TaxCloud::TaxCode::Groups.all.values
       groups_and_tax_codes = Hash[groups.map do |group|
-        [ group, group.tax_codes.values ]
+        [group, group.tax_codes.values]
       end]
-      File.open filename, "wt" do |f|
+      File.open filename, 'wt' do |f|
         f.write "module TaxCloud\n"
         f.write "  # Tax Codes.\n"
         f.write "  class TaxCodes\n"
@@ -20,9 +21,9 @@ namespace :tax_cloud do
           f.write "    \# #{group.description}\n\n"
           tax_codes.each do |tax_code|
             code = tax_code.description.upcase
-            code.gsub! /[^A-Z0-9]/, '_'
-            code.gsub! /\_+$/, ''
-            code.gsub! /\_+/, '_'
+            code.gsub!(/[^A-Z0-9]/, '_')
+            code.gsub!(/_+$/, '')
+            code.gsub!(/_+/, '_')
             # avoid duplicates
             code_id = codes[code] ? "#{code}_#{codes[code]}" : code
             codes[code] = (codes[code] || 0) + 1
@@ -35,11 +36,10 @@ namespace :tax_cloud do
         f.write "end\n"
       end
       puts "Done, #{filename}."
-    rescue => e
-      puts "ERROR: Unable to generate a new list of tax codes."
+    rescue StandardError => e
+      puts 'ERROR: Unable to generate a new list of tax codes.'
       puts e.message
       raise e
     end
-
   end
 end