pact 1.0.9 → 1.0.10

data/lib/pact/consumer/rspec.rb

@@ -1,7 +1,4 @@
-require_relative '../configuration'
-require_relative '../consumer'
-require_relative 'dsl'
-require 'pact/consumer/consumer_contract_builder'
+require 'pact/consumer'
 
 module Pact
   module Consumer

data/lib/pact/consumer_contract/consumer_contract.rb

@@ -1,14 +1,15 @@
-require 'pact/consumer_contract'
 require 'pact/logging'
 require 'pact/json_warning'
-require 'date'
+require 'pact/something_like'
+require 'pact/symbolize_keys'
+require 'pact/term'
 require 'pact/version'
+require 'date'
 require 'open-uri'
-require 'pact/term'
-require 'pact/something_like'
 require_relative 'service_consumer'
 require_relative 'service_provider'
 require_relative 'interaction'
+require_relative 'request'
 
 
 
@@ -27,6 +28,7 @@ module Pact
 
   class ConsumerContract
 
+    include SymbolizeKeys
     include Logging
     include JsonWarning
     include FileName
@@ -58,11 +60,12 @@ module Pact
       as_json.to_json(options)
     end
 
-    def self.from_hash(obj)
+    def self.from_hash(hash)
+      hash = symbolize_keys(hash)
       new({
-        :interactions => obj['interactions'].collect { |hash| Interaction.from_hash(hash)},
-        :consumer => ServiceConsumer.from_hash(obj['consumer']),
-        :provider => ServiceProvider.from_hash(obj['provider'] || {})
+        :interactions => hash[:interactions].collect { |hash| Interaction.from_hash(hash)},
+        :consumer => ServiceConsumer.from_hash(hash[:consumer]),
+        :provider => ServiceProvider.from_hash(hash[:provider])
       })
     end
 

data/lib/pact/consumer_contract/interaction.rb

@@ -1,7 +1,9 @@
-require 'pact/request'
+require 'pact/consumer_contract/request'
+require 'pact/symbolize_keys'
 
 module Pact
    class Interaction
+      include SymbolizeKeys
 
       attr_accessor :description, :request, :response, :provider_state
 
@@ -13,35 +15,20 @@ module Pact
       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']
-          )
+        request = Pact::Request::Expected.from_hash(hash['request'])
+        new(symbolize_keys(hash).merge({request: request}))
       end
 
       def as_json
-        {
-          :description => @description,
-          :request => @request.as_json,
-          :response => @response,
-        }.tap{ | hash | hash[:provider_state] = @provider_state if @provider_state }
+        hash = { :description => @description }
+        hash[:provider_state] = @provider_state if @provider_state #Easier to read when provider state at top
+        hash.merge(:request => @request.as_json, :response => @response)
       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
@@ -64,7 +51,7 @@ module Pact
       end
 
       def to_s
-        to_json
+        JSON.pretty_generate(self)
       end
    end
 end

data/lib/pact/consumer_contract/request.rb

@@ -0,0 +1,68 @@
+require 'pact/shared/request'
+require 'pact/shared/null_expectation'
+
+module Pact
+
+  module Request
+
+    class Expected < Pact::Request::Base
+
+      DEFAULT_OPTIONS = {:allow_unexpected_keys => false}.freeze
+      attr_accessor :options #Temporary hack
+
+      def self.from_hash(hash)
+        sym_hash = symbolize_keys hash
+        method = sym_hash.fetch(:method)
+        path = sym_hash.fetch(:path)
+        query = sym_hash.fetch(:query, key_not_found)
+        headers = sym_hash.fetch(:headers, key_not_found)
+        body = sym_hash.fetch(:body, key_not_found)
+        options = sym_hash.fetch(:options, {})
+        new(method, path, headers, body, query, options)
+      end
+
+      def initialize(method, path, headers, body, query, options = {})
+        super(method, path, headers, body, query)
+        @options = options
+      end
+
+      def matches?(actual_request)
+        difference(actual_request).empty?
+      end
+
+      def matches_route? actual_request
+        diff({:method => method, :path => path}, {:method => actual_request.method, :path => actual_request.path}).empty?
+      end
+
+      def difference(actual_request)
+        request_diff = diff(as_json_without_body, actual_request.as_json_without_body)
+        unless body.is_a? NullExpectation
+          request_diff.merge(body_difference(actual_request.body))
+        else
+          request_diff
+        end
+      end
+
+      protected
+
+      def self.key_not_found
+        Pact::NullExpectation.new
+      end
+
+      private
+
+      # Options is a dirty hack to allow Condor to send extra keys in the request, 
+      # as it's too much work to set up an exactly matching expectation.
+      # Need to implement a proper matching strategy and remove this.
+      # Do not rely on it!
+      def runtime_options
+        DEFAULT_OPTIONS.merge(symbolize_keys(options))
+      end
+
+      def body_difference(actual_body)
+        diff({:body => body}, {body: actual_body}, allow_unexpected_keys: runtime_options[:allow_unexpected_keys_in_body])
+      end
+    end
+
+  end
+end

data/lib/pact/consumer_contract/service_consumer.rb

@@ -1,5 +1,9 @@
+require 'pact/symbolize_keys'
+
 module Pact
   class ServiceConsumer
+    include SymbolizeKeys
+
     attr_accessor :name
     def initialize options
       @name = options[:name]
@@ -13,8 +17,8 @@ module Pact
       {name: name}
     end
 
-    def self.from_hash obj
-      ServiceConsumer.new(:name => obj['name'])
+    def self.from_hash hash
+      new(symbolize_keys(hash))
     end
   end
 end

data/lib/pact/consumer_contract/service_provider.rb

@@ -1,5 +1,9 @@
+require 'pact/symbolize_keys'
+
 module Pact
   class ServiceProvider
+    include SymbolizeKeys
+
     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]'
@@ -13,8 +17,8 @@ module Pact
       {name: name}
     end
 
-    def self.from_hash obj
-      ServiceProvider.new(:name => obj['name'])
+    def self.from_hash hash
+      new(symbolize_keys(hash))
     end
   end
 end

data/lib/pact/matchers/index_not_found.rb

@@ -0,0 +1,20 @@
+module Pact
+  class IndexNotFound
+    def == other
+      other.is_a? IndexNotFound
+    end
+
+    def to_s
+      "<index not found>"
+    end
+
+    def to_json options = {}
+      to_s
+    end
+
+    def empty?
+      true
+    end
+  end  
+
+end

data/lib/pact/matchers/matchers.rb

@@ -1,32 +1,19 @@
 require 'awesome_print'
 require 'pact/term'
 require 'pact/something_like'
+require 'pact/shared/null_expectation'
+require 'pact/shared/key_not_found'
+require 'pact/matchers/unexpected_key'
+require 'pact/matchers/unexpected_index'
+require 'pact/matchers/index_not_found'
 
 module Pact
   module Matchers
 
     NO_DIFF_INDICATOR = 'no difference here!'
-    UNEXPECTED_KEY = '<key not to be present>'
+    #UnexpectedKey.new = '<key not to be present>'
     DEFAULT_OPTIONS = {allow_unexpected_keys: true, structure: false}.freeze
 
-    class KeyNotFound
-      def == other
-        other.is_a? KeyNotFound
-      end
-
-      def eql? other
-        self == other
-      end
-
-      def to_s
-        "<key not found>"
-      end
-
-      def to_json options = {}
-        to_s
-      end
-    end
-
     def diff expected, actual, opts = {}
       options = DEFAULT_OPTIONS.merge(opts)
       case expected
@@ -53,11 +40,7 @@ module Pact
 
     def array_diff expected, actual, options
       if actual.is_a? Array
-        if expected.length == actual.length
-          actual_array_diff expected, actual, options
-        else
-          {expected: expected, actual: actual}
-        end
+        actual_array_diff expected, actual, options
       else
         {expected: expected, actual: actual}
       end
@@ -66,8 +49,11 @@ module Pact
     def actual_array_diff expected, actual, options
       difference = []
       diff_found = false
-      expected.each_with_index do | item, index|
-        if (item_diff = diff(item, actual.fetch(index, KeyNotFound.new), options)).any?
+      length = [expected.length, actual.length].max
+      length.times do | index|
+        expected_item = expected.fetch(index, Pact::UnexpectedIndex.new)
+        actual_item = actual.fetch(index, Pact::IndexNotFound.new)
+        if (item_diff = diff(expected_item, actual_item, options)).any?
           diff_found = true
           difference << item_diff
         else
@@ -79,7 +65,7 @@ module Pact
 
     def actual_hash_diff expected, actual, options
       difference = expected.keys.inject({}) do |diff, key|
-        if (diff_at_key = diff(expected[key], actual.fetch(key, KeyNotFound.new), options)).any?
+        if (diff_at_key = diff(expected[key], actual.fetch(key, Pact::KeyNotFound.new), options)).any?
           diff[key] = diff_at_key
         end
         diff
@@ -92,7 +78,7 @@ module Pact
         {}
       else
         (actual.keys - expected.keys).inject({}) do | diff, key |
-          diff[key] = {:expected => UNEXPECTED_KEY, :actual => actual[key]}
+          diff[key] = {:expected => UnexpectedKey.new, :actual => actual[key]}
           diff
         end
       end

data/lib/pact/matchers/unexpected_index.rb

@@ -0,0 +1,17 @@
+module Pact
+  class UnexpectedIndex
+
+    def == other
+      other.is_a? UnexpectedIndex
+    end
+
+    def to_s
+      '<index not to exist>'
+    end
+
+    def to_json opts = {}
+      to_s
+    end
+
+  end
+end

data/lib/pact/matchers/unexpected_key.rb

@@ -0,0 +1,17 @@
+module Pact
+  class UnexpectedKey
+
+    def == other
+      other.is_a? UnexpectedKey
+    end
+     
+
+    def to_s
+      '<key not to exist>'
+    end
+
+    def to_json opts = {}
+      to_s
+    end
+  end
+end

data/lib/pact/provider.rb

@@ -1,3 +1,3 @@
 require 'pact/configuration'
-require 'pact/provider/dsl'
+require 'pact/provider/configuration'
 require 'pact/provider/pact_spec_runner'

data/lib/pact/provider/configuration.rb

@@ -0,0 +1,129 @@
+require 'pact/provider/pact_verification'
+require 'pact/shared/dsl'
+module Pact
+
+  module Provider
+
+    module DSL
+      def service_provider name, &block
+        Configuration::ServiceProviderDSL.build(name, &block)
+      end
+    end
+
+    Pact.send(:extend, Pact::Provider::DSL)
+
+    module Configuration
+
+      module ConfigurationExtension
+        def provider= 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
+
+        def add_pact_verification verification
+          pact_verifications << verification
+        end
+
+        def pact_verifications
+          @pact_verifications ||= []
+        end
+      end
+
+      Pact::Configuration.send(:include, ConfigurationExtension)
+
+      class ServiceProviderConfig
+
+        def initialize &app_block
+          @app_block = app_block
+        end
+
+        def app
+          @app_block.call
+        end
+      end
+
+      class PactVerification
+        extend Pact::DSL
+
+        attr_accessor :consumer_name, :pact_uri, :ref
+
+        def initialize consumer_name, options = {}
+          @consumer_name = consumer_name
+          @ref = options.fetch(:ref, :head)
+          @pact_uri = nil
+        end
+
+        dsl do
+          def pact_uri pact_uri
+            self.pact_uri = pact_uri
+          end
+        end
+
+        def finalize
+          validate
+          create_pact_verification
+        end
+
+        private
+
+        def create_pact_verification
+          verification = Pact::Provider::PactVerification.new(consumer_name, pact_uri, ref)
+          Pact.configuration.add_pact_verification verification
+        end
+
+        def validate
+          raise "Please provide a pact_uri for the verification" unless pact_uri
+        end
+
+      end
+
+      class ServiceProviderDSL
+        extend Pact::DSL
+
+        attr_accessor :name, :app_block
+
+        def initialize name
+          @name = name
+          @app_block = nil
+        end
+
+        dsl do
+          def app &block
+            self.app_block = block
+          end
+
+          def honours_pact_with consumer_name, options = {}, &block
+            create_pact_verification consumer_name, options, &block
+          end
+        end
+
+        def create_pact_verification consumer_name, options, &block
+          PactVerification.build(consumer_name, options, &block)
+        end
+
+        def finalize
+          validate
+          create_service_provider
+        end
+
+        private
+
+        def validate
+          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 create_service_provider
+          Pact.configuration.provider = ServiceProviderConfig.new(&@app_block)
+        end
+      end
+    end
+  end
+end