wesley-key-sdk 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8ccc80876b4bddcfbd2f5bba54cb4d9bab55f7de0b0d0b078deabf3e24ff149
-  data.tar.gz: 9b0b9ebcb2e165727b56be888eaf36481cc75827e12459a03bc828c7466d86e7
+  metadata.gz: b32f263fc60a62f3e0f46b9eee4275f72dbcfcb13790f5ba79bad8cfdb1bc660
+  data.tar.gz: 2d482091fdb4bf25fa3d6d375775c493b19cca519b5d626cd334359d32d3a9a1
 SHA512:
-  metadata.gz: 69b5c83b7d2c862d2db646fac6a28062e91c4f971958236381fa9b200abf37a68f42cf1e2ec5c789ffe980416ff78b9e6f0f70d6bf91721f60ba9124041d3c1b
-  data.tar.gz: 45d2b0d8c3c4cea9919c2585e094356e3a52015afc72645bc3f581d7661f1d500adb4a60a13839122421a166da56c7de37b3302c149f1ca14a7370e200a6f791
+  metadata.gz: d6c6219a7f98f45784f43b1bbb4efe716c219fac7fb3cb4a68e7d3dc4848c95cd254aaf813da791b0e86bd6630a42d75f77619a2a62156defde759452853830d
+  data.tar.gz: 8e7eea8e9bafa69b3010ae4899b6ac1c302a8356bbd6ad3c98baaeb548e4f249b5b0730e887e1475030c38efbbbbbea17138726af43cced87bd0274d8cbe5c5e

data/README.md

@@ -1,25 +1,27 @@
 
-# Getting Started with Cypress Test API
+# Getting Started with Swagger Petstore
 
 ## Introduction
 
-This is a sample API to demonstrate an OpenAPI spec with multiple endpoints and a custom model.
+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)
 
 ## Install the Package
 
 Install the gem from the command line:
 
 ```bash
-gem install wesley-key-sdk -v 0.1.6
+gem install wesley-key-sdk -v 0.1.7
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'wesley-key-sdk', '0.1.6'
+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.6).
+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
 
@@ -36,8 +38,8 @@ irb
 Now you can load the SDK in the IRB
 
 ```ruby
-require 'cypress_test_api'
-include CypressTestApi
+require 'swagger_petstore'
+include SwaggerPetstore
 ```
 
 ### 2. Use IRB within SDK
@@ -45,7 +47,7 @@ include CypressTestApi
 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
+cd path/to/swagger_petstore
 ```
 
 Now you can start the preconfigured irb console by running the following command
@@ -66,13 +68,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.6/doc/client.md)
+**_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)
 
 The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| default_host | `String` | *Default*: `'www.example.com'` |
+| test_header | `String` | This is a test header<br>*Default*: `'TestHeaderDefaultValue'` |
 | 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 |
@@ -83,52 +85,92 @@ 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.6/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| 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 |
 
 The API client can be initialized as follows:
 
 ### Code-Based Client Initialization
 
 ```ruby
-require 'cypress_test_api'
-include CypressTestApi
+require 'swagger_petstore'
+include SwaggerPetstore
 
 client = Client.new(
-  environment: Environment::PRODUCTION,
-  default_host: 'www.example.com'
+  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-Based Client Initialization
 
 ```ruby
-require 'cypress_test_api'
-include CypressTestApi
+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.6/doc/environment-based-client-initialization.md) section for details.
+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
 
-* [API](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.6/doc/controllers/api.md)
+* [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)
 
 ## SDK Infrastructure
 
 ### Configuration
 
-* [ProxySettings](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.6/doc/proxy-settings.md)
-* [Environment-Based Client Initialization](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.6/doc/environment-based-client-initialization.md)
+* [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)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.6/doc/http-response.md)
-* [HttpRequest](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.6/doc/http-request.md)
+* [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)
 
 ### Utilities
 
-* [ApiHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.6/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/0.1.6/doc/date-time-helper.md)
+* [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)
 

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'
 
-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 'SwaggerPetstore SDK loaded!'
+puts 'You can now create a client with: client = SwaggerPetstore::Client.new'
+puts 'Or use from_env: client = SwaggerPetstore::Client.from_env'
 
 # Start an interactive IRB session
 require 'irb'

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

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

data/lib/swagger_petstore/client.rb

@@ -0,0 +1,95 @@
+# swagger_petstore
+#
+# This file was automatically generated by APIMATIC v3.0
+# ( https://www.apimatic.io ).
+
+module SwaggerPetstore
+  #  swagger_petstore client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Returns the configured authentication petstore_auth instance.
+    def petstore_auth
+      @auth_managers['petstore_auth']
+    end
+
+    # Access to pet controller.
+    # @return [PetController] Returns the controller instance.
+    def pet
+      @pet ||= PetController.new @global_configuration
+    end
+
+    # Access to store controller.
+    # @return [StoreController] Returns the controller instance.
+    def store
+      @store ||= StoreController.new @global_configuration
+    end
+
+    # Access to user controller.
+    # @return [UserController] Returns the controller instance.
+    def user
+      @user ||= UserController.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, api_key_credentials: nil,
+      http_basic_credentials: nil, petstore_auth_credentials: nil,
+      test_header: 'TestHeaderDefaultValue', 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,
+                    api_key_credentials: api_key_credentials,
+                    http_basic_credentials: http_basic_credentials,
+                    petstore_auth_credentials: petstore_auth_credentials,
+                    test_header: test_header
+                  )
+                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)
+                                                 .global_header('TestHeader', @config.test_header)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[api_key httpBasic petstore_auth].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['api_key'] = ApiKey.new(http_client_config.api_key_credentials)
+      @auth_managers['httpBasic'] = HttpBasic.new(http_client_config.http_basic_credentials)
+      @auth_managers['petstore_auth'] = PetstoreAuth.new(
+        http_client_config.petstore_auth_credentials, global_config
+      )
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end

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

@@ -1,20 +1,31 @@
-# cypress_test_api
+# swagger_petstore
 #
 # This file was automatically generated by APIMATIC v3.0
 # ( https://www.apimatic.io ).
 
-module CypressTestApi
+module SwaggerPetstore
   # An enum for SDK environments.
   class Environment
     ENVIRONMENT = [
-      PRODUCTION = 'production'.freeze
+      PRODUCTION = 'production'.freeze,
+      ENVIRONMENT2 = 'environment2'.freeze,
+      ENVIRONMENT3 = 'environment3'.freeze
     ].freeze
 
     # Converts a string or symbol into a valid Environment constant.
     def self.from_value(value, default_value = PRODUCTION)
       return default_value if value.nil?
 
-      default_value
+      str = value.to_s.strip.downcase
+      case str
+      when 'production' then PRODUCTION
+      when 'environment2' then ENVIRONMENT2
+      when 'environment3' then ENVIRONMENT3
+
+      else
+        warn "[Environment] Unknown environment '#{value}', falling back to #{default_value} "
+        default_value
+      end
     end
   end
 
@@ -36,7 +47,8 @@ module CypressTestApi
   # are configured in this class.
   class Configuration < CoreLibrary::HttpClientConfiguration
     # The attribute readers for properties.
-    attr_reader :environment, :default_host
+    attr_reader :environment, :api_key_credentials, :http_basic_credentials,
+                :petstore_auth_credentials, :test_header
 
     class << self
       attr_reader :environments
@@ -47,7 +59,9 @@ module CypressTestApi
       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'
+      environment: Environment::PRODUCTION, api_key_credentials: nil,
+      http_basic_credentials: nil, petstore_auth_credentials: nil,
+      test_header: 'TestHeaderDefaultValue'
     )
       super connection: connection, adapter: adapter, timeout: timeout,
             max_retries: max_retries, retry_interval: retry_interval,
@@ -58,8 +72,17 @@ module CypressTestApi
       # Current API environment
       @environment = String(environment)
 
-      # defaultHost value
-      @default_host = default_host
+      # The object holding Custom Header Signature credentials
+      @api_key_credentials = api_key_credentials
+
+      # The object holding Basic Authentication credentials
+      @http_basic_credentials = http_basic_credentials
+
+      # The object holding OAuth 2 Implicit Grant credentials
+      @petstore_auth_credentials = petstore_auth_credentials
+
+      # This is a test header
+      @test_header = test_header
 
       # The Http Client to use for making requests.
       set_http_client CoreLibrary::FaradayClient.new(self)
@@ -68,7 +91,9 @@ module CypressTestApi
     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)
+                   proxy_settings: nil, environment: nil,
+                   api_key_credentials: nil, http_basic_credentials: nil,
+                   petstore_auth_credentials: nil, test_header: nil)
       connection ||= self.connection
       adapter ||= self.adapter
       timeout ||= self.timeout
@@ -80,7 +105,10 @@ module CypressTestApi
       http_callback ||= self.http_callback
       proxy_settings ||= self.proxy_settings
       environment ||= self.environment
-      default_host ||= self.default_host
+      api_key_credentials ||= self.api_key_credentials
+      http_basic_credentials ||= self.http_basic_credentials
+      petstore_auth_credentials ||= self.petstore_auth_credentials
+      test_header ||= self.test_header
 
       Configuration.new(connection: connection, adapter: adapter,
                         timeout: timeout, max_retries: max_retries,
@@ -90,14 +118,24 @@ module CypressTestApi
                         retry_methods: retry_methods,
                         http_callback: http_callback,
                         proxy_settings: proxy_settings,
-                        environment: environment, default_host: default_host)
+                        environment: environment,
+                        api_key_credentials: api_key_credentials,
+                        http_basic_credentials: http_basic_credentials,
+                        petstore_auth_credentials: petstore_auth_credentials,
+                        test_header: test_header)
     end
 
 
     # All the environments the SDK can run in.
     ENVIRONMENTS = {
       Environment::PRODUCTION => {
-        Server::DEFAULT => 'https://{defaultHost}'
+        Server::DEFAULT => 'https://petstore.swagger.io/v2'
+      },
+      Environment::ENVIRONMENT2 => {
+        Server::DEFAULT => 'http://petstore.swagger.io/v2'
+      },
+      Environment::ENVIRONMENT3 => {
+        Server::DEFAULT => 'https://petstore.swagger.io/oauth'
       }
     }.freeze
 
@@ -106,19 +144,14 @@ module CypressTestApi
     # 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
-      )
+      ENVIRONMENTS[environment][server].clone
     end
 
     # Builds a Configuration instance using environment variables.
     def self.build_default_config_from_env
       # === Core environment ===
       environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production'))
-      default_host = ENV.fetch('DEFAULT_HOST', 'www.example.com')
+      test_header = ENV.fetch('TEST_HEADER', 'TestHeaderDefaultValue')
       timeout = (ENV['TIMEOUT'] || 60).to_f
       max_retries = (ENV['MAX_RETRIES'] || 0).to_i
       retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
@@ -137,18 +170,26 @@ module CypressTestApi
                                             item.match?(/\A\d+\z/) ? item.to_i : item.downcase
                                           end
 
+      # === Authentication credentials ===
+      api_key_credentials = ApiKeyCredentials.from_env
+      http_basic_credentials = HttpBasicCredentials.from_env
+      petstore_auth_credentials = PetstoreAuthCredentials.from_env
+
       # === Proxy settings ===
       proxy_settings = ProxySettings.from_env
 
       Configuration.new(
         environment: environment,
-        default_host: default_host,
+        test_header: test_header,
         timeout: timeout,
         max_retries: max_retries,
         retry_interval: retry_interval,
         backoff_factor: backoff_factor,
         retry_statuses: retry_statuses,
         retry_methods: retry_methods,
+        api_key_credentials: api_key_credentials,
+        http_basic_credentials: http_basic_credentials,
+        petstore_auth_credentials: petstore_auth_credentials,
         proxy_settings: proxy_settings
       )
     end

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

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