pact_broker 2.3.0 → 2.4.0

data/lib/pact_broker/configuration.rb

@@ -11,7 +11,7 @@ module PactBroker
 
   class Configuration
 
-    SAVABLE_SETTING_NAMES = [:order_versions_by_date, :use_case_sensitive_resource_names]
+    SAVABLE_SETTING_NAMES = [:order_versions_by_date, :use_case_sensitive_resource_names, :enable_badge_resources, :shields_io_base_url]
 
     attr_accessor :log_dir, :database_connection, :auto_migrate_db, :use_hal_browser, :html_pact_renderer
     attr_accessor :validate_database_connection_config, :enable_diagnostic_endpoints, :version_parser

data/lib/pact_broker/domain.rb

@@ -1,5 +1,6 @@
 require 'pact_broker/domain/pact'
 require 'pact_broker/domain/pacticipant'
 require 'pact_broker/domain/tag'
+require 'pact_broker/domain/label'
 require 'pact_broker/domain/version'
 require 'pact_broker/domain/webhook'

data/lib/pact_broker/domain/label.rb

@@ -0,0 +1,19 @@
+require 'pact_broker/db'
+
+module PactBroker
+  module Domain
+    class Label < Sequel::Model
+
+      unrestrict_primary_key
+
+      associate(:many_to_one, :pacticipant, :class => "PactBroker::Domain::Pacticipant", :key => :pacticipant_id, :primary_key => :id)
+
+      def <=> other
+        name <=> other.name
+      end
+
+    end
+
+    Label.plugin :timestamps, update_on_create: true
+  end
+end

data/lib/pact_broker/domain/pacticipant.rb

@@ -1,5 +1,6 @@
 require 'pact_broker/db'
 require 'pact_broker/messages'
+require 'pact_broker/repositories/helpers'
 
 module PactBroker
 
@@ -12,8 +13,18 @@ module PactBroker
       set_primary_key :id
 
       one_to_many :versions, :order => :order, :reciprocal => :pacticipant
+      one_to_many :labels, :order => :name, :reciprocal => :pacticipant
       one_to_many :pacts
 
+      dataset_module do
+        include PactBroker::Repositories::Helpers
+
+        def label label_name
+          filter = name_like(Sequel[:labels][:name], label_name)
+          join(:labels, {pacticipant_id: :id}).where(filter)
+        end
+      end
+
       def latest_version
         versions.last
       end
@@ -29,6 +40,6 @@ module PactBroker
       end
     end
 
-    Pacticipant.plugin :timestamps, :update_on_create=>true
+    Pacticipant.plugin :timestamps, update_on_create: true
   end
 end

data/lib/pact_broker/labels/repository.rb

@@ -0,0 +1,32 @@
+require 'pact_broker/domain/label'
+require 'pact_broker/repositories/helpers'
+
+module PactBroker
+  module Labels
+    class Repository
+
+      include PactBroker::Repositories::Helpers
+
+      def create args
+        Domain::Label.new(name: args.fetch(:name), pacticipant: args.fetch(:pacticipant)).save
+      end
+
+      def find args
+        PactBroker::Domain::Label
+          .select(Sequel.qualify("labels", "name"), Sequel.qualify("labels", "pacticipant_id"), Sequel.qualify("labels", "created_at"), Sequel.qualify("labels", "updated_at"))
+          .join(:pacticipants, {id: :pacticipant_id})
+          .where(name_like(Sequel.qualify("labels", "name"), args.fetch(:label_name)))
+          .where(name_like(Sequel.qualify("pacticipants", "name"), args.fetch(:pacticipant_name)))
+          .single_record
+      end
+
+      def delete args
+        find(args).delete
+      end
+
+      def delete_by_pacticipant_id pacticipant_id
+        Sequel::Model.db[:labels].where(pacticipant_id: pacticipant_id).delete
+      end
+    end
+  end
+end

data/lib/pact_broker/labels/service.rb

@@ -0,0 +1,26 @@
+require 'pact_broker/repositories'
+
+module PactBroker
+
+  module Labels
+    module Service
+
+      extend self
+
+      extend PactBroker::Repositories
+
+      def create args
+        pacticipant = pacticipant_repository.find_by_name_or_create args.fetch(:pacticipant_name)
+        label_repository.create pacticipant: pacticipant, name: args.fetch(:label_name)
+      end
+
+      def find args
+        label_repository.find args
+      end
+
+      def delete args
+        label_repository.delete args
+      end
+    end
+  end
+end

data/lib/pact_broker/pacticipants/repository.rb

@@ -17,12 +17,17 @@ module PactBroker
       end
 
       def find_all
-        PactBroker::Domain::Pacticipant.order(:name).all
+        find
+      end
+
+      def find options = {}
+        query = PactBroker::Domain::Pacticipant.select_all_qualified
+        query = query.label(options[:label_name]) if options[:label_name]
+        query.order_ignore_case(Sequel[:pacticipants][:name]).all
       end
 
       def find_all_pacticipant_versions_in_reverse_order name
-        PactBroker::Domain::Version
-          .select(Sequel[:versions][:id], Sequel[:versions][:number], Sequel[:versions][:pacticipant_id], Sequel[:versions][:order], Sequel[:versions][:created_at], Sequel[:versions][:updated_at])
+        PactBroker::Domain::Version.select_all_qualified
           .join(:pacticipants, {id: :pacticipant_id})
           .where(name_like(:name, name))
           .reverse_order(:order)
@@ -43,10 +48,6 @@ module PactBroker
       def pacticipant_names
         PactBroker::Domain::Pacticipant.select(:name).order(:name).collect{ | pacticipant| pacticipant.name }
       end
-
-      def find_latest_version name
-
-      end
     end
   end
 end

data/lib/pact_broker/pacticipants/service.rb

@@ -41,6 +41,10 @@ module PactBroker
         pacticipant_repository.find_by_name(name)
       end
 
+      def self.find options
+        pacticipant_repository.find options
+      end
+
       def self.find_all_pacticipant_versions_in_reverse_order name
         pacticipant_repository.find_all_pacticipant_versions_in_reverse_order(name)
       end

data/lib/pact_broker/repositories.rb

@@ -22,6 +22,11 @@ module PactBroker
       Tags::Repository.new
     end
 
+    def label_repository
+      require 'pact_broker/labels/repository'
+      Labels::Repository.new
+    end
+
     def webhook_repository
       require 'pact_broker/webhooks/repository'
       Webhooks::Repository.new

data/lib/pact_broker/services.rb

@@ -17,6 +17,11 @@ module PactBroker
       Tags::Service
     end
 
+    def label_service
+      require 'pact_broker/labels/service'
+      Labels::Service
+    end
+
     def group_service
       require 'pact_broker/groups/service'
       Groups::Service

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 end

data/spec/features/delete_label_spec.rb

@@ -0,0 +1,28 @@
+describe "Deleting a label" do
+
+  before do
+    TestDataBuilder.new
+      .create_pacticipant("foo")
+      .create_label("ios")
+      .create_label("consumer")
+      .create_pacticipant("bar")
+      .create_label("ios")
+      .create_label("consumer")
+  end
+
+  let(:path) { "/pacticipants/foo/labels/ios" }
+  let(:response_body_hash) { JSON.parse(subject.body, symbolize_names: true) }
+  let(:expected_response_body) { {name: 'ios'} }
+
+  subject { delete path; last_response  }
+
+  context "when the label exists" do
+    it "returns a 204 No Content" do
+      expect(subject.status).to be 204
+    end
+
+    it "deletes the label" do
+      expect { subject }.to change { PactBroker::Domain::Label.count }.by(-1)
+    end
+  end
+end

data/spec/features/get_label_spec.rb

@@ -0,0 +1,28 @@
+describe "Get a label" do
+
+  before do
+    TestDataBuilder.new
+      .create_pacticipant("foo")
+      .create_label("ios")
+      .create_label("consumer")
+      .create_pacticipant("bar")
+      .create_label("ios")
+      .create_label("consumer")
+  end
+
+  let(:path) { "/pacticipants/foo/labels/ios" }
+  let(:response_body_hash) { JSON.parse(subject.body, symbolize_names: true) }
+  let(:expected_response_body) { {name: 'ios'} }
+
+  subject { get path; last_response  }
+
+  context "when the label exists" do
+    it "returns a 200 OK" do
+      expect(subject).to be_a_hal_json_success_response
+    end
+
+    it "returns the label in the body" do
+      expect(response_body_hash).to include expected_response_body
+    end
+  end
+end

data/spec/features/get_pacticipants_by_label_spec.rb

@@ -0,0 +1,27 @@
+describe "Get pacticipants by label" do
+
+  let(:path) { "/pacticipants/label/ios" }
+  let(:response_body_hash) { JSON.parse(subject.body, symbolize_names: true) }
+  let(:expected_response_body) { {name: "Foo"} }
+
+  subject { get path; last_response }
+
+  context "when the pacts exist" do
+
+    before do
+      TestDataBuilder.new
+        .create_pacticipant("Foo")
+        .create_label("ios")
+        .create_pacticipant("Bar")
+        .create_label("android")
+    end
+
+    it "returns a 200 OK" do
+      expect(subject).to be_a_hal_json_success_response
+    end
+
+    it "returns a list of pacticipants" do
+      expect(response_body_hash[:_embedded][:pacticipants].first).to include expected_response_body
+    end
+  end
+end

data/spec/features/label_pacticipant_spec.rb

@@ -0,0 +1,22 @@
+describe "Labelling a pacticipant" do
+
+  let(:path) { "/pacticipants/foo/labels/ios" }
+  let(:response_body_hash) { JSON.parse(subject.body, symbolize_names: true) }
+  let(:expected_response_body) { {name: 'ios'} }
+
+  subject { put path, nil, {'CONTENT_TYPE' => 'application/json'}; last_response  }
+
+  context "when the pacticipant exists" do
+    it "returns a 201 Created" do
+      expect(subject.status).to be 201
+    end
+
+    it "returns a json body" do
+      expect(subject.headers['Content-Type']).to eq "application/hal+json;charset=utf-8"
+    end
+
+    it "returns the label in the body" do
+      expect(response_body_hash).to include expected_response_body
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'pact_broker/api/decorators/embedded_label_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+
+      describe LabelDecorator do
+
+        let(:label) do
+          TestDataBuilder.new
+            .create_consumer("Consumer")
+            .create_label("ios")
+            .and_return(:label)
+        end
+
+        let(:options) { { user_options: { base_url: 'http://example.org' } } }
+
+        subject { JSON.parse EmbeddedLabelDecorator.new(label).to_json(options), symbolize_names: true }
+
+        it "includes the label name" do
+          expect(subject[:name]).to eq "ios"
+        end
+
+        it "includes a link to itself" do
+          expect(subject[:_links][:self][:href]).to eq "http://example.org/pacticipants/Consumer/labels/ios"
+        end
+
+        it "includes the label name" do
+          expect(subject[:_links][:self][:name]).to eq "ios"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require 'pact_broker/api/decorators/label_decorator'
+
+module PactBroker
+  module Api
+    module Decorators
+
+      describe LabelDecorator do
+
+        let(:label) do
+          TestDataBuilder.new
+            .create_consumer("Consumer")
+            .create_label("ios")
+            .and_return(:label)
+        end
+
+        let(:options) { { user_options: { base_url: 'http://example.org' } } }
+
+        subject { JSON.parse LabelDecorator.new(label).to_json(options), symbolize_names: true }
+
+        it "includes the label name" do
+          expect(subject[:name]).to eq "ios"
+        end
+
+        it "includes a link to itself" do
+          expect(subject[:_links][:self][:href]).to eq "http://example.org/pacticipants/Consumer/labels/ios"
+        end
+
+        it "includes the label name" do
+          expect(subject[:_links][:self][:name]).to eq "ios"
+        end
+
+        it "includes a link to the pacticipant" do
+          expect(subject[:_links][:pacticipant][:href]).to eq "http://example.org/pacticipants/Consumer"
+        end
+
+        it "includes the pacticipant name" do
+          expect(subject[:_links][:pacticipant][:name]).to eq "Consumer"
+        end
+      end
+    end
+  end
+end

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

@@ -3,18 +3,20 @@ require 'pact_broker/api/decorators/pacticipant_collection_decorator'
 require 'pact_broker/domain/pacticipant'
 
 module PactBroker
-
   module Api
-
     module Decorators
-
       describe PacticipantCollectionDecorator do
+        let(:options) { {user_options: {base_url: 'http://example.org'} } }
+        let(:pacticipants) { [] }
+        let(:json) { PacticipantCollectionDecorator.new(pacticipants).to_json(options) }
 
-        subject { JSON.parse PacticipantCollectionDecorator.new(pacticipants).to_json, symbolize_names: true }
+        subject { JSON.parse json, symbolize_names: true }
 
-        context "with no pacticipants" do
-          let(:pacticipants) { [] }
+        it "includes a link to find pacticipants by label" do
+          expect(subject[:_links][:'pb:pacticipants-with-label'][:href]).to match %r{http://.*label/{label}}
+        end
 
+        context "with no pacticipants" do
           it "doesn't blow up" do
             subject
           end
@@ -25,11 +27,35 @@ module PactBroker
           let(:pacticipants) { [pacticipant] }
 
           it "displays a list of pacticipants" do
-            expect(subject[:pacticipants]).to be_instance_of(Array)
-            expect(subject[:pacticipants].size).to eq 1
+            expect(subject[:_embedded][:pacticipants]).to be_instance_of(Array)
+            expect(subject[:_embedded][:pacticipants].size).to eq 1
           end
         end
+      end
+
+      describe DeprecatedPacticipantCollectionDecorator do
+        let(:options) { {user_options: {base_url: 'http://example.org'} } }
+        let(:pacticipant) { PactBroker::Domain::Pacticipant.new(name: 'Name', created_at: DateTime.new, updated_at: DateTime.new)}
+        let(:pacticipants) { [pacticipant] }
+        let(:json) { DeprecatedPacticipantCollectionDecorator.new(pacticipants).to_json(options) }
+
+        subject { JSON.parse json, symbolize_names: true }
+
+        it "includes the pacticipants under the _embedded key" do
+          expect(subject[:_embedded][:pacticipants]).to be_instance_of(Array)
+        end
+
+        it "includes the pacticipants under the pacticipants key" do
+          expect(subject[:pacticipants]).to be_instance_of(Array)
+        end
+
+        it "includes a deprecation warning in the pacticipants links" do
+          expect(subject[:_links][:pacticipants].first[:name]).to include "DEPRECATED"
+        end
 
+        it "includes a deprecation warning in the non-embedded pacticipant title" do
+          expect(subject[:pacticipants].first[:title]).to include "DEPRECATED"
+        end
       end
     end
   end