pact_broker 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03e1cb232f71117f88a50df3b9b46001bf5fcc4d
-  data.tar.gz: 72758f12fc4fb67c94bb3f21190ccf7e56e36b80
+  metadata.gz: ccb2b3e09704513328cc45bb520d07bec978a711
+  data.tar.gz: a98ed177a3db187c531c6f7a606a38c0382278b5
 SHA512:
-  metadata.gz: a455b7e1e44018827ac663ffe87eeb4c118c082865f9cbb926f0cc2fc3ed7d30ba28686c6b58548b7f36550f30ff8a634f0dc4ec26af8238aaae5d27b96cf2f0
-  data.tar.gz: 805d6d8e3d035ae6543d342459f22e21dc05eb0cda99bf96c64b568c937c383678c5ce20582d0a44ffa41f626e9e40bed0fe15f5dcdcf5155fa053e47cad9cc9
+  metadata.gz: 029ca439a15afebbcca133103d59a67ce4a359df4f57dfb4d9da5e0cf02b820d6eccbb93304d64f400216d455f7c3beac9b27fcd04318a5beb4960e66cf569a7
+  data.tar.gz: 462f2d6f9a04dbe36916b94e0f2a52965c8f23234d901ea80280859e2f71c8695a2c1f7b484f763a633b1de873c9d9cec6b9ac93b08dab900f07d93f809c52db

data/CHANGELOG.md

@@ -2,6 +2,14 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+* 3a03f41 - fix(publish verification result): Fix Location header for newly created resource (Beth Skurrie, Mon Jul 31 10:49:37 2017 +1000)
+* 3b0f390 - feat(pacticipant labels): Add HAL link to pacticipants resource to find pacticipants by label. (Beth Skurrie, Mon Jul 24 08:17:36 2017 +1000)
+* 588d2ad - fix(pacticipant and pacticipants resources): Add correctly capitalised and namespaced properties and relations. Added deprecation warnings to existing incorrect properties and relations. (Beth Skurrie, Mon Jul 24 08:14:52 2017 +1000)
+* ab11f56 - feat(pacticipant labels): Adds embedded label resources to pacticipant resource. (Beth Skurrie, Fri Jul 21 18:03:15 2017 +1000)
+* 57086cf - feat(pacticipant labels): Adds /pacticipants/label/LABEL_NAME resource to retrieve pacticipants by label. (Beth Skurrie, Fri Jul 21 14:07:08 2017 +1000)
+* 4b44331 - feat(pacticipant labels): Adds pacticipant label resource with GET, PUT and DELETE (Beth Skurrie, Fri Jul 21 13:18:18 2017 +1000)
+* c5af7e1 - feat(badges): Allow badge config settings to be saved to/loaded from database (Beth Skurrie, Fri Jul 14 20:50:02 2017 +1000)
+
 #### 2.3.0 (2017-07-14)
 * 3ac4351 - fix(potential duplicate pacticipant names): Make duplicate logic smarter. Fixes https://github.com/pact-foundation/pact_broker/issues/35 (Beth Skurrie, Tue Jul 11 10:30:11 2017 +1000)
 * 81979b1 - add basic auth example to duplicate pacticipant error/help message (Fitzgerald, Andrew, Mon Jul 10 00:11:25 2017 -0400)

data/README.md

@@ -21,15 +21,14 @@ Features:
 * A RESTful API for publishing and retrieving pacts.
 * An embedded HAL browser for navigating the API.
 * Autogenerated documentation for each pact.
-* Dynamically generated network diagrams.
-* Displays provider verificaton results.
+* Dynamically generated network diagrams so you can visualise your microservice network.
+* Displays provider verificaton results so you know if you can deploy safely.
+* Provides badges to display pact verification statuses in your READMEs.
 * Enables a pact version to be tagged (ie. "prod") so a provider can verify itself against a fixed version of a pact to ensure backwards compatibility.
 * Provides webhooks to trigger a provider build when a consumer publishes a change to a pact.
 * Tracks changes between Pact versions so you can tell when a consumer has changed its expectations.
 * [Docker Pact Broker][docker]
 
-Travis CI Status: [![Build Status](https://travis-ci.org/pact-foundation/pact_broker.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker)
-
 ### How would I use the Pact Broker?
 
 #### Step 1. Consumer CI build

data/db/migrations/37_create_labels_table.rb

@@ -0,0 +1,11 @@
+Sequel.migration do
+  change do
+    create_table(:labels, charset: 'utf8') do
+      String :name
+      foreign_key :pacticipant_id, :pacticipants
+      primary_key [:pacticipant_id, :name], name: :labels_pk
+      DateTime :created_at, null: false
+      DateTime :updated_at, null: false
+    end
+  end
+end

data/lib/pact_broker/api.rb

@@ -9,7 +9,9 @@ require 'pact_broker/api/resources/latest_pact'
 require 'pact_broker/api/resources/latest_pacts'
 require 'pact_broker/api/resources/pacticipant'
 require 'pact_broker/api/resources/pacticipants'
+require 'pact_broker/api/resources/pacticipants_for_label'
 require 'pact_broker/api/resources/tag'
+require 'pact_broker/api/resources/label'
 require 'pact_broker/api/resources/index'
 require 'pact_broker/api/resources/relationships'
 require 'pact_broker/api/resources/group'
@@ -69,10 +71,12 @@ module PactBroker
 
         # Pacticipants
         add ['pacticipants'], Api::Resources::Pacticipants, {resource_name: "pacticipants"}
+        add ['pacticipants', 'label', :label_name], PactBroker::Api::Resources::PacticipantsForLabel, {resource_name: "pacticipants_for_label"}
         add ['pacticipants', :name], Api::Resources::Pacticipant, {resource_name: "pacticipant"}
         add ['pacticipants', :pacticipant_name, 'versions'], Api::Resources::Versions, {resource_name: "pacticipant_versions"}
         add ['pacticipants', :pacticipant_name, 'versions', :pacticipant_version_number], Api::Resources::Version, {resource_name: "pacticipant_version"}
         add ['pacticipants', :pacticipant_name, 'versions', :pacticipant_version_number, 'tags', :tag_name], Api::Resources::Tag, {resource_name: "pacticipant_version_tag"}
+        add ['pacticipants', :pacticipant_name, 'labels', :label_name], Api::Resources::Label, {resource_name: "pacticipant_label"}
 
         # Webhooks
         add ['webhooks', 'provider', :provider_name, 'consumer', :consumer_name ], Api::Resources::PactWebhooks, {resource_name: "pact_webhooks"}

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

@@ -0,0 +1,20 @@
+require_relative 'base_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      class EmbeddedLabelDecorator < BaseDecorator
+
+        property :name
+
+        link :self do | options |
+          {
+            title: 'Label',
+            name: represented.name,
+            href: label_url(represented, options[:base_url])
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require_relative 'base_decorator'
+require_relative 'pact_pacticipant_decorator'
+require_relative 'timestamps'
+
+module PactBroker
+  module Api
+    module Decorators
+      class LabelDecorator < BaseDecorator
+
+        property :name
+
+        include Timestamps
+
+        link :self do | options |
+          {
+            title: 'Label',
+            name: represented.name,
+            href: label_url(represented, options[:base_url])
+          }
+        end
+
+        link :pacticipant do | options |
+          {
+            title: 'Pacticipant',
+            name: represented.pacticipant.name,
+            href: pacticipant_url(options.fetch(:base_url), represented.pacticipant)
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -4,11 +4,8 @@ require_relative 'latest_pact_decorator'
 require_relative 'representable_pact'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class PactCollectionDecorator < BaseDecorator
         include Roar::JSON::HAL
         include PactBroker::Api::PactBrokerUrls
@@ -37,8 +34,7 @@ module PactBroker
             }
           end
         end
-
       end
     end
   end
-end
+end

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

@@ -2,12 +2,8 @@ require_relative 'base_decorator'
 require_relative 'pact_version_decorator'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
-
       class PactVersionsDecorator < BaseDecorator
 
         collection :entries, as: :pacts, embedded: true, :extend => PactBroker::Api::Decorators::PactVersionDecorator
@@ -45,7 +41,6 @@ module PactBroker
             }
           end
         end
-
       end
     end
   end

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

@@ -10,16 +10,45 @@ module PactBroker
 
       class PacticipantCollectionDecorator < BaseDecorator
 
-        collection :entries, :as => :pacticipants, :class => PactBroker::Domain::Pacticipant, :extend => PactBroker::Api::Decorators::PacticipantDecorator
+        collection :entries, :as => :pacticipants, :class => PactBroker::Domain::Pacticipant, :extend => PactBroker::Api::Decorators::PacticipantDecorator, embedded: true
 
         link :self do | options |
           pacticipants_url options[:base_url]
         end
 
+        link :'pb:pacticipants-with-label' do | options |
+          {
+            title: "Find pacticipants by label",
+            href: "#{pacticipants_url(options[:base_url])}/label/{label}",
+            templated: true
+          }
+        end
+
+        links :'pb:pacticipants' do | options |
+          represented.collect{ | pacticipant | {:href => pacticipant_url(options[:base_url], pacticipant), title: 'Pacticipant', name: pacticipant.name } }
+        end
+
+        # TODO deprecate in v3
         links :pacticipants do | options |
-          represented.collect{ | pacticipant | {:href => pacticipant_url(options[:base_url], pacticipant), :title => pacticipant.name } }
+          represented.collect{ | pacticipant | {:href => pacticipant_url(options[:base_url], pacticipant), :title => pacticipant.name, name: 'DEPRECATED - please use pb:pacticipants' } }
         end
+      end
 
+      class DeprecatedPacticipantDecorator < PactBroker::Api::Decorators::PacticipantDecorator
+        property :title, getter: ->(something) { "DEPRECATED - Please use the embedded pacticipants collection" }
+      end
+
+      class NonEmbeddedPacticipantCollectionDecorator < BaseDecorator
+        collection :entries, :as => :pacticipants, :class => PactBroker::Domain::Pacticipant, :extend => DeprecatedPacticipantDecorator, embedded: false
+      end
+
+      # TODO deprecate this - breaking change for v 3.0
+      class DeprecatedPacticipantCollectionDecorator < PacticipantCollectionDecorator
+        def to_hash(options = {})
+          embedded_pacticipant_hash = super
+          non_embedded_pacticipant_hash = NonEmbeddedPacticipantCollectionDecorator.new(represented).to_hash(options)
+          embedded_pacticipant_hash.merge(non_embedded_pacticipant_hash)
+        end
       end
     end
   end

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

@@ -1,20 +1,19 @@
 require_relative 'base_decorator'
 require_relative 'embedded_version_decorator'
-require 'pact_broker/api/decorators/timestamps'
+require_relative 'embedded_label_decorator'
+require_relative 'timestamps'
 require 'pact_broker/domain'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       class PacticipantDecorator < BaseDecorator
 
         property :name
         property :repository_url, as: :repositoryUrl
 
-        property :latest_version, as: :'latest-version', :class => PactBroker::Domain::Version, :extend => PactBroker::Api::Decorators::EmbeddedVersionDecorator, :embedded => true, writeable: false
+        property :latest_version, as: :latestVersion, :class => PactBroker::Domain::Version, extend: PactBroker::Api::Decorators::EmbeddedVersionDecorator, embedded: true, writeable: false
+        collection :labels, :class => PactBroker::Domain::Label, extend: PactBroker::Api::Decorators::EmbeddedLabelDecorator, embedded: true
 
         include Timestamps
 
@@ -22,14 +21,44 @@ module PactBroker
           pacticipant_url(options[:base_url], represented)
         end
 
-        link 'latest-version' do | options |
-          latest_version_url(options[:base_url], represented)
+        link :'pb:versions' do | options |
+          versions_url(options[:base_url], represented)
         end
 
+        # TODO deprecate in v3
+        # URL isn't implemented
+        # link 'latest-version' do | options |
+        #   {
+        #     title: "Deprecated - use pb:latest-version",
+        #     href: latest_version_url(options[:base_url], represented)
+        #   }
+        # end
+
+        # TODO deprecate in v3
         link :versions do | options |
-          versions_url(options[:base_url], represented)
+          {
+            title: "Deprecated - use pb:versions",
+            href: versions_url(options[:base_url], represented)
+          }
+        end
+
+        def to_hash options
+          h = super
+          dasherized = DasherizedVersionDecorator.new(represented).to_hash(options)
+          if dasherized['_embedded']
+            if dasherized['_embedded']['latest-version']
+              dasherized['_embedded']['latest-version']['title'] = 'DEPRECATED - please use latestVersion'
+            end
+            h['_embedded'] ||= {}
+            h['_embedded'].merge!(dasherized['_embedded'])
+          end
+          h
         end
+      end
 
+      class DasherizedVersionDecorator < BaseDecorator
+        # TODO deprecate in v3
+        property :latest_version, as: :'latest-version', :class => PactBroker::Domain::Version, extend: PactBroker::Api::Decorators::EmbeddedVersionDecorator, embedded: true, writeable: false
       end
     end
   end

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -67,11 +67,11 @@ module PactBroker
         "#{version_url(base_url, version)}/tags"
       end
 
-      def new_verification_url params, number, base_url
+      def new_verification_url pact, number, base_url
         [ base_url, 'pacts',
-          'provider', url_encode(params[:provider_name]),
-          'consumer', url_encode(params[:consumer_name]),
-          'pact-version', params[:sha],
+          'provider', url_encode(pact.provider_name),
+          'consumer', url_encode(pact.consumer_name),
+          'pact-version', pact.pact_version_sha,
           'verification-results', number
         ].join('/')
       end
@@ -97,6 +97,14 @@ module PactBroker
         "#{tags_url(base_url, tag.version)}/#{tag.name}"
       end
 
+      def label_url label, base_url
+        "#{labels_url(label.pacticipant, base_url)}/#{label.name}"
+      end
+
+      def labels_url pacticipant, base_url
+        "#{pacticipant_url(base_url, pacticipant)}/labels"
+      end
+
       def webhooks_url base_url
         "#{base_url}/webhooks"
       end

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

@@ -0,0 +1,52 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/api/decorators/label_decorator'
+
+module PactBroker
+  module Api
+    module Resources
+
+      class Label < BaseResource
+
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def content_types_accepted
+          [["application/json", :from_json]]
+        end
+
+        def allowed_methods
+          ["GET","PUT","DELETE"]
+        end
+
+        def from_json
+          unless label
+            @label = label_service.create identifier_from_path
+            # Make it return a 201 by setting the Location header
+            response.headers["Location"] = label_url(label, base_url)
+          end
+          response.body = to_json
+        end
+
+        def resource_exists?
+          label
+        end
+
+        def to_json
+          PactBroker::Api::Decorators::LabelDecorator.new(label).to_json(user_options: { base_url: base_url })
+        end
+
+        def label
+          @label ||= label_service.find identifier_from_path
+        end
+
+        def delete_resource
+          label_service.delete identifier_from_path
+          true
+        end
+
+      end
+    end
+
+  end
+end

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

@@ -45,7 +45,7 @@ module PactBroker
         end
 
         def generate_json pacticipants
-          PactBroker::Api::Decorators::PacticipantCollectionDecorator.new(pacticipants).to_json(user_options: { base_url: base_url })
+          PactBroker::Api::Decorators::DeprecatedPacticipantCollectionDecorator.new(pacticipants).to_json(user_options: { base_url: base_url })
         end
 
         def decorator_for model

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

@@ -0,0 +1,27 @@
+require 'pact_broker/api/resources/base_resource'
+require 'pact_broker/api/decorators/pacticipant_collection_decorator'
+
+module PactBroker
+  module Api
+    module Resources
+      class PacticipantsForLabel < BaseResource
+
+        def content_types_provided
+          [["application/hal+json", :to_json]]
+        end
+
+        def allowed_methods
+          ["GET"]
+        end
+
+        def to_json
+          generate_json(pacticipant_service.find identifier_from_path )
+        end
+
+        def generate_json pacticipants
+          PactBroker::Api::Decorators::PacticipantCollectionDecorator.new(pacticipants).to_json(user_options: { base_url: base_url })
+        end
+      end
+    end
+  end
+end

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

@@ -39,7 +39,7 @@ module PactBroker
         end
 
         def create_path
-          new_verification_url(pact_params, next_verification_number, base_url)
+          new_verification_url(pact, next_verification_number, base_url)
         end
 
         def from_json

data/lib/pact_broker/badges/service.rb

@@ -12,7 +12,6 @@ module PactBroker
       include PactBroker::Logging
 
       SPACE_DASH_UNDERSCORE = /[\s_\-]/
-      LOWER_TO_UPPERCASE = /[a-zA-Z](?=[A-Z])/
 
       def pact_verification_badge pact, label, initials, verification_status
         return static_svg(pact, verification_status) unless pact
@@ -37,13 +36,24 @@ module PactBroker
 
       def prepare_name name, initials
         if initials
-          parts = name.split(SPACE_DASH_UNDERSCORE)
-          parts = name.split(LOWER_TO_UPPERCASE) if parts.size == 1
+          parts = split_space_dash_underscore(name)
+          parts = split_camel_case(name) if parts.size == 1
           return parts.collect{ |p| p[0] }.join.downcase if parts.size > 1
         end
         name.downcase
       end
 
+      def split_space_dash_underscore name
+        name.split(SPACE_DASH_UNDERSCORE)
+      end
+
+      def split_camel_case name
+        name.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr('-', '_')
+            .split('_')
+      end
+
       def badge_status verification_status
         case verification_status
           when :success then "verified"