pact_broker 2.23.4 → 2.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7bd5ebfd2122389ceccb3515386666e4152c57a4
-  data.tar.gz: fb9817503a5f8762b7d79092abc6a7b34cf10027
+  metadata.gz: 221e35de8afb505b63a3bd3eb76ccc8a332e9c99
+  data.tar.gz: 985e0d73ff17ad8d6a7d9cd044863576a53b1ce9
 SHA512:
-  metadata.gz: a4a893b1fc19db8c348e700f2d267828c39ee8eaba41ce8e9d97101f8b7e1f7e0a1d6c5269a53ccf34737cb14b0fe5dcd450c1a02a788bad77cbdcd3ecb47a83
-  data.tar.gz: 0c575437f3cb2ab677a22ca8d6d29849fc5033ea2028b887c8fe6a151a06222909d81fa22146ce8fba225230fb440cae381d3845900dd1cf120db11d4cf87242
+  metadata.gz: 21b9b6aee402ff56fdaf1149867f2ff729a5ca350c3a60c82b0b2c2df9b3788ac2db15b185113fc9108f80e52cb0430340c04f66a473bdef536b5323c6e09275
+  data.tar.gz: 22b9cc5f105543a9a7fd359cf7616c78c6e4e168f9f315ed90944133c97b4a9bd6dc7cf6c4a7c1346a888b4243e468cfe6361edfbbf2c9ffedf902662353ad0f

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+<a name="v2.24.0"></a>
+### v2.24.0 (2018-07-08)
+
+
+#### Features
+
+* disable wip-provider-pacts in production until the feature is passed alpha testing	 ([3f9a1c7](/../../commit/3f9a1c7))
+* allow HAL docs to specify a context so that two relations with the same name in different resources don't clash	 ([fe85b0b](/../../commit/fe85b0b))
+* add pb:diff relation to pact resource to view a diff with an arbitrary pact version	 ([3eaa79c](/../../commit/3eaa79c))
+* add HAL documentation for the relations that were missing documentation	 ([6b04d70](/../../commit/6b04d70))
+* add resource for "work in progress" pacts for a provider	 ([50c003b](/../../commit/50c003b))
+* deprecate pacts relation in favour of pb:pacts in latest pacts resource	 ([ccdd46f](/../../commit/ccdd46f))
+* add bash script to migrate pacts from one broker to another	 ([7d587d9](/../../commit/7d587d9))
+
+
 <a name="v2.23.4"></a>
 ### v2.23.4 (2018-07-04)
 

data/lib/pact_broker/api.rb

@@ -40,6 +40,10 @@ module PactBroker
         add ['pacts', 'provider', :provider_name, 'latest', :tag], Api::Resources::LatestProviderPacts, {resource_name: "latest_tagged_provider_pact_publications"}
         add ['pacts', 'latest'], Api::Resources::LatestPacts, {resource_name: "latest_pacts"}
 
+        if ENV['RACK_ENV'] != 'production'
+          add ['pacts', 'provider', :provider_name, 'wip'], Api::Resources::WipProviderPacts, {resource_name: "wip_provider_pact_publications"}
+        end
+
         # Deprecated pact
         add ['pact', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number], Api::Resources::Pact, {resource_name: "pact_publications", deprecated: "true"} # Deprecate, singular /pact
         add ['pact', 'provider', :provider_name, 'consumer', :consumer_name, 'latest'], Api::Resources::LatestPact, {resource_name: "latest_pact_publications", deprecated: "true"}

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

@@ -24,15 +24,34 @@ module PactBroker
           latest_pacts_url(options[:base_url])
         end
 
+        # This is the LATEST pact URL
+        links :'pb:pacts' do | options |
+          represented.collect do | pact |
+            {
+              :href => latest_pact_url(options[:base_url], pact),
+              :title => "Latest pact between #{pact.consumer.name} and #{pact.provider.name}",
+            }
+          end
+        end
+
         # This is the LATEST pact URL
         links :pacts do | options |
           represented.collect do | pact |
             {
               :href => latest_pact_url(options[:base_url], pact),
               :title => "Latest pact between #{pact.consumer.name} and #{pact.provider.name}",
+              :name => "DEPRECATED - please use the pb:pacts relation"
             }
           end
         end
+
+        curies do | options |
+          [{
+            name: :pb,
+            href: options[:base_url] + '/doc/{rel}?context=pacts',
+            templated: true
+          }]
+        end
       end
     end
   end

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

@@ -99,6 +99,15 @@ module PactBroker
           }
         end
 
+        link :'pb:diff' do | options |
+          {
+            title: "Diff with another specified version of this pact",
+            href: templated_diff_url(represented, options.fetch(:base_url)),
+            templated: true
+
+          }
+        end
+
         link :'pb:pact-webhooks' do | options |
           {
             title: "Webhooks for the pact between #{represented.consumer.name} and #{represented.provider.name}",
@@ -151,11 +160,10 @@ module PactBroker
         curies do | options |
           [{
             name: :pb,
-            href: options[:base_url] + '/doc/{rel}',
+            href: options[:base_url] + '/doc/{rel}?context=pact',
             templated: true
           }]
         end
-
       end
     end
   end

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

@@ -46,7 +46,7 @@ module PactBroker
         curies do | options |
           [{
             name: :pb,
-            href: options.fetch(:base_url) + '/doc/{rel}',
+            href: options.fetch(:base_url) + '/doc/{rel}?context=version',
             templated: true
           }]
         end

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -51,7 +51,7 @@ module PactBroker
       end
 
       def pact_version_url pact, base_url
-        "#{pactigration_base_url(base_url, path)}/pact-version/#{pact.sha}"
+        "#{pactigration_base_url(base_url, pact)}/pact-version/#{pact.pact_version_sha}"
       end
 
       def pact_url_from_params base_url, params
@@ -81,6 +81,10 @@ module PactBroker
         pact_url(base_url, pact) + "/diff/previous-distinct"
       end
 
+      def templated_diff_url pact, base_url = ''
+        pact_version_url(pact, base_url) + "/diff/pact-version/{pactVersion}"
+      end
+
       def previous_distinct_pact_version_url pact, base_url
         pact_url(base_url, pact) + "/previous-distinct"
       end

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

@@ -16,78 +16,88 @@ module PactBroker
         end
 
         def to_json
+          { _links: links }.to_json
+        end
+
+        def links
           {
-            _links: {
-              'self' =>
-              {
-                href: base_url,
-                title: 'Index',
-                templated: false
-              },
-              'pb:publish-pact' => {
-                href: base_url + '/pacts/provider/{provider}/consumer/{consumer}/version/{consumerApplicationVersion}',
-                title: 'Publish a pact',
-                templated: true
-              },
-              'pb:latest-pact-versions' =>
-              {
-                href: base_url + '/pacts/latest',
-                title: 'Latest pact versions',
-                templated: false
-              },
-              'pb:pacticipants' =>
-              {
-                href: base_url + '/pacticipants',
-                title: 'Pacticipants',
-                templated: false
-              },
-              'pb:latest-provider-pacts' =>
-              {
-                href: base_url + '/pacts/provider/{provider}/latest',
-                title: 'Latest pacts by provider',
-                templated: true
-              },
-              'pb:latest-provider-pacts-with-tag' =>
-              {
-                href: base_url + '/pacts/provider/{provider}/latest/{tag}',
-                title: 'Latest pacts for provider with the specified tag',
-                templated: true
-              },
-              'pb:provider-pacts-with-tag' =>
-              {
-                href: base_url + '/pacts/provider/{provider}/tag/{tag}',
-                title: 'All pact versions for the provider with the specified consumer version tag',
-                templated: true
-              },
-              'pb:provider-pacts' =>
-              {
-                href: base_url + '/pacts/provider/{provider}',
-                title: 'All pact versions for the specified provider',
-                templated: true
-              },
-              'pb:latest-version' => {
-                href: base_url + '/pacticipants/{pacticipant}/latest-version',
-                title: 'Latest pacticipant version',
-                templated: true
-              },
-              'pb:latest-tagged-version' => {
-                href: base_url + '/pacticipants/{pacticipant}/latest-version/{tag}',
-                title: 'Latest pacticipant version with the specified tag',
-                templated: true
-              },
-              'pb:webhooks' => {
-                href: base_url + '/webhooks',
-                title: 'Webhooks',
-                templated: false
-              },
-              'curies' =>
-              [{
-                name: 'pb',
-                href: base_url + '/doc/{rel}',
-                templated: true
-              }]
-            }
-          }.to_json
+            'self' =>
+            {
+              href: base_url,
+              title: 'Index',
+              templated: false
+            },
+            'pb:publish-pact' => {
+              href: base_url + '/pacts/provider/{provider}/consumer/{consumer}/version/{consumerApplicationVersion}',
+              title: 'Publish a pact',
+              templated: true
+            },
+            'pb:latest-pact-versions' =>
+            {
+              href: base_url + '/pacts/latest',
+              title: 'Latest pact versions',
+              templated: false
+            },
+            'pb:pacticipants' =>
+            {
+              href: base_url + '/pacticipants',
+              title: 'Pacticipants',
+              templated: false
+            },
+            'pb:latest-provider-pacts' =>
+            {
+              href: base_url + '/pacts/provider/{provider}/latest',
+              title: 'Latest pacts by provider',
+              templated: true
+            },
+            'pb:latest-provider-pacts-with-tag' =>
+            {
+              href: base_url + '/pacts/provider/{provider}/latest/{tag}',
+              title: 'Latest pacts for provider with the specified tag',
+              templated: true
+            },
+            'pb:provider-pacts-with-tag' =>
+            {
+              href: base_url + '/pacts/provider/{provider}/tag/{tag}',
+              title: 'All pact versions for the provider with the specified consumer version tag',
+              templated: true
+            },
+            'pb:provider-pacts' =>
+            {
+              href: base_url + '/pacts/provider/{provider}',
+              title: 'All pact versions for the specified provider',
+              templated: true
+            },
+            'pb:wip-provider-pacts' =>
+            {
+              href: base_url + '/pacts/provider/{provider}/wip',
+              title: 'WIP pact versions for the specified provider',
+              templated: true
+            },
+            'pb:latest-version' => {
+              href: base_url + '/pacticipants/{pacticipant}/latest-version',
+              title: 'Latest pacticipant version',
+              templated: true
+            },
+            'pb:latest-tagged-version' => {
+              href: base_url + '/pacticipants/{pacticipant}/latest-version/{tag}',
+              title: 'Latest pacticipant version with the specified tag',
+              templated: true
+            },
+            'pb:webhooks' => {
+              href: base_url + '/webhooks',
+              title: 'Webhooks',
+              templated: false
+            },
+            'curies' =>
+            [{
+              name: 'pb',
+              href: base_url + '/doc/{rel}?context=index',
+              templated: true
+            }]
+          }.tap do | it |
+            it.delete('pb:wip-provider-pacts') if ENV['RACK_ENV'] == 'production'
+          end
         end
       end
     end

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

@@ -0,0 +1,21 @@
+require 'pact_broker/api/resources/provider_pacts'
+require 'pact_broker/configuration'
+require 'pact_broker/api/decorators/provider_pacts_decorator'
+
+module PactBroker
+  module Api
+    module Resources
+      class WipProviderPacts < ProviderPacts
+        private
+
+        def pacts
+          pact_service.find_wip_pact_versions_for_provider provider_name
+        end
+
+        def resource_title
+          "WIP pact versions for the provider #{provider_name}"
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/doc/controllers/app.rb

@@ -17,24 +17,28 @@ module PactBroker
         }.freeze
 
         helpers do
-          def view_name_for rel_name
-            MAPPINGS[rel_name] || rel_name
+          def view_name_for rel_name, context = nil
+            view_name = MAPPINGS[rel_name] || rel_name
+            context ? "#{context}/#{view_name}" : view_name
           end
 
-          def resource_exists? rel_name
-            File.exist? File.join(self.class.root, 'views', "#{view_name_for(rel_name)}.markdown")
+          def resource_exists? rel_name, context = nil
+            File.exist? File.join(self.class.root, 'views', "#{view_name_for(rel_name, context)}.markdown")
           end
         end
 
         get ":rel_name" do
           rel_name = params[:rel_name]
-          if resource_exists? rel_name
-            markdown view_name_for(rel_name).to_sym, {:layout_engine => :haml, layout: :'layouts/main'}, {}
+          context = params[:context]
+          view_params = {:layout_engine => :haml, layout: :'layouts/main'}
+          if resource_exists? rel_name, context
+            markdown view_name_for(rel_name, context).to_sym, view_params, {}
+          elsif resource_exists? rel_name
+            markdown view_name_for(rel_name).to_sym, view_params, {}
           else
-            response.status = 404
+            markdown :not_found, view_params, {}
           end
         end
-
       end
     end
   end

data/lib/pact_broker/doc/views/consumer-version.markdown

@@ -0,0 +1,5 @@
+# Consumer version
+
+Allowed method: `GET`, `PUT`, `DELETE`
+
+The pacticipant (application) version of the consumer that this resource belongs to. Deleting this resource will delete all child resources.

data/lib/pact_broker/doc/views/index/latest-provider-pacts-with-tag.markdown

@@ -0,0 +1,5 @@
+# Latest pacts for provider with the specified tag
+
+Allowed methods: `GET`
+
+Given a provider name and a consumer version tag name, this resource returns the latest pact for each consumer that has the specified tag.

data/lib/pact_broker/doc/views/index/latest-provider-pacts.markdown

@@ -0,0 +1,5 @@
+# Latest pacts by provider
+
+Allowed methods: `GET`
+
+Given a provider name, this resource returns the latest pact for each consumer.

data/lib/pact_broker/doc/views/index/latest-tagged-version.markdown

@@ -0,0 +1,5 @@
+# Latest pacticipant version with the specified tag
+
+Allowed methods: `GET`
+
+Given a pacticipant name and a pacticipant version tag name, this resource returns the latest pacticipant version with the specified tag. Note that the "latest" is determined by the creation date of the pacticipant version resource (or the semantic order if `order_versions_by_date` is false), not by the creation date of the tag.

data/lib/pact_broker/doc/views/index/latest-version.markdown

@@ -0,0 +1,7 @@
+# Latest pacticipant version
+
+Allowed methods: `GET`
+
+Given a pacticipant name, this resource returns the latest pacticipant version according to the configured ordering scheme. Ordering will be by creation date of the version resource if `order_versions_by_date` is true, and will be by semantic order if `order_versions_by_date` is false.
+
+Note that this resource represents a pacticipant (application) version, not a pact version.

data/lib/pact_broker/doc/views/index/provider-pacts-with-tag.markdown

@@ -0,0 +1,5 @@
+# Provider pacts
+
+Allowed methods: `GET`
+
+Given a pacticipant name and a consumer version tag, this resource returns all the pact versions for all consumers of this provider with the specified tag. The most common use of this resource is to find all the `production` pact versions for the mobile consumers of an API, so that backwards compatibility can be maintained.

data/lib/pact_broker/doc/views/index/provider-pacts.markdown

@@ -0,0 +1,5 @@
+# Provider pacts
+
+Allowed methods: `GET`
+
+Given a pacticipant name, this resource returns all the pact versions for all consumers.

data/lib/pact_broker/doc/views/not_found.markdown

@@ -0,0 +1 @@
+No documentation exists for this relation yet.

data/lib/pact_broker/doc/views/{diff-previous-distinct.markdown → pact/diff-previous-distinct.markdown}

@@ -1,5 +1,5 @@
 # Diff with previous distinct version
 
-Allowed methods: GET
+Allowed methods: `GET`
 
 This resource displays the difference between the current pact, and the previous "distinct" version. Given that the pact file does not change every time it is published, the previous distinct version is the most recent version published before the current one where the content is actually different.

data/lib/pact_broker/doc/views/pact/diff.markdown

@@ -0,0 +1,5 @@
+# Diff between two pact versions
+
+Allowed methods: `GET`
+
+This resource displays the difference between the current pact version, and the specified pact version. Note that the pact version in the URL is the pact version content sha, not the consumer version number.

data/lib/pact_broker/doc/views/{publish-verification-results.markdown → pact/publish-verification-results.markdown}

@@ -1,9 +1,9 @@
 # Publish pact verification result
 
-Allowed methods: POST
+Allowed methods: `POST`
 
 Use a `POST` request to the `pb:publish-verification-results` link (`$['_links']['pb:publish-verification-results']['href']`) in the pact resource to publish the result (either success or failure) of a pact verification. The body of the request must include the success (true or false) and the provider application version that the pact was verified against. It may also include the build URL to facilitate debugging when failures occur.
- 
+
     {
       "success": true,
       "providerApplicationVersion": "4.5.6",

data/lib/pact_broker/doc/views/pact/tag-prod-version.markdown

@@ -0,0 +1,7 @@
+# Tag Production Version
+
+Allowed methods: `PUT`
+
+Add the "prod" tag to this consumer version. This allows you to retrieve the latest version production version using the following URL.
+
+    http://pact-broker/pacts/provider/{provider}/consumer/{consumer}/latest/prod

data/lib/pact_broker/doc/views/pact/tag-version.markdown

@@ -0,0 +1,5 @@
+# Add Tag to Consumer Version
+
+Allowed methods: `PUT`
+
+Add a tag with the specified name to this consumer version.

data/lib/pact_broker/doc/views/provider.markdown

@@ -2,6 +2,6 @@
 
 Allowed methods: GET, PATCH, DELETE
 
-The application that initiates the HTTP request.
+The application that responds to the HTTP request.
 
 See [Pacticipant](/doc/pacticipants) for more information.

data/lib/pact_broker/pacts/pact_publication.rb

@@ -1,9 +1,9 @@
 require 'pact_broker/domain/pact'
 require 'pact_broker/pacts/pact_version'
+require 'pact_broker/repositories/helpers'
 
 module PactBroker
   module Pacts
-
     class PactPublication < Sequel::Model(:pact_publications)
 
       extend Forwardable
@@ -15,7 +15,9 @@ module PactBroker
       associate(:many_to_one, :consumer_version, :class => "PactBroker::Domain::Version", :key => :consumer_version_id, :primary_key => :id)
       associate(:many_to_one, :pact_version, class: "PactBroker::Pacts::PactVersion", :key => :pact_version_id, :primary_key => :id)
 
-      PactPublication.plugin :timestamps, :update_on_create=>true
+      dataset_module do
+        include PactBroker::Repositories::Helpers
+      end
 
       def before_create
         super
@@ -55,5 +57,7 @@ module PactBroker
         @domain_object ||= to_domain
       end
     end
+
+    PactPublication.plugin :timestamps, update_on_create: true
   end
 end

data/lib/pact_broker/pacts/repository.rb

@@ -10,12 +10,14 @@ require 'pact_broker/pacts/latest_tagged_pact_publications'
 require 'pact/shared/json_differ'
 require 'pact_broker/domain'
 require 'pact_broker/pacts/parse'
+require 'pact_broker/matrix/head_row'
 
 module PactBroker
   module Pacts
     class Repository
 
       include PactBroker::Logging
+      include PactBroker::Repositories
 
       def create params
         PactPublication.new(
@@ -71,6 +73,12 @@ module PactBroker
         end
       end
 
+      def find_wip_pact_versions_for_provider provider_name
+        provider_id = pacticipant_repository.find_by_name(provider_name).id
+        pact_publication_ids = PactBroker::Matrix::HeadRow.where(provider_id: provider_id).exclude(success: true).select_for_subquery(:pact_publication_id)
+        AllPactPublications.where(id: pact_publication_ids).order_ignore_case(:consumer_name).order_append(:consumer_version_order).collect(&:to_domain)
+      end
+
       def find_pact_versions_for_provider provider_name, tag = nil
         if tag
           LatestPactPublicationsByConsumerVersion

data/lib/pact_broker/pacts/service.rb

@@ -72,6 +72,10 @@ module PactBroker
         pact_repository.find_latest_pact_versions_for_provider provider_name, options[:tag]
       end
 
+      def find_wip_pact_versions_for_provider provider_name
+        pact_repository.find_wip_pact_versions_for_provider provider_name
+      end
+
       def find_pact_versions_for_provider provider_name, options = {}
         pact_repository.find_pact_versions_for_provider provider_name, options[:tag]
       end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.23.4'
+  VERSION = '2.24.0'
 end

data/script/prod/migrate-latest-pacts.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+#
+# Usage: migrate-latest-pacts.sh SOURCE_BROKER_BASE_URL DEST_BROKER_BASE_URL
+#
+
+set -e
+
+function cleanup() {
+  rm -rf /tmp/pact
+}
+
+trap cleanup EXIT
+
+source_broker_base_url=${1:?Usage: ${BASH_SOURCE[0]} SOURCE_BROKER_BASE_URL DEST_BROKER_BASE_URL}
+dest_broker_base_url=${2:?Usage: ${BASH_SOURCE[0]} SOURCE_BROKER_BASE_URL DEST_BROKER_BASE_URL}
+
+latest_pacts=$(curl -s ${source_broker_base_url}/pacts/latest)
+latest_pact_urls=$(echo "${latest_pacts}" | jq "[.pacts[]._links.self[1:][].href]" | jq 'join("\n")' --raw-output)
+
+for url in ${latest_pact_urls}
+do
+  source_pact_content=$(curl -s $url)
+  source_pact_url=$(echo ${source_pact_content} | jq "._links.self.href" --raw-output)
+  dest_pact_url=$(echo "${source_pact_url}" | sed "s~${source_broker_base_url}~${dest_broker_base_url}~")
+  dest_pact_content=$(echo "${source_pact_content}" | jq -r '{consumer: .consumer, provider: .provider, interactions: .interactions, metadata: .metadata}')
+  echo "${source_pact_content}" > /tmp/pact
+  echo "Migrating ${source_pact_url} to ${dest_pact_url}"
+  curl -s -XPUT "${dest_pact_url}" -d @/tmp/pact -H "Content-Type: application/json" -H "Accept: application/hal+json" > /dev/null
+done

data/spec/features/get_wip_provider_pacts_spec.rb

@@ -0,0 +1,26 @@
+describe "Get WIP provider pacts" do
+  subject { get path; last_response }
+
+  let(:last_response_body) { JSON.parse(subject.body, symbolize_names: true) }
+  let(:pact_links) { last_response_body[:_links][:'pb:pacts'] }
+
+  context "when the provider exists" do
+    before do
+      TestDataBuilder.new
+        .create_provider("Provider")
+        .create_consumer("Consumer")
+        .create_consumer_version("0.0.1")
+        .create_pact
+    end
+
+    let(:path) { "/pacts/provider/Provider/wip" }
+
+    it "returns a 200 HAL JSON response" do
+      expect(subject).to be_a_hal_json_success_response
+    end
+
+    it "returns a list of links to the pacts" do
+      expect(pact_links.size).to eq 1
+    end
+  end
+end

data/spec/lib/pact_broker/api/decorators/pact_decorator_spec.rb

@@ -2,13 +2,13 @@ require 'spec_helper'
 require 'pact_broker/api/decorators/pact_decorator'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       describe PactDecorator do
 
+        before do
+          allow_any_instance_of(PactDecorator).to receive(:templated_diff_url).and_return('templated-diff-url')
+        end
         let(:content_hash) {
           {
             'consumer' => {'name' => 'Consumer'},
@@ -105,8 +105,13 @@ module PactBroker
             expect(subject[:_links][:'pb:publish-verification-results'][:href]).to match %r{http://example.org/.*/verification-results}
           end
 
+          it "includes a link to diff this pact version with another pact version" do
+            expect(subject[:_links][:'pb:diff'][:href]).to eq 'templated-diff-url'
+            expect(subject[:_links][:'pb:diff'][:templated]).to eq true
+          end
+
           it "includes a curie" do
-            expect(subject[:_links][:curies]).to eq [{ name: "pb", href: "http://example.org/doc/{rel}", templated: true }]
+            expect(subject[:_links][:curies]).to eq [{ name: "pb", href: "http://example.org/doc/{rel}?context=pact", templated: true }]
           end
 
           context "when the json_content is not a Hash" do
@@ -116,7 +121,6 @@ module PactBroker
             end
           end
         end
-
       end
     end
   end

data/spec/lib/pact_broker/api/pact_broker_urls_spec.rb

@@ -4,8 +4,11 @@ module PactBroker
   module Api
     describe PactBrokerUrls do
 
+      # Regex find all the URL parameter names
+      # \/\{[^\}\s\[\(\.]+\}
+
       let(:base_url) { "http://example.org" }
-      let(:pact) { double('pact', consumer: consumer, provider: provider, consumer_version_number: "123") }
+      let(:pact) { double('pact', consumer: consumer, provider: provider, consumer_version_number: "123", pact_version_sha: "5hbfu") }
       let(:consumer) { double('pacticipant', name: "Foo") }
       let(:provider) { double('pacticipant', name: "Bar") }
       let(:verification) do
@@ -33,6 +36,12 @@ module PactBroker
 
         it { is_expected.to eq "http://example.org/pacts/provider/Bar/consumer/Foo/pact-version/1234/verification-results/1/triggered-webhooks" }
       end
+
+      describe "templated_diff_url" do
+        subject { PactBrokerUrls.templated_diff_url(pact, base_url) }
+
+        it { is_expected.to eq "http://example.org/pacts/provider/Bar/consumer/Foo/pact-version/5hbfu/diff/pact-version/{pactVersion}" }
+      end
     end
   end
 end

data/spec/lib/pact_broker/api/resources/wip_provider_pacts_spec.rb

@@ -0,0 +1,34 @@
+require 'pact_broker/api/resources/latest_provider_pacts'
+
+module PactBroker
+  module Api
+    module Resources
+      describe WipProviderPacts do
+        before do
+          allow(PactBroker::Pacts::Service).to receive(:find_wip_pact_versions_for_provider).and_return(pacts)
+          allow(PactBroker::Api::Decorators::ProviderPactsDecorator).to receive(:new).and_return(decorator)
+          allow_any_instance_of(WipProviderPacts).to receive(:resource_exists?).and_return(provider)
+        end
+
+        let(:provider) { double('provider') }
+        let(:pacts) { double('pacts') }
+        let(:path) { '/pacts/provider/Bar/wip' }
+        let(:decorator) { instance_double('PactBroker::Api::Decorators::ProviderPactsDecorator') }
+
+        subject { get path; last_response }
+
+        it "finds the wip pacts for the provider" do
+          expect(PactBroker::Pacts::Service).to receive(:find_wip_pact_versions_for_provider).with("Bar")
+          subject
+        end
+
+        it "sets the correct resource title" do
+          expect(decorator).to receive(:to_json) do | options |
+            expect(options[:user_options][:title]).to eq "WIP pact versions for the provider Bar"
+          end
+          subject
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/doc/controllers/app_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'pact_broker/doc/controllers/app'
 
 module PactBroker
@@ -32,9 +31,9 @@ module PactBroker
           context "when the resource does not exist" do
             subject { get "/blah" }
 
-            it "returns a 404 status" do
+            it "returns a 200 status, because otherwise, the Rack cascade will make it return a 404 from the webmachine API" do
               subject
-              expect(last_response.status).to eq 404
+              expect(last_response.status).to eq 200
             end
 
             it "returns a html content type" do
@@ -42,9 +41,27 @@ module PactBroker
               expect(last_response.headers['Content-Type']).to eq "text/html;charset=utf-8"
             end
 
+            it "returns a custom error page" do
+              subject
+              expect(last_response.body).to include "No documentation exists"
+            end
           end
-        end
 
+          context "when the resource has a context and there is a folder with a matching name" do
+            subject { get "/diff?context=pact" }
+
+            it "returns documentation in a folder of the matching name" do
+              subject
+              expect(last_response.status).to eq 200
+              expect(last_response.body).to include "Diff"
+            end
+
+            it "returns a html content type" do
+              subject
+              expect(last_response.headers['Content-Type']).to eq "text/html;charset=utf-8"
+            end
+          end
+        end
       end
     end
   end

data/spec/lib/pact_broker/doc/coverage_spec.rb

@@ -0,0 +1,33 @@
+require 'pact_broker/doc/controllers/app'
+
+RSpec.describe "the HAL docs for the index" do
+
+  let(:app) do
+    Rack::Builder.new do
+      map "/docs" do
+        run PactBroker::Doc::Controllers::App
+      end
+      map "/" do
+        run PactBroker::API
+      end
+    end
+  end
+
+  let(:index_response) { get "/", {}, { 'HTTP_ACCEPT' => 'application/hal+json' } }
+  let(:index_body) { JSON.parse(index_response.body) }
+
+  it "has a document for each relation" do
+    relations_that_should_have_docs = index_body['_links'].keys - ['self', 'curies']
+    relations_without_docs = {}
+
+    relations_that_should_have_docs.each do | relation |
+      path = "/docs/#{relation.split(":", 2).last}?context=index"
+      get path, {}, { 'HTTP_ACCEPT' => 'text/html' }
+      if last_response.status != 200
+        relations_without_docs[relation] = last_response.status
+      end
+    end
+
+    expect(relations_without_docs).to eq({})
+  end
+end

data/spec/lib/pact_broker/pacts/repository_find_wip_pact_versions_for_provider_spec.rb

@@ -0,0 +1,94 @@
+require 'pact_broker/pacts/repository'
+
+module PactBroker
+  module Pacts
+    describe Repository do
+      let(:td) { TestDataBuilder.new }
+
+      describe "find_wip_pact_versions_for_provider" do
+        subject { Repository.new.find_wip_pact_versions_for_provider("bar") }
+
+        context "when the latest pact for a tag has been successfully verified" do
+          before do
+            td.create_pact_with_hierarchy("foo", "1", "bar")
+              .comment("above not included because it's not the latest prod")
+              .create_consumer_version("2")
+              .create_consumer_version_tag("prod")
+              .create_pact
+              .create_verification(provider_version: "3", comment: "not included because already verified")
+          end
+
+          it "is not included" do
+            expect(subject.size).to be 0
+          end
+        end
+
+        context "when the latest pact without a tag has failed verification" do
+          before do
+            td.create_pact_with_hierarchy("foo", "1", "bar")
+              .create_verification(provider_version: "3", success: false)
+          end
+
+          it "is included" do
+            expect(subject.size).to be 1
+          end
+        end
+
+        context "when the latest pact without a tag has not been verified" do
+          before do
+            td.create_pact_with_hierarchy("foo", "1", "bar")
+              .create_consumer_version("2")
+              .create_pact
+          end
+
+          it "is included" do
+            expect(subject.first.consumer_version_number).to eq "2"
+            expect(subject.size).to be 1
+          end
+        end
+
+        context "when the latest pact for a tag has failed verification" do
+          before do
+            td.create_pact_with_hierarchy("foo", "1", "bar")
+              .create_consumer_version_tag("prod")
+              .create_verification(provider_version: "3", success: true)
+              .create_consumer_version("2", tag_names: ["prod"])
+              .create_pact
+              .create_verification(provider_version: "5", success: false)
+          end
+
+          it "is included" do
+            expect(subject.first.consumer_version_number).to eq "2"
+            expect(subject.size).to be 1
+          end
+        end
+
+        context "when the latest pact for a tag has not been verified" do
+          before do
+            td.create_pact_with_hierarchy("foo", "1", "bar")
+              .create_consumer_version_tag("prod")
+              .create_verification(provider_version: "5")
+              .create_consumer_version("2", tag_names: ["prod"])
+              .create_pact
+          end
+
+          it "is included" do
+            expect(subject.first.consumer_version_number).to eq "2"
+            expect(subject.size).to be 1
+          end
+        end
+
+        context "when the provider name does not match the given provider name" do
+          before do
+            td.create_pact_with_hierarchy("foo", "1", "baz")
+              .create_provider("bar")
+          end
+
+          it "is not included" do
+            expect(subject.size).to be 0
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/pacts/repository_spec.rb

@@ -1,7 +1,6 @@
 # Yes, I know this file is too bug, but cmd+shift+t is too useful!
 
 require 'pact_broker/pacts/repository'
-require 'spec/support/test_data_builder'
 require 'pact_broker/pacts/pact_params'
 require 'pact_broker/versions/repository'
 require 'pact_broker/pacticipants/repository'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.23.4
+  version: 2.24.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-04 00:00:00.000000000 Z
+date: 2018-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -762,6 +762,7 @@ files:
 - lib/pact_broker/api/resources/webhook_execution.rb
 - lib/pact_broker/api/resources/webhook_resource_methods.rb
 - lib/pact_broker/api/resources/webhooks.rb
+- lib/pact_broker/api/resources/wip_provider_pacts.rb
 - lib/pact_broker/app.rb
 - lib/pact_broker/badges/service.rb
 - lib/pact_broker/build_http_options.rb
@@ -785,21 +786,30 @@ files:
 - lib/pact_broker/diagnostic/resources/dependencies.rb
 - lib/pact_broker/diagnostic/resources/heartbeat.rb
 - lib/pact_broker/doc/controllers/app.rb
+- lib/pact_broker/doc/views/consumer-version.markdown
 - lib/pact_broker/doc/views/consumer.markdown
-- lib/pact_broker/doc/views/diff-previous-distinct.markdown
-- lib/pact_broker/doc/views/latest-pact-version.markdown
-- lib/pact_broker/doc/views/latest-pact-versions.markdown
-- lib/pact_broker/doc/views/latest-verifications.markdown
+- lib/pact_broker/doc/views/index/latest-pact-versions.markdown
+- lib/pact_broker/doc/views/index/latest-provider-pacts-with-tag.markdown
+- lib/pact_broker/doc/views/index/latest-provider-pacts.markdown
+- lib/pact_broker/doc/views/index/latest-tagged-version.markdown
+- lib/pact_broker/doc/views/index/latest-version.markdown
+- lib/pact_broker/doc/views/index/pacticipants.markdown
+- lib/pact_broker/doc/views/index/provider-pacts-with-tag.markdown
+- lib/pact_broker/doc/views/index/provider-pacts.markdown
+- lib/pact_broker/doc/views/index/publish-pact.markdown
+- lib/pact_broker/doc/views/index/self.markdown
 - lib/pact_broker/doc/views/layouts/main.haml
+- lib/pact_broker/doc/views/not_found.markdown
 - lib/pact_broker/doc/views/pact-versions.markdown
-- lib/pact_broker/doc/views/pact-webhooks.markdown
-- lib/pact_broker/doc/views/pacticipants.markdown
+- lib/pact_broker/doc/views/pact/diff-previous-distinct.markdown
+- lib/pact_broker/doc/views/pact/diff.markdown
+- lib/pact_broker/doc/views/pact/latest-pact-version.markdown
+- lib/pact_broker/doc/views/pact/pact-webhooks.markdown
+- lib/pact_broker/doc/views/pact/publish-verification-results.markdown
+- lib/pact_broker/doc/views/pact/tag-prod-version.markdown
+- lib/pact_broker/doc/views/pact/tag-version.markdown
 - lib/pact_broker/doc/views/provider.markdown
-- lib/pact_broker/doc/views/publish-pact.markdown
-- lib/pact_broker/doc/views/publish-verification-results.markdown
-- lib/pact_broker/doc/views/self.markdown
-- lib/pact_broker/doc/views/tag-prod-version.markdown
-- lib/pact_broker/doc/views/tag-version.markdown
+- lib/pact_broker/doc/views/version/latest-verification-results-where-pacticipant-is-consumer.markdown
 - lib/pact_broker/doc/views/webhooks.markdown
 - lib/pact_broker/domain.rb
 - lib/pact_broker/domain/group.rb
@@ -969,6 +979,7 @@ files:
 - script/foo-bar.json
 - script/generate-certificates-for-webooks-certificate-spec.rb
 - script/insert-self-signed-certificate-from-url.rb
+- script/prod/migrate-latest-pacts.sh
 - script/publish-2.sh
 - script/publish-new.sh
 - script/publish-not-a-pact.sh
@@ -1016,6 +1027,7 @@ files:
 - spec/features/get_verifications_for_consumer_version_spec.rb
 - spec/features/get_version_spec.rb
 - spec/features/get_versions_spec.rb
+- spec/features/get_wip_provider_pacts_spec.rb
 - spec/features/label_pacticipant_spec.rb
 - spec/features/merge_pact_spec.rb
 - spec/features/publish_not_a_pact_spec.rb
@@ -1107,6 +1119,7 @@ files:
 - spec/lib/pact_broker/api/resources/webhook_execution_spec.rb
 - spec/lib/pact_broker/api/resources/webhook_spec.rb
 - spec/lib/pact_broker/api/resources/webhooks_spec.rb
+- spec/lib/pact_broker/api/resources/wip_provider_pacts_spec.rb
 - spec/lib/pact_broker/app_spec.rb
 - spec/lib/pact_broker/badges/service_spec.rb
 - spec/lib/pact_broker/build_http_options_spec.rb
@@ -1121,6 +1134,7 @@ files:
 - spec/lib/pact_broker/diagnostic/resources/dependencies_spec.rb
 - spec/lib/pact_broker/diagnostic/resources/heartbeat_spec.rb
 - spec/lib/pact_broker/doc/controllers/app_spec.rb
+- spec/lib/pact_broker/doc/coverage_spec.rb
 - spec/lib/pact_broker/domain/group_spec.rb
 - spec/lib/pact_broker/domain/index_item_spec.rb
 - spec/lib/pact_broker/domain/order_versions_spec.rb
@@ -1153,6 +1167,7 @@ files:
 - spec/lib/pact_broker/pacts/pact_params_spec.rb
 - spec/lib/pact_broker/pacts/pact_publication_spec.rb
 - spec/lib/pact_broker/pacts/pact_version_spec.rb
+- spec/lib/pact_broker/pacts/repository_find_wip_pact_versions_for_provider_spec.rb
 - spec/lib/pact_broker/pacts/repository_spec.rb
 - spec/lib/pact_broker/pacts/service_spec.rb
 - spec/lib/pact_broker/pacts/sort_content_spec.rb
@@ -1319,6 +1334,7 @@ test_files:
 - spec/features/get_verifications_for_consumer_version_spec.rb
 - spec/features/get_version_spec.rb
 - spec/features/get_versions_spec.rb
+- spec/features/get_wip_provider_pacts_spec.rb
 - spec/features/label_pacticipant_spec.rb
 - spec/features/merge_pact_spec.rb
 - spec/features/publish_not_a_pact_spec.rb
@@ -1410,6 +1426,7 @@ test_files:
 - spec/lib/pact_broker/api/resources/webhook_execution_spec.rb
 - spec/lib/pact_broker/api/resources/webhook_spec.rb
 - spec/lib/pact_broker/api/resources/webhooks_spec.rb
+- spec/lib/pact_broker/api/resources/wip_provider_pacts_spec.rb
 - spec/lib/pact_broker/app_spec.rb
 - spec/lib/pact_broker/badges/service_spec.rb
 - spec/lib/pact_broker/build_http_options_spec.rb
@@ -1424,6 +1441,7 @@ test_files:
 - spec/lib/pact_broker/diagnostic/resources/dependencies_spec.rb
 - spec/lib/pact_broker/diagnostic/resources/heartbeat_spec.rb
 - spec/lib/pact_broker/doc/controllers/app_spec.rb
+- spec/lib/pact_broker/doc/coverage_spec.rb
 - spec/lib/pact_broker/domain/group_spec.rb
 - spec/lib/pact_broker/domain/index_item_spec.rb
 - spec/lib/pact_broker/domain/order_versions_spec.rb
@@ -1456,6 +1474,7 @@ test_files:
 - spec/lib/pact_broker/pacts/pact_params_spec.rb
 - spec/lib/pact_broker/pacts/pact_publication_spec.rb
 - spec/lib/pact_broker/pacts/pact_version_spec.rb
+- spec/lib/pact_broker/pacts/repository_find_wip_pact_versions_for_provider_spec.rb
 - spec/lib/pact_broker/pacts/repository_spec.rb
 - spec/lib/pact_broker/pacts/service_spec.rb
 - spec/lib/pact_broker/pacts/sort_content_spec.rb

data/lib/pact_broker/doc/views/tag-prod-version.markdown

@@ -1,7 +0,0 @@
-# Tag Production Version
-
-Allowed methods: PUT
-
-Add the "prod" tag to this version. This allows you to retrieve the latest version production version using the following URL.
-
-    http://pact-broker/pacts/provider/{provider}/consumer/{consumer}/latest/prod

data/lib/pact_broker/doc/views/tag-version.markdown

@@ -1,4 +0,0 @@
-# Add Tag to Version
-
-Allowed methods: PUT
-