pact_broker 1.3.2.rc1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73c13ba9bbfe6c1ec7ad64a93f145bd164894f13
-  data.tar.gz: 1938f955d3f2d67b4b0929040dfc6fbfb3645c47
+  metadata.gz: 90724c609e603dd08b1bc686cbc8c46eeff7c030
+  data.tar.gz: b0b359476aea99b3738b802e8433441544d2add8
 SHA512:
-  metadata.gz: 9c539c2e7434b3572172aeef0b22de80ab5bddd506e48e6819d77d6579bc6f2935b8b53d5c63862e9ef7cff63ee56dd6337267033baa5dafbb5b76731e8e055f
-  data.tar.gz: fefad6d9bec291eaba9e99a3e52bb2632d25e900e6bf275d0b4dbd0ded33ec9388daf0e3054739c47c39e41d6d69c532c6542506df1678672867e5ddb683bed7
+  metadata.gz: e027014136c6782da4f3ba31b0d3779b0bb2d55fff9f91ad8378d1644a3facf94630e129140f81c1ea61e628e616e0da4cd14d55c56c290e464bb53989835418
+  data.tar.gz: dbd9391992584cc6fddde02a8de3b15a5799b8a267db22947b3b48b50aa25a1e88d117c9b22a35d84a01a7260b4163843f3bdf010c696b223a747aaa47fe9eda

data/CHANGELOG.md

@@ -2,6 +2,27 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+#### 1.4.0 (2015-01-20)
+
+* d740fb0 - Removed pact-versions rel from pact resource. Pact versions resource is not implemented yet. (Beth, Tue Jan 20 09:20:52 2015 +1100)
+* bd6e63e - Handle case where there is no previous distinct version when displaying diff (Beth, Tue Jan 20 09:17:21 2015 +1100)
+* d032ce1 - Changed pact icon on Pacts page to look more like a pact. (Beth, Wed Dec 24 09:58:35 2014 +1100)
+* dbf67aa - Added endpoint for previous distinct pact version. (Beth, Mon Dec 22 14:08:07 2014 +1100)
+* bde72f9 - Added migration to change pacts table to UTF8 (Beth, Mon Dec 22 11:45:09 2014 +1100)
+* 8f587b7 - Modified pact HAL rels. (Beth, Mon Dec 22 11:41:10 2014 +1100)
+* b813c0d - Renamed Relationships to Pacts. It was confusing. (Beth, Mon Dec 22 10:25:27 2014 +1100)
+* 00d81aa - Changed diff resource to text/plain, added dates (Beth, Sun Dec 14 17:05:18 2014 +1100)
+* 8f05772 - Set timezone to utc for test db connection (Beth, Sun Dec 14 17:04:16 2014 +1100)
+* 407fa74 - Added link from HAL browser to home (Beth, Sat Dec 13 19:54:53 2014 +1100)
+* a62faa9 - Adding missing docs (Beth, Sat Dec 13 19:51:36 2014 +1100)
+* ec04e77 - Added HAL link to diff with previous distinct version (Beth, Fri Dec 12 08:31:12 2014 +1100)
+* fe5f1d6 - Added endpoint to see the diff between a pact and the previous distinct version. (Beth, Thu Dec 11 17:35:22 2014 +1100)
+* f802641 - Added version endpoint. (Beth, Wed Dec 10 13:06:13 2014 +1100)
+* 715f49d - Force documentation window in HAL browser to be longer. This used to display correctly, but has somehow become quite short. Don't know what changed. (Beth, Tue Dec 9 18:47:53 2014 +1100)
+* 25e612b - Removed curie from self links (Beth, Wed Dec 3 21:14:23 2014 +1100)
+* 5cc922e - Added script to publish test pact. (Beth, Wed Dec 3 20:26:31 2014 +1100)
+* f468b2c - Changed Padrino to log to stdout. :null creates a StringIO, don't want to hog memory. (Beth, Wed Dec 3 20:25:05 2014 +1100)
+
 #### 1.3.2.rc1 (2014-12-03)
 
 * a2413f4 - Stop Padrino trying to create a log file in the gem directory https://github.com/bethesque/pact_broker/issues/13 (Beth, Wed Dec 3 13:16:06 2014 +1100)

data/README.md

@@ -1,44 +1,103 @@
 # Pact Broker
 
-The Pact Broker provides a repository for pacts created using the pact gem. It solves the problem of how to share pacts between consumer and provider projects.
+The Pact Broker provides a repository for consumer driven contracts created using the pact gem. 
+
+It: 
+
+* solves the problem of how to share pacts between consumer and provider projects
+* allows you to [decouple your service release cycles][decouple]
+* provides API documentation that is guaranteed to be up-to date
+* shows you real examples of how your services interact
+* allows you to visualise the relationships between your services
+
+Features:
+
+* A RESTful API for publishing and retrieving pacts.
+* An embedded HAL browser for navigating the API.
+* Autogenerated documentation for each pact.
+* Dynamically generated network diagrams.
+* Enables a pact version to be tagged (ie. "prod") so a provider can verify itself against a fixed version of a pact to ensure backwards compatibility.
+* Webhooks to trigger a provider build when a consumer publishes a change to a pact.
 
 Travis CI Status: [![Build Status](https://travis-ci.org/bethesque/pact_broker.svg?branch=master)](https://travis-ci.org/bethesque/pact_broker)
 
-The Pact Broker:
+### How would I use the Pact Broker?
+
+#### Step 1. Consumer CI build
+1. The consumer project runs its tests using the [Pact][pact] library to provide a mock service.
+2. While the tests run, the mock service writes the requests and the expected responses to a JSON "pact" file - this is the consumer contract.
+3. The generated pact is then published to the Pact Broker. This is simply a PUT to a resource that specifies the consumer name and version, and the provider name. eg `http://my-pact-broker/pacts/provider/Animal%20Service/consumer/Zoo%20App/version/1.0.0`
+
+#### Step 2. Provider CI build
+1. The provider has a verification task that is configured with the URL to retrieve the dynamically calculated latest pact between itself and the consumer. eg `http://my-pact-broker/pacts/provider/Animal%20Service/consumer/Zoo%20App/latest`. The "latest" version is determined by the Pact Broker by inspecting the consumer version number specified when each pact was published.
+2. The provider build runs the pact verification task, which retrieves the pact from the Pact Broker, replays each request against the provider, and checks that the responses match the expected responses.
+3. If the pact verification fails, the build fails. The [Pact Broker CI Nerf Gun][nerf] magically determines who caused the verification to fail, and shoots them.
 
-* Enables pacts to be shared between consumer and provider projects.
-* Displays autogenerated documentation for each pact.
-* Enables a pact to be tagged (ie. "prod") so a provider can verify itself against a fixed version of a pact to ensure backwards compatibility.
-* Provides webhooks to trigger a provider build when a consumer publishes a change to a pact.
-* Displays dynamically generated network diagrams.
+If you don't have a [Pact Broker CI Nerf Gun][nerf], you'll probably want to read about using pact when the consumer and provider are being written by [different teams][different-teams].
+
+## Documentation
 
 See the [Pact Broker Client](https://github.com/bethesque/pact_broker-client) for documentation on how to publish a pact to the Pact Broker, and configure the URLs in the provider project.
 
+See the [wiki](https://github.com/bethesque/pact_broker/wiki) for documentation related to the Pact Broker itself.
+
 ### Screenshots
 
 #### Index
+
+* * *
 <img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/index.png"/>
 
 #### Autogenerated documentation
+
+Paste the pact URL into a browser to view a HTML version of the pact.
+* * *
 <img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/autogenerated_documentation.png"/>
 
+
 #### Network diagram
+
+* * *
 <img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/network_diagram.png"/>
 
-## Documentation
+#### HAL browser
 
-See the [wiki](https://github.com/bethesque/pact_broker/wiki) for documentation.
+Use the embedded HAL browser to nagivate the API.
+* * *
+<img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/hal_browser.png"/>
+
+#### HAL documentation
+
+Use the HAL browser to view documentation as you browse.
+* * *
+<img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/hal_documentation.png"/>
 
 ## Usage
 
-* Create a database using a product that is supported by the Sequel gem (listed on this page http://sequel.jeremyevans.net/rdoc/files/README_rdoc.html). At time of writing, Sequel has adapters for:  ADO, Amalgalite, CUBRID, DataObjects, DB2, DBI, Firebird, IBM_DB, Informix, JDBC, MySQL, Mysql2, ODBC, OpenBase, Oracle, PostgreSQL, SQLAnywhere, SQLite3, Swift, and TinyTDS.
-* __Note:__ It is recommended to use __PostgreSQL__ as it will support JSON search features that are planned in a future release.
+### To have a play around on your local machine
+
 * Install ruby 1.9.3 or later
-* Copy the [example](/example) directory to your workstation.
-* Modify the config.ru and Gemfile as desired (eg. choose database driver gem, set your database credentials)
-* Please ensure you use `encoding: 'utf8'` in your Sequel options to avoid encoding issues.
+* Run `git clone git@github.com:bethesque/pact_broker.git && cd pact_broker/example`
 * Run `bundle`
-* Run `bundle exec rackup`
-* Open [http://localhost:9292](http://localhost:9292) and you should see the HAL browser.
+* Run `bundle exec rackup -p 8080`
+* Open [http://localhost:8080](http://localhost:8080) and you should see a list containing the pact between the Zoo App and the Animal Service.
+* Click on the arrow to see the generated HTML documentation.
+* Click on either service to see an autogenerated network diagram.
+* Click on the HAL Browser link to have a poke around the API.
+* Click on the book icon under "docs" to view documentation related to a given relation.
+
+### For reals
+
+* Create a database using a product that is supported by the Sequel gem (listed on this page http://sequel.jeremyevans.net/rdoc/files/README_rdoc.html). The migrations have been tested on MySQL and PostgreSQL - your milage will vary on other databases.
+* __Note:__ It is recommended to use __PostgreSQL__ as it will support JSON search features that are planned in a future release, however MySQL the other well supported database.
+* Install ruby 1.9.3 or later
+* 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.
+* Deploy to your location of choice.
 
-For production usage, use a web application server like [Phusion Passenger](https://www.phusionpassenger.com) to serve the Pact Broker application.
+[decouple]: http://techblog.realestate.com.au/enter-the-pact-matrix-or-how-to-decouple-the-release-cycles-of-your-microservices/
+[pact]: https://github.com/realestate-com-au/pact
+[nerf]: https://github.com/bethesque/pact_broker/wiki/pact-broker-ci-nerf-gun
+[different-teams]: https://github.com/realestate-com-au/pact/wiki/Using-pact-where-the-consumer-team-is-different-from-the-provider-team

data/db/migrations/16_add_pact_content_foreign_key_to_pacts.rb

@@ -3,6 +3,12 @@ require_relative 'migration_helper'
 
 Sequel.migration do
   change do
+
+    PactBroker::MigrationHelper.with_mysql do
+      # Needed to make FK pact_version_content_sha match encoding of pact_version_content ID
+      run("ALTER TABLE pacts CONVERT TO CHARACTER SET 'utf8';")
+    end
+
     alter_table(:pacts) do
       add_foreign_key :pact_version_content_sha, :pact_version_contents, type: String, null: true, foreign_key_constraint_name: 'fk_pact_version_content'
     end

data/db/migrations/migration_helper.rb

@@ -4,12 +4,22 @@ module PactBroker
     extend self
 
     def large_text_type
-      if Sequel::Model.db.adapter_scheme == :postgres
+      if adapter == 'postgres'
         :text
       else
         # Assume mysql
         :mediumtext
       end
     end
+
+    def with_mysql
+      if adapter =~ /mysql/
+        yield
+      end
+    end
+
+    def adapter
+      Sequel::Model.db.adapter_scheme.to_s
+    end
   end
 end

data/example/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
 
-gem "pact_broker"
+gem "pact_broker", "~>1.4"
 gem "sqlite3" # Replace with your choice of database driver eg. mysql2
 gem "thin" # Keep, or replace with your choice of web server

data/lib/db.rb

@@ -28,6 +28,7 @@ module DB
     con = Sequel.connect(db_credentials.merge(:logger => logger, :pool_class => Sequel::ThreadedConnectionPool))
     con.extension(:connection_validator)
     con.pool.connection_validation_timeout = -1 #Check the connection on every request
+    con.timezone = :utc
     con
   end
 

data/lib/pact_broker/api.rb

@@ -12,6 +12,10 @@ require 'pact_broker/api/resources/pact_versions'
 require 'pact_broker/api/resources/webhooks'
 require 'pact_broker/api/resources/webhook'
 require 'pact_broker/api/resources/webhook_execution'
+require 'pact_broker/api/resources/version'
+require 'pact_broker/api/resources/pact_content_diff'
+require 'pact_broker/api/resources/previous_distinct_pact_version'
+
 
 require 'webmachine/adapters/rack'
 
@@ -23,15 +27,20 @@ module PactBroker
         add(['trace', '*'], Webmachine::Trace::TraceResource) unless ENV['RACK_ENV'] == 'production'
         # Support both /pact and /pacts
         # /pact will be deprecated
+        # Todo, rename /version/ to /versions
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest'], Api::Resources::LatestPact
         add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'latest', :tag], Api::Resources::LatestPact
-        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number], Api::Resources::Pact
-        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'versions'], Api::Resources::PactVersions
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number], Api::Resources::Pact # Deprecate
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'versions', :consumer_version_number], Api::Resources::Pact
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number, 'previous-distinct'], Api::Resources::PreviousDistinctPactVersion
+        add ['pacts', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number, 'diff', 'previous-distinct'], Api::Resources::PactContentDiff
+
         add ['pact', 'provider', :provider_name, 'consumer', :consumer_name, 'version', :consumer_version_number], Api::Resources::Pact
         add ['pact', 'provider', :provider_name, 'consumer', :consumer_name, 'latest'], Api::Resources::LatestPact
         add ['pacts', 'latest'], Api::Resources::LatestPacts
         add ['pacticipants'], Api::Resources::Pacticipants
         add ['pacticipants', :name], Api::Resources::Pacticipant
+        add ['pacticipants', :pacticipant_name, 'versions', :pacticipant_version_number], Api::Resources::Version
         add ['pacticipants', :pacticipant_name, 'versions', :pacticipant_version_number, 'tags', :tag_name], Api::Resources::Tag
         add ['relationships'], Api::Resources::Relationships
         add ['groups', :pacticipant_name], Api::Resources::Group

data/lib/pact_broker/api/decorators.rb

@@ -1,6 +1,6 @@
 require 'pact_broker/api/decorators/pacticipant_decorator'
 require 'pact_broker/api/decorators/pacticipant_collection_decorator'
-require 'pact_broker/api/decorators/version_decorator'
+require 'pact_broker/api/decorators/embedded_version_decorator'
 require 'pact_broker/api/decorators/pact_collection_decorator'
 require 'pact_broker/api/decorators/pact_pacticipant_decorator'
 require 'pact_broker/api/decorators/pact_details_decorator'

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

@@ -1,5 +1,5 @@
 require 'roar/decorator'
-require 'roar/representer/json/hal'
+require 'roar/json/hal'
 require 'pact_broker/api/pact_broker_urls'
 require 'pact_broker/api/decorators/decorator_context'
 
@@ -10,8 +10,8 @@ module PactBroker
     module Decorators
 
       class BaseDecorator < Roar::Decorator
-        include Roar::Representer::JSON::HAL
-        include Roar::Representer::JSON::HAL::Links
+        include Roar::JSON::HAL
+        include Roar::JSON::HAL::Links
         include PactBroker::Api::PactBrokerUrls
       end
     end

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

@@ -1,5 +1,4 @@
 require_relative 'base_decorator'
-require_relative 'version_decorator'
 
 module PactBroker
 

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

@@ -0,0 +1,26 @@
+require_relative 'base_decorator'
+require_relative 'pact_pacticipant_decorator'
+require_relative 'timestamps'
+
+module PactBroker
+
+  module Api
+
+    module Decorators
+
+      class EmbeddedTagDecorator < BaseDecorator
+
+        property :name
+
+        link :self do | options |
+          {
+            title: 'Tag',
+            name: represented.name,
+            href: tag_url(options[:base_url], represented)
+          }
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+require_relative 'base_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+      class EmbeddedVersionDecorator < BaseDecorator
+
+        property :number
+
+        link :self do | options |
+          {
+            title: 'Version',
+            name: represented.number,
+            href: version_url(options.fetch(:base_url), represented)
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 require_relative 'base_decorator'
-require_relative 'version_decorator'
+require_relative 'embedded_version_decorator'
 require_relative 'latest_pact_decorator'
 require_relative 'representable_pact'
 
@@ -10,7 +10,7 @@ module PactBroker
     module Decorators
 
       class PactCollectionDecorator < BaseDecorator
-        include Roar::Representer::JSON::HAL
+        include Roar::JSON::HAL
         include PactBroker::Api::PactBrokerUrls
 
         collection :pacts, exec_context: :decorator, :class => PactBroker::Domain::Pact, :extend => PactBroker::Api::Decorators::LatestPactDecorator
@@ -29,7 +29,13 @@ module PactBroker
 
         # This is the LATEST pact URL
         links :pacts do | options |
-          represented.collect{ | pact | {:href => latest_pact_url(options[:base_url], pact), :title => "Latest pact between #{pact.consumer.name} and #{pact.provider.name}" } }
+          represented.collect do | pact |
+            {
+              :href => latest_pact_url(options[:base_url], pact),
+              :name => "Latest pact between #{pact.consumer.name} and #{pact.provider.name}",
+              :title => "Pact"
+            }
+          end
         end
 
       end

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

@@ -16,28 +16,92 @@ module PactBroker
           ::JSON.parse(represented.json_content, PACT_PARSING_OPTIONS).merge super
         end
 
-        link :'latest-pact' do | options |
+        link :self do | options |
           {
-            title: "Latest version of the pact between #{represented.consumer.name} and #{represented.provider.name}",
+            title: 'Pact',
+            name: represented.name,
+            href: pact_url(options.fetch(:base_url), represented)
+          }
+        end
+
+        link :'pb:consumer' do | options |
+          {
+            title: "Consumer",
+            name: represented.consumer.name,
+            href: pacticipant_url(options.fetch(:base_url), represented.consumer)
+          }
+        end
+
+        link :'pb:provider' do | options |
+          {
+            title: "Provider",
+            name: represented.provider.name,
+            href: pacticipant_url(options.fetch(:base_url), represented.provider)
+          }
+        end
+
+        link :'pb:latest-pact-version' do | options |
+          {
+            title: "Pact",
+            name: "Latest version of this pact",
             href: latest_pact_url(options.fetch(:base_url), represented)
 
           }
         end
 
-        link :'pact-versions' do | options |
+        link :'pb:previous-distinct' do | options |
+          {
+            title: "Pact",
+            name: "Previous distinct version of this pact",
+            href: previous_distinct_pact_version_url(represented, options.fetch(:base_url))
+          }
+        end
+
+        link :'pb:diff-previous-distinct' do | options |
           {
-            title: "All versions of the pact between #{represented.consumer.name} and #{represented.provider.name}",
-            href: pact_versions_url(represented.consumer.name, represented.provider.name, options.fetch(:base_url))
+            title: "Diff",
+            name: "Diff with previous distinct version of this pact",
+            href: previous_distinct_diff_url(represented, options.fetch(:base_url))
+
           }
         end
 
-        link :'pact-webhooks' do | options |
+        # link :'pb:pact-versions' do | options |
+        #   {
+        #     title: "All versions of the pact between #{represented.consumer.name} and #{represented.provider.name}",
+        #     href: pact_versions_url(represented.consumer.name, represented.provider.name, options.fetch(:base_url))
+        #   }
+        # end
+
+        link :'pb:pact-webhooks' do | options |
           {
             title: "Webhooks for the pact between #{represented.consumer.name} and #{represented.provider.name}",
             href: webhooks_for_pact_url(represented.consumer, represented.provider, options.fetch(:base_url))
           }
         end
 
+        link :'pb:tag-prod-version' do | options |
+          {
+            title: "Tag this version as 'production'",
+            href: tags_url(options.fetch(:base_url), represented.consumer_version) + "/prod"
+          }
+        end
+
+        link :'pb:tag-version' do | options |
+          {
+            title: "Tag version",
+            href: tags_url(options.fetch(:base_url), represented.consumer_version) + "/{tag}"
+          }
+        end
+
+        curies do | options |
+          [{
+            name: :pb,
+            href: options[:base_url] + '/doc/{rel}',
+            templated: true
+          }]
+        end
+
       end
     end
   end