mockserver-client 5.3.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 78cecf99392693da9d10a7e638e1cc0b6c2ef499
-  data.tar.gz: 405fb05b09c13e62df825c3c9badea9f9be3ec97
+SHA256:
+  metadata.gz: 52c92809897fcdfe317afdab740419e5bef114b46482df4a9756821916bd4a73
+  data.tar.gz: 8b8ee1a6a5c341edecbe70a90ccb1dda4c481162eca2f30e83ee121beaa656d5
 SHA512:
-  metadata.gz: 83e4ac08844b4dfa0bc2edee4f8fab1b5f8c07826e7b8af644275d4ca71c3a2f573854d064baf996a071d6e9a166bca2eda6ddd1204c7993708ac7f0616bb737
-  data.tar.gz: 7ebefc74dba04037c95fb072c8fd4bd0faa8a7bdf81981205ae11e82993b3b0ac9833c64ef9f254d7ab273bc224e7f58e5ed7212e933caa8c097167c95cb4b4d
+  metadata.gz: 476994411a429882a93e0fe6852527b14ac9ce60ffc2ac328f0536eef2adee69f7c2ce8061bc8dfda7cc32869fe0e227ed3f5e979a3a1e1513c1ae3540be2f27
+  data.tar.gz: 94828363b6159101e0288c15b604e7e9acf19716f67efb5edf56f591a79946aaf987ed2c32f079f421d3ad74045d61fa0aac62b93820d162df3299b284108cd7

data/Gemfile

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

data/README.md

@@ -1,120 +1,112 @@
-# mockserver-client
+# MockServer Ruby 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
+Hand-written Ruby client for [MockServer](https://www.mock-server.com) with full REST API, fluent builder DSL, and WebSocket callback support.
 
 ## Installation
 
-### Build a gem
-
-To build the Ruby code into a gem:
+Add to your Gemfile:
 
-```shell
-gem build mockserver-client.gemspec
+```ruby
+gem 'mockserver-client', '~> 5.16'
 ```
 
-Then either install the gem locally:
+Or install directly:
 
-```shell
-gem install ./mockserver-client-5.3.0.gem
+```bash
+gem install mockserver-client
 ```
-(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'
+## Quick Start
 
-### Install from Git
+```ruby
+require 'mockserver-client'
 
-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:
+# Create a client
+client = MockServer::Client.new('localhost', 1080)
+
+# Set up an expectation using the fluent API
+client.when(
+  MockServer::HttpRequest.request(path: '/hello')
+    .with_method('GET')
+).respond(
+  MockServer::HttpResponse.response(body: 'world', status_code: 200)
+)
+
+# Verify a request was received
+client.verify(
+  MockServer::HttpRequest.request(path: '/hello'),
+  times: MockServer::VerificationTimes.at_least(1)
+)
+
+# Clean up
+client.reset
+client.close
+```
 
-    gem 'mockserver-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+## Block Form
 
-### Include the Ruby code directly
+```ruby
+MockServer::Client.new('localhost', 1080) do |client|
+  client.when(
+    MockServer::HttpRequest.request(path: '/api/test')
+  ).respond(
+    MockServer::HttpResponse.response(body: '{"status":"ok"}', status_code: 200)
+  )
+end
+# Client is automatically closed when the block exits
+```
 
-Include the Ruby code directly using `-I` as follows:
+## WebSocket Callbacks
 
-```shell
-ruby -Ilib script.rb
+```ruby
+client = MockServer::Client.new('localhost', 1080)
+
+# Response callback - dynamically generate responses
+client.mock_with_callback(
+  MockServer::HttpRequest.request(path: '/dynamic'),
+  ->(request) {
+    MockServer::HttpResponse.new(
+      status_code: 200,
+      body: "Echo: #{request.path}"
+    )
+  }
+)
+
+# Forward callback - modify requests before forwarding
+client.mock_with_forward_callback(
+  MockServer::HttpRequest.request(path: '/proxy'),
+  ->(request) {
+    request.with_header('X-Proxied', 'true')
+  }
+)
+
+client.close
 ```
 
-## Getting Started
+## Models
 
-Please follow the [installation](#installation) procedure and then run the following code:
-```ruby
-# Load the gem
-require 'mockserver-client'
+All 25 domain model classes are available under the `MockServer` module:
 
-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
+- `Delay`, `Times`, `TimeToLive`
+- `KeyToMultiValue`, `Body`, `SocketAddress`
+- `HttpRequest`, `HttpResponse`, `HttpForward`, `HttpTemplate`
+- `HttpClassCallback`, `HttpObjectCallback`, `HttpError`
+- `HttpOverrideForwardedRequest`, `HttpRequestAndHttpResponse`
+- `ConnectionOptions`
+- `Expectation`, `ExpectationId`
+- `OpenAPIDefinition`, `OpenAPIExpectation`
+- `Verification`, `VerificationSequence`, `VerificationTimes`
+- `Ports`
+- `RequestDefinition` (alias for `HttpRequest`)
 
-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
+## License
 
-```
+Apache-2.0
+
+## AI Assistant Integration
 
-## 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.
+MockServer includes a built-in [MCP](https://modelcontextprotocol.io) (Model Context Protocol) server that enables AI coding assistants to create expectations, verify requests, and debug HTTP traffic programmatically.
 
+- **MCP Endpoint:** `http://localhost:1080/mockserver/mcp`
+- **AI Documentation:** [llms.txt](https://www.mock-server.com/llms.txt)
+- **Setup Guide:** [AI Integration](https://www.mock-server.com/mock_server/ai_mcp_setup.html)