stub_requests 0.1.1 → 0.1.2

data/lib/stub_requests/core_ext/array/extract_options.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# @see Hash
+# @api private
+class Hash
+  # @api private
+  def extractable_options?
+    instance_of?(Hash)
+  end
+end
+
+# @see Array
+# @api private
+class Array
+  # @api private
+  def extract_options!
+    if last.is_a?(Hash) && last.extractable_options?
+      pop
+    else
+      {}
+    end
+  end
+
+  # @api private
+  def extract_options
+    if last.is_a?(Hash) && last.extractable_options?
+      last
+    else
+      {}
+    end
+  end
+end

data/lib/stub_requests/core_ext/class/attribute.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+unless defined?(Rails) || defined?(ActiveSupport)
+  # See {Class}
+  # @api private
+  class Class
+    # @api private
+    def class_attribute(*attrs)
+      options       = attrs.extract_options!
+      default_value = options.fetch(:default, nil)
+
+      attrs.each do |name|
+        singleton_class.silence_redefinition_of_method(name)
+        define_singleton_method(name) { nil }
+
+        singleton_class.silence_redefinition_of_method("#{name}?")
+        define_singleton_method("#{name}?") { !!public_send(name) }
+
+        ivar = "@#{name}"
+
+        singleton_class.silence_redefinition_of_method("#{name}=")
+        define_singleton_method("#{name}=") do |val|
+          singleton_class.class_eval do
+            redefine_method(name) { val }
+          end
+
+          if singleton_class?
+            class_eval do
+              redefine_method(name) do
+                if instance_variable_defined? ivar
+                  instance_variable_get ivar
+                else
+                  singleton_class.send name
+                end
+              end
+            end
+          end
+          val
+        end
+
+        redefine_method(name) do
+          if instance_variable_defined?(ivar)
+            instance_variable_get ivar
+          else
+            self.class.public_send name
+          end
+        end
+
+        redefine_method("#{name}?") { !!public_send(name) }
+
+        redefine_method("#{name}=") do |val|
+          instance_variable_set ivar, val
+        end
+
+        unless default_value.nil?
+          self.send("#{name}=", default_value)
+        end
+      end
+    end
+  end
+end

data/lib/stub_requests/core_ext/kernel/singleton_class.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+unless defined?(Rails) || defined?(ActiveSupport)
+  # See {Class}
+  # @api private
+  module Kernel
+    # @api private
+    def class_eval(*args, &block)
+      singleton_class.class_eval(*args, &block)
+    end
+  end
+end

data/lib/stub_requests/core_ext/module/redefine_method.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+unless defined?(Rails) || defined?(ActiveSupport)
+  # See {Module}
+  # @api private
+  class Module
+    # @api private
+    def silence_redefinition_of_method(method)
+      if method_defined?(method) || private_method_defined?(method)
+        alias_method :__rails_redefine, method
+        remove_method :__rails_redefine
+      end
+    end
+
+    # Replaces the existing method definition, if there is one, with the passed
+    # block as its body.
+    # @api private
+    def redefine_method(method, &block)
+      visibility = method_visibility(method)
+      silence_redefinition_of_method(method)
+      define_method(method, &block)
+      send(visibility, method)
+    end
+
+    # Replaces the existing singleton method definition, if there is one, with
+    # the passed block as its body.
+    # @api private
+    def redefine_singleton_method(method, &block)
+      singleton_class.redefine_method(method, &block)
+    end
+
+    # @api private
+    def method_visibility(method) # :nodoc:
+      case
+      when private_method_defined?(method)
+        :private
+      when protected_method_defined?(method)
+        :protected
+      else
+        :public
+      end
+    end
+  end
+end

data/lib/stub_requests/core_ext/object/blank.rb

@@ -1,171 +1,115 @@
 # frozen_string_literal: true
 
-require "concurrent/map"
-
 # Copied from https://raw.githubusercontent.com/rails/rails/d66e7835bea9505f7003e5038aa19b6ea95ceea1/activesupport/lib/active_support/core_ext/object/blank.rb
 
-# :nodoc:
-# :nocov:
-
-# @see Object
-class Object # :nodoc: # :nocov:
-  # An object is blank if it's false, empty, or a whitespace string.
-  # For example, +nil+, '', '   ', [], {}, and +false+ are all blank.
-  #
-  # This simplifies
-  #
-  #   !address || address.empty?
-  #
-  # to
-  #
-  #   address.blank?
-  #
-  # @return [true, false]
-  def blank?
-    respond_to?(:empty?) ? !!empty? : !self # rubocop:disable Style/DoubleNegation
-  end unless respond_to?(:blank?)
+unless defined?(Rails) || defined?(ActiveSupport)
 
-  # An object is present if it's not blank.
-  #
-  # @return [true, false]
-  def present?
-    !blank?
-  end unless respond_to?(:present?)
+  # @see Object
+  # @api private
+  class Object
+    # @api private
+    def blank?
+      respond_to?(:empty?) ? !!empty? : !self # rubocop:disable Style/DoubleNegation
+    end
+    # @api private
+    def present?
+      !blank?
+    end
+    # @api private
+    def presence
+      self if present?
+    end
+  end
 
-  # Returns the receiver if it's present otherwise returns +nil+.
-  # <tt>object.presence</tt> is equivalent to
-  #
-  #    object.present? ? object : nil
-  #
-  # For example, something like
-  #
-  #   state   = params[:state]   if params[:state].present?
-  #   country = params[:country] if params[:country].present?
-  #   region  = state || country || 'US'
-  #
-  # becomes
-  #
-  #   region = params[:state].presence || params[:country].presence || 'US'
-  #
-  # @return [Object]
-  def presence
-    self if present?
-  end unless respond_to?(:presence)
-end
+  # @see NilClass
+  # @api private
+  class NilClass
+    # @api private
+    def blank?
+      true
+    end
+  end
 
-# @see NilClass
-class NilClass
-  # +nil+ is blank:
-  #
-  #   nil.blank? # => true
-  #
-  # @return [true]
-  def blank?
-    true
-  end unless respond_to?(:blank?)
-end
+  # @see FalseClass
+  # @api private
+  class FalseClass
+    # @api private
+    def blank?
+      true
+    end
+  end
 
-# @see FalseClass
-class FalseClass
-  # +false+ is blank:
-  #
-  #   false.blank? # => true
-  #
-  # @return [true]
-  def blank?
-    true
-  end unless respond_to?(:blank?)
-end
+  # @see TrueClass
+  # @api private
+  class TrueClass
+    # @api private
+    def blank?
+      false
+    end
+  end
 
-# @see TrueClass
-class TrueClass
-  # +true+ is not blank:
-  #
-  #   true.blank? # => false
-  #
-  # @return [false]
-  def blank?
-    false
-  end unless respond_to?(:blank?)
-end
+  # @see Array
+  # @api private
+  class Array
+    # @api private
+    alias blank? empty?
+  end
 
-# @see Array
-class Array
-  # An array is blank if it's empty:
-  #
-  #   [].blank?      # => true
-  #   [1,2,3].blank? # => false
-  #
-  # @return [true, false]
-  alias blank? empty?
-end
+  # @see Hash
+  # @api private
+  class Hash
+    # @api private
+    alias blank? empty?
+  end
 
-# @see Hash
-class Hash
-  # A hash is blank if it's empty:
-  #
-  #   {}.blank?                # => true
-  #   { key: 'value' }.blank?  # => false
-  #
-  # @return [true, false]
-  alias blank? empty?
-end
+  # @see String
+  class String
+    # :nodoc:
+    # @api private
+    BLANK_RE = /\A[[:space:]]*\z/.freeze
+    # :nodoc:
+    # @api private
+    ENCODED_BLANKS = Concurrent::Map.new do |map, enc|
+      map[enc] = Regexp.new(BLANK_RE.source.encode(enc), BLANK_RE.options | Regexp::FIXEDENCODING)
+    end
 
-# @see String
-class String
-  # :nodoc:
-  BLANK_RE = /\A[[:space:]]*\z/.freeze
-  # :nodoc:
-  ENCODED_BLANKS = Concurrent::Map.new do |map, enc|
-    map[enc] = Regexp.new(BLANK_RE.source.encode(enc), BLANK_RE.options | Regexp::FIXEDENCODING)
+    # @api private
+    def blank?
+      # The regexp that matches blank strings is expensive. For the case of empty
+      # strings we can speed up this method (~3.5x) with an empty? call. The
+      # penalty for the rest of strings is marginal.
+      empty? ||
+        begin
+          if  RUBY_VERSION >= "2.4"
+            BLANK_RE.match?(self)
+          else
+            !!BLANK_RE.match(self)
+          end
+        rescue Encoding::CompatibilityError
+          if  RUBY_VERSION >= "2.4"
+            ENCODED_BLANKS[encoding].match?(self)
+          else
+            !!ENCODED_BLANKS[encoding].match(self)
+          end
+        end
+    end
   end
 
-  # A string is blank if it's empty or contains whitespaces only:
-  #
-  #   ''.blank?       # => true
-  #   '   '.blank?    # => true
-  #   "\t\n\r".blank? # => true
-  #   ' blah '.blank? # => false
-  #
-  # Unicode whitespace is supported:
-  #
-  #   "\u00a0".blank? # => true
-  #
-  # @return [true, false]
-  def blank?
-    # The regexp that matches blank strings is expensive. For the case of empty
-    # strings we can speed up this method (~3.5x) with an empty? call. The
-    # penalty for the rest of strings is marginal.
-    empty? ||
-      begin
-        BLANK_RE.match?(self)
-      rescue Encoding::CompatibilityError
-        ENCODED_BLANKS[encoding].match?(self)
-      end
-  end unless respond_to?(:blank?)
-end
-
-# @see Numeric
-class Numeric
-  # No number is blank:
-  #
-  #   1.blank? # => false
-  #   0.blank? # => false
-  #
-  # @return [false]
-  def blank?
-    false
-  end unless respond_to?(:blank?)
-end
+  # @see Numeric
+  # @api private
+  class Numeric
+    # @api private
+    def blank?
+      false
+    end
+  end
 
-# @see Time
-class Time
-  # No Time is blank:
-  #
-  #   Time.now.blank? # => false
-  #
-  # @return [false]
-  def blank?
-    false
-  end unless respond_to?(:blank?)
+  # @see Time
+  # @api private
+  class Time
+    # @api private
+    def blank?
+      false
+    end
+  end
 end

data/lib/stub_requests/endpoint.rb

@@ -10,30 +10,32 @@ module StubRequests
   #
   # Class Endpoint provides registration of stubbed endpoints
   #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
   class Endpoint
-    include ArgumentValidation
     include Comparable
+    include Property
 
     #
     # @!attribute [rw] id
     #   @return [Symbol] the id of the endpoint
-    attr_reader :id
+    property :id, type: Symbol
 
     #
     # @!attribute [rw] verb
     #   @return [Symbol] a HTTP verb
-    attr_reader :verb
+    property :verb, type: Symbol
 
     #
     # @!attribute [rw] uri_template
     #   @return [String] a string template for the endpoint
-    attr_reader :uri_template
+    property :uri_template, type: String
 
     #
-    # @!attribute [rw] default_options
+    # @!attribute [rw] options
     #   @see
-    #   @return [Hash<Symbol>] a string template for the endpoint
-    attr_reader :default_options
+    #   @return [Hash<Symbol>] a Hash with default request/response options
+    property :options, type: Hash, default: {}
 
     #
     # An endpoint for a specific {Service}
@@ -41,21 +43,17 @@ module StubRequests
     # @param [Symbol] endpoint_id a descriptive id for the endpoint
     # @param [Symbol] verb a HTTP verb
     # @param [String] uri_template how to reach the endpoint
-    # @param [optional, Hash<Symbol>] default_options
-    # @option default_options [optional, Hash<Symbol>] :request for request_stub.with
-    # @option default_options [optional, Hash<Symbol>] :response for request_stub.to_return
-    # @option default_options [optional, Array, Exception, StandardError, String] :error for request_stub.to_raise
-    # @option default_options [optional, TrueClass] :timeout for request_stub.to_timeout
+    # @param [optional, Hash<Symbol>] options
+    # @option options [optional, Hash<Symbol>] :request for request_stub.with
+    # @option options [optional, Hash<Symbol>] :response for request_stub.to_return
+    # @option options [optional, Array, Exception, StandardError, String] :error for request_stub.to_raise
+    # @option options [optional, TrueClass] :timeout for request_stub.to_timeout
     #
-    def initialize(endpoint_id, verb, uri_template, default_options = {})
-      validate! endpoint_id,  is_a: Symbol
-      validate! verb,         is_a: Symbol
-      validate! uri_template, is_a: String
-
-      @id              = endpoint_id
-      @verb            = verb
-      @uri_template    = uri_template
-      @default_options = default_options
+    def initialize(endpoint_id, verb, uri_template, options = {})
+      self.id              = endpoint_id
+      self.verb            = verb
+      self.uri_template    = uri_template
+      self.options         = options
     end
 
     #
@@ -63,18 +61,18 @@ module StubRequests
     #
     # @param [Symbol] verb a HTTP verb
     # @param [String] uri_template how to reach the endpoint
-    # @param [optional, Hash<Symbol>] default_options
-    # @option default_options [optional, Hash<Symbol>] :request for request_stub.with
-    # @option default_options [optional, Hash<Symbol>] :response for request_stub.to_return
-    # @option default_options [optional, Array, Exception, StandardError, String] :error for request_stub.to_raise
-    # @option default_options [optional, TrueClass] :timeout for request_stub.to_timeout
+    # @param [optional, Hash<Symbol>] options
+    # @option options [optional, Hash<Symbol>] :request for request_stub.with
+    # @option options [optional, Hash<Symbol>] :response for request_stub.to_return
+    # @option options [optional, Array, Exception, StandardError, String] :error for request_stub.to_raise
+    # @option options [optional, TrueClass] :timeout for request_stub.to_timeout
     #
     # @return [Endpoint] returns the updated endpoint
     #
-    def update(verb, uri_template, default_options)
-      @verb            = verb
-      @uri_template    = uri_template
-      @default_options = default_options
+    def update(verb, uri_template, options)
+      self.verb            = verb
+      self.uri_template    = uri_template
+      self.options = options
       self
     end
 

data/lib/stub_requests/endpoint_registry.rb

@@ -10,6 +10,8 @@ module StubRequests
   #
   # Class EndpointRegistry holds a collection of {Endpoint}
   #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
   class EndpointRegistry
     include Enumerable
 
@@ -39,18 +41,18 @@ module StubRequests
     # @param [Symbol] endpoint_id the id of this Endpoint
     # @param [Symbol] verb a HTTP verb
     # @param [String] uri_template the URI to reach the endpoint
-    # @param [optional, Hash<Symbol>] default_options default options
+    # @param [optional, Hash<Symbol>] options default options
     #
     # @return [Endpoint]
     #
     # :reek:LongParameterList { max_params: 4 }
-    def register(endpoint_id, verb, uri_template, default_options = {})
+    def register(endpoint_id, verb, uri_template, options = {})
       endpoint =
-        if (endpoint = get(endpoint_id))
+        if (endpoint = find(endpoint_id))
           StubRequests.logger.warn("Endpoint already registered: #{endpoint}")
-          endpoint.update(verb, uri_template, default_options)
+          endpoint.update(verb, uri_template, options)
         else
-          Endpoint.new(endpoint_id, verb, uri_template, default_options)
+          Endpoint.new(endpoint_id, verb, uri_template, options)
         end
 
       endpoints[endpoint.id] = endpoint
@@ -74,20 +76,20 @@ module StubRequests
     # @param [Symbol] endpoint_id the id of the endpoint
     # @param [Symbol] verb a HTTP verb
     # @param [String] uri_template how to reach the endpoint
-    # @param [optional, Hash<Symbol>] default_options
-    # @option default_options [optional, Hash<Symbol>] :request request options
-    # @option default_options [optional, Hash<Symbol>] :response options
-    # @option default_options [optional, Array, Exception, StandardError, String] :error to raise
-    # @option default_options [optional, TrueClass] :timeout raise a timeout error?
+    # @param [optional, Hash<Symbol>] options
+    # @option options [optional, Hash<Symbol>] :request request options
+    # @option options [optional, Hash<Symbol>] :response options
+    # @option options [optional, Array, Exception, StandardError, String] :error to raise
+    # @option options [optional, TrueClass] :timeout raise a timeout error?
     #
     # @raise [EndpointNotFound] when the endpoint couldn't be found
     #
     # @return [Endpoint] returns the updated endpoint
     #
     # :reek:LongParameterList { max_params: 4 }
-    def update(endpoint_id, verb, uri_template, default_options)
-      endpoint = get!(endpoint_id)
-      endpoint.update(verb, uri_template, default_options)
+    def update(endpoint_id, verb, uri_template, options)
+      endpoint = find!(endpoint_id)
+      endpoint.update(verb, uri_template, options)
     end
 
     #
@@ -108,7 +110,7 @@ module StubRequests
     #
     # @return [Endpoint]
     #
-    def get(endpoint_id)
+    def find(endpoint_id)
       endpoints[endpoint_id]
     end
 
@@ -121,8 +123,8 @@ module StubRequests
     #
     # @return [Endpoint, nil]
     #
-    def get!(endpoint_id)
-      get(endpoint_id) || raise(EndpointNotFound, "Couldn't find an endpoint with id=:#{endpoint_id}")
+    def find!(endpoint_id)
+      find(endpoint_id) || raise(EndpointNotFound, "Couldn't find an endpoint with id=:#{endpoint_id}")
     end
 
     #

data/lib/stub_requests/exceptions.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Error is a base class for all gem errors
+  #
+  class Error < StandardError; end
+
+  #
+  # EndpointNotFound is raised when an endpoint cannot be found
+  #
+  class EndpointNotFound < Error; end
+
+  #
+  # InvalidType is raised when an argument is invalid
+  #
+  class InvalidType < Error
+    def initialize(actual, expected)
+      super("Expected `#{actual}` to be any of [#{expected}]")
+    end
+  end
+
+  #
+  # InvalidArgumentType is raised when an argument is not of the expected type
+  #
+  class InvalidArgumentType < Error
+    #
+    # @param [Symbol] name the name of the argument
+    # @param [Object] actual the actual value of the argument
+    # @param [Array<Class>, Array<Module>] expected the types the argument is expected to be
+    #
+    def initialize(name:, actual:, expected:)
+      super("The argument `:#{name}` was `#{actual}`, expected any of [#{expected.join(', ')}]")
+    end
+  end
+
+  #
+  # InvalidUri is raised when a URI is invalid
+  #
+  class InvalidUri < Error
+    def initialize(uri)
+      super("'#{uri}' is not a valid URI.")
+    end
+  end
+
+  #
+  # PropertyDefined is raised when trying to add the same property twice
+  #
+  class PropertyDefined < Error
+    def initialize(name:, type:, default:)
+      default = "nil" if default.is_a?(NilClass)
+      super("Property ##{name} was already defined as `{ type: #{type}, default: #{default} }")
+    end
+  end
+
+  #
+  # ServiceHaveEndpoints is raised to prevent overwriting a registered service's endpoints
+  #
+  class ServiceHaveEndpoints < StandardError
+    def initialize(service)
+      super("Service with id #{service.id} have already been registered. #{service}")
+    end
+  end
+
+  #
+  # ServiceNotFound is raised when a service cannot be found
+  #
+  class ServiceNotFound < Error
+    def initialize(service_id)
+      super("Couldn't find a service with id=:#{service_id}")
+    end
+  end
+
+  #
+  # UriSegmentMismatch is raised when a segment cannot be replaced
+  #
+  class UriSegmentMismatch < Error; end
+end