stub_requests 0.1.9 → 0.1.10

data/lib/stub_requests/endpoint.rb

@@ -13,10 +13,12 @@ module StubRequests
   # @author Mikael Henriksson <mikael@zoolutions.se>
   #
   class Endpoint
-    extend Forwardable
-
+    # includes "Comparable"
+    # @!parse include Comparable
     include Comparable
-    include Property
+    # includes "Concerns::Property"
+    # @!parse include Concerns::Property
+    include Concerns::Property
     #
     # @!attribute [rw] id
     #   @return [Symbol] the id of the endpoint
@@ -29,49 +31,46 @@ module StubRequests
     # @!attribute [rw] path
     #   @return [String] a string template for the endpoint
     property :path, type: String
-
     #
-    # @!attribute [rw] service
-    #   @see
-    #   @return [Service] a service
-    attr_reader :service
-
+    # @!attribute [rw] uri
+    #   @return [String] the full uri for the endpoint
+    attr_reader :uri
     #
     # @!attribute [rw] service_id
     #   @see
     #   @return [Symbol] the id of the service
     attr_reader :service_id
-
     #
     # @!attribute [rw] service_uri
     #   @see
     #   @return [String] a service's base URI
     attr_reader :service_uri
-
     #
-    # @!attribute [rw] options
+    # @!attribute [rw] route_params
     #   @see
     #   @return [Array<Symbol>] an array with required route params
     attr_reader :route_params
 
     #
-    # An endpoint for a specific {StubRequests::Service}
+    # Initialize an endpoint for a specific {Service}
     #
     #
-    # @param [Service] service a registered service
     # @param [Symbol] endpoint_id a descriptive id for the endpoint
+    # @param [Symbol] service_id the id of a registered service
+    # @param [String] service_uri the uri of a registered service
     # @param [Symbol] verb a HTTP verb
     # @param [String] path how to reach the endpoint
     #
-    def initialize(service, endpoint_id, verb, path)
-      self.id   = endpoint_id
-      self.verb = verb
-      self.path = path
+    def initialize(endpoint_id:, service_id:, service_uri:, verb:, path:)
+      self.id       = endpoint_id
+      self.verb     = verb
+      self.path     = path
 
-      @service      = service
-      @service_id   = service.id
-      @service_uri  = service.uri
+      @service_id   = service_id
+      @service_uri  = service_uri
+      @uri          = URI.safe_join(service_uri, path)
       @route_params = URI.route_params(path)
+      @stubs        = Concurrent::Array.new
     end
 
     #
@@ -84,8 +83,8 @@ module StubRequests
     # @return [Endpoint] returns the updated endpoint
     #
     def update(verb, path)
-      self.verb = verb
-      self.path = path
+      @verb = verb
+      @path = path
       self
     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 Endpoints manages a collection of endpoints
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
+  class EndpointRegistry
+    # extend "Forwardable"
+    # @!parse extend Forwardable
+    extend Forwardable
+
+    # includes "Singleton"
+    # @!parse include Singleton
+    include Singleton
+    # includes "Enumerable"
+    # @!parse include Enumerable
+    include Enumerable
+
+    delegate [:each, :[], :[]=, :delete, :keys, :values] => :endpoints
+
+    #
+    # Return all endpoints for a service
+    #
+    # @param [Symbol] service_id the id of a registered service
+    #
+    # @return [Array<Endpoint>] the endpoints for the service
+    #
+    def self.[](service_id)
+      instance.values.select { |ep| ep.service_id == service_id }
+    end
+
+    #
+    # @!attribute [rw] endpoints
+    #   @return [Concurrent::Map<Symbol, Endpoint>] a map with endpoints
+    attr_reader :endpoints
+
+    #
+    # Initialize is used by Singleton
+    #
+    #
+    def initialize
+      reset
+    end
+
+    #
+    # Resets the endpoints array (used for testing)
+    #
+    #
+    def reset
+      @endpoints = Concurrent::Map.new
+    end
+
+    #
+    # The size of the endpoints array
+    #
+    #
+    # @return [Integer]
+    #
+    def size
+      keys.size
+    end
+    alias count size
+
+    #
+    # Registers an endpoint in the collection
+    #
+    # @param [Endpoint] endpoint the endpoint to register
+    #
+    # @return [Endpoint]
+    #
+    def register(endpoint)
+      StubRequests.logger.warn("Endpoint already registered: #{endpoint}") if find(endpoint)
+
+      self[endpoint.id] = endpoint
+      endpoint
+    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]
+    #
+    def find!(endpoint_id)
+      endpoint = find(endpoint_id)
+      return endpoint if endpoint
+
+      raise EndpointNotFound, id: endpoint_id, suggestions: suggestions(endpoint_id)
+    end
+
+    #
+    # Fetches an endpoint from the collection or raises an error
+    #
+
+    # @param [Symbol] endpoint_id the id of the endpoint
+    #
+    # @return [Endpoint, nil]
+
+    def find(endpoint_id)
+      endpoint_id = endpoint_id.id if endpoint_id.is_a?(Endpoint)
+      self[endpoint_id]
+    end
+
+    #
+    # Returns an array of potential alternatives
+    #
+    # @param [Symbol] endpoint_id the id of an endpoint
+    #
+    # @return [Array<Symbol>] an array of endpoint_id's
+    #
+    def suggestions(endpoint_id)
+      Utils::Fuzzy.match(endpoint_id, keys)
+    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/exceptions.rb

@@ -15,7 +15,34 @@ module StubRequests
   #
   # EndpointNotFound is raised when an endpoint cannot be found
   #
-  class EndpointNotFound < Error; end
+  class EndpointNotFound < Error
+    attr_reader :id
+
+    def initialize(id:, suggestions: [])
+      @id           = id
+      @suggestions  = Array(suggestions).compact
+      error_message = [base_message, suggestions_message].join(".")
+      super(error_message)
+    end
+
+    def base_message
+      @base_message ||= "Couldn't find an endpoint with id=:#{id}"
+    end
+
+    def suggestions_message
+      return if suggestions.none?
+
+      @suggestions_message ||= " Did you mean one of the following? (#{suggestions_string})"
+    end
+
+    def suggestions
+      @suggestions.map { |sym| ":#{sym}" }
+    end
+
+    def suggestions_string
+      suggestions.join(", ")
+    end
+  end
 
   #
   # Class InvalidCallback is raised when a callback argument doesn't have the correct number of arguments
@@ -55,15 +82,6 @@ module StubRequests
     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
   #

data/lib/stub_requests/request_stub.rb

@@ -14,15 +14,20 @@ module StubRequests
   # @since 0.1.2
   #
   class RequestStub
-    include Property
+    # extends "Forwardable"
+    # @!parse extend Forwardable
     extend Forwardable
 
+    # includes "Concerns::Property"
+    # @!parse include Concerns::Property
+    include Concerns::Property
+
     # Delegate service_id, endpoint_id, verb and path to endpoint
-    delegate [:service_id, :endpoint_id, :verb, :path] => :endpoint
+    delegate [:service_id, :service_uri, :verb, :path] => :endpoint
     #
     # @!attribute [r] endpoint
-    #   @return [StubRequests::EndpointStub] a stubbed endpoint
-    property :endpoint, type: StubRequests::EndpointStub
+    #   @return [Symbol] the id of a registered {Endpoint}
+    property :endpoint_id, type: Symbol
     #
     # @!attribute [r] verb
     #   @return [Symbol] a HTTP verb/method
@@ -30,11 +35,11 @@ module StubRequests
     #
     # @!attribute [r] uri
     #   @return [String] the full URI for this endpoint
-    property :uri, type: String
+    property :request_uri, type: String
     #
-    # @!attribute [r] request_stub
+    # @!attribute [r] webmock_stub
     #   @return [WebMock::RequestStub] a webmock stubbed request
-    property :request_stub, type: WebMock::RequestStub
+    property :webmock_stub, type: WebMock::RequestStub
     #
     # @!attribute [r] recorded_at
     #   @return [Time] the time this record was recorded
@@ -52,20 +57,30 @@ module StubRequests
     # Initialize a new Record
     #
     #
-    # @param [Endpoint] endpoint a stubbed endpoint
-    # @param [WebMock::RequestStub] request_stub the stubbed webmock request
+    # @param [Endpoint] endpoint_id the id of a stubbed endpoint
+    # @param [WebMock::RequestStub] webmock_stub the stubbed webmock request
     #
-    def initialize(endpoint, request_stub)
-      request_pattern = request_stub.request_pattern
-      self.endpoint       = endpoint
+    def initialize(endpoint_id, webmock_stub)
+      request_pattern     = webmock_stub.request_pattern
+      self.endpoint_id    = endpoint_id
       self.verb           = request_pattern.method_pattern.to_s.to_sym
-      self.uri            = request_pattern.uri_pattern.to_s
-      self.request_stub   = request_stub
+      self.request_uri    = request_pattern.uri_pattern.to_s
+      self.webmock_stub   = webmock_stub
       self.recorded_at    = Time.now
       self.recorded_from  = RSpec.current_example.metadata[:location]
       @responded_at = nil # ByPass the validation for the initializer
     end
 
+    #
+    # Retrieve the endpoint for this request stub
+    #
+    #
+    # @return [Endpoint] <description>
+    #
+    def endpoint
+      EndpointRegistry.instance[endpoint_id]
+    end
+
     #
     # Marks this record as having responded
     #

data/lib/stub_requests/service.rb

@@ -13,8 +13,15 @@ module StubRequests
   # @author Mikael Henriksson <mikael@zoolutions.se>
   #
   class Service
+    # includes "Comparable"
+    # @!parse include Comparable
     include Comparable
-    include Property
+    # includes "Concerns::Property"
+    # @!parse include Concerns::Property
+    include Concerns::Property
+    # includes "Concerns::RegisterVerb"
+    # @!parse include Concerns::RegisterVerb
+    include Concerns::RegisterVerb
 
     # @!attribute [rw] id
     #   @return [Symbol] the id of the service
@@ -24,10 +31,6 @@ module StubRequests
     #   @return [String] the base uri to the service
     property :uri, type: String
 
-    # @!attribute [rw] endpoints
-    #   @return [Endpoints] a list with defined endpoints
-    attr_reader :endpoints
-
     #
     # Initializes a new instance of a Service
     #
@@ -37,7 +40,26 @@ module StubRequests
     def initialize(service_id, service_uri)
       self.id    = service_id
       self.uri   = service_uri
-      @endpoints = Endpoints.new(self)
+    end
+
+    #
+    # Register and endpoint for this service
+    #
+    # @param [Symbol] endpoint_id the id of the endpoint
+    # @param [Symbol] verb the HTTP verb/method
+    # @param [String] path the path to the endpoint
+    #
+    # @return [Endpoint] the endpoint that was registered
+    #
+    def register(endpoint_id, verb, path)
+      endpoint = Endpoint.new(
+        service_id: id,
+        service_uri: uri,
+        endpoint_id: endpoint_id,
+        verb: verb,
+        path: path,
+      )
+      EndpointRegistry.instance.register(endpoint)
     end
 
     #
@@ -49,6 +71,16 @@ module StubRequests
       endpoints.any?
     end
 
+    #
+    # The endpoints for this service
+    #
+    #
+    # @return [Array<Endpoints>]
+    #
+    def endpoints
+      EndpointRegistry[id]
+    end
+
     #
     # Returns a nicely formatted string with this service
     #
@@ -59,7 +91,7 @@ module StubRequests
         +"#<#{self.class}",
         +" id=#{id}",
         +" uri=#{uri}",
-        +" endpoints=#{endpoints.endpoints_string}",
+        +" endpoints=#{endpoints_string}",
         +">",
       ].join("")
     end
@@ -73,5 +105,21 @@ module StubRequests
     end
 
     alias eql? ==
+
+    #
+    # Returns a nicely formatted string with an array of endpoints
+    #
+    #
+    # @return [String]
+    #
+    def endpoints_string
+      "[#{endpoints_as_string}]"
+    end
+
+    private
+
+    def endpoints_as_string
+      endpoints.map(&:to_s).join(",") if endpoints?
+    end
   end
 end