pact_broker 2.105.0 → 2.107.0.beta.1

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

@@ -0,0 +1,125 @@
+require "pact_broker/api/contracts/base_contract"
+require "pact_broker/webhooks/render"
+require "pact_broker/webhooks/check_host_whitelist"
+require "pact_broker/api/contracts/validation_helpers"
+
+module PactBroker
+  module Api
+    module Contracts
+      class WebhookRequestContract < BaseContract
+        include ValidationHelpers
+
+        json do
+          required(:method).filled(:string)
+          required(:url).filled(:string)
+        end
+
+        rule(:url) do
+          if !valid_webhook_url?(value)
+            key.failure(validation_message("invalid_url"))
+          end
+        end
+
+        rule(:method) do
+          if !valid_http_method?(value)
+            key.failure(validation_message("invalid_http_method"))
+          end
+        end
+
+        rule(:method) do
+          if_still_valid(self) do
+            if !allowed_webhook_method?(value)
+              key.failure(http_method_error_message)
+            end
+          end
+        end
+
+        rule(:url) do
+          if_still_valid(self) do
+            if templated_host?(value)
+              key.failure(validation_message("webhook_templated_host_not_allowed"))
+            end
+          end
+        end
+
+        rule(:url) do
+          if_still_valid(self) do
+            if !allowed_webhook_scheme?(value)
+              key.failure(scheme_error_message)
+            end
+          end
+        end
+
+        rule(:url) do
+          if_still_valid(self) do
+            if !allowed_webhook_host?(value)
+              key.failure(host_error_message)
+            end
+          end
+        end
+
+        def allowed_webhook_method?(http_method)
+          PactBroker.configuration.webhook_http_method_whitelist.any? do | allowed_method |
+            http_method.downcase == allowed_method.downcase
+          end
+        end
+
+        def http_method_error_message
+          if PactBroker.configuration.webhook_http_method_whitelist.size == 1
+            "must be #{PactBroker.configuration.webhook_http_method_whitelist.first}. See /doc/webhooks#whitelist for more information."
+          else
+            "must be one of #{PactBroker.configuration.webhook_http_method_whitelist.join(", ")}. See /doc/webhooks#whitelist for more information."
+          end
+        end
+
+        def allowed_webhook_scheme?(url)
+          scheme = parse_uri(url).scheme
+          PactBroker.configuration.webhook_scheme_whitelist.any? do | allowed_scheme |
+            scheme.downcase == allowed_scheme.downcase
+          end
+        end
+
+        def scheme_error_message
+          "scheme must be #{PactBroker.configuration.webhook_scheme_whitelist.join(", ")}. See /doc/webhooks#whitelist for more information."
+        end
+
+        def parse_uri(uri_string, placeholder = "placeholder")
+          URI(PactBroker::Webhooks::Render.render_with_placeholder(uri_string, placeholder))
+        end
+
+        def allowed_webhook_host?(url)
+          if host_whitelist.any?
+            PactBroker::Webhooks::CheckHostWhitelist.call(parse_uri(url).host, host_whitelist).any?
+          else
+            true
+          end
+        end
+
+        def host_whitelist
+          PactBroker.configuration.webhook_host_whitelist
+        end
+
+        def host_error_message
+          "host must be in the whitelist #{PactBroker.configuration.webhook_host_whitelist.collect(&:inspect).join(", ")}. See /doc/webhooks#whitelist for more information."
+        end
+
+        def valid_webhook_url?(url)
+          uri = parse_uri(url)
+          uri.scheme && uri.host
+        rescue URI::InvalidURIError, ArgumentError
+          nil
+        end
+
+        def templated_host?(url)
+          parse_uri(url).host != parse_uri(url, "differentplaceholder").host
+        end
+
+        def if_still_valid(context)
+          if !context.rule_error?(context.path.keys)
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/contracts.rb

@@ -0,0 +1,3 @@
+Dir.glob(File.expand_path(File.join(__FILE__, "..", "contracts", "*.rb"))).sort.each do | path |
+  require path
+end

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

@@ -0,0 +1,36 @@
+# Formats a message string into application/problem+json format.
+
+module PactBroker
+  module Api
+    module Decorators
+      class CustomErrorProblemJSONDecorator
+
+        # @option title [String]
+        # @option type [String]
+        # @option detail [String]
+        # @option status [Integer] HTTP status code
+        def initialize(title:, type:, detail:, status: )
+          @title = title
+          @type = type
+          @detail = detail
+          @status = status
+        end
+
+        # @return [Hash]
+        def to_hash(user_options: {}, **__other)
+          {
+            "title" => @title,
+            "type" => "#{user_options[:base_url]}/problem/#{@type}",
+            "detail" => @detail,
+            "status" => @status
+          }
+        end
+
+        # @return [String] JSON
+        def to_json(*args, **kwargs)
+          to_hash(*args, **kwargs).to_json
+        end
+      end
+    end
+  end
+end

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

@@ -17,8 +17,8 @@ module PactBroker
           to_hash(options).to_json
         end
 
-        def to_text(options)
-          data = items(index_items, options[:user_options][:base_url])
+        def to_text(user_options:, **_other)
+          data = items(index_items, user_options[:base_url])
           printer = TablePrint::Printer.new(data)
           printer.table_print + "\n"
         end

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

@@ -32,7 +32,7 @@ module PactBroker
 
         # TODO rather than remove the contract keys that we added in the super class,
         # it would be better to inherit from a shared super class
-        def to_hash(options = {})
+        def to_hash(*)
           keys_to_remove = represented.content_hash.keys
           super.each_with_object({}) do | (key, value), new_hash |
             new_hash[key] = value unless keys_to_remove.include?(key)

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

@@ -16,18 +16,18 @@ module PactBroker
           @query_results_with_deployment_status_summary = query_results_with_deployment_status_summary
         end
 
-        def to_json(options)
-          to_hash(options).to_json
+        def to_json(*args, **kwargs)
+          to_hash(*args, **kwargs).to_json
         end
 
-        def to_hash(options)
+        def to_hash(user_options:, **_other)
           {
             summary: {
               deployable: deployable,
               reason: reason
             },
             notices: notices,
-            matrix: matrix(options[:user_options][:base_url])
+            matrix: matrix(user_options[:base_url])
           }.tap do | hash |
             hash[:summary].merge!(query_results_with_deployment_status_summary.deployment_status_summary.counts)
           end

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

@@ -14,7 +14,7 @@ module PactBroker
           @lines = lines
         end
 
-        def to_text(_options)
+        def to_text(**_options)
           json_decorator = PactBroker::Api::Decorators::MatrixDecorator.new(lines)
           data = lines.collect do | line |
             Line.new(line.consumer_name, line.consumer_version_number, line.pact_revision_number, line.provider_name, line.provider_version_number, line.verification_number, line.success)

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

@@ -9,7 +9,7 @@ module PactBroker
 
         include Timestamps
 
-        def to_hash(options = {})
+        def to_hash(*)
           parsed_content = represented.content_hash
           if parsed_content.is_a?(::Hash)
             parsed_content.merge super

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

@@ -1,6 +1,7 @@
 require "roar/json/hal"
 require "pact_broker/api/pact_broker_urls"
 require_relative "embedded_version_decorator"
+require_relative "pagination_links"
 require "pact_broker/domain/pacticipant"
 require "pact_broker/api/decorators/pacticipant_decorator"
 
@@ -11,6 +12,8 @@ module PactBroker
 
         collection :entries, :as => :pacticipants, :class => PactBroker::Domain::Pacticipant, :extend => PactBroker::Api::Decorators::PacticipantDecorator, embedded: true
 
+        include PaginationLinks
+
         link :self do | options |
           pacticipants_url options[:base_url]
         end
@@ -34,7 +37,7 @@ module PactBroker
       end
 
       class DeprecatedPacticipantDecorator < PactBroker::Api::Decorators::PacticipantDecorator
-        property :title, getter: ->(_something) { "DEPRECATED - Please use the embedded pacticipants collection" }
+        property :title, getter: ->(_) { "DEPRECATED - Please use the embedded pacticipants collection" }
       end
 
       class NonEmbeddedPacticipantCollectionDecorator < BaseDecorator
@@ -43,7 +46,7 @@ module PactBroker
 
       # TODO deprecate this - breaking change for v 3.0
       class DeprecatedPacticipantCollectionDecorator < PacticipantCollectionDecorator
-        def to_hash(options = {})
+        def to_hash(options)
           embedded_pacticipant_hash = super
           non_embedded_pacticipant_hash = NonEmbeddedPacticipantCollectionDecorator.new(represented).to_hash(options)
           embedded_pacticipant_hash.merge(non_embedded_pacticipant_hash)

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

@@ -106,7 +106,8 @@ module PactBroker
           }]
         end
 
-        def to_hash options
+        # representable passes through the kwargs from to_json as normal args
+        def to_hash(options)
           h = super
           dasherized = DasherizedVersionDecorator.new(represented).to_hash(options)
           if dasherized["_embedded"]

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

@@ -15,7 +15,10 @@ module PactBroker
         property :provider_version_branch
 
         collection :consumer_version_selectors, default: PactBroker::Pacts::Selectors.new, class: PactBroker::Pacts::Selector do
-          property :main_branch
+          property :main_branch, setter: -> (fragment:, represented:, **) {
+            represented.main_branch = fragment
+            represented.latest = true
+          }
           property :tag
           property :branch, setter: -> (fragment:, represented:, **) {
             represented.branch = fragment

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

@@ -8,6 +8,17 @@ module PactBroker
         include Roar::JSON::HAL
         include Roar::JSON::HAL::Links
 
+        property :page, getter: lambda { |represented:, **|
+          if represented.respond_to?(:current_page)
+            {
+              number: represented.current_page,
+              size: represented.page_size,
+              totalElements: represented.pagination_record_count,
+              totalPages: represented.page_count,
+            }
+          end
+        }
+
         link :next do | context |
           if represented.respond_to?(:current_page) &&
               represented.respond_to?(:page_count) &&

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

@@ -0,0 +1,34 @@
+# Formats a message string into application/problem+json format.
+
+module PactBroker
+  module Api
+    module Decorators
+      class RuntimeErrorProblemJSONDecorator
+
+        # @param message [String]
+        def initialize(message)
+          @message = message
+        end
+
+        # @return [Hash]
+        def to_hash(user_options:, **)
+          {
+            "title" => "Server error",
+            "type" => "#{user_options[:base_url]}/problems/server_error",
+            "detail" => message,
+            "status" => 500
+          }
+        end
+
+        # @return [String] JSON
+        def to_json(*args, **kwargs)
+          to_hash(*args, **kwargs).to_json
+        end
+
+        private
+
+        attr_reader :message
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# Formats a nested Hash of errors as it comes out of the Dry Validation library
+# into application/problem+json format.
+require "pact_broker/string_refinements"
+
+module PactBroker
+  module Api
+    module Decorators
+      class ValidationErrorsProblemJSONDecorator
+        using PactBroker::StringRefinements
+
+
+        # @param errors [Hash]
+        def initialize(errors)
+          @errors = errors
+        end
+
+        # @return [Hash]
+        def to_hash(user_options:, **)
+          error_list = []
+          walk_errors(errors, error_list, "", user_options[:base_url])
+          {
+            "title" => "Validation errors",
+            "type" => "#{user_options[:base_url]}/problems/validation-error",
+            "status" => 400,
+            "instance" => "/",
+            "errors" => error_list
+          }
+        end
+
+        # @return [String] JSON
+        def to_json(*args, **kwargs)
+          to_hash(*args, **kwargs).to_json
+        end
+
+        private
+
+        attr_reader :errors
+
+        # The path is meant to be implemented using JSON Pointer, but this will probably do for now.
+        # As per https://gregsdennis.github.io/Manatee.Json/usage/pointer.html
+        # the only things that need to be escaped are "~" and "/", which are unlikely to be used
+        # in a key name. You get what you deserve if you've done that.
+        def walk_errors(object, list, path, base_url)
+          if object.is_a?(Hash)
+            object.each { | key, value | walk_errors(value, list, "#{path}/#{key}", base_url) }
+          elsif object.is_a?(Array)
+            object.each { | value | walk_errors(value, list, path, base_url) }
+          elsif object.is_a?(String)
+            append_error(list, object, path, base_url)
+          end
+        end
+
+        def append_error(list, message, path, base_url)
+          error = {
+            "type" => "#{base_url}/problems/invalid-body-property-value",
+            "title" => "Validation error",
+            "detail" => message,
+            "status" => 400
+          }
+          error["pointer"] = path.tr(".", "/") if path.present?
+          list << error
+        end
+      end
+    end
+  end
+end

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

@@ -9,17 +9,17 @@ module PactBroker
       class VerifiablePactDecorator < BaseDecorator
         include PactBroker::Pacts::Metadata
 
-        property :shortDescription, getter: -> (context) { PactBroker::Pacts::VerifiablePactMessages.new(context[:represented], nil).pact_version_short_description }
+        property :shortDescription, getter: lambda { | represented:, ** | PactBroker::Pacts::VerifiablePactMessages.new(represented, nil).pact_version_short_description }
 
         nested :verificationProperties do
           include PactBroker::Api::PactBrokerUrls
 
           property :pending,
-            if: ->(context) { context[:options][:user_options][:include_pending_status] }
+            if: ->(options:, **_other) { options.dig(:user_options, :include_pending_status) }
           property :wip,
-            if: -> (context) { context[:represented].wip }
+            if: -> (represented:, **_other) { represented.wip }
           property :notices,
-            getter: -> (context) { context[:decorator].notices(context[:options][:user_options]) }
+            getter: -> (decorator:, options:, **) { decorator.notices(options[:user_options]) }
 
           def notices(user_options)
             metadata = represented.wip ? { wip: true } : nil

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/badge_methods.rb

@@ -37,7 +37,7 @@ module PactBroker
             badge_url
           rescue StandardError => e
             # Want to render a badge, even if there's an error
-            badge_service.error_badge_url("error", ErrorResponseBodyGenerator.display_message(e, "reference: #{PactBroker::Errors.generate_error_reference}"))
+            badge_service.error_badge_url("error", ErrorResponseGenerator.display_message(e, "reference: #{PactBroker::Errors.generate_error_reference}"))
           end
         end