stub_requests 0.1.1 → 0.1.2

data/lib/stub_requests/service_registry.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require "singleton"
-require "concurrent/map"
-
 #
 # Abstraction over WebMock to reduce duplication
 #
@@ -13,6 +10,8 @@ module StubRequests
   #
   # Class ServiceRegistry provides registration of services
   #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
   class ServiceRegistry
     include Singleton
     include Enumerable
@@ -56,8 +55,8 @@ module StubRequests
     #
     # @return [Service] the service that was just registered
     #
-    def register_service(service_id, service_uri)
-      if (service = get_service(service_id))
+    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
@@ -72,7 +71,7 @@ module StubRequests
     #
     # @raise [ServiceNotFound] when the service was not removed
     #
-    def remove_service(service_id)
+    def remove(service_id)
       services.delete(service_id) || raise(ServiceNotFound, service_id)
     end
 
@@ -84,7 +83,7 @@ module StubRequests
     #
     # @return [Service] the found service
     #
-    def get_service(service_id)
+    def find(service_id)
       services[service_id]
     end
 
@@ -98,8 +97,8 @@ module StubRequests
     #
     # @return [Endpoint]
     #
-    def get_service!(service_id)
-      get_service(service_id) || raise(ServiceNotFound, service_id)
+    def find!(service_id)
+      find(service_id) || raise(ServiceNotFound, service_id)
     end
   end
 end

data/lib/stub_requests/stub_requests.rb

@@ -7,57 +7,6 @@
 # @since 0.1.0
 #
 module StubRequests
-  #
-  # Error is a base class for all gem errors
-  #
-  class Error < StandardError; 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
-
-  #
-  # InvalidType is raised when an argument is invalid
-  #
-  class InvalidType < Error
-    def initialize(actual:, expected:)
-      super("Expected `#{actual}` to be any of [#{expected}]")
-    end
-  end
-
-  #
-  # EndpointNotFound is raised when an endpoint cannot be found
-  #
-  class EndpointNotFound < Error; end
-
-  #
-  # ServiceNotFound is raised when a service cannot be found
-  #
-  class ServiceNotFound < Error
-    def initialize(service_id)
-      super("Couldn't find a service with id=:#{service_id}")
-    end
-  end
-
-  #
-  # UriSegmentMismatch is raised when a segment cannot be replaced
-  #
-  class UriSegmentMismatch < Error; end
-
-  #
-  # InvalidUri is raised when a URI is invalid
-  #
-  class InvalidUri < Error
-    def initialize(uri)
-      super("'#{uri}' is not a valid URI.")
-    end
-  end
-
   # extends "self"
   # @!parse extend self
   extend self
@@ -78,6 +27,29 @@ module StubRequests
   #   @return [Logger] the logger to use in the gem
   attr_accessor :logger
 
+  #
+  # Allows the gem to be configured
+  #
+  #
+  # @return [Configuration] <description>
+  #
+  # @yieldparam [Configuration] config <description>
+  # @yieldreturn [<type>] <describe what yield should return>
+  def configure
+    yield(config) if block_given?
+    config
+  end
+
+  #
+  # Contains gem configuration
+  #
+  #
+  # @return [Configuration]
+  #
+  def config
+    @config ||= Configuration.new
+  end
+
   #
   # The current version of the gem
   #

data/lib/stub_requests/uri/builder.rb

@@ -8,12 +8,16 @@
 #
 module StubRequests
   #
-  # Builds a URI from a #host, #template and #replacements
+  # Module URI organizes all gem logic regarding URI
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
   #
   module URI
     #
     # Builder constructs and validates URIs
     #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    #
     # :reek:TooManyInstanceVariables { max_instance_variables: 6 }
     class Builder
       #

data/lib/stub_requests/uri/scheme.rb

@@ -8,7 +8,9 @@
 #
 module StubRequests
   #
-  # Provides convenience methods for URI
+  # Module URI organizes all gem logic regarding URI
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
   #
   module URI
     #

data/lib/stub_requests/uri/suffix.rb

@@ -7,6 +7,11 @@
 # @since 0.1.0
 #
 module StubRequests
+  #
+  # Module URI organizes all gem logic regarding URI
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  #
   module URI
     #
     # Module Suffix deals with validating {URI} suffix

data/lib/stub_requests/uri/validator.rb

@@ -8,7 +8,9 @@
 #
 module StubRequests
   #
-  # Provides convenience methods for URI
+  # Module URI organizes all gem logic regarding URI
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
   #
   module URI
     #

data/lib/stub_requests/uri.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module URI organizes all gem logic regarding URI
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  module URI
+    #
+    # 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
+    #
+    # @return [Array<Service, Endpoint, String] the service, endpoint and full URI
+    #
+    def self.for_service_endpoint(service_id, endpoint_id, replacements)
+      service  = ServiceRegistry.instance.find!(service_id)
+      endpoint = service.endpoints.find!(endpoint_id)
+      uri      = URI::Builder.build(service.uri, endpoint.uri_template, replacements)
+
+      [service, endpoint, uri]
+    end
+  end
+end

data/lib/stub_requests/version.rb

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

data/lib/stub_requests/webmock/builder.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module WebMock extends WebMock with more functionality
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  module WebMock
+    #
+    # Module Builder is responsible for building WebMock::RequestStub's
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @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
+      #
+      def self.build(verb, uri, options = {}, &callback)
+        new(verb, uri, options, &callback).build
+      end
+
+      #
+      # @!attribute [r] request_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
+      #
+      # @!attribute [r] callback
+      #   @return [Block] call back when given a block
+      attr_reader :callback
+
+      #
+      # Initializes a new instance of
+      #
+      #
+      # @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
+        @callback     = callback
+      end
+
+      #
+      # Prepares a WebMock::RequestStub and registers it in WebMock
+      #
+      #
+      # @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))
+      end
+    end
+  end
+end

data/lib/stub_requests/webmock/stub_registry_extension.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Module WebMock extends WebMock with more functionality
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.2
+  #
+  module WebMock
+    #
+    # Module StubRegistryExtension extends WebMock::StubRegistry with
+    #   recording of when a response was found and used for a WebMock::RequestStub
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @since 0.1.2
+    #
+    module StubRegistryExtension
+      # :nodoc:
+      def self.included(base)
+        base.class_eval do
+          alias_method :request_stub_for_orig, :request_stub_for
+          alias_method :request_stub_for, :request_stub_for_ext
+        end
+      end
+
+      private
+
+      def request_stub_for_ext(request_signature)
+        request_stub = request_stub_for_orig(request_signature)
+        return request_stub unless request_stub
+
+        Metrics::Registry.instance.mark_as_responded(request_stub)
+        request_stub
+      end
+    end
+  end
+end
+
+::WebMock::StubRegistry.send(:include, StubRequests::WebMock::StubRegistryExtension)

data/lib/stub_requests.rb

@@ -1,25 +1,43 @@
 # frozen_string_literal: true
 
-require "singleton"
+require "concurrent/array"
+require "concurrent/map"
 require "docile"
+require "singleton"
 require "webmock"
 require "webmock/api"
+require "webmock/stub_registry"
+require "webmock/request_stub"
 
 require "stub_requests/version"
 
 require "stub_requests/core_ext"
+require "stub_requests/exceptions"
 require "stub_requests/hash_util"
 require "stub_requests/argument_validation"
+require "stub_requests/property"
+require "stub_requests/property/validator"
+require "stub_requests/configuration"
+
 require "stub_requests/endpoint"
 require "stub_requests/endpoint_registry"
+
+require "stub_requests/metrics"
+require "stub_requests/metrics/endpoint_stat"
+require "stub_requests/metrics/registry"
+require "stub_requests/metrics/stub_stat"
+
 require "stub_requests/service"
 require "stub_requests/service_registry"
+
+require "stub_requests/uri"
 require "stub_requests/uri/scheme"
 require "stub_requests/uri/suffix"
 require "stub_requests/uri/validator"
 require "stub_requests/uri/builder"
-require "stub_requests/webmock_builder"
 
-require "stub_requests/api"
+require "stub_requests/webmock/builder"
+require "stub_requests/webmock/stub_registry_extension"
 
+require "stub_requests/api"
 require "stub_requests/stub_requests"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stub_requests
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-01 00:00:00.000000000 Z
+date: 2019-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -370,52 +370,7 @@ files:
 - _config.yml
 - bin/console
 - bin/setup
-- docs/.gitkeep
-- docs/Array.html
-- docs/FalseClass.html
-- docs/Hash.html
-- docs/NilClass.html
-- docs/Numeric.html
-- docs/Object.html
-- docs/String.html
-- docs/StubRequests.html
-- docs/StubRequests/API.html
-- docs/StubRequests/ArgumentValidation.html
-- docs/StubRequests/Endpoint.html
-- docs/StubRequests/EndpointNotFound.html
-- docs/StubRequests/EndpointRegistry.html
-- docs/StubRequests/Error.html
-- docs/StubRequests/HashUtil.html
-- docs/StubRequests/InvalidType.html
-- docs/StubRequests/InvalidUri.html
-- docs/StubRequests/Service.html
-- docs/StubRequests/ServiceHaveEndpoints.html
-- docs/StubRequests/ServiceNotFound.html
-- docs/StubRequests/ServiceRegistry.html
-- docs/StubRequests/URI.html
-- docs/StubRequests/URI/Builder.html
-- docs/StubRequests/URI/Scheme.html
-- docs/StubRequests/URI/Suffix.html
-- docs/StubRequests/URI/Validator.html
-- docs/StubRequests/UriSegmentMismatch.html
-- docs/StubRequests/WebMockBuilder.html
-- docs/Time.html
-- docs/TrueClass.html
-- docs/_config.yml
-- docs/_index.html
-- docs/class_list.html
-- docs/css/common.css
-- docs/css/full_list.css
-- docs/css/style.css
-- docs/file.README.html
-- docs/file_list.html
-- docs/frames.html
-- docs/index.html
-- docs/js/app.js
-- docs/js/full_list.js
-- docs/js/jquery.js
-- docs/method_list.html
-- docs/top-level-namespace.html
+- bin/update_docs.sh
 - gemfiles/.bundle/config
 - gemfiles/webmock_2.3.gemfile
 - gemfiles/webmock_2.3.gemfile.lock
@@ -424,24 +379,39 @@ files:
 - gemfiles/webmock_develop.gemfile
 - gemfiles/webmock_develop.gemfile.lock
 - index.md
+- lib/rspec/subject_as_lambda.rb
 - lib/stub_requests.rb
 - lib/stub_requests/api.rb
 - lib/stub_requests/argument_validation.rb
+- lib/stub_requests/configuration.rb
 - lib/stub_requests/core_ext.rb
 - lib/stub_requests/core_ext/all.rb
+- lib/stub_requests/core_ext/array/extract_options.rb
+- lib/stub_requests/core_ext/class/attribute.rb
+- lib/stub_requests/core_ext/kernel/singleton_class.rb
+- lib/stub_requests/core_ext/module/redefine_method.rb
 - lib/stub_requests/core_ext/object/blank.rb
 - lib/stub_requests/endpoint.rb
 - lib/stub_requests/endpoint_registry.rb
+- lib/stub_requests/exceptions.rb
 - lib/stub_requests/hash_util.rb
+- lib/stub_requests/metrics.rb
+- lib/stub_requests/metrics/endpoint_stat.rb
+- lib/stub_requests/metrics/registry.rb
+- lib/stub_requests/metrics/stub_stat.rb
+- lib/stub_requests/property.rb
+- lib/stub_requests/property/validator.rb
 - lib/stub_requests/service.rb
 - lib/stub_requests/service_registry.rb
 - lib/stub_requests/stub_requests.rb
+- lib/stub_requests/uri.rb
 - lib/stub_requests/uri/builder.rb
 - lib/stub_requests/uri/scheme.rb
 - lib/stub_requests/uri/suffix.rb
 - lib/stub_requests/uri/validator.rb
 - lib/stub_requests/version.rb
-- lib/stub_requests/webmock_builder.rb
+- lib/stub_requests/webmock/builder.rb
+- lib/stub_requests/webmock/stub_registry_extension.rb
 - lib/tasks/changelog.rake
 - lib/tasks/gem.rake
 - lib/tasks/git.rake