quiz_api_client 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48279a4ca7eeb3d7fc50e493733f5718c2960b2267d70db68b2956b0b11c99c1
-  data.tar.gz: cbd66f799b72273b23b2e7a208fc10336bee5cf2cb93656987d0fdc5d1c173a7
+  metadata.gz: f901bb687e405ab11127e8cbbe476f38c3578d122d838b25438cc106287b4d83
+  data.tar.gz: 6bae389bad7c912f709747a00a562e42cd10e4b85d1d72f5a7c5ffff6564ae61
 SHA512:
-  metadata.gz: d448acbf4ac471f2c8f55cda52191d35ade2d0e107546946e9cee8f6712556ac402160150555d8e3f978034843240deeeb4cec0a658a5fdf8ce2b2b8d3e1a452
-  data.tar.gz: c73951b3bc89f5ff17b08ac1199aff03f3fd2a7e9cf701d5b2d9fffcc31d4bc76ddd2cc4384622584479ab32f2abf85abc3993554fb8a872a4b961eb8b23b4a3
+  metadata.gz: 519030cead9c1d820cf40bb489029433f751ce41e6488dcddfd7a8520ea2c47c5fa7a8a96e0aaea59640793f0efcc7fcd825c3d5e2fbe026533cb9d18208fd18
+  data.tar.gz: b906985f27f6e78e734f248685ae071efde9414cc3198d5a214caf9d54d8c1d2f29e6cc7d9e53677eac2c1c1d4d9bbd3016f3cea210173c1cf00628784d18507

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+CHANGELOG
+=========
+
+All notable changes to this project will be documented in this file. This
+project adheres to [Semantic Versioning](http://semver.org/).
+
+[TOC]
+
+## 4.1.0 (2021-10-27)
+
+### Breaking changes (potentially)
+
+* All non-successful (2xx) responses will raise `QuizApiClient::HttpClient::RequestFailed` error except for 401 and 422
+  * Can be overridden in `allowable_response_codes` config
+
+## 4.0.0 (2021-10-18)
+
+### Breaking changes
+
+* Ruby 2.4.x is no longer supported
+* Ruby 2.5.x is no longer supported
+
+### Changed
+* Minimum Ruby version to 2.6.x
+* Internal classes use a configuration object instead parameters on instantiation
+  * Instantiating `QuizApiClient::Client` remains the same
+* Added `error_handler` configuration to work with Sentry Raven gem
+

data/lib/quiz_api_client/config.rb

@@ -1,12 +1,13 @@
 module QuizApiClient
   class Config
+    DEFAULT_ALLOWABLE_RESPONSE_CODES = [401, 422].freeze
     DEFAULT_PROTOCOL = 'https'.freeze
     ERROR_HANDLERS = %i[sentry_raven].freeze
 
     class InvalidErrorHandler < StandardError; end
 
     attr_reader :error_handler
-    attr_writer :protocol
+    attr_writer :protocol, :allowable_response_codes
     attr_accessor :consumer_key, :consumer_request_id, :host, :shared_secret
 
     def initialize
@@ -23,6 +24,10 @@ module QuizApiClient
       @error_handler = handler
     end
 
+    def allowable_response_codes
+      @allowable_response_codes || DEFAULT_ALLOWABLE_RESPONSE_CODES
+    end
+
     private
 
     def validate_error_hander!(handler)

data/lib/quiz_api_client/http_client.rb

@@ -4,7 +4,14 @@ module QuizApiClient
   class HttpClient
     include HTTParty
 
-    class RequestFailed < StandardError; end
+    class RequestFailed < StandardError
+      attr_reader :context
+
+      def initialize(context)
+        @context = context
+        super(context)
+      end
+    end
 
     attr_reader :jwt, :uri, :config
 
@@ -75,11 +82,13 @@ module QuizApiClient
     end
 
     def make_request(method, url, request_options = {})
-      self.class.send(
+      resp = self.class.send(
         method,
         url,
         default_request_data.merge(request_options)
       )
+      raise_error(method, url, response: resp) unless successful_response?(resp)
+      resp
     rescue HTTParty::Error, Errno::ECONNREFUSED, Net::ReadTimeout => e
       raise_error(method, url, current_error: e)
     end
@@ -91,8 +100,6 @@ module QuizApiClient
 
       until request_url.nil?
         resp = make_request(method, request_url, request_options)
-        raise_error(method, url, response: resp) unless resp.code == 200
-
         entities.concat(resp.parsed_response)
         request_url, request_options = next_page(resp, url, options)
       end
@@ -182,7 +189,11 @@ module QuizApiClient
 
       record_error_context(context)
 
-      raise error_class, error_message(current_error, url, response)
+      raise error_class.new(context), error_message(current_error, url, response)
+    end
+
+    def successful_response?(resp)
+      resp.success? || config.allowable_response_codes.include?(resp.code)
     end
   end
 end

data/lib/quiz_api_client/version.rb

@@ -1,3 +1,3 @@
 module QuizApiClient
-  VERSION = '4.0.0'.freeze
+  VERSION = '4.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Chris Wang
@@ -20,7 +20,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-18 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -200,6 +200,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Dockerfile
 - Gemfile
 - Jenkinsfile