saeed-calc-apimatic 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2934824f5253b2a863330d5f6dc0314d89742153785e7c9283e52a366923047
-  data.tar.gz: 22e2b6f53056ed1f24483c5525fc915fd94f7465d460ff10e8da2bc521395cf1
+  metadata.gz: 828f732de096b07de47ca02756b1b5b208e8ffb42c925d1ef1b0e194e86ff308
+  data.tar.gz: 789c880a98932fbe93e65e1fc661707640537b7749ef1818bd9fd6d81c601024
 SHA512:
-  metadata.gz: 4503d22deb42fbc3963735c49457577ea1d72cf3bc7ef48275945deaa281307f4da0650229fdee2217cdcedc054433c9fee1b5d21a6de1fa9a315c8682bb4c56
-  data.tar.gz: 9833aed4afbaba326e6339ed370b5038033e8fba31cccecee88e92e1d9188440feb26e91f487589e86967bc9abae399017cd5f2fb7036069649c2c31fd89001c
+  metadata.gz: '087711b29146bd432596054d5c0816987e90d21fc787400f0e2cbfd291b9cc531aad0a81e59fcd8c1a2f46caafcbd559052796c9a672df389e359df012e784f3'
+  data.tar.gz: abdafbad02270efca73ffe5c8ff14fea1488ee990f5d38e020ff2ae650cbd96800e1cde740c557903b85f3c5497e116b689083c1daca7d6ba65b84636a20a88d

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2024 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,68 @@
+
+# Getting Started with APIMATIC Calculator
+
+## Introduction
+
+Simple calculator API hosted on APIMATIC
+
+## Install the Package
+
+Install the gem from the command line:
+
+```ruby
+gem install saeed-calc-apimatic -v 0.1.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'saeed-calc-apimatic', '0.1.1'
+```
+
+For additional gem details, see the [RubyGems page for the saeed-calc-apimatic gem](https://rubygems.org/gems/saeed-calc-apimatic/versions/0.1.1).
+
+## 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.](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: 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. |
+
+The API client can be initialized as follows:
+
+```ruby
+client = ApimaticCalculator::Client.new(
+  environment: Environment::PRODUCTION
+)
+```
+
+## List of APIs
+
+* [Simple Calculator](doc/controllers/simple-calculator.md)
+
+## Classes Documentation
+
+* [Utility Classes](doc/utility-classes.md)
+* [HttpResponse](doc/http-response.md)
+* [HttpRequest](doc/http-request.md)
+

data/lib/apimatic_calculator/api_helper.rb

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

data/lib/apimatic_calculator/client.rb

@@ -0,0 +1,43 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  #  apimatic_calculator client class.
+  class Client
+    attr_reader :config
+
+    # Access to simple_calculator controller.
+    # @return [SimpleCalculatorController] Returns the controller instance.
+    def simple_calculator
+      @simple_calculator ||= SimpleCalculatorController.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,
+      environment: Environment::PRODUCTION, 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,
+                                    environment: environment)
+                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/apimatic_calculator/configuration.rb

@@ -0,0 +1,92 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION: This environment connect to the LIVE calculator API
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      CALCULATOR = 'Calculator'.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
+
+    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,
+      environment: Environment::PRODUCTION
+    )
+
+      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
+
+      # Current API environment
+      @environment = String(environment)
+
+      # 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,
+                   environment: 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
+      environment ||= self.environment
+
+      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, environment: environment)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::CALCULATOR => 'https://examples.apimatic.io/apps/calculator'
+      }
+    }.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::CALCULATOR)
+      ENVIRONMENTS[environment][server].clone
+    end
+  end
+end

data/lib/apimatic_calculator/controllers/base_controller.rb

@@ -0,0 +1,65 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # BaseController.
+  class BaseController
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'APIMATIC 3.0'
+    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 builder for the Api Call instance.
+    # @return [ApiCall] The instance of ApiCall.
+    def new_api_call_builder
+      @api_call.new_builder
+    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/apimatic_calculator/controllers/simple_calculator_controller.rb

@@ -0,0 +1,31 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # SimpleCalculatorController
+  class SimpleCalculatorController < BaseController
+    # Calculates the expression using the specified operation.
+    # @param [OperationTypeEnum] operation Required parameter: The operator to
+    # apply on the variables
+    # @param [Float] x Required parameter: The LHS value
+    # @param [Float] y Required parameter: The RHS value
+    # @return [Float] response from the API call
+    def get_calculate(options = {})
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/{operation}',
+                                     Server::CALCULATOR)
+                   .template_param(new_parameter(options['operation'], key: 'operation')
+                                    .should_encode(true))
+                   .query_param(new_parameter(options['x'], key: 'x'))
+                   .query_param(new_parameter(options['y'], key: 'y')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:deserialize_primitive_types))
+                   .deserialize_into(proc do |response| response.to_f end)
+                   .is_primitive_response(true))
+        .execute
+    end
+  end
+end

data/lib/apimatic_calculator/exceptions/api_exception.rb

@@ -0,0 +1,10 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+  end
+end

data/lib/apimatic_calculator/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/apimatic_calculator/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/apimatic_calculator/http/http_request.rb

@@ -0,0 +1,10 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/apimatic_calculator/http/http_response.rb

@@ -0,0 +1,10 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/apimatic_calculator/models/base_model.rb

@@ -0,0 +1,62 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # Base model.
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        key = self.class.names.key?(name) ? self.class.names[name] : name
+        optional_fields = self.class.optionals
+        nullable_fields = self.class.nullables
+        if value.nil?
+          next unless nullable_fields.include?(name)
+
+          if !optional_fields.include?(name) && !nullable_fields.include?(name)
+            raise ArgumentError,
+                  "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+          end
+        end
+
+        hash[key] = nil
+        unless value.nil?
+          if respond_to?("to_custom_#{name}")
+            if (value.instance_of? Array) || (value.instance_of? Hash)
+              params = [hash, key]
+              hash[key] = send("to_custom_#{name}", *params)
+            else
+              hash[key] = send("to_custom_#{name}")
+            end
+          elsif respond_to?("to_union_type_#{name}")
+            hash[key] = send("to_union_type_#{name}")
+          elsif value.instance_of? Array
+            hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+          elsif value.instance_of? Hash
+            hash[key] = {}
+            value.each do |k, v|
+              hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+            end
+          else
+            hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+          end
+        end
+      end
+      hash
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+end

data/lib/apimatic_calculator/models/operation_type_enum.rb

@@ -0,0 +1,29 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # Possible operators are sum, subtract, multiply, divide
+  class OperationTypeEnum
+    OPERATION_TYPE_ENUM = [
+      # Represents the sum operator
+      SUM = 'SUM'.freeze,
+
+      # Represents the subtract operator
+      SUBTRACT = 'SUBTRACT'.freeze,
+
+      # Represents the multiply operator
+      MULTIPLY = 'MULTIPLY'.freeze,
+
+      # Represents the divide operator
+      DIVIDE = 'DIVIDE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OPERATION_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/apimatic_calculator/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module ApimaticCalculator
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/apimatic_calculator/utilities/file_wrapper.rb

@@ -0,0 +1,16 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+  end
+end

data/lib/apimatic_calculator.rb

@@ -0,0 +1,39 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+require 'json'
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+# rubocop:disable Style/MixinUsage
+include CoreLibrary
+# rubocop:enable Style/MixinUsage
+
+require_relative 'apimatic_calculator/api_helper'
+require_relative 'apimatic_calculator/client'
+
+# Utilities
+require_relative 'apimatic_calculator/utilities/file_wrapper'
+require_relative 'apimatic_calculator/utilities/date_time_helper'
+
+# Http
+require_relative 'apimatic_calculator/http/http_call_back'
+require_relative 'apimatic_calculator/http/http_method_enum'
+require_relative 'apimatic_calculator/http/http_request'
+require_relative 'apimatic_calculator/http/http_response'
+
+# Models
+require_relative 'apimatic_calculator/models/base_model'
+require_relative 'apimatic_calculator/models/operation_type_enum'
+
+# Exceptions
+require_relative 'apimatic_calculator/exceptions/api_exception'
+
+require_relative 'apimatic_calculator/configuration'
+
+# Controllers
+require_relative 'apimatic_calculator/controllers/base_controller'
+require_relative 'apimatic_calculator/controllers/simple_calculator_controller'

data/test/controllers/controller_test_base.rb

@@ -0,0 +1,28 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'json'
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/pride'
+require 'minitest/proveit'
+require 'apimatic_calculator'
+require_relative '../http_response_catcher'
+
+class ControllerTestBase < Minitest::Test
+  parallelize_me!
+  include ApimaticCalculator
+
+  # 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)
+  end
+end

data/test/controllers/test_simple_calculator_controller.rb

@@ -0,0 +1,35 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'controller_test_base'
+
+class SimpleCalculatorControllerTests < ControllerTestBase
+  # Called only once for the class before any test has executed
+  def setup
+    setup_class
+    @controller = @client.simple_calculator
+    @response_catcher = @controller.http_call_back
+  end
+
+  # Check if multiplication works
+  def test_multiply
+    # Parameters for the API call
+    options = {}
+    options['operation'] = 'MULTIPLY'
+    options['x'] = 4
+    options['y'] = 5
+
+    # Perform the API call through the SDK function
+    result = @controller.get_calculate(options)
+
+    # Test response code
+    assert_equal(200, @response_catcher.response.status_code)
+
+    # Test whether the captured response is as we expected
+    refute_nil(result)
+    assert_equal('20', @response_catcher.response.raw_body)
+  end
+
+end

data/test/http_response_catcher.rb

@@ -0,0 +1,19 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+class HttpResponseCatcher < ApimaticCalculator::HttpCallBack
+  attr_accessor :response
+
+  def on_before_request(request)
+  end
+
+  # Catching the response
+  def on_after_response(response)
+    @response = response
+  end
+end
+
+
+