mockserver-client 0.0.3 → 1.0.0.pre

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MDRhZTQwOTYwOTZjZjQ3ZThlNWFlZTk0NjIwMjIzZjUwMzRiY2UxMA==
-  data.tar.gz: !binary |-
-    MGM5MWMyZWYzYzJjZTU5Y2NjZDhiNjM2YWI0OWM1MTU4ZWE1OWYzNg==
+SHA1:
+  metadata.gz: 6549161ca51a971fc321ebe5da63c14212c53c0d
+  data.tar.gz: b89a79a7b67637194d00714c33e186f41344695d
 SHA512:
-  metadata.gz: !binary |-
-    NzlmZDZlYTcyMzQ0YWFkOWViMmI0ZmFlZDgwODdmM2ZhM2QyYWIwZWRkYThj
-    MmU2YzkyNDEyZDI3NWZiN2NkNjc1Mzk5NGJhYmI1ZTU3YTdiYmEzYTI3NzM5
-    ZGEwMWRkYWUwYWQ2MjQwZjM0YWUwZTQ4MWUzOWYxMTc4MGVmMmQ=
-  data.tar.gz: !binary |-
-    MzljZWQ0MjNkMGJiOGFkMjM1N2FlM2MzYjczOWQxODZlOGJhYWFmODg4NDg3
-    MjBlMmYyMGI2NGI3ZTA0MjdhNWNhMDUxN2QwYTZmOTBmODI4NWZhZjA1ZDUz
-    NGRjYzhjOGRmN2VlNGQ1YWMxMGEzNjk2NTEwMjg2MGNlZjQ1YzQ=
+  metadata.gz: 5ab50f696abe0df060f1059ed6365b6b27e7648d4fb7d37e998c97e7c02080b95637de7d8c0aaadd60e65e4c9d7d4e690a6d6475691d563229d8de108725694f
+  data.tar.gz: 4a196fa9b3357f2c97ff2ccfe8e705c8892f801a8e9c866bcce8f5c8491e184fabd625462d51607ecd38adba4122c1242f1957ccbad763fdc1532642910cad6c

data/.rubocop.yml

@@ -2,12 +2,6 @@ Style/LineLength:
   Max: 180
 Style/ClassAndModuleChildren:
   EnforcedStyle: compact
-Style/CyclomaticComplexity:
-  Enabled: false
-Lint/LiteralInInterpolation:
-  Enabled: false
-Style/MethodLength:
-  Enabled: false
 Style/FileName:
   Exclude:
     - '**/mockserver-client.rb'

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### Version 0.0.1
+ - Basic code.
+
+### Version 0.0.2
+ - CLI for this gem.
+
+### Version 0.0.3
+ - Changes responses returned from /retrieve and /verify to be Ruby models.
+
+### Version 1.0.0
+ - Merged ruby client fully into main MockServer build on master.

data/README.md

@@ -1,22 +1,26 @@
 # Mockserver Client
 
-[![Build Status](https://travis-ci.org/nayyara-samuel/mockserver-client.svg?branch=master)](https://travis-ci.org/nayyara-samuel/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.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'mockserver-client'
+```ruby
+gem 'mockserver-client'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install mockserver-client
+```bash
+gem install mockserver-client
+```
 
 ## Usage
 
@@ -30,8 +34,8 @@ include MockServer::Model::DSL
 ### Create Expectations
 
 ##### Java
-```java
 
+```java
 new MockServerClient("localhost", 9999)
         .when(
                 request()
@@ -61,7 +65,6 @@ new MockServerClient("localhost", 9999)
 ##### Ruby
 
 ```ruby
-
 client = MockServerClient.new('localhost', 9999)
 expectation = expectation do |expectation|
      expectation.request do |request|
@@ -122,7 +125,6 @@ new ProxyClient("localhost", 9090).verify(
 ##### Ruby
 
 ```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'}")
@@ -144,6 +146,7 @@ new ProxyClient("localhost", 9090).dumpToLogAsJava(
 ```
 
 ##### Ruby
+
 ```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)
@@ -194,7 +197,7 @@ Getter methods for `request`, `response` and `forward` methods will optionally a
 
 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: 
@@ -216,7 +219,7 @@ Options:
 
 To get help for an individual command, e.g. `dump_log`, you would do:
 
-```
+```bash
 mockserver --help dump_log
 
 Usage:
@@ -235,7 +238,7 @@ 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:
@@ -248,11 +251,10 @@ Running with parameters:
 [2014-06-21 09:23:32] DEBUG [MockServerClient] Got dump to log response: 202
 ```
 
-## Contributing
+# Issues
+
+If you have any problems, please [check the project issues](https://github.com/jamesdbloom/mockserver/issues?state=open).
+
+# Contributions
 
-1. Fork it ( https://github.com/[my-github-username]/mockserver-client/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
-6. **IMPORTANT**: Keep code coverage high. Preferably above 95%. This project uses SimpleCov for code coverage which reports percentage coverage.
+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.

data/lib/cli.rb

@@ -23,7 +23,7 @@ module CLIHelpers
   # @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        = MockServerClient.new(options.host, options.port)
     client.logger = LOGGER
     client
   end
@@ -32,7 +32,7 @@ module CLIHelpers
   # @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        = ProxyClient.new(options.host, options.port)
     client.logger = LOGGER
     client
   end
@@ -96,7 +96,7 @@ class MockServerCLI < Thor
 
   def register
     execute_command(true, true) do |client, options|
-      payload = read_file(options.data)
+      payload          = read_file(options.data)
       mock_expectation = expectation do |expectation|
         expectation.populate_from_payload(payload)
       end
@@ -135,9 +135,9 @@ class MockServerCLI < Thor
 
   def verify
     execute_command(false, true) do |client, _|
-      payload = read_file(options.data)
+      payload      = read_file(options.data)
       mock_request = payload[HTTP_REQUEST]
-      mock_times = payload[HTTP_TIMES]
+      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)

data/lib/mockserver/abstract_client.rb

@@ -10,8 +10,8 @@ require_relative './utility_methods'
 # @author Nayyara Samuel(mailto: nayyara.samuel@opower.com)
 #
 module MockServer
-  RESET_ENDPOINT = '/reset'
-  CLEAR_ENDPOINT = '/clear'
+  RESET_ENDPOINT    = '/reset'
+  CLEAR_ENDPOINT    = '/clear'
   RETRIEVE_ENDPOINT = '/retrieve'
   DUMP_LOG_ENDPOINT = '/dumpToLog'
 
@@ -26,7 +26,7 @@ module MockServer
     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}")
+      @base   = RestClient::Resource.new("http://#{host}:#{port}")
       @logger = ::LoggingFactory::DEFAULT_FACTORY.log(self.class)
     end
 
@@ -35,28 +35,26 @@ module MockServer
     # @return [Object] the response from the clear action
     def clear(request)
       request = camelized_hash(HTTP_REQUEST => Request.new(symbolize_keys(request)))
-      url = CLEAR_ENDPOINT
 
       logger.debug("Clearing expectation with request: #{request}")
-      logger.debug("URL: #{url}. Payload: #{request.to_hash}")
+      logger.debug("URL: #{CLEAR_ENDPOINT}. Payload: #{request.to_hash}")
 
-      response = @base[url].put(request.to_json, content_type: :json)
+      response = @base[CLEAR_ENDPOINT].put(request.to_json, content_type: :json)
       logger.debug("Got clear response: #{response.code}")
-      parse_response(response)
+      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 = {}
-      url = RESET_ENDPOINT
 
       logger.debug('Resetting mockserver')
-      logger.debug("URL: #{url}. Payload: #{request.to_hash}")
+      logger.debug("URL: #{RESET_ENDPOINT}. Payload: #{request.to_hash}")
 
-      response = @base[url].put(request.to_json)
+      response = @base[RESET_ENDPOINT].put(request.to_json)
       logger.debug("Got reset response: #{response.code}")
-      parse_response(response)
+      parse_string_to_json(response)
     end
 
     # Retrieve the list of requests that have been processed by the server
@@ -64,25 +62,17 @@ module MockServer
     # @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))) : {}
-      url = RETRIEVE_ENDPOINT
 
       logger.debug('Retrieving request list from mockserver')
-      logger.debug("URL: #{url}. Payload: #{request.to_hash}")
+      logger.debug("URL: #{RETRIEVE_ENDPOINT}. Payload: #{request.to_hash}")
 
       response = @base[RETRIEVE_ENDPOINT].put(request.to_json)
       logger.debug("Got retrieve response: #{response.code}")
-      results = parse_response(response)
-      mocks = Mocks.new([])
-      unless results.empty?
-        results.each do |result|
-          mock = Mock.new
-          mock.populate_from_payload(result)
-          mocks << mock
-        end
-      end
-      mocks.code = response.code
-
-      mocks
+      expectations = Expectations.new([])
+      parse_string_to_json(response).map { |result| expectations << expectation_from_json(result) } unless response.empty?
+      # expectations = Expectations.new([]).insert(0, (parse_string_to_json(response).map { |result| expectation_from_json(result) } unless response.empty?))
+      expectations.code = response.code
+      expectations
     end
 
     # Request to dump logs to file
@@ -90,15 +80,15 @@ module MockServer
     # @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)) : {}
+      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_response(response)
+      parse_string_to_json(response)
     end
 
     # Verify that the given request is called the number of times expected
@@ -107,12 +97,12 @@ module MockServer
     # @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)
+      results   = retrieve(request)
 
       # Reusing the times model here so interpreting values here
-      times = Times.new(symbolize_keys(times))
+      times     = Times.new(symbolize_keys(times))
       num_times = times.remaining_times
-      is_exact = !times.unlimited
+      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

data/lib/mockserver/mock_server_client.rb

@@ -20,15 +20,14 @@ module MockServer
     # @return [Object] the response from the register action
     def register(expectation)
       fail 'Expectation passed in is not valid type' unless expectation.is_a?(Expectation)
-      url = EXPECTATION_ENDPOINT
       request = create_expectation_request(expectation)
 
       logger.debug('Registering new expectation')
-      logger.debug("URL: #{url} Payload: #{request.to_hash}")
+      logger.debug("URL: #{EXPECTATION_ENDPOINT} Payload: #{request.to_hash}")
 
-      response = @base[url].put(request.to_json, content_type: :json)
+      response = @base[EXPECTATION_ENDPOINT].put(request.to_json, content_type: :json)
       logger.debug("Got register response: #{response.code}")
-      parse_response(response)
+      parse_string_to_json(response)
     end
 
     private
@@ -36,6 +35,7 @@ module MockServer
     # 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}")

data/lib/mockserver/model/expectation.rb

@@ -1,10 +1,11 @@
 # encoding: UTF-8
+require_relative './array_of'
 require_relative './request'
 require_relative './response'
 require_relative './forward'
 require_relative './times'
 require_relative '../utility_methods'
-require_relative './mock'
+
 #
 # A class to model an expectation sent to the Mockserver instance.
 # See http://www.mock-server.com/#create-expectations for details.
@@ -12,15 +13,111 @@ require_relative './mock'
 # @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
 #
 module MockServer
-  HTTP_REQUEST = 'httpRequest'
-  HTTP_RESPONSE = 'httpResponse'
-  HTTP_FORWARD = 'httpForward'
-  HTTP_TIMES = 'times'
+  HTTP_REQUEST  = 'httpRequest' unless const_defined?(:HTTP_REQUEST)
+  HTTP_RESPONSE = 'httpResponse' unless const_defined?(:HTTP_RESPONSE)
+  HTTP_FORWARD  = 'httpForward' unless const_defined?(:HTTP_FORWARD)
+  HTTP_TIMES    = 'times' unless const_defined?(:HTTP_TIMES)
 
   # Models
   module Model
     # Expectation model
-    class Expectation < Mock
+    class Expectation
+      include MockServer::UtilityMethods
+      attr_accessor :times
+
+      # Creates an expectation from a hash
+      # @param payload [Hash] a hash representation of the expectation
+      def populate_from_payload(payload)
+        @request = payload[MockServer::HTTP_REQUEST]
+        @request = Request.new(symbolize_keys(@request)) if @request
+
+        @response = payload[MockServer::HTTP_RESPONSE]
+        @response = Response.new(symbolize_keys(@response)) if @response
+
+        @forward = payload[MockServer::HTTP_FORWARD]
+        @forward = Forward.new(symbolize_keys(@forward)) if @forward
+
+        @times = payload[MockServer::HTTP_TIMES]
+        @times = Times.new(symbolize_keys(@times)) if @times
+      end
+
+      # Method to setup the request on the expectation object
+      # @yieldparam [Request] the request that this expectation references
+      # @return [Expectation] this object according to the  the builder pattern
+      def request(&_)
+        if block_given?
+          @request ||= Request.new
+          yield @request
+        end
+        @request
+      end
+
+      # Method to setup the response on the expectation object
+      # @yieldparam [Response] the response that this expectation references
+      # @return [Expectation] this object according to the  the builder pattern
+      def response(&_)
+        if block_given?
+          @response ||= Response.new
+          yield @response
+        end
+        @response
+      end
+
+      # Method to setup the request on the expectation object
+      # @yieldparam [Forward] the forward object that this expectation references
+      # @return [Expectation] this object according to the  the builder pattern
+      def forward(&_)
+        if block_given?
+          @forward ||= Forward.new
+          yield @forward
+        end
+        @forward
+      end
+
+      # Setter for request
+      # @param request [Request] a request object
+      def request=(request)
+        @request = Request.new(request)
+      end
+
+      # Setter for response
+      # @param response [Response] a response object
+      def response=(response)
+        @response = Response.new(response)
+      end
+
+      # Setter for forward
+      # @param forward [Forward] a forward object
+      def forward=(forward)
+        @forward = Forward.new(forward)
+      end
+
+      # Override to_json method
+      # @return [String] the json representation for this object
+      def to_json(*p)
+        to_hash.to_json(*p)
+      end
+
+      # Convert to hash
+      # @return [Hash] the hash representation for this object
+      def to_hash
+        {
+          MockServer::HTTP_REQUEST  => @request,
+          MockServer::HTTP_RESPONSE => @response,
+          MockServer::HTTP_FORWARD  => @forward,
+          MockServer::HTTP_TIMES    => @times
+        }
+      end
+    end
+
+    # Class to store a list of mocks - useful for modeling retrieve endpoint result
+    class Expectations < ArrayOf
+      # Code is used to store HTTP status code returned from retrieve endpoint
+      attr_accessor :code
+
+      def child_class
+        Expectation
+      end
     end
 
     # DSL method for creating expectation
@@ -30,6 +127,13 @@ module MockServer
         yield expectation if block_given?
         expectation
       end
+
+      def expectation_from_json(payload)
+        expectation = Expectation.new
+        yield expectation if block_given?
+        expectation.populate_from_payload(payload)
+        expectation
+      end
     end
   end
 end

data/lib/mockserver/utility_methods.rb

@@ -10,14 +10,16 @@ module MockServer::UtilityMethods
   # Does the following filter/transform operations on a hash
   # - exclude null or empty valued keys from the hash
   # - camelize the keys of the hash
-  # @param hash [Object] an object which will be used to create the hash. Must support :to_hash method
+  # @param obj [Object] an object which will be used to create the hash. Must support :to_hash method
   # @return [Hash] the transformed hash
+  # rubocop:disable Style/MethodLength
+  # rubocop:disable Style/CyclomaticComplexity
   def camelized_hash(obj)
     obj = obj && obj.respond_to?(:to_hash) ? obj.to_hash : obj
 
     if obj.is_a?(Hash)
       obj.each_with_object({}) do |(k, v), acc|
-        is_empty = v.nil? || (v.respond_to?(:empty?) ? v.empty? : false)
+        is_empty         = v.nil? || (v.respond_to?(:empty?) ? v.empty? : false)
         acc[camelize(k)] = camelized_hash(v) unless is_empty
       end
     elsif obj.respond_to?(:map)
@@ -40,7 +42,7 @@ module MockServer::UtilityMethods
     end
   end
 
-  # @param [Object] an object to camelize the string representation of
+  # @param str [Object] an object to camelize the string representation of
   # @return [String] the string converted to camelcase with first letter in lower case
   def camelize(str)
     str.to_s.camelize(:lower)
@@ -49,7 +51,7 @@ module MockServer::UtilityMethods
   # Parse string response into JSON
   # @param response [Response] from RestClient response
   # @return [Hash] the parsed response or the object unmodified if parsing is not possible
-  def parse_response(response)
+  def parse_string_to_json(response)
     JSON.parse(response)
   rescue JSON::ParserError
     response

data/lib/mockserver/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 # Version for this gem
 module MockServer
-  VERSION = '0.0.3'
+  VERSION = '1.0.0.pre'
 end

data/mockserver-client.gemspec

@@ -4,30 +4,34 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'mockserver/version'
 
 Gem::Specification.new do |spec|
-  spec.name = 'mockserver-client'
-  spec.version = MockServer::VERSION
-  spec.authors = ['Nayyara Samuel']
-  spec.email = ['nayyara.samuel@opower.com']
-  spec.summary = %q(A Ruby client for MockServer)
-  spec.required_ruby_version = '~> 1.9.3'
+  spec.name        = 'mockserver-client'
+  spec.version     = MockServer::VERSION
+  spec.authors     = ['Nayyara Samuel', 'James D Bloom']
+  spec.email       = ['nayyara.samuel@opower.com', 'jamesdbloom@gmail.com']
+  spec.homepage    = 'http://www.mock-server.com'
+  spec.summary     = 'A Ruby client for MockServer'
+  spec.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)'
 
-  spec.files = `git ls-files -z`.split("\x0")
-  spec.executables = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files = spec.files.grep(/^(test|spec|features)\//)
+  spec.required_ruby_version     = '>= 1.9'
+  spec.required_rubygems_version = '~> 1'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake', '~> 10.3.2'
-  spec.add_development_dependency 'rspec', '~> 3.0.0'
-  spec.add_development_dependency 'simplecov', '~> 0.8.2'
-  spec.add_development_dependency 'webmock', '~> 1.18'
-  spec.add_development_dependency 'rubocop', '~> 0.23.0'
+  spec.add_development_dependency 'bundler', '~> 1'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'simplecov', '~> 0'
+  spec.add_development_dependency 'webmock', '~> 1'
+  spec.add_development_dependency 'rubocop', '~> 0'
 
-  spec.add_dependency 'hashie', '~> 3.0'
-  spec.add_dependency 'json', '~> 1.8.1'
-  spec.add_dependency 'activesupport', '~> 4.1.1'
-  spec.add_dependency 'rest-client', '~> 1.6.7'
-  spec.add_dependency 'logging_factory', '~> 0.0.2'
-  spec.add_dependency 'thor', '~> 0.19.1'
-  spec.add_dependency 'colorize', '~> 0.7.0'
+  spec.add_dependency 'hashie', '~> 3'
+  spec.add_dependency 'json', '~> 1'
+  spec.add_dependency 'activesupport', '~> 4'
+  spec.add_dependency 'rest-client', '~> 1'
+  spec.add_dependency 'logging_factory', '~> 0'
+  spec.add_dependency 'thor', '~> 0'
+  spec.add_dependency 'colorize', '~> 0'
 end

data/pom.xml

@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>mockserver</artifactId>
+        <groupId>org.mock-server</groupId>
+        <version>3.4-SNAPSHOT</version>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>mockserver-client-ruby</artifactId>
+    <name>MockServer Ruby Client</name>
+    <description>A ruby client for the MockServer</description>
+    <url>http://www.mock-server.com</url>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>exec-maven-plugin</artifactId>
+                <version>1.2.1</version>
+                <executions>
+                    <execution>
+                        <id>bundle_install</id>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>exec</goal>
+                        </goals>
+                        <configuration>
+                            <executable>bundle</executable>
+                            <arguments>
+                                <argument>install</argument>
+                            </arguments>
+                            <environmentVariables>
+                                <BUNDLE_GEMFILE>${basedir}/Gemfile</BUNDLE_GEMFILE>
+                            </environmentVariables>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>ruby_make</id>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>exec</goal>
+                        </goals>
+                        <configuration>
+                            <executable>bundle</executable>
+                            <arguments>
+                                <argument>exec</argument>
+                                <argument>rake</argument>
+                                <argument>build</argument>
+                            </arguments>
+                            <environmentVariables>
+                                <BUNDLE_GEMFILE>${basedir}/Gemfile</BUNDLE_GEMFILE>
+                            </environmentVariables>
+                        </configuration>
+                    </execution>
+                    <!-- TODO setup release permissions to https://rubygems.org/gems/mockserver-client -->
+                    <!--<execution>-->
+                        <!--<id>ruby_release</id>-->
+                        <!--<phase>deploy</phase>-->
+                        <!--<goals>-->
+                            <!--<goal>exec</goal>-->
+                        <!--</goals>-->
+                        <!--<configuration>-->
+                            <!--<executable>bundle</executable>-->
+                            <!--<arguments>-->
+                                <!--<argument>exec</argument>-->
+                                <!--<argument>rake</argument>-->
+                                <!--<argument>release</argument>-->
+                            <!--</arguments>-->
+                            <!--<environmentVariables>-->
+                                <!--<BUNDLE_GEMFILE>${basedir}/Gemfile</BUNDLE_GEMFILE>-->
+                            <!--</environmentVariables>-->
+                        <!--</configuration>-->
+                    <!--</execution>-->
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

data/spec/mockserver/builder_spec.rb

@@ -4,29 +4,29 @@ require_relative '../spec_helper'
 describe MockServer::Model::DSL do
 
   it 'generates http requests correctly' do
-    mock_request = http_request(:POST, '/login')
+    mock_request                  = http_request(:POST, '/login')
     mock_request.query_parameters = [parameter('returnUrl', '/account')]
-    mock_request.cookies = [cookie('sessionId', '2By8LOhBmaW5nZXJwcmludCIlMDAzMW')]
-    mock_request.body = exact("{username:'foo', password:'bar'}")
+    mock_request.cookies          = [cookie('sessionId', '2By8LOhBmaW5nZXJwcmludCIlMDAzMW')]
+    mock_request.body             = exact("{username:'foo', password:'bar'}")
 
     expect(to_camelized_hash(HTTP_REQUEST => mock_request)).to eq(FIXTURES.read('post_login_request.json'))
 
     # Block style
     mock_request = request(:POST, '/login') do |request|
       request.query_parameters = [parameter('returnUrl', '/account')]
-      request.cookies = [cookie('sessionId', '2By8LOhBmaW5nZXJwcmludCIlMDAzMW')]
-      request.body = exact("{username:'foo', password:'bar'}")
+      request.cookies          = [cookie('sessionId', '2By8LOhBmaW5nZXJwcmludCIlMDAzMW')]
+      request.body             = exact("{username:'foo', password:'bar'}")
     end
 
     expect(to_camelized_hash(HTTP_REQUEST => mock_request)).to eq(FIXTURES.read('post_login_request.json'))
   end
 
   it 'generates http responses correctly' do
-    mock_response = http_response
+    mock_response             = http_response
     mock_response.status_code = 401
-    mock_response.headers = [header('Content-Type', 'application/json; charset=utf-8')]
+    mock_response.headers     = [header('Content-Type', 'application/json; charset=utf-8')]
     mock_response.headers << header('Cache-Control', 'public, max-age=86400')
-    mock_response.body = body('incorrect username and password combination')
+    mock_response.body  = body('incorrect username and password combination')
     mock_response.delay = delay_by(:SECONDS, 1)
 
     expect(to_camelized_hash(HTTP_RESPONSE => mock_response)).to eq(FIXTURES.read('incorrect_login_response.json'))
@@ -34,9 +34,9 @@ describe MockServer::Model::DSL do
     # Block style
     mock_response = response do |response|
       response.status_code = 401
-      response.headers = [header('Content-Type', 'application/json; charset=utf-8')]
+      response.headers     = [header('Content-Type', 'application/json; charset=utf-8')]
       response.headers << header('Cache-Control', 'public, max-age=86400')
-      response.body = body('incorrect username and password combination')
+      response.body  = body('incorrect username and password combination')
       response.delay = delay_by(:SECONDS, 1)
     end
 
@@ -44,7 +44,7 @@ describe MockServer::Model::DSL do
   end
 
   it 'generates http forwards correctly' do
-    mock_forward = http_forward
+    mock_forward      = http_forward
     mock_forward.host = 'www.mock-server.com'
     mock_forward.port = 80
 
@@ -70,9 +70,8 @@ describe MockServer::Model::DSL do
   end
 
   it 'generates expectation correctly from file' do
-    payload = FIXTURES.read('register_expectation.json')
-    mock_expectation = expectation
-    mock_expectation.populate_from_payload(payload)
+    payload          = FIXTURES.read('register_expectation.json')
+    mock_expectation = expectation_from_json(payload)
 
     expect(to_camelized_hash(mock_expectation.to_hash)).to eq(payload)
   end

data/spec/mockserver/mock_client_spec.rb

@@ -22,7 +22,7 @@ describe MockServer::MockServerClient do
     mock_expectation = expectation do |expectation|
       expectation.request do |request|
         request.method = 'POST'
-        request.path = '/login'
+        request.path   = '/login'
         request.query_parameters << parameter('returnUrl', '/account')
         request.cookies << cookie('sessionId', '2By8LOhBmaW5nZXJwcmludCIlMDAzMW')
         request.body = exact({ username: 'foo', password: 'bar' }.to_json)
@@ -32,7 +32,7 @@ describe MockServer::MockServerClient do
         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' }.to_json)
+        response.body  = body({ message: 'incorrect username and password combination' }.to_json)
         response.delay = delay_by(:SECONDS, 1)
       end
 
@@ -47,7 +47,7 @@ describe MockServer::MockServerClient do
     mock_expectation = expectation do |expectation|
       expectation.request do |request|
         request.method = 'POST'
-        request.path = '/login'
+        request.path   = '/login'
       end
 
       expectation.response do |response|

data/spec/mockserver/proxy_client_spec.rb

@@ -14,7 +14,7 @@ describe MockServer::ProxyClient do
 
     # Stub requests
     stub_request(:put, /.+\/retrieve/).with(body: search_request_json).to_return(
-      body: "[#{register_expectation_json}, #{register_expectation_json}]",
+      body:   "[#{register_expectation_json}, #{register_expectation_json}]",
       status: 200
     )
     stub_request(:put, /.+\/dumpToLog$/).to_return(status: 202).once

metadata

@@ -1,208 +1,210 @@
 --- !ruby/object:Gem::Specification
 name: mockserver-client
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0.pre
 platform: ruby
 authors:
 - Nayyara Samuel
+- James D Bloom
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: logging_factory
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
-description: 
+        version: '0'
+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)
 email:
 - nayyara.samuel@opower.com
+- jamesdbloom@gmail.com
 executables:
 - mockserver
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
-- .travis.yml
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -217,7 +219,6 @@ files:
 - lib/mockserver/model/enum.rb
 - lib/mockserver/model/expectation.rb
 - lib/mockserver/model/forward.rb
-- lib/mockserver/model/mock.rb
 - lib/mockserver/model/parameter.rb
 - lib/mockserver/model/request.rb
 - lib/mockserver/model/response.rb
@@ -226,6 +227,7 @@ files:
 - lib/mockserver/utility_methods.rb
 - lib/mockserver/version.rb
 - mockserver-client.gemspec
+- pom.xml
 - spec/fixtures/forward_mockserver.json
 - spec/fixtures/incorrect_login_response.json
 - spec/fixtures/post_login_request.json
@@ -236,7 +238,7 @@ files:
 - spec/mockserver/mock_client_spec.rb
 - spec/mockserver/proxy_client_spec.rb
 - spec/spec_helper.rb
-homepage: 
+homepage: http://www.mock-server.com
 licenses: []
 metadata: {}
 post_install_message: 
@@ -245,14 +247,14 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2

data/.gitignore

@@ -1,23 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log
-tmp.log

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-script:
-  - bundle exec rake rubocop
-  - bundle exec rake spec
-  - bundle exec rake build

data/lib/mockserver/model/mock.rb

@@ -1,123 +0,0 @@
-# encoding: UTF-8
-require_relative './array_of'
-require_relative './request'
-require_relative './response'
-require_relative './forward'
-require_relative './times'
-require_relative '../utility_methods'
-
-#
-# A class to model a mock object used to create and retrieve mock requests.
-# See http://www.mock-server.com/#create-expectations for details.
-#
-# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
-#
-module MockServer
-  HTTP_REQUEST = 'httpRequest'
-  HTTP_RESPONSE = 'httpResponse'
-  HTTP_FORWARD = 'httpForward'
-  HTTP_TIMES = 'times'
-
-  # Models
-  module Model # rubocop:disable Style/ClassAndModuleChildren
-    # Mock object model
-    class Mock
-      include MockServer::UtilityMethods
-      attr_accessor :times
-
-      # Creates an expectation from a hash
-      # @param payload [Hash] a hash representation of the expectation
-      def populate_from_payload(payload)
-        @request = payload[MockServer::HTTP_REQUEST]
-        @request = Request.new(symbolize_keys(@request)) if @request
-
-        @response = payload[MockServer::HTTP_RESPONSE]
-        @response = Response.new(symbolize_keys(@response)) if @response
-
-        @forward = payload[MockServer::HTTP_FORWARD]
-        @forward = Forward.new(symbolize_keys(@forward)) if @forward
-
-        @times = payload[MockServer::HTTP_TIMES]
-        @times = Times.new(symbolize_keys(@times)) if @times
-      end
-
-      # Method to setup the request on the expectation object
-      # @yieldparam [Request] the request that this expectation references
-      # @return [Expectation] this object according to the  the builder pattern
-      def request(&_)
-        if block_given?
-          @request ||= Request.new
-          yield @request
-        end
-        @request
-      end
-
-      # Method to setup the response on the expectation object
-      # @yieldparam [Response] the response that this expectation references
-      # @return [Expectation] this object according to the  the builder pattern
-      def response(&_)
-        if block_given?
-          @response ||= Response.new
-          yield @response
-        end
-        @response
-      end
-
-      # Method to setup the request on the expectation object
-      # @yieldparam [Forward] the forward object that this expectation references
-      # @return [Expectation] this object according to the  the builder pattern
-      def forward(&_)
-        if block_given?
-          @forward ||= Forward.new
-          yield @forward
-        end
-        @forward
-      end
-
-      # Setter for request
-      # @param request [Request] a request object
-      def request=(request)
-        @request = Request.new(request)
-      end
-
-      # Setter for response
-      # @param response [Response] a response object
-      def response=(response)
-        @response = Response.new(response)
-      end
-
-      # Setter for forward
-      # @param forward [Forward] a forward object
-      def forward=(forward)
-        @forward = Forward.new(forward)
-      end
-
-      # Override to_json method
-      # @return [String] the json representation for this object
-      def to_json(*p)
-        to_hash.to_json(*p)
-      end
-
-      # Convert to hash
-      # @return [Hash] the hash representation for this object
-      def to_hash
-        {
-          MockServer::HTTP_REQUEST => @request,
-          MockServer::HTTP_RESPONSE => @response,
-          MockServer::HTTP_FORWARD => @forward,
-          MockServer::HTTP_TIMES => @times
-        }
-      end
-    end
-
-    # Class to store a list of mocks - useful for modeling retrieve endpoint result
-    class Mocks < ArrayOf
-      # Code is used to store HTTP status code returned from retrieve endpoint
-      attr_accessor :code
-
-      def child_class
-        Mock
-      end
-    end
-  end
-end