pact_broker 1.3.0 → 1.3.1

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YzNkZTQzNTE1OWIzZDNlYmQ0Y2IzODEyZmRkYzhjZWI0YjIwMDIxMg==
-  data.tar.gz: !binary |-
-    N2QwYjkzYzk0YWQ1NjFkODVkZjIyOGJiYThhMzEwYzRlNGIxM2RkNw==
+SHA1:
+  metadata.gz: c2efe6a0f09d53fcd3eda935e760ffdddf06c39c
+  data.tar.gz: 35000029a9b755d9c4f14be9ef900864dcb50a51
 SHA512:
-  metadata.gz: !binary |-
-    NzlkN2YyYzI4YWM1OTNmNWVmN2RkYTcwMjU1ZWJiNGI2OGE2NDFjYmZmNTY0
-    MmE3Yzc1NGVmZDA0YmQ2YjJlYjZhODIwODAxOGRhYTgxZGI1MTZmODRlOGY5
-    ZGYyMDRiNzBkN2MzMmIxOWI4ZTI4MDM1MDIwNmFiNTU5N2I0ZTk=
-  data.tar.gz: !binary |-
-    MDNkNzJkNjgwYzI2ZjdiOGM2NTNhZmJiMDBmNWZjNWVjZTVmM2VlYTQyOTI4
-    NzEwN2JjYzUxYWViMzJiZGI1NzQwYTkyNTJjZTM2NGI1Y2FmNjE4OWVhYTUx
-    NTA1NDgyYjYxZDQyNDE4NGEyYWY3Yzc5M2VlYWJiYjBjNjRiYmY=
+  metadata.gz: f5852a4d2cd9bedd28fc5dff28da6d6464d9936a1cb9e693956364d7c6a0c421b364af5be6d3ff229dd24ac36462b8af530ae01209f433dd971574cd87691e8a
+  data.tar.gz: a2224dbd381b2313175752bc002c2d118363c90fdd9a08b54f20d6a868dd1599c334c3574fdeac5fc1c6cf3fff99b46c226695ee4bb7a4d2f6a3e24f29430b57

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - 2.1.2

data/CHANGELOG.md

@@ -2,6 +2,12 @@ Do this to generate your change history
 
     $ git log --pretty=format:'  * %h - %s (%an, %ad)'
 
+#### 1.3.1 (2014-10-23)
+
+* e61b40e - Added Travis configuration. (Beth, Fri Oct 17 16:32:26 2014 +1100)
+* b320fe4 - Fixed pact publish validation for ruby 1.9.3 (Beth, Fri Oct 17 16:31:41 2014 +1100)
+* b9b4d2b - Added validation to ensure that the participant names in the path match the participant names in the pact. (Beth, Thu Oct 16 20:21:10 2014 +1100)
+
 #### 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)

data/README.md

@@ -2,6 +2,8 @@
 
 The Pact Broker provides a repository for pacts created using the pact gem. It solves the problem of how to share pacts between consumer and provider projects.
 
+Travis CI Status: [![Build Status](https://travis-ci.org/bethesque/pact_broker.svg?branch=master)](https://travis-ci.org/bethesque/pact_broker)
+
 The Pact Broker:
 
 * Enables pacts to be shared between consumer and provider projects.
@@ -18,7 +20,7 @@ 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.

data/lib/pact_broker/api/contracts/consumer_version_number_validation.rb

@@ -0,0 +1,32 @@
+module PactBroker
+  module Api
+    module Contracts
+      module ConsumerVersionNumberValidation
+
+        include PactBroker::Messages
+
+        def consumer_version_number_present
+          unless consumer_version_number
+            errors.add(:base, validation_message('consumer_version_number_missing'))
+          end
+        end
+
+        def consumer_version_number_valid
+          if consumer_version_number && invalid_consumer_version_number?
+            errors.add(:base, consumer_version_number_validation_message)
+          end
+        end
+
+        def invalid_consumer_version_number?
+          begin
+            Versionomy.parse(consumer_version_number)
+            false
+          rescue Versionomy::Errors::ParseError => e
+            true
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/pact_broker/api/contracts/pacticipant_name_contract.rb

@@ -0,0 +1,27 @@
+require 'reform'
+require 'reform/contract'
+
+module PactBroker
+  module Api
+    module Contracts
+
+      class PacticipantNameContract < Reform::Contract
+        property :name
+        property :name_in_pact
+        property :pacticipant
+        property :message_args
+
+
+        include PactBroker::Messages
+
+        def blank? string
+          string && string.strip.empty?
+        end
+
+        def empty? string
+          string.nil? || blank?(string)
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/contracts/pacticipant_name_validation.rb

@@ -0,0 +1,30 @@
+module PactBroker
+  module Api
+    module Contracts
+      module PacticipantNameValidation
+
+        include PactBroker::Messages
+
+        def name_in_pact_present
+          unless name_in_pact
+            errors.add(:'name', validation_message('pact_missing_pacticipant_name', pacticipant: pacticipant))
+          end
+        end
+
+        def name_not_blank
+          if blank? name
+            errors.add(:'name', validation_message('blank'))
+          end
+        end
+
+        def blank? string
+          string && string.strip.empty?
+        end
+
+        def empty? string
+          string.nil? || blank?(string)
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/contracts/put_pact_params_contract.rb

@@ -0,0 +1,55 @@
+require 'reform'
+require 'reform/contract'
+require 'versionomy'
+require 'pact_broker/messages'
+require 'pact_broker/constants'
+require 'pact_broker/api/contracts/pacticipant_name_contract'
+require 'pact_broker/api/contracts/consumer_version_number_validation'
+
+module PactBroker
+  module Api
+    module Contracts
+
+      class PutPacticipantNameContract < PacticipantNameContract
+
+        validates :name, presence: true, blank: false
+        validate :name_in_path_matches_name_in_pact
+
+        def name_in_path_matches_name_in_pact
+          if present?(name) && present?(name_in_pact)
+            if name != name_in_pact
+              errors.add(:name, validation_message('pacticipant_name_mismatch', message_args))
+            end
+          end
+        end
+
+        def present? string
+          string && !blank?(string)
+        end
+
+      end
+
+      class PutPactParamsContract < Reform::Contract
+
+        include PactBroker::Messages
+
+        property :consumer_version_number
+        property :consumer, form: PutPacticipantNameContract
+        property :provider, form: PutPacticipantNameContract
+
+        validates :consumer_version_number, presence: true
+        validate :consumer_version_number_valid
+
+
+        include ConsumerVersionNumberValidation
+
+        def consumer_version_number_validation_message
+          validation_message('consumer_version_number_invalid', consumer_version_number: consumer_version_number)
+        end
+
+      end
+
+
+    end
+  end
+end

data/lib/pact_broker/api/contracts/request_validations.rb

@@ -0,0 +1,40 @@
+require 'reform'
+require 'reform/contract'
+require 'net/http'
+
+module PactBroker
+  module Api
+    module Contracts
+
+      module RequestValidations
+        def method_is_valid
+          if http_method && !valid_method?
+            errors.add(:method, "is not a recognised HTTP method")
+          end
+        end
+
+        def valid_method?
+          Net::HTTP.const_defined?(http_method.capitalize)
+        end
+
+        def url_is_valid
+          if url && !url_valid?
+            errors.add(:url, "is not a valid URL eg. http://example.org")
+          end
+        end
+
+        def url_valid?
+          uri && uri.scheme && uri.host
+        end
+
+        def uri
+          begin
+            URI(url)
+          rescue URI::InvalidURIError
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pact_broker/api/contracts/webhook_contract.rb

@@ -0,0 +1,32 @@
+require 'reform'
+require 'reform/contract'
+require 'pact_broker/api/contracts/request_validations'
+
+module PactBroker
+  module Api
+    module Contracts
+
+      class WebhookContract < Reform::Contract
+
+        property :request
+        validates :request, presence: true
+
+        property :request do
+
+          include RequestValidations
+
+          property :url
+          property :http_method
+
+          validates :url, presence: true
+          validates :http_method, presence: true
+
+          validate :method_is_valid
+          validate :url_is_valid
+
+        end
+
+      end
+    end
+  end
+end

data/lib/pact_broker/api/pact_broker_urls.rb

@@ -29,6 +29,13 @@ module PactBroker
         "#{pactigration_base_url(base_url, representable_pact)}/version/#{representable_pact.consumer.version.number}"
       end
 
+      def pact_url_from_params base_url, params
+        [ base_url, 'pacts',
+          'provider', url_encode(params[:provider_name]),
+          'consumer', url_encode(params[:consumer_name]),
+          'version', url_encode(params[:consumer_version_number]) ].join('/')
+      end
+
       def latest_pact_url base_url, pact
         "#{pactigration_base_url(base_url, pact)}/latest"
       end

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

@@ -36,6 +36,8 @@ module PactBroker
           end
         end
 
+        alias_method :path_info, :identifier_from_path
+
         def base_url
           request.uri.to_s.gsub(/#{request.uri.path}$/,'')
         end
@@ -99,6 +101,13 @@ module PactBroker
           end
         end
 
+        def contract_validation_errors? contract
+          if (invalid = !contract.validate)
+            set_json_validation_error_messages contract.errors.full_messages
+          end
+          invalid
+        end
+
       end
     end
   end

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

@@ -3,6 +3,8 @@ require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/api/resources/pacticipant_resource_methods'
 require 'pact_broker/api/decorators/pact_decorator'
 require 'pact_broker/json'
+require 'pact_broker/pacts/pact_params'
+require 'pact_broker/api/contracts/put_pact_params_contract'
 
 module PactBroker
 
@@ -28,7 +30,8 @@ module PactBroker
         def malformed_request?
           if request.put?
             return invalid_json? ||
-              potential_duplicate_pacticipants?([identifier_from_path[:consumer_name], identifier_from_path[:provider_name]])
+              contract_validation_errors?(Contracts::PutPactParamsContract.new(pact_params)) ||
+              potential_duplicate_pacticipants?(pact_params.pacticipant_names)
           else
             false
           end
@@ -40,7 +43,7 @@ module PactBroker
 
         def from_json
           response_code = pact ? 200 : 201
-          @pact = pact_service.create_or_update_pact(identifier_from_path.merge(:json_content => request_body))
+          @pact = pact_service.create_or_update_pact(pact_params)
           response.body = to_json
           response_code
         end
@@ -50,7 +53,11 @@ module PactBroker
         end
 
         def pact
-          @pact ||= pact_service.find_pact(identifier_from_path)
+          @pact ||= pact_service.find_pact(pact_params)
+        end
+
+        def pact_params
+          @pact_params ||= PactBroker::Pacts::PactParams.from_request request, path_info
         end
 
       end

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

@@ -2,6 +2,7 @@
 require 'pact_broker/api/resources/base_resource'
 require 'pact_broker/api/decorators/webhook_decorator'
 require 'pact_broker/api/decorators/webhooks_decorator'
+require 'pact_broker/api/contracts/webhook_contract'
 
 module PactBroker
 
@@ -33,6 +34,14 @@ module PactBroker
           false
         end
 
+        def validation_errors? webhook
+          if (errors = webhook_service.errors(webhook)).any?
+            response.headers['Content-Type'] = 'application/json'
+            response.body = {errors: errors.full_messages }.to_json
+          end
+          errors.any?
+        end
+
         def create_path
           webhook_url next_uuid, base_url
         end

data/lib/pact_broker/constants.rb

@@ -0,0 +1,5 @@
+module PactBroker
+
+  CONSUMER_VERSION_HEADER = 'X-Pact-Consumer-Version'.freeze
+
+end

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

@@ -2,9 +2,9 @@
 
 "Pacticipant" - a party that participates in a pact (ie. a Consumer or a Provider).
 
-### Creating participants
+### Creating pacticipants
 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.
+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/locale/en.yml

@@ -2,9 +2,15 @@ en:
   pact_broker:
     errors:
       validation:
+        blank: "cannot be blank."
         attribute_missing: "Missing required attribute '%{attribute}'"
         invalid_http_method: "Invalid HTTP method '%{method}'"
         invalid_url: "Invalid URL '%{url}'. Expected format: http://example.org"
+        pact_missing_pacticipant_name: "was not found at expected path $.%{pacticipant}.name in the submitted pact file."
+        consumer_version_number_missing: "Please specify the consumer version number by setting the X-Pact-Consumer-Version header."
+        consumer_version_number_header_invalid: "X-Pact-Consumer-Version '%{consumer_version_number}' is not recognised as a standard semantic version. eg. 1.3.0 or 2.0.4.rc1"
+        consumer_version_number_invalid: "Consumer version number '%{consumer_version_number}' is not recognised as a standard semantic version. eg. 1.3.0 or 2.0.4.rc1"
+        pacticipant_name_mismatch: "in pact ('%{name_in_pact}') does not match %{pacticipant} name in path ('%{name}')."
       duplicate_pacticipant: |
         This is the first time a pact has been published for "%{new_name}".
         The name "%{new_name}" is very similar to the following existing consumers/providers:

data/lib/pact_broker/messages.rb

@@ -19,6 +19,10 @@ module PactBroker
       ::I18n.t(key, options.merge(:scope => :pact_broker))
     end
 
+    def validation_message key, options = {}
+      message('errors.validation.' + key, options)
+    end
+
     def potential_duplicate_pacticipant_message new_name, potential_duplicate_pacticipants, base_url
       existing_names = potential_duplicate_pacticipants.
         collect{ | p | "* #{p.name}"  }.join("\n")

data/lib/pact_broker/models/webhook.rb

@@ -1,6 +1,7 @@
 require 'pact_broker/models/webhook_request'
 require 'pact_broker/messages'
 require 'pact_broker/logging'
+require 'pact_broker/api/contracts/webhook_contract'
 
 module PactBroker
 
@@ -22,13 +23,6 @@ module PactBroker
         @updated_at = attributes[:updated_at]
       end
 
-      def validate
-        messages = []
-        messages << message('errors.validation.attribute_missing', attribute: 'request') unless request
-        messages.concat request.validate if request
-        messages
-      end
-
       def description
         "A webhook for the pact between #{consumer.name} and #{provider.name}"
       end
@@ -44,7 +38,15 @@ module PactBroker
       end
 
       def to_s
-        "webhook for consumer=#{consumer.name} provider=#{provider.name} uuid=#{uuid} request=#{request}"
+        "webhook for consumer=#{consumer_name} provider=#{provider_name} uuid=#{uuid} request=#{request}"
+      end
+
+      def consumer_name
+        consumer && consumer.name
+      end
+
+      def provider_name
+        provider && provider.name
       end
     end