pact_broker 1.3.1 → 1.3.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2efe6a0f09d53fcd3eda935e760ffdddf06c39c
-  data.tar.gz: 35000029a9b755d9c4f14be9ef900864dcb50a51
+  metadata.gz: 73c13ba9bbfe6c1ec7ad64a93f145bd164894f13
+  data.tar.gz: 1938f955d3f2d67b4b0929040dfc6fbfb3645c47
 SHA512:
-  metadata.gz: f5852a4d2cd9bedd28fc5dff28da6d6464d9936a1cb9e693956364d7c6a0c421b364af5be6d3ff229dd24ac36462b8af530ae01209f433dd971574cd87691e8a
-  data.tar.gz: a2224dbd381b2313175752bc002c2d118363c90fdd9a08b54f20d6a868dd1599c334c3574fdeac5fc1c6cf3fff99b46c226695ee4bb7a4d2f6a3e24f29430b57
+  metadata.gz: 9c539c2e7434b3572172aeef0b22de80ab5bddd506e48e6819d77d6579bc6f2935b8b53d5c63862e9ef7cff63ee56dd6337267033baa5dafbb5b76731e8e055f
+  data.tar.gz: fefad6d9bec291eaba9e99a3e52bb2632d25e900e6bf275d0b4dbd0ded33ec9388daf0e3054739c47c39e41d6d69c532c6542506df1678672867e5ddb683bed7

data/CHANGELOG.md

@@ -2,6 +2,17 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+#### 1.3.2.rc1 (2014-12-03)
+
+* a2413f4 - Stop Padrino trying to create a log file in the gem directory https://github.com/bethesque/pact_broker/issues/13 (Beth, Wed Dec 3 13:16:06 2014 +1100)
+* abf9459 - Added DELETE endpoint for pact resource (Beth, Wed Nov 19 17:45:34 2014 +1100)
+* 1d01937 - Set default encoding to utf-8 in example app. This is required for the sha foreign key to work between the pact table and the pact_version_content table. (Beth, Tue Nov 18 22:35:51 2014 +1100)
+* 9e3401e - Save all the space! Reuse the same pact_version_content when one with the same sha1 already exists in the database. (Beth, Tue Nov 18 20:27:59 2014 +1100)
+* 84ab8ad - Creating example pact_broker_database.sqlite3 with the Zoo App/Animal Service pact (Beth, Tue Nov 18 17:30:25 2014 +1100)
+* d767b0d - Fixed query for all pacts when pact has more than one tag (Beth, Mon Nov 17 20:44:01 2014 +1100)
+* 21563c6 - Changed date to use day name and month name instead of numbers (Beth, Wed Nov 12 16:19:19 2014 +1100)
+* 7766b77 - Added count to relationships page. (Beth, Mon Nov 3 11:06:05 2014 +1100)
+
 #### 1.3.1 (2014-10-23)
 
 * e61b40e - Added Travis configuration. (Beth, Fri Oct 17 16:32:26 2014 +1100)

data/README.md

@@ -14,6 +14,17 @@ The Pact Broker:
 
 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.
 
+### Screenshots
+
+#### Index
+<img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/index.png"/>
+
+#### Autogenerated documentation
+<img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/autogenerated_documentation.png"/>
+
+#### Network diagram
+<img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/network_diagram.png"/>
+
 ## Documentation
 
 See the [wiki](https://github.com/bethesque/pact_broker/wiki) for documentation.
@@ -25,6 +36,7 @@ See the [wiki](https://github.com/bethesque/pact_broker/wiki) for documentation.
 * 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, set your database credentials)
+* Please ensure you use `encoding: 'utf8'` in your Sequel options to avoid encoding issues.
 * Run `bundle`
 * Run `bundle exec rackup`
 * Open [http://localhost:9292](http://localhost:9292) and you should see the HAL browser.

data/db/migrations/07_increase_json_content_length.rb

@@ -1,13 +1,9 @@
+require_relative 'migration_helper'
+
 Sequel.migration do
   change do
     alter_table(:pacts) do
-      if Sequel::Model.db.adapter_scheme == :postgres
-        set_column_type(:json_content, :text)
-      else
-        # Assume mysql
-        set_column_type(:json_content, :mediumtext)
-      end
+      set_column_type(:json_content, PactBroker::MigrationHelper.large_text_type)
     end
   end
 end
-

data/db/migrations/15_add_value_to_tag.rb.wip

@@ -0,0 +1,5 @@
+Sequel.migration do
+  change do
+    add_column(:tag, :value, String)
+  end
+end

data/db/migrations/15_create_pact_version_content.rb

@@ -0,0 +1,13 @@
+require 'digest/sha1'
+require_relative 'migration_helper'
+
+Sequel.migration do
+  change do
+    create_table(:pact_version_contents) do
+      String :sha, primary_key: true, null: false, primary_key_constraint_name: 'pk_pact_version_contents'
+      String :content, type: PactBroker::MigrationHelper.large_text_type
+      DateTime :created_at, null: false
+      DateTime :updated_at, null: false
+    end
+  end
+end

data/db/migrations/16_add_pact_content_foreign_key_to_pacts.rb

@@ -0,0 +1,10 @@
+require 'digest/sha1'
+require_relative 'migration_helper'
+
+Sequel.migration do
+  change do
+    alter_table(:pacts) do
+      add_foreign_key :pact_version_content_sha, :pact_version_contents, type: String, null: true, foreign_key_constraint_name: 'fk_pact_version_content'
+    end
+  end
+end

data/db/migrations/17_migrate_json_content_to_pact_version_content_table.rb

@@ -0,0 +1,14 @@
+require 'digest/sha1'
+require_relative 'migration_helper'
+
+Sequel.migration do
+  change do
+    self[:pacts].each do | row |
+      sha = Digest::SHA1.hexdigest(row[:json_content])
+      if self[:pact_version_contents].where(sha: sha).count == 0
+        self[:pact_version_contents].insert(sha: sha, content: row[:json_content], created_at: row[:created_at], updated_at: row[:updated_at])
+      end
+      self[:pacts].where(id: row[:id]).update(pact_version_content_sha: sha)
+    end
+  end
+end

data/db/migrations/18_drop_json_content_column_from_pacts.rb

@@ -0,0 +1,14 @@
+require 'digest/sha1'
+require_relative 'migration_helper'
+
+Sequel.migration do
+  change do
+    drop_view(:latest_pacts)
+    drop_view(:latest_pact_consumer_version_orders)
+    drop_view(:all_pacts)
+
+    alter_table(:pacts) do
+      drop_column(:json_content)
+    end
+  end
+end

data/db/migrations/19_make_pact_version_content_sha_not_nullable.rb

@@ -0,0 +1,10 @@
+require 'digest/sha1'
+require_relative 'migration_helper'
+
+Sequel.migration do
+  change do
+    alter_table(:pacts) do
+      set_column_not_null(:pact_version_content_sha)
+    end
+  end
+end

data/db/migrations/20_add_pact_version_content_sha_to_all_pacts_view.rb

@@ -0,0 +1,18 @@
+require 'digest/sha1'
+require_relative 'migration_helper'
+
+Sequel.migration do
+  change do
+    create_or_replace_view(:all_pacts,
+      Sequel::Model.db[:pacts].select(:pacts__id,
+      :c__id___consumer_id, :c__name___consumer_name,
+      :cv__id___consumer_version_id, :cv__number___consumer_version_number, :cv__order___consumer_version_order,
+      :p__id___provider_id, :p__name___provider_name,
+      :pvc__sha___pact_version_content_sha, :pacts__created_at, :pacts__updated_at).
+      join(:versions, {:id => :version_id}, {:table_alias => :cv, implicit_qualifier: :pacts}).
+      join(:pacticipants, {:id => :pacticipant_id}, {:table_alias => :c, implicit_qualifier: :cv}).
+      join(:pacticipants, {:id => :provider_id}, {:table_alias => :p, implicit_qualifier: :pacts}).
+      join(:pact_version_contents, {:sha => :pact_version_content_sha}, {:table_alias => :pvc, implicit_qualifier: :pacts})
+    )
+  end
+end

data/db/migrations/21_recreate_latest_pacts_view.rb

@@ -0,0 +1,21 @@
+require 'digest/sha1'
+require_relative 'migration_helper'
+
+Sequel.migration do
+  change do
+    create_or_replace_view(:latest_pact_consumer_version_orders,
+      "select provider_id, consumer_id, max(consumer_version_order) as latest_consumer_version_order
+      from all_pacts
+      group by provider_id, consumer_id"
+    )
+
+    create_or_replace_view(:latest_pacts,
+      "select ap.*
+      from all_pacts ap
+      inner join latest_pact_consumer_version_orders lp
+      on ap.consumer_id = lp.consumer_id
+           and ap.provider_id = lp.provider_id
+           and ap.consumer_version_order = latest_consumer_version_order"
+    )
+  end
+end

data/db/migrations/migration_helper.rb

@@ -0,0 +1,15 @@
+module PactBroker
+  module MigrationHelper
+
+    extend self
+
+    def large_text_type
+      if Sequel::Model.db.adapter_scheme == :postgres
+        :text
+      else
+        # Assume mysql
+        :mediumtext
+      end
+    end
+  end
+end

data/example/config.ru

@@ -4,7 +4,11 @@ require 'sequel'
 require 'pact_broker'
 
 # Create a real database, and set the credentials for it here
-DATABASE_CREDENTIALS = {database: "pact_broker_database.sqlite3", adapter: "sqlite"}
+# It is highly recommended to set the encoding to utf8 (varchar foreign keys may blow up otherwise)
+DATABASE_CREDENTIALS = {database: "pact_broker_database.sqlite3", adapter: "sqlite", :encoding => 'utf8'}
+
+# Have a look at the Sequel documentation to make decisions about things like connection pooling
+# and connection validation.
 
 app = PactBroker::App.new do | config |
   # change these from their default values if desired

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

@@ -13,7 +13,7 @@ module PactBroker
         include Roar::Representer::JSON::HAL
         include PactBroker::Api::PactBrokerUrls
 
-        collection :pacts, exec_context: :decorator, :class => PactBroker::Models::Pact, :extend => PactBroker::Api::Decorators::LatestPactDecorator
+        collection :pacts, exec_context: :decorator, :class => PactBroker::Domain::Pact, :extend => PactBroker::Api::Decorators::LatestPactDecorator
 
         def pacts
           represented.collect{ | pact | create_representable_pact(pact) }

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

@@ -13,7 +13,7 @@ module PactBroker
 
         property :name
         property :repository_url
-        property :version, :class => "PactBroker::Models::Version", :extend => PactBroker::Api::Decorators::VersionRepresenter, :embedded => true
+        property :version, :class => "PactBroker::Domain::Version", :extend => PactBroker::Api::Decorators::VersionRepresenter, :embedded => true
 
         link :self do | options |
           pacticipant_url(options[:base_url], represented)

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

@@ -30,7 +30,7 @@ module PactBroker
 
       class PacticipantCollectionRepresenter < BaseDecorator
 
-        collection :pacticipants, exec_context: :decorator, :class => PactBroker::Models::Pacticipant, :extend => PactBroker::Api::Decorators::PacticipantRepresenter
+        collection :pacticipants, exec_context: :decorator, :class => PactBroker::Domain::Pacticipant, :extend => PactBroker::Api::Decorators::PacticipantRepresenter
 
         def pacticipants
           represented

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

@@ -13,7 +13,7 @@ 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, writeable: false
+        property :latest_version, as: :'latest-version', :class => PactBroker::Domain::Version, :extend => PactBroker::Api::Decorators::VersionRepresenter, :embedded => true, writeable: false
 
         include Timestamps
 

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

@@ -11,7 +11,7 @@ module PactBroker
 
         def initialize pacts
           @pacts = pacts
-          @relationships = pacts.collect{|pact| PactBroker::Models::Relationship.new(pact.consumer,pact.provider)}
+          @relationships = pacts.collect{|pact| PactBroker::Domain::Relationship.new(pact.consumer,pact.provider)}
         end
 
         def to_csv

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

@@ -1,7 +1,7 @@
 require_relative 'base_decorator'
 require 'pact_broker/api/decorators/webhook_request_decorator'
 require 'pact_broker/api/decorators/timestamps'
-require 'pact_broker/models/webhook_request'
+require 'pact_broker/domain/webhook_request'
 require 'pact_broker/api/decorators/basic_pacticipant_decorator'
 
 module PactBroker
@@ -9,7 +9,7 @@ module PactBroker
     module Decorators
       class WebhookDecorator < BaseDecorator
 
-        property :request, :class => PactBroker::Models::WebhookRequest, :extend => WebhookRequestDecorator
+        property :request, :class => PactBroker::Domain::WebhookRequest, :extend => WebhookRequestDecorator
 
         include Timestamps
 

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

@@ -56,7 +56,7 @@ module PactBroker
         end
 
         def published_date
-          @pact.updated_at.to_time.localtime.to_datetime.strftime("%d/%m/%Y %l:%M%p %:z")
+          @pact.updated_at.to_time.localtime.to_datetime.strftime("%a %d %b %Y, %l:%M%P %:z")
         end
 
         def json_url

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

@@ -24,7 +24,7 @@ module PactBroker
         end
 
         def allowed_methods
-          ["GET", "PUT"]
+          ["GET", "PUT", "DELETE"]
         end
 
         def malformed_request?
@@ -52,6 +52,13 @@ module PactBroker
           PactBroker::Api::Decorators::PactDecorator.new(pact).to_json(base_url: base_url)
         end
 
+        def delete_resource
+          pact_service.delete(pact_params)
+          true
+        end
+
+        private
+
         def pact
           @pact ||= pact_service.find_pact(pact_params)
         end

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

@@ -66,7 +66,7 @@ module PactBroker
         end
 
         def webhook
-          @webhook ||= Decorators::WebhookDecorator.new(PactBroker::Models::Webhook.new).from_json(request_body)
+          @webhook ||= Decorators::WebhookDecorator.new(PactBroker::Domain::Webhook.new).from_json(request_body)
         end
 
         def next_uuid

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

@@ -1,6 +1,6 @@
 require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/api/decorators/pacticipant_decorator'
-require 'pact_broker/models/pacticipant'
+require 'pact_broker/domain/pacticipant'
 
 module PactBroker
   module Api
@@ -53,7 +53,7 @@ module PactBroker
         end
 
         def new_model
-          @new_model ||= decorator_for(PactBroker::Models::Pacticipant.new).from_json(request.body.to_s)
+          @new_model ||= decorator_for(PactBroker::Domain::Pacticipant.new).from_json(request.body.to_s)
         end
 
       end

data/lib/pact_broker/db/validate_encoding.rb

@@ -0,0 +1,22 @@
+require 'sequel'
+require 'pact_broker/messages'
+
+module PactBroker
+  module DB
+
+    class ConnectionConfigurationError < StandardError; end
+
+    class ValidateEncoding
+
+      extend PactBroker::Messages
+
+      def self.call connection
+        encoding = connection.opts[:encoding] || connection.opts['encoding']
+        unless encoding =~ /utf\-?8/i
+          raise ConnectionConfigurationError.new(message('errors.validation.connection_encoding_not_utf8', encoding: encoding.inspect))
+        end
+      end
+
+    end
+  end
+end

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

@@ -7,4 +7,6 @@ Participants are created automatically when a pact is published to the pact brok
 
 
 ### 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.
+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 or any other HTTP client.
+
+    $ curl -X DELETE http://pact-broker/pacticipants/My%20Consumer

data/lib/pact_broker/domain.rb

@@ -0,0 +1,5 @@
+require 'pact_broker/domain/pact'
+require 'pact_broker/domain/pacticipant'
+require 'pact_broker/domain/tag'
+require 'pact_broker/domain/version'
+

data/lib/pact_broker/{models → domain}/group.rb

@@ -1,7 +1,7 @@
 require 'versionomy'
 
 module PactBroker
-  module Models
+  module Domain
     class Group < Array
 
       def initialize *relationships

data/lib/pact_broker/{models → domain}/order_versions.rb

@@ -1,11 +1,11 @@
 require 'versionomy'
 
 module PactBroker
-  module Models
+  module Domain
     class OrderVersions
 
       def self.call pacticipant_id
-        orderable_versions = PactBroker::Models::Version.where(:pacticipant_id => pacticipant_id).all.collect{| version | OrderableVersion.new(version) }
+        orderable_versions = PactBroker::Domain::Version.where(:pacticipant_id => pacticipant_id).all.collect{| version | OrderableVersion.new(version) }
         orderable_versions.sort.each_with_index{ | version, i | version.update_model(i) }
       end
 

data/lib/pact_broker/{models → domain}/pact.rb

@@ -2,7 +2,7 @@ require 'pact_broker/db'
 
 module PactBroker
 
-  module Models
+  module Domain
     class Pact
 
       attr_accessor :id, :provider, :consumer_version, :consumer, :updated_at, :created_at, :json_content, :consumer_version_number

data/lib/pact_broker/{models → domain}/pacticipant.rb

@@ -3,7 +3,7 @@ require 'pact_broker/messages'
 
 module PactBroker
 
-  module Models
+  module Domain
 
     class Pacticipant < Sequel::Model