pact_broker 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cedb84e67d02ce7d28e31fdc09aca4c39fa19e98
-  data.tar.gz: 4fa9e9b2022aa04df878b8cd6769a9d9ad36e1a6
+  metadata.gz: eab6ba50f1698c583aa2c5ea2499134dccdf26fe
+  data.tar.gz: 90c46d03810fdaba756c7d10528193636913a159
 SHA512:
-  metadata.gz: 7f756c1fc77440d7805ceeda97220d64dd1ad1f8f0fd940eb9f2be76f683bc5b7bb3c5ea8e4f6a8fd3a65f9b39951f58faba1537722ac5e6c3ff40b84d6310e5
-  data.tar.gz: a4ed85b29750424cc833bfe1bec6b43805304f2c006bd61fe0612eabd703a38110317a7a5d74a6900e429337db60def0a344d829ff5436ae05688504ae4ed355
+  metadata.gz: 71d627be7fcefa1d267b9e6347bd473aea3fe9b204a2d3235b9a0df7f03701f45ff764a9e235300b3b813ba19027f9bb5b3cca18261e5a2461d8cdf134a142af
+  data.tar.gz: 45bebda0fb63072a4fc33c082b1990b1a0ae941e04858624a733aa94a7aab9c51ab6b8bd8a965b350c1128987590ddb4f5fc489ed1bc6e4dfcac68346c5799c8

data/CHANGELOG.md

@@ -2,6 +2,24 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+#### 1.2.0 (2014-09-22)
+
+* 0ccde50 - Made webhook creation code more Webmachiney. (Beth, Tue Sep 16 10:07:56 2014 +1000)
+* 4c628e5 - Using localtime to display dates. (Beth, Fri Aug 29 13:32:20 2014 +1000)
+* 7d99c51 - Fixed HAL Browser link - page title was stopping it being clickable (Beth, Fri Sep 5 16:41:03 2014 +1000)
+* 8ba3be0 - Updating spec task for latest rspec (Beth, Fri Sep 5 16:40:10 2014 +1000)
+* fcc25eb - Updated pact gem (Beth, Tue Aug 26 18:45:31 2014 +1000)
+* 5d0d3dc - Added pact versions link to the pact response (Beth, Tue Aug 26 07:54:26 2014 +1000)
+* 16971ff - Added method to find distinct pacts between a consumer and provider (Beth, Tue Aug 26 07:41:54 2014 +1000)
+* 4798c09 - Added pact versions endpoint. (Beth, Mon Aug 25 22:23:48 2014 +1000)
+* e1f8c97 - Changed 'Date published' to display pact.updated_at date instead of created_at date (Beth, Mon Aug 25 07:37:58 20
+* 39eac31 - Fixed pact-webhooks rel title (Beth, Sun Aug 24 17:54:05 2014 +1000)
+* f6fc9f7 - Added latest-pact rel to pact representation (Beth, Sun Aug 24 17:51:08 2014 +1000)
+* 08b088c - Added method to pacticipant_service to find potentially duplicated pacticipants (Beth, Sat Aug 23 08:32:34 2014 +
+* 24e8d5d - Adding support for creating a pacticipant through the API (as distinct from it being auto created by publishing a
+* dc4d4aa - Set DB timezone to UTC. (Beth, Thu Aug 21 17:30:41 2014 +1000)
+* 19693fa - Added pact metadata to HTML view (Beth, Thu Aug 21 17:30:23 2014 +1000)
+
 #### 1.1.0 (2014-08-21)
 
 * d25395b - Fixed pacts failing to publish because of too deeply nested JSON (Beth, Tue Aug 19 11:13:02 2014 +1000)

data/README.md

@@ -2,22 +2,19 @@
 
 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.
 
-When a consumer CI build is configured to publish its pacts to a Pact Broker, it allows the provider to always be verified against the latest version of the pact. Once the required development work has been done, it will also allow providers to be verified against the "production" version of a pact, giving confidence when deploying that a new version of a provider will work against the production version of a consumer.
+The Pact Broker:
 
-It provides endpoints for the following:
-
-* Publish a pact between a provider and a given version of a consumer.
-* Retrieve the latest pact between a consumer and a provider.
-* View a list of published pacts.
-* View a list of "pacticipants" (consumers and providers).
+* 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.
 
 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.
 
-### Upcoming development
+## Documentation
 
-* Create a UI to show a network diagram based on the published pacts.
-* Display pacts in HTML format.
-* Allow "tagging" of pacts so that the provider can be verified against the production version of a pact.
+See the [wiki](https://github.com/bethesque/pact_broker/wiki) for documentation.
 
 ## Usage
 

data/lib/pact_broker/api.rb

@@ -8,6 +8,7 @@ require 'pact_broker/api/resources/index'
 require 'pact_broker/api/resources/relationships'
 require 'pact_broker/api/resources/group'
 require 'pact_broker/api/resources/pact_webhooks'
+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'
@@ -25,6 +26,7 @@ module PactBroker
         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 ['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

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

@@ -6,13 +6,20 @@ module PactBroker
 
         attr_reader :base_url, :resource_url, :resource_title
 
-        def initialize base_url, resource_url, options
+        def initialize base_url, resource_url, options = {}
           @base_url = base_url
+          self[:base_url] = base_url
           @resource_url = resource_url
+          self[:resource_url] = resource_url
           @resource_title = options[:resource_title]
+          self[:resource_title] = resource_title
           merge!(options)
         end
 
+        def to_s
+          "DecoratorContext #{super}"
+        end
+
       end
 
     end

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

@@ -9,16 +9,31 @@ module PactBroker
 
       class PactDecorator < BaseDecorator
 
-        property :createdAt, getter: lambda { |_|  created_at.xmlschema }
-        property :updatedAt, getter: lambda { |_| updated_at.xmlschema }
+        property :createdAt, getter: lambda { |_|  created_at.xmlschema }, writeable: false
+        property :updatedAt, getter: lambda { |_| updated_at.xmlschema }, writeable: false
 
         def to_hash(options = {})
           ::JSON.parse(represented.json_content, PACT_PARSING_OPTIONS).merge super
         end
 
+        link :'latest-pact' do | options |
+          {
+            title: "Latest version of the pact between #{represented.consumer.name} and #{represented.provider.name}",
+            href: latest_pact_url(options.fetch(:base_url), represented)
+
+          }
+        end
+
+        link :'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 :'pact-webhooks' do | options |
           {
-            title: 'Webhooks for this pact',
+            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

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

@@ -0,0 +1,39 @@
+require_relative 'base_decorator'
+require_relative 'pact_pacticipant_decorator'
+
+module PactBroker
+
+  module Api
+
+    module Decorators
+
+      class EmbeddedVersionDecorator < BaseDecorator
+
+        property :number
+
+        link :self do | options |
+          version_url(options[:base_url], represented)
+        end
+      end
+
+      class PactVersionDecorator < BaseDecorator
+
+
+        property :createdAt, getter: lambda { |_|  created_at.to_time.localtime.xmlschema }, writeable: false
+        property :updatedAt, getter: lambda { |_| updated_at.to_time.localtime.xmlschema }, writeable: false
+
+        property :consumer_version, as: :consumerVersion, embedded: true, decorator: EmbeddedVersionDecorator
+
+
+        link :self do | options |
+          {
+            href: pact_url(options.base_url, represented),
+            title: represented.name
+          }
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require_relative 'base_decorator'
+require_relative 'pact_version_decorator'
+
+module PactBroker
+
+  module Api
+
+    module Decorators
+
+
+      class PactVersionsDecorator < BaseDecorator
+
+        collection :entries, as: :pacts, embedded: true, :extend => PactBroker::Api::Decorators::PactVersionDecorator
+
+        link :self do | context |
+          {
+            href: context.resource_url,
+            title: "All versions of the pact between #{context[:consumer_name]} and #{context[:provider_name]}"
+          }
+        end
+
+        link :consumer do | context |
+          {
+            href: pacticipant_url(context.base_url, OpenStruct.new(name: context[:consumer_name])),
+            title: context[:consumer_name]
+          }
+        end
+
+        link :provider do | context |
+          {
+            href: pacticipant_url(context.base_url, OpenStruct.new(name: context[:provider_name])),
+            title: context[:provider_name]
+          }
+        end
+
+        links :'pact-versions' do | context |
+          represented.collect do | pact |
+            {
+              :href => pact_url(context.base_url, pact),
+              :title => pact.version_and_updated_date
+            }
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -11,10 +11,10 @@ module PactBroker
 
         property :name
         property :repository_url, as: :repositoryUrl
-        property :latest_version, as: :'latest-version', :class => PactBroker::Models::Version, :extend => PactBroker::Api::Decorators::VersionRepresenter, :embedded => true
-        property :createdAt, getter: lambda { |_|  created_at.xmlschema }
-        property :updatedAt, getter: lambda { |_| updated_at.xmlschema }
 
+        property :latest_version, as: :'latest-version', :class => PactBroker::Models::Version, :extend => PactBroker::Api::Decorators::VersionRepresenter, :embedded => true, writeable: false
+        property :createdAt, getter: lambda { |_|  created_at.xmlschema }, writeable: false
+        property :updatedAt, getter: lambda { |_| updated_at.xmlschema }, writeable: false
 
         link :self do | options |
           pacticipant_url(options[:base_url], represented)

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

@@ -19,7 +19,7 @@ module PactBroker
         link :self do | options |
           {
             title: represented.description,
-            href: webhook_url(represented, options[:base_url])
+            href: webhook_url(represented.uuid, options[:base_url])
           }
 
         end

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

@@ -42,7 +42,7 @@ module PactBroker
 
         link :webhook do | options |
           {
-            href: webhook_url(options.fetch(:webhook), options.fetch(:base_url))
+            href: webhook_url(options.fetch(:webhook).uuid, options.fetch(:base_url))
           }
         end
 

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

@@ -19,7 +19,7 @@ module PactBroker
             {
               title: webhook.description,
               name: webhook.request_description,
-              href: webhook_url(webhook, context.base_url)
+              href: webhook_url(webhook.uuid, context.base_url)
             }
           end
         end

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -2,6 +2,8 @@ module PactBroker
   module Api
     module PactBrokerUrls
 
+      extend self
+
       def pacticipants_url base_url
         "#{base_url}/pacticipants"
       end
@@ -35,6 +37,10 @@ module PactBroker
         "#{base_url}/pacts/latest"
       end
 
+      def pact_versions_url consumer_name, provider_name, base_url
+        "#{base_url}/pacts/provider/#{url_encode(provider_name)}/consumer/#{url_encode(consumer_name)}/versions"
+      end
+
       def tags_url base_url, version
         "#{version_url(base_url, version)}/tags"
       end
@@ -47,8 +53,8 @@ module PactBroker
         "#{base_url}/webhooks"
       end
 
-      def webhook_url webhook, base_url
-        "#{base_url}/webhooks/#{webhook.uuid}"
+      def webhook_url uuid, base_url
+        "#{base_url}/webhooks/#{uuid}"
       end
 
       def webhook_execution_url webhook, base_url
@@ -59,6 +65,14 @@ module PactBroker
         "#{base_url}/webhooks/provider/#{provider.name}/consumer/#{consumer.name}"
       end
 
+      def hal_browser_url target_url
+        "/hal-browser/browser.html#" + target_url
+      end
+
+      def url_encode param
+        ERB::Util.url_encode param
+      end
+
       private
 
       def representable_pact pact
@@ -68,10 +82,6 @@ module PactBroker
       def pactigration_base_url base_url, pact
         "#{base_url}/pacts/provider/#{url_encode(pact.provider.name)}/consumer/#{url_encode(pact.consumer.name)}"
       end
-
-      def url_encode param
-        ERB::Util.url_encode param
-      end
     end
   end
 end

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

@@ -2,28 +2,57 @@ require 'pact/consumer_contract'
 require 'pact/reification'
 require 'redcarpet'
 require 'pact/doc/markdown/consumer_contract_renderer'
+require 'pact_broker/api/pact_broker_urls'
 
 module PactBroker
   module Api
     module Renderers
       class HtmlPactRenderer
 
-        def self.call json_content
-          new(json_content).call
+        def self.call pact
+          new(pact).call
         end
 
-        def initialize json_content
-          @json_content = json_content
+        def initialize pact
+          @json_content = pact.json_content
+          @pact = pact
         end
 
         def call
-          "<html><head>#{head}</head><body>#{html}</body></html>"
+          "<html><head>#{head}</head><body>#{pact_metadata}#{html}</body></html>"
         end
 
         private
 
         def head
-          '<link rel="stylesheet" type="text/css" href="/stylesheets/github.css">'
+          '<link rel="stylesheet" type="text/css" href="/stylesheets/github.css">' + "\n" +
+          '<link rel="stylesheet" type="text/css" href="/stylesheets/pact.css">'
+        end
+
+        def pact_metadata
+          "<div class='pact-metadata'>
+            <ul>
+              <li>
+                <span class='name'>#{@pact.consumer.name} version:</span>
+                <span class='value'>#{@pact.consumer_version_number}</span>
+              </li>
+              <li>
+                <span class='name'>Date published:</span>
+                <span class='value'>#{@pact.updated_at.to_time.localtime.to_datetime.strftime("%d/%m/%Y %l:%M%p %:z")}</span>
+              </li>
+              <li>
+                <a href=\"#{json_url}\">View in HAL Browser</a>
+              </li>
+            </ul>
+          </div>"
+        end
+
+        def json_url
+          PactBroker::Api::PactBrokerUrls.hal_browser_url pact_url
+        end
+
+        def pact_url
+          PactBroker::Api::PactBrokerUrls.pact_url '', @pact
         end
 
         def markdown

data/lib/pact_broker/api/resources/base_resource.rb

@@ -4,55 +4,102 @@ require 'pact_broker/api/decorators'
 require 'pact_broker/logging'
 require 'pact_broker/api/pact_broker_urls'
 require 'pact_broker/api/decorators/decorator_context'
+require 'pact_broker/json'
 
-module PactBroker::Api
+module PactBroker
 
-  module Resources
+  module Api
+    module Resources
 
+      class InvalidJsonError < StandardError ; end
 
-    class ErrorHandler
+      class ErrorHandler
 
-      include PactBroker::Logging
+        include PactBroker::Logging
 
-      def self.handle_exception e, response
-        logger.error e
-        logger.error e.backtrace
-        response.body = {:message => e.message, :backtrace => e.backtrace }.to_json
-        response.code = 500
+        def self.handle_exception e, response
+          logger.error e
+          logger.error e.backtrace
+          response.body = {:message => e.message, :backtrace => e.backtrace }.to_json
+        end
       end
-    end
 
-    class BaseResource < Webmachine::Resource
+      class BaseResource < Webmachine::Resource
 
-      include PactBroker::Services
-      include PactBroker::Api::PactBrokerUrls
-      include PactBroker::Logging
+        include PactBroker::Services
+        include PactBroker::Api::PactBrokerUrls
+        include PactBroker::Logging
 
-      def identifier_from_path
-        request.path_info.each_with_object({}) do | pair, hash|
-          hash[pair.first] = CGI::unescape(pair.last)
+        def identifier_from_path
+          request.path_info.each_with_object({}) do | pair, hash|
+            hash[pair.first] = URI.decode(pair.last)
+          end
         end
-      end
 
-      # This should be called base_url
-      def base_url
-        request.uri.to_s.gsub(/#{request.uri.path}$/,'')
-      end
+        # This should be called base_url
+        def base_url
+          request.uri.to_s.gsub(/#{request.uri.path}$/,'')
+        end
 
-      def resource_url
-        request.uri.to_s
-      end
+        def resource_url
+          request.uri.to_s
+        end
 
-      def decorator_context options = {}
-        Decorators::DecoratorContext.new(base_url, resource_url, options)
-      end
+        def decorator_context options = {}
+          Decorators::DecoratorContext.new(base_url, resource_url, options)
+        end
 
-      def handle_exception e
-        PactBroker::Api::Resources::ErrorHandler.handle_exception(e, response)
-      end
+        def handle_exception e
+          PactBroker::Api::Resources::ErrorHandler.handle_exception(e, response)
+        end
+
+        def params
+          @params ||= JSON.parse(request.body.to_s, {symbolize_names: true}.merge(PACT_PARSING_OPTIONS))
+        end
+
+        def set_json_error_message message
+          response.headers['Content-Type'] = 'application/json'
+          response.body = {error: message}.to_json
+        end
+
+        def set_json_validation_error_messages errors
+          response.headers['Content-Type'] = 'application/json'
+          response.body = {errors: errors}.to_json
+        end
+
+        def request_body
+          @request_body ||= request.body.to_s
+        end
+
+        def consumer_name
+          identifier_from_path[:consumer_name]
+        end
+
+        def provider_name
+          identifier_from_path[:provider_name]
+        end
+
+        def invalid_json?
+          begin
+            JSON.parse(request_body, PACT_PARSING_OPTIONS) #Not load! Otherwise it will try to load Ruby classes.
+            false
+          rescue StandardError => e
+            logger.error "Error parsing JSON #{e} - #{request_body}"
+            set_json_error_message "Error parsing JSON - #{e.message}"
+            response.headers['Content-Type'] = 'application/json'
+            true
+          end
+        end
+
+        def validation_errors? model
+          if (errors = model.validate).any?
+            set_json_validation_error_messages errors
+            true
+          else
+            false
+          end
+        end
 
-      def params
-        JSON.parse(request.body.to_s, symbolize_names: true)
       end
     end
   end