Merge pull request #1 from karaggeorge/add-support-for-body-types

Add support for other Body types

Author: jamesdbloom

.rubocop.yml

@@ -1,7 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - Rakefile
+  Exclude:
+    - Gemfile
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
 Style/LineLength:
   Max: 180
 Style/ClassAndModuleChildren:
   EnforcedStyle: compact
 Style/FileName:
   Exclude:
     - '**/mockserver-client.rb'
+    - 'mockserver-client.gemspec'

.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3
+script:
+  - bundle exec rubocop
+  - ./build.sh

Rakefile

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: UTF-8
+
 require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
 require 'rspec/core/rake_task'

lib/cli.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'thor'
 require 'colorize'
 require_relative './mockserver-client'
@@ -88,7 +90,7 @@ class MockServerCLI < Thor
   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
+      puts "RESULT:\n".bold + result.to_json.green
     end
   end
 

lib/mockserver-client.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require_relative './mockserver/version'
 require_relative './mockserver/mock_server_client'
 require_relative './mockserver/proxy_client'
@@ -7,6 +9,7 @@
 require 'json/pure'
 
 # To fix serialization bugs. See: http://prettystatemachine.blogspot.com/2010/09/typeerrors-in-tojson-make-me-briefly.html
+# rubocop:disable Lint/UnifiedInteger
 class Fixnum
   def to_json(_)
     to_s

lib/mockserver/abstract_client.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'rest-client'
 require 'logging_factory'
 require_relative './model/times'
@@ -24,8 +26,8 @@ class AbstractClient
     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
+      raise 'Cannot instantiate AbstractClient class. You must subclass it.' if self.class == AbstractClient
+      raise 'Host/port must not be nil' unless host && port
       protocol = ('https' if port == 443) || 'http'
       @base   = RestClient::Resource.new("#{protocol}://#{host}:#{port}", headers: { 'Content-Type' => 'application/json' })
       @logger = ::LoggingFactory::DEFAULT_FACTORY.log(self.class)
@@ -34,7 +36,7 @@ def initialize(host, port)
     # 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)
+    def clear(request) # rubocop:disable Metrics/AbcSize
       request = camelized_hash(HTTP_REQUEST => Request.new(symbolize_keys(request)))
 
       logger.debug("Clearing expectation with request: #{request}")
@@ -61,7 +63,7 @@ def reset
     # 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)
+    def retrieve(request = nil) # rubocop:disable Metrics/AbcSize
       request = request ? camelized_hash(HTTP_REQUEST => Request.new(symbolize_keys(request))) : {}
 
       logger.debug('Retrieving request list from mockserver')
@@ -95,7 +97,7 @@ def dump_log(request = nil, java = false)
     # @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))
+    def verify(request, times = exactly(1)) # rubocop:disable Metrics/AbcSize
       logger.debug('Sending query for verify to mockserver')
       results   = retrieve(request)
 
@@ -105,7 +107,7 @@ def verify(request, times = exactly(1))
       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
+      raise "Expected request to be present: [#{num_times}] (#{is_exact ? 'exactly' : 'at least'}). But found: [#{results.size}]" unless fulfilled
       results
     end
   end

lib/mockserver/mock_server_client.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require_relative './model/expectation'
 require_relative './abstract_client'
 require_relative './utility_methods'
@@ -18,8 +20,8 @@ class MockServerClient < AbstractClient
     # 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)
+    def register(expectation) # rubocop:disable Metrics/AbcSize
+      raise 'Expectation passed in is not valid type' unless expectation.is_a?(Expectation)
       request = create_expectation_request(expectation)
 
       logger.debug('Registering new expectation')
@@ -35,11 +37,10 @@ def register(expectation)
     # 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]
+      raise "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

lib/mockserver/model/array_of.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: UTF-8
+
 #
 # The ArrayOf class stores instances of a given class only.
 # It enforces this by intercepting the methods :<<, :[]= and :insert on the Array class
@@ -15,9 +17,9 @@ module MockServer::Model
 
   # The ArrayOf class stores instances of a given class only.
   class ArrayOf < Array
-    alias_method :add_element, :<<
-    alias_method :set_element, :[]=
-    alias_method :insert_element, :insert
+    alias add_element <<
+    alias set_element []=
+    alias insert_element insert
 
     # Create an array from the elements passed in
     def initialize(items)
@@ -28,7 +30,7 @@ def initialize(items)
 
     # The class/type that this array stores
     def child_class
-      fail 'Subclass should override method :child_class'
+      raise 'Subclass should override method :child_class'
     end
 
     # Add the item to the array
@@ -75,7 +77,7 @@ def convert_to_child_class(item)
       if item && item.class != child_class
         begin
           item = child_class.new(item)
-        rescue Exception => e # rubocop:disable Lint/RescueException
+        rescue StandardError => e
           raise "Failed to convert element: #{item} to required type #{child_class}. Error: #{e.message}"
         end
       end

lib/mockserver/model/body.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'hashie'
 require_relative './parameter'
 require_relative './enum'
@@ -11,7 +13,7 @@ module MockServer::Model
   # An enum for body type
   class BodyType < SymbolizedEnum
     def allowed_values
-      [:STRING, :REGEX, :XPATH, :PARAMETERS, :BINARY]
+      [:STRING, :REGEX, :XPATH, :PARAMETERS, :BINARY, :JSON, :JSON_SCHEMA, :XML_SCHEMA]
     end
   end
 
@@ -41,6 +43,18 @@ def exact(value)
       Body.new(type: :STRING, value: value)
     end
 
+    def json(value)
+      Body.new(type: :JSON, value: value)
+    end
+
+    def json_schema(value)
+      Body.new(type: :JSON_SCHEMA, value: value)
+    end
+
+    def xml_schema(value)
+      Body.new(type: :XML_SCHEMA, value: value)
+    end
+
     def regex(value)
       Body.new(type: :REGEX, value: value)
     end

lib/mockserver/model/cookie.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'hashie'
 require_relative './array_of'
 

lib/mockserver/model/delay.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require_relative './enum'
 
 #

lib/mockserver/model/enum.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 #
 # A class to model a Java-like Enum.
 # To create an Enum extend this class and override :allowed_values method with allowed enum values.
@@ -13,13 +15,13 @@ class Enum
     # @raise [Exception] if the supplied value is not valid for this enum
     def initialize(supplied_value)
       supplied_value = pre_process_value(supplied_value)
-      fail "Supplied value: #{supplied_value} is not valid. Allowed values are: #{allowed_values.inspect}" unless allowed_values.include?(supplied_value)
+      raise "Supplied value: #{supplied_value} is not valid. Allowed values are: #{allowed_values.inspect}" unless allowed_values.include?(supplied_value)
       @value = supplied_value
     end
 
     # @return [Array] a list of values allowed by this enum
     def allowed_values
-      fail 'Override :allowed_values in Enum class'
+      raise 'Override :allowed_values in Enum class'
     end
 
     # A pre-process hook for a value before it is stored

lib/mockserver/model/expectation.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require_relative './array_of'
 require_relative './request'
 require_relative './response'

lib/mockserver/model/forward.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'hashie'
 require_relative './enum'
 
@@ -36,6 +38,6 @@ def forward(&_)
       obj
     end
 
-    alias_method :http_forward, :forward
+    alias :http_forward forward
   end
 end

lib/mockserver/model/header.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'hashie'
 require_relative './array_of'
 

lib/mockserver/model/parameter.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'hashie'
 require_relative './array_of'
 

lib/mockserver/model/request.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'hashie'
 require_relative './parameter'
 require_relative './header'
@@ -24,8 +26,6 @@ class Request < Hashie::Trash
     include Hashie::Extensions::IgnoreUndeclared
     include Hashie::Extensions::Coercion
 
-    ALLOWED_METHODS = [:GET, :POST, :PUT, :DELETE, :PATCH]
-
     property :method, required: true, default: :GET
     property :path, required: true, default: ''
     property :query_string_parameters, default: Parameters.new([])
@@ -77,14 +77,14 @@ def request_from_json(payload)
       body = payload['body']
 
       if body && body.is_a?(String)
-        payload.merge!('body' => { 'type' => :STRING, 'value' => body })
+        payload['body'] = { 'type' => :STRING, 'value' => body }
       end
 
       request = Request.new(symbolize_keys(payload))
       yield request if block_given?
       request
     end
 
-    alias_method :http_request, :request
+    alias http_request request
   end
 end

lib/mockserver/model/response.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require_relative './body'
 require_relative './delay'
 require_relative './header'
@@ -40,6 +42,6 @@ def decode(string)
       Base64.decode64(string)
     end
 
-    alias_method :http_response, :response
+    alias http_response response
   end
 end

lib/mockserver/model/times.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'hashie'
 require_relative './enum'
 

lib/mockserver/proxy_client.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require_relative './abstract_client'
 
 #

lib/mockserver/utility_methods.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 require 'active_support/inflector'
 require 'json'
 
@@ -12,8 +14,7 @@ module MockServer::UtilityMethods
   # - camelize the keys of the hash
   # @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
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
   def camelized_hash(obj)
     obj = obj && obj.respond_to?(:to_hash) ? obj.to_hash : obj
 

lib/mockserver/version.rb

@@ -1,4 +1,6 @@
 # encoding: UTF-8
+# frozen_string_literal: true
+
 # Version for this gem
 module MockServer
   VERSION = '1.0.8.pre'