pact_broker 2.107.1 → 2.108.0

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

@@ -0,0 +1,30 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/embedded_pacticipant_decorator"
+require "pact_broker/api/decorators/embedded_version_decorator"
+require "pact_broker/api/decorators/environment_decorator"
+
+module PactBroker
+  module Api
+    module Decorators
+      class EmbeddedDeployedVersionDecorator < BaseDecorator
+        property :uuid
+        property :currently_deployed, camelize: true
+        property :target, camelize: true # deprecated
+        property :applicationInstance, getter: lambda { |_| target }
+        property :undeployedAt, getter: lambda { |_|  undeployed_at ? FormatDateTime.call(undeployed_at) : nil }, writeable: false
+
+        property :pacticipant, :extend => EmbeddedPacticipantDecorator, writeable: false, embedded: true, if: -> (user_options:, **_other) { user_options[:expand]&.include?(:pacticipant) }
+        property :version,     :extend => EmbeddedVersionDecorator,     writeable: false, embedded: true, if: -> (user_options:, **_other) { user_options[:expand]&.include?(:version) }
+        property :environment, :extend => EnvironmentDecorator,         writeable: false, embedded: true, if: -> (user_options:, **_other) { user_options[:expand]&.include?(:environment) }
+
+        include Timestamps
+
+        link :self do | user_options |
+          {
+            href: deployed_version_url(represented, user_options.fetch(:base_url))
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+require "pact_broker/api/decorators/base_decorator"
+
+# Decorates the individual validation error message Dry::Validation::Message
+
+module PactBroker
+  module Api
+    module Decorators
+      class EmbeddedErrorProblemJsonDecorator < BaseDecorator
+
+        property :type, getter: -> (decorator:, user_options:, **) { decorator.type(user_options[:base_url]) }
+        property :title, exec_context: :decorator
+        property :text, as: :detail
+        property :pointer, exec_context: :decorator
+        property :parameter, exec_context: :decorator
+
+        # dry-validation doesn't support validating a top level array, so we wrap
+        # the json patch operations array in a hash with the key :_ops to validate it.
+        # When we render the error, we have to remove the /_ops prefix from the pointer.
+        # For contracts where we validate the path and the body together using _path and _body
+        # we also need to remove the first key from the path.
+        # It's possible the pointer should have a # at the start of it as per https://www.rfc-editor.org/rfc/rfc6901 :shrug:
+        def pointer
+          if is_path_error?
+            nil
+          # _ops, _path or _body for use when we need to hack the way dry-validation schemas work
+          elsif represented.path.first.to_s.start_with?("_")
+            "/" + represented.path[1..-1].join("/")
+          else
+            "/" + represented.path.join("/")
+          end
+        end
+
+        def parameter
+          if is_path_error?
+            represented.path.last.to_s
+          else
+            nil
+          end
+        end
+
+        def title
+          if is_path_error?
+            "Invalid path segment"
+          else
+            "Invalid body parameter"
+          end
+        end
+
+        # @param [String] base_url
+        def type(base_url)
+          if is_path_error?
+            "#{base_url}/#{path_type}"
+          else
+            "#{base_url}/#{body_type}"
+          end
+        end
+
+        def path_type
+          if represented.text.include?("missing")
+            "problems/missing-request-parameter"
+          elsif represented.text.include?("format")
+            "problems/invalid-request-parameter-format"
+          else
+            "problems/invalid-request-parameter-value"
+          end
+        end
+
+        def body_type
+          if represented.text.include?("missing")
+            "problems/missing-body-property"
+          elsif represented.text.include?("format")
+            "problems/invalid-body-property-format"
+          else
+            "problems/invalid-body-property-value"
+          end
+        end
+
+        def is_path_error?
+          represented.path.first == :_path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/embedded_pacticipant_decorator"
+require "pact_broker/api/decorators/embedded_version_decorator"
+require "pact_broker/api/decorators/environment_decorator"
+
+module PactBroker
+  module Api
+    module Decorators
+      class EmbeddedReleasedVersionDecorator < BaseDecorator
+        property :uuid
+        property :currently_supported, camelize: true
+        include Timestamps
+        property :supportEndedAt, getter: lambda { |_|  support_ended_at ? FormatDateTime.call(support_ended_at) : nil }, writeable: false
+
+        property :pacticipant, :extend => EmbeddedPacticipantDecorator, writeable: false, embedded: true, if: -> (user_options:, **_other) { user_options[:expand]&.include?(:pacticipant) }
+        property :version,     :extend => EmbeddedVersionDecorator,     writeable: false, embedded: true, if: -> (user_options:, **_other) { user_options[:expand]&.include?(:version) }
+        property :environment, :extend => EnvironmentDecorator,         writeable: false, embedded: true, if: -> (user_options:, **_other) { user_options[:expand]&.include?(:environment) }
+
+        link :self do | user_options |
+          {
+            href: released_version_url(represented, user_options.fetch(:base_url))
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -7,9 +7,6 @@ module PactBroker
         camelize_property_names
 
         property :number
-        if PactBroker.feature_enabled?(:branches)
-          property :build_url
-        end
 
         link :self do | options |
           {

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

@@ -0,0 +1,30 @@
+# Formats a nested Hash of errors into the "old" Pact Broker errors format
+# TODO: delete this in favour of problem+json in the next major version
+
+module PactBroker
+  module Api
+    module Decorators
+      class ErrorDecorator
+
+        # @param error [String]
+        def initialize(error)
+          @error = error
+        end
+
+        # @return [Hash]
+        def to_hash(*_args, **_kwargs)
+          { error: error }
+        end
+
+        # @return [String] JSON
+        def to_json(*args, **kwargs)
+          to_hash(*args, **kwargs).to_json
+        end
+
+        private
+
+        attr_reader :error
+      end
+    end
+  end
+end

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

@@ -1,5 +1,10 @@
 require "pact_broker/api/decorators/pact_decorator"
 
+# Pactflow notes:
+# This decorator was added for Pactflow, but we needed to change it so much that there
+# is a separate class in pact_broker_fork/lib/pactflow/api/decorators/extended_pact_decorator.rb now
+# and this one isn't used.
+
 module PactBroker
   module Api
     module Decorators
@@ -47,4 +52,4 @@ module PactBroker
       end
     end
   end
-end
+end

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

@@ -7,16 +7,16 @@ module PactBroker
       class IntegrationDecorator < BaseDecorator
         include PactBroker::Api::PactBrokerUrls
 
+        # TODO should be embedded in v3
         property :consumer do
           property :name
         end
 
+        # TODO should be embedded in v3
         property :provider do
           property :name
         end
 
-        property :verificationStatus, getter: ->(represented:, **) { represented.verification_status_for_latest_pact.to_s }
-
         link "pb:dashboard" do | options |
           {
             title: "BETA: Pacts to show on the dashboard",
@@ -40,3 +40,4 @@ module PactBroker
     end
   end
 end
+

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

@@ -1,5 +1,6 @@
 require_relative "base_decorator"
 require_relative "integration_decorator"
+require "pact_broker/api/decorators/pagination_links"
 
 module PactBroker
   module Api
@@ -13,6 +14,8 @@ module PactBroker
             title: "All integrations"
           }
         end
+
+        include PactBroker::Api::Decorators::PaginationLinks
       end
     end
   end

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

@@ -0,0 +1,11 @@
+require_relative "base_decorator"
+
+module PactBroker
+  module Api
+    module Decorators
+      class NoticesDecorator < BaseDecorator
+        property :entries, as: :notices, getter: ->(represented:, **) { represented.collect(&:to_h) }
+      end
+    end
+  end
+end

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

@@ -3,11 +3,8 @@ require_relative "embedded_version_decorator"
 require_relative "base_decorator"
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class PactPacticipantDecorator < BaseDecorator
 
         property :name
@@ -17,8 +14,7 @@ module PactBroker
         link :self do | options |
           pacticipant_url(options[:base_url], represented)
         end
-
       end
     end
   end
-end
+end

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

@@ -5,7 +5,6 @@ module PactBroker
   module Api
     module Decorators
       class PactVersionsDecorator < BaseDecorator
-
         collection :entries, as: :pacts, embedded: true, :extend => PactBroker::Api::Decorators::PactVersionDecorator
 
         link :self do | context |

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

@@ -6,7 +6,6 @@ require_relative "triggered_webhook_decorator"
 module PactBroker
   module Api
     module Decorators
-
       class PactWebhooksStatusDecorator < BaseDecorator
 
         property :summary, exec_context: :decorator do

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

@@ -0,0 +1,32 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/timestamps"
+require "pact_broker/api/decorators/pagination_links"
+require "pact_broker/api/decorators/branch_decorator"
+
+module PactBroker
+  module Api
+    module Decorators
+      class PacticipantBranchesDecorator < BaseDecorator
+        collection :entries, as: :branches, embedded: true, :extend => PactBroker::Api::Decorators::BranchDecorator
+
+        link :self do | user_options |
+          {
+            title: "#{user_options.fetch(:pacticipant).name} branches",
+            href: user_options.fetch(:request_url)
+          }
+        end
+
+        links "pb:branches" do | user_options |
+          represented.collect do | branch |
+            {
+              name: branch.name,
+              href: branch_url(branch, user_options.fetch(:base_url))
+            }
+          end
+        end
+
+        include PaginationLinks
+      end
+    end
+  end
+end

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

@@ -19,12 +19,18 @@ module PactBroker
         property :repository_namespace
         property :main_branch
 
-
         property :latest_version, as: :latestVersion, :class => PactBroker::Domain::Version, extend: PactBroker::Api::Decorators::EmbeddedVersionDecorator, embedded: true, writeable: false
         collection :labels, :class => PactBroker::Domain::Label, extend: PactBroker::Api::Decorators::EmbeddedLabelDecorator, embedded: true
 
         include Timestamps
 
+        # The associations that should be eager loaded on the Pacticipant so that this
+        # decorator can be used without any extra calls to the database.
+        # @return Array<Symbol>
+        def self.eager_load_associations
+          [:labels, :latest_version]
+        end
+
         link :self do | options |
           pacticipant_url(options[:base_url], represented)
         end
@@ -33,6 +39,10 @@ module PactBroker
           versions_url(options[:base_url], represented)
         end
 
+        link :'pb:branches' do | options |
+          pacticipant_branches_url(represented, options[:base_url])
+        end
+
         link :'pb:version' do | options |
           {
             title: "Get, create or delete a pacticipant version",

data/lib/pact_broker/api/decorators/{pacticipant_collection_decorator.rb → pacticipants_decorator.rb}

@@ -8,12 +8,16 @@ require "pact_broker/api/decorators/pacticipant_decorator"
 module PactBroker
   module Api
     module Decorators
-      class PacticipantCollectionDecorator < BaseDecorator
+      class PacticipantsDecorator < BaseDecorator
 
         collection :entries, :as => :pacticipants, :class => PactBroker::Domain::Pacticipant, :extend => PactBroker::Api::Decorators::PacticipantDecorator, embedded: true
 
         include PaginationLinks
 
+        def self.eager_load_associations
+          PactBroker::Api::Decorators::PacticipantDecorator.eager_load_associations
+        end
+
         link :self do | options |
           pacticipants_url options[:base_url]
         end
@@ -27,12 +31,12 @@ module PactBroker
         end
 
         links :'pb:pacticipants' do | options |
-          represented.collect{ | pacticipant | {:href => pacticipant_url(options[:base_url], pacticipant), title: "Pacticipant", name: pacticipant.name } }
+          represented.collect{ | pacticipant | { href: pacticipant_url(options[:base_url], pacticipant), title: "Pacticipant", name: pacticipant.name } }
         end
 
         # TODO deprecate in v3
         links :pacticipants do | options |
-          represented.collect{ | pacticipant | {:href => pacticipant_url(options[:base_url], pacticipant), :title => pacticipant.name, name: "DEPRECATED - please use pb:pacticipants" } }
+          represented.collect{ | pacticipant | { href: pacticipant_url(options[:base_url], pacticipant), :title => pacticipant.name, name: "DEPRECATED - please use pb:pacticipants" } }
         end
       end
 
@@ -45,7 +49,7 @@ module PactBroker
       end
 
       # TODO deprecate this - breaking change for v 3.0
-      class DeprecatedPacticipantCollectionDecorator < PacticipantCollectionDecorator
+      class DeprecatedPacticipantsDecorator < PacticipantsDecorator
         def to_hash(options)
           embedded_pacticipant_hash = super
           non_embedded_pacticipant_hash = NonEmbeddedPacticipantCollectionDecorator.new(represented).to_hash(options)

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

@@ -24,7 +24,7 @@ module PactBroker
               represented.respond_to?(:page_count) &&
               represented.current_page < represented.page_count
             {
-              href: context[:resource_url] + "?pageSize=#{represented.page_size}&pageNumber=#{represented.current_page + 1}",
+              href: context[:resource_url] + "?size=#{represented.page_size}&page=#{represented.current_page + 1}",
               title: "Next page"
             }
 
@@ -34,7 +34,7 @@ module PactBroker
         link :previous do | context |
           if represented.respond_to?(:first_page?) && !represented.first_page?
             {
-              href: context[:resource_url] + "?pageSize=#{represented.page_size}&pageNumber=#{represented.current_page - 1}",
+              href: context[:resource_url] + "?size=#{represented.page_size}&page=#{represented.current_page - 1}",
               title: "Previous page"
             }
           end

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

@@ -1,11 +1,11 @@
 require "pact_broker/api/decorators/base_decorator"
-require "pact_broker/api/decorators/released_version_decorator"
+require "pact_broker/api/decorators/embedded_released_version_decorator"
 
 module PactBroker
   module Api
     module Decorators
       class ReleasedVersionsDecorator < BaseDecorator
-        collection :entries, as: :releasedVersions, embedded: true, :extend => PactBroker::Api::Decorators::ReleasedVersionDecorator
+        collection :entries, as: :releasedVersions, embedded: true, :extend => PactBroker::Api::Decorators::EmbeddedReleasedVersionDecorator
 
         link :self do | context |
           href = append_query_if_present(context[:resource_url], context[:query_string])

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

@@ -3,7 +3,7 @@
 module PactBroker
   module Api
     module Decorators
-      class RuntimeErrorProblemJSONDecorator
+      class RuntimeErrorProblemJsonDecorator
 
         # @param message [String]
         def initialize(message)
@@ -14,7 +14,7 @@ module PactBroker
         def to_hash(user_options:, **)
           {
             "title" => "Server error",
-            "type" => "#{user_options[:base_url]}/problems/server_error",
+            "type" => "#{user_options[:base_url]}/problems/server-error",
             "detail" => message,
             "status" => 500
           }

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

@@ -0,0 +1,30 @@
+# Formats a nested Hash of errors, or an Array of Strings, into the "old" Pact Broker errors format
+# TODO: delete this in favour of problem+json in the next major version
+
+module PactBroker
+  module Api
+    module Decorators
+      class ValidationErrorsDecorator
+
+        # @param errors [Hash, Array<String>]
+        def initialize(errors)
+          @errors = errors
+        end
+
+        # @return [Hash]
+        def to_hash(*_args, **_kwargs)
+          { errors: errors }
+        end
+
+        # @return [String] JSON
+        def to_json(*args, **kwargs)
+          to_hash(*args, **kwargs).to_json
+        end
+
+        private
+
+        attr_reader :errors
+      end
+    end
+  end
+end

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

@@ -1,11 +1,10 @@
-# Formats a nested Hash of errors as it comes out of the Dry Validation library
-# into application/problem+json format.
+# Formats a nested Hash of errors into application/problem+json format.
 require "pact_broker/string_refinements"
 
 module PactBroker
   module Api
     module Decorators
-      class ValidationErrorsProblemJSONDecorator
+      class ValidationErrorsProblemJsonDecorator
         using PactBroker::StringRefinements
 
 
@@ -53,9 +52,8 @@ module PactBroker
         def append_error(list, message, path, base_url)
           error = {
             "type" => "#{base_url}/problems/invalid-body-property-value",
-            "title" => "Validation error",
-            "detail" => message,
-            "status" => 400
+            "title" => "Invalid body parameter",
+            "detail" => message
           }
           error["pointer"] = path.tr(".", "/") if path.present?
           list << error

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

@@ -1,5 +1,6 @@
 require_relative "base_decorator"
 require_relative "embedded_tag_decorator"
+require_relative "embedded_branch_version_decorator"
 
 module PactBroker
   module Api
@@ -20,7 +21,8 @@ module PactBroker
           {
             title: "Version",
             name: represented.number,
-            href: version_url(options.fetch(:base_url), represented)
+            # This decorator is used for multiple Version resources, so dynamically fetch the current resource URL
+            href: options.fetch(:resource_url)
           }
         end
 
@@ -58,7 +60,7 @@ module PactBroker
         end
 
         links :'pb:record-deployment' do | context |
-          context.fetch(:environments, []).collect do | environment |
+          context[:environments]&.collect do | environment |
             {
               title: "Record deployment to #{environment.display_name}",
               name: environment.name,
@@ -68,7 +70,7 @@ module PactBroker
         end
 
         links :'pb:record-release' do | context |
-          context.fetch(:environments, []).collect do | environment |
+          context[:environments]&.collect do | environment |
             {
               title: "Record release to #{environment.display_name}",
               name: environment.name,

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

@@ -6,46 +6,56 @@ module PactBroker
   module Api
     module Decorators
       class VersionsDecorator < BaseDecorator
+        class VersionInCollectionDecorator < PactBroker::Api::Decorators::VersionDecorator
+          # VersionDecorator has a dynamic self URL, depending which path the Version resource is mounted at.
+          # Hardcode the URL of the embedded Versions in this collection to use the canonical URL with the version number.
+          link :self do | user_options |
+            {
+              title: "Version",
+              name: represented.number,
+              href: version_url(user_options.fetch(:base_url), represented)
+            }
+          end
+        end
 
-        collection :entries, as: :versions, embedded: true, :extend => PactBroker::Api::Decorators::VersionDecorator
+        collection :entries, as: :versions, embedded: true, :extend => VersionInCollectionDecorator
 
-        link :self do | context |
-          href = append_query_if_present(context[:resource_url], context[:query_string])
+        link :self do | user_options |
           {
-            href: href,
-            title: "All application versions of #{context[:pacticipant_name]}"
+            href: user_options.fetch(:request_url),
+            title: user_options[:resource_title] || "All application versions of #{user_options[:pacticipant_name]}"
           }
         end
 
         include PaginationLinks
 
-        link :'pb:pacticipant' do | context |
+        link :'pb:pacticipant' do | user_options |
           {
-            href: pacticipant_url(context[:base_url], OpenStruct.new(name: context[:pacticipant_name])),
-            title: context[:pacticipant_name]
+            href: pacticipant_url(user_options[:base_url], OpenStruct.new(name: user_options[:pacticipant_name])),
+            title: user_options[:pacticipant_name]
           }
         end
 
-        links :'pb:versions' do | context |
+        links :'pb:versions' do | user_options |
           represented.collect do | version |
             {
-              :href => version_url(context[:base_url], version),
+              :href => version_url(user_options[:base_url], version),
               :title => version.version_and_updated_date
             }
           end
         end
 
-        link :pacticipant do | context |
+        link :pacticipant do | user_options |
           {
-            href: pacticipant_url(context[:base_url], OpenStruct.new(name: context[:pacticipant_name])),
+            href: pacticipant_url(user_options[:base_url], OpenStruct.new(name: user_options[:pacticipant_name])),
             title: "Deprecated - please use pb:pacticipant"
           }
         end
 
-        links :'versions' do | context |
+        links :'versions' do | user_options |
           represented.collect do | version |
             {
-              :href => version_url(context[:base_url], version),
+              :href => version_url(user_options[:base_url], version),
               :title => "Deprecated - please use pb:versions"
             }
           end

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

@@ -65,6 +65,7 @@ module PactBroker
         property :logs
         property :success?, as: :success
 
+        #TODO rename to pb:webhook in next major version
         link :webhook do | options |
           if options.fetch(:webhook).uuid
             {
@@ -73,6 +74,7 @@ module PactBroker
           end
         end
 
+        #TODO rename to pb:try-again in next major version
         link :'try-again' do | options |
           {
             title: "Execute the webhook again",

data/lib/pact_broker/api/middleware/configuration.rb

@@ -1,5 +1,7 @@
 require "pact_broker/logging"
 
+# Allows the load-time configuration to be overridden on a per-request basis (for Pactflow)
+
 module PactBroker
   module Api
     module Middleware