Skip to content

V5.13.2 #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .openapi-generator/VERSION

This file was deleted.

2 changes: 0 additions & 2 deletions .rspec

This file was deleted.

3 changes: 2 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ source 'https://rubygems.org'
gemspec

group :development, :test do
gem 'rake', '~> 12.0.0'
gem 'rake', '~> 13.0.1'
gem 'pry-byebug'
gem 'rubocop', '~> 0.66.0'
end
69 changes: 52 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# mockserver-client

MockServer - the Ruby gem for the Mock Server API
MockServer - the Ruby gem for the MockServer 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).

Expand All @@ -10,8 +10,8 @@ Both MockServer and the MockServer Proxy record all received requests so that it

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 5.3.0
- Package version: 5.3.0
- API version: 5.13.2
- Package version: 5.13.2
- Build package: org.openapitools.codegen.languages.RubyClientCodegen

## Installation
Expand All @@ -27,15 +27,16 @@ gem build mockserver-client.gemspec
Then either install the gem locally:

```shell
gem install ./mockserver-client-5.3.0.gem
gem install ./mockserver-client-5.13.2.gem
```
(for development, run `gem install --dev ./mockserver-client-5.3.0.gem` to install the development dependencies)

(for development, run `gem install --dev ./mockserver-client-5.13.2.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'
gem 'mockserver-client', '~> 5.13.2'

### Install from Git

Expand All @@ -54,6 +55,7 @@ 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'
Expand All @@ -63,10 +65,10 @@ ports = MockServer::Ports.new # Ports | list of ports to bind to, where 0 indica

begin
#bind additional listening ports
result = api_instance.bind_put(ports)
result = api_instance.mockserver_bind_put(ports)
p result
rescue MockServer::ApiError => e
puts "Exception when calling ControlApi->bind_put: #{e}"
puts "Exception when calling ControlApi->mockserver_bind_put: #{e}"
end

```
Expand All @@ -77,36 +79,69 @@ 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
*MockServer::ControlApi* | [**mockserver_bind_put**](docs/ControlApi.md#mockserver_bind_put) | **PUT** /mockserver/bind | bind additional listening ports
*MockServer::ControlApi* | [**mockserver_clear_put**](docs/ControlApi.md#mockserver_clear_put) | **PUT** /mockserver/clear | clears expectations and recorded requests that match the request matcher
*MockServer::ControlApi* | [**mockserver_reset_put**](docs/ControlApi.md#mockserver_reset_put) | **PUT** /mockserver/reset | clears all expectations and recorded requests
*MockServer::ControlApi* | [**mockserver_retrieve_put**](docs/ControlApi.md#mockserver_retrieve_put) | **PUT** /mockserver/retrieve | retrieve recorded requests, active expectations, recorded expectations or log messages
*MockServer::ControlApi* | [**mockserver_status_put**](docs/ControlApi.md#mockserver_status_put) | **PUT** /mockserver/status | return listening ports
*MockServer::ControlApi* | [**mockserver_stop_put**](docs/ControlApi.md#mockserver_stop_put) | **PUT** /mockserver/stop | stop running process
*MockServer::ExpectationApi* | [**mockserver_expectation_put**](docs/ExpectationApi.md#mockserver_expectation_put) | **PUT** /mockserver/expectation | create expectation
*MockServer::ExpectationApi* | [**mockserver_openapi_put**](docs/ExpectationApi.md#mockserver_openapi_put) | **PUT** /mockserver/openapi | create expectations from OpenAPI or Swagger
*MockServer::VerifyApi* | [**mockserver_verify_put**](docs/VerifyApi.md#mockserver_verify_put) | **PUT** /mockserver/verify | verify a request has been received a specific number of times
*MockServer::VerifyApi* | [**mockserver_verify_sequence_put**](docs/VerifyApi.md#mockserver_verify_sequence_put) | **PUT** /mockserver/verifySequence | verify a sequence of request has been received in the specific order


## Documentation for Models

- [MockServer::Body](docs/Body.md)
- [MockServer::BodyAnyOf](docs/BodyAnyOf.md)
- [MockServer::BodyAnyOf1](docs/BodyAnyOf1.md)
- [MockServer::BodyAnyOf2](docs/BodyAnyOf2.md)
- [MockServer::BodyAnyOf3](docs/BodyAnyOf3.md)
- [MockServer::BodyAnyOf4](docs/BodyAnyOf4.md)
- [MockServer::BodyAnyOf5](docs/BodyAnyOf5.md)
- [MockServer::BodyAnyOf6](docs/BodyAnyOf6.md)
- [MockServer::BodyAnyOf7](docs/BodyAnyOf7.md)
- [MockServer::BodyAnyOf8](docs/BodyAnyOf8.md)
- [MockServer::BodyAnyOf9](docs/BodyAnyOf9.md)
- [MockServer::BodyWithContentType](docs/BodyWithContentType.md)
- [MockServer::BodyWithContentTypeAnyOf](docs/BodyWithContentTypeAnyOf.md)
- [MockServer::BodyWithContentTypeAnyOf1](docs/BodyWithContentTypeAnyOf1.md)
- [MockServer::BodyWithContentTypeAnyOf2](docs/BodyWithContentTypeAnyOf2.md)
- [MockServer::BodyWithContentTypeAnyOf3](docs/BodyWithContentTypeAnyOf3.md)
- [MockServer::ConnectionOptions](docs/ConnectionOptions.md)
- [MockServer::Delay](docs/Delay.md)
- [MockServer::Expectation](docs/Expectation.md)
- [MockServer::ExpectationId](docs/ExpectationId.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::HttpOverrideForwardedRequestOneOf](docs/HttpOverrideForwardedRequestOneOf.md)
- [MockServer::HttpOverrideForwardedRequestOneOf1](docs/HttpOverrideForwardedRequestOneOf1.md)
- [MockServer::HttpOverrideForwardedRequestOneOfRequestModifier](docs/HttpOverrideForwardedRequestOneOfRequestModifier.md)
- [MockServer::HttpOverrideForwardedRequestOneOfRequestModifierCookies](docs/HttpOverrideForwardedRequestOneOfRequestModifierCookies.md)
- [MockServer::HttpOverrideForwardedRequestOneOfRequestModifierPath](docs/HttpOverrideForwardedRequestOneOfRequestModifierPath.md)
- [MockServer::HttpOverrideForwardedRequestOneOfRequestModifierQueryStringParameters](docs/HttpOverrideForwardedRequestOneOfRequestModifierQueryStringParameters.md)
- [MockServer::HttpOverrideForwardedRequestOneOfResponseModifier](docs/HttpOverrideForwardedRequestOneOfResponseModifier.md)
- [MockServer::HttpRequest](docs/HttpRequest.md)
- [MockServer::HttpResponse](docs/HttpResponse.md)
- [MockServer::HttpTemplate](docs/HttpTemplate.md)
- [MockServer::KeyToMultiValue](docs/KeyToMultiValue.md)
- [MockServer::KeyToMultiValueOneOf](docs/KeyToMultiValueOneOf.md)
- [MockServer::KeyToValue](docs/KeyToValue.md)
- [MockServer::OpenAPIDefinition](docs/OpenAPIDefinition.md)
- [MockServer::OpenAPIExpectation](docs/OpenAPIExpectation.md)
- [MockServer::OpenAPIExpectations](docs/OpenAPIExpectations.md)
- [MockServer::Ports](docs/Ports.md)
- [MockServer::PositiveIntegerDefault0](docs/PositiveIntegerDefault0.md)
- [MockServer::RequestDefinition](docs/RequestDefinition.md)
- [MockServer::Schema](docs/Schema.md)
- [MockServer::SocketAddress](docs/SocketAddress.md)
- [MockServer::StringOrJsonSchema](docs/StringOrJsonSchema.md)
- [MockServer::StringOrJsonSchemaOneOf](docs/StringOrJsonSchemaOneOf.md)
- [MockServer::TimeToLive](docs/TimeToLive.md)
- [MockServer::Times](docs/Times.md)
- [MockServer::Verification](docs/Verification.md)
Expand Down
43 changes: 41 additions & 2 deletions docs/Body.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,46 @@
# MockServer::Body

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_not** | **Boolean** | | [optional] |
| **type** | **String** | | [optional] |
| **base64_bytes** | **String** | | [optional] |
| **content_type** | **String** | | [optional] |
| **json** | **String** | | [optional] |
| **match_type** | **String** | | [optional] |
| **json_schema** | **Object** | | [optional] |
| **json_path** | **String** | | [optional] |
| **parameters** | [**KeyToMultiValue**](KeyToMultiValue.md) | | [optional] |
| **regex** | **String** | | [optional] |
| **string** | **String** | | [optional] |
| **sub_string** | **Boolean** | | [optional] |
| **xml** | **String** | | [optional] |
| **xml_schema** | **String** | | [optional] |
| **xpath** | **String** | | [optional] |

## Example

```ruby
require 'mockserver-client'

instance = MockServer::Body.new(
_not: null,
type: null,
base64_bytes: null,
content_type: null,
json: null,
match_type: null,
json_schema: null,
json_path: null,
parameters: null,
regex: null,
string: null,
sub_string: null,
xml: null,
xml_schema: null,
xpath: null
)
```

24 changes: 24 additions & 0 deletions docs/BodyAnyOf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# MockServer::BodyAnyOf

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_not** | **Boolean** | | [optional] |
| **type** | **String** | | [optional] |
| **base64_bytes** | **String** | | [optional] |
| **content_type** | **String** | | [optional] |

## Example

```ruby
require 'mockserver-client'

instance = MockServer::BodyAnyOf.new(
_not: null,
type: null,
base64_bytes: null,
content_type: null
)
```

26 changes: 26 additions & 0 deletions docs/BodyAnyOf1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# MockServer::BodyAnyOf1

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_not** | **Boolean** | | [optional] |
| **type** | **String** | | [optional] |
| **json** | **String** | | [optional] |
| **content_type** | **String** | | [optional] |
| **match_type** | **String** | | [optional] |

## Example

```ruby
require 'mockserver-client'

instance = MockServer::BodyAnyOf1.new(
_not: null,
type: null,
json: null,
content_type: null,
match_type: null
)
```

22 changes: 22 additions & 0 deletions docs/BodyAnyOf2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# MockServer::BodyAnyOf2

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_not** | **Boolean** | | [optional] |
| **type** | **String** | | [optional] |
| **json_schema** | **Object** | | [optional] |

## Example

```ruby
require 'mockserver-client'

instance = MockServer::BodyAnyOf2.new(
_not: null,
type: null,
json_schema: null
)
```

22 changes: 22 additions & 0 deletions docs/BodyAnyOf3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# MockServer::BodyAnyOf3

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_not** | **Boolean** | | [optional] |
| **type** | **String** | | [optional] |
| **json_path** | **String** | | [optional] |

## Example

```ruby
require 'mockserver-client'

instance = MockServer::BodyAnyOf3.new(
_not: null,
type: null,
json_path: null
)
```

22 changes: 22 additions & 0 deletions docs/BodyAnyOf4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# MockServer::BodyAnyOf4

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_not** | **Boolean** | | [optional] |
| **type** | **String** | | [optional] |
| **parameters** | [**KeyToMultiValue**](KeyToMultiValue.md) | | [optional] |

## Example

```ruby
require 'mockserver-client'

instance = MockServer::BodyAnyOf4.new(
_not: null,
type: null,
parameters: null
)
```

22 changes: 22 additions & 0 deletions docs/BodyAnyOf5.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# MockServer::BodyAnyOf5

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_not** | **Boolean** | | [optional] |
| **type** | **String** | | [optional] |
| **regex** | **String** | | [optional] |

## Example

```ruby
require 'mockserver-client'

instance = MockServer::BodyAnyOf5.new(
_not: null,
type: null,
regex: null
)
```

26 changes: 26 additions & 0 deletions docs/BodyAnyOf6.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# MockServer::BodyAnyOf6

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_not** | **Boolean** | | [optional] |
| **type** | **String** | | [optional] |
| **string** | **String** | | [optional] |
| **content_type** | **String** | | [optional] |
| **sub_string** | **Boolean** | | [optional] |

## Example

```ruby
require 'mockserver-client'

instance = MockServer::BodyAnyOf6.new(
_not: null,
type: null,
string: null,
content_type: null,
sub_string: null
)
```

24 changes: 24 additions & 0 deletions docs/BodyAnyOf7.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# MockServer::BodyAnyOf7

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **_not** | **Boolean** | | [optional] |
| **type** | **String** | | [optional] |
| **xml** | **String** | | [optional] |
| **content_type** | **String** | | [optional] |

## Example

```ruby
require 'mockserver-client'

instance = MockServer::BodyAnyOf7.new(
_not: null,
type: null,
xml: null,
content_type: null
)
```

Loading