pact-support 1.7.0.alpha.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad9d08da6cd0f2b5a4916c2f5c12f7749aed29c7
-  data.tar.gz: 740000cf408626229d5cfd34d445dcf9856285fe
+  metadata.gz: 2bbba1bbc7c4a2bf0c9bf83c335bca49f3911b33
+  data.tar.gz: 074b3a5fbf4ea09514e9a58d6af2d42d22739942
 SHA512:
-  metadata.gz: 618a7e49e43b611c6b7435f94bfe6bc5dba1162d33760a2e4c6643a8b088535354b7457d41e25e292573a87d3f6d126f3ea50f0a8005f4c3a80e7b8d480b0659
-  data.tar.gz: 7ebdf91b188ca969ecd0cfaf5bb5d516714f3e2096956cfe07c7389020f678ee0d196c03f5aaa6fa6195adf9eed681ffe0c5aadd5585e61610749e9526e74b5e
+  metadata.gz: d15ba35784d2b6a93feeae4f77fd43f32ae2b07d3ece6b1b1a0367d9d05702a6a6dca9696e65287ba782c2ccfc495fc7fb3c8e8a34c57f525ddaf0702acdf6b2
+  data.tar.gz: 58ebf78d2b351442c2d3ac0ce8a2874949939acb51ca94b5aa7f0b261b1674da0ddd73db983e643267e9dd3b8c0117a80277090ac36690ff71ece9fbb694c118

data/CHANGELOG.md

@@ -1,3 +1,38 @@
+<a name="v1.7.0"></a>
+### v1.7.0 (2018-08-07)
+
+
+#### Features
+
+* add support for multipart/form	 ([8ed4332](/../../commit/8ed4332))
+
+
+<a name="v1.6.6"></a>
+### v1.6.6 (2018-07-25)
+
+
+#### Bug Fixes
+
+* correctly handle an 'each like' inside a 'like'	 ([7dc76dc](/../../commit/7dc76dc))
+
+
+<a name="v1.6.5"></a>
+### v1.6.5 (2018-07-23)
+
+
+#### Features
+
+* use 0 as the nil pact specification version	 ([88e4750](/../../commit/88e4750))
+* reify StringWithMatchingRules to a String	 ([a025dd3](/../../commit/a025dd3))
+* parse String response and request bodies to StringWithMatchingRules to support pact-xml	 ([a9fbb58](/../../commit/a9fbb58))
+* add custom contract parsers to front of pact parsers list so that customised parsers are tried first	 ([babc319](/../../commit/babc319))
+
+
+#### Bug Fixes
+
+* show a more helpful error when attempting to parse a URI that is not a pact	 ([a8ba1ed](/../../commit/a8ba1ed))
+
+
 <a name="v1.6.4"></a>
 ### v1.6.4 (2018-07-14)
 

data/lib/pact/configuration.rb

@@ -1,9 +1,11 @@
 require 'pact/matchers/embedded_diff_formatter'
 require 'pact/matchers/unix_diff_formatter'
 require 'pact/matchers/list_diff_formatter'
+require 'pact/matchers/multipart_form_diff_formatter'
 require 'pact/shared/json_differ'
 require 'pact/shared/text_differ'
 require 'pact/shared/form_differ'
+require 'pact/shared/multipart_form_differ'
 
 
 module Pact
@@ -24,6 +26,7 @@ module Pact
     end
 
     DIFF_FORMATTER_REGISTRATIONS = [
+      [/multipart\/form-data/, Pact::Matchers::MultipartFormDiffFormatter],
       [/.*/, Pact::Matchers::UnixDiffFormatter],
       [NilMatcher, Pact::Matchers::UnixDiffFormatter]
     ]
@@ -31,6 +34,7 @@ module Pact
     DIFFERS = [
       [/json/, Pact::JsonDiffer],
       [/application\/x\-www\-form\-urlencoded/, Pact::FormDiffer],
+      [/multipart\/form-data/, Pact::MultipartFormDiffer],
       [NilMatcher, Pact::TextDiffer],
       [/.*/, Pact::TextDiffer]
     ]

data/lib/pact/consumer_contract/consumer_contract.rb

@@ -14,6 +14,8 @@ require 'pact/consumer_contract/http_consumer_contract_parser'
 
 module Pact
 
+  class UnrecognizePactFormatError < ::Pact::Error; end
+
   class ConsumerContract
 
     include SymbolizeKeys
@@ -42,7 +44,7 @@ module Pact
       parsers.each do | parser |
         return parser.call(hash) if parser.can_parse?(hash)
       end
-      raise Pact::Error.new("No consumer contract parser found for hash: #{hash}")
+      raise Pact::UnrecognizePactFormatError.new("This document does not use a recognised Pact format: #{hash}")
     end
 
     def self.from_json string
@@ -52,6 +54,8 @@ module Pact
 
     def self.from_uri uri, options = {}
       from_json(Pact::PactFile.read(uri, options))
+    rescue UnrecognizePactFormatError
+      raise Pact::UnrecognizePactFormatError.new("This document does not use a recognised Pact format. Please check that #{uri} is a valid pact file.")
     end
 
     def self.maintain_backwards_compatiblity_with_producer_keys string

data/lib/pact/consumer_contract/interaction.rb

@@ -1,150 +1,71 @@
-require 'pact/consumer_contract/request'
-require 'pact/consumer_contract/response'
-require 'pact/symbolize_keys'
 require 'pact/shared/active_support_support'
-require 'pact/matching_rules'
-require 'pact/errors'
-require 'pact/specification_version'
-require 'pact/consumer_contract/string_with_matching_rules'
+require 'pact/consumer_contract/interaction_parser'
 
 module Pact
   class Interaction
     include ActiveSupportSupport
-      include SymbolizeKeys
 
-      attr_accessor :description, :request, :response, :provider_state
-
-      def initialize attributes = {}
-        @description = attributes[:description]
-        @request = attributes[:request]
-        @response = attributes[:response]
-        @provider_state = attributes[:provider_state] || attributes[:providerState]
-      end
-
-      def self.from_hash hash, options = {}
-        pact_specification_version = options[:pact_specification_version] || Pact::SpecificationVersion::NIL_VERSION
-        case pact_specification_version.major
-        when nil, 0, 1, 2 then parse_v2_interaction(hash, pact_specification_version: pact_specification_version)
-        else parse_v3_interaction(hash, pact_specification_version: pact_specification_version)
-        end
-      end
-
-      def self.parse_v2_interaction hash, options
-        request = parse_v2_request(hash['request'], options)
-        response = parse_v2_response(hash['response'], options)
-        new(symbolize_keys(hash).merge(request: request, response: response))
-      end
-
-      def self.parse_v3_interaction hash, options
-        request = parse_v3_request(hash['request'], options)
-        response = parse_v3_response(hash['response'], options)
-        new(symbolize_keys(hash).merge(request: request, response: response))
-      end
-
-      def self.parse_v2_request request_hash, options
-        request_hash = Pact::MatchingRules.merge(request_hash, request_hash['matchingRules'], options)
-        Pact::Request::Expected.from_hash(request_hash)
-      end
-
-      def self.parse_v2_response response_hash, options
-        response_hash = Pact::MatchingRules.merge(response_hash, response_hash['matchingRules'], options)
-        Pact::Response.from_hash(response_hash)
-      end
-
-      def self.parse_v3_request request_hash, options
-        request_matching_rules = request_hash['matchingRules'] || {}
-        if request_hash['body'].is_a?(String)
-          parse_request_with_string_body(request_hash, request_matching_rules['body'] || {}, options)
-        else
-          parse_v3_request_with_non_string_body(request_hash, request_matching_rules, options)
-        end
-      end
-
-      def self.parse_request_with_string_body request_hash, request_matching_rules, options
-        string_with_matching_rules = StringWithMatchingRules.new(request_hash['body'], options[:pact_specification_version], request_matching_rules)
-        Pact::Request::Expected.from_hash(request_hash.merge('body' => string_with_matching_rules))
-      end
-
-      def self.parse_v3_response response_hash, options
-        response_matching_rules = response_hash['matchingRules'] || {}
-        if response_hash['body'].is_a?(String)
-          parse_response_with_string_body(response_hash, response_matching_rules['body'] || {}, options)
-        else
-          parse_v3_response_with_non_string_body(response_hash, response_matching_rules, options)
-        end
-      end
-
-      def self.parse_response_with_string_body response_hash, response_matching_rules, options
-        string_with_matching_rules = StringWithMatchingRules.new(response_hash['body'], options[:pact_specification_version], response_matching_rules)
-        Pact::Response.from_hash(response_hash.merge('body' => string_with_matching_rules))
-      end
-
-      def self.parse_v3_request_with_non_string_body request_hash, request_matching_rules, options
-        request_hash = request_hash.keys.each_with_object({}) do | key, new_hash |
-          new_hash[key] = Pact::MatchingRules.merge(request_hash[key], request_matching_rules[key], options)
-        end
-        Pact::Request::Expected.from_hash(request_hash)
-      end
-
-      def self.parse_v3_response_with_non_string_body response_hash, response_matching_rules, options
-        response_hash = response_hash.keys.each_with_object({}) do | key, new_hash |
-          new_hash[key] = Pact::MatchingRules.merge(response_hash[key], response_matching_rules[key], options)
-        end
-        Pact::Response.from_hash(response_hash)
-      end
-
-      def to_hash
-        {
-          description: description,
-          provider_state: provider_state,
-          request: request.to_hash,
-          response: response.to_hash
-        }
-      end
-
-      def http?
-        true
-      end
-
-      def validate!
-        raise Pact::InvalidInteractionError.new(self) unless description && request && response
-      end
-
-      def matches_criteria? criteria
-        criteria.each do | key, value |
-          unless match_criterion self.send(key.to_s), value
-            return false
-          end
+    attr_accessor :description, :request, :response, :provider_state
+
+    def initialize attributes = {}
+      @description = attributes[:description]
+      @request = attributes[:request]
+      @response = attributes[:response]
+      @provider_state = attributes[:provider_state] || attributes[:providerState]
+    end
+
+    def self.from_hash hash, options = {}
+      InteractionParser.call(hash, options)
+    end
+
+    def to_hash
+      {
+        description: description,
+        provider_state: provider_state,
+        request: request.to_hash,
+        response: response.to_hash
+      }
+    end
+
+    def http?
+      true
+    end
+
+    def validate!
+      raise Pact::InvalidInteractionError.new(self) unless description && request && response
+    end
+
+    def matches_criteria? criteria
+      criteria.each do | key, value |
+        unless match_criterion self.send(key.to_s), value
+          return false
         end
-        true
       end
+      true
+    end
 
-      def match_criterion target, criterion
-        target == criterion || (criterion.is_a?(Regexp) && criterion.match(target))
-      end
+    def match_criterion target, criterion
+      target == criterion || (criterion.is_a?(Regexp) && criterion.match(target))
+    end
 
-      def == other
-        other.is_a?(Interaction) && to_hash == other.to_hash
-      end
+    def == other
+      other.is_a?(Interaction) && to_hash == other.to_hash
+    end
 
-      def eq? other
-        self == other
-      end
+    def eq? other
+      self == other
+    end
 
-      def description_with_provider_state_quoted
-        provider_state ? "\"#{description}\" given \"#{provider_state}\"" : "\"#{description}\""
-      end
+    def description_with_provider_state_quoted
+      provider_state ? "\"#{description}\" given \"#{provider_state}\"" : "\"#{description}\""
+    end
 
-      def request_modifies_resource_without_checking_response_body?
-        request.modifies_resource? && response.body_allows_any_value?
-      end
+    def request_modifies_resource_without_checking_response_body?
+      request.modifies_resource? && response.body_allows_any_value?
+    end
 
-      def to_s
-        to_hash.to_s
-      end
-
-      def self.is_xml? body
-        body.is_a?(String) && body.start_with?("<")
-      end
-   end
+    def to_s
+      to_hash.to_s
+    end
+  end
 end

data/lib/pact/consumer_contract/interaction_parser.rb

@@ -0,0 +1,23 @@
+require 'pact/specification_version'
+require 'pact/consumer_contract/interaction_v2_parser'
+require 'pact/consumer_contract/interaction_v3_parser'
+
+module Pact
+  class InteractionParser
+    def self.call hash, options = {}
+      pact_specification_version = options[:pact_specification_version] || Pact::SpecificationVersion::NIL_VERSION
+      case pact_specification_version.major
+      when nil, 0, 1, 2 then parse_v2_interaction(hash, pact_specification_version: pact_specification_version)
+      else parse_v3_interaction(hash, pact_specification_version: pact_specification_version)
+      end
+    end
+
+    def self.parse_v2_interaction hash, options
+      InteractionV2Parser.call(hash, options)
+    end
+
+    def self.parse_v3_interaction hash, options
+      InteractionV3Parser.call(hash, options)
+    end
+  end
+end

data/lib/pact/consumer_contract/interaction_v2_parser.rb

@@ -0,0 +1,28 @@
+require 'pact/consumer_contract/request'
+require 'pact/consumer_contract/response'
+require 'pact/symbolize_keys'
+require 'pact/matching_rules'
+require 'pact/errors'
+
+module Pact
+  class InteractionV2Parser
+
+    include SymbolizeKeys
+
+    def self.call hash, options
+      request = parse_request(hash['request'], options)
+      response = parse_response(hash['response'], options)
+      Interaction.new(symbolize_keys(hash).merge(request: request, response: response))
+    end
+
+    def self.parse_request request_hash, options
+      request_hash = Pact::MatchingRules.merge(request_hash, request_hash['matchingRules'], options)
+      Pact::Request::Expected.from_hash(request_hash)
+    end
+
+    def self.parse_response response_hash, options
+      response_hash = Pact::MatchingRules.merge(response_hash, response_hash['matchingRules'], options)
+      Pact::Response.from_hash(response_hash)
+    end
+  end
+end

data/lib/pact/consumer_contract/interaction_v3_parser.rb

@@ -0,0 +1,61 @@
+require 'pact/consumer_contract/request'
+require 'pact/consumer_contract/response'
+require 'pact/symbolize_keys'
+require 'pact/matching_rules'
+require 'pact/errors'
+require 'pact/consumer_contract/string_with_matching_rules'
+
+module Pact
+  class InteractionV3Parser
+
+    include SymbolizeKeys
+
+    def self.call hash, options
+      request = parse_request(hash['request'], options)
+      response = parse_response(hash['response'], options)
+      Interaction.new(symbolize_keys(hash).merge(request: request, response: response))
+    end
+
+    def self.parse_request request_hash, options
+      request_matching_rules = request_hash['matchingRules'] || {}
+      if request_hash['body'].is_a?(String)
+        parse_request_with_string_body(request_hash, request_matching_rules['body'] || {}, options)
+      else
+        parse_request_with_non_string_body(request_hash, request_matching_rules, options)
+      end
+    end
+
+    def self.parse_response response_hash, options
+      response_matching_rules = response_hash['matchingRules'] || {}
+      if response_hash['body'].is_a?(String)
+        parse_response_with_string_body(response_hash, response_matching_rules['body'] || {}, options)
+      else
+        parse_response_with_non_string_body(response_hash, response_matching_rules, options)
+      end
+    end
+
+    def self.parse_request_with_non_string_body request_hash, request_matching_rules, options
+      request_hash = request_hash.keys.each_with_object({}) do | key, new_hash |
+        new_hash[key] = Pact::MatchingRules.merge(request_hash[key], request_matching_rules[key], options)
+      end
+      Pact::Request::Expected.from_hash(request_hash)
+    end
+
+    def self.parse_response_with_non_string_body response_hash, response_matching_rules, options
+      response_hash = response_hash.keys.each_with_object({}) do | key, new_hash |
+        new_hash[key] = Pact::MatchingRules.merge(response_hash[key], response_matching_rules[key], options)
+      end
+      Pact::Response.from_hash(response_hash)
+    end
+
+    def self.parse_request_with_string_body request_hash, request_matching_rules, options
+      string_with_matching_rules = StringWithMatchingRules.new(request_hash['body'], options[:pact_specification_version], request_matching_rules)
+      Pact::Request::Expected.from_hash(request_hash.merge('body' => string_with_matching_rules))
+    end
+
+    def self.parse_response_with_string_body response_hash, response_matching_rules, options
+      string_with_matching_rules = StringWithMatchingRules.new(response_hash['body'], options[:pact_specification_version], response_matching_rules)
+      Pact::Response.from_hash(response_hash.merge('body' => string_with_matching_rules))
+    end
+  end
+end

data/lib/pact/consumer_contract/pact_file.rb

@@ -40,7 +40,7 @@ module Pact
     end
 
     private
-    
+
     def local? uri
       !uri.start_with?("http://", "https://")
     end
@@ -74,7 +74,7 @@ module Pact
         end
       end
     end
-    
+
     def get_remote(uri, options)
       request = Net::HTTP::Get.new(uri)
       request.basic_auth(options[:username], options[:password]) if options[:username]

data/lib/pact/consumer_contract/request.rb

@@ -2,9 +2,7 @@ require 'pact/shared/request'
 require 'pact/shared/null_expectation'
 
 module Pact
-
   module Request
-
     class Expected < Pact::Request::Base
 
       DEFAULT_OPTIONS = {:allow_unexpected_keys => false}.freeze
@@ -80,8 +78,6 @@ module Pact
       def body_differ
         Pact.configuration.body_differ_for_content_type content_type
       end
-
     end
-
   end
-end
+end

data/lib/pact/matchers/multipart_form_diff_formatter.rb

@@ -0,0 +1,41 @@
+require 'pact/matchers/unix_diff_formatter'
+require 'pact/matchers/differ'
+
+module Pact
+  module Matchers
+    class MultipartFormDiffFormatter
+
+      def initialize diff, options = {}
+        @options = options
+        @body_diff = diff[:body]
+        @non_body_diff = diff.reject{ |k, v| k == :body }
+        @colour = options.fetch(:colour, false)
+        @differ = Pact::Matchers::Differ.new(@colour)
+      end
+
+      def self.call diff, options = {}
+        new(diff, options).call
+      end
+
+      def call
+        Pact::Matchers::UnixDiffFormatter::MESSAGES_TITLE + "\n" + non_body_diff_string + "\n" + body_diff_string
+      end
+
+      def non_body_diff_string
+        if @non_body_diff.any?
+          Pact::Matchers::ExtractDiffMessages.call(@non_body_diff).collect{ | message| "* #{message}" }.join("\n")
+        else
+          ""
+        end
+      end
+
+      def body_diff_string
+        if @body_diff
+          @differ.diff_as_string(@body_diff.expected, @body_diff.actual)
+        else
+          ""
+        end
+      end
+    end
+  end
+end

data/lib/pact/matching_rules/merge.rb

@@ -92,7 +92,7 @@ module Pact
 
       def handle_match_type object, path, rules
         log_used_rule(path, 'match', 'type')
-        Pact::SomethingLike.new(object)
+        Pact::SomethingLike.new(recurse(object, path))
       end
 
       def handle_regex object, path, rules

data/lib/pact/matching_rules/v3/merge.rb

@@ -18,15 +18,15 @@ module Pact
 
         def call
           return @expected if @matching_rules.nil? || @matching_rules.empty?
-          recurse @expected, @root_path
+          recurse(@expected, @root_path).tap { log_ignored_rules }
         end
 
         private
 
         def standardise_paths matching_rules
           return matching_rules if matching_rules.nil? || matching_rules.empty?
-          matching_rules.each_with_object({}) do | (path, rule), new_matching_rules |
-            new_matching_rules[JsonPath.new(path).to_s] = rule
+          matching_rules.each_with_object({}) do | (path, rules), new_matching_rules |
+            new_matching_rules[JsonPath.new(path).to_s] = Marshal.load(Marshal.dump(rules)) # simplest way to deep clone
           end
         end
 
@@ -47,14 +47,14 @@ module Pact
         end
 
         def recurse_array array, path
+
+          parent_match_rule = @matching_rules[path] && @matching_rules[path]['matchers'] && @matching_rules[path]['matchers'].first && @matching_rules[path]['matchers'].first.delete('match')
           array_like_children_path = "#{path}[*]*"
-          parent_match_rule = @matching_rules[path] && @matching_rules[path]['matchers'] && @matching_rules[path]['matchers'].first && @matching_rules[path]['matchers'].first['match']
-          children_match_rule = @matching_rules[array_like_children_path] && @matching_rules[array_like_children_path]['matchers'] && @matching_rules[array_like_children_path]['matchers'].first && @matching_rules[array_like_children_path]['matchers'].first['match']
-          min = @matching_rules[path] && @matching_rules[path]['matchers'] && @matching_rules[path]['matchers'].first && @matching_rules[path]['matchers'].first['min']
+          children_match_rule = @matching_rules[array_like_children_path] && @matching_rules[array_like_children_path]['matchers'] && @matching_rules[array_like_children_path]['matchers'].first && @matching_rules[array_like_children_path]['matchers'].first.delete('match')
+          min = @matching_rules[path] && @matching_rules[path]['matchers'] && @matching_rules[path]['matchers'].first && @matching_rules[path]['matchers'].first.delete('min')
 
           if min && (children_match_rule == 'type' || (children_match_rule.nil? && parent_match_rule == 'type'))
             warn_when_not_one_example_item(array, path)
-            # log_ignored_rules(path, @matching_rules[path], {'min' => min})
             Pact::ArrayLike.new(recurse(array.first, "#{path}[*]"), min: min)
           else
             new_array = []
@@ -82,30 +82,46 @@ module Pact
           elsif rules['regex']
             handle_regex(object, path, rules)
           else
-            log_ignored_rules(path, rules, {})
+            #log_ignored_rules(path, rules, {})
             object
           end
         end
 
         def handle_match_type object, path, rules
-          log_ignored_rules(path, rules, {'match' => 'type'})
-          Pact::SomethingLike.new(object)
+          rules.delete('match')
+          Pact::SomethingLike.new(recurse(object, path))
         end
 
         def handle_regex object, path, rules
-          log_ignored_rules(path, rules, {'match' => 'regex', 'regex' => rules['regex']})
-          Pact::Term.new(generate: object, matcher: Regexp.new(rules['regex']))
+          rules.delete('match')
+          regex = rules.delete('regex')
+          Pact::Term.new(generate: object, matcher: Regexp.new(regex))
         end
 
-        def log_ignored_rules path, rules, used_rules
-          dup_rules = rules.dup
-          used_rules.each_pair do | used_key, used_value |
-            dup_rules.delete(used_key) if dup_rules[used_key] == used_value
+        def log_ignored_rules
+          @matching_rules.each do | jsonpath, rules_hash |
+            rules_array = rules_hash["matchers"]
+            ((rules_array.length - 1)..0).each do | index |
+              rules_array.delete_at(index) if rules_array[index].empty?
+            end
           end
-          if dup_rules.any?
-            $stderr.puts "WARN: Ignoring unsupported matching rules #{dup_rules} for path #{path}"
+
+          if @matching_rules.any?
+            @matching_rules.each do | path, rules_hash |
+              rules_hash.each do | key, value |
+                $stderr.puts "WARN: Ignoring unsupported #{key} #{value} for path #{path}" if value.any?
+              end
+            end
           end
         end
+
+        def find_rule(path, key)
+          @matching_rules[path] && @matching_rules[path][key]
+        end
+
+        def log_used_rule path, key, value
+          @used_rules << [path, key, value]
+        end
       end
     end
   end

data/lib/pact/shared/multipart_form_differ.rb

@@ -0,0 +1,14 @@
+require 'uri'
+require 'pact/shared/text_differ'
+
+module Pact
+  class MultipartFormDiffer
+    def self.call expected, actual, options = {}
+      require 'pact/matchers' # avoid recursive loop between this file and pact/matchers
+      expected_boundary = expected.split.first
+      actual_boundary = actual.split.first
+      actual_with_hardcoded_boundary = actual.gsub(actual_boundary, expected_boundary)
+      TextDiffer.call(expected, actual_with_hardcoded_boundary, options)
+    end
+  end
+end

data/lib/pact/specification_version.rb

@@ -14,5 +14,5 @@ module Pact
     end
   end
 
-  SpecificationVersion::NIL_VERSION = Pact::SpecificationVersion.new('')
+  SpecificationVersion::NIL_VERSION = Pact::SpecificationVersion.new('0')
 end

data/lib/pact/support/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module Support
-    VERSION = "1.7.0.alpha.1"
+    VERSION = "1.7.0"
   end
 end

data/spec/fixtures/multipart-form-diff.txt

@@ -0,0 +1,9 @@
+
+
+Description of differences
+--------------------------------------
+* Wrong header
+
+@@ -1,2 +1,2 @@
+-bar
++foo

data/spec/fixtures/not-a-pact.json

@@ -0,0 +1,3 @@
+{
+  "foo": "bar"
+}

data/spec/integration/matching_rules_extract_and_merge_spec.rb

@@ -1,7 +1,9 @@
 require 'pact/term'
 require 'pact/something_like'
 require 'pact/matching_rules/extract'
+require 'pact/matching_rules/v3/extract'
 require 'pact/matching_rules/merge'
+require 'pact/matching_rules/v3/merge'
 require 'pact/reification'
 
 describe "converting Pact::Term and Pact::SomethingLike to matching rules and back again" do
@@ -10,6 +12,9 @@ describe "converting Pact::Term and Pact::SomethingLike to matching rules and ba
   let(:matching_rules) { Pact::MatchingRules::Extract.(expected) }
   let(:recreated_expected) { Pact::MatchingRules::Merge.(example, matching_rules)}
 
+  let(:recreated_expected_v3) { Pact::MatchingRules::V3::Merge.(example, matching_rules_v3) }
+  let(:matching_rules_v3) { Pact::MatchingRules::V3::Extract.(expected) }
+
   context "with a Pact::Term" do
     let(:expected) do
       {
@@ -21,9 +26,29 @@ describe "converting Pact::Term and Pact::SomethingLike to matching rules and ba
       }
     end
 
-    it "recreates the same object hierarchy" do
+    it "recreates the same object hierarchy with v2 matching" do
+      expect(recreated_expected).to eq expected
+    end
+
+    it "recreates the same object hierarchy with v3 matching" do
+      expect(recreated_expected_v3).to eq expected
+    end
+  end
+
+  context "with a Pact::SomethingLike containing a Pact::ArrayLike" do
+    let(:expected) do
+      {
+        body: Pact::SomethingLike.new(children: Pact::ArrayLike.new("foo", min: 2))
+      }
+    end
+
+    it "recreates the same object hierarchy with v2 matching" do
       expect(recreated_expected).to eq expected
     end
+
+    it "recreates the same object hierarchy with v3 matching" do
+      expect(recreated_expected_v3).to eq expected
+    end
   end
 
   context "with a Pact::SomethingLike" do
@@ -37,9 +62,13 @@ describe "converting Pact::Term and Pact::SomethingLike to matching rules and ba
       }
     end
 
-    it "recreates the same object hierarchy" do
+    it "recreates the same object hierarchy with v2 matching" do
       expect(recreated_expected).to eq expected
     end
+
+    it "recreates the same object hierarchy with v3 matching" do
+      expect(recreated_expected_v3).to eq expected
+    end
   end
 
   context "with a Pact::SomethingLike containing a Hash" do
@@ -61,9 +90,13 @@ describe "converting Pact::Term and Pact::SomethingLike to matching rules and ba
       }
     end
 
-    it "recreates the same object hierarchy" do
+    it "recreates the same object hierarchy with v2 matching" do
       expect(recreated_expected).to eq expected
     end
+
+    it "recreates the same object hierarchy with v3 matching" do
+      expect(recreated_expected_v3).to eq expected
+    end
   end
 
   context "with a Pact::SomethingLike containing an Array" do
@@ -83,8 +116,12 @@ describe "converting Pact::Term and Pact::SomethingLike to matching rules and ba
       }
     end
 
-    it "recreates the same object hierarchy" do
+    it "recreates the same object hierarchy with v2 matching" do
       expect(recreated_expected).to eq expected
     end
+
+    it "recreates the same object hierarchy with v3 matching" do
+      expect(recreated_expected_v3).to eq expected
+    end
   end
 end

data/spec/lib/pact/consumer_contract/consumer_contract_spec.rb

@@ -3,6 +3,26 @@ require 'pact/consumer_contract'
 
 module Pact
   describe ConsumerContract do
+    describe "from_uri" do
+      context "when the URL does not point to a valid pact" do
+        subject { ConsumerContract.from_uri('spec/fixtures/not-a-pact.json') }
+
+        it "raises a helpful error" do
+          expect { subject }.to raise_error UnrecognizePactFormatError, /Please check that spec/
+        end
+      end
+    end
+
+    describe "from_hash" do
+      context "when the hash is not a valid pact" do
+        subject { ConsumerContract.from_hash({'foo' => 'bar'}) }
+
+        it "raises a helpful error" do
+          expect { subject }.to raise_error UnrecognizePactFormatError, 'This document does not use a recognised Pact format: {"foo"=>"bar"}'
+        end
+      end
+    end
+
     describe ".from_json" do
 
       let(:loaded_pact) { ConsumerContract.from_json(string) }

data/spec/lib/pact/consumer_contract/interaction_parser_spec.rb

@@ -0,0 +1,62 @@
+require 'pact/consumer_contract/interaction_parser'
+
+module Pact
+  describe InteractionParser do
+    describe ".call" do
+
+      let(:request) { {method: 'get', path: 'path'} }
+      let(:response) { {} }
+
+      context "when providerState has been used instead of provider_state" do
+
+        subject { InteractionParser.call('response' => response, 'request' => request, 'providerState' => 'some state') }
+
+        it "recognises the provider state" do
+          expect(subject.provider_state).to eq 'some state'
+        end
+      end
+
+      context "when there are matching rules" do
+        let(:hash) { load_json_fixture 'interaction-with-matching-rules.json' }
+
+        subject { InteractionParser.call(hash, pact_specification_version: Pact::SpecificationVersion.new("2")) }
+
+        it "merges the rules with the example for the request" do
+          expect(subject.request.body['name']).to be_instance_of(Pact::Term)
+        end
+
+        it "merges the rules with the example for the response" do
+          expect(subject.response.body['_links']['self']['href']).to be_instance_of(Pact::Term)
+        end
+      end
+
+      context "when the request body is a String" do
+        let(:hash) { { 'request' => request, 'response' => response } }
+        subject { InteractionParser.call(hash, pact_specification_version: Pact::SpecificationVersion.new("3")) }
+
+        let(:request) { { 'method' => 'get', 'path' => 'path' , 'body' => "<xml></xml>", 'matchingRules' => {"body" => {"foo" => "bar"} } } }
+
+        it "returns an interaction with an StringWithMatchingRules in the request" do
+          expect(subject.request.body).to be_a(Pact::StringWithMatchingRules)
+          expect(subject.request.body).to eq "<xml></xml>"
+          expect(subject.request.body.matching_rules).to eq "foo" => "bar"
+          expect(subject.request.body.pact_specification_version).to eq Pact::SpecificationVersion.new("3")
+        end
+      end
+
+      context "when the response body is a String" do
+        let(:hash) { { 'request' => request, 'response' => response } }
+        subject { InteractionParser.call(hash, pact_specification_version: Pact::SpecificationVersion.new("3")) }
+
+        let(:response) { { 'status' => '200', 'body' => "<xml></xml>", 'matchingRules' => {"body" => {"foo" => "bar"} } } }
+
+        it "returns an interaction with an StringWithMatchingRules in the response" do
+          expect(subject.response.body).to be_a(Pact::StringWithMatchingRules)
+          expect(subject.response.body).to eq "<xml></xml>"
+          expect(subject.response.body.matching_rules).to eq "foo" => "bar"
+          expect(subject.response.body.pact_specification_version).to eq Pact::SpecificationVersion.new("3")
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact/consumer_contract/interaction_spec.rb

@@ -52,58 +52,7 @@ module Pact
         end
       end
 
-      describe "from_hash" do
-        context "when providerState has been used instead of provider_state" do
 
-          subject { Interaction.from_hash('response' => response, 'request' => request, 'providerState' => 'some state') }
-
-          it "recognises the provider state" do
-            expect(subject.provider_state).to eq 'some state'
-          end
-        end
-
-        context "when there are matching rules" do
-          let(:hash) { load_json_fixture 'interaction-with-matching-rules.json' }
-
-          subject { Interaction.from_hash hash, pact_specification_version: Pact::SpecificationVersion.new("2") }
-
-          it "merges the rules with the example for the request" do
-            expect(subject.request.body['name']).to be_instance_of(Pact::Term)
-          end
-
-          it "merges the rules with the example for the response" do
-            expect(subject.response.body['_links']['self']['href']).to be_instance_of(Pact::Term)
-          end
-        end
-
-        context "when the request body is a String" do
-          let(:hash) { { 'request' => request, 'response' => response } }
-          subject { Interaction.from_hash hash, pact_specification_version: Pact::SpecificationVersion.new("3") }
-
-          let(:request) { { 'method' => 'get', 'path' => 'path' , 'body' => "<xml></xml>", 'matchingRules' => {"body" => {"foo" => "bar"} } } }
-
-          it "returns an interaction with an StringWithMatchingRules in the request" do
-            expect(subject.request.body).to be_a(Pact::StringWithMatchingRules)
-            expect(subject.request.body).to eq "<xml></xml>"
-            expect(subject.request.body.matching_rules).to eq "foo" => "bar"
-            expect(subject.request.body.pact_specification_version).to eq Pact::SpecificationVersion.new("3")
-          end
-        end
-
-        context "when the response body is a String" do
-          let(:hash) { { 'request' => request, 'response' => response } }
-          subject { Interaction.from_hash hash, pact_specification_version: Pact::SpecificationVersion.new("3") }
-
-          let(:response) { { 'status' => '200', 'body' => "<xml></xml>", 'matchingRules' => {"body" => {"foo" => "bar"} } } }
-
-          it "returns an interaction with an StringWithMatchingRules in the response" do
-            expect(subject.response.body).to be_a(Pact::StringWithMatchingRules)
-            expect(subject.response.body).to eq "<xml></xml>"
-            expect(subject.response.body.matching_rules).to eq "foo" => "bar"
-            expect(subject.response.body.pact_specification_version).to eq Pact::SpecificationVersion.new("3")
-          end
-        end
-      end
 
       describe "request_modifies_resource_without_checking_response_body?" do
 

data/spec/lib/pact/matchers/multipart_form_diff_formatter_spec.rb

@@ -0,0 +1,36 @@
+require 'pact/matchers/multipart_form_diff_formatter'
+
+module Pact
+  module Matchers
+    describe MultipartFormDiffFormatter do
+      describe ".call" do
+        subject { MultipartFormDiffFormatter.call(diff, options)}
+
+        let(:diff) do
+          {
+            headers: header_diff,
+            body: body_diff
+          }
+        end
+
+        let(:header_diff) do
+          {
+            "Content-Type" => Difference.new("foo", "bar", "Wrong header")
+          }
+        end
+
+        let(:body_diff) do
+          Difference.new("foo", "bar", "A message")
+        end
+
+        let(:options) { {} }
+
+        let(:expected_output) { File.read("spec/fixtures/multipart-form-diff.txt")}
+
+        it "formats the diff" do
+          expect(subject).to eq expected_output
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact/matching_rules/v3/merge_spec.rb

@@ -7,10 +7,16 @@ module Pact
         subject { Merge.(expected, matching_rules) }
 
         before do
-          allow($stderr).to receive(:puts)
+          allow($stderr).to receive(:puts) do | message |
+            raise "Was not expecting stderr to receive #{message.inspect} in this spec. This may be because of a missed rule deletion in Merge."
+          end
         end
 
         describe "no recognised rules" do
+          before do
+            allow($stderr).to receive(:puts)
+          end
+
           let(:expected) do
             {
               "_links" => {
@@ -65,6 +71,10 @@ module Pact
         end
 
         describe "type based matching" do
+          before do
+            allow($stderr).to receive(:puts)
+          end
+
           let(:expected) do
             {
               "name" => "Mary"
@@ -88,11 +98,19 @@ module Pact
             subject
           end
 
+          it "does not alter the passed in rules hash" do
+            original_matching_rules = JSON.parse(matching_rules.to_json)
+            subject
+            expect(matching_rules).to eq original_matching_rules
+          end
         end
 
         describe "regular expressions" do
-
           describe "in a hash" do
+            before do
+              allow($stderr).to receive(:puts)
+            end
+
             let(:expected) do
               {
                 "_links" => {
@@ -275,6 +293,10 @@ module Pact
           end
 
           describe "with an example array with more than one item" do
+            before do
+              allow($stderr).to receive(:puts)
+            end
+
             let(:expected) do
               {
 
@@ -292,7 +314,7 @@ module Pact
               }
             end
 
-            xit "doesn't warn about the min size being ignored" do
+            it "doesn't warn about the min size being ignored" do
               expect(Pact.configuration.error_stream).to receive(:puts).once
               subject
             end

data/spec/lib/pact/shared/multipart_form_differ_spec.rb

@@ -0,0 +1,39 @@
+require 'pact/shared/multipart_form_differ'
+
+module Pact
+  describe MultipartFormDiffer do
+
+    describe ".call" do
+
+      let(:expected_body) do
+        "-------------RubyMultipartPost-1e4912957c7bb64de3c444568326663b\r\nContent-Disposition: form-data; name=\"file\"; filename=\"text.txt\"\r\nContent-Length: 14\r\nContent-Type: text/plain\r\nContent-Transfer-Encoding: binary\r\n\r\nThis is a file\r\n-------------RubyMultipartPost-1e4912957c7bb64de3c444568326663b--\r\n\r\n"
+      end
+
+      let(:actual_body) do
+        "-------------RubyMultipartPost-1e4912957c7bb64de3c4445683266XXX\r\nContent-Disposition: form-data; name=\"file\"; filename=\"text.txt\"\r\nContent-Length: 14\r\nContent-Type: text/plain\r\nContent-Transfer-Encoding: binary\r\n\r\nThis is a file\r\n-------------RubyMultipartPost-1e4912957c7bb64de3c4445683266XXX--\r\n\r\n"
+      end
+
+      let(:options) do
+        {}
+      end
+
+      subject { MultipartFormDiffer.call(expected_body, actual_body, options) }
+
+      context "when the bodies are the same apart from the boundary" do
+        it "returns an empty diff" do
+          expect(subject).to eq({})
+        end
+      end
+
+      context "when the bodies are not the same" do
+        let(:actual_body) do
+          "-------------RubyMultipartPost-1e4912957c7bb64de3c4445683266XXX\r\nContent-Disposition: form-data; name=\"file\"; filename=\"bar.txt\"\r\nContent-Length: 14\r\nContent-Type: text/plain\r\nContent-Transfer-Encoding: binary\r\n\r\nThis is a file\r\n-------------RubyMultipartPost-1e4912957c7bb64de3c4445683266XXX--\r\n\r\n"
+        end
+
+        it "returns a text diff" do
+          expect(subject).to_not eq({})
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-support
 version: !ruby/object:Gem::Version
-  version: 1.7.0.alpha.1
+  version: 1.7.0
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-14 00:00:00.000000000 Z
+date: 2018-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -270,6 +270,9 @@ files:
 - lib/pact/consumer_contract/headers.rb
 - lib/pact/consumer_contract/http_consumer_contract_parser.rb
 - lib/pact/consumer_contract/interaction.rb
+- lib/pact/consumer_contract/interaction_parser.rb
+- lib/pact/consumer_contract/interaction_v2_parser.rb
+- lib/pact/consumer_contract/interaction_v3_parser.rb
 - lib/pact/consumer_contract/pact_file.rb
 - lib/pact/consumer_contract/query.rb
 - lib/pact/consumer_contract/query_hash.rb
@@ -294,6 +297,7 @@ files:
 - lib/pact/matchers/index_not_found.rb
 - lib/pact/matchers/list_diff_formatter.rb
 - lib/pact/matchers/matchers.rb
+- lib/pact/matchers/multipart_form_diff_formatter.rb
 - lib/pact/matchers/no_diff_at_index.rb
 - lib/pact/matchers/regexp_difference.rb
 - lib/pact/matchers/type_difference.rb
@@ -314,6 +318,7 @@ files:
 - lib/pact/shared/jruby_support.rb
 - lib/pact/shared/json_differ.rb
 - lib/pact/shared/key_not_found.rb
+- lib/pact/shared/multipart_form_differ.rb
 - lib/pact/shared/null_expectation.rb
 - lib/pact/shared/request.rb
 - lib/pact/shared/text_differ.rb
@@ -328,6 +333,8 @@ files:
 - script/release.sh
 - script/update-pact-specification-v2
 - spec/fixtures/interaction-with-matching-rules.json
+- spec/fixtures/multipart-form-diff.txt
+- spec/fixtures/not-a-pact.json
 - spec/fixtures/pact-http-v2.json
 - spec/fixtures/pact-http-v3.json
 - spec/integration/matching_rules_extract_and_merge_spec.rb
@@ -339,6 +346,7 @@ files:
 - spec/lib/pact/consumer_contract/file_name_spec.rb
 - spec/lib/pact/consumer_contract/headers_spec.rb
 - spec/lib/pact/consumer_contract/http_consumer_contract_parser_spec.rb
+- spec/lib/pact/consumer_contract/interaction_parser_spec.rb
 - spec/lib/pact/consumer_contract/interaction_spec.rb
 - spec/lib/pact/consumer_contract/pact_file_spec.rb
 - spec/lib/pact/consumer_contract/query_hash_spec.rb
@@ -357,6 +365,7 @@ files:
 - spec/lib/pact/matchers/matchers_messages_mismatched_value_spec.rb
 - spec/lib/pact/matchers/matchers_messages_regexp_spec.rb
 - spec/lib/pact/matchers/matchers_spec.rb
+- spec/lib/pact/matchers/multipart_form_diff_formatter_spec.rb
 - spec/lib/pact/matchers/no_diff_at_index_spec.rb
 - spec/lib/pact/matchers/regexp_difference_spec.rb
 - spec/lib/pact/matchers/type_difference_spec.rb
@@ -373,6 +382,7 @@ files:
 - spec/lib/pact/shared/form_differ_spec.rb
 - spec/lib/pact/shared/json_differ_spec.rb
 - spec/lib/pact/shared/key_not_found_spec.rb
+- spec/lib/pact/shared/multipart_form_differ_spec.rb
 - spec/lib/pact/shared/request_spec.rb
 - spec/lib/pact/shared/text_differ_spec.rb
 - spec/lib/pact/something_like_spec.rb
@@ -420,9 +430,9 @@ 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: []
 rubyforge_project: 
 rubygems_version: 2.6.11
@@ -431,6 +441,8 @@ specification_version: 4
 summary: Shared code for Pact gems
 test_files:
 - spec/fixtures/interaction-with-matching-rules.json
+- spec/fixtures/multipart-form-diff.txt
+- spec/fixtures/not-a-pact.json
 - spec/fixtures/pact-http-v2.json
 - spec/fixtures/pact-http-v3.json
 - spec/integration/matching_rules_extract_and_merge_spec.rb
@@ -442,6 +454,7 @@ test_files:
 - spec/lib/pact/consumer_contract/file_name_spec.rb
 - spec/lib/pact/consumer_contract/headers_spec.rb
 - spec/lib/pact/consumer_contract/http_consumer_contract_parser_spec.rb
+- spec/lib/pact/consumer_contract/interaction_parser_spec.rb
 - spec/lib/pact/consumer_contract/interaction_spec.rb
 - spec/lib/pact/consumer_contract/pact_file_spec.rb
 - spec/lib/pact/consumer_contract/query_hash_spec.rb
@@ -460,6 +473,7 @@ test_files:
 - spec/lib/pact/matchers/matchers_messages_mismatched_value_spec.rb
 - spec/lib/pact/matchers/matchers_messages_regexp_spec.rb
 - spec/lib/pact/matchers/matchers_spec.rb
+- spec/lib/pact/matchers/multipart_form_diff_formatter_spec.rb
 - spec/lib/pact/matchers/no_diff_at_index_spec.rb
 - spec/lib/pact/matchers/regexp_difference_spec.rb
 - spec/lib/pact/matchers/type_difference_spec.rb
@@ -476,6 +490,7 @@ test_files:
 - spec/lib/pact/shared/form_differ_spec.rb
 - spec/lib/pact/shared/json_differ_spec.rb
 - spec/lib/pact/shared/key_not_found_spec.rb
+- spec/lib/pact/shared/multipart_form_differ_spec.rb
 - spec/lib/pact/shared/request_spec.rb
 - spec/lib/pact/shared/text_differ_spec.rb
 - spec/lib/pact/something_like_spec.rb