mockserver-client 1.0.8.pre → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5949e6484134d15b965631dad80fde5bce36b48b
-  data.tar.gz: 11dbadd346eae086b0b93e981d9f4b55e6900bed
+  metadata.gz: 78cecf99392693da9d10a7e638e1cc0b6c2ef499
+  data.tar.gz: 405fb05b09c13e62df825c3c9badea9f9be3ec97
 SHA512:
-  metadata.gz: 7404475b6281eef548a4c27baf6397c47a3bfb0d7de8a2154ac3d0c92e4b85a2429a0c8aafca47918dc0f2a158154cefd7dfc61e11d94182a9cdb69b25e382d6
-  data.tar.gz: 16776ab334b6690eec900c3cf694902e3c2119617d18339ba2af621296b3af1f0f0eb7b631486277c538e3802f0662e4853578a9c606c6ef4ca747321c7e81ac
+  metadata.gz: 83e4ac08844b4dfa0bc2edee4f8fab1b5f8c07826e7b8af644275d4ca71c3a2f573854d064baf996a071d6e9a166bca2eda6ddd1204c7993708ac7f0616bb737
+  data.tar.gz: 7ebefc74dba04037c95fb072c8fd4bd0faa8a7bdf81981205ae11e82993b3b0ac9833c64ef9f254d7ab273bc224e7f58e5ed7212e933caa8c097167c95cb4b4d

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
-# Gem's dependencies in mockserver-client.gemspec
 gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    mockserver-client (5.3.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.13)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  mockserver-client!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -1,260 +1,120 @@
-# Mockserver Client
+# mockserver-client
 
-A Ruby client for [MockServer](http://www.mock-server.com) project. This client follows the Java client's fluent style closely by using Ruby blocks.
+MockServer - the Ruby gem for the Mock Server API
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'mockserver-client'
-```
+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).
 
-And then execute:
+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).
 
-```bash
-bundle
-```
+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.
 
-Or install it yourself as:
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-```bash
-gem install mockserver-client
-```
+- API version: 5.3.0
+- Package version: 5.3.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
-## Usage
+## Installation
 
-The usage notes here compare the Java syntax with the Ruby DSL for the various actions the MockServer client/proxy client supports. The Ruby code here assumes you have included `MockServer` and `MockServer::Model::DSL` modules. So these lines should  typically be at the top of your code:
+### Build a gem
 
-```ruby
-include MockServer
-include MockServer::Model::DSL
-```
+To build the Ruby code into a gem:
 
-### Create Expectations
-
-##### Java
-
-```java
-new MockServerClient("localhost", 9999)
-        .when(
-                request()
-                        .withMethod("POST")
-                        .withPath("/login")
-                        .withQueryStringParameters(
-                                new Parameter("returnUrl", "/account")
-                        )
-                        .withCookies(
-                                new Cookie("sessionId", "2By8LOhBmaW5nZXJwcmludCIlMDAzMW")
-                        )
-                        .withBody("{username: 'foo', password: 'bar'}"),
-                Times.exactly(1)
-        )
-        .respond(
-                response()
-                        .withStatusCode(401)
-                        .withHeaders(
-                                new Header("Content-Type", "application/json; charset=utf-8"),
-                                new Header("Cache-Control", "public, max-age=86400")
-                        )
-                        .withBody("{ message: 'incorrect username and password combination' }")
-                        .withDelay(new Delay(TimeUnit.SECONDS, 1))
-        );
+```shell
+gem build mockserver-client.gemspec
 ```
 
-##### Ruby
+Then either install the gem locally:
 
-```ruby
-client = MockServerClient.new('localhost', 9999)
-expectation = expectation do |expectation|
-     expectation.request do |request|
-        request.method = 'POST'
-        request.path = '/login'
-        request.query_string_parameters << parameter('returnUrl', '/account')
-        request.cookies = [cookie('sessionId', '2By8LOhBmaW5nZXJwcmludCIlMDAzMW')]
-        request.body = exact("{username: 'foo', password: 'bar'}")
-     end
-
-    expectation.response do |response|
-        response.status_code = 401
-        response.headers << header('Content-Type', 'application/json; charset=utf-8')
-        response.headers << header('Cache-Control', 'public, max-age=86400')
-        response.body = body("{ message: 'incorrect username and password combination' }")
-        response.delay = delay_by(:SECONDS, 1)
-    end
-end
-client.register(expectation)
+```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)
 
-### Clear & Reset Server
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
-##### Java
+Finally add this to the Gemfile:
 
-```java
-mockServerClient.clear(
-        request()
-                .withMethod("POST")
-                .withPath("/login")
-);
-mockServerClient.reset();
-```
-
-##### Ruby
-
- ```ruby
- client.clear(request('POST', '/login'))
- client.reset
- ```
-### Verifying Behavior
-
-##### Java
-
-```java
-new ProxyClient("localhost", 9090).verify(
-        request()
-                .withMethod("POST")
-                .withPath("/login")
-                .withBody(exact("{username: 'foo', password: 'bar'}"))
-                .withCookies(
-                        new Cookie("sessionId", ".*")
-                ),
-        Times.exactly(1)
-);
-```
+    gem 'mockserver-client', '~> 5.3.0'
 
-##### Ruby
+### Install from Git
 
-```ruby
-# Not providing times here because the default is exactly(1) i.e. the second argument to verify method
-ProxyClient.new('localhost', 9090).verify(request(:POST, '/login') do |request|
-    request.body = exact("{username: 'foo', password: 'bar'}")
-    request.cookies = [cookie("sessionId", ".*")]
-end)
-```
+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'
 
-### Analyzing Behavior
+### Include the Ruby code directly
 
-##### Java
+Include the Ruby code directly using `-I` as follows:
 
-```java
-new ProxyClient("localhost", 9090).dumpToLogAsJava(
-        request()
-                .withMethod("POST")
-                .withPath("/login")
-);
+```shell
+ruby -Ilib script.rb
 ```
 
-##### Ruby
+## Getting Started
 
+Please follow the [installation](#installation) procedure and then run the following code:
 ```ruby
-# Second argument is true to set output to Java; false to set output to default JSON (default)
-ProxyClient.new('localhost', 9090).dump_log(request(:POST, '/login'), true)
-```
-
-## Complete Ruby DSL
-The DSL is provided via the `MockServer::Model::DSL` module. Include this module in your code to make the DSL available.
-
-Request
-* **request**: Used to build a request object. If a block is passed, will configure request first and then return the configured request. Example: `request(:POST, '/login') {|r| r.headers << header("Content-Type", "application/json")}`.
-* **http_request**: Alias for `request`.
-
-Body
-* **body**: Create a string body object (use in a response). Example: `body("unaccepted")`.
-* **exact**: Create a body of type `STRING`. Example: `exact('{"reason": "unauthorized"}')`.
-* **regex**: Create a body of type `REGEX`. Example: `regex('username[a-z]{4}')`.
-* **xpath**: Used to create a body of type `XPATH`. Example: `xpath("/element[key = 'some_key' and value = 'some_value']")`.
-* **parameterized**; Create a body to type `PARAMETERS`. Example `parameterized(parameter('someValue', 1, 2), parameter('otherValue', 4, 5))`.
-
-Parameters
-* **parameter**: Create a generic parameter. Example: `parameter('key', 'value1' , 'value2')`.
-* **cookie**: Create a cookie (same as `parameter` above but exists as syntactic sugar). Example: `cookie('sessionId', 'sessionid1ldj')`.
-* **header**: Create a header (same as `parameter` above but exists as syntactic sugar). Example: `header('Content-Type', 'application/json')`.
-
-Forward
-* **forward**: Create a forwarding response. If a block is passed, will configure forward response first and then return the configured object. Example: `forward {|f| f.scheme = 'HTTPS' }`.
-* **http_forward**: Alias for `forward`.
-
-Response
-* **response**: Create a response object. If a block is passed, will configure response first and then return the configured response. Example: `response {|r| r.status_code = 201 }`.
-* **http_response**: Alias for `response`.
-
-Delay
-* **delay_by**. Create a delay object in a response. Example : `delay_by(:MICROSECONDS, 20)`.
-
-Times (used in Expectation)
-* **times**: Create an 'times' object. If a block is passed, will configure the object first before returning it. Example: `times {|t| t.unlimited = false }`.
-* **unlimited**: Create an object with unlimited repeats. Example: `unlimited()`. (No parameters).
-* **once**. Create an object that repeats only once. Example: `once()`. (No parameters).
-* **exactly**. Create an object that repeats exactly the number of times specified. Example: `exactly(2)`.
-* **at_least**: Create an object that repeats at least the given number of times. (Use in verify). Example: `at_least(2)`.
-
-Expectation (use in register)
-* **expectation**: Create an expectation object. If a block is passed, will configure the object first before returning it. Example: `expectation {|e| e.request {|r| r.path = "index.html} }`. 
-Getter methods for `request`, `response` and `forward` methods will optionally accept a block. If block is passed object is configured before it is returned. The attribute `times` has conventional getter and setter methods.
-
-## CLI
-
-This gem comes with a command line interface which allow you to run the Mock Server calls from the command line. When this gem is installed, you will have the `mockserver` executable on your PATH. Type `mockserver --help` and you will get this output: 
-
-```bash
-mockserver --help 
-
-Commands: 
-  mockserver clear           # Clears all stored mock request/responses from server.
-  mockserver dump_log        # Dumps the matching request to the mock server logs.
-  mockserver help [COMMAND]  # Describe available commands or one specific command
-  mockserver register        # Register an expectation with the mock server.
-  mockserver reset           # Resets the server clearing all data.
-  mockserver retrieve        # Retrieve the list of requests that have been made to the mock/proxy server.
-  mockserver verify          # Verify that a request has been made the specified number of times to the server.
-
-Options:
-  -h, --host=HOST    # The host for the MockServer client.
-                     # Default: localhost
-  -p, --port=N       # The port for the MockServer client.
-                     # Default: 8080
-  -d, [--data=DATA]  # A JSON or YAML file containing the request payload.
-```
-
-To get help for an individual command, e.g. `dump_log`, you would do:
-
-```bash
-mockserver --help dump_log
-
-Usage:
-  mockserver dump_log
-
-Options:
-  -j, [--java], [--no-java]  # A switch to turn Java format for logs on/off.
-  -h, --host=HOST            # The host for the MockServer client.
-                             # Default: localhost
-  -p, --port=N               # The port for the MockServer client.
-                             # Default: 8080
-  -d, [--data=DATA]          # A JSON or YAML file containing the request payload.
-
-Dumps the matching request to the mock server logs.
-```
-
-Here is an example on how you would run the command:
-
-```bash
-mockserver dump_log -j true
-
-Running with parameters:
-	host: localhost
-	port: 8080
-	java: true
+# 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
 
-[2014-06-21 09:23:32] DEBUG [MockServerClient] Sending dump log request to mockserver
-[2014-06-21 09:23:32] DEBUG [MockServerClient] URL: /dumpToLog?type=java. Payload: {}
-[2014-06-21 09:23:32] DEBUG [MockServerClient] Got dump to log response: 202
 ```
 
-# Issues
-
-If you have any problems, please [check the project issues](https://github.com/jamesdbloom/mockserver/issues?state=open).
-
-# Contributions
+## 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.
 
-Pull requests are, of course, very welcome! Please read our [contributing to the project](https://github.com/jamesdbloom/mockserver/wiki/Contributing-to-the-project) guide first. Then head over to the [open issues](https://github.com/jamesdbloom/mockserver/issues?state=open) to see what we need help with. Make sure you let us know if you intend to work on something. Also, check out the [milestones](https://github.com/jamesdbloom/mockserver/issues/milestones) to see what is planned for future releases.