apimatic_core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c581361453ae63c619ca7b7bcc5b2e4cb5cd2afe4ab1f7584462a0698ab8be3d
+  data.tar.gz: 51c745d2ac8600da653324628f1cf4e00e2059ceb12e22f150f49ec2ed3a9f03
+SHA512:
+  metadata.gz: 1a87d5f62193c6f46e4fda2289d5c4a8cae5d716ee35723f030d6ad97ffc569ffec23019e89065a5882ea806aec791ea121bc8f0e326496a923a49feb0c1b484
+  data.tar.gz: 44acde48930a6e621608d30fb646e9f467e0fba89c07520016e55e2b017b17f239ede9bcc0de1e79537e5303da469b91f1fd2f1844a212f10bd92a40b48cd103

data/LICENSE

@@ -0,0 +1,26 @@
+APIMATIC REFERENCE SOURCE LICENSE
+
+This license governs the use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software.
+
+1. Definitions
+The terms "reproduce," "reproduction" and "distribution" have the same meaning here as under U.S. copyright law.
+
+"You" means the licensee of the software.
+
+"Your company" means the company you worked for when you downloaded the software.
+
+"Reference use" means the use of the software within your company as a reference, in read-only form, for the sole purposes of debugging your products, maintaining your products, or enhancing the interoperability of your products with the software, and specifically excludes the right to distribute the software outside of your company.
+
+"Licensed patents" means any Licensor patent claims which read directly on the software as distributed by the Licensor under this license.
+
+2. Grant of Rights
+(A) Copyright Grant- Subject to the terms of this license, the Licensor grants you a non-transferable, non-exclusive, worldwide, royalty-free copyright license to reproduce the software for reference use.
+
+(B) Patent Grant- Subject to the terms of this license, the Licensor grants you a non-transferable, non-exclusive, worldwide, royalty-free patent license under licensed patents for reference use.
+
+3. Limitations
+(A) No Trademark License- This license does not grant you any rights to use the Licensor's name, logo, or trademarks.
+
+(B) If you begin patent litigation against the Licensor over patents that you think may apply to the software (including a cross-claim or counterclaim in a lawsuit), your license to the software ends automatically.
+
+(C) The software is licensed "as-is." You bear the risk of using it. The Licensor gives no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the Licensor excludes the implied warranties of merchantability, fitness for a particular purpose and non-infringement.

data/README.md

@@ -0,0 +1,101 @@
+# apimatic-core
+[//]: # ([![PyPI][rubygems-version]][rubygems-apimatic-faraday-client-adapter-url])
+[![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]
+
+## Introduction
+Core library ruby does the job of congregating common and core functionality from ruby SDKs. This includes functionalities like the ability to create HTTP requests, handle responses, apply authentication schemes, convert API responses back to object instances, and validate user and server data.
+
+
+## Installation
+You will need `2.6 <= Ruby version < 3.1` to support this package.
+
+Installation is quite simple, just execute the following command:
+```
+gem install apimatic_core
+```
+
+If you'd rather install apimatic_core using bundler, add a line for it in your Gemfile:
+```
+gem 'apimatic_core'
+```
+
+## API Call Classes
+| Name                                                                  | Description                                        |
+|-----------------------------------------------------------------------|----------------------------------------------------|
+| [`RequestBuilder`](lib/apimatic-core/http/request/http_request.rb)    | Builder class used to build an API Request         |
+| [`APICall`](lib/apimatic-core/api_call.rb)                            | Class used to create an API Call object            |
+| [`ResponseHandler`](lib/apimatic-core/http/response/http_response.rb) | Used to handle the response returned by the server |
+
+
+## Authentication
+| Name                                                                   | Description                                                                 |
+|------------------------------------------------------------------------|-----------------------------------------------------------------------------|
+| [`HeaderAuth`](lib/apimatic-core/authentication/header_auth.rb)        | Supports HTTP authentication through HTTP Headers                           |
+| [`QueryAuth`](lib/apimatic-core/authentication/query_auth.rb)          | Supports HTTP authentication through query parameters                       |
+| [`AuthGroup`](lib/apimatic-core/authentication/multiple/auth_group.rb) | Helper class to support  multiple authentication operation                  |
+| [`And`](lib/apimatic-core/authentication/multiple/and_auth_group.rb)   | Helper class to support AND operation between multiple authentication types |
+| [`Or`](lib/apimatic-core/authentication/multiple/or_auth_group.rb)     | Helper class to support OR operation between multiple authentication  types |
+| [`Single`](lib/apimatic-core/authentication/multiple/single_auth.rb)   | Helper class to support single authentication                               |
+
+
+## Configurations
+| Name                                                                                           | Description                                                                     |
+|------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
+| [`GlobalConfiguration`](lib/apimatic-core/configurations/global_configuration.rb )             | Class holding the global configuration properties to make a successful API Call |
+
+## Factories
+| Name                                                                          | Description                              |
+|-------------------------------------------------------------------------------|------------------------------------------|
+| [`HttpResponseFactory`](lib/apimatic-core/factories/http_response_factory.rb) | Factory class to create an HTTP Response |
+
+## HTTP
+| Name                                                                                            | Description                                              |
+|-------------------------------------------------------------------------------------------------|----------------------------------------------------------|
+| [`HttpClientConfiguration`](lib/apimatic-core/http/configurations/http_client_configuration.rb) | Class used for configuring SDK by a user                 |
+| [`HttpRequest`](lib/apimatic-core/http/request/http_request.rb)                                 | Class which contains information about the HTTP Request  |
+| [`ApiResponse`](lib/apimatic-core/http/response/api_response.rb)                                | Wrapper class for Api Response                           |
+| [`HttpResponse`](lib/apimatic-core/http/response/http_response.rb)                              | Class which contains information about the HTTP Response |
+
+## Logger
+| Name                                                              | Description                                |
+|-------------------------------------------------------------------|--------------------------------------------|
+| [`EndpointLogger`](lib/apimatic-core/logger/endpoint_logger.rb)   | A class to provide logging for an API call |
+
+## Types
+| Name                                                                         | Description                                                                   |
+|------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
+| [`ApiException`](lib/apimatic-core/types/sdk/api_exception.rb)               | Basic exception type for the SDK                                              |
+| [`ValidationException`](lib/apimatic-core/types/sdk/validation_exception.rb) | Exception thrown in case of validation error or failure                       |
+| [`ErrorCase`](lib/apimatic-core/types/error_case.rb)                         | A class to represent Exception types                                          |
+| [`FileWrapper`](lib/apimatic-core/types/sdk/file_wrapper.rb)                 | A wrapper to allow passing in content type for file uploads                   |
+| [`Parameter`](lib/apimatic-core/types/parameter.rb)                          | A class to represent information about a Parameter passed in an endpoint      |
+| [`XmlAttributes`](lib/apimatic-core/types/xml_attributes.rb)                 | A class to represent information about an XML Parameter passed in an endpoint |
+
+## Utilities
+| Name                                                                   | Description                                                                          |
+|------------------------------------------------------------------------|--------------------------------------------------------------------------------------|
+| [`ApiHelper`](lib/apimatic-core/utilities/api_helper.rb)               | A Helper Class with various functions associated with making an API Call             |
+| [`AuthHelper`](lib/apimatic-core/utilities/auth_helper.rb)             | A Helper Class with various functions associated with authentication in API Calls    |
+| [`ComparisonHelper`](lib/apimatic-core/utilities/comparison_helper.rb) | A Helper Class used for the comparison of expected and actual API response           |
+| [`FileHelper`](lib/apimatic-core/utilities/file_helper.rb)             | A Helper Class for files                                                             |
+| [`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)
+
+[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
+[lint-url]: https://github.com/apimatic/core-lib-ruby/actions/workflows/lint-runner.yml
+[code-climate-url]: https://codeclimate.com/github/apimatic/core-lib-ruby
+[maintainability-url]: https://api.codeclimate.com/v1/badges/85d658cd4e879f057e7d/maintainability
+[test-coverage-url]: https://api.codeclimate.com/v1/badges/85d658cd4e879f057e7d/test_coverage
+[license-badge]: https://img.shields.io/badge/licence-APIMATIC-blue
+[license-url]: LICENSE

data/lib/apimatic-core/api_call.rb

@@ -0,0 +1,103 @@
+module CoreLibrary
+  # This class is responsible for executing an API call using HttpClient, RequestBuilder and ResponseHandler objects.
+  class ApiCall
+    # Creates a new builder instance of the API call with pre-configured global and logging configurations.
+    # @return [ApiCall] The instance of ApiCall object.
+    def new_builder
+      ApiCall.new(@global_configuration, logger: @endpoint_logger.logger)
+    end
+
+    def initialize(global_configuration, logger: nil)
+      @global_configuration = global_configuration
+      @request_builder = RequestBuilder.new
+      @response_handler = ResponseHandler.new
+      @endpoint_logger = EndpointLogger.new(logger)
+      @endpoint_name_for_logging = nil
+      @endpoint_context = {}
+    end
+
+    # The setter for the request builder to be used for building the request of an API call.
+    # @param [RequestBuilder] request_builder The request builder instance.
+    # @return [ApiCall] An updated instance of ApiCall.
+    def request(request_builder)
+      @request_builder = request_builder
+      self
+    end
+
+    # The setter for the response handler to be used for handling the response of an API call.
+    # @param [ResponseHandler] response_handler The response handler instance.
+    # @return [ApiCall] An updated instance of ApiCall.
+    def response(response_handler)
+      @response_handler = response_handler
+      self
+    end
+
+    # The setter for the name of the endpoint controller method to used while logging an endpoint call.
+    # @param [String] endpoint_name_for_logging The name of the endpoint controller method to used while logging.
+    # @return [ApiCall] An updated instance of ApiCall.
+    def endpoint_name_for_logging(endpoint_name_for_logging)
+      @endpoint_name_for_logging = endpoint_name_for_logging
+      self
+    end
+
+    # The setter for the context for an endpoint call.
+    # @param [String] context_key The name of the endpoint context.
+    # @param [Object] context_value The value of the endpoint context.
+    # @return [ApiCall] An updated instance of ApiCall.
+    def endpoint_context(context_key, context_value)
+      @endpoint_context[context_key] = context_value
+      self
+    end
+
+    # Executes the API call using provided HTTP client, request builder and response handler objects.
+    # @return The deserialized endpoint response.
+    def execute
+      _client_configuration = @global_configuration.client_configuration
+      begin
+        if _client_configuration.http_client.nil?
+          raise ArgumentError, 'An HTTP client instance is required to execute an Api call.'
+        end
+
+        _http_request = @request_builder.endpoint_logger(@endpoint_logger)
+                                        .endpoint_name_for_logging(@endpoint_name_for_logging)
+                                        .global_configuration(@global_configuration)
+                                        .build(@endpoint_context)
+        @endpoint_logger.debug("Raw request for #{@endpoint_name_for_logging} is: #{_http_request.inspect}")
+
+        _http_callback = _client_configuration.http_callback
+        unless _http_callback.nil?
+          update_http_callback(proc do
+            _http_callback&.on_before_request(_http_request)
+          end, "Calling the on_before_request method of http_call_back for #{@endpoint_name_for_logging}.")
+        end
+
+        _http_response = _client_configuration.http_client.execute(_http_request)
+        @endpoint_logger.debug("Raw response for #{@endpoint_name_for_logging} is: #{_http_response.inspect}")
+
+        unless _http_callback.nil?
+          update_http_callback(proc do
+            _http_callback&.on_after_response(_http_response)
+          end, "Calling the on_after_response method of http_call_back for #{@endpoint_name_for_logging}.")
+        end
+
+        _deserialized_response = @response_handler.endpoint_logger(@endpoint_logger)
+                                                  .endpoint_name_for_logging(@endpoint_name_for_logging)
+                                                  .handle(_http_response, @global_configuration.get_global_errors,
+                                                          @global_configuration.get_sdk_module,
+                                                          @global_configuration.should_symbolize_hash)
+        _deserialized_response
+      rescue StandardError => e
+        @endpoint_logger.error(e)
+        raise e
+      end
+    end
+
+    # Registers request and response with the provided http_callback
+    # @param [Callable] callable The callable to be called for registering into the HttpCallback instance.
+    # @param [String] log_message The message to be logged if HttpCallback is set.
+    def update_http_callback(callable, log_message)
+      @endpoint_logger.info(log_message)
+      callable.call
+    end
+  end
+end

data/lib/apimatic-core/authentication/header_auth.rb

@@ -0,0 +1,21 @@
+module CoreLibrary
+  # This class is responsible for adding authentication in request header parameter.
+  class HeaderAuth < Authentication
+    def initialize(auth_params)
+      @auth_params = auth_params
+      @error_message = nil
+    end
+
+    # Checks whether this authentication scheme is valid or not.
+    # @return [Boolean] True if the auth instance is valid to be applied on the request.
+    def valid
+      AuthHelper.valid_auth?(@auth_params)
+    end
+
+    # Applies the authentication scheme on the given HTTP request.
+    # @param [HttpRequest] _http_request The HTTP request to apply the authentication on.
+    def apply(_http_request)
+      AuthHelper.apply(@auth_params, _http_request.method(:add_header))
+    end
+  end
+end

data/lib/apimatic-core/authentication/multiple/and_auth_group.rb

@@ -0,0 +1,28 @@
+module CoreLibrary
+  # The class to handle the AND combination of multiple authentications.
+  class And < AuthGroup
+    # Getter for the error message for auth.
+    # @return [String] The error message while applying the auth.
+    def error_message
+      @error_messages.join(' and ')
+    end
+
+    def initialize(*auth_group)
+      super auth_group
+      @is_valid_group = true
+    end
+
+    # Checks if the associated auth is valid.
+    # @return [Boolean] True if the associated auth is valid, false otherwise.
+    def valid
+      @mapped_group.each do |participant|
+        unless participant.valid
+          @error_messages.append(participant.error_message)
+          @is_valid_group = false
+        end
+      end
+
+      @is_valid_group
+    end
+  end
+end

data/lib/apimatic-core/authentication/multiple/auth_group.rb

@@ -0,0 +1,45 @@
+module CoreLibrary
+  # The parent class of multiple authentication groups (i.e. Or & And groups).
+  # This parent class is responsible for handling multiple auths on a particular request.
+  class AuthGroup < Authentication
+    attr_accessor :auth_participants, :mapped_group, :error_messages, :is_valid_group
+
+    def initialize(auth_group)
+      @auth_participants = []
+      auth_group.each do |auth_participant|
+        if !auth_participant.nil? && auth_participant.is_a?(String)
+          @auth_participants.append(Single.new(auth_participant))
+        elsif !auth_participant.nil?
+          @auth_participants.append(auth_participant)
+        end
+        @mapped_group = []
+        @error_messages = []
+        @is_valid_group = nil
+      end
+    end
+
+    # Extracts out the auth from the given auth managers.
+    # @param [Hash] auth_managers The hash of auth managers.
+    # @return [Single] An updated instance of itself.
+    def with_auth_managers(auth_managers)
+      @auth_participants.each do |participant|
+        @mapped_group.append(participant.with_auth_managers(auth_managers))
+      end
+      self
+    end
+
+    # Checks if the associated auth is valid.
+    # @return [Boolean] True if the associated auth is valid, false otherwise.
+    def valid
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+
+    # Applies the associated auth to the HTTP request.
+    # @param [HttpRequest] http_request The HTTP request on which the auth is to be applied.
+    def apply(http_request)
+      return unless @is_valid_group
+
+      @mapped_group.each { |participant| participant.apply(http_request) }
+    end
+  end
+end

data/lib/apimatic-core/authentication/multiple/or_auth_group.rb

@@ -0,0 +1,29 @@
+module CoreLibrary
+  # The class to handle the OR combination of multiple authentications for a particular request.
+  class Or < AuthGroup
+    # Getter for the error message for auth.
+    # @return [String] The error message while applying the auth.
+    def error_message
+      @error_messages.join(' or ')
+    end
+
+    def initialize(*auth_group)
+      super auth_group
+      @is_valid_group = false
+    end
+
+    # Checks if the associated auth is valid.
+    # @return [Boolean] True if the associated auth is valid, false otherwise.
+    def valid
+      @mapped_group.each do |participant|
+        if participant.valid
+          @is_valid_group = true
+        else
+          @error_messages.append(participant.error_message)
+        end
+      end
+
+      @is_valid_group
+    end
+  end
+end

data/lib/apimatic-core/authentication/multiple/single_auth.rb

@@ -0,0 +1,48 @@
+module CoreLibrary
+  # The class to handle the single authentication for a particular request.
+  class Single < Authentication
+    # Getter for the error message for auth.
+    # @return [String] The error message while applying the auth.
+    def error_message
+      "[#{@error_message}]"
+    end
+
+    def initialize(auth_participant)
+      @auth_participant = auth_participant
+      @mapped_auth = nil
+      @error_message = nil
+      @is_valid = true
+    end
+
+    # Extracts out the auth from the given auth managers.
+    # @param [Hash] auth_managers The hash of auth managers.
+    # @return [Single] An updated instance of itself.
+    def with_auth_managers(auth_managers)
+      raise ArgumentError, 'Auth key is invalid.' unless auth_managers.key?(@auth_participant)
+
+      @mapped_auth = auth_managers[@auth_participant]
+      self
+    end
+
+    # Checks if the associated auth is valid.
+    # @return [Boolean] True if the associated auth is valid, false otherwise.
+    def valid
+      raise ArgumentError, 'The auth manager entry must not have a nil value.' if @mapped_auth.nil?
+
+      unless @mapped_auth.valid
+        @error_message = @mapped_auth.error_message
+        @is_valid = false
+      end
+
+      @is_valid
+    end
+
+    # Applies the associated auth to the HTTP request.
+    # @param [HttpRequest] http_request The HTTP request on which the auth is to be applied.
+    def apply(http_request)
+      return unless @is_valid
+
+      @mapped_auth.apply(http_request)
+    end
+  end
+end

data/lib/apimatic-core/authentication/query_auth.rb

@@ -0,0 +1,21 @@
+module CoreLibrary
+  # This class is responsible for adding authentication in request query parameter.
+  class QueryAuth < Authentication
+    def initialize(auth_params)
+      @auth_params = auth_params
+      @error_message = nil
+    end
+
+    # Checks whether this authentication scheme is valid or not.
+    # @return [Boolean] True if the auth instance is valid to be applied on the request.
+    def valid
+      AuthHelper.valid_auth?(@auth_params)
+    end
+
+    # Applies the authentication scheme on the given HTTP request.
+    # @param [HttpRequest] _http_request The HTTP request to apply the authentication on.
+    def apply(_http_request)
+      AuthHelper.apply(@auth_params, _http_request.method(:add_query_parameter))
+    end
+  end
+end

data/lib/apimatic-core/configurations/global_configuration.rb

@@ -0,0 +1,149 @@
+module CoreLibrary
+  # A class to hold the global configurations for the core library. This class is initiated from the SDK.
+  class GlobalConfiguration
+    attr_reader :client_configuration
+
+    def initialize(client_configuration: HttpClientConfiguration.new)
+      @client_configuration = client_configuration
+      @global_errors = {}
+      @global_headers = {}
+      @additional_headers = {}
+      @auth_managers = {}
+      @base_uri_executor = nil
+      @sdk_module = nil
+      @symbolize_hash = false
+    end
+
+    # The setter for the global errors.
+    # @param [Hash] global_errors The hash of global errors.
+    # @return [GlobalConfiguration] An updated instance of GlobalConfiguration.
+    def global_errors(global_errors)
+      @global_errors = global_errors
+      self
+    end
+
+    # The getter for the global errors.
+    # @return [Hash] The hash of global errors.
+    def get_global_errors
+      @global_errors
+    end
+
+    # Sets the current SDK module core library is being used for.
+    def sdk_module(sdk_module)
+      @sdk_module = sdk_module
+      self
+    end
+
+    def get_sdk_module
+      @sdk_module
+    end
+
+    # The setter for the global headers to be attached with all requests.
+    # @param [Hash] global_headers The hash of global headers.
+    # @return [GlobalConfiguration] An updated instance of GlobalConfiguration.
+    def global_headers(global_headers)
+      @global_headers = global_headers
+      self
+    end
+
+    # The setter for a global header to be attached with all requests.
+    # @param [String] key The key of a global header.
+    # @param [Object] value The value of a global header.
+    # @return [GlobalConfiguration] An updated instance of GlobalConfiguration.
+    def global_header(key, value)
+      @global_headers[key] = value
+      self
+    end
+
+    # The getter for the global headers.
+    # @return [Hash] The hash of global headers.
+    def get_global_headers
+      @global_headers
+    end
+
+    # The setter for the additional headers to be attached with all requests.
+    # @param [Hash] additional_headers The hash of additional headers.
+    # @return [GlobalConfiguration] An updated instance of GlobalConfiguration.
+    def additional_headers(additional_headers)
+      @additional_headers = additional_headers
+      self
+    end
+
+    # The setter for a additional header to be attached with all requests.
+    # @param [String] key The key of a additional header.
+    # @param [Object] value The value of a additional header.
+    # @return [GlobalConfiguration] An updated instance of GlobalConfiguration.
+    def additional_header(key, value)
+      @additional_headers[key] = value
+      self
+    end
+
+    # The getter for the additional headers.
+    # @return [Hash] The hash of additional headers.
+    def get_additional_headers
+      @additional_headers
+    end
+
+    # The setter for the auth managers.
+    # @param [Hash] auth_managers The hash of auth managers.
+    # @return [GlobalConfiguration] An updated instance of GlobalConfiguration.
+    def auth_managers(auth_managers)
+      @auth_managers = auth_managers
+      self
+    end
+
+    # The getter for the auth managers.
+    # @return [Hash] The hash of auth managers.
+    def get_auth_managers
+      @auth_managers
+    end
+
+    # The setter for the user agent information to be attached with all requests.
+    # @param [String] user_agent The user agent template string.
+    # @param [Hash, Optional] agent_parameters The agent configuration to be replaced in the actual user agent template.
+    # @return [GlobalConfiguration] An updated instance of GlobalConfiguration.
+    def user_agent(user_agent, agent_parameters: {})
+      add_useragent_in_headers(user_agent, agent_parameters)
+      self
+    end
+
+    # The setter for the base URI extractor callable.
+    # @param [Callable] base_uri_executor The callable for the base URI extractor.
+    # @return [GlobalConfiguration] An updated instance of GlobalConfiguration.
+    def base_uri_executor(base_uri_executor)
+      @base_uri_executor = base_uri_executor
+      self
+    end
+
+    # The getter for the base URI extractor.
+    # @return [Callable] The base URI extractor.
+    def get_base_uri_executor
+      @base_uri_executor
+    end
+
+    # The setter for the flag of symbolizing hash while deserialization.
+    # @param [Boolean] symbolize_hash The flag of symbolizing hash while deserialization.
+    # @return [GlobalConfiguration] An updated instance of GlobalConfiguration.
+    def symbolize_hash(symbolize_hash)
+      @symbolize_hash = symbolize_hash
+      self
+    end
+
+    # The setter for the flag of wrapping the body parameters in a hash.
+    # @return [Boolean] True if symbolizing hash is allowed during deserialization of response.
+    def should_symbolize_hash
+      @symbolize_hash
+    end
+
+    # Updates the user agent template with the provided parameters and adds user agent in the global_headers.
+    # @param [String] user_agent The user agent template string.
+    # @param [Hash, Optional] agent_parameters The agent configurations to be replaced in the actual user agent value.
+    def add_useragent_in_headers(user_agent, agent_parameters)
+      if !agent_parameters.nil? && agent_parameters.any?
+        user_agent = ApiHelper.update_user_agent_value_with_parameters(user_agent,
+                                                                       agent_parameters).gsub('  ', ' ')
+      end
+      @global_headers['user-agent'] = user_agent unless user_agent.nil?
+    end
+  end
+end

data/lib/apimatic-core/exceptions/invalid_auth_credential.rb

@@ -0,0 +1,5 @@
+module CoreLibrary
+  # Class for exceptions when there is an invalid state while applying the auth credentials.
+  class InvalidAuthCredential < StandardError
+  end
+end

data/lib/apimatic-core/factories/http_response_factory.rb

@@ -0,0 +1,14 @@
+module CoreLibrary
+  # Factory to create an instance of HttpResponse
+  class HttpResponseFactory < ResponseFactory
+    # The factory method for creating HttpResponse type.
+    # @param [Integer] _status_code The status code returned by the server.
+    # @param [String] _reason_phrase The reason phrase returned by the server.
+    # @param [Hash] _headers headers The headers sent by the server in the response.
+    # @param [String] _raw_body The raw body of the response.
+    # @param [HttpRequest] _request The request that resulted in this response.
+    def create(_status_code, _reason_phrase, _headers, _raw_body, _request)
+      HttpResponse.new(_status_code, _reason_phrase, _headers, _raw_body, _request)
+    end
+  end
+end

data/lib/apimatic-core/http/configurations/http_client_configuration.rb

@@ -0,0 +1,32 @@
+module CoreLibrary
+  # Configuration for an HttpClient.
+  class HttpClientConfiguration < ClientConfiguration
+    attr_reader :http_client, :http_callback
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], cache: false, verify: true, http_callback: nil, http_client: nil
+    )
+      @response_factory = HttpResponseFactory.new
+      @connection = connection
+      @adapter = adapter
+      @retry_interval = retry_interval
+      @http_callback = http_callback
+      @timeout = timeout
+      @max_retries = max_retries
+      @backoff_factor = backoff_factor
+      @retry_statuses = retry_statuses
+      @retry_methods = retry_methods
+      @verify = verify
+      @cache = cache
+      @http_client = http_client
+    end
+
+    # Setter for http_client.
+    def set_http_client(http_client)
+      @http_client = http_client
+    end
+  end
+end