pact 0.1.37 → 1.0.0

data/lib/pact/{producer/producer_state.rb → provider/provider_state.rb}

@@ -1,40 +1,33 @@
 module Pact
-  module Producer
+  module Provider
 
     module DSL
-      def producer_state name, &block
-        ProducerState.producer_state(name, &block).register
+      def provider_state name, &block
+        ProviderState.provider_state(name, &block).register
       end
 
-      def with_consumer name, &block
-        ProducerState.current_namespaces << name
+      def provider_states_for name, &block
+        ProviderState.current_namespaces << name
         instance_eval(&block)
-        ProducerState.current_namespaces.pop
+        ProviderState.current_namespaces.pop
       end
-
-      alias_method :provider_states_for, :with_consumer
-      alias_method :provider_state, :producer_state
     end
 
-    class ProducerState
+    class ProviderState
 
       attr_accessor :name
       attr_accessor :namespace
 
-      def self.producer_state name, &block
-        ProducerState.new(name, current_namespaces.join('.'), &block)
-      end
-
       def self.provider_state name, &block
-        producer_state name, &block
+        ProviderState.new(name, current_namespaces.join('.'), &block)
       end
 
-      def self.register name, producer_state
-        producer_states[name] = producer_state
+      def self.register name, provider_state
+        provider_states[name] = provider_state
       end
 
-      def self.producer_states
-        @@producer_states ||= {}
+      def self.provider_states
+        @@provider_states ||= {}
       end
 
       def self.current_namespaces
@@ -43,7 +36,7 @@ module Pact
 
       def self.get name, options = {}
         fullname = options[:for] ? "#{options[:for]}.#{name}" : name
-        (producer_states[fullname] || producer_states[fullname.to_sym]) || producer_states[name]
+        (provider_states[fullname] || provider_states[fullname.to_sym]) || provider_states[name]
       end
 
       def register
@@ -84,5 +77,3 @@ module Pact
     end
   end
 end
-
-Pact.send(:extend, Pact::Producer::DSL)

data/lib/pact/provider/rspec.rb

@@ -1 +1,128 @@
-require 'pact/producer/rspec'
+require 'open-uri'
+require 'pact/consumer_contract'
+require 'pact/json_warning'
+require_relative 'matchers'
+require_relative 'test_methods'
+require 'pact/provider/dsl'
+
+module Pact
+  module Provider
+    module RSpec
+
+      module InstanceMethods
+        def app
+          Pact.configuration.provider.app
+        end
+      end
+
+      module ClassMethods
+
+        include Pact::JsonWarning
+
+        def honour_pactfile pactfile_uri, options = {}
+          describe "Pact in #{pactfile_uri}" do
+            consumer_contract = Pact::ConsumerContract.from_json(read_pact_from(pactfile_uri, options))
+            honour_consumer_contract consumer_contract, options
+          end
+        end
+
+        def honour_consumer_contract consumer_contract, options = {}
+          check_for_active_support_json
+          describe_consumer_contract consumer_contract, options.merge({:consumer => consumer_contract.consumer.name})
+        end
+
+        private
+
+        def describe_consumer_contract consumer_contract, options
+          consumer_contract.interactions.each do |interaction|
+            describe_interaction_with_provider_state interaction, options
+          end
+        end
+
+        def describe_interaction_with_provider_state interaction, options
+          if interaction.provider_state
+            describe "Given #{interaction.provider_state}" do
+              describe_interaction interaction, options
+            end
+          else
+            describe_interaction interaction, options
+          end
+        end
+
+        def describe_interaction interaction, options
+
+          describe description_for(interaction) do
+
+            before do
+              set_up_provider_state interaction.provider_state, options[:consumer]
+              replay_interaction interaction
+            end
+
+            after do
+              tear_down_provider_state interaction.provider_state, options[:consumer]
+            end
+
+            describe_response interaction.response
+          end
+
+        end
+
+        def describe_response response
+          describe "returns a response which" do
+            if response['status']
+              it "has status code #{response['status']}" do
+                expect(last_response.status).to eql response['status']
+              end
+            end
+
+            if response['headers']
+              describe "includes headers" do
+                response['headers'].each do |name, value|
+                  it "\"#{name}\" with value \"#{value}\"" do
+                    expect(last_response.headers[name]).to match_term value
+                  end
+                end
+              end
+            end
+
+            if response['body']
+              it "has a matching body" do
+                logger.debug "Response body is #{last_response.body}"
+                expect(parse_entity_from_response(last_response)).to match_term response['body']
+              end
+            end
+          end
+        end
+
+        def description_for interaction
+          "#{interaction.description} to #{interaction.request.path}"
+        end
+
+        def read_pact_from uri, options = {}
+          pact = open(uri) { | file | file.read }
+          if options[:save_pactfile_to_tmp]
+            save_pactfile_to_tmp pact, File.basename(uri)
+          end
+          pact
+        rescue StandardError => e
+          $stderr.puts "Error reading file from #{uri}"
+          $stderr.puts "#{e.to_s} #{e.backtrace.join("\n")}"
+          raise e
+        end
+
+        def save_pactfile_to_tmp pact, name
+          FileUtils.mkdir_p Pact.configuration.tmp_dir
+          File.open(Pact.configuration.tmp_dir + "/#{name}", "w") { |file|  file << pact}
+        end
+
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.extend Pact::Provider::RSpec::ClassMethods
+  config.include Pact::Provider::RSpec::InstanceMethods
+  config.include Pact::Provider::TestMethods
+  config.include Pact::Provider::TestMethods
+end

data/lib/pact/{producer → provider}/test_methods.rb

@@ -1,10 +1,10 @@
 require 'pact/logging'
 require 'rack/test'
 require 'pact/reification'
-require 'pact/producer/producer_state'
+require 'pact/provider/provider_state'
 
 module Pact
-  module Producer
+  module Provider
     module TestMethods
 
       include Pact::Logging
@@ -19,15 +19,15 @@ module Pact
         end
       end
 
-      def set_up_producer_state producer_state_name, consumer
-        if producer_state_name
-          get_producer_state(producer_state_name, consumer).set_up
+      def set_up_provider_state provider_state_name, consumer
+        if provider_state_name
+          get_provider_state(provider_state_name, consumer).set_up
         end
       end
 
-      def tear_down_producer_state producer_state_name, consumer
-        if producer_state_name
-          get_producer_state(producer_state_name, consumer).tear_down
+      def tear_down_provider_state provider_state_name, consumer
+        if provider_state_name
+          get_provider_state(provider_state_name, consumer).tear_down
         end
       end
 
@@ -77,12 +77,12 @@ module Pact
         end
       end
 
-      def get_producer_state producer_state_name, consumer
-        unless producer_state = ProducerState.get(producer_state_name, :for => consumer)
+      def get_provider_state provider_state_name, consumer
+        unless provider_state = ProviderState.get(provider_state_name, :for => consumer)
           extra = consumer ? " for consumer \"#{consumer}\"" : ""
-          raise "Could not find a producer state defined for \"#{producer_state_name}\"#{extra}. Have you required the producer state file in your spec?"
+          raise "Could not find a provider state defined for \"#{provider_state_name}\"#{extra}. Have you required the provider state file in your spec?"
         end
-        producer_state
+        provider_state
       end
     end
   end

data/lib/pact/verification_task.rb

@@ -1,5 +1,5 @@
 require 'rake/tasklib'
-require 'pact/producer/pact_spec_runner'
+require 'pact/provider/pact_spec_runner'
 
 =begin
 	To create a rake pact:verify:<something> task
@@ -33,15 +33,15 @@ module Pact
 	    yield self
 
 	    namespace :pact do
-	      desc "Verify producer against the consumer pacts for #{name}"
+	      desc "Verify provider against the consumer pacts for #{name}"
 	      task "verify:#{name}" do
-	        exit_status = Producer::PactSpecRunner.run(pact_spec_config)
+	        exit_status = Provider::PactSpecRunner.run(pact_spec_config)
 	        fail failure_message if exit_status != 0
 	      end
 
 	      def failure_message
 	      	"\n* * * * * * * * * * * * * * * * * * *\n" +
-	      	"Producer did not honour pact file.\nSee\n * #{Pact.configuration.log_path}\n * #{Pact.configuration.tmp_dir}\nfor logs and pact files." +
+	      	"Provider did not honour pact file.\nSee\n * #{Pact.configuration.log_path}\n * #{Pact.configuration.tmp_dir}\nfor logs and pact files." +
 	      	"\n* * * * * * * * * * * * * * * * * * *\n\n"
 	      end
 	    end

data/lib/pact/version.rb

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

data/lib/pact.rb

@@ -1,5 +1,5 @@
 require_relative 'pact/version'
 require_relative 'pact/configuration'
 require_relative 'pact/consumer'
-require_relative 'pact/producer'
+require_relative 'pact/provider'
 require_relative 'pact/consumer_contract'

data/pact.gemspec

@@ -19,12 +19,11 @@ Gem::Specification.new do |gem|
   gem.license       = 'MIT'
 
   gem.add_runtime_dependency 'randexp', '~> 0.1.7'
-  gem.add_runtime_dependency 'hashie', '~> 2.0.5'
+  gem.add_runtime_dependency 'hashie', '~> 2.0'
   gem.add_runtime_dependency 'rspec', '~> 2.12'
   gem.add_runtime_dependency 'find_a_port', '~> 1.0.1'
   gem.add_runtime_dependency 'rack-test', '~> 0.6.2'
   gem.add_runtime_dependency 'awesome_print', '~> 1.1.0'
-  gem.add_runtime_dependency 'capybara', '~> 2.1.0'
   gem.add_runtime_dependency 'thor'
   gem.add_runtime_dependency 'thin'
   gem.add_runtime_dependency 'json' #Not locking down a version because buncher gem requires 1.6, while other projects use 1.7.

data/scratchpad.txt

@@ -5,7 +5,7 @@ Could use:
 eg
 ex
 
-my_producer.
+my_provider.
    given("a thing exists").
       upon_receiving("a request for a thing").with({:method => 'get', :path => '/thing'})
          will_respond_with({:body => {

data/spec/features/consumption_spec.rb

@@ -99,20 +99,16 @@ describe "A service consumer side of a pact", :pact => true  do
     expect{ bob_service.verify('goes a little something like this') }.to raise_error /do not match/
   end
 
-  context "with a producer state" do
+  context "with a provider state" do
     before do
       Pact.clear_configuration
 
-      Pact.configure do | config |
-        config.service_consumer do
-          name "Consumer"
-        end
-      end
-
-      Pact.with_service_provider "Zebra Service" do
-        mock_service :zebra_service do
-          verify false
-          port 1235
+      Pact.service_consumer "Consumer" do
+        has_pact_with "Zebra Service" do
+          mock_service :zebra_service do
+            verify false
+            port 1235
+          end
         end
       end
     end
@@ -132,25 +128,21 @@ describe "A service consumer side of a pact", :pact => true  do
         })
 
         interactions = Pact::ConsumerContract.from_json(File.read(zebra_service.consumer_contract.pactfile_path)).interactions
-        interactions.first.producer_state.should eq("the_zebras_are_here")
+        interactions.first.provider_state.should eq("the_zebras_are_here")
         sleep 1
     end
   end
 
-  context "with a async interaction with producer" do
+  context "with a async interaction with provider" do
     before do
       Pact.clear_configuration
 
-      Pact.configure do | config |
-        config.service_consumer do
-          name "Consumer"
-        end
-      end
-
-      Pact.with_service_provider "Zebra Service" do
-        mock_service :zebra_service do
-          verify true
-          port 1239
+      Pact.service_consumer "Consumer" do | config |
+        has_pact_with "Zebra Service" do
+          mock_service :zebra_service do
+            verify true
+            port 1239
+          end
         end
       end
     end

data/spec/features/production_spec.rb

@@ -1,9 +1,9 @@
 require 'pact/provider/rspec'
 require 'pact/consumer_contract'
-require 'features/producer_states/zebras'
+require 'features/provider_states/zebras'
 
 
-module Pact::Producer
+module Pact::Provider
 
   describe "A service production side of a pact" do
 
@@ -83,7 +83,7 @@ module Pact::Producer
 
   end
 
-  describe "with a producer_state" do
+  describe "with a provider_state" do
 
     context "that is a symbol" do
         consumer_contract = Pact::ConsumerContract.from_json <<-EOS
@@ -100,7 +100,7 @@ module Pact::Producer
                         "body": {"names": ["Jason", "Sarah"]},
                         "status": 200
                     },
-                    "producer_state" : "the_zebras_are_here"
+                    "provider_state" : "the_zebras_are_here"
                 }
             ]
         }
@@ -131,7 +131,7 @@ module Pact::Producer
                         "body": {"names": ["Mark", "Gertrude"]},
                         "status": 200
                     },
-                    "producer_state" : "some other zebras are here"
+                    "provider_state" : "some other zebras are here"
                 }
             ]
         }

data/spec/features/{producer_states → provider_states}/zebras.rb

@@ -1,9 +1,9 @@
 require 'json'
 require 'fileutils'
 
-Pact.with_consumer 'the-wild-beast-store' do
+Pact.provider_states_for 'the-wild-beast-store' do
 
-  producer_state :the_zebras_are_here do
+  provider_state :the_zebras_are_here do
     set_up do
       FileUtils.mkdir_p 'tmp'
       some_data = [{'name' => 'Jason'},{'name' => 'Sarah'}]
@@ -16,7 +16,7 @@ Pact.with_consumer 'the-wild-beast-store' do
   end
 end
 
-Pact.producer_state "some other zebras are here" do
+Pact.provider_state "some other zebras are here" do
   set_up do
     some_data = [{'name' => 'Mark'},{'name' => 'Gertrude'}]
     File.open("tmp/a_mock_database.json", "w") { |file| file << some_data.to_json }

data/spec/integration/pact/consumer_configuration_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 require 'pact/configuration'
 require 'pact/consumer/dsl'
-require 'pact/consumer/configuration_dsl'
-require 'pact/producer/configuration_dsl'
 
 describe "consumer side" do
   describe "configure" do
@@ -47,7 +45,7 @@ describe "consumer side" do
       subject { TestHelper.new.my_service.consumer_contract.consumer }
 
       it "should be configured" do
-        expect(subject).to be_instance_of Pact::Consumer::ServiceConsumer
+        expect(subject).to be_instance_of Pact::ServiceConsumer
       end
 
       it "should have the right name" do
@@ -59,11 +57,11 @@ describe "consumer side" do
       end
     end
 
-    describe "producers" do
+    describe "providers" do
 
       subject { TestHelper.new.my_service }
 
-      it "should have defined methods in MockServices for the producers" do
+      it "should have defined methods in MockServices for the providers" do
         subject.should be_instance_of Pact::Consumer::ConsumerContractBuilder
       end
 
@@ -80,65 +78,4 @@ describe "consumer side" do
       end
     end
   end
-
-
-  describe "deprecated configure" do
-
-    before do
-      Pact.clear_configuration
-      Pact::Consumer::AppManager.instance.clear_all
-
-      Pact.configure do | config |
-        config.service_consumer do
-          name "My Consumer"
-        end
-      end
-
-      Pact.with_service_provider "My Service" do
-        mock_service :my_service do
-          port 1234
-          standalone true
-        end
-      end
-
-      Pact.with_service_provider "My Other Service" do
-        mock_service :my_other_service do
-          port 1235
-          standalone false
-        end
-      end
-    end
-
-    describe "configuration" do
-      it "should return the same configuration object each time" do
-        expect(Pact.configuration).to equal(Pact.configuration)
-      end
-    end
-
-    describe "deprecated consumer" do
-      it "should be configured" do
-        Pact.configuration.consumer.name.should eq "My Consumer"
-      end
-    end
-
-    describe "producers" do
-      include Pact::Consumer::ConsumerContractBuilders
-
-      it "should have defined methods in MockServices for the producers" do
-        my_service.should be_instance_of Pact::Consumer::ConsumerContractBuilder
-      end
-
-      context "when standalone is true" do
-        it "is not registerd with the AppManager" do
-          Pact::Consumer::AppManager.instance.app_registered_on?(1234).should be_false
-        end
-      end
-
-      context "when standalone is false" do
-        it "should register the MockServices on their given ports if they are not" do
-          Pact::Consumer::AppManager.instance.app_registered_on?(1235).should be_true
-        end
-      end
-    end
-  end
 end

data/spec/integration/pact/provider_configuration_spec.rb

@@ -5,7 +5,7 @@ describe "provider side" do
    describe "configure" do
 
       class TestHelper
-         include Pact::Producer::RSpec::InstanceMethods
+         include Pact::Provider::RSpec::InstanceMethods
       end
 
       let(:application) { double("App")}

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

@@ -7,23 +7,26 @@ module Pact
 		describe ConsumerContractBuilder do
 
 		   describe "initialize" do
+		   	SUPPORT_PACT_FILE = './spec/support/a_consumer-a_provider.json'
 			   before do
 			      Pact.clear_configuration
 			      Pact.configuration.stub(:pact_dir).and_return(File.expand_path(tmp_pact_dir))
 			      FileUtils.rm_rf tmp_pact_dir
 			      FileUtils.mkdir_p tmp_pact_dir
-			      FileUtils.cp './spec/support/a_consumer-a_producer.json', "#{tmp_pact_dir}/a_consumer-a_producer.json"
+			      FileUtils.cp SUPPORT_PACT_FILE, "#{tmp_pact_dir}/a_consumer-a_provider.json"
 			   end
 
+			   let(:expected_interactions) { ConsumerContract.from_json(File.read(SUPPORT_PACT_FILE)).interactions }
+
 			   let(:tmp_pact_dir) {"./tmp/pacts"}
 
 			   let(:consumer_name) { 'a consumer' }
-			   let(:producer_name) { 'a producer' }
+			   let(:provider_name) { 'a provider' }
 			   let(:consumer_contract_builder) { 
 			      Pact::Consumer::ConsumerContractBuilder.new(
 			         :pactfile_write_mode => pactfile_write_mode,
 			         :consumer_name => consumer_name,
-			         :producer_name => producer_name,
+			         :provider_name => provider_name,
 			         :port => 1234)}
 
 			   context "when overwriting pact" do
@@ -31,20 +34,51 @@ module Pact
 			      it "it overwrites the existing pact file" do
 			         expect(consumer_contract_builder.consumer_contract.interactions).to eq []
 			      end
+
+			      it "uses an DistinctInteractionsFilter to handle new interactions" do
+			      	Pact::Consumer::DistinctInteractionsFilter.should_receive(:new).with([])
+			      	consumer_contract_builder
+			      end
 			   end
 
 			   context "when updating pact" do
 			      let(:pactfile_write_mode) {:update}
-			      it "updates the existing pact file" do
-			         expect(consumer_contract_builder.consumer_contract.interactions.size).to eq 2
+			      it "loads the interactions from the existing pact file" do
+			         expect(consumer_contract_builder.consumer_contract.interactions).to eq expected_interactions
+			      end
+
+			      it "uses an UpdatableInteractionsFilter to handle new interactions" do
+			      	Pact::Consumer::UpdatableInteractionsFilter.should_receive(:new).with(expected_interactions)
+			      	consumer_contract_builder
 			      end
 			   end
+
+			   context "when an error occurs deserializing the existing pactfile" do
+			   	let(:pactfile_write_mode) {:update}
+			   	let(:error) { RuntimeError.new('some error')}
+			   	let(:line1) { /Could not load existing consumer contract from .* due to some error/ }
+			   	let(:line2) {'Creating a new file.'}
+			   	before do
+			   		ConsumerContract.stub(:from_json).and_raise(error)
+			   		$stderr.should_receive(:puts).with(line1)
+			   		$stderr.should_receive(:puts).with(line2)
+			   		Pact.configuration.logger.should_receive(:warn).with(line1)
+			   		Pact.configuration.logger.should_receive(:warn).with(line2)
+			   	end
+			   	it "logs the error" do
+			   		consumer_contract_builder
+			   	end
+
+			   	it "continues with a new file" do
+			   		expect(consumer_contract_builder.consumer_contract.interactions).to eq []
+			   	end
+			   end
 		   end
 
 			describe "handle_interaction_fully_defined" do
 
 				subject {
-					Pact::Consumer::ConsumerContractBuilder.new({:consumer_name => 'blah', :producer_name => 'blah', :port => 2222})
+					Pact::Consumer::ConsumerContractBuilder.new({:consumer_name => 'blah', :provider_name => 'blah', :port => 2222})
 				}
 
 				let(:interaction_hash) {
@@ -66,21 +100,31 @@ module Pact
 
 				let(:interaction_json) { interaction.to_json_for_mock_service }
 
-				let(:interaction) { Pact::Consumer::Interaction.from_hash(JSON.parse(interaction_hash.to_json)) }
+				let(:interaction) { Pact::Interaction.from_hash(JSON.parse(interaction_hash.to_json)) }
 
 				before do
 					stub_request(:post, 'localhost:2222/interactions')
 				end
 
-      	it "posts the interaction with generated response to the mock service" do
-        	subject.handle_interaction_fully_defined interaction
-        	WebMock.should have_requested(:post, 'localhost:2222/interactions').with(body: interaction_json)
-      	end
+	      	it "posts the interaction with generated response to the mock service" do
+		        	subject.handle_interaction_fully_defined interaction
+		        	WebMock.should have_requested(:post, 'localhost:2222/interactions').with(body: interaction_json)
+	      	end
+
+	      	it "adds the interaction to the consumer contract" do
+	      		subject.handle_interaction_fully_defined interaction
+	      		expect(subject.consumer_contract.interactions).to eq [interaction]
+	      	end
+
+	      	it "updates the provider's pactfile" do
+	      		subject.consumer_contract.should_receive(:update_pactfile)
+	      		subject.handle_interaction_fully_defined interaction
+	      	end
 
-      	it "updates the Producer's Pactfile" do
-      		subject.consumer_contract.should_receive(:update_pactfile)
-      		subject.handle_interaction_fully_defined interaction
-      	end
+	      	it "resets the interaction_builder to nil" do
+	      		subject.should_receive(:interaction_builder=).with(nil)
+	      		subject.handle_interaction_fully_defined interaction
+	      	end
 			end
 		end
 	end