pact_broker 2.88.0 → 2.89.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b886a748e8133256c6b1a48f018263b18abe3e907878bd659941529791052b72
-  data.tar.gz: a236b15253a54764939b260d80aa77e1c3635448ce486606f6013df9f864029d
+  metadata.gz: fb2a319d08e394deac2b0ddab3c97cb09e3ef17025daebe82e54a30577a049b6
+  data.tar.gz: b3767941da7f343cff6b14ddeca1398bb86e492b84d2447d03e59658c7d1ae31
 SHA512:
-  metadata.gz: cededddf5b3eacacd0bc3347bb3350156d2acb5bd29bfd0f43b2a234470ec7a592f4a0b41c167d47f9ec25815092d5bdde16d688b4ded08cce6c1c57008683b3
-  data.tar.gz: 683226ee8e28b2055a0e99623c7b2fbbb0bc959308eee60d00f5f255a23411331818c236082f23f56ac4752bd32b63fbe37a702747ce99300e3980dbaa5d4262
+  metadata.gz: 4373701434b40c1529c20469d860e352ffb32a100b22a2ea6774c7579ddc4a30956fc7879b1fb3f58d0e6676116cbb7ac504648178a28513b684056918e3818a
+  data.tar.gz: a2f2b2d4b5ffb90e4ed31394d47a8a05aa75e90d2329f22cad4092930097f5958f6ccbd53ebb499c05d375bc980de62ddaf31252bd58d22ed9ff09911da106c7

data/.github/workflows/release_gem.yml

@@ -35,7 +35,7 @@ jobs:
     needs: release
     strategy:
       matrix:
-        repository: [pact-foundation/pact-broker-docker, DiUS/pact_broker-docker]
+        repository: [pact-foundation/pact-broker-docker, DiUS/pact_broker-docker, pact-foundation/pact_broker]
     runs-on: ubuntu-latest
     steps:
       - name: Notify ${{ matrix.repository }} of gem release

data/.github/workflows/trigger_pact_docs_update.yml

@@ -9,6 +9,7 @@ on:
   repository_dispatch:
     types:
       - gem-released
+  workflow_dispatch:
 
 jobs:
   build:

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+<a name="v2.89.0"></a>
+### v2.89.0 (2021-10-15)
+
+#### Features
+
+* add applicationInstance to deployed version resource as a replacement for target	 ([9bfafc8a](/../../commit/9bfafc8a))
+* apply allow_dangerous_contract_modification setting when publishing using the /contracts/publish endpoint	 ([956227fe](/../../commit/956227fe))
+* add support for matchingBranch property in consumer version selectors	 ([48068d29](/../../commit/48068d29))
+
+#### Bug Fixes
+
+* set missing provider branch name parameter for contract_requiring_verification_published webhooks	 ([777ccdd2](/../../commit/777ccdd2))
+* correct misnamed database port configuration property causing the PACT_BROKER_DATABASE_PORT not to be respected	 ([3d14013a](/../../commit/3d14013a))
+
 <a name="v2.88.0"></a>
 ### v2.88.0 (2021-10-11)
 

data/docs/CONFIGURATION.md

@@ -1,7 +1,7 @@
 # Pact Broker Configuration
 
 
-<!-- This is a generated file. Please do not edit it directly. -->
+<!-- This is a generated file. Please do not edit it directly. The source is https://github.com/pact-foundation/pact_broker/blob/master/docs/configuration.yml -->
 
 The Pact Broker supports configuration via environment variables or a YAML file from version 2.87.0.1 of the Docker images.
 

data/lib/pact_broker/api/contracts/pacts_for_verification_json_query_schema.rb

@@ -15,7 +15,7 @@ module PactBroker
         using PactBroker::HashRefinements
         using PactBroker::StringRefinements
 
-        BRANCH_KEYS = [:latest, :tag, :fallbackTag, :branch, :fallbackBranch]
+        BRANCH_KEYS = [:latest, :tag, :fallbackTag, :branch, :fallbackBranch, :matchingBranch]
         ENVIRONMENT_KEYS = [:environment, :deployed, :released, :deployedOrReleased]
         ALL_KEYS = BRANCH_KEYS + ENVIRONMENT_KEYS
 
@@ -36,6 +36,7 @@ module PactBroker
               optional(:mainBranch).filled(included_in?: [true])
               optional(:tag).filled(:str?)
               optional(:branch).filled(:str?)
+              optional(:matchingBranch).filled(included_in?: [true])
               optional(:latest).filled(included_in?: [true, false])
               optional(:fallbackTag).filled(:str?)
               optional(:fallbackBranch).filled(:str?)
@@ -65,7 +66,7 @@ module PactBroker
           # This is a ducking joke. Need to get rid of dry-validation
           if params[:consumerVersionSelectors].is_a?(Array)
             errors = params[:consumerVersionSelectors].each_with_index.flat_map do | selector, index |
-              validate_consumer_version_selector(selector, index)
+              validate_consumer_version_selector(selector, index, params)
             end
             if errors.any?
               results[:consumerVersionSelectors] ||= []
@@ -82,7 +83,7 @@ module PactBroker
         # when setting the branch, it doesn't make sense to verify all pacts for a branch,
         # so latest is not required, but cannot be set to false
         # rubocop: disable Metrics/CyclomaticComplexity, Metrics/MethodLength
-        def self.validate_consumer_version_selector(selector, index)
+        def self.validate_consumer_version_selector(selector, index, params)
           errors = []
 
           if selector[:fallbackTag] && !selector[:latest]
@@ -97,17 +98,22 @@ module PactBroker
               not_provided?(selector[:tag]) &&
               not_provided?(selector[:branch]) &&
               not_provided?(selector[:environment]) &&
+              selector[:matchingBranch] != true &&
               selector[:deployed] != true &&
               selector[:released] != true &&
               selector[:deployedOrReleased] != true &&
               selector[:latest] != true
-            errors << "must specify a value for environment or tag or branch, or specify mainBranch=true, latest=true, deployed=true, released=true or deployedOrReleased=true (at index #{index})"
+            errors << "must specify a value for environment or tag or branch, or specify mainBranch=true, matchingBranch=true, latest=true, deployed=true, released=true or deployedOrReleased=true (at index #{index})"
           end
 
           if selector[:mainBranch] && selector.slice(*ALL_KEYS - [:consumer, :mainBranch]).any?
             errors << "cannot specify mainBranch=true with any other criteria apart from consumer (at index #{index})"
           end
 
+          if selector[:matchingBranch] && selector.slice(*ALL_KEYS - [:consumer, :matchingBranch]).any?
+            errors << "cannot specify matchingBranch=true with any other criteria apart from consumer (at index #{index})"
+          end
+
           if selector[:tag] && selector[:branch]
             errors << "cannot specify both a tag and a branch (at index #{index})"
           end
@@ -136,6 +142,10 @@ module PactBroker
             errors << "cannot specify both released=true and deployedOrReleased=true (at index #{index})"
           end
 
+          if selector[:matchingBranch] && not_provided?(params[:providerVersionBranch])
+            errors << "the providerVersionBranch must be specified when the selector matchingBranch=true is used (at index #{index})"
+          end
+
           non_environment_fields = selector.slice(*BRANCH_KEYS).keys.sort
           environment_related_fields = selector.slice(*ENVIRONMENT_KEYS).keys.sort
 

data/lib/pact_broker/api/decorators/deployed_version_decorator.rb

@@ -9,7 +9,8 @@ module PactBroker
       class DeployedVersionDecorator < BaseDecorator
         property :uuid
         property :currently_deployed, camelize: true
-        property :target, camelize: true
+        property :target, camelize: true # deprecated
+        property :applicationInstance, getter: lambda { |_| target }
         include Timestamps
         property :undeployedAt, getter: lambda { |_|  undeployed_at ? FormatDateTime.call(undeployed_at) : nil }, writeable: false
 

data/lib/pact_broker/api/decorators/pacts_for_verification_query_decorator.rb

@@ -21,6 +21,10 @@ module PactBroker
             represented.branch = fragment
             represented.latest = true
           }
+          property :matching_branch, setter: -> (fragment:, represented:, **) {
+            represented.matching_branch = fragment
+            represented.latest = true
+          }
           property :latest,
             setter: ->(fragment:, represented:, **) {
               represented.latest = (fragment == "true" || fragment == true)
@@ -53,6 +57,9 @@ module PactBroker
           result = super(hash&.snakecase_keys)
 
           result.consumer_version_selectors = split_out_deployed_or_released_selectors(result.consumer_version_selectors)
+          if result.provider_version_branch
+            result.consumer_version_selectors = set_branch_for_matching_branch_selectors(result.consumer_version_selectors, result.provider_version_branch)
+          end
 
           if result.consumer_version_selectors && !result.consumer_version_selectors.is_a?(PactBroker::Pacts::Selectors)
             result.consumer_version_selectors = PactBroker::Pacts::Selectors.new(result.consumer_version_selectors)
@@ -62,6 +69,17 @@ module PactBroker
 
         private
 
+        def set_branch_for_matching_branch_selectors(consumer_version_selectors, provider_version_branch)
+          consumer_version_selectors.collect do | consumer_version_selector |
+            if consumer_version_selector[:matching_branch]
+              consumer_version_selector[:branch] = provider_version_branch
+              consumer_version_selector
+            else
+              consumer_version_selector
+            end
+          end
+        end
+
         def split_out_deployed_or_released_selectors(consumer_version_selectors)
           consumer_version_selectors.flat_map do | selector |
             if selector.currently_deployed && selector.currently_supported

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

@@ -60,7 +60,9 @@ module PactBroker
           query = Rack::Utils.parse_query(request.env["QUERY_STRING"])
           q = {}
           q[:pacticipant_name] = request.query["pacticipant"] if query["pacticipant"]
-          if query["target"]
+          if query["applicationInstance"]
+            q[:target] = query["applicationInstance"].blank? ? nil : query["applicationInstance"]
+          elsif query["target"]
             q[:target] = query["target"].blank? ? nil : query["target"]
           end
           q

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

@@ -30,7 +30,7 @@ module PactBroker
         end
 
         def from_json
-          @deployed_version = deployed_version_service.find_or_create(deployed_version_uuid, version, environment, target)
+          @deployed_version = deployed_version_service.find_or_create(deployed_version_uuid, version, environment, application_instance)
           response.headers["Location"] = deployed_version_url(deployed_version, base_url)
           response.body = decorator_class(:deployed_version_decorator).new(deployed_version).to_json(decorator_options)
         end
@@ -72,8 +72,9 @@ module PactBroker
         end
 
         # TODO disallow an empty string because that is used as a NULL indicator in the database
-        def target
-          params(default: {})[:target]&.to_s
+        def application_instance
+          parameters = params(default: {})
+          (parameters[:applicationInstance] || parameters[:target])&.to_s
         end
 
         def title

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

@@ -110,7 +110,7 @@ module PactBroker
 
         def disallowed_modification?
           if request.really_put? && pact_service.disallowed_modification?(pact, pact_params.json_content)
-            message_params = { consumer_name: pact_params.consumer_name, consumer_version_number: pact_params.consumer_version_number }
+            message_params = { consumer_name: pact_params.consumer_name, consumer_version_number: pact_params.consumer_version_number, provider_name: pact_params.provider_name }
             set_json_error_message(message("errors.validation.pact_content_modification_not_allowed", message_params))
             true
           else

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

@@ -31,11 +31,13 @@ module PactBroker
         end
 
         def process_post
-          handle_webhook_events(consumer_version_branch: parsed_contracts.branch, build_url: parsed_contracts.build_url) do
-            results = contract_service.publish(parsed_contracts, base_url: base_url)
-            response.body = decorator_class(:publish_contracts_results_decorator).new(results).to_json(decorator_options)
+          if conflict_notices.any?
+            set_conflict_response
+            409
+          else
+            publish_contracts
+            true
           end
-          true
         end
 
         def policy_name
@@ -75,6 +77,27 @@ module PactBroker
             contract["decodedParsedContent"] = PactBroker::Pacts::Parse.call(contract["decodedContent"]) rescue nil
           end
         end
+
+        def publish_contracts
+          handle_webhook_events(consumer_version_branch: parsed_contracts.branch, build_url: parsed_contracts.build_url) do
+            results = contract_service.publish(parsed_contracts, base_url: base_url)
+            response.body = decorator_class(:publish_contracts_results_decorator).new(results).to_json(decorator_options)
+          end
+        end
+
+        def set_conflict_response
+          response.body = {
+            notices: conflict_notices.collect(&:to_h),
+            errors: {
+              contracts: conflict_notices.select(&:error?).collect(&:text)
+            }
+          }.to_json
+          response.headers["Content-Type"] = "application/json;charset=utf-8"
+        end
+
+        def conflict_notices
+          @conflict_notices ||= contract_service.conflict_notices(parsed_contracts)
+        end
       end
     end
   end

data/lib/pact_broker/config/runtime_configuration_database_methods.rb

@@ -93,7 +93,7 @@ module PactBroker
               password: database_password,
               host: database_host,
               database: database_name,
-              database_port: database_port
+              port: database_port
             }.compact
           end
           private :database_credentials

data/lib/pact_broker/contracts/contracts_publication_results.rb

@@ -1,13 +1,8 @@
 module PactBroker
   module Contracts
-    ContractsPublicationResults = Struct.new(:pacticipant, :version, :tags, :contracts, :notices) do
+    ContractsPublicationResults = Struct.new(:pacticipant, :version, :tags, :contracts, :notices, keyword_init: true) do
       def self.from_hash(params)
-        new(params[:pacticipant],
-          params[:version],
-          params[:tags],
-          params[:contracts],
-          params[:notices]
-        )
+        new(params)
       end
     end
   end

data/lib/pact_broker/contracts/notice.rb

@@ -20,6 +20,14 @@ module PactBroker
       def self.success(text)
         Notice.new("success", text)
       end
+
+      def self.error(text)
+        Notice.new("error", text)
+      end
+
+      def error?
+        type == "error"
+      end
     end
   end
 end

data/lib/pact_broker/contracts/service.rb

@@ -6,6 +6,7 @@ require "pact_broker/contracts/contracts_publication_results"
 require "pact_broker/contracts/notice"
 require "pact_broker/events/subscriber"
 require "pact_broker/api/pact_broker_urls"
+require "pact_broker/pacts/create_formatted_diff"
 
 module PactBroker
   module Contracts
@@ -42,6 +43,30 @@ module PactBroker
         )
       end
 
+      def conflict_notices(parsed_contracts)
+        notices = []
+        parsed_contracts.contracts.collect do | contract_to_publish |
+          pact_params = create_pact_params(parsed_contracts, contract_to_publish)
+          existing_pact = pact_service.find_pact(pact_params)
+          if existing_pact && pact_service.disallowed_modification?(existing_pact, contract_to_publish.decoded_content)
+            add_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_pact.json_content, contract_to_publish.decoded_content)
+          end
+        end
+        notices
+      end
+
+      def add_conflict_notice(notices, parsed_contracts, contract_to_publish, existing_json_content, new_json_content)
+        message_params = {
+          consumer_name: contract_to_publish.provider_name,
+          consumer_version_number: parsed_contracts.pacticipant_version_number,
+          provider_name: contract_to_publish.provider_name
+        }
+        notices << Notice.error(message("errors.validation.pact_content_modification_not_allowed", message_params))
+        notices << Notice.info(PactBroker::Pacts::CreateFormattedDiff.call(new_json_content, existing_json_content))
+      end
+
+      private :add_conflict_notice
+
       def create_version(parsed_contracts)
         version_params = {
           build_url: parsed_contracts.build_url,

data/lib/pact_broker/doc/views/index/publish-contracts.markdown

@@ -12,6 +12,8 @@ This is the preferred endpoint with which to publish contracts (previously, cont
 
 The previous tag and pact endpoints are still supported, however, future features that build on this endpoint may not be able to be backported into those endpoints.
 
+This endpoint is designed to be used by a command line tool, and hence, the response notices are designed for output to the user in a terminal.
+
 ## Parameters
 
 * `pacticipantName`: the name of the application. Required.
@@ -31,7 +33,7 @@ The previous tag and pact endpoints are still supported, however, future feature
 ### Success
 
 * `notices`
-  * `level`: one of `debug`, `info`, `warning`,`prompt`,`success`
+  * `level`: one of `debug`, `info`, `warning`,`prompt`,`success`, `error`, `danger`
   * `text`: the text of the notice. This is designed to be displayed in the output of a CLI.
 
 The `_links` section will contain links to all the resources created by the publication. The relations are:
@@ -43,7 +45,9 @@ The `_links` section will contain links to all the resources created by the publ
 
 ### Errors
 
-Any validation errors will be returned in the standard Pact Broker format:
+### Schema validation errors
+
+Any validation errors will be returned in the standard Pact Broker format with a 400 status:
 
     {
       "errors": {
@@ -51,6 +55,32 @@ Any validation errors will be returned in the standard Pact Broker format:
       }
     }
 
+### Contract conflict errors
+
+If there is a conflict with an existing published pact and `allow_dangerous_contract_modification` is set to false, a 409 will be returned with an array of notices, which will contain a diff between the existing pact content and the content that was attempted to be published. For consistency with the existing error responses, the errors hash will also contain the error messages, but there will be no diff included. For CLI usage, when there are notices and errors, just the notices should be displayed to the user.
+
+    {
+        "notices":
+        [
+            {
+                "text": "Cannot change the content of the pact for Foo version 183a77b0 and provider Bar, as race conditions will cause unreliable results for can-i-deploy. Each pact must be published with a unique consumer version number. For more information see https://docs.pact.io/go/versioning",
+                "type": "error"
+            },
+            {
+                "text": "<the diff, will include new lines>",
+                "type": "info"
+            }
+        ],
+        "errors":
+        {
+            "content":
+            [
+                "Cannot change the content of the pact for Foo version 183a77b0 and provider Bar, as race conditions will cause unreliable results for can-i-deploy. Each pact must be published with a unique consumer version number. For more information see https://docs.pact.io/go/versioning"
+            ]
+        }
+    }
+
+
 ## Example
 
     POST http://broker/contracts/publish

data/lib/pact_broker/doc/views/provider-pacts-for-verification.markdown

@@ -30,6 +30,8 @@ Example: This data structure represents the way a user might specify "I want to
 
 `consumerVersionSelectors.branch`: the branch name of the consumer versions to get the pacts for. Use of this selector requires that the consumer has configured a branch name when publishing the pacts.
 
+`consumerVersionSelectors.matchingBranch`: if the key is specified, can only be set to `true`. When true, returns the latest pact for any branch with the same name as the specified `providerVersionBranch`.
+
 `consumerVersionSelectors.fallbackBranch`: the name of the branch to fallback to if the specified `branch` does not exist. Use of this property is discouraged as it may allow a pact to pass on a feature branch while breaking backwards compatibility with the main branch, which is generally not desired. It is better to use two separate consumer version selectors, one with the main branch name, and one with the feature branch name, rather than use this property.
 
 `consumerVersionSelectors.deployed`: if the key is specified, can only be set to `true`. Returns the pacts for all versions of the consumer that are currently deployed to any environment. Use of this selector requires that the deployment of the consumer application is recorded in the Pact Broker using the `pact-broker record-deployment` CLI.

data/lib/pact_broker/locale/en.yml

@@ -74,7 +74,7 @@ en:
         invalid_http_method: "Invalid HTTP method '%{method}'"
         invalid_url: "Invalid URL '%{url}'. Expected format: http://example.org"
         pact_missing_pacticipant_name: "was not found at expected path $.%{pacticipant}.name in the submitted pact file."
-        pact_content_modification_not_allowed: "Cannot change the content of the pact for %{consumer_name} version %{consumer_version_number}, as race conditions will cause unreliable results for can-i-deploy. Each pact must be published with a unique consumer version number. For more information see https://docs.pact.io/go/versioning"
+        pact_content_modification_not_allowed: "Cannot change the content of the pact for %{consumer_name} version %{consumer_version_number} and provider %{provider_name}, as race conditions will cause unreliable results for can-i-deploy. Each pact must be published with a unique consumer version number. For more information see https://docs.pact.io/go/versioning"
         consumer_version_number_missing: "Please specify the consumer version number by setting the X-Pact-Consumer-Version header."
         consumer_version_number_header_invalid: "X-Pact-Consumer-Version '%{consumer_version_number}' cannot be parsed to a version number. The expected format (unless this configuration has been overridden) is a semantic version. eg. 1.3.0 or 2.0.4.rc1"
         consumer_version_number_invalid: "Consumer version number '%{consumer_version_number}' cannot be parsed to a version number. The expected format (unless this configuration has been overridden) is a semantic version. eg. 1.3.0 or 2.0.4.rc1"

data/lib/pact_broker/pacts/content.rb

@@ -1,11 +1,13 @@
 require "pact_broker/pacts/parse"
 require "pact_broker/pacts/sort_content"
 require "pact_broker/pacts/generate_interaction_sha"
+require "pact_broker/hash_refinements"
 
 module PactBroker
   module Pacts
     class Content
       include GenerateInteractionSha
+      using PactBroker::HashRefinements
 
       def initialize pact_hash
         @pact_hash = pact_hash
@@ -75,6 +77,18 @@ module PactBroker
         Content.from_hash(new_pact_hash)
       end
 
+      def without_ids
+        new_pact_hash = pact_hash.dup
+        if interactions && interactions.is_a?(Array)
+          new_pact_hash["interactions"] = remove_ids(interactions)
+        end
+
+        if messages && messages.is_a?(Array)
+          new_pact_hash["messages"] = remove_ids(messages)
+        end
+        Content.from_hash(new_pact_hash)
+      end
+
       def interaction_ids
         messages_or_interaction_or_empty_array.collect do | interaction |
           interaction["_id"]
@@ -138,6 +152,10 @@ module PactBroker
         end
       end
 
+      def remove_ids(interactions_or_messages)
+        interactions_or_messages.collect{ | h | h.without("_id") }
+      end
+
       def merge_verification_results(interactions, tests)
         interactions.collect(&:dup).collect do | interaction |
           interaction["tests"] = tests.select do | test |

data/lib/pact_broker/pacts/create_formatted_diff.rb

@@ -1,16 +1,23 @@
 require "pact/matchers"
 require "pact_broker/json"
 require "pact/matchers/unix_diff_formatter"
+require "pact_broker/pacts/sort_content"
+require "pact_broker/pacts/content"
 
 module PactBroker
   module Pacts
     class CreateFormattedDiff
-
       extend Pact::Matchers
 
-      def self.call pact_json_content, previous_pact_json_content
+      def self.call pact_json_content, previous_pact_json_content, raw: false
         pact_hash = JSON.load(pact_json_content, nil, PactBroker::PACT_PARSING_OPTIONS)
         previous_pact_hash = JSON.load(previous_pact_json_content, nil, PactBroker::PACT_PARSING_OPTIONS)
+
+        if !raw
+          pact_hash = SortContent.call(PactBroker::Pacts::Content.from_hash(pact_hash).without_ids.to_hash)
+          previous_pact_hash = SortContent.call(PactBroker::Pacts::Content.from_hash(previous_pact_hash).without_ids.to_hash)
+        end
+
         difference = diff(previous_pact_hash, pact_hash)
         Pact::Matchers::UnixDiffFormatter.call(difference, colour: false, include_explanation: false)
       end

data/lib/pact_broker/pacts/selector.rb

@@ -6,7 +6,7 @@ module PactBroker
     class Selector < Hash
       using PactBroker::HashRefinements
 
-      PROPERTY_NAMES = [:latest, :tag, :branch, :consumer, :consumer_version, :environment_name, :fallback_tag, :fallback_branch, :main_branch, :currently_supported, :currently_deployed]
+      PROPERTY_NAMES = [:latest, :tag, :branch, :consumer, :consumer_version, :environment_name, :fallback_tag, :fallback_branch, :main_branch, :matching_branch, :currently_supported, :currently_deployed]
 
       def initialize(properties = {})
         properties.without(*PROPERTY_NAMES).tap { |it| warn("WARN: Unsupported property for #{self.class.name}: #{it.keys.join(", ")} at #{caller[0..3]}") if it.any? }
@@ -31,6 +31,8 @@ module PactBroker
       def type
         if latest_for_branch?
           :latest_for_branch
+        elsif matching_branch?
+          :matching_branch
         elsif currently_deployed?
           :currently_deployed
         elsif currently_supported?
@@ -53,6 +55,10 @@ module PactBroker
         self[:main_branch] = main_branch
       end
 
+      def matching_branch= matching_branch
+        self[:matching_branch] = matching_branch
+      end
+
       def tag= tag
         self[:tag] = tag
       end
@@ -130,83 +136,83 @@ module PactBroker
       end
 
       def self.overall_latest
-        Selector.new(latest: true)
+        new(latest: true)
       end
 
       def self.for_main_branch
-        Selector.new(main_branch: true)
+        new(main_branch: true)
       end
 
       def self.latest_for_tag(tag)
-        Selector.new(latest: true, tag: tag)
+        new(latest: true, tag: tag)
       end
 
       def self.latest_for_branch(branch)
-        Selector.new(latest: true, branch: branch)
+        new(latest: true, branch: branch)
       end
 
       def self.latest_for_tag_with_fallback(tag, fallback_tag)
-        Selector.new(latest: true, tag: tag, fallback_tag: fallback_tag)
+        new(latest: true, tag: tag, fallback_tag: fallback_tag)
       end
 
       def self.latest_for_branch_with_fallback(branch, fallback_branch)
-        Selector.new(latest: true, branch: branch, fallback_branch: fallback_branch)
+        new(latest: true, branch: branch, fallback_branch: fallback_branch)
       end
 
       def self.all_for_tag(tag)
-        Selector.new(tag: tag)
+        new(tag: tag)
       end
 
       def self.all_for_tag_and_consumer(tag, consumer)
-        Selector.new(tag: tag, consumer: consumer)
+        new(tag: tag, consumer: consumer)
       end
 
       def self.latest_for_tag_and_consumer(tag, consumer)
-        Selector.new(latest: true, tag: tag, consumer: consumer)
+        new(latest: true, tag: tag, consumer: consumer)
       end
 
       def self.latest_for_branch_and_consumer(branch, consumer)
-        Selector.new(latest: true, branch: branch, consumer: consumer)
+        new(latest: true, branch: branch, consumer: consumer)
       end
 
       def self.latest_for_consumer(consumer)
-        Selector.new(latest: true, consumer: consumer)
+        new(latest: true, consumer: consumer)
       end
 
       def self.for_currently_deployed(environment_name = nil)
-        Selector.new( { currently_deployed: true, environment_name: environment_name }.compact )
+        new( { currently_deployed: true, environment_name: environment_name }.compact )
       end
 
       def self.for_currently_supported(environment_name = nil)
-        Selector.new( { currently_supported: true, environment_name: environment_name }.compact )
+        new( { currently_supported: true, environment_name: environment_name }.compact )
       end
 
       def self.for_currently_deployed_and_consumer(consumer)
-        Selector.new(currently_deployed: true, consumer: consumer)
+        new(currently_deployed: true, consumer: consumer)
       end
 
       def self.for_currently_deployed_and_environment_and_consumer(environment_name, consumer)
-        Selector.new(currently_deployed: true, environment_name: environment_name, consumer: consumer)
+        new(currently_deployed: true, environment_name: environment_name, consumer: consumer)
       end
 
       def self.for_currently_supported_and_environment_and_consumer(environment_name, consumer)
-        Selector.new(currently_supported: true, environment_name: environment_name, consumer: consumer)
+        new(currently_supported: true, environment_name: environment_name, consumer: consumer)
       end
 
       def self.for_environment(environment_name)
-        Selector.new(environment_name: environment_name)
+        new(environment_name: environment_name)
       end
 
       def self.for_environment_and_consumer(environment_name, consumer)
-        Selector.new(environment_name: environment_name, consumer: consumer)
+        new(environment_name: environment_name, consumer: consumer)
       end
 
       def self.from_hash hash
-        Selector.new(hash)
+        new(hash)
       end
 
       def for_consumer(consumer)
-        Selector.new(to_h.merge(consumer: consumer))
+        self.class.new(to_h.merge(consumer: consumer))
       end
 
       def latest_for_main_branch?
@@ -233,6 +239,14 @@ module PactBroker
         self[:branch]
       end
 
+      def matching_branch
+        self[:matching_branch]
+      end
+
+      def matching_branch?
+        !!matching_branch
+      end
+
       def overall_latest?
         !!(latest? && !tag && !branch && !main_branch && !currently_deployed && !currently_supported && !environment_name)
       end