stub_requests 0.1.1 → 0.1.2

data/lib/stub_requests/hash_util.rb

@@ -10,6 +10,8 @@ module StubRequests
   #
   # Provides convenience methods for hashes
   #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
   module HashUtil
     #
     # Removes all entries with nil values (first level only)

data/lib/stub_requests/metrics/endpoint_stat.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module Metrics contains logic for collecting metrics about {EndpointStat} and {StubStat}
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  # :reek:TooManyInstanceVariables
+  module Metrics
+    #
+    # Class EndpointStat provides metrics for stubbed endpoints
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @since 0.1.2
+    #
+    class EndpointStat
+      # includes "Enumerable"
+      # @!parse include Enumerable
+      include Enumerable
+
+      # @api private
+      include Property
+
+      #
+      # @!attribute [r] service_id
+      #   @return [Symbol] the id of a {Service}
+      property :service_id, type: Symbol
+      #
+      # @!attribute [r] endpoint_id
+      #   @return [Symbol] the id of an endpoint
+      property :endpoint_id, type: Symbol
+      #
+      # @!attribute [r] verb
+      #   @return [String] the HTTP verb/method for this endpoint
+      property :verb, type: Symbol
+      #
+      # @!attribute [r] uri_template
+      #   @return [String] the full URI template for the endpoint
+      property :uri_template, type: Symbol
+      #
+      # @!attribute [r] stats
+      #   @return [Array] an array with recorded request_stubs
+      attr_reader :stats
+
+      #
+      # Initializes a new EndpointStat
+      #
+      # @param [Service] service a service
+      # @param [Endpoint] endpoint an endpoint
+      #
+      def initialize(service, endpoint)
+        @service_id   = service.id
+        @endpoint_id  = endpoint.id
+        @verb         = endpoint.verb
+        @uri_template = [service.uri, endpoint.uri_template].join("/")
+        @stats        = Concurrent::Array.new
+      end
+
+      def find_by(attribute:, value:)
+        find { |stat| stat.send(attribute) == value }
+      end
+
+      #
+      # Required by Enumerable
+      #
+      #
+      # @return [Concurrent::Map<Symbol, Service>] an map with services
+      #
+      # @yield used by Enumerable
+      #
+      def each(&block)
+        stats.each(&block)
+      end
+
+      #
+      # Records a WebMock::RequestStub as stubbed
+      #
+      # @param [WebMock::RequestStub] request_stub <description>
+      #
+      # @return [Record]
+      #
+      def record(request_stub)
+        stat = StubStat.new(self, request_stub)
+        stats.push(stat)
+        stat
+      end
+    end
+  end
+end

data/lib/stub_requests/metrics/registry.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module Metrics contains logic for collecting metrics about {EndpointStat} and {StubStat}
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  # :reek:DataClump
+  module Metrics
+    #
+    # Class Registry maintains a registry of stubbed endpoints.
+    #   Also allows provides querying capabilities for said entities.
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @since 0.1.2
+    #
+    class Registry
+      # includes "Singleton"
+      # @!parse include Singleton
+      include Singleton
+      # includes "Enumerable"
+      # @!parse include Enumerable
+      include Enumerable
+
+      #
+      # @!attribute [rw] services
+      #   @return [Concurrent::Array<EndpointStat>] a map with stubbed endpoints
+      attr_reader :stats
+
+      #
+      # Initialize a new registry
+      #
+      #
+      def initialize
+        @stats = Concurrent::Array.new
+      end
+
+      #
+      # Resets the map with stubbed endpoints
+      #
+      #
+      # @api private
+      def reset
+        stats.clear
+      end
+
+      #
+      # Required by Enumerable
+      #
+      #
+      # @return [Concurrent::Array<EndpointStat>] an array with stubbed endpoints
+      #
+      # @yield used by Enumerable
+      #
+      def each(&block)
+        stats.each(&block)
+      end
+
+      #
+      # Records metrics about stubbed endpoints
+      #
+      #
+      # @param [Service] service a symbolic id of the service
+      # @param [Endpoint] endpoint a string with a base_uri to the service
+      # @param [WebMock::RequestStub] request_stub the stubbed request
+      #
+      # @return [Service] the service that was just registered
+      #
+      def record(service, endpoint, request_stub)
+        stat = find_or_initialize_stat(service, endpoint)
+        stat.record(request_stub)
+
+        stats.push(stat)
+        stat
+      end
+
+      #
+      # Mark a {StubStat} as having responded
+      #
+      # @note Called when webmock responds successfully
+      #
+      # @param [WebMock::RequestStub] request_stub the stubbed webmock request
+      #
+      # @return [void]
+      #
+      def mark_as_responded(request_stub)
+        return unless (stat = find_stub_stat(request_stub))
+
+        stat.mark_as_responded
+      end
+
+      #
+      # Finds a {StubStat} amongst the endpoint stubs
+      #
+      #
+      # @param [WebMock::RequestStub] request_stub a stubbed webmock response
+      #
+      # @return [StubStat] the stub_stat matching the request stub
+      #
+      def find_stub_stat(request_stub)
+        map do |endpoint|
+          endpoint.find_by(attribute: :request_stub, value: request_stub)
+        end.compact.first
+      end
+
+      private
+
+      def find_or_initialize_stat(service, endpoint)
+        find_stat(service, endpoint) || initialize_stat(service, endpoint)
+      end
+
+      # :reek:UtilityFunction
+      # :reek:FeatureEnvy
+      def find_stat(service, endpoint)
+        find { |stat| stat.service_id == service.id && stat.endpoint_id == endpoint.id }
+      end
+
+      # :reek:UtilityFunction
+      def initialize_stat(service, endpoint)
+        Metrics::EndpointStat.new(service, endpoint)
+      end
+    end
+  end
+end

data/lib/stub_requests/metrics/stub_stat.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module Metrics contains logic for collecting metrics about {EndpointStat} and {StubStat}
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  module Metrics
+    #
+    # Class StubStat tracks the WebMock::RequestStub life cycle
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @since 0.1.2
+    #
+    # :reek:TooManyInstanceVariables
+    class StubStat
+      include Property
+      #
+      # @!attribute [r] verb
+      #   @return [Symbol] a HTTP verb/method
+      property :verb, type: Symbol
+      #
+      # @!attribute [r] uri
+      #   @return [String] the full URI for this endpoint
+      property :uri, type: String
+      #
+      # @!attribute [r] request_stub
+      #   @return [WebMock::RequestStub] a webmock stubbed request
+      property :request_stub, type: WebMock::RequestStub
+      #
+      # @!attribute [r] recorded_at
+      #   @return [Time] the time this record was recorded
+      property :recorded_at, type: Time
+      #
+      # @!attribute [r] recorded_from
+      #   @return [String] the relative path to the spec that recorded it
+      property :recorded_from, type: String
+      #
+      # @!attribute [r] responded_at
+      #   @return [Time] the time this stubs response was used
+      property :responded_at, type: Time
+
+      #
+      # Initialize a new Record
+      #
+      #
+      # @param [EndpointStat] endpoint_stat a stubbed endpoint
+      # @param [WebMock::RequestStub] request_stub the stubbed webmock request
+      #
+      def initialize(endpoint_stat, request_stub)
+        request_pattern = request_stub.request_pattern
+        @endpoint_stat  = endpoint_stat
+        @verb           = request_pattern.method_pattern.to_s.to_sym
+        @uri            = request_pattern.uri_pattern.to_s
+        @request_stub   = request_stub
+        @recorded_at    = Time.now
+        @recorded_from  = RSpec.current_example.metadata[:location]
+        @responded_at   = nil
+      end
+
+      #
+      # Marks this record as having responded
+      #
+      #
+      # @return [Time] the time it was marked responded
+      #
+      def mark_as_responded
+        @responded_at = Time.now
+      end
+    end
+  end
+end

data/lib/stub_requests/metrics.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module Metrics contains logic for collecting metrics about {EndpointStat} and {StubStat}
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  module Metrics
+    #
+    # Records metrics about stubbed endpoints
+    #
+    # @param [Service] service a Service
+    # @param [Endpoint] endpoint an Endpoint
+    # @param [WebMock::RequestStub] endpoint_stub the stubbed webmock request
+    #
+    # @return [EndpointStat] the stat that was recorded
+    #
+    def self.record(service, endpoint, endpoint_stub)
+      return unless StubRequests.config.record_metrics?
+
+      Registry.instance.record(service, endpoint, endpoint_stub)
+    end
+  end
+end

data/lib/stub_requests/property/validator.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module Property provides type checked attribute definition with default value
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  module Property
+    #
+    # Class Validator provides validation for adding properties
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @since 0.1.2
+    #
+    class Validator
+      include ArgumentValidation
+
+      #
+      # Validates that the property can be added to the class
+      #
+      #
+      # @param [Symbol] name the name of the property
+      # @param [Class, Module] type the type of the property
+      # @param [Object] default the default value of the property
+      # @param [Hash] properties the list of currently defined properties
+      #
+      # @raise [InvalidArgumentType] when name is not a Symbol
+      # @raise [InvalidArgumentType] when default does not match type
+      # @raise [PropertyDefined] when property has already been defined
+      #
+      # @return [void]
+      #
+      # :reek:LongParameterList
+      def self.call(name, type, default, properties)
+        new(name, type, default, properties).run_validations
+      end
+
+      #
+      # @!attribute [r] name
+      #   @return [Symbol] the name of the property
+      attr_reader :name
+      #
+      # @!attribute [r] type
+      #   @return [Class, Module] the type of the property
+      attr_reader :type
+      #
+      # @!attribute [r] default
+      #   @return [Object] the default value of the property
+      attr_reader :default
+      #
+      # @!attribute [r] properties
+      #   @return [Hash] the list of currently defined properties
+      attr_reader :properties
+
+      # Initializes a new {Validator}
+      #
+      # @param [Symbol] name the name of the property
+      # @param [Class, Module] type the type of the property
+      # @param [Object] default the default value of the property
+      # @param [Hash] properties the list of currently defined properties
+      #
+      # :reek:LongParameterList
+      def initialize(name, type, default, properties)
+        @name       = name
+        @type       = Array(type).flatten
+        @default    = default
+        @properties = properties
+      end
+
+      #
+      # Performs all validations
+      #
+      #
+      # @raise [InvalidArgumentType] when name is not a Symbol
+      # @raise [InvalidArgumentType] when default does not match type
+      # @raise [PropertyDefined] when property has already been defined
+      #
+      # @return [void]
+      #
+      def run_validations
+        validate_undefined
+        validate_name
+        validate_default
+      end
+
+      private
+
+      #
+      # Validates that the name is of type Symbol
+      #
+      # @raise [InvalidArgumentType] when name is not a Symbol
+      #
+      # @return [void]
+      #
+      def validate_name
+        validate! :name, name, is_a: Symbol
+      end
+
+      #
+      # Validate that the default value matches the type
+      #
+      #
+      # @raise [InvalidArgumentType] when default does not match type
+      #
+      # @return [void]
+      #
+      def validate_default
+        return unless default || default.is_a?(FalseClass)
+
+        validate! :default, default, is_a: type
+      end
+
+      #
+      # Validate that the property has not been defined
+      #
+      #
+      # @raise [PropertyDefined] when property has already been defined
+      #
+      # @return [void]
+      #
+      def validate_undefined
+        return unless (prop = properties[name])
+
+        raise PropertyDefined, name: name, type: prop[:type], default: prop[:default]
+      end
+    end
+  end
+end

data/lib/stub_requests/property.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module Property provides type checked attribute definition with default value
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  module Property
+    include ArgumentValidation
+
+    #
+    # Extends the base class with the ClassMethods module
+    #
+    # @param [Class,Module] base the class where this module is included
+    #
+    # @return [void]
+    #
+    def self.included(base)
+      base.class_attribute :properties, default: {}
+      base.send(:extend, ClassMethods)
+    end
+
+    #
+    # Module ClassMethods provides class methods for {Property}
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    #
+    # :reek:DataClump
+    module ClassMethods
+      #
+      # Define property methods for the name
+      #
+      # @param [Symbol] name the name of the property
+      # @param [Object] type: the expected type of the property
+      # @param [Hash<Symbol>] **options a hash with options
+      # @option options [Object] :default a default value for the property
+      #
+      # @return [Object] the whatever
+      #
+      def property(name, type:, **options)
+        type = normalize_type(type, options)
+        default = options[:default]
+        Property::Validator.call(name, type, default, properties)
+
+        Docile.dsl_eval(self) do
+          define_property(name, type, default)
+        end
+      end
+
+      def normalize_type(type, **options)
+        type_array = Array(type)
+        return type_array unless (default = options[:default])
+
+        type_array.concat([default.class]).flatten.uniq
+      end
+
+      def define_property(name, type, default)
+        property_reader(name)
+        property_predicate(name)
+        property_writer(name, type)
+
+        set_property_defined(name, type, default)
+      end
+
+      def property_reader(name)
+        silence_redefinition_of_method(name.to_s)
+        redefine_method(name) do
+          instance_variable_get("@#{name}") || properties.dig(name, :default)
+        end
+      end
+
+      def property_predicate(name)
+        silence_redefinition_of_method("#{name}?")
+        redefine_method("#{name}?") do
+          !!public_send(name) # rubocop:disable Style/DoubleNegation
+        end
+      end
+
+      def property_writer(name, type)
+        redefine_method("#{name}=") do |obj|
+          validate! name, obj, is_a: type
+          instance_variable_set("@#{name}", obj)
+        end
+      end
+
+      def set_property_defined(name, type, default)
+        properties[name] = { type: type, default: default }
+      end
+    end
+  end
+end

data/lib/stub_requests/service.rb

@@ -10,21 +10,23 @@ module StubRequests
   #
   # Class Service provides details for a registered service
   #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
   class Service
-    include ArgumentValidation
     include Comparable
+    include Property
 
     # @!attribute [rw] id
     #   @return [EndpointRegistry] the id of the service
-    attr_reader :id
+    property :id, type: Symbol
 
     # @!attribute [rw] uri
     #   @return [EndpointRegistry] the base uri to the service
-    attr_reader :uri
+    property :uri, type: String
 
-    # @!attribute [rw] endpoint_registry
+    # @!attribute [rw] endpoints
     #   @return [EndpointRegistry] a list with defined endpoints
-    attr_reader :endpoint_registry
+    attr_reader :endpoints
 
     #
     # Initializes a new instance of a Service
@@ -33,28 +35,9 @@ module StubRequests
     # @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)
+      self.id    = service_id
+      self.uri   = service_uri
+      @endpoints = EndpointRegistry.new
     end
 
     #
@@ -63,31 +46,7 @@ module StubRequests
     # @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)
+      endpoints.any?
     end
 
     #
@@ -100,7 +59,7 @@ module StubRequests
         +"#<#{self.class}",
         +" id=#{id}",
         +" uri=#{uri}",
-        +" endpoints=#{endpoint_registry.endpoints_string}",
+        +" endpoints=#{endpoints.endpoints_string}",
         +">",
       ].join("")
     end