stub_requests 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 521fcf52479aee73bde3bacc79d67c6d4a45032000b5db6c52aa74d11f96135b
-  data.tar.gz: a762b8db4bda856bf186c50974c16f2ca0668d9e3fe5dc77c84d6e096de938f6
+  metadata.gz: be0196cbd37c83eff04abe21413a0bded52b335db5437e6c31eaf79b7484d81b
+  data.tar.gz: 2c4d16e0b0d23d285a7b2532cbb6d3f3507348c05f473bacdfe52dee352ff1e2
 SHA512:
-  metadata.gz: 94eaf0edd7a35e83f6321189e775e6e90290ddfac63117e60f07b86aea9b84fffa6b363f8014e6629ff6214324c99d8b1686a113cd5f3a89ed8199191a200a18
-  data.tar.gz: 10084a0c36f0e7c857f19615312fe018fab42272468a72a74e62747113b15953e2706f25965d81f80f50a7d21f56b339d2c37d58b696ad41c274eb63cefbccce
+  metadata.gz: dd5f10556ecfb6aef179cf59dcfaf5938eadbda4c7ae64f0556ffd2502caf434e0747e1f3b8e7ed73a7e99a2636f23fb825967c5dea919ccc486ae8156da2973
+  data.tar.gz: 78e59cb1fbe7ad99282f0162ab0cdb7cbe97a77647dd5be0055edc6e106ac132fd48cd6fe92a764551719e541c114949081b1ed8c6e2b91a92be990f75b10358

data/.simplecov

@@ -24,6 +24,7 @@ SimpleCov.start do
   add_filter "/gemfiles/"
   add_filter "/lib/stub_requests/core_ext/array/extract_options.rb"
   add_filter "/lib/stub_requests/core_ext/class/attribute.rb"
+  add_filter "/lib/stub_requests/core_ext/object/blank.rb"
   add_filter "/lib/stub_requests/core_ext/kernel/singleton_class.rb"
   add_filter "/lib/stub_requests/core_ext/module/redefine_method.rb"
 end

data/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 [Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.0...HEAD)
 
+**Implemented enhancements:**
+
+- Script updating documentation [\#9](https://github.com/mhenrixon/stub_requests/pull/9) ([mhenrixon](https://github.com/mhenrixon))
+- Add a simple script to update documentation [\#8](https://github.com/mhenrixon/stub_requests/pull/8) ([mhenrixon](https://github.com/mhenrixon))
+- Improve documentation [\#7](https://github.com/mhenrixon/stub_requests/pull/7) ([mhenrixon](https://github.com/mhenrixon))
+- Initial metrics implementation [\#6](https://github.com/mhenrixon/stub_requests/pull/6) ([mhenrixon](https://github.com/mhenrixon))
+- Remove the docs folder in preference of a branch [\#5](https://github.com/mhenrixon/stub_requests/pull/5) ([mhenrixon](https://github.com/mhenrixon))
+
 **Merged pull requests:**
 
 - Allow older webmock versions [\#4](https://github.com/mhenrixon/stub_requests/pull/4) ([mhenrixon](https://github.com/mhenrixon))

data/README.md

@@ -14,11 +14,13 @@ This is achieve by keeping a registry over the service endpoints.
 
 <!-- MarkdownTOC -->
 
+- [Required ruby version](#required-ruby-version)
 - [Installation](#installation)
 - [Usage](#usage)
   - [Register service endpoints](#register-service-endpoints)
   - [Stubbing service endpoints](#stubbing-service-endpoints)
   - [Metrics](#metrics)
+  - [Observing endpoint invocations](#observing-endpoint-invocations)
 - [Future Improvements](#future-improvements)
   - [API Client Gem](#api-client-gem)
 - [Development](#development)
@@ -28,6 +30,11 @@ This is achieve by keeping a registry over the service endpoints.
 
 <!-- /MarkdownTOC -->
 
+<a id="required-ruby-version"></a>
+## Required ruby version
+
+Ruby version >= 2.3
+
 <a id="installation"></a>
 ## Installation
 
@@ -112,6 +119,26 @@ StubRequests.configure do |config|
 end
 ```
 
+<a id="observing-endpoint-invocations"></a>
+### Observing endpoint invocations
+
+```ruby
+# To jump into pry when a request is called
+callback = lambda do |request|
+  p request
+  binding.pry
+end
+
+callback = ->(request) { p request; binding.pry }
+
+StubRequests.subscribe_to(:document_service, :show, :get, callback)
+```
+
+```ruby
+# To unsubscribe from notifications
+StubRequests.unsubscribe_from(:document_service, :show, :get)
+```
+
 <a id="future-improvements"></a>
 ## Future Improvements
 

data/gemfiles/webmock_2.3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    stub_requests (0.1.1)
+    stub_requests (0.1.2)
       concurrent-ruby (~> 1.0, < 2)
       docile (~> 1.0, < 2)
       public_suffix (~> 3.0, < 4)

data/gemfiles/webmock_3.5.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    stub_requests (0.1.1)
+    stub_requests (0.1.2)
       concurrent-ruby (~> 1.0, < 2)
       docile (~> 1.0, < 2)
       public_suffix (~> 3.0, < 4)

data/gemfiles/webmock_develop.gemfile.lock

@@ -10,7 +10,7 @@ GIT
 PATH
   remote: ..
   specs:
-    stub_requests (0.1.1)
+    stub_requests (0.1.2)
       concurrent-ruby (~> 1.0, < 2)
       docile (~> 1.0, < 2)
       public_suffix (~> 3.0, < 4)

data/lib/stub_requests.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require "forwardable"
+require "singleton"
+
 require "concurrent/array"
 require "concurrent/map"
 require "docile"
-require "singleton"
 require "webmock"
 require "webmock/api"
 require "webmock/stub_registry"
@@ -11,30 +13,33 @@ require "webmock/request_stub"
 
 require "stub_requests/version"
 
+require "stub_requests/argument_validation"
 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/uri"
+require "stub_requests/uri/scheme"
+require "stub_requests/uri/suffix"
+require "stub_requests/uri/validator"
+require "stub_requests/uri/builder"
 require "stub_requests/configuration"
 
-require "stub_requests/endpoint"
-require "stub_requests/endpoint_registry"
+require "stub_requests/observable"
+require "stub_requests/observable/subscription"
+require "stub_requests/observable/registry"
 
 require "stub_requests/metrics"
-require "stub_requests/metrics/endpoint_stat"
+require "stub_requests/metrics/endpoint"
+require "stub_requests/metrics/request"
 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/registration"
+require "stub_requests/registration/endpoint"
+require "stub_requests/registration/endpoints"
+require "stub_requests/registration/service"
+require "stub_requests/registration/registry"
 
 require "stub_requests/webmock/builder"
 require "stub_requests/webmock/stub_registry_extension"

data/lib/stub_requests/api.rb

@@ -21,15 +21,6 @@ module StubRequests
     # @!parse extend self
     extend self
 
-    # :reek:LongParameterList { max_params: 4 }
-    # @api private
-    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
-
     # :nodoc:
     def self.included(base)
       base.send(:extend, self)
@@ -56,9 +47,7 @@ module StubRequests
     #
     # :reek:UtilityFunction
     def register_service(service_id, service_uri, &block)
-      service = ServiceRegistry.instance.register(service_id, service_uri)
-      Docile.dsl_eval(service.endpoints, &block) if block.present?
-      service
+      StubRequests::Registration.register_service(service_id, service_uri, &block)
     end
 
     #
@@ -97,11 +86,36 @@ module StubRequests
     # :reek:UtilityFunction
     # :reek:LongParameterList { max_params: 5 }
     def 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)
+      StubRequests::Registration.stub_endpoint(service_id, endpoint_id, uri_replacements, options, &callback)
+    end
+
+    #
+    # Subscribe to notifications for a service endpoint
+    #
+    # @param [Symbol] service_id the id of a service
+    # @param [Symbol] endpoint_id the id of an endpoint
+    # @param [Symbol] verb an HTTP verb/method
+    # @param [Proc] callback a Proc to call when receiving response
+    #
+    # @return [void]
+    #
+    # :reek:UtilityFunction
+    # :reek:LongParameterList
+    def subscribe_to(service_id, endpoint_id, verb, callback)
+      StubRequests::Observable.subscribe_to(service_id, endpoint_id, verb, callback)
+    end
 
-      Metrics.record(service, endpoint, endpoint_stub)
-      ::WebMock::StubRegistry.instance.register_request_stub(endpoint_stub)
+    #
+    # Unsubscribe from notifications for a service endpoint
+    #
+    # @param [Symbol] service_id the id of a service
+    # @param [Symbol] endpoint_id the id of an endpoint
+    #
+    # @return [void]
+    #
+    # :reek:UtilityFunction
+    def unsubscribe_from(service_id, endpoint_id, verb)
+      StubRequests::Observable.unsubscribe_from(service_id, endpoint_id, verb)
     end
   end
 end

data/lib/stub_requests/argument_validation.rb

@@ -22,29 +22,29 @@ module StubRequests
     # Require the value to be any of the types past in
     #
     #
-    # @param [Object] value the value to validate
-    # @param [Array<Class>, Array<Module>, Class, Module] is_a
+    # @param [Symbol] name the name of the argument
+    # @param [Object] value the actual value of the argument
+    # @param [Array, Class, Module] type nil the expected argument value class
     #
     # @raise [InvalidArgumentType] when the value is disallowed
     #
-    # @return [true] when the value is allowed
+    # @return [void]
     #
     # :reek:UtilityFunction
-    def validate!(name, value, is_a:)
-      validate! :name, name, is_a: [Symbol, String] unless name
+    def validate!(name:, value:, type:)
+      validate_type!(:name, name, [Symbol, String]) unless name
+      validate_type!(name, value, type) if type
+    end
 
-      expected_types = Array(is_a).flatten
-      return true if validate(value, expected_types)
+    # :reek:UtilityFunction
+    def validate_type!(name, value, type)
+      expected_types = Array(type).flatten
+      return if expected_types.any? { |is_a| value.is_a?(is_a) }
 
       raise StubRequests::InvalidArgumentType,
             name: name,
             actual: value.class,
             expected: expected_types
     end
-
-    # :reek:UtilityFunction
-    def validate(value, expected_types)
-      expected_types.any? { |type| value.is_a?(type) }
-    end
   end
 end

data/lib/stub_requests/endpoint.rb

@@ -13,24 +13,25 @@ module StubRequests
   # @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
@@ -38,7 +39,7 @@ module StubRequests
     property :options, type: Hash, default: {}
 
     #
-    # An endpoint for a specific {Service}
+    # An endpoint for a specific {StubRequests::Registration::Service}
     #
     # @param [Symbol] endpoint_id a descriptive id for the endpoint
     # @param [Symbol] verb a HTTP verb
@@ -49,11 +50,12 @@ module StubRequests
     # @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
+    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
     end
 
     #
@@ -67,7 +69,7 @@ module StubRequests
     # @option options [optional, Array, Exception, StandardError, String] :error for request_stub.to_raise
     # @option options [optional, TrueClass] :timeout for request_stub.to_timeout
     #
-    # @return [Endpoint] returns the updated endpoint
+    # @return [Registration::Endpoint] returns the updated endpoint
     #
     def update(verb, uri_template, options)
       self.verb            = verb

data/lib/stub_requests/exceptions.rb

@@ -18,13 +18,9 @@ module StubRequests
   class EndpointNotFound < Error; end
 
   #
-  # InvalidType is raised when an argument is invalid
+  # Class InvalidCallback is raised when a callback argument doesn't have the correct number of arguments
   #
-  class InvalidType < Error
-    def initialize(actual, expected)
-      super("Expected `#{actual}` to be any of [#{expected}]")
-    end
-  end
+  class InvalidCallback < Error; end
 
   #
   # InvalidArgumentType is raised when an argument is not of the expected type

data/lib/stub_requests/metrics.rb

@@ -8,7 +8,7 @@
 #
 module StubRequests
   #
-  # Module Metrics contains logic for collecting metrics about {EndpointStat} and {StubStat}
+  # Module Metrics contains logic for collecting metrics about {Metrics::Endpoint} and {Metrics::Request}
   #
   # @author Mikael Henriksson <mikael@zoolutions.se>
   # @since 0.1.2
@@ -17,11 +17,12 @@ module StubRequests
     #
     # Records metrics about stubbed endpoints
     #
-    # @param [Service] service a Service
-    # @param [Endpoint] endpoint an Endpoint
+    #
+    # @param [Registration::Service] service a Service
+    # @param [Registration::Endpoint] endpoint an Endpoint
     # @param [WebMock::RequestStub] endpoint_stub the stubbed webmock request
     #
-    # @return [EndpointStat] the stat that was recorded
+    # @return [Metrics::Endpoint] the stat that was recorded
     #
     def self.record(service, endpoint, endpoint_stub)
       return unless StubRequests.config.record_metrics?

data/lib/stub_requests/metrics/{endpoint_stat.rb → endpoint.rb}

@@ -8,7 +8,7 @@
 #
 module StubRequests
   #
-  # Module Metrics contains logic for collecting metrics about {EndpointStat} and {StubStat}
+  # Module Metrics contains logic for collecting metrics about requests stubs
   #
   # @author Mikael Henriksson <mikael@zoolutions.se>
   # @since 0.1.2
@@ -16,22 +16,22 @@ module StubRequests
   # :reek:TooManyInstanceVariables
   module Metrics
     #
-    # Class EndpointStat provides metrics for stubbed endpoints
+    # Class Endpoint provides metrics for stubbed endpoints
     #
     # @author Mikael Henriksson <mikael@zoolutions.se>
     # @since 0.1.2
     #
-    class EndpointStat
+    class Endpoint
       # includes "Enumerable"
       # @!parse include Enumerable
       include Enumerable
-
       # @api private
       include Property
+      # @api private
 
       #
       # @!attribute [r] service_id
-      #   @return [Symbol] the id of a {Service}
+      #   @return [Symbol] the id of a {StubRequests::Registration::Service}
       property :service_id, type: Symbol
       #
       # @!attribute [r] endpoint_id
@@ -44,28 +44,29 @@ module StubRequests
       #
       # @!attribute [r] uri_template
       #   @return [String] the full URI template for the endpoint
-      property :uri_template, type: Symbol
+      property :uri_template, type: String
       #
-      # @!attribute [r] stats
-      #   @return [Array] an array with recorded request_stubs
-      attr_reader :stats
+      # @!attribute [r] stubs
+      #   @return [Array] an array with recorded requests
+      attr_reader :requests
 
       #
-      # Initializes a new EndpointStat
+      # Initializes a new Endpoint
       #
-      # @param [Service] service a service
-      # @param [Endpoint] endpoint an endpoint
+      # @param [Registration::Service] service a service
+      # @param [Registration::Endpoint] endpoint an endpoint
       #
       def initialize(service, endpoint)
-        @service_id   = service.id
-        @endpoint_id  = endpoint.id
-        @verb         = endpoint.verb
-        @uri_template = [service.uri, endpoint.uri_template].join("/")
-        @stats        = Concurrent::Array.new
+        self.service_id   = service.id
+        self.endpoint_id  = endpoint.id
+        self.verb         = endpoint.verb
+        self.uri_template = [service.uri, endpoint.uri_template].join("/")
+
+        @requests = Concurrent::Array.new
       end
 
       def find_by(attribute:, value:)
-        find { |stat| stat.send(attribute) == value }
+        find { |request| request.send(attribute) == value }
       end
 
       #
@@ -77,7 +78,7 @@ module StubRequests
       # @yield used by Enumerable
       #
       def each(&block)
-        stats.each(&block)
+        requests.each(&block)
       end
 
       #
@@ -88,9 +89,9 @@ module StubRequests
       # @return [Record]
       #
       def record(request_stub)
-        stat = StubStat.new(self, request_stub)
-        stats.push(stat)
-        stat
+        request = Request.new(self, request_stub)
+        requests.push(request)
+        request
       end
     end
   end