tax_cloud 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dce34f03969027431c16d3504d5f02106ae8c086
-  data.tar.gz: c55d7e4fa58df6cc206994e42ad2f0bfff8ead2b
+SHA256:
+  metadata.gz: 2460bb8644d05b7169cd48c66cf45044c83d85b3bd9a4294f8a89b4313890774
+  data.tar.gz: f2e119009a8f5e45f379ed3a0b39d7417897504e502b21bf8e32b03dc02d5843
 SHA512:
-  metadata.gz: 4c0b46885a58ebf4ba0d807d32e7b342d57b5057824d024cc60ab699e32ec5ff9ea2f815ad466362d91e468f962c1bb9b198052052adfed99b74829d4308efc7
-  data.tar.gz: 4b909e99313bfcb962d44d124cdaf1b8d2d4c27d1d067549ad00f823d474fbd1c6fe0ffc5912f3fc38aeb7cd6da9677cf89637844c7870b9bdd709642bfb1521
+  metadata.gz: ab1f5b780aa0a1e6bc8b8f3345c15d9ea93bb9ce822805fb1a842d2c7fb42a4fc1cb17eb84206dc818af9131e498315abf17f360fb9e1a777e48083bae6607f6
+  data.tar.gz: 3eeb12ff2d77868a321fafbc81d52f7cd2abcd7ae8dd24f1ca8800b72db8a47b58e1ceb5f33bd5f0535e87b98f20954dd169e7cf58bc8e19ff00b8ebf141c84c

data/.rubocop.yml

@@ -1,29 +1,12 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
-  Excludes:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  Exclude:
     - vendor/**
     - 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/.travis.yml

@@ -1,6 +1,6 @@
+language: ruby
+before_install:
+  - gem update bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - jruby-19mode
-  - rbx-2.1.1
+  - 2.6.0
+  - 2.7.0

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+=== 0.4.0 (12/7/2020)
+
+* Add <tt>open_timeout</tt> and <tt>read_timeout</tt> options into configuration - @ka8725.
+* Switch to using BigDecimal for <tt>tax_amount</tt> 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.

data/CONTRIBUTORS.txt

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

data/Gemfile

@@ -1,9 +1,20 @@
-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'
+  gem 'rdoc'
 end

data/LICENSE.rdoc

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2011-2012 Drew Tempelmeyer & Contributors
+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

data/README.rdoc

@@ -1,16 +1,16 @@
 = TaxCloud
 
-{<img src="https://travis-ci.org/drewtempelmeyer/tax_cloud.png" />}[https://travis-ci.org/drewtempelmeyer/tax_cloud]
+{<img src="https://travis-ci.org/txcrb/tax_cloud.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/txcrb/tax_cloud]
 
 TaxCloud[http://www.taxcloud.com] is a free service to calculate sales tax and generate tax reports. The <tt>tax_cloud</tt> 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 UserID. To obtain your USPS UserID:
-1. Download and Install the USPS Shipping Assistant from http://www.usps.com/shippingassistant.
-2. Launch the USPS Shipping Assistant and go through the Shipping Assistant registration process.
-3. Once you have registered for your Shipping Assistant account, you can find your USPS Shipping Assistant UserID in the "About" box, in parentheses to the right of the name of the registered user.
+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.
@@ -22,9 +22,13 @@ Configure your environment. For example, create an initializer in Rails in <tt>c
     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'
+      config.usps_username = 'your_usps_username' # optional
+      config.open_timeout = 1 # optional
+      config.read_timeout = 1 # optional
     end
 
+The <tt>open_timeout</tt> and <tt>read_timeout</tt> options are used to specify waiting time for the TaxCloud web service response in seconds. Default values: <tt>open_timeout = 2</tt> and <tt>read_timeout = 2</tt>.
+
 === Using TaxCloud
 Define the destination and origin addresses using <tt>TaxCloud::Address</tt>.
 
@@ -116,7 +120,7 @@ Tax code constants are defined in <tt>tax_code_constants.rb</tt> and tax code gr
     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.net/account/states. You can find more information about SSUTA here[http://www.streamlinedsalestax.org/index.php?page=About-Us].
+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 <tt>test/cassettes</tt> directory.
@@ -135,6 +139,6 @@ TaxCloud manages a list of states in which you can calculate sales tax. The defa
 
 === License
 
-Copyright Drew Tempelmeyer and contributors, 2011-2014.
+Copyright Drew Tempelmeyer and contributors, 2011-2020.
 
 This gem is licensed under the MIT license.

data/Rakefile

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rdoc/task'
+require 'vcr'
 
-gemspec = eval(File.read(Dir["*.gemspec"].first))
+README = 'README.rdoc'
 
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -11,25 +14,18 @@ Rake::TestTask.new(:test) do |test|
 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_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

data/lib/tax_cloud.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require 'savon'
 require 'i18n'
 require 'hash'
+
+require 'active_support'
 require 'active_support/core_ext'
 
 require 'tax_cloud/version'
@@ -25,7 +29,7 @@ I18n.load_path << File.join(File.dirname(__FILE__), 'config', 'locales', 'en.yml
 # For information on configuring and using the TaxCloud API, look at the <tt>README</tt> file.
 module TaxCloud
   # WSDL location for TaxCloud API.
-  WSDL_URL = 'https://api.taxcloud.net/1.0/?wsdl'
+  WSDL_URL = 'https://asmx.taxcloud.com/1.0/?wsdl'
 
   # TaxCloud API version.
   API_VERSION = '1.0'
@@ -36,7 +40,7 @@ module TaxCloud
 
     # Returns true if the gem has been configured.
     def configured?
-      !!configuration
+      configuration.present?
     end
 
     # Configure the gem.
@@ -60,7 +64,8 @@ module TaxCloud
     private
 
     def check_configuration!
-      fail TaxCloud::Errors::MissingConfig.new unless self.configuration
+      raise TaxCloud::Errors::MissingConfig unless self.configuration
+
       self.configuration.check!
     end
   end