stub_requests 0.1.2 → 0.1.3

data/lib/stub_requests/metrics/registry.rb

@@ -8,7 +8,7 @@
 #
 module StubRequests
   #
-  # Module Metrics contains logic for collecting metrics about {EndpointStat} and {StubStat}
+  # Module Metrics contains logic for collecting metrics about requests stubs
   #
   # @author Mikael Henriksson <mikael@zoolutions.se>
   # @since 0.1.2
@@ -32,15 +32,15 @@ module StubRequests
 
       #
       # @!attribute [rw] services
-      #   @return [Concurrent::Array<EndpointStat>] a map with stubbed endpoints
-      attr_reader :stats
+      #   @return [Concurrent::Array<Endpoint>] a map with stubbed endpoints
+      attr_reader :endpoints
 
       #
       # Initialize a new registry
       #
       #
       def initialize
-        @stats = Concurrent::Array.new
+        @endpoints = Concurrent::Array.new
       end
 
       #
@@ -49,41 +49,41 @@ module StubRequests
       #
       # @api private
       def reset
-        stats.clear
+        endpoints.clear
       end
 
       #
       # Required by Enumerable
       #
       #
-      # @return [Concurrent::Array<EndpointStat>] an array with stubbed endpoints
+      # @return [Concurrent::Array<Endpoint>] an array with stubbed endpoints
       #
       # @yield used by Enumerable
       #
       def each(&block)
-        stats.each(&block)
+        endpoints.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 [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)
-        stat = find_or_initialize_stat(service, endpoint)
-        stat.record(request_stub)
+        endpoint = find_or_initialize_endpoint(service, endpoint)
+        endpoint.record(request_stub)
 
-        stats.push(stat)
-        stat
+        endpoints.push(endpoint)
+        endpoint
       end
 
       #
-      # Mark a {StubStat} as having responded
+      # Mark a {Request} as having responded
       #
       # @note Called when webmock responds successfully
       #
@@ -92,20 +92,20 @@ module StubRequests
       # @return [void]
       #
       def mark_as_responded(request_stub)
-        return unless (stat = find_stub_stat(request_stub))
+        return unless (request = find_request(request_stub))
 
-        stat.mark_as_responded
+        request.mark_as_responded
       end
 
       #
-      # Finds a {StubStat} amongst the endpoint stubs
+      # Finds a {Request} amongst the endpoint stubs
       #
       #
       # @param [WebMock::RequestStub] request_stub a stubbed webmock response
       #
-      # @return [StubStat] the stub_stat matching the request stub
+      # @return [Request] the request_stubbed matching the request stub
       #
-      def find_stub_stat(request_stub)
+      def find_request(request_stub)
         map do |endpoint|
           endpoint.find_by(attribute: :request_stub, value: request_stub)
         end.compact.first
@@ -113,19 +113,19 @@ module StubRequests
 
       private
 
-      def find_or_initialize_stat(service, endpoint)
-        find_stat(service, endpoint) || initialize_stat(service, endpoint)
+      def find_or_initialize_endpoint(service, endpoint)
+        find_endpoint(service, endpoint) || initialize_endpoint(service, endpoint)
       end
 
       # :reek:UtilityFunction
       # :reek:FeatureEnvy
-      def find_stat(service, endpoint)
-        find { |stat| stat.service_id == service.id && stat.endpoint_id == endpoint.id }
+      def find_endpoint(service, endpoint)
+        find { |ep| ep.service_id == service.id && ep.endpoint_id == endpoint.id }
       end
 
       # :reek:UtilityFunction
-      def initialize_stat(service, endpoint)
-        Metrics::EndpointStat.new(service, endpoint)
+      def initialize_endpoint(service, endpoint)
+        Metrics::Endpoint.new(service, endpoint)
       end
     end
   end

data/lib/stub_requests/metrics/{stub_stat.rb → request.rb}

@@ -8,21 +8,29 @@
 #
 module StubRequests
   #
-  # Module Metrics contains logic for collecting metrics about {EndpointStat} and {StubStat}
+  # Module Metrics contains logic for collecting metrics about requests stubs
   #
   # @author Mikael Henriksson <mikael@zoolutions.se>
   # @since 0.1.2
   #
   module Metrics
     #
-    # Class StubStat tracks the WebMock::RequestStub life cycle
+    # Class Stub tracks the WebMock::RequestStub life cycle
     #
     # @author Mikael Henriksson <mikael@zoolutions.se>
     # @since 0.1.2
     #
     # :reek:TooManyInstanceVariables
-    class StubStat
+    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
@@ -52,18 +60,18 @@ module StubRequests
       # Initialize a new Record
       #
       #
-      # @param [EndpointStat] endpoint_stat a stubbed endpoint
+      # @param [Endpoint] endpoint a stubbed endpoint
       # @param [WebMock::RequestStub] request_stub the stubbed webmock request
       #
-      def initialize(endpoint_stat, request_stub)
+      def initialize(endpoint, 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
+        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
 
       #
@@ -73,7 +81,8 @@ module StubRequests
       # @return [Time] the time it was marked responded
       #
       def mark_as_responded
-        @responded_at = Time.now
+        self.responded_at = Time.now
+        Observable.notify_subscribers(self)
       end
     end
   end

data/lib/stub_requests/observable.rb

@@ -0,0 +1,62 @@
+# 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 observing webmock requests
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.3
+  #
+  module Observable
+    #
+    # Subscribe to a service endpoint call
+    # @see Observable::Registry#subscribe
+    #
+    #
+    # @param [Symbol] service_id the id of a service
+    # @param [Symbol] endpoint_id the id of an endpoint
+    # @param [Symbol] verb the HTTP verb to subscribe to
+    # @param [Proc] callback the callback to use for when.a request was made
+    #
+    # @return [Subscription]
+    #
+    # :reek:LongParameterList
+    def self.subscribe_to(service_id, endpoint_id, verb, callback)
+      Registry.instance.subscribe(service_id, endpoint_id, verb, callback)
+    end
+
+    #
+    # Unsubscribe from a service endpoint call
+    # @see Observable::Registry#unsubscribe
+    #
+    #
+    # @param [Symbol] service_id the id of a service
+    # @param [Symbol] endpoint_id the id of an endpoint
+    # @param [Symbol] verb the HTTP verb to subscribe to
+    #
+    # @return [Subscription]
+    #
+    def self.unsubscribe_from(service_id, endpoint_id, verb)
+      Registry.instance.unsubscribe(service_id, endpoint_id, verb)
+    end
+
+    #
+    # Notifies subscribers that a request was made
+    # @see Observable::Registry#notify_subscribers
+    #
+    #
+    # @param [Metrics::Request] request the stubbed request
+    #
+    # @return [Request]
+    #
+    def self.notify_subscribers(request)
+      Registry.instance.notify_subscribers(request)
+    end
+  end
+end

data/lib/stub_requests/observable/registry.rb

@@ -0,0 +1,152 @@
+# 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

@@ -0,0 +1,58 @@
+# 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