stub_requests 0.1.2 → 0.1.3

data/lib/stub_requests/property.rb

@@ -39,8 +39,8 @@ module StubRequests
       # 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
+      # @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
@@ -55,6 +55,7 @@ module StubRequests
         end
       end
 
+      # @api private
       def normalize_type(type, **options)
         type_array = Array(type)
         return type_array unless (default = options[:default])
@@ -62,6 +63,7 @@ module StubRequests
         type_array.concat([default.class]).flatten.uniq
       end
 
+      # @api private
       def define_property(name, type, default)
         property_reader(name)
         property_predicate(name)
@@ -70,6 +72,7 @@ module StubRequests
         set_property_defined(name, type, default)
       end
 
+      # @api private
       def property_reader(name)
         silence_redefinition_of_method(name.to_s)
         redefine_method(name) do
@@ -77,6 +80,7 @@ module StubRequests
         end
       end
 
+      # @api private
       def property_predicate(name)
         silence_redefinition_of_method("#{name}?")
         redefine_method("#{name}?") do
@@ -84,13 +88,15 @@ module StubRequests
         end
       end
 
+      # @api private
       def property_writer(name, type)
         redefine_method("#{name}=") do |obj|
-          validate! name, obj, is_a: type
+          validate! name: name, value: obj, type: type
           instance_variable_set("@#{name}", obj)
         end
       end
 
+      # @api private
       def set_property_defined(name, type, default)
         properties[name] = { type: type, default: default }
       end

data/lib/stub_requests/property/validator.rb

@@ -68,10 +68,10 @@ module StubRequests
       # @param [Hash] properties the list of currently defined properties
       #
       # :reek:LongParameterList
-      def initialize(name, type, default, properties)
-        @name       = name
+      def initialize(name, type, default = nil, properties = {})
         @type       = Array(type).flatten
         @default    = default
+        @name       = name
         @properties = properties
       end
 
@@ -101,7 +101,7 @@ module StubRequests
       # @return [void]
       #
       def validate_name
-        validate! :name, name, is_a: Symbol
+        validate! name: :name, value: name, type: Symbol
       end
 
       #
@@ -115,7 +115,7 @@ module StubRequests
       def validate_default
         return unless default || default.is_a?(FalseClass)
 
-        validate! :default, default, is_a: type
+        validate! name: :default, value: default, type: type
       end
 
       #

data/lib/stub_requests/registration.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module StubRequests
+  #
+  # Module Registration handles registration of stubbed endpoints and services
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.3
+  #
+  module Registration
+    # Register a service in the service registry
+    #
+    #
+    # @param [Symbol] service_id a descriptive id for the service
+    # @param [Symbol] service_uri the uri used to call the service
+    #
+    # @example Register a service with endpoints
+    #   register_service(:documents, "https://company.com/api/v1") do
+    #     register(:show, :get, "documents/:id")
+    #     register(:index, :get, "documents")
+    #     register(:create, :post, "documents")
+    #     register(:update, :patch, "documents/:id")
+    #     register(:destroy, :delete, "documents/:id")
+    #   end
+    #
+    # @return [Service] a new service or a previously registered service
+    #
+    def self.register_service(service_id, service_uri, &block)
+      service = Registry.instance.register(service_id, service_uri)
+      Docile.dsl_eval(service.endpoints, &block) if block.present?
+      service
+    end
+
+    #
+    # Stub a request to a registered service endpoint
+    #
+    #
+    # @param [Symbol] service_id the id of a registered service
+    # @param [Symbol] endpoint_id the id of a registered endpoint
+    # @param [Hash<Symbol>] uri_replacements a list of URI replacements
+    # @param [Hash<Symbol>] options
+    # @option options [optional, Hash<Symbol>] :request webmock request options
+    # @option options [optional, Hash<Symbol>] :response webmock response options
+    # @option options [optional, Array, Exception, StandardError, String] :error webmock error to raise
+    # @option options [optional, TrueClass] :timeout set to true to raise some kind of timeout error
+    #
+    # @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
+    #   register_stub(
+    #     :google_api,
+    #     :get_map_location,
+    #     {}, # No URI replacements needed for this endpoint
+    #     { request: { headers: { "Accept" => "application/json" }}},
+    #     { response: { body: { id: "abyasdjasd", status: "successful" }}}
+    #   )
+    #
+    # @example Stub a request to a registered service endpoint using block version
+    #   register_stub(:documents, :index) do
+    #     with(headers: { "Accept" => "application/json" }}})
+    #     to_return(body: "No content", status: 204)
+    #   end
+    #
+    # @see #stub_http_request
+    # @return [WebMock::RequestStub] a mocked request
+    #
+    # :reek:UtilityFunction
+    # :reek:LongParameterList { max_params: 5 }
+    def self.stub_endpoint(service_id, endpoint_id, uri_replacements = {}, options = {}, &callback)
+      service, endpoint, uri = StubRequests::URI.for_service_endpoint(service_id, endpoint_id, uri_replacements)
+      endpoint_stub          = WebMock::Builder.build(endpoint.verb, uri, options, &callback)
+
+      Metrics.record(service, endpoint, endpoint_stub)
+      ::WebMock::StubRegistry.instance.register_request_stub(endpoint_stub)
+    end
+
+    # @api private
+    # Used only for testing purposes
+    # :reek:LongParameterList { max_params: 4 }
+    def self.__stub_endpoint(service_id, endpoint_id, uri_replacements = {}, options = {})
+      _service, endpoint, uri = StubRequests::URI.for_service_endpoint(service_id, endpoint_id, uri_replacements)
+      endpoint_stub           = WebMock::Builder.build(endpoint.verb, uri, options)
+
+      ::WebMock::StubRegistry.instance.register_request_stub(endpoint_stub)
+    end
+  end
+end

data/lib/stub_requests/registration/endpoint.rb

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

data/lib/stub_requests/registration/endpoints.rb

@@ -0,0 +1,156 @@
+# 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 Endpoints manages a collection of endpoints
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    #
+    class Endpoints
+      include Enumerable
+
+      #
+      # @!attribute [rw] endpoints
+      #   @return [Concurrent::Map<Symbol, Endpoint>] a map with endpoints
+      attr_reader :endpoints
+
+      def initialize
+        @endpoints = Concurrent::Map.new
+      end
+
+      #
+      # Required by Enumerable
+      #
+      # @return [Concurrent::Map<Symbol, Service>] a map with endpoints
+      #
+      # @yield used by Enumerable
+      #
+      def each(&block)
+        endpoints.each(&block)
+      end
+
+      #
+      # Registers an endpoint in the collection
+      #
+      # @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>] options default options
+      #
+      # @return [Endpoint]
+      #
+      # :reek:LongParameterList { max_params: 4 }
+      def register(endpoint_id, verb, uri_template, options = {})
+        endpoint =
+          if (endpoint = find(endpoint_id))
+            StubRequests.logger.warn("Endpoint already registered: #{endpoint}")
+            endpoint.update(verb, uri_template, options)
+          else
+            Endpoint.new(endpoint_id, verb, uri_template, options)
+          end
+
+        endpoints[endpoint.id] = endpoint
+        endpoint
+      end
+
+      #
+      # Updates an endpoint
+      #
+      # @param [Symbol] endpoint_id the id of 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 request options
+      # @option options [optional, Hash<Symbol>] :response options
+      # @option options [optional, Array, Exception, StandardError, String] :error to raise
+      # @option options [optional, TrueClass] :timeout raise a timeout error?
+      #
+      # @raise [EndpointNotFound] when the endpoint couldn't be found
+      #
+      # @return [Endpoint] returns the updated endpoint
+      #
+      # :reek:LongParameterList { max_params: 4 }
+      def update(endpoint_id, verb, uri_template, options)
+        endpoint = find!(endpoint_id)
+        endpoint.update(verb, uri_template, options)
+      end
+
+      #
+      # Removes an endpoint from the collection
+      #
+      # @param [Symbol] endpoint_id the id of the endpoint, `:file_service`
+      #
+      # @return [Endpoint] the endpoint that was removed
+      #
+      def remove(endpoint_id)
+        endpoints.delete(endpoint_id)
+      end
+
+      #
+      # Fetches an endpoint from the collection
+      #
+      # @param [<type>] endpoint_id <description>
+      #
+      # @return [Endpoint]
+      #
+      def find(endpoint_id)
+        endpoints[endpoint_id]
+      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, nil]
+      #
+      def find!(endpoint_id)
+        find(endpoint_id) || raise(EndpointNotFound, "Couldn't find an endpoint with id=:#{endpoint_id}")
+      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
+end

data/lib/stub_requests/registration/registry.rb

@@ -0,0 +1,112 @@
+# 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 Registry provides registration of services
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    #
+    class Registry
+      include Singleton
+      include Enumerable
+
+      #
+      # @!attribute [rw] services
+      #   @return [Concurrent::Map<Symbol, Service>] a map with services
+      attr_reader :services
+
+      def initialize
+        @services = Concurrent::Map.new
+      end
+
+      #
+      # Resets the map with registered services
+      #
+      #
+      # @api private
+      def reset
+        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
+      #
+      #
+      # @param [Symbol] service_id a symbolic id of the service
+      # @param [String] service_uri a string with a base_uri to the service
+      #
+      # @return [Registration::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}")
+          raise ServiceHaveEndpoints, service if service.endpoints?
+        end
+        services[service_id] = Service.new(service_id, service_uri)
+      end
+
+      #
+      # Removes a service from the registry
+      #
+      #
+      # @param [Symbol] service_id the service_id to remove
+      #
+      # @raise [ServiceNotFound] when the service was not removed
+      #
+      def remove(service_id)
+        services.delete(service_id) || raise(ServiceNotFound, service_id)
+      end
+
+      #
+      # Fetches a service from the registry
+      #
+      #
+      # @param [Symbol] service_id id of the service to remove
+      #
+      # @return [Registration::Service] the found service
+      #
+      def find(service_id)
+        services[service_id]
+      end
+
+      #
+      # Fetches a service from the registry or raises {ServiceNotFound}
+      #
+      #
+      # @param [Symbol] service_id the id of a service
+      #
+      # @raise [ServiceNotFound] when an endpoint couldn't be found
+      #
+      # @return [Registration::Service]
+      #
+      def find!(service_id)
+        find(service_id) || raise(ServiceNotFound, service_id)
+      end
+    end
+  end
+end