stub_requests 0.1.9 → 0.1.10

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
 
-        StubRequests::StubRegistry.mark_as_responded(request_stub)
+        StubRequests::StubRegistry.instance.mark_as_responded(request_stub)
         request_stub
       end
     end

data/lib/tasks/changelog.rake

@@ -12,18 +12,12 @@ task :changelog do
     --no-verbose
     --token
   ]
-  CHECKOUT_CHANGELOG_CMD ||= "git checkout -B update-changelog"
   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"
   # rubocop:enable Style/MutableConstant
 
+  sh("git checkout master")
   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)
-  sh("git checkout master")
 end

data/stub_requests.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "webmock",         ">= 2.3", "< 4.0"
   spec.add_dependency "concurrent-ruby", "~> 1.0", "< 2"
   spec.add_dependency "public_suffix",   "~> 3.0", "< 4"
+  spec.add_dependency "jaro_winkler",    "~> 1.0", "< 2"
 
   # ===== Basics =====
   spec.add_development_dependency "bundler",        ">= 2.0"

data/update_docs.sh

@@ -9,7 +9,7 @@ if [[ "$(git diff --stat)" != "" ]]; then
   git stash push -u -a -m "Before updating docs"
 fi;
 
-git reset --hard origin/master
+git pull --rebase
 
 rake yard
 
@@ -24,7 +24,7 @@ mv doc/* ./
 echo "Sending new documentation to github"
 git add --all
 git commit -a -m 'Update documentation'
-git push
+git push --force
 
 if [[ $stash_created == 1 ]]; then
   git stash pop

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stub_requests
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Mikael Henriksson
@@ -90,6 +90,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: jaro_winkler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -392,9 +412,12 @@ files:
 - lib/rspec/subject_as_lambda.rb
 - lib/stub_requests.rb
 - lib/stub_requests/api.rb
-- lib/stub_requests/argument_validation.rb
 - lib/stub_requests/callback.rb
 - lib/stub_requests/callback_registry.rb
+- lib/stub_requests/concerns/argument_validation.rb
+- lib/stub_requests/concerns/property.rb
+- lib/stub_requests/concerns/property/validator.rb
+- lib/stub_requests/concerns/register_verb.rb
 - lib/stub_requests/configuration.rb
 - lib/stub_requests/core_ext.rb
 - lib/stub_requests/core_ext/all.rb
@@ -408,13 +431,8 @@ files:
 - lib/stub_requests/dsl/define_method.rb
 - lib/stub_requests/dsl/method_definition.rb
 - lib/stub_requests/endpoint.rb
-- lib/stub_requests/endpoint_stub.rb
-- lib/stub_requests/endpoints.rb
+- lib/stub_requests/endpoint_registry.rb
 - lib/stub_requests/exceptions.rb
-- lib/stub_requests/hash_util.rb
-- lib/stub_requests/observable.rb
-- lib/stub_requests/property.rb
-- lib/stub_requests/property/validator.rb
 - lib/stub_requests/request_stub.rb
 - lib/stub_requests/service.rb
 - lib/stub_requests/service_registry.rb
@@ -425,6 +443,7 @@ files:
 - lib/stub_requests/uri/scheme.rb
 - lib/stub_requests/uri/suffix.rb
 - lib/stub_requests/uri/validator.rb
+- lib/stub_requests/utils/fuzzy.rb
 - lib/stub_requests/version.rb
 - lib/stub_requests/webmock/builder.rb
 - lib/stub_requests/webmock/stub_registry_extension.rb

data/lib/stub_requests/argument_validation.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require "addressable/uri"
-require "public_suffix"
-
-#
-# Abstraction over WebMock to reduce duplication
-#
-# @author Mikael Henriksson <mikael@zoolutions.se>
-# @since 0.1.0
-#
-module StubRequests
-  #
-  # Module ArgumentValidation provides validation of method arguments
-  #
-  # @author Mikael Henriksson <mikael@zoolutions.se>
-  #
-  module ArgumentValidation
-    extend self
-
-    #
-    # Require the value to be any of the types past in
-    #
-    #
-    # @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 [void]
-    #
-    def validate!(name:, value:, type:)
-      validate_type!(:name, name, [Symbol, String]) unless name
-      validate_type!(name, value, type) if type
-    end
-
-    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
-  end
-end

data/lib/stub_requests/endpoint_stub.rb

@@ -1,89 +0,0 @@
-# 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

@@ -1,246 +0,0 @@
-# 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]
-    #
-    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
-
-    #
-    # Convenience wrapper for register
-    #
-    #
-    # @example **Register a get endpoint**
-    # .  get("documents/:id", as: :documents_show)
-    #
-    # @param [String] path the path to the endpoint
-    # @param [Symbol] as the id of the endpoint
-    #
-    # @return [Endpoint] the registered endpoint
-    #
-    def any(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
-      register(as, __method__, path)
-    end
-
-    #
-    # Convenience wrapper for register
-    #
-    #
-    # @example **Register a get endpoint**
-    # .  get("documents/:id", as: :documents_show)
-    #
-    # @param [String] path the path to the endpoint
-    # @param [Symbol] as the id of the endpoint
-    #
-    # @return [Endpoint] the registered endpoint
-    #
-    def get(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
-      register(as, __method__, path)
-    end
-
-    #
-    # Register a :post endpoint
-    #
-    #
-    # @example **Register a post endpoint**
-    # .  post("documents", as: :documents_create)
-    #
-    # @param [String] path the path to the endpoint
-    # @param [Symbol] as the id of the endpoint
-    #
-    # @return [Endpoint] the registered endpoint
-    #
-    def post(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
-      register(as, __method__, path)
-    end
-
-    #
-    # Register a :patch endpoint
-    #
-    #
-    # @example **Register a patch endpoint**
-    # .  patch("documents/:id", as: :documents_update)
-    #
-    # @param [String] path the path to the endpoint
-    # @param [Symbol] as the id of the endpoint
-    #
-    # @return [Endpoint] the registered endpoint
-    #
-    def patch(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
-      register(as, __method__, path)
-    end
-
-    #
-    # Register a :put endpoint
-    #
-    #
-    # @example **Register a put endpoint**
-    # .  put("documents/:id", as: :documents_update)
-    #
-    # @param [String] path the path to the endpoint
-    # @param [Symbol] as the id of the endpoint
-    #
-    # @return [Endpoint] the registered endpoint
-    #
-    def put(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
-      register(as, __method__, path)
-    end
-
-    #
-    # Register a :delete endpoint
-    #
-    #
-    # @example **Register a delete endpoint**
-    # .  delete("documents/:id", as: :documents_destroy)
-    #
-    # @param [String] path the path to the endpoint
-    # @param [Symbol] as the id of the endpoint
-    #
-    # @return [Endpoint] the registered endpoint
-    #
-    def delete(path, as:) # rubocop:disable Naming/UncommunicativeMethodParamName
-      register(as, __method__, path)
-    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
-    #
-    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