quiz_api_client 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f901bb687e405ab11127e8cbbe476f38c3578d122d838b25438cc106287b4d83
-  data.tar.gz: 6bae389bad7c912f709747a00a562e42cd10e4b85d1d72f5a7c5ffff6564ae61
+  metadata.gz: 9191c8a80cb0e2a654139c30e5e6ad3662e7589f6bf34a5b9f00b4517de22f99
+  data.tar.gz: 875e4bc7336dac500bbf699438ce9ad457680d6d3ce736b6aff3077efc495dfd
 SHA512:
-  metadata.gz: 519030cead9c1d820cf40bb489029433f751ce41e6488dcddfd7a8520ea2c47c5fa7a8a96e0aaea59640793f0efcc7fcd825c3d5e2fbe026533cb9d18208fd18
-  data.tar.gz: b906985f27f6e78e734f248685ae071efde9414cc3198d5a214caf9d54d8c1d2f29e6cc7d9e53677eac2c1c1d4d9bbd3016f3cea210173c1cf00628784d18507
+  metadata.gz: bf91a4c19851e9c1e4569f25be567ffae06bb91666da2d56cfc28fea0569cf55ce2706e18ebbb5ad38ce1ea9246eb348806f2fd05243250baa8573379ac9a843
+  data.tar.gz: aa366eff458ec1045bab8abae45d5a99bc374327a2d085a70fce32963e730b31d7a1f58ad5150f8978326b0b7608bb27c74b4a4ddde5e5bf3cbd25717ed463ff

data/CHANGELOG.md

@@ -6,6 +6,13 @@ project adheres to [Semantic Versioning](http://semver.org/).
 
 [TOC]
 
+#TODO: Enter the date
+## 4.2.0 ()
+
+### Changed
+* Internal refactor of request error handling
+* Added `metric_handler` and `metrics_namespace` to work with InstStatsd gem
+
 ## 4.1.0 (2021-10-27)
 
 ### Breaking changes (potentially)

data/README.md

@@ -41,6 +41,10 @@ client = QuizApiClient::Client.new(
 
 In order to set addition error information in your error handling system, you can set the `error_hander` property of the config.  The list of valid values can be found in the `QuizApiClient::Config::ERROR_HANDLERS` constant.
 
+### Metrics
+
+HTTP Request metrics will now be provided if the `setup_metrics` method is called.  The list of valid values can be found in the `QuizApiClient::Config::METRICS_HANDLERS` constant.  The count and duration metrics will be provided under the namespace provided.
+
 ### Creation of Tokens
 
 JWTs are created without hitting quiz_api and and they are validated on quiz_api. Tokens are created for a given scope, expiration, and an optional resource_id.

data/lib/quiz_api_client/config.rb

@@ -3,10 +3,13 @@ module QuizApiClient
     DEFAULT_ALLOWABLE_RESPONSE_CODES = [401, 422].freeze
     DEFAULT_PROTOCOL = 'https'.freeze
     ERROR_HANDLERS = %i[sentry_raven].freeze
+    METRICS_HANDLERS = %i[inststatsd].freeze
 
     class InvalidErrorHandler < StandardError; end
+    class InvalidMetricsHandler < StandardError; end
+    class InvalidMetricsNamespace < StandardError; end
 
-    attr_reader :error_handler
+    attr_reader :error_handler, :metrics_handler, :metrics_namespace
     attr_writer :protocol, :allowable_response_codes
     attr_accessor :consumer_key, :consumer_request_id, :host, :shared_secret
 
@@ -19,9 +22,17 @@ module QuizApiClient
     end
 
     def error_handler=(handler)
-      validate_error_hander!(handler)
+      validate_error_handler!(handler)
 
-      @error_handler = handler
+      @error_handler = handler.to_sym
+    end
+
+    def setup_metrics(handler, namespace)
+      validate_metrics_handler!(handler)
+      validate_metrics_namespace!(namespace)
+
+      @metrics_handler = handler.to_sym
+      @metrics_namespace = namespace.to_s.strip
     end
 
     def allowable_response_codes
@@ -30,14 +41,24 @@ module QuizApiClient
 
     private
 
-    def validate_error_hander!(handler)
+    def validate_error_handler!(handler)
       return unless handler
+      return if ERROR_HANDLERS.include?(handler)
 
-      unless ERROR_HANDLERS.include?(handler)
-        raise InvalidErrorHandler, "It must be one of the following: #{ERROR_HANDLERS.inspect}"
-      end
+      raise InvalidErrorHandler, "It must be one of the following: #{ERROR_HANDLERS.inspect}"
+    end
 
-      @error_handler = handler.to_sym
+    def validate_metrics_handler!(handler)
+      return unless handler
+      return if METRICS_HANDLERS.include?(handler)
+
+      raise InvalidMetricsHandler, "It must be one of the following: #{METRICS_HANDLERS.inspect}"
+    end
+
+    def validate_metrics_namespace!(namespace)
+      return unless namespace.nil? || namespace.to_s.strip == ''
+
+      raise InvalidMetricsNamespace, 'It must be present'
     end
   end
 end

data/lib/quiz_api_client/http_client.rb

@@ -82,6 +82,7 @@ module QuizApiClient
     end
 
     def make_request(method, url, request_options = {})
+      start_time = Time.now
       resp = self.class.send(
         method,
         url,
@@ -91,6 +92,8 @@ module QuizApiClient
       resp
     rescue HTTParty::Error, Errno::ECONNREFUSED, Net::ReadTimeout => e
       raise_error(method, url, current_error: e)
+    ensure
+      record_metrics(method, url, resp, start_time, Time.now)
     end
 
     def make_paginated_request(method, url, options)
@@ -146,50 +149,18 @@ module QuizApiClient
       [url, options.merge(query: query)]
     end
 
-    def generate_error_context(method, url, response = nil)
-      context = {
-        quiz_api_client: {
-          request: {
-            method: method,
-            url: url
-          }
-        }
-      }
-
-      if response
-        context[:quiz_api_client][:response] = {
-          body: response.body,
-          code: response.code
-        }
-      end
-
-      context
-    end
-
-    def record_error_context(context)
-      case config.error_handler
-      when :sentry_raven
-        require 'sentry-raven'
-        Raven.extra_context(context)
-      end
-    end
+    def raise_error(method, url, response: nil, current_error: nil)
+      failure = QuizApiClient::HttpRequest::Failure.new(config)
 
-    def error_message(current_error, url, response)
-      if current_error && response
-        "#{current_error.message}: #{url} responded #{response.body} (#{response.code})"
-      elsif current_error
-        current_error.message
-      elsif response
-        "#{url} responded #{response.body} (#{response.code})"
-      end
+      failure.raise_error(method, url, response: response, current_error: current_error)
     end
 
-    def raise_error(method, url, response: nil, current_error: nil, error_class: RequestFailed)
-      context = generate_error_context(method, url, response)
-
-      record_error_context(context)
+    def record_metrics(method, url, resp, start_time, end_time)
+      code = resp&.code || 0
+      metrics = QuizApiClient::HttpRequest::Metrics.new(config, method, url, code)
 
-      raise error_class.new(context), error_message(current_error, url, response)
+      metrics.increment
+      metrics.duration(start_time, end_time)
     end
 
     def successful_response?(resp)

data/lib/quiz_api_client/http_request/failure.rb

@@ -0,0 +1,65 @@
+module QuizApiClient
+  module HttpRequest
+    class Failure
+      attr_reader :config
+
+      def initialize(config)
+        @config = config
+      end
+
+      def raise_error(
+        method,
+        url,
+        response: nil,
+        current_error: nil,
+        error_class: QuizApiClient::HttpClient::RequestFailed
+      )
+        context = generate_error_context(method, url, response)
+
+        record_error_context(context)
+
+        raise error_class.new(context), error_message(current_error, url, response)
+      end
+
+      private
+
+      def generate_error_context(method, url, response = nil)
+        context = {
+          quiz_api_client: {
+            request: {
+              method: method,
+              url: url
+            }
+          }
+        }
+
+        if response
+          context[:quiz_api_client][:response] = {
+            body: response.body,
+            code: response.code
+          }
+        end
+
+        context
+      end
+
+      def record_error_context(context)
+        case config.error_handler
+        when :sentry_raven
+          require 'sentry-raven'
+          Raven.extra_context(context)
+        end
+      end
+
+      def error_message(current_error, url, response)
+        if current_error && response
+          "#{current_error.message}: #{url} responded #{response.body} (#{response.code})"
+        elsif current_error
+          current_error.message
+        elsif response
+          "#{url} responded #{response.body} (#{response.code})"
+        end
+      end
+    end
+  end
+end

data/lib/quiz_api_client/http_request/metrics.rb

@@ -0,0 +1,67 @@
+module QuizApiClient
+  module HttpRequest
+    class Metrics
+      extend Forwardable
+
+      attr_reader :config, :method, :url, :code
+      def_delegators :config, :metrics_handler, :metrics_namespace
+
+      def initialize(config, method, url, code)
+        @config = config
+        @method = method
+        @url = url
+        @code = code
+      end
+
+      def increment
+        return unless configured?
+
+        case metrics_handler
+        when :inststatsd
+          InstStatsd::Statsd.increment count_metric_name, tags: tags
+        end
+      end
+
+      def duration(start_time, end_time)
+        return unless configured?
+
+        duration_ms = ((end_time - start_time) * 1_000).round
+
+        case metrics_handler
+        when :inststatsd
+          InstStatsd::Statsd.timing duration_metric_name, duration_ms, tags: tags
+        end
+      end
+
+      private
+
+      def configured?
+        metrics_handler_present? && metrics_namespace_present?
+      end
+
+      def count_metric_name
+        "#{metrics_namespace}.quiz_api_client.request.count"
+      end
+
+      def duration_metric_name
+        "#{metrics_namespace}.quiz_api_client.request.duration_ms"
+      end
+
+      def metrics_handler_present?
+        !metrics_handler.nil?
+      end
+
+      def metrics_namespace_present?
+        !metrics_namespace.nil?
+      end
+
+      def tags
+        {
+          method: method,
+          status: code,
+          url: url
+        }
+      end
+    end
+  end
+end

data/lib/quiz_api_client/version.rb

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

data/lib/quiz_api_client.rb

@@ -101,6 +101,8 @@ require 'quiz_api_client/version'
 require 'quiz_api_client/config'
 require 'quiz_api_client/http_client'
 require 'quiz_api_client/json_formatter'
+require 'quiz_api_client/http_request/failure'
+require 'quiz_api_client/http_request/metrics'
 require 'quiz_api_client/services/jwt_service'
 require 'quiz_api_client/services/base_api_service'
 

data/quiz_api_client.gemspec

@@ -48,6 +48,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'jwt', '~> 2.2'
   spec.add_dependency 'link_header', '~> 0.0'
 
+  spec.add_development_dependency 'inst_statsd'
   spec.add_development_dependency 'pact', '~> 1.41'
   spec.add_development_dependency 'pact_broker-client', '~> 1.19'
   spec.add_development_dependency 'rake', '~> 12.3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quiz_api_client
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Chris Wang
@@ -20,7 +20,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -64,6 +64,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: inst_statsd
+  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: pact
   requirement: !ruby/object:Gem::Requirement
@@ -214,6 +228,8 @@ files:
 - lib/quiz_api_client.rb
 - lib/quiz_api_client/config.rb
 - lib/quiz_api_client/http_client.rb
+- lib/quiz_api_client/http_request/failure.rb
+- lib/quiz_api_client/http_request/metrics.rb
 - lib/quiz_api_client/json_formatter.rb
 - lib/quiz_api_client/services/base_api_service.rb
 - lib/quiz_api_client/services/interaction_types_service.rb