mockserver-client 0.0.1

data/lib/mockserver/model/array_of.rb

@@ -0,0 +1,85 @@
+# 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
+# and casts objects to the allowed type first. To use in your code, create a subclass of ArrayOf and override the child_class() method to return
+# the class associated with the array.
+#
+# NOTE: You should use this class internally with the contract that you only call :<<. :[]= and :insert method
+# to manipulate the array in use. Can easily be changed to have stricter rules, suffices for internal use in this gem.
+#
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  DEFAULT_MISSING_INDEX = -1_000_000_000
+
+  # 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
+
+    # Create an array from the elements passed in
+    def initialize(items)
+      items.each do |item|
+        self << item
+      end
+    end
+
+    # The class/type that this array stores
+    def child_class
+      fail 'Subclass should override method :child_class'
+    end
+
+    # Add the item to the array
+    # @param item [Object] an item of the type/class supported by this array
+    # @raise [Exception] if the item cannot be converted to the allowed class
+    def <<(item)
+      add_element(convert_to_child_class(item))
+    end
+
+    # Set the given item at the index
+    # @param index [Integer] the index for the new element
+    # @param item [Object] an item of the type/class supported by this array
+    # @raise [Exception] if the item cannot be converted to the allowed class
+    def []=(index, item)
+      set_element(index, convert_to_child_class(item))
+    end
+
+    # Adds the given item at the index and shifts elements forward
+    # @param index [Integer] the index for the new element
+    # @param item [Object] an item of the type/class supported by this array
+    # @raise [Exception] if the item cannot be converted to the allowed class
+    def insert(index, item)
+      insert_element(index, convert_to_child_class(item))
+    end
+
+    # Method to set the element at the specified index.
+    # Will insert at index if there is another object at the index; otherwise will update.
+    # If the special DEFAULT_MISSING_INDEX value is given, will insert at the end.
+    # @param index [Integer] the index for the new element
+    # @param item [Object] an item of the type/class supported by this array
+    # @raise [Exception] if the item cannot be converted to the allowed class
+    def set(index, item)
+      if index == DEFAULT_MISSING_INDEX
+        self << item
+      elsif self[index]
+        insert(index, item)
+      else
+        self[index] = item
+      end
+    end
+
+    # Cast item to target class
+    def convert_to_child_class(item)
+      if item && item.class != child_class
+        begin
+          item = child_class.new(item)
+        rescue e
+          raise "Failed to convert element: #{item} to required type #{child_class}. Error: #{e.message}"
+        end
+      end
+      item
+    end
+  end
+end

data/lib/mockserver/model/body.rb

@@ -0,0 +1,56 @@
+# encoding: UTF-8
+require 'hashie'
+require_relative './parameter'
+require_relative './enum'
+
+#
+# A model for a a body in a request object.
+# @author: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # An enum for body type
+  class BodyType < SymbolizedEnum
+    def allowed_values
+      [:EXACT, :REGEX, :XPATH, :PARAMETERS]
+    end
+  end
+
+  # A model for a a body in a request object.
+  class Body < Hashie::Dash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :type, required: true
+    property :value
+    property :parameters
+
+    coerce_key :type, BodyType
+    coerce_key :value, String
+    coerce_key :parameters, Parameters
+  end
+
+  # DSL methods related to body
+  module DSL
+    # For response object where body can only be a string
+    def body(value)
+      value
+    end
+
+    def exact(value)
+      Body.new(type: :EXACT, value: value)
+    end
+
+    def regex(value)
+      Body.new(type: :REGEX, value: value)
+    end
+
+    def xpath(value)
+      Body.new(type: :XPATH, value: value)
+    end
+
+    def parameterized(*parameters)
+      Body.new(type: :PARAMETERS, parameters: parameters)
+    end
+  end
+end

data/lib/mockserver/model/delay.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+require_relative './enum'
+
+#
+# A model for a delay in a response.
+# @author: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # Enum for time unit
+  class TimeUnit < SymbolizedEnum
+    def allowed_values
+      [:NANOSECONDS, :MICROSECONDS, :MILLISECONDS, :SECONDS, :MINUTES, :HOURS, :DAYS]
+    end
+  end
+
+  # Model a delay object
+  class Delay < Hashie::Dash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :time_unit, default: 'SECONDS'
+    property :value, required: true
+
+    coerce_key :time_unit, TimeUnit
+  end
+
+  # DSL methods related to delay model
+  module DSL
+    def delay_by(time_unit, value)
+      Delay.new(time_unit: time_unit, value: value)
+    end
+  end
+end

data/lib/mockserver/model/enum.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+#
+# A class to model a Java-like Enum.
+# To create an Enum extend this class and override :allowed_values method with allowed enum values.
+#
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # Enum generic class
+  class Enum
+    # Create an instance of the enum from the value supplied
+    # @param supplied_value [Object] value used to create instance of an 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: #{supplied_value}" 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'
+    end
+
+    # A pre-process hook for a value before it is stored
+    # @param value [Object] a value used to instantiate the enum
+    # @return [Object] the processed value. By default, a no-op implementation.
+    def pre_process_value(value)
+      value
+    end
+
+    # Override this for JSON representation
+    def to_s
+      @value.to_s
+    end
+  end
+
+  # Subclass of Enum that has a list of symbols as allowed values.
+  class SymbolizedEnum < Enum
+    # Pre-process the value passed in and convert to a symbol
+    # @param value [Object] a value used to instantiate the enum
+    # @return [Symbol] a symbolized version of the value passed in (first calls to_s)
+    def pre_process_value(value)
+      value.to_s.to_sym
+    end
+  end
+end

data/lib/mockserver/model/expectation.rb

@@ -0,0 +1,60 @@
+# encoding: UTF-8
+require_relative './request'
+require_relative './response'
+require_relative './forward'
+require_relative './times'
+
+#
+# A class to model an expectation sent to the Mockserver instance.
+# See http://www.mock-server.com/#create-expectations for details.
+#
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # Expectation model
+  class Expectation
+    attr_accessor :times
+
+    # 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
+  end
+
+  # DSL methods related to expectation
+  module DSL
+    def expectation(&_)
+      expectation = Expectation.new
+      yield expectation if block_given?
+      expectation
+    end
+  end
+end

data/lib/mockserver/model/forward.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+require 'hashie'
+require_relative './enum'
+
+#
+# A class to model a forwarding on a request.
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # Enum for a scheme used in a forward request
+  class Scheme < SymbolizedEnum
+    def allowed_values
+      [:HTTP, :HTTPS]
+    end
+  end
+
+  # Model for forwarding
+  class Forward < Hashie::Dash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :host, default: 'localhost'
+    property :port, default: 80
+    property :scheme, default: 'HTTP'
+
+    coerce_key :host, String
+    coerce_key :scheme, Scheme
+  end
+
+  # DSL methods for forward
+  module DSL
+    def forward(&_)
+      obj = Forward.new
+      yield obj if block_given?
+      obj
+    end
+
+    alias_method :http_forward, :forward
+  end
+end

data/lib/mockserver/model/parameter.rb

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+require 'hashie'
+require_relative './array_of'
+
+#
+# A class to model parameters in payloads.
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # A class that only stores strings
+  class Strings < ArrayOf
+    def child_class
+      String
+    end
+  end
+
+  # Model for parameter
+  class Parameter < Hashie::Dash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :name, required: true
+    property :values, default: Strings.new([])
+
+    coerce_key :name, String
+    coerce_key :values, Strings
+  end
+
+  # A collection that only stores parameters
+  class Parameters < ArrayOf
+    def child_class
+      Parameter
+    end
+  end
+
+  # DSL methods for parameter
+  module DSL
+    def parameter(key, *value)
+      Parameter.new(name: key, values: value)
+    end
+
+    alias_method :cookie, :parameter
+    alias_method :header, :parameter
+  end
+end

data/lib/mockserver/model/request.rb

@@ -0,0 +1,52 @@
+# encoding: UTF-8
+require 'hashie'
+require_relative './parameter'
+require_relative './body'
+require_relative './enum'
+
+#
+# A class to model a request in an expectation.
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # Enum for HTTP methods
+  class HTTPMethod < SymbolizedEnum
+    def allowed_values
+      [:GET, :POST, :PUT, :DELETE]
+    end
+  end
+
+  # Request model
+  class Request < Hashie::Dash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    ALLOWED_METHODS = [:GET, :POST, :PUT, :DELETE]
+
+    property :method, required: true, default: :GET
+    property :path, required: true, default: ''
+    property :query_parameters, default: Parameters.new([])
+    property :cookies, default: Parameters.new([])
+    property :headers, default: Parameters.new([])
+    property :body
+
+    coerce_key :method, HTTPMethod
+    coerce_key :path, String
+    coerce_key :query_parameters, Parameters
+    coerce_key :cookies, Parameters
+    coerce_key :headers, Parameters
+    coerce_key :body, Body
+  end
+
+  # DSL methods related to requests
+  module DSL
+    def request(method, path, &_)
+      obj = Request.new(method: method, path: path)
+      yield obj if block_given?
+      obj
+    end
+
+    alias_method :http_request, :request
+  end
+end

data/lib/mockserver/model/response.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+require_relative './body'
+require_relative './delay'
+require_relative './parameter'
+
+#
+# A class to model a response in an expectation.
+# @author:: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+module MockServer::Model
+  # Model for a mock response
+  class Response < Hashie::Dash
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IgnoreUndeclared
+    include Hashie::Extensions::Coercion
+
+    property :status_code, default: 200
+    property :cookies, default: Parameters.new([])
+    property :headers, default: Parameters.new([])
+    property :delay
+    property :body
+
+    coerce_key :cookies, Parameters
+    coerce_key :headers, Parameters
+    coerce_key :delay, Delay
+    coerce_key :body, String
+  end
+
+  # DSL Methods for a response
+  module DSL
+    def response(&_)
+      obj = Response.new
+      yield obj if block_given?
+      obj
+    end
+
+    alias_method :http_response, :response
+  end
+end