pact-support 1.6.4 → 1.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff8ff3846a8b04e97c85f0bc41ec7d0162e58195
-  data.tar.gz: aba56d2bc4538303c403f236897ef29dd769c79c
+  metadata.gz: 0d403d886a68ff8d7dcc27760407ae9c38328347
+  data.tar.gz: abbf6ec8fe5c0aef4d88c27861206e3ad8911a07
 SHA512:
-  metadata.gz: afc426f3151482889c6aec89940d44db5301f657e690bb34985a37af38c82c00cbbf1bc0ba865876b92688ebaeb10635ef157b9e99e31868619d1cfcbc73035c
-  data.tar.gz: 9cf48a3493ddf6ef465720c79dd9b61e5588c206ddbba3d51b4997b0d13ef4b59162f14867961d6cbbacd6253584053c8c941337480476e5196d61855930b407
+  metadata.gz: 784021ebd38e3b04a2ce10078af2dd1575a80a66a6e3d10008086725407c3f2a568b41be3a7198ff5d7f52c70979c1cb034d601cd1bcdf0ab482d15da0c8da48
+  data.tar.gz: 13b5f238474aa903389b9252a76c71c0d6b416dbab8642571ac60d55100017dab53c98bd2d4b6056fe45922dba69e1984026ed6cea398a89ccf6d06269c69ea4

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+<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/consumer_contract/consumer_contract.rb

@@ -13,6 +13,9 @@ require 'pact/consumer_contract/pact_file'
 require 'pact/consumer_contract/http_consumer_contract_parser'
 
 module Pact
+
+  class UnrecognizePactFormatError < ::Pact::Error; end
+
   class ConsumerContract
 
     include SymbolizeKeys
@@ -30,7 +33,7 @@ module Pact
     end
 
     def self.add_parser consumer_contract_parser
-      parsers << consumer_contract_parser
+      parsers.unshift(consumer_contract_parser)
     end
 
     def self.parsers
@@ -41,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
@@ -51,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,104 +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/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)
+    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
       end
+      true
+    end
 
-      def self.parse_v2_interaction hash, options
-        request_hash = Pact::MatchingRules.merge(hash['request'], hash['request']['matchingRules'], options)
-        request = Pact::Request::Expected.from_hash(request_hash)
-        response_hash = Pact::MatchingRules.merge(hash['response'], hash['response']['matchingRules'], options)
-        response = Pact::Response.from_hash(response_hash)
-        new(symbolize_keys(hash).merge(request: request, response: response))
-      end
-
-      def self.parse_v3_interaction hash, options
-
-        request_hash = hash['request'].keys.each_with_object({}) do | key, new_hash |
-          new_hash[key] = Pact::MatchingRules.merge(hash['request'][key], hash['request'].fetch('matchingRules', {})[key], options)
-        end
-        request = Pact::Request::Expected.from_hash(request_hash)
-
-        response_hash = hash['response'].keys.each_with_object({}) do | key, new_hash |
-          new_hash[key] = Pact::MatchingRules.merge(hash['response'][key], hash['response'].fetch('matchingRules', {})[key], options)
-        end
+    def match_criterion target, criterion
+      target == criterion || (criterion.is_a?(Regexp) && criterion.match(target))
+    end
 
-        response = Pact::Response.from_hash(response_hash)
-        new(symbolize_keys(hash).merge(request: request, response: response))
-      end
+    def == other
+      other.is_a?(Interaction) && to_hash == other.to_hash
+    end
 
-      def to_hash
-        {
-          description: description,
-          provider_state: provider_state,
-          request: request.to_hash,
-          response: response.to_hash
-        }
-      end
+    def eq? other
+      self == other
+    end
 
-      def http?
-        true
-      end
+    def description_with_provider_state_quoted
+      provider_state ? "\"#{description}\" given \"#{provider_state}\"" : "\"#{description}\""
+    end
 
-      def validate!
-        raise Pact::InvalidInteractionError.new(self) unless description && request && response
-      end
+    def request_modifies_resource_without_checking_response_body?
+      request.modifies_resource? && response.body_allows_any_value?
+    end
 
-      def matches_criteria? criteria
-        criteria.each do | key, value |
-          unless match_criterion self.send(key.to_s), value
-            return false
-          end
-        end
-        true
-      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 eq? other
-        self == other
-      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 to_s
-        to_hash.to_s
-      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/string_with_matching_rules.rb

@@ -0,0 +1,17 @@
+module Pact
+  class StringWithMatchingRules < String
+    attr_reader :matching_rules
+    attr_reader :pact_specification_version
+
+    def initialize string, pact_specification_version, matching_rules = {}
+      super(string)
+      @matching_rules = matching_rules
+      @pact_specification_version = pact_specification_version
+    end
+
+    # How can we show the matching rules too?
+    def to_s
+      super
+    end
+  end
+end

data/lib/pact/reification.rb

@@ -5,6 +5,7 @@ require 'pact/array_like'
 require 'pact/shared/request'
 require 'pact/consumer_contract/query_hash'
 require 'pact/consumer_contract/query_string'
+require 'pact/consumer_contract/string_with_matching_rules'
 
 module Pact
   module Reification
@@ -35,6 +36,8 @@ module Pact
             "#{k}=#{escape(v)}"
           end
         }.join('&')
+      when Pact::StringWithMatchingRules
+        String.new(term)
       else
         term
       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.6.4"
+    VERSION = "1.6.5"
   end
 end

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

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

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,30 +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
-      end
 
       describe "request_modifies_resource_without_checking_response_body?" do
 

data/spec/lib/pact/reification_spec.rb

@@ -160,5 +160,13 @@ module Pact
         expect(subject).to eq("param=1&param=1")
       end
     end
+
+    context "with a StringWithMatchingRules" do
+      subject { Reification.from_term(StringWithMatchingRules.new("foo", Pact::SpecificationVersion.new("3"), {}))}
+
+      it "returns a String" do
+        expect(subject.class).to be String
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact-support
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.6.5
 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-07-24 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
@@ -278,6 +281,7 @@ files:
 - lib/pact/consumer_contract/response.rb
 - lib/pact/consumer_contract/service_consumer.rb
 - lib/pact/consumer_contract/service_provider.rb
+- lib/pact/consumer_contract/string_with_matching_rules.rb
 - lib/pact/errors.rb
 - lib/pact/helpers.rb
 - lib/pact/logging.rb
@@ -327,6 +331,7 @@ files:
 - script/release.sh
 - script/update-pact-specification-v2
 - spec/fixtures/interaction-with-matching-rules.json
+- 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
@@ -338,6 +343,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
@@ -430,6 +436,7 @@ specification_version: 4
 summary: Shared code for Pact gems
 test_files:
 - spec/fixtures/interaction-with-matching-rules.json
+- 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
@@ -441,6 +448,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