pact 1.2.1.rc2 → 1.3.3

data/.travis.yml

@@ -5,4 +5,4 @@ rvm:
   - 2.1.1
   - jruby-19mode
   - jruby-1.7.11
-  - jruby-head
+  - jruby-1.7.12

data/CHANGELOG.md

@@ -2,6 +2,37 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 1.3.3 (23 September 2014)
+
+* 9106aac - Fixed reification when using FactoryGirl. (bethesque, Tue Sep 23 08:23:51 2014 +1000)
+* 2182803 - Added "query" to example. (bethesque, Fri Sep 19 14:29:36 2014 +1000)
+* 0002014 - Added key to explain - and + in unix diff output. (bethesque, Mon Sep 8 15:21:37 2014 +1000)
+* 34f1c9b - Adding forward compatibility for reading 'providerState' from pact. (bethesque, Mon Aug 25 16:09:57 2014 +1000)
+
+### 1.3.2 (20 August 2014)
+
+* 65e1e23 - Renamed memoised :options to :diff_options because it clashes with the HTTP options method (bethesque, Wed Aug 20 09:31:0
+* ca883a8 - Made options optional for ConsumerContactBuilder.wait_for_interactions (bethesque, Mon Aug 18 15:53:47 2014 +1000)
+
+### 1.3.1 (11 August 2014)
+
+* 3432259 - Fixed 'pact:verify broken with rspec-core 3.0.3'  https://github.com/realestate-com-au/pact/issues/44 (bethesque, Mon Aug 11 10:14:42 2014 +1000)
+* e2e8eff - Deleted documentation that has been moved to the wiki (bethesque, Thu Jul 24 15:20:07 2014 +1000)
+* bcc3143 - Fixing bug 'Method case should not matter when matching requests' https://github.com/realestate-com-au/pact/issues/41 (bethesque, Tue Jul 22 16:51:48 2014 +1000)
+* d4bfab9 - Adding ability to configure DiffFormatter based on content-type (bethesque, Mon Jun 23 21:22:47 2014 +1000)
+* eb330ea - Ensured content-type header works in a case insensitive way when looking up the right differ (bethesque, Mon Jun 23 17:23:04 2014 +1000)
+* 2733e8e - Made header matching case insensitive for requests. Fixing issue https://github.com/realestate-com-au/pact/issues/20 (bethesque, Mon May 26 19:15:48 2014 +1000)
+* 2b8355d - Added nicer error message for scenario when a service provider app has not been configured, and there is no config.ru (bethesque, Mon Jun 23 09:42:18 2014 +1000)
+* 1e774bb - Defaulting to TextDiffer if response has no content-type (bethesque, Sat Jun 21 10:34:44 2014 +1000)
+* 863b093 - Added support for documents without content types (bethesque, Sat Jun 21 10:32:08 2014 +1000)
+* b21900b - Enabling differs to be configured based on Content-Type (bethesque, Sat Jun 21 10:21:37 2014 +1000)
+* 527b5d5 - Modified after hook to only write pacts when one or more 'pact => true' examples have run (bethesque, Wed Jun 18 15:15:55 2014 +1000)
+
+### 1.3.0 (18 June 2014)
+
+* ea79190 - Modifying (cough*monkeypatching*cough) RSpec::Core::BacktraceFormatter as RSpec3 has some hardcoded exclusion patterns that result in *all* the backtrace lines being shown when pact:verify fails. (bethesque, Wed Jun 18 13:02:38 2014 +1000)
+* 0fd2bb2 - Support objects that return valid URI strings through to_s (Gabriel Rotbart, Fri Jun 13 14:34:03 2014 +1000)
+
 ### 1.2.1.rc2 (13 June 2014)
 
 * d805f35 - Ensuring the pact RSpec formatter works for both rspec 2 and rspec 3 (Beth, Fri Jun 13 16:27:01 2014 +1000)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (1.2.1.rc2)
+    pact (1.3.3)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json
@@ -50,21 +50,21 @@ GEM
       rspec-core (~> 3.0.0)
       rspec-expectations (~> 3.0.0)
       rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.0)
+    rspec-core (3.0.4)
       rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.0)
+    rspec-expectations (3.0.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.1)
+    rspec-mocks (3.0.4)
       rspec-support (~> 3.0.0)
-    rspec-support (3.0.0)
+    rspec-support (3.0.4)
     safe_yaml (1.0.3)
     slop (3.5.0)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.4)
-    tins (1.3.0)
+    tins (1.3.2)
     tzinfo (1.2.1)
       thread_safe (~> 0.1)
     webmock (1.18.0)

data/README.md

@@ -2,32 +2,39 @@
 
 Define a pact between service consumers and providers, enabling "consumer driven contract" testing.
 
-Pact provides an RSpec DSL for service consumers to define the HTTP requests they will make to a service provider and the HTTP responses they expect back. These expectations are used in the consumers specs to provide a mock service provider. The interactions are recorded, and played back in the service provider specs to ensure the service provider actually does provide the response the consumer expects.
+Pact provides an fluent API for service consumers to define the HTTP requests they will make to a service provider and the HTTP responses they expect back. These expectations are used in the consumer specs to provide a mock service provider. The interactions are recorded, and played back in the service provider specs to ensure the service provider actually does provide the response the consumer expects.
 
 This allows testing of both sides of an integration point using fast unit tests.
 
-This gem is inspired by the concept of "Consumer driven contracts". See http://martinfowler.com/articles/consumerDrivenContracts.html for more information.
+This gem is inspired by the concept of "Consumer driven contracts". See [this article](http://martinfowler.com/articles/consumerDrivenContracts.html) by Martin Fowler for more information.
 
 Travis CI Status: [![travis-ci.org Build Status](https://travis-ci.org/realestate-com-au/pact.png)](https://travis-ci.org/realestate-com-au/pact)
 
 ## What is it good for?
 
-Pact is most valuable for designing and testing integrations where you (or your team/organisation/partner organisation) control the development of both the consumer and the provider. It is fantastic tool for intra-organsation microservices.
+Pact is most valuable for designing and testing integrations where you (or your team/organisation/partner organisation) control the development of both the consumer and the provider. It is fantastic tool for testing intra-organsation microservices.
+
+## What is it not good for?
+
+* Performance and load testing.
+* Functional testing of the provider - that is what the provider's own tests should do. Pact is about checking the contents and format of requests and responses.
+* Situations where you cannot load data into the provider without using the API that you're actually testing.
 
 ## Features
 
 * A service is mocked using an actual process running on a specified port, so javascript clients can be tested as easily as backend clients.
 * "Provider states" (similar to fixtures) allow the same request to be made with a different expected response.
 * Consumers specify only the fields they are interested in, allowing a provider to return more fields without breaking the pact. This allows a provider to have a different pact with a different consumer, and know which fields each cares about in a given response.
+* RSpec and Minitest support for the service consumer codebase.
 * Rake tasks allow pacts to be verified against a service provider codebase.
 * Different versions of a consumer/provider pairs can be easily tested against each other, allowing confidence when deploying new versions of each (see the pact_broker and pact_broker-client gems).
 * Autogenerated API documentation - need we say more?
-* Coming soon - autogenerated network diagrams with the [Pact Broker](https://github.com/bethesque/pact_broker)
+* Autogenerated network diagrams with the [Pact Broker](https://github.com/bethesque/pact_broker)
 
 ## How does it work?
 
 1. In the specs for the provider facing code in the consumer project, expectations are set up on a mock service provider.
-1. When the specs are run, the requests, and their expected responses, are written to a "pact" file.
+1. When the specs are run, the mock service returns the expected responses. The requests, and their expected responses, are then written to a "pact" file.
 1. The requests in the pact file are later replayed against the provider, and the actual responses are checked to make sure they match the expected responses.
 
 ## Why is developing and testing with Pact better than using traditional system integration tests?
@@ -37,6 +44,7 @@ Pact is most valuable for designing and testing integrations where you (or your
 * Causes of failure are easier to identify as only one component is being tested at a time.
 * Design of service provider is improved by considering first how the data is actually going to be used, rather than how it is most easily retrieved and serialised.
 * No separate integration environment required for automated integration tests - pact tests run in standalone CI builds.
+* Integration flows that would traditionally require running multiple services at the same time can be broken down and each integration point tested separately.
 
 ## Contact
 
@@ -74,6 +82,8 @@ end
 Imagine a service provider client class that looks something like this.
 
 ```ruby
+require 'httparty'
+
 class MyServiceProviderClient
   include HTTParty
   base_uri 'http://my-service'
@@ -92,6 +102,7 @@ The following code will create a mock service on localhost:1234 which will respo
 # In /spec/service_providers/pact_helper.rb
 
 require 'pact/consumer/rspec'
+# or require 'pact/consumer/minitest' if you are using Minitest
 
 Pact.service_consumer "My Service Consumer" do
   has_pact_with "My Service Provider" do
@@ -107,7 +118,9 @@ end
 ```ruby
 # In /spec/service_providers/my_service_provider_client_spec.rb
 
-# Use the :pact => true describe metadata to include all the pact generation functionality in your spec.
+# When using RSpec, use the metadata `:pact => true` to include all the pact functionality in your spec.
+# When using Minitest, include Pact::Consumer::Minitest in your spec.
+
 describe MyServiceProviderClient, :pact => true do
 
   before do
@@ -121,7 +134,7 @@ describe MyServiceProviderClient, :pact => true do
 
     before do
       my_service_provider.given("something exists").
-        upon_receiving("a request for something").with(method: :get, path: '/something').
+        upon_receiving("a request for something").with(method: :get, path: '/something', query: '').
         will_respond_with(
           status: 200,
           headers: {'Content-Type' => 'application/json'},
@@ -160,14 +173,18 @@ end
 
 #### 7. Run the specs again.
 
-Green! You now have a pact file that can be used to verify your expectations in the provider project.
-Now, rinse and repeat for ALL the likely status codes that may be returned (we recommend 404, 500 and 401/403 if there is authorisation.)
+Green! You now have a pact file that can be used to verify your expectations of the provider project.
+
+Now, rinse and repeat for other likely status codes that may be returned. For example, consider how you want your client to respond to a: 
+* 404 (return null, or raise an error?)
+* 500 (specifying that the response body should contain an error message, and ensuring that your client logs that error message will make your life much easier when things go wrong)
+* 401/403 if there is authorisation.
 
 ### Service Provider project
 
 #### 1. Create the skeleton API classes
 
-Create your API class using the framework of your choice - leave the methods unimplemented, we're doing Test First Develoment, remember?
+Create your API class using the framework of your choice (the Pact authors have a preference for [Webmachine][webmachine] and [Roar][roar]) - leave the methods unimplemented, we're doing Test First Develoment, remember?
 
 #### 2. Tell your provider that it needs to honour the pact file you made earlier
 
@@ -180,7 +197,7 @@ require 'pact/tasks'
 
 Create a `pact_helper.rb` in your service provider project. The recommended place is `spec/service_consumers/pact_helper.rb`.
 
-See [Verifying Pacts](documentation/verifying-pacts.md) and the [Provider](documentation/configuration.md#provider) section of the Configuration documentation for more information.
+See [Verifying Pacts](https://github.com/realestate-com-au/pact/wiki/Verifying-pacts) and the [Provider](documentation/configuration.md#provider) section of the Configuration documentation for more information.
 
 ```ruby
 # In specs/service_consumers/pact_helper.rb
@@ -220,29 +237,8 @@ Yay! Your provider now honours the pact it has with your consumer. You can now h
 
 ### Using provider states
 
-Provider states allow you to set up data on the provider before the interaction is run, so that it can make a response that matches what the consumer expects. It also allows the consumer to make the same request with different expected responses.
+Each interaction in a pact is verified in isolation, with no context maintained from the previous interactions. So how do you test a request that requires data to already exist on the provider? Read about provider states [here](https://github.com/realestate-com-au/pact/wiki/Provider-states).
 
-Read more about provider states [here](/documentation/provider-states.md).
-
-### Verifying pacts
-
-You can verify a pact at an arbitrary local or remote URL
-
-    $ rake pact:verify:at[../path-to-your-consumer-project/specs/pacts/my_consumer-my_provider.json]
-    $ rake pact:verify:at[http://build-box/MyConsumerBuild/latestSuccessful/artifacts/my_consumer-my_provider.json]
-
-To make a shortcut task for pact at an arbitrary URL, add the following to your Rakefile. The pact.uri may be a local file system path or a remote URL.
-
-```ruby
-# In Rakefile or /tasks/pact.rake
-
-# This creates a rake task that can be executed by running
-# $ rake pact:verify:dev
-
-Pact::VerificationTask.new(:dev) do | pact |
-  pact.uri '../path-to-your-consumer-project/specs/pacts/my_consumer-my_provider.json'
-end
-```
 
 ## Configuration
 
@@ -250,15 +246,21 @@ See the [Configuration](/documentation/configuration.md) section of the document
 
 ## Pact best practices
 
-As in all things, there are good ways to implement Pacts, and there are not so good ways. Check out the [Best practices](/documentation/best-practices.md) section of the documentation to make sure you're not Pacting it Wrong.
+As in all things, there are good ways to implement Pacts, and there are not so good ways. Check out the [Best practices](https://github.com/realestate-com-au/pact/wiki/Best-practices) section of the documentation to make sure you're not Pacting it Wrong.
 
 ## Docs
 
 * [Example](example)
-* [Frequently Asked Questions](documentation/faq.md) 
-* [Rarely Asked Questions](documentation/raq.md)
-* [Terminology](documentation/terminology.md)
-* [Configuration](/documentation/configuration.md)
+* [Configuration](documentation/configuration.md)
+* [Terminology](https://github.com/realestate-com-au/pact/wiki/Terminology)
+* [Provider States](https://github.com/realestate-com-au/pact/wiki/Provider-states)
+* [Verifying pacts](https://github.com/realestate-com-au/pact/wiki/Verifying-pacts)
+* [Sharing pacts between consumer and provider](https://github.com/realestate-com-au/pact/wiki/Sharing-pacts-between-consumer-and-provider)
+* [Frequently asked questions](https://github.com/realestate-com-au/pact/wiki/FAQ)
+* [Rarely asked questions](https://github.com/realestate-com-au/pact/wiki/RAQ)
+* [Best practices](https://github.com/realestate-com-au/pact/wiki/Best-practices)
+* [Troubleshooting](https://github.com/realestate-com-au/pact/wiki/Troubleshooting)
+* [Testing with pact diagram](https://github.com/realestate-com-au/pact/wiki/Testing with pact.png)
 
 ## Related libraries
 
@@ -270,6 +272,8 @@ As in all things, there are good ways to implement Pacts, and there are not so g
 
 [Pact JVM](https://github.com/DiUS/pact-jvm) - A Pact implementation for the JVM (Java and Scala). It generates pact files that are compatible with the Ruby implementation.
 
+[Pact .NET](https://github.com/SEEK-Jobs/pact-net) - A Pact implementation for .NET.
+
 [Shokkenki](https://github.com/brentsnook/shokkenki) - Another Consumer Driven Contract gem written by one of Pact's original authors, Brent Snook. Shokkenki allows matchers to be composed using jsonpath expressions and allows auto-generation of mock response values based on regular expressions.
 
 ## Links
@@ -301,3 +305,9 @@ Long term:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+If you would like to implement pact in another language, please check out the [Pact specification](https://github.com/bethesque/pact-specification) and have a chat to one of us on the [pact-dev Google group](https://groups.google.com/forum/#!forum/pact-dev). The vision is to have a compatible pact implementation in all the commonly used languages, your help would be greatly appreciated!
+
+[webmachine]: https://github.com/seancribbs/webmachine-ruby
+[roar]: https://github.com/apotonick/roar
+

data/documentation/README.md

@@ -1,11 +1,13 @@
 ### Pact Documentation
 
 * Step by step instructions for getting started with pacts can be found in the project [README.md](/README.md#usage)
-* [Terminology](terminology.md)
+* [Terminology](https://github.com/realestate-com-au/pact/wiki/Terminology)
 * [Configuration](configuration.md)
-* [Provider States](provider-states.md)
-* [Frequently asked questions](faq.md)
-* [Rarely asked questions](raq.md)
-* [Best practices](best-practices.md)
-* [Troubleshooting](troubleshooting.md)
-* [Testing with pact diagram](Testing with pact.png)
+* [Provider States](https://github.com/realestate-com-au/pact/wiki/Provider-states)
+* [Verifying pacts](https://github.com/realestate-com-au/pact/wiki/Verifying-pacts)
+* [Frequently asked questions](https://github.com/realestate-com-au/pact/wiki/FAQ)
+* [Rarely asked questions](https://github.com/realestate-com-au/pact/wiki/RAQ)
+* [Best practices](https://github.com/realestate-com-au/pact/wiki/Best-practices)
+* [Troubleshooting](https://github.com/realestate-com-au/pact/wiki/Troubleshooting)
+* [Testing with pact diagram](https://github.com/realestate-com-au/pact/wiki/Testing with pact.png)
+* [Development workflow](https://github.com/realestate-com-au/pact/wiki/Development-workflow)

data/lib/pact/configuration.rb

@@ -4,6 +4,8 @@ require 'pact/doc/markdown/generator'
 require 'pact/matchers/unix_diff_formatter'
 require 'pact/matchers/embedded_diff_formatter'
 require 'pact/matchers/list_diff_formatter'
+require 'pact/shared/json_differ'
+require 'pact/shared/text_differ'
 
 module Pact
 
@@ -17,6 +19,27 @@ module Pact
       :list => Pact::Matchers::ListDiffFormatter
     }
 
+
+    class NilMatcher
+      def self.=~ other
+        other == nil ? 0 : nil
+      end
+    end
+
+    DIFF_FORMATTER_REGISTRATIONS = [
+      [/.*/, Pact::Matchers::UnixDiffFormatter],
+      [NilMatcher, Pact::Matchers::UnixDiffFormatter]
+    ]
+
+    DIFFERS = [
+      [/json/, Pact::JsonDiffer],
+      [NilMatcher, Pact::TextDiffer],
+      [/.*/, Pact::TextDiffer]
+    ]
+
+
+    DEFAULT_DIFFER = Pact::TextDiffer
+
     attr_accessor :pact_dir
     attr_accessor :log_dir
     attr_accessor :doc_dir
@@ -41,6 +64,11 @@ module Pact
       c
     end
 
+    def initialize
+      @differ_registrations = []
+      @diff_formatter_registrations = []
+    end
+
     def logger
       @logger ||= create_logger
     end
@@ -61,20 +89,29 @@ module Pact
       @doc_generators  ||= []
     end
 
-    def diff_formatter
-      @diff_formatter ||= DIFF_FORMATTERS[:unix]
+    # Should this be deprecated in favour of register_diff_formatter???
+    def diff_formatter= diff_formatter
+      register_diff_formatter /.*/, diff_formatter
+      register_diff_formatter nil, diff_formatter
     end
 
-    def diff_formatter= diff_formatter
-      @diff_formatter = begin
-        if DIFF_FORMATTERS[diff_formatter]
-          DIFF_FORMATTERS[diff_formatter]
-        elsif diff_formatter.respond_to?(:call)
-          diff_formatter
-        else
-          raise "Pact.configuration.diff_formatter needs to respond to call, or be in the preconfigured list: #{DIFF_FORMATTERS.keys}"
-        end
-      end
+    def register_diff_formatter content_type, diff_formatter
+      key = content_type_regexp_for content_type
+      @diff_formatter_registrations << [key, diff_formatter_for(diff_formatter)]
+    end
+
+    def diff_formatter_for_content_type content_type
+      diff_formatter_registrations.find{ | registration | registration.first =~ content_type }.last
+    end
+
+    def register_body_differ content_type, differ
+      key = content_type_regexp_for content_type
+      validate_differ differ
+      @differ_registrations << [key, differ]
+    end
+
+    def body_differ_for_content_type content_type
+      differ_registrations.find{ | registration | registration.first =~ content_type }.last
     end
 
     def log_path
@@ -91,6 +128,40 @@ module Pact
 
     private
 
+    def diff_formatter_for input
+      if DIFF_FORMATTERS[input]
+        DIFF_FORMATTERS[input]
+      elsif input.respond_to?(:call)
+        input
+      else
+        raise "Pact diff_formatter needs to respond to call, or be in the preconfigured list: #{DIFF_FORMATTERS.keys}"
+      end
+    end
+
+    def validate_differ differ
+      if !differ.respond_to?(:call)
+        raise "Pact.configuration.register_body_differ expects a differ that is a lamda or a class/object that responds to call."
+      end
+    end
+
+    def content_type_regexp_for content_type
+      case content_type
+      when String then Regexp.new(/^#{Regexp.escape(content_type)}$/)
+      when Regexp then content_type
+      when nil then NilMatcher
+      else
+        raise "Invalid content type used to register a differ (#{content_type.inspect}). Please use a Regexp or a String."
+      end
+    end
+
+    def differ_registrations
+      @differ_registrations + DIFFERS
+    end
+
+    def diff_formatter_registrations
+      @diff_formatter_registrations + DIFF_FORMATTER_REGISTRATIONS
+    end
+
     def self.default_log_dir
       File.expand_path("./log")
     end

data/lib/pact/consumer/consumer_contract_builder.rb

@@ -55,7 +55,7 @@ module Pact
         mock_service_client.write_pact @consumer_contract_details
       end
 
-      def wait_for_interactions options
+      def wait_for_interactions options = {}
         wait_max_seconds = options.fetch(:wait_max_seconds, 3)
         poll_interval = options.fetch(:poll_interval, 0.1)
         mock_service_client.wait_for_interactions wait_max_seconds, poll_interval
@@ -71,54 +71,6 @@ module Pact
       attr_reader :mock_service_client
       attr_writer :interaction_builder
 
-      # def interactions_for_new_consumer_contract pactfile_write_mode
-      #   pactfile_write_mode == :update ? existing_interactions : []
-      # end
-
-      # def filter interactions, pactfile_write_mode
-      #   if pactfile_write_mode == :update
-      #     UpdatableInteractionsFilter.new(interactions)
-      #   else
-      #     DistinctInteractionsFilter.new(interactions)
-      #   end
-      # end
-
-      # def warn_and_stderr msg
-      #   Pact.configuration.error_stream.puts msg
-      #   logger.warn msg
-      # end
-
-      # def info_and_puts msg
-      #   $stdout.puts msg
-      #   logger.info msg
-      # end
-
-      # def existing_interactions
-      #   interactions = []
-      #   if pactfile_exists?
-      #     begin
-      #       interactions = existing_consumer_contract.interactions
-      #       info_and_puts "*****************************************************************************"
-      #       info_and_puts "Updating existing file .#{consumer_contract.pactfile_path.gsub(Dir.pwd, '')} as config.pactfile_write_mode is :update"
-      #       info_and_puts "Only interactions defined in this test run will be updated."
-      #       info_and_puts "As interactions are identified by description and provider state, pleased note that if either of these have changed, the old interactions won't be removed from the pact file until the specs are next run with :pactfile_write_mode => :overwrite."
-      #       info_and_puts "*****************************************************************************"
-      #     rescue StandardError => e
-      #       warn_and_stderr "Could not load existing consumer contract from #{consumer_contract.pactfile_path} due to #{e}"
-      #       warn_and_stderr "Creating a new file."
-      #     end
-      #   end
-      #   interactions
-      # end
-
-      # def pactfile_exists?
-      #   File.exist?(consumer_contract.pactfile_path)
-      # end
-
-      # def existing_consumer_contract
-      #   Pact::ConsumerContract.from_uri(consumer_contract.pactfile_path)
-      # end
-
     end
   end
 end

data/lib/pact/consumer/mock_service/interaction_mismatch.rb

@@ -56,10 +56,14 @@ module Pact
         def to_s
           [
             "Diff with interaction: #{candidate_interaction.description_with_provider_state_quoted}",
-            Pact.configuration.diff_formatter.call(diff, {colour: false})
+            diff_formatter.call(diff, {colour: false})
           ].join("\n")
         end
 
+        def diff_formatter
+          Pact.configuration.diff_formatter_for_content_type(candidate_interaction.request.content_type)
+        end
+
         def diff
           @diff ||= candidate_interaction.request.difference(actual_request)
         end

data/lib/pact/consumer/spec_hooks.rb

@@ -11,6 +11,7 @@ module Pact
       end
 
       def before_each example_description
+        Pact.consumer_world.register_pact_example_ran
         Pact.configuration.logger.info "Clearing all expectations"
         Pact::Consumer::AppManager.instance.ports_of_mock_services.each do | port |
           Pact::Consumer::MockServiceClient.clear_interactions port, example_description
@@ -25,10 +26,12 @@ module Pact
       end
 
       def after_suite
-        Pact.consumer_world.consumer_contract_builders.each { | c | c.write_pact }
-        Pact::Doc::Generate.call
-        Pact::Consumer::AppManager.instance.kill_all
-        Pact::Consumer::AppManager.instance.clear_all
+        if Pact.consumer_world.any_pact_examples_ran?
+          Pact.consumer_world.consumer_contract_builders.each { | c | c.write_pact }
+          Pact::Doc::Generate.call
+          Pact::Consumer::AppManager.instance.kill_all
+          Pact::Consumer::AppManager.instance.clear_all
+        end
       end
     end
   end

data/lib/pact/consumer/world.rb

@@ -12,6 +12,10 @@ module Pact
   module Consumer
     class World
 
+      def initialize
+        @any_pact_examples_ran = false
+      end
+
       def consumer_contract_builders
         @consumer_contract_builders ||= []
       end
@@ -20,6 +24,14 @@ module Pact
         consumer_contract_builders << consumer_contract_builder
       end
 
+      def register_pact_example_ran
+        @any_pact_examples_ran = true
+      end
+
+      def any_pact_examples_ran?
+        @any_pact_examples_ran
+      end
+
     end
   end
 end

data/lib/pact/consumer_contract/headers.rb

@@ -0,0 +1,51 @@
+module Pact
+
+  class DuplicateHeaderError < StandardError; end
+  class InvalidHeaderNameTypeError < StandardError; end
+
+  class Headers < Hash
+
+    def initialize hash = {}
+      hash.each_pair do | key, value |
+        check_for_invalid key
+        self[find_matching_key(key)] = value
+      end
+      self.freeze
+    end
+
+    def [] key
+      super(find_matching_key(key))
+    end
+
+    def fetch *args, &block
+      args[0] = find_matching_key(args[0]) if args.first
+      super(*args, &block)
+    end
+
+    def key? key
+      super(find_matching_key(key))
+    end
+
+    alias_method :has_key?, :key?
+    alias_method :include?, :key?
+
+    private
+
+    def find_matching_key key
+      key = key.to_s
+      match = keys.find { |k| k.downcase == key.downcase }
+      match.nil? ? key : match
+    end
+
+    def check_for_invalid key
+      unless (String === key || Symbol === key)
+        raise InvalidHeaderNameTypeError.new "Header name (#{key}) must be a String or a Symbol."
+      end
+      if key? key
+        raise DuplicateHeaderError.new "Duplicate header found (#{find_matching_key(key)} and #{key}. Please use a comma separated single value when multiple headers with the same name are required."
+      end
+    end
+
+  end
+
+end

data/lib/pact/consumer_contract/interaction.rb

@@ -13,7 +13,7 @@ module Pact
         @description = attributes[:description]
         @request = attributes[:request]
         @response = attributes[:response]
-        @provider_state = attributes[:provider_state]
+        @provider_state = attributes[:provider_state] || attributes[:providerState]
       end
 
       def self.from_hash hash

data/lib/pact/consumer_contract/pact_file.rb

@@ -5,9 +5,9 @@ module Pact
     extend self
 
     def read uri, options = {}
-      pact = open(uri) { | file | file.read }
+      pact = open(uri.to_s) { | file | file.read }
       if options[:save_pactfile_to_tmp]
-        save_pactfile_to_tmp pact, ::File.basename(uri)
+        save_pactfile_to_tmp pact, ::File.basename(uri.to_s)
       end
       pact
     rescue StandardError => e

data/lib/pact/consumer_contract/request.rb

@@ -60,8 +60,13 @@ module Pact
       end
 
       def body_difference(actual_body)
-        diff({:body => body}, {body: actual_body}, allow_unexpected_keys: runtime_options[:allow_unexpected_keys_in_body])
+        body_differ.call({:body => body}, {body: actual_body}, allow_unexpected_keys: runtime_options[:allow_unexpected_keys_in_body])
       end
+
+      def body_differ
+        Pact.configuration.body_differ_for_content_type content_type
+      end
+
     end
 
   end