pact_broker 2.105.0 → 2.107.0.beta.1

data/lib/pact_broker/webhooks/repository.rb

@@ -159,7 +159,7 @@ module PactBroker
 
       def find_latest_triggered_webhooks consumer, provider
         # policy already applied to pact
-        deliberately_unscoped(TriggeredWebhook)
+        scope_for(TriggeredWebhook)
           .where(consumer: consumer, provider: provider)
           .latest_triggered_webhooks
           .all

data/lib/pact_broker/webhooks/service.rb

@@ -29,6 +29,7 @@ module PactBroker
       extend PactBroker::Messages
 
       delegate [
+        :create,
         :find_by_uuid,
         :find_all,
         :update_triggered_webhook_status,
@@ -37,34 +38,15 @@ module PactBroker
         :find_latest_triggered_webhooks_for_pact,
         :fail_retrying_triggered_webhooks,
         :find_triggered_webhooks_for_pact,
-        :find_triggered_webhooks_for_verification
+        :find_triggered_webhooks_for_verification,
+        :delete_by_uuid
       ] => :webhook_repository
 
-      # Not actually a UUID. Ah well.
-      def valid_uuid_format?(uuid)
-        !!(uuid =~ /^[A-Za-z0-9_\-]{16,}$/)
-      end
 
       def next_uuid
         SecureRandom.urlsafe_base64
       end
 
-      def errors webhook, uuid = nil
-        contract = PactBroker::Api::Contracts::WebhookContract.new(webhook)
-        contract.validate(webhook.attributes)
-        messages = contract.errors.messages
-
-        if uuid && !valid_uuid_format?(uuid)
-          messages["uuid"] = [message("errors.validation.invalid_webhook_uuid")]
-        end
-
-        OpenStruct.new(messages: messages, empty?: messages.empty?, any?: messages.any?)
-      end
-
-      def create uuid, webhook, consumer, provider
-        webhook_repository.create uuid, webhook, consumer, provider
-      end
-
       def update_by_uuid uuid, params
         webhook = webhook_repository.find_by_uuid(uuid)
         maintain_redacted_params(webhook, params)
@@ -72,10 +54,6 @@ module PactBroker
         webhook_repository.update_by_uuid uuid, webhook
       end
 
-      def delete_by_uuid uuid
-        webhook_repository.delete_by_uuid uuid
-      end
-
       def delete_all_webhhook_related_objects_by_pacticipant pacticipant
         webhook_repository.delete_by_pacticipant(pacticipant)
       end

data/lib/pact_broker/webhooks/triggered_webhook.rb

@@ -10,6 +10,7 @@ module PactBroker
   module Webhooks
     class TriggeredWebhook < Sequel::Model(:triggered_webhooks)
       using PactBroker::HashRefinements
+      set_primary_key :id
       plugin :timestamps, update_on_create: true
       plugin :serialization, :json, :event_context
 

data/lib/pact_broker/webhooks/webhook_event.rb

@@ -4,6 +4,7 @@ require "pact_broker/repositories/helpers"
 module PactBroker
   module Webhooks
     class WebhookEvent < Sequel::Model
+      set_primary_key :id
       plugin :timestamps, update_on_create: true
 
       CONTRACT_PUBLISHED = "contract_published"

data/lib/pact_broker/webmachine.rb

@@ -0,0 +1,22 @@
+require "webmachine"
+require "webmachine/application_monkey_patch"
+require "webmachine/adapters/rack_mapped"
+require "webmachine/application_monkey_patch"
+require "webmachine/render_error_monkey_patch"
+
+
+module Webmachine
+  def self.build_rack_api(application_context)
+    api = Webmachine::Application.new do |app|
+      yield app
+    end
+
+    api.application_context = application_context
+
+    api.configure do |config|
+      config.adapter = :RackMapped
+    end
+
+    api.adapter
+  end
+end

data/lib/rack/pact_broker/invalid_uri_protection.rb

@@ -45,7 +45,7 @@ module Rack
       end
 
       def validate(uri)
-        decoded_path = URI.decode(uri.path)
+        decoded_path = URI.decode_www_form_component(uri.path)
         if decoded_path.include?("\n")
           message("errors.new_line_in_url_path")
         elsif decoded_path.include?("\t")

data/lib/rack/pact_broker/request_target.rb

@@ -7,7 +7,7 @@ module Rack
       extend self
 
       WEB_ASSET_EXTENSIONS = %w[.js .woff .woff2 .css .png .html .map .ttf .ico].freeze
-      API_CONTENT_TYPES = %w[application/hal+json application/json text/csv application/yaml text/plain].freeze
+      API_CONTENT_TYPES = %w[application/hal+json application/problem+json application/json text/csv application/yaml text/plain].freeze
 
       def request_for_ui?(env)
         !(request_for_api?(env))

data/lib/rack/pact_broker/use_when.rb

@@ -15,11 +15,12 @@ module Rack
   module PactBroker
     module UseWhen
       class ConditionallyUseMiddleware
-        def initialize(app, condition_proc, middleware, *args, &block)
+        def initialize(app, condition_proc, middleware, *args, **kwargs, &block)
           @app_without_middleware = app
           @condition_proc = condition_proc
           @middleware = middleware
           @args = args
+          @kwargs = kwargs
           @block = block
         end
 
@@ -33,12 +34,12 @@ module Rack
 
         private
 
-        attr_reader :app_without_middleware, :condition_proc, :middleware, :args, :block
+        attr_reader :app_without_middleware, :condition_proc, :middleware, :args, :kwargs, :block
 
         def app_with_middleware
           @app_with_middleware ||= begin
             rack_builder = ::Rack::Builder.new
-            rack_builder.use middleware, *args, &block
+            rack_builder.use middleware, *args, **kwargs, &block
             rack_builder.run app_without_middleware
             rack_builder.to_app
           end
@@ -46,8 +47,8 @@ module Rack
       end
 
       refine Rack::Builder do
-        def use_when(condition_proc, middleware, *args, &block)
-          use(ConditionallyUseMiddleware, condition_proc, middleware, *args, &block)
+        def use_when(condition_proc, middleware, *args, **kwargs, &block)
+          use(ConditionallyUseMiddleware, condition_proc, middleware, *args, **kwargs, &block)
         end
       end
     end

data/lib/sequel/plugins/age.rb

@@ -0,0 +1,13 @@
+require "moments"
+
+module Sequel
+  module Plugins
+    module Age
+      module InstanceMethods
+        def age
+          @age ||= Moments.difference(Time.now, created_at.to_time)
+        end
+      end
+    end
+  end
+end

data/lib/webmachine/application_monkey_patch.rb

@@ -0,0 +1,15 @@
+require "webmachine/application"
+
+class Webmachine::Application
+  def application_context= application_context
+    @application_context = application_context
+    # naughty, but better than setting each route manually
+    routes.each do | route |
+      route.instance_variable_get(:@bindings)[:application_context] = application_context
+    end
+  end
+
+  def application_context
+    @application_context
+  end
+end

data/lib/webmachine/describe_routes.rb

@@ -1,7 +1,9 @@
 require "webmachine/adapters/rack_mapped"
+require "pact_broker/string_refinements"
 
 module Webmachine
   class DescribeRoutes
+    using PactBroker::StringRefinements
 
     Route = Struct.new(
         :path,
@@ -11,6 +13,7 @@ module Webmachine
         :resource_class_location,
         :allowed_methods,
         :policy_class,
+        :schemas,
         keyword_init: true) do
 
       def [](key)
@@ -77,33 +80,57 @@ module Webmachine
           resource_class: webmachine_route.resource,
           resource_name: webmachine_route.instance_variable_get(:@bindings)[:resource_name],
           resource_class_location: resource_path_absolute.relative_path_from(Pathname.pwd).to_s
-        }.merge(info_from_resource_instance(webmachine_route)))
+        }.merge(info_from_resource_instance(webmachine_route, webmachine_application.application_context)))
       end.reject{ | route | route.resource_class == Webmachine::Trace::TraceResource }
     end
 
-    def self.info_from_resource_instance(webmachine_route)
+    def self.info_from_resource_instance(webmachine_route, application_context)
       with_no_logging do
-        path_info = { application_context: OpenStruct.new, pacticipant_name: "foo", pacticipant_version_number: "1", resource_name: "foo" }
+        path_info = { application_context: application_context, pacticipant_name: "foo", pacticipant_version_number: "1", resource_name: "foo" }
         path_info.default = "1"
-        dummy_request = Webmachine::Adapters::Rack::RackRequest.new("GET", "/", Webmachine::Headers["host" => "example.org"], nil, {}, {}, { "REQUEST_METHOD" => "GET" })
-        dummy_request.path_info = path_info
+        dummy_request = dummy_request(http_method: "GET", path_info: path_info)
+
         dummy_resource = webmachine_route.resource.new(dummy_request, Webmachine::Response.new)
         if dummy_resource
           {
             allowed_methods: dummy_resource.allowed_methods,
-          }
+            schemas: dummy_resource.respond_to?(:schema, true) && dummy_resource.send(:schema) ? schemas(dummy_resource.allowed_methods, webmachine_route.resource, path_info) : nil
+          }.compact
         else
           {}
         end
       end
     rescue StandardError => e
-      puts "Could not determine instance info for #{route.resource}. #{e.class} - #{e.message}"
+      puts "Could not determine instance info for #{webmachine_route.resource}. #{e.class} - #{e.message}"
       {}
     end
 
+    # This is not entirely accurate, because some GET requests have schemas too, but we can't tell that statically at the moment
+    def self.schemas(allowed_methods, resource, path_info)
+      (allowed_methods - ["GET", "OPTIONS", "DELETE"]).collect do | http_method |
+        resource.new(dummy_request(http_method: http_method, path_info: path_info), Webmachine::Response.new).send(:schema)
+      end.uniq.collect do | schema_class |
+        {
+          class: schema_class,
+          location: source_location_for(schema_class)
+        }
+      end
+    end
+
+    def self.dummy_request(http_method: "GET", path_info: )
+      dummy_request = Webmachine::Adapters::Rack::RackRequest.new(http_method, "/", Webmachine::Headers["host" => "example.org"], nil, {}, {}, { "REQUEST_METHOD" => http_method })
+      dummy_request.path_info = path_info
+      dummy_request
+    end
+
     def self.source_location_for(clazz)
       first_instance_method_name = (clazz.instance_methods(false) + clazz.private_instance_methods(false)).first
-      clazz.instance_method(first_instance_method_name).source_location.first
+      if first_instance_method_name
+        clazz.instance_method(first_instance_method_name).source_location.first
+      else
+        # have a guess!
+        "lib/" + clazz.name.snakecase.gsub("::", "/") + ".rb"
+      end
     end
 
     # If we don't turn off the logging, we get metrics logging due to the instantiation of the Webmachine::RackRequest class

data/lib/webmachine/render_error_monkey_patch.rb

@@ -0,0 +1,70 @@
+require "webmachine/errors"
+require "pact_broker/string_refinements"
+
+# Monkey patches the render_error method so that it returns hal+json or problem+json instead of text/html
+
+module Webmachine
+  using PactBroker::StringRefinements
+
+  class << self
+    alias_method :original_render_error, :render_error
+  end
+
+  # Renders a standard error message body for the response. The
+  # standard messages are defined in localization files.
+  # @param [Integer] code the response status code
+  # @param [Request] req the request object
+  # @param [Response] req the response object
+  # @param [Hash] options keys to override the defaults when rendering
+  #     the response body
+  def self.render_error(code, req, res, options={})
+    if text_html_error_content_type?(req)
+      Webmachine.original_render_error(code, req, res, options)
+    else
+      render_error_for_api(code, req, res, options)
+    end
+  end
+
+  def self.render_error_for_api(code, req, res, options)
+    res.code = code
+    unless res.body
+      title, message = t(["errors.#{code}.title", "errors.#{code}.message"],
+                         **{ :method => req.method,
+                           :error => res.error}.merge(options))
+
+      title = options[:title] if options[:title]
+      message = options[:message] if options[:message]
+
+      res.body = error_response_body(message, title, title.dasherize.gsub(/^\d+\-/, ""), code, req)
+      res.headers[CONTENT_TYPE] = error_response_content_type(req)
+    end
+    ensure_content_length(res)
+    ensure_date_header(res)
+  end
+
+  def self.text_html_error_content_type?(request)
+    request.headers["Accept"]&.include?("text/html")
+  end
+
+  def self.problem_json_error_content_type?(request)
+    request.headers["Accept"]&.include?("application/problem+json")
+  end
+
+  def self.error_response_content_type(request)
+    if problem_json_error_content_type?(request)
+      "application/problem+json;charset=utf-8"
+    elsif text_html_error_content_type?(request)
+      "text/html;charset=utf-8"
+    else
+      "application/json;charset=utf-8"
+    end
+  end
+
+  def self.error_response_body(detail, title, type, status, request)
+    if problem_json_error_content_type?(request)
+      PactBroker::Api::Decorators::CustomErrorProblemJSONDecorator.new(detail: detail, title: title, type: type, status: status).to_json
+    else
+      { error: detail }.to_json
+    end
+  end
+end

data/pact_broker.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |gem|
                         if Dir.exist?(".git")
                           Dir.chdir(File.expand_path(__dir__)) do
                             include_patterns = %w[lib/**/* db/**/* docs/**/*.md public/**/* vendor/**/* LICENSE.txt README.md CHANGELOG.md Gemfile pact_broker.gemspec]
-                            exclude_patterns = %w[db/test/**/*]
+                            exclude_patterns = %w[db/test/**/* lib/**/*/README.md]
                             include_list = include_patterns.flat_map{ | pattern | Dir.glob(pattern) } - exclude_patterns.flat_map{ | pattern | Dir.glob(pattern) }
 
                             `git ls-files -z`.split("\x0") & include_list
@@ -49,23 +49,13 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.license       = "MIT"
 
-  #gem.add_runtime_dependency 'pact'
   gem.add_runtime_dependency "json", "~> 2.3"
+  gem.add_runtime_dependency "psych", "~> 4.0" # TODO identify breaking changes and see if we can use 5
   gem.add_runtime_dependency "roar", "~> 1.1"
-  gem.add_runtime_dependency "reform", "~> 2.3.3"
-  gem.add_runtime_dependency "dry-validation", "~> 0.10.5"
-  # if dry-container is not locked, get this error:
-  # An error occurred while loading spec_helper.
-  # Failure/Error: require "reform/form/dry"
-  # NoMethodError:
-  #   undefined method `call' for nil:NilClass
-  # # /Users/beth.skurrie/.gem/ruby/2.7.5/gems/dry-container-0.10.0/lib/dry/container/mixin.rb:151:in `register'
-  gem.add_runtime_dependency "dry-container", "0.8.0"
-  # /usr/local/bundle/gems/dry-validation-0.10.7/lib/dry/validation/schema/class_interface.rb:7:in `<module:Validation>' [dry-configurable] default value as positional argument to settings is deprecated and will be removed in the next major version
-  # Provide a `default:` keyword argument instead
-  gem.add_runtime_dependency "dry-configurable", "0.12.1"
+  gem.add_runtime_dependency "dry-validation", "~> 1.8"
+  gem.add_runtime_dependency "reform", "~> 2.6"
   gem.add_runtime_dependency "sequel", "~> 5.28"
-  gem.add_runtime_dependency "webmachine", "1.6.0"
+  gem.add_runtime_dependency "webmachine", ">= 2.0.0.beta", "< 3.0"
   gem.add_runtime_dependency "semver2", "~> 3.4.2"
   gem.add_runtime_dependency "rack", ">= 2.2.3", "~> 2.2"
   gem.add_runtime_dependency "redcarpet", ">= 3.5.1", "~>3.5"
@@ -75,12 +65,11 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency "haml", "~>5.0"
   gem.add_runtime_dependency "sucker_punch", "~>2.0"
   gem.add_runtime_dependency "rack-protection", ">= 2.0.8.1", "< 3.0"
-  gem.add_runtime_dependency "dry-types", "~> 0.10.3" # https://travis-ci.org/pact-foundation/pact_broker/jobs/249448621
-  gem.add_runtime_dependency "dry-logic", "0.4.2" # Later version cases ArgumentError: wrong number of arguments
   gem.add_runtime_dependency "table_print", "~> 1.5"
   gem.add_runtime_dependency "semantic_logger", "~> 4.11"
-  gem.add_runtime_dependency "sanitize", "6.0"
+  gem.add_runtime_dependency "sanitize", "~> 6.0"
   gem.add_runtime_dependency "wisper", "~> 2.0"
   gem.add_runtime_dependency "anyway_config", "~> 2.1"
   gem.add_runtime_dependency "request_store", "~> 1.5"
+  gem.add_runtime_dependency "moments", "~> 0.2"
 end