apimatic_core 0.3.17 → 0.3.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb57dc9ff26738c2c3729fc25e818fcb3332856d1c5198ef0d124c95a5bee705
-  data.tar.gz: c6282f7eab4aba5fa315559f4771ed11bc19389a4e9100f492181dfb3d770b2d
+  metadata.gz: 8036d7d4e85c7d9a51ba0cb35b55512f7f5ee7b9be1ae82539968818cb071647
+  data.tar.gz: a7c919a5d44e501c1dcb24c348a8a2d86397a7544cf909f9437a70b4e362cc13
 SHA512:
-  metadata.gz: ed4993b9e5dd5c868b6edfe9fddf0dccb29e3d533af41728abb1b03d57c50cd0e3f5ff35a684d95acad12aa14a9a59fba9cdfef2803ea61f44440eca54f568b2
-  data.tar.gz: 1385e863201a29c29c4eee3ada89cec1ae267786c682a34b92af864784041c6b78614c989d8826361a71ba3bd3dcc1aa1e84ef578a7a2767f926f7a3005b45da
+  metadata.gz: 740e2f24d1386d43da34543a506044593a9e15dd879f894e83a2abb5f68d0497c4edc0c741dfcc73c5147f691eeab8abef8c2b9d005f0f2493ff3136f28dca20
+  data.tar.gz: a691fb1f4ebf03184ad11ad9d1662da02563d5f6208d71224ff6782474eb017c09e970053919816782684af64ec188de94ad0507f61c7ca2c72c75db24f0c144

data/README.md

@@ -3,7 +3,9 @@
 [![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]
-[![Test Coverage][test-coverage-url]][code-climate-url]
+[![Test Coverage][coverage-badge]][coverage-url]
+[![Maintainability Rating][maintainability-badge]][maintainability-url]
+[![Vulnerabilities][vulnerabilities-badge]][vulnerabilities-url]
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
 [![Licence][license-badge]][license-url]
 
@@ -43,7 +45,7 @@ gem 'apimatic_core'
 | [`Single`](lib/apimatic-core/authentication/multiple/single_auth.rb)   | Helper class to support single authentication                               |
 
 
-## Configurations
+## Global Configuration
 | Name                                                                                           | Description                                                                     |
 |------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
 | [`GlobalConfiguration`](lib/apimatic-core/configurations/global_configuration.rb )             | Class holding the global configuration properties to make a successful API Call |
@@ -61,10 +63,15 @@ gem 'apimatic_core'
 |-------------------------------------------------------------------------------|------------------------------------------|
 | [`HttpResponseFactory`](lib/apimatic-core/factories/http_response_factory.rb) | Factory class to create an HTTP Response |
 
+## HTTP Configuration
+| Name                                                                                            | Description                                                                                                           |
+|-------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
+| [`HttpClientConfiguration`](lib/apimatic-core/http/configurations/http_client_configuration.rb) | Class used for configuring SDK by a user                                                                              |
+| [`ProxySettings`](lib/apimatic-core/http/configurations/proxy_settings.rb)                      | ProxySettings encapsulates HTTP proxy configuration for Faraday, e.g. address, port and optional basic authentication |
+
 ## 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                                                                                                         |
@@ -125,8 +132,11 @@ gem 'apimatic_core'
 [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
+[coverage-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_core-lib-ruby&metric=coverage
+[coverage-url]: https://sonarcloud.io/summary/new_code?id=apimatic_core-lib-ruby
+[maintainability-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_core-lib-ruby&metric=sqale_rating
+[maintainability-url]: https://sonarcloud.io/summary/new_code?id=apimatic_core-lib-ruby
+[vulnerabilities-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_core-lib-ruby&metric=vulnerabilities
+[vulnerabilities-url]: https://sonarcloud.io/summary/new_code?id=apimatic_core-lib-ruby
 [license-badge]: https://img.shields.io/badge/licence-MIT-blue
 [license-url]: LICENSE

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

@@ -16,12 +16,13 @@ module CoreLibrary
     # @param [Boolean] verify Should verification be enabled.
     # @param http_callback A method to be used as http callback
     # @param [HttpClient] http_client An instance of HttpClient
+    # @param [ProxySettings] proxy_settings The configurable settings for proxy
     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,
-      logging_configuration: nil
+      logging_configuration: nil, proxy_settings: nil
     )
       @response_factory = HttpResponseFactory.new
       @connection = connection
@@ -37,6 +38,7 @@ module CoreLibrary
       @cache = cache
       @http_client = http_client
       @logging_configuration = logging_configuration
+      @proxy_settings = proxy_settings
     end
 
     # Setter for http_client.
@@ -58,7 +60,8 @@ module CoreLibrary
         verify: @verify,
         http_callback: http_callback || DeepCloneUtils.deep_copy(@http_callback),
         http_client: DeepCloneUtils.deep_copy(@http_client),
-        logging_configuration: DeepCloneUtils.deep_copy(@logging_configuration)
+        logging_configuration: DeepCloneUtils.deep_copy(@logging_configuration),
+        proxy_settings: DeepCloneUtils.deep_copy(@proxy_settings)
       )
     end
   end

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

@@ -0,0 +1,42 @@
+module CoreLibrary
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings
+    attr_accessor :address, :port, :username, :password
+
+    ##
+    # @param address [String] The proxy server address (e.g., 'http://localhost').
+    # @param port [Integer, nil] Optional proxy server port (e.g., 8080).
+    # @param username [String, nil] Optional proxy auth username.
+    # @param password [String, nil] Optional proxy auth password.
+    #
+    # @raise [ArgumentError] If address is invalid.
+    #
+    def initialize(address:, port: nil, username: nil, password: nil)
+      raise ArgumentError, 'Proxy address must be a non-empty string' unless address.is_a?(String) && !address.empty?
+
+      @address = address
+      @port = port
+      @username = username
+      @password = password
+    end
+
+    ##
+    # Converts the proxy settings into a Faraday-compatible hash.
+    #
+    # @return [Hash] A hash with keys :uri, :user, and :password (as applicable).
+    #
+    def to_h
+      uri_str = port ? "#{address}:#{port}" : address
+
+      {
+        uri: uri_str
+      }.tap do |hash|
+        hash[:user] = username if username
+        hash[:password] = password if password
+      end
+    end
+  end
+end

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

@@ -72,8 +72,11 @@ module CoreLibrary
 
     # Deserializer to use when the type of response is not known beforehand.
     # @param response The response received.
+    # @return [Hash, Array, nil] The deserialized response.
     def self.dynamic_deserializer(response, should_symbolize)
-      json_deserialize(response, should_symbolize) unless response.nil? || response.to_s.strip.empty?
+      return unless deserializable_json?(response)
+
+      json_deserialize(response, should_symbolize)
     end
 
     # Deserializes response to a known custom model type.
@@ -303,6 +306,20 @@ module CoreLibrary
       end
     end
 
+    # Checks whether the content is deserializable JSON.
+    # @param [String] json A JSON string.
+    # @return [Boolean] True if the content can be deserialized, false otherwise.
+    def self.deserializable_json?(json)
+      return false if json.nil? || json.to_s.strip.empty?
+
+      begin
+        JSON.parse(json)
+        true
+      rescue JSON::ParserError
+        false
+      end
+    end
+
     # Parses JSON string.
     # @param [object] obj The object to serialize.
     def self.json_serialize(obj)

data/lib/apimatic_core.rb

@@ -30,6 +30,7 @@ require_relative 'apimatic-core/pagination/strategies/offset_pagination'
 require_relative 'apimatic-core/pagination/strategies/page_pagination'
 
 require_relative 'apimatic-core/http/configurations/http_client_configuration'
+require_relative 'apimatic-core/http/configurations/proxy_settings'
 require_relative 'apimatic-core/http/request/http_request'
 require_relative 'apimatic-core/http/response/http_response'
 require_relative 'apimatic-core/http/response/api_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apimatic_core
 version: !ruby/object:Gem::Version
-  version: 0.3.17
+  version: 0.3.19
 platform: ruby
 authors:
 - APIMatic Ltd.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-18 00:00:00.000000000 Z
+date: 2025-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -170,6 +170,7 @@ files:
 - lib/apimatic-core/exceptions/one_of_validation_exception.rb
 - lib/apimatic-core/factories/http_response_factory.rb
 - lib/apimatic-core/http/configurations/http_client_configuration.rb
+- lib/apimatic-core/http/configurations/proxy_settings.rb
 - lib/apimatic-core/http/http_call_context.rb
 - lib/apimatic-core/http/request/http_request.rb
 - lib/apimatic-core/http/response/api_response.rb