suretax 1.0.2 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b5d53ab784021867bfd2f58a97c7e2f419fc4198
-  data.tar.gz: f540f107cc97af0d594dda3e7bcdc93b0ff88878
+SHA256:
+  metadata.gz: 620a9d4fb40588a041c883da4f0ebeba65d78a03b1b215808c1ad92b8d5cd48d
+  data.tar.gz: 1070aa9064d87eddfa9e541e75cfd45413f95fb9baff06718ae4505b108a76a3
 SHA512:
-  metadata.gz: d96a1068aac2f733470687d58bff68bd27bed67f7a5e8fcc48b23a834f6e85113a9a92a9698aa3d5603087809b6da9915d21d21d440e88371c6ddbf8b6c09353
-  data.tar.gz: 7438dd784baecae802d71d563ebd7f6f5e4d824328e42b1c70a9e6866b407aaaba5371d070bee568b52b28cf184686ed3cc63d72904700e02d3250d1d725f7e1
+  metadata.gz: 38ded09d6aa2104b5aa384669a6f5a51ee18178844b0a1e08909cefc9cb8ba549d6a46ce12d167786c872990bf83158e62b33d5274fd696e8bb0f1d977f4792d
+  data.tar.gz: c6931fb4060cb38e409f6b9adead8a81c5b8eb30c6f1af566c678afecb70008dd1ab96b7dce02be95107b481dfc5de8c18f287955cd371cb1e106e11662804e3

data/.circleci/config.yml

@@ -0,0 +1,44 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.7.0
+    environment:
+      RAILS_ENV: test
+      RAKE_ENV: test
+      SURETAX_BASE_URL: "https://testapi.taxrating.net"
+      SURETAX_VALIDATION_KEY: "xxxxxxxxxx"
+      SURETAX_CLIENT_NUMBER: "000000000"
+      SURETAX_POST_PATH: "/Services/V01/SureTax.asmx/PostRequest"
+      SURETAX_CANCEL_PATH: "/Services/V01/SureTax.asmx/CancelPostRequest"
+    working_directory: ~/suretax
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+            bundle exec rspec --format progress \
+                            --format RspecJunitFormatter \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/.env.test

@@ -0,0 +1,4 @@
+SURETAX_VALIDATION_KEY=885aa2c6-1a61-4ec6-9aa6-296120572b5e
+SURETAX_CLIENT_NUMBER=000000123
+SURETAX_BASE_URL=https://testapi.taxrating.net
+SURETAX_REQUEST_VERSION=02

data/.rubocop.yml

@@ -8,7 +8,7 @@ AllCops:
   Exclude:
     - vendor/**/*
     - db/**/*
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
 
 Rails:
   Enabled: true

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.7.0

data/Gemfile

@@ -1,4 +1,12 @@
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in suretax.gemspec
 gemspec
+
+group :development, :test do
+  gem "dotenv"
+  gem "pry-byebug"
+  gem "rspec", "~> 3.9.0"
+  gem "rspec-its"
+  gem "rspec_junit_formatter"
+  gem "webmock"
+end

data/Gemfile.lock

@@ -1,67 +1,74 @@
 PATH
   remote: .
   specs:
-    suretax (1.0.1)
+    suretax (1.1.2)
       excon
       monetize
-      money (~> 6.9.0)
+      money (~> 6.13)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.7)
-    awesome_print (1.6.1)
-    coderay (1.1.0)
-    crack (0.4.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    dotenv (1.0.2)
-    excon (0.56.0)
-    i18n (0.8.4)
-    method_source (0.8.2)
-    monetize (1.7.0)
-      money (~> 6.9)
-    money (6.9.0)
-      i18n (>= 0.6.4, < 0.9)
-    pry (0.10.1)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.4.2)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.4)
+    diff-lcs (1.3)
+    dotenv (2.7.5)
+    excon (0.73.0)
+    hashdiff (1.0.1)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    monetize (1.9.4)
+      money (~> 6.12)
+    money (6.13.7)
+      i18n (>= 0.6.4, <= 2)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-its (1.2.0)
+      rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.4)
-    safe_yaml (1.0.4)
-    slop (3.6.0)
-    webmock (1.20.4)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    safe_yaml (1.0.5)
+    webmock (3.8.3)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  awesome_print
-  bundler (~> 1.3)
   dotenv
-  pry
-  rake
-  rspec (~> 3.0.0)
-  rspec-its (~> 1.0)
+  pry-byebug
+  rspec (~> 3.9.0)
+  rspec-its
+  rspec_junit_formatter
   suretax!
   webmock
 
 BUNDLED WITH
-   1.15.1
+   2.1.2

data/README.md

@@ -1,6 +1,5 @@
 # Suretax
-[![Code Climate](https://codeclimate.com/github/bqsoft/suretax.png)](https://codeclimate.com/github/bqsoft/suretax)
-
+[![Code Climate](https://codeclimate.com/github/hello-labs/suretax.png)](https://codeclimate.com/github/hello-labs/suretax)
 
 ## Synopsis
 
@@ -28,17 +27,14 @@ Suretax transactions.  The validation_key, client_number, and
 base_url may be overridden by supplying the key when instantiating
 a Suretax::Api::Request object.
 
-
-If not supplied, the base_url will default to the Suretax test 
+If not supplied, the base_url will default to the Suretax test
 host (https://testapi.taxrating.net) and the request version
 and cancel version will default to the latest versions available
 (currently V03 and V01 respectively).
 
-
 You can peek inside the tests for more examples and to see what data
 methods are available.
 
-
 ## Development Environment
 
 Suretax uses [dotenv] to easily switch between development/test environments

data/lib/suretax.rb

@@ -1,15 +1,16 @@
 require "suretax/version"
-
 require "suretax/concerns"
-
 require "suretax/configuration"
 require "suretax/connection"
 require "suretax/response"
 require "suretax/constants"
 require "suretax/api"
-
 require "money"
 
+Money.locale_backend = :currency
+Money.default_currency = Money::Currency.new("USD")
+Money.rounding_mode = BigDecimal::ROUND_HALF_EVEN
+
 module Suretax
   class << self
     attr_accessor :configuration

data/lib/suretax/api/request.rb

@@ -1,6 +1,7 @@
 module Suretax
   module Api
     class ValidationError < StandardError; end
+    class ConnectionError < StandardError; end
 
     class Request
       include Suretax::Concerns::Validatable

data/lib/suretax/configuration.rb

@@ -64,17 +64,17 @@ module Suretax
     def register_dollar_with_six_decimal_places
       Money::Currency.register(
         priority: 1,
-iso_code: "US6",
-iso_numeric: "840",
-name: "Dollar with six decimal places",
-symbol: "$",
-subunit: "Cent",
-subunit_to_unit: 1_000_000,
-symbol_first: true,
-html_entity: "$",
-decimal_mark: ".",
-thousands_separator: ",",
-symbolize_names: true
+        iso_code: "US6",
+        iso_numeric: "840",
+        name: "Dollar with six decimal places",
+        symbol: "$",
+        subunit: "Cent",
+        subunit_to_unit: 1_000_000,
+        symbol_first: true,
+        html_entity: "$",
+        decimal_mark: ".",
+        thousands_separator: ",",
+        symbolize_names: true
       )
     end
   end

data/lib/suretax/constants.rb

@@ -4,4 +4,6 @@ module Suretax
   require "suretax/constants/sales_type_codes"
   require "suretax/constants/tax_situs_codes"
   require "suretax/constants/transaction_type_codes"
+  require "suretax/constants/tax_exemption_codes"
+  require "suretax/constants/tax_type_exemption_code_mapping"
 end

data/lib/suretax/constants/tax_type_exemption_code_mapping.rb

@@ -0,0 +1,28 @@
+module Suretax
+  TAX_TYPE_EXEMPTION_CODES = [
+    { "exemption_code" => "01", "tax_types" => %w[000] },
+    { "exemption_code" => "24", "tax_types" => %w[035] },
+    { "exemption_code" => "35", "tax_types" => %w[060] },
+    { "exemption_code" => "09", "tax_types" => %w[000 035 060] },
+    { "exemption_code" => "11", "tax_types" => %w[106 133 233 333 433 533] },
+    { "exemption_code" => "13", "tax_types" => %w[224 324 424] },
+    { "exemption_code" => "14", "tax_types" => %w[106 133 233 333 433 533] },
+    { "exemption_code" => "20", "tax_types" => %w[108 208 308 408 508] },
+    { "exemption_code" => "21", "tax_types" => %w[128 228 328 428 528 132 232 332 432 532] },
+    { "exemption_code" => "22", "tax_types" => %w[126 226 326 426 526] },
+    { "exemption_code" => "23", "tax_types" => %w[126 226 326 426 526 128 228 328 428 528 132 232 332 432 532] },
+    { "exemption_code" => "31", "tax_types" => %w[101] },
+    { "exemption_code" => "25", "tax_types" => %w[000 035 101] },
+    { "exemption_code" => "26", "tax_types" => %w[127] },
+    { "exemption_code" => "30", "tax_types" => %w[127 227 327 427 137 237 337 437] },
+    { "exemption_code" => "36", "tax_types" => %w[051 151 251 351 451 551] },
+    { "exemption_code" => "37", "tax_types" => %w[042 142 242 342 442 542] },
+    { "exemption_code" => "38", "tax_types" => %w[041 141 241 341 441 541] },
+    { "exemption_code" => "39", "tax_types" => %w[040 140 240 340 440 540] },
+    { "exemption_code" => "41", "tax_types" => %w[016 116 216 316 416 516] },
+    { "exemption_code" => "42", "tax_types" => %w[117 127 417 427] },
+    { "exemption_code" => "43", "tax_types" => %w[022 122 222 322 422 522] },
+    { "exemption_code" => "45", "tax_types" => %w[123] },
+    { "exemption_code" => "46", "tax_types" => %w[236 336 436 536] }
+  ].freeze
+end

data/lib/suretax/response.rb

@@ -27,6 +27,8 @@ module Suretax
       @status = map_response_code_to_http_status(api.status)
       log_response
       self
+    rescue JSON::ParserError => e
+      raise(Suretax::Api::ConnectionError, "Failed to parse response from SureTax: #{e.inspect}")
     end
 
     def invalid_request_response(sanitized_body)

data/lib/suretax/version.rb

@@ -1,3 +1,3 @@
 module Suretax
-  VERSION = "1.0.2".freeze
+  VERSION = "1.1.2".freeze
 end

data/spec/lib/suretax/response_spec.rb

@@ -129,4 +129,12 @@ describe Suretax::Response do
       expect(client_response).to_not be_success
     end
   end
+
+  context "when posting fails with a html error" do
+    let(:response_body) { suretax_wrap_response("html error") }
+
+    it "should raise connection error" do
+      expect { client_response }.to raise_error(Suretax::Api::ConnectionError)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,11 +1,10 @@
-require "dotenv"  # First line of spec_helper
-Dotenv.load       # Second line of spec_helper
+require "dotenv"
+Dotenv.load(".env.test")
 
 require "pry"
 require "rspec"
 require "rspec/its"
 require "suretax"
-require "awesome_print"
 require "webmock/rspec"
 
 # Load support files
@@ -16,8 +15,8 @@ end
 RSpec.configure do |config|
   config.before(:each) do
     Suretax.configure do |c|
-      c.validation_key  = ENV["SURETAX_VALIDATION_KEY"]
-      c.client_number   = ENV["SURETAX_CLIENT_NUMBER"]
+      c.validation_key = ENV["SURETAX_VALIDATION_KEY"]
+      c.client_number = ENV["SURETAX_CLIENT_NUMBER"]
     end
   end
 
@@ -30,9 +29,6 @@ RSpec.configure do |config|
   end
 end
 
-# Silence deprecation warning from money/monetize libraries
-I18n.enforce_available_locales = false
-
 include RequestSpecHelper
 include CancellationSpecHelper
 include SuretaxSpecHelper

data/spec/support/request_helper.rb

@@ -351,4 +351,22 @@ module RequestSpecHelper
       common_carrier: nil
     }
   end
+
+  def suretax_html_error
+    "<html xmlns='http://www.w3.org/1999/xhtml'>
+    <head>
+    <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
+    <title>502 - Web server received an invalid response while acting as a gateway or proxy server.</title>
+    </head>
+    <body>
+    <div id='header'><h1>Server Error</h1></div>
+    <div id='content'>
+     <div class='content-container'><fieldset>
+      <h2>502 - Web server received an invalid response while acting as a gateway or proxy server.</h2>
+      <h3>There is a problem with the page you are looking for, and it cannot be displayed. When the Web server (while acting as a gateway or proxy) contacted the upstream content server, it received an invalid response from the content server.</h3>
+     </fieldset></div>
+    </div>
+    </body>
+    </html>"
+  end
 end

data/suretax.gemspec

@@ -20,15 +20,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "excon"
-  spec.add_dependency "money", "~> 6.9.0"
+  spec.add_dependency "money", "~> 6.13"
   spec.add_dependency "monetize"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.0.0"
-  spec.add_development_dependency "rspec-its", "~> 1.0"
-  spec.add_development_dependency "dotenv"
-  spec.add_development_dependency "awesome_print"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suretax
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.2
 platform: ruby
 authors:
 - Damon Davison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-27 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.9.0
+        version: '6.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.9.0
+        version: '6.13'
 - !ruby/object:Gem::Dependency
   name: monetize
   requirement: !ruby/object:Gem::Requirement
@@ -52,118 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: rspec-its
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  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'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  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'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  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'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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: A wrapper library for the SureTax communications tax API
 email:
 - damon@allolex.net
@@ -171,7 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".env.example"
+- ".env.test"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -179,10 +69,8 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- NOTES.md
 - README.md
 - Rakefile
-- circle.yml
 - lib/suretax.rb
 - lib/suretax/api.rb
 - lib/suretax/api/cancel_request.rb
@@ -203,6 +91,7 @@ files:
 - lib/suretax/constants/sales_type_codes.rb
 - lib/suretax/constants/tax_exemption_codes.rb
 - lib/suretax/constants/tax_situs_codes.rb
+- lib/suretax/constants/tax_type_exemption_code_mapping.rb
 - lib/suretax/constants/transaction_type_codes.rb
 - lib/suretax/response.rb
 - lib/suretax/version.rb
@@ -243,8 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: This gem will allow Ruby developers to easily integrate SureTax into their

data/NOTES.md

@@ -1,3 +0,0 @@
-# Suretax gem notes
-
-- Deal with post failures and parse errors in Response.

data/circle.yml

@@ -1,7 +0,0 @@
-machine:
-  environment:
-    SURETAX_BASE_URL: "https://testapi.taxrating.net"
-    SURETAX_VALIDATION_KEY: "xxxxxxxxxx"
-    SURETAX_CLIENT_NUMBER: "000000000"
-    SURETAX_POST_PATH: "/Services/V01/SureTax.asmx/PostRequest"
-    SURETAX_CANCEL_PATH: "/Services/V01/SureTax.asmx/CancelPostRequest"