pact 0.1.37 → 1.0.0

data/lib/pact/consumer/mock_service.rb

@@ -19,7 +19,7 @@ module Pact
   module Consumer
 
     class InteractionList
-      include Singleton
+      #include Singleton
 
       attr_reader :interactions
       attr_reader :unexpected_requests
@@ -112,9 +112,10 @@ module Pact
 
       include RackHelper
 
-      def initialize name, logger
+      def initialize name, logger, interaction_list
         @name = name
         @logger = logger
+        @interaction_list = interaction_list
       end
 
       def match? env
@@ -123,7 +124,7 @@ module Pact
       end
 
       def respond env
-        InteractionList.instance.clear
+        @interaction_list.clear
         @logger.info "Cleared interactions before example \"#{params_hash(env)['example_description']}\""
         [200, {}, ['Deleted interactions']]
       end
@@ -131,9 +132,10 @@ module Pact
 
     class InteractionPost
 
-      def initialize name, logger
+      def initialize name, logger, interaction_list
         @name = name
         @logger = logger
+        @interaction_list = interaction_list
       end
 
       def match? env
@@ -143,7 +145,7 @@ module Pact
 
       def respond env
         interactions = Hashie::Mash.new(JSON.load(env['rack.input'].string))
-        InteractionList.instance.add interactions
+        @interaction_list.add interactions
         @logger.info "Added interaction to #{@name}"
         @logger.ap interactions
         [200, {}, ['Added interactions']]
@@ -197,9 +199,10 @@ module Pact
       include Pact::Matchers
       include RequestExtractor
 
-      def initialize name, logger
+      def initialize name, logger, interaction_list
         @name = name
         @logger = logger
+        @interaction_list = interaction_list
       end
 
       def match? env
@@ -217,7 +220,7 @@ module Pact
         @logger.info "#{@name} received request"
         @logger.ap actual_request.as_json
         candidates = []
-        matching_interactions = InteractionList.instance.interactions.select do |interaction|
+        matching_interactions = @interaction_list.interactions.select do |interaction|
           expected_request = Request::Expected.from_hash(interaction.request.merge(:description => interaction.description))
           candidates << expected_request if expected_request.matches_route? actual_request
           expected_request.match actual_request
@@ -231,7 +234,7 @@ module Pact
           handle_unrecognised_request(actual_request, candidates)
         else
           response = response_from(matching_interactions.first.response)
-          InteractionList.instance.register_matched matching_interactions.first
+          @interaction_list.register_matched matching_interactions.first
           @logger.info "Found matching response on #{@name}:"
           @logger.ap response
           response
@@ -239,7 +242,7 @@ module Pact
       end
 
       def handle_unrecognised_request request, candidates
-        InteractionList.instance.register_unexpected request
+        @interaction_list.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|
@@ -267,9 +270,10 @@ module Pact
     class MissingInteractionsGet
       include RackHelper
 
-      def initialize name, logger
+      def initialize name, logger, interaction_list
         @name = name
         @logger = logger
+        @interaction_list = interaction_list
       end
 
       def match? env
@@ -278,7 +282,7 @@ module Pact
       end
 
       def respond env
-        number_of_missing_interactions = InteractionList.instance.missing_interactions.size
+        number_of_missing_interactions = @interaction_list.missing_interactions.size
         @logger.info "Number of missing interactions for mock \"#{@name}\" = #{number_of_missing_interactions}"
         [200, {}, ["#{number_of_missing_interactions}"]]
       end
@@ -289,10 +293,11 @@ module Pact
 
       include RackHelper
 
-      def initialize name, logger, log_description
+      def initialize name, logger, log_description, interaction_list
         @name = name
         @logger = logger
         @log_description = log_description
+        @interaction_list = interaction_list
       end
 
       def match? env
@@ -301,12 +306,12 @@ module Pact
       end
 
       def respond env
-        if InteractionList.instance.all_matched?
+        if @interaction_list.all_matched?
           @logger.info "Verifying - interactions matched for example \"#{example_description(env)}\""
           [200, {}, ['Interactions matched']]
         else
           @logger.warn "Verifying - actual interactions do not match expected interactions for example \"#{example_description(env)}\". Interaction diffs:"
-          @logger.ap InteractionList.instance.interaction_diffs, :warn
+          @logger.ap @interaction_list.interaction_diffs, :warn
           [500, {}, ["Actual interactions do not match expected interactions for mock #{@name}. See #{@log_description} for details."]]
         end
       end
@@ -329,15 +334,17 @@ module Pact
           "standard out/err"
         end
 
+        interaction_list = InteractionList.new
+
         @name = options.fetch(:name, "MockService")
         @handlers = [
           StartupPoll.new(@name, @logger),
           CapybaraIdentify.new(@name, @logger),
-          MissingInteractionsGet.new(@name, @logger),
-          VerificationGet.new(@name, @logger, log_description),
-          InteractionPost.new(@name, @logger),
-          InteractionDelete.new(@name, @logger),
-          InteractionReplay.new(@name, @logger)
+          MissingInteractionsGet.new(@name, @logger, interaction_list),
+          VerificationGet.new(@name, @logger, log_description, interaction_list),
+          InteractionPost.new(@name, @logger, interaction_list),
+          InteractionDelete.new(@name, @logger, interaction_list),
+          InteractionReplay.new(@name, @logger, interaction_list)
         ]
       end
 

data/lib/pact/consumer/rspec.rb

@@ -1,7 +1,6 @@
 require_relative '../configuration'
 require_relative '../consumer'
 require_relative 'dsl'
-require_relative 'configuration_dsl'
 require 'pact/consumer/consumer_contract_builder'
 
 module Pact
@@ -31,8 +30,8 @@ RSpec.configure do |config|
   config.after :each, :pact => true do | example |
     example_description = "#{example.example.example_group.description} #{example.example.description}"
     Pact.configuration.logger.info "Verifying interactions for #{example_description}"
-    Pact.configuration.producer_verifications.each do | producer_verification |
-      producer_verification.call example_description
+    Pact.configuration.provider_verifications.each do | provider_verification |
+      provider_verification.call example_description
     end
   end
 

data/lib/pact/consumer/server.rb

@@ -0,0 +1,90 @@
+require 'uri'
+require 'net/http'
+require 'rack'
+
+# Copied shamelessly from Capybara
+module Pact
+  class Server
+    class Middleware
+      attr_accessor :error
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        if env["PATH_INFO"] == "/__identify__"
+          [200, {}, [@app.object_id.to_s]]
+        else
+          begin
+            @app.call(env)
+          rescue StandardError => e
+            @error = e unless @error
+            raise e
+          end
+        end
+      end
+    end
+
+    class << self
+      def ports
+        @ports ||= {}
+      end
+    end
+
+    attr_reader :app, :port
+
+    def initialize(app, port)
+      @app = app
+      @middleware = Middleware.new(@app)
+      @server_thread = nil # supress warnings
+      @port = port
+    end
+
+    def reset_error!
+      @middleware.error = nil
+    end
+
+    def error
+      @middleware.error
+    end
+
+    def host
+      "localhost"
+    end
+
+    def responsive?
+      return false if @server_thread && @server_thread.join(0)
+
+      res = Net::HTTP.start(host, @port) { |http| http.get('/__identify__') }
+
+      if res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
+        return res.body == @app.object_id.to_s
+      end
+    rescue SystemCallError
+      return false
+    end
+
+    def run_default_server(app, port)
+      require 'rack/handler/webrick'
+      Rack::Handler::WEBrick.run(app, :Port => port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0))
+    end
+
+    def boot
+      unless responsive?
+        Pact::Server.ports[@app.object_id] = @port
+
+        @server_thread = Thread.new do
+          run_default_server(@middleware, @port)
+        end
+
+        Timeout.timeout(60) { @server_thread.join(0.1) until responsive? }
+      end
+    rescue Timeout::Error
+      raise "Rack application timed out during boot"
+    else
+      self
+    end
+
+  end
+end

data/lib/pact/consumer.rb

@@ -1,7 +1,10 @@
-require_relative 'consumer/interaction'
+require_relative 'consumer_contract'
 require_relative 'consumer/consumer_contract_builder'
+require_relative 'consumer/consumer_contract_builders'
+require_relative 'consumer/dsl'
+require_relative 'consumer/interaction_builder'
 require_relative 'consumer/mock_service'
+require_relative 'consumer/mock_service_client'
 require_relative 'consumer/app_manager'
 require_relative 'term'
-require_relative 'request'
-require_relative 'consumer_contract'
+require_relative 'request'

data/lib/pact/consumer_contract/consumer_contract.rb

@@ -0,0 +1,103 @@
+require 'pact/consumer_contract'
+require 'pact/logging'
+require 'pact/json_warning'
+require 'date'
+require 'pact/version'
+require_relative 'service_consumer'
+require_relative 'service_provider'
+require_relative 'interaction'
+
+module Pact
+  class ConsumerContract
+
+    include Pact::Logging
+    include Pact::JsonWarning
+
+    attr_accessor :interactions
+    attr_accessor :consumer
+    attr_accessor :provider
+
+    def initialize(attributes = {})
+      @interactions = attributes[:interactions] || []
+      @consumer = attributes[:consumer]
+      @provider = attributes[:provider]
+    end
+
+    def as_json(options = {})
+      {
+        provider: @provider.as_json,
+        consumer: @consumer.as_json,
+        interactions: @interactions.collect(&:as_json),
+        metadata: {
+          pact_gem: {
+            version: Pact::VERSION
+          }
+        }
+      }
+    end
+
+    def to_json(options = {})
+      as_json(options).to_json(options)
+    end
+
+    def self.from_hash(obj)
+      new({
+        :interactions => obj['interactions'].collect { |hash| Interaction.from_hash(hash)},
+        :consumer => ServiceConsumer.from_hash(obj['consumer']),
+        :provider => ServiceProvider.from_hash(obj['provider'] || {})
+      })
+    end
+
+    def self.from_json string
+      deserialised_object = JSON.load(maintain_backwards_compatiblity_with_producer_keys(string))
+      from_hash(deserialised_object)
+    end
+
+    def self.maintain_backwards_compatiblity_with_producer_keys string
+      string.gsub('"producer":', '"provider":').gsub('"producer_state":', '"provider_state":')
+    end
+
+    def find_interaction criteria
+      interactions = find_interactions criteria
+      if interactions.size == 0
+        raise "Could not find interaction matching #{criteria} in pact file between #{consumer.name} and #{provider.name}."
+      elsif interactions.size > 1
+        raise "Found more than 1 interaction matching #{criteria} in pact file between #{consumer.name} and #{provider.name}."
+      end
+      interactions.first
+    end
+
+    def find_interactions criteria
+      interactions.select{ | interaction| interaction.matches_criteria?(criteria)}
+    end
+
+    def each
+      interactions.each do | interaction |
+        yield interaction
+      end
+    end
+
+    def pact_file_name
+      "#{filenamify(consumer.name)}-#{filenamify(provider.name)}.json"
+    end
+
+      def pactfile_path
+        raise 'You must first specify a consumer and service name' unless (consumer && consumer.name && provider && provider.name)
+        @pactfile_path ||= File.join(Pact.configuration.pact_dir, pact_file_name)
+      end
+
+      def update_pactfile
+        logger.debug "Updating pact file for #{provider.name} at #{pactfile_path}"
+        check_for_active_support_json
+        File.open(pactfile_path, 'w') do |f|
+          f.write JSON.pretty_generate(self)
+        end
+      end
+
+    private
+
+      def filenamify name
+        name.downcase.gsub(/\s/, '_')
+      end
+  end
+end

data/lib/pact/consumer_contract/interaction.rb

@@ -0,0 +1,70 @@
+require 'pact/request'
+
+module Pact
+   class Interaction
+
+      attr_accessor :description, :request, :response, :provider_state
+
+      def initialize attributes = {}
+        @description = attributes[:description]
+        @request = attributes[:request]
+        @response = attributes[:response]
+        @provider_state = attributes[:provider_state]
+      end
+
+      def self.from_hash hash
+        new(:description => hash['description'],
+            :provider_state => hash['provider_state'],
+            :request => Pact::Request::Expected.from_hash(hash['request']),
+            :response => hash['response']
+          )
+      end
+
+      def as_json
+        {
+          :description => @description,
+          :request => @request.as_json,
+          :response => @response,
+        }.tap{ | hash | hash[:provider_state] = @provider_state if @provider_state }
+      end
+
+      def to_json(options = {})
+        as_json.to_json(options)
+      end
+
+      def as_json_for_mock_service
+        {:response => Reification.from_term(response), :request => @request.as_json_with_options, :description => description }.
+          tap{ | hash | hash[:provider_state] = @provider_state if @provider_state }
+      end
+
+      def to_json_for_mock_service
+        as_json_for_mock_service.to_json
+      end
+
+      # Move this to interaction
+      def matches_criteria? criteria
+        criteria.each do | key, value |
+          unless match_criterion self.send(key.to_s), value
+            return false
+          end
+        end
+        true
+      end
+
+      def match_criterion target, criterion
+        target == criterion || (criterion.is_a?(Regexp) && criterion.match(target))
+      end
+
+      def == other
+        other.is_a?(Interaction) && as_json == other.as_json
+      end
+
+      def eq? other
+        self == other
+      end
+
+      def to_s
+        to_json
+      end
+   end
+end

data/lib/pact/consumer_contract/service_consumer.rb

@@ -0,0 +1,20 @@
+module Pact
+  class ServiceConsumer
+    attr_accessor :name
+    def initialize options
+      @name = options[:name]
+    end
+
+    def to_s
+      name
+    end
+
+    def as_json options = {}
+      {name: name}
+    end
+
+    def self.from_hash obj
+      ServiceConsumer.new(:name => obj['name'])
+    end
+  end
+end

data/lib/pact/consumer_contract/service_provider.rb

@@ -0,0 +1,20 @@
+module Pact
+  class ServiceProvider
+    attr_accessor :name
+    def initialize options
+      @name = options[:name] || '[provider name unknown - please update the pact gem in the consumer project to the latest version and regenerate the pacts]'
+    end
+
+    def to_s
+      name
+    end
+
+    def as_json options = {}
+      {name: name}
+    end
+
+    def self.from_hash obj
+      ServiceProvider.new(:name => obj['name'])
+    end
+  end
+end

data/lib/pact/consumer_contract.rb

@@ -1,112 +1 @@
-require 'pact/consumer/service_consumer'
-require 'pact/consumer/service_producer'
-require 'pact/consumer/interaction'
-require 'pact/logging'
-require 'pact/json_warning'
-require 'date'
-require 'pact/version'
-
-module Pact
-	class ConsumerContract
-
-		include Pact::Logging
-      include Pact::JsonWarning
-
-		attr_accessor :interactions
-		attr_accessor :consumer
-		attr_accessor :producer
-
-		def initialize(attributes = {})
-			@interactions = attributes[:interactions] || []
-			@consumer = attributes[:consumer]
-			@producer = attributes[:producer]
-		end
-
-		def as_json(options = {})
-			{
-				producer: @producer.as_json,
-				consumer: @consumer.as_json,
-				interactions: @interactions.collect(&:as_json),
-				metadata: {
-					pact_gem: {
-						version: Pact::VERSION
-					}
-				}
-			}
-		end
-
-		def to_json(options = {})
-			as_json(options).to_json(options)
-		end
-
-		def self.from_hash(obj)
-		  new({
-		  	:interactions => obj['interactions'].collect { |hash| Pact::Consumer::Interaction.from_hash(hash)},
-		  	:consumer => Pact::Consumer::ServiceConsumer.from_hash(obj['consumer']),
-		  	:producer => Pact::Consumer::ServiceProducer.from_hash(obj['producer'] || {})
-		  })
-		end
-
-		def self.from_json string
-			deserialised_object = JSON.load(string)
-			from_hash(deserialised_object)
-		end
-
-		def find_interaction criteria
-			interactions = find_interactions criteria
-			if interactions.size == 0
-				raise "Could not find interaction matching #{criteria} in pact file between #{consumer.name} and #{producer.name}."
-			elsif interactions.size > 1
-				raise "Found more than 1 interaction matching #{criteria} in pact file between #{consumer.name} and #{producer.name}."
-			end
-			interactions.first
-		end
-
-		def find_interactions criteria
-			interactions.select{ | interaction| match_criteria? interaction, criteria}
-		end
-
-		def each
-			interactions.each do | interaction |
-				yield interaction
-			end
-		end
-
-		# Move this to interaction
-		def match_criteria? interaction, criteria
-			criteria.each do | key, value |
-				unless match_criterion interaction.send(key.to_s), value
-					return false
-				end
-			end
-			true
-		end
-
-		def match_criterion target, criterion
-			target == criterion || (criterion.is_a?(Regexp) && criterion.match(target))
-		end
-
-		def pact_file_name
-			"#{filenamify(consumer.name)}-#{filenamify(producer.name)}.json"
-		end
-
-      def pactfile_path
-        raise 'You must first specify a consumer and service name' unless (consumer && consumer.name && producer && producer.name)
-        @pactfile_path ||= File.join(Pact.configuration.pact_dir, pact_file_name)
-      end
-
-      def update_pactfile
-        logger.debug "Updating pact file for #{producer.name} at #{pactfile_path}"
-        check_for_active_support_json
-        File.open(pactfile_path, 'w') do |f|
-          f.write JSON.pretty_generate(self)
-        end
-      end
-
-		private
-
-      def filenamify name
-        name.downcase.gsub(/\s/, '_')
-      end
-	end
-end
+require 'pact/consumer_contract/consumer_contract'

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

@@ -1,12 +1,21 @@
 module Pact
 
-   module Producer
+   module Provider
       module DSL
 
+         #TODO: Move this into a module, out of configuration
          module Configuration
             def provider= provider
-               @producer = provider
+               @provider = provider
             end
+
+            def provider
+              if defined? @provider
+                @provider
+              else
+                raise "Please configure your provider. See the Provider section in the README for examples."
+              end
+            end            
          end
 
          Pact::Configuration.send(:include, Configuration)
@@ -39,8 +48,8 @@ module Pact
            end
 
            def validate
-             raise "Please provide a name for the Producer" unless @name
-             raise "Please configure an app for the Producer" unless @app_block
+             raise "Please provide a name for the Provider" unless @name && !@name.strip.empty?
+             raise "Please configure an app for the Provider" unless @app_block
            end
 
            def name name
@@ -59,3 +68,5 @@ module Pact
       end
    end
 end
+
+Pact.send(:extend, Pact::Provider::DSL)

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

@@ -5,10 +5,10 @@ require 'rspec/core/formatters/documentation_formatter'
 require_relative 'rspec'
 
 module Pact
-	module Producer
+	module Provider
 		class PactSpecRunner
 
-			extend Pact::Producer::RSpec::ClassMethods
+			extend Pact::Provider::RSpec::ClassMethods
 
 			def self.run(spec_definitions, options = {})
 				initialize_specs spec_definitions