apimatic_calculator_test_ruby 1.0.0

data/lib/apimatic_calculator/configuration.rb

@@ -0,0 +1,115 @@
+# 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
+    # The attribute readers for properties.
+    attr_reader :http_client, :connection, :adapter, :timeout, :max_retries, :retry_interval,
+                :backoff_factor, :retry_statuses, :retry_methods, :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],
+                   environment: Environment::PRODUCTION)
+      # The Faraday connection object passed by the SDK user for making requests
+      @connection = connection
+
+      # The Faraday adapter object passed by the SDK user for performing http requests
+      @adapter = adapter
+
+      # The value to use for connection timeout
+      @timeout = timeout
+
+      # The number of times to retry an endpoint call if it fails
+      @max_retries = max_retries
+
+      # Pause in seconds between retries
+      @retry_interval = retry_interval
+
+      # The amount to multiply each successive retry's interval amount
+      # by in order to provide backoff
+      @backoff_factor = backoff_factor
+
+      # A list of HTTP statuses to retry
+      @retry_statuses = retry_statuses
+
+      # A list of HTTP methods to retry
+      @retry_methods = retry_methods
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The Http Client to use for making requests.
+      @http_client = create_http_client
+    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, 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
+      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, environment: environment)
+    end
+
+    def create_http_client
+      FaradayClient.new(timeout: timeout, max_retries: max_retries,
+                        retry_interval: retry_interval,
+                        backoff_factor: backoff_factor,
+                        retry_statuses: retry_statuses,
+                        retry_methods: retry_methods, connection: connection,
+                        adapter: adapter)
+    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] 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,59 @@
+# 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 initialize(config, http_call_back: nil)
+      @config = config
+      @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => get_user_agent
+      }
+    end
+
+    def validate_parameters(args)
+      args.each do |_name, value|
+        raise ArgumentError, "Required parameter #{_name} cannot be nil." if value.nil?
+      end
+    end
+
+    def validate_parameters_types(args)
+      args.each do |_name, type|
+        key, val = type.first
+        APIHelper.validate_types(key, val) unless key.nil?
+      end
+    end
+
+    def execute_request(request, binary: false)
+      @http_call_back&.on_before_request(request)
+
+      APIHelper.clean_hash(request.headers)
+      request.headers.merge!(@global_headers)
+
+      response = if binary
+                   config.http_client.execute_as_binary(request)
+                 else
+                   config.http_client.execute_as_string(request)
+                 end
+      @http_call_back&.on_after_response(response)
+
+      response
+    end
+
+    def validate_response(response)
+      raise APIException.new 'HTTP Response Not OK', response unless
+        response.status_code.between?(200, 208) # [200,208] = HTTP OK
+    end
+
+    def get_user_agent
+      user_agent = 'APIMATIC 3.0'
+      user_agent
+    end
+  end
+end

data/lib/apimatic_calculator/controllers/simple_calculator_controller.rb

@@ -0,0 +1,45 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # SimpleCalculatorController
+  class SimpleCalculatorController < BaseController
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # 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 = {})
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/{operation}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'operation' => { 'value' => options['operation'], 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'x' => options['x'],
+        'y' => options['y']
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url
+      )
+      _response = execute_request(_request)
+      validate_response(_response)
+
+      # Return appropriate response type.
+      _response.raw_body.to_f
+    end
+  end
+end

data/lib/apimatic_calculator/exceptions/api_exception.rb

@@ -0,0 +1,20 @@
+# 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 < StandardError
+    attr_reader :response, :response_code
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason)
+      @response = response
+      @response_code = response.status_code
+    end
+  end
+end

data/lib/apimatic_calculator/exceptions/validation_exception.rb

@@ -0,0 +1,18 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # Class for exceptions when there is a schema validation error.
+  class ValidationException < StandardError
+    attr_reader :reason
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    def initialize(value, template)
+      @reason = "The value #{value} provided doesn't validate against the schema #{template}"
+      super(reason)
+    end
+  end
+end

data/lib/apimatic_calculator/http/faraday_client.rb

@@ -0,0 +1,98 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'faraday/http_cache'
+require 'faraday/retry'
+require 'faraday/multipart'
+require 'faraday/follow_redirects'
+require 'faraday/gzip'
+require 'faraday/net_http_persistent'
+
+module ApimaticCalculator
+  # An implementation of HttpClient.
+  class FaradayClient < HttpClient
+    # The attribute readers for properties.
+    attr_reader :connection
+
+    # The constructor.
+    def initialize(timeout:, max_retries:, retry_interval:,
+                   backoff_factor:, retry_statuses:, retry_methods:,
+                   connection:, adapter:, cache: false, verify: true)
+      @connection = if connection.nil?
+                      create_connection(timeout: timeout, max_retries: max_retries,
+                                        retry_interval: retry_interval, backoff_factor: backoff_factor,
+                                        retry_statuses: retry_statuses, retry_methods: retry_methods,
+                                        adapter: adapter, cache: cache, verify: verify)
+                    else
+                      connection
+                    end
+    end
+
+    # Method to initialize connection.
+    def create_connection(timeout:, max_retries:, retry_interval:,
+                          backoff_factor:, retry_statuses:, retry_methods:,
+                          adapter:, cache: false, verify: true)
+      Faraday.new do |faraday|
+        faraday.use Faraday::HttpCache, serializer: Marshal if cache
+        faraday.use Faraday::FollowRedirects::Middleware
+        faraday.request :gzip
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.ssl[:ca_file] = Certifi.where
+        faraday.ssl[:verify] = verify
+        faraday.request :retry, max: max_retries, interval: retry_interval,
+                                backoff_factor: backoff_factor,
+                                retry_statuses: retry_statuses,
+                                methods: retry_methods,
+                                retry_if: proc { |env, _exc|
+                                            env.request.context['forced_retry'] ||= false
+                                          }
+        faraday.adapter adapter
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
+        faraday.options[:timeout] = timeout if timeout.positive?
+      end
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_string(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers.map { |k, v| [k.to_s, v.to_s] }
+        request.options.context ||= {}
+        request.options.context.merge!(http_request.context)
+        unless http_request.http_method == HttpMethodEnum::GET &&
+               http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
+      end
+      convert_response(response, http_request)
+    end
+
+    # Method overridden from HttpClient.
+    def execute_as_binary(http_request)
+      response = @connection.send(
+        http_request.http_method.downcase,
+        http_request.query_url
+      ) do |request|
+        request.headers = http_request.headers
+        request.options.context ||= {}
+        request.options.context.merge!(http_request.context)
+        unless http_request.http_method == HttpMethodEnum::GET &&
+               http_request.parameters.empty?
+          request.body = http_request.parameters
+        end
+      end
+      convert_response(response, http_request)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response, http_request)
+      HttpResponse.new(response.status, response.reason_phrase,
+                       response.headers, response.body, http_request)
+    end
+  end
+end

data/lib/apimatic_calculator/http/http_call_back.rb

@@ -0,0 +1,24 @@
+# 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
+    # A controller will call this method before making an HTTP Request.
+    # @param [HttpRequest] The HttpRequest object which the HttpClient
+    # will execute.
+    def on_before_request(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # A controller will call this method after making an HTTP Request.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def on_after_response(_http_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+  end
+end

data/lib/apimatic_calculator/http/http_client.rb

@@ -0,0 +1,123 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # An interface for the methods that an HTTP Client must implement.
+  #
+  # This class should not be instantiated but should be used as a base class
+  # for HTTP Client classes.
+  class HttpClient
+    # Execute an HttpRequest when the response is expected to be a string.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_string(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Execute an HttpRequest when the response is expected to be binary.
+    # @param [HttpRequest] The HttpRequest to be executed.
+    def execute_as_binary(_http_request)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Converts the HTTP Response from the client to an HttpResponse object.
+    # @param [Dynamic] The response object received from the client.
+    def convert_response(_response)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+
+    # Get a GET HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def get(query_url,
+            headers: {},
+            context: {})
+      HttpRequest.new(HttpMethodEnum::GET,
+                      query_url,
+                      headers: headers,
+                      context: context)
+    end
+
+    # Get a HEAD HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def head(query_url,
+             headers: {},
+             context: {})
+      HttpRequest.new(HttpMethodEnum::HEAD,
+                      query_url,
+                      headers: headers,
+                      context: context)
+    end
+
+    # Get a POST HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def post(query_url,
+             headers: {},
+             parameters: {},
+             context: {})
+      HttpRequest.new(HttpMethodEnum::POST,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters,
+                      context: context)
+    end
+
+    # Get a PUT HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def put(query_url,
+            headers: {},
+            parameters: {},
+            context: {})
+      HttpRequest.new(HttpMethodEnum::PUT,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters,
+                      context: context)
+    end
+
+    # Get a PATCH HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def patch(query_url,
+              headers: {},
+              parameters: {},
+              context: {})
+      HttpRequest.new(HttpMethodEnum::PATCH,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters,
+                      context: context)
+    end
+
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def delete(query_url,
+               headers: {},
+               parameters: nil,
+               context: {})
+      HttpRequest.new(HttpMethodEnum::DELETE,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters,
+                      context: context)
+    end
+  end
+end

data/lib/apimatic_calculator/http/http_method_enum.rb

@@ -0,0 +1,13 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum
+    HTTPMETHODENUM = [GET = 'GET'.freeze, POST = 'POST'.freeze,
+                      PUT = 'PUT'.freeze, PATCH = 'PATCH'.freeze,
+                      DELETE = 'DELETE'.freeze, HEAD = 'HEAD'.freeze].freeze
+  end
+end

data/lib/apimatic_calculator/http/http_request.rb

@@ -0,0 +1,54 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # Represents a single Http Request.
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password,
+                  :context
+
+    # The constructor.
+    # @param [HttpMethodEnum] The HTTP method.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
+    def initialize(http_method,
+                   query_url,
+                   headers: {},
+                   parameters: {},
+                   context: {})
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+      @context = context
+    end
+
+    # Add a header to the HttpRequest.
+    # @param [String] The name of the header.
+    # @param [String] The value of the header.
+    def add_header(name, value)
+      @headers[name] = value
+    end
+
+    # Add a parameter to the HttpRequest.
+    # @param [String] The name of the parameter.
+    # @param [String] The value of the parameter.
+    def add_parameter(name, value)
+      @parameters[name] = value
+    end
+
+    # Add a query parameter to the HttpRequest.
+    # @param [String] The name of the query parameter.
+    # @param [String] The value of the query parameter.
+    def add_query_parameter(name, value)
+      @query_url = APIHelper.append_url_with_query_parameters(@query_url,
+                                                              name => value)
+      @query_url = APIHelper.clean_url(@query_url)
+    end
+  end
+end

data/lib/apimatic_calculator/http/http_response.rb

@@ -0,0 +1,29 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # Http response received.
+  class HttpResponse
+    attr_reader :status_code, :reason_phrase, :headers, :raw_body, :request
+
+    # The constructor
+    # @param [Integer] The status code returned by the server.
+    # @param [String] The reason phrase returned by the server.
+    # @param [Hash] The headers sent by the server in the response.
+    # @param [String] The raw body of the response.
+    # @param [HttpRequest] The request that resulted in this response.
+    def initialize(status_code,
+                   reason_phrase,
+                   headers,
+                   raw_body,
+                   request)
+      @status_code = status_code
+      @reason_phrase = reason_phrase
+      @headers = headers
+      @raw_body = raw_body
+      @request = request
+    end
+  end
+end

data/lib/apimatic_calculator/models/base_model.rb

@@ -0,0 +1,58 @@
+# apimatic_calculator
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module ApimaticCalculator
+  # Base model.
+  class BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      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_#{name}")
+            if (value.instance_of? Array) || (value.instance_of? Hash)
+              params = [hash, key]
+              hash[key] = send("to_#{name}", *params)
+            else
+              hash[key] = send("to_#{name}")
+            end
+          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,23 @@
+# 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
+  end
+end