pact_broker 2.26.1 → 2.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3741742cfc8f29b64fd8bde01c62c9bdf445b9c
-  data.tar.gz: 204bd0c2317882a9ce4c50d0cfab2cb9829278ea
+  metadata.gz: 05fcf55e9f52ba3eab88ff971faffb939b8bf3a3
+  data.tar.gz: 15dd2c9ae6976e5f0ed924947072625fab619dfe
 SHA512:
-  metadata.gz: 591321838ff5732fb86fd4383ce4a603cd6f7f35c6337a1554343675c2d33d03bb80481eab609eec311d6e4a79f78961aa027cdf51100d7cb6f3b8a8949e255a
-  data.tar.gz: aa3ebf059c8d4d0bfb04ffb13c8da4380596c8bbe532daecea1efdcaecff28a1da2546de0567493ce8e06a2799e6899400a90c86214bb493ce89851ca74ff3ae
+  metadata.gz: 74e9bf66eebb3355c4809b5423469242ccfb31d780eb29c3c0d28d6d6b140726826a4fa8ac204672631a5cd856356708580e6e7d205468b4a3e8f76e4c1c1e2d
+  data.tar.gz: 7e52f4d4457fa1a9c013a3d58340d5ccbc01b4075c0fd7ca7d787b66593e0a71736992e773bec72e4767e6cdddb5bb893087380e61896b1e75537e516dfd7e26

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+<a name="v2.27.0"></a>
+### v2.27.0 (2018-09-07)
+
+
+#### Features
+
+* add ${pactbroker.consumerLabels} and ${pactbroker.providerLabels} to webhook templates	 ([afebbc5a](/../../commit/afebbc5a))
+
+
 <a name="v2.26.1"></a>
 ### v2.26.1 (2018-09-07)
 

data/README.md

@@ -136,11 +136,10 @@ You can use the [Pact Broker Docker image][docker] or [Terraform on AWS][terrafo
 #### Rolling your own
 
 * Are you sure you don't just want to use the [Pact Broker Docker image][docker]? No Docker at your company yet? Ah well, keep reading.
-* Create a PostgreSQL (recommended) or MySQL (not recommended, see following note) database.
-    * __Note:__ It is recommended to use __PostgreSQL__ as it will support JSON search features that are planned in the future, however MySQL the other [semi supported](https://github.com/pact-foundation/pact_broker/issues/33) database.
- * Check the [travis.yml][travisyml] file to make sure you're using the version of the database that we're currently running our tests against.
+* Create a PostgreSQL (recommended) or MySQL (not _as_ recommended because of @bethesque's personal prejudices, but still fully supported) database.
+ * To ensure you're on a supported version of the database that you choose, check the [travis.yml][travisyml] file to see which versions we're currently running our tests against.
 * If you're using PostgreSQL (did we mention this was _recommended!_) you'll find the database creation script in the [example/config.ru](https://github.com/pact-foundation/pact_broker/blob/master/example/config.ru).
-* Install ruby 2.2.0 or later (ruby 2.4 is recommended) and bundler >= 1.12.0 (if you've come this far, I'm assuming you know how to do both of these. Did I mention there was a [Docker][docker] image?)
+* Install ruby 2.4 or later and the latest version of bundler (if you've come this far, I'm assuming you know how to do both of these. Did I mention there was a [Docker][docker] image?)
 * Copy the [pact\_broker](https://github.com/DiUS/pact_broker-docker/tree/master/pact_broker) directory from the Pact Broker Docker project. This will have the recommended settings for database connections, logging, basic auth etc. Note that the Docker image uses Phusion Passenger as the web application server in front of the Pact Broker Ruby application, which is the recommended set up.
 * Modify the config.ru and Gemfile as desired (eg. choose database driver gem, set your database credentials. Use the "pg" gem if using Postgres and the "mysql2" gem if using MySQL)
     * example Sequel configuration for postgres `{adapter: "postgres", database: "pact_broker", username: 'pact_broker', password: 'pact_broker', :encoding => 'utf8'}`

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

@@ -33,6 +33,14 @@ module PactBroker
           }
         end
 
+        link :'pb:label' do | options |
+          {
+            title: "Get, create or delete a label for #{represented.name}",
+            href: templated_label_url_for_pacticipant(represented.name, options[:base_url]),
+            templated: true
+          }
+        end
+
         # TODO deprecate in v3
         # URL isn't implemented
         # link 'latest-version' do | options |

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -140,6 +140,10 @@ module PactBroker
         pacticipant_url_from_params({pacticipant_name: pacticipant_name}, base_url) + "/versions/{version}/tags/{tag}"
       end
 
+      def templated_label_url_for_pacticipant pacticipant_name, base_url = ""
+        pacticipant_url_from_params({pacticipant_name: pacticipant_name}, base_url) + "/labels/{label}"
+      end
+
       def label_url label, base_url
         "#{labels_url(label.pacticipant, base_url)}/#{label.name}"
       end

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

@@ -84,15 +84,17 @@ To specify an XML body, you will need to use a correctly escaped string (or use
 
 The following variables may be used in the request path, parameters or body, and will be replaced with their appropriate values at runtime.
 
-`${pactbroker.consumerName}`: the consumer name
-`${pactbroker.providerName}`: the provider name
-`${pactbroker.consumerVersionNumber}`: the version number of the most recent consumer version associated with the pact content.
-`${pactbroker.providerVersionNumber}`: the provider version number for the verification result
-`${pactbroker.consumerVersionTags}`: the list of tag names for the most recent consumer version associated with the pact content, separated by ", ".
-`${pactbroker.providerVersionTags}`: the list of tag names for the provider version associated with the verification result, separated by ", ".
-`${pactbroker.githubVerificationStatus}`: the verification status using the correct keywords for posting to the the [Github commit status API](https://developer.github.com/v3/repos/statuses).
-`${pactbroker.pactUrl}`: the "permalink" URL to the newly published pact (the URL specifying the consumer version URL, rather than the "/latest" format.)
-`${pactbroker.verificationResultUrl}`: the URL to the relevant verification result.
+* `${pactbroker.consumerName}`: the consumer name
+* `${pactbroker.providerName}`: the provider name
+* `${pactbroker.consumerVersionNumber}`: the version number of the most recent consumer version associated with the pact content.
+* `${pactbroker.providerVersionNumber}`: the provider version number for the verification result
+* `${pactbroker.consumerVersionTags}`: the list of tag names for the most recent consumer version associated with the pact content, separated by ", ".
+* `${pactbroker.providerVersionTags}`: the list of tag names for the provider version associated with the verification result, separated by ", ".
+* `${pactbroker.consumerLabels}`: the list of labels for the consumer associated with the pact content, separated by ", ".
+* `${pactbroker.providerLabels}`: the list of labels for the provider associated with the pact content, separated by ", ".
+* `${pactbroker.githubVerificationStatus}`: the verification status using the correct keywords for posting to the the [Github commit status API](https://developer.github.com/v3/repos/statuses).
+* `${pactbroker.pactUrl}`: the "permalink" URL to the newly published pact (the URL specifying the consumer version URL, rather than the "/latest" format.)
+* `${pactbroker.verificationResultUrl}`: the URL to the relevant verification result.
 
 Example usage:
 

data/lib/pact_broker/pacts/placeholder_pact.rb

@@ -4,8 +4,8 @@ module PactBroker
   module Pacts
     class PlaceholderPact < PactBroker::Domain::Pact
       def initialize
-        consumer = OpenStruct.new(name: "placeholder-consumer")
-        @provider = OpenStruct.new(name: "placeholder-provider")
+        consumer = OpenStruct.new(name: "placeholder-consumer", labels: [OpenStruct.new(name: "placeholder-consumer-label")])
+        @provider = OpenStruct.new(name: "placeholder-provider", labels: [OpenStruct.new(name: "placeholder-provider-label")])
         @consumer_version = OpenStruct.new(number: "gggghhhhjjjjkkkkllll66667777888899990000", pacticipant: consumer, tags: [OpenStruct.new(name: "master")])
         @consumer_version_number = @consumer_version.number
         @created_at = DateTime.now

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.26.1'
+  VERSION = '2.27.0'
 end

data/lib/pact_broker/webhooks/render.rb

@@ -16,7 +16,9 @@ module PactBroker
           '${pactbroker.consumerVersionTags}' => consumer_version_tags(pact),
           '${pactbroker.consumerName}' => pact ? pact.consumer_name : "",
           '${pactbroker.providerName}' => pact ? pact.provider_name : "",
-          '${pactbroker.githubVerificationStatus}' => github_verification_status(verification)
+          '${pactbroker.githubVerificationStatus}' => github_verification_status(verification),
+          '${pactbroker.consumerLabels}' => pacticipant_labels(pact && pact.consumer),
+          '${pactbroker.providerLabels}' => pacticipant_labels(pact && pact.provider)
         }
 
         if escaper
@@ -61,6 +63,10 @@ module PactBroker
           ""
         end
       end
+
+      def self.pacticipant_labels pacticipant
+        pacticipant && pacticipant.labels ? pacticipant.labels.collect(&:name).join(", ") : ""
+      end
     end
   end
 end

data/spec/lib/pact_broker/webhooks/render_spec.rb

@@ -21,6 +21,8 @@ module PactBroker
             consumer_version_number: "1.2.3+foo",
             consumer_name: "Foo",
             provider_name: "Bar",
+            consumer: consumer,
+            provider: provider,
             latest_verification: nil)
         end
 
@@ -32,6 +34,8 @@ module PactBroker
             consumer_version_number: "1.2.3+foo",
             consumer_name: "Foo",
             provider_name: "Bar",
+            consumer: consumer,
+            provider: provider,
             latest_verification: verification)
         end
 
@@ -41,9 +45,19 @@ module PactBroker
             consumer_version_number: "1.2.3+foo",
             consumer_name: "Foo",
             provider_name: "Bar",
+            consumer: consumer,
+            provider: provider,
             latest_verification: failed_verification)
         end
 
+        let (:provider) do
+          double("provider", labels: provider_labels)
+        end
+
+        let (:consumer) do
+          double("consumer", labels: consumer_labels)
+        end
+
         let(:verification) do
           double("verification", provider_version_number: "3", success: true, provider_version: provider_version)
         end
@@ -68,6 +82,14 @@ module PactBroker
           [ double("tag", name: "test") ]
         end
 
+        let(:provider_labels) do
+          [ double("label", name: "finance"), double("label", name: "IT") ]
+        end
+
+        let(:consumer_labels) do
+          [ double("label", name: "foo"), double("label", name: "bar") ]
+        end
+
         let(:nil_pact) { nil }
         let(:nil_verification) { nil }
 
@@ -91,6 +113,8 @@ module PactBroker
           ["${pactbroker.verificationResultUrl}", "http://verification", :pact_with_successful_verification, :verification],
           ["${pactbroker.providerVersionTags}", "test, prod", :pact_with_successful_verification, :verification],
           ["${pactbroker.consumerVersionTags}", "test", :pact_with_successful_verification, :verification],
+          ["${pactbroker.consumerLabels}", "foo, bar", :pact_with_successful_verification, :verification],
+          ["${pactbroker.providerLabels}", "finance, IT", :pact, :nil_verification],
         ]
 
         TEST_CASES.each do | (template, expected_output, pact_var_name, verification_var_name) |

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.26.1
+  version: 2.27.0
 platform: ruby
 authors:
 - Bethany Skurrie