stub_requests 0.1.3 → 0.1.4

data/lib/stub_requests/dsl/method_definition.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module StubRequests
+  class DSL
+    #
+    # Class DefineMethod generates method definition for a stubbed endpoint
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @since 0.1.4
+    #
+    class MethodDefinition
+      #
+      # @return [String]
+      BLOCK_ARG = "&block"
+
+      #
+      # @!attribute [r] service_id
+      #   @return [Symbol] the id of a registered service
+      attr_reader :service_id
+      #
+      # @!attribute [r] endpoint_id
+      #   @return [Symbol] the id of a registered endpoint
+      attr_reader :endpoint_id
+      #
+      # @!attribute [r] route_params
+      #   @return [Array<Symbol>] the URI parameters for the endpoint
+      attr_reader :route_params
+
+      #
+      # Initialize a new endpoint of {MethodDefinition}
+      #
+      # @param [Symbol] service_id the id of a registered service
+      # @param [Symbol] endpoint_id the id of a registered endpoint
+      # @param [Array<Symbol>] route_params the route parameter keys
+      #
+      def initialize(service_id, endpoint_id, route_params)
+        @service_id   = service_id
+        @endpoint_id  = endpoint_id
+        @route_params = route_params
+      end
+
+      #
+      # The name of this method
+      #
+      #
+      # @return [String] a string prefixed with stub_, `"stub_documents_show"`
+      #
+      def name
+        @name ||= "stub_#{endpoint_id}"
+      end
+
+      def to_s
+        <<~METHOD
+          def #{name}(#{keywords})
+            stub_endpoint(:#{service_id}, :#{endpoint_id}, #{arguments})
+          end
+        METHOD
+      end
+      alias to_str to_s
+
+      private
+
+      def keywords
+        @keywords ||= route_params.map { |param| "#{param}:" }.concat([+BLOCK_ARG]).join(", ")
+      end
+
+      def arguments
+        @arguments ||= route_params.map { |param| "#{param}: #{param}" }.concat([+BLOCK_ARG]).join(", ")
+      end
+    end
+  end
+end

data/lib/stub_requests/dsl.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module StubRequests
+  #
+  # Module DSL takes the id of a registered service
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.4
+  #
+  # @example **Register service with endpoints**
+  #   StubRequests.register_service(:documents, "https://company.com/api/v1") do
+  #     register_endpoints do
+  #       register(:show, :get, "documents/:id")
+  #       register(:index, :get, "documents")
+  #       register(:create, :post, "documents")
+  #     end
+  #   end
+  # @example **Create a receiver module for the stub methods**
+  #   module Stubs; end
+  #
+  #   Stubs.instance_methods #=> []
+  # @example **Define the endpoint methods using the DSL**
+  #   StubRequests::DSL.define_endpoint_methods(
+  #     :documents, receiver: Stubs
+  #   )
+  #
+  #   # This turns the module Stubs into the following:
+  #
+  #   Stubs.instance_methods #=> [:stub_documents_show, :stub_documents_index, :stub_documents_create]
+  #   module Stubs
+  #      def stub_documents_show(id:, &block)
+  #         stub_endpoint(:documents, :show, id: id, &block)
+  #      end
+  #
+  #      def stub_documents_index(&block)
+  #         stub_endpoint(:documents, :index, &block)
+  #      end
+  #
+  #      def stub_documents_create(&block)
+  #         stub_endpoint(:documents, :create, &block)
+  #      end
+  #    end
+  #
+  # @example **Use the helper methods in your tests**
+  #   include Stubs
+  #
+  #   let(:document_id)   { 1234 }
+  #   let(:request_body)  { { key: "value" }.to_json }
+  #   let(:response_body) { { id: document_id, key: "value" }.to_json }
+  #
+  #   before do
+  #     stub_documents_create do
+  #       with(body: request_body)
+  #       to_return(body: response_body)
+  #     end
+  #
+  #     stub_documents_show(id: document_id) do
+  #       with(body: request_body)
+  #       to_return(body: response_body)
+  #     end
+  #   end
+  #
+  #   it "stubs the requests nicely" do
+  #     create_uri = URI("https://company.com/api/v1/documents")
+  #     response   = Net::HTTP.post(create_uri)
+  #     expect(response).to be_json_eql(response_body.to_json)
+  #
+  #     show_uri = URI("https://company.com/api/v1/documents/#{document_id}")
+  #     response = Net::HTTP.post(create_uri)
+  #     expect(response).to be_json_eql(response_body.to_json)
+  #   end
+  class DSL
+    def self.define_endpoint_methods(service_id, receiver:)
+      new(service_id, receiver: receiver).define_endpoint_methods
+    end
+
+    attr_reader :service, :receiver, :endpoints
+
+    def initialize(service_id, receiver:)
+      @service   = StubRequests::ServiceRegistry.instance.find(service_id)
+      @receiver  = receiver
+      @endpoints = service.endpoints.endpoints.values
+    end
+
+    def define_endpoint_methods
+      receiver.send(:include, StubRequests::API)
+
+      endpoints.each do |endpoint|
+        definition = MethodDefinition.new(service.id, endpoint.id, endpoint.route_params)
+        DefineMethod.new(definition, receiver).define
+      end
+    end
+  end
+end

data/lib/stub_requests/endpoint.rb

@@ -17,9 +17,6 @@ module StubRequests
 
     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
@@ -29,57 +26,72 @@ module StubRequests
     #   @return [Symbol] a HTTP verb
     property :verb, type: Symbol
     #
-    # @!attribute [rw] uri_template
+    # @!attribute [rw] path
     #   @return [String] a string template for the endpoint
-    property :uri_template, type: String
+    property :path, type: String
+
+    #
+    # @!attribute [rw] service
+    #   @see
+    #   @return [Service] a service
+    attr_reader :service
+
+    #
+    # @!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
     #   @see
-    #   @return [Hash<Symbol>] a Hash with default request/response options
-    property :options, type: Hash, default: {}
+    #   @return [Array<Symbol>] an array with required route params
+    attr_reader :route_params
 
     #
-    # An endpoint for a specific {StubRequests::Registration::Service}
+    # An endpoint for a specific {StubRequests::Service}
     #
+    #
+    # @param [Service] service a registered 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(service, endpoint_id, verb, uri_template, options = {})
-      self.service      = service
-      self.id           = endpoint_id
-      self.verb         = verb
-      self.uri_template = uri_template
-      self.options      = options
+    # @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
+
+      @service      = service
+      @service_id   = service.id
+      @service_uri  = service.uri
+      @route_params = URI.route_params(path)
     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
+    # @param [String] path how to reach the endpoint
+    #
+    # @return [Endpoint] returns the updated endpoint
+    #
+    def update(verb, path)
+      self.verb = verb
+      self.path = path
       self
     end
 
     def <=>(other)
-      id <=> other.id
+      service_id <=> other.service_id &&
+        id <=> other.id
     end
 
     def hash
@@ -94,7 +106,7 @@ module StubRequests
     # @return [String]
     #
     def to_s
-      "#<#{self.class} id=:#{id} verb=:#{verb} uri_template='#{uri_template}'>"
+      "#<#{self.class} id=:#{id} verb=:#{verb} path='#{path}'>"
     end
   end
 end

data/lib/stub_requests/endpoint_stub.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Class Endpoint provides metrics for stubbed endpoints
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  class EndpointStub
+    # includes "Enumerable"
+    # @!parse include Enumerable
+    include Enumerable
+    # @api private
+    include Property
+    # @api private
+
+    #
+    # @!attribute [r] service_id
+    #   @return [Symbol] the id of a {StubRequests::Service}
+    property :service_id, type: Symbol
+    #
+    # @!attribute [r] endpoint_id
+    #   @return [Symbol] the id of an endpoint
+    property :endpoint_id, type: Symbol
+    #
+    # @!attribute [r] verb
+    #   @return [String] the HTTP verb/method for this endpoint
+    property :verb, type: Symbol
+    #
+    # @!attribute [r] path
+    #   @return [String] the full URI template for the endpoint
+    property :path, type: String
+    #
+    # @!attribute [r] stubs
+    #   @return [Array] an array with recorded stubs
+    attr_reader :stubs
+
+    #
+    # Initializes a new Endpoint
+    #
+    # @param [Service] service a service
+    # @param [Endpoint] endpoint an endpoint
+    #
+    def initialize(service, endpoint)
+      self.service_id   = service.id
+      self.endpoint_id  = endpoint.id
+      self.verb         = endpoint.verb
+      self.path = [service.uri, endpoint.path].join("/")
+
+      @stubs = Concurrent::Array.new
+    end
+
+    def find_by(attribute:, value:)
+      find { |request| request.send(attribute) == value }
+    end
+
+    #
+    # Required by Enumerable
+    #
+    #
+    # @return [Concurrent::Map<Symbol, Service>] an map with services
+    #
+    # @yield used by Enumerable
+    #
+    def each(&block)
+      stubs.each(&block)
+    end
+
+    #
+    # Records a WebMock::RequestStub as stubbed
+    #
+    # @param [WebMock::RequestStub] webmock_stub <description>
+    #
+    # @return [RequestStub]
+    #
+    def record(webmock_stub)
+      request_stub = RequestStub.new(self, webmock_stub)
+      stubs.push(request_stub)
+      request_stub
+    end
+  end
+end

data/lib/stub_requests/endpoints.rb

@@ -0,0 +1,147 @@
+# 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 Endpoints
+    include Enumerable
+
+    #
+    # @!attribute [rw] service
+    #   @return [Service] the service the collection belongs to
+    attr_reader :service
+    #
+    # @!attribute [rw] endpoints
+    #   @return [Concurrent::Map<Symbol, Endpoint>] a map with endpoints
+    attr_reader :endpoints
+
+    def initialize(service)
+      @service   = service
+      @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] path the URI to reach the endpoint
+    #
+    # @return [Endpoint]
+    #
+    # :reek:LongParameterList { max_params: 4 }
+    def register(endpoint_id, verb, path)
+      endpoint =
+        if (endpoint = find(endpoint_id))
+          StubRequests.logger.warn("Endpoint already registered: #{endpoint}")
+          endpoint.update(verb, path)
+        else
+          Endpoint.new(service, endpoint_id, verb, path)
+        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] path the path to the endpoint
+    #
+    # @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, path)
+      endpoint = find!(endpoint_id)
+      endpoint.update(verb, path)
+    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

data/lib/stub_requests/observable.rb

@@ -14,49 +14,5 @@ module StubRequests
   # @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/request_stub.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Class Stub tracks the WebMock::RequestStub life cycle
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  # :reek:TooManyInstanceVariables
+  class RequestStub
+    include Property
+    extend Forwardable
+
+    # Delegate service_id, endpoint_id, verb and path to endpoint
+    delegate [:service_id, :endpoint_id, :verb, :path] => :endpoint
+    #
+    # @!attribute [r] endpoint
+    #   @return [StubRequests::EndpointStub] a stubbed endpoint
+    property :endpoint, type: StubRequests::EndpointStub
+    #
+    # @!attribute [r] verb
+    #   @return [Symbol] a HTTP verb/method
+    property :verb, type: Symbol
+    #
+    # @!attribute [r] uri
+    #   @return [String] the full URI for this endpoint
+    property :uri, type: String
+    #
+    # @!attribute [r] request_stub
+    #   @return [WebMock::RequestStub] a webmock stubbed request
+    property :request_stub, type: WebMock::RequestStub
+    #
+    # @!attribute [r] recorded_at
+    #   @return [Time] the time this record was recorded
+    property :recorded_at, type: Time
+    #
+    # @!attribute [r] recorded_from
+    #   @return [String] the relative path to the spec that recorded it
+    property :recorded_from, type: String
+    #
+    # @!attribute [r] responded_at
+    #   @return [Time] the time this stubs response was used
+    property :responded_at, type: Time
+
+    #
+    # Initialize a new Record
+    #
+    #
+    # @param [Endpoint] endpoint a stubbed endpoint
+    # @param [WebMock::RequestStub] request_stub the stubbed webmock request
+    #
+    def initialize(endpoint, request_stub)
+      request_pattern = request_stub.request_pattern
+      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
+
+    #
+    # Marks this record as having responded
+    #
+    #
+    # @return [Time] the time it was marked responded
+    #
+    def mark_as_responded
+      self.responded_at = Time.now
+    end
+  end
+end