apimatic_core 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c581361453ae63c619ca7b7bcc5b2e4cb5cd2afe4ab1f7584462a0698ab8be3d
-  data.tar.gz: 51c745d2ac8600da653324628f1cf4e00e2059ceb12e22f150f49ec2ed3a9f03
+  metadata.gz: 43a0787b023f7ffa1b7c2a85955b951607f73678560cd1ae5ed5093a98e39787
+  data.tar.gz: 6753fbba0aeb9f496c4a926a226b55fe6aa6245b836ac027fd86d0b9cb295a12
 SHA512:
-  metadata.gz: 1a87d5f62193c6f46e4fda2289d5c4a8cae5d716ee35723f030d6ad97ffc569ffec23019e89065a5882ea806aec791ea121bc8f0e326496a923a49feb0c1b484
-  data.tar.gz: 44acde48930a6e621608d30fb646e9f467e0fba89c07520016e55e2b017b17f239ede9bcc0de1e79537e5303da469b91f1fd2f1844a212f10bd92a40b48cd103
+  metadata.gz: a3d9f9fe3b80a7980b632ac2a6b3fa34780aec0e94cefc7f8f0f1a4a632e99e0da7b2d66cf48f279356cee3486c4595e1ebe48764afcaa7344562732a91ea7f2
+  data.tar.gz: 125c4d4c4dadcd5c069b78eed5b703493e46e666575d1e926acb0e7a4b62099627ed97d8703b502e5e2d476edbf14e34f4438b4733198e00ca5b13a8378cbbf6

data/README.md

@@ -1,8 +1,8 @@
 # apimatic-core
-[//]: # ([![PyPI][rubygems-version]][rubygems-apimatic-faraday-client-adapter-url])
+
+[![Gem Version](https://badge.fury.io/rb/apimatic_core.svg)](https://badge.fury.io/rb/apimatic_core)
 [![Tests][test-badge]][test-url]
 [![Linting][lint-badge]][lint-url]
-[![Maintainability][maintainability-url]][code-climate-url]
 [![Test Coverage][test-coverage-url]][code-climate-url]
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
 [![Licence][license-badge]][license-url]
@@ -86,10 +86,8 @@ gem 'apimatic_core'
 | [`XmlHelper`](lib/apimatic-core/utilities/xml_helper.rb )              | A Helper class that holds utility methods for xml serialization and deserialization. |
 
 ## Links
-* [apimatic_core_interfaces](link here)
+* [apimatic_core_interfaces](https://rubygems.org/gems/apimatic_core_interfaces)
 
-[rubygems-version]: https://img.shields.io/pypi/v/apimatic-requests-client-adapter
-[rubygems-apimatic-faraday-client-adapter-url]: https://pypi.org/project/apimatic-requests-client-adapter/
 [test-badge]: https://github.com/apimatic/core-lib-ruby/actions/workflows/test-runner.yml/badge.svg
 [test-url]: https://github.com/apimatic/core-lib-ruby/actions/workflows/test-runner.yml
 [lint-badge]: https://github.com/apimatic/core-lib-ruby/actions/workflows/lint-runner.yml/badge.svg

data/lib/apimatic-core/response_handler.rb

@@ -44,13 +44,27 @@ module CoreLibrary
       self
     end
 
-    # Sets local_errors hash key value.
+    # Registers an entry with error message in the local errors hash.
     # @param [String] error_code The error code to check against.
-    # @param [String] description The reason for the exception.
+    # @param [String] error_message The reason for the exception.
     # @param [ApiException] exception_type The type of the exception to raise.
     # @return [ResponseHandler] An updated instance of ResponseHandler.
-    def local_error(error_code, description, exception_type)
-      @local_errors[error_code.to_s] = ErrorCase.new.description(description).exception_type(exception_type)
+    def local_error(error_code, error_message, exception_type)
+      @local_errors[error_code.to_s] = ErrorCase.new
+                                                .error_message(error_message)
+                                                .exception_type(exception_type)
+      self
+    end
+
+    # Registers an entry with error template in the local errors hash.
+    # @param [String] error_code The error code to check against.
+    # @param [String] error_message_template The reason template for the exception.
+    # @param [ApiException] exception_type The type of the exception to raise.
+    # @return [ResponseHandler] An updated instance of ResponseHandler.
+    def local_error_template(error_code, error_message_template, exception_type)
+      @local_errors[error_code.to_s] = ErrorCase.new
+                                                .error_message_template(error_message_template)
+                                                .exception_type(exception_type)
       self
     end
 
@@ -186,34 +200,16 @@ module CoreLibrary
     end
     # rubocop:enable Style/OptionalBooleanParameter
 
-    # Validates the response provided and throws an error from global_errors if it fails.
-    # @param response The received response.
-    # @param global_errors Global errors hash.
+    # Validates the response provided and throws an error against the configured status code.
+    # @param [HttpResponse] response The received response.
+    # @param [Hash] global_errors Global errors hash.
+    # @raise [ApiException] Throws the exception when the response contains errors.
     def validate(response, global_errors)
-      return unless response.status_code < 200 || response.status_code > 208
-
-      actual_status_code = response.status_code.to_s
-
-      contains_local_errors = (!@local_errors.nil? and !@local_errors[actual_status_code].nil?)
-      if contains_local_errors
-        error_case = @local_errors[actual_status_code]
-        raise error_case.get_exception_type.new error_case.get_description, response
-      end
-
-      contains_local_default_error = (!@local_errors.nil? and !@local_errors['default'].nil?)
-      if contains_local_default_error
-        error_case = @local_errors['default']
-        raise error_case.get_exception_type.new error_case.get_description, response
-      end
+      return unless response.status_code < 200 || response.status_code > 299
 
-      contains_global_errors = (!global_errors.nil? and !global_errors[actual_status_code].nil?)
-      if contains_global_errors
-        error_case = global_errors[actual_status_code]
-        raise error_case.get_exception_type.new error_case.get_description, response
-      end
+      validate_against_error_cases(response, @local_errors)
 
-      error_case = global_errors['default']
-      raise error_case.get_exception_type.new error_case.get_description, response unless error_case.nil?
+      validate_against_error_cases(response, global_errors)
     end
 
     # Applies xml deserializer to the response.
@@ -265,5 +261,31 @@ module CoreLibrary
 
       deserialized_value
     end
+
+    # Validates the response against the provided error cases hash, if matches, it raises the exception.
+    # @param [HttpResponse] response The received response.
+    # @param [Hash] error_cases The error cases hash.
+    # @raise [ApiException] Raises the APIException when configured error code matches.
+    def validate_against_error_cases(response, error_cases)
+      actual_status_code = response.status_code.to_s
+
+      # Handling error case when configured as explicit error code
+      error_case = error_cases[actual_status_code]
+      error_case&.raise_exception(response)
+
+      # Handling error case when configured as explicit error codes range
+      default_range_entry = error_cases&.filter do |error_code, _|
+        error_code.match?("^#{actual_status_code[0]}XX$")
+      end
+
+      default_range_error_case = default_range_entry&.map { |_, error_case_instance| error_case_instance }
+
+      default_range_error_case[0].raise_exception(response) unless
+        default_range_error_case.nil? || default_range_error_case.empty?
+
+      # Handling default error case if configured
+      default_error_case = error_cases['default']
+      default_error_case&.raise_exception(response)
+    end
   end
 end

data/lib/apimatic-core/types/error_case.rb

@@ -2,22 +2,25 @@ module CoreLibrary
   # This data class represents the expected errors to be handled after the API call.
   class ErrorCase
     def initialize
-      @description = nil
+      @error_message = nil
+      @error_message_template = nil
       @exception_type = nil
     end
 
     # The setter for the description of the error message.
-    # @param [String] description The description of the error message.
+    # @param [String] error_message The error message.
     # @return [ErrorCase] An updated instance of ErrorCase.
-    def description(description)
-      @description = description
+    def error_message(error_message)
+      @error_message = error_message
       self
     end
 
-    # The getter for the description of the error message.
-    # @return [String] The description of the error message.
-    def get_description
-      @description
+    # The setter for the description of the error message.
+    # @param [String] error_message_template The error message template.
+    # @return [ErrorCase] An updated instance of ErrorCase.
+    def error_message_template(error_message_template)
+      @error_message_template = error_message_template
+      self
     end
 
     # The setter for the type of the exception to be thrown.
@@ -28,10 +31,48 @@ module CoreLibrary
       self
     end
 
-    # The getter for the type of the exception to be thrown.
-    # @return [Object] The type of the exception to be thrown.
-    def get_exception_type
-      @exception_type
+    # Getter for the error message for the exception case. This considers both error message
+    # and error template message. Error message template has the higher precedence over an error message.
+    # @param response The received http response.
+    # @return [String] The resolved exception message.
+    def get_error_message(response)
+      return _get_resolved_error_message_template(response) unless @error_message_template.nil?
+
+      @error_message
+    end
+
+    # Raises the exception for the current error case type.
+    # @param response The received response.
+    def raise_exception(response)
+      raise @exception_type.new get_error_message(response), response
+    end
+
+    # Updates all placeholders in the given message template with provided value.
+    # @param response The received http response.
+    # @return [String] The resolved template message.
+    def _get_resolved_error_message_template(response)
+      placeholders = @error_message_template.scan(/{\$.*?\}/)
+
+      status_code_placeholder = placeholders.select { |element| element == '{$statusCode}' }.uniq
+      header_placeholders = placeholders.select { |element| element.start_with?('{$response.header') }.uniq
+      body_placeholders = placeholders.select { |element| element.start_with?('{$response.body') }.uniq
+
+      # Handling response code placeholder
+      error_message_template = ApiHelper.resolve_template_placeholders(status_code_placeholder,
+                                                                       response.status_code.to_s,
+                                                                       @error_message_template)
+
+      # Handling response header placeholder
+      error_message_template = ApiHelper.resolve_template_placeholders(header_placeholders, response.headers,
+                                                                       error_message_template)
+
+      # Handling response body placeholder
+      response_payload = ApiHelper.json_deserialize(response.raw_body, true)
+      error_message_template = ApiHelper.resolve_template_placeholders_using_json_pointer(body_placeholders,
+                                                                                          response_payload,
+                                                                                          error_message_template)
+
+      error_message_template
     end
   end
 end

data/lib/apimatic-core/utilities/api_helper.rb

@@ -1,4 +1,6 @@
 require 'erb'
+require 'json-pointer'
+
 module CoreLibrary
   # API utility class involved in executing an API
   class ApiHelper
@@ -230,9 +232,13 @@ module CoreLibrary
     # @param [String] json A JSON string.
     # rubocop:disable Style/OptionalBooleanParameter
     def self.json_deserialize(json, should_symbolize = false)
-      JSON.parse(json, symbolize_names: should_symbolize)
-    rescue StandardError
-      raise TypeError, 'Server responded with invalid JSON.'
+      return if json.nil?
+
+      begin
+        JSON.parse(json, symbolize_names: should_symbolize)
+      rescue StandardError
+        raise TypeError, 'Server responded with invalid JSON.'
+      end
     end
     # rubocop:enable Style/OptionalBooleanParameter
 
@@ -547,5 +553,54 @@ module CoreLibrary
        TrueClass, FalseClass, Date,
        DateTime, Array, Hash, Object]
     end
+
+    # Updates all placeholders in the given message template with provided value.
+    # @param [String] placeholders The placeholders that need to be searched and replaced in the given template value.
+    # @param [String] value The dictionary containing the actual values to replace with.
+    # @param [String] template The template string containing placeholders.
+    # @@return [String] The resolved template value.
+    def self.resolve_template_placeholders_using_json_pointer(placeholders, value, template)
+      placeholders.each do |placeholder|
+        extracted_value = ''
+        if placeholder.include? '#'
+          # pick the 2nd chunk then remove the last character (i.e. `}`) of the string value
+          node_pointer = placeholder.split('#')[1].delete_suffix('}')
+          value_pointer = JsonPointer.new(value, node_pointer, symbolize_keys: true)
+          extracted_value = json_serialize(value_pointer.value) if value_pointer.exists?
+        elsif !value.nil?
+          extracted_value = json_serialize(value)
+        end
+        template.gsub!(placeholder, extracted_value)
+      end
+
+      template
+    end
+
+    # Updates all placeholders in the given message template with provided value.
+    # @param [List] placeholders The placeholders that need to be searched and replaced in the given template value.
+    # @param [Hash|String] values The value which refers to the actual values to replace with.
+    # @param [String] template The template string containing placeholders.
+    # @@return [String] The resolved template value.
+    def self.resolve_template_placeholders(placeholders, values, template)
+      values = values.map { |key, value| [key.to_s, value.to_s] }.to_h if values.is_a? Hash
+
+      placeholders.each do |placeholder|
+        extracted_value = ''
+        if values.is_a? Hash
+          # pick the last chunk then strip the last character (i.e. `}`) of the string value
+          key = if placeholder.include? '.'
+                  placeholder.split('.')[-1].delete_suffix('}')
+                else
+                  placeholder.delete_prefix('{').delete_suffix('}')
+                end
+          extracted_value = values[key] unless values[key].nil?
+        else
+          extracted_value = values unless values.nil?
+        end
+        template.gsub!(placeholder, extracted_value.to_s)
+      end
+
+      template
+    end
   end
 end

data/lib/apimatic_core.rb

@@ -3,6 +3,7 @@ require 'json'
 require 'certifi'
 require 'apimatic_core_interfaces'
 require 'cgi'
+require 'json-pointer'
 
 require_relative 'apimatic-core/request_builder'
 require_relative 'apimatic-core/response_handler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apimatic_core
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - APIMatic Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -78,6 +78,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json-pointer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement