pact_broker 1.0.0 → 1.1.0

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

@@ -5,12 +5,14 @@ module PactBroker
     module Decorators
       class RepresentablePact
 
-        attr_reader :consumer, :provider, :consumer_version
+        attr_reader :consumer, :provider, :consumer_version, :created_at, :updated_at
 
         def initialize pact
           @consumer_version = pact.consumer_version
           @consumer = OpenStruct.new(:version => @consumer_version, :name => pact.consumer.name)
           @provider = OpenStruct.new(:version => nil, :name => pact.provider.name)
+          @created_at = pact.created_at
+          @updated_at = pact.updated_at
         end
 
       end

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

@@ -9,6 +9,9 @@ module PactBroker
 
       class TagDecorator < BaseDecorator
 
+        property :createdAt, getter: lambda { |_| created_at ? created_at.xmlschema : nil }
+        property :updatedAt, getter: lambda { |_| updated_at ? updated_at.xmlschema : nil }
+
         link :self do | options |
           tag_url(options[:base_url], represented)
         end

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

@@ -0,0 +1,52 @@
+require_relative 'base_decorator'
+require 'pact_broker/api/decorators/webhook_request_decorator'
+require 'pact_broker/models/webhook_request'
+require 'pact_broker/api/decorators/basic_pacticipant_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      class WebhookDecorator < BaseDecorator
+
+        property :request, :class => PactBroker::Models::WebhookRequest, :extend => WebhookRequestDecorator
+
+        property :createdAt, getter: lambda { |_| created_at.xmlschema }, writeable: false
+        property :updatedAt, getter: lambda { |_| updated_at.xmlschema }, writeable: false
+
+        property :consumer, :extend => PactBroker::Api::Decorators::BasicPacticipantRepresenter, :embedded => true, writeable: false
+        property :provider, :extend => PactBroker::Api::Decorators::BasicPacticipantRepresenter, :embedded => true, writeable: false
+
+        link :self do | options |
+          {
+            title: represented.description,
+            href: webhook_url(represented, options[:base_url])
+          }
+
+        end
+
+        link :'pact-webhooks' do | options |
+          {
+            title: "All webhooks for the pact between #{represented.consumer.name} and #{represented.provider.name}",
+            href: webhooks_for_pact_url(represented.consumer, represented.provider, options[:base_url])
+          }
+        end
+
+        link :'webhooks' do | options |
+          {
+            title: "All webhooks",
+            href: webhooks_url(options[:base_url])
+          }
+        end
+
+        link :execute do | options |
+          {
+            title: "Test the execution of the webhook by sending a POST request to this URL",
+            href: webhook_execution_url(represented, options[:base_url])
+          }
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+require_relative 'base_decorator'
+require 'json'
+
+module PactBroker
+  module Api
+    module Decorators
+
+      class WebhookExecutionResultDecorator < BaseDecorator
+
+        class ErrorDecorator < BaseDecorator
+
+          property :message
+          property :backtrace
+
+        end
+
+        class HTTPResponseDecorator < BaseDecorator
+
+          property :status, :getter => lambda { |_| code.to_i }
+          property :headers, exec_context: :decorator
+          property :body, exec_context: :decorator
+
+          def headers
+            headers_hash = represented.to_hash
+            headers_hash.keys.each_with_object({}) do | name, new_headers_hash|
+              new_headers_hash[name] = headers_hash[name].join(", ")
+            end
+          end
+
+          def body
+            begin
+              ::JSON.parse(represented.body)
+            rescue StandardError => e
+              represented.body
+            end
+          end
+
+        end
+
+        property :error, :extend => ErrorDecorator
+        property :response, :extend => HTTPResponseDecorator
+
+        link :webhook do | options |
+          {
+            href: webhook_url(options.fetch(:webhook), options.fetch(:base_url))
+          }
+        end
+
+        link :'try-again' do | options |
+          {
+            title: 'Execute the webhook again',
+            href: webhook_execution_url(options.fetch(:webhook), options.fetch(:base_url))
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require_relative 'base_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      class WebhookRequestDecorator < BaseDecorator
+
+        property :method
+        property :url
+        property :headers, getter: lambda { | _ | headers.empty? ? nil : headers }
+        property :body
+        property :username
+        property :password, getter: lambda { | _ | display_password }
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require_relative 'base_decorator'
+require 'pact_broker/api/decorators/webhook_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      class WebhooksDecorator < BaseDecorator
+
+
+        link :'pb:self' do | context |
+          {
+            title: context.resource_title,
+            href: context.resource_url
+          }
+        end
+
+        links :webhooks do | context |
+          represented.entries.collect do | webhook |
+            {
+              title: webhook.description,
+              name: webhook.request_description,
+              href: webhook_url(webhook, context.base_url)
+            }
+          end
+        end
+
+        curies do | context |
+          [{
+            name: :pb,
+            href: context.base_url + '/doc/webhooks',
+          }]
+        end
+
+      end
+    end
+  end
+end

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -43,6 +43,22 @@ module PactBroker
         "#{tags_url(base_url, tag.version)}/#{tag.name}"
       end
 
+      def webhooks_url base_url
+        "#{base_url}/webhooks"
+      end
+
+      def webhook_url webhook, base_url
+        "#{base_url}/webhooks/#{webhook.uuid}"
+      end
+
+      def webhook_execution_url webhook, base_url
+        "#{base_url}/webhooks/#{webhook.uuid}/execute"
+      end
+
+      def webhooks_for_pact_url consumer, provider, base_url
+        "#{base_url}/webhooks/provider/#{provider.name}/consumer/#{consumer.name}"
+      end
+
       private
 
       def representable_pact pact

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

@@ -1,6 +1,7 @@
 require 'pact/consumer_contract'
 require 'pact/reification'
 require 'redcarpet'
+require 'pact/doc/markdown/consumer_contract_renderer'
 
 module PactBroker
   module Api
@@ -26,7 +27,7 @@ module PactBroker
         end
 
         def markdown
-          Pact::Doc::Markdown::InteractionsRenderer.call consumer_contract
+          Pact::Doc::Markdown::ConsumerContractRenderer.call consumer_contract
         end
 
         def html

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

@@ -3,6 +3,7 @@ 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'
 
 module PactBroker::Api
 
@@ -25,6 +26,7 @@ module PactBroker::Api
 
       include PactBroker::Services
       include PactBroker::Api::PactBrokerUrls
+      include PactBroker::Logging
 
       def identifier_from_path
         request.path_info.each_with_object({}) do | pair, hash|
@@ -32,10 +34,19 @@ module PactBroker::Api
         end
       end
 
-      def resource_url
+      # This should be called base_url
+      def base_url
         request.uri.to_s.gsub(/#{request.uri.path}$/,'')
       end
 
+      def resource_url
+        request.uri.to_s
+      end
+
+      def decorator_context options = {}
+        Decorators::DecoratorContext.new(base_url, resource_url, options)
+      end
+
       def handle_exception e
         PactBroker::Api::Resources::ErrorHandler.handle_exception(e, response)
       end

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

@@ -0,0 +1,38 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/api/decorators/relationships_csv_decorator'
+
+module PactBroker::Api
+
+  module Resources
+
+    class Group < BaseResource
+
+      def content_types_provided
+        [["text/csv", :to_csv]]
+      end
+
+      def allowed_methods
+        ["GET"]
+      end
+
+      def to_csv
+        generate_csv(group_service.find_group_containing @pacticipant)
+      end
+
+      def generate_csv group
+        PactBroker::Api::Decorators::RelationshipsCsvDecorator.new(group).to_csv
+      end
+
+      def pacticipant_name
+        identifier_from_path[:pacticipant_name]
+      end
+
+      def resource_exists?
+        @pacticipant = pacticipant_service.find_pacticipant_by_name(pacticipant_name)
+        @pacticipant != nil
+      end
+
+    end
+  end
+
+end

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

@@ -19,31 +19,40 @@ module PactBroker::Api
       def to_json
         {
           _links: {
-            'index' => [
-              {
-                href: request.uri.to_s,
-                title: 'The index page',
-                templated: false
-              }
-            ],
-            'latest-pacts' => [
-              {
-                href: request.uri.to_s + 'pacts/latest',
-                title: 'Retrieve latest pacts',
-                templated: false
-              }
-            ],
-            'pacticpants' => [
-              {
-                href: request.uri.to_s + 'pacticipants',
-                title: 'Retrieve pacticipants',
-                templated: false
-              }
-            ]
+            'pb:self' =>
+            {
+              href: request.uri.to_s,
+              title: 'The Pact Broker index page',
+              templated: false
+            },
+            'pb:latest-pacts' =>
+            {
+              href: request.uri.to_s + 'pacts/latest',
+              title: 'Retrieve latest pacts',
+              templated: false
+            },
+            'pb:pacticipants' =>
+            {
+              href: request.uri.to_s + 'pacticipants',
+              title: 'Retrieve pacticipants',
+              templated: false
+            },
+            'pb:webhooks' =>
+            {
+              href: request.uri.to_s + 'webhooks',
+              title: 'Webhooks',
+              templated: false
+            },'curies' =>
+            [{
+              name: 'pb',
+              href: request.uri.to_s + 'doc/{rel}',
+              templated: true
+            }]
           }
         }.to_json
       end
 
+
     end
   end
 

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

@@ -23,7 +23,7 @@ module PactBroker::Api
 
       def to_json
         response.headers['X-Pact-Consumer-Version'] = @pact.consumer_version_number
-        @pact.json_content
+        PactBroker::Api::Decorators::PactDecorator.new(@pact).to_json(base_url: base_url)
       end
 
       def to_html

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

@@ -19,7 +19,7 @@ module PactBroker::Api
       end
 
       def generate_json pacts
-        PactBroker::Api::Decorators::PactCollectionDecorator.new(pacts).to_json(base_url: resource_url)
+        PactBroker::Api::Decorators::PactCollectionDecorator.new(pacts).to_json(base_url: base_url)
       end
 
     end

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

@@ -1,5 +1,7 @@
 require 'cgi'
 require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/api/decorators/pact_decorator'
+require 'pact_broker/json'
 
 module PactBroker::Api
 
@@ -19,6 +21,20 @@ module PactBroker::Api
         ["GET", "PUT"]
       end
 
+      def malformed_request?
+        if request.put?
+          begin
+            JSON.parse(pact_content, PactBroker::PACT_PARSING_OPTIONS) #Not load! Otherwise it will try to load Ruby classes.
+            false
+          rescue StandardError => e
+            logger.error "Error parsing JSON #{e} - #{pact_content}"
+            response.headers['Content-Type'] = 'application/json'
+            response.body = {error: "Invalid JSON - #{e.message}"}.to_json
+            true
+          end
+        end
+      end
+
       def resource_exists?
         @pact = pact_service.find_pact(identifier_from_path)
         @pact != nil
@@ -26,12 +42,12 @@ module PactBroker::Api
 
       def from_json
         @pact, created = pact_service.create_or_update_pact(identifier_from_path.merge(:json_content => pact_content))
-        response.headers["Location"] = pact_url(resource_url, @pact) if created
+        response.headers["Location"] = pact_url(base_url, @pact) if created
         response.body = to_json
       end
 
       def to_json
-        @pact.json_content
+        PactBroker::Api::Decorators::PactDecorator.new(@pact).to_json(base_url: base_url)
       end
 
       def pact_content

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

@@ -0,0 +1,87 @@
+
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/api/decorators/webhook_decorator'
+require 'pact_broker/api/decorators/webhooks_decorator'
+
+module PactBroker::Api
+
+  module Resources
+
+    class PactWebhooks < BaseResource
+
+      def allowed_methods
+        ["POST", "GET"]
+      end
+
+      def content_types_provided
+        [["application/hal+json", :to_json]]
+      end
+
+      def resource_exists?
+        (@consumer = find_pacticipant(identifier_from_path[:consumer_name], "consumer")) &&
+          (@provider = find_pacticipant(identifier_from_path[:provider_name], "provider"))
+      end
+
+      def malformed_request?
+        if request.post?
+          begin
+            if (errors = webhook.validate).any?
+              set_json_validation_error_messages errors
+              return true
+            end
+          rescue
+            set_json_error_message 'Invalid JSON'
+            return true
+          end
+        end
+        false
+      end
+
+      def process_post
+        saved_webhook = webhook_service.create webhook, consumer, provider
+        response.headers['Content-Type'] = 'application/json'
+        response.headers['Location'] = webhook_url saved_webhook, base_url
+        response.body = Decorators::WebhookDecorator.new(saved_webhook).to_json(base_url: base_url)
+        true
+      end
+
+      def to_json
+        Decorators::WebhooksDecorator.new(webhooks).to_json(decorator_context(resource_title: 'Pact webhooks'))
+      end
+
+      private
+
+      attr_reader :consumer, :provider
+
+      def webhooks
+        webhook_service.find_by_consumer_and_provider consumer, provider
+      end
+
+      def webhook
+        @webhook ||= Decorators::WebhookDecorator.new(PactBroker::Models::Webhook.new).from_json(request.body.to_s)
+      end
+
+      def set_json_error_message message
+        response.headers['Content-Type'] = 'application/json'
+        response.body = {error: message}.to_json
+      end
+
+      def set_json_validation_error_messages errors
+        response.headers['Content-Type'] = 'application/json'
+        response.body = {errors: errors}.to_json
+      end
+
+      def find_pacticipant name, role
+        pacticipant = pacticipant_service.find_pacticipant_by_name name
+        if pacticipant.nil?
+          set_json_error_message "No #{role} with name '#{name}' found"
+          nil
+        else
+          pacticipant
+        end
+      end
+
+    end
+  end
+
+end