pact_broker 2.113.1 → 2.114.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aae45f50ce42ed60ea96c782c5cea44a8c3398d28aabdb705e0941e87690f59f
-  data.tar.gz: a27c8cbf72dd52c2d75a7c06319029c115d4b6c284033fa5487b4e6eefe6f565
+  metadata.gz: 159a993d4863a7a528c058763f2c5a5b6a3104710757d51110fc3d08b9f6c38b
+  data.tar.gz: 1832a40fbf58b8d54e375d460d50b5db331167d09dc695252cbf91e57878c8e7
 SHA512:
-  metadata.gz: 76ad626f57a946907f476c41a17ededfdcb27352a85196e640bbe228a49300f3a6efbc74b32576a3d76b778544c2ee8c2f3255182be90985db4a0683bc06fa34
-  data.tar.gz: 21aa4ec4d72413459dc670f896e5a5c2d9dfd7b3ac6635685fce9d91b1d8ee0e41d73ed4a0e46ae75a8a88eb9069267b762f110d5cb5fcd9b7c2c8aa6519b20a
+  metadata.gz: 55a9a315ba42be7d8533af1e3fb895e5fcc6f24e49a199ae1f42150e6119b7c2cc80aec2e9b7ac4e56d2fc291ab665e44948f191912c9fe355aca74fc4abf1f9
+  data.tar.gz: fe719a11a09ca94776bebe02e51d66da51809080b7c009dfbd8a2ec208802e66863713e3ee698145accb800fed5d7dde8d0d184aa331917f840017b3dafee88d

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+<a name="v2.114.0"></a>
+### v2.114.0 (2025-03-06)
+
+#### Features
+
+* support extended verification results (#778)	 ([18f571c8](/../../commit/18f571c8))
+
+<a name="v2.113.2"></a>
+### v2.113.2 (2025-03-05)
+
+#### Bug Fixes
+
+* downcase Content-Type header	 ([6eebfbdf](/../../commit/6eebfbdf))
+* downcase X-Pact-Broker-Version header	 ([8dfb3ac2](/../../commit/8dfb3ac2))
+* downcase Cache-Control header	 ([6ceae489](/../../commit/6ceae489))
+* downcase Vary header	 ([a43416a3](/../../commit/a43416a3))
+* add webmachine monkey patch to exclude webrick default load	 ([ef674d37](/../../commit/ef674d37))
+
 <a name="v2.113.1"></a>
 ### v2.113.1 (2025-02-20)
 

data/db/migrations/20240112_add_client_language_verified_by_to_verification.rb

@@ -0,0 +1,7 @@
+Sequel.migration do
+  change do
+    add_column(:verifications, :verified_by_client_implementation, String)
+    add_column(:verifications, :verified_by_client_version, String)
+    add_column(:verifications, :verified_by_client_test_framework, String)
+  end
+end

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

@@ -18,6 +18,9 @@ module PactBroker
         nested :verifiedBy do
           property :verified_by_implementation, as: :implementation
           property :verified_by_version, as: :version
+          property :verified_by_client_implementation, as: :client_implementation
+          property :verified_by_client_test_framework, as: :client_test_framework
+          property :verified_by_client_version, as: :client_version
         end
 
         link :self do | options |

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

@@ -18,12 +18,12 @@ module PactBroker
         end
 
         def to_svg
-          response.headers["Cache-Control"] = "no-cache"
+          response.headers["cache-control"] = "no-cache"
           comment + badge_service.pact_verification_badge(pact, label, initials, pseudo_branch_verification_status, tags)
         end
 
         def moved_temporarily?
-          response.headers["Cache-Control"] = "no-cache"
+          response.headers["cache-control"] = "no-cache"
           badge_service.pact_verification_badge_url(pact, label, initials, pseudo_branch_verification_status, tags)
         end
 

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

@@ -47,7 +47,7 @@ module PactBroker
         end
 
         def set_cache_control(cache_control_str)
-          response.headers["Cache-Control"] = cache_control_str
+          response.headers["cache-control"] = cache_control_str
         end
 
         private

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

@@ -32,13 +32,13 @@ module PactBroker
         # @param [String] type
         # @param [Integer] status
         def set_json_error_message(detail, title: "Server error", type: "server-error", status: 500)
-          response.headers["Content-Type"] = error_response_content_type
+          response.headers["content-type"] = error_response_content_type
           response.body = error_response_body(detail, title, type, status)
         end
 
         # @param [Hash,Dry::Validation::MessageSet] errors
         def set_json_validation_error_messages(errors)
-          response.headers["Content-Type"] = error_response_content_type
+          response.headers["content-type"] = error_response_content_type
           response.body = validation_errors_response_body(errors)
         end
 

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

@@ -68,9 +68,9 @@ module PactBroker
 
         private_class_method def self.headers(env)
           if problem_json?(env)
-            { "Content-Type" => "application/problem+json;charset=utf-8" }
+            { "content-type" => "application/problem+json;charset=utf-8" }
           else
-            { "Content-Type" => "application/hal+json;charset=utf-8" }
+            { "content-type" => "application/hal+json;charset=utf-8" }
           end
         end
 

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

@@ -15,7 +15,7 @@ module PactBroker
             }
           end
           response.body = response_body.to_json
-          response.headers["Content-Type" => "application/hal+json;charset=utf-8"]
+          response.headers["content-type" => "application/hal+json;charset=utf-8"]
         end
       end
     end

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

@@ -8,7 +8,7 @@ module PactBroker
             messages = pacticipant_service.messages_for_potential_duplicate_pacticipants pacticipant_names, base_url
             if messages.any?
               response.body = messages.join("\n")
-              response.headers["Content-Type"] = "text/plain"
+              response.headers["content-type"] = "text/plain"
             end
             messages.any?
           else

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

@@ -97,7 +97,7 @@ module PactBroker
               contracts: conflict_notices.select(&:error?).collect(&:text)
             }
           }.to_json
-          response.headers["Content-Type"] = "application/json;charset=utf-8"
+          response.headers["content-type"] = "application/json;charset=utf-8"
         end
 
         def conflict_notices

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

@@ -21,7 +21,7 @@ module PactBroker
 
         def process_post
           webhook_execution_result = webhook_trigger_service.test_execution(webhook, webhook_execution_configuration.webhook_context, webhook_execution_configuration)
-          response.headers["Content-Type"] = "application/hal+json;charset=utf-8"
+          response.headers["content-type"] = "application/hal+json;charset=utf-8"
           response.body = post_response_body(webhook_execution_result)
           true
         end

data/lib/pact_broker/app.rb

@@ -197,7 +197,7 @@ module PactBroker
       @app_builder.use Rack::PactBroker::AddPactBrokerVersionHeader
       @app_builder.use Rack::PactBroker::AddVaryHeader
       @app_builder.use Rack::Static, :urls => ["/stylesheets", "/css", "/fonts", "/js", "/javascripts", "/images"], :root => PactBroker.project_root.join("public")
-      @app_builder.use Rack::Static, :urls => ["/favicon.ico"], :root => PactBroker.project_root.join("public/images"), header_rules: [[:all, {"Content-Type" => "image/x-icon"}]]
+      @app_builder.use Rack::Static, :urls => ["/favicon.ico"], :root => PactBroker.project_root.join("public/images"), header_rules: [[:all, {"content-type" => "image/x-icon"}]]
       @app_builder.use Rack::PactBroker::AddCacheHeader
       @app_builder.use Rack::PactBroker::ConvertFileExtensionToAcceptHeader
       # Rack::PactBroker::SetBaseUrl needs to be before the Rack::PactBroker::HalBrowserRedirect

data/lib/pact_broker/doc/views/pact/publish-verification-results.markdown

@@ -11,3 +11,21 @@ Use a `POST` request to the `pb:publish-verification-results` link (`$['_links']
     }
 
 Multiple verification results may be published for the same pact resource. The most recently published one will be considered to reflect the current status of verification.
+
+Optionally the body can contain details about the Pact implementation which performed the verification, and test results, which support arbitrary json
+
+    {
+      "providerApplicationVersion": "1",
+      "success": true,
+      "buildUrl": "http://build-url",
+      "testResults": [],
+      "verifiedBy": {
+        "implementation": "Pact-Rust",
+        "version": "1.0.0",
+        "clientLanguage": {
+          "testFramework": "TEST",
+          "name": "TESTER",
+          "version": "1.2.3"
+        }
+      }
+    }

data/lib/pact_broker/domain/verification.rb

@@ -259,6 +259,9 @@ end
 #  pact_pending                     | boolean                     |
 #  verified_by_implementation       | text                        |
 #  verified_by_version              | text                        |
+#  verified_by_client_implementation| text                        |
+#  verified_by_client_version       | text                        |
+#  verified_by_client_test_framework| text                        |
 # Indexes:
 #  verifications_pkey                          | PRIMARY KEY btree (id)
 #  verifications_pact_version_id_number_index  | UNIQUE btree (pact_version_id, number)

data/lib/pact_broker/test/test_data_builder.rb

@@ -362,7 +362,7 @@ module PactBroker
                          params[:events] || [{ name: PactBroker::Webhooks::WebhookEvent::DEFAULT_EVENT_NAME }]
                        end
         events = event_params.collect{ |e| PactBroker::Webhooks::WebhookEvent.new(e) }
-        template_params = { method: "POST", url: "http://example.org", headers: {"Content-Type" => "application/json"}, username: params[:username], password: params[:password] }
+        template_params = { method: "POST", url: "http://example.org", headers: {"content-type" => "application/json"}, username: params[:username], password: params[:password] }
         request = PactBroker::Webhooks::WebhookRequestTemplate.new(template_params.merge(params))
         new_webhook = PactBroker::Domain::Webhook.new(
           request: request,

data/lib/pact_broker/ui/controllers/dashboard.rb

@@ -70,7 +70,7 @@ module PactBroker
         private
 
         def set_headers
-          response.headers["Cache-Control"] = "no-cache, no-store, must-revalidate"
+          response.headers["cache-control"] = "no-cache, no-store, must-revalidate"
           response.headers["Pragma"] = "no-cache"
           response.headers["Expires"] = "0"
         end

data/lib/pact_broker/ui/controllers/index.rb

@@ -55,7 +55,7 @@ module PactBroker
         private
 
         def set_headers
-          response.headers["Cache-Control"] = "no-cache, no-store, must-revalidate"
+          response.headers["cache-control"] = "no-cache, no-store, must-revalidate"
           response.headers["Pragma"] = "no-cache"
           response.headers["Expires"] = "0"
         end

data/lib/pact_broker/verifications/service.rb

@@ -46,6 +46,9 @@ module PactBroker
         verification.number = next_verification_number
         verification.verified_by_implementation = params.dig("verifiedBy", "implementation")
         verification.verified_by_version = params.dig("verifiedBy", "version")
+        verification.verified_by_client_implementation = params.dig("verifiedBy", "clientLanguage", "name")
+        verification.verified_by_client_version = params.dig("verifiedBy", "clientLanguage", "version")
+        verification.verified_by_client_test_framework = params.dig("verifiedBy", "clientLanguage", "testFramework")
         verification.consumer_version_selector_hashes = event_context[:consumer_version_selectors]
         pact_version = pact_repository.find_pact_version(first_verified_pact.consumer, first_verified_pact.provider, first_verified_pact.pact_version_sha)
         verification = verification_repository.create(verification, provider_version_number, pact_version)

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = "2.113.1"
+  VERSION = "2.114.0"
 end

data/lib/rack/pact_broker/add_cache_header.rb

@@ -7,7 +7,7 @@ module Rack
 
       def call(env)
         status, headers, body = @app.call(env)
-        [status, { "Cache-Control" => "no-cache" }.merge(headers || {}), body]
+        [status, { "cache-control" => "no-cache" }.merge(headers || {}), body]
       end
     end
   end

data/lib/rack/pact_broker/add_pact_broker_version_header.rb

@@ -4,7 +4,7 @@ module Rack
   module PactBroker
     class AddPactBrokerVersionHeader
 
-      X_PACT_BROKER_VERSION = "X-Pact-Broker-Version".freeze
+      X_PACT_BROKER_VERSION = "x-pact-broker-version".freeze
 
       def initialize app
         @app = app

data/lib/rack/pact_broker/add_vary_header.rb

@@ -32,7 +32,7 @@ module Rack
 
       def call(env)
         status, headers, body = @app.call(env)
-        [status, { "Vary" => "Accept" }.merge(headers || {}), body]
+        [status, { "vary" => "Accept" }.merge(headers || {}), body]
       end
     end
   end

data/lib/rack/pact_broker/cascade.rb

@@ -18,7 +18,7 @@ module Rack
   module PactBroker
     class Cascade
       # deprecated, no longer used
-      NotFound = [404, { CONTENT_TYPE => "text/plain" }, []]
+      NotFound = [404, { "content-type" => "text/plain" }, []]
 
       # An array of applications to try in order.
       attr_reader :apps
@@ -41,7 +41,7 @@ module Rack
       # cascading, try the next app.  If all responses require cascading,
       # return the response from the last app.
       def call(env)
-        return [404, { CONTENT_TYPE => "text/plain" }, []] if @apps.empty?
+        return [404, { "content-type" => "text/plain" }, []] if @apps.empty?
         result = nil
         last_body = nil
 

data/lib/rack/pact_broker/invalid_uri_protection.rb

@@ -58,7 +58,7 @@ module Rack
       end
 
       def headers
-        {"Content-Type" => "application/problem+json"}
+        {"content-type" => "application/problem+json"}
       end
 
       def body(env, detail, title, type, status)

data/lib/rack/pact_broker/request_target.rb

@@ -20,7 +20,7 @@ module Rack
       private
 
       def body_is_json(env)
-        env["CONTENT_TYPE"]&.include?("json")
+        env["content-type"]&.include?("json")
       end
 
       def explicit_request_for_api(env)
@@ -32,7 +32,7 @@ module Rack
       end
 
       def body_is_api_content_type(env)
-        is_api_content_type((env["CONTENT_TYPE"]&.downcase) || "")
+        is_api_content_type((env["content-type"]&.downcase) || "")
       end
 
       def is_api_content_type(header)

data/lib/webmachine/adapters.rb

@@ -0,0 +1,9 @@
+require "webmachine/adapters/lazy_request_body"
+# require "webmachine/adapters/webrick" # Commenting out this line as our monkey patch
+
+module Webmachine
+  # Contains classes and modules that connect Webmachine to Ruby
+  # application servers.
+  module Adapters
+  end
+end

data/lib/webmachine/render_error_monkey_patch.rb

@@ -36,7 +36,7 @@ module Webmachine
       message = options[:message] if options[:message]
 
       res.body = error_response_body(req, message, title, title.dasherize.gsub(/^\d+\-/, ""), code, req)
-      res.headers[CONTENT_TYPE] = error_response_content_type(req)
+      res.headers["content-type"] = error_response_content_type(req)
     end
     ensure_content_length(res)
     ensure_date_header(res)

data/pact_broker.gemspec

@@ -57,7 +57,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "sequel", "~> 5.28"
   gem.add_runtime_dependency "webmachine", ">= 2.0.0.beta", "< 3.0"
   gem.add_runtime_dependency "semver2", "~> 3.4.2"
-  gem.add_runtime_dependency "rack", "~> 3.1", ">= 3.1.10"
+  gem.add_runtime_dependency "rack", "~> 3.1", ">= 3.1.11"
   gem.add_runtime_dependency "redcarpet", ">= 3.5.1", "~>3.5"
   gem.add_runtime_dependency "pact-support" , ">= 1.21.2", "~> 1.21"
   gem.add_runtime_dependency "haml", "~>5.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.113.1
+  version: 2.114.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -9,7 +9,7 @@ authors:
 - Warner Godfrey
 bindir: bin
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -138,7 +138,7 @@ dependencies:
         version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.10
+        version: 3.1.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -148,7 +148,7 @@ dependencies:
         version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.10
+        version: 3.1.11
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -528,6 +528,7 @@ files:
 - db/migrations/20230616_set_integrations_contract_data_updated_at.rb
 - db/migrations/20231002_add_version_id_index_to_released_version.rb
 - db/migrations/20231003_add_version_id_index_to_deployed_version.rb
+- db/migrations/20240112_add_client_language_verified_by_to_verification.rb
 - db/migrations/migration_helper.rb
 - docs/CONFIGURATION.md
 - docs/api/PACTICIPANTS.md
@@ -1093,6 +1094,7 @@ files:
 - lib/sequel/plugins/age.rb
 - lib/sequel/plugins/insert_ignore.rb
 - lib/sequel/plugins/upsert.rb
+- lib/webmachine/adapters.rb
 - lib/webmachine/adapters/rack3_adapter.rb
 - lib/webmachine/application_monkey_patch.rb
 - lib/webmachine/describe_routes.rb