pact 0.1.35 → 0.1.37

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pact (0.1.35)
+    pact (0.1.37)
       awesome_print (~> 1.1.0)
       capybara (~> 2.1.0)
       find_a_port (~> 1.0.1)

data/README.md

@@ -11,6 +11,14 @@ This allows you to test 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.
 
+## Features
+* A services 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.
+* Expected interactions are verified to have actually occurred.
+* A rake verification task allows a pact at any URI to be checked against a given service provider codebase.
+* Different versions of a consumer/provider pair can be easily tested against each other, allowing confidence when deploying new versions of each.
+
 ## Installation
 
 Put it in your Gemfile. You know how.

data/lib/pact/consumer/dsl.rb

@@ -92,7 +92,7 @@ module Pact::Consumer
             @name = name
             @port = nil
             @standalone = false
-            @verify = false
+            @verify = true
             instance_eval(&block)
          end
 

data/lib/pact/consumer/interaction.rb

@@ -38,7 +38,8 @@ module Pact
       end
 
       def as_json_for_mock_service
-        {:response => Reification.from_term(response), :request => @request.as_json_with_options, :description => description }
+        {:response => Reification.from_term(response), :request => @request.as_json_with_options, :description => description }.
+          tap{ | hash | hash[:producer_state] = @producer_state if @producer_state }
       end
 
       def to_json_for_mock_service

data/lib/pact/consumer/mock_service.rb

@@ -43,6 +43,7 @@ module Pact
         @matched_interactions << interaction
       end
 
+      # Request::Actual
       def register_unexpected request
         @unexpected_requests << request
       end
@@ -58,7 +59,7 @@ module Pact
       def interaction_diffs
         {
           :missing_interactions => missing_interactions,
-          :unexpected_requests => unexpected_requests
+          :unexpected_requests => unexpected_requests.collect(&:as_json)
         }.inject({}) do | hash, pair |
           hash[pair.first] = pair.last if pair.last.any?
           hash
@@ -238,6 +239,7 @@ module Pact
       end
 
       def handle_unrecognised_request request, candidates
+        InteractionList.instance.register_unexpected request
         @logger.error "No interaction found on #{@name} amongst expected requests \"#{candidates.map(&:description).join(', ')}\""
         @logger.error 'Interaction diffs for that route:'
         interaction_diff = candidates.map do |candidate|

data/lib/pact/consumer_contract.rb

@@ -72,9 +72,10 @@ module Pact
 			end
 		end
 
+		# Move this to interaction
 		def match_criteria? interaction, criteria
 			criteria.each do | key, value |
-				unless match_criterion interaction[key.to_s], value
+				unless match_criterion interaction.send(key.to_s), value
 					return false
 				end
 			end
@@ -100,12 +101,12 @@ module Pact
         File.open(pactfile_path, 'w') do |f|
           f.write JSON.pretty_generate(self)
         end
-      end      		
+      end
 
 		private
 
       def filenamify name
         name.downcase.gsub(/\s/, '_')
-      end		
+      end
 	end
 end

data/lib/pact/json_warning.rb

@@ -4,6 +4,7 @@ require 'json/add/regexp'
 module Pact
   module JsonWarning
     def check_for_active_support_json
+      @already_warned ||= false
       # Active support clobbers the as_json methods defined in the json/add directory of the json gem.
       # These methods are required to serialize and deserialize the Regexp and Symbol classes properly.
       # You can potentially fix this by making sure the json gem is required AFTER the active_support/json gem
@@ -15,8 +16,11 @@ module Pact
       # without breaking the calling code, which may depend on activesupport/json... then please fix this.
       # Note: we can probably do this in Ruby 2.0 with refinements, but for now, we're all stuck on 1.9 :(
 
-      unless Regexp.new('').as_json.is_a?(Hash)
-        Logger.new($stderr).warn("It appears you are using ActiveSupport json in your project. You are now in rubygems hell. Please see Pact::JsonWarning for more info.")
+      unless @already_warned
+        unless Regexp.new('').as_json.is_a?(Hash)
+          Logger.new($stderr).warn("It appears you are using ActiveSupport json in your project. You are now in rubygems hell. Please see Pact::JsonWarning for more info.")
+          @already_warned = true
+        end
       end
     end
   end

data/lib/pact/matchers/matchers.rb

@@ -105,15 +105,28 @@ module Pact
     end
 
     def class_diff expected, actual
-      if expected.class != actual.class
-        actual_display = actual.nil? ? nil : {:class => actual.class, :value => actual }
-        expected_display = expected.nil? ? nil : {:class => expected.class, eg: expected}
-        {:expected => expected_display, :actual => actual_display}
-      else
+      if classes_match? expected, actual
         {}
+      else
+        {:expected => structure_diff_expected_display(expected), :actual => structure_diff_actual_display(actual)}
       end
     end
 
+    def structure_diff_actual_display actual
+      (actual.nil? || actual.is_a?(KeyNotFound) ) ? actual : {:class => actual.class, :value => actual }
+    end
+
+    def structure_diff_expected_display expected
+      (expected.nil?) ? expected : {:class => expected.class, eg: expected}
+    end
+
+    def classes_match? expected, actual
+      #There must be a more elegant way to do this
+      expected.class == actual.class ||
+        (expected.is_a?(TrueClass) && actual.is_a?(FalseClass)) ||
+          (expected.is_a?(FalseClass) && actual.is_a?(TrueClass))
+    end
+
     def object_diff expected, actual, options
       return class_diff(expected, actual) if options[:structure]
       if expected != actual

data/lib/pact/request.rb

@@ -85,6 +85,23 @@ module Pact
         as_json.reject{ |key, value| !keep_keys.include? key }
       end
 
+      def short_description
+        "#{method} #{full_path}"
+      end
+
+      def full_path
+        fp = ''
+        if path.empty?
+          fp << "/"
+        else
+          fp << path
+        end
+        if query && !query.empty?
+          fp << ("?" + query)
+        end
+        fp
+      end
+
     end
 
     class Expected < Base
@@ -130,6 +147,10 @@ module Pact
         as_json.merge( options.empty? ? {} : { options: options} )
       end
 
+      def generated_body
+        Pact::Reification.from_term(body)
+      end
+
       # Don't want to put the default options in the pact json just yet, so calculating these at run time, rather than assigning
       # the result to @options
       def runtime_options

data/lib/pact/version.rb

@@ -1,3 +1,3 @@
 module Pact
-  VERSION = "0.1.35"
+  VERSION = "0.1.37"
 end

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

@@ -46,7 +46,7 @@ module Pact
         let(:request) { double(Pact::Request::Expected, :as_json_with_options => {:opts => 'blah'})}
         let(:response) { double('response') }
         let(:generated_response ) { double('generated_response', :to_json => 'generated_response') }
-        subject { Interaction.new(:description => 'description', :request => request, :response => response, :producer_state => 'ignored')}
+        subject { Interaction.new(:description => 'description', :request => request, :response => response, :producer_state => 'some state')}
         let(:expected_hash) { {:response => generated_response, :request => as_json_with_options, :description => '' } }
 
         before do
@@ -62,8 +62,8 @@ module Pact
           expect(subject.as_json_for_mock_service[:request]).to eq as_json_with_options
         end
 
-        it "does not send the producer state" do
-          expect(subject.as_json_for_mock_service.key?(:producer_state)).to be_false
+        it "includes the producer state" do
+          expect(subject.as_json_for_mock_service[:producer_state]).to eq 'some state'
         end
 
         it "includes the description" do
@@ -71,7 +71,7 @@ module Pact
         end
 
         it "doesn't have any other keys" do
-          expect(subject.as_json_for_mock_service.keys).to eq [:response, :request, :description]
+          expect(subject.as_json_for_mock_service.keys).to eq [:response, :request, :description, :producer_state]
         end
       end
 

data/spec/lib/pact/consumer/mock_service_spec.rb

@@ -10,7 +10,7 @@ module Pact::Consumer
 
     shared_context "unexpected requests and missed interactions" do
       let(:expected_call) { {request: 'blah'} }
-      let(:unexpected_call) { {request: 'meh'} }
+      let(:unexpected_call) { Pact::Request::Actual.from_hash(path: '/path', method: 'get') }
       subject {
         interactionList = InteractionList.instance
         interactionList.add expected_call
@@ -21,7 +21,7 @@ module Pact::Consumer
 
     shared_context "no unexpected requests or missed interactions exist" do
       let(:expected_call) { {request: 'blah'} }
-      let(:unexpected_call) { {request: 'meh'} }
+      let(:unexpected_call) { Pact::Request::Actual.from_hash(path: '/path', method: 'get') }
       subject {
         interactionList = InteractionList.instance
         interactionList.add expected_call
@@ -34,7 +34,7 @@ module Pact::Consumer
       context "when unexpected requests and missed interactions exist" do
         include_context "unexpected requests and missed interactions"
         let(:expected) {
-          {:missing_interactions=>[{:request=>"blah"}], :unexpected_requests=>[{:request=>"meh"}]}
+          {:missing_interactions=>[{:request=>"blah"}], :unexpected_requests=>[{:method=>"get", :path=>"/path"}]}
         }
         it "returns the unexpected requests and missed interactions" do
           expect(subject.interaction_diffs).to eq expected

data/spec/lib/pact/consumer_contract_spec.rb

@@ -68,8 +68,8 @@ module Pact
     describe "find_interactions" do
       let(:consumer) { double('ServiceConsumer', :name => 'Consumer')}
       let(:producer) { double('ServiceProducer', :name => 'Producer')}
-      let(:interaction1) { {'description' => 'a request for food'} }
-      let(:interaction2) { {'description' => 'a request for drink'} }
+      let(:interaction1) { Pact::Consumer::Interaction.new(:description => 'a request for food') }
+      let(:interaction2) { Pact::Consumer::Interaction.new(:description => 'a request for drink') }
       subject { ConsumerContract.new(:interactions => [interaction1, interaction2], :consumer => consumer, :producer => producer) }
       context "by description" do
         context "when no interactions are found" do
@@ -87,8 +87,9 @@ module Pact
     describe "find_interaction" do
       let(:consumer) { double('ServiceConsumer', :name => 'Consumer')}
       let(:producer) { double('ServiceProducer', :name => 'Producer')}
-      let(:interaction1) { {'description' => 'a request for food'} }
-      let(:interaction2) { {'description' => 'a request for drink'} }
+      # Should be stubbing these
+      let(:interaction1) { Pact::Consumer::Interaction.new(:description => 'a request for food') }
+      let(:interaction2) { Pact::Consumer::Interaction.new(:description => 'a request for drink') }
       subject { ConsumerContract.new(:interactions => [interaction1, interaction2], :consumer => consumer, :producer => producer) }
       context "by description" do
         context "when a match is found" do

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

@@ -27,13 +27,23 @@ describe Pact::Matchers do
 
   describe 'structure_diff' do
     let(:expected) {
-      {a: 'a string', b: 1, c: nil, d: [{e: 'thing'}], f: {g: 10}}
+      {a: 'a string', b: 1, c: nil, d: [{e: 'thing'}], f: {g: 10}, h: false}
     }
 
     context "when the classes match" do
-      let(:actual) { {a: 'another string', b: 2, c: nil, d: [{e: 'something'}], f: {g: 100}} }
+      let(:actual) { {a: 'another string', b: 2, c: nil, d: [{e: 'something'}], f: {g: 100}, h: true} }
+      let(:difference) { {} }
       it "returns an empty hash" do
-        expect(structure_diff(expected, actual)).to be_empty
+        expect(structure_diff(expected, actual)).to eq difference
+      end
+    end
+
+    context "when a key is not found" do
+      let(:actual) { {a: 'blah'} }
+      let(:expected) { {b: 'blah'} }
+      let(:difference) { {:b=>{:expected=>{:class=>String, :eg=>"blah"}, :actual=>Pact::Matchers::KeyNotFound.new}} }
+      it "returns the difference" do
+        expect(structure_diff(expected, actual)).to eq difference
       end
     end
 

data/spec/lib/pact/request_spec.rb

@@ -2,6 +2,28 @@ require 'spec_helper'
 require 'pact/request'
 
 shared_examples "a request" do
+
+  describe 'full_path' do
+    context "with empty path" do
+      subject { described_class.from_hash({:path => '', :method => 'get'}) }
+      it "returns the full path"do
+        expect(subject.full_path).to eq "/"
+      end
+    end
+    context "with a path" do
+      subject { described_class.from_hash({:path => '/path', :method => 'get'}) }
+      it "returns the full path"do
+        expect(subject.full_path).to eq "/path"
+      end
+    end
+    context "with a path and query" do
+      subject { described_class.from_hash({:path => '/path', :method => 'get', :query => "something"}) }
+      it "returns the full path"do
+        expect(subject.full_path).to eq "/path?something"
+      end
+    end
+  end
+
   describe "building from a hash" do
 
     let(:raw_request) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 0.1.35
+  version: 0.1.37
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
+date: 2013-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp