pact_broker 1.9.3 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1822a1c9b39785852ced69a22fd88a124a894e06
-  data.tar.gz: 17276a5d6ea111fd01b5766d3246154a59ab1a60
+  metadata.gz: df97d13a663699e7a3eb4d7f58cc7abe8a1012d2
+  data.tar.gz: 319a6de81120c2bc7d627fbc2255caf51da2e742
 SHA512:
-  metadata.gz: a74a5d53bc9b238c522190b2b6039b66c2af41ab2f8a7d900c2e12ea9e008788223d852285bf7e71c381f333679c047f48dcfbc59f1295cccd5326903fda85a3
-  data.tar.gz: a45265e6cafa287a32fc6f31b257d4efc63bcfcf907cc9cb7808f1c35af11d342aa5caf3ff1ad766c7155af390b92e921f974b80dd53151ebcd96491213e3c4f
+  metadata.gz: 0130cac31b2abaebf71905c841d136a0e6d7fcf4e00186c3e33afb2fda2a8ce4fddceb5fcfe4cd5de9b0650bf6eb8d5cec1f33c422bf17af36292f01665e253b
+  data.tar.gz: 3a7f9c3663de5c1b1143608727321f97a40af7737d3868034e9bff1b2cfbb86ec131731667963f173484057bd118c6b84f32ca41fa22101f8f2542aaa34e1e56

data/CHANGELOG.md

@@ -2,6 +2,9 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)' vX.Y.Z..HEAD
 
+#### 1.10.0 (2016-08-01)
+* efdde13 - Add ability to merge pacts via PATCH requests (Steve Pletcher, Thu Jul 28 16:29:22 2016 -0400)
+
 #### 1.9.3 (2016-06-27)
 * f57db36 - Clarify that pact_broker will only work with ruby >= 2.0 (Sergei Matheson, Mon Jun 27 11:06:40 2016 +1000)
 * a1742b8 - Correct release instructions (Sergei Matheson, Mon Jun 27 11:03:03 2016 +1000)

data/example/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
-gem "pact_broker", "~>1.4"
+gem "pact_broker", "~>1.9.3"
 gem "sqlite3" # Replace with your choice of database driver eg. gem "pg"
-gem "thin" # Keep, or replace with your choice of web server
+gem "thin" # Keep, or replace with your choice of web server

data/lib/pact_broker/api/resources/pact.rb

@@ -6,6 +6,14 @@ require 'pact_broker/json'
 require 'pact_broker/pacts/pact_params'
 require 'pact_broker/api/contracts/put_pact_params_contract'
 
+module Webmachine
+  class Request
+    def patch?
+      method == "PATCH"
+    end
+  end
+end
+
 module PactBroker
 
   module Api
@@ -24,7 +32,11 @@ module PactBroker
         end
 
         def allowed_methods
-          ["GET", "PUT", "DELETE"]
+          ["GET", "PUT", "DELETE", "PATCH"]
+        end
+
+        def known_methods
+          super + ['PATCH']
         end
 
         def is_conflict?
@@ -32,8 +44,8 @@ module PactBroker
         end
 
         def malformed_request?
-          if request.put?
-            return invalid_json? ||
+          if request.patch? || request.put?
+            invalid_json? ||
               contract_validation_errors?(Contracts::PutPactParamsContract.new(pact_params))
           else
             false
@@ -41,12 +53,18 @@ module PactBroker
         end
 
         def resource_exists?
-          pact
+          !!pact
         end
 
         def from_json
           response_code = pact ? 200 : 201
-          @pact = pact_service.create_or_update_pact(pact_params)
+
+          if request.patch? && resource_exists?
+            @pact = pact_service.merge_pact(pact_params)
+          else
+            @pact = pact_service.create_or_update_pact(pact_params)
+          end
+
           response.body = to_json
           response_code
         end
@@ -73,4 +91,4 @@ module PactBroker
       end
     end
   end
-end
+end

data/lib/pact_broker/api/resources/pacticipant.rb

@@ -67,4 +67,4 @@ module PactBroker
     end
 
   end
-end
+end

data/lib/pact_broker/pacts/merger.rb

@@ -0,0 +1,53 @@
+require 'json'
+
+module PactBroker
+  module Pacts
+    module Merger
+
+      extend self
+
+      # Accepts two hashes representing pacts, outputs a merged hash
+      # Does not make any guarantees about order of interactions
+      def merge_pacts original_json, additional_json
+        original, additional = [original_json, additional_json].map{|str| JSON.parse(str, PACT_PARSING_OPTIONS) }
+
+        new_pact = original
+
+        additional["interactions"].each do |new_interaction|
+          # check to see if this interaction matches an existing interaction
+          overwrite_index = original["interactions"].find_index do |original_interaction|
+            matching_request?(original_interaction, new_interaction)
+          end
+
+          # overwrite existing interaction if a match is found, otherwise appends the new interaction
+          if overwrite_index
+            new_pact["interactions"][overwrite_index] = new_interaction
+          else
+            new_pact["interactions"] << new_interaction
+          end
+        end
+
+        new_pact.to_json
+      end
+
+      private
+
+      def matching_request? original_interaction, new_interaction
+        same_description_and_state?(original_interaction, new_interaction) &&
+          same_request_properties?(original_interaction["request"], new_interaction["request"])
+      end
+
+      def same_description_and_state? original, additional
+        original["description"] == additional["description"] &&
+          original["provider_state"] == additional["provider_state"]
+      end
+
+      def same_request_properties? original, additional
+        method_matches = original["method"] == additional["method"]
+        path_matches = original["path"] == additional["path"]
+
+        method_matches && path_matches && original["headers"] == additional["headers"]
+      end
+    end
+  end
+end

data/lib/pact_broker/pacts/service.rb

@@ -1,6 +1,7 @@
 require 'pact_broker/repositories'
 require 'pact_broker/services'
 require 'pact_broker/logging'
+require 'pact_broker/pacts/merger'
 
 module PactBroker
   module Pacts
@@ -42,6 +43,17 @@ module PactBroker
         end
       end
 
+      def merge_pact params
+        provider = pacticipant_repository.find_by_name_or_create params[:provider_name]
+        consumer = pacticipant_repository.find_by_name_or_create params[:consumer_name]
+        consumer_version = version_repository.find_by_pacticipant_id_and_number_or_create consumer.id, params[:consumer_version_number]
+        existing_pact = pact_repository.find_by_version_and_provider(consumer_version.id, provider.id)
+
+        params.merge!(json_content: Merger.merge_pacts(params[:json_content], existing_pact.json_content))
+
+        update_pact params, existing_pact
+      end
+
       def find_all_pact_versions_between consumer, options
         pact_repository.find_all_pact_versions_between consumer, options
       end
@@ -102,7 +114,6 @@ module PactBroker
           webhook_service.execute_webhooks pact
         end
       end
-
     end
   end
-end
+end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '1.9.3'
+  VERSION = '1.10.0'
 end

data/spec/features/merge_pact_spec.rb

@@ -0,0 +1,55 @@
+require 'spec/support/provider_state_builder'
+
+describe "Merging a pact" do
+
+  let(:pact_content) { load_fixture('a_consumer-a_provider.json') }
+  let(:path) { "/pacts/provider/A%20Provider/consumer/A%20Consumer/version/1.2.3" }
+  let(:response_body_json) { JSON.parse(subject.body) }
+
+  subject do
+    patch path, pact_content, {'CONTENT_TYPE' => 'application/json' }; last_response
+  end
+
+  context "when a pact for this consumer version does not exist" do
+    it "returns a 201 Created" do
+      expect(subject.status).to be 201
+    end
+
+    it "returns a json body" do
+      expect(subject.headers['Content-Type']).to eq "application/json;charset=utf-8"
+    end
+
+    it "returns the pact in the body" do
+      expect(response_body_json).to include JSON.parse(pact_content)
+    end
+  end
+
+  context "when a pact for this consumer version does exist" do
+    let(:existing_pact_content) { load_fixture('a_consumer-a_provider-2.json') }
+    let(:merged_pact_content) { load_fixture('a_consumer-a_provider-merged.json') }
+
+    before do
+      ProviderStateBuilder.new.create_pact_with_hierarchy "A Consumer", "1.2.3", "A Provider", existing_pact_content
+    end
+
+    it "returns a 200 Success" do
+      expect(subject.status).to be 200
+    end
+
+    it "returns an application/json Content-Type" do
+      expect(subject.headers['Content-Type']).to eq "application/json;charset=utf-8"
+    end
+
+    it "returns the merged pact in the response body" do
+      expect(response_body_json).to contain_hash JSON.parse(merged_pact_content)
+    end
+  end
+
+  context "when the pacticipant names in the path do not match those in the pact" do
+    let(:path) { "/pacts/provider/Another%20Provider/consumer/A%20Consumer/version/1.2.3" }
+
+    it "returns a json error response" do
+      expect(subject).to be_a_json_error_response "does not match"
+    end
+  end
+end

data/spec/fixtures/a_consumer-a_provider-merged.json

@@ -0,0 +1,34 @@
+{
+  "consumer": {
+    "name": "A Consumer"
+  },
+  "provider": {
+    "name": "A Provider"
+  },
+  "interactions": [
+    {
+      "description" : "a request for something",
+      "provider_state": null,
+      "request": {
+        "method": "post",
+        "path" : "/something"
+      },
+      "response": {
+        "status": 200,
+        "body" : "something"
+      }
+    },
+    {
+      "description" : "a request for something",
+      "provider_state": null,
+      "request": {
+        "method": "get",
+        "path" : "/something"
+      },
+      "response": {
+        "status": 200,
+        "body" : "something"
+      }
+    }
+  ]
+}

data/spec/lib/pact_broker/api/resources/pact_spec.rb

@@ -14,9 +14,8 @@ module PactBroker::Api
       let(:app) { PactBroker::API }
       let(:json) { {some: 'json'}.to_json }
 
-      describe "PUT" do
-
-        subject { put "/pacts/provider/Provider/consumer/Consumer/version/1.2", json, {'CONTENT_TYPE' => "application/json"} ; last_response }
+      shared_examples "an update endpoint" do |http_method|
+        subject { self.send http_method, "/pacts/provider/Provider/consumer/Consumer/version/1.2", json, {'CONTENT_TYPE' => "application/json"} ; last_response }
 
         let(:response) { subject; last_response }
 
@@ -76,7 +75,14 @@ module PactBroker::Api
             expect(response.body).to eq "message1\nmessage2"
           end
         end
+      end
+
+      describe "PUT" do
+        it_behaves_like "an update endpoint", :put
+      end
 
+      describe "PATCH" do
+        it_behaves_like "an update endpoint", :patch
       end
 
       describe "DELETE" do

data/spec/lib/pact_broker/pacts/merger_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+require 'spec/support/provider_state_builder'
+require 'pact_broker/pacts/merger'
+require 'json'
+
+module PactBroker
+  module Pacts
+    describe Merger do
+      let(:example_pact) { load_json_fixture('consumer-provider.json') }
+      let(:example_interaction) do
+        {
+          "description" => "some description",
+          "provider_state" => nil,
+          "request" => {
+            "method" => "get",
+            "path" => "/cash_money",
+            "headers" => {
+              "Content-Type" => "application/json"
+            }
+          },
+          "response" => {
+            "status" => 200,
+            "body" => "$$$$$$$$",
+            "headers" => {
+              "Content-Type" => "application/json"
+            }
+          }
+        }
+      end
+
+      before :each do
+        @pact_to_merge = load_json_fixture('consumer-provider.json')
+      end
+
+      it "merges two pacts" do
+        @pact_to_merge["interactions"] << example_interaction
+        result = merge_pacts(example_pact, @pact_to_merge)
+        expect(result["interactions"]).to match_array(example_pact["interactions"].push(example_interaction))
+      end
+
+      it "is idempotent" do
+        @pact_to_merge["interactions"] << example_interaction
+        first_result = merge_pacts(example_pact, @pact_to_merge)
+        second_result = merge_pacts(first_result, @pact_to_merge)
+        expect(first_result).to contain_hash second_result
+      end
+
+      it "overwrites identical interactions" do
+        @pact_to_merge["interactions"][0]["response"]["body"] = "changed!"
+        result = merge_pacts(example_pact, @pact_to_merge)
+
+        expect(result["interactions"].length).to eq example_pact["interactions"].length
+        expect(result["interactions"].first["response"]["body"]).to eq "changed!"
+      end
+
+      it "appends interactions with a different provider state" do
+        @pact_to_merge["interactions"][0]["provider_state"] = "upside down"
+
+        result = merge_pacts(example_pact, @pact_to_merge)
+        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
+      end
+
+      it "appends interactions with a different description" do
+        @pact_to_merge["interactions"][0]["description"] = "getting $$$"
+
+        result = merge_pacts(example_pact, @pact_to_merge)
+        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
+      end
+
+      it "appends interactions with a different request method" do
+        @pact_to_merge["interactions"][0]["request"]["method"] = "delete"
+
+        result = merge_pacts(example_pact, @pact_to_merge)
+        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
+      end
+
+      it "appends interactions with a different request path" do
+        @pact_to_merge["interactions"][0]["request"]["path"] = "/decrypt_all_passwords"
+
+        result = merge_pacts(example_pact, @pact_to_merge)
+        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
+      end
+
+      it "appends interactions which have additional request headers in the new pact" do
+        @pact_to_merge["interactions"][0]["request"]["headers"] = { "Accept" => "script/javascript" }
+
+        result = merge_pacts(example_pact, @pact_to_merge)
+        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
+      end
+
+      it "appends interactions with different request headers" do
+        example_pact["interactions"][0]["request"]["headers"] = { "Content-Type" => "script/javascript" }
+        @pact_to_merge["interactions"][0]["request"]["headers"] = { "Content-Type" => "ayy/lmao" }
+
+        result = merge_pacts(example_pact, @pact_to_merge)
+        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
+      end
+
+      it "appends interactions with fewer request headers" do
+        example_pact["interactions"][0]["request"]["headers"] = { "Content-Type" => "script/javascript" }
+
+        result = merge_pacts(example_pact, @pact_to_merge)
+        expect(result["interactions"].length).to eq example_pact["interactions"].length + 1
+      end
+
+      # helper that lets these specs deal with hashes instead of JSON strings
+      def merge_pacts(a, b, return_hash = true)
+        result = PactBroker::Pacts::Merger.merge_pacts(a.to_json, b.to_json)
+
+        return_hash ? JSON.parse(result) : result
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/pacts/service_spec.rb

@@ -66,4 +66,4 @@ module PactBroker
 
     end
   end
-end
+end

data/spec/support/rspec_match_hash.rb

@@ -0,0 +1,25 @@
+# checks if actual contains all the key-value pairs that expected does,
+# ignoring order for any child arrays
+RSpec::Matchers.define :contain_hash do |expected|
+  match do |actual|
+    contains_hash?(expected, actual)
+  end
+end
+
+
+def contains_hash?(expected, actual)
+  expected.all? do |key, value|
+    unordered_match(actual[key], value)
+  end
+end
+
+def unordered_match(expected, actual)
+  case
+  when [expected, actual].all?{|val| val.is_a? Array }
+    expected.all?{|el| actual.include? el }
+  when [expected, actual].all?{|val| val.is_a? Hash }
+    contains_hash?(expected, actual)
+  else
+    expected == actual
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 1.9.3
+  version: 1.10.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -498,6 +498,7 @@ files:
 - lib/pact_broker/pacts/diff.rb
 - lib/pact_broker/pacts/latest_pacts.rb
 - lib/pact_broker/pacts/latest_tagged_pacts.rb
+- lib/pact_broker/pacts/merger.rb
 - lib/pact_broker/pacts/pact_params.rb
 - lib/pact_broker/pacts/pact_version_content.rb
 - lib/pact_broker/pacts/repository.rb
@@ -575,10 +576,12 @@ files:
 - spec/features/get_previous_distinct_version.rb
 - spec/features/get_provider_pacts.rb
 - spec/features/get_version.rb
+- spec/features/merge_pact_spec.rb
 - spec/features/publish_not_a_pact_spec.rb
 - spec/features/publish_pact_spec.rb
 - spec/features/update_pacticipant_spec.rb
 - spec/fixtures/a_consumer-a_provider-2.json
+- spec/fixtures/a_consumer-a_provider-merged.json
 - spec/fixtures/a_consumer-a_provider.json
 - spec/fixtures/consumer-provider.json
 - spec/fixtures/renderer_pact.json
@@ -630,6 +633,7 @@ files:
 - spec/lib/pact_broker/pacticipants/find_potential_duplicate_pacticipant_names_spec.rb
 - spec/lib/pact_broker/pacts/create_formatted_diff_spec.rb
 - spec/lib/pact_broker/pacts/diff_spec.rb
+- spec/lib/pact_broker/pacts/merger_spec.rb
 - spec/lib/pact_broker/pacts/pact_params_spec.rb
 - spec/lib/pact_broker/pacts/repository_spec.rb
 - spec/lib/pact_broker/pacts/service_spec.rb
@@ -653,6 +657,7 @@ files:
 - spec/support/database_cleaner.rb
 - spec/support/fixture_helpers.rb
 - spec/support/provider_state_builder.rb
+- spec/support/rspec_match_hash.rb
 - spec/support/shared_examples_for_responses.rb
 - tasks/database.rb
 - tasks/db.rake
@@ -728,10 +733,12 @@ test_files:
 - spec/features/get_previous_distinct_version.rb
 - spec/features/get_provider_pacts.rb
 - spec/features/get_version.rb
+- spec/features/merge_pact_spec.rb
 - spec/features/publish_not_a_pact_spec.rb
 - spec/features/publish_pact_spec.rb
 - spec/features/update_pacticipant_spec.rb
 - spec/fixtures/a_consumer-a_provider-2.json
+- spec/fixtures/a_consumer-a_provider-merged.json
 - spec/fixtures/a_consumer-a_provider.json
 - spec/fixtures/consumer-provider.json
 - spec/fixtures/renderer_pact.json
@@ -783,6 +790,7 @@ test_files:
 - spec/lib/pact_broker/pacticipants/find_potential_duplicate_pacticipant_names_spec.rb
 - spec/lib/pact_broker/pacts/create_formatted_diff_spec.rb
 - spec/lib/pact_broker/pacts/diff_spec.rb
+- spec/lib/pact_broker/pacts/merger_spec.rb
 - spec/lib/pact_broker/pacts/pact_params_spec.rb
 - spec/lib/pact_broker/pacts/repository_spec.rb
 - spec/lib/pact_broker/pacts/service_spec.rb
@@ -806,4 +814,5 @@ test_files:
 - spec/support/database_cleaner.rb
 - spec/support/fixture_helpers.rb
 - spec/support/provider_state_builder.rb
+- spec/support/rspec_match_hash.rb
 - spec/support/shared_examples_for_responses.rb