pact_broker 1.1.0 → 1.2.0

data/lib/pact_broker/app.rb

@@ -29,6 +29,7 @@ module PactBroker
     def post_configure
       PactBroker.logger = configuration.logger
       PactBroker::DB.connection = configuration.database_connection
+      PactBroker::DB.connection.timezone = :utc
 
       if configuration.auto_migrate_db
         logger.info "Migrating database"

data/lib/pact_broker/configuration.rb

@@ -23,9 +23,9 @@ module PactBroker
     end
 
     def self.default_html_pact_render
-      lambda { |json_content|
+      lambda { |pact|
         require 'pact_broker/api/renderers/html_pact_renderer'
-        PactBroker::Api::Renderers::HtmlPactRenderer.call json_content
+        PactBroker::Api::Renderers::HtmlPactRenderer.call pact
       }
     end
 

data/lib/pact_broker/doc/views/webhooks.markdown

@@ -2,7 +2,7 @@
 
 ### Creating
 
-1. To create a webhook, navigate to the pact you want to create the webhook for
+1. To create a webhook, in the HAL Browser, navigate to the pact you want to create the webhook for
 (Click "Go to Entry Point", then select "latest-pacts", then select the pact you want to create the webhook for.)
 2. Click the "NON-GET" button for the "pact-webhooks" relation.
 3. Paste in the webhook JSON (example shown below) in the body section and click "Make Request".

data/lib/pact_broker/functions/find_potential_duplicate_pacticipant_names.rb

@@ -0,0 +1,43 @@
+require 'pact_broker/models/group'
+
+=begin
+
+=end
+
+module PactBroker
+
+  module Functions
+
+    class FindPotentialDuplicatePacticipantNames
+
+      attr_reader :new_name, :existing_names
+
+      def initialize new_name, existing_names
+        @new_name = new_name
+        @existing_names = existing_names
+      end
+
+      def self.call new_name, existing_names
+        new(new_name, existing_names).call
+      end
+
+      def call
+        return [] if existing_names.include?(new_name)
+
+        existing_names.select do | existing_name |
+          similar?(clean(new_name), clean(existing_name))
+        end
+      end
+
+      def similar?(new_name, existing_name)
+        existing_name.include?(new_name) || new_name.include?(existing_name)
+      end
+
+      def clean name #TODO uppercase S
+        name.gsub(/s\b/,'').gsub(/s([A-Z])/,'\1').gsub(/[^A-Za-z0-9]/,'').downcase
+      end
+
+    end
+
+  end
+end

data/lib/pact_broker/locale/en.yml

@@ -5,6 +5,13 @@ en:
         attribute_missing: "Missing required attribute '%{attribute}'"
         invalid_http_method: "Invalid HTTP method '%{method}'"
         invalid_url: "Invalid URL '%{url}'. Expected format: http://example.org"
+      duplicate_pacticipant: |
+        This is the first time a pact has been published for "%{new_name}".
+        The name "%{new_name}" is very similar to the following existing consumers/providers:
+        %{existing_names}
+        If you meant to specify one of the above names, please correct the pact configuration, and re-publish the pact.
+        If the pact is intended to be for a new consumer or provider, please manually create "%{new_name}" using the following command, and then re-publish the pact:
+        $ curl -v -XPOST -H "Content-Type: application/json" -d "{\"name\": \"%{new_name}\"}" %{create_pacticipant_url}
       "400":
         title: 400 Malformed Request
         message: The request was malformed and could not be processed.

data/lib/pact_broker/messages.rb

@@ -1,11 +1,15 @@
 require 'i18n'
+require 'pact_broker/api/pact_broker_urls'
 
 I18n.config.load_path << File.expand_path("../locale/en.yml", __FILE__)
 
 module PactBroker
   # Provides an interface to the I18n library specifically for
-  # {Webmachine}'s messages.
+  # the PactBroker's messages.
   module Messages
+
+    extend self
+
     # Interpolates an internationalized string.
     # @param [String] key the name of the string to interpolate
     # @param [Hash] options options to pass to I18n, including
@@ -14,5 +18,20 @@ module PactBroker
     def message(key, options={})
       ::I18n.t(key, options.merge(:scope => :pact_broker))
     end
+
+    def potential_duplicate_pacticipant_message new_name, potential_duplicate_pacticipants, base_url
+      existing_names = potential_duplicate_pacticipants.
+        collect{ | p | "* #{p.name}"  }.join("\n")
+      message('errors.duplicate_pacticipant',
+        new_name: new_name,
+        existing_names: existing_names,
+        create_pacticipant_url: pacticipants_url(base_url))
+    end
+
+    private
+
+    def pacticipants_url base_url
+      PactBroker::Api::PactBrokerUrls.pacticipants_url base_url
+    end
   end
 end

data/lib/pact_broker/models/pact.rb

@@ -25,6 +25,14 @@ module PactBroker
       def to_json options = {}
         json_content
       end
+
+      def name
+        "Pact between #{consumer.name} (v#{consumer_version_number}) and #{provider.name}"
+      end
+
+      def version_and_updated_date
+        "Version #{consumer_version_number} - #{updated_at.to_time.localtime.strftime("%d/%m/%Y")}"
+      end
     end
 
     Pact.plugin :timestamps, :update_on_create=>true

data/lib/pact_broker/models/pacticipant.rb

@@ -1,4 +1,5 @@
 require 'pact_broker/db'
+require 'pact_broker/messages'
 
 module PactBroker
 
@@ -6,6 +7,8 @@ module PactBroker
 
     class Pacticipant < Sequel::Model
 
+      include Messages
+
       set_primary_key :id
 
       one_to_many :versions, :order => :order, :reciprocal => :pacticipant
@@ -18,6 +21,12 @@ module PactBroker
       def to_s
         "Pacticipant: id=#{id}, name=#{name}"
       end
+
+      def validate
+        messages = []
+        messages << message('errors.validation.attribute_missing', attribute: 'name') unless name
+        messages
+      end
     end
 
     Pacticipant.plugin :timestamps, :update_on_create=>true

data/lib/pact_broker/models/version.rb

@@ -10,6 +10,7 @@ module PactBroker
       set_primary_key :id
       one_to_many :pacts
       associate(:many_to_one, :pacticipant, :class => "PactBroker::Models::Pacticipant", :key => :pacticipant_id, :primary_key => :id)
+      one_to_many :tags, :reciprocal => :version
 
       def after_create
         OrderVersions.(self.pacticipant_id)

data/lib/pact_broker/repositories/pact_repository.rb

@@ -8,6 +8,12 @@ module PactBroker
 
       include PactBroker::Logging
 
+      def find_all_pacts_between consumer_name, options
+        pact_finder(consumer_name, options.fetch(:and))
+          .left_outer_join(:tags, {:version_id => :id}, {implicit_qualifier: :versions})
+          .reverse_order(:order).all
+      end
+
       def find_by_version_and_provider version_id, provider_id
         PactBroker::Models::Pact.where(version_id: version_id, provider_id: provider_id).single_record
       end

data/lib/pact_broker/repositories/pacticipant_repository.rb

@@ -29,6 +29,10 @@ module PactBroker
         PactBroker::Models::Pacticipant.new(name: args[:name], repository_url: args[:repository_url]).save(raise_on_save_failure: true)
       end
 
+      def pacticipant_names
+        PactBroker::Models::Pacticipant.select(:name).order(:name).collect{ | pacticipant| pacticipant.name }
+      end
+
       def find_latest_version name
 
       end

data/lib/pact_broker/repositories/webhook_repository.rb

@@ -2,7 +2,6 @@ require 'sequel'
 require 'pact_broker/models/webhook'
 require 'pact_broker/models/pacticipant'
 require 'pact_broker/db'
-require 'base64'
 
 module PactBroker
   module Repositories
@@ -14,9 +13,9 @@ module PactBroker
 
       include Repositories
 
-      def create webhook, consumer, provider
+      def create uuid, webhook, consumer, provider
         db_webhook = Webhook.from_model webhook, consumer, provider
-        db_webhook.uuid = SecureRandom.urlsafe_base64
+        db_webhook.uuid = uuid
         db_webhook.save
         webhook.request.headers.each_pair do | name, value |
           db_webhook.add_header WebhookHeader.from_model(name, value, db_webhook.id)

data/lib/pact_broker/services/pact_service.rb

@@ -36,6 +36,26 @@ module PactBroker
 
       end
 
+      def find_all_pacts_between consumer, options
+        pact_repository.find_all_pacts_between consumer, options
+      end
+
+      def find_distinct_pacts_between consumer, options
+        # Assumes pacts are sorted from newest to oldest
+        all = pact_repository.find_all_pacts_between consumer, options
+        distinct = []
+        (0...all.size).each do | i |
+          if i == all.size - 1
+            distinct << all[i]
+          else
+            if all[i].json_content != all[i+1].json_content
+              distinct << all[i]
+            end
+          end
+        end
+        distinct
+      end
+
       def pact_has_changed_since_previous_version? pact
         previous_pact = pact_repository.find_previous_pact pact
         previous_pact && pact.json_content != previous_pact.json_content

data/lib/pact_broker/services/pacticipant_service.rb

@@ -1,5 +1,8 @@
 require 'pact_broker/repositories'
+require 'pact_broker/logging'
+require 'pact_broker/messages'
 require 'pact_broker/models/relationship'
+require 'pact_broker/functions/find_potential_duplicate_pacticipant_names'
 
 module PactBroker
 
@@ -8,6 +11,27 @@ module PactBroker
 
       extend PactBroker::Repositories
       extend PactBroker::Services
+      extend PactBroker::Logging
+
+      def self.messages_for_potential_duplicate_pacticipants pacticipant_names, base_url
+        messages = []
+        pacticipant_names.each do | name |
+          potential_duplicate_pacticipants = find_potential_duplicate_pacticipants(name)
+          if potential_duplicate_pacticipants.any?
+            messages << Messages.potential_duplicate_pacticipant_message(name, potential_duplicate_pacticipants, base_url)
+          end
+        end
+        messages
+      end
+
+      def self.find_potential_duplicate_pacticipants pacticipant_name
+        PactBroker::Functions::FindPotentialDuplicatePacticipantNames
+          .call(pacticipant_name, pacticipant_names).tap { | names|
+            if names.any?
+              logger.info "The following potential duplicate pacticipants were found for #{pacticipant_name}: #{names.join(", ")}"
+            end
+          } .collect{ | name | pacticipant_repository.find_by_name(name) }
+      end
 
       def self.find_all_pacticipants
         pacticipant_repository.find_all
@@ -51,6 +75,10 @@ module PactBroker
         connection.run("delete from pacticipants where name = '#{name}'")
       end
 
+      def self.pacticipant_names
+        pacticipant_repository.pacticipant_names
+      end
+
     end
   end
 end

data/lib/pact_broker/services/webhook_service.rb

@@ -1,5 +1,6 @@
 require 'pact_broker/repositories'
 require 'pact_broker/logging'
+require 'base64'
 
 module PactBroker
 
@@ -9,8 +10,12 @@ module PactBroker
       extend Repositories
       include Logging
 
-      def self.create webhook, consumer, provider
-        webhook_repository.create webhook, consumer, provider
+      def self.next_uuid
+        SecureRandom.urlsafe_base64
+      end
+
+      def self.create uuid, webhook, consumer, provider
+        webhook_repository.create uuid, webhook, consumer, provider
       end
 
       def self.find_by_uuid uuid

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/pact_broker.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'versionomy'
   gem.add_runtime_dependency 'rack'
   gem.add_runtime_dependency 'redcarpet', '~>3.1'
-  gem.add_runtime_dependency 'pact', '~>1.3'
+  gem.add_runtime_dependency 'pact', '~>1.3', '>=1.3.2'
   gem.add_runtime_dependency 'padrino', '~>0.12'
   gem.add_runtime_dependency 'haml'
 

data/public/stylesheets/github.css

@@ -43,7 +43,7 @@ h1, h2, h3, h4, h5, h6 {
   font-weight: bold;
   -webkit-font-smoothing: antialiased;
   cursor: text;
-  position: relative;
+  /* position: relative; Beth: this makes the View In HAL Browser link unclickable */
 }
 
 h2:first-child, h1:first-child, h1:first-child + h2, h3:first-child, h4:first-child, h5:first-child, h6:first-child {

data/public/stylesheets/pact.css

@@ -0,0 +1,12 @@
+div.pact-metadata {
+  float: right;
+}
+
+div.pact-metadata li {
+  list-style-type: none ;
+  text-align: right
+}
+
+div.pact-metadata span.name {
+  font-weight: bold ;
+}

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

@@ -41,6 +41,16 @@ module PactBroker
           it "includes a link to the webhooks for this pact" do
             expect(subject[:_links][:'pact-webhooks'][:href]).to eq "http://example.org/webhooks/provider/Provider/consumer/Consumer"
           end
+
+          it "includes a link to the latest pact" do
+            expect(subject[:_links][:'latest-pact'][:title]).to eq "Latest version of the pact between Consumer and Provider"
+            expect(subject[:_links][:'latest-pact'][:href]).to eq "http://example.org/pacts/provider/Provider/consumer/Consumer/latest"
+          end
+
+          it "includes a link to the pact versions" do
+            expect(subject[:_links][:'pact-versions'][:title]).to eq "All versions of the pact between Consumer and Provider"
+            expect(subject[:_links][:'pact-versions'][:href]).to eq "http://example.org/pacts/provider/Provider/consumer/Consumer/versions"
+          end
         end
 
       end

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

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'pact_broker/api/decorators/pact_version_decorator'
+
+module PactBroker
+
+  module Api
+
+    module Decorators
+
+      describe PactVersionDecorator do
+
+        let(:json_content) {
+          {
+            '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, created_at: created_at, updated_at: updated_at, consumer: consumer, provider: provider, consumer_version: consumer_version, name: 'pact_name')}
+        let(:consumer) { instance_double(PactBroker::Models::Pacticipant, name: 'Consumer')}
+        let(:provider) { instance_double(PactBroker::Models::Pacticipant, name: 'Provider')}
+        let(:consumer_version) { instance_double(PactBroker::Models::Version, number: '1234', pacticipant: consumer)}
+        let(:decorator_context) { DecoratorContext.new(base_url, '') }
+
+        let(:json) { PactVersionDecorator.new(pact).to_json(decorator_context) }
+
+        subject { JSON.parse(json, symbolize_names: true) }
+
+        it "includes a link to the pact" do
+          expect(subject[:_links][:self][:href]).to eq 'http://example.org/pacts/provider/Provider/consumer/Consumer/version/1234'
+        end
+
+        it "includes the consumer version number" do
+          expect(subject[:_embedded][:consumerVersion][:number]).to eq "1234"
+        end
+
+        it "includes a link to the version" do
+          expect(subject[:_embedded][:consumerVersion][:_links][:self][:href]).to eq "http://example.org/pacticipants/Consumer/versions/1234"
+        end
+
+      end
+    end
+  end
+end

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

@@ -6,9 +6,17 @@ module PactBroker
     module Renderers
       describe HtmlPactRenderer do
 
+        let(:consumer) { double('consumer', name: 'Consumer')}
+        let(:created_at) { DateTime.now }
         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_url) { '/pact/url' }
 
-        subject { HtmlPactRenderer.call json_content }
+        before do
+          allow(PactBroker::Api::PactBrokerUrls).to receive(:pact_url).with('', pact).and_return(pact_url)
+        end
+
+        subject { HtmlPactRenderer.call pact }
 
         describe ".call" do
           it "renders the pact as HTML" do