pact 1.3.3 → 1.4.0.rc2

data/CHANGELOG.md

@@ -2,6 +2,21 @@ Do this to generate your change history
 
   git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+### 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 +50,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/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pact.gemspec
 gemspec
+
+if ENV['X_PACT_DEVELOPMENT']
+  gem "pact-support", path: '../pact-support'
+  gem "pact-mock_service", path: '../pact-mock_service'
+end

data/Gemfile.lock

@@ -1,10 +1,12 @@
 PATH
   remote: .
   specs:
-    pact (1.3.3)
+    pact (1.4.0.rc2)
       awesome_print (~> 1.1)
       find_a_port (~> 1.0.1)
       json
+      pact-mock_service (~> 0.0.1)
+      pact-support (~> 0.0.2)
       rack-test (~> 0.6.2)
       randexp (~> 0.1.7)
       rspec (>= 2.14)
@@ -37,6 +39,25 @@ GEM
     method_source (0.8.2)
     minitest (5.3.4)
     multipart-post (2.0.0)
+    pact-mock_service (0.0.1)
+      awesome_print (~> 1.1)
+      find_a_port (~> 1.0.1)
+      json
+      rack
+      rack-test (~> 0.6.2)
+      rspec (>= 2.14)
+      term-ansicolor (~> 1.0)
+      thor
+      webrick
+    pact-support (0.0.2)
+      awesome_print (~> 1.1)
+      find_a_port (~> 1.0.1)
+      json
+      rack-test (~> 0.6.2)
+      randexp (~> 0.1.7)
+      rspec (>= 2.14)
+      term-ansicolor (~> 1.0)
+      thor
     pry (0.10.0)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
@@ -46,25 +67,25 @@ GEM
       rack (>= 1.0)
     rake (10.0.4)
     randexp (0.1.7)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.6)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.4)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
     safe_yaml (1.0.3)
     slop (3.5.0)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     thor (0.19.1)
     thread_safe (0.3.4)
-    tins (1.3.2)
+    tins (1.3.3)
     tzinfo (1.2.1)
       thread_safe (~> 0.1)
     webmock (1.18.0)

data/README.md

@@ -59,7 +59,7 @@ Put it in your Gemfile. You know how.
 
 ### Service Consumer project
 
-#### 1. Start with you model
+#### 1. Start with your model
 
 Imagine a model class that looks something like this. The attributes for a Something live on a remote server, and will need to be retrieved by an HTTP call.
 
@@ -95,7 +95,7 @@ end
 ```
 #### 3. Configure the mock server
 
-The following code will create a mock service on localhost:1234 which will respond to your application's queries over HTTP as if it were the real "My Service Provider" app. It also creats a mock service provider object which you will use to set up your expectations. The method name to access the mock service provider will be what ever name you give as the service argument - in this case "my_service_provider"
+The following code will create a mock service on localhost:1234 which will respond to your application's queries over HTTP as if it were the real "My Service Provider" app. It also creates a mock service provider object which you will use to set up your expectations. The method name to access the mock service provider will be what ever name you give as the service argument - in this case "my_service_provider"
 
 
 ```ruby
@@ -256,6 +256,7 @@ As in all things, there are good ways to implement Pacts, and there are not so g
 * [Provider States](https://github.com/realestate-com-au/pact/wiki/Provider-states)
 * [Verifying pacts](https://github.com/realestate-com-au/pact/wiki/Verifying-pacts)
 * [Sharing pacts between consumer and provider](https://github.com/realestate-com-au/pact/wiki/Sharing-pacts-between-consumer-and-provider)
+* [Regular expressions and type matching with Pact](https://github.com/realestate-com-au/pact/wiki/Regular-expressions-and-type-matching-with-Pact)
 * [Frequently asked questions](https://github.com/realestate-com-au/pact/wiki/FAQ)
 * [Rarely asked questions](https://github.com/realestate-com-au/pact/wiki/RAQ)
 * [Best practices](https://github.com/realestate-com-au/pact/wiki/Best-practices)

data/example/animal-service/lib/animal_service/api.rb

@@ -1,5 +1,6 @@
 require 'sinatra/base'
 require_relative 'animal_repository'
+require 'json'
 
 module AnimalService
 

data/example/zoo-app/lib/zoo_app/animal_service_client.rb

@@ -7,15 +7,6 @@ module ZooApp
     include HTTParty
     base_uri 'animal-service.com'
 
-    def self.find_alligators
-      response = get("/alligators", :headers => {'Accept' => 'application/json'})
-      handle_response response do
-        parse_body(response).collect do | hash |
-          ZooApp::Animals::Alligator.new(hash)
-        end
-      end
-    end
-
     def self.find_alligator_by_name name
       response = get("/alligators/#{name}", :headers => {'Accept' => 'application/json'})
       when_successful(response) do

data/example/zoo-app/lib/zoo_app/models/alligator.rb

@@ -1,7 +1,9 @@
 module ZooApp
   module Animals
     class Alligator
+
       attr_reader :name
+
       def initialize attributes
         @name = attributes[:name]
       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/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.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/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/consumer_contract_builder.rb

@@ -35,8 +35,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
@@ -33,9 +34,6 @@ module Pact
         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/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