apimatic_faraday_client_adapter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 368a4751f2a43b497174044144d8be6790b1355c19d7a837f647d874a4b78f70
+  data.tar.gz: 0b241473039956ab55f12bd8405453d68eda6ca18697929b9486c0a87221c1f5
+SHA512:
+  metadata.gz: dbb775134ff1563f7ad9230a6fb5104469e51f9526f3c7f1b19004ea9bac5b1b9dff631263fd0da7b625de5d239b6157038240c6b29f1d323fe86a1534e76d21
+  data.tar.gz: 30be7348957c1c0a551d1ee66c5ab0a4802748eae4126af30b438dd3f0420d535df4d7bd51d43e73ab4905c76fad04ad2d306250900779e70af8a95491a3aef2

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,53 @@
+# apimatic-faraday-client-adapter
+
+[![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
+This repository contains the client implementation that uses the faraday client library for the ruby SDKs provided by APIMatic.
+
+## Version supported
+Currently APIMatic supports  `2.6 <= Ruby version < 3.1`  hence faraday-client-adapter will need the same versions to be supported.
+
+## Installation
+Installation is quite simple, just execute the following command:
+```
+gem install apimatic_faraday_client_adapter
+```
+
+If you'd rather install apimatic_faraday_client_adapter using bundler, add a line for it in your Gemfile:
+```
+gem 'apimatic_faraday_client_adapter'
+```
+
+## Classes
+| Class                                                                                | Description                                                                                        |
+|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
+| [`FaradayClient`](lib/apimatic-faraday-client-adapter/faraday_client.rb)             | Executes an HttpRequest and converts the HTTP Response from the client to an HttpResponse object.  |
+
+
+## Methods
+| Method                                                                         | Description                                   |
+|--------------------------------------------------------------------------------|-----------------------------------------------|
+| [`create_connection`](lib/apimatic-faraday-client-adapter/faraday_client.rb)   | Initiates a new connection for executing the HTTP calls            |
+| [`execute`](lib/apimatic-faraday-client-adapter/faraday_client.rb)             | Executes request with the properties set                           |
+| [`convert_response`](lib/apimatic-faraday-client-adapter/faraday_client.rb)    | Converts the Response from the HTTP client into HttpResponse object|
+
+## Links
+
+[//]: # (* [apimatic-core-interfaces]&#40;https://pypi.org/project/apimatic-core-interfaces/&#41;)
+* [Faraday](https://rubygems.org/gems/faraday)
+
+[test-badge]: https://github.com/apimatic/faraday-client-adapter/actions/workflows/test-runner.yml/badge.svg
+[test-url]: https://github.com/apimatic/faraday-client-adapter/actions/workflows/test-runner.yml
+[lint-badge]: https://github.com/apimatic/faraday-client-adapter/actions/workflows/lint-runner.yml/badge.svg
+[lint-url]: https://github.com/apimatic/faraday-client-adapter/actions/workflows/lint-runner.yml
+[code-climate-url]: https://codeclimate.com/github/apimatic/faraday-client-adapter
+[maintainability-url]: https://api.codeclimate.com/v1/badges/59badaadebeb3478eb48/maintainability
+[test-coverage-url]: https://api.codeclimate.com/v1/badges/59badaadebeb3478eb48/test_coverage
+[license-badge]: https://img.shields.io/badge/licence-APIMATIC-blue
+[license-url]: LICENSE

data/lib/apimatic-faraday-client-adapter/faraday_client.rb

@@ -0,0 +1,76 @@
+require 'faraday/http_cache'
+require 'faraday/retry'
+require 'faraday/multipart'
+require 'faraday/follow_redirects'
+require 'faraday/gzip'
+require 'faraday/net_http_persistent'
+
+module CoreLibrary
+  # An implementation of HttpClient.
+  class FaradayClient < CoreLibrary::HttpClient
+    # The attribute readers for properties.
+    attr_reader :connection, :response_factory
+
+    # The constructor.
+    # @param [ClientConfiguration] client_configuration The configurations for the Faraday client.
+    def initialize(client_configuration)
+      @response_factory = client_configuration.response_factory
+      @connection = if client_configuration.connection.nil?
+                      create_connection(client_configuration)
+                    else
+                      client_configuration.connection
+                    end
+    end
+
+    # Method to initialize connection.
+    # @param [ClientConfiguration] client_configuration The configurations for the Faraday client.
+    def create_connection(client_configuration)
+      Faraday.new do |faraday|
+        faraday.use Faraday::HttpCache, serializer: Marshal if client_configuration.cache
+        faraday.use Faraday::FollowRedirects::Middleware
+        faraday.request :gzip
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.ssl[:ca_file] = Certifi.where
+        faraday.ssl[:verify] = client_configuration.verify
+        faraday.request :retry,
+                        max: client_configuration.max_retries,
+                        interval: client_configuration.retry_interval,
+                        backoff_factor: client_configuration.backoff_factor,
+                        retry_statuses: client_configuration.retry_statuses,
+                        methods: client_configuration.retry_methods,
+                        retry_if: proc { |env, _exc|
+                          env.request.context['forced_retry'] ||= false
+                        }
+        faraday.adapter client_configuration.adapter
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
+        faraday.options[:timeout] = client_configuration.timeout if client_configuration.timeout.positive?
+      end
+    end
+
+    # Method overridden from HttpClient.
+    # @param [HttpRequest] http_request The HttpRequest to be executed.
+    def execute(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers.map { |k, v| [k.to_s, v.to_s] }
+        request.options.context ||= {}
+        request.options.context.merge!(http_request.context)
+        unless http_request.http_method == HttpMethod::GET && http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
+      end
+      convert_response(response, http_request)
+    end
+
+    # Method overridden from HttpClient.
+    # @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)
+      @response_factory.create(response.status, response.reason_phrase,
+                               response.headers, response.body, http_request)
+    end
+  end
+end

data/lib/apimatic_faraday_client_adapter.rb

@@ -0,0 +1,4 @@
+require 'faraday'
+require 'certifi'
+require 'apimatic_core_interfaces'
+require_relative 'apimatic-faraday-client-adapter/faraday_client'

metadata

@@ -0,0 +1,235 @@
+--- !ruby/object:Gem::Specification
+name: apimatic_faraday_client_adapter
+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:
+- !ruby/object:Gem::Dependency
+  name: apimatic_core_interfaces
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-gzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http_persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: certifi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2018.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2018.01.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2018.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2018.01.18
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.1
+- !ruby/object:Gem::Dependency
+  name: minitest-proveit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+description: Faraday is a simple, yet elegant, HTTP library. This repository contains
+  the client implementation that uses the requests library for python SDK provided
+  by APIMatic.
+email: support@apimatic.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/apimatic-faraday-client-adapter/faraday_client.rb
+- lib/apimatic_faraday_client_adapter.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 adapter for faraday client library consumed by the SDKs generated with
+  APIMatic.
+test_files: []