testerhjnew 1.1.0

data/lib/tester/controllers/template_params_controller.rb

@@ -0,0 +1,93 @@
+# This file was automatically generated for Stamplay by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Tester
+  # TemplateParamsController
+  class TemplateParamsController < BaseController
+    @instance = TemplateParamsController.new
+
+    class << self
+      attr_accessor :instance
+    end
+
+    def instance
+      self.class.instance
+    end
+
+    # TODO: type endpoint description here
+    # @param [List of String] strings Required parameter: Example:
+    # @return EchoResponse response from the API call
+    def send_string_array(strings)
+      # Validate required parameters.
+      validate_parameters(
+        'strings' => strings
+      )
+      # Prepare query url.
+      _query_builder = Configuration.get_base_uri
+      _query_builder << '/{strings}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'strings' => strings
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      _context = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      return nil if _context.response.status_code == 404
+      validate_response(_context)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      EchoResponse.from_hash(decoded)
+    end
+
+    # TODO: type endpoint description here
+    # @param [List of Integer] integers Required parameter: Example:
+    # @return EchoResponse response from the API call
+    def send_integer_array(integers)
+      # Validate required parameters.
+      validate_parameters(
+        'integers' => integers
+      )
+      # Prepare query url.
+      _query_builder = Configuration.get_base_uri
+      _query_builder << '/{integers}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'integers' => integers
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = @http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      _context = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      return nil if _context.response.status_code == 404
+      validate_response(_context)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_context.response.raw_body)
+      EchoResponse.from_hash(decoded)
+    end
+  end
+end

data/lib/tester/exceptions/api_exception.rb

@@ -0,0 +1,18 @@
+# This file was automatically generated for Stamplay by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Tester
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < StandardError
+    attr_reader :context, :response_code
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason)
+      @context = context
+      @response_code = context.response.status_code
+    end
+  end
+end

data/lib/tester/exceptions/global_test_exception.rb

@@ -0,0 +1,32 @@
+# This file was automatically generated for Stamplay by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Tester
+  # To test specific global exceptions.
+  class GlobalTestException < APIException
+    # Represents the server's exception message
+    # @return [String]
+    attr_accessor :server_message
+
+    # Represents the server's error code
+    # @return [Integer]
+    attr_accessor :server_code
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason, context)
+      hash = APIHelper.json_deserialize(@context.response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @server_message = hash['ServerMessage']
+      @server_code = hash['ServerCode']
+    end
+  end
+end

data/lib/tester/exceptions/local_test_exception.rb

@@ -0,0 +1,30 @@
+# This file was automatically generated for Stamplay by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require_relative 'global_test_exception'
+
+module Tester
+  # To test specific local exceptions.
+  class LocalTestException < GlobalTestException
+    # Represents the specific endpoint info
+    # @return [String]
+    attr_accessor :secret_message_for_endpoint
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason, context)
+      hash = APIHelper.json_deserialize(@context.response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      super(hash)
+      @secret_message_for_endpoint = hash['SecretMessageForEndpoint']
+    end
+  end
+end

data/lib/tester/exceptions/nested_model_exception.rb

@@ -0,0 +1,37 @@
+# This file was automatically generated for Stamplay by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Tester
+  # NestedModelException class.
+  class NestedModelException < APIException
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :server_message
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :server_code
+
+    # TODO: Write general description for this method
+    # @return [Validate]
+    attr_accessor :model
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpContext] The HttpContext of the API call.
+    def initialize(reason, context)
+      super(reason, context)
+      hash = APIHelper.json_deserialize(@context.response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @server_message = hash['ServerMessage']
+      @server_code = hash['ServerCode']
+      @model = Validate.from_hash(hash['model']) if hash['model']
+    end
+  end
+end

data/lib/tester/http/faraday_client.rb

@@ -0,0 +1,55 @@
+# This file was automatically generated for Stamplay by APIMATIC v2.0
+# ( https://apimatic.io ).
+require 'faraday/http_cache'
+
+module Tester
+  # An implementation of HttpClient.
+  class FaradayClient < HttpClient
+    # The constructor.
+    def initialize(timeout: nil, cache: false,
+                   max_retries: nil, retry_interval: nil)
+      @connection = Faraday.new do |faraday|
+        faraday.use Faraday::HttpCache, serializer: Marshal if cache
+        faraday.request :multipart
+        faraday.request :url_encoded
+        faraday.ssl[:ca_file] = Certifi.where
+        faraday.adapter Faraday.default_adapter
+        faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
+        faraday.options[:open_timeout] = timeout if timeout
+        faraday.request :retry, max: max_retries, interval: if max_retries &&
+                                                               retry_interval
+                                                              retry_interval
+                                                            end
+      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
+        request.body = http_request.parameters
+      end
+      convert_response(response)
+    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.body = http_request.parameters
+      end
+      convert_response(response)
+    end
+
+    # Method overridden from HttpClient.
+    def convert_response(response)
+      HttpResponse.new(response.status, response.headers, response.body)
+    end
+  end
+end

data/lib/tester/http/http_call_back.rb

@@ -0,0 +1,22 @@
+# This file was automatically generated for Stamplay by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Tester
+  # 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 [HttpContext] The HttpContext of the API call.
+    def on_after_response(_http_context)
+      raise NotImplementedError, 'This method needs
+        to be implemented in a child class.'
+    end
+  end
+end

data/lib/tester/http/http_client.rb

@@ -0,0 +1,92 @@
+# This file was automatically generated for Stamplay by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Tester
+  # 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.
+    def get(query_url,
+            headers: {})
+      HttpRequest.new(HttpMethodEnum::GET,
+                      query_url,
+                      headers: headers)
+    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.
+    def post(query_url,
+             headers: {},
+             parameters: {})
+      HttpRequest.new(HttpMethodEnum::POST,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    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.
+    def put(query_url,
+            headers: {},
+            parameters: {})
+      HttpRequest.new(HttpMethodEnum::PUT,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    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.
+    def patch(query_url,
+              headers: {},
+              parameters: {})
+      HttpRequest.new(HttpMethodEnum::PATCH,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+
+    # Get a DELETE HttpRequest object.
+    # @param [String] The URL to send the request to.
+    # @param [Hash, Optional] The headers for the HTTP Request.
+    def delete(query_url,
+               headers: {},
+               parameters: {})
+      HttpRequest.new(HttpMethodEnum::DELETE,
+                      query_url,
+                      headers: headers,
+                      parameters: parameters)
+    end
+  end
+end

data/lib/tester/http/http_context.rb

@@ -0,0 +1,18 @@
+# This file was automatically generated for Stamplay by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Tester
+  # Represents an Http call in context.
+  class HttpContext
+    attr_accessor :request, :response
+
+    # The constructor.
+    # @param [HttpRequest] An HttpRequest object representing the HTTP request.
+    # @param [HttpResponse] An HttpResponse object representing the HTTP
+    # response.
+    def initialize(request, response)
+      @request = request
+      @response = response
+    end
+  end
+end

data/lib/tester/http/http_method_enum.rb

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

data/lib/tester/http/http_request.rb

@@ -0,0 +1,48 @@
+# This file was automatically generated for Stamplay by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Tester
+  # Represents a single Http Request.
+  class HttpRequest
+    attr_accessor :http_method, :query_url, :headers,
+                  :parameters, :username, :password
+
+    # 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.
+    def initialize(http_method,
+                   query_url,
+                   headers: {},
+                   parameters: {})
+      @http_method = http_method
+      @query_url = query_url
+      @headers = headers
+      @parameters = parameters
+    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