stub_requests 0.1.3 → 0.1.4

data/lib/stub_requests/service.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Class Service provides details for a registered service
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
+  class Service
+    include Comparable
+    include Property
+
+    # @!attribute [rw] id
+    #   @return [Symbol] the id of the service
+    property :id, type: Symbol
+
+    # @!attribute [rw] uri
+    #   @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
+    #
+    # @param [Symbol] service_id the id of this service
+    # @param [String] service_uri the base uri to reach the service
+    #
+    def initialize(service_id, service_uri)
+      self.id    = service_id
+      self.uri   = service_uri
+      @endpoints = Endpoints.new(self)
+    end
+
+    #
+    # Check if the endpoint registry has endpoints
+    #
+    # @return [true,false]
+    #
+    def endpoints?
+      endpoints.any?
+    end
+
+    #
+    # Returns a nicely formatted string with this service
+    #
+    # @return [String]
+    #
+    def to_s
+      [
+        +"#<#{self.class}",
+        +" id=#{id}",
+        +" uri=#{uri}",
+        +" endpoints=#{endpoints.endpoints_string}",
+        +">",
+      ].join("")
+    end
+
+    def <=>(other)
+      id <=> other.id
+    end
+
+    def hash
+      [id, self.class].hash
+    end
+
+    alias eql? ==
+  end
+end

data/lib/stub_requests/service_registry.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Class Registry provides registration of services
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
+  class ServiceRegistry
+    include Singleton
+    include Enumerable
+
+    # 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 = 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>] route_params a map with route parameters
+    #
+    # @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
+    #   )
+    #   .to_return(body: "No content", status: 204)
+    #
+    # @example Stub a request to a registered service endpoint using block
+    #   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, route_params = {}, &callback)
+      service, endpoint, uri = StubRequests::URI.for_service_endpoint(service_id, endpoint_id, route_params)
+      endpoint_stub          = WebMock::Builder.build(endpoint.verb, uri, {}, &callback)
+
+      StubRegistry.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, 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
+    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 [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 [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 [Service]
+    #
+    def find!(service_id)
+      find(service_id) || raise(ServiceNotFound, service_id)
+    end
+  end
+end

data/lib/stub_requests/stub_registry.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # 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
+  #
+  # :reek:DataClump
+  class StubRegistry
+    # includes "Singleton"
+    # @!parse include Singleton
+    include Singleton
+    # includes "Enumerable"
+    # @!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
+
+    #
+    # 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
+
+    #
+    # 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 [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 [Service] the service that was just registered
+    #
+    def record(service, endpoint, webmock_stub)
+      endpoint = find_or_initialize_endpoint_stub(service, endpoint)
+      endpoint.record(webmock_stub)
+
+      endpoints.push(endpoint)
+      endpoint
+    end
+
+    #
+    # Mark a {RequestStub} as having responded
+    #
+    # @note Called when webmock responds successfully
+    #
+    # @param [WebMock::RequestStub] webmock_stub the stubbed webmock request
+    #
+    # @return [void]
+    #
+    def mark_as_responded(webmock_stub)
+      return unless (request_stub = find_request_stub(webmock_stub))
+
+      request_stub.mark_as_responded
+      CallbackRegistry.invoke_callbacks(request_stub)
+      request_stub
+    end
+
+    #
+    # Finds a {RequestStub} amongst the endpoint stubs
+    #
+    #
+    # @param [WebMock::RequestStub] webmock_stub a stubbed webmock response
+    #
+    # @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
+
+    # :reek:UtilityFunction
+    # :reek:FeatureEnvy
+    def find_endpoint_stub(service, endpoint)
+      find { |ep| ep.service_id == service.id && ep.endpoint_id == endpoint.id }
+    end
+
+    # :reek:UtilityFunction
+    def initialize_endpoint_stub(service, endpoint)
+      EndpointStub.new(service, endpoint)
+    end
+  end
+end

data/lib/stub_requests/uri/builder.rb

@@ -33,12 +33,12 @@ module StubRequests
       #
       # @param [String] host the URI used to reach the service
       # @param [String] template the endpoint template
-      # @param [Hash<Symbol>] replacements a list of uri_replacement keys
+      # @param [Hash<Symbol>] route_params a list of uri_replacement keys
       #
       # @return [String] a validated URI string
       #
-      def self.build(host, template, replacements = {})
-        new(host, template, replacements).build
+      def self.build(host, template, route_params = {})
+        new(host, template, route_params).build
       end
 
       #
@@ -54,12 +54,12 @@ module StubRequests
       #   @return [String] a valid URI path
       attr_reader :path
       #
-      # @!attribute [r] replacements
+      # @!attribute [r] route_params
       #   @return [Hash<Symbol] a hash with keys matching the {#template}
-      attr_reader :replacements
+      attr_reader :route_params
       #
       # @!attribute [r] unused
-      #   @return [Array<String>] a list with unused {#replacements}
+      #   @return [Array<String>] a list with unused {#route_params}
       attr_reader :unused
       #
       # @!attribute [r] unreplaced
@@ -72,13 +72,13 @@ module StubRequests
       #
       # @param [String] host the URI used to reach the service
       # @param [String] template the endpoint template
-      # @param [Hash<Symbol>] replacements a list of uri_replacement keys
+      # @param [Hash<Symbol>] route_params a list of uri_replacement keys
       #
-      def initialize(host, template, replacements = {})
+      def initialize(host, template, route_params = {})
         @host         = +host
         @template     = +template
         @path         = +@template.dup
-        @replacements = replacements
+        @route_params = route_params.to_route_param
       end
 
       #
@@ -109,38 +109,35 @@ module StubRequests
       end
 
       def run_validations
-        validate_replacements_used
-        validate_segments_replaced
+        validate_route_params_used
+        validate_route_keys_replaced
         validate_uri
       end
 
       #
-      # Replaces the URI segments with the arguments in replacements
+      # Replaces the URI segments with the arguments in route_params
       #
       #
-      # @return [Array] an list with unused replacements
+      # @return [Array] an list with unused route_params
       #
       def replace_segments
-        @unused = replacements.map do |key, value|
-          uri_segment = ":#{key}"
-          if path.include?(uri_segment)
-            path.gsub!(uri_segment.to_s, value.to_s)
-            next
-          else
-            uri_segment
-          end
+        @unused = route_params.map do |key, value|
+          next key unless path.include?(key)
+
+          path.gsub!(key, value.to_s)
+          next
         end.compact
       end
 
       #
-      # Validates that all replacements have been used
+      # Validates that all route_params have been used
       #
       #
-      # @raise [UriSegmentMismatch] when there are unused replacements
+      # @raise [UriSegmentMismatch] when there are unused route_params
       #
       # @return [void]
       #
-      def validate_replacements_used
+      def validate_route_params_used
         return if replacents_used?
 
         raise UriSegmentMismatch,
@@ -148,7 +145,7 @@ module StubRequests
       end
 
       #
-      # Checks that no replacements are left
+      # Checks that no route_params are left
       #
       #
       # @return [true,false]
@@ -165,26 +162,22 @@ module StubRequests
       #
       # @return [void]
       #
-      def validate_segments_replaced
-        return if segments_replaced?
+      def validate_route_keys_replaced
+        return if route_keys_replaced?
 
         raise UriSegmentMismatch,
               "The URI segment(s) [#{unreplaced.join(',')}]" \
               " were not replaced in template (#{path})." \
-              " Given replacements=[#{segment_keys.join(',')}]"
-      end
-
-      def segment_keys
-        @segment_keys ||= replacements.keys.map { |segment_key| ":#{segment_key}" }
+              " Given route_params=[#{route_params.keys.join(',')}]"
       end
 
       #
-      # Checks that all URI segments were replaced
+      # Checks that all URI keys were replaced
       #
       #
       # @return [true,false]
       #
-      def segments_replaced?
+      def route_keys_replaced?
         unreplaced.none?
       end
 

data/lib/stub_requests/uri.rb

@@ -14,19 +14,46 @@ module StubRequests
   # @since 0.1.2
   #
   module URI
+    #
+    # @return [Regexp] A pattern for matching route parameters
+    ROUTE_PARAM = %r{/:(\w+)/?}.freeze
+
+    #
+    # Extracts route parameters from a string
+    #
+    # @param [String] string a regular string to scan for route parameters
+    #
+    # @return [Array<Symbol>] an array with all route parameter keys
+    #
+    def self.route_params(string)
+      string.scan(ROUTE_PARAM).flatten.map(&:to_sym)
+    end
+
+    #
+    # Safely joins two string without any extra ///
+    #
+    # @param [String] host the host of the URI
+    # @param [String] path the path of the URI
+    #
+    # @return [String] the full URI
+    #
+    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>] replacements hash with replacements
+    # @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, replacements)
-      service  = Registration::Registry.instance.find!(service_id)
+    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.uri_template, replacements)
+      uri      = URI::Builder.build(service.uri, endpoint.path, route_params)
 
       [service, endpoint, uri]
     end

data/lib/stub_requests/version.rb

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

data/lib/stub_requests/webmock/stub_registry_extension.rb

@@ -36,7 +36,7 @@ module StubRequests
         request_stub = request_stub_for_orig(request_signature)
         return request_stub unless request_stub
 
-        Metrics::Registry.instance.mark_as_responded(request_stub)
+        StubRequests::StubRegistry.mark_as_responded(request_stub)
         request_stub
       end
     end

data/lib/stub_requests.rb

@@ -26,23 +26,23 @@ require "stub_requests/uri/validator"
 require "stub_requests/uri/builder"
 require "stub_requests/configuration"
 
-require "stub_requests/observable"
-require "stub_requests/observable/subscription"
-require "stub_requests/observable/registry"
+require "stub_requests/callback"
+require "stub_requests/callback_registry"
 
-require "stub_requests/metrics"
-require "stub_requests/metrics/endpoint"
-require "stub_requests/metrics/request"
-require "stub_requests/metrics/registry"
+require "stub_requests/endpoint_stub"
+require "stub_requests/request_stub"
+require "stub_requests/stub_registry"
 
-require "stub_requests/registration"
-require "stub_requests/registration/endpoint"
-require "stub_requests/registration/endpoints"
-require "stub_requests/registration/service"
-require "stub_requests/registration/registry"
+require "stub_requests/endpoints"
+require "stub_requests/endpoint"
+require "stub_requests/service"
+require "stub_requests/service_registry"
 
 require "stub_requests/webmock/builder"
 require "stub_requests/webmock/stub_registry_extension"
 
 require "stub_requests/api"
 require "stub_requests/stub_requests"
+require "stub_requests/dsl/method_definition"
+require "stub_requests/dsl/define_method"
+require "stub_requests/dsl"

data/lib/tasks/changelog.rake

@@ -13,7 +13,7 @@ task :changelog do
     --token
   ]
   CHECKOUT_CHANGELOG_CMD ||= "git checkout -B update-changelog"
-  COMMIT_CHANGELOG_CMD   ||= "git add --all"
+  ADD_CHANGELOG_CMD      ||= "git add --all"
   COMMIT_CHANGELOG_CMD   ||= "git commit -a -m 'Update changelog'"
   GIT_PUSH_CMD           ||= "git push -u origin update-changelog"
   OPEN_PR_CMD            ||= "hub pull-request -b master  -m 'Update Changelog' -a mhenrixon -l changelog"
@@ -21,6 +21,7 @@ task :changelog do
 
   sh(*CHANGELOG_CMD.push(ENV["CHANGELOG_GITHUB_TOKEN"]))
   sh(CHECKOUT_CHANGELOG_CMD)
+  sh(ADD_CHANGELOG_CMD)
   sh(COMMIT_CHANGELOG_CMD)
   sh(GIT_PUSH_CMD)
   sh(OPEN_PR_CMD)