pact_broker 2.58.0 → 2.58.2

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -35,7 +35,7 @@ module PactBroker
       end
 
       def version_url base_url, version
-        "#{pacticipant_url(base_url, version.pacticipant)}/versions/#{version.number}"
+        "#{pacticipant_url(base_url, version.pacticipant)}/versions/#{url_encode(version.number)}"
       end
 
       def version_url_from_params params, base_url = ''
@@ -157,7 +157,7 @@ module PactBroker
       end
 
       def latest_verifications_for_consumer_version_url version, base_url
-        "#{base_url}/verification-results/consumer/#{url_encode(version.pacticipant.name)}/version/#{version.number}/latest"
+        "#{base_url}/verification-results/consumer/#{url_encode(version.pacticipant.name)}/version/#{url_encode(version.number)}/latest"
       end
 
       def latest_verification_for_pact_url pact, base_url, permalink = true
@@ -198,7 +198,7 @@ module PactBroker
       end
 
       def label_url label, base_url
-        "#{labels_url(label.pacticipant, base_url)}/#{label.name}"
+        "#{labels_url(label.pacticipant, base_url)}/#{url_encode(label.name)}"
       end
 
       def labels_url pacticipant, base_url
@@ -281,7 +281,7 @@ module PactBroker
       end
 
       def group_url(pacticipant_name, base_url = '')
-        "#{base_url}/groups/#{pacticipant_name}"
+        "#{base_url}/groups/#{url_encode(pacticipant_name)}"
       end
 
       def hal_browser_url target_url, base_url = ''

data/lib/pact_broker/api/paths.rb

@@ -0,0 +1,15 @@
+module PactBroker
+  module Api
+    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
+
+      extend self
+
+      def is_badge_path?(path)
+        # Optimise by checking include? first - regexp slow
+        path.include?('/badge') && (path =~ PACT_BADGE_PATH || path =~ MATRIX_BADGE_PATH)
+      end
+    end
+  end
+end

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

@@ -37,12 +37,12 @@ module PactBroker
         end
 
         def to_json
-          Decorators::WebhooksDecorator.new(webhooks).to_json(user_options: decorator_context(resource_title: "Webhooks"))
+          Decorators::WebhooksDecorator.new(webhooks).to_json(decorator_options(resource_title: "Webhooks"))
         end
 
         def from_json
-          saved_webhook = webhook_service.create next_uuid, webhook, consumer, provider
-          response.body = Decorators::WebhookDecorator.new(saved_webhook).to_json(user_options: { base_url: base_url })
+          saved_webhook = webhook_service.create(next_uuid, webhook, consumer, provider)
+          response.body = Decorators::WebhookDecorator.new(saved_webhook).to_json(decorator_options)
         end
 
         private

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

@@ -1,181 +1,9 @@
-require 'webmachine'
-require 'pact_broker/api/resources/error_handler'
-require 'pact_broker/services'
-require 'pact_broker/api/decorators'
-require 'pact_broker/logging'
-require 'pact_broker/api/pact_broker_urls'
-require 'pact_broker/api/decorators/decorator_context'
-require 'pact_broker/json'
-require 'pact_broker/pacts/pact_params'
-require 'pact_broker/api/resources/authentication'
+require 'pact_broker/configuration'
 
 module PactBroker
-
   module Api
     module Resources
-
-      class InvalidJsonError < StandardError ; end
-
-      class BaseResource < Webmachine::Resource
-
-        include PactBroker::Services
-        include PactBroker::Api::PactBrokerUrls
-        include PactBroker::Api::Resources::Authentication
-        include PactBroker::Logging
-
-        attr_accessor :user
-
-        def initialize
-          PactBroker.configuration.before_resource.call(self)
-        end
-
-        def options
-          { 'Access-Control-Allow-Methods' => allowed_methods.join(", ")}
-        end
-
-        def known_methods
-          super + ['PATCH']
-        end
-
-        def finish_request
-          PactBroker.configuration.after_resource.call(self)
-        end
-
-        def is_authorized?(authorization_header)
-          authenticated?(self, authorization_header)
-        end
-
-        def forbidden?
-          return false if PactBroker.configuration.authorize.nil?
-          !PactBroker.configuration.authorize.call(self, {})
-        end
-
-        def identifier_from_path
-          request.path_info.each_with_object({}) do | pair, hash|
-            hash[pair.first] = pair.last === String ? URI.decode(pair.last) : pair.last
-          end
-        end
-
-        alias_method :path_info, :identifier_from_path
-
-        def base_url
-          PactBroker.configuration.base_url || request.base_uri.to_s.chomp('/')
-        end
-
-        # See comments for base_url in lib/pact_broker/doc/controllers/app.rb
-        def ui_base_url
-          PactBroker.configuration.base_url || ''
-        end
-
-        def charsets_provided
-          [['utf-8', :encode]]
-        end
-
-        # We only use utf-8 so leave encoding as it is
-        def encode(body)
-          body
-        end
-
-        def resource_url
-          request.uri.to_s.gsub(/\?.*/, '').chomp('/')
-        end
-
-        def decorator_context options = {}
-          Decorators::DecoratorContext.new(base_url, resource_url, request.env, options)
-        end
-
-        def handle_exception e
-          PactBroker::Api::Resources::ErrorHandler.call(e, request, response)
-        end
-
-        def params
-          @params ||= JSON.parse(request.body.to_s, { symbolize_names: true }.merge(PACT_PARSING_OPTIONS)) #Not load! Otherwise it will try to load Ruby classes.
-        end
-
-        def params_with_string_keys
-          @params_with_string_keys ||= JSON.parse(request.body.to_s, {symbolize_names: false}.merge(PACT_PARSING_OPTIONS))
-        end
-
-        def pact_params
-          @pact_params ||= PactBroker::Pacts::PactParams.from_request request, path_info
-        end
-
-        def set_json_error_message message
-          response.headers['Content-Type'] = 'application/hal+json;charset=utf-8'
-          response.body = {error: message}.to_json
-        end
-
-        def set_json_validation_error_messages errors
-          response.headers['Content-Type'] = 'application/hal+json;charset=utf-8'
-          response.body = {errors: errors}.to_json
-        end
-
-        def request_body
-          @request_body ||= request.body.to_s
-        end
-
-        def consumer_name
-          identifier_from_path[:consumer_name]
-        end
-
-        def provider_name
-          identifier_from_path[:provider_name]
-        end
-
-        def pacticipant_name
-          identifier_from_path[:pacticipant_name]
-        end
-
-        def invalid_json?
-          begin
-            params
-            false
-          rescue StandardError => e
-            logger.info "Error parsing JSON #{e} - #{request_body}"
-            set_json_error_message "Error parsing JSON - #{e.message}"
-            response.headers['Content-Type'] = 'application/hal+json;charset=utf-8'
-            true
-          end
-        end
-
-        def validation_errors? model
-          if (errors = model.validate).any?
-            set_json_validation_error_messages errors
-            true
-          else
-            false
-          end
-        end
-
-        def contract_validation_errors? contract, params
-          if (invalid = !contract.validate(params))
-            set_json_validation_error_messages contract.errors.messages
-          end
-          invalid
-        end
-
-        def find_pacticipant name, role
-          pacticipant_service.find_pacticipant_by_name(name).tap do | pacticipant |
-            set_json_error_message("No #{role} with name '#{name}' found") if pacticipant.nil?
-          end
-        end
-
-        def consumer
-          @consumer ||= identifier_from_path[:consumer_name] && find_pacticipant(identifier_from_path[:consumer_name], "consumer")
-        end
-
-        def provider
-          @provider ||= identifier_from_path[:provider_name] && find_pacticipant(identifier_from_path[:provider_name], "provider")
-        end
-
-        def pact
-          @pact ||= pact_service.find_pact(pact_params)
-        end
-
-        def database_connector
-          request.env["pactbroker.database_connector"]
-        end
-      end
+      BaseResource = PactBroker.configuration.base_resource_class_factory.call
     end
   end
 end

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

@@ -0,0 +1,211 @@
+require 'webmachine'
+require 'pact_broker/api/resources/error_handler'
+require 'pact_broker/services'
+require 'pact_broker/api/decorators'
+require 'pact_broker/logging'
+require 'pact_broker/api/pact_broker_urls'
+require 'pact_broker/api/decorators/decorator_context'
+require 'pact_broker/json'
+require 'pact_broker/pacts/pact_params'
+require 'pact_broker/api/resources/authentication'
+
+module PactBroker
+  module Api
+    module Resources
+      class InvalidJsonError < PactBroker::Error ; end
+
+      class DefaultBaseResource < Webmachine::Resource
+        include PactBroker::Services
+        include PactBroker::Api::PactBrokerUrls
+        include PactBroker::Api::Resources::Authentication
+        include PactBroker::Logging
+
+        attr_accessor :user
+
+        def initialize
+          PactBroker.configuration.before_resource.call(self)
+        end
+
+        def options
+          { 'Access-Control-Allow-Methods' => allowed_methods.join(", ")}
+        end
+
+        def known_methods
+          super + ['PATCH']
+        end
+
+        def finish_request
+          PactBroker.configuration.after_resource.call(self)
+        end
+
+        def is_authorized?(authorization_header)
+          authenticated?(self, authorization_header)
+        end
+
+        def forbidden?
+          return false if PactBroker.configuration.authorize.nil?
+          !PactBroker.configuration.authorize.call(self, {})
+        end
+
+        def identifier_from_path
+          request.path_info.each_with_object({}) do | pair, hash|
+            hash[pair.first] = pair.last === String ? URI.decode(pair.last) : pair.last
+          end
+        end
+
+        alias_method :path_info, :identifier_from_path
+
+        def base_url
+          PactBroker.configuration.base_url || request.base_uri.to_s.chomp('/')
+        end
+
+        # See comments for base_url in lib/pact_broker/doc/controllers/app.rb
+        def ui_base_url
+          PactBroker.configuration.base_url || ''
+        end
+
+        def charsets_provided
+          [['utf-8', :encode]]
+        end
+
+        # We only use utf-8 so leave encoding as it is
+        def encode(body)
+          body
+        end
+
+        def resource_url
+          request.uri.to_s.gsub(/\?.*/, '').chomp('/')
+        end
+
+        def decorator_context options = {}
+          Decorators::DecoratorContext.new(base_url, resource_url, request.env, options)
+        end
+
+        def decorator_options options = {}
+          { user_options: decorator_context(options) }
+        end
+
+        def handle_exception e
+          PactBroker::Api::Resources::ErrorHandler.call(e, request, response)
+        end
+
+        def params(options = {})
+          return options[:default] if options.key?(:default) && request_body.empty?
+
+          symbolize_names = !options.key?(:symbolize_names) || options[:symbolize_names]
+          if symbolize_names
+            @params_with_symbol_keys ||= JSON.parse(request_body, { symbolize_names: true }.merge(PACT_PARSING_OPTIONS)) #Not load! Otherwise it will try to load Ruby classes.
+          else
+            @params_with_string_keys ||= JSON.parse(request_body, { symbolize_names: false }.merge(PACT_PARSING_OPTIONS)) #Not load! Otherwise it will try to load Ruby classes.
+          end
+        rescue JSON::JSONError => e
+          raise InvalidJsonError.new("Error parsing JSON - #{e.message}")
+        end
+
+        def params_with_string_keys
+          params(symbolize_names: false)
+        end
+
+        def pact_params
+          @pact_params ||= PactBroker::Pacts::PactParams.from_request request, path_info
+        end
+
+        def set_json_error_message message
+          response.headers['Content-Type'] = 'application/hal+json;charset=utf-8'
+          response.body = { error: message }.to_json
+        end
+
+        def set_json_validation_error_messages errors
+          response.headers['Content-Type'] = 'application/hal+json;charset=utf-8'
+          response.body = { errors: errors }.to_json
+        end
+
+        def request_body
+          @request_body ||= request.body.to_s
+        end
+
+        def consumer_name
+          identifier_from_path[:consumer_name]
+        end
+
+        def consumer_version_number
+          identifier_from_path[:consumer_version_number]
+        end
+
+        def consumer_specified?
+          identifier_from_path.key?(:consumer_name)
+        end
+
+        def provider_specified?
+          identifier_from_path.key?(:provider_name)
+        end
+
+        def provider_name
+          identifier_from_path[:provider_name]
+        end
+
+        def pacticipant_name
+          identifier_from_path[:pacticipant_name]
+        end
+
+        def pacticipant_specified?
+          identifier_from_path.key?(:pacticipant_name)
+        end
+
+        def invalid_json?
+          begin
+            params
+            false
+          rescue StandardError => e
+            logger.info "Error parsing JSON #{e} - #{request_body}"
+            set_json_error_message "Error parsing JSON - #{e.message}"
+            response.headers['Content-Type'] = 'application/hal+json;charset=utf-8'
+            true
+          end
+        end
+
+        def validation_errors? model
+          if (errors = model.validate).any?
+            set_json_validation_error_messages errors
+            true
+          else
+            false
+          end
+        end
+
+        def contract_validation_errors? contract, params
+          if (invalid = !contract.validate(params))
+            set_json_validation_error_messages contract.errors.messages
+          end
+          invalid
+        end
+
+        def find_pacticipant name, role
+          pacticipant_service.find_pacticipant_by_name(name).tap do | pacticipant |
+            set_json_error_message("No #{role} with name '#{name}' found") if pacticipant.nil?
+          end
+        end
+
+        def consumer
+          @consumer ||= identifier_from_path[:consumer_name] && find_pacticipant(identifier_from_path[:consumer_name], "consumer")
+        end
+
+        def provider
+          @provider ||= identifier_from_path[:provider_name] && find_pacticipant(identifier_from_path[:provider_name], "provider")
+        end
+
+        def pacticipant
+          @pacticipant ||= identifier_from_path[:pacticipant_name] && find_pacticipant(identifier_from_path[:pacticipant_name], "pacticipant")
+        end
+
+        def pact
+          @pact ||= pact_service.find_pact(pact_params)
+        end
+
+        def database_connector
+          request.env["pactbroker.database_connector"]
+        end
+      end
+    end
+  end
+end