mockserver-client-2 5.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4fc5945edb1033b86201eb7434cac5800f2f1460bfa77182eb63dce07327d165
+  data.tar.gz: 3570a137ad228f6c31a13d8c6639c7aba6d8f48a305f291a461774f11ac89a41
+SHA512:
+  metadata.gz: 3f458ea524edb3bf6d1714d3584817211c75f57ef4064fca638e29f7fd8cae8ca39ab1c79bfa41ca2e5276196d36280bd2608cbcc1b0e27ee0eef8f491027505
+  data.tar.gz: b19729faeaceca8986ebc735313d83a5e445aa93dba8c9d33957f750ef49eee6a037749dea585dc1281e213331ecef40fbad690dd66b1c248f4c5203048e24fc

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+end

data/README.md

@@ -0,0 +1,120 @@
+# mockserver-client
+
+MockServer - the Ruby gem for the 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.
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 5.3.0
+- Package version: 5.3.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build mockserver-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./mockserver-client-5.3.0.gem
+```
+(for development, run `gem install --dev ./mockserver-client-5.3.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'mockserver-client', '~> 5.3.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'mockserver-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# Load the gem
+require 'mockserver-client'
+
+api_instance = MockServer::ControlApi.new
+ports = MockServer::Ports.new # Ports | list of ports to bind to, where 0 indicates dynamically bind to any available port
+
+begin
+  #bind additional listening ports
+  result = api_instance.bind_put(ports)
+  p result
+rescue MockServer::ApiError => e
+  puts "Exception when calling ControlApi->bind_put: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost:1080*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*MockServer::ControlApi* | [**bind_put**](docs/ControlApi.md#bind_put) | **PUT** /bind | bind additional listening ports
+*MockServer::ControlApi* | [**clear_put**](docs/ControlApi.md#clear_put) | **PUT** /clear | clears expectations and recorded requests that match the request matcher
+*MockServer::ControlApi* | [**reset_put**](docs/ControlApi.md#reset_put) | **PUT** /reset | clears all expectations and recorded requests
+*MockServer::ControlApi* | [**retrieve_put**](docs/ControlApi.md#retrieve_put) | **PUT** /retrieve | retrieve recorded requests, active expectations, recorded expectations or log messages
+*MockServer::ControlApi* | [**status_put**](docs/ControlApi.md#status_put) | **PUT** /status | return listening ports
+*MockServer::ControlApi* | [**stop_put**](docs/ControlApi.md#stop_put) | **PUT** /stop | stop running process
+*MockServer::ExpectationApi* | [**expectation_put**](docs/ExpectationApi.md#expectation_put) | **PUT** /expectation | create expectation
+*MockServer::VerifyApi* | [**verify_put**](docs/VerifyApi.md#verify_put) | **PUT** /verify | verify a request has been received a specific number of times
+*MockServer::VerifyApi* | [**verify_sequence_put**](docs/VerifyApi.md#verify_sequence_put) | **PUT** /verifySequence | verify a sequence of request has been received in the specific order
+
+
+## Documentation for Models
+
+ - [MockServer::Body](docs/Body.md)
+ - [MockServer::BodyWithContentType](docs/BodyWithContentType.md)
+ - [MockServer::ConnectionOptions](docs/ConnectionOptions.md)
+ - [MockServer::Delay](docs/Delay.md)
+ - [MockServer::Expectation](docs/Expectation.md)
+ - [MockServer::Expectations](docs/Expectations.md)
+ - [MockServer::HttpClassCallback](docs/HttpClassCallback.md)
+ - [MockServer::HttpError](docs/HttpError.md)
+ - [MockServer::HttpForward](docs/HttpForward.md)
+ - [MockServer::HttpObjectCallback](docs/HttpObjectCallback.md)
+ - [MockServer::HttpOverrideForwardedRequest](docs/HttpOverrideForwardedRequest.md)
+ - [MockServer::HttpRequest](docs/HttpRequest.md)
+ - [MockServer::HttpResponse](docs/HttpResponse.md)
+ - [MockServer::HttpTemplate](docs/HttpTemplate.md)
+ - [MockServer::KeyToMultiValue](docs/KeyToMultiValue.md)
+ - [MockServer::KeyToValue](docs/KeyToValue.md)
+ - [MockServer::Ports](docs/Ports.md)
+ - [MockServer::TimeToLive](docs/TimeToLive.md)
+ - [MockServer::Times](docs/Times.md)
+ - [MockServer::Verification](docs/Verification.md)
+ - [MockServer::VerificationSequence](docs/VerificationSequence.md)
+ - [MockServer::VerificationTimes](docs/VerificationTimes.md)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/code-generate.md

@@ -0,0 +1,3 @@
+brew install openapi-generator
+
+openapi-generator generate -i https://raw.githubusercontent.com/jamesdbloom/mockserver/master/mockserver-core/src/main/resources/org/mockserver/openapi/mock-server-openapi-embedded-model.yaml --config code-generation-config.json -g ruby -o .

data/code-generation-config.json

@@ -0,0 +1,10 @@
+{
+	"gemName": "mockserver-client",
+    "moduleName": "MockServer",
+    "gemVersion": "5.3.0",
+    "gemLicense": "Apache-2.0",
+    "gemRequiredRubyVersion": ">= 2.0",
+    "gemHomepage": "https://www.mock-server.com",
+    "gemAuthor": "James D Bloom",
+    "gemAuthorEmail": "jamesdbloom@gmail.com"
+}

data/docs/Body.md

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

data/docs/BodyWithContentType.md

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

data/docs/ConnectionOptions.md

@@ -0,0 +1,12 @@
+# MockServer::ConnectionOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**close_socket** | **BOOLEAN** |  | [optional] 
+**content_length_header_override** | **Integer** |  | [optional] 
+**suppress_content_length_header** | **BOOLEAN** |  | [optional] 
+**suppress_connection_header** | **BOOLEAN** |  | [optional] 
+**keep_alive_override** | **BOOLEAN** |  | [optional] 
+
+

data/docs/ControlApi.md

@@ -0,0 +1,269 @@
+# MockServer::ControlApi
+
+All URIs are relative to *http://localhost:1080*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**bind_put**](ControlApi.md#bind_put) | **PUT** /bind | bind additional listening ports
+[**clear_put**](ControlApi.md#clear_put) | **PUT** /clear | clears expectations and recorded requests that match the request matcher
+[**reset_put**](ControlApi.md#reset_put) | **PUT** /reset | clears all expectations and recorded requests
+[**retrieve_put**](ControlApi.md#retrieve_put) | **PUT** /retrieve | retrieve recorded requests, active expectations, recorded expectations or log messages
+[**status_put**](ControlApi.md#status_put) | **PUT** /status | return listening ports
+[**stop_put**](ControlApi.md#stop_put) | **PUT** /stop | stop running process
+
+
+# **bind_put**
+> Ports bind_put(ports)
+
+bind additional listening ports
+
+only supported on Netty version
+
+### Example
+```ruby
+# load the gem
+require 'mockserver-client'
+
+api_instance = MockServer::ControlApi.new
+ports = MockServer::Ports.new # Ports | list of ports to bind to, where 0 indicates dynamically bind to any available port
+
+begin
+  #bind additional listening ports
+  result = api_instance.bind_put(ports)
+  p result
+rescue MockServer::ApiError => e
+  puts "Exception when calling ControlApi->bind_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **ports** | [**Ports**](Ports.md)| list of ports to bind to, where 0 indicates dynamically bind to any available port | 
+
+### Return type
+
+[**Ports**](Ports.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **clear_put**
+> clear_put(opts)
+
+clears expectations and recorded requests that match the request matcher
+
+### Example
+```ruby
+# load the gem
+require 'mockserver-client'
+
+api_instance = MockServer::ControlApi.new
+opts = {
+  http_request: MockServer::HttpRequest.new # HttpRequest | request used to match expectations and recored requests to clear
+}
+
+begin
+  #clears expectations and recorded requests that match the request matcher
+  api_instance.clear_put(opts)
+rescue MockServer::ApiError => e
+  puts "Exception when calling ControlApi->clear_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **http_request** | [**HttpRequest**](HttpRequest.md)| request used to match expectations and recored requests to clear | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+
+# **reset_put**
+> reset_put
+
+clears all expectations and recorded requests
+
+### Example
+```ruby
+# load the gem
+require 'mockserver-client'
+
+api_instance = MockServer::ControlApi.new
+
+begin
+  #clears all expectations and recorded requests
+  api_instance.reset_put
+rescue MockServer::ApiError => e
+  puts "Exception when calling ControlApi->reset_put: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **retrieve_put**
+> Object retrieve_put(opts)
+
+retrieve recorded requests, active expectations, recorded expectations or log messages
+
+### Example
+```ruby
+# load the gem
+require 'mockserver-client'
+
+api_instance = MockServer::ControlApi.new
+opts = {
+  format: 'format_example', # String | changes response format, default if not specificed is \"json\", supported values are \"java\", \"json\"
+  type: 'type_example', # String | specifies the type of object that is retrieve, default if not specified is \"requests\", supported values are \"logs\", \"requests\", \"recorded_expectations\", \"active_expectations\"
+  http_request: MockServer::HttpRequest.new # HttpRequest | request used to match which recorded requests, expectations or log messages to return, an empty body matches all requests, expectations or log messages
+}
+
+begin
+  #retrieve recorded requests, active expectations, recorded expectations or log messages
+  result = api_instance.retrieve_put(opts)
+  p result
+rescue MockServer::ApiError => e
+  puts "Exception when calling ControlApi->retrieve_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **format** | **String**| changes response format, default if not specificed is \"json\", supported values are \"java\", \"json\" | [optional] 
+ **type** | **String**| specifies the type of object that is retrieve, default if not specified is \"requests\", supported values are \"logs\", \"requests\", \"recorded_expectations\", \"active_expectations\" | [optional] 
+ **http_request** | [**HttpRequest**](HttpRequest.md)| request used to match which recorded requests, expectations or log messages to return, an empty body matches all requests, expectations or log messages | [optional] 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, application/java, text/plain
+
+
+
+# **status_put**
+> Ports status_put
+
+return listening ports
+
+### Example
+```ruby
+# load the gem
+require 'mockserver-client'
+
+api_instance = MockServer::ControlApi.new
+
+begin
+  #return listening ports
+  result = api_instance.status_put
+  p result
+rescue MockServer::ApiError => e
+  puts "Exception when calling ControlApi->status_put: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Ports**](Ports.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **stop_put**
+> stop_put
+
+stop running process
+
+only supported on Netty version
+
+### Example
+```ruby
+# load the gem
+require 'mockserver-client'
+
+api_instance = MockServer::ControlApi.new
+
+begin
+  #stop running process
+  api_instance.stop_put
+rescue MockServer::ApiError => e
+  puts "Exception when calling ControlApi->stop_put: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+

data/docs/Delay.md

@@ -0,0 +1,9 @@
+# MockServer::Delay
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**time_unit** | **String** |  | [optional] 
+**value** | **Integer** |  | [optional] 
+
+

data/docs/Expectation.md

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

data/docs/ExpectationApi.md

@@ -0,0 +1,51 @@
+# MockServer::ExpectationApi
+
+All URIs are relative to *http://localhost:1080*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**expectation_put**](ExpectationApi.md#expectation_put) | **PUT** /expectation | create expectation
+
+
+# **expectation_put**
+> expectation_put(expectations)
+
+create expectation
+
+### Example
+```ruby
+# load the gem
+require 'mockserver-client'
+
+api_instance = MockServer::ExpectationApi.new
+expectations = nil # Array<Expectations> | expectation to create
+
+begin
+  #create expectation
+  api_instance.expectation_put(expectations)
+rescue MockServer::ApiError => e
+  puts "Exception when calling ExpectationApi->expectation_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **expectations** | [**Array&lt;Expectations&gt;**](Array.md)| expectation to create | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+

data/docs/Expectations.md

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

data/docs/HttpClassCallback.md

@@ -0,0 +1,8 @@
+# MockServer::HttpClassCallback
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**callback_class** | **String** |  | [optional] 
+
+

data/docs/HttpError.md

@@ -0,0 +1,10 @@
+# MockServer::HttpError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**delay** | [**Delay**](Delay.md) |  | [optional] 
+**drop_connection** | **BOOLEAN** |  | [optional] 
+**response_bytes** | **String** |  | [optional] 
+
+

data/docs/HttpForward.md

@@ -0,0 +1,11 @@
+# MockServer::HttpForward
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**host** | **String** |  | [optional] 
+**port** | **Integer** |  | [optional] 
+**scheme** | **String** |  | [optional] 
+**delay** | [**Delay**](Delay.md) |  | [optional] 
+
+

data/docs/HttpObjectCallback.md

@@ -0,0 +1,8 @@
+# MockServer::HttpObjectCallback
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** |  | [optional] 
+
+

data/docs/HttpOverrideForwardedRequest.md

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

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] 
+
+