pact_broker 2.40.0 → 2.41.0

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

@@ -52,14 +52,15 @@ module PactBroker
             provider = OpenStruct.new(name: line.provider_name)
             consumer = OpenStruct.new(name: line.consumer_name)
             consumer_version = OpenStruct.new(number: line.consumer_version_number, pacticipant: consumer)
-            line_hash(consumer, provider, consumer_version, line, base_url)
+            provider_version = line.provider_version_number ? OpenStruct.new(number: line.provider_version_number, pacticipant: provider) : nil
+            line_hash(consumer, provider, consumer_version, provider_version, line, base_url)
           end
         end
 
-        def line_hash(consumer, provider, consumer_version, line, base_url)
+        def line_hash(consumer, provider, consumer_version, provider_version, line, base_url)
           {
             consumer: consumer_hash(line, consumer, consumer_version, base_url),
-            provider: provider_hash(line, provider, base_url),
+            provider: provider_hash(line, provider, provider_version, base_url),
             pact: pact_hash(line, base_url),
             verificationResult: verification_hash(line, base_url)
           }
@@ -74,7 +75,8 @@ module PactBroker
                 self: {
                   href: version_url(base_url, consumer_version)
                 }
-              }
+              },
+              tags: tags(line.consumer_version_tags)
             },
             _links: {
               self: {
@@ -84,7 +86,16 @@ module PactBroker
           }
         end
 
-        def provider_hash(line, provider, base_url)
+        def tags(tags)
+          tags.collect do | tag |
+            {
+              name: tag.name,
+              latest: tag.latest?
+            }
+          end
+        end
+
+        def provider_hash(line, provider, provider_version, base_url)
           hash = {
             name: line.provider_name,
             version: nil,
@@ -96,7 +107,15 @@ module PactBroker
           }
 
           if !line.provider_version_number.nil?
-            hash[:version] = { number: line.provider_version_number }
+            hash[:version] = {
+              number: line.provider_version_number,
+              _links: {
+                self: {
+                  href: version_url(base_url, provider_version)
+                }
+              },
+              tags: tags(line.provider_version_tags)
+            }
           end
 
           hash

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

@@ -1,22 +1,16 @@
 require 'csv'
-require 'set'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class RelationshipsCsvDecorator
-
         def initialize pacts
           @pacts = pacts
-          @index_items = pacts.collect{|pact| PactBroker::Domain::IndexItem.new(pact.consumer,pact.provider)}
+          @index_items = pacts.collect{|pact| PactBroker::Domain::IndexItem.new(pact.consumer, pact.provider)}
         end
 
         def to_csv
           hash = {}
-          pacticipants = @index_items.collect{|r| r.pacticipants}.flatten.uniq
 
           @index_items.each do | index_item |
             hash[index_item.consumer.id] ||= pacticipant_array(index_item.consumer, hash.size + 1)
@@ -24,7 +18,7 @@ module PactBroker
             hash[index_item.consumer.id] << index_item.provider.id
           end
 
-          max_length = hash.values.collect{|array| array.size}.max
+          max_length = hash.values.collect(&:size).max
 
           hash.values.each do | array |
             while array.size < max_length
@@ -37,7 +31,6 @@ module PactBroker
               csv << array
             end
           end
-
         end
 
         def pacticipant_array pacticipant, order
@@ -46,9 +39,8 @@ module PactBroker
 
         private
 
-        attr_accessor :pacts
-
+        attr_reader :pacts
       end
     end
   end
-end
+end

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

@@ -21,9 +21,12 @@ module PactBroker
         end
 
         property :verification_properties, as: :verificationProperties do
-          property :pending
-          property :pending_reason, as: :pendingReason, exec_context: :decorator
+          property :pending,
+            if: ->(context) { context[:options][:user_options][:include_pending_status] }
+          property :wip, if: -> (context) { context[:represented].wip }
           property :inclusion_reason, as: :inclusionReason, exec_context: :decorator
+          property :pending_reason, as: :pendingReason, exec_context: :decorator,
+            if: ->(context) { context[:options][:user_options][:include_pending_status] }
 
           def inclusion_reason
             PactBroker::Pacts::VerifiablePactMessages.new(represented).inclusion_reason

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

@@ -1,25 +1,37 @@
 require_relative 'base_decorator'
 require_relative 'verifiable_pact_decorator'
 require 'pact_broker/api/pact_broker_urls'
+require 'pact_broker/hash_refinements'
 
 module PactBroker
   module Api
     module Decorators
       class VerifiablePactsQueryDecorator < BaseDecorator
-        collection :provider_version_tags
+        using PactBroker::HashRefinements
 
-        collection :consumer_version_selectors, class: OpenStruct do
+        collection :provider_version_tags, default: []
+
+        collection :consumer_version_selectors, default: [], class: OpenStruct do
           property :tag
-          property :latest, setter: ->(fragment:, represented:, **) { represented.latest = (fragment == 'true') }
+          property :latest,
+            setter: ->(fragment:, represented:, **) {
+              represented.latest = (fragment == 'true' || fragment == true)
+            }
         end
 
+        property :include_pending_status, default: true,
+          setter: ->(fragment:, represented:, **) {
+            represented.include_pending_status = (fragment == 'true' || fragment == true)
+          }
+
+        property :include_wip_pacts_since, default: nil,
+          setter: ->(fragment:, represented:, **) {
+            represented.include_wip_pacts_since = fragment ? DateTime.parse(fragment) : nil
+          }
 
-        def from_hash(*args)
-          # Should remember how to do this via Representable...
-          result = super
-          result.consumer_version_selectors = [] if result.consumer_version_selectors.nil?
-          result.provider_version_tags = [] if result.provider_version_tags.nil?
-          result
+        def from_hash(hash)
+          # This handles both the snakecase keys from the GET query and the camelcase JSON POST body
+          super(hash&.snakecase_keys)
         end
       end
     end

data/lib/pact_broker/api/renderers/integrations_dot_renderer.rb

@@ -28,7 +28,7 @@ module PactBroker
         end
 
         def escape_name(name)
-          name.gsub(" ", "_")
+          name.tr(" ", "_")
         end
       end
     end

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

@@ -88,7 +88,7 @@ module PactBroker
         end
 
         def params_with_string_keys
-          JSON.parse(request.body.to_s, {symbolize_names: false}.merge(PACT_PARSING_OPTIONS))
+          @params_with_string_keys ||= JSON.parse(request.body.to_s, {symbolize_names: false}.merge(PACT_PARSING_OPTIONS))
         end
 
         def pact_params

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

@@ -7,6 +7,7 @@ module PactBroker
     module Resources
       class CanIDeploy < Matrix
         def initialize
+          super
           @query_params = JSON.parse(Rack::Utils.parse_nested_query(request.uri.query).to_json, symbolize_names: true)
           @selectors, @options = PactBroker::Matrix::ParseCanIDeployQuery.call(query_params)
         end
@@ -22,19 +23,11 @@ module PactBroker
 
         private
 
-        attr_reader :query_params
+        attr_reader :query_params, :selectors, :options
 
         def query_schema
           PactBroker::Api::Contracts::CanIDeployQuerySchema
         end
-
-        def selectors
-          @selectors
-        end
-
-        def options
-          @options
-        end
       end
     end
   end

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

@@ -7,8 +7,10 @@ module PactBroker
   module Api
     module Resources
       class Matrix < BaseResource
+        attr_reader :selectors, :options
 
         def initialize
+          super
           @selectors, @options = PactBroker::Matrix::ParseQuery.call(request.uri.query)
         end
 
@@ -44,14 +46,6 @@ module PactBroker
         def lines
           @lines ||= matrix_service.find(selectors, options)
         end
-
-        def selectors
-          @selectors
-        end
-
-        def options
-          @options
-        end
       end
     end
   end

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

@@ -7,6 +7,7 @@ module PactBroker
       class MatrixForConsumerAndProvider < BaseResource
 
         def initialize
+          super
           _, @options = PactBroker::Matrix::ParseQuery.call(request.uri.query)
         end
 

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

@@ -2,13 +2,21 @@ require 'pact_broker/api/resources/provider_pacts'
 require 'pact_broker/api/decorators/verifiable_pacts_decorator'
 require 'pact_broker/api/contracts/verifiable_pacts_query_schema'
 require 'pact_broker/api/decorators/verifiable_pacts_query_decorator'
+require 'pact_broker/api/contracts/verifiable_pacts_json_query_schema'
+require 'pact_broker/hash_refinements'
 
 module PactBroker
   module Api
     module Resources
       class ProviderPactsForVerification < ProviderPacts
-        def initialize
-          @query = Rack::Utils.parse_nested_query(request.uri.query)
+        using PactBroker::HashRefinements
+
+        def allowed_methods
+          ["GET", "POST", "OPTIONS"]
+        end
+
+        def content_types_accepted
+          [["application/json"]]
         end
 
         def malformed_request?
@@ -20,15 +28,19 @@ module PactBroker
           end
         end
 
-        private
+        def process_post
+          response.body = to_json
+          true
+        end
 
-        attr_reader :query
+        private
 
         def pacts
           pact_service.find_for_verification(
             provider_name,
             parsed_query_params.provider_version_tags,
-            parsed_query_params.consumer_version_selectors
+            parsed_query_params.consumer_version_selectors,
+            { include_wip_pacts_since: parsed_query_params.include_wip_pacts_since }
           )
         end
 
@@ -40,14 +52,31 @@ module PactBroker
           PactBroker::Api::Decorators::VerifiablePactsDecorator.new(pacts).to_json(to_json_options)
         end
 
-
         def query_schema
-          PactBroker::Api::Contracts::VerifiablePactsQuerySchema
+          if request.get?
+            PactBroker::Api::Contracts::VerifiablePactsQuerySchema
+          else
+            PactBroker::Api::Contracts::VerifiablePactsJSONQuerySchema
+          end
         end
 
         def parsed_query_params
           @parsed_query_params ||= PactBroker::Api::Decorators::VerifiablePactsQueryDecorator.new(OpenStruct.new).from_hash(query)
         end
+
+        def query
+          @query ||= begin
+            if request.get?
+              Rack::Utils.parse_nested_query(request.uri.query)
+            elsif request.post?
+              params_with_string_keys
+            end
+          end
+        end
+
+        def to_json_options
+          super.deep_merge(user_options: { include_pending_status: parsed_query_params.include_pending_status })
+        end
       end
     end
   end

data/lib/pact_broker/app.rb

@@ -110,6 +110,7 @@ module PactBroker
       PactBroker::DB.connection.timezone = :utc
       PactBroker::DB.validate_connection_config if configuration.validate_database_connection_config
       PactBroker::DB.set_mysql_strict_mode_if_mysql
+      PactBroker::DB.connection.extension(:pagination)
       Sequel.datetime_class = DateTime
       Sequel.database_timezone = :utc # Store all dates in UTC, assume any date without a TZ is UTC
       Sequel.application_timezone = :local # Convert dates to localtime when retrieving from database

data/lib/pact_broker/db/data_migrations/migrate_webhook_headers.rb

@@ -11,7 +11,7 @@ module PactBroker
             connection[:webhook_headers].for_update.each do | webhook_header |
               webhook = connection[:webhooks].for_update.where(id: webhook_header[:webhook_id]).first
               new_headers = webhook[:headers] ? JSON.parse(webhook[:headers]) : {}
-              new_headers.merge!(webhook_header[:name] => webhook_header[:value])
+              new_headers[webhook_header[:name]] = webhook_header[:value]
               connection[:webhooks].where(id: webhook[:id]).update(headers: new_headers.to_json)
               connection[:webhook_headers].where(webhook_header).delete
             end

data/lib/pact_broker/db/seed_example_data.rb

@@ -18,21 +18,24 @@ module PactBroker
           .create_provider(provider_name, created_at: days_ago(16))
           .create_consumer_version("e15da45d3943bf10793a6d04cfb9f5dabe430fe2", created_at: days_ago(16))
           .create_consumer_version_tag("prod", created_at: days_ago(16))
-          .create_consumer_version_tag("dev", created_at: days_ago(16))
+          .create_consumer_version_tag("master", created_at: days_ago(16))
           .create_pact(json_content: pact_1, created_at: days_ago(16))
           .create_verification(provider_version: "1315e0b1924cb6f42751f977789be3559373033a", execution_date: days_ago(15))
-          .create_provider_version_tag("dev", created_at: days_ago(14))
+          .create_provider_version_tag("master", created_at: days_ago(14))
           .create_provider_version_tag("prod", created_at: days_ago(14))
           .create_verification(provider_version: "480e5aeb30467856ca995d0024d2c1800b0719e5", success: false, number: 2, execution_date: days_ago(14))
-          .create_provider_version_tag("dev", created_at: days_ago(14))
+          .create_provider_version_tag("master", created_at: days_ago(14))
           .create_consumer_version("725c6ccb7cf7efc51b4394f9828585eea9c379d9", created_at: days_ago(7))
           .create_consumer_version_tag("feat-new-thing", created_at: days_ago(7))
           .create_pact(json_content: pact_2, created_at: days_ago(7))
           .create_consumer_version("7bd4d9173522826dc3e8704fd62dde0424f4c827", created_at: days_ago(1))
-          .create_consumer_version_tag("dev", created_at: days_ago(1))
+          .create_consumer_version_tag("master", created_at: days_ago(1))
           .create_pact(json_content: pact_3, created_at: days_ago(1))
           .create_verification(provider_version: "4fdf20082263d4c5038355a3b734be1c0054d1e1", execution_date: days_ago(1))
-          .create_provider_version_tag("dev", created_at: days_ago(1))
+          .create_provider_version_tag("master", created_at: days_ago(1))
+          .create_consumer_version("5556b8149bf8bac76bc30f50a8a2dd4c22c85f30", created_at: days_ago(0.5))
+          .create_consumer_version_tag("master", created_at: days_ago(0.5))
+          .republish_same_pact(created_at: days_ago(0.5))
       end
 
       def database_empty?

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

@@ -16,14 +16,6 @@ module PactBroker
           return false if PactBroker.configuration.authorize.nil?
           !PactBroker.configuration.authorize.call(self, {})
         end
-
-        def initialize
-          PactBroker.configuration.before_resource.call(self)
-        end
-
-        def finish_request
-          PactBroker.configuration.after_resource.call(self)
-        end
       end
     end
   end

data/lib/pact_broker/domain/index_item.rb

@@ -4,10 +4,22 @@ require 'pact_broker/webhooks/status'
 module PactBroker
   module Domain
     class IndexItem
-
-      attr_reader :consumer, :provider, :latest_pact, :latest_verification, :webhooks, :triggered_webhooks, :latest_verification_latest_tags
-
-      def initialize consumer, provider, latest_pact = nil, latest = true, latest_verification = nil, webhooks = [], triggered_webhooks = [], tags = [], latest_verification_latest_tags = []
+      attr_reader :consumer,
+        :provider,
+        :latest_pact,
+        :latest_verification,
+        :webhooks,
+        :triggered_webhooks,
+        :latest_verification_latest_tags
+
+      # rubocop:disable Metrics/ParameterLists
+      def self.create(consumer, provider, latest_pact, latest, latest_verification, webhooks = [], triggered_webhooks = [], tags = [], latest_verification_latest_tags = [])
+        new(consumer, provider, latest_pact, latest, latest_verification, webhooks, triggered_webhooks, tags, latest_verification_latest_tags)
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(consumer, provider, latest_pact = nil, latest = true, latest_verification = nil, webhooks = [], triggered_webhooks = [], tags = [], latest_verification_latest_tags = [])
         @consumer = consumer
         @provider = provider
         @latest_pact = latest_pact
@@ -18,10 +30,7 @@ module PactBroker
         @tags = tags
         @latest_verification_latest_tags = latest_verification_latest_tags
       end
-
-      def self.create consumer, provider, latest_pact, latest, latest_verification, webhooks = [], triggered_webhooks = [], tags = [], latest_verification_latest_tags = []
-        new consumer, provider, latest_pact, latest, latest_verification, webhooks, triggered_webhooks, tags, latest_verification_latest_tags
-      end
+      # rubocop:enable Metrics/ParameterLists
 
       def eq? other
         IndexItem === other && other.consumer == consumer && other.provider == provider &&
@@ -43,10 +52,6 @@ module PactBroker
         provider.name
       end
 
-      def latest_pact
-        @latest_pact
-      end
-
       def latest?
         @latest
       end
@@ -55,6 +60,10 @@ module PactBroker
         @latest_pact.consumer_version_number
       end
 
+      def consumer_version_order
+        consumer_version.order
+      end
+
       def consumer_version
         @latest_pact.consumer_version
       end
@@ -93,10 +102,6 @@ module PactBroker
         !!latest_verification
       end
 
-      def latest_verification
-        @latest_verification
-      end
-
       def latest_verification_successful?
         latest_verification.success
       end
@@ -127,6 +132,32 @@ module PactBroker
         provider_name <=> other.provider_name
       end
 
+      # Add logic for ignoring case
+      def <=> other
+        comparisons = [
+          compare_name_asc(consumer_name, other.consumer_name),
+          compare_number_desc(consumer_version.order, other.consumer_version.order),
+          compare_number_desc(latest_pact.revision_number, other.latest_pact.revision_number),
+          compare_name_asc(provider_name, other.provider_name)
+        ]
+
+        comparisons.find{|c| c != 0 } || 0
+      end
+
+      def compare_name_asc name1, name2
+        name1&.downcase <=> name2&.downcase
+      end
+
+      def compare_number_desc number1, number2
+        if number1 && number2
+          number2 <=> number1
+        elsif number1
+          1
+        else
+          -1
+        end
+      end
+
       def to_s
         "Pact between #{consumer_name} #{consumer_version_number} and #{provider_name} #{provider_version_number}"
       end