pact_broker 2.106.0 → 2.107.0

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

@@ -18,7 +18,7 @@ module PactBroker
 
         property :uuid
 
-        property :description, getter: lambda { |context| context[:represented].display_description }
+        property :description, getter: lambda { |represented:, **| represented.display_description }
 
         property :consumer, class: Domain::WebhookPacticipant, default: nil do
           property :name
@@ -42,7 +42,6 @@ module PactBroker
             title: represented.display_description,
             href: webhook_url(represented.uuid, options[:base_url])
           }
-
         end
 
         link :'pb:execute' do | options |
@@ -108,7 +107,7 @@ module PactBroker
           }
         end
 
-        def from_json represented
+        def from_json(represented)
           super.tap do | webhook |
             if webhook.events == nil
               webhook.events = [PactBroker::Webhooks::WebhookEvent.new(name: PactBroker::Webhooks::WebhookEvent::DEFAULT_EVENT_NAME)]

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

@@ -56,10 +56,12 @@ module PactBroker
           end
         end
 
-        property :error, :extend => ErrorDecorator, if: lambda { |context| context[:options][:user_options][:show_response] }
+        property :error, :extend => ErrorDecorator, if: lambda { |options:, **| options.dig(:user_options, :show_response) }
         property :request, :extend => HTTPRequestDecorator
-        property :response, :extend => HTTPResponseDecorator, if: lambda { |context| context[:options][:user_options][:show_response] }
-        property :response_hidden_message, as: :message, exec_context: :decorator, if: lambda { |context| !context[:options][:user_options][:show_response] }
+        property :response, :extend => HTTPResponseDecorator, if: lambda { |options:, **| options.dig(:user_options, :show_response) }
+        property :message,
+          if: lambda { |options:, **| !options.dig(:user_options, :show_response) },
+          getter: lambda { |options:, **| PactBroker::Messages.message("messages.response_body_hidden", base_url: options.dig(:user_options, :base_url))  }
         property :logs
         property :success?, as: :success
 
@@ -77,15 +79,6 @@ module PactBroker
             href: options.fetch(:resource_url)
           }
         end
-
-        def to_hash(options)
-          @to_hash_options = options
-          super
-        end
-
-        def response_hidden_message
-          PactBroker::Messages.message("messages.response_body_hidden", base_url: @to_hash_options[:user_options][:base_url])
-        end
       end
     end
   end

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

@@ -30,16 +30,16 @@ module PactBroker
         end
 
         def malformed_request?
-          super || (request.post? && validation_errors?(webhook))
+          super || (request.post? && validation_errors_for_schema?)
         end
 
         def to_json
-          decorator_class(:webhooks_decorator).new(webhooks).to_json(decorator_options(resource_title: "Webhooks"))
+          decorator_class(:webhooks_decorator).new(webhooks).to_json(**decorator_options(resource_title: "Webhooks"))
         end
 
         def from_json
           saved_webhook = webhook_service.create(next_uuid, webhook, consumer, provider)
-          response.body = decorator_class(:webhook_decorator).new(saved_webhook).to_json(decorator_options)
+          response.body = decorator_class(:webhook_decorator).new(saved_webhook).to_json(**decorator_options)
         end
 
         def policy_name
@@ -56,14 +56,8 @@ module PactBroker
 
         private
 
-        def validation_errors? webhook
-          errors = webhook_service.errors(webhook)
-
-          unless errors.empty?
-            set_json_validation_error_messages(errors.messages)
-          end
-
-          !errors.empty?
+        def schema
+          api_contract_class(:webhook_contract)
         end
 
         def consumer

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

@@ -67,12 +67,11 @@ module PactBroker
           end
         end
 
-        # The path_info segments aren't URL decoded
+        # Remove the non-path compontents in the path_info (eg. the application context, which is naughtily passed in via the path_info)
         def identifier_from_path
           @identifier_from_path ||= request.path_info.each_with_object({}) do | (key, value), hash|
-            if value.is_a?(String)
-              hash[key] = URI.decode(value)
-            elsif value.is_a?(Symbol) || value.is_a?(Numeric)
+            case value
+            when String, Symbol, Numeric
               hash[key] = value
             end
           end
@@ -204,22 +203,6 @@ module PactBroker
           end
         end
 
-        def validation_errors? model
-          if (errors = model.validate).any?
-            set_json_validation_error_messages errors
-            true
-          else
-            false
-          end
-        end
-
-        def contract_validation_errors? contract, params
-          if (invalid = !contract.validate(params))
-            set_json_validation_error_messages contract.errors.messages
-          end
-          invalid
-        end
-
         def find_pacticipant name, role
           pacticipant_service.find_pacticipant_by_name(name).tap do | pacticipant |
             if pacticipant.nil?

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

@@ -26,7 +26,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:branch_version_decorator).new(branch_version).to_json(decorator_options)
+          decorator_class(:branch_version_decorator).new(branch_version).to_json(**decorator_options)
         end
 
         def delete_resource
@@ -36,7 +36,7 @@ module PactBroker
 
         def from_json
           already_existed = !!branch_version
-          @branch_version = branch_service.find_or_create_branch_version(identifier_from_path)
+          @branch_version = branch_service.find_or_create_branch_version(**identifier_from_path)
           # Make it return a 201 by setting the Location header
           response.headers["Location"] = branch_version_url(branch_version, base_url) unless already_existed
           response.body = to_json
@@ -49,7 +49,7 @@ module PactBroker
         private
 
         def branch_version
-          @branch_version ||= branch_service.find_branch_version(identifier_from_path)
+          @branch_version ||= branch_service.find_branch_version(**identifier_from_path)
         end
       end
     end

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

@@ -1,5 +1,5 @@
 require "pact_broker/api/resources/matrix"
-require "pact_broker/matrix/can_i_deploy_query_schema"
+require "pact_broker/api/contracts/can_i_deploy_query_schema"
 require "pact_broker/matrix/parse_can_i_deploy_query"
 require "pact_broker/messages"
 
@@ -9,16 +9,9 @@ module PactBroker
       class CanIDeploy < Matrix
         include PactBroker::Messages
 
+        # Can't call super because it will execute the Matrix validation, not the BaseResource validation
         def malformed_request?
-          if (errors = query_schema.call(query_params)).any?
-            set_json_validation_error_messages(errors)
-            true
-          elsif !pacticipant
-            set_json_validation_error_messages(pacticipant: [message("errors.validation.pacticipant_not_found", name: pacticipant_name)])
-            true
-          else
-            false
-          end
+          request.get? && validation_errors_for_schema?(schema, request.query)
         end
 
         def policy_name
@@ -27,18 +20,10 @@ module PactBroker
 
         private
 
-        def query_schema
+        def schema
           PactBroker::Api::Contracts::CanIDeployQuerySchema
         end
 
-        def pacticipant
-          @pacticipant ||= pacticipant_service.find_pacticipant_by_name(pacticipant_name)
-        end
-
-        def pacticipant_name
-          selectors.first.pacticipant_name
-        end
-
         def parsed_query
           @parsed_query ||= PactBroker::Matrix::ParseCanIDeployQuery.call(query_params)
         end

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

@@ -1,8 +1,5 @@
 require "pact_broker/api/resources/matrix"
-require "pact_broker/matrix/can_i_deploy_query_schema"
-require "pact_broker/matrix/parse_can_i_deploy_query"
 require "pact_broker/api/decorators/matrix_decorator"
-require "pact_broker/api/decorators/matrix_text_decorator"
 
 module PactBroker
   module Api
@@ -47,7 +44,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:matrix_decorator).new(results).to_json(decorator_options)
+          decorator_class(:matrix_decorator).new(results).to_json(**decorator_options)
         end
 
         def results

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

@@ -1,6 +1,4 @@
 require "pact_broker/api/resources/matrix"
-require "pact_broker/matrix/can_i_deploy_query_schema"
-require "pact_broker/matrix/parse_can_i_deploy_query"
 
 module PactBroker
   module Api

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

@@ -1,5 +1,4 @@
-require "pact_broker/matrix/can_i_deploy_query_schema"
-require "pact_broker/matrix/parse_can_i_deploy_query"
+require "pact_broker/api/resources/can_i_deploy_pacticipant_version_by_tag_to_tag"
 require "pact_broker/api/resources/badge_methods"
 
 module PactBroker

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

@@ -21,7 +21,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(decorator_name).new(deployed_versions).to_json(decorator_options(title: title))
+          decorator_class(decorator_name).new(deployed_versions).to_json(**decorator_options(title: title))
         end
 
         def policy_name
@@ -43,7 +43,7 @@ module PactBroker
         end
 
         def deployed_versions
-          @deployed_versions ||= deployed_version_service.find_currently_deployed_versions_for_environment(environment, query_params)
+          @deployed_versions ||= deployed_version_service.find_currently_deployed_versions_for_environment(environment, **query_params)
         end
 
         def environment_uuid

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

@@ -21,7 +21,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(decorator_name).new(released_versions).to_json(decorator_options(title: title))
+          decorator_class(decorator_name).new(released_versions).to_json(**decorator_options(title: title))
         end
 
         def policy_name
@@ -43,7 +43,7 @@ module PactBroker
         end
 
         def released_versions
-          @released_versions ||= released_version_service.find_currently_supported_versions_for_environment(environment, query_params)
+          @released_versions ||= released_version_service.find_currently_supported_versions_for_environment(environment, **query_params)
         end
 
         def environment_uuid

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

@@ -21,11 +21,11 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:dashboard_decorator).new(index_items).to_json(decorator_options)
+          decorator_class(:dashboard_decorator).new(index_items).to_json(**decorator_options)
         end
 
         def to_text
-          decorator_class(:dashboard_text_decorator).new(index_items).to_text(decorator_options)
+          decorator_class(:dashboard_text_decorator).new(index_items).to_text(**decorator_options)
         end
 
         def policy_name
@@ -35,7 +35,7 @@ module PactBroker
         private
 
         def index_items
-          index_service.find_index_items_for_api(identifier_from_path.merge(pagination_options))
+          index_service.find_index_items_for_api(**identifier_from_path.merge(pagination_options))
         end
       end
     end

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

@@ -33,7 +33,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:deployed_version_decorator).new(deployed_version).to_json(decorator_options)
+          decorator_class(:deployed_version_decorator).new(deployed_version).to_json(**decorator_options)
         end
 
         def from_merge_patch_json

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

@@ -32,11 +32,11 @@ module PactBroker
         def from_json
           @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)
+          response.body = decorator_class(:deployed_version_decorator).new(deployed_version).to_json(**decorator_options)
         end
 
         def to_json
-          decorator_class(:deployed_versions_decorator).new(deployed_versions).to_json(decorator_options(title: title))
+          decorator_class(:deployed_versions_decorator).new(deployed_versions).to_json(**decorator_options(title: title))
         end
 
         def policy_name

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

@@ -43,7 +43,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:environment_decorator).new(environment).to_json(decorator_options)
+          decorator_class(:environment_decorator).new(environment).to_json(**decorator_options)
         end
 
         def parsed_environment

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

@@ -35,7 +35,7 @@ module PactBroker
         end
 
         def from_json
-          response.body = decorator_class(:environment_decorator).new(create_environment).to_json(decorator_options)
+          response.body = decorator_class(:environment_decorator).new(create_environment).to_json(**decorator_options)
         end
 
         def policy_name
@@ -43,7 +43,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:environments_decorator).new(environments).to_json(decorator_options)
+          decorator_class(:environments_decorator).new(environments).to_json(**decorator_options)
         end
 
         def parsed_environment

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

@@ -26,7 +26,7 @@ module PactBroker
         def set_json_validation_error_messages errors
           response.headers["Content-Type"] = error_response_content_type
           if problem_json_error_content_type?
-            response.body = PactBroker::Api::Decorators::ValidationErrorsProblemJSONDecorator.new(errors).to_json(decorator_options)
+            response.body = PactBroker::Api::Decorators::ValidationErrorsProblemJSONDecorator.new(errors).to_json(**decorator_options)
           else
             response.body = { errors: errors }.to_json
           end
@@ -42,7 +42,7 @@ module PactBroker
 
         def error_response_body(detail, title, type, status)
           if problem_json_error_content_type?
-            PactBroker::Api::Decorators::CustomErrorProblemJSONDecorator.new(detail: detail, title: title, type: type, status: status).to_json(decorator_options)
+            PactBroker::Api::Decorators::CustomErrorProblemJSONDecorator.new(detail: detail, title: title, type: type, status: status).to_json(**decorator_options)
           else
             { error: detail }.to_json
           end

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

@@ -22,7 +22,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:integrations_decorator).new(integrations).to_json(decorator_options)
+          decorator_class(:integrations_decorator).new(integrations).to_json(**decorator_options)
         end
 
         def integrations

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

@@ -39,7 +39,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:label_decorator).new(label).to_json(decorator_options)
+          decorator_class(:label_decorator).new(label).to_json(**decorator_options)
         end
 
         def label

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

@@ -30,11 +30,11 @@ module PactBroker
 
         def to_json
           response.headers["X-Pact-Consumer-Version"] = pact.consumer_version_number
-          decorator_class(:pact_decorator).new(pact).to_json(decorator_options(metadata: metadata))
+          decorator_class(:pact_decorator).new(pact).to_json(**decorator_options(metadata: metadata))
         end
 
         def to_extended_json
-          decorator_class(:extended_pact_decorator).new(pact).to_json(decorator_options(metadata: metadata))
+          decorator_class(:extended_pact_decorator).new(pact).to_json(**decorator_options(metadata: metadata))
         end
 
         def to_html

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

@@ -14,7 +14,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:pact_collection_decorator).new(pacts).to_json(decorator_options)
+          decorator_class(:pact_collection_decorator).new(pacts).to_json(**decorator_options)
         end
 
         def pacts

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

@@ -23,7 +23,7 @@ module PactBroker
 
         def to_json
           summary = verification_service.verification_summary_for_consumer_version(identifier_from_path)
-          decorator_for(summary).to_json(decorator_options(identifier_from_path))
+          decorator_for(summary).to_json(**decorator_options(identifier_from_path))
         end
 
         def policy_name

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

@@ -29,11 +29,11 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:matrix_decorator).new(results).to_json(decorator_options)
+          decorator_class(:matrix_decorator).new(results).to_json(**decorator_options)
         end
 
         def to_text
-          decorator_class(:matrix_text_decorator).new(results).to_text(decorator_options)
+          decorator_class(:matrix_text_decorator).new(results).to_text(**decorator_options)
         end
 
         def policy_name

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

@@ -34,7 +34,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:matrix_decorator).new(results).to_json(decorator_options)
+          decorator_class(:matrix_decorator).new(results).to_json(**decorator_options)
         end
 
         def policy_name

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

@@ -54,9 +54,8 @@ module PactBroker
           potential_duplicate_pacticipants?(pact_params.pacticipant_names) || merge_conflict || disallowed_modification?
         end
 
-
         def malformed_request?
-          super || ((request.patch? || request.really_put?) && contract_validation_errors?(Contracts::PutPactParamsContract.new(pact_params), pact_params))
+          super || ((request.patch? || request.really_put?) && validation_errors_for_schema?(schema, pact_params.to_hash_for_validation))
         end
 
         def resource_exists?
@@ -78,11 +77,11 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:pact_decorator).new(pact).to_json(decorator_options(metadata: identifier_from_path[:metadata]))
+          decorator_class(:pact_decorator).new(pact).to_json(**decorator_options(metadata: identifier_from_path[:metadata]))
         end
 
         def to_extended_json
-          decorator_class(:extended_pact_decorator).new(pact).to_json(decorator_options(metadata: identifier_from_path[:metadata]))
+          decorator_class(:extended_pact_decorator).new(pact).to_json(**decorator_options(metadata: identifier_from_path[:metadata]))
         end
 
         def to_html
@@ -118,6 +117,10 @@ module PactBroker
             false
           end
         end
+
+        def schema
+          api_contract_class(:put_pact_params_contract)
+        end
       end
     end
   end

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

@@ -18,7 +18,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:triggered_webhooks_decorator).new(triggered_webhooks).to_json(decorator_options(resource_title: resource_title))
+          decorator_class(:triggered_webhooks_decorator).new(triggered_webhooks).to_json(**decorator_options(resource_title: resource_title))
         end
 
         def policy_name

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

@@ -19,7 +19,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:pact_versions_decorator).new(pacts).to_json(decorator_options(identifier_from_path))
+          decorator_class(:pact_versions_decorator).new(pacts).to_json(**decorator_options(identifier_from_path))
         end
 
         def pacts

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

@@ -25,18 +25,7 @@ module PactBroker
         end
 
         def malformed_request?
-          super || (request.post? && validation_errors?(webhook))
-        end
-
-        def validation_errors? webhook
-          errors = webhook_service.errors(webhook)
-
-          unless errors.empty?
-            response.headers["Content-Type"] = "application/hal+json;charset=utf-8"
-            response.body = { errors: errors.messages }.to_json
-          end
-
-          !errors.empty?
+          super || (request.post? && validation_errors_for_schema?)
         end
 
         def create_path
@@ -49,11 +38,11 @@ module PactBroker
 
         def from_json
           saved_webhook = webhook_service.create next_uuid, webhook, consumer, provider
-          response.body = decorator_class(:webhook_decorator).new(saved_webhook).to_json(decorator_options)
+          response.body = decorator_class(:webhook_decorator).new(saved_webhook).to_json(**decorator_options)
         end
 
         def to_json
-          decorator_class(:webhooks_decorator).new(webhooks).to_json(decorator_options(resource_title: "Pact webhooks"))
+          decorator_class(:webhooks_decorator).new(webhooks).to_json(**decorator_options(resource_title: "Pact webhooks"))
         end
 
         def policy_name
@@ -62,6 +51,10 @@ module PactBroker
 
         private
 
+        def schema
+          api_contract_class(:webhook_contract)
+        end
+
         def webhooks
           @webhooks ||= webhook_service.find_by_consumer_and_provider consumer, provider
         end

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

@@ -19,11 +19,15 @@ module PactBroker
         end
 
         def to_json
-          decorator_for(latest_triggered_webhooks).to_json(decorator_options(identifier_from_path))
+          decorator_for(latest_triggered_webhooks).to_json(**decorator_options(identifier_from_path))
         end
 
         def policy_name
-          :'webhooks::webhooks'
+          :'pacts::pact'
+        end
+
+        def policy_record
+          pact
         end
 
         private

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

@@ -71,7 +71,7 @@ module PactBroker
         end
 
         def to_json
-          decorator_class(:pacticipant_decorator).new(pacticipant).to_json(decorator_options)
+          decorator_class(:pacticipant_decorator).new(pacticipant).to_json(**decorator_options)
         end
 
         def parsed_pacticipant(pacticipant)

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

@@ -2,13 +2,11 @@ require "pact_broker/api/resources/base_resource"
 require "pact_broker/api/decorators/webhook_decorator"
 require "pact_broker/api/decorators/webhooks_decorator"
 require "pact_broker/api/contracts/webhook_contract"
-require "pact_broker/api/resources/webhook_resource_methods"
 
 module PactBroker
   module Api
     module Resources
       class PacticipantWebhooks < BaseResource
-        include WebhookResourceMethods
 
         def allowed_methods
           ["POST", "GET", "OPTIONS"]
@@ -27,7 +25,7 @@ module PactBroker
         end
 
         def malformed_request?
-          super || (request.post? && webhook_validation_errors?(webhook))
+          super || (request.post? && validation_errors_for_schema?)
         end
 
         def create_path
@@ -40,11 +38,11 @@ module PactBroker
 
         def from_json
           saved_webhook = webhook_service.create next_uuid, webhook, consumer, provider
-          response.body = decorator_class(:webhook_decorator).new(saved_webhook).to_json(decorator_options)
+          response.body = decorator_class(:webhook_decorator).new(saved_webhook).to_json(**decorator_options)
         end
 
         def to_json
-          decorator_class(:webhooks_decorator).new(webhooks).to_json(decorator_options(resource_title: "Webhooks"))
+          decorator_class(:webhooks_decorator).new(webhooks).to_json(**decorator_options(resource_title: "Webhooks"))
         end
 
         def policy_name
@@ -57,6 +55,10 @@ module PactBroker
 
         private
 
+        def schema
+          api_contract_class(:webhook_contract)
+        end
+
         def webhooks
           webhook_service.find_by_consumer_and_provider(consumer, provider)
         end

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

@@ -39,7 +39,7 @@ module PactBroker
 
         def from_json
           created_model = pacticipant_service.create(parsed_pacticipant.to_h)
-          response.body = decorator_for(created_model).to_json(decorator_options)
+          response.body = decorator_for(created_model).to_json(**decorator_options)
         end
 
         def create_path
@@ -51,7 +51,7 @@ module PactBroker
         end
 
         def generate_json pacticipants
-          decorator_class(:deprecated_pacticipant_collection_decorator).new(pacticipants).to_json(decorator_options)
+          decorator_class(:deprecated_pacticipant_collection_decorator).new(pacticipants).to_json(**decorator_options)
         end
 
         def decorator_for model