pact_broker 2.77.0 → 2.80.0

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

@@ -1,6 +1,6 @@
-require_relative 'base_decorator'
-require 'pact_broker/json'
-require 'pact_broker/api/decorators/timestamps'
+require_relative "base_decorator"
+require "pact_broker/json"
+require "pact_broker/api/decorators/timestamps"
 
 module PactBroker
   module Api
@@ -20,7 +20,7 @@ module PactBroker
 
         link :self do | options |
           {
-            title: 'Pact',
+            title: "Pact",
             name: represented.name,
             href: pact_url(options.fetch(:base_url), represented)
           }
@@ -177,7 +177,7 @@ module PactBroker
         curies do | options |
           [{
             name: :pb,
-            href: options[:base_url] + '/doc/{rel}?context=pact',
+            href: options[:base_url] + "/doc/{rel}?context=pact",
             templated: true
           }]
         end

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

@@ -1,5 +1,5 @@
-require_relative 'base_decorator'
-require_relative 'pact_pacticipant_decorator'
+require_relative "base_decorator"
+require_relative "pact_pacticipant_decorator"
 
 module PactBroker
   module Api

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

@@ -1,6 +1,6 @@
-require 'pact_broker/api/pact_broker_urls'
-require_relative 'embedded_version_decorator'
-require_relative 'base_decorator'
+require "pact_broker/api/pact_broker_urls"
+require_relative "embedded_version_decorator"
+require_relative "base_decorator"
 
 module PactBroker
 

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

@@ -1,6 +1,6 @@
-require_relative 'base_decorator'
-require_relative 'pact_pacticipant_decorator'
-require 'pact_broker/api/decorators/timestamps'
+require_relative "base_decorator"
+require_relative "pact_pacticipant_decorator"
+require "pact_broker/api/decorators/timestamps"
 
 module PactBroker
   module Api

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

@@ -1,5 +1,5 @@
-require_relative 'base_decorator'
-require_relative 'pact_version_decorator'
+require_relative "base_decorator"
+require_relative "pact_version_decorator"
 
 module PactBroker
   module Api

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

@@ -1,7 +1,7 @@
-require_relative 'base_decorator'
-require_relative 'timestamps'
-require_relative 'pact_version_decorator'
-require_relative 'triggered_webhook_decorator'
+require_relative "base_decorator"
+require_relative "timestamps"
+require_relative "pact_version_decorator"
+require_relative "triggered_webhook_decorator"
 
 module PactBroker
   module Api
@@ -71,8 +71,8 @@ module PactBroker
         end
 
         def summary
-          counts = represented.group_by(&:status).each_with_object({}) do | (status, triggered_webhooks), counts |
-            counts[status] = triggered_webhooks.count
+          counts = represented.group_by(&:status).each_with_object({}) do | (status, triggered_webhooks), count |
+            count[status] = triggered_webhooks.count
           end
           OpenStruct.new(counts)
         end

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

@@ -1,8 +1,8 @@
-require 'roar/json/hal'
-require 'pact_broker/api/pact_broker_urls'
-require_relative 'embedded_version_decorator'
-require 'pact_broker/domain/pacticipant'
-require 'pact_broker/api/decorators/pacticipant_decorator'
+require "roar/json/hal"
+require "pact_broker/api/pact_broker_urls"
+require_relative "embedded_version_decorator"
+require "pact_broker/domain/pacticipant"
+require "pact_broker/api/decorators/pacticipant_decorator"
 
 module PactBroker
   module Api
@@ -24,17 +24,17 @@ 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
 
       class DeprecatedPacticipantDecorator < PactBroker::Api::Decorators::PacticipantDecorator
-        property :title, getter: ->(something) { "DEPRECATED - Please use the embedded pacticipants collection" }
+        property :title, getter: ->(_something) { "DEPRECATED - Please use the embedded pacticipants collection" }
       end
 
       class NonEmbeddedPacticipantCollectionDecorator < BaseDecorator

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

@@ -1,16 +1,24 @@
-require_relative 'base_decorator'
-require_relative 'embedded_version_decorator'
-require_relative 'embedded_label_decorator'
-require_relative 'timestamps'
-require 'pact_broker/domain'
+require_relative "base_decorator"
+require_relative "embedded_version_decorator"
+require_relative "embedded_label_decorator"
+require_relative "timestamps"
+require "pact_broker/feature_toggle"
+
+require "pact_broker/domain"
 
 module PactBroker
   module Api
     module Decorators
       class PacticipantDecorator < BaseDecorator
+        camelize_property_names
 
         property :name
-        property :repository_url, as: :repositoryUrl
+        property :display_name
+        property :repository_url
+        property :repository_name
+        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
@@ -25,6 +33,14 @@ module PactBroker
           versions_url(options[:base_url], represented)
         end
 
+        link :'pb:version' do | options |
+          {
+            title: "Get, create or delete a pacticipant version",
+            href: templated_version_url_for_pacticipant(represented.name, options[:base_url]),
+            templated: true
+          }
+        end
+
         link :'pb:version-tag' do | options |
           {
             title: "Get, create or delete a tag for a version of #{represented.name}",
@@ -69,7 +85,7 @@ module PactBroker
         curies do | options |
           [{
             name: :pb,
-            href: options[:base_url] + '/doc/{rel}?context=pacticipant',
+            href: options[:base_url] + "/doc/{rel}?context=pacticipant",
             templated: true
           }]
         end
@@ -77,13 +93,13 @@ module PactBroker
         def to_hash options
           h = super
           dasherized = DasherizedVersionDecorator.new(represented).to_hash(options)
-          if dasherized['_embedded']
-            if dasherized['_embedded']['latest-version']
-              dasherized['_embedded']['latest-version']['title'] = 'DEPRECATED - please use latestVersion'
-              dasherized['_embedded']['latest-version']['name'] = 'DEPRECATED - please use latestVersion'
+          if dasherized["_embedded"]
+            if dasherized["_embedded"]["latest-version"]
+              dasherized["_embedded"]["latest-version"]["title"] = "DEPRECATED - please use latestVersion"
+              dasherized["_embedded"]["latest-version"]["name"] = "DEPRECATED - please use latestVersion"
             end
-            h['_embedded'] ||= {}
-            h['_embedded'].merge!(dasherized['_embedded'])
+            h["_embedded"] ||= {}
+            h["_embedded"].merge!(dasherized["_embedded"])
           end
           h
         end

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

@@ -1,5 +1,5 @@
-require 'roar/decorator'
-require 'roar/json/hal'
+require "roar/decorator"
+require "roar/json/hal"
 
 module PactBroker
   module Api

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

@@ -1,5 +1,5 @@
-require_relative 'base_decorator'
-require_relative 'pact_version_decorator'
+require_relative "base_decorator"
+require_relative "pact_version_decorator"
 
 module PactBroker
   module Api
@@ -7,7 +7,6 @@ module PactBroker
       class ProviderPactsDecorator < BaseDecorator
 
         link :self do | context |
-          suffix = context[:tag] ? " with tag '#{context[:tag]}'" : ""
           {
             href: context[:resource_url],
             title: context[:title]

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

@@ -0,0 +1,19 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/timestamps"
+
+module PactBroker
+  module Api
+    module Decorators
+      class PublishContractDecorator < BaseDecorator
+        camelize_property_names
+
+        property :consumer_name
+        property :provider_name
+        property :specification
+        property :content_type
+        property :decoded_content
+        property :on_conflict, default: "overwrite"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/publish_contract_decorator"
+require "pact_broker/contracts/contract_to_publish"
+
+module PactBroker
+  module Api
+    module Decorators
+      class PublishContractsDecorator < BaseDecorator
+        camelize_property_names
+
+        property :pacticipant_name
+        property :pacticipant_version_number
+        property :tags
+        property :branch
+        property :build_url
+
+        collection :contracts, :extend => PublishContractDecorator, class: PactBroker::Contracts::ContractToPublish
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/publish_contract_decorator"
+require "pact_broker/api/decorators/embedded_version_decorator"
+
+module PactBroker
+  module Api
+    module Decorators
+      class PublishContractsResultsDecorator < BaseDecorator
+        camelize_property_names
+
+        property :logs, getter: ->(represented:, **) { represented.notices.collect{ | notice | { level: notice.type, message: notice.text, deprecationWarning: "Replaced by notices" } } }
+        property :notices, getter: ->(represented:, **) { represented.notices.collect(&:to_h) }
+
+        property :pacticipant, embedded: true, extend: EmbeddedPacticipantDecorator
+        property :version, embedded: true, extend: EmbeddedVersionDecorator
+
+        link :'pb:pacticipant' do | options |
+          {
+            title: "Pacticipant",
+            name: represented.pacticipant.name,
+            href: pacticipant_url(options.fetch(:base_url), represented.pacticipant)
+          }
+        end
+
+        link :'pb:pacticipant-version' do | options |
+          {
+            title: "Pacticipant version",
+            name: represented.version.number,
+            href: version_url(options.fetch(:base_url), represented.version)
+          }
+        end
+
+        links :'pb:pacticipant-version-tags' do | options |
+          represented.tags.collect do | tag |
+            {
+              title: "Tag",
+              name: tag.name,
+              href: tag_url(options.fetch(:base_url), tag)
+            }
+          end
+        end
+
+        links :'pb:contracts' do | options |
+          represented.contracts.collect do | contract |
+            {
+              title: "Pact",
+              name: contract.name,
+              href: pact_url(options.fetch(:base_url), contract)
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,21 +1,34 @@
-require 'pact_broker/matrix/reason'
+require "pact_broker/matrix/reason"
 
 module PactBroker
   module Api
     module Decorators
       class ReasonDecorator
         def initialize(reason)
-          @reason = reason
+          if reason.is_a?(PactBroker::Matrix::IgnoredReason)
+            @reason = reason.root_reason
+            @ignored = true
+          else
+            @reason = reason
+            @ignored = false
+          end
         end
 
         def to_s
+          (ignored ? "Ignoring: " : "") + reason_text
+        end
+
+        private
+
+        attr_reader :reason, :ignored
+
+        # rubocop: disable Metrics/CyclomaticComplexity
+        def reason_text
           case reason
           when PactBroker::Matrix::PactNotEverVerifiedByProvider
             "There is no verified pact between #{reason.consumer_selector.description} and #{reason.provider_selector.description}"
           when PactBroker::Matrix::PactNotVerifiedByRequiredProviderVersion
             "There is no verified pact between #{reason.consumer_selector.description} and #{reason.provider_selector.description}"
-          # when PactBroker::Matrix::VerificationFailed
-          #   "The pact verification between #{reason.consumer_selector.description} and #{reason.provider_selector.description} failed"
           when PactBroker::Matrix::SpecifiedVersionDoesNotExist
             version_does_not_exist_description(reason.selector)
           when PactBroker::Matrix::VerificationFailed
@@ -27,17 +40,19 @@ module PactBroker
           when PactBroker::Matrix::InteractionsMissingVerifications
             descriptions = reason.interactions.collect do | interaction |
               interaction_description(interaction)
-            end.join('; ')
-            "WARNING: Although the verification was reported as successful, the results for #{reason.consumer_selector.description} and #{reason.provider_selector.description} may be missing tests for the following interactions: #{descriptions}"
+            end.join("; ")
+            "WARN: Although the verification was reported as successful, the results for #{reason.consumer_selector.description} and #{reason.provider_selector.description} may be missing tests for the following interactions: #{descriptions}"
+          when PactBroker::Matrix::IgnoreSelectorDoesNotExist
+            "WARN: Cannot ignore #{reason.selector.description}"
+          when PactBroker::Matrix::SelectorWithoutPacticipantVersionNumberSpecified
+            "WARN: For production use of can-i-deploy, it is recommended to specify the version number (rather than latest tag or branch) of each pacticipant to avoid race conditions."
+          when PactBroker::Matrix::NoEnvironmentSpecified
+            "WARN: For production use of can-i-deploy, it is recommended to specify the environment into which you are deploying. Without the environment, this result will not be reliable."
           else
             reason
           end
         end
 
-        private
-
-        attr_reader :reason
-
         def version_does_not_exist_description selector
           if selector.version_does_not_exist?
             if selector.tag
@@ -54,16 +69,17 @@ module PactBroker
 
         # TODO move this somewhere else
         def interaction_description(interaction)
-          if interaction['providerState'] && interaction['providerState'] != ''
+          if interaction["providerState"] && interaction["providerState"] != ""
             "#{interaction['description']} given #{interaction['providerState']}"
-          elsif interaction['providerStates'] && interaction['providerStates'].is_a?(Array) && interaction['providerStates'].any?
-            provider_states = interaction['providerStates'].collect{ |ps| ps['name'] }.compact.join(', ')
+          elsif interaction["providerStates"] && interaction["providerStates"].is_a?(Array) && interaction["providerStates"].any?
+            provider_states = interaction["providerStates"].collect{ |ps| ps["name"] }.compact.join(", ")
             "#{interaction['description']} given #{provider_states}"
           else
-            interaction['description']
+            interaction["description"]
           end
         end
       end
+      # rubocop: enable Metrics/CyclomaticComplexity
     end
   end
 end

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

@@ -1,4 +1,4 @@
-require 'csv'
+require "csv"
 
 module PactBroker
   module Api
@@ -9,6 +9,7 @@ module PactBroker
           @index_items = pacts.collect{|pact| PactBroker::Domain::IndexItem.new(pact.consumer, pact.provider)}
         end
 
+        # rubocop: disable Metrics/CyclomaticComplexity
         def to_csv
           hash = {}
 
@@ -32,6 +33,7 @@ module PactBroker
             end
           end
         end
+        # rubocop: enable Metrics/CyclomaticComplexity
 
         def pacticipant_array pacticipant, order
           [pacticipant.id, pacticipant.name, 1, 1, 0, order]

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

@@ -0,0 +1,25 @@
+require "pact_broker/api/decorators/base_decorator"
+require "pact_broker/api/decorators/embedded_version_decorator"
+require "pact_broker/api/decorators/environment_decorator"
+
+module PactBroker
+  module Api
+    module Decorators
+      class ReleasedVersionDecorator < 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 :version, :extend => EmbeddedVersionDecorator, writeable: false, embedded: true
+        property :environment, :extend => EnvironmentDecorator, writeable: false, embedded: true
+
+        link :self do | user_options |
+          {
+            href: released_version_url(represented, user_options.fetch(:base_url))
+          }
+        end
+      end
+    end
+  end
+end