{"id":18724359,"url":"https://github.com/mock-server/mockserver-client-ruby","last_synced_at":"2025-10-21T06:37:54.209Z","repository":{"id":40353759,"uuid":"79703896","full_name":"mock-server/mockserver-client-ruby","owner":"mock-server","description":"A Ruby client for MockServer project. This client is code generated using the MockServer OpenAPI v3 specification.","archived":false,"fork":false,"pushed_at":"2022-05-11T16:04:50.000Z","size":142,"stargazers_count":9,"open_issues_count":6,"forks_count":15,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-14T12:08:01.947Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://www.mock-server.com","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mock-server.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-01-22T08:12:50.000Z","updated_at":"2023-03-10T11:57:26.000Z","dependencies_parsed_at":"2022-08-09T18:01:20.439Z","dependency_job_id":null,"html_url":"https://github.com/mock-server/mockserver-client-ruby","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mock-server%2Fmockserver-client-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mock-server%2Fmockserver-client-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mock-server%2Fmockserver-client-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mock-server%2Fmockserver-client-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mock-server","download_url":"https://codeload.github.com/mock-server/mockserver-client-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248589687,"owners_count":21129666,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T14:06:14.077Z","updated_at":"2025-10-21T06:37:49.158Z","avatar_url":"https://github.com/mock-server.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mockserver-client\n\nMockServer - the Ruby gem for the Mock Server API\n\nMockServer 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).\n\nMockServer 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).\n\nBoth 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.\n\nThis SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 5.3.0\n- Package version: 5.3.0\n- Build package: org.openapitools.codegen.languages.RubyClientCodegen\n\n## Installation\n\n### Build a gem\n\nTo build the Ruby code into a gem:\n\n```shell\ngem build mockserver-client.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./mockserver-client-5.3.0.gem\n```\n(for development, run `gem install --dev ./mockserver-client-5.3.0.gem` to install the development dependencies)\n\nor publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).\n\nFinally add this to the Gemfile:\n\n    gem 'mockserver-client', '~\u003e 5.3.0'\n\n### Install from Git\n\nIf 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:\n\n    gem 'mockserver-client', :git =\u003e 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'\n\n### Include the Ruby code directly\n\nInclude the Ruby code directly using `-I` as follows:\n\n```shell\nruby -Ilib script.rb\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) procedure and then run the following code:\n```ruby\n# Load the gem\nrequire 'mockserver-client'\n\napi_instance = MockServer::ControlApi.new\nports = MockServer::Ports.new # Ports | list of ports to bind to, where 0 indicates dynamically bind to any available port\n\nbegin\n  #bind additional listening ports\n  result = api_instance.bind_put(ports)\n  p result\nrescue MockServer::ApiError =\u003e e\n  puts \"Exception when calling ControlApi-\u003ebind_put: #{e}\"\nend\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:1080*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*MockServer::ControlApi* | [**bind_put**](docs/ControlApi.md#bind_put) | **PUT** /bind | bind additional listening ports\n*MockServer::ControlApi* | [**clear_put**](docs/ControlApi.md#clear_put) | **PUT** /clear | clears expectations and recorded requests that match the request matcher\n*MockServer::ControlApi* | [**reset_put**](docs/ControlApi.md#reset_put) | **PUT** /reset | clears all expectations and recorded requests\n*MockServer::ControlApi* | [**retrieve_put**](docs/ControlApi.md#retrieve_put) | **PUT** /retrieve | retrieve recorded requests, active expectations, recorded expectations or log messages\n*MockServer::ControlApi* | [**status_put**](docs/ControlApi.md#status_put) | **PUT** /status | return listening ports\n*MockServer::ControlApi* | [**stop_put**](docs/ControlApi.md#stop_put) | **PUT** /stop | stop running process\n*MockServer::ExpectationApi* | [**expectation_put**](docs/ExpectationApi.md#expectation_put) | **PUT** /expectation | create expectation\n*MockServer::VerifyApi* | [**verify_put**](docs/VerifyApi.md#verify_put) | **PUT** /verify | verify a request has been received a specific number of times\n*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\n\n\n## Documentation for Models\n\n - [MockServer::Body](docs/Body.md)\n - [MockServer::BodyWithContentType](docs/BodyWithContentType.md)\n - [MockServer::ConnectionOptions](docs/ConnectionOptions.md)\n - [MockServer::Delay](docs/Delay.md)\n - [MockServer::Expectation](docs/Expectation.md)\n - [MockServer::Expectations](docs/Expectations.md)\n - [MockServer::HttpClassCallback](docs/HttpClassCallback.md)\n - [MockServer::HttpError](docs/HttpError.md)\n - [MockServer::HttpForward](docs/HttpForward.md)\n - [MockServer::HttpObjectCallback](docs/HttpObjectCallback.md)\n - [MockServer::HttpOverrideForwardedRequest](docs/HttpOverrideForwardedRequest.md)\n - [MockServer::HttpRequest](docs/HttpRequest.md)\n - [MockServer::HttpResponse](docs/HttpResponse.md)\n - [MockServer::HttpTemplate](docs/HttpTemplate.md)\n - [MockServer::KeyToMultiValue](docs/KeyToMultiValue.md)\n - [MockServer::KeyToValue](docs/KeyToValue.md)\n - [MockServer::Ports](docs/Ports.md)\n - [MockServer::TimeToLive](docs/TimeToLive.md)\n - [MockServer::Times](docs/Times.md)\n - [MockServer::Verification](docs/Verification.md)\n - [MockServer::VerificationSequence](docs/VerificationSequence.md)\n - [MockServer::VerificationTimes](docs/VerificationTimes.md)\n\n\n## Documentation for Authorization\n\n All endpoints do not require authorization.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmock-server%2Fmockserver-client-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmock-server%2Fmockserver-client-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmock-server%2Fmockserver-client-ruby/lists"}