mockserver-client 1.0.8.pre → 6.0.0

metadata

@@ -1,280 +1,128 @@
 --- !ruby/object:Gem::Specification
 name: mockserver-client
 version: !ruby/object:Gem::Version
-  version: 1.0.8.pre
+  version: 6.0.0
 platform: ruby
 authors:
-- Nayyara Samuel
-- James D Bloom
-autorequire: 
+- James Bloom
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2026-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: websocket-client-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
-  type: :development
+        version: '0.8'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.18'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.18'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '3.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.23'
-- !ruby/object:Gem::Dependency
-  name: hashie
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: logging_factory
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.0.2
-- !ruby/object:Gem::Dependency
-  name: thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.19'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.19'
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
-description: A Ruby Client for MockServer that enables easy mocking of any system
-  you integrate with via HTTP or HTTPS (i.e. services, web sites, etc)
+        version: '3.19'
+description: Official Ruby client for MockServer — create expectations, verify requests,
+  and register dynamic callbacks via WebSocket. Includes a fluent builder DSL.
 email:
-- nayyara.samuel@opower.com
 - jamesdbloom@gmail.com
-executables:
-- mockserver
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
 - Gemfile
 - README.md
-- Rakefile
-- bin/mockserver
-- lib/cli.rb
 - lib/mockserver-client.rb
-- lib/mockserver/abstract_client.rb
-- lib/mockserver/mock_server_client.rb
-- lib/mockserver/model/array_of.rb
-- lib/mockserver/model/body.rb
-- lib/mockserver/model/cookie.rb
-- lib/mockserver/model/delay.rb
-- lib/mockserver/model/enum.rb
-- lib/mockserver/model/expectation.rb
-- lib/mockserver/model/forward.rb
-- lib/mockserver/model/header.rb
-- lib/mockserver/model/parameter.rb
-- lib/mockserver/model/request.rb
-- lib/mockserver/model/response.rb
-- lib/mockserver/model/times.rb
-- lib/mockserver/proxy_client.rb
-- lib/mockserver/utility_methods.rb
+- lib/mockserver/client.rb
+- lib/mockserver/errors.rb
+- lib/mockserver/forward_chain_expectation.rb
+- lib/mockserver/models.rb
 - lib/mockserver/version.rb
+- lib/mockserver/websocket_client.rb
 - mockserver-client.gemspec
-- pom.xml
-- spec/fixtures/forward_mockserver.json
-- spec/fixtures/incorrect_login_response.json
-- spec/fixtures/post_login_request.json
-- spec/fixtures/register_expectation.json
-- spec/fixtures/retrieved_request.json
-- spec/fixtures/search_request.json
-- spec/fixtures/times_once.json
-- spec/integration/mock_client_integration_spec.rb
-- spec/mockserver/builder_spec.rb
-- spec/mockserver/mock_client_spec.rb
-- spec/mockserver/proxy_client_spec.rb
-- spec/spec_helper.rb
-homepage: http://www.mock-server.com
-licenses: []
-metadata: {}
-post_install_message: 
+homepage: https://www.mock-server.com
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/mock-server/mockserver-monorepo
+  changelog_uri: https://www.mock-server.com/mock_server/changelog.html
+  bug_tracker_uri: https://github.com/mock-server/mockserver-monorepo/issues
+  documentation_uri: https://www.mock-server.com/mock_server/getting_started.html
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.2
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
-summary: A Ruby client for MockServer
-test_files:
-- spec/fixtures/forward_mockserver.json
-- spec/fixtures/incorrect_login_response.json
-- spec/fixtures/post_login_request.json
-- spec/fixtures/register_expectation.json
-- spec/fixtures/retrieved_request.json
-- spec/fixtures/search_request.json
-- spec/fixtures/times_once.json
-- spec/integration/mock_client_integration_spec.rb
-- spec/mockserver/builder_spec.rb
-- spec/mockserver/mock_client_spec.rb
-- spec/mockserver/proxy_client_spec.rb
-- spec/spec_helper.rb
+summary: Official Ruby client for MockServer
+test_files: []

data/.gitignore

@@ -1,21 +0,0 @@
-# Ruby #
-########
-*.gem
-*.rbc
-*.bundle
-*.so
-*.o
-*.a
-*.log
-.config
-.yardoc
-.rakeTasks
-Gemfile.lock
-InstalledFiles
-coverage
-*doc
-*tmp
-lib/bundler/man
-pkg
-spec/reports
-vendor/bundle

data/.rubocop.yml

@@ -1,7 +0,0 @@
-Style/LineLength:
-  Max: 180
-Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
-Style/FileName:
-  Exclude:
-    - '**/mockserver-client.rb'

data/Rakefile

@@ -1,10 +0,0 @@
-# encoding: UTF-8
-require 'bundler/gem_tasks'
-require 'rubocop/rake_task'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new(:rubocop)
-
-desc 'Main task for this project to ensure the project passes build'
-task default: [:rubocop, :spec, :build]

data/bin/mockserver

@@ -1,9 +0,0 @@
-# encoding: UTF-8
-#!/usr/bin/env ruby
-
-#
-# A thor-based runner for commands in this project
-# @author: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
-#
-require_relative '../lib/cli'
-MockServerCLI.start

data/lib/cli.rb

@@ -1,146 +0,0 @@
-# encoding: UTF-8
-require 'thor'
-require 'colorize'
-require_relative './mockserver-client'
-
-# CLI for this gem
-# @author Nayyara Samuel(nayyara.samuel@opower.com)
-#
-module CLIHelpers
-  include MockServer
-
-  LOGGER = LoggingFactory::DEFAULT_FACTORY.log('MockServerClient')
-
-  # Prints out the parameters passed to it
-  # @param options [Hash] a hash of parameters
-  def print_parameters(options)
-    puts "\nRunning with parameters:".bold
-    options.each { |k, v| puts "\t#{k}: #{v}".yellow }
-    puts ''
-  end
-
-  # Create a mockserver client
-  # @param options [Struct] with host and port set
-  # @return [MockServerClient] the mockserver client with the host and port
-  def mockserver_client(options)
-    client        = MockServerClient.new(options.host, options.port)
-    client.logger = LOGGER
-    client
-  end
-
-  # Create a proxy client
-  # @param options [Struct] with host and port set
-  # @return [ProxyClient] the proxy client with the host and port
-  def proxy_client(options)
-    client        = ProxyClient.new(options.host, options.port)
-    client.logger = LOGGER
-    client
-  end
-
-  # Convert a hash to a struct
-  # @param hash [Hash] a hash
-  # @return [Struct] a struct constructed from the hash
-  def to_struct(hash)
-    hash = symbolize_keys(hash)
-    Struct.new(*hash.keys).new(*hash.values)
-  end
-
-  # Process a block using options extracted into a struct
-  # @param mockserver [Boolean] true to use mockserver, false to use proxy
-  # @yieldparam [AbstractClient] a mockserver or a proxy client
-  # @yieldparam [Struct] a struct created from options hash
-  def execute_command(mockserver = false, data_required = false, error_msg = '--data option must be provided', &_)
-    print_parameters(options)
-    struct_options = to_struct({ data: nil }.merge(options))
-    if data_required && !options['data']
-      error(error_msg)
-    else
-      client = mockserver ? mockserver_client(struct_options) : proxy_client(struct_options)
-      yield client, struct_options if block_given?
-    end
-  end
-
-  # Prints an error message
-  # @param message [String] an error message
-  def error(message)
-    puts message.red
-  end
-
-  # Read a file
-  # @param file [String] a file to read
-  def read_file(file)
-    YAML.load_file(file)
-  end
-end
-
-# CLI for mock server and proxy clients
-class MockServerCLI < Thor
-  include CLIHelpers
-  include MockServer::UtilityMethods
-  include MockServer::Model::DSL
-
-  class_option :host, type: :string, aliases: '-h', required: true, default: 'localhost', desc: 'The host for the MockServer client.'
-  class_option :port, type: :numeric, aliases: '-p', required: true, default: 8080, desc: 'The port for the MockServer client.'
-  class_option :data, type: :string, aliases: '-d', desc: 'A JSON or YAML file containing the request payload.'
-
-  desc 'retrieve', 'Retrieve the list of requests that have been made to the mock/proxy server.'
-
-  def retrieve
-    execute_command do |client, _|
-      result = options.data ? client.retrieve(read_file(options.data)) : client.retrieve
-      puts "RESULT:\n".bold + "#{result.to_json}".green
-    end
-  end
-
-  desc 'register', 'Register an expectation with the mock server.'
-
-  def register
-    execute_command(true, true) do |client, options|
-      payload          = read_file(options.data)
-      mock_expectation = expectation do |expectation|
-        expectation.populate_from_payload(payload)
-      end
-      client.register(mock_expectation)
-    end
-  end
-
-  desc 'dump_log', 'Dumps the matching request to the mock server logs.'
-  option :java, type: :boolean, aliases: '-j', default: false, desc: 'A switch to turn Java format for logs on/off.'
-
-  def dump_log
-    execute_command do |client, options|
-      options.data ? client.dump_log(read_file(options.data), options.java) : client.dump_log(nil, options.java)
-    end
-  end
-
-  desc 'clear', 'Clears all stored mock request/responses from server.'
-
-  def clear
-    error_message = 'ERROR: No request provided. HINT: Use `clear` to selectively clear requests. Use `reset` to clear all.'
-    execute_command(false, true, error_message) do |client, _|
-      payload = read_file(options.data)
-      client.clear(payload)
-    end
-  end
-
-  desc 'reset', 'Resets the server clearing all data.'
-
-  def reset
-    execute_command do |client, _|
-      client.reset
-    end
-  end
-
-  desc 'verify', 'Verify that a request has been made the specified number of times to the server.'
-
-  def verify
-    execute_command(false, true) do |client, _|
-      payload      = read_file(options.data)
-      mock_request = payload[HTTP_REQUEST]
-      mock_times   = payload[HTTP_TIMES]
-
-      error 'No request found for verifying against' unless mock_request
-      mock_times ? client.verify(mock_request, mock_times) : client.verify(mock_request)
-    end
-  end
-end

data/lib/mockserver/abstract_client.rb

@@ -1,111 +0,0 @@
-# encoding: UTF-8
-require 'rest-client'
-require 'logging_factory'
-require_relative './model/times'
-require_relative './model/request'
-require_relative './model/expectation'
-require_relative './utility_methods'
-
-# An abstract client for making requests supported by mock and proxy client.
-# @author Nayyara Samuel(mailto: nayyara.samuel@opower.com)
-#
-module MockServer
-  RESET_ENDPOINT    = '/reset'
-  CLEAR_ENDPOINT    = '/clear'
-  RETRIEVE_ENDPOINT = '/retrieve'
-  DUMP_LOG_ENDPOINT = '/dumpToLog'
-
-  # An abstract client for making requests supported by mock and proxy client.
-  class AbstractClient
-    include Model::DSL
-    include Model
-    include UtilityMethods
-
-    attr_accessor :logger
-
-    def initialize(host, port)
-      fail 'Cannot instantiate AbstractClient class. You must subclass it.' if self.class == AbstractClient
-      fail 'Host/port must not be nil' unless host && port
-      @base   = RestClient::Resource.new("http://#{host}:#{port}", headers: { 'Content-Type' => 'application/json' })
-      @logger = ::LoggingFactory::DEFAULT_FACTORY.log(self.class)
-    end
-
-    # Clear all expectations with the given request
-    # @param request [Request] the request to use to clear an expectation
-    # @return [Object] the response from the clear action
-    def clear(request)
-      request = camelized_hash(HTTP_REQUEST => Request.new(symbolize_keys(request)))
-
-      logger.debug("Clearing expectation with request: #{request}")
-      logger.debug("URL: #{CLEAR_ENDPOINT}. Payload: #{request.to_hash}")
-
-      response = @base[CLEAR_ENDPOINT].put(request.to_json, content_type: :json)
-      logger.debug("Got clear response: #{response.code}")
-      parse_string_to_json(response)
-    end
-
-    # Reset the mock server clearing all expectations previously registered
-    # @return [Object] the response from the reset action
-    def reset
-      request = {}
-
-      logger.debug('Resetting mockserver')
-      logger.debug("URL: #{RESET_ENDPOINT}. Payload: #{request.to_hash}")
-
-      response = @base[RESET_ENDPOINT].put(request.to_json)
-      logger.debug("Got reset response: #{response.code}")
-      parse_string_to_json(response)
-    end
-
-    # Retrieve the list of requests that have been processed by the server
-    # @param request [Request] to filter requests
-    # @return [Object] the list of responses processed by the server
-    def retrieve(request = nil)
-      request = request ? camelized_hash(HTTP_REQUEST => Request.new(symbolize_keys(request))) : {}
-
-      logger.debug('Retrieving request list from mockserver')
-      logger.debug("URL: #{RETRIEVE_ENDPOINT}. Payload: #{request.to_hash}")
-
-      response = @base[RETRIEVE_ENDPOINT].put(request.to_json)
-      logger.debug("Got retrieve response: #{response.code}")
-      requests = Requests.new([])
-      parse_string_to_json(response.body).map { |result| requests << request_from_json(result) } unless response.empty?
-      requests.code = response.code
-      requests
-    end
-
-    # Request to dump logs to file
-    # @param java [Boolean] true to dump as Java code; false to dump as JSON
-    # @return [Object] the list of responses processed by the server
-    def dump_log(request = nil, java = false)
-      type_params = java ? '?type=java' : ''
-      url         = "#{DUMP_LOG_ENDPOINT}#{type_params}"
-      request     = request ? Request.new(symbolize_keys(request)) : {}
-
-      logger.debug('Sending dump log request to mockserver')
-      logger.debug("URL: #{url}. Payload: #{request.to_hash}")
-
-      response = @base[url].put(request.to_json)
-      logger.debug("Got dump to log response: #{response.code}")
-      parse_string_to_json(response)
-    end
-
-    # Verify that the given request is called the number of times expected
-    # @param request [Request] to filter requests
-    # @param times [Times] expected number of times
-    # @return [Object] the list of responses processed by the server that match the request
-    def verify(request, times = exactly(1))
-      logger.debug('Sending query for verify to mockserver')
-      results   = retrieve(request)
-
-      # Reusing the times model here so interpreting values here
-      times     = Times.new(symbolize_keys(times))
-      num_times = times.remaining_times
-      is_exact  = !times.unlimited
-
-      fulfilled = is_exact ? (num_times == results.size) : (num_times <= results.size)
-      fail "Expected request to be present: [#{num_times}] (#{is_exact ? 'exactly' : 'at least'}). But found: [#{results.size}]" unless fulfilled
-      results
-    end
-  end
-end

data/lib/mockserver/mock_server_client.rb

@@ -1,46 +0,0 @@
-# encoding: UTF-8
-require_relative './model/expectation'
-require_relative './abstract_client'
-require_relative './utility_methods'
-
-#
-# The client used to interact with the mock server.
-# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
-#
-module MockServer
-  EXPECTATION_ENDPOINT = '/expectation'
-
-  # The client used to interact with the mock server.
-  class MockServerClient < AbstractClient
-    include Model
-    include UtilityMethods
-
-    # Registers an expectation with the mockserver
-    # @param expectation [Expectation] the expectation to create the request from
-    # @return [Object] the response from the register action
-    def register(expectation)
-      fail 'Expectation passed in is not valid type' unless expectation.is_a?(Expectation)
-      request = create_expectation_request(expectation)
-
-      logger.debug('Registering new expectation')
-      logger.debug("URL: #{EXPECTATION_ENDPOINT} Payload: #{request.to_hash}")
-
-      response = @base[EXPECTATION_ENDPOINT].put(request.to_json, content_type: :json)
-      logger.debug("Got register response: #{response.code}")
-      parse_string_to_json(response)
-    end
-
-    private
-
-    # Create an expecation request to send to the expectation endpoint of
-    # @param expectation [Expectation] the expectation  to create the request from
-    # @return [Hash] a hash representing the request to use in registering an expectation with the mock server
-    # rubocop:disable Lint/LiteralInInterpolation
-    def create_expectation_request(expectation)
-      expectation_request = camelized_hash(expectation)
-      logger.debug("Expectation JSON: #{expectation_request.to_json}")
-      fail "You can only set either of #{[HTTP_RESPONSE, HTTP_FORWARD]}. But not both" if expectation_request[HTTP_RESPONSE] && expectation_request[HTTP_FORWARD]
-      expectation_request
-    end
-  end
-end