pact 1.26.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: cb658bf653b3a96004e3e9907a879b94ac723796ce3dc0d3eb49bca8cf9d9dae
-  data.tar.gz: f700d052cfbe66ed2a53ef4be267b96994ce940ea4683a7da22fd46a24133384
+SHA1:
+  metadata.gz: 863f88ef054fb71549db6134a969beaf7ded3f35
+  data.tar.gz: 444f03ebae284db7197842e7be35008a976d5779
 SHA512:
-  metadata.gz: 0f01bb647d4065caff16740a52ae2b9141c4aa0c0220a7afcac4bba29958e48ebe1e282ed2fe3ff8027d7a66a4d503fdf88e54b4c955f169454e7090ea5935fe
-  data.tar.gz: cc372af0a41fea7417382d2f3d5671093b3c6aced8afc00d8c52e55ea02206241233b8b157f9beecffa4fe2318ab793cf3ac5a3e8f8a2e149f44b484946b6402
+  metadata.gz: 248b0ed165715ea29e49f74ed98990020908b5f56b08b22bb2b9744c4e0e18066fabb064629883d95bc462e4e2239032a17528a2172e0502efe54ec788cc3f3d
+  data.tar.gz: 848fb4bb48b346947d787843a0b84613063bfb1d2bfeac6f575a3d35a14b9db8ac5bf398f16bf73c478f4764df11feb3bf7451f9fe4b1e25ece2f18b708d4c1a

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+<a name="v1.27.0"></a>
+### v1.27.0 (2018-06-22)
+
+
+#### Features
+
+* log tagging to stdout when publishing verification results	 ([2387424](/../../commit/2387424))
+* Dynamically retrieve pacts for a given provider	 ([5aca966](/../../commit/5aca966))
+
+
+#### Bug Fixes
+
+* correct request url in http client	 ([1fb22b6](/../../commit/1fb22b6))
+* correctly escape expanded URL in the HAL client	 ([821238d](/../../commit/821238d))
+
+
 <a name="v1.26.0"></a>
 ### v1.26.0 (2018-05-08)
 

data/lib/pact/hal/entity.rb

@@ -0,0 +1,76 @@
+require 'uri'
+require 'delegate'
+require 'pact/hal/link'
+
+module Pact
+  module Hal
+    class Entity
+      def initialize(data, http_client, response = nil)
+        @data = data
+        @links = (@data || {}).fetch("_links", {})
+        @client = http_client
+        @response = response
+      end
+
+      def get(key, *args)
+        _link(key).get(*args)
+      end
+
+      def post(key, *args)
+        _link(key).post(*args)
+      end
+
+      def put(key, *args)
+        _link(key).put(*args)
+      end
+
+      def can?(key)
+        @links.key? key.to_s
+      end
+
+      def follow(key, http_method, *args)
+        Link.new(@links[key].merge(method: http_method), @client).run(*args)
+      end
+
+      def _link(key)
+        if @links[key]
+          Link.new(@links[key], @client)
+        else
+          nil
+        end
+      end
+
+      def success?
+        true
+      end
+
+      def response
+        @response
+      end
+
+      def fetch(key)
+        @links[key]
+      end
+
+      def method_missing(method_name, *args, &block)
+        if @data.key?(method_name.to_s)
+          @data[method_name.to_s]
+        elsif @links.key?(method_name)
+          Link.new(@links[method_name], @client).run(*args)
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        @data.key?(method_name) || @links.key?(method_name)
+      end
+    end
+
+    class ErrorEntity < Entity
+      def success?
+        false
+      end
+    end
+  end
+end

data/lib/pact/hal/http_client.rb

@@ -0,0 +1,69 @@
+require 'pact/retry'
+
+module Pact
+  module Hal
+    class HttpClient
+      attr_accessor :username, :password
+
+      def initialize options
+        @username = options[:username]
+        @password = options[:password]
+      end
+
+      def get href, params = {}, headers = {}
+        query = params.collect{ |(key, value)| "#{CGI::escape(key)}=#{CGI::escape(value)}" }.join("&")
+        uri = URI(href)
+        uri.query = query
+        perform_request(create_request(uri, 'Get', nil, headers), uri)
+      end
+
+      def put href, body = nil, headers = {}
+        uri = URI(href)
+        perform_request(create_request(uri, 'Put', body, headers), uri)
+      end
+
+      def post href, body = nil, headers = {}
+        uri = URI(href)
+        perform_request(create_request(uri, 'Post', body, headers), uri)
+      end
+
+      def create_request uri, http_method, body = nil, headers = {}
+        request = Net::HTTP.const_get(http_method).new(uri.request_uri)
+        request['Content-Type'] = "application/json" if ['Post', 'Put', 'Patch'].include?(http_method)
+        request['Accept'] = "application/hal+json"
+        headers.each do | key, value |
+          request[key] = value
+        end
+
+        request.body = body if body
+        request.basic_auth username, password if username
+        request
+      end
+
+      def perform_request request, uri
+        options = {:use_ssl => uri.scheme == 'https'}
+        response = Retry.until_true do
+          Net::HTTP.start(uri.host, uri.port, :ENV, options) do |http|
+            http.request request
+          end
+        end
+        Response.new(response)
+      end
+
+      class Response < SimpleDelegator
+        def body
+          bod = __getobj__().body
+          if bod && bod != ''
+            JSON.parse(bod)
+          else
+            nil
+          end
+        end
+
+        def success?
+          __getobj__().code.start_with?("2")
+        end
+      end
+    end
+  end
+end

data/lib/pact/hal/link.rb

@@ -0,0 +1,65 @@
+require 'uri'
+require 'delegate'
+
+module Pact
+  module Hal
+    class Link
+      attr_reader :request_method, :href
+
+      def initialize(attrs, http_client)
+        @attrs = attrs
+        @request_method = attrs.fetch(:method, :get).to_sym
+        @href = attrs.fetch('href')
+        @http_client = http_client
+      end
+
+      def run(payload = nil)
+        response = case request_method
+          when :get
+            get(payload)
+          when :put
+            put(payload)
+          when :post
+            post(payload)
+          end
+      end
+
+      def get(payload = {}, headers = {})
+        wrap_response(@http_client.get(href, payload, headers))
+      end
+
+      def put(payload = nil, headers = {})
+        wrap_response(@http_client.put(href, payload ? JSON.dump(payload) : nil, headers))
+      end
+
+      def post(payload = nil, headers = {})
+        wrap_response(@http_client.post(href, payload ? JSON.dump(payload) : nil, headers))
+      end
+
+      def expand(params)
+        expanded_url = expand_url(params, href)
+        new_attrs = @attrs.merge('href' => expanded_url)
+        Link.new(new_attrs, @http_client)
+      end
+
+      private
+
+      def wrap_response(http_response)
+        require 'pact/hal/entity' # avoid circular reference
+        if http_response.success?
+          Entity.new(http_response.body, @http_client, http_response)
+        else
+          ErrorEntity.new(http_response.body, @http_client, http_response)
+        end
+      end
+
+      def expand_url(params, url)
+        new_url = url
+        params.each do | key, value |
+          new_url = new_url.gsub('{' + key.to_s + '}', URI.escape(value))
+        end
+        new_url
+      end
+    end
+  end
+end

data/lib/pact/pact_broker/fetch_pacts.rb

@@ -0,0 +1,89 @@
+require 'pact/hal/entity'
+require 'pact/hal/http_client'
+
+module Pact
+  module PactBroker
+    class FetchPacts
+      attr_reader :provider, :tags, :broker_base_url, :basic_auth_options, :http_client, :index_entity, :all_pacts
+
+      ALL_PROVIDER_TAG_RELATION = 'pb:provider-pacts-with-tag'.freeze
+      LATEST_PROVIDER_TAG_RELATION = 'pb:latest-provider-pacts-with-tag'.freeze
+      ALL_PROVIDER_RELATION = 'pb:provider-pacts'.freeze
+      LATEST_PROVIDER_RELATION = 'pb:latest-provider-pacts'.freeze
+      PACTS = 'pacts'.freeze
+      HREF = 'href'.freeze
+
+      def initialize(provider, tags, broker_base_url, basic_auth_options, all_pacts)
+        @provider = provider
+        @tags = tags
+        @broker_base_url = broker_base_url
+        @http_client = Pact::Hal::HttpClient.new(basic_auth_options)
+        @all_pacts = all_pacts
+      end
+
+      def self.call(provider, tags, broker_base_url, basic_auth_options, all_pacts)
+        new(provider, tags, broker_base_url, basic_auth_options, all_pacts).call
+      end
+
+      def call
+        get_index
+        if tags && tags.any?
+          get_tagged_pacts_for_provider
+        else
+          get_pacts_for_provider
+        end
+      end
+
+      private
+
+      def get_pacts_for_provider
+        if all_pacts
+          get_all_pacts_for_provider
+        else
+          get_latest_pacts_for_provider
+        end
+      end
+
+      def get_tagged_pacts_for_provider
+        if all_pacts
+          get_all_tagged_pacts_for_provider
+        else
+          get_latest_tagged_pacts_for_provider
+        end
+      end
+
+      def get_index
+        response = http_client.get(broker_base_url)
+        @index_entity = Pact::Hal::Entity.new(response.body, http_client)
+      end
+
+      def get_latest_tagged_pacts_for_provider
+        link = index_entity._link(LATEST_PROVIDER_TAG_RELATION)
+        tags.collect do | tag |
+          get_pact_urls(link.expand(provider: provider, tag: tag).get)
+        end.flatten
+      end
+
+      def get_all_tagged_pacts_for_provider
+        link = index_entity._link(ALL_PROVIDER_TAG_RELATION)
+        tags.collect do |tag|
+          get_pact_urls(link.expand(provider: provider, tag: tag).get)
+        end.flatten
+      end
+
+      def get_latest_pacts_for_provider
+        link = index_entity._link(LATEST_PROVIDER_RELATION)
+        get_pact_urls(link.expand(provider: provider).get)
+      end
+
+      def get_all_pacts_for_provider
+        link = index_entity._link(ALL_PROVIDER_RELATION)
+        get_pact_urls(link.expand(provider: provider).get)
+      end
+
+      def get_pact_urls(link_by_provider)
+        link_by_provider.fetch(PACTS).collect{ |pact | pact[HREF] }
+      end
+    end
+  end
+end

data/lib/pact/provider/configuration/service_provider_dsl.rb

@@ -1,5 +1,6 @@
 require 'pact/provider/configuration/pact_verification'
 require 'pact/provider/configuration/service_provider_config'
+require 'pact/errors'
 
 module Pact
 

data/lib/pact/provider/verification_results/publish.rb

@@ -1,6 +1,8 @@
 require 'json'
 require 'pact/errors'
 require 'pact/retry'
+require 'pact/hal/entity'
+require 'pact/hal/http_client'
 
 # TODO move this to the pact broker client
 
@@ -10,6 +12,11 @@ module Pact
       class PublicationError < Pact::Error; end
 
       class Publish
+
+        PUBLISH_RELATION = 'pb:publish-verification-results'.freeze
+        PROVIDER_RELATION = 'pb:provider'.freeze
+        VERSION_TAG_RELATION = 'pb:version-tag'.freeze
+
         def self.call pact_source, verification_result
           new(pact_source, verification_result).call
         end
@@ -17,6 +24,15 @@ module Pact
         def initialize pact_source, verification_result
           @pact_source = pact_source
           @verification_result = verification_result
+
+          http_client_options = {}
+          if pact_source.uri.basic_auth?
+            http_client_options[:username] = pact_source.uri.username
+            http_client_options[:password] = pact_source.uri.password
+          end
+
+          @http_client = Pact::Hal::HttpClient.new(http_client_options)
+          @pact_entity = Pact::Hal::Entity.new(pact_source.pact_hash, http_client)
         end
 
         def call
@@ -27,11 +43,12 @@ module Pact
         end
 
         private
+        attr_reader :pact_source, :verification_result, :pact_entity, :http_client
 
         def can_publish_verification_results?
           return false unless Pact.configuration.provider.publish_verification_results?
 
-          if publication_url.nil?
+          if !pact_entity.can?(PUBLISH_RELATION)
             Pact.configuration.error_stream.puts "WARN: Cannot publish verification for #{consumer_name} as there is no link named pb:publish-verification-results in the pact JSON. If you are using a pact broker, please upgrade to version 2.0.0 or later."
             return false
           end
@@ -43,94 +60,60 @@ module Pact
           true
         end
 
-        def publication_url
-          @publication_url ||= pact_source.pact_hash.fetch('_links', {}).fetch('pb:publish-verification-results', {})['href']
-        end
-
-        def tag_url tag
-          # This is so dodgey, need to use proper HAL
-          if publication_url
-            u = URI(publication_url)
-            if match = publication_url.match(%r{/provider/([^/]+)})
-              provider_name = match[1]
-              base_url = "#{u.scheme}://#{u.host}:#{u.host == u.default_port ? '' : u.port}"
-              provider_application_version = Pact.configuration.provider.application_version
-              "#{base_url}/pacticipants/#{provider_name}/versions/#{provider_application_version}/tags/#{tag}"
-            end
-          end
+        def hacky_tag_url provider_entity
+          hacky_tag_url = provider_entity._link('self').href + "/versions/{version}/tags/{tag}"
+          Pact::Hal::Link.new('href' => hacky_tag_url)
         end
 
         def tag_versions_if_configured
           if Pact.configuration.provider.tags.any?
-            tag_versions if tag_url('')
+            if pact_entity.can?(PROVIDER_RELATION)
+              tag_versions
+            else
+              Pact.configuration.error_stream.puts "WARN: Could not tag provider version as the pb:provider link cannot be found"
+            end
           end
         end
 
         def tag_versions
-          Pact.configuration.provider.tags.each do | tag |
-            uri = URI(tag_url(tag))
-            request = build_request('Put', uri, nil, "Tagging provider version at")
-            response = nil
-            begin
-              options = {:use_ssl => uri.scheme == 'https'}
-              Retry.until_true do
-                response = Net::HTTP.start(uri.host, uri.port, options) do |http|
-                  http.request request
-                end
-              end
-            rescue StandardError => e
-              error_message = "Failed to tag provider version due to: #{e.class} #{e.message}"
-              raise PublicationError.new(error_message)
-            end
+          provider_entity = pact_entity.get(PROVIDER_RELATION)
+          tag_link = provider_entity._link(VERSION_TAG_RELATION) || hacky_tag_url(provider_entity)
+          provider_application_version = Pact.configuration.provider.application_version
 
-            unless response.code.start_with?("2")
-              raise PublicationError.new("Error returned from tagging request #{response.code} #{response.body}")
+          Pact.configuration.provider.tags.each do | tag |
+            Pact.configuration.output_stream.puts "INFO: Tagging version #{provider_application_version} of #{provider_name} as #{tag.inspect}"
+            tag_entity = tag_link.expand(version: provider_application_version, tag: tag).put
+            unless tag_entity.success?
+              raise PublicationError.new("Error returned from tagging request #{tag_entity.response.code} #{tag_entity.response.body}")
             end
           end
         end
 
         def publish_verification_results
-          uri = URI(publication_url)
-          request = build_request('Post', uri, verification_result.to_json, "Publishing verification result #{verification_result} to")
-          response = nil
+          verification_entity = nil
           begin
-            options = {:use_ssl => uri.scheme == 'https'}
-            Retry.until_true do
-              response = Net::HTTP.start(uri.host, uri.port, options) do |http|
-                http.request request
-              end
-            end
+            # The verifications resource didn't have the content_types_provided set correctly, so publishing fails if we don't have */*
+            verification_entity = pact_entity.post(PUBLISH_RELATION, verification_result, { "Accept" => "application/hal+json, */*" })
           rescue StandardError => e
-            error_message = "Failed to publish verification results due to: #{e.class} #{e.message}"
+            error_message = "Failed to publish verification results due to: #{e.class} #{e.message} #{e.backtrace.join("\n")}"
             raise PublicationError.new(error_message)
           end
 
-          if response.code.start_with?("2")
-            new_resource_url = JSON.parse(response.body)['_links']['self']['href']
+          if verification_entity.success?
+            new_resource_url = verification_entity._link('self').href
             Pact.configuration.output_stream.puts "INFO: Verification results published to #{new_resource_url}"
           else
-            raise PublicationError.new("Error returned from verification results publication #{response.code} #{response.body}")
+            raise PublicationError.new("Error returned from verification results publication #{verification_entity.response.code} #{verification_entity.response.body}")
           end
         end
 
-        def build_request meth, uri, body, action
-          request = Net::HTTP.const_get(meth).new(uri.path)
-          request['Content-Type'] = "application/json"
-          request.body = body if body
-          debug_uri = uri
-          if pact_source.uri.basic_auth?
-            request.basic_auth pact_source.uri.username, pact_source.uri.password
-            debug_uri = URI(uri.to_s).tap { |x| x.userinfo="#{pact_source.uri.username}:*****"}
-          end
-          Pact.configuration.output_stream.puts "INFO: #{action} #{debug_uri}"
-          request
-        end
-
         def consumer_name
           pact_source.pact_hash['consumer']['name']
         end
 
-        attr_reader :pact_source, :verification_result
+        def provider_name
+          pact_source.pact_hash['provider']['name']
+        end
       end
     end
   end

data/lib/pact/provider/verification_results/verification_result.rb

@@ -20,12 +20,12 @@ module Pact
           !!provider_application_version
         end
 
-        def to_json
+        def to_json(options = {})
           {
             success: success,
             providerApplicationVersion: provider_application_version,
             #testResults: test_results_hash # not yet
-          }.to_json
+          }.to_json(options)
         end
 
         def to_s

data/lib/pact/version.rb

@@ -1,4 +1,4 @@
 # Remember to bump pact-provider-proxy when this changes major version
 module Pact
-  VERSION = "1.26.0"
+  VERSION = "1.27.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.26.0
+  version: 1.27.0
 platform: ruby
 authors:
 - James Fraser
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: randexp
@@ -332,6 +332,10 @@ files:
 - lib/pact/doc/markdown/interaction.erb
 - lib/pact/doc/markdown/interaction_renderer.rb
 - lib/pact/doc/sort_interactions.rb
+- lib/pact/hal/entity.rb
+- lib/pact/hal/http_client.rb
+- lib/pact/hal/link.rb
+- lib/pact/pact_broker/fetch_pacts.rb
 - lib/pact/project_root.rb
 - lib/pact/provider.rb
 - lib/pact/provider/configuration.rb
@@ -403,7 +407,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Enables consumer driven contract testing, providing a mock service and DSL