mannual-calculator 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ff2e9c136f91bc89a757a7d55d684f30ed8f8860212239eba14e944c6bd4352
+  data.tar.gz: c1c751a6211186eb6bb7c689283cb8656bdd6a724a218477cd61a3780dd275ac
+SHA512:
+  metadata.gz: 0162ef85ff368773b236ab49dc7b7bb8bcb7f6b7b85824f6bad073404ea90d4e659e470828d225fc203190ebc392fc8d12e46372d20da2c7566ae0ccae34d301
+  data.tar.gz: 1ba0063bf2bf8594ab687ca654f08c8c48214bc7b3af2327243ee6f7df18f0e5035b3f75afa842d8d14ac222477fcdc03f1e64ed867ab482c8908dd7909dff35

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2025 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,105 @@
+
+# Getting Started with Manualpractice-SampleAPI
+
+## Introduction
+
+Sample API for manual practice.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install mannual-calculator -v 1.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'mannual-calculator', '1.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the mannual-calculator gem](https://rubygems.org/gems/mannual-calculator/versions/1.0.1).
+
+## 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` | 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]** |
+| 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. |
+| logging_configuration | [`LoggingConfiguration`](doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| authorization_code_auth_credentials | [`AuthorizationCodeAuthCredentials`](__base_path/auth/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |
+
+The API client can be initialized as follows:
+
+```ruby
+client = ManualpracticeSampleApi::Client.new(
+  authorization_code_auth_credentials: AuthorizationCodeAuthCredentials.new(
+    oauth_client_id: 'OAuthClientId',
+    oauth_client_secret: 'OAuthClientSecret',
+    oauth_redirect_uri: 'OAuthRedirectUri',
+    oauth_scopes: [
+      OauthScope::READ,
+      OauthScope::WRITE
+    ]
+  ),
+  environment: Environment::PRODUCTION,
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`acgauth2 (OAuth 2 Authorization Code Grant)`](__base_path/auth/oauth-2-authorization-code-grant.md)
+
+## List of APIs
+
+* [API](doc/controllers/api.md)
+* [Createsquarerootmath](doc/controllers/createsquarerootmath.md)
+* [Addnumbermath](doc/controllers/addnumbermath.md)
+* [Subtractnumbermath](doc/controllers/subtractnumbermath.md)
+* [Multipliednumbermath](doc/controllers/multipliednumbermath.md)
+* [Updatenumbermath](doc/controllers/updatenumbermath.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [AbstractLogger](doc/abstract-logger.md)
+* [LoggingConfiguration](doc/logging-configuration.md)
+* [RequestLoggingConfiguration](doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](doc/http-response.md)
+* [HttpRequest](doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](doc/api-response.md)
+* [ApiHelper](doc/api-helper.md)
+* [DateTimeHelper](doc/date-time-helper.md)
+

data/lib/manualpractice_sample_api/api_helper.rb

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

data/lib/manualpractice_sample_api/apis/addnumbermath_api.rb

@@ -0,0 +1,32 @@
+# manualpractice_sample_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ManualpracticeSampleApi
+  # AddnumbermathApi
+  class AddnumbermathApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [Float] num1 Required parameter: TODO: type description here
+    # @param [Float] num2 Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def add_numbers(num1,
+                    num2)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/addnumbers',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(num1, key: 'num1')
+                                 .is_required(true))
+                   .query_param(new_parameter(num2, key: 'num2')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('acgauth2')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AddnumbersResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/manualpractice_sample_api/apis/api.rb

@@ -0,0 +1,25 @@
+# manualpractice_sample_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ManualpracticeSampleApi
+  # Api
+  class Api < BaseApi
+    # TODO: type endpoint description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def test_endpoint
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/getcode',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('acgauth2')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetcodeResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/manualpractice_sample_api/apis/base_api.rb

@@ -0,0 +1,67 @@
+# manualpractice_sample_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ManualpracticeSampleApi
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/1.0.1 [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 = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end

data/lib/manualpractice_sample_api/apis/createsquarerootmath_api.rb

@@ -0,0 +1,28 @@
+# manualpractice_sample_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ManualpracticeSampleApi
+  # CreatesquarerootmathApi
+  class CreatesquarerootmathApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [Float] number Optional parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_square_root(number: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/createsquareroot',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter(number, key: 'number'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('acgauth2')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CreatesquarerootResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/manualpractice_sample_api/apis/multipliednumbermath_api.rb

@@ -0,0 +1,32 @@
+# manualpractice_sample_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ManualpracticeSampleApi
+  # MultipliednumbermathApi
+  class MultipliednumbermathApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [Float] num1 Required parameter: TODO: type description here
+    # @param [Float] num2 Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def multiply_numbers(num1,
+                         num2)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/multiplnumbers',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(num1, key: 'num1')
+                                  .is_required(true))
+                   .header_param(new_parameter(num2, key: 'num2')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('acgauth2')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MultiplnumbersResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/manualpractice_sample_api/apis/oauth_authorization_api.rb

@@ -0,0 +1,87 @@
+# manualpractice_sample_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ManualpracticeSampleApi
+  # OauthAuthorizationApi
+  class OauthAuthorizationApi < BaseApi
+    # Create a new OAuth 2 token.
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] code Required parameter: Authorization Code
+    # @param [String] redirect_uri Required parameter: Redirect Uri
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def request_token(authorization,
+                      code,
+                      redirect_uri,
+                      _field_parameters: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter('authorization_code', key: 'grant_type'))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .form_param(new_parameter(code, key: 'code')
+                                .is_required(true))
+                   .form_param(new_parameter(redirect_uri, key: 'redirect_uri')
+                                .is_required(true))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .additional_form_params(_field_parameters))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(OauthToken.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'OAuth 2 provider returned an error.',
+                                 OauthProviderException)
+                    .local_error('401',
+                                 'OAuth 2 provider says client authentication failed.',
+                                 OauthProviderException))
+        .execute
+    end
+
+    # Obtain a new access token using a refresh token
+    # @param [String] authorization Required parameter: Authorization header in
+    # Basic auth format
+    # @param [String] refresh_token Required parameter: Refresh token
+    # @param [String] scope Optional parameter: Requested scopes as a
+    # space-delimited list.
+    # @param [Hash] _field_parameters Additional optional form parameters are
+    # supported by this endpoint.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def refresh_token(authorization,
+                      refresh_token,
+                      scope: nil,
+                      _field_parameters: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/',
+                                     Server::DEFAULT)
+                   .form_param(new_parameter('refresh_token', key: 'grant_type'))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .form_param(new_parameter(refresh_token, key: 'refresh_token')
+                                .is_required(true))
+                   .form_param(new_parameter(scope, key: 'scope'))
+                   .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .additional_form_params(_field_parameters))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(OauthToken.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'OAuth 2 provider returned an error.',
+                                 OauthProviderException)
+                    .local_error('401',
+                                 'OAuth 2 provider says client authentication failed.',
+                                 OauthProviderException))
+        .execute
+    end
+  end
+end

data/lib/manualpractice_sample_api/apis/subtractnumbermath_api.rb

@@ -0,0 +1,34 @@
+# manualpractice_sample_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ManualpracticeSampleApi
+  # SubtractnumbermathApi
+  class SubtractnumbermathApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [Float] num1 Required parameter: TODO: type description here
+    # @param [Float] num2 Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def subtract_numbers(num1,
+                         num2)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/subtractnumbers/{num1}/{num2}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(num1, key: 'num1')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(num2, key: 'num2')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('acgauth2')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SubtractnumbersResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/manualpractice_sample_api/apis/updatenumbermath_api.rb

@@ -0,0 +1,31 @@
+# manualpractice_sample_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ManualpracticeSampleApi
+  # UpdatenumbermathApi
+  class UpdatenumbermathApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [Complexvalueset] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_number(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/updatenumber',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_s unless param.nil? end)
+                   .auth(Single.new('acgauth2')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UpdatenumberResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/manualpractice_sample_api/client.rb

@@ -0,0 +1,104 @@
+# manualpractice_sample_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ManualpracticeSampleApi
+  #  manualpractice_sample_api client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    # Returns the configured authentication acgauth2 instance.
+    def acgauth2
+      @auth_managers['acgauth2']
+    end
+
+    # Access to createsquarerootmath controller.
+    # @return [CreatesquarerootmathApi] Returns the controller instance.
+    def createsquarerootmath
+      @createsquarerootmath ||= CreatesquarerootmathApi.new @global_configuration
+    end
+
+    # Access to addnumbermath controller.
+    # @return [AddnumbermathApi] Returns the controller instance.
+    def addnumbermath
+      @addnumbermath ||= AddnumbermathApi.new @global_configuration
+    end
+
+    # Access to subtractnumbermath controller.
+    # @return [SubtractnumbermathApi] Returns the controller instance.
+    def subtractnumbermath
+      @subtractnumbermath ||= SubtractnumbermathApi.new @global_configuration
+    end
+
+    # Access to multipliednumbermath controller.
+    # @return [MultipliednumbermathApi] Returns the controller instance.
+    def multipliednumbermath
+      @multipliednumbermath ||= MultipliednumbermathApi.new @global_configuration
+    end
+
+    # Access to updatenumbermath controller.
+    # @return [UpdatenumbermathApi] Returns the controller instance.
+    def updatenumbermath
+      @updatenumbermath ||= UpdatenumbermathApi.new @global_configuration
+    end
+
+    # Access to client controller.
+    # @return [Api] Returns the controller instance.
+    def client
+      @client ||= Api.new @global_configuration
+    end
+
+    # Access to oauth_authorization controller.
+    # @return [OauthAuthorizationApi] Returns the controller instance.
+    def oauth_authorization
+      @oauth_authorization ||= OauthAuthorizationApi.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      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,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      authorization_code_auth_credentials: nil, 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,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
+                    authorization_code_auth_credentials: authorization_code_auth_credentials
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseApi.user_agent_parameters
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseApi::GLOBAL_ERRORS)
+                                                 .user_agent(BaseApi.user_agent,
+                                                             agent_parameters: user_agent_params)
+
+      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[acgauth2].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['acgauth2'] = Oauth2.new(
+        http_client_config.authorization_code_auth_credentials, global_config
+      )
+    end
+  end
+end