stub_requests 0.1.0

data/lib/stub_requests/argument_validation.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "addressable/uri"
+require "public_suffix"
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module ArgumentValidation provides validation of method arguments
+  #
+  module ArgumentValidation
+    extend self
+
+    #
+    # Require the value to be any of the types past in
+    #
+    #
+    # @param [Object] value the value to validate
+    # @param [Array<Class>, Array<Module>, Class, Module] is_a
+    #
+    # @raise [InvalidType] when the value is disallowed
+    #
+    # @return [true] when the value is allowed
+    #
+    def validate!(value, is_a:)
+      expected_types = Array(is_a)
+      return true if expected_types.any? { |type| value.is_a?(type) }
+
+      raise StubRequests::InvalidType,
+            actual: value.class,
+            expected: expected_types.join(", ")
+    end
+  end
+end

data/lib/stub_requests/core_ext/all.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "stub_requests/core_ext/object/blank"

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

@@ -0,0 +1,171 @@
+# 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?)
+
+  # An object is present if it's not blank.
+  #
+  # @return [true, false]
+  def present?
+    !blank?
+  end unless respond_to?(:present?)
+
+  # 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
+class NilClass
+  # +nil+ is blank:
+  #
+  #   nil.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end unless respond_to?(:blank?)
+end
+
+# @see FalseClass
+class FalseClass
+  # +false+ is blank:
+  #
+  #   false.blank? # => true
+  #
+  # @return [true]
+  def blank?
+    true
+  end unless respond_to?(:blank?)
+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
+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
+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:
+  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)
+  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 Time
+class Time
+  # No Time is blank:
+  #
+  #   Time.now.blank? # => false
+  #
+  # @return [false]
+  def blank?
+    false
+  end unless respond_to?(:blank?)
+end

data/lib/stub_requests/core_ext.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "stub_requests/core_ext/all"

data/lib/stub_requests/endpoint.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Class Endpoint provides registration of stubbed endpoints
+  #
+  class Endpoint
+    include ArgumentValidation
+    include Comparable
+
+    #
+    # @!attribute [rw] id
+    #   @return [Symbol] the id of the endpoint
+    attr_reader :id
+
+    #
+    # @!attribute [rw] verb
+    #   @return [Symbol] a HTTP verb
+    attr_reader :verb
+
+    #
+    # @!attribute [rw] uri_template
+    #   @return [String] a string template for the endpoint
+    attr_reader :uri_template
+
+    #
+    # @!attribute [rw] default_options
+    #   @see
+    #   @return [Hash<Symbol>] a string template for the endpoint
+    attr_reader :default_options
+
+    #
+    # An endpoint for a specific {Service}
+    #
+    # @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
+    #
+    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
+    end
+
+    #
+    # Updates this 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
+    #
+    # @return [Endpoint] returns the updated endpoint
+    #
+    def update(verb, uri_template, default_options)
+      @verb            = verb
+      @uri_template    = uri_template
+      @default_options = default_options
+      self
+    end
+
+    def <=>(other)
+      id <=> other.id
+    end
+
+    def hash
+      [id, self.class].hash
+    end
+
+    alias eql? ==
+
+    #
+    # Returns a descriptive string of this endpoint
+    #
+    # @return [String]
+    #
+    def to_s
+      "#<#{self.class} id=:#{id} verb=:#{verb} uri_template='#{uri_template}'>"
+    end
+  end
+end

data/lib/stub_requests/endpoint_registry.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Class EndpointRegistry holds a collection of {Endpoint}
+  #
+  class EndpointRegistry
+    include Enumerable
+
+    #
+    # @!attribute [rw] endpoints
+    #   @return [Concurrent::Map<Symbol, Endpoint>] a map with endpoints
+    attr_reader :endpoints
+
+    def initialize
+      @endpoints = Concurrent::Map.new
+    end
+
+    #
+    # Required by Enumerable
+    #
+    # @return [Concurrent::Map<Symbol, Service>] a map with endpoints
+    #
+    # @yield used by Enumerable
+    #
+    def each(&block)
+      endpoints.each(&block)
+    end
+
+    #
+    # Registers an endpoint in the collection
+    #
+    # @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
+    #
+    # @return [Endpoint]
+    #
+    # :reek:LongParameterList { max_params: 4 }
+    def register(endpoint_id, verb, uri_template, default_options = {})
+      endpoint =
+        if (endpoint = get(endpoint_id))
+          StubRequests.logger.warn("Endpoint already registered: #{endpoint}")
+          endpoint.update(verb, uri_template, default_options)
+        else
+          Endpoint.new(endpoint_id, verb, uri_template, default_options)
+        end
+
+      endpoints[endpoint.id] = endpoint
+      endpoint
+    end
+
+    #
+    # Check if an endpoint is registered
+    #
+    # @param [Symbol] endpoint_id the id of the endpoint
+    #
+    # @return [true, false]
+    #
+    def registered?(endpoint_id)
+      endpoints[endpoint_id].present?
+    end
+
+    #
+    # Updates an endpoint
+    #
+    # @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?
+    #
+    # @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)
+    end
+
+    #
+    # Removes an endpoint from the collection
+    #
+    # @param [Symbol] endpoint_id the id of the endpoint, `:file_service`
+    #
+    # @return [Endpoint] the endpoint that was removed
+    #
+    def remove(endpoint_id)
+      endpoints.delete(endpoint_id)
+    end
+
+    #
+    # Fetches an endpoint from the collection
+    #
+    # @param [<type>] endpoint_id <description>
+    #
+    # @return [Endpoint]
+    #
+    def get(endpoint_id)
+      endpoints[endpoint_id]
+    end
+
+    #
+    # Fetches an endpoint from the collection or raises an error
+    #
+    # @param [Symbol] endpoint_id the id of the endpoint
+    #
+    # @raise [EndpointNotFound] when an endpoint couldn't be found
+    #
+    # @return [Endpoint, nil]
+    #
+    def get!(endpoint_id)
+      get(endpoint_id) || raise(EndpointNotFound, "Couldn't find an endpoint with id=:#{endpoint_id}")
+    end
+
+    #
+    # Returns a descriptive string with all endpoints in the collection
+    #
+    # @return [String]
+    #
+    def to_s
+      [
+        +"#<#{self.class} endpoints=",
+        +endpoints_string,
+        +">",
+      ].join("")
+    end
+
+    #
+    # Returns a nicely formatted string with an array of endpoints
+    #
+    #
+    # @return [<type>] <description>
+    #
+    def endpoints_string
+      "[#{endpoints_as_string}]"
+    end
+
+    private
+
+    def endpoints_as_string
+      endpoints.values.map(&:to_s).join(",") if endpoints.size.positive?
+    end
+  end
+end

data/lib/stub_requests/hash_util.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Provides convenience methods for hashes
+  #
+  module HashUtil
+    #
+    # Removes all entries with nil values (first level only)
+    #
+    # @param [Hash] options the hash to compact
+    #
+    # @return [Hash, nil] Returns
+    #
+    # @yieldparam [Hash] compacted the hash without nils
+    # @yieldreturn [void]
+    def self.compact(options)
+      return if options.blank?
+
+      compacted = options.delete_if { |_, val| val.blank? }
+      yield compacted if compacted.present?
+    end
+  end
+end

data/lib/stub_requests/service.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Class Service provides details for a registered service
+  #
+  class Service
+    include ArgumentValidation
+    include Comparable
+
+    # @!attribute [rw] id
+    #   @return [EndpointRegistry] the id of the service
+    attr_reader :id
+
+    # @!attribute [rw] uri
+    #   @return [EndpointRegistry] the base uri to the service
+    attr_reader :uri
+
+    # @!attribute [rw] endpoint_registry
+    #   @return [EndpointRegistry] a list with defined endpoints
+    attr_reader :endpoint_registry
+
+    #
+    # Initializes a new instance of a Service
+    #
+    # @param [Symbol] service_id the id of this service
+    # @param [String] service_uri the base uri to reach the service
+    #
+    def initialize(service_id, service_uri)
+      validate! service_id,  is_a: Symbol
+      validate! service_uri, is_a: String
+
+      @id        = service_id
+      @uri       = service_uri
+      @endpoint_registry = EndpointRegistry.new
+    end
+
+    #
+    # Registers a new endpoint or updates an existing one
+    #
+    #
+    # @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
+    #
+    # @return [Endpoint] either the new endpoint or the updated one
+    #
+    # :reek:LongParameterList { max_params: 5 }
+    def register_endpoint(endpoint_id, verb, uri_template, default_options = {})
+      endpoint_registry.register(endpoint_id, verb, uri_template, default_options)
+    end
+
+    #
+    # Check if the endpoint registry has endpoints
+    #
+    # @return [true,false]
+    #
+    def endpoints?
+      endpoint_registry.any?
+    end
+
+    #
+    # Gets an endpoint from the {#endpoint_registry} collection
+    #
+    # @param [Symbol] endpoint_id the id of the endpoint
+    #
+    # @raise [EndpointNotFound] when the endpoint couldn't be found
+    #
+    # @return [Endpoint]
+    #
+    def get_endpoint!(endpoint_id)
+      endpoint_registry.get!(endpoint_id)
+    end
+
+    #
+    # Gets an endpoint from the {#endpoint_registry} collection
+    #
+    # @param [Symbol] endpoint_id the id of the endpoint
+    #
+    # @return [Endpoint, nil]
+    #
+    def get_endpoint(endpoint_id)
+      endpoint_registry.get(endpoint_id)
+    end
+
+    #
+    # Returns a nicely formatted string with this service
+    #
+    # @return [String]
+    #
+    def to_s
+      [
+        +"#<#{self.class}",
+        +" id=#{id}",
+        +" uri=#{uri}",
+        +" endpoints=#{endpoint_registry.endpoints_string}",
+        +">",
+      ].join("")
+    end
+
+    def <=>(other)
+      id <=> other.id
+    end
+
+    def hash
+      [id, self.class].hash
+    end
+
+    alias eql? ==
+  end
+end