pact_broker-client 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '038d9dad336dd4380cecfed72c8149a0db8b6083'
-  data.tar.gz: 534b53f01fe7d391edadc74e01513a2cb0914c9d
+  metadata.gz: 254d1374fb868966c77ccff58753e8d53d96f577
+  data.tar.gz: fe50c5757ad5e4e10efda0aa144e63e167fec078
 SHA512:
-  metadata.gz: 7c6a3cd12937059590d1d8e775ff33bbde1d232b9870394e1bd123472c9e27d5ec840463abe9c047deff7d72b152cba9be489ca2fe8eebcc643a137f7e27a96b
-  data.tar.gz: fdc7eaf43f5d2008e8bfa0a04301fef007bf07fa11fde3a9076ab65ab46b6a392a9948055ff1368de20a5384e2642fbac20f2037019fa67088e3ab957aca8812
+  metadata.gz: 9104dcc0ffcd52808781158d8ec862314063b18fbd5338ac535e8baba140030e833af899b1af00056f3822933790f9631214a01be04bfa0d48228b366b344856
+  data.tar.gz: c251c838c5379b259120af768652493d05184d812157b6b3d44963116016707709c2216138c21b74109038291f0c3d102ecc200f83c856e1ec995bf924f9a540

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+<a name="v1.19.0"></a>
+### v1.19.0 (2019-06-25)
+
+
+#### Features
+
+* **hal client**
+  * update from pact-ruby	 ([f8b3432](/../../commit/f8b3432))
+
+* update pact with broker for scenario where version does not exist	 ([27b744f](/../../commit/27b744f))
+
+
+#### Bug Fixes
+
+* **create webhook**
+  * pass in token from command line	 ([9d3170e](/../../commit/9d3170e))
+
+* correct pact merge error message	 ([5ebe808](/../../commit/5ebe808))
+
+
 <a name="v1.18.0"></a>
 ### v1.18.0 (2019-03-05)
 

data/README.md

@@ -1,6 +1,6 @@
 # Pact Broker Client
 
-A client for the Pact Broker. Publishes pacts to, and retrieves pacts from, the pact broker. The functionality is available via a CLI, or via Ruby Rake tasks.
+A client for the Pact Broker. Publishes pacts to, and retrieves pacts from, a Pact Broker. The functionality is available via a CLI, or via Ruby Rake tasks. You can also use the [Pact CLI Docker image][docker].
 
 [![Build Status](https://travis-ci.org/pact-foundation/pact_broker-client.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker-client)
 
@@ -231,3 +231,4 @@ bundle exec rake pact:publish
 
 [wiki-tags]: https://github.com/pact-foundation/pact_broker/wiki/Using-tags
 [pact-ruby-standalone]: https://github.com/pact-foundation/pact-ruby-standalone/releases
+[docker]: https://cloud.docker.com/u/pactfoundation/repository/docker/pactfoundation/pact-cli

data/doc/pacts/markdown/Pact Broker Client - Pact Broker.md

@@ -417,14 +417,14 @@ Given **the pact for Foo version 1.2.3 has been verified by Bar version 4.5.6**,
 Pact Broker will respond with:
 ```json
 {
-  "status": 400,
+  "status": 200,
   "headers": {
     "Content-Type": "application/hal+json;charset=utf-8"
   },
   "body": {
-    "errors": [
-      "an error message"
-    ]
+    "summary": {
+      "reason": "an error message"
+    }
   }
 }
 ```

data/lib/pact_broker/client/git.rb

@@ -1,5 +1,13 @@
 require 'pact_broker/client/error'
 
+ # BUILDKITE_BRANCH BUILDKITE_COMMIT https://buildkite.com/docs/pipelines/environment-variables
+ # CIRCLE_BRANCH CIRCLE_SHA1 https://circleci.com/docs/2.0/env-vars/
+ # TRAVIS_COMMIT TRAVIS_BRANCH - TRAVIS_PULL_REQUEST_BRANCH TRAVIS_PULL_REQUEST_SHA https://docs.travis-ci.com/user/environment-variables/
+ # GIT_COMMIT GIT_BRANCH https://wiki.jenkins.io/display/JENKINS/Building+a+software+project
+ # GIT_COMMIT GIT_LOCAL_BRANCH https://hudson.eclipse.org/webtools/env-vars.html/
+ # APPVEYOR_REPO_COMMIT APPVEYOR_REPO_BRANCH       https://www.appveyor.com/docs/environment-variables/
+ # bamboo.repository.git.branch https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html
+
 module PactBroker
   module Client
     module Git

data/lib/pact_broker/client/hal/authorization_header_redactor.rb

@@ -0,0 +1,34 @@
+require 'delegate'
+
+module PactBroker
+  module Client
+    module Hal
+      class AuthorizationHeaderRedactor < SimpleDelegator
+        def puts(*args)
+          __getobj__().puts(*redact_args(args))
+        end
+
+        def print(*args)
+          __getobj__().puts(*redact_args(args))
+        end
+
+        def <<(*args)
+          __getobj__().send(:<<, *redact_args(args))
+        end
+
+        private
+
+        attr_reader :redactions
+
+        def redact_args(args)
+          args.collect{ | s| redact(s) }
+        end
+
+        def redact(string)
+          return string unless string.is_a?(String)
+          string.gsub(/Authorization: .*\\r\\n/, "Authorization: [redacted]\\r\\n")
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/client/hal/http_client.rb

@@ -1,15 +1,18 @@
 require 'pact_broker/client/retry'
+require 'pact_broker/client/hal/authorization_header_redactor'
+require 'net/http'
 
 module PactBroker
   module Client
     module Hal
       class HttpClient
-        attr_accessor :username, :password, :verbose
+        attr_accessor :username, :password, :verbose, :token
 
         def initialize options
           @username = options[:username]
           @password = options[:password]
           @verbose = options[:verbose]
+          @token = options[:token]
         end
 
         def get href, params = {}, headers = {}
@@ -39,13 +42,14 @@ module PactBroker
 
           request.body = body if body
           request.basic_auth username, password if username
+          request['Authorization'] = "Bearer #{token}" if token
           request
         end
 
         def perform_request request, uri
-          response = Retry.while_error do
+          response = Retry.until_truthy_or_max_times do
             http = Net::HTTP.new(uri.host, uri.port, :ENV)
-            http.set_debug_output($stderr) if verbose
+            http.set_debug_output(output_stream) if verbose
             http.use_ssl = (uri.scheme == 'https')
             http.start do |http|
               http.request request
@@ -54,6 +58,10 @@ module PactBroker
           Response.new(response)
         end
 
+        def output_stream
+          AuthorizationHeaderRedactor.new($stdout)
+        end
+
         class Response < SimpleDelegator
           def body
             bod = raw_body
@@ -77,7 +85,6 @@ module PactBroker
           end
         end
       end
-
     end
   end
 end

data/lib/pact_broker/client/merge_pacts.rb

@@ -42,10 +42,9 @@ module PactBroker
       private
 
       def almost_duplicate_message(original, new_interaction)
-        "An interaction with same description (#{new_interaction[:description].inspect}) and provider state (#{new_interaction[:providerState].inspect}) but a different request or response has already been used. " +
-          "Please use a different description or provider state, or hard-code any random data.\n" +
-          original.to_json + "\n\n"
-          new_interaction.to_json
+        "Two interactions have been found with same description (#{new_interaction[:description].inspect}) and provider state (#{new_interaction[:providerState].inspect}) but a different request or response. " +
+          "Please use a different description or provider state, or hard-code any random data.\n\n" +
+          original.to_json + "\n\n" + new_interaction.to_json
       end
 
       def same_description_and_state? original, additional

data/lib/pact_broker/client/version.rb

@@ -1,5 +1,5 @@
 module PactBroker
   module Client
-    VERSION = '1.18.0'
+    VERSION = '1.19.0'
   end
 end

data/lib/pact_broker/client/webhooks/create.rb

@@ -20,9 +20,7 @@ module PactBroker
         def initialize(params, pact_broker_base_url, pact_broker_client_options)
           @params = OpenStruct.new(params)
           @pact_broker_base_url = pact_broker_base_url
-          @basic_auth_options = pact_broker_client_options[:basic_auth] || {}
-          @verbose = pact_broker_client_options[:verbose]
-          @http_client = PactBroker::Client::Hal::HttpClient.new(basic_auth_options.merge(verbose: verbose))
+          @http_client = PactBroker::Client::Hal::HttpClient.new(pact_broker_client_options.merge(pact_broker_client_options[:basic_auth] || {}))
         end
 
         def call

data/script/publish-pact.sh

@@ -1 +1 @@
-bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json --consumer-app-version 1.2.3 --broker-base-url http://localhost:9292 --tag-with-git-branch
+bundle exec bin/pact-broker publish spec/pacts/pact_broker_client-pact_broker.json --consumer-app-version 1.2.3 --broker-base-url http://localhost:9292 --tag-with-git-branch --broker-username localhost --broker-password localhost

data/spec/lib/pact_broker/client/hal/authorization_header_redactor_spec.rb

@@ -0,0 +1,17 @@
+require 'pact_broker/client/hal/authorization_header_redactor'
+
+module PactBroker
+  module Client
+    module Hal
+      describe AuthorizationHeaderRedactor do
+        let(:stream) { StringIO.new }
+        let(:stream_redactor) { AuthorizationHeaderRedactor.new(stream) }
+
+        it "redacts the authorizaton header" do
+          stream_redactor << "\\r\\nAuthorization: Bearer TOKEN\\r\\n"
+          expect(stream.string).to eq "\\r\\nAuthorization: [redacted]\\r\\n"
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact_broker/client/hal/http_client_spec.rb

@@ -4,7 +4,7 @@ module PactBroker::Client
   module Hal
     describe HttpClient do
       before do
-        allow(Retry).to receive(:while_error) { |&block| block.call }
+        allow(Retry).to receive(:until_truthy_or_max_times) { |&block| block.call }
       end
 
       subject { HttpClient.new(username: 'foo', password: 'bar') }
@@ -43,7 +43,7 @@ module PactBroker::Client
 
 
         it "retries on failure" do
-          expect(Retry).to receive(:while_error)
+          expect(Retry).to receive(:until_truthy_or_max_times)
           do_get
         end
 
@@ -74,8 +74,8 @@ module PactBroker::Client
           expect(request).to have_been_made
         end
 
-        it "calls Retry.while_error" do
-          expect(Retry).to receive(:while_error)
+        it "calls Retry.until_truthy_or_max_times" do
+          expect(Retry).to receive(:until_truthy_or_max_times)
           do_post
         end
 

data/spec/lib/pact_broker/client/merge_pacts_spec.rb

@@ -60,7 +60,7 @@ module PactBroker
           end
 
           it "raises an error" do
-            expect { subject }.to raise_error PactMergeError
+            expect { subject }.to raise_error PactMergeError, /foo.*different/
           end
         end
       end

data/spec/lib/pact_broker/client/webhooks/create_spec.rb

@@ -15,7 +15,7 @@ module PactBroker
             }.to_json
           end
           let!(:index_request) do
-            stub_request(:get, "http://broker").to_return(status: 200, body: index_body, headers: { "Content-Type" => "application/hal+json" }  )
+            stub_request(:get, "http://broker").with(headers: { "Authorization" => /.*/}).to_return(status: 200, body: index_body, headers: { "Content-Type" => "application/hal+json" }  )
           end
 
           let!(:webhook_request) do
@@ -34,10 +34,16 @@ module PactBroker
             }.tap { |it| Pact::Fixture.add_fixture(:create_webhook_params, it) }
           end
 
-          subject { Create.call(params, "http://broker", {}) }
+          let(:pact_broker_client_options) do
+            {
+              token: 'token',
+              verbose: 'verbose'
+            }
+          end
 
-          context "when a 405 is returned from the webhook creation request" do
+          subject { Create.call(params, "http://broker", pact_broker_client_options) }
 
+          context "when a 405 is returned from the webhook creation request" do
             it "raises an error with a message to upgrade the Pact Broker" do
               expect { subject }.to raise_error PactBroker::Client::Error, /This version of the Pact Broker/
             end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -345,20 +345,17 @@
         "query": "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=9.9.9&latestby=cvpv"
       },
       "response": {
-        "status": 400,
+        "status": 200,
         "headers": {
           "Content-Type": "application/hal+json;charset=utf-8"
         },
         "body": {
-          "errors": [
-            "an error message"
-          ]
+          "summary": {
+            "reason": "an error message"
+          }
         },
         "matchingRules": {
-          "$.body.errors": {
-            "min": 1
-          },
-          "$.body.errors[*].*": {
+          "$.body.summary.reason": {
             "match": "type"
           }
         }

data/spec/service_providers/pact_broker_client_matrix_spec.rb

@@ -95,20 +95,20 @@ module PactBroker::Client
               query: "q[][pacticipant]=Foo&q[][version]=1.2.3&q[][pacticipant]=Bar&q[][version]=9.9.9&latestby=cvpv"
             ).
             will_respond_with(
-              status: 400,
+              status: 200,
               headers: pact_broker_response_headers,
               body: {
-                errors: Pact.each_like("an error message")
+                summary: {
+                  reason: Pact.like("an error message")
+                }
               }
             )
         end
 
         let(:selectors) { [{ pacticipant: "Foo", version: "1.2.3" }, { pacticipant: "Bar", version: "9.9.9" }] }
 
-        it 'raises an error' do
-          expect {
-            pact_broker_client.matrix.get(selectors)
-          }.to raise_error PactBroker::Client::Error, "an error message"
+        it 'does not raise an error' do
+          pact_broker_client.matrix.get(selectors)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2019-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -207,6 +207,7 @@ files:
 - lib/pact_broker/client/error.rb
 - lib/pact_broker/client/git.rb
 - lib/pact_broker/client/hal.rb
+- lib/pact_broker/client/hal/authorization_header_redactor.rb
 - lib/pact_broker/client/hal/entity.rb
 - lib/pact_broker/client/hal/entry_point.rb
 - lib/pact_broker/client/hal/http_client.rb
@@ -247,6 +248,7 @@ files:
 - spec/lib/pact_broker/client/cli/broker_publish_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
+- spec/lib/pact_broker/client/hal/authorization_header_redactor_spec.rb
 - spec/lib/pact_broker/client/hal/entity_spec.rb
 - spec/lib/pact_broker/client/hal/http_client_spec.rb
 - spec/lib/pact_broker/client/hal/link_spec.rb
@@ -320,6 +322,7 @@ test_files:
 - spec/lib/pact_broker/client/cli/broker_publish_spec.rb
 - spec/lib/pact_broker/client/cli/custom_thor_spec.rb
 - spec/lib/pact_broker/client/cli/version_selector_options_parser_spec.rb
+- spec/lib/pact_broker/client/hal/authorization_header_redactor_spec.rb
 - spec/lib/pact_broker/client/hal/entity_spec.rb
 - spec/lib/pact_broker/client/hal/http_client_spec.rb
 - spec/lib/pact_broker/client/hal/link_spec.rb