pact 1.1.0.rc2 → 1.1.0.rc3

data/documentation/raq.md

@@ -19,6 +19,10 @@ end
 The service prints messages it recieves to stdout which can be really useful
 when diagnosing issues with pacts.
 
+### Doesn't this break HAL?
+
+Yes.
+
 ### How can I specify multiple headers with the same name?
 
 RFC 2616 states that two headers with the same name can interpreted as a single header with two comma-separated values. This is the safest way to specify multiple headers with the same name, as Rack will only pass the last value through when they are defined separately (see https://github.com/rack/rack/issues/436).
@@ -33,7 +37,3 @@ my_service_provider.
   )
 
 ```
-
-### What is this pact file write mode?
-
-By default, the pact file will be overwritten (started from scratch) every time any rspec runs any spec using pacts. This means that if there are interactions that haven't been executed in the most recent rspec run, they are effectively removed from the pact file. If you have long running pact specs (e.g. they are generated using the browser with Capybara) and you are developing both consumer and provider in parallel, or trying to fix a broken interaction, it can be tedius to run all the specs at once. In this scenario, you can set the pactfile_write_mode to :update. This will keep all existing interactions, and update only the changed ones, identified by description and provider state. The down side of this is that if either of those fields change, the old interactions will not be removed from the pact file. As a middle path, you can set pactfile_write_mode to :smart. This will use :overwrite mode when running rake (as determined by a call to system using 'ps') and :update when running an individual spec.

data/documentation/terminology.md

@@ -20,6 +20,6 @@ A file containing the JSON serialised requests and responses that were defined i
 
 To verify a pact, the requests contained in a pact file are replayed against the provider code, and the responses returned are checked to ensure they match those expected in the pact file.
 
-## Provider state
+### Provider state
 
-A name describing a "state" (like a fixture) that the provider should be in when a given request is replayed against it. Eg. "there is an alligator called Mary" or "there are no alligators". A provider state name is specified when writing the consumer specs, then, when the pact verification is set up in the provider, the same name will be used to identify the set up code block that should be run before the request is executed.
+A name describing a "state" (like a fixture) that the provider should be in when a given request is replayed against it. Eg. "there is an alligator called Mary" or "there are no alligators". A provider state name is specified when writing the consumer specs, then, when the pact verification is set up in the provider, the same name will be used to identify the set up code block that should be run before the request is executed.

data/example/animal-service/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: ../../
   specs:
-    pact (1.0.30)
+    pact (1.1.0.rc2)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json
       rack-test (~> 0.6.2)
       randexp (~> 0.1.7)
       rspec (~> 2.12)
-      thin
+      term-ansicolor (~> 1.0)
       thor
       webrick
 
@@ -17,9 +17,7 @@ GEM
   specs:
     awesome_print (1.2.0)
     coderay (1.0.9)
-    daemons (1.1.9)
     diff-lcs (1.2.4)
-    eventmachine (1.0.3)
     find_a_port (1.0.1)
     json (1.6.8)
     method_source (0.8.2)
@@ -49,12 +47,11 @@ GEM
       tilt (~> 1.3, >= 1.3.4)
     slop (3.4.6)
     sqlite3 (1.3.8)
-    thin (1.6.1)
-      daemons (>= 1.0.9)
-      eventmachine (>= 1.0.0)
-      rack (>= 1.0.0)
-    thor (0.18.1)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
     tilt (1.4.1)
+    tins (1.1.0)
     webrick (1.3.1)
 
 PLATFORMS

data/example/animal-service/Rakefile

@@ -1,3 +1,5 @@
+$: << File.join(File.dirname(__FILE__), "lib")
+
 require 'pact/tasks'
 
 task :default => 'pact:verify'

data/example/animal-service/lib/animal_service/animal_repository.rb

@@ -4,13 +4,9 @@ require_relative 'db'
 module AnimalService
   class AnimalRepository
 
-
-    def self.find_alligators
-      DATABASE[:animals].find_all
-    end
-
     def self.find_alligator_by_name name
       DATABASE[:animals].where(name: name).single_record
     end
+
   end
 end

data/example/animal-service/lib/animal_service/api.rb

@@ -12,7 +12,7 @@ module AnimalService
       e = env['sinatra.error']
       content_type :json
       status 500
-      {:error => e.message, :backtrace => e.backtrace}.to_json
+      {error: e.message, backtrace: e.backtrace}.to_json
     end
 
     get '/alligators/:name' do

data/example/animal-service/spec/service_consumers/pact_helper.rb

@@ -1,18 +1,15 @@
-$: << File.expand_path("../../../lib", __FILE__)
-
 require 'pact/provider/rspec'
-require 'animal_service/db'
 
-require_relative "provider_states_for_zoo_app"
+require "./spec/service_consumers/provider_states_for_zoo_app"
+
+Pact.configure do | config |
+  config.include RSpec::Mocks::ExampleMethods
+end
 
 Pact.service_provider 'Animal Service' do
+
   honours_pact_with "Zoo App" do
     pact_uri '../zoo-app/spec/pacts/zoo_app-animal_service.json'
   end
-end
 
-RSpec.configure do | config |
-  config.before do
-    AnimalService::DATABASE[:animals].truncate
-  end
-end
+end

data/example/animal-service/spec/service_consumers/provider_states_for_zoo_app.rb

@@ -4,6 +4,10 @@ require 'animal_service/animal_repository'
 
 Pact.provider_states_for "Zoo App" do
 
+  set_up do
+    AnimalService::DATABASE[:animals].truncate
+  end
+
   provider_state "there is an alligator named Mary" do
     set_up do
       AnimalService::DATABASE[:animals].insert(name: 'Mary')
@@ -16,7 +20,7 @@ Pact.provider_states_for "Zoo App" do
 
   provider_state "an error occurs retrieving an alligator" do
     set_up do
-      AnimalService::AnimalRepository.stub(:find_alligator_by_name).and_raise("Argh!!!")
+      allow(AnimalService::AnimalRepository).to receive(:find_alligator_by_name).and_raise("Argh!!!")
     end
   end
 end

data/example/zoo-app/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: ../../
   specs:
-    pact (1.0.30)
+    pact (1.1.0.rc2)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json
       rack-test (~> 0.6.2)
       randexp (~> 0.1.7)
       rspec (~> 2.12)
-      thin
+      term-ansicolor (~> 1.0)
       thor
       webrick
 
@@ -17,9 +17,7 @@ GEM
   specs:
     awesome_print (1.2.0)
     coderay (1.0.9)
-    daemons (1.1.9)
     diff-lcs (1.2.4)
-    eventmachine (1.0.3)
     find_a_port (1.0.1)
     httparty (0.11.0)
       multi_json (~> 1.0)
@@ -46,11 +44,10 @@ GEM
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.3)
     slop (3.4.6)
-    thin (1.6.1)
-      daemons (>= 1.0.9)
-      eventmachine (>= 1.0.0)
-      rack (>= 1.0.0)
-    thor (0.18.1)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.1.0)
     webrick (1.3.1)
 
 PLATFORMS

data/example/zoo-app/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/example/zoo-app/doc/markdown/README.md

@@ -0,0 +1,3 @@
+### Pacts for Zoo App
+
+* [Animal Service](Zoo App - Animal Service.md)

data/example/zoo-app/doc/markdown/Zoo App - Animal Service.md

@@ -0,0 +1,75 @@
+### A pact between Zoo App and Animal Service
+
+#### Requests from Zoo App to Animal Service
+
+* [A request for an alligator](#a_request_for_an_alligator_given_there_is_an_alligator_named_Mary) given there is an alligator named Mary
+
+* [A request for an alligator](#a_request_for_an_alligator_given_there_is_not_an_alligator_named_Mary) given there is not an alligator named Mary
+
+* [A request for an alligator](#a_request_for_an_alligator_given_an_error_occurs_retrieving_an_alligator) given an error occurs retrieving an alligator
+
+#### Interactions
+
+<a name="a_request_for_an_alligator_given_there_is_an_alligator_named_Mary"></a>
+Given **there is an alligator named Mary**, upon receiving **a request for an alligator** from Zoo App, with
+```json
+{
+  "method": "get",
+  "path": "/alligators/Mary",
+  "headers": {
+    "Accept": "application/json"
+  }
+}
+```
+Animal Service will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/json;charset=utf-8"
+  },
+  "body": {
+    "name": "Mary"
+  }
+}
+```
+<a name="a_request_for_an_alligator_given_there_is_not_an_alligator_named_Mary"></a>
+Given **there is not an alligator named Mary**, upon receiving **a request for an alligator** from Zoo App, with
+```json
+{
+  "method": "get",
+  "path": "/alligators/Mary",
+  "headers": {
+    "Accept": "application/json"
+  }
+}
+```
+Animal Service will respond with:
+```json
+{
+  "status": 404
+}
+```
+<a name="a_request_for_an_alligator_given_an_error_occurs_retrieving_an_alligator"></a>
+Given **an error occurs retrieving an alligator**, upon receiving **a request for an alligator** from Zoo App, with
+```json
+{
+  "method": "get",
+  "path": "/alligators/Mary",
+  "headers": {
+    "Accept": "application/json"
+  }
+}
+```
+Animal Service will respond with:
+```json
+{
+  "status": 500,
+  "headers": {
+    "Content-Type": "application/json;charset=utf-8"
+  },
+  "body": {
+    "error": "Argh!!!"
+  }
+}
+```

data/example/zoo-app/lib/zoo_app/animal_service_client.rb

@@ -18,12 +18,12 @@ module ZooApp
 
     def self.find_alligator_by_name name
       response = get("/alligators/#{name}", :headers => {'Accept' => 'application/json'})
-      handle_response response do
+      when_successful(response) do
         ZooApp::Animals::Alligator.new(parse_body(response))
       end
     end
 
-    def self.handle_response response
+    def self.when_successful response
       if response.success?
         yield
       elsif response.code == 404

data/example/zoo-app/spec/pacts/zoo_app-animal_service.json

@@ -62,6 +62,6 @@
     }
   ],
   "metadata": {
-    "pactSpecificationVersion": "1.0"
+    "pactSpecificationVersion": "1.0.0"
   }
 }

data/example/zoo-app/spec/service_providers/animal_service_client_spec.rb

@@ -10,22 +10,22 @@ module ZooApp
 
     describe ".find_alligator_by_name" do
       context "when an alligator by the given name exists" do
+
         before do
-          animal_service.
-            given("there is an alligator named Mary").
-              upon_receiving("a request for an alligator").
-                with( method: :get,
-                  path: '/alligators/Mary',
-                  :headers => {'Accept' => 'application/json'} ).
-                  will_respond_with(
-                    status: 200,
-                    headers: { 'Content-Type' => 'application/json;charset=utf-8' },
-                    body: { name: 'Mary'}
-                  )
+          animal_service.given("there is an alligator named Mary").
+            upon_receiving("a request for an alligator").with(
+              method: :get,
+              path: '/alligators/Mary',
+              headers: {'Accept' => 'application/json'} ).
+            will_respond_with(
+              status: 200,
+              headers: {'Content-Type' => 'application/json;charset=utf-8'},
+              body: {name: 'Mary'}
+            )
         end
 
         it "returns the alligator" do
-          expect(AnimalServiceClient.find_alligator_by_name("Mary")).to eq ZooApp::Animals::Alligator.new(:name => 'Mary')
+          expect(AnimalServiceClient.find_alligator_by_name("Mary")).to eq ZooApp::Animals::Alligator.new(name: 'Mary')
         end
 
       end
@@ -33,16 +33,12 @@ module ZooApp
       context "when an alligator by the given name does not exist" do
 
         before do
-          animal_service.
-            given("there is not an alligator named Mary").
-              upon_receiving("a request for an alligator").
-                with(
-                  method: :get,
-                    path: '/alligators/Mary',
-                    headers: {'Accept' => 'application/json'} ).
-                  will_respond_with(
-                    status: 404
-                  )
+          animal_service.given("there is not an alligator named Mary").
+            upon_receiving("a request for an alligator").with(
+              method: :get,
+              path: '/alligators/Mary',
+              headers: {'Accept' => 'application/json'} ).
+            will_respond_with(status: 404)
         end
 
         it "returns nil" do
@@ -51,19 +47,18 @@ module ZooApp
 
       end
 
-      context "when an error response is returned" do
+      context "when an error occurs retrieving the alligator" do
+
         before do
-          animal_service.
-            given("an error occurs retrieving an alligator").
-              upon_receiving("a request for an alligator").
-                with( method: :get,
-                    path: '/alligators/Mary',
-                    :headers => {'Accept' => 'application/json'} ).
-                  will_respond_with(
-                    status: 500,
-                    headers: { 'Content-Type' => 'application/json;charset=utf-8' },
-                    body: {:error => 'Argh!!!'}
-                  )
+          animal_service.given("an error occurs retrieving an alligator").
+            upon_receiving("a request for an alligator").with(
+              method: :get,
+              path: '/alligators/Mary',
+              headers: {'Accept' => 'application/json'}).
+            will_respond_with(
+              status: 500,
+              headers: { 'Content-Type' => 'application/json;charset=utf-8'},
+              body: {error: 'Argh!!!'})
         end
 
         it "raises an error" do

data/example/zoo-app/spec/service_providers/pact_helper.rb

@@ -1,6 +1,10 @@
 require_relative '../spec_helper'
 require 'pact/consumer/rspec'
 
+Pact.configure do | config |
+  config.doc_generator = :markdown
+end
+
 Pact.service_consumer 'Zoo App' do
   has_pact_with "Animal Service" do
     mock_service :animal_service do

data/lib/pact/configuration.rb

@@ -1,15 +1,30 @@
 require 'ostruct'
 require 'logger'
+require 'pact/doc/markdown/generator'
+require 'pact/matchers/unix_diff_formatter'
+require 'pact/matchers/embedded_diff_formatter'
+require 'pact/matchers/list_diff_formatter'
 
 module Pact
 
   class Configuration
+
+    DOC_GENERATORS = { markdown: Pact::Doc::Markdown::Generator }
+
+    DIFF_FORMATTERS = {
+      :embedded => Pact::Matchers::EmbeddedDiffFormatter,
+      :unix => Pact::Matchers::UnixDiffFormatter,
+      :list => Pact::Matchers::ListDiffFormatter
+    }
+
     attr_accessor :pact_dir
     attr_accessor :log_dir
+    attr_accessor :doc_dir
+    attr_accessor :reports_dir
     attr_accessor :logger
     attr_accessor :tmp_dir
-    attr_accessor :reports_dir
     attr_writer :pactfile_write_mode
+
     attr_accessor :error_stream
     attr_accessor :output_stream
 
@@ -25,6 +40,38 @@ module Pact
       end
     end
 
+    def doc_generator= doc_generator
+      doc_generators << begin
+        if DOC_GENERATORS[doc_generator]
+          DOC_GENERATORS[doc_generator]
+        elsif doc_generator.respond_to?(:call)
+          doc_generator
+        else
+          raise "Pact.configuration.doc_generator needs to respond to call, or be in the preconfigured list: #{DOC_GENERATORS.keys}"
+        end
+      end
+    end
+
+    def doc_generators
+      @doc_generators  ||= []
+    end
+
+    def diff_formatter
+      @diff_formatter ||= DIFF_FORMATTERS[:unix]
+    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
+    end
+
     private
 
     #Would love a better way of determining this! It sure won't work on windows.
@@ -56,6 +103,7 @@ module Pact
     c.logger = default_logger c.log_path
     c.pactfile_write_mode = :overwrite
     c.reports_dir = File.expand_path('./reports/pacts')
+    c.doc_dir = File.expand_path("./doc")
     c.output_stream = $stdout
     c.error_stream = $stderr
     c