stub_requests 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a536f3b0a7ae3cf0c19b91fd9f3c00ba97990f192c0361a070e993702bc69c5e
-  data.tar.gz: a8bb04de37a709efaf4859a71ac81c9c360109faf392ef0505ebb3e195fb5e68
+  metadata.gz: 790cf23df8e8bd3f6532cb0e3008bf41150c189135ec7eed33ac795523325f20
+  data.tar.gz: 7c546bc75dc7aeb88aa7d92addc7455f1d240feca299427c4da970eceb20116b
 SHA512:
-  metadata.gz: 16c128e4b4a894c4478eaa697aafb84aa467d7c51a0d6086340f30dd7f8acf969254cb506d6a52bc19d6c0f148af18492c4461a4b07ba988b0ee01eb223d232e
-  data.tar.gz: c30405764a9064978698b3fdbf6046bd8a01cac0a2ace240b4b7f8092f7e1716f108e0b01a26fef24216ac444c134377a518a4537d97a69b18314d33adf0ee8c
+  metadata.gz: 68a87e36d03c65705c587417600ec9dd798c92ecfd56df45da50fce6b8471a8f460e27a8a1c34a5787daff77c54a383caf79bff35eb98c6da937ec0255659083
+  data.tar.gz: 92fccfea4f37480e5fb4cfff7863288897b7741fcd606848eb702b1a73459d66a1acf862ffa27fd171913defd513e2e702769a02f809285b5a48ff7818c1021e

data/.reek.yml

@@ -17,6 +17,7 @@ detectors:
     exclude:
       - initialize
       - RSpec::SubjectAsLambda#it!
+      - StubRequests::UriSegmentMismatch#message_parts
   DataClump:
     exclude:
       - StubRequests::Concerns::RegisterVerb

data/CHANGELOG.md

@@ -1,8 +1,7 @@
 # Change Log
 
-## [Unreleased](https://github.com/mhenrixon/stub_requests/tree/HEAD)
-
-[Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.9...HEAD)
+## [v0.1.10](https://github.com/mhenrixon/stub_requests/tree/v0.1.10) (2019-02-07)
+[Full Changelog](https://github.com/mhenrixon/stub_requests/compare/v0.1.9...v0.1.10)
 
 **Implemented enhancements:**
 

data/Rakefile

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

data/lib/stub_requests/api.rb

@@ -72,7 +72,7 @@ module StubRequests
     #
     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)
+      uri           = URI::Builder.build(endpoint.uri, route_params)
       webmock_stub  = WebMock::Builder.build(endpoint.verb, uri, &callback)
 
       StubRegistry.instance.record(endpoint.id, webmock_stub)
@@ -82,7 +82,7 @@ module StubRequests
     # :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)
+      uri           = URI::Builder.build(endpoint.uri, route_params)
       endpoint_stub = WebMock::Builder.build(endpoint.verb, uri)
 
       ::WebMock::StubRegistry.instance.register_request_stub(endpoint_stub)

data/lib/stub_requests/exceptions.rb

@@ -94,5 +94,54 @@ module StubRequests
   #
   # UriSegmentMismatch is raised when a segment cannot be replaced
   #
-  class UriSegmentMismatch < Error; end
+  class UriSegmentMismatch < Error
+    attr_reader :uri, :expected_keys, :received_keys
+    def initialize(uri:, expected_keys:, received_keys:)
+      @uri           = uri
+      @expected_keys = expected_keys
+      @received_keys = received_keys
+
+      super(message_parts.join("\n  "))
+    end
+
+    private
+
+    def message_parts
+      [].tap do |arr|
+        arr << default_part
+        arr << expected_keys_part
+        arr << received_keys_part
+        arr << missing_keys_part if missing_keys.any?
+        arr << invalid_keys_part if invalid_keys.any?
+      end
+    end
+
+    def default_part
+      "The URI (#{uri}) received unexpected route parameters"
+    end
+
+    def expected_keys_part
+      "Expected: [#{expected_keys.join(',')}]"
+    end
+
+    def received_keys_part
+      "Received: [#{received_keys.join(',')}]"
+    end
+
+    def missing_keys_part
+      "Missing: [#{missing_keys.join(',')}]"
+    end
+
+    def invalid_keys_part
+      "Invalid: [#{invalid_keys.join(',')}]"
+    end
+
+    def missing_keys
+      @missing_keys ||= expected_keys - received_keys
+    end
+
+    def invalid_keys
+      @invalid_keys ||= received_keys - expected_keys
+    end
+  end
 end

data/lib/stub_requests/uri/builder.rb

@@ -21,7 +21,7 @@ module StubRequests
     class Builder
       #
       # @return [Regexp] A pattern for matching url segment keys
-      URL_SEGMENT_REGEX = /(:\w+)/.freeze
+      URI_KEY = /(:[a-zA-Z_]+)/.freeze
 
       #
       # Convenience method to avoid .new.build
@@ -30,54 +30,44 @@ module StubRequests
       # @raise [UriSegmentMismatch] when there are unused URI segments
       # @raise [UriSegmentMismatch] when the template have unplaced URI segments
       #
-      # @param [String] host the URI used to reach the service
-      # @param [String] template the endpoint template
+      # @param [String] the URI to the service endpoint
       # @param [Hash<Symbol>] route_params a list of uri_replacement keys
       #
       # @return [String] a validated URI string
       #
-      def self.build(host, template, route_params = {})
-        new(host, template, route_params).build
+      def self.build(uri, route_params = {})
+        new(uri, route_params).build
       end
 
       #
       # @!attribute [r] uri
-      #   @return [String] the request host {Service#service_uri}
-      attr_reader :host
-      #
-      # @!attribute [r] template
-      #   @return [String] a string template for the endpoint
-      attr_reader :template
-      #
-      # @!attribute [r] path
-      #   @return [String] a valid URI path
-      attr_reader :path
+      #   @return [String] the URI to the service endpoint
+      attr_reader :uri
       #
       # @!attribute [r] route_params
       #   @return [Hash<Symbol] a hash with keys matching the {#template}
       attr_reader :route_params
       #
-      # @!attribute [r] unused
-      #   @return [Array<String>] a list with unused {#route_params}
-      attr_reader :unused
+      # @!attribute [r] received_keys
+      #   @return [Array<String>] a list with actual {#route_params} keys
+      attr_reader :received_keys
       #
-      # @!attribute [r] unreplaced
-      #   @return [Array<String>] a list of uri_segments that should have been replaced
-      attr_reader :unreplaced
+      # @!attribute [r] expected_keys
+      #   @return [Array<String>] a list of expected route keys
+      attr_reader :expected_keys
 
       #
       # Initializes a new Builder
       #
       #
-      # @param [String] host the URI used to reach the service
-      # @param [String] template the endpoint template
+      # @param [String] uri the URI used to reach the service
       # @param [Hash<Symbol>] route_params a list of uri_replacement keys
       #
-      def initialize(host, template, route_params = {})
-        @host         = +host
-        @template     = +template
-        @path         = +@template.dup
-        @route_params = route_params.to_route_param
+      def initialize(uri, route_params = {})
+        @uri           = +uri
+        @route_params  = route_params.to_route_param
+        @received_keys = @route_params.keys
+        @expected_keys = uri.scan(URI_KEY).flatten.uniq
       end
 
       #
@@ -90,104 +80,33 @@ module StubRequests
       # @return [String] a validated URI string
       #
       def build
+        validate_uri_has_route_params!
         build_uri
-        run_validations
+        validate_uri
 
         uri
       end
 
       private
 
-      def build_uri
-        replace_segments
-        parse_unreplaced_segments
-      end
-
-      def uri
-        @uri ||= [host, path].join("/")
-      end
-
-      def run_validations
-        validate_route_params_used
-        validate_route_keys_replaced
-        validate_uri
-      end
-
-      #
-      # Replaces the URI segments with the arguments in route_params
-      #
-      #
-      # @return [Array] an list with unused route_params
-      #
-      def replace_segments
-        @unused = route_params.map do |key, value|
-          next key unless path.include?(key)
-
-          path.gsub!(key, value.to_s)
-          next
-        end.compact
-      end
-
-      #
-      # Validates that all route_params have been used
-      #
-      #
-      # @raise [UriSegmentMismatch] when there are unused route_params
-      #
-      # @return [void]
-      #
-      def validate_route_params_used
-        return if replacents_used?
-
-        raise UriSegmentMismatch,
-              "The URI segment(s) [#{unused.join(',')}] are missing in template (#{path})"
-      end
+      def validate_uri_has_route_params!
+        return if validate_uri_has_route_params
 
-      #
-      # Checks that no route_params are left
-      #
-      #
-      # @return [true,false]
-      #
-      def replacents_used?
-        unused.none?
+        raise UriSegmentMismatch, uri: uri, expected_keys: expected_keys, received_keys: received_keys
       end
 
-      #
-      # Validates that all URI segments have been replaced in {#path}
-      #
-      #
-      # @raise [UriSegmentMismatch] when the path have unplaced URI segments
-      #
-      # @return [void]
-      #
-      def validate_route_keys_replaced
-        return if route_keys_replaced?
-
-        raise UriSegmentMismatch,
-              "The URI segment(s) [#{unreplaced.join(',')}]" \
-              " were not replaced in template (#{path})." \
-              " Given route_params=[#{route_params.keys.join(',')}]"
+      def validate_uri_has_route_params
+        expected_keys.sort == received_keys.sort
       end
 
-      #
-      # Checks that all URI keys were replaced
-      #
-      #
-      # @return [true,false]
-      #
-      def route_keys_replaced?
-        unreplaced.none?
+      def build_uri
+        route_params.each do |key, value|
+          replace_key(key, value)
+        end
       end
 
-      #
-      # Parses out all unused URI segments
-      #
-      #
-      # @return [Array<String>] a list of not replaced uri_segments
-      #
-      def parse_unreplaced_segments
-        @unreplaced = URL_SEGMENT_REGEX.match(path).to_a.uniq
+      def replace_key(key, value)
+        uri.gsub!(key, value.to_s)
       end
 
       #

data/lib/stub_requests/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stub_requests
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Mikael Henriksson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2019-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile