stub_requests 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6f04591bc43a8c2ecb505a719517f6b07520c8ca85d603f6aa4b5f4219bbf25
-  data.tar.gz: 2ae8bde3a1d335d5a855809624a205fa386bb953a147f1486578eecde44c08d0
+  metadata.gz: a536f3b0a7ae3cf0c19b91fd9f3c00ba97990f192c0361a070e993702bc69c5e
+  data.tar.gz: a8bb04de37a709efaf4859a71ac81c9c360109faf392ef0505ebb3e195fb5e68
 SHA512:
-  metadata.gz: 2d6bbfaeb2eeaf0751bf8e3893229fc359b5cfd38f97f28aae23dde2ff26561c332ee3f6845fc52f288a533fcaed6cf3933a9ee201263482a7d15d62d4124663
-  data.tar.gz: 3aa7bd9c09bf54c62d6895a50edcdcfe37f966317da927c0cbb7bbb84b8bdb783c9346d559c2cad06fe573488f52a5a428d18d22d7a3e22162399dcd8b8d62ed
+  metadata.gz: 16c128e4b4a894c4478eaa697aafb84aa467d7c51a0d6086340f30dd7f8acf969254cb506d6a52bc19d6c0f148af18492c4461a4b07ba988b0ee01eb223d232e
+  data.tar.gz: c30405764a9064978698b3fdbf6046bd8a01cac0a2ace240b4b7f8092f7e1716f108e0b01a26fef24216ac444c134377a518a4537d97a69b18314d33adf0ee8c

data/.reek.yml

@@ -19,6 +19,7 @@ detectors:
       - RSpec::SubjectAsLambda#it!
   DataClump:
     exclude:
+      - StubRequests::Concerns::RegisterVerb
       - StubRequests::API
       - StubRequests::Endpoints
       - StubRequests::StubRegistry
@@ -27,20 +28,14 @@ detectors:
       - StubRequests::API#register_callback
       - StubRequests::CallbackRegistry#register
       - StubRequests::CallbackRegistry#self.register
-      - StubRequests::Property::Validator#self.call
+      - StubRequests::Concerns::Property::Validator#self.call
   UtilityFunction:
     exclude:
-      - StubRequests::API#define_stubs
-      - StubRequests::API#print_stubs
-      - StubRequests::API#register_callback
-      - StubRequests::API#register_service
-      - StubRequests::API#stub_endpoint
-      - StubRequests::API#unregister_callback
-      - StubRequests::StubRegistry#initialize_endpoint_stub
+      - StubRequests::API
   ControlParameter:
     exclude:
       - StubRequests::CallbackRegistry#find_by
-      - StubRequests::Property::Validator#initialize
+      - StubRequests::Concerns::Property::Validator#initialize
   FeatureEnvy:
     exclude:
       - StubRequests::CallbackRegistry#dispatch_callback
@@ -52,4 +47,5 @@ detectors:
       - StubRequests#logger
   TooManyInstanceVariables:
     exclude:
+      - StubRequests::Endpoint
       - StubRequests::URI::Builder

data/.rubocop.yml

@@ -49,6 +49,7 @@ Naming/FileName:
 Naming/UncommunicativeMethodParamName:
   AllowedNames:
     - ex
+    - id
 
 AlignLeftLetBrace:
   Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Change Log
 
+## [Unreleased](https://github.com/mhenrixon/stub_requests/tree/HEAD)
+
+[Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.9...HEAD)
+
+**Implemented enhancements:**
+
+- More helpful stub methods [\#29](https://github.com/mhenrixon/stub_requests/pull/29) ([mhenrixon](https://github.com/mhenrixon))
+
+**Merged pull requests:**
+
+- Update Changelog [\#28](https://github.com/mhenrixon/stub_requests/pull/28) ([mhenrixon](https://github.com/mhenrixon))
+
+## [v0.1.9](https://github.com/mhenrixon/stub_requests/tree/v0.1.9) (2019-02-07)
+[Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.8...v0.1.9)
+
+## [v0.1.8](https://github.com/mhenrixon/stub_requests/tree/v0.1.8) (2019-02-07)
+[Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.7...v0.1.8)
+
+**Merged pull requests:**
+
+- Reduce number of warnings [\#27](https://github.com/mhenrixon/stub_requests/pull/27) ([mhenrixon](https://github.com/mhenrixon))
+- Update Changelog [\#26](https://github.com/mhenrixon/stub_requests/pull/26) ([mhenrixon](https://github.com/mhenrixon))
+
 ## [v0.1.7](https://github.com/mhenrixon/stub_requests/tree/v0.1.7) (2019-02-07)
 [Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.6...v0.1.7)
 

data/README.md

@@ -84,7 +84,7 @@ Now we have a list of endpoints we can stub.
 ### Stubbing service endpoints
 
 ```ruby
-StubRequests.stub_endpoint(:google_ads, :index)
+StubRequests.stub_endpoint(:ads_index)
             .to_return(code: 204, body: "")
 
 # This is the equivalent of doing the following in WebMock
@@ -95,7 +95,7 @@ WebMock.stub_request(:get, "#{Settings.google_ads_base_uri}/ads")
 ```
 
 ```ruby
-StubRequests.stub_endpoint(:google_ads, :update, id: 1) do
+StubRequests.stub_endpoint(:ads_update, id: 1) do
   with(body: request_body.to_json)
   to_return(code: 200, body: response_body.to_json)
 end
@@ -117,7 +117,7 @@ Metrics collection are by default turned off. It can be turned on by the followi
 
 ```ruby
 StubRequests.configure do |config|
-  config.record_metrics = true
+  config.record_stubs = true
 end
 ```
 
@@ -233,32 +233,32 @@ StubRequests.print_stubs(:documents)
 #
 module DocumentStubs
   def stub_documents_show(id:, &block)
-    StubRequests.stub_endpoint(:documents, :documents_show, id: id, &block)
+    StubRequests.stub_endpoint(:documents_show, id: id, &block)
   end
 
 
   def stub_documents_index(&block)
-    StubRequests.stub_endpoint(:documents, :documents_index, &block)
+    StubRequests.stub_endpoint(:documents_index, &block)
   end
 
 
   def stub_documents_create(&block)
-    StubRequests.stub_endpoint(:documents, :documents_create, &block)
+    StubRequests.stub_endpoint(:documents_create, &block)
   end
 
 
   def stub_documents_update(id:, &block)
-    StubRequests.stub_endpoint(:documents, :documents_update, id: id, &block)
+    StubRequests.stub_endpoint(:documents_update, id: id, &block)
   end
 
 
   def stub_document_put(id:, &block)
-    StubRequests.stub_endpoint(:documents, :document_put, id: id, &block)
+    StubRequests.stub_endpoint(:document_put, id: id, &block)
   end
 
 
   def stub_documents_destroy(id:, &block)
-    StubRequests.stub_endpoint(:documents, :documents_destroy, id: id, &block)
+    StubRequests.stub_endpoint(:documents_destroy, id: id, &block)
   end
 end
 ```

data/Rakefile

@@ -20,9 +20,11 @@ end
 
 task default: :spec
 
-task :release do
-  sh("gem release --tag --push")
-  Rake::Task["changelog"].invoke
-  sh("./update_docs.sh")
-  sh("gem bump")
+namespace :stub_requests do
+  task :release do
+    sh("./update_docs.sh")
+    Rake::Task["changelog"].invoke
+    sh("gem release --tag --push")
+    sh("gem bump")
+  end
 end

data/lib/stub_requests.rb

@@ -1,24 +1,35 @@
 # frozen_string_literal: true
 
+#
+# 1. Require core classes
+#
 require "forwardable"
 require "singleton"
 
+#
+# 2. Require from gems
+#
+require "addressable/uri"
+require "jaro_winkler"
 require "concurrent/array"
 require "concurrent/map"
 require "docile"
+require "public_suffix"
 require "webmock"
 require "webmock/api"
 require "webmock/stub_registry"
 require "webmock/request_stub"
 
-require "stub_requests/version"
-
-require "stub_requests/argument_validation"
+#
+# 3. Require shared functionality
+#
 require "stub_requests/core_ext"
 require "stub_requests/exceptions"
-require "stub_requests/hash_util"
-require "stub_requests/property"
-require "stub_requests/property/validator"
+require "stub_requests/utils/fuzzy"
+require "stub_requests/concerns/argument_validation"
+require "stub_requests/concerns/property"
+require "stub_requests/concerns/property/validator"
+require "stub_requests/concerns/register_verb"
 require "stub_requests/uri"
 require "stub_requests/uri/scheme"
 require "stub_requests/uri/suffix"
@@ -26,23 +37,26 @@ require "stub_requests/uri/validator"
 require "stub_requests/uri/builder"
 require "stub_requests/configuration"
 
+#
+# 4. Require core functionality
+#
 require "stub_requests/callback"
 require "stub_requests/callback_registry"
-
-require "stub_requests/endpoint_stub"
-require "stub_requests/request_stub"
-require "stub_requests/stub_registry"
-
-require "stub_requests/endpoints"
+require "stub_requests/dsl"
+require "stub_requests/dsl/method_definition"
+require "stub_requests/dsl/define_method"
 require "stub_requests/endpoint"
+require "stub_requests/endpoint_registry"
+require "stub_requests/request_stub"
 require "stub_requests/service"
 require "stub_requests/service_registry"
-
+require "stub_requests/stub_registry"
 require "stub_requests/webmock/builder"
 require "stub_requests/webmock/stub_registry_extension"
 
+#
+# 5. Require public API
+#
 require "stub_requests/api"
+require "stub_requests/version"
 require "stub_requests/stub_requests"
-require "stub_requests/dsl/method_definition"
-require "stub_requests/dsl/define_method"
-require "stub_requests/dsl"

data/lib/stub_requests/api.rb

@@ -43,7 +43,49 @@ module StubRequests
     # @return [Service] a new service or a previously registered service
     #
     def register_service(service_id, service_uri, &block)
-      StubRequests::ServiceRegistry.register_service(service_id, service_uri, &block)
+      service = ServiceRegistry.instance.register(service_id, service_uri)
+      Docile.dsl_eval(service, &block) if block.present?
+      service
+    end
+    alias register_service2 register_service
+
+    #
+    # Stub a request to a registered service endpoint
+    #
+    #
+    # @param [Symbol] endpoint_id the id of a registered endpoint
+    # @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
+    #   stub_endpoint(:get_map_location, id: 1)
+    #    .to_return(body: "No content", status: 204)
+    #
+    # @example Stub a request to a registered service endpoint using block
+    #   stub_endpoint(:documents_index) do
+    #     with(headers: { "Accept" => "application/json" }}})
+    #     to_return(body: "No content", status: 204)
+    #   end
+    #
+    # @return [WebMock::RequestStub] a mocked request
+    #
+    def stub_endpoint(endpoint_id, route_params = {}, &callback)
+      endpoint      = EndpointRegistry.instance.find!(endpoint_id)
+      uri           = URI::Builder.build(endpoint.service_uri, endpoint.path, route_params)
+      webmock_stub  = WebMock::Builder.build(endpoint.verb, uri, &callback)
+
+      StubRegistry.instance.record(endpoint.id, webmock_stub)
+      ::WebMock::StubRegistry.instance.register_request_stub(webmock_stub)
+    end
+
+    # :nodoc:
+    def __stub_endpoint(endpoint_id, route_params = {})
+      endpoint      = EndpointRegistry.instance.find!(endpoint_id)
+      uri           = URI::Builder.build(endpoint.service_uri, endpoint.path, route_params)
+      endpoint_stub = WebMock::Builder.build(endpoint.verb, uri)
+
+      ::WebMock::StubRegistry.instance.register_request_stub(endpoint_stub)
     end
 
     #
@@ -74,29 +116,6 @@ module StubRequests
       DSL.new(service_id).print_stubs
     end
 
-    #
-    # Stub a request to a registered service endpoint
-    #
-    #
-    # @param [Symbol] service_id the id of a registered service
-    # @param [Symbol] endpoint_id the id of a registered endpoint
-    # @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 using block version
-    #   stub_endpoint(:documents, :index) do
-    #     with(headers: { "Accept" => "application/json" }}})
-    #     to_return(body: "No content", status: 204)
-    #   end
-    #
-    # @see #stub_http_request
-    # @return [WebMock::RequestStub] a mocked request
-    #
-    def stub_endpoint(service_id, endpoint_id, route_params = {}, &callback)
-      StubRequests::ServiceRegistry.stub_endpoint(service_id, endpoint_id, route_params, &callback)
-    end
-
     #
     # Subscribe to notifications for a service endpoint
     #
@@ -108,7 +127,7 @@ module StubRequests
     # @return [void]
     #
     def register_callback(service_id, endpoint_id, verb, callback)
-      StubRequests::CallbackRegistry.register(service_id, endpoint_id, verb, callback)
+      StubRequests::CallbackRegistry.instance.register(service_id, endpoint_id, verb, callback)
     end
 
     #
@@ -120,7 +139,7 @@ module StubRequests
     # @return [void]
     #
     def unregister_callback(service_id, endpoint_id, verb)
-      StubRequests::CallbackRegistry.unregister(service_id, endpoint_id, verb)
+      StubRequests::CallbackRegistry.instance.unregister(service_id, endpoint_id, verb)
     end
   end
 end

data/lib/stub_requests/callback.rb

@@ -14,7 +14,9 @@ module StubRequests
   # @since 0.1.3
   #
   class Callback
-    include Property
+    # includes "Concerns::Property"
+    # @!parse include Concerns::Property
+    include Concerns::Property
     #
     # @!attribute [rw] service_id
     #   @return [Symbol] the id of a service

data/lib/stub_requests/callback_registry.rb

@@ -14,52 +14,18 @@ module StubRequests
   # @since 0.1.3
   #
   class CallbackRegistry
+    # extend "Forwardable"
+    # @!parse extend Forwardable
+    extend Forwardable
+
+    # includes "Singleton"
+    # @!parse include Singleton
     include Singleton
+    # includes "Enumerable"
+    # @!parse include Enumerable
     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]
-    #
-    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
+    delegate [:each] => :callbacks
 
     #
     # @!attribute [r] callbacks
@@ -83,18 +49,6 @@ module StubRequests
       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
     #

data/lib/stub_requests/concerns/argument_validation.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+#
+# Abstraction over WebMock to reduce duplication
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+# @since 0.1.0
+#
+module StubRequests
+  module Concerns
+    #
+    # 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
+end