pact-support 1.17.0.pre.rc2 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53f96e38ed02dd28e53b0ff88d6c5f5e8fe97fce7435aedd09be3f427be967c7
-  data.tar.gz: f4a3628a3a334e9a0a9726b8f49af3342fb7e36dd763b05dfe1461872f8636a9
+  metadata.gz: ffae927e01cda7b4e78b62dbf4e60d0c5b51907f882b1aedf9e81d37458033a7
+  data.tar.gz: 3dae3b8274a7a9f3b8631e209eb14999758e6eb3f501826928f0860ff4a2c0cc
 SHA512:
-  metadata.gz: f3d6641e193bbc36a0039b90382a0aa062b1e236391ba4cdb979776e1a1a03114b82c4fd95e860328b0a54c2e632f5240e0fa78edec4cf5d5ad4e197c05db40c
-  data.tar.gz: bb8b6beeade90f3d3377bc126ef2bb02c10daeaa7c01b6fdd151569744632c3f086a1316987f872641f3f34e0fd58ec63bbf6123814245a68115d39d9969e4dd
+  metadata.gz: d285d2dd1ecbbd99576591c816d4e0ce867313672e20ad3f4f113c5520378e7b83b533557734ba7315a2b1fa776e052e5457c860b40f3ef5dc82d0a251a327c3
+  data.tar.gz: 3209c1f4ce99e5765c98b86dc67b53cd0f364d71b576208cda7982d830610eb93a01402b896adb33d4feee21c46fb7c3ffccb968b0d3991fb1365df3ab91ba00

data/CHANGELOG.md

@@ -1,8 +1,73 @@
-<a name="v1.17.0.pre.rc2"></a>
-### v1.17.0.pre.rc2 (2020-11-06)
+<a name="v1.17.0"></a>
+### v1.17.0 (2021-10-01)
 
-<a name="v1.17.0.pre.rc1"></a>
-### v1.17.0.pre.rc1 (2020-11-06)
+#### Features
+
+* allow SSL verification to be disabled by setting environment variable PACT_DISABLE_SSL_VERIFICATION=true	 ([dd39c04](/../../commit/dd39c04))
+
+<a name="v1.16.10"></a>
+### v1.16.10 (2021-10-01)
+
+#### Bug Fixes
+
+* change expgen to a runtime dependency	 ([da81634](/../../commit/da81634))
+
+<a name="v1.16.9"></a>
+### v1.16.9 (2021-09-30)
+
+#### Bug Fixes
+
+* remove randexp dependency (#91)	 ([794fd4e](/../../commit/794fd4e))
+
+<a name="v1.16.8"></a>
+### v1.16.8 (2021-07-27)
+
+#### Bug Fixes
+
+* log HTTP request for pacts retrieved by URL when requested with verbose=true	 ([3288b81](/../../commit/3288b81))
+
+<a name="v1.16.7"></a>
+### v1.16.7 (2021-01-28)
+
+#### Bug Fixes
+
+* dynamically parse actual query to match expected format	 ([a86a3e3](/../../commit/a86a3e3))
+
+<a name="v1.16.6"></a>
+### v1.16.6 (2021-01-28)
+
+#### Bug Fixes
+
+* raise Pact::Error not RuntimeError when invalid constructor arguments are supplied to a Pact::Term	 ([d9fb8ea](/../../commit/d9fb8ea))
+* update active support support for Ruby 3.0	 ([6c30d42](/../../commit/6c30d42))
+
+<a name="v1.16.5"></a>
+### v1.16.5 (2020-11-25)
+
+#### Bug Fixes
+
+* maintain the original string query for the provider verification while also parsing the string query into a hash to allow the matching rules to be applied correctly for use in the mock service on the consumer side	 ([12105dd](/../../commit/12105dd))
+
+<a name="v1.16.4"></a>
+### v1.16.4 (2020-11-13)
+
+#### Bug Fixes
+
+* ensure expected and actual query strings are parsed consistently	 ([4e9ca9c](/../../commit/4e9ca9c))
+
+<a name="v1.16.3"></a>
+### v1.16.3 (2020-11-10)
+
+#### Bug Fixes
+
+* add missing params_hash_has_key	 ([700efa7](/../../commit/700efa7))
+
+<a name="v1.16.2"></a>
+### v1.16.2 (2020-11-07)
+
+#### Bug Fixes
+
+* removed undefined depth from query	 ([53a373d](/../../commit/53a373d))
 
 <a name="v1.16.1"></a>
 ### v1.16.1 (2020-11-06)

data/README.md

@@ -1,5 +1,5 @@
 # Pact Support
 
-[![Build Status](https://travis-ci.org/pact-foundation/pact-support.svg?branch=master)](https://travis-ci.org/pact-foundation/pact-support)
+![Build status](https://github.com/pact-foundation/pact-support/workflows/Test/badge.svg)
 
 Provides shared code for the Pact gems

data/lib/pact/consumer_contract/interaction_v2_parser.rb

@@ -23,12 +23,22 @@ module Pact
     end
 
     def self.parse_request request_hash, options
-      if request_hash['query'].is_a?(String)
+      original_query_string = request_hash['query']
+      query_is_string = original_query_string.is_a?(String)
+      if query_is_string
         request_hash = request_hash.dup
         request_hash['query'] = Pact::Query.parse_string(request_hash['query'])
       end
+      # The query has to be a hash at this stage for the matching rules to be applied
       request_hash = Pact::MatchingRules.merge(request_hash, request_hash['matchingRules'], options)
-      Pact::Request::Expected.from_hash(request_hash)
+      # The original query string needs to be passed in to the constructor so it can be used
+      # when the request is replayed. Otherwise, we loose the square brackets because they get lost
+      # in the translation between string => structured object, as we don't know/store which
+      # query string convention was used.
+      if query_is_string
+        request_hash['query'] = Pact::QueryHash.new(request_hash['query'], original_query_string, Pact::Query.parsed_as_nested?(request_hash['query']))
+      end
+      request = Pact::Request::Expected.from_hash(request_hash)
     end
 
     def self.parse_response response_hash, options

data/lib/pact/consumer_contract/pact_file.rb

@@ -1,4 +1,6 @@
-require 'net/http'
+require "net/http"
+require "pact/configuration"
+require "pact/http/authorization_header_redactor"
 
 module Pact
   module PactFile
@@ -81,7 +83,7 @@ module Pact
       request = Net::HTTP::Get.new(uri)
       request = prepare_auth(request, options) if options[:username] || options[:token]
 
-      http = prepare_request(uri)
+      http = prepare_request(uri, options)
       response = perform_http_request(http, request, options)
 
       if response.is_a?(Net::HTTPRedirection)
@@ -89,7 +91,7 @@ module Pact
         req = Net::HTTP::Get.new(uri)
         req = prepare_auth(req, options) if options[:username] || options[:token]
 
-        http = prepare_request(uri)
+        http = prepare_request(uri, options)
         response = perform_http_request(http, req, options)
       end
       response
@@ -101,11 +103,18 @@ module Pact
       request
     end
 
-    def prepare_request(uri)
+    def prepare_request(uri, options)
       http = Net::HTTP.new(uri.host, uri.port, :ENV)
       http.use_ssl = (uri.scheme == 'https')
       http.ca_file = ENV['SSL_CERT_FILE'] if ENV['SSL_CERT_FILE'] && ENV['SSL_CERT_FILE'] != ''
       http.ca_path = ENV['SSL_CERT_DIR'] if ENV['SSL_CERT_DIR'] && ENV['SSL_CERT_DIR'] != ''
+      http.set_debug_output(Pact::Http::AuthorizationHeaderRedactor.new(Pact.configuration.output_stream)) if verbose?(options)
+      if disable_ssl_verification?
+        if verbose?(options)
+          Pact.configuration.output_stream.puts("SSL verification is disabled")
+        end
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
       http
     end
 
@@ -136,5 +145,13 @@ module Pact
     def windows_safe(uri)
       uri.start_with?("http") ? uri : uri.gsub("\\", File::SEPARATOR)
     end
+
+    def verbose?(options)
+      options[:verbose] || ENV['VERBOSE'] == 'true'
+    end
+
+    def disable_ssl_verification?
+      ENV['PACT_DISABLE_SSL_VERIFICATION'] == 'true' || ENV['PACT_BROKER_DISABLE_SSL_VERIFICATION'] == 'true'
+    end
   end
 end

data/lib/pact/consumer_contract/query.rb

@@ -6,6 +6,8 @@ module Pact
     DEFAULT_SEP = /[&;] */n
     COMMON_SEP = { ";" => /[;] */n, ";," => /[;,] */n, "&" => /[&] */n }
 
+    class NestedQuery < Hash; end
+
     def self.create query
       if query.is_a? Hash
         Pact::QueryHash.new(query)
@@ -14,12 +16,20 @@ module Pact
       end
     end
 
+    def self.is_a_query_object?(object)
+      object.is_a?(Pact::QueryHash) || object.is_a?(Pact::QueryString)
+    end
+
+    def self.parsed_as_nested?(object)
+      object.is_a?(NestedQuery)
+    end
+
     def self.parse_string query_string
-      parsed_query = parse_query(query_string)
+      parsed_query = parse_string_as_non_nested_query(query_string)
 
       # If Rails nested params...
-      if parsed_query.keys.any?{ | key| key.include?("[") }
-        parse_nested_query(query_string)
+      if parsed_query.keys.any?{ | key| key =~ /\[.*\]/ }
+        parse_string_as_nested_query(query_string)
       else
         parsed_query.each_with_object({}) do | (key, value), new_hash |
           new_hash[key] = [*value]
@@ -29,7 +39,7 @@ module Pact
 
     # Ripped from Rack to avoid adding an unnecessary dependency, thank you Rack
     # https://github.com/rack/rack/blob/649c72bab9e7b50d657b5b432d0c205c95c2be07/lib/rack/utils.rb
-    def self.parse_query(qs, d = nil, &unescaper)
+    def self.parse_string_as_non_nested_query(qs, d = nil, &unescaper)
       unescaper ||= method(:unescape)
 
       params = {}
@@ -52,7 +62,7 @@ module Pact
       return params.to_h
     end
 
-    def self.parse_nested_query(qs, d = nil)
+    def self.parse_string_as_nested_query(qs, d = nil)
       params = {}
 
       unless qs.nil? || qs.empty?
@@ -63,7 +73,7 @@ module Pact
         end
       end
 
-      return params.to_h
+      return NestedQuery[params.to_h]
     end
 
     def self.normalize_params(params, name, v)
@@ -99,7 +109,7 @@ module Pact
       else
         params[k] ||= {}
         raise ParameterTypeError, "expected Hash (got #{params[k].class.name}) for param `#{k}'" unless params_hash_type?(params[k])
-        params[k] = normalize_params(params[k], after, v, depth - 1)
+        params[k] = normalize_params(params[k], after, v)
       end
 
       params
@@ -109,6 +119,18 @@ module Pact
       obj.is_a?(Hash)
     end
 
+    def self.params_hash_has_key?(hash, key)
+      return false if key =~ /\[\]/
+
+      key.split(/[\[\]]+/).inject(hash) do |h, part|
+        next h if part == ''
+        return false unless params_hash_type?(h) && h.key?(part)
+        h[part]
+      end
+
+      true
+    end
+
     def self.unescape(s, encoding = Encoding::UTF_8)
       URI.decode_www_form_component(s, encoding)
     end

data/lib/pact/consumer_contract/query_hash.rb

@@ -8,8 +8,20 @@ module Pact
     include ActiveSupportSupport
     include SymbolizeKeys
 
-    def initialize(query)
+    attr_reader :original_string
+
+    def initialize(query, original_string = nil, nested = false)
       @hash = query.nil? ? query : convert_to_hash_of_arrays(query)
+      @original_string = original_string
+      @nested = nested
+    end
+
+    def nested?
+      @nested
+    end
+
+    def any_key_contains_square_brackets?
+      query.keys.any?{ |key| key =~ /\[.*\]/ }
     end
 
     def as_json(opts = {})
@@ -32,7 +44,14 @@ module Pact
     # from the actual query string.
     def difference(other)
       require 'pact/matchers' # avoid recursive loop between this file, pact/reification and pact/matchers
-      Pact::Matchers.diff(query, symbolize_keys(CGI::parse(other.query)), allow_unexpected_keys: false)
+
+      if any_key_contains_square_brackets?
+        other_query_hash_non_nested = Query.parse_string_as_non_nested_query(other.query)
+        Pact::Matchers.diff(query, convert_to_hash_of_arrays(other_query_hash_non_nested), allow_unexpected_keys: false)
+      else
+        other_query_hash = Query.parse_string(other.query)
+        Pact::Matchers.diff(query, symbolize_keys(convert_to_hash_of_arrays(other_query_hash)), allow_unexpected_keys: false)
+      end
     end
 
     def query

data/lib/pact/http/authorization_header_redactor.rb

@@ -0,0 +1,32 @@
+require "delegate"
+
+module Pact
+  module Http
+    class AuthorizationHeaderRedactor < SimpleDelegator
+      def puts(*args)
+        __getobj__().puts(*redact_args(args))
+      end
+
+      def print(*args)
+        __getobj__().puts(*redact_args(args))
+      end
+
+      def <<(*args)
+        __getobj__().send(:<<, *redact_args(args))
+      end
+
+      private
+
+      attr_reader :redactions
+
+      def redact_args(args)
+        args.collect{ | s| redact(s) }
+      end
+
+      def redact(string)
+        return string unless string.is_a?(String)
+        string.gsub(/Authorization: .*\\r\\n/, "Authorization: [redacted]\\r\\n")
+      end
+    end
+  end
+end

data/lib/pact/reification.rb

@@ -1,4 +1,4 @@
-require 'randexp'
+require 'expgen'
 require 'pact/term'
 require 'pact/something_like'
 require 'pact/array_like'
@@ -13,8 +13,10 @@ module Pact
 
     def self.from_term(term)
       case term
-      when Pact::Term, Regexp, Pact::SomethingLike, Pact::ArrayLike
+      when Pact::Term, Pact::SomethingLike, Pact::ArrayLike
         from_term(term.generate)
+      when Regexp
+        from_term(Expgen.gen(term))
       when Hash
         term.inject({}) do |mem, (key,t)|
           mem[key] = from_term(t)
@@ -27,15 +29,19 @@ module Pact
       when Pact::QueryString
         from_term(term.query)
       when Pact::QueryHash
-        from_term(term.query).map { |k, v|
-          if v.nil?
-            k
-          elsif v.is_a?(Array) #For cases where there are multiple instance of the same parameter
-            v.map { |x| "#{k}=#{escape(x)}"}.join('&')
-          else
-            "#{k}=#{escape(v)}"
-          end
-        }.join('&')
+        if term.original_string
+          term.original_string
+        else
+          from_term(term.query).map { |k, v|
+            if v.nil?
+              k
+            elsif v.is_a?(Array) #For cases where there are multiple instance of the same parameter
+              v.map { |x| "#{k}=#{escape(x)}"}.join('&')
+            else
+              "#{k}=#{escape(v)}"
+            end
+          }.join('&')
+        end
       when Pact::StringWithMatchingRules
         String.new(term)
       else

data/lib/pact/shared/active_support_support.rb

@@ -2,22 +2,28 @@
 
 module Pact
   module ActiveSupportSupport
-
     extend self
 
     def fix_all_the_things thing
-      if thing.is_a?(Regexp)
-        fix_regexp(thing)
-      elsif thing.is_a?(Array)
-        thing.each{ | it | fix_all_the_things it }
-      elsif thing.is_a?(Hash)
-          thing.values.each{ | it | fix_all_the_things it }
-      elsif thing.class.name.start_with?("Pact")
-        thing.instance_variables.collect{ | iv_name | thing.instance_variable_get(iv_name)}.each do | iv |
-          fix_all_the_things iv
+      if defined?(ActiveSupport)
+        if thing.is_a?(Regexp)
+          fix_regexp(thing)
+        elsif thing.is_a?(Array)
+          thing.collect{ | it | fix_all_the_things it }
+        elsif thing.is_a?(Hash)
+          thing.each_with_object({}) { | (k, v), new_hash | new_hash[k] = fix_all_the_things(v) }
+        elsif thing.is_a?(Pact::Term)
+          # matcher Regexp is fixed in its own as_json method
+          thing
+        elsif thing.class.name.start_with?("Pact")
+          warn_about_regexp(thing)
+          thing
+        else
+          thing
         end
+      else
+        thing
       end
-      thing
     end
 
     # ActiveSupport JSON overwrites (i.e. TRAMPLES) the json methods of the Regexp class directly
@@ -27,10 +33,7 @@ module Pact
     # original as_json to the Regexp instances in the ConsumerContract before we write them to the
     # pact file. If anyone can find a better way, please submit a pull request ASAP!
     def fix_regexp regexp
-      def regexp.as_json options = {}
-        {:json_class => 'Regexp', "o" => self.options, "s" => self.source }
-      end
-      regexp
+      {:json_class => 'Regexp', "o" => regexp.options, "s" => regexp.source }
     end
 
     # Having Active Support JSON loaded somehow kills the formatting of pretty_generate for objects.
@@ -49,5 +52,14 @@ module Pact
       json.gsub(/\\u([0-9A-Za-z]{4})/) {|s| [$1.to_i(16)].pack("U")}
     end
 
+    def warn_about_regexp(thing)
+      thing.instance_variables.each do | iv_name |
+        iv = thing.instance_variable_get(iv_name)
+        if iv.is_a?(Regexp)
+          require 'pact/configuration'
+          Pact.configuration.error_stream.puts("WARN: Instance variable #{iv_name} for class #{thing.class.name} is a Regexp and isn't been serialized properly. Please raise an issue at https://github.com/pact-foundation/pact-support/issues/new.")
+        end
+      end
+    end
   end
 end

data/lib/pact/shared/request.rb

@@ -3,9 +3,7 @@ require 'pact/consumer_contract/headers'
 require 'pact/consumer_contract/query'
 
 module Pact
-
   module Request
-
     class Base
       include Pact::SymbolizeKeys
 
@@ -16,7 +14,7 @@ module Pact
         @path = path
         @headers = Hash === headers ? Headers.new(headers) : headers # Could be a NullExpectation - TODO make this more elegant
         @body = body
-        @query = is_unspecified?(query) ? query : Pact::Query.create(query)
+        set_query(query)
       end
 
       def to_hash
@@ -92,6 +90,17 @@ module Pact
         (query.nil? || query.empty?) ? '' : "?#{Pact::Reification.from_term(query)}"
       end
 
+      def set_query(query)
+        @query = if is_unspecified?(query)
+          query
+        else
+          if Pact::Query.is_a_query_object?(query)
+            query
+          else
+            Pact::Query.create(query)
+          end
+        end
+      end
     end
   end
-end
+end

data/lib/pact/support/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module Support
-    VERSION = "1.17.0.pre.rc2"
+    VERSION = "1.17.0"
   end
 end

data/lib/pact/term.rb

@@ -1,5 +1,6 @@
 require 'pact/shared/active_support_support'
 require 'json/add/regexp'
+require 'pact/errors'
 
 module Pact
   class Term
@@ -25,13 +26,13 @@ module Pact
     def initialize(attributes = {})
       @generate = attributes[:generate]
       @matcher = attributes[:matcher]
-      raise "Please specify a matcher for the Term" unless @matcher != nil
-      raise "Please specify a value to generate for the Term" unless @generate != nil
-      raise "Value to generate \"#{@generate}\" does not match regular expression #{@matcher.inspect}" unless @generate =~ @matcher
+      raise Pact::Error.new("Please specify a matcher for the Term") unless @matcher != nil
+      raise Pact::Error.new("Please specify a value to generate for the Term") unless @generate != nil
+      raise Pact::Error.new("Value to generate \"#{@generate}\" does not match regular expression #{@matcher.inspect}") unless @generate =~ @matcher
     end
 
     def to_hash
-      { json_class: self.class.name, data: { generate: generate, matcher: fix_regexp(matcher)} }
+      { json_class: self.class.name, data: { generate: generate, matcher: fix_regexp(matcher) } }
     end
 
     def as_json(options = {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-support
 version: !ruby/object:Gem::Version
-  version: 1.17.0.pre.rc2
+  version: 1.17.0
 platform: ruby
 authors:
 - James Fraser
@@ -12,64 +12,64 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2021-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: randexp
+  name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: term-ansicolor
+  name: awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: diff-lcs
+  name: expgen
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -96,14 +96,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.0.3
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -254,6 +254,7 @@ files:
 - lib/pact/consumer_contract/string_with_matching_rules.rb
 - lib/pact/errors.rb
 - lib/pact/helpers.rb
+- lib/pact/http/authorization_header_redactor.rb
 - lib/pact/logging.rb
 - lib/pact/matchers.rb
 - lib/pact/matchers/actual_type.rb
@@ -314,11 +315,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.28
 signing_key: 
 specification_version: 4
 summary: Shared code for Pact gems