apimatic_core_interfaces 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 79f8cde8fe5c6a5cec765e78448c3e72d82a11d5c1a447ec54210e4d0064264e
+  data.tar.gz: 34cd4ac1a8463c474666a735c8d7df65651ba37b0a233d942bc11b02bca5aebf
+SHA512:
+  metadata.gz: 39e69b43f329bd3c0bd16e3e47aef0c80062549af0ebd82304df9a3d03ad922235a604d9ee0bab799c782ac7c13be33df60a665ed9417ce792a126e23cb68532
+  data.tar.gz: 62e5d85255b6ee92c7cdfda9de3ee1a798903bea0d6edf29a51cd9749e0959b829e36c3dd118c6d78c132e5e163d8019b2916983e03ac8ccf9529f2efa0d8d8d

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,49 @@
+# apimatic-core-interfaces
+
+[//]: # ([![PyPI][rubygems-version]](https://pypi.org/project/apimatic-core-interfaces/))
+[![Linting][lint-badge]][lint-url]
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+[![Maintainability][maintainability-url]][code-climate-url]
+[![Licence][license-badge]][license-url]
+
+## Introduction
+This project contains the abstract layer for core library ruby. The purpose of creating interfaces is to separate out the functionalities needed by ruby core library. The goal is to support scalability and feature enhancement of the core library and the SDKs along with avoiding any breaking changes by reducing tight coupling between modules through the introduction of interfaces.
+
+## Version supported
+Currently APIMatic supports  `2.6 <= Ruby version < 3.1`  hence core-interfaces-ruby will need the same versions to be supported.
+
+## Installation
+Installation is quite simple, just execute the following command:
+```
+gem install apimatic_core_interfaces
+```
+
+If you'd rather install apimatic_core_interfaces using bundler, add a line for it in your Gemfile:
+```
+gem 'apimatic_core_interfaces'
+```
+
+## Interfaces
+| Name                                                                                 | Description                                                                                |
+|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
+| [`HttpClient`](lib/apimatic-core-interfaces/client/http_client.rb)                   | To save both Request and Response after the completion of response                         |
+| [`ResponseFactory`](lib/apimatic-core-interfaces/factories/response_factory.rb)      | To convert the client-adapter response into a custom HTTP response                         |
+| [`Authentication`](lib/apimatic-core-interfaces/types/authentication.rb)             | To setup methods for the validation and application of the required authentication scheme  |
+| [`ClientConfiguration`](lib/apimatic-core-interfaces/client/client_configuration.rb) | To setup the http client configurations including retries, timeouts and connections etc.  |
+
+
+## Enumerations
+| Name                                                                                           | Description                                                    |
+|------------------------------------------------------------------------------------------------|----------------------------------------------------------------|
+| [`DateTimeFormat`](lib/apimatic-core-interfaces/types/datetime_format.rb)                      | Enumeration containing different datetime formats (RFC1123, RFC3339, UNIX_TIMESTAMP)              |
+| [`HttpMethod`](lib/apimatic-core-interfaces/types/http_method.rb)                              | Enumeration containing HTTP Methods (GET, PUT, POST, PATCH, DELETE, HEAD) |
+| [`ArraySerializationFormat`](lib/apimatic-core-interfaces/types/array_serialization_format.rb) | Enumeration containing different array serialization formats (INDEXED, UNINDEXED, PLAIN, CSV, PSV, TSV)  |
+
+[rubymine-version]: https://img.shields.io/pypi/v/apimatic-core-interfaces
+[lint-badge]: https://github.com/apimatic/core-interfaces-ruby/actions/workflows/lint-runner.yml/badge.svg
+[lint-url]: https://github.com/apimatic/core-interfaces-ruby/actions/workflows/lint-runner.yml
+[code-climate-url]: https://codeclimate.com/github/apimatic/core-interfaces-ruby
+[maintainability-url]: https://api.codeclimate.com/v1/badges/6557a25e71f7e97e4bb5/maintainability
+[license-badge]: https://img.shields.io/badge/licence-APIMATIC-blue
+[license-url]: LICENSE
+

data/lib/apimatic-core-interfaces/client/client_configuration.rb

@@ -0,0 +1,9 @@
+module CoreLibrary
+  # An interface for the methods that an HTTP Client Configuration must implement.
+  # This class should not be instantiated but should be used as a base class
+  # for HTTP Client Configuration class.
+  class ClientConfiguration
+    attr_reader :timeout, :max_retries, :retry_interval, :backoff_factor, :retry_statuses,
+                :retry_methods, :connection, :adapter, :response_factory, :cache, :verify
+  end
+end

data/lib/apimatic-core-interfaces/client/http_client.rb

@@ -0,0 +1,21 @@
+module CoreLibrary
+  # An interface for the methods that an HTTP Client must implement.
+  # This class should not be instantiated but should be used as a base class
+  # for HTTP Client class.
+  class HttpClient
+    # Execute an HttpRequest when the response is expected to be binary.
+    # @param [HttpRequest] _http_request The HttpRequest to be executed.
+    def execute(_http_request)
+      raise NotImplementedError, 'This method needs
+          to be implemented in a child class.'
+    end
+
+    # Converts the HTTP Response from the client to an HttpResponse object.
+    # @param [Dynamic] _response The response object received from the client.
+    # @param [HttpRequest] _http_request The HttpRequest which was executed.
+    def convert_response(_response, _http_request)
+      raise NotImplementedError, 'This method needs
+          to be implemented in a child class.'
+    end
+  end
+end

data/lib/apimatic-core-interfaces/factories/response_factory.rb

@@ -0,0 +1,17 @@
+module CoreLibrary
+  # An interface for the creation of SDK HttpResponse.
+  # This class should not be instantiated but should be used as a base class
+  # for the HttpResponse creation.
+  class 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)
+      raise NotImplementedError, 'This method needs
+          to be implemented in a child class.'
+    end
+  end
+end

data/lib/apimatic-core-interfaces/types/array_serialization_format.rb

@@ -0,0 +1,19 @@
+module CoreLibrary
+  # All Array Serialization Formats.
+  class ArraySerializationFormat
+    # Members:
+    #     UN_INDEXED: Used for serializing array elements in the un-indexed format.
+    #     INDEXED: Used for serializing array elements in the indexed format.
+    #     PLAIN: Used for serializing array elements in the plain format.
+    #     CSV: Used for serializing array elements in the comma separated format.
+    #     TSV: Used for serializing array elements in the tab separated format.
+    #     PSV: Used for serializing array elements in the pipe separated format.
+
+    ARRAY_SERIALIZATION_FORMAT = [UN_INDEXED = 'un-indexed'.freeze,
+                                  INDEXED = 'indexed'.freeze,
+                                  PLAIN = 'plain'.freeze,
+                                  CSV = 'csv'.freeze,
+                                  TSV = 'tsv'.freeze,
+                                  PSV = 'psv'.freeze].freeze
+  end
+end

data/lib/apimatic-core-interfaces/types/authentication.rb

@@ -0,0 +1,20 @@
+module CoreLibrary
+  # An interface for authenticating the HTTP requests.
+  # This class should not be instantiated but should be used as a base class
+  # for authenticating the request.
+  class Authentication
+    # 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
+      raise NotImplementedError, 'This method needs
+          to be implemented in a child class.'
+    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)
+      raise NotImplementedError, 'This method needs
+          to be implemented in a child class.'
+    end
+  end
+end

data/lib/apimatic-core-interfaces/types/datetime_format.rb

@@ -0,0 +1,17 @@
+module CoreLibrary
+  # Date Time Formats Enumeration.
+  class DateTimeFormat
+    # Members:
+    #     HTTP_DATE_TIME: RFC 1123 Date-Time format
+    #     UNIX_DATE_TIME: Unix Timestamp Format
+    #     RFC3339_DATE_TIME: RFC 3339 Date-Time format
+
+    DATE_TIME_FORMAT = [
+      HTTP_DATE_TIME = 'HttpDateTime'.freeze,
+
+      UNIX_DATE_TIME = 'UnixDateTime'.freeze,
+
+      RFC3339_DATE_TIME = 'RFC3339DateTime'.freeze
+    ].freeze
+  end
+end

data/lib/apimatic-core-interfaces/types/http_callback.rb

@@ -0,0 +1,20 @@
+module CoreLibrary
+  # HttpCallBack allows defining callables for pre and post API calls.
+  # This class should not be instantiated but should be used as a base class
+  # for capturing the request and response of an API call.
+  class HttpCallback
+    # A controller will call this method before making an HTTP Request.
+    # @param [HttpRequest] _http_request The HttpRequest object which the HttpClient will execute.
+    def on_before_request(_http_request)
+      raise NotImplementedError, 'This method needs
+          to be implemented in a child class.'
+    end
+
+    # A controller will call this method after making an HTTP Request.
+    # @param [HttpResponse] _http_response The HttpResponse of the API call.
+    def on_after_response(_http_response)
+      raise NotImplementedError, 'This method needs
+          to be implemented in a child class.'
+    end
+  end
+end

data/lib/apimatic-core-interfaces/types/http_method.rb

@@ -0,0 +1,19 @@
+module CoreLibrary
+  # HTTP Methods Enumeration.
+  class HttpMethod
+    # Members:
+    #     GET: Used for the GET request.
+    #     POST: Used for the POST request.
+    #     PUT: Used for the PUT request.
+    #     PATCH: Used for the PATCH request.
+    #     DELETE: Used for the DELETE request.
+    #     HEAD: Used for the HEAD request.
+
+    HTTP_METHOD = [GET = 'GET'.freeze,
+                   POST = 'POST'.freeze,
+                   PUT = 'PUT'.freeze,
+                   PATCH = 'PATCH'.freeze,
+                   DELETE = 'DELETE'.freeze,
+                   HEAD = 'HEAD'.freeze].freeze
+  end
+end

data/lib/apimatic_core_interfaces.rb

@@ -0,0 +1,10 @@
+require_relative 'apimatic-core-interfaces/client/http_client'
+require_relative 'apimatic-core-interfaces/client/client_configuration'
+
+require_relative 'apimatic-core-interfaces/factories/response_factory'
+
+require_relative 'apimatic-core-interfaces/types/authentication'
+require_relative 'apimatic-core-interfaces/types/http_callback'
+require_relative 'apimatic-core-interfaces/types/http_method'
+require_relative 'apimatic-core-interfaces/types/array_serialization_format'
+require_relative 'apimatic-core-interfaces/types/datetime_format'

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: apimatic_core_interfaces
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- APIMatic Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-12-28 00:00:00.000000000 Z
+dependencies: []
+description: This project contains the abstract layer for APIMatic's core library.
+  The purpose of creating interfaces is to separate out the functionalities needed
+  by APIMatic's core library module. The goal is to support scalability and feature
+  enhancement of the core library and the SDKs along with avoiding any breaking changes
+  by reducing tight coupling between modules through the introduction of interfaces.
+email: support@apimatic.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/apimatic-core-interfaces/client/client_configuration.rb
+- lib/apimatic-core-interfaces/client/http_client.rb
+- lib/apimatic-core-interfaces/factories/response_factory.rb
+- lib/apimatic-core-interfaces/types/array_serialization_format.rb
+- lib/apimatic-core-interfaces/types/authentication.rb
+- lib/apimatic-core-interfaces/types/datetime_format.rb
+- lib/apimatic-core-interfaces/types/http_callback.rb
+- lib/apimatic-core-interfaces/types/http_method.rb
+- lib/apimatic_core_interfaces.rb
+homepage: https://apimatic.io
+licenses:
+- APIMATIC REFERENCE SOURCE LICENSE
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: An abstract layer of the functionalities provided by apimatic-core, faraday-client-adapter
+  and APIMatic SDKs.
+test_files: []