pact_broker 2.110.0 → 2.111.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0747ca988604f56bec96bb0511242e8b3e9e2c18c823ec53742a1c58f80eee16
-  data.tar.gz: fbdc8b9be85cf443ccd8ddcb58704a1aece12759e267aea1b4f79ba0d05fbf9c
+  metadata.gz: e21e3c2fc82cfe4697582921613bd435e026cf6f381c64c33d703b8c31c586be
+  data.tar.gz: 6b6bc75a486f936441b172c7a80a7e8541f3bbb1731be03b1e33a869327014bf
 SHA512:
-  metadata.gz: 416b29a9c6fe749e990ce9a051e526568d1a453c78db704d68e63002bb0ba1c17f8117b1d54ec540bea609168e26d2e7583bf087394aa249d9bacd6f0ad58ea5
-  data.tar.gz: b729576d06caac277699def3e48bfd1c75400467018da3b740fad3ff1ba84e628388369dddb60f964cf4b948d66d27096feca800f8e80314be762d327cdd1e54
+  metadata.gz: 2afe779170a4910f06ace0a29b8ee66fa81bc355fc1a1c22a532fb3f9f64f5775309543c23b3b7ae4c4c837c1a66d0b10ddb0f62e8e9f586b7fd4942dc29d33c
+  data.tar.gz: 3b2738f3785dc1c272d4e1ba24104b4786bd467780808d41bdf2dd7f2ce0e83f0f11645a8ca3b8fd16642055a897d60b573ea7fc8392751cf0a59ecafeba6130

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+<a name="v2.111.0"></a>
+### v2.111.0 (2024-07-26)
+
+#### Features
+
+* add new label api (#703)	 ([ff3f84e2](/../../commit/ff3f84e2))
+* search pacticipants by display_name	 ([c5945801](/../../commit/c5945801))
+
+#### Bug Fixes
+
+* **docs**
+  * Update OAS with correct ref to Notice schema	 ([6729b7f8](/../../commit/6729b7f8))
+
 <a name="v2.110.0"></a>
 ### v2.110.0 (2024-04-02)
 

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

@@ -11,20 +11,26 @@ module PactBroker
 
         include Timestamps
 
-        link :self do | options |
-          {
-            title: "Label",
-            name: represented.name,
-            href: label_url(represented, options[:base_url])
-          }
-        end
+        # This method is overridden to conditionally render the links based on the user_options
+        def to_hash(options)
+          hash = super
+
+          unless options.dig(:user_options, :hide_label_decorator_links)
+            hash[:_links] = {
+              self: {
+                title: "Label",
+                name: represented.name,
+                href: label_url(represented, options.dig(:user_options, :base_url))
+              },
+              pacticipant: {
+                title: "Pacticipant",
+                name: represented.pacticipant.name,
+                href: pacticipant_url(options.dig(:user_options, :base_url), represented.pacticipant)
+              }
+            }
+          end
 
-        link :pacticipant do | options |
-          {
-            title: "Pacticipant",
-            name: represented.pacticipant.name,
-            href: pacticipant_url(options.fetch(:base_url), represented.pacticipant)
-          }
+          hash
         end
       end
     end

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

@@ -0,0 +1,23 @@
+require_relative "base_decorator"
+require_relative "pagination_links"
+require_relative "label_decorator"
+require "pact_broker/domain/label"
+
+module PactBroker
+  module Api
+    module Decorators
+      class LabelsDecorator < BaseDecorator
+        collection :entries, :as => :labels, :class => PactBroker::Domain::Label, :extend => PactBroker::Api::Decorators::LabelDecorator, embedded: true
+
+        include PaginationLinks
+
+        link :self do | options |
+          {
+            title: "Labels",
+            href: options.fetch(:resource_url)
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -20,7 +20,7 @@ module PactBroker
         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
+        collection :labels, :class => PactBroker::Domain::Label, extend: PactBroker::Api::Decorators::EmbeddedLabelDecorator, embedded: true, writeable: false
 
         include Timestamps
 

data/lib/pact_broker/api/paths.rb

@@ -3,11 +3,12 @@ module PactBroker
     module Paths
       PACT_BADGE_PATH =         %r{^/pacts/provider/[^/]+/consumer/.*/badge(?:\.[A-Za-z]+)?$}.freeze
       MATRIX_BADGE_PATH =       %r{^/matrix/provider/[^/]+/latest/[^/]+/consumer/[^/]+/latest/[^/]+/badge(?:\.[A-Za-z]+)?$}.freeze
+      CAN_I_MERGE_BADGE_PATH = %r{^/pacticipants/[^/]+/main-branch/can-i-merge/badge(?:\.[A-Za-z]+)?$}.freeze
       CAN_I_DEPLOY_TAG_BADGE_PATH = %r{^/pacticipants/[^/]+/latest-version/[^/]+/can-i-deploy/to/[^/]+/badge(?:\.[A-Za-z]+)?$}.freeze
       CAN_I_DEPLOY_BRANCH_ENV_BADGE_PATH = %r{^/pacticipants/[^/]+/branches/[^/]+/latest-version/can-i-deploy/to-environment/[^/]+/badge(?:\.[A-Za-z]+)?$}.freeze
       VERIFICATION_RESULTS =    %r{^/pacts/provider/[^/]+/consumer/[^/]+/pact-version/[^/]+/verification-results/[^/]+}
 
-      BADGE_PATHS = [PACT_BADGE_PATH, MATRIX_BADGE_PATH, CAN_I_DEPLOY_TAG_BADGE_PATH, CAN_I_DEPLOY_BRANCH_ENV_BADGE_PATH]
+      BADGE_PATHS = [PACT_BADGE_PATH, MATRIX_BADGE_PATH, CAN_I_DEPLOY_TAG_BADGE_PATH, CAN_I_DEPLOY_BRANCH_ENV_BADGE_PATH, CAN_I_MERGE_BADGE_PATH]
 
       extend self
 

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

@@ -0,0 +1,36 @@
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/api/resources/badge_methods"
+
+module PactBroker
+  module Api
+    module Resources
+      class CanIMergeBadge < BaseResource
+        include BadgeMethods # This module contains all necessary webmachine methods for badge implementation
+
+        def badge_url 
+          if pacticipant.nil? # pacticipant method is defined in BaseResource
+            # if the pacticipant is nil, we return an error badge url
+            badge_service.error_badge_url("pacticipant", "not found")
+          elsif version.nil?
+            # when there is no main branch version, we return an error badge url
+            badge_service.error_badge_url("main branch version", "not found")
+          else
+            # we call badge_service to build the badge url
+            badge_service.can_i_merge_badge_url(deployable: results)
+          end
+        end
+        
+        private
+
+        def results
+          # can_i_merge returns true or false if the main branch version is compatible with all the integrations
+          @results ||= matrix_service.can_i_merge(pacticipant: pacticipant, latest_main_branch_version: version)
+        end
+
+        def version
+          @version ||= version_service.find_latest_version_from_main_branch(pacticipant) 
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require "pact_broker/api/resources/base_resource"
+require "pact_broker/api/decorators/labels_decorator"
+require "pact_broker/api/resources/pagination_methods"
+
+module PactBroker
+  module Api
+    module Resources
+      class Labels < BaseResource
+        include PaginationMethods
+
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def allowed_methods
+          ["GET", "OPTIONS"]
+        end
+
+        def policy_name
+          :'labels::labels'
+        end
+
+        def to_json
+          decorator_class(:labels_decorator).new(labels).to_json(
+            **decorator_options(
+              hide_label_decorator_links: true,
+            )
+          )
+        end
+
+        def labels
+          label_service.get_all_unique_labels(pagination_options)
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api.rb

@@ -85,6 +85,9 @@ module PactBroker
         add ["pacticipants", :pacticipant_name], Api::Resources::Pacticipant, {resource_name: "pacticipant"}
         add ["pacticipants", :pacticipant_name, "labels", :label_name], Api::Resources::Label, {resource_name: "pacticipant_label"}
 
+        # Labels
+        add ["labels"], Api::Resources::Labels, {resource_name: "labels"}
+
         # Versions
         add ["pacticipants", :pacticipant_name, "versions"], Api::Resources::Versions, {resource_name: "pacticipant_versions"}
         add ["pacticipants", :pacticipant_name, "branches", :branch_name, "versions"], Api::Resources::BranchVersions, {resource_name: "pacticipant_branch_versions"}
@@ -92,6 +95,7 @@ module PactBroker
         add ["pacticipants", :pacticipant_name, "latest-version", :tag], Api::Resources::LatestVersion, {resource_name: "latest_tagged_pacticipant_version"}
         add ["pacticipants", :pacticipant_name, "latest-version", :tag, "can-i-deploy", "to", :to], Api::Resources::CanIDeployPacticipantVersionByTagToTag, { resource_name: "can_i_deploy_latest_tagged_version_to_tag" }
         add ["pacticipants", :pacticipant_name, "latest-version", :tag, "can-i-deploy", "to", :to, "badge"], Api::Resources::CanIDeployPacticipantVersionByTagToTagBadge, { resource_name: "can_i_deploy_latest_tagged_version_to_tag_badge" }
+        add ["pacticipants", :pacticipant_name, "main-branch", "can-i-merge", "badge"], Api::Resources::CanIMergeBadge, { resource_name: "can_i_merge_badge" }
         add ["pacticipants", :pacticipant_name, "latest-version"], Api::Resources::LatestVersion, {resource_name: "latest_pacticipant_version"}
         add ["pacticipants", :pacticipant_name, "versions", :pacticipant_version_number, "tags", :tag_name], Api::Resources::Tag, {resource_name: "pacticipant_version_tag"}
         add ["pacticipants", :pacticipant_name, "branches"], Api::Resources::PacticipantBranches, {resource_name: "pacticipant_branches"}

data/lib/pact_broker/badges/service.rb

@@ -40,6 +40,24 @@ module PactBroker
         build_shield_io_uri(title, status, color)
       end
 
+      def can_i_merge_badge_url(deployable: nil)
+        title = "can-i-merge"
+        
+        # rubocop:disable Layout/EndAlignment
+        color, status = case deployable
+        when nil
+          [ "lightgrey", "unknown" ]
+        when true
+          [ "brightgreen", "success" ]
+        else
+          [ "red", "failed" ]
+        end
+        # rubocop:enable Layout/EndAlignment
+
+        # left text is "can-i-merge", right text is the version number
+        build_shield_io_uri(title, status, color)
+      end
+
       def error_badge_url(left_text, right_text)
         build_shield_io_uri(left_text, right_text, "lightgrey")
       end

data/lib/pact_broker/labels/repository.rb

@@ -3,6 +3,11 @@ require "pact_broker/domain/label"
 module PactBroker
   module Labels
     class Repository
+
+      def get_all_unique_labels pagination_options = {}
+        PactBroker::Domain::Label.distinct.select(:name).all_with_pagination_options(pagination_options)
+      end
+
       def create args
         Domain::Label.new(name: args.fetch(:name), pacticipant: args.fetch(:pacticipant)).save
       end

data/lib/pact_broker/labels/service.rb

@@ -9,6 +9,10 @@ module PactBroker
 
       extend PactBroker::Repositories
 
+      def get_all_unique_labels pagination_options = {}
+        label_repository.get_all_unique_labels(pagination_options)
+      end
+
       def create args
         pacticipant = pacticipant_repository.find_by_name_or_create args.fetch(:pacticipant_name)
         label_repository.create pacticipant: pacticipant, name: args.fetch(:label_name)

data/lib/pact_broker/matrix/service.rb

@@ -22,6 +22,32 @@ module PactBroker
         QueryResultsWithDeploymentStatusSummary.new(query_results, DeploymentStatusSummary.new(query_results))
       end
 
+      def can_i_merge(pacticipant_name: nil, pacticipant: nil, latest_main_branch_version: nil)
+        # first we find the pacticipant by name (or use the one passed in) if pacticipant is nil
+        if pacticipant.nil?
+          pacticipant = pacticipant_service.find_pacticipant_by_name(pacticipant_name)
+          raise PactBroker::Error.new("No pacticipant found with name '#{pacticipant_name}'") unless pacticipant
+        else
+          pacticipant_name = pacticipant.name
+        end
+         
+        # then we find the latest version from the main branch if not passed in
+        if latest_main_branch_version.nil?
+          latest_main_branch_version = version_service.find_latest_version_from_main_branch(pacticipant)
+          raise PactBroker::Error.new("No main branch version found for pacticipant '#{pacticipant_name}'") unless latest_main_branch_version
+        end
+
+        selectors = PactBroker::Matrix::UnresolvedSelector.from_hash(
+          pacticipant_name: pacticipant_name, 
+          pacticipant_version_number: latest_main_branch_version.number
+        )
+         
+        options = { main_branch: true, latest: true, latestby: "cvp" }
+        query_results = can_i_deploy([selectors], options)
+   
+        query_results.deployable?
+      end
+
       def find selectors, options = {}
         logger.info "Querying matrix", selectors: selectors, options: options
         matrix_repository.find(selectors, options)

data/lib/pact_broker/pacticipants/repository.rb

@@ -102,7 +102,16 @@ module PactBroker
 
       def search_by_name(pacticipant_name)
         terms = pacticipant_name.split.map { |v| v.gsub("_", "\\_") }
-        string_match_query = Sequel.|( *terms.map { |term| Sequel.ilike(Sequel[:pacticipants][:name], "%#{term}%") })
+        columns = [:name, :display_name]
+        string_match_query = Sequel.|(
+          *terms.map do |term|
+            Sequel.|(
+              *columns.map do |column|
+                Sequel.ilike(Sequel[:pacticipants][column], "%#{term}%")
+              end
+            )
+          end
+        )
         scope_for(PactBroker::Domain::Pacticipant).where(string_match_query)
       end
 

data/lib/pact_broker/test/test_data_builder.rb

@@ -165,9 +165,16 @@ module PactBroker
 
       def create_pacticipant pacticipant_name, params = {}
         params.delete(:comment)
+        version_to_create = params.delete(:version)
+
         repository_url = "https://github.com/#{params[:repository_namespace] || "example-organization"}/#{params[:repository_name] || pacticipant_name}"
         merged_params = { name: pacticipant_name, repository_url: repository_url }.merge(params)
         @pacticipant = PactBroker::Domain::Pacticipant.create(merged_params)
+
+        version = create_pacticipant_version(version_to_create, @pacticipant) if version_to_create
+        main_branch = params[:main_branch]
+        PactBroker::Versions::BranchVersionRepository.new.add_branch(version, main_branch) if version && main_branch
+
         self
       end
 
@@ -639,8 +646,6 @@ module PactBroker
          }.to_json
       end
 
-      private
-
       def create_pacticipant_version(version_number, pacticipant, params = {})
         params.delete(:comment)
         tag_names = [params.delete(:tag_names), params.delete(:tag_name)].flatten.compact
@@ -665,6 +670,8 @@ module PactBroker
         version
       end
 
+      private
+
       def create_deployed_version(uuid: , currently_deployed: , version:, environment_name: , target: nil, created_at: nil)
         env = find_environment(environment_name)
         @deployed_version = PactBroker::Deployments::DeployedVersionService.find_or_create(uuid, version, env, target)

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = "2.110.0"
+  VERSION = "2.111.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.110.0
+  version: 2.111.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 2024-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -654,6 +654,7 @@ files:
 - lib/pact_broker/api/decorators/integration_decorator.rb
 - lib/pact_broker/api/decorators/integrations_decorator.rb
 - lib/pact_broker/api/decorators/label_decorator.rb
+- lib/pact_broker/api/decorators/labels_decorator.rb
 - lib/pact_broker/api/decorators/latest_pact_decorator.rb
 - lib/pact_broker/api/decorators/matrix_decorator.rb
 - lib/pact_broker/api/decorators/matrix_text_decorator.rb
@@ -720,6 +721,7 @@ files:
 - lib/pact_broker/api/resources/can_i_deploy_pacticipant_version_by_branch_to_environment_badge.rb
 - lib/pact_broker/api/resources/can_i_deploy_pacticipant_version_by_tag_to_tag.rb
 - lib/pact_broker/api/resources/can_i_deploy_pacticipant_version_by_tag_to_tag_badge.rb
+- lib/pact_broker/api/resources/can_i_merge_badge.rb
 - lib/pact_broker/api/resources/clean.rb
 - lib/pact_broker/api/resources/currently_deployed_versions_for_environment.rb
 - lib/pact_broker/api/resources/currently_supported_versions_for_environment.rb
@@ -739,6 +741,7 @@ files:
 - lib/pact_broker/api/resources/integration.rb
 - lib/pact_broker/api/resources/integrations.rb
 - lib/pact_broker/api/resources/label.rb
+- lib/pact_broker/api/resources/labels.rb
 - lib/pact_broker/api/resources/latest_pact.rb
 - lib/pact_broker/api/resources/latest_pacts.rb
 - lib/pact_broker/api/resources/latest_provider_pacts.rb
@@ -1265,7 +1268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
+rubygems_version: 3.5.17
 signing_key:
 specification_version: 4
 summary: See description