stub_requests 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be0196cbd37c83eff04abe21413a0bded52b335db5437e6c31eaf79b7484d81b
-  data.tar.gz: 2c4d16e0b0d23d285a7b2532cbb6d3f3507348c05f473bacdfe52dee352ff1e2
+  metadata.gz: 981c31047c2aad42cd7c11962cb1429e742dfda6ed6656485a78d4b83f5acd78
+  data.tar.gz: 49b9c4cfd8fde9f4ab99429fcd5ae02b68809f98d47009b43b880f7802d09202
 SHA512:
-  metadata.gz: dd5f10556ecfb6aef179cf59dcfaf5938eadbda4c7ae64f0556ffd2502caf434e0747e1f3b8e7ed73a7e99a2636f23fb825967c5dea919ccc486ae8156da2973
-  data.tar.gz: 78e59cb1fbe7ad99282f0162ab0cdb7cbe97a77647dd5be0055edc6e106ac132fd48cd6fe92a764551719e541c114949081b1ed8c6e2b91a92be990f75b10358
+  metadata.gz: 725506e6bfec1e4088bd8cbe436c33c285a0a0d7e7a9601cb6257d4f9375a321ba3ea663e5bcbf81a3d2dbdb5aac75b265676cbcbec220faaf6856706ec12de4
+  data.tar.gz: eafe65b7a4cec3296935ac42745480a486a1929c5f95a62b8ba9f438317f4ce7d6291724aaece80352e36728193a88cfe782d11651198c349ada37ef560bce7c

data/.reek.yml

@@ -12,3 +12,4 @@ exclude_paths:
   - vendor/bundle
   - gemfiles
   - lib/stub_requests/core_ext/
+  - spec/

data/CHANGELOG.md

@@ -6,6 +6,7 @@
 
 **Implemented enhancements:**
 
+- Add rough initial implementation of subscriptions [\#12](https://github.com/mhenrixon/stub_requests/pull/12) ([mhenrixon](https://github.com/mhenrixon))
 - 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))
@@ -14,6 +15,7 @@
 
 **Merged pull requests:**
 
+- Update Changelog [\#11](https://github.com/mhenrixon/stub_requests/pull/11) ([mhenrixon](https://github.com/mhenrixon))
 - Allow older webmock versions [\#4](https://github.com/mhenrixon/stub_requests/pull/4) ([mhenrixon](https://github.com/mhenrixon))
 - Add docs folder [\#3](https://github.com/mhenrixon/stub_requests/pull/3) ([mhenrixon](https://github.com/mhenrixon))
 - Add docs folder and CHANGELOG.md [\#2](https://github.com/mhenrixon/stub_requests/pull/2) ([mhenrixon](https://github.com/mhenrixon))

data/README.md

@@ -131,12 +131,12 @@ end
 
 callback = ->(request) { p request; binding.pry }
 
-StubRequests.subscribe_to(:document_service, :show, :get, callback)
+StubRequests.register(:document_service, :show, :get, callback)
 ```
 
 ```ruby
 # To unsubscribe from notifications
-StubRequests.unsubscribe_from(:document_service, :show, :get)
+StubRequests.unregister(:document_service, :show, :get)
 ```
 
 <a id="future-improvements"></a>

data/lib/stub_requests/api.rb

@@ -47,7 +47,7 @@ module StubRequests
     #
     # :reek:UtilityFunction
     def register_service(service_id, service_uri, &block)
-      StubRequests::Registration.register_service(service_id, service_uri, &block)
+      StubRequests::ServiceRegistry.register_service(service_id, service_uri, &block)
     end
 
     #
@@ -56,24 +56,10 @@ module StubRequests
     #
     # @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
+    # @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
-    #     { 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" }}})
@@ -85,8 +71,8 @@ module StubRequests
     #
     # :reek:UtilityFunction
     # :reek:LongParameterList { max_params: 5 }
-    def stub_endpoint(service_id, endpoint_id, uri_replacements = {}, options = {}, &callback)
-      StubRequests::Registration.stub_endpoint(service_id, endpoint_id, uri_replacements, options, &callback)
+    def stub_endpoint(service_id, endpoint_id, route_params = {}, &callback)
+      StubRequests::ServiceRegistry.stub_endpoint(service_id, endpoint_id, route_params, &callback)
     end
 
     #
@@ -101,8 +87,8 @@ module StubRequests
     #
     # :reek:UtilityFunction
     # :reek:LongParameterList
-    def subscribe_to(service_id, endpoint_id, verb, callback)
-      StubRequests::Observable.subscribe_to(service_id, endpoint_id, verb, callback)
+    def register_callback(service_id, endpoint_id, verb, callback)
+      StubRequests::CallbackRegistry.register(service_id, endpoint_id, verb, callback)
     end
 
     #
@@ -114,8 +100,8 @@ module StubRequests
     # @return [void]
     #
     # :reek:UtilityFunction
-    def unsubscribe_from(service_id, endpoint_id, verb)
-      StubRequests::Observable.unsubscribe_from(service_id, endpoint_id, verb)
+    def unregister_callback(service_id, endpoint_id, verb)
+      StubRequests::CallbackRegistry.unregister(service_id, endpoint_id, verb)
     end
   end
 end

data/lib/stub_requests/callback.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Class Callback contains information about a subscription
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.3
+  #
+  class Callback
+    include Property
+    #
+    # @!attribute [rw] service_id
+    #   @return [Symbol] the id of a service
+    property :service_id, type: Symbol
+    #
+    # @!attribute [rw] endpoint_id
+    #   @return [Symbol] the id of an endpoint
+    property :endpoint_id, type: Symbol
+    #
+    # @!attribute [rw] verb
+    #   @return [Symbol] the HTTP verb/method
+    property :verb, type: Symbol, default: :any
+    #
+    # @!attribute [rw] callback
+    #   @return [Proc] a proc to callback on notify
+    property :callback, type: Proc
+
+    #
+    # Initialize a new Callback
+    #
+    # @param [Symbol] service_id the id of a service
+    # @param [Symbol] endpoint_id the id of an endpoint
+    # @param [Symbol] verb the HTTP verb/method
+    # @param [Proc] callback a proc to callback on notify
+    #
+    def initialize(service_id, endpoint_id, verb, callback)
+      self.service_id  = service_id
+      self.endpoint_id = endpoint_id
+      self.verb        = verb
+      self.callback    = callback
+    end
+
+    def call(*args)
+      callback.call(*args)
+    end
+
+    def arity
+      callback.arity
+    end
+  end
+end

data/lib/stub_requests/callback_registry.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  #
+  # Class Registry handles callbacks to webmock requests
+  #
+  # @author Mikael Henriksson <mikael@zoolutions.se>
+  # @since 0.1.3
+  #
+  # :reek:UtilityFunction
+  # :reek:DataClump
+  # :reek:FeatureEnvy
+  class CallbackRegistry
+    include Singleton
+    include Enumerable
+
+    #
+    # Register to a service endpoint call
+    # @see CallbackRegistry#register
+    #
+    #
+    # @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 [Callback]
+    #
+    # :reek:LongParameterList
+    def self.register(service_id, endpoint_id, verb, callback)
+      instance.register(service_id, endpoint_id, verb, callback)
+    end
+
+    #
+    # Unregister from a service endpoint call
+    # @see CallbackRegistry#unregister
+    #
+    #
+    # @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 [Callback]
+    #
+    def self.unregister(service_id, endpoint_id, verb)
+      instance.unregister(service_id, endpoint_id, verb)
+    end
+
+    #
+    # Notifies subscribers that a request was made
+    # @see CallbackRegistry#invoke_callbacks
+    #
+    #
+    # @param [RequestStub] request the stubbed request
+    #
+    # @return [RequestStub]
+    #
+    def self.invoke_callbacks(request)
+      instance.invoke_callbacks(request)
+    end
+
+    #
+    # @!attribute [r] callbacks
+    #   @return [Concurrent::Array<Callback>] a list of callbacks
+    attr_reader :callbacks
+
+    #
+    # Used by Singleton
+    #
+    #
+    def initialize
+      @callbacks = Concurrent::Array.new
+    end
+
+    #
+    # Resets the map with registered services
+    #
+    #
+    # @api private
+    def reset
+      callbacks.clear
+    end
+
+    #
+    # Required by Enumerable
+    #
+    #
+    # @return [Concurrent::Array<Callback>] a list with callbacks
+    #
+    # @yield used by Enumerable
+    #
+    def each(&block)
+      callbacks.each(&block)
+    end
+
+    #
+    # Register to a service endpoint call
+    #
+    #
+    # @param [Symbol] service_id the id of a service
+    # @param [Symbol] endpoint_id the id of an endpoint
+    # @param [optional, Symbol] verb the HTTP verb to subscribe to
+    # @param [proc] block the callback to use for when.a request was made
+    #
+    # @return [Callback] the added callback
+    #
+    # :reek:LongParameterList
+    def register(service_id, endpoint_id, verb, block)
+      callback = find_by(service_id, endpoint_id, verb)
+      return callback if callback
+
+      callback = Callback.new(service_id, endpoint_id, verb, block)
+      callbacks.push(callback)
+      callback
+    end
+
+    #
+    # Unregister to a service endpoint call
+    #
+    #
+    # @param [Symbol] service_id the id of a service
+    # @param [Symbol] endpoint_id the id of an endpoint
+    # @param [optional, Symbol] verb the HTTP verb to subscribe to
+    #
+    # @return [Callback] the deleted callback
+    #
+    # :reek:ControlParameter
+    def unregister(service_id, endpoint_id, verb)
+      return unless (callback = find_by(service_id, endpoint_id, verb))
+
+      callbacks.delete(callback)
+    end
+
+    #
+    # Notifies subscribers that a request was made
+    #
+    # @param [RequestStub] request the stubbed request
+    #
+    # @return [void]
+    #
+    def invoke_callbacks(request)
+      return unless (callback = find_by(request.service_id, request.endpoint_id, request.verb))
+
+      dispatch_callback(request, callback)
+    end
+
+    private
+
+    #
+    # Finds a callback for a service endpoint
+    #
+    #
+    # @param [Symbol] service_id the id of a service
+    # @param [Symbol] endpoint_id the id of an endpoint
+    # @param [optional, Symbol] verb the HTTP verb to subscribe to
+    #
+    # @return [Callback]
+    #
+    # :reek:ControlParameter
+    # :reek:DuplicateMethodCall
+    def find_by(service_id, endpoint_id, verb)
+      find do |sub|
+        sub.service_id == service_id &&
+          sub.endpoint_id == endpoint_id &&
+          ([sub.verb, verb].include?(:any) || sub.verb == verb)
+      end
+    end
+
+    def dispatch_callback(request_stub, callback)
+      arity = callback.arity
+
+      case arity
+      when 0
+        callback.call
+      when 1
+        callback.call(request_stub)
+      else
+        raise InvalidCallback, "The callback for a callback can either take 0 or 1 arguments (was #{arity})"
+      end
+    end
+  end
+end

data/lib/stub_requests/core_ext/all.rb

@@ -5,3 +5,4 @@ require "stub_requests/core_ext/kernel/singleton_class"
 require "stub_requests/core_ext/module/redefine_method"
 require "stub_requests/core_ext/class/attribute"
 require "stub_requests/core_ext/object/blank"
+require "stub_requests/core_ext/string/to_route_param"

data/lib/stub_requests/core_ext/array/extract_options.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-# @see Hash
-# @api private
+# :nodoc:
 class Hash
   # @api private
   def extractable_options?
@@ -9,10 +8,9 @@ class Hash
   end
 end
 
-# @see Array
-# @api private
+# :nodoc:
 class Array
-  # @api private
+  # :nodoc:
   def extract_options!
     if last.is_a?(Hash) && last.extractable_options?
       pop
@@ -21,7 +19,7 @@ class Array
     end
   end
 
-  # @api private
+  # :nodoc:
   def extract_options
     if last.is_a?(Hash) && last.extractable_options?
       last

data/lib/stub_requests/core_ext/class/attribute.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 unless defined?(Rails) || defined?(ActiveSupport)
-  # See {Class}
-  # @api private
+  # :nodoc:
   class Class
-    # @api private
+    # :nodoc:
     def class_attribute(*attrs)
       options       = attrs.extract_options!
       default_value = options.fetch(:default, nil)

data/lib/stub_requests/core_ext/kernel/singleton_class.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 unless defined?(Rails) || defined?(ActiveSupport)
-  # See {Class}
-  # @api private
+  # :nodoc:
   module Kernel
-    # @api private
+    # :nodoc:
     def class_eval(*args, &block)
       singleton_class.class_eval(*args, &block)
     end

data/lib/stub_requests/core_ext/module/redefine_method.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+# :nodoc:
+
 unless defined?(Rails) || defined?(ActiveSupport)
   # See {Module}
   # @api private
   class Module
     # @api private
+    # :nodoc:
     def silence_redefinition_of_method(method)
       if method_defined?(method) || private_method_defined?(method)
         alias_method :__rails_redefine, method
@@ -15,6 +18,7 @@ unless defined?(Rails) || defined?(ActiveSupport)
     # Replaces the existing method definition, if there is one, with the passed
     # block as its body.
     # @api private
+    # :nodoc:
     def redefine_method(method, &block)
       visibility = method_visibility(method)
       silence_redefinition_of_method(method)
@@ -25,11 +29,13 @@ unless defined?(Rails) || defined?(ActiveSupport)
     # Replaces the existing singleton method definition, if there is one, with
     # the passed block as its body.
     # @api private
+    # :nodoc:
     def redefine_singleton_method(method, &block)
       singleton_class.redefine_method(method, &block)
     end
 
     # @api private
+    # :nodoc:
     def method_visibility(method) # :nodoc:
       case
       when private_method_defined?(method)

data/lib/stub_requests/core_ext/object/blank.rb

@@ -4,76 +4,75 @@
 
 unless defined?(Rails) || defined?(ActiveSupport)
 
-  # @see Object
-  # @api private
+  # :nodoc:
   class Object
-    # @api private
+    # :nodoc:
     def blank?
       respond_to?(:empty?) ? !!empty? : !self # rubocop:disable Style/DoubleNegation
     end
-    # @api private
+    # :nodoc:
     def present?
       !blank?
     end
-    # @api private
+    # :nodoc:
     def presence
       self if present?
     end
   end
 
   # @see NilClass
-  # @api private
+  # :nodoc:
   class NilClass
-    # @api private
+    # :nodoc:
     def blank?
       true
     end
   end
 
   # @see FalseClass
-  # @api private
+  # :nodoc:
   class FalseClass
-    # @api private
+    # :nodoc:
     def blank?
       true
     end
   end
 
   # @see TrueClass
-  # @api private
+  # :nodoc:
   class TrueClass
-    # @api private
+    # :nodoc:
     def blank?
       false
     end
   end
 
   # @see Array
-  # @api private
+  # :nodoc:
   class Array
-    # @api private
+    # :nodoc:
     alias blank? empty?
   end
 
   # @see Hash
-  # @api private
+  # :nodoc:
   class Hash
-    # @api private
+    # :nodoc:
     alias blank? empty?
   end
 
   # @see String
   class String
     # :nodoc:
-    # @api private
+    # :nodoc:
     BLANK_RE = /\A[[:space:]]*\z/.freeze
     # :nodoc:
-    # @api private
+    # :nodoc:
     ENCODED_BLANKS = Concurrent::Map.new do |map, enc|
       map[enc] = Regexp.new(BLANK_RE.source.encode(enc), BLANK_RE.options | Regexp::FIXEDENCODING)
     end
 
-    # @api private
+    # :nodoc:
     def blank?
       # The regexp that matches blank strings is expensive. For the case of empty
       # strings we can speed up this method (~3.5x) with an empty? call. The
@@ -96,18 +95,18 @@ unless defined?(Rails) || defined?(ActiveSupport)
   end
 
   # @see Numeric
-  # @api private
+  # :nodoc:
   class Numeric
-    # @api private
+    # :nodoc:
     def blank?
       false
     end
   end
 
   # @see Time
-  # @api private
+  # :nodoc:
   class Time
-    # @api private
+    # :nodoc:
     def blank?
       false
     end

data/lib/stub_requests/core_ext/string/to_route_param.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# :nodoc:
+# @api private
+class String
+  # :nodoc:
+  # @api private
+  def to_route_param
+    return self if start_with?(":")
+
+    ":#{+self}"
+  end unless method_defined?(:to_route_param)
+end
+
+# :nodoc:
+# @api private
+class Symbol
+  # :nodoc:
+  # @api private
+  def to_route_param
+    to_s.to_route_param
+  end unless method_defined?(:to_route_param)
+end
+
+# :nodoc:
+# @api private
+class Hash
+  # :nodoc:
+  # @api private
+  def to_route_param
+    each_with_object({}) do |(key, value), memo|
+      memo[key.to_route_param] = value
+    end
+  end unless method_defined?(:to_route_param)
+end

data/lib/stub_requests/dsl/define_method.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module StubRequests
+  class DSL
+    #
+    # Class DefineMethod defines helper methods for stubbed endpoints
+    #
+    # @author Mikael Henriksson <mikael@zoolutions.se>
+    # @since 0.1.4
+    #
+    class DefineMethod
+      #
+      # @!attribute [r] definition
+      #   @return [MethodDefinition] the method definition
+      attr_reader :definition
+      #
+      # @!attribute [r] receiver
+      #   @return [Module] the receiver of the method definition
+      attr_reader :receiver
+
+      #
+      # Initialize a new instance of DefineMethod
+      #
+      #
+      # @param [MethodDefinition] definition the method definition
+      # @param [Module] receiver the receiver of the method definition
+      #
+      def initialize(definition, receiver)
+        @receiver   = receiver
+        @definition = definition
+      end
+
+      #
+      # Define the {MethodDefinition#to_s} on the receiver
+      #
+      #
+      # @return [void]
+      #
+      def define
+        Docile.dsl_eval(receiver) do
+          silence_redefinition_of_method(definition.name)
+          module_eval <<~METHOD, __FILE__, __LINE__ + 1
+            #{definition}
+          METHOD
+        end
+      end
+    end
+  end
+end