wesley-key-sdk 3.0.7 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 784656e06493786bdbd19fb9edb6c3937440703f401e611933de3aa5974cd64e
-  data.tar.gz: ef76250bba23b0a785aaca63c02cf83dc271fc29fd7346f83a248e24221ff13a
+  metadata.gz: f22b22395a8452f239db0c529bcd4bd9c4d209bc42dece0aa51ccda0794bf274
+  data.tar.gz: 646a929e08b140f97c9ff50c7aa9e052d087e5880f5b13b0f045d84dfa6a4bb4
 SHA512:
-  metadata.gz: fc1de4713f9f89bc8dd517e1350676182f963069cf431639e87ab5befc55cdf39fbedec5bc37db700ffdfabac478ba15ebd107df8e94c8dc5da45085102f5021
-  data.tar.gz: 955843f36310a6a95479a3a7eb523c41c0acba470583c4d259eb3f6cd40e4e607bef83c33f8a81e7f1fe9ae8bfd772e6b9cd160ff2bb0579e784d5bf8cce79a2
+  metadata.gz: 8b841fcc3575323415331051808a172ab7b2f10380c9292190d122a6912b6e68ab655654905faa41949e252c2b1aa9ba9923146dab8c32bb85eb24b8cee1d241
+  data.tar.gz: e7865b424ea16c05604c1ed249dcc4665279c35b890ea60736597b6c0476889121b9a662e67f40956192fc8e372c496fe1920e43ddf75cf1e0101462a53783bd

data/README.md

@@ -1,144 +1,181 @@
-
-# Getting Started with Cypress Test API
-
-## Introduction
-
-This is a sample API to demonstrate an OpenAPI spec with multiple endpoints and a custom model.
-
-## Install the Package
-
-Install the gem from the command line:
-
-```bash
-gem install wesley-key-sdk -v 3.0.7
-```
-
-Or add the gem to your Gemfile and run `bundle`:
-
-```ruby
-gem 'wesley-key-sdk', '3.0.7'
-```
-
-For additional gem details, see the [RubyGems page for the wesley-key-sdk gem](https://rubygems.org/gems/wesley-key-sdk/versions/3.0.7).
-
-## IRB Console Usage
-
-You can explore the SDK interactively using IRB in two ways
-
-### 1. Use IRB with Installed Gem
-
-Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
-
-```bash
-irb
-```
-
-Now you can load the SDK in the IRB
-
-```ruby
-require 'cypress_test_api'
-include CypressTestApi
-```
-
-### 2. Use IRB within SDK
-
-Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
-
-```
-cd path/to/cypress_test_api
-```
-
-Now you can start the preconfigured irb console by running the following command
-
-```bash
-ruby bin/console
-```
-
-**_Note:_** This automatically loads the SDK from lib/
-
-## Test the SDK
-
-To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
-
-```
-rake
-```
-
-## Initialize the API Client
-
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/client.md)
-
-The following parameters are configurable for the API Client:
-
-| Parameter | Type | Description |
-|  --- | --- | --- |
-| default_host | `String` | *Default*: `'www.example.com'` |
-| environment | [`Environment`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
-| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
-| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
-| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
-| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
-| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
-| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
-| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
-| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
-| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
-| proxy_settings | [`ProxySettings`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
-
-The API client can be initialized as follows:
-
-### Code-Based Client Initialization
-
-```ruby
-require 'cypress_test_api'
-include CypressTestApi
+
+# Getting Started with Swagger Petstore - OpenAPI 3.0
+
+## Introduction
+
+This is a sample Pet Store Server based on the OpenAPI 3.0 specification.  You can find out more about
+Swagger at [https://swagger.io](https://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!
+You can now help us improve the API whether it's by making changes to the definition itself or to the code.
+That way, with time, we can improve the API in general, and expose some of the new features in OAS3.
+
+Some useful links:
+
+- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)
+- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)
+
+Find out more about Swagger: [https://swagger.io](https://swagger.io)
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install wesley-key-sdk -v 4.2.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'wesley-key-sdk', '4.2.0'
+```
+
+For additional gem details, see the [RubyGems page for the wesley-key-sdk gem](https://rubygems.org/gems/wesley-key-sdk/versions/4.2.0).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'swagger_petstore_open_api30'
+include SwaggerPetstoreOpenApi30
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/swagger_petstore_open_api30
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 30** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| petstore_auth_credentials | [`PetstoreAuthCredentials`](doc/auth/oauth-2-implicit-grant.md) | The credential object for OAuth 2 Implicit Grant |
+| api_key_credentials | [`ApiKeyCredentials`](doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'swagger_petstore_open_api30'
+include SwaggerPetstoreOpenApi30
 
 client = Client.new(
+  petstore_auth_credentials: PetstoreAuthCredentials.new(
+    oauth_client_id: 'OAuthClientId',
+    oauth_redirect_uri: 'OAuthRedirectUri',
+    oauth_scopes: [
+      OauthScopePetstoreAuth::WRITEPETS,
+      OauthScopePetstoreAuth::READPETS
+    ]
+  ),
+  api_key_credentials: ApiKeyCredentials.new(
+    api_key: 'api_key'
+  ),
   environment: Environment::PRODUCTION,
-  default_host: 'www.example.com'
-)
-```
-
-### Environment-Based Client Initialization
-
-```ruby
-require 'cypress_test_api'
-include CypressTestApi
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'swagger_petstore_open_api30'
+include SwaggerPetstoreOpenApi30
 
 # Create client from environment
-client = Client.from_env
-```
-
-See the [`Environment-Based Client Initialization`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/environment-based-client-initialization.md) section for details.
-
-## Environments
-
-The SDK can be configured to use a different environment for making API calls. Available environments are:
-
-### Fields
-
-| Name | Description |
-|  --- | --- |
-| PRODUCTION | **Default** |
-
-## List of APIs
-
-* [API](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/controllers/api.md)
-
-## SDK Infrastructure
-
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](doc/environment-based-client-initialization.md) section for details.
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION | **Default** |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`petstore_auth (OAuth 2 Implicit Grant)`](doc/auth/oauth-2-implicit-grant.md)
+* [`api_key (Custom Header Signature)`](doc/auth/custom-header-signature.md)
+
+## List of APIs
+
+* [Pet](doc/controllers/pet.md)
+* [Store](doc/controllers/store.md)
+* [User](doc/controllers/user.md)
+
+## SDK Infrastructure
+
 ### Configuration
 
-* [ProxySettings](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/proxy-settings.md)
-* [Environment-Based Client Initialization](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/environment-based-client-initialization.md)
+* [ProxySettings](doc/proxy-settings.md)
+* [Environment-Based Client Initialization](doc/environment-based-client-initialization.md)
+* [AbstractLogger](doc/abstract-logger.md)
+* [LoggingConfiguration](doc/logging-configuration.md)
+* [RequestLoggingConfiguration](doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](doc/response-logging-configuration.md)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/http-response.md)
-* [HttpRequest](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/http-request.md)
+* [HttpResponse](doc/http-response.md)
+* [HttpRequest](doc/http-request.md)
 
 ### Utilities
 
-* [ApiHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/3.0.7/doc/date-time-helper.md)
-
+* [ApiResponse](doc/api-response.md)
+* [ApiHelper](doc/api-helper.md)
+* [DateTimeHelper](doc/date-time-helper.md)
+

data/bin/console

@@ -4,11 +4,11 @@
 $LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
 
 # Require the gem
-require 'cypress_test_api'
+require 'swagger_petstore_open_api30'
 
-puts 'CypressTestApi SDK loaded!'
-puts 'You can now create a client with: client = CypressTestApi::Client.new'
-puts 'Or use from_env: client = CypressTestApi::Client.from_env'
+puts 'SwaggerPetstoreOpenApi30 SDK loaded!'
+puts 'You can now create a client with: client = SwaggerPetstoreOpenApi30::Client.new'
+puts 'Or use from_env: client = SwaggerPetstoreOpenApi30::Client.from_env'
 
 # Start an interactive IRB session
 require 'irb'

data/lib/swagger_petstore_open_api30/api_helper.rb

@@ -0,0 +1,10 @@
+# swagger_petstore_open_api30
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module SwaggerPetstoreOpenApi30
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/{cypress_test_api/controllers/base_controller.rb → swagger_petstore_open_api30/apis/base_api.rb}

@@ -1,23 +1,30 @@
-# cypress_test_api
+# swagger_petstore_open_api30
 #
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
-module CypressTestApi
-  # BaseController.
-  class BaseController
+module SwaggerPetstoreOpenApi30
+  # BaseApi.
+  class BaseApi
     include CoreLibrary
     attr_accessor :config, :http_call_back
 
-    def self.user_agent
-      'APIMATIC 3.0'
+    def self.user_agent
+      'Ruby-SDK/4.2.0 (OS: {os-info}, Engine: {engine}/{engine-version})'
     end
 
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
 
-    GLOBAL_ERRORS = {
+    GLOBAL_ERRORS = {
       'default' => ErrorCase.new
                             .error_message('HTTP response not OK.')
-                            .exception_type(APIException)
+                            .exception_type(APIException)
     }.freeze
 
     # Initialization constructor.