stub_requests 0.1.3 → 0.1.4

data/lib/stub_requests/metrics/endpoint.rb

@@ -1,98 +0,0 @@
-# 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 requests stubs
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  # @since 0.1.2
-  #
-  # :reek:TooManyInstanceVariables
-  module Metrics
-    #
-    # Class Endpoint provides metrics for stubbed endpoints
-    #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
-    # @since 0.1.2
-    #
-    class Endpoint
-      # includes "Enumerable"
-      # @!parse include Enumerable
-      include Enumerable
-      # @api private
-      include Property
-      # @api private
-
-      #
-      # @!attribute [r] service_id
-      #   @return [Symbol] the id of a {StubRequests::Registration::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: String
-      #
-      # @!attribute [r] stubs
-      #   @return [Array] an array with recorded requests
-      attr_reader :requests
-
-      #
-      # Initializes a new Endpoint
-      #
-      # @param [Registration::Service] service a service
-      # @param [Registration::Endpoint] endpoint an endpoint
-      #
-      def initialize(service, endpoint)
-        self.service_id   = service.id
-        self.endpoint_id  = endpoint.id
-        self.verb         = endpoint.verb
-        self.uri_template = [service.uri, endpoint.uri_template].join("/")
-
-        @requests = Concurrent::Array.new
-      end
-
-      def find_by(attribute:, value:)
-        find { |request| request.send(attribute) == value }
-      end
-
-      #
-      # Required by Enumerable
-      #
-      #
-      # @return [Concurrent::Map<Symbol, Service>] an map with services
-      #
-      # @yield used by Enumerable
-      #
-      def each(&block)
-        requests.each(&block)
-      end
-
-      #
-      # Records a WebMock::RequestStub as stubbed
-      #
-      # @param [WebMock::RequestStub] request_stub <description>
-      #
-      # @return [Record]
-      #
-      def record(request_stub)
-        request = Request.new(self, request_stub)
-        requests.push(request)
-        request
-      end
-    end
-  end
-end

data/lib/stub_requests/metrics/registry.rb

@@ -1,132 +0,0 @@
-# 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 requests stubs
-  #
-  # @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<Endpoint>] a map with stubbed endpoints
-      attr_reader :endpoints
-
-      #
-      # Initialize a new registry
-      #
-      #
-      def initialize
-        @endpoints = Concurrent::Array.new
-      end
-
-      #
-      # Resets the map with stubbed endpoints
-      #
-      #
-      # @api private
-      def reset
-        endpoints.clear
-      end
-
-      #
-      # Required by Enumerable
-      #
-      #
-      # @return [Concurrent::Array<Endpoint>] an array with stubbed endpoints
-      #
-      # @yield used by Enumerable
-      #
-      def each(&block)
-        endpoints.each(&block)
-      end
-
-      #
-      # Records metrics about stubbed endpoints
-      #
-      #
-      # @param [Registration::Service] service a symbolic id of the service
-      # @param [Registration::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)
-        endpoint = find_or_initialize_endpoint(service, endpoint)
-        endpoint.record(request_stub)
-
-        endpoints.push(endpoint)
-        endpoint
-      end
-
-      #
-      # Mark a {Request} 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 (request = find_request(request_stub))
-
-        request.mark_as_responded
-      end
-
-      #
-      # Finds a {Request} amongst the endpoint stubs
-      #
-      #
-      # @param [WebMock::RequestStub] request_stub a stubbed webmock response
-      #
-      # @return [Request] the request_stubbed matching the request stub
-      #
-      def find_request(request_stub)
-        map do |endpoint|
-          endpoint.find_by(attribute: :request_stub, value: request_stub)
-        end.compact.first
-      end
-
-      private
-
-      def find_or_initialize_endpoint(service, endpoint)
-        find_endpoint(service, endpoint) || initialize_endpoint(service, endpoint)
-      end
-
-      # :reek:UtilityFunction
-      # :reek:FeatureEnvy
-      def find_endpoint(service, endpoint)
-        find { |ep| ep.service_id == service.id && ep.endpoint_id == endpoint.id }
-      end
-
-      # :reek:UtilityFunction
-      def initialize_endpoint(service, endpoint)
-        Metrics::Endpoint.new(service, endpoint)
-      end
-    end
-  end
-end

data/lib/stub_requests/metrics/request.rb

@@ -1,89 +0,0 @@
-# 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 requests stubs
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  # @since 0.1.2
-  #
-  module Metrics
-    #
-    # Class Stub tracks the WebMock::RequestStub life cycle
-    #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
-    # @since 0.1.2
-    #
-    # :reek:TooManyInstanceVariables
-    class Request
-      include Property
-      extend Forwardable
-
-      # Delegate service_id, endpoint_id, verb and uri_template to endpoint
-      delegate [:service_id, :endpoint_id, :verb, :uri_template] => :endpoint
-      #
-      # @!attribute [r] endpoint
-      #   @return [StubRequests::Metrics::Endpoint] a stubbed endpoint
-      property :endpoint, type: StubRequests::Metrics::Endpoint
-      #
-      # @!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 [Endpoint] endpoint a stubbed endpoint
-      # @param [WebMock::RequestStub] request_stub the stubbed webmock request
-      #
-      def initialize(endpoint, request_stub)
-        request_pattern = request_stub.request_pattern
-        self.endpoint       = endpoint
-        self.verb           = request_pattern.method_pattern.to_s.to_sym
-        self.uri            = request_pattern.uri_pattern.to_s
-        self.request_stub   = request_stub
-        self.recorded_at    = Time.now
-        self.recorded_from  = RSpec.current_example.metadata[:location]
-        @responded_at = nil # ByPass the validation for the initializer
-      end
-
-      #
-      # Marks this record as having responded
-      #
-      #
-      # @return [Time] the time it was marked responded
-      #
-      def mark_as_responded
-        self.responded_at = Time.now
-        Observable.notify_subscribers(self)
-      end
-    end
-  end
-end

data/lib/stub_requests/metrics.rb

@@ -1,33 +0,0 @@
-# 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 {Metrics::Endpoint} and {Metrics::Request}
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  # @since 0.1.2
-  #
-  module Metrics
-    #
-    # Records metrics about stubbed endpoints
-    #
-    #
-    # @param [Registration::Service] service a Service
-    # @param [Registration::Endpoint] endpoint an Endpoint
-    # @param [WebMock::RequestStub] endpoint_stub the stubbed webmock request
-    #
-    # @return [Metrics::Endpoint] 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/observable/registry.rb

@@ -1,152 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Abstraction over WebMock to reduce duplication
-#
-# @author Mikael Henriksson <mikael@zoolutions.se>
-# @since 0.1.0
-#
-module StubRequests
-  #
-  # Module Observable handles listening to endpoint invocations
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  # @since 0.1.3
-  #
-  module Observable
-    #
-    # Class Registry handles subscriptions to webmock requests
-    #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
-    # @since 0.1.3
-    #
-    # :reek:UtilityFunction
-    # :reek:DataClump
-    # :reek:FeatureEnvy
-    class Registry
-      include Singleton
-      include Enumerable
-
-      #
-      # @!attribute [r] subscriptions
-      #   @return [Concurrent::Array<Subscription>] a list of subscriptions
-      attr_reader :subscriptions
-
-      #
-      # Used by Singleton
-      #
-      #
-      def initialize
-        @subscriptions = Concurrent::Array.new
-      end
-
-      #
-      # Resets the map with registered services
-      #
-      #
-      # @api private
-      def reset
-        subscriptions.clear
-      end
-
-      #
-      # Required by Enumerable
-      #
-      #
-      # @return [Concurrent::Array<Subscription>] a list with subscriptions
-      #
-      # @yield used by Enumerable
-      #
-      def each(&block)
-        subscriptions.each(&block)
-      end
-
-      #
-      # Subscribe to a service endpoint call
-      #
-      #
-      # @param [Symbol] service_id the id of a service
-      # @param [Symbol] endpoint_id the id of an endpoint
-      # @param [optional, Symbol] verb the HTTP verb to subscribe to
-      # @param [proc] callback the callback to use for when.a request was made
-      #
-      # @return [Subscription] the added subscription
-      #
-      # :reek:LongParameterList
-      def subscribe(service_id, endpoint_id, verb, callback)
-        subscription = find_by(service_id, endpoint_id, verb)
-        return subscription if subscription
-
-        subscription = Subscription.new(service_id, endpoint_id, verb, callback)
-        subscriptions.push(subscription)
-        subscription
-      end
-
-      #
-      # Unsubscribe to a service endpoint call
-      #
-      #
-      # @param [Symbol] service_id the id of a service
-      # @param [Symbol] endpoint_id the id of an endpoint
-      # @param [optional, Symbol] verb the HTTP verb to subscribe to
-      #
-      # @return [Subscription] the deleted subscription
-      #
-      # :reek:ControlParameter
-      def unsubscribe(service_id, endpoint_id, verb)
-        return unless (subscription = find_by(service_id, endpoint_id, verb))
-
-        subscriptions.delete(subscription)
-      end
-
-      #
-      # Notifies subscribers that a request was made
-      #
-      # @param [Metrics::Request] request the stubbed request
-      #
-      # @return [void]
-      #
-      def notify_subscribers(request)
-        return unless (subscription = find_by(request.service_id, request.endpoint_id, request.verb))
-
-        send_notification(request, subscription)
-      end
-
-      private
-
-      #
-      # Finds a subscription for a service endpoint
-      #
-      #
-      # @param [Symbol] service_id the id of a service
-      # @param [Symbol] endpoint_id the id of an endpoint
-      # @param [optional, Symbol] verb the HTTP verb to subscribe to
-      #
-      # @return [Subscription]
-      #
-      # :reek:ControlParameter
-      # :reek:DuplicateMethodCall
-      def find_by(service_id, endpoint_id, verb)
-        find do |sub|
-          sub.service_id == service_id &&
-            sub.endpoint_id == endpoint_id &&
-            ([sub.verb, verb].include?(:any) || sub.verb == verb)
-        end
-      end
-
-      def send_notification(request, subscription)
-        callback = subscription.callback
-        arity    = callback.arity
-
-        case arity
-        when 0
-          callback.call
-        when 1
-          callback.call(request)
-        else
-          raise InvalidCallback, "The callback for a subscription can either take 0 or 1 arguments (was #{arity})"
-        end
-      end
-    end
-  end
-end

data/lib/stub_requests/observable/subscription.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Abstraction over WebMock to reduce duplication
-#
-# @author Mikael Henriksson <mikael@zoolutions.se>
-# @since 0.1.0
-#
-module StubRequests
-  #
-  # Module Observable handles listening to endpoint invocations
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  # @since 0.1.3
-  #
-  module Observable
-    #
-    # Class Subscription contains information about a subscription
-    #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
-    # @since 0.1.3
-    #
-    class Subscription
-      include Property
-      #
-      # @!attribute [rw] service_id
-      #   @return [Symbol] the id of a service
-      property :service_id, type: Symbol
-      #
-      # @!attribute [rw] endpoint_id
-      #   @return [Symbol] the id of an endpoint
-      property :endpoint_id, type: Symbol
-      #
-      # @!attribute [rw] verb
-      #   @return [Symbol] the HTTP verb/method
-      property :verb, type: Symbol, default: :any
-      #
-      # @!attribute [rw] callback
-      #   @return [Proc] a proc to callback on notify
-      property :callback, type: Proc
-
-      #
-      # Initialize a new Subscription
-      #
-      # @param [Symbol] service_id the id of a service
-      # @param [Symbol] endpoint_id the id of an endpoint
-      # @param [Symbol] verb the HTTP verb/method
-      # @param [Proc] callback a proc to callback on notify
-      #
-      def initialize(service_id, endpoint_id, verb, callback)
-        self.service_id  = service_id
-        self.endpoint_id = endpoint_id
-        self.verb        = verb
-        self.callback    = callback
-      end
-    end
-  end
-end

data/lib/stub_requests/registration/endpoint.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-#
-# Abstraction over WebMock to reduce duplication
-#
-# @author Mikael Henriksson <mikael@zoolutions.se>
-# @since 0.1.0
-#
-module StubRequests
-  #
-  # Module Registration provides registration of stubbed endpoints and services
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  # @since 0.1.3
-  #
-  module Registration
-    #
-    # Class Endpoint provides registration of stubbed endpoints
-    #
-    # @author Mikael Henriksson <mikael@zoolutions.se>
-    #
-    class Endpoint
-      extend Forwardable
-
-      include Comparable
-      include Property
-
-      # Delegate id, uri and endpoints to service
-      delegate [:id, :uri, :endpoints] => :service
-      #
-      # @!attribute [rw] id
-      #   @return [Symbol] the id of the endpoint
-      property :id, type: Symbol
-      #
-      # @!attribute [rw] verb
-      #   @return [Symbol] a HTTP verb
-      property :verb, type: Symbol
-      #
-      # @!attribute [rw] uri_template
-      #   @return [String] a string template for the endpoint
-      property :uri_template, type: String
-      #
-      # @!attribute [rw] options
-      #   @see
-      #   @return [Hash<Symbol>] a Hash with default request/response options
-      property :options, type: Hash, default: {}
-
-      #
-      # An endpoint for a specific {StubRequests::Registration::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>] 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, options = {})
-        self.id              = endpoint_id
-        self.verb            = verb
-        self.uri_template    = uri_template
-        self.options         = options
-      end
-
-      #
-      # Updates this endpoint
-      #
-      # @param [Symbol] verb a HTTP verb
-      # @param [String] uri_template how to reach the endpoint
-      # @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 [Registration::Endpoint] returns the updated endpoint
-      #
-      def update(verb, uri_template, options)
-        self.verb            = verb
-        self.uri_template    = uri_template
-        self.options = 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
-end