pact_broker 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: eab6ba50f1698c583aa2c5ea2499134dccdf26fe
-  data.tar.gz: 90c46d03810fdaba756c7d10528193636913a159
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzNkZTQzNTE1OWIzZDNlYmQ0Y2IzODEyZmRkYzhjZWI0YjIwMDIxMg==
+  data.tar.gz: !binary |-
+    N2QwYjkzYzk0YWQ1NjFkODVkZjIyOGJiYThhMzEwYzRlNGIxM2RkNw==
 SHA512:
-  metadata.gz: 71d627be7fcefa1d267b9e6347bd473aea3fe9b204a2d3235b9a0df7f03701f45ff764a9e235300b3b813ba19027f9bb5b3cca18261e5a2461d8cdf134a142af
-  data.tar.gz: 45bebda0fb63072a4fc33c082b1990b1a0ae941e04858624a733aa94a7aab9c51ab6b8bd8a965b350c1128987590ddb4f5fc489ed1bc6e4dfcac68346c5799c8
+  metadata.gz: !binary |-
+    NzlkN2YyYzI4YWM1OTNmNWVmN2RkYTcwMjU1ZWJiNGI2OGE2NDFjYmZmNTY0
+    MmE3Yzc1NGVmZDA0YmQ2YjJlYjZhODIwODAxOGRhYTgxZGI1MTZmODRlOGY5
+    ZGYyMDRiNzBkN2MzMmIxOWI4ZTI4MDM1MDIwNmFiNTU5N2I0ZTk=
+  data.tar.gz: !binary |-
+    MDNkNzJkNjgwYzI2ZjdiOGM2NTNhZmJiMDBmNWZjNWVjZTVmM2VlYTQyOTI4
+    NzEwN2JjYzUxYWViMzJiZGI1NzQwYTkyNTJjZTM2NGI1Y2FmNjE4OWVhYTUx
+    NTA1NDgyYjYxZDQyNDE4NGEyYWY3Yzc5M2VlYWJiYjBjNjRiYmY=

data/.gitignore

@@ -26,3 +26,5 @@ _yardoc
 
 *.sqlite
 Gemfile.lock
+
+bethtest/

data/CHANGELOG.md

@@ -2,6 +2,11 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+#### 1.3.0 (2014-10-14)
+
+* ed08811 - Converted raw SQL create view statements to Sequel so they will run on Postgres (Beth, Sat Oct 11 22:07:37 2014 +1100)
+* 457edf4 - Added syntax highlighting to JSON in autogenerated HTML docs. (Beth, Wed Sep 24 22:12:14 2014 +1000)
+
 #### 1.2.0 (2014-09-22)
 
 * 0ccde50 - Made webhook creation code more Webmachiney. (Beth, Tue Sep 16 10:07:56 2014 +1000)

data/README.md

@@ -18,7 +18,8 @@ See the [wiki](https://github.com/bethesque/pact_broker/wiki) for documentation.
 
 ## 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
+* 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. 
+* __Note:__ It is recommended to use __PostgreSQL__ as it will support JSON search features that are planned in a future release.
 * 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)

data/Rakefile

@@ -10,13 +10,11 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
-
 
 FileList['lib/tasks/**/*.rake'].each { |task| load "#{Dir.pwd}/#{task}" }
 FileList['tasks/**/*.rake'].each { |task| load "#{Dir.pwd}/#{task}" }
 
-task :default => ['db:prepare:test', :boot, :spec]
+task :default => ['db:prepare:test', :boot, :spec, 'pact:verify']
 
 task :boot do
   require File.join(File.dirname(__FILE__), 'config/boot')

data/db/migrations/07_increase_json_content_length.rb

@@ -1,7 +1,12 @@
 Sequel.migration do
   change do
     alter_table(:pacts) do
-      set_column_type(:json_content, :mediumtext)
+      if Sequel::Model.db.adapter_scheme == :postgres
+        set_column_type(:json_content, :text)
+      else
+        # Assume mysql
+        set_column_type(:json_content, :mediumtext)
+      end
     end
   end
 end

data/db/migrations/08_create_latest_pact_view.rb

@@ -1,11 +1,13 @@
 Sequel.migration do
   change do
     create_view(:all_pacts,
-      "select pact.id, c.id as consumer_id, c.name as consumer_name, cv.number as consumer_version_number, cv.`order` as consumer_version_order, p.id as provider_id, p.name as provider_name, pact.json_content
-      from pacts pact
-      join versions cv on pact.version_id = cv.id
-      join pacticipants c on cv.pacticipant_id = c.id
-      join pacticipants p on pact.provider_id = p.id")
+      Sequel::Model.db[:pacts].select(:pacts__id, :c__id___consumer_id, :c__name___consumer_name,
+      :cv__number___consumer_version_number, :cv__order___consumer_version_order,
+      :p__id___provider_id, :p__name___provider_name,
+      :pacts__json_content).
+      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}))
 
     create_view(:latest_pact_consumer_version_orders,
       "select provider_id, consumer_id, max(consumer_version_order) as latest_consumer_version_order

data/db/migrations/14_add_timestamps_to_pact_views.rb

@@ -0,0 +1,28 @@
+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__number___consumer_version_number, :cv__order___consumer_version_order,
+      :p__id___provider_id, :p__name___provider_name,
+      :pacts__json_content, :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}))
+
+    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/lib/pact_broker/api.rb

@@ -35,10 +35,6 @@ module PactBroker
         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

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

@@ -1,4 +1,5 @@
 require_relative 'pact_details_decorator'
+require 'pact_broker/api/decorators/timestamps'
 
 module PactBroker
 
@@ -8,6 +9,8 @@ module PactBroker
 
       class LatestPactDecorator < PactDetailsDecorator
 
+        include Timestamps
+
         links :self do | options |
           [
             {
@@ -21,4 +24,4 @@ module PactBroker
       end
     end
   end
-end
+end

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

@@ -1,5 +1,6 @@
 require_relative 'base_decorator'
 require 'pact_broker/json'
+require 'pact_broker/api/decorators/timestamps'
 
 module PactBroker
 
@@ -9,8 +10,7 @@ module PactBroker
 
       class PactDecorator < BaseDecorator
 
-        property :createdAt, getter: lambda { |_|  created_at.xmlschema }, writeable: false
-        property :updatedAt, getter: lambda { |_| updated_at.xmlschema }, writeable: false
+        include Timestamps
 
         def to_hash(options = {})
           ::JSON.parse(represented.json_content, PACT_PARSING_OPTIONS).merge super

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

@@ -1,5 +1,6 @@
 require_relative 'base_decorator'
 require_relative 'pact_pacticipant_decorator'
+require 'pact_broker/api/decorators/timestamps'
 
 module PactBroker
 
@@ -18,16 +19,14 @@ module PactBroker
 
       class PactVersionDecorator < BaseDecorator
 
-
-        property :createdAt, getter: lambda { |_|  created_at.to_time.localtime.xmlschema }, writeable: false
-        property :updatedAt, getter: lambda { |_| updated_at.to_time.localtime.xmlschema }, writeable: false
+        include Timestamps
 
         property :consumer_version, as: :consumerVersion, embedded: true, decorator: EmbeddedVersionDecorator
 
 
         link :self do | options |
           {
-            href: pact_url(options.base_url, represented),
+            href: pact_url(options[:base_url], represented),
             title: represented.name
           }
 

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

@@ -14,21 +14,21 @@ module PactBroker
 
         link :self do | context |
           {
-            href: context.resource_url,
+            href: context[:resource_url],
             title: "All versions of the pact between #{context[:consumer_name]} and #{context[:provider_name]}"
           }
         end
 
         link :consumer do | context |
           {
-            href: pacticipant_url(context.base_url, OpenStruct.new(name: context[:consumer_name])),
+            href: pacticipant_url(context[:base_url], OpenStruct.new(name: context[:consumer_name])),
             title: context[:consumer_name]
           }
         end
 
         link :provider do | context |
           {
-            href: pacticipant_url(context.base_url, OpenStruct.new(name: context[:provider_name])),
+            href: pacticipant_url(context[:base_url], OpenStruct.new(name: context[:provider_name])),
             title: context[:provider_name]
           }
         end
@@ -36,7 +36,7 @@ module PactBroker
         links :'pact-versions' do | context |
           represented.collect do | pact |
             {
-              :href => pact_url(context.base_url, pact),
+              :href => pact_url(context[:base_url], pact),
               :title => pact.version_and_updated_date
             }
           end

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

@@ -1,5 +1,6 @@
 require_relative 'base_decorator'
 require_relative 'version_decorator'
+require 'pact_broker/api/decorators/timestamps'
 
 module PactBroker
 
@@ -13,8 +14,8 @@ module PactBroker
         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 :createdAt, getter: lambda { |_|  created_at.xmlschema }, writeable: false
-        property :updatedAt, getter: lambda { |_| updated_at.xmlschema }, writeable: false
+
+        include Timestamps
 
         link :self do | options |
           pacticipant_url(options[:base_url], represented)

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

@@ -1,5 +1,6 @@
 require_relative 'base_decorator'
 require_relative 'pact_pacticipant_decorator'
+require_relative 'timestamps'
 
 module PactBroker
 
@@ -9,8 +10,7 @@ module PactBroker
 
       class TagDecorator < BaseDecorator
 
-        property :createdAt, getter: lambda { |_| created_at ? created_at.xmlschema : nil }
-        property :updatedAt, getter: lambda { |_| updated_at ? updated_at.xmlschema : nil }
+        include Timestamps
 
         link :self do | options |
           tag_url(options[:base_url], represented)

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

@@ -0,0 +1,24 @@
+require 'roar/representer/json'
+
+module PactBroker
+
+  module Api
+
+    module Decorators
+
+      module Timestamps
+
+        include Roar::Representer::JSON
+
+        property :optional_updated_at, as: :updatedAt, exec_context: :decorator, writeable: false
+        property :createdAt, getter: lambda { |_|  created_at.xmlschema }, writeable: false
+
+        def optional_updated_at
+          if represented.updated_at != represented.created_at
+            represented.updated_at.xmlschema
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 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/api/decorators/basic_pacticipant_decorator'
 
@@ -10,8 +11,7 @@ module PactBroker
 
         property :request, :class => PactBroker::Models::WebhookRequest, :extend => WebhookRequestDecorator
 
-        property :createdAt, getter: lambda { |_| created_at.xmlschema }, writeable: false
-        property :updatedAt, getter: lambda { |_| updated_at.xmlschema }, writeable: false
+        include Timestamps
 
         property :consumer, :extend => PactBroker::Api::Decorators::BasicPacticipantRepresenter, :embedded => true, writeable: false
         property :provider, :extend => PactBroker::Api::Decorators::BasicPacticipantRepresenter, :embedded => true, writeable: false

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

@@ -9,8 +9,8 @@ module PactBroker
 
         link :'pb:self' do | context |
           {
-            title: context.resource_title,
-            href: context.resource_url
+            title: context[:resource_title],
+            href: context[:resource_url]
           }
         end
 
@@ -19,7 +19,7 @@ module PactBroker
             {
               title: webhook.description,
               name: webhook.request_description,
-              href: webhook_url(webhook.uuid, context.base_url)
+              href: webhook_url(webhook.uuid, context[:base_url])
             }
           end
         end
@@ -27,7 +27,7 @@ module PactBroker
         curies do | context |
           [{
             name: :pb,
-            href: context.base_url + '/doc/webhooks',
+            href: context[:base_url] + '/doc/webhooks',
           }]
         end
 

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

@@ -19,14 +19,22 @@ module PactBroker
         end
 
         def call
-          "<html><head>#{head}</head><body>#{pact_metadata}#{html}</body></html>"
+          "<html>
+            <head>#{head}</head>
+            <body>
+              #{pact_metadata}#{html}
+            </body>
+          </html>"
         end
 
         private
 
         def head
-          '<link rel="stylesheet" type="text/css" href="/stylesheets/github.css">' + "\n" +
-          '<link rel="stylesheet" type="text/css" href="/stylesheets/pact.css">'
+         "<link rel='stylesheet' type='text/css' href='/stylesheets/github.css'>
+          <link rel='stylesheet' type='text/css' href='/stylesheets/pact.css'>
+          <link rel='stylesheet' type='text/css' href='/stylesheets/github-json.css'>
+          <script src='/javascripts/highlight.pack.js'></script>
+          <script>hljs.initHighlightingOnLoad();</script>"
         end
 
         def pact_metadata
@@ -38,7 +46,7 @@ module PactBroker
               </li>
               <li>
                 <span class='name'>Date published:</span>
-                <span class='value'>#{@pact.updated_at.to_time.localtime.to_datetime.strftime("%d/%m/%Y %l:%M%p %:z")}</span>
+                <span class='value'>#{published_date}</span>
               </li>
               <li>
                 <a href=\"#{json_url}\">View in HAL Browser</a>
@@ -47,6 +55,10 @@ module PactBroker
           </div>"
         end
 
+        def published_date
+          @pact.updated_at.to_time.localtime.to_datetime.strftime("%d/%m/%Y %l:%M%p %:z")
+        end
+
         def json_url
           PactBroker::Api::PactBrokerUrls.hal_browser_url pact_url
         end

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

@@ -36,7 +36,6 @@ module PactBroker
           end
         end
 
-        # This should be called base_url
         def base_url
           request.uri.to_s.gsub(/#{request.uri.path}$/,'')
         end

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

@@ -16,21 +16,26 @@ module PactBroker
           ["GET"]
         end
 
-        def to_csv
-          generate_csv(group_service.find_group_containing @pacticipant)
+        def resource_exists?
+          pacticipant
         end
 
-        def generate_csv group
+        def to_csv
           PactBroker::Api::Decorators::RelationshipsCsvDecorator.new(group).to_csv
         end
 
+        private
+
         def pacticipant_name
           identifier_from_path[:pacticipant_name]
         end
 
-        def resource_exists?
-          @pacticipant = pacticipant_service.find_pacticipant_by_name(pacticipant_name)
-          @pacticipant != nil
+        def pacticipant
+          @pacticipant ||= pacticipant_service.find_pacticipant_by_name(pacticipant_name)
+        end
+
+        def group
+          @group ||= group_service.find_group_containing pacticipant
         end
 
       end

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

@@ -15,37 +15,36 @@ module PactBroker
           ["GET"]
         end
 
-        # TODO change to use request.base_url to avoid params getting included!!!
         def to_json
           {
             _links: {
               'pb:self' =>
               {
-                href: request.uri.to_s,
+                href: base_url,
                 title: 'The Pact Broker index page',
                 templated: false
               },
               'pb:latest-pacts' =>
               {
-                href: request.uri.to_s + 'pacts/latest',
+                href: base_url + '/pacts/latest',
                 title: 'Retrieve latest pacts',
                 templated: false
               },
               'pb:pacticipants' =>
               {
-                href: request.uri.to_s + 'pacticipants',
+                href: base_url + '/pacticipants',
                 title: 'Retrieve pacticipants',
                 templated: false
               },
               'pb:webhooks' =>
               {
-                href: request.uri.to_s + 'webhooks',
+                href: base_url + '/webhooks',
                 title: 'Webhooks',
                 templated: false
               },'curies' =>
               [{
                 name: 'pb',
-                href: request.uri.to_s + 'doc/{rel}',
+                href: base_url + '/doc/{rel}',
                 templated: true
               }]
             }