wesley-key-sdk 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9256ecaae367cc849e40e6270dfcb9fcc7f2a31d32e394f95718d47328cd176c
-  data.tar.gz: 19a7a97b270b1a9d27d8fbe005cfdea1c09df6cf681bc2014670388dd67c83a3
+  metadata.gz: bcd3d338d691a30b884a0b016c1ccd0b9d056bf8c7aef2bf633f6f7fd7e44110
+  data.tar.gz: 2ad11507830d6c4b90f54bca2c1f37ea4b38cd669711d8a322ad6dac2e1770d5
 SHA512:
-  metadata.gz: 51ec09d8d57e235c433945db44408cc7c388f5456aa313c32b315d4f0012b03cc2a367988001dc684e2f72c7d1a9dfa834de47720326839e371feee461fc3cdc
-  data.tar.gz: 3f26e151f0e6fa13640ada893f562649c07652b32c3e1202fbec2156c5df5ee3779b635da0801aad6d12a76e60db5940ee1295e9a1a584b1f862902b5a712292
+  metadata.gz: 8d8262d7ec1091cd1517cc1e2ecd6b647e83a11b4440ea497c46b6aabeea4ab49d1bb8efaa4f60097527e508946eb91ae15b445b992e38bcd2f2eb8b43493b8b
+  data.tar.gz: 45c53a21fe782533fc4fc94e5c87efb97a15283a0fef8b61d58ddd20b7ba65e38d3656490250ea3c4edf3f9849e23e107b30e1a649099930025cab0a69009231

data/README.md

@@ -10,16 +10,51 @@ This is a sample API to demonstrate an OpenAPI spec with multiple endpoints and
 Install the gem from the command line:
 
 ```bash
-gem install wesley-key-sdk -v 1.1.2
+gem install wesley-key-sdk -v 2.0.0
 ```
 
 Or add the gem to your Gemfile and run `bundle`:
 
 ```ruby
-gem 'wesley-key-sdk', '1.1.2'
+gem 'wesley-key-sdk', '2.0.0'
 ```
 
-For additional gem details, see the [RubyGems page for the wesley-key-sdk gem](https://rubygems.org/gems/wesley-key-sdk/versions/1.1.2).
+For additional gem details, see the [RubyGems page for the wesley-key-sdk gem](https://rubygems.org/gems/wesley-key-sdk/versions/2.0.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 '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
 
@@ -31,7 +66,7 @@ rake
 
 ## Initialize the API Client
 
-**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.2/doc/client.md)
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/2.0.0/doc/client.md)
 
 The following parameters are configurable for the API Client:
 
@@ -48,10 +83,12 @@ 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/1.1.2/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/2.0.0/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
@@ -62,23 +99,36 @@ client = Client.new(
 )
 ```
 
+### Environment-Based Client Initialization
+
+```ruby
+require 'cypress_test_api'
+include CypressTestApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/2.0.0/doc/environment-based-client-initialization.md) section for details.
+
 ## List of APIs
 
-* [API](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.2/doc/controllers/api.md)
+* [API](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/2.0.0/doc/controllers/api.md)
 
 ## SDK Infrastructure
 
 ### Configuration
 
-* [ProxySettings](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.2/doc/proxy-settings.md)
+* [ProxySettings](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/2.0.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/2.0.0/doc/environment-based-client-initialization.md)
 
 ### HTTP
 
-* [HttpResponse](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.2/doc/http-response.md)
-* [HttpRequest](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.2/doc/http-request.md)
+* [HttpResponse](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/2.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/2.0.0/doc/http-request.md)
 
 ### Utilities
 
-* [ApiHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.2/doc/api-helper.md)
-* [DateTimeHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/1.1.2/doc/date-time-helper.md)
+* [ApiHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/2.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/ZahraN444/wesley-key-ruby-sdk/tree/2.0.0/doc/date-time-helper.md)
 

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'cypress_test_api'
+
+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'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/cypress_test_api/client.rb

@@ -9,6 +9,10 @@ module CypressTestApi
     include CoreLibrary
     attr_reader :config
 
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
     # Access to client controller.
     # @return [APIController] Returns the controller instance.
     def client
@@ -43,5 +47,12 @@ module CypressTestApi
                                                  .global_errors(BaseController::GLOBAL_ERRORS)
                                                  .user_agent(BaseController.user_agent)
     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/configuration.rb

@@ -9,6 +9,13 @@ module CypressTestApi
     ENVIRONMENT = [
       PRODUCTION = 'production'.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
+    end
   end
 
   # An enum for API servers.
@@ -16,6 +23,13 @@ module CypressTestApi
     SERVER = [
       DEFAULT = 'default'.freeze
     ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      default_value
+    end
   end
 
   # All configuration including auth info and base URI for the API access
@@ -99,5 +113,44 @@ module CypressTestApi
         ENVIRONMENTS[environment][server], parameters
       )
     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')
+      timeout = (ENV['TIMEOUT'] || 60).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+
+      Configuration.new(
+        environment: environment,
+        default_host: default_host,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        proxy_settings: proxy_settings
+      )
+    end
   end
 end

data/lib/cypress_test_api/http/proxy_settings.rb

@@ -9,5 +9,14 @@ module CypressTestApi
   # including optional basic authentication.
   #
   class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
   end
 end

data/lib/cypress_test_api/models/custom_enum.rb

@@ -22,5 +22,19 @@ module CypressTestApi
 
       CUSTOM_ENUM.include?(value)
     end
+
+    def self.from_value(value, default_value = VALUE1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'value1' then VALUE1
+      when 'value2' then VALUE2
+      when 'value3' then VALUE3
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/cypress_test_api/models/o_auth_scope_o_auth_acg_enum.rb

@@ -25,5 +25,20 @@ module CypressTestApi
 
       O_AUTH_SCOPE_O_AUTH_ACG_ENUM.include?(value)
     end
+
+    def self.from_value(value, default_value = ENUM_FILE_REQUESTSREAD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_file_requestsread' then ENUM_FILE_REQUESTSREAD
+      when 'zahra' then ZAHRA
+      when 'test1' then TEST1
+      when 'selection' then SELECTION
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/cypress_test_api/models/status11_enum.rb

@@ -22,5 +22,19 @@ module CypressTestApi
 
       STATUS11_ENUM.include?(value)
     end
+
+    def self.from_value(value, default_value = ENUMVALUE1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enumvalue1' then ENUMVALUE1
+      when 'enumvalue2' then ENUMVALUE2
+      when 'enumvalue3' then ENUMVALUE3
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/cypress_test_api/models/status1_enum.rb

@@ -22,5 +22,19 @@ module CypressTestApi
 
       STATUS1_ENUM.include?(value)
     end
+
+    def self.from_value(value, default_value = ENUMVALUE1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enumvalue1' then ENUMVALUE1
+      when 'enumvalue2' then ENUMVALUE2
+      when 'enumvalue3' then ENUMVALUE3
+      else
+        default_value
+      end
+    end
   end
 end

data/lib/cypress_test_api/models/status_enum.rb

@@ -22,5 +22,19 @@ module CypressTestApi
 
       STATUS_ENUM.include?(value)
     end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'inactive' then INACTIVE
+      when 'pending' then PENDING
+      else
+        default_value
+      end
+    end
   end
 end

data/test/controllers/controller_test_base.rb

@@ -16,14 +16,8 @@ class ControllerTestBase < Minitest::Test
   include CypressTestApi
   include CoreLibrary
 
-  # Create configuration and set any test parameters
-  def create_configuration
-    Configuration.new(http_callback: HttpResponseCatcher.new)
-  end
-
   # Initializes the base test controller
   def setup_class
-    _config = create_configuration
-    @client = Client.new(config: _config)
+    @client = Client.from_env(http_callback: HttpResponseCatcher.new)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wesley-key-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Kenyon Jacobs
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-29 00:00:00.000000000 Z
+date: 2025-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: apimatic_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.19
+        version: 0.3.20
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.19
+        version: 0.3.20
 - !ruby/object:Gem::Dependency
   name: apimatic_faraday_client_adapter
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- bin/console
 - lib/cypress_test_api.rb
 - lib/cypress_test_api/api_helper.rb
 - lib/cypress_test_api/client.rb