pact 1.3.3 → 1.4.0

data/CHANGELOG.md

@@ -2,6 +2,42 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+
+
+### 1.4.0 (25 November 2014)
+
+* e596eb8 - Added appraisal gem so we can test against RSpec 2 and 3. (bethesque, Thu Nov 20 09:31:13 2014 +1100)
+* fb40662 - Rescue EOFError when starting server jruby fails because of this all the time on TravisCI (bethesque, Fri Nov 14 15:58:08 2014 +1100)
+* c1e8b55 - Removing extraneous files from being included in the gem (bethesque, Fri Nov 14 14:03:44 2014 +1100)
+* 247e1c2 - Added example pact:publish task to example app (bethesque, Tue Nov 11 21:30:48 2014 +1100)
+* 935b318 - Removed Gemfile.lock from source control (bethesque, Fri Oct 24 16:02:36 2014 +1100)
+* b2f9073 - Mock Service client must now specify the pact dir (bethesque, Fri Oct 24 09:39:12 2014 +1100)
+* c64e122 - Add the ability to use regex in headers when defining the response. (Michael Treacher, Thu Oct 23 21:22:13 2014 +1100)
+* 892e526 - Removed jruby-19mode from .travis.yml, it fails inconsistently with EOF error. (bethesque, Wed Oct 22 16:26:28 2014 +1100)
+
+### 1.4.0.rc4 (22 October 2014)
+
+* e56775a - Upgraded pact support gems to allow form bodies to be specified as Hashes with Pact::Terms (bethesque, Wed Oct 22 15:31:30 2014 +1100)
+
+### 1.4.0.rc3 (17 October 2014)
+
+* 602906f - Upped pact-support version to allow queries specified as hashes. (bethesque, Fri Oct 17 14:30:39 2014 +1100)
+
+### 1.4.0.rc2 (12 October 2014)
+
+* 61036fc - Updating pact-support version (bethesque, Sun Oct 12 14:39:36 2014 +1100)
+
+### 1.4.0.rc1 (12 October 2014)
+
+* df3342f - Removing pact server command as it is now in pact-mock_service (bethesque, Sun Oct 12 12:39:56 2014 +1100)
+* 12ccdb7 - Making gem source configurable (bethesque, Sun Oct 12 12:39:32 2014 +1100)
+* 5b76516 - Removed files that are now in pact-support (bethesque, Sun Oct 12 11:40:57 2014 +1100)
+* c4365c5 - Fix bug in calling of SomethingLike serialisation (André Allavena, Fri Oct 10 15:39:57 2014 +1000)
+* 546b5c7 - JSON isn't auto-loaded; require it before use. (Daniel Heath, Wed Oct 8 13:31:24 2014 +1100)
+* 7cac7e9 - Replaced response hash with Response class - say no to Hash Driven Development (bethesque, Fri Oct 3 17:22:38 2014 +1000)
+* 36940d3 - Added test cases to show response headers are case insensitive (bethesque, Fri Oct 3 15:25:03 2014 +1000)
+* f4422e2 - Fix typos in README (Mark Dalgleish, Mon Sep 29 17:12:17 2014 +1000)
+
 ### 1.3.3 (23 September 2014)
 
 * 9106aac - Fixed reification when using FactoryGirl. (bethesque, Tue Sep 23 08:23:51 2014 +1000)
@@ -35,7 +71,7 @@ Do this to generate your change history
 
 ### 1.2.1.rc2 (13 June 2014)
 
-* d805f35 - Ensuring the pact RSpec formatter works for both rspec 2 and rspec 3 (Beth, Fri Jun 13 16:27:01 2014 +1000)
+* d805f35 - Ensuring the pact RSpec formatter works for both rspec 2 and rspec 3 (bethesque, Fri Jun 13 16:27:01 2014 +1000)
 * 1669d46 - Fix require for sample app to work without munging LOAD_PATH (Daniel Heath, Fri Jun 13 15:50:03 2014 +1000)
 
 ### 1.2.1.rc1 (13 June 2014)

data/lib/pact/cli.rb

@@ -15,15 +15,6 @@ module Pact
       RunPactVerification.call(options)
     end
 
-    desc 'service', "Start a mock service"
-    method_option :port, aliases: "-p", desc: "Port on which to run the service"
-    method_option :log, aliases: "-l", desc: "File to which to log output"
-    method_option :quiet, aliases: "-q", desc: "If true, no admin messages will be shown"
-
-    def service
-      RunStandaloneMockService.call(options)
-    end
-
     private
 
     def log message
@@ -98,23 +89,6 @@ module Pact
 
   end
 
-  class RunStandaloneMockService
-
-    def self.call options
-      service_options = {}
-      if options[:log]
-        log = File.open(options[:log], 'w')
-        log.sync = true
-        service_options[:log_file] = log
-      end
-
-      port = options[:port] || FindAPort.available_port
-      mock_service = Consumer::MockService.new(service_options)
-      trap(:INT) { Rack::Handler::WEBrick.shutdown }
-      Rack::Handler::WEBrick.run(mock_service, :Port => port, :AccessLog => [])
-    end
-  end
-
   class SpecCriteria
 
     def self.call

data/lib/pact/consumer/configuration/configuration_extensions.rb

@@ -1,14 +1,65 @@
+require 'pact/configuration'
+require 'pact/doc/markdown/generator'
+
 module Pact
   module Consumer
     module Configuration
 
       module ConfigurationExtensions
+
+        DOC_GENERATORS = { markdown: Pact::Doc::Markdown::Generator }
+
+        def doc_dir
+          @doc_dir ||= File.expand_path("./doc/pacts")
+        end
+
+        def doc_dir= doc_dir
+          @doc_dir = doc_dir
+        end
+
         def add_provider_verification &block
           provider_verifications << block
         end
+
         def provider_verifications
           @provider_verifications ||= []
         end
+
+        def doc_generator= doc_generator
+          doc_generators << begin
+            if DOC_GENERATORS[doc_generator]
+              DOC_GENERATORS[doc_generator]
+            elsif doc_generator.respond_to?(:call)
+              doc_generator
+            else
+              raise "Pact.configuration.doc_generator needs to respond to call, or be in the preconfigured list: #{DOC_GENERATORS.keys}"
+            end
+          end
+        end
+
+        def doc_generators
+          @doc_generators  ||= []
+        end
+
+        def pactfile_write_mode
+          @pactfile_write_mode ||= :overwrite
+          if @pactfile_write_mode == :smart
+            is_rake_running? ? :overwrite : :update
+          else
+            @pactfile_write_mode
+          end
+        end
+
+        def pactfile_write_mode= pactfile_write_mode
+          @pactfile_write_mode = pactfile_write_mode
+        end
+
+        private
+
+        #Would love a better way of determining this! It sure won't work on windows.
+        def is_rake_running?
+          `ps -ef | grep rake | grep #{Process.ppid} | grep -v 'grep'`.size > 0
+        end
       end
     end
   end

data/lib/pact/consumer/configuration/mock_service.rb

@@ -61,7 +61,8 @@ module Pact
             :consumer_name => consumer_name,
             :provider_name => provider_name,
             :pactfile_write_mode => Pact.configuration.pactfile_write_mode,
-            :port => port
+            :port => port,
+            :pact_dir => Pact.configuration.pact_dir
           }
           Pact::Consumer::ConsumerContractBuilder.new consumer_contract_builder_fields
         end

data/lib/pact/consumer/configuration.rb

@@ -6,6 +6,5 @@ require 'pact/consumer/configuration/service_provider'
 require 'pact/consumer/configuration/dsl'
 require 'pact/consumer/configuration/configuration_extensions'
 
-
 Pact.send(:extend, Pact::Consumer::DSL)
 Pact::Configuration.send(:include, Pact::Consumer::Configuration::ConfigurationExtensions)

data/lib/pact/consumer/consumer_contract_builder.rb

@@ -18,7 +18,8 @@ module Pact
         @consumer_contract_details = {
           consumer: {name: attributes[:consumer_name]},
           provider: {name: attributes[:provider_name]},
-          pactfile_write_mode: attributes[:pactfile_write_mode].to_s
+          pactfile_write_mode: attributes[:pactfile_write_mode].to_s,
+          pact_dir: attributes.fetch(:pact_dir)
         }
         @mock_service_client = MockServiceClient.new(attributes[:port])
         @mock_service_base_url = "http://localhost:#{attributes[:port]}"
@@ -35,8 +36,7 @@ module Pact
       def interaction_builder
         @interaction_builder ||=
         begin
-          interaction_builder = InteractionBuilder.new
-          interaction_builder.on_interaction_fully_defined do | interaction |
+          interaction_builder = InteractionBuilder.new do | interaction |
             self.handle_interaction_fully_defined(interaction)
           end
           interaction_builder

data/lib/pact/consumer/interaction_builder.rb

@@ -8,8 +8,9 @@ module Pact
 
       attr_reader :interaction
 
-      def initialize
+      def initialize &block
         @interaction = Interaction.new
+        @callback = block
       end
 
       def upon_receiving description
@@ -28,14 +29,11 @@ module Pact
       end
 
       def will_respond_with(response)
-        interaction.response = response
+        interaction.response = Pact::Response.new(response)
         @callback.call interaction
         self
       end
 
-      def on_interaction_fully_defined &block
-        @callback = block
-      end
     end
   end
 end

data/lib/pact/doc/interaction_view_model.rb

@@ -31,7 +31,7 @@ module Pact
       end
 
       def response_status
-        interaction.response['status']
+        interaction.response.status
       end
 
       def consumer_name
@@ -67,7 +67,10 @@ module Pact
       attr_reader :interaction, :consumer_contract
 
       def clean_request
-        ordered_clean_hash Reification.from_term(interaction.request)
+        reified_request = Reification.from_term(interaction.request)
+        ordered_clean_hash(reified_request).tap do | hash |
+          hash[:body] = reified_request[:body] if reified_request[:body]
+        end
       end
 
       def clean_response
@@ -80,17 +83,17 @@ module Pact
       def ordered_clean_hash source
         ordered_keys.each_with_object({}) do |key, target|
           if source.key? key
-            target[key] = source[key] unless value_is_an_empty_hash_that_is_not_request_body(source[key], key)
+            target[key] = source[key] unless value_is_an_empty_hash(source[key])
           end
         end
       end
 
-      def value_is_an_empty_hash_that_is_not_request_body value, key
-        value.is_a?(Hash) && value.empty? && key != :body
+      def value_is_an_empty_hash value
+        value.is_a?(Hash) && value.empty?
       end
 
       def ordered_keys
-        [:method, :path, :query, :headers, :body, "status", "headers","body"]
+        [:method, :path, :query, :status, :headers, :body]
       end
 
       def remove_key_if_empty key, hash

data/lib/pact/doc/sort_interactions.rb

@@ -9,7 +9,7 @@ module Pact
       private
 
       def self.sortable_id interaction
-        "#{interaction.description.downcase} #{interaction.response['status']} #{(interaction.provider_state || '').downcase}"
+        "#{interaction.description.downcase} #{interaction.response.status} #{(interaction.provider_state || '').downcase}"
       end
 
     end

data/lib/pact/provider/configuration/configuration_extension.rb

@@ -37,15 +37,6 @@ module Pact
           @config_ru_path = config_ru_path
         end
 
-        def color_enabled
-          # Can't use ||= when the variable might be false, it will execute the expression if it's false
-          defined?(@color_enabled) ? @color_enabled : true
-        end
-
-        def color_enabled= color_enabled
-          @color_enabled = color_enabled
-        end
-
         def include mod
           Pact::Provider::State::ProviderStateConfiguredModules.instance_eval do
             include mod

data/lib/pact/provider/rspec.rb

@@ -68,8 +68,10 @@ module Pact
 
           describe description_for(interaction), metadata do
 
+
             describe "with #{interaction.request.method_and_path}" do
 
+
               interaction_context = InteractionContext.new
 
               before do | example |
@@ -87,7 +89,7 @@ module Pact
                 end
               end
 
-              describe_response Pact::Term.unpack_regexps(interaction.response), interaction_context
+              describe_response Pact::Response.new(Pact::Term.unpack_regexps(interaction.response)), interaction_context
 
             end
 
@@ -101,27 +103,27 @@ module Pact
 
             include Pact::RSpec::Matchers
 
-            let(:expected_response_status) { expected_response['status'] }
-            let(:expected_response_body) { expected_response['body'] }
+            let(:expected_response_status) { expected_response.status }
+            let(:expected_response_body) { expected_response.body }
             let(:response) { interaction_context.last_response }
             let(:response_status) { response.status }
             let(:response_body) { parse_body_from_response(response) }
             let(:differ) { Pact.configuration.body_differ_for_content_type diff_content_type }
             let(:diff_formatter) { Pact.configuration.diff_formatter_for_content_type diff_content_type }
-            let(:expected_content_type) { Pact::Headers.new(expected_response['headers'] || {})['Content-Type'] }
+            let(:expected_content_type) { Pact::Headers.new(expected_response.headers || {})['Content-Type'] }
             let(:actual_content_type) { response.headers['Content-Type']}
             let(:diff_content_type) { String === expected_content_type ? expected_content_type : actual_content_type } # expected_content_type may be a Regexp
             let(:diff_options) { { with: differ, diff_formatter: diff_formatter } }
 
-            if expected_response['status']
-              it "has status code #{expected_response['status']}" do
+            if expected_response.status
+              it "has status code #{expected_response.status}" do
                 expect(response_status).to eql expected_response_status
               end
             end
 
-            if expected_response['headers']
+            if expected_response.headers
               describe "includes headers" do
-                expected_response['headers'].each do |name, expected_header_value|
+                expected_response.headers.each do |name, expected_header_value|
                   it "\"#{name}\" with value #{expected_header_value.inspect}" do
                     header_value = response.headers[name]
                     expect(header_value).to match_header(name, expected_header_value)
@@ -130,7 +132,7 @@ module Pact
               end
             end
 
-            if expected_response['body']
+            if expected_response.body
               it "has a matching body" do
                 expect(response_body).to match_term expected_response_body, diff_options
               end

data/lib/pact/version.rb

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

data/lib/pact.rb

@@ -1,5 +1,6 @@
-require_relative 'pact/version'
-require_relative 'pact/configuration'
-require_relative 'pact/consumer'
-require_relative 'pact/provider'
-require_relative 'pact/consumer_contract'
+require 'pact/support'
+require 'pact/version'
+require 'pact/configuration'
+require 'pact/consumer'
+require 'pact/provider'
+require 'pact/consumer_contract'

data/pact.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   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.}
   gem.homepage      = "https://github.com/realestate-com-au/pact"
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files bin lib pact.gemspec CHANGELOG.md LICENSE.txt`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
@@ -28,11 +28,15 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'webrick'
   gem.add_runtime_dependency 'term-ansicolor', '~> 1.0'
 
+  gem.add_runtime_dependency 'pact-support', '~> 0.1.2'
+  gem.add_runtime_dependency 'pact-mock_service', '~> 0.2.0'
+
   gem.add_development_dependency 'rake', '~> 10.0.3'
   gem.add_development_dependency 'webmock', '~> 1.18.0'
   gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'fakefs', '~> 0.4'
+  gem.add_development_dependency 'fakefs', '0.5' # 0.6.0 blows up
   gem.add_development_dependency 'hashie', '~> 2.0'
   gem.add_development_dependency 'activesupport'
   gem.add_development_dependency 'faraday'
+  gem.add_development_dependency 'appraisal'
 end