pact_broker-client 1.13.1 → 1.14.0

data/spec/integration/create_version_tag_spec.rb

@@ -5,7 +5,7 @@ describe "pact-broker create-version-tag" do
   end
 
   context "when the version is successfully tagged" do
-    subject { `bundle exec bin/pact-broker create-version-tag -v --pacticipant Condor --version 1.3.0 --tag prod --broker-base-url http://localhost:5001` }
+    subject { `bundle exec bin/pact-broker create-version-tag --pacticipant Condor --version 1.3.0 --tag prod --broker-base-url http://localhost:5001` }
 
     it "returns a success exit code" do
       subject

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

@@ -3,6 +3,8 @@ module PactBroker
   module Client
     describe BaseClient do
       describe '#initialize' do
+        subject { BaseClient.new(base_url: base_url) }
+
         let(:base_url) { 'http://pact_broker_base_url'}
         let(:username) { 'pact_repo_username'}
         let(:password) { 'pact_repo_password'}
@@ -45,6 +47,32 @@ module PactBroker
             subject
           end
         end
+
+        describe "url_for_relation" do
+          let(:index_body) do
+            {
+              _links: {
+                :'pb:foo-bar' => {
+                  href: "http://foo-bar/{name}"
+                }
+              }
+            }.to_json
+          end
+
+          let!(:request) do
+            stub_request(:get, "http://pact_broker_base_url/").to_return(status: 200, body: index_body, headers: { "Content-Type" => "application/json" }  )
+          end
+
+          it "retrieves a relation URL from the index" do
+            expect(subject.url_for_relation('pb:foo-bar', name: 'wiffle')).to eq 'http://foo-bar/wiffle'
+          end
+
+          context "when the relation is not found" do
+            it "raises an error" do
+              expect { subject.url_for_relation('pb:not-found', name: 'wiffle') }.to raise_error PactBroker::Client::RelationNotFound, /Could not find relation pb:not-found in index resource/
+            end
+          end
+        end
       end
     end
   end

data/spec/lib/pact_broker/client/versions/describe_spec.rb

@@ -0,0 +1,65 @@
+require 'pact_broker/client/versions/describe'
+
+module PactBroker
+  module Client
+    class Versions
+      describe Describe do
+        describe ".call" do
+
+          let(:versions_client) do
+            instance_double('PactBroker::Client::Versions', latest: version_hash)
+          end
+
+          let(:pact_broker_base_url) { 'http://broker' }
+          let(:pact_broker_client_options) { {} }
+          let(:pact_broker_client) { instance_double('PactBroker::Client::PactBrokerClient')}
+          let(:version_hash) do
+            {
+              foo: 'bar'
+            }
+          end
+
+          let(:params) do
+            {
+              pacticipant: 'foo',
+              latest: true,
+              tag: 'bar'
+            }
+          end
+
+          let(:options) do
+            {
+              output: 'someformat'
+            }
+          end
+
+          before do
+            allow(PactBroker::Client::PactBrokerClient).to receive(:new).and_return(pact_broker_client)
+            allow(pact_broker_client).to receive_message_chain(:pacticipants, :versions).and_return(versions_client)
+            allow(Formatter).to receive(:call).and_return('formatted_output')
+          end
+
+          subject { Describe.call(params, options, pact_broker_base_url, pact_broker_client_options) }
+
+          it "invokes the versions client" do
+            expect(versions_client).to receive(:latest).with(params)
+            subject
+          end
+
+          it "formats the output" do
+            expect(Formatter).to receive(:call).with(version_hash, 'someformat')
+            subject
+          end
+
+          it "returns a successful result" do
+            expect(subject.success).to be true
+          end
+
+          it "returns a result with the formatted output as the message" do
+            expect(subject.message).to eq 'formatted_output'
+          end
+        end
+      end
+    end
+  end
+end

data/spec/pacts/pact_broker_client-pact_broker.json

@@ -1090,6 +1090,124 @@
           }
         }
       }
+    },
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pb:latest-version relation exists in the index resource",
+      "request": {
+        "method": "get",
+        "path": "/",
+        "headers": {
+          "Accept": "application/json, application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+        },
+        "body": {
+          "_links": {
+            "pb:latest-version": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-VERSION-{pacticipant}"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:latest-version.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*{pacticipant}"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to retrieve the latest version of Condor",
+      "providerState": "'Condor' exists in the pact-broker with the latest version 1.2.3",
+      "request": {
+        "method": "get",
+        "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-VERSION-Condor",
+        "headers": {
+          "Accept": "application/json, application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+        },
+        "body": {
+          "number": "1.2.3",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request for the index resource",
+      "providerState": "the pb:latest-tagged-version relation exists in the index resource",
+      "request": {
+        "method": "get",
+        "path": "/",
+        "headers": {
+          "Accept": "application/json, application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+        },
+        "body": {
+          "_links": {
+            "pb:latest-tagged-version": {
+              "href": "http://localhost:1234/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-TAGGED-VERSION-{pacticipant}-{tag}"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.pb:latest-tagged-version.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*{pacticipant}.*{tag}"
+          }
+        }
+      }
+    },
+    {
+      "description": "a request to retrieve the latest 'production' version of Condor",
+      "providerState": "'Condor' exists in the pact-broker with the latest tagged 'production' version 1.2.3",
+      "request": {
+        "method": "get",
+        "path": "/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-TAGGED-VERSION-Condor-production",
+        "headers": {
+          "Accept": "application/json, application/hal+json"
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+        },
+        "body": {
+          "number": "1.2.3",
+          "_links": {
+            "self": {
+              "href": "http://localhost:1234/some-url"
+            }
+          }
+        },
+        "matchingRules": {
+          "$.body._links.self.href": {
+            "match": "regex",
+            "regex": "http:\\/\\/.*"
+          }
+        }
+      }
     }
   ],
   "metadata": {

data/spec/service_providers/pact_broker_client_versions_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+require 'pact_broker/client'
+require_relative 'pact_helper'
+
+describe PactBroker::Client::Versions, pact: true do
+
+  include_context "pact broker"
+
+  let(:get_headers) { { "Accept" => "application/json, application/hal+json" } }
+
+  describe "retrieving the latest pacticipant version" do
+    let(:latest_version_path) { "/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-VERSION-{pacticipant}" }
+    let(:latest_version_url) { pact_broker.mock_service_base_url + latest_version_path }
+
+    before do
+      pact_broker
+        .given("the pb:latest-version relation exists in the index resource")
+        .upon_receiving("a request for the index resource")
+        .with(
+            method: :get,
+            path: '/',
+            headers: get_headers).
+          will_respond_with(
+            status: 200,
+            headers: pact_broker_response_headers,
+            body: {
+              _links: {
+                :'pb:latest-version' => {
+                  href: Pact.term(latest_version_url, /http:\/\/.*{pacticipant}/)
+                }
+              }
+            }
+          )
+
+      pact_broker
+        .given("'Condor' exists in the pact-broker with the latest version 1.2.3")
+        .upon_receiving("a request to retrieve the latest version of Condor")
+        .with(
+            method: :get,
+            path: '/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-VERSION-Condor',
+            headers: get_headers).
+          will_respond_with(
+            status: 200,
+            headers: pact_broker_response_headers,
+            body: {
+              number: '1.2.3',
+              _links: {
+                self: {
+                  href: Pact.term('http://localhost:1234/some-url', %r{http://.*})
+                }
+              }
+            }
+          )
+    end
+
+    it "returns the version hash" do
+      version_hash = pact_broker_client.pacticipants.versions.latest(pacticipant: 'Condor')
+      expect(version_hash[:number]).to eq '1.2.3'
+      expect(version_hash[:_links][:self][:href]).to eq 'http://localhost:1234/some-url'
+    end
+  end
+
+  describe "retrieving the latest pacticipant version for a tag" do
+    let(:latest_tagged_version_path) { "/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-TAGGED-VERSION-{pacticipant}-{tag}" }
+    let(:latest_tagged_version_url) { pact_broker.mock_service_base_url + latest_tagged_version_path }
+
+    before do
+      pact_broker
+        .given("the pb:latest-tagged-version relation exists in the index resource")
+        .upon_receiving("a request for the index resource")
+        .with(
+            method: :get,
+            path: '/',
+            headers: get_headers).
+          will_respond_with(
+            status: 200,
+            headers: pact_broker_response_headers,
+            body: {
+              _links: {
+                :'pb:latest-tagged-version' => {
+                  href: Pact.term(latest_tagged_version_url, /http:\/\/.*{pacticipant}.*{tag}/)
+                }
+              }
+            }
+          )
+
+      pact_broker
+        .given("'Condor' exists in the pact-broker with the latest tagged 'production' version 1.2.3")
+        .upon_receiving("a request to retrieve the latest 'production' version of Condor")
+        .with(
+            method: :get,
+            path: '/HAL-REL-PLACEHOLDER-INDEX-PB-LATEST-TAGGED-VERSION-Condor-production',
+            headers: get_headers).
+          will_respond_with(
+            status: 200,
+            headers: pact_broker_response_headers,
+            body: {
+              number: '1.2.3',
+              _links: {
+                self: {
+                  href: Pact.term('http://localhost:1234/some-url', %r{http://.*})
+                }
+              }
+            }
+          )
+    end
+
+    it "returns the version hash" do
+      version_hash = pact_broker_client.pacticipants.versions.latest(pacticipant: 'Condor', tag: 'production')
+      expect(version_hash[:number]).to eq '1.2.3'
+      expect(version_hash[:_links][:self][:href]).to eq 'http://localhost:1234/some-url'
+    end
+  end
+end

data/spec/service_providers/pact_helper.rb

@@ -4,6 +4,7 @@ require 'pact/consumer/rspec'
 
 Pact.configure do | config |
   config.logger.level = Logger::DEBUG
+  config.doc_generator = :markdown
 end
 
 Pact.service_consumer 'Pact Broker Client' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker-client
 version: !ruby/object:Gem::Version
-  version: 1.13.1
+  version: 1.14.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-19 00:00:00.000000000 Z
+date: 2018-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -172,6 +172,14 @@ files:
 - ci.sh
 - doc/markdown/Pact Broker Client - Pact Broker.md
 - doc/markdown/README.md
+- doc/pacts/markdown/Pact Broker Client - Pact Broker.md
+- doc/pacts/markdown/README.md
+- example/scripts/README.md
+- example/scripts/deploy-consumer.sh
+- example/scripts/pact.json
+- example/scripts/publish-pact.sh
+- example/scripts/publish-verification.sh
+- example/scripts/verification.json
 - lib/pact_broker/client.rb
 - lib/pact_broker/client/base_client.rb
 - lib/pact_broker/client/can_i_deploy.rb
@@ -198,6 +206,10 @@ files:
 - lib/pact_broker/client/tasks/publication_task.rb
 - lib/pact_broker/client/version.rb
 - lib/pact_broker/client/versions.rb
+- lib/pact_broker/client/versions/describe.rb
+- lib/pact_broker/client/versions/formatter.rb
+- lib/pact_broker/client/versions/json_formatter.rb
+- lib/pact_broker/client/versions/text_formatter.rb
 - lib/pact_broker_client.rb
 - pact-broker-client.gemspec
 - script/generate-cli-usage.sh
@@ -218,6 +230,7 @@ files:
 - spec/lib/pact_broker/client/pacticipants_spec.rb
 - spec/lib/pact_broker/client/publish_pacts_spec.rb
 - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
+- spec/lib/pact_broker/client/versions/describe_spec.rb
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
 - spec/service_providers/extra_goodies_spec.rb
@@ -228,6 +241,7 @@ files:
 - spec/service_providers/pact_broker_client_retrieve_all_pacts_for_provider_spec.rb
 - spec/service_providers/pact_broker_client_retrive_pact_spec.rb
 - spec/service_providers/pact_broker_client_tags_spec.rb
+- spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
 - spec/spec_helper.rb
 - spec/support/cli_test_pacts/bar.json
@@ -261,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: See description
@@ -281,6 +295,7 @@ test_files:
 - spec/lib/pact_broker/client/pacticipants_spec.rb
 - spec/lib/pact_broker/client/publish_pacts_spec.rb
 - spec/lib/pact_broker/client/tasks/publication_task_spec.rb
+- spec/lib/pact_broker/client/versions/describe_spec.rb
 - spec/lib/pact_broker/client/versions_spec.rb
 - spec/pacts/pact_broker_client-pact_broker.json
 - spec/service_providers/extra_goodies_spec.rb
@@ -291,6 +306,7 @@ test_files:
 - spec/service_providers/pact_broker_client_retrieve_all_pacts_for_provider_spec.rb
 - spec/service_providers/pact_broker_client_retrive_pact_spec.rb
 - spec/service_providers/pact_broker_client_tags_spec.rb
+- spec/service_providers/pact_broker_client_versions_spec.rb
 - spec/service_providers/pact_helper.rb
 - spec/spec_helper.rb
 - spec/support/cli_test_pacts/bar.json