wesley-key-sdk 0.1.7 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b32f263fc60a62f3e0f46b9eee4275f72dbcfcb13790f5ba79bad8cfdb1bc660
-  data.tar.gz: 2d482091fdb4bf25fa3d6d375775c493b19cca519b5d626cd334359d32d3a9a1
+  metadata.gz: 987a43498857664572a8228264bc2b63580e6120df139eb5087bbc800d9fa469
+  data.tar.gz: 68ea1ecd67713a031a8f71d67542aa076efe3754c26b1960b2de8f61ccda73f1
 SHA512:
-  metadata.gz: d6c6219a7f98f45784f43b1bbb4efe716c219fac7fb3cb4a68e7d3dc4848c95cd254aaf813da791b0e86bd6630a42d75f77619a2a62156defde759452853830d
-  data.tar.gz: 8e7eea8e9bafa69b3010ae4899b6ac1c302a8356bbd6ad3c98baaeb548e4f249b5b0730e887e1475030c38efbbbbbea17138726af43cced87bd0274d8cbe5c5e
+  metadata.gz: 8713b6f446cc6593942de3d498ab6696700324137cfe784f9fd8526cb6e0cdf17354c21d353bf7b54ce61f0282508ef75f11e458d6ad36000bb262caec367842
+  data.tar.gz: ca0e97d5a2dfaf407b8b44d040889723212ff67260575075290f90b8a1ac3e94b2132b9aaf3683045fc50479dc145396f896e56501204e90c05a5f1167043fdf

data/README.md

@@ -1,62 +1,25 @@
 
-# Getting Started with Swagger Petstore
+# Getting Started with Cypress Test API
 
 ## Introduction
 
-This is a sample server Petstore server.  You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).  For this sample, you can use the api key `special-key` to test the authorization filters.
-
-Find out more about Swagger: [http://swagger.io](http://swagger.io)
+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 0.1.7
+gem install wesley-key-sdk -v 1.1.1
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'wesley-key-sdk', '0.1.7'
-```
-
-For additional gem details, see the [RubyGems page for the wesley-key-sdk gem](https://rubygems.org/gems/wesley-key-sdk/versions/0.1.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 'swagger_petstore'
-include SwaggerPetstore
-```
-
-### 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
+gem 'wesley-key-sdk', '1.1.1'
 ```
 
-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/
+For additional gem details, see the [RubyGems page for the wesley-key-sdk gem](https://rubygems.org/gems/wesley-key-sdk/versions/1.1.1).
 
 ## Test the SDK
 
@@ -68,13 +31,13 @@ rake
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.1/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| test_header | `String` | This is a test header<br>*Default*: `'TestHeaderDefaultValue'` |
+| default_host | `String` | *Default*: `'www.example.com'` |
 | environment | `Environment` | 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 |
@@ -85,92 +48,37 @@ The following parameters are configurable for the API Client:
 | 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/0.1.7/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
-| api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
-| http_basic_credentials | [`HttpBasicCredentials`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
-| petstore_auth_credentials | [`PetstoreAuthCredentials`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/auth/oauth-2-implicit-grant.md) | The credential object for OAuth 2 Implicit Grant |
+| proxy_settings | [`ProxySettings`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.1/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 'swagger_petstore'
-include SwaggerPetstore
+require 'cypress_test_api'
+include CypressTestApi
 
 client = Client.new(
-  test_header: 'TestHeaderDefaultValue',
-  api_key_credentials: ApiKeyCredentials.new(
-    api_key: 'api_key'
-  ),
-  http_basic_credentials: HttpBasicCredentials.new(
-    username: 'username',
-    passwprd: 'passwprd'
-  ),
-  petstore_auth_credentials: PetstoreAuthCredentials.new(
-    o_auth_client_id: 'OAuthClientId',
-    o_auth_redirect_uri: 'OAuthRedirectUri',
-    o_auth_scopes: [
-      OAuthScopePetstoreAuthEnum::READPETS,
-      OAuthScopePetstoreAuthEnum::WRITEPETS
-    ]
-  ),
-  environment: Environment::PRODUCTION
+  environment: Environment::PRODUCTION,
+  default_host: 'www.example.com'
 )
 ```
 
-### Environment-Based Client Initialization
-
-```ruby
-require 'swagger_petstore'
-include SwaggerPetstore
-
-# Create client from environment
-client = Client.from_env
-```
-
-See the [`Environment-Based Client Initialization`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.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** |
-| environment2 | - |
-| environment3 | - |
-
-## Authorization
-
-This API uses the following authentication schemes.
-
-* [`api_key (Custom Header Signature)`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/auth/custom-header-signature.md)
-* [`httpBasic (Basic Authentication)`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/auth/basic-authentication.md)
-* [`petstore_auth (OAuth 2 Implicit Grant)`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/auth/oauth-2-implicit-grant.md)
-
 ## List of APIs
 
-* [Pet](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/controllers/pet.md)
-* [Store](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/controllers/store.md)
-* [User](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/controllers/user.md)
+* [API](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.1/doc/controllers/api.md)
 
 ## SDK Infrastructure
 
 ### Configuration
 
-* [ProxySettings](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/proxy-settings.md)
-* [Environment-Based Client Initialization](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/environment-based-client-initialization.md)
+* [ProxySettings](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.1/doc/proxy-settings.md)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/http-response.md)
-* [HttpRequest](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/http-request.md)
+* [HttpResponse](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.1/doc/http-request.md)
 
 ### Utilities
 
-* [ApiHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.7/doc/date-time-helper.md)
+* [ApiHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.1/doc/date-time-helper.md)
 

data/lib/{swagger_petstore → cypress_test_api}/api_helper.rb

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

data/lib/cypress_test_api/client.rb

@@ -0,0 +1,47 @@
+# cypress_test_api
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module CypressTestApi
+  #  cypress_test_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config
+
+    # Access to client controller.
+    # @return [APIController] Returns the controller instance.
+    def client
+      @client ||= APIController.new @global_configuration
+    end
+
+    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], http_callback: nil, proxy_settings: nil,
+      environment: Environment::PRODUCTION, default_host: 'www.example.com',
+      config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(connection: connection, adapter: adapter,
+                                    timeout: timeout, max_retries: max_retries,
+                                    retry_interval: retry_interval,
+                                    backoff_factor: backoff_factor,
+                                    retry_statuses: retry_statuses,
+                                    retry_methods: retry_methods,
+                                    http_callback: http_callback,
+                                    proxy_settings: proxy_settings,
+                                    environment: environment,
+                                    default_host: default_host)
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+    end
+  end
+end

data/lib/cypress_test_api/configuration.rb

@@ -0,0 +1,103 @@
+# cypress_test_api
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module CypressTestApi
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :default_host
+
+    class << self
+      attr_reader :environments
+    end
+
+    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], http_callback: nil, proxy_settings: nil,
+      environment: Environment::PRODUCTION, default_host: 'www.example.com'
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings
+
+      # Current API environment
+      @environment = String(environment)
+
+      # defaultHost value
+      @default_host = default_host
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, environment: nil, default_host: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      environment ||= self.environment
+      default_host ||= self.default_host
+
+      Configuration.new(connection: connection, adapter: adapter,
+                        timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods,
+                        http_callback: http_callback,
+                        proxy_settings: proxy_settings,
+                        environment: environment, default_host: default_host)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://{defaultHost}'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      parameters = {
+        'defaultHost' => { 'value' => default_host, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
+    end
+  end
+end

data/lib/cypress_test_api/controllers/api_controller.rb

@@ -0,0 +1,102 @@
+# cypress_test_api
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module CypressTestApi
+  # APIController
+  class APIController < BaseController
+    # Creates a new resource in the system.
+    # @param [Status11Enum] status Required parameter: The status of the items
+    # to filter by.
+    # @param [Item] body Optional parameter: Custom model with additional
+    # properties
+    # @return [Object] Response from the API call.
+    def createanitem(status,
+                     body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/items/{status}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(status, key: 'status')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .local_error('400',
+                                 'Bad Syntax',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Permission Denied',
+                                 APIException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] id Required parameter: The ID of the item to retrieve
+    # @param [String] value Required parameter: The value of the item to
+    # retrieve
+    # @return [Item] Response from the API call.
+    def getanitemby_id(id,
+                       value)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/items/{id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(value, key: 'value'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Item.method(:from_hash)))
+        .execute
+    end
+
+    # Generates a new OAuth token with the specified scopes.
+    # @param [TokensRequest] body Optional parameter: TODO: type description
+    # here
+    # @return [void] Response from the API call.
+    def create_o_auth_token(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/tokens',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .local_error('400',
+                                 'Bad request',
+                                 APIException))
+        .execute
+    end
+
+    # This endpoint accepts a complex structure with multiple arrays.
+    # @param [MultipleArraysRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
+    def test_endpointwith_arrays(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/multiple-arrays',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .local_error('400',
+                                 'Bad request',
+                                 APIException))
+        .execute
+    end
+  end
+end

data/lib/{swagger_petstore → cypress_test_api}/controllers/base_controller.rb

@@ -1,9 +1,9 @@
-# swagger_petstore
+# cypress_test_api
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module SwaggerPetstore
+module CypressTestApi
   # BaseController.
   class BaseController
     include CoreLibrary

data/lib/{swagger_petstore → cypress_test_api}/exceptions/api_exception.rb

@@ -1,9 +1,9 @@
-# swagger_petstore
+# cypress_test_api
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module SwaggerPetstore
+module CypressTestApi
   # Class for exceptions when there is a network error, status code error, etc.
   class APIException < CoreLibrary::ApiException
     # Provides a human-readable string representation of the object.

data/lib/{swagger_petstore → cypress_test_api}/http/http_call_back.rb

@@ -1,9 +1,9 @@
-# swagger_petstore
+# cypress_test_api
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module SwaggerPetstore
+module CypressTestApi
   # HttpCallBack allows defining callables for pre and post API calls.
   class HttpCallBack < CoreLibrary::HttpCallback
   end

data/lib/{swagger_petstore → cypress_test_api}/http/http_method_enum.rb

@@ -1,9 +1,9 @@
-# swagger_petstore
+# cypress_test_api
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module SwaggerPetstore
+module CypressTestApi
   # HTTP Methods Enumeration.
   class HttpMethodEnum < CoreLibrary::HttpMethod
   end

data/lib/{swagger_petstore → cypress_test_api}/http/http_request.rb

@@ -1,9 +1,9 @@
-# swagger_petstore
+# cypress_test_api
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module SwaggerPetstore
+module CypressTestApi
   # Represents a single Http Request.
   class HttpRequest < CoreLibrary::HttpRequest
   end

data/lib/{swagger_petstore → cypress_test_api}/http/http_response.rb

@@ -1,9 +1,9 @@
-# swagger_petstore
+# cypress_test_api
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module SwaggerPetstore
+module CypressTestApi
   # Http response received.
   class HttpResponse < CoreLibrary::HttpResponse
   end

data/lib/cypress_test_api/http/proxy_settings.rb

@@ -0,0 +1,13 @@
+# cypress_test_api
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module CypressTestApi
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+  end
+end

data/lib/{swagger_petstore → cypress_test_api}/models/base_model.rb

@@ -1,9 +1,9 @@
-# swagger_petstore
+# cypress_test_api
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module SwaggerPetstore
+module CypressTestApi
   # Base model.
   # rubocop:disable all
   class BaseModel < CoreLibrary::BaseModel

data/lib/cypress_test_api/models/custom_enum.rb

@@ -0,0 +1,26 @@
+# cypress_test_api
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module CypressTestApi
+  # CustomEnum.
+  class CustomEnum
+    CUSTOM_ENUM = [
+      # TODO: Write general description for VALUE1
+      VALUE1 = 'VALUE1'.freeze,
+
+      # TODO: Write general description for VALUE2
+      VALUE2 = 'VALUE2'.freeze,
+
+      # TODO: Write general description for VALUE3
+      VALUE3 = 'VALUE3'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CUSTOM_ENUM.include?(value)
+    end
+  end
+end