pact_broker 1.18.0.beta.1 → 1.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c780083d99fd7a3c73e53f16b703c3bfe5b86a78
-  data.tar.gz: aa8ef0eb97c2e18461179607d395c7b493e9f50e
+  metadata.gz: 7ef22c7934452713d713906de14fade4ecc2a2c8
+  data.tar.gz: e20f94e91cd30b71fde2c80393861342e989a33f
 SHA512:
-  metadata.gz: 63db04af90da66ce5833f9f2de88f734529f94c7ebb759ffe4a8eb89f5a7cf5b439c221bf5464bf4d499f5e326038668dd58e5ebbff6f9db31ab7a9b92669861
-  data.tar.gz: 261ccb52f5819dc9d9eee9c1088bff11c0d6fb3269492d68e1de25f5687e66adc7a814a43ad7c69c8e3b883ec10ca5e0bf865a0e46bf5f515011384057e402fd
+  metadata.gz: b5be0a05dd839aef2b0da83d95f7ea58c0c9934ec6e59162a726fa21c3c9f7f795090f05071506df821ff2a930557a1649111f951ec7321a008faed5f59ea2de
+  data.tar.gz: 1fb67c57f5491571a02d096e0243bd20c43f64faf1a5245457743c71663a002ee3c91dd59355ea863164025ef22ca6840c38d226ec324b40d69c237da5bbddae

data/CHANGELOG.md

@@ -2,8 +2,10 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)' vX.Y.Z..HEAD
 
-#### 1.18.0.beta.1 (2017-05-05)
-* 99e825b - Add in-built configuration for basic auth. (Beth Skurrie, Fri May 5 10:22:53 2017 +1000)
+#### 1.18.0 (2017-05-09)
+* 397060b - Display application versions in reverse order in the Versions resource. (Beth Skurrie, Tue May 9 13:59:54 2017 +1000)
+* 251c878 - Allow application versions to be ordered by creation date where no consistent orderable object can be extracted from the consumer application version. (Beth Skurrie, Tue May 9 13:22:36 2017 +1000)
+* 68bb6d9 - Execute webhooks using sucker punch. (Beth Skurrie, Mon May 8 10:32:45 2017 +1000)
 
 #### 1.17.2 (2017-05-04)
 * b8f45e1 - fix issue with pact document link not displaying #94 (Matt Fellows, Wed May 3 11:23:09 2017 +1000)

data/README.md

@@ -1,6 +1,6 @@
 # Pact Broker
 
-[![Build Status](https://travis-ci.org/bethesque/pact_broker.svg?branch=master)](https://travis-ci.org/bethesque/pact_broker) [![Join the chat at https://gitter.im/bethesque/pact_broker](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/bethesque/pact_broker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Build Status](https://travis-ci.org/pact-foundation/pact_broker.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker) [![Join the chat at https://gitter.im/pact-foundation/pact_broker](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pact-foundation/pact_broker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 The Pact Broker provides a repository for consumer driven contracts created using the pact gem.
 
@@ -23,7 +23,7 @@ Features:
 * Tracks changes between Pact versions so you can tell when a consumer has changed its expectations.
 * [Docker Pact Broker][docker]
 
-Travis CI Status: [![Build Status](https://travis-ci.org/bethesque/pact_broker.svg?branch=master)](https://travis-ci.org/bethesque/pact_broker)
+Travis CI Status: [![Build Status](https://travis-ci.org/pact-foundation/pact_broker.svg?branch=master)](https://travis-ci.org/pact-foundation/pact_broker)
 
 ### How would I use the Pact Broker?
 
@@ -41,47 +41,47 @@ If you don't have a [Pact Broker CI Nerf Gun][nerf], you'll probably want to rea
 
 ## Documentation
 
-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.
+See the [Pact Broker Client](https://github.com/pact-foundation/pact_broker-client) for documentation on how to publish a pact to the Pact Broker, and configure the URLs in the provider project.
 
-See the [wiki](https://github.com/bethesque/pact_broker/wiki) for documentation related to the Pact Broker itself.
+See the [wiki](https://github.com/pact-foundation/pact_broker/wiki) for documentation related to the Pact Broker itself.
 
 ### Screenshots
 
 #### Index
 
 * * *
-<img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/index.png"/>
+<img src="https://raw.githubusercontent.com/wiki/pact-foundation/pact_broker/images/index.png"/>
 
 #### Autogenerated documentation
 
 Paste the pact URL into a browser to view a HTML version of the pact.
 * * *
-<img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/autogenerated_documentation.png"/>
+<img src="https://raw.githubusercontent.com/wiki/pact-foundation/pact_broker/images/autogenerated_documentation.png"/>
 
 
 #### Network diagram
 
 * * *
-<img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/network_diagram.png"/>
+<img src="https://raw.githubusercontent.com/wiki/pact-foundation/pact_broker/images/network_diagram.png"/>
 
 #### HAL browser
 
 Use the embedded HAL browser to navigate the API.
 * * *
-<img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/hal_browser.png"/>
+<img src="https://raw.githubusercontent.com/wiki/pact-foundation/pact_broker/images/hal_browser.png"/>
 
 #### HAL documentation
 
 Use the HAL browser to view documentation as you browse.
 * * *
-<img src="https://raw.githubusercontent.com/wiki/bethesque/pact_broker/images/hal_documentation.png"/>
+<img src="https://raw.githubusercontent.com/wiki/pact-foundation/pact_broker/images/hal_documentation.png"/>
 
 ## Usage
 
 ### To have a play around on your local machine
 
 * Install ruby 2.2.0 or later and bundler >= 1.12.0
-* Run `git clone git@github.com:bethesque/pact_broker.git && cd pact_broker/example`
+* Run `git clone git@github.com:pact-foundation/pact_broker.git && cd pact_broker/example`
 * Run `bundle`
 * Run `bundle exec rackup -p 8080`
 * Open [http://localhost:8080](http://localhost:8080) and you should see a list containing the pact between the Zoo App and the Animal Service.
@@ -100,7 +100,7 @@ the [Hosted Pact Broker](https://pact.dius.com.au/?utm_source=github&utm_campaig
 You can use the [Pact Broker Docker container][docker] or [Terraform on AWS][terraform] or to roll your own...
 
 * 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). The migrations have been tested on MySQL and PostgreSQL - your mileage will vary on other databases.
-* __Note:__ It is recommended to use __PostgreSQL__ as it will support JSON search features that are planned in a future release, however MySQL the other [semi supported](https://github.com/bethesque/pact_broker/issues/33) database.
+* __Note:__ It is recommended to use __PostgreSQL__ as it will support JSON search features that are planned in a future release, however MySQL the other [semi supported](https://github.com/pact-foundation/pact_broker/issues/33) database.
 * Install ruby 2.2.0 or later and bundler >= 1.12.0
 * Copy the [example](/example) directory to the location you want to install the application.
 * Modify the config.ru and Gemfile as desired (eg. choose database driver gem, set your database credentials. Use the "pg" gem if using Postgres.)
@@ -110,7 +110,7 @@ You can use the [Pact Broker Docker container][docker] or [Terraform on AWS][ter
 
 [decouple]: http://techblog.realestate.com.au/enter-the-pact-matrix-or-how-to-decouple-the-release-cycles-of-your-microservices/
 [pact]: https://github.com/realestate-com-au/pact
-[nerf]: https://github.com/bethesque/pact_broker/wiki/pact-broker-ci-nerf-gun
+[nerf]: https://github.com/pact-foundation/pact_broker/wiki/pact-broker-ci-nerf-gun
 [different-teams]: https://github.com/realestate-com-au/pact/wiki/Using-pact-where-the-consumer-team-is-different-from-the-provider-team
 [docker]: https://hub.docker.com/r/dius/pact-broker
 [terraform]: https://github.com/nadnerb/terraform-pact-broker

data/example/{heroku → basic_auth}/README.md

@@ -27,7 +27,7 @@ $ git push heroku master
 Your Pact Broker instance is now available!
 
 ## Publish consumer pacts - consumer side
-You will need to set these environment variables with your basic auth credentials
+You will need to set these environment variables with your basic auth credentials 
 ```
 export PACT_BROKER_USERNAME=admin
 export PACT_BROKER_PASSWORD=changeme

data/example/basic_auth/config.ru

@@ -0,0 +1,19 @@
+require 'fileutils'
+require 'logger'
+require 'sequel'
+require 'pact_broker'
+require 'pg'
+
+use Rack::Auth::Basic, "Restricted Area" do |username, password|
+  username == ENV['PACT_BROKER_USERNAME'] and password == ENV['PACT_BROKER_PASSWORD']
+end
+
+app = PactBroker::App.new do | config |
+  # change these from their default values if desired
+  # config.log_dir = "./log"
+  # config.auto_migrate_db = true
+  # config.use_hal_browser = true
+  config.database_connection = Sequel.connect(ENV['DATABASE_URL'], adapter: "postgres", encoding: 'utf8')
+end
+
+run app

data/example/config.ru

@@ -27,8 +27,6 @@ app = PactBroker::App.new do | config |
   # config.use_hal_browser = true
   config.database_connection = Sequel.connect(DATABASE_CREDENTIALS.merge(:logger => config.logger))
   config.database_connection.timezone = :utc
-  # See configuration section of wiki for more basic auth configuration options
-  # config.protect_with_basic_auth :app_read, {username: 'username', password: 'password'}
 end
 
 run app

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

@@ -15,7 +15,7 @@ module PactBroker
         link :self do | context |
           {
             href: context[:resource_url],
-            title: "All versions of the pacticipant #{context[:pacticipant_name]}"
+            title: "All application versions of #{context[:pacticipant_name]}"
           }
         end
 

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

@@ -25,7 +25,7 @@ module PactBroker
         end
 
         def versions
-          pacticipant_service.find_all_pacticipant_versions pacticipant_name
+          pacticipant_service.find_all_pacticipant_versions_in_reverse_order pacticipant_name
         end
 
       end

data/lib/pact_broker/app.rb

@@ -3,7 +3,7 @@ require 'pact_broker/db'
 require 'pact_broker/project_root'
 require 'rack/hal_browser'
 require 'rack/pact_broker/convert_file_extension_to_accept_header'
-require 'pact_broker/configuration/configure_basic_auth'
+require 'sucker_punch'
 
 module PactBroker
 
@@ -33,6 +33,7 @@ module PactBroker
       PactBroker::DB.connection = configuration.database_connection
       PactBroker::DB.connection.timezone = :utc
       PactBroker::DB.validate_connection_config if configuration.validate_database_connection_config
+      SuckerPunch.logger = configuration.logger
 
       if configuration.auto_migrate_db
         logger.info "Migrating database"
@@ -71,12 +72,12 @@ module PactBroker
       apps << PactBroker::UI::App.new
       apps << PactBroker::API
 
-      cascade = Rack::Cascade.new(apps)
-      app_with_basic_auth = PactBroker::Configuration::ConfigureBasicAuth.call(cascade, configuration)
-
       @app.map "/" do
-        run app_with_basic_auth
+        run Rack::Cascade.new(apps)
       end
+
     end
+
   end
-end
+
+end

data/lib/pact_broker/configuration.rb

@@ -4,33 +4,13 @@ module PactBroker
     @@configuration ||= Configuration.default_configuration
   end
 
-  def self.reset_configuration
-    @@configuration = Configuration.default_configuration
-  end
-
   class Configuration
 
-    REQUEST_METHOD = 'REQUEST_METHOD'.freeze
-    GET = 'GET'.freeze
-    PATH_INFO = 'PATH_INFO'.freeze
-    DIAGNOSTIC = '/diagnostic/'.freeze
-
     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
-    attr_accessor :use_case_sensitive_resource_names, :basic_auth_predicates
+    attr_accessor :use_case_sensitive_resource_names, :order_versions_by_date
     attr_writer :logger
 
-    def initialize
-      @basic_auth_config = {}
-      @basic_auth_predicates = [
-        [:diagnostic,  ->(env) { env[PATH_INFO].start_with? DIAGNOSTIC }],
-        [:app,         ->(env) { !env[PATH_INFO].start_with? DIAGNOSTIC } ],
-        [:app_read,    ->(env) { env[REQUEST_METHOD] == GET }],
-        [:app_write,   ->(env) { env[REQUEST_METHOD] != GET }],
-        [:all,         ->(env) { true }]
-      ]
-    end
-
     def logger
       @logger ||= create_logger log_path
     end
@@ -46,10 +26,12 @@ module PactBroker
       config.use_case_sensitive_resource_names = true
       config.html_pact_renderer = default_html_pact_render
       config.version_parser = PactBroker::Versions::ParseSemanticVersion
+      # Not recommended to set this to true unless there is no way to
+      # consistently extract an orderable object from the consumer application version number.
+      config.order_versions_by_date = false
       config
     end
 
-    # public
     def self.default_html_pact_render
       lambda { |pact|
         require 'pact_broker/api/renderers/html_pact_renderer'
@@ -57,28 +39,8 @@ module PactBroker
       }
     end
 
-    # public
-    def protect_with_basic_auth scopes, credentials
-      [*scopes].each do | scope |
-        basic_auth_config[scope] ||= []
-        basic_auth_config[scope] << credentials
-      end
-    end
-
-    # private
-    def protect_with_basic_auth? scope
-      !!basic_auth_credentials_list_for(scope)
-    end
-
-    # private
-    def basic_auth_credentials_list_for scope
-      basic_auth_config[scope]
-    end
-
     private
 
-    attr_reader :basic_auth_config
-
     def create_logger path
       FileUtils::mkdir_p File.dirname(path)
       logger = Logger.new(path)

data/lib/pact_broker/domain/order_versions.rb

@@ -4,9 +4,17 @@ module PactBroker
   module Domain
     class OrderVersions
 
+      include PactBroker::Logging
+      # TODO select for update
       def self.call pacticipant_id
-        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) }
+
+        orderable_versions = PactBroker::Domain::Version.for_update.where(:pacticipant_id => pacticipant_id).order(:created_at, :id).collect{| version | OrderableVersion.new(version) }
+        ordered_versions = if PactBroker.configuration.order_versions_by_date
+          orderable_versions # already ordered in SQL
+        else
+          orderable_versions.sort
+        end
+        ordered_versions.each_with_index{ | version, i | version.update_model(i) }
       end
 
       class OrderableVersion
@@ -23,9 +31,11 @@ module PactBroker
         end
 
         def update_model new_order
-          # Sequel will only run the update if the column value has changed, so in 99% of
-          # cases, only one update will occur.
-          version_model.update(:order => new_order)
+          if version_model.order != new_order
+            # Avoid modifying the updated_at flag by doing a manual update
+            # In 99% of cases, this will only set the order of the most recent version
+            PactBroker::Domain::Version.where(id: version_model.id).update(order: new_order)
+          end
         end
       end
     end

data/lib/pact_broker/domain/webhook.rb

@@ -33,7 +33,6 @@ module PactBroker
         request && request.description
       end
 
-      #TODO retries
       def execute
         logger.info "Executing #{self}"
         request.execute

data/lib/pact_broker/domain/webhook_request.rb

@@ -22,7 +22,7 @@ module PactBroker
       include PactBroker::Logging
       include PactBroker::Messages
 
-      attr_accessor :method, :url, :headers, :body, :username, :password
+      attr_accessor :method, :url, :headers, :body, :username, :password, :uuid
 
       # Reform gets confused by the :method method, as :method is a standard
       # Ruby method.
@@ -35,6 +35,7 @@ module PactBroker
         @password = attributes[:password]
         @headers = attributes[:headers] || {}
         @body = attributes[:body]
+        @uuid = attributes[:uuid]
       end
 
       def description
@@ -64,17 +65,18 @@ module PactBroker
             end
           end
 
-          logger.info "Making webhook request #{to_s}"
+          logger.info "Making webhook #{uuid} request #{to_s}"
           response = Net::HTTP.start(uri.hostname, uri.port,
             :use_ssl => uri.scheme == 'https') do |http|
             http.request req
           end
 
-          logger.info "Received response status=#{response.code} body=#{response.body}"
+          logger.info "Received response for webhook #{uuid} status=#{response.code}"
+          logger.debug "body=#{response.body}"
           WebhookExecutionResult.new(response)
 
         rescue StandardError => e
-          logger.error "Error executing webhook #{e.class.name} - #{e.message}"
+          logger.error "Error executing webhook #{uuid} #{e.class.name} - #{e.message}"
           logger.error e.backtrace.join("\n")
           WebhookExecutionResult.new(nil, e)
         end

data/lib/pact_broker/logging.rb

@@ -17,6 +17,10 @@ module PactBroker
       @@logger = logger
     end
 
+    def log_error e
+      logger.error "#{e.class} #{e.message} #{e.backtrace.join("\n")}"
+    end
+
     def logger
       @@logger ||= begin
         FileUtils.mkdir_p(LOG_DIR)

data/lib/pact_broker/pacticipants/repository.rb

@@ -20,11 +20,12 @@ module PactBroker
         PactBroker::Domain::Pacticipant.order(:name).all
       end
 
-      def find_all_pacticipant_versions name
+      def find_all_pacticipant_versions_in_reverse_order name
         PactBroker::Domain::Version
           .select(:versions__id, :versions__number, :versions__pacticipant_id, :versions__order, :versions__created_at, :versions__updated_at)
           .join(:pacticipants, {id: :pacticipant_id})
           .where(name_like(:name, name))
+          .reverse_order(:order)
       end
 
       def find_by_name_or_create name

data/lib/pact_broker/pacticipants/service.rb

@@ -41,8 +41,8 @@ module PactBroker
         pacticipant_repository.find_by_name(name)
       end
 
-      def self.find_all_pacticipant_versions name
-        pacticipant_repository.find_all_pacticipant_versions(name)
+      def self.find_all_pacticipant_versions_in_reverse_order name
+        pacticipant_repository.find_all_pacticipant_versions_in_reverse_order(name)
       end
 
       def self.find_pacticipant_repository_url_by_pacticipant_name name

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '1.18.0.beta.1'
+  VERSION = '1.18.0'
 end

data/lib/pact_broker/webhooks/job.rb

@@ -0,0 +1,46 @@
+require 'sucker_punch'
+require 'pact_broker/webhooks/service'
+require 'pact_broker/logging'
+
+module PactBroker
+  module Webhooks
+    class Job
+
+      BACKOFF_TIMES = [10, 60, 120, 300, 600, 1200] #10 sec, 1 min, 2 min, 5 min, 10 min, 20 min => 38 minutes
+
+      include SuckerPunch::Job
+      include PactBroker::Logging
+
+      def perform data
+        @webhook = data[:webhook]
+        @error_count = data[:error_count] || 0
+        begin
+          webhook_execution_result = PactBroker::Webhooks::Service.execute_webhook_now webhook
+          reschedule_job unless webhook_execution_result.success?
+        rescue StandardError => e
+          handle_error e
+        end
+      end
+
+      private
+
+      attr_reader :webhook, :error_count
+
+      def handle_error e
+        log_error e
+        reschedule_job
+      end
+
+      def reschedule_job
+        case error_count
+        when 0...BACKOFF_TIMES.size
+          logger.debug "Re-enqeuing job for webhook #{webhook.uuid} to run in #{BACKOFF_TIMES[error_count]} seconds"
+          Job.perform_in(BACKOFF_TIMES[error_count], {webhook: webhook, error_count: error_count+1})
+        else
+          logger.error "Failed to execute webhook #{webhook.uuid} after #{BACKOFF_TIMES.size} times."
+        end
+      end
+
+    end
+  end
+end