taxjar-ruby 3.0.0 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47a7bd26490bf919e6339a26097c87d7d9dd0b09ea6214b87070243da422d03c
-  data.tar.gz: ba4de289c2768c0e52effab858cd0569c3a43f524c34698bafc3cbea8e0eab4f
+  metadata.gz: 18688d5bc45966595ed15e6d20eef07bd736db1344a901f8314cc290ac120dcf
+  data.tar.gz: 2a3f17b97d09c5e4a5bc2f405884374e29bd0e8a326c29892d461bfe2b8db48e
 SHA512:
-  metadata.gz: 7dbea4df68a8bd664c86507f8b266aa1a5901aad30f9b558d8d0e4fa999d36c887a0b6b5acebf511f0a67d8a812d98c60f0693fa4a54057e201765ea67db7ab3
-  data.tar.gz: d152b6c9d34c19fbae78386346d63aa6bab0ac8d95197a7fa700bb7f2c4ea5da5fede05c6f7458f138febeb7a4065c542cf4c86c7bb320474856352858c67d56
+  metadata.gz: 5346c3672896ea11c88c741513003d4567ccc13cc33e7055abcae9529999a227bfc058c0d98a841881cc550c99b87ec0cacfe438f6e2f795c75c0a309e371992
+  data.tar.gz: afd508979ce8b8cce3a0700170b6fb13acfea108faae1caf5fdcdbce173f0f62c18bfb17646e54f68d2bdc86c4713ce5115a3a0f197fdcf82aa20981941b2f0a

data/.travis.yml

@@ -6,5 +6,6 @@ rvm:
  - "2.5"
  - "2.6"
  - "2.7"
+ - "3.0"
 
 script: bundle exec rspec

data/CHANGELOG.md

@@ -7,6 +7,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [3.0.3] - 2022-02-07
+- Throw a `Taxjar::Error::GatewayTimeout` exception when receiving a 504 HTTP status code
+
+## [3.0.2] - 2021-03-18
+- Re-classify `HTTP::ConnectionError` and other `HTTP::Error` types as `Taxjar::Error`
+
+## [3.0.1] - 2021-03-16
+- Throw a `Taxjar::Error` exception for any non-successful HTTP response
+
 ## [3.0.0] - 2020-04-03
 - Add information to custom user agent for debugging and informational purposes
 - Update required Ruby version from 2.0 to 2.3 or higher
@@ -43,7 +52,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Update minimum required Ruby version to 2.0
 - Update HTTP (The Gem) to 2.2
 
-[Unreleased]: https://github.com/taxjar/taxjar-ruby/compare/v3.0.0...HEAD
+[Unreleased]: https://github.com/taxjar/taxjar-ruby/compare/v3.0.3...HEAD
+[3.0.3]: https://github.com/taxjar/taxjar-ruby/compare/v3.0.2...v3.0.3
+[3.0.2]: https://github.com/taxjar/taxjar-ruby/compare/v3.0.1...v3.0.2
+[3.0.1]: https://github.com/taxjar/taxjar-ruby/compare/v3.0.0...v3.0.1
 [3.0.0]: https://github.com/taxjar/taxjar-ruby/compare/v2.6.1...v3.0.0
 [2.6.1]: https://github.com/taxjar/taxjar-ruby/compare/v2.6.0...v2.6.1
 [2.6.0]: https://github.com/taxjar/taxjar-ruby/compare/v2.5.0...v2.6.0

data/README.md

@@ -1,10 +1,10 @@
 # TaxJar Sales Tax API for Ruby [![RubyGems](https://img.shields.io/gem/v/taxjar-ruby.svg?style=flat-square)](https://rubygems.org/gems/taxjar-ruby) [![Build Status](https://img.shields.io/travis/taxjar/taxjar-ruby.svg?style=flat-square)](https://travis-ci.org/taxjar/taxjar-ruby)
 
-<a href="https://developers.taxjar.com"><img src="https://www.taxjar.com/img/TJ_logo_color_office_png.png" alt="TaxJar" width="220"></a>
+<a href="https://developers.taxjar.com"><img src="https://www.taxjar.com/wp-content/uploads/TaxJar__Wordmark_Black.svg" alt="TaxJar" width="220"></a>
 
 A Ruby interface to the TaxJar [Sales Tax API](https://developers.taxjar.com/api/reference/?ruby). TaxJar makes sales tax filing easier for online sellers and merchants. See local jurisdictional tax reports, get payment reminders, and more. You can use our API to access TaxJar API endpoints, which can get information on sales tax rates, categories or upload transactions.
 
-* This wrapper supports 100% of [SmartCalcs v2](https://developers.taxjar.com/api/#introduction)
+* This wrapper supports 100% of the [TaxJar API](https://developers.taxjar.com/api/#introduction)
 * Data returned from API calls are mapped to Ruby objects
 
 <hr>
@@ -1188,7 +1188,7 @@ nexus_regions = client.nexus_regions
 
 ### Validate an address <small>_([API docs](https://developers.taxjar.com/api/reference/?ruby#post-validate-an-address))_</small>
 
-> Validates a customer address and returns back a collection of address matches. **Address validation requires a [TaxJar Plus](https://www.taxjar.com/plus/) subscription.**
+> Validates a customer address and returns back a collection of address matches. **Address validation requires a [TaxJar Professional](https://www.taxjar.com/pricing) subscription.**
 
 #### Definition
 
@@ -1268,7 +1268,7 @@ validation = client.validate({
 
 > Retrieve minimum and average sales tax rates by region as a backup.
 >
-> This method is useful for periodically pulling down rates to use if the SmartCalcs API is unavailable. However, it does not support nexus determination, sourcing based on a ship from and ship to address, shipping taxability, product exemptions, customer exemptions, or sales tax holidays. We recommend using [`tax_for_order` to accurately calculate sales tax for an order](#calculate-sales-tax-for-an-order-api-docs).
+> This method is useful for periodically pulling down rates to use if the TaxJar API is unavailable. However, it does not support nexus determination, sourcing based on a ship from and ship to address, shipping taxability, product exemptions, customer exemptions, or sales tax holidays. We recommend using [`tax_for_order` to accurately calculate sales tax for an order](#calculate-sales-tax-for-an-order-api-docs).
 
 #### Definition
 

data/lib/taxjar/api/request.rb

@@ -34,7 +34,9 @@ module Taxjar
           rescue JSON::ParserError
             nil
           end
-        fail_or_return_response_body(response.code, response_body)
+        fail_or_return_response_body(response, response_body)
+      rescue HTTP::Error => e
+        raise Taxjar::Error, e
       end
 
       private
@@ -72,17 +74,15 @@ module Taxjar
           object
         end
 
-        def fail_or_return_response_body(code, body)
-          e = extract_error(code, body)
-          fail(e) if e
-          body[object_key.to_sym]
-        end
-
-        def extract_error(code, body)
-          return Taxjar::Error.for_json_parse_error(code) if body.nil?
-          klass = Taxjar::Error::ERRORS[code]
-          if !klass.nil?
-            klass.from_response(body)
+        def fail_or_return_response_body(response, body)
+          if body.nil?
+            fail(Taxjar::Error.for_json_parse_error(response.code))
+          elsif response.status.success?
+            body[object_key.to_sym]
+          elsif !(klass = Taxjar::Error::ERRORS[response.code]).nil?
+            fail(klass.from_response(body))
+          else
+            fail(Taxjar::Error.from_response_code(response.code))
           end
         end
     end

data/lib/taxjar/error.rb

@@ -39,6 +39,9 @@ module Taxjar
     # Raised when Taxjar endpoint returns the HTTP status code 503
     ServiceUnavailable = Class.new(ServerError)
 
+    # Raised when Taxjar endpoint returns the HTTP status code 504
+    GatewayTimeout = Class.new(ServerError)
+
     ERRORS = {
       400 => Taxjar::Error::BadRequest,
       401 => Taxjar::Error::Unauthorized,
@@ -50,7 +53,8 @@ module Taxjar
       422 => Taxjar::Error::UnprocessableEntity,
       429 => Taxjar::Error::TooManyRequests,
       500 => Taxjar::Error::InternalServerError,
-      503 => Taxjar::Error::ServiceUnavailable
+      503 => Taxjar::Error::ServiceUnavailable,
+      504 => Taxjar::Error::GatewayTimeout
     }
 
     class << self
@@ -61,6 +65,11 @@ module Taxjar
         new(message, code)
       end
 
+      def from_response_code(code)
+        message = HTTP::Response::Status::REASONS[code] || "Unknown Error"
+        new(message, code)
+      end
+
       def for_json_parse_error(code)
         ServerError.new("Couldn't parse response as JSON.", code)
       end

data/lib/taxjar/version.rb

@@ -10,7 +10,7 @@ module Taxjar
     end
 
     def patch
-      0
+      3
     end
 
     def pre

data/spec/taxjar/api/request_spec.rb

@@ -175,6 +175,24 @@ describe Taxjar::API::Request do
       expect{subject.perform}.to raise_error(Taxjar::Error::ServerError)
     end
 
+    [
+      HTTP::Error,
+      HTTP::ConnectionError,
+      HTTP::RequestError,
+      HTTP::ResponseError,
+      HTTP::StateError,
+      HTTP::TimeoutError,
+      HTTP::HeaderError
+    ].each do |http_error_class|
+      context "#{http_error_class}" do
+        it "is classified as a Taxjar::Error" do
+          stub_request(:get, "https://api.taxjar.com/api_path").to_raise(http_error_class)
+
+          expect{subject.perform}.to raise_error(Taxjar::Error)
+        end
+      end
+    end
+
     Taxjar::Error::ERRORS.each do |status, exception|
       context "when HTTP status is #{status}" do
         it "raises #{exception}" do
@@ -191,5 +209,41 @@ describe Taxjar::API::Request do
         end
       end
     end
+
+    context "when HTTP status is 502" do
+      it "raises Taxjar::Error" do
+        stub_request(:get, "https://api.taxjar.com/api_path").
+          with(:headers => {'Authorization'=>'Bearer AK', 'Connection'=>'close',
+                            'Host'=>'api.taxjar.com'}).
+          to_return(:status => 502,
+                    :body => '{}',
+                    :headers => {content_type: 'application/json; charset=UTF-8'})
+
+        expect{subject.perform}.to raise_error(
+          an_instance_of(Taxjar::Error).and having_attributes({
+            "message" => "Bad Gateway",
+            "code" => 502
+          })
+        )
+      end
+    end
+
+    context "when HTTP status is 5xx" do
+      it "raises Taxjar::Error" do
+        stub_request(:get, "https://api.taxjar.com/api_path").
+          with(:headers => {'Authorization'=>'Bearer AK', 'Connection'=>'close',
+                            'Host'=>'api.taxjar.com'}).
+          to_return(:status => 509,
+                    :body => '{}',
+                    :headers => {content_type: 'application/json; charset=UTF-8'})
+
+        expect{subject.perform}.to raise_error(
+          an_instance_of(Taxjar::Error).and having_attributes({
+            "message" => "Unknown Error",
+            "code" => 509
+          })
+        )
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taxjar-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.3
 platform: ruby
 authors:
 - TaxJar
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -116,7 +116,6 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".rspec"
-- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -187,7 +186,7 @@ metadata:
   changelog_uri: https://github.com/taxjar/taxjar-ruby/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/taxjar/taxjar-ruby
   bug_tracker_uri: https://github.com/taxjar/taxjar-ruby/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -202,8 +201,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for Taxjar API
 test_files:

data/.ruby-version

@@ -1 +0,0 @@
-1.9.3-p0