pact_broker 1.0.0 → 1.1.0

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

@@ -23,7 +23,7 @@ module PactBroker::Api
       end
 
       def allowed_methods
-        ["GET", "PATCH"]
+        ["GET", "PATCH", "DELETE"]
       end
 
       def known_methods
@@ -32,21 +32,30 @@ module PactBroker::Api
 
       def from_json
         if @pacticipant
-          @pacticipant = pacticipant_service.update params.merge(name: identifier_from_path[:name])
+          @pacticipant = pacticipant_service.update params.merge(name: pacticipant_name)
         else
-          @pacticipant = pacticipant_service.create params.merge(name: identifier_from_path[:name])
-          response.headers["Location"] = pacticipant_url(resource_url, @pacticipant)
+          @pacticipant = pacticipant_service.create params.merge(name: pacticipant_name)
+          response.headers["Location"] = pacticipant_url(base_url, @pacticipant)
         end
         response.body = to_json
       end
 
       def resource_exists?
-        @pacticipant = pacticipant_service.find_pacticipant_by_name(identifier_from_path[:name])
+        @pacticipant = pacticipant_service.find_pacticipant_by_name(pacticipant_name)
         @pacticipant != nil
       end
 
+      def delete_resource
+        pacticipant_service.delete pacticipant_name
+        true
+      end
+
       def to_json
-        PactBroker::Api::Decorators::PacticipantRepresenter.new(@pacticipant).to_json(base_url: resource_url)
+        PactBroker::Api::Decorators::PacticipantRepresenter.new(@pacticipant).to_json(base_url: base_url)
+      end
+
+      def pacticipant_name
+        identifier_from_path[:name]
       end
 
     end

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

@@ -19,7 +19,7 @@ module PactBroker::Api
       end
 
       def generate_json pacticipants
-        PactBroker::Api::Decorators::PacticipantCollectionRepresenter.new(pacticipants).to_json(base_url: resource_url)
+        PactBroker::Api::Decorators::PacticipantCollectionRepresenter.new(pacticipants).to_json(base_url: base_url)
       end
 
     end

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

@@ -21,7 +21,7 @@ module PactBroker::Api
       def from_json
         unless @tag
           @tag = tag_service.create identifier_from_path
-          response.headers["Location"] = tag_url(resource_url, @tag)
+          response.headers["Location"] = tag_url(base_url, @tag)
         end
         response.body = generate_json @tag
       end
@@ -35,7 +35,7 @@ module PactBroker::Api
       end
 
       def generate_json tag
-        PactBroker::Api::Decorators::TagDecorator.new(tag).to_json(base_url: resource_url)
+        PactBroker::Api::Decorators::TagDecorator.new(tag).to_json(base_url: base_url)
       end
 
     end

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

@@ -0,0 +1,44 @@
+require 'pact_broker/services'
+require 'pact_broker/api/decorators/webhook_decorator'
+
+module PactBroker::Api
+
+  module Resources
+
+    class Webhook < BaseResource
+
+      def content_types_provided
+        [["application/hal+json", :to_json]]
+      end
+
+      def allowed_methods
+        ["GET", "DELETE"]
+      end
+
+      def resource_exists?
+        !webhook.nil?
+      end
+
+      def to_json
+        Decorators::WebhookDecorator.new(webhook).to_json(base_url: base_url)
+      end
+
+      def delete_resource
+        webhook_service.delete_by_uuid uuid
+        true
+      end
+
+      private
+
+      def webhook
+        @webhook ||= webhook_service.find_by_uuid uuid
+      end
+
+      def uuid
+        identifier_from_path[:uuid]
+      end
+
+    end
+  end
+
+end

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

@@ -0,0 +1,43 @@
+require 'pact_broker/services'
+require 'pact_broker/api/decorators/webhook_execution_result_decorator'
+
+module PactBroker
+  module Api
+
+    module Resources
+
+      class WebhookExecution < BaseResource
+
+        def allowed_methods
+          ["POST"]
+        end
+
+        def process_post
+          webhook_execution_result = webhook_service.execute_webhook_now webhook
+          response.headers['Content-Type'] = 'application/hal+json'
+          response.body = post_response_body webhook_execution_result
+          webhook_execution_result.success? ? true : 500
+        end
+
+        def resource_exists?
+          !webhook.nil?
+        end
+
+        private
+
+        def post_response_body webhook_execution_result
+          Decorators::WebhookExecutionResultDecorator.new(webhook_execution_result).to_json(base_url: base_url, webhook: webhook)
+        end
+
+        def webhook
+          @webhook ||= webhook_service.find_by_uuid uuid
+        end
+
+        def uuid
+          identifier_from_path[:uuid]
+        end
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,29 @@
+require 'pact_broker/services'
+require 'pact_broker/api/decorators/webhooks_decorator'
+
+module PactBroker::Api
+
+  module Resources
+
+    class Webhooks < BaseResource
+
+      def content_types_provided
+        [["application/hal+json", :to_json]]
+      end
+
+      def allowed_methods
+        ["GET"]
+      end
+
+      def to_json
+        Decorators::WebhooksDecorator.new(webhooks).to_json(decorator_context(resource_title: "Webhooks"))
+      end
+
+      def webhooks
+        webhook_service.find_all
+      end
+
+    end
+  end
+
+end

data/lib/pact_broker/app.rb

@@ -28,6 +28,7 @@ module PactBroker
 
     def post_configure
       PactBroker.logger = configuration.logger
+      PactBroker::DB.connection = configuration.database_connection
 
       if configuration.auto_migrate_db
         logger.info "Migrating database"
@@ -42,23 +43,32 @@ module PactBroker
 
       @app.use Rack::Static, :urls => ["/stylesheets", "/images", "/css", "/fonts", "/js", "/javascripts"], :root => PactBroker.project_root.join("public")
 
-      if configuration.use_hal_browser
-        logger.info "Mounting HAL browser"
-        @app.use Rack::HalBrowser::Redirect, :exclude => ['/trace']
-      else
-        logger.info "Not mounting HAL browser"
-      end
-
       logger.info "Mounting UI"
       require 'pact_broker/ui/controllers/relationships'
+      require 'pact_broker/ui/controllers/groups'
+      require 'pact_broker/doc/controllers/app'
 
       ui = Rack::Builder.new {
+
+        use HtmlFilter
+
         map "/ui/relationships" do
           run PactBroker::UI::Controllers::Relationships
         end
+
+        map "/groups" do
+          run PactBroker::UI::Controllers::Groups
+        end
+
+        map "/doc" do
+          run PactBroker::Doc::Controllers::App
+        end
+
         map "/" do
           run lambda { |env|
-            if (env['PATH_INFO'] == "/" || env['PATH_INFO'] == "") && !env['HTTP_ACCEPT'].include?("json")
+            # A request for the root path in the browser (not the json index) should
+            # redirect to ui/relationships
+            if (env['PATH_INFO'].chomp("/") == "")
               [303, {'Location' => 'ui/relationships'},[]]
             else
               [404, {},[]]
@@ -67,6 +77,13 @@ module PactBroker
         end
       }
 
+      if configuration.use_hal_browser
+        logger.info "Mounting HAL browser"
+        @app.use Rack::HalBrowser::Redirect, :exclude => ['/trace', '/network-graph', '/ui']
+      else
+        logger.info "Not mounting HAL browser"
+      end
+
       logger.info "Mounting PactBroker::API"
       require 'pact_broker/api'
 
@@ -77,6 +94,27 @@ module PactBroker
       end
 
     end
+
+    class HtmlFilter
+
+      def initialize app
+        @app = app
+      end
+
+      def call env
+        if accepts_html_and_not_json_or_csv env
+          @app.call(env)
+        else
+          [404, {},[]]
+        end
+      end
+
+      def accepts_html_and_not_json_or_csv env
+        accept = env['HTTP_ACCEPT'] || ''
+        accept.include?("html") && !accept.include?("json") && !accept.include?("csv")
+      end
+
+    end
   end
 
 end

data/lib/pact_broker/db.rb

@@ -1,10 +1,20 @@
 require 'sequel'
 
+Sequel.datetime_class = DateTime
+
 module PactBroker
   module DB
 
     MIGRATIONS_DIR = File.expand_path("../../../db/migrations", __FILE__)
 
+    def self.connection= connection
+      @connection = connection
+    end
+
+    def self.connection
+      @connection
+    end
+
     def self.run_migrations database_connection
       Sequel.extension :migration
       Sequel::Migrator.run(database_connection, PactBroker::DB::MIGRATIONS_DIR)

data/lib/pact_broker/doc/controllers/app.rb

@@ -0,0 +1,32 @@
+require 'padrino'
+require 'redcarpet'
+
+Tilt.prefer Tilt::RedcarpetTemplate
+
+module PactBroker
+  module Doc
+    module Controllers
+      class App < Padrino::Application
+
+        set :root, File.join(File.dirname(__FILE__), '..')
+        set :show_exceptions, true
+
+        helpers do
+          def resource_exists? rel_name
+            File.exist? File.join(self.class.root, 'views', "#{rel_name}.markdown")
+          end
+        end
+
+        get ":rel_name" do
+          rel_name = params[:rel_name]
+          if resource_exists? rel_name
+            markdown rel_name.to_sym, {:layout_engine => :haml, layout: :'layouts/main'}, {}
+          else
+            response.status = 404
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/pact_broker/doc/views/latest-pacts.markdown

@@ -0,0 +1,3 @@
+# Latest pacts
+
+A list of the latest pacts for each consumer/provider pair. The "latest" is determined by inspecting the consumer version used when each pact was published.

data/lib/pact_broker/doc/views/layouts/main.haml

@@ -0,0 +1,5 @@
+%html
+  %head
+    %link{rel: 'stylesheet', href: '/css/bootstrap.min.css'}
+  %body{style: 'margin:20px'}
+    = yield

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

@@ -0,0 +1,10 @@
+# Pacticipants
+
+"Pacticipant" - a party that participates in a pact (ie. a Consumer or a Provider).
+
+### Creating participants
+Participants are created automatically when a pact is published to the pact broker. The name is based on the URL compontents used to publish the pact (ie. /pacts/provider/$PROVIDER\_NAME/consumer/$CONSUMER\_NAME/version/$CONSUMER\_VERSION), not on the contents of the pact, as the Pact Broker is designed to be agnostic of the actual pact format as much as possible.
+
+
+### Deleting pacticipants
+Deleting a pacticipant will delete all associated pacts, versions, tags and webhooks. To delete a pacticipant, send a DELETE request to the relevant pacticipant URL via the HAL browser.

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

@@ -0,0 +1,8 @@
+# Pact Broker
+
+The Pact Broker is a repository for pacts. It provides a way to share pacts between consumer and provider projects as well as providing:
+
+* autogenerated documentation
+* autogenerated network diagrams
+* webhooks to trigger the provider build when a pact is published
+* the ability to tag a pact (ie. "prod") so a provider can verify itself against a fixed version of a pact to ensure backwards compatibility.

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

@@ -0,0 +1,48 @@
+# Webhooks
+
+### Creating
+
+1. To create a webhook, 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".
+
+An example webhook to trigger a Bamboo job.
+
+    {
+      "request": {
+        "method": "POST",
+        "url": "http://master.ci.my.domain:8085/rest/api/latest/queue/SOME-PROJECT?os_authType=basic",
+        "username": "username",
+        "password": "password",
+        "headers": {
+          "Accept": "application/json"
+        }
+      }
+    }
+
+A request body can be specified as well.
+
+    {
+      "request": {
+        "method": "POST",
+        "url": "http://example.org/something",
+        "body": {
+          "some" : "json"
+        }
+      }
+    }
+
+**BEWARE** The password can be reverse engineered from the database, so make a separate account for the Pact Broker to use, don't use your personal account!
+
+### Testing
+
+To test a webhook, navigate to the webhook in the HAL browser, then make a POST request to the "execute" relation. The response or error will be shown in the window.
+
+### Deleting
+
+Send a DELETE request to the webhook URL.
+
+### Updating
+
+Currently not implemented. You will need to delete and re-create the webhook.

data/lib/pact_broker/functions/groupify.rb

@@ -0,0 +1,39 @@
+require 'pact_broker/models/group'
+
+=begin
+  Splits all relationships up into groups of non-connecting relationships.
+=end
+
+module PactBroker
+
+  module Functions
+
+    class Groupify
+
+      def self.call relationships
+        recurse_groups([], relationships.dup).collect{ | group | Models::Group.new(group) }
+      end
+
+      def self.recurse_groups groups, relationship_pool
+        if relationship_pool.empty?
+          groups
+        else
+          first, *rest = *relationship_pool
+          group = recurse first, rest
+          recurse_groups(groups + [group], relationship_pool - group)
+        end
+      end
+
+      def self.recurse relationship, relationship_pool
+        connected_relationships = relationship_pool.select{ | candidate| candidate.connected?(relationship) }
+        if connected_relationships.empty?
+          [relationship]
+        else
+          ([relationship] + connected_relationships.map{| connected_relationship| recurse(connected_relationship, relationship_pool - connected_relationships)}.flatten).uniq
+        end
+      end
+
+    end
+
+  end
+end