pact_broker 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NmJjZTUwYWI2YzdiZmM0OTc5ODQ4NWI5MWVjYTBlNTU5N2ZiNTUyNA==
-  data.tar.gz: !binary |-
-    NDQ0NzY2ZGJiODViN2ZkZTZlNjBkNTJiNGRkNzJkODQ5MzU0MWFiMA==
+SHA1:
+  metadata.gz: cedb84e67d02ce7d28e31fdc09aca4c39fa19e98
+  data.tar.gz: 4fa9e9b2022aa04df878b8cd6769a9d9ad36e1a6
 SHA512:
-  metadata.gz: !binary |-
-    NDAzMWI0ZGM2ZTQxZTZmOGQ1ZmE3MjczMWU1NTE1OTE5NmExOGNjMjc2YzI4
-    NGRlZThkNjBlY2M2ZDdhM2M4YWI3N2E2MGQ0MTgzNjhiOGIxY2NmN2NkN2Vh
-    MzZjZTU3OTMzMGZhOTMxYjIzYjYwODc3NzAyMDJhYjFjYTEwNGU=
-  data.tar.gz: !binary |-
-    YTFjYmI0YmUxY2JhMzE3NmMxODkyOTM0ZWQxNWIzMTg0ZDZkNTFlOGE1OTJj
-    ODlhY2Q5NWQ1Y2JjMmU3OWQyOTQzYzcwYmIwM2NjZTllNmE2YjE5M2NhMTNk
-    ZWYyMjM1YjcxZGJmMjk1YWVhNGJmNzgyZjVjY2U3YmFmMTczYWE=
+  metadata.gz: 7f756c1fc77440d7805ceeda97220d64dd1ad1f8f0fd940eb9f2be76f683bc5b7bb3c5ea8e4f6a8fd3a65f9b39951f58faba1537722ac5e6c3ff40b84d6310e5
+  data.tar.gz: a4ed85b29750424cc833bfe1bec6b43805304f2c006bd61fe0612eabd703a38110317a7a5d74a6900e429337db60def0a344d829ff5436ae05688504ae4ed355

data/.gitignore

@@ -17,7 +17,6 @@ reports
 # YARD artifacts
 .yardoc
 _yardoc
-doc/
 .bin
 
 # Editor files

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format documentation
+--require spec_helper

data/CHANGELOG.md

@@ -2,6 +2,53 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+#### 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)
+* 9288c98 - Saving password in Base64 just so it is not plain text. WIP (Beth, Tue Aug 19 09:14:53 2014 +1000)
+* 6a40151 - Added username and password to webhook request (Beth, Mon Aug 18 22:02:48 2014 +1000)
+* 6eb0d70 - Added mouseover for relationship paths (Beth, Fri Aug 15 15:38:56 2014 +1000)
+* 8e916fc - Added clickable relationship links (Beth, Fri Aug 15 11:37:57 2014 +1000)
+* 7fc6418 - Added webhook HAL documentation. (Beth, Tue Aug 12 17:17:08 2014 +1000)
+* 434fbe8 - Added useful rels to help navigate between webhook resources. (Beth, Tue Aug 12 09:14:08 2014 +1000)
+* 959675b - Adding description to webhooks link (Beth, Mon Aug 11 21:46:39 2014 +1000)
+* 9cbf2b1 - Added webhook test execution endpoint. (Beth, Mon Aug 11 21:37:47 2014 +1000)
+* 6bdfd16 - Webhooks belonging to a pacticipant will be deleted when the pacticipant is deleted. (Beth, Mon Aug 11 14:16:50 2014 +1000)
+* 27572e2 - WIP - ensuring webhook executes when a pact version is overridden and changed. (Beth, Fri Aug 8 16:59:48 2014 +1000)
+* 2469ad5 - Adding webhook DELETE (Beth, Fri Aug 8 16:45:48 2014 +1000)
+* 7ae9b59 - Adding code to execte webhook and to detect when pact content has changed (Beth, Fri Aug 8 10:13:16 2014 +1000)
+* c8289fb - Adding /webhooks resource (Beth, Thu Aug 7 16:57:27 2014 +1000)
+* 2d818ee - Added endpoint to retrieve webhook by UUID (Beth, Thu Aug 7 14:35:04 2014 +1000)
+* 25c3866 - Completed web hooks resource. (Beth, Wed Aug 6 11:38:39 2014 +1000)
+* a59e46e - Started work on webhooks (Beth, Sat Aug 2 18:12:16 2014 +1000)
+* 56d9ae5 - Return 400 error for pacts with invalid JSON (Beth, Sat Aug 2 07:08:39 2014 +1000)
+* 884aa06 - Added links from relationship page to group. (Beth, Thu Jul 31 20:05:55 2014 +1000)
+* 642570e - Adding group UI endpoint. (Beth, Thu Jul 31 17:36:37 2014 +1000)
+* 3609028 - Adding a group resource (Beth, Mon Jul 28 09:11:46 2014 +1000)
+* 437df9e - Added created_at and updated_at timestamps to all objects. (Beth, Fri Jul 25 16:53:46 2014 +1000)
+* 594f160 - Turning exception showing on (Beth, Fri Jul 25 08:59:57 2014 +1000)
+* 7250a51 - Updated to pact 1.3.0 (Beth, Thu Jul 24 12:13:38 2014 +1000)
+* 9824247 - Implemented DELETE for pacticipant resource (Beth, Tue Jun 10 17:32:26 2014 +1000)
+* 1c65600 - Swapped links and properties order in the HAL browser, because the documents are large, and scrolling to the bottom of the page to click around is annoying. (Beth, Fri Jun 6 10:19:47 2014 +1000)
+
+#### 1.0.0 (2014-06-06)
+
+* ed25adb - Sorting relationships by consumer name, then provider name. (Beth, Wed May 21 15:13:39 2014 +1000)
+* 7aae530 - Releasing version 1.0.0.alpha3 (Beth, Mon May 19 15:44:33 2014 +1000)
+* 53e24cb - Increased json_content size from text to mediumtext (16MB) (Beth, Mon May 19 15:43:32 2014 +1000)
+* 1f65546 - Releasing 1.0.0.alpha2 (Beth, Mon May 19 12:49:42 2014 +1000)
+* 3714ab5 - Adding network graph spike files (Beth, Sat May 17 21:12:04 2014 +1000)
+* 73e2b81 - Implemented finding latest pact by tag (Beth, Sat May 17 17:56:58 2014 +1000)
+* bfa62cc - Changed /pact to /pacts because it is more RESTy (Beth, Sat May 17 12:22:55 2014 +1000)
+* 91c8fab - Releasing 1.0.0.alpha1 (Beth, Fri May 9 15:21:13 2014 +1000)
+* f497f13 - Made HtmlPactRenderer configurable in case shokkenki want to use the PactBroker ;) (Beth, Fri May 9 14:20:38 2014 +1000)
+* 5343019 - Added Relationship UI (Beth, Fri May 9 12:23:30 2014 +1000)
+* f7270a6 - Added HTML rendering of latest pact. Added /relationships CSV endpoint. (Beth, Thu May 8 16:17:52 2014 +1000)
+* 264e16b - Created nice interface for making a pact_broker instance (Beth, Sat Apr 26 16:43:07 2014 +1000)
+* 8001792 - Added HAL browser (Beth, Wed Apr 23 13:31:25 2014 +1000)
+* 8c94d1f - Creating example app (Beth, Wed Apr 23 13:06:40 2014 +1000)
+
+
 #### 0.0.10 (2014-06-06)
 
   * 24daeea - Added task to delete pacticipant (bethesque Tue May 20 11:59:10 2014 +1000)

data/README.md

@@ -21,10 +21,12 @@ See the [Pact Broker Client](https://github.com/bethesque/pact_broker-client) fo
 
 ## 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
+* 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)
+* Modify the config.ru and Gemfile as desired (eg. choose database driver gem, set your database credentials)
 * Run `bundle`
 * Run `bundle exec rackup`
 * Open [http://localhost:9292](http://localhost:9292) and you should see the HAL browser.
 
-For production usage, use a web application server like Phusion Passenger to serve the Pact Broker application.
+For production usage, use a web application server like [Phusion Passenger](https://www.phusionpassenger.com) to serve the Pact Broker application.

data/config.ru

@@ -5,13 +5,11 @@ require 'rack/hal_browser'
 require 'pact_broker/ui/controllers/relationships'
 
 
-use Rack::Static, :urls => ["/stylesheets", "/css", "/fonts", "/js"], :root => "public"
-use Rack::HalBrowser::Redirect, :exclude => ['/diagnostic', '/trace','/index','/force.csv']
+use Rack::Static, :urls => ["/stylesheets", "/css", "/fonts", "/js", "/javascripts"], :root => "public"
+use Rack::HalBrowser::Redirect, :exclude => ['/diagnostic', '/trace','/index']
 
 run Rack::URLMap.new(
   '/ui/relationships' => PactBroker::UI::Controllers::Relationships,
-  '/index.html' => Rack::File.new("#{File.dirname(__FILE__)}/assets/index.html"),
-  '/index2.html' => Rack::File.new("#{File.dirname(__FILE__)}/assets/index2.html"),
-  '/force.csv' => Rack::File.new("#{File.dirname(__FILE__)}/assets/force.csv"),
+  '/network-graph' => Rack::File.new("#{File.dirname(__FILE__)}/public/Network Graph REA.html"),
   '/' => PactBroker::API,
 )

data/db/migrations/09_add_timestamps.rb

@@ -0,0 +1,12 @@
+Sequel.migration do
+  change do
+    add_column(:pacts, :created_at, DateTime)
+    add_column(:pacts, :updated_at, DateTime)
+    add_column(:tags, :created_at, DateTime)
+    add_column(:tags, :updated_at, DateTime)
+    add_column(:versions, :created_at, DateTime)
+    add_column(:versions, :updated_at, DateTime)
+    add_column(:pacticipants, :created_at, DateTime)
+    add_column(:pacticipants, :updated_at, DateTime)
+  end
+end

data/db/migrations/10_populate_timestamps.rb

@@ -0,0 +1,15 @@
+Sequel.migration do
+  up do
+    self[:pacts].update(:created_at => DateTime.now, :updated_at => DateTime.now)
+    self[:versions].update(:created_at => DateTime.now, :updated_at => DateTime.now)
+    self[:pacticipants].update(:created_at => DateTime.now, :updated_at => DateTime.now)
+    self[:tags].update(:created_at => DateTime.now, :updated_at => DateTime.now)
+  end
+
+  down do
+    self[:pacts].update(:created_at => nil, :updated_at => nil)
+    self[:versions].update(:created_at => nil, :updated_at => nil)
+    self[:pacticipants].update(:created_at => nil, :updated_at => nil)
+    self[:tags].update(:created_at => nil, :updated_at => nil)
+  end
+end

data/db/migrations/11_made_timestamps_mandatory.rb

@@ -0,0 +1,20 @@
+Sequel.migration do
+  change do
+    alter_table(:tags) do
+      set_column_not_null(:created_at)
+      set_column_not_null(:updated_at)
+    end
+    alter_table(:pacticipants) do
+      set_column_not_null(:created_at)
+      set_column_not_null(:updated_at)
+    end
+    alter_table(:versions) do
+      set_column_not_null(:created_at)
+      set_column_not_null(:updated_at)
+    end
+    alter_table(:pacts) do
+      set_column_not_null(:created_at)
+      set_column_not_null(:updated_at)
+    end
+  end
+end

data/db/migrations/12_create_webhooks_table.rb

@@ -0,0 +1,21 @@
+Sequel.migration do
+  change do
+    create_table(:webhooks) do
+      primary_key :id
+      String :uuid, null: false, unique: true, unique_constraint_name: 'uq_webhook_uuid'
+      String :method, null: false
+      String :url, null: false
+      String :body
+      Boolean :is_json_request_body
+      foreign_key :consumer_id, :pacticipants, null: false, foreign_key_constraint_name: 'fk_webhooks_consumer'
+      foreign_key :provider_id, :pacticipants, null: false, foreign_key_constraint_name: 'fk_webhooks_provider'
+    end
+
+    create_table(:webhook_headers) do
+      String :name, null: false
+      String :value
+      foreign_key :webhook_id, :webhooks, null: false, foreign_key_constraint_name: 'fk_webhookheaders_webhooks'
+      primary_key [:webhook_id, :name], :name=>:webhooks_headers_pk
+    end
+  end
+end

data/db/migrations/13_add_columns_to_webhooks.rb

@@ -0,0 +1,8 @@
+Sequel.migration do
+  change do
+    add_column(:webhooks, :created_at, DateTime)
+    add_column(:webhooks, :updated_at, DateTime)
+    add_column(:webhooks, :username, String)
+    add_column(:webhooks, :password, String)
+  end
+end

data/lib/pact_broker/api.rb

@@ -6,6 +6,11 @@ require 'pact_broker/api/resources/pacticipants'
 require 'pact_broker/api/resources/tag'
 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/webhooks'
+require 'pact_broker/api/resources/webhook'
+require 'pact_broker/api/resources/webhook_execution'
 
 require 'webmachine/adapters/rack'
 
@@ -27,6 +32,15 @@ module PactBroker
         add ['pacticipants', :name], Api::Resources::Pacticipant
         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
+        # If the HTML and the CSV resources are both requested by the browser,
+        # Chrome gets confused by the content types, and when you click back, it tries to load the CSV
+        # instead of the HTML page. So we have to give it a different URL.
+        add ['groups', :pacticipant_name, 'csv'], Api::Resources::Group
+        add ['webhooks', 'provider', :provider_name, 'consumer', :consumer_name ], Api::Resources::PactWebhooks
+        add ['webhooks', :uuid ], Api::Resources::Webhook
+        add ['webhooks', :uuid, 'execute' ], Api::Resources::WebhookExecution
+        add ['webhooks'], Api::Resources::Webhooks
         add [], Api::Resources::Index
       end
     end

data/lib/pact_broker/api/decorators.rb

@@ -3,5 +3,5 @@ require 'pact_broker/api/decorators/pacticipant_collection_decorator'
 require 'pact_broker/api/decorators/version_decorator'
 require 'pact_broker/api/decorators/pact_collection_decorator'
 require 'pact_broker/api/decorators/pact_pacticipant_decorator'
-require 'pact_broker/api/decorators/pact_decorator'
-require 'pact_broker/api/decorators/tag_decorator'
+require 'pact_broker/api/decorators/pact_details_decorator'
+require 'pact_broker/api/decorators/tag_decorator'

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

@@ -1,6 +1,7 @@
 require 'roar/decorator'
 require 'roar/representer/json/hal'
 require 'pact_broker/api/pact_broker_urls'
+require 'pact_broker/api/decorators/decorator_context'
 
 module PactBroker
 
@@ -15,4 +16,4 @@ module PactBroker
       end
     end
   end
-end
+end

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

@@ -0,0 +1,21 @@
+require_relative 'base_decorator'
+require_relative 'version_decorator'
+
+module PactBroker
+
+  module Api
+
+    module Decorators
+
+      class BasicPacticipantRepresenter < BaseDecorator
+
+        property :name
+
+        link :self do | options |
+          pacticipant_url(options[:base_url], represented)
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module PactBroker
+  module Api
+    module Decorators
+
+      class DecoratorContext < Hash
+
+        attr_reader :base_url, :resource_url, :resource_title
+
+        def initialize base_url, resource_url, options
+          @base_url = base_url
+          @resource_url = resource_url
+          @resource_title = options[:resource_title]
+          merge!(options)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-require_relative 'pact_decorator'
+require_relative 'pact_details_decorator'
 
 module PactBroker
 
@@ -6,7 +6,7 @@ module PactBroker
 
     module Decorators
 
-      class LatestPactDecorator < PactDecorator
+      class LatestPactDecorator < PactDetailsDecorator
 
         links :self do | options |
           [

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

@@ -1,5 +1,5 @@
 require_relative 'base_decorator'
-require_relative 'pact_pacticipant_decorator'
+require 'pact_broker/json'
 
 module PactBroker
 
@@ -9,11 +9,18 @@ module PactBroker
 
       class PactDecorator < BaseDecorator
 
-        property :consumer, :extend => PactBroker::Api::Decorators::PactPacticipantRepresenter, :embedded => true
-        property :provider, :extend => PactBroker::Api::Decorators::PactPacticipantRepresenter, :embedded => true
+        property :createdAt, getter: lambda { |_|  created_at.xmlschema }
+        property :updatedAt, getter: lambda { |_| updated_at.xmlschema }
 
-        link :self do | options |
-          pact_url(options[:base_url], represented)
+        def to_hash(options = {})
+          ::JSON.parse(represented.json_content, PACT_PARSING_OPTIONS).merge super
+        end
+
+        link :'pact-webhooks' do | options |
+          {
+            title: 'Webhooks for this pact',
+            href: webhooks_for_pact_url(represented.consumer, represented.provider, options.fetch(:base_url))
+          }
         end
 
       end

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

@@ -0,0 +1,22 @@
+require_relative 'base_decorator'
+require_relative 'pact_pacticipant_decorator'
+
+module PactBroker
+
+  module Api
+
+    module Decorators
+
+      class PactDetailsDecorator < BaseDecorator
+
+        property :consumer, :extend => PactBroker::Api::Decorators::PactPacticipantRepresenter, :embedded => true
+        property :provider, :extend => PactBroker::Api::Decorators::PactPacticipantRepresenter, :embedded => true
+
+        link :self do | options |
+          pact_url(options[:base_url], represented)
+        end
+
+      end
+    end
+  end
+end

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

@@ -10,15 +10,17 @@ module PactBroker
       class PacticipantRepresenter < BaseDecorator
 
         property :name
-        property :repository_url
+        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, :class => PactBroker::Models::Version, :extend => PactBroker::Api::Decorators::VersionRepresenter, :embedded => true
 
         link :self do | options |
           pacticipant_url(options[:base_url], represented)
         end
 
-        link :latest_version do | options |
+        link 'latest-version' do | options |
           latest_version_url(options[:base_url], represented)
         end
 
@@ -29,4 +31,4 @@ module PactBroker
       end
     end
   end
-end
+end

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

@@ -1,4 +1,5 @@
 require 'csv'
+require 'set'
 
 module PactBroker
 
@@ -10,16 +11,37 @@ module PactBroker
 
         def initialize pacts
           @pacts = pacts
+          @relationships = pacts.collect{|pact| PactBroker::Models::Relationship.new(pact.consumer,pact.provider)}
         end
 
         def to_csv
+          hash = {}
+          pacticipants = @relationships.collect{|r| r.pacticipants}.flatten.uniq
+
+          @relationships.each do | relationship |
+            hash[relationship.consumer.id] ||= pacticipant_array(relationship.consumer, hash.size + 1)
+            hash[relationship.provider.id] ||= pacticipant_array(relationship.provider, hash.size + 1)
+            hash[relationship.consumer.id] << relationship.provider.id
+          end
+
+          max_length = hash.values.collect{|array| array.size}.max
+
+          hash.values.each do | array |
+            while array.size < max_length
+              array << 0
+            end
+          end
 
           CSV.generate do |csv|
-            csv << ["source", "target", "weight"]
-            pacts.each do | pact |
-              csv << [pact.consumer.name, pact.provider.name, 1]
+            hash.values.each do | array |
+              csv << array
             end
           end
+
+        end
+
+        def pacticipant_array pacticipant, order
+          [pacticipant.id, pacticipant.name, 1, 1, 0, order]
         end
 
         private