pact-support 1.16.5 → 1.16.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e0c625aaae1df3561bcc4931619c302e86e7a095532a796ccbb0d72c25fa1a0
-  data.tar.gz: 5cecf64f0fcdd42ba68cd87fe117a3de729b96f1cd22ae4f47dcb171f78c0fc0
+  metadata.gz: 46ec9f6e6642bfc067b5327994f844ecd15afaa81ab23b9c4fc4fa55ceae83fe
+  data.tar.gz: ef772e9256e18df3164c834aa55e21fb7742484a19fbc9dccdc17b11fc391d7d
 SHA512:
-  metadata.gz: dcb61af6781e17f964725fdd44452c3fa63b146bc71240c5a2cff6580d7572da316e41af133d4c9ac814d2a8200a72b250e32333292567718c43fbee88aaf3c0
-  data.tar.gz: 661cf6909d54987e5e9e63ba38ce2b92ac00c2823853ac178670a204ce80adf96084c9665cf622f7a04ce2e50e7948b755c07ffc0d14e344492908bb033966d8
+  metadata.gz: 0a6f386eb4fcb8f3b49832e58564ed56e4a1e56a8da6ecea776f211ee0850a78ba9adb6677571053d943ef717204f17b513a2347bfcd43757a03ce2018a35d94
+  data.tar.gz: 60d0cbcc25b2b10937c2bea9501ae540b0a5aaf7946676414ea01da95829ef36a2c0f19a558883367631cb894bf9ccbcce32200d09f8a907050b763b731bf68b

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+<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)
 

data/README.md

@@ -1,5 +1,5 @@
 # Pact Support
 
-[![Build Status](https://travis-ci.com/pact-foundation/pact-support.svg?branch=master)](https://travis-ci.com/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

@@ -36,7 +36,7 @@ module Pact
       # 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)
+        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

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,12 @@ 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 options[:verbose]
       http
     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)
@@ -18,12 +20,16 @@ module Pact
       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 =~ /\[.*\]/ }
-        parse_nested_query(query_string)
+        parse_string_as_nested_query(query_string)
       else
         parsed_query.each_with_object({}) do | (key, value), new_hash |
           new_hash[key] = [*value]
@@ -33,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 = {}
@@ -56,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?
@@ -67,7 +73,7 @@ module Pact
         end
       end
 
-      return params.to_h
+      return NestedQuery[params.to_h]
     end
 
     def self.normalize_params(params, name, v)

data/lib/pact/consumer_contract/query_hash.rb

@@ -10,9 +10,18 @@ module Pact
 
     attr_reader :original_string
 
-    def initialize(query, original_string = nil)
+    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 = {})
@@ -35,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(convert_to_hash_of_arrays(Query.parse_string(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)

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/support/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module Support
-    VERSION = "1.16.5"
+    VERSION = "1.16.9"
   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.16.5
+  version: 1.16.9
 platform: ruby
 authors:
 - James Fraser
@@ -12,64 +12,64 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2021-09-30 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'
-  type: :runtime
+        version: 0.1.1
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: rspec
   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
@@ -318,7 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.28
 signing_key: 
 specification_version: 4
 summary: Shared code for Pact gems