pact 1.3.2 → 1.3.3

data/CHANGELOG.md

@@ -2,6 +2,13 @@ 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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (1.3.2)
+    pact (1.3.3)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json

data/README.md

@@ -2,17 +2,17 @@
 
 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?
 
@@ -25,10 +25,11 @@ Pact is most valuable for designing and testing integrations where you (or your
 * 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?
 
@@ -81,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'
@@ -99,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
@@ -114,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
@@ -128,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'},
@@ -167,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
 
@@ -245,6 +255,7 @@ As in all things, there are good ways to implement Pacts, and there are not so g
 * [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)
@@ -297,3 +308,6 @@ Long term:
 
 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/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/matchers/differ.rb

@@ -71,6 +71,16 @@ module Pact
         end
       end
 
+      def red(text)
+        return text unless @color
+        color(text, 31)
+      end
+
+      def green(text)
+        return text unless @color
+        color(text, 32)
+      end
+
     protected
 
       def format
@@ -85,13 +95,6 @@ module Pact
         "\e[#{color_code}m#{text}\e[0m"
       end
 
-      def red(text)
-        color(text, 31)
-      end
-
-      def green(text)
-        color(text, 32)
-      end
 
       def blue(text)
         color(text, 34)

data/lib/pact/matchers/unix_diff_formatter.rb

@@ -11,6 +11,7 @@ module Pact
       def initialize diff, options = {}
         @diff = diff
         @colour = options.fetch(:colour, false)
+        @differ = Pact::Matchers::Differ.new(@colour)
       end
 
       def self.call diff, options = {colour: Pact.configuration.color_enabled}
@@ -24,7 +25,7 @@ module Pact
       def to_s
         expected = generate_string(diff, :expected)
         actual = generate_string(diff, :actual)
-        Pact::Matchers::Differ.new(@colour).diff_as_string(actual, expected).lstrip
+        @differ.diff_as_string(actual, expected).lstrip + "\n" + key
       end
 
       private
@@ -85,6 +86,12 @@ module Pact
         end
       end
 
+      def key
+        "Key: " + @differ.red("-") + @differ.red(" means \"expected, but was not found\". \n") +
+        @differ.green("     +") + @differ.green(" means \"actual, should not be found\". \n") +
+        "     Values where the expected matches the actual are not shown.\n"
+      end
+
       class RegexpDecorator
 
         def initialize regexp

data/lib/pact/reification.rb

@@ -4,20 +4,20 @@ module Pact
   module Reification
 
     def self.from_term(term)
-      case
-      when term.respond_to?(:generate)
+      case term
+      when Pact::Term, Regexp, Pact::SomethingLike
         term.generate
-      when term.is_a?(Hash)
+      when Hash
         term.inject({}) do |mem, (key,term)|
           mem[key] = from_term(term)
         mem
         end
-      when term.is_a?(Array)
+      when Array
         term.inject([]) do |mem, term|
           mem << from_term(term)
           mem
         end
-      when term.is_a?(Pact::Request::Base)
+      when Pact::Request::Base
         from_term(term.to_hash)
       else
         term

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "1.3.2"
+  VERSION = "1.3.3"
 end

data/pact.gemspec

@@ -6,7 +6,7 @@ require 'pact/version'
 Gem::Specification.new do |gem|
   gem.name          = "pact"
   gem.version       = Pact::VERSION
-  gem.authors       = ["James Fraser", "Sergei Matheson", "Brent Snook", "Ronald Holshausen", "Bethany Skurrie"]
+  gem.authors       = ["James Fraser", "Sergei Matheson", "Brent Snook", "Ronald Holshausen", "Beth Skurrie"]
   gem.email         = ["james.fraser@alumni.swinburne.edu", "sergei.matheson@gmail.com", "brent@fuglylogic.com", "uglyog@gmail.com", "bskurrie@dius.com.au"]
   gem.description   = %q{Enables consumer driven contract testing, providing a mock service and DSL for the consumer project, and interaction playback and verification for the service provider project.}
   gem.summary       = %q{Enables consumer driven contract testing, providing a mock service and DSL for the consumer project, and interaction playback and verification for the service provider project.}

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

@@ -7,6 +7,9 @@ module Pact
 
     describe Interaction do
 
+      let(:request) { {method: 'get', path: 'path'} }
+      let(:response) { {} }
+
       describe "==" do
         subject { InteractionFactory.create }
         context "when other is the same" do
@@ -39,6 +42,17 @@ 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
+      end
+
       describe "to JSON" do
         let(:request) do
           {

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

@@ -9,6 +9,7 @@ module Pact
 
       describe ".call" do
 
+        let(:key_lines_count) { 4 }
         let(:colour) { false }
         subject { UnixDiffFormatter.call(diff, {colour: colour}) }
 
@@ -54,7 +55,7 @@ EOF
           end
 
           it "generates the right number of lines, even with ActiveSupport loaded" do
-            expect(line_count).to eq 9
+            expect(line_count).to eq 9 + key_lines_count
           end
 
         end
@@ -76,7 +77,7 @@ EOF
           end
 
           it "generates the right number of lines, even with ActiveSupport loaded" do
-            expect(line_count).to eq 9
+            expect(line_count).to eq 9 + key_lines_count
           end
 
         end
@@ -98,7 +99,7 @@ EOF
           end
 
           it "generates the right number of lines, even with ActiveSupport loaded" do
-            expect(line_count).to eq 5
+            expect(line_count).to eq 5 + key_lines_count
           end
 
         end
@@ -120,7 +121,7 @@ EOF
           end
 
           it "generates the right number of lines, even with ActiveSupport loaded" do
-            expect(line_count).to eq 8
+            expect(line_count).to eq 8 + key_lines_count
           end
         end
 
@@ -140,7 +141,7 @@ EOF
           end
 
           it "generates the right number of lines, even with ActiveSupport loaded" do
-            expect(line_count).to eq 8
+            expect(line_count).to eq 8 + key_lines_count
           end
 
         end
@@ -159,7 +160,7 @@ EOF
           end
 
           it "generates the right number of lines, even with ActiveSupport loaded" do
-            expect(line_count).to eq 8
+            expect(line_count).to eq 8 + key_lines_count
           end
 
         end
@@ -185,7 +186,7 @@ EOF
           end
 
           it "generates the right number of lines, even with ActiveSupport loaded" do
-            expect(line_count).to eq 8
+            expect(line_count).to eq 8 + key_lines_count
           end
 
         end
@@ -203,7 +204,7 @@ EOF
           end
 
           it "generates the right number of lines, even with ActiveSupport loaded" do
-            expect(line_count).to eq 11
+            expect(line_count).to eq 11 + key_lines_count
           end
 
         end

data/spec/lib/pact/reification_spec.rb

@@ -51,5 +51,17 @@ module Pact
 
     end
 
+    context "when SomethingLike" do
+
+      let(:request) { Pact::SomethingLike.new({a: 'String'})}
+
+      subject { Reification.from_term(request)}
+
+      it "returns the contents of the SomethingLike" do
+        expect(subject).to eq({a: 'String'})
+      end
+
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 - Sergei Matheson
 - Brent Snook
 - Ronald Holshausen
-- Bethany Skurrie
+- Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -560,7 +560,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3697299514790813108
+      hash: 3250914731854232740
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -569,7 +569,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3697299514790813108
+      hash: 3250914731854232740
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23