pact_broker 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17b10186ffac951ca6a1d81ca4c4941b378d8e72
-  data.tar.gz: 8cfabd6ed5d782788096d445ae46e098679d0fcd
+  metadata.gz: e750616e35159ab4915a82899463fb4726c3f1a0
+  data.tar.gz: 194233d951cfa4bc3b4039efbaac97f19ecf88f7
 SHA512:
-  metadata.gz: 758286a2af8b8d56f12763e6b2a4c5f156186ed95a2f37ed4e30b24a8c2d79903fcdd54444317a3cef9fd67811cd5d8c9fed66e950aa9d5244e87b0949d0025b
-  data.tar.gz: c6db590d2225a0738a0b0dd9c8c1582ef1f887905990b383951537a9df23fdc5f1158c75de76242978d4c01689b66bce1f723f5c2f28438561cc5c5a24dbc3fb
+  metadata.gz: fe4b4e81c2224d8ef238c3ddc8f5539b435dcadf5c87add833e9992d4e5ca79ad8463aff7a337601826be1fccd148cc709a6ca9b43c922a618ddf259b0b35eeb
+  data.tar.gz: 3a3b9df99e3e07546c2088297e6baf3b15d6928d0190642de12ed86bcd627b56412c40f486793954600f1c1aa368cd178fbea307f85d9f04e1db65be669b016e

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 Do this to generate your change history
 
-    $ git log --pretty=format:'  * %h - %s (%an, %ad)'
+    $ git log --pretty=format:'  * %h - %s (%an, %ad)' vX.Y.Z..HEAD
+
+#### 1.6.0 (2015-03-20)
+
+* e20e657 - Added support for JSON contracts that are not in the Pact format (e.g. top level is an array) (Beth Skurrie, Fri Mar 20 19:12:46 2015 +1100)
 
 #### 1.5.0 (2015-02-20)
 

data/README.md

@@ -94,7 +94,7 @@ Use the HAL browser to view documentation as you browse.
 * Copy the [example](/example) directory to the location you want to install the application.
 * Modify the config.ru and Gemfile as desired (eg. choose database driver gem, set your database credentials. Use the "pg" gem if using Postgres.)
 * Please ensure you use `encoding: 'utf8'` in your Sequel options to avoid encoding issues.
-* For production usage, use a web application server like [Phusion Passenger](https://www.phusionpassenger.com) or [Nginx][http://nginx.org/] to serve the Pact Broker application.
+* For production usage, use a web application server like [Phusion Passenger](https://www.phusionpassenger.com) or [Nginx](http://nginx.org/) to serve the Pact Broker application.
 * Deploy to your location of choice.
 
 [decouple]: http://techblog.realestate.com.au/enter-the-pact-matrix-or-how-to-decouple-the-release-cycles-of-your-microservices/

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

@@ -13,7 +13,12 @@ module PactBroker
         include Timestamps
 
         def to_hash(options = {})
-          ::JSON.parse(represented.json_content, PACT_PARSING_OPTIONS).merge super
+          parsed_content = represented.content_hash
+          if parsed_content.is_a?(::Hash)
+            parsed_content.merge super
+          else
+            parsed_content
+          end
         end
 
         link :self do | options |

data/lib/pact_broker/api/renderers/html_pact_renderer.rb

@@ -9,6 +9,8 @@ module PactBroker
     module Renderers
       class HtmlPactRenderer
 
+        class NotAPactError < StandardError; end
+
         def self.call pact
           new(pact).call
         end
@@ -69,6 +71,11 @@ module PactBroker
 
         def markdown
           Pact::Doc::Markdown::ConsumerContractRenderer.call consumer_contract
+        rescue NotAPactError
+          heading = "### A contract between #{@pact.consumer.name} and #{@pact.provider.name}"
+          warning = "_Note: this contract could not be parsed to a Pact, showing raw content instead._"
+          pretty_json = JSON.pretty_generate(@pact.content_hash)
+          "#{heading}\n#{warning}\n```json\n#{pretty_json}\n```\n"
         end
 
         def html
@@ -77,6 +84,8 @@ module PactBroker
 
         def consumer_contract
           Pact::ConsumerContract.from_json(@json_content)
+        rescue
+          raise NotAPactError
         end
 
       end

data/lib/pact_broker/pacts/pact_params.rb

@@ -12,18 +12,21 @@ module PactBroker
 
       def self.from_request request, path_info
         json_content = request.body.to_s
-        pact_hash = begin
+        parsed_content = begin
           JSON.parse(json_content, PACT_PARSING_OPTIONS)
         rescue
           {}
         end
 
+        consumer_name_in_pact = parsed_content.is_a?(Hash) ? parsed_content.fetch('consumer',{})['name'] : nil
+        provider_name_in_pact = parsed_content.is_a?(Hash) ? parsed_content.fetch('provider',{})['name'] : nil
+
         new(
           consumer_name: path_info.fetch(:consumer_name),
           provider_name: path_info.fetch(:provider_name),
           consumer_version_number: path_info.fetch(:consumer_version_number),
-          consumer_name_in_pact: pact_hash.fetch('consumer',{})['name'],
-          provider_name_in_pact: pact_hash.fetch('provider',{})['name'],
+          consumer_name_in_pact: consumer_name_in_pact,
+          provider_name_in_pact: provider_name_in_pact,
           json_content: json_content
         )
       end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

data/script/publish-2.sh

@@ -1,3 +1,3 @@
 curl -v -XPUT \-H "Content-Type: application/json" \
 -d@spec/fixtures/a_consumer-a_provider-2.json \
-http://localhost:9292/pacts/provider/A%20Provider/consumer/A%20Consumer/version/1.0.1
+http://localhost:9292/pacts/provider/A%20Provider/consumer/A%20Consumer/version/1.0.1

data/script/publish-not-a-pact.sh

@@ -0,0 +1,3 @@
+curl -v -XPUT \-H "Content-Type: application/json" \
+-d '[1]' \
+http://localhost:9292/pacts/provider/A%20Not%20Pact%20Provider/consumer/A%20Not%20Pact%20Consumer/version/1.0.0

data/script/publish.sh

@@ -1,3 +1,3 @@
 curl -v -XPUT \-H "Content-Type: application/json" \
 -d@spec/fixtures/a_consumer-a_provider.json \
-http://localhost:9292/pacts/provider/A%20Provider/consumer/A%20Consumer/version/1.0.0
+http://localhost:9292/pacts/provider/A%20Provider/consumer/A%20Consumer/version/1.0.0

data/spec/features/publish_not_a_pact_spec.rb

@@ -0,0 +1,37 @@
+describe "Publishing a contract that is not a pact" do
+
+  let(:path) { "/pacts/provider/A%20Provider/consumer/A%20Consumer/version/1.2.3" }
+  let(:parsed_response_body) { JSON.parse(subject.body) }
+
+  subject { put path, pact_content, {'CONTENT_TYPE' => 'application/json' }; last_response  }
+
+  context "when the pact is another type of CDC that doesn't have the Consumer or Provider names in the expected places" do
+    let(:pact_content) { {a: 'not pact'}.to_json }
+
+    it "accepts the un-pact Pact" do
+      expect(subject.status).to be 201
+    end
+
+    it "returns the content" do
+      expect(parsed_response_body).to include 'a' => 'not pact'
+    end
+
+    it "returns _links" do
+      expect(parsed_response_body).to have_key '_links'
+    end
+  end
+
+  context "when the content is an array" do
+
+    let(:pact_content) { '[1]' }
+
+    it "accepts the un-pact Pact" do
+      expect(subject.status).to be 201
+    end
+
+    it "returns the content" do
+      expect(parsed_response_body).to eq [1]
+    end
+
+  end
+end

data/spec/features/publish_pact_spec.rb

@@ -46,13 +46,4 @@ describe "Publishing a pact" do
       expect(subject).to be_a_json_error_response "does not match"
     end
   end
-
-  context "when the pact is another type of CDC that doesn't have the Consumer or Provider names in the expected places" do
-    let(:pact_content) { {}.to_json }
-
-    it "accepts the un-pact Pact" do
-      expect(subject.status).to be 201
-    end
-  end
-
 end

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

@@ -9,20 +9,20 @@ module PactBroker
 
       describe PactDecorator do
 
-        let(:json_content) {
+        let(:content_hash) {
           {
             'consumer' => {'name' => 'Consumer'},
             'provider' => {'name' => 'Provider'},
             'interactions' => [],
             'metadata' => {}
-          }.to_json
+          }
         }
 
         let(:base_url) { 'http://example.org' }
         let(:created_at) { Time.new(2014, 3, 4) }
         let(:updated_at) { Time.new(2014, 3, 5) }
         let(:pact) { double('pact',
-          json_content: json_content,
+          content_hash: content_hash,
           created_at: created_at,
           updated_at: updated_at,
           consumer: consumer,
@@ -93,6 +93,13 @@ module PactBroker
           it "includes a curie" do
             expect(subject[:_links][:curies]).to eq [{ name: "pb", href: "http://example.org/doc/{rel}", templated: true }]
           end
+
+          context "when the json_content is not a Hash" do
+            let(:content_hash) { [1] }
+            it "returns the plain JSON without any links" do
+              expect(subject).to eq content_hash
+            end
+          end
         end
 
       end

data/spec/lib/pact_broker/api/renderers/html_pact_renderer_spec.rb

@@ -16,9 +16,10 @@ module PactBroker
         end
 
         let(:consumer) { double('consumer', name: 'Consumer')}
+        let(:provider) { double('provider', name: 'Provider')}
         let(:created_at) { DateTime.new(2014, 02, 27) }
         let(:json_content) { load_fixture('renderer_pact.json') }
-        let(:pact) { double('pact', json_content: json_content, updated_at: created_at, consumer_version_number: '1.2.3', consumer: consumer)}
+        let(:pact) { double('pact', json_content: json_content, updated_at: created_at, consumer_version_number: '1.2.3', consumer: consumer, provider: provider)}
         let(:pact_url) { '/pact/url' }
 
         before do
@@ -40,6 +41,26 @@ module PactBroker
             expect(subject).to include("Date published:")
             expect(subject).to include("Thu 27 Feb 2014, 11:00am +11:00")
           end
+
+          context "when the content is not a valid pact, but is still JSON" do
+            before do
+              allow(pact).to receive(:content_hash).and_return(content_hash)
+            end
+            let(:json_content) { '[1]' }
+            let(:content_hash) { [1] }
+
+            it "includes a dismissive title" do
+              expect(subject).to include "A contract between Consumer and Provider"
+            end
+
+            it "includes a warning" do
+              expect(subject).to include "Note:"
+            end
+
+            it "renders the JSON in HTML" do
+              expect(subject).to match /\[\s+1\s+\]/m
+            end
+          end
         end
 
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -552,6 +552,7 @@ files:
 - public/stylesheets/pact.css
 - public/stylesheets/relationships.css
 - script/publish-2.sh
+- script/publish-not-a-pact.sh
 - script/publish.sh
 - script/update-hal-browser
 - spec/features/create_webhook_spec.rb
@@ -559,6 +560,7 @@ files:
 - spec/features/get_diff.rb
 - spec/features/get_previous_distinct_version.rb
 - spec/features/get_version.rb
+- spec/features/publish_not_a_pact_spec.rb
 - spec/features/publish_pact_spec.rb
 - spec/features/update_pacticipant_spec.rb
 - spec/fixtures/a_consumer-a_provider-2.json
@@ -709,6 +711,7 @@ test_files:
 - spec/features/get_diff.rb
 - spec/features/get_previous_distinct_version.rb
 - spec/features/get_version.rb
+- spec/features/publish_not_a_pact_spec.rb
 - spec/features/publish_pact_spec.rb
 - spec/features/update_pacticipant_spec.rb
 - spec/fixtures/a_consumer-a_provider-2.json