pact_broker 2.15.0 → 2.16.0

data/lib/pact_broker/api.rb

@@ -66,6 +66,7 @@ module PactBroker
         add ['matrix', 'provider', :provider_name, 'latest', :provider_tag, 'consumer', :consumer_name, 'latest', :tag, 'badge'], Api::Resources::MatrixBadge, {resource_name: "matrix_tag_badge"}
         add ['matrix'], Api::Resources::Matrix, {resource_name: "matrix"}
 
+        add ['dashboard'], Api::Resources::Dashboard, {resource_name: "dashboard"}
         add [], Api::Resources::Index, {resource_name: "index"}
       end
     end

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

@@ -0,0 +1,163 @@
+require 'ostruct'
+require 'pact_broker/api/pact_broker_urls'
+
+module PactBroker
+  module Api
+    module Decorators
+      class DashboardDecorator
+        include PactBroker::Api::PactBrokerUrls
+
+        def initialize(index_items)
+          @index_items = index_items
+        end
+
+        def to_json(options)
+          to_hash(options).to_json
+        end
+
+        def to_hash(options)
+          {
+            items: items(index_items, options[:user_options][:base_url])
+          }
+        end
+
+        private
+
+        attr_reader :index_items
+
+        def items(index_items, base_url)
+          index_items.collect do | index_item |
+            index_item_hash(index_item.consumer, index_item.provider, index_item.consumer_version, index_item, base_url)
+          end
+        end
+
+        def index_item_hash(consumer, provider, consumer_version, index_item, base_url)
+          {
+            consumer: consumer_hash(index_item, consumer, consumer_version, base_url),
+            provider: provider_hash(index_item, provider, base_url),
+            pact: pact_hash(index_item, base_url),
+            pactTags: pact_tags(index_item, base_url),
+            latestVerificationResult: verification_hash(index_item, base_url),
+            latestVerificationResultTags: verification_tags(index_item, base_url),
+            verificationStatus: index_item.verification_status.to_s,
+            webhookStatus: index_item.webhook_status.to_s,
+            latestWebhookExecution: latest_webhook_execution(index_item, base_url),
+            _links: links(index_item, base_url)
+
+          }
+        end
+
+        def consumer_hash(index_item, consumer, consumer_version, base_url)
+          {
+            name: index_item.consumer_name,
+            version: {
+              number: index_item.consumer_version_number,
+              _links: {
+                self: {
+                  href: version_url(base_url, index_item.consumer_version)
+                }
+              }
+            },
+            _links: {
+              self: {
+                href: pacticipant_url(base_url, index_item.consumer)
+              }
+            }
+          }
+        end
+
+        def provider_hash(index_item, provider, base_url)
+          hash = {
+            name: index_item.provider_name,
+            version: nil,
+            _links: {
+              self: {
+                href: pacticipant_url(base_url, index_item.provider)
+              }
+            }
+          }
+
+          if index_item.latest_verification
+            hash[:version] = { number: index_item.provider_version_number }
+          end
+
+          hash
+        end
+
+        def pact_hash(index_item, base_url)
+          {
+            createdAt: index_item.latest_pact.created_at.to_datetime.xmlschema,
+            _links: {
+              self: {
+                href: pact_url(base_url, index_item.latest_pact)
+              }
+            }
+          }
+        end
+
+        def verification_hash(index_item, base_url)
+          if index_item.latest_verification
+            {
+              success: index_item.latest_verification.success,
+              verifiedAt: index_item.latest_verification.created_at.to_datetime.xmlschema,
+              _links: {
+                self: {
+                  href: verification_url(index_item.latest_verification, base_url)
+                }
+              }
+            }
+          else
+            nil
+          end
+        end
+
+        def pact_tags(index_item, base_url)
+          index_item.tag_names.collect do | tag_name |
+            fake_tag = OpenStruct.new(name: tag_name, version: index_item.consumer_version)
+            {
+              name: tag_name,
+              latest: true,
+              _links: {
+                self: {
+                  href: tag_url(base_url, fake_tag)
+                }
+              }
+            }
+          end
+        end
+
+        def verification_tags(index_item, base_url)
+          index_item.latest_verification_latest_tags.collect do | tag |
+            fake_tag = OpenStruct.new(name: tag.name, version: index_item.provider_version)
+            {
+              name: tag.name,
+              latest: tag.latest?,
+              _links: {
+                self: {
+                  href: tag_url(base_url, fake_tag)
+                }
+              }
+            }
+          end
+        end
+
+        def latest_webhook_execution(index_item, base_url)
+          if index_item.last_webhook_execution_date
+            {
+              triggeredAt: index_item.last_webhook_execution_date.to_datetime.xmlschema
+            }
+          end
+        end
+
+        def links(index_item, base_url)
+          {
+            'pb:webhook-status' => {
+              title: "Status of webhooks for #{index_item.consumer_name}/#{index_item.provider_name} pact",
+              href: webhooks_status_url(index_item.consumer, index_item.provider, base_url)
+            }
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+require 'ostruct'
+require 'pact_broker/api/pact_broker_urls'
+
+module PactBroker
+  module Api
+    module Decorators
+      class DashboardTextDecorator
+        include PactBroker::Api::PactBrokerUrls
+
+        Line = Struct.new(:consumer_name, :c_version, :c_tags , :provider_name, :p_version, :p_tags, :success)
+
+        def initialize(index_items)
+          @index_items = index_items
+        end
+
+        def to_json(options)
+          to_hash(options).to_json
+        end
+
+        def to_text(options)
+          data = items(index_items, options[:user_options][:base_url])
+          printer = TablePrint::Printer.new(data)
+          printer.table_print + "\n"
+        end
+
+        private
+
+        attr_reader :index_items
+
+        def items(index_items, base_url)
+          index_items.collect do | index_item |
+            index_item_object(index_item)
+          end
+        end
+
+        def index_item_object(index_item)
+          Line.new(
+            index_item.consumer_name,
+            index_item.consumer_version_number,
+            index_item.tag_names.join(", "),
+            index_item.provider_name,
+            index_item.provider_version_number,
+            index_item.latest_verification_latest_tags.collect(&:name).join(", "),
+            index_item.verification_status.to_s
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -27,8 +27,8 @@ module PactBroker
 
         def deployable
           return nil if lines.empty?
-          return nil if lines.any?{ |line| line[:success].nil? }
-          lines.any? && lines.all?{ |line| line[:success] }
+          return nil if lines.any?{ |line| line.success.nil? }
+          lines.any? && lines.all?{ |line| line.success }
         end
 
         def reason
@@ -47,9 +47,9 @@ module PactBroker
 
         def matrix(lines, base_url)
           lines.collect do | line |
-            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)
+            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)
           end
         end
@@ -65,9 +65,9 @@ module PactBroker
 
         def consumer_hash(line, consumer, consumer_version, base_url)
           {
-            name: line[:consumer_name],
+            name: line.consumer_name,
             version: {
-              number: line[:consumer_version_number],
+              number: line.consumer_version_number,
               _links: {
                 self: {
                   href: version_url(base_url, consumer_version)
@@ -84,7 +84,7 @@ module PactBroker
 
         def provider_hash(line, provider, base_url)
           hash = {
-            name: line[:provider_name],
+            name: line.provider_name,
             version: nil,
             _links: {
               self: {
@@ -93,8 +93,8 @@ module PactBroker
             }
           }
 
-          if !line[:provider_version_number].nil?
-            hash[:version] = { number: line[:provider_version_number] }
+          if !line.provider_version_number.nil?
+            hash[:version] = { number: line.provider_version_number }
           end
 
           hash
@@ -102,23 +102,28 @@ module PactBroker
 
         def pact_hash(line, base_url)
           {
-            createdAt: line[:pact_created_at].to_datetime.xmlschema,
+            createdAt: line.pact_created_at.to_datetime.xmlschema,
             _links: {
               self: {
-                href: pact_url_from_params(base_url, line)
+                href: pact_url(base_url, line)
               }
             }
           }
         end
 
         def verification_hash(line, base_url)
-          if !line[:success].nil?
+          if !line.success.nil?
+            url_params = { consumer_name: line.consumer_name,
+              provider_name: line.provider_name,
+              pact_version_sha: line.pact_version_sha,
+              verification_number: line.verification_number
+            }
             {
-              success: line[:success],
-              verifiedAt: line[:verification_executed_at].to_datetime.xmlschema,
+              success: line.success,
+              verifiedAt: line.verification_executed_at.to_datetime.xmlschema,
               _links: {
                 self: {
-                  href: verification_url(OpenStruct.new(line.merge(number: line[:verification_number])), base_url)
+                  href: verification_url_from_params(url_params, base_url)
                 }
               }
             }

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

@@ -48,6 +48,7 @@ module PactBroker
           if dasherized['_embedded']
             if dasherized['_embedded']['latest-version']
               dasherized['_embedded']['latest-version']['title'] = 'DEPRECATED - please use latestVersion'
+              dasherized['_embedded']['latest-version']['name'] = 'DEPRECATED - please use latestVersion'
             end
             h['_embedded'] ||= {}
             h['_embedded'].merge!(dasherized['_embedded'])

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -4,6 +4,8 @@ module PactBroker
   module Api
     module PactBrokerUrls
 
+      # TODO make base_url the last and optional argument for all methods, defaulting to ''
+
       extend self
 
       def pacticipants_url base_url
@@ -14,6 +16,14 @@ module PactBroker
         "#{pacticipants_url(base_url)}/#{url_encode(pacticipant.name)}"
       end
 
+      def pacticipant_url_from_params params, base_url = ''
+        [
+          base_url,
+          'pacticipants',
+          url_encode(params.fetch(:pacticipant_name))
+        ].join("/")
+      end
+
       def latest_version_url base_url, pacticipant
         "#{pacticipant_url(base_url, pacticipant)}/versions/latest"
       end
@@ -26,6 +36,16 @@ module PactBroker
         "#{pacticipant_url(base_url, version.pacticipant)}/versions/#{version.number}"
       end
 
+      def version_url_from_params params, base_url = ''
+        [
+          base_url,
+          'pacticipants',
+          url_encode(params.fetch(:pacticipant_name)),
+          'versions',
+          url_encode(params.fetch(:version_number)),
+        ].join("/")
+      end
+
       def pact_url base_url, pact
         "#{pactigration_base_url(base_url, pact)}/version/#{pact.consumer_version_number}"
       end
@@ -87,6 +107,15 @@ module PactBroker
         ].join('/')
       end
 
+      def verification_url_from_params params, base_url = ''
+        [ base_url, 'pacts',
+          'provider', url_encode(params.fetch(:provider_name)),
+          'consumer', url_encode(params.fetch(:consumer_name)),
+          'pact-version', params.fetch(:pact_version_sha),
+          'verification-results', params.fetch(:verification_number)
+        ].join('/')
+      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"
       end

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

@@ -41,6 +41,9 @@ module PactBroker
         end
 
         def finish_request
+          if !request.get? && !request.head?
+            matrix_service.refresh(identifier_from_path)
+          end
           PactBroker.configuration.after_resource.call(self)
         end
 

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

@@ -0,0 +1,38 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/api/decorators/dashboard_decorator'
+require 'pact_broker/api/decorators/dashboard_text_decorator'
+
+module PactBroker
+  module Api
+    module Resources
+
+      class Dashboard < BaseResource
+
+        def content_types_provided
+          [
+            ["application/hal+json", :to_json],
+            ["text/plain", :to_text],
+          ]
+        end
+
+        def allowed_methods
+          ["GET"]
+        end
+
+        def to_json
+          PactBroker::Api::Decorators::DashboardDecorator.new(index_items).to_json(user_options: decorator_context)
+        end
+
+        def to_text
+          PactBroker::Api::Decorators::DashboardTextDecorator.new(index_items).to_text(user_options: decorator_context)
+        end
+
+        private
+
+        def index_items
+          index_service.find_index_items(tags: true)
+        end
+      end
+    end
+  end
+end

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

@@ -4,7 +4,6 @@ require 'pact_broker/api/decorators/label_decorator'
 module PactBroker
   module Api
     module Resources
-
       class Label < BaseResource
 
         def content_types_provided

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

@@ -3,7 +3,6 @@ require 'pact_broker/api/resources/base_resource'
 module PactBroker
   module Api
     module Resources
-
       class Tag < BaseResource
 
         def content_types_provided