mockserver-client 1.0.8.pre → 5.3.0

data/docs/HttpRequest.md

@@ -0,0 +1,15 @@
+# MockServer::HttpRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | [**Body**](Body.md) |  | [optional] 
+**headers** | [**KeyToMultiValue**](KeyToMultiValue.md) |  | [optional] 
+**cookies** | [**KeyToValue**](KeyToValue.md) |  | [optional] 
+**query_string_parameters** | [**KeyToMultiValue**](KeyToMultiValue.md) |  | [optional] 
+**path** | **String** |  | [optional] 
+**method** | **String** |  | [optional] 
+**secure** | **BOOLEAN** |  | [optional] 
+**keep_alive** | **BOOLEAN** |  | [optional] 
+
+

data/docs/HttpResponse.md

@@ -0,0 +1,14 @@
+# MockServer::HttpResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | [**BodyWithContentType**](BodyWithContentType.md) |  | [optional] 
+**delay** | [**Delay**](Delay.md) |  | [optional] 
+**cookies** | [**KeyToValue**](KeyToValue.md) |  | [optional] 
+**connection_options** | [**ConnectionOptions**](ConnectionOptions.md) |  | [optional] 
+**headers** | [**KeyToMultiValue**](KeyToMultiValue.md) |  | [optional] 
+**status_code** | **Integer** |  | [optional] 
+**reason_phrase** | **String** |  | [optional] 
+
+

data/docs/HttpTemplate.md

@@ -0,0 +1,10 @@
+# MockServer::HttpTemplate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**template_type** | **String** |  | [optional] 
+**template** | **String** |  | [optional] 
+**delay** | [**Delay**](Delay.md) |  | [optional] 
+
+

data/docs/KeyToMultiValue.md

@@ -0,0 +1,7 @@
+# MockServer::KeyToMultiValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/KeyToValue.md

@@ -0,0 +1,7 @@
+# MockServer::KeyToValue
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/Ports.md

@@ -0,0 +1,8 @@
+# MockServer::Ports
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ports** | **Array<Float>** |  | [optional] 
+
+

data/docs/TimeToLive.md

@@ -0,0 +1,10 @@
+# MockServer::TimeToLive
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time_unit** | **String** |  | [optional] 
+**time_to_live** | **Integer** |  | [optional] 
+**unlimited** | **BOOLEAN** |  | [optional] 
+
+

data/docs/Times.md

@@ -0,0 +1,9 @@
+# MockServer::Times
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**remaining_times** | **Integer** |  | [optional] 
+**unlimited** | **BOOLEAN** |  | [optional] 
+
+

data/docs/Verification.md

@@ -0,0 +1,9 @@
+# MockServer::Verification
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**http_request** | [**HttpRequest**](HttpRequest.md) |  | [optional] 
+**times** | [**VerificationTimes**](VerificationTimes.md) |  | [optional] 
+
+

data/docs/VerificationSequence.md

@@ -0,0 +1,8 @@
+# MockServer::VerificationSequence
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**http_requests** | [**Array<HttpRequest>**](HttpRequest.md) |  | [optional] 
+
+

data/docs/VerificationTimes.md

@@ -0,0 +1,9 @@
+# MockServer::VerificationTimes
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] 
+**exact** | **BOOLEAN** |  | [optional] 
+
+

data/docs/VerifyApi.md

@@ -0,0 +1,94 @@
+# MockServer::VerifyApi
+
+All URIs are relative to *http://localhost:1080*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**verify_put**](VerifyApi.md#verify_put) | **PUT** /verify | verify a request has been received a specific number of times
+[**verify_sequence_put**](VerifyApi.md#verify_sequence_put) | **PUT** /verifySequence | verify a sequence of request has been received in the specific order
+
+
+# **verify_put**
+> verify_put(verification)
+
+verify a request has been received a specific number of times
+
+### Example
+```ruby
+# load the gem
+require 'mockserver-client'
+
+api_instance = MockServer::VerifyApi.new
+verification = MockServer::Verification.new # Verification | request matcher and the number of times to match
+
+begin
+  #verify a request has been received a specific number of times
+  api_instance.verify_put(verification)
+rescue MockServer::ApiError => e
+  puts "Exception when calling VerifyApi->verify_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **verification** | [**Verification**](Verification.md)| request matcher and the number of times to match | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/plain
+
+
+
+# **verify_sequence_put**
+> verify_sequence_put(verification_sequence)
+
+verify a sequence of request has been received in the specific order
+
+### Example
+```ruby
+# load the gem
+require 'mockserver-client'
+
+api_instance = MockServer::VerifyApi.new
+verification_sequence = MockServer::VerificationSequence.new # VerificationSequence | the sequence of requests matchers
+
+begin
+  #verify a sequence of request has been received in the specific order
+  api_instance.verify_sequence_put(verification_sequence)
+rescue MockServer::ApiError => e
+  puts "Exception when calling VerifyApi->verify_sequence_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **verification_sequence** | [**VerificationSequence**](VerificationSequence.md)| the sequence of requests matchers | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: text/plain
+
+
+

data/lib/mockserver-client.rb

@@ -1,17 +1,64 @@
-# encoding: UTF-8
-require_relative './mockserver/version'
-require_relative './mockserver/mock_server_client'
-require_relative './mockserver/proxy_client'
-
-# Setup serialization correctly with multi_json
-require 'json/pure'
-
-# To fix serialization bugs. See: http://prettystatemachine.blogspot.com/2010/09/typeerrors-in-tojson-make-me-briefly.html
-class Fixnum
-  def to_json(_)
-    to_s
+=begin
+#Mock Server API
+
+#MockServer enables easy mocking of any system you integrate with via HTTP or HTTPS with clients written in Java, JavaScript and Ruby and a simple REST API (as shown below).  MockServer Proxy is a proxy that introspects all proxied traffic including encrypted SSL traffic and supports Port Forwarding, Web Proxying (i.e. HTTP proxy), HTTPS Tunneling Proxying (using HTTP CONNECT) and SOCKS Proxying (i.e. dynamic port forwarding).  Both MockServer and the MockServer Proxy record all received requests so that it is possible to verify exactly what requests have been sent by the system under test.
+
+OpenAPI spec version: 5.3.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.1
+
+=end
+
+# Common files
+require 'mockserver-client/api_client'
+require 'mockserver-client/api_error'
+require 'mockserver-client/version'
+require 'mockserver-client/configuration'
+
+# Models
+require 'mockserver-client/models/body'
+require 'mockserver-client/models/body_with_content_type'
+require 'mockserver-client/models/connection_options'
+require 'mockserver-client/models/delay'
+require 'mockserver-client/models/expectation'
+require 'mockserver-client/models/expectations'
+require 'mockserver-client/models/http_class_callback'
+require 'mockserver-client/models/http_error'
+require 'mockserver-client/models/http_forward'
+require 'mockserver-client/models/http_object_callback'
+require 'mockserver-client/models/http_override_forwarded_request'
+require 'mockserver-client/models/http_request'
+require 'mockserver-client/models/http_response'
+require 'mockserver-client/models/http_template'
+require 'mockserver-client/models/key_to_multi_value'
+require 'mockserver-client/models/key_to_value'
+require 'mockserver-client/models/ports'
+require 'mockserver-client/models/time_to_live'
+require 'mockserver-client/models/times'
+require 'mockserver-client/models/verification'
+require 'mockserver-client/models/verification_sequence'
+require 'mockserver-client/models/verification_times'
+
+# APIs
+require 'mockserver-client/api/control_api'
+require 'mockserver-client/api/expectation_api'
+require 'mockserver-client/api/verify_api'
+
+module MockServer
+  class << self
+    # Customize default settings for the SDK using block.
+    #   MockServer.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
   end
 end
-
-require 'multi_json'
-MultiJson.use(:json_pure)

data/lib/mockserver-client/api/control_api.rb

@@ -0,0 +1,316 @@
+=begin
+#Mock Server API
+
+#MockServer enables easy mocking of any system you integrate with via HTTP or HTTPS with clients written in Java, JavaScript and Ruby and a simple REST API (as shown below).  MockServer Proxy is a proxy that introspects all proxied traffic including encrypted SSL traffic and supports Port Forwarding, Web Proxying (i.e. HTTP proxy), HTTPS Tunneling Proxying (using HTTP CONNECT) and SOCKS Proxying (i.e. dynamic port forwarding).  Both MockServer and the MockServer Proxy record all received requests so that it is possible to verify exactly what requests have been sent by the system under test.
+
+OpenAPI spec version: 5.3.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 3.3.1
+
+=end
+
+require 'uri'
+
+module MockServer
+  class ControlApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # bind additional listening ports
+    # only supported on Netty version
+    # @param ports list of ports to bind to, where 0 indicates dynamically bind to any available port
+    # @param [Hash] opts the optional parameters
+    # @return [Ports]
+    def bind_put(ports, opts = {})
+      data, _status_code, _headers = bind_put_with_http_info(ports, opts)
+      data
+    end
+
+    # bind additional listening ports
+    # only supported on Netty version
+    # @param ports list of ports to bind to, where 0 indicates dynamically bind to any available port
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ports, Fixnum, Hash)>] Ports data, response status code and response headers
+    def bind_put_with_http_info(ports, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ControlApi.bind_put ...'
+      end
+      # verify the required parameter 'ports' is set
+      if @api_client.config.client_side_validation && ports.nil?
+        fail ArgumentError, "Missing the required parameter 'ports' when calling ControlApi.bind_put"
+      end
+      # resource path
+      local_var_path = '/bind'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(ports)
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Ports')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ControlApi#bind_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # clears expectations and recorded requests that match the request matcher
+    # @param [Hash] opts the optional parameters
+    # @option opts [HttpRequest] :http_request request used to match expectations and recored requests to clear
+    # @return [nil]
+    def clear_put(opts = {})
+      clear_put_with_http_info(opts)
+      nil
+    end
+
+    # clears expectations and recorded requests that match the request matcher
+    # @param [Hash] opts the optional parameters
+    # @option opts [HttpRequest] :http_request request used to match expectations and recored requests to clear
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def clear_put_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ControlApi.clear_put ...'
+      end
+      # resource path
+      local_var_path = '/clear'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'http_request'])
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ControlApi#clear_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # clears all expectations and recorded requests
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def reset_put(opts = {})
+      reset_put_with_http_info(opts)
+      nil
+    end
+
+    # clears all expectations and recorded requests
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def reset_put_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ControlApi.reset_put ...'
+      end
+      # resource path
+      local_var_path = '/reset'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ControlApi#reset_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # retrieve recorded requests, active expectations, recorded expectations or log messages
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :format changes response format, default if not specificed is \&quot;json\&quot;, supported values are \&quot;java\&quot;, \&quot;json\&quot;
+    # @option opts [String] :type specifies the type of object that is retrieve, default if not specified is \&quot;requests\&quot;, supported values are \&quot;logs\&quot;, \&quot;requests\&quot;, \&quot;recorded_expectations\&quot;, \&quot;active_expectations\&quot;
+    # @option opts [HttpRequest] :http_request request used to match which recorded requests, expectations or log messages to return, an empty body matches all requests, expectations or log messages
+    # @return [Object]
+    def retrieve_put(opts = {})
+      data, _status_code, _headers = retrieve_put_with_http_info(opts)
+      data
+    end
+
+    # retrieve recorded requests, active expectations, recorded expectations or log messages
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :format changes response format, default if not specificed is \&quot;json\&quot;, supported values are \&quot;java\&quot;, \&quot;json\&quot;
+    # @option opts [String] :type specifies the type of object that is retrieve, default if not specified is \&quot;requests\&quot;, supported values are \&quot;logs\&quot;, \&quot;requests\&quot;, \&quot;recorded_expectations\&quot;, \&quot;active_expectations\&quot;
+    # @option opts [HttpRequest] :http_request request used to match which recorded requests, expectations or log messages to return, an empty body matches all requests, expectations or log messages
+    # @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
+    def retrieve_put_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ControlApi.retrieve_put ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'format'] && !['java', 'json'].include?(opts[:'format'])
+        fail ArgumentError, 'invalid value for "format", must be one of java, json'
+      end
+      if @api_client.config.client_side_validation && opts[:'type'] && !['logs', 'requests', 'recorded_expectations', 'active_expectations'].include?(opts[:'type'])
+        fail ArgumentError, 'invalid value for "type", must be one of logs, requests, recorded_expectations, active_expectations'
+      end
+      # resource path
+      local_var_path = '/retrieve'
+
+      # query parameters
+      query_params = {}
+      query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/java', 'text/plain'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(opts[:'http_request'])
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Object')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ControlApi#retrieve_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # return listening ports
+    # @param [Hash] opts the optional parameters
+    # @return [Ports]
+    def status_put(opts = {})
+      data, _status_code, _headers = status_put_with_http_info(opts)
+      data
+    end
+
+    # return listening ports
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Ports, Fixnum, Hash)>] Ports data, response status code and response headers
+    def status_put_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ControlApi.status_put ...'
+      end
+      # resource path
+      local_var_path = '/status'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Ports')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ControlApi#status_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # stop running process
+    # only supported on Netty version
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def stop_put(opts = {})
+      stop_put_with_http_info(opts)
+      nil
+    end
+
+    # stop running process
+    # only supported on Netty version
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def stop_put_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ControlApi.stop_put ...'
+      end
+      # resource path
+      local_var_path = '/stop'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = []
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ControlApi#stop_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+  end
+end