stub_requests 0.1.9 → 0.1.10

data/lib/stub_requests/service_registry.rb

@@ -13,79 +13,42 @@ module StubRequests
   # @author Mikael Henriksson <mikael@zoolutions.se>
   #
   class ServiceRegistry
+    # extend "Forwardable"
+    # @!parse extend Forwardable
+    extend Forwardable
+
+    # includes "Singleton"
+    # @!parse include Singleton
     include Singleton
+    # includes "Enumerable"
+    # @!parse include Enumerable
     include Enumerable
 
-    # Register a service in the service registry
-    #
+    delegate [:each, :[], :[]=, :keys, :delete] => :services
+
     #
-    # @param [Symbol] service_id a descriptive id for the service
-    # @param [Symbol] service_uri the uri used to call the service
+    # @!attribute [rw] services
+    #   @return [Concurrent::Map<Symbol, Service>] a map with services
+    attr_reader :services
+
     #
-    # @example Register a service with endpoints
-    #   register_service(:documents, "https://company.com/api/v1") do
-    #     get    "documents/:id", as: :show
-    #     get    "documents",     as: :index
-    #     post   "documents",     as: :create
-    #     patch  "documents/:id", as: :update
-    #     delete "documents/:id", as: :destroy
-    #   end
+    # Initialize a new instance (used by Singleton)
     #
-    # @return [Service] a new service or a previously registered service
     #
-    def self.register_service(service_id, service_uri, &block)
-      service = instance.register(service_id, service_uri)
-      Docile.dsl_eval(service.endpoints, &block) if block.present?
-      service
+    def initialize
+      @services = Concurrent::Map.new
     end
 
     #
-    # Stub a request to a registered service endpoint
+    # Returns the size of the registry
     #
     #
-    # @param [Symbol] service_id the id of a registered service
-    # @param [Symbol] endpoint_id the id of a registered endpoint
-    # @param [Hash<Symbol>] route_params a map with route parameters
+    # @return [Integer]
     #
-    # @note the kind of timeout error raised by webmock is depending on the HTTP client used
-    #
-    # @example Stub a request to a registered service endpoint
-    #   stub_endpoint(:google_api, :get_map_location)
-    #    .to_return(body: "No content", status: 204)
-    #
-    # @example Stub a request to a registered service endpoint using block
-    #   stub_endpoint(:documents, :index) do
-    #     with(headers: { "Accept" => "application/json" }}})
-    #     to_return(body: "No content", status: 204)
-    #   end
-    #
-    # @return [WebMock::RequestStub] a mocked request
-    #
-    def self.stub_endpoint(service_id, endpoint_id, route_params = {}, &callback)
-      service, endpoint, uri = StubRequests::URI.for_service_endpoint(service_id, endpoint_id, route_params)
-      webmock_stub           = WebMock::Builder.build(endpoint.verb, uri, {}, &callback)
-
-      StubRegistry.record(service, endpoint, webmock_stub)
-      ::WebMock::StubRegistry.instance.register_request_stub(webmock_stub)
-    end
-
-    # @api private
-    # Used only for testing purposes
-    def self.__stub_endpoint(service_id, endpoint_id, route_params = {})
-      _service, endpoint, uri = StubRequests::URI.for_service_endpoint(service_id, endpoint_id, route_params)
-      endpoint_stub           = WebMock::Builder.build(endpoint.verb, uri)
-
-      ::WebMock::StubRegistry.instance.register_request_stub(endpoint_stub)
-    end
-
-    #
-    # @!attribute [rw] services
-    #   @return [Concurrent::Map<Symbol, Service>] a map with services
-    attr_reader :services
-
-    def initialize
-      @services = Concurrent::Map.new
+    def size
+      keys.size
     end
+    alias count size
 
     #
     # Resets the map with registered services
@@ -96,18 +59,6 @@ module StubRequests
       services.clear
     end
 
-    #
-    # Required by Enumerable
-    #
-    #
-    # @return [Concurrent::Map<Symbol, Service>] an map with services
-    #
-    # @yield used by Enumerable
-    #
-    def each(&block)
-      services.each(&block)
-    end
-
     #
     # Registers a service in the registry
     #
@@ -118,11 +69,11 @@ module StubRequests
     # @return [Service] the service that was just registered
     #
     def register(service_id, service_uri)
-      if (service = find(service_id))
-        StubRequests.logger.warn("Service already registered #{service}")
-        return service
-      end
-      services[service_id] = Service.new(service_id, service_uri)
+      service = Service.new(service_id, service_uri)
+      StubRequests.logger.warn("Service already registered #{service}") if self[service_id]
+
+      self[service_id] = service
+      service
     end
 
     #
@@ -134,7 +85,7 @@ module StubRequests
     # @raise [ServiceNotFound] when the service was not removed
     #
     def remove(service_id)
-      services.delete(service_id) || raise(ServiceNotFound, service_id)
+      delete(service_id) || raise(ServiceNotFound, service_id)
     end
 
     #
@@ -146,7 +97,7 @@ module StubRequests
     # @return [Service] the found service
     #
     def find(service_id)
-      services[service_id]
+      self[service_id]
     end
 
     #
@@ -160,7 +111,7 @@ module StubRequests
     # @return [Service]
     #
     def find!(service_id)
-      find(service_id) || raise(ServiceNotFound, service_id)
+      self[service_id] || raise(ServiceNotFound, service_id)
     end
   end
 end

data/lib/stub_requests/stub_registry.rb

@@ -15,6 +15,10 @@ module StubRequests
   # @since 0.1.2
   #
   class StubRegistry
+    # extend "Forwardable"
+    # @!parse extend Forwardable
+    extend Forwardable
+
     # includes "Singleton"
     # @!parse include Singleton
     include Singleton
@@ -22,50 +26,19 @@ module StubRequests
     # @!parse include Enumerable
     include Enumerable
 
-    #
-    # Records metrics about stubbed endpoints
-    #
-    #
-    # @param [Service] service a Service
-    # @param [Endpoint] endpoint an Endpoint
-    # @param [WebMock::RequestStub] webmock_stub the stubbed webmock request
-    #
-    # @note the class method of record validates that
-    #   configuration option :collect_metrics is true.
-    #
-    # @return [EndpointStub] the stub that was recorded
-    #
-    def self.record(service, endpoint, webmock_stub)
-      # Note: The class method v
-      return unless StubRequests.config.record_metrics?
-
-      instance.record(service, endpoint, webmock_stub)
-    end
+    delegate [:each, :concat] => :stubs
 
     #
-    # Mark a {RequestStub} as having responded
-    #
-    # @note Called when webmock responds successfully
-    #
-    # @param [WebMock::RequestStub] webmock_stub the stubbed webmock request
-    #
-    # @return [void]
-    #
-    def self.mark_as_responded(webmock_stub)
-      instance.mark_as_responded(webmock_stub)
-    end
-
-    #
-    # @!attribute [rw] services
-    #   @return [Concurrent::Array<Endpoint>] a map with stubbed endpoints
-    attr_reader :endpoints
+    # @!attribute [r] stubs
+    #   @return [Concurrent::Array] a collection of {RequestStub}
+    attr_reader :stubs
 
     #
     # Initialize a new registry
     #
     #
     def initialize
-      @endpoints = Concurrent::Array.new
+      reset
     end
 
     #
@@ -74,37 +47,22 @@ module StubRequests
     #
     # @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)
+      @stubs = Concurrent::Array.new
     end
 
     #
-    # Records metrics about stubbed endpoints
+    # Records a WebMock::RequestStub as stubbed
     #
+    # @param [WebMock::RequestStub] webmock_stub <description>
     #
-    # @param [Service] service a symbolic id of the service
-    # @param [Endpoint] endpoint a string with a base_uri to the service
-    # @param [WebMock::RequestStub] webmock_stub the stubbed request
+    # @return [RequestStub]
     #
-    # @return [Service] the service that was just registered
-    #
-    def record(service, endpoint, webmock_stub)
-      endpoint_stub = find_or_initialize_endpoint_stub(service, endpoint)
-      endpoint_stub.record(webmock_stub)
+    def record(endpoint_id, webmock_stub)
+      return unless StubRequests.config.record_stubs?
 
-      endpoints.push(endpoint_stub)
-      endpoint_stub
+      request_stub = RequestStub.new(endpoint_id, webmock_stub)
+      concat([request_stub])
+      request_stub
     end
 
     #
@@ -117,10 +75,10 @@ module StubRequests
     # @return [void]
     #
     def mark_as_responded(webmock_stub)
-      return unless (request_stub = find_request_stub(webmock_stub))
+      return unless (request_stub = find_by_webmock_stub(webmock_stub))
 
       request_stub.mark_as_responded
-      CallbackRegistry.invoke_callbacks(request_stub)
+      CallbackRegistry.instance.invoke_callbacks(request_stub)
       request_stub
     end
 
@@ -132,24 +90,8 @@ module StubRequests
     #
     # @return [RequestStub] the request_stubbed matching the request stub
     #
-    def find_request_stub(webmock_stub)
-      map do |endpoint|
-        endpoint.find_by(attribute: :request_stub, value: webmock_stub)
-      end.compact.first
-    end
-
-    private
-
-    def find_or_initialize_endpoint_stub(service, endpoint)
-      find_endpoint_stub(service, endpoint) || initialize_endpoint_stub(service, endpoint)
-    end
-
-    def find_endpoint_stub(service, endpoint)
-      find { |ep| ep.service_id == service.id && ep.endpoint_id == endpoint.id }
-    end
-
-    def initialize_endpoint_stub(service, endpoint)
-      EndpointStub.new(service, endpoint)
+    def find_by_webmock_stub(webmock_stub)
+      find { |stub| stub.webmock_stub == webmock_stub }
     end
   end
 end

data/lib/stub_requests/stub_requests.rb

@@ -22,11 +22,6 @@ module StubRequests
   # @!parse extend API
   include API
 
-  #
-  # @!attribute [rw] logger
-  #   @return [Logger] the logger to use in the gem
-  attr_accessor :logger
-
   #
   # Allows the gem to be configured
   #
@@ -50,6 +45,14 @@ module StubRequests
     @config ||= Configuration.new
   end
 
+  def logger
+    config.logger
+  end
+
+  def logger=(obj)
+    config.logger = obj
+  end
+
   #
   # The current version of the gem
   #

data/lib/stub_requests/uri.rb

@@ -40,22 +40,5 @@ module StubRequests
     def self.safe_join(host, path)
       [host.chomp("/"), path.sub(%r{\A/}, "")].join("/")
     end
-
-    #
-    # UtilityFunction to construct the full URI for a service endpoint
-    #
-    # @param [Symbol] service_id the id of a service
-    # @param [Symbol] endpoint_id the id of an endpoint
-    # @param [Hash<Symbol>] route_params hash with route_params
-    #
-    # @return [Array<Service, Endpoint, String] the service, endpoint and full URI
-    #
-    def self.for_service_endpoint(service_id, endpoint_id, route_params)
-      service  = ServiceRegistry.instance.find!(service_id)
-      endpoint = service.endpoints.find!(endpoint_id)
-      uri      = URI::Builder.build(service.uri, endpoint.path, route_params)
-
-      [service, endpoint, uri]
-    end
   end
 end

data/lib/stub_requests/utils/fuzzy.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module Utils provides a namespace for utility module
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
+  module Utils
+    #
+    # Provides convenience methods for hashes
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    #
+    module Fuzzy
+      #
+      # @return [Regexp] a pattern excluding all except alphanumeric
+      FILTER_REGEX = /(^\w\d)/.freeze
+      #
+      # Find strings that are similar
+      #
+      #
+      # @param [String] original a string to match
+      # @param [Array<String>] others an array of string to search
+      #
+      # @return [Array] Returns
+      #
+      def self.match(original, others)
+        matches = compute_distances(original, others).sort.reverse
+        filter_matches(matches.to_h)
+      end
+
+      # :nodoc:
+      def self.filter_matches(matches)
+        suggestions = matches.values
+        return suggestions if suggestions.size <= 3
+
+        matches.select { |distance, _| distance >= 0.7 }
+               .values
+      end
+
+      # :nodoc:
+      def self.compute_distances(original, others)
+        others.each_with_object([]) do |other, memo|
+          memo << [jaro_distance(original, other), other]
+        end
+      end
+
+      # :nodoc:
+      def self.jaro_distance(original, other)
+        JaroWinkler.jaro_distance(
+          normalize_string(original),
+          normalize_string(other),
+          StubRequests.config.jaro_options,
+        )
+      end
+
+      # :nodoc:
+      def self.normalize_string(value)
+        value.to_s.gsub(FILTER_REGEX, "")
+      end
+    end
+  end
+end

data/lib/stub_requests/version.rb

@@ -9,5 +9,5 @@
 module StubRequests
   #
   # @return [String] a version string
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

data/lib/stub_requests/webmock/builder.rb

@@ -21,32 +21,25 @@ module StubRequests
     # @since 0.1.2
     #
     class Builder
-      include HashUtil
-
       #
       # Builds and registers a WebMock::RequestStub
       #
       #
       # @param [Symbol] verb a HTTP verb/method
       # @param [String] uri a URI to call
-      # @param [Hash<Symbol>] options request/response options for Webmock::RequestStub
       #
       # @yield a callback to eventually yield to the caller
       #
-      # @return [WebMock::RequestStub] the registered stub
+      # @return [WebMock::RequestStub]
       #
-      def self.build(verb, uri, options = {}, &callback)
-        new(verb, uri, options, &callback).build
+      def self.build(verb, uri, &callback)
+        new(verb, uri, &callback).build
       end
 
       #
-      # @!attribute [r] request_stub
+      # @!attribute [r] webmock_stub
       #   @return [WebMock::RequestStub] a stubbed webmock request
-      attr_reader :request_stub
-      #
-      # @!attribute [r] options
-      #   @return [Hash<Symbol>] options for the stub_request
-      attr_reader :options
+      attr_reader :webmock_stub
       #
       # @!attribute [r] callback
       #   @return [Block] call back when given a block
@@ -58,13 +51,11 @@ module StubRequests
       #
       # @param [Symbol] verb a HTTP verb/method
       # @param [String] uri a URI to call
-      # @param [Hash<Symbol>] options request/response options for Webmock::RequestStub
       #
       # @yield a block to eventually yield to the caller
       #
-      def initialize(verb, uri, options = {}, &callback)
-        @request_stub = ::WebMock::RequestStub.new(verb, uri)
-        @options      = options
+      def initialize(verb, uri, &callback)
+        @webmock_stub = ::WebMock::RequestStub.new(verb, uri)
         @callback     = callback
       end
 
@@ -75,41 +66,8 @@ module StubRequests
       # @return [WebMock::RequestStub] the registered stub
       #
       def build
-        if callback.present?
-          Docile.dsl_eval(request_stub, &callback)
-        else
-          prepare_mock_request
-        end
-
-        request_stub
-      end
-
-      private
-
-      def prepare_mock_request
-        prepare_with
-        prepare_to_return
-        prepare_to_raise
-        request_stub.to_timeout if options[:timeout]
-        request_stub
-      end
-
-      def prepare_with
-        HashUtil.compact(options[:request]) do |request_options|
-          request_stub.with(request_options)
-        end
-      end
-
-      def prepare_to_return
-        HashUtil.compact(options[:response]) do |response_options|
-          request_stub.to_return(response_options)
-        end
-      end
-
-      def prepare_to_raise
-        return unless (error = options[:error])
-
-        request_stub.to_raise(*Array(error))
+        Docile.dsl_eval(webmock_stub, &callback) if callback.present?
+        webmock_stub
       end
     end
   end