pact 1.59.0 → 1.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af00495e49852d068acbf8b6506801223c8f0760abfd757fcb73d49f06781060
-  data.tar.gz: cc0598bbde870c213eddcc20bcea43bfc47db77a5fc0faf008239b7a79ef6c5f
+  metadata.gz: 3bbef2d45df174d528bf23ecd3c5b380196789c842d49b32dd7c49478aca0942
+  data.tar.gz: ef0bdd2ea78d03ab7db7eec95c5b5e293495ce5aab33d614daca1ffe4215229b
 SHA512:
-  metadata.gz: 89598a20ef196beff002e418f4aa903b9975c75774ce9c8aa2b7bb4ea978a1d9668bfb83e49325d5c88fbe39c43ed15af880ae7e0e757f9fb44112577f401716
-  data.tar.gz: 6de032e0069da9cb7705e9fb02db2383145449e38865f2367eb68cbea68daa7887ae410ee7bab015ceb292272ab8696d5488bc4a0c310a66127d627fec70dd24
+  metadata.gz: 30e6ab38f2b4475474af538a149ba504462a36438f9b2cd2a4ccf148c2081ee92c973b3bb0d61d07edf19389869e631b6bc7011d4a758b54f752baa341eec715
+  data.tar.gz: abc1767938dcc4e417b3d76798c742f7e4bccbd850cd19cd3034d9ad9e28502c063c5b3272ac75cfd98c008dd5e3786e7a8708fb3f8b3332bb933c6a6b8c1acb

data/CHANGELOG.md

@@ -1,3 +1,42 @@
+<a name="v1.63.0"></a>
+### v1.63.0 (2022-09-28)
+
+#### Features
+
+* relax rack-test dependency to allow version 2 (#270)	 ([a619deb](/../../commit/a619deb))
+* only print metrics warning once per thread	 ([91da38f](/../../commit/91da38f))
+* provide configuration for build url to be published in verification results (#252)	 ([ce1c9bc](/../../commit/ce1c9bc))
+
+#### Bug Fixes
+
+* example/animal-service/Gemfile to reduce vulnerabilities (#263)	 ([8f3b732](/../../commit/8f3b732))
+* Fixup ruby warnings (#262)	 ([3640593](/../../commit/3640593))
+
+<a name="v1.62.0"></a>
+### v1.62.0 (2022-02-21)
+
+#### Features
+
+* add telemetry (#256)	 ([4497ee9](/../../commit/4497ee9))
+
+<a name="v1.61.0"></a>
+### v1.61.0 (2021-12-16)
+
+#### Features
+
+* support description of matching_branch and matching_tag consumer version selectors	 ([8e8bb22](/../../commit/8e8bb22))
+
+#### Bug Fixes
+
+* pass through includePendingStatus to the 'pacts for verification' API when it is false	 ([f0e37a4](/../../commit/f0e37a4))
+
+<a name="v1.60.0"></a>
+### v1.60.0 (2021-10-01)
+
+#### Features
+
+* allow SSL verification to be disabled in the HAL client by setting the environment variable PACT_DISABLE_SSL_VERIFICATION=true	 ([ce07d32](/../../commit/ce07d32))
+
 <a name="v1.59.0"></a>
 ### v1.59.0 (2021-09-07)
 

data/lib/pact/hal/http_client.rb

@@ -2,6 +2,7 @@ require 'pact/retry'
 require 'pact/hal/authorization_header_redactor'
 require 'net/http'
 require 'rack'
+require 'openssl'
 
 module Pact
   module Hal
@@ -48,10 +49,16 @@ module Pact
       def perform_request request, uri
         response = Retry.until_true do
           http = Net::HTTP.new(uri.host, uri.port, :ENV)
-          http.set_debug_output(output_stream) if verbose || ENV['VERBOSE'] == 'true'
+          http.set_debug_output(output_stream) if verbose?
           http.use_ssl = (uri.scheme == 'https')
           http.ca_file = ENV['SSL_CERT_FILE'] if ENV['SSL_CERT_FILE'] && ENV['SSL_CERT_FILE'] != ''
           http.ca_path = ENV['SSL_CERT_DIR'] if ENV['SSL_CERT_DIR'] && ENV['SSL_CERT_DIR'] != ''
+          if disable_ssl_verification?
+            if verbose?
+              Pact.configuration.output_stream.puts("SSL verification is disabled")
+            end
+            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          end
           http.start do |http|
             http.request request
           end
@@ -63,6 +70,14 @@ module Pact
         AuthorizationHeaderRedactor.new(Pact.configuration.output_stream)
       end
 
+      def verbose?
+        verbose || ENV['VERBOSE'] == 'true'
+      end
+
+      def disable_ssl_verification?
+        ENV['PACT_DISABLE_SSL_VERIFICATION'] == 'true' || ENV['PACT_BROKER_DISABLE_SSL_VERIFICATION'] == 'true'
+      end
+
       class Response < SimpleDelegator
         def body
           bod = raw_body

data/lib/pact/hash_refinements.rb

@@ -0,0 +1,17 @@
+module Pact
+  module HashRefinements
+    refine Hash do
+      def compact
+        h = {}
+        each do |key, value|
+          h[key] = value unless value == nil
+        end
+        h
+      end unless Hash.method_defined? :compact
+
+      def compact!
+        reject! {|_key, value| value == nil}
+      end unless Hash.method_defined? :compact!
+    end
+  end
+end

data/lib/pact/pact_broker/fetch_pact_uris_for_verification.rb

@@ -5,10 +5,13 @@ require 'pact/errors'
 require 'pact/pact_broker/fetch_pacts'
 require 'pact/pact_broker/notices'
 require 'pact/pact_broker/pact_selection_description'
+require "pact/hash_refinements"
 
 module Pact
   module PactBroker
     class FetchPactURIsForVerification
+      using Pact::HashRefinements
+
       include PactSelectionDescription
       attr_reader :provider, :consumer_version_selectors, :provider_version_branch, :provider_version_tags, :broker_base_url, :http_client_options, :http_client, :options
 
@@ -74,12 +77,12 @@ module Pact
 
       def query
         q = {}
-        q["includePendingStatus"] = true if options[:include_pending_status]
+        q["includePendingStatus"] = options[:include_pending_status]
         q["consumerVersionSelectors"] = consumer_version_selectors if consumer_version_selectors.any?
         q["providerVersionTags"] = provider_version_tags if provider_version_tags.any?
-        q["providerVersionBranch"] = provider_version_branch if provider_version_branch
-        q["includeWipPactsSince"] = options[:include_wip_pacts_since] if options[:include_wip_pacts_since]
-        q
+        q["providerVersionBranch"] = provider_version_branch
+        q["includeWipPactsSince"] = options[:include_wip_pacts_since]
+        q.compact
       end
 
       def extract_notices(pact)

data/lib/pact/pact_broker/pact_selection_description.rb

@@ -39,6 +39,12 @@ module Pact
             elsif selector[:environment]
               desc = "currently in #{selector[:environment]}"
               desc = "#{selector[:consumer]} #{desc}" if selector[:consumer]
+            elsif selector[:matchingBranch]
+              desc = "matching current branch"
+              desc = "#{desc} for #{selector[:consumer]}" if selector[:consumer]
+            elsif selector[:matchingTag]
+              desc = "matching tag"
+              desc = "#{desc} for #{selector[:consumer]}" if selector[:consumer]
             else
               desc = selector.to_s
             end

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

@@ -46,7 +46,7 @@ module Pact
           end
 
           def honours_pacts_from_pact_broker &block
-            create_pact_verification_from_broker &block
+            create_pact_verification_from_broker(&block)
           end
 
           def builder &block

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

@@ -4,14 +4,15 @@ module Pact
       class ServiceProviderConfig
 
         attr_accessor :application_version
-        attr_reader :branch
+        attr_reader :branch, :build_url
 
-        def initialize application_version, branch, tags, publish_verification_results, &app_block
+        def initialize application_version, branch, tags, publish_verification_results, build_url, &app_block
           @application_version = application_version
           @branch = branch
           @tags = [*tags]
           @publish_verification_results = publish_verification_results
           @app_block = app_block
+          @build_url = build_url
         end
 
         def app

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

@@ -15,7 +15,7 @@ module Pact
 
         extend Pact::DSL
 
-        attr_accessor :name, :app_block, :application_version, :branch, :tags, :publish_verification_results
+        attr_accessor :name, :app_block, :application_version, :branch, :tags, :publish_verification_results, :build_url
 
         CONFIG_RU_APP = lambda {
           unless File.exist? Pact.configuration.config_ru_path
@@ -48,6 +48,10 @@ module Pact
             self.branch = branch
           end
 
+          def build_url build_url
+            self.build_url = build_url
+          end
+
           def publish_verification_results publish_verification_results
             self.publish_verification_results = publish_verification_results
             Pact::RSpec.with_rspec_2 do
@@ -60,7 +64,7 @@ module Pact
           end
 
           def honours_pacts_from_pact_broker &block
-            create_pact_verification_from_broker &block
+            create_pact_verification_from_broker(&block)
           end
         end
 
@@ -89,7 +93,7 @@ module Pact
         end
 
         def create_service_provider
-          Pact.configuration.provider = ServiceProviderConfig.new(application_version, branch, tags, publish_verification_results, &@app_block)
+          Pact.configuration.provider = ServiceProviderConfig.new(application_version, branch, tags, publish_verification_results, build_url, &@app_block)
         end
       end
     end

data/lib/pact/provider/pact_spec_runner.rb

@@ -12,6 +12,7 @@ require 'pact/provider/rspec/pact_broker_formatter'
 require 'pact/provider/rspec/json_formatter'
 require 'pact/provider/rspec'
 require 'pact/provider/rspec/calculate_exit_code'
+require 'pact/utils/metrics'
 
 module Pact
   module Provider
@@ -130,6 +131,8 @@ module Pact
             ignore_failures: options[:ignore_failures],
             request_customizer: options[:request_customizer]
           }
+          Pact::Utils::Metrics.report_metric("Pacts verified", "ProviderTest", "Completed")
+
           honour_pactfile pact_source, ordered_pact_json(pact_source.pact_json), spec_options
         end
       end

data/lib/pact/provider/pact_uri.rb

@@ -3,7 +3,7 @@ module Pact
     class PactURI
       attr_reader :uri, :options, :metadata
 
-      def initialize (uri, options = nil, metadata = nil)
+      def initialize(uri, options = nil, metadata = nil)
         @uri = uri
         @options = options || {}
         @metadata = metadata || {} # make sure it's not nil if nil is passed in

data/lib/pact/provider/state/provider_state.rb

@@ -12,11 +12,11 @@ module Pact
       end
 
       def set_up &block
-        ProviderStates.base_provider_state.register.register_set_up &block
+        ProviderStates.base_provider_state.register.register_set_up(&block)
       end
 
       def tear_down &block
-        ProviderStates.base_provider_state.register_tear_down &block
+        ProviderStates.base_provider_state.register_tear_down(&block)
       end
 
       def provider_states_for name, &block
@@ -60,7 +60,7 @@ module Pact
       end
 
       def self.namespaced_name name, options = {}
-        fullname = options[:for] ? "#{options[:for]}.#{name}" : name
+        options[:for] ? "#{options[:for]}.#{name}" : name
       end
     end
 
@@ -81,11 +81,11 @@ module Pact
 
       dsl do
         def set_up &block
-          self.register_set_up &block
+          self.register_set_up(&block)
         end
 
         def tear_down &block
-          self.register_tear_down &block
+          self.register_tear_down(&block)
         end
 
         def no_op

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

@@ -14,7 +14,13 @@ module Pact
         end
 
         def call
-          VerificationResult.new(publishable?, !any_failures?, Pact.configuration.provider.application_version, test_results_hash_for_pact_uri)
+          VerificationResult.new(
+            publishable?,
+            !any_failures?,
+            Pact.configuration.provider.application_version,
+            test_results_hash_for_pact_uri,
+            Pact.configuration.provider.build_url
+          )
         end
 
         private

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

@@ -6,11 +6,12 @@ module Pact
       class VerificationResult
         attr_reader :success, :provider_application_version, :test_results_hash
 
-        def initialize publishable, success, provider_application_version, test_results_hash
+        def initialize publishable, success, provider_application_version, test_results_hash, build_url
           @publishable = publishable
           @success = success
           @provider_application_version = provider_application_version
           @test_results_hash = test_results_hash
+          @build_url = build_url
         end
 
         def publishable?
@@ -25,7 +26,8 @@ module Pact
           {
             success: success,
             providerApplicationVersion: provider_application_version,
-            testResults: test_results_hash
+            testResults: test_results_hash,
+            buildUrl: @build_url
           }.to_json(options)
         end
 

data/lib/pact/utils/metrics.rb

@@ -0,0 +1,100 @@
+require 'securerandom'
+require 'digest'
+require 'socket'
+require 'pact/version'
+require 'net/http'
+
+module Pact
+  module Utils
+    class Metrics
+
+      def self.report_metric(event, category, action, value = 1)
+        do_once_per_thread(:pact_metrics_message_shown) do
+          if track_events?
+            Pact.configuration.output_stream.puts "pact WARN: Please note: we are tracking events anonymously to gather important usage statistics like Pact-Ruby version
+              and operating system. To disable tracking, set the 'PACT_DO_NOT_TRACK' environment
+              variable to 'true'."
+          end
+        end
+
+        in_thread do
+          begin
+            if track_events?
+              uri = URI('https://www.google-analytics.com/collect')
+              req = Net::HTTP::Post.new(uri)
+              req.set_form_data(create_tracking_event(event, category, action, value))
+
+              Net::HTTP.start(uri.hostname, uri.port, read_timeout:2, open_timeout:2, :use_ssl => true  ) do |http|
+                http.request(req)
+              end
+            end
+          rescue StandardError => e
+            handle_error(e)
+          end
+        end
+      end
+
+      private
+
+      def self.handle_error e
+        if ENV['PACT_METRICS_DEBUG'] == 'true'
+          Pact.configuration.output_stream.puts("DEBUG: #{e.inspect}\n" + e.backtrace.join("\n"))
+        end
+      end
+
+      def self.in_thread
+        Thread.new do
+          yield
+        end
+      end
+
+      # not super safe to use the thread, but it's good enough for this usecase
+      def self.do_once_per_thread(key)
+        result = nil
+        if !Thread.current[key]
+          result = yield
+        end
+        Thread.current[key] = true
+        result
+      end
+
+      def self.create_tracking_event(event, category, action, value)
+        {
+          "v" => 1,
+          "t" => "event",
+          "tid" => "UA-117778936-1",
+          "cid" => calculate_cid,
+          "an" => "Pact Ruby",
+          "av" => Pact::VERSION,
+          "aid" => "pact-ruby",
+          "aip" => 1,
+          "ds" => ENV['PACT_EXECUTING_LANGUAGE'] ? "client" : "cli",
+          "cd2" => ENV['CI'] == "true" ? "CI" : "unknown",
+          "cd3" => RUBY_PLATFORM,
+          "cd6" => ENV['PACT_EXECUTING_LANGUAGE'] || "unknown",
+          "cd7" => ENV['PACT_EXECUTING_LANGUAGE_VERSION'],
+          "el" => event,
+          "ec" => category,
+          "ea" => action,
+          "ev" => value
+        }
+      end
+
+      def self.track_events?
+        ENV['PACT_DO_NOT_TRACK'] != 'true'
+      end
+
+      def self.calculate_cid
+        if RUBY_PLATFORM.include? "windows"
+          hostname = ENV['COMPUTERNAME']
+        else
+          hostname = ENV['HOSTNAME']
+        end
+        if !hostname
+          hostname = Socket.gethostname
+        end
+        Digest::MD5.hexdigest hostname || SecureRandom.urlsafe_base64(5)
+      end
+    end
+  end
+end

data/lib/pact/version.rb

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

data/pact.gemspec

@@ -27,20 +27,20 @@ Gem::Specification.new do |gem|
   }
 
   gem.add_runtime_dependency 'rspec', '~> 3.0'
-  gem.add_runtime_dependency 'rack-test', '>= 0.6.3', '< 2.0.0'
+  gem.add_runtime_dependency 'rack-test', '>= 0.6.3', '< 3.0.0'
   gem.add_runtime_dependency 'thor', '>= 0.20', '< 2.0'
   gem.add_runtime_dependency 'webrick', '~> 1.3'
   gem.add_runtime_dependency 'term-ansicolor', '~> 1.0'
 
-  gem.add_runtime_dependency 'pact-support', '~> 1.15'
+  gem.add_runtime_dependency 'pact-support', '~> 1.16', '>= 1.16.9'
   gem.add_runtime_dependency 'pact-mock_service', '~> 3.0', '>= 3.3.1'
 
   gem.add_development_dependency 'rake', '~> 13.0'
   gem.add_development_dependency 'webmock', '~> 3.0'
   gem.add_development_dependency 'fakefs', '0.5' # 0.6.0 blows up
   gem.add_development_dependency 'hashie', '~> 2.0'
-  gem.add_development_dependency 'activesupport', '~> 5.2'
-  gem.add_development_dependency 'faraday', '~> 0.13'
+  gem.add_development_dependency 'faraday', '~>1.0', '<3.0'
+  gem.add_development_dependency 'faraday-multipart', '~> 1.0'
   gem.add_development_dependency 'conventional-changelog', '~> 1.3'
   gem.add_development_dependency 'bump', '~> 0.5'
   gem.add_development_dependency 'pact-message', '~> 0.8'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact
 version: !ruby/object:Gem::Version
-  version: 1.59.0
+  version: 1.63.0
 platform: ruby
 authors:
 - James Fraser
@@ -9,10 +9,10 @@ authors:
 - Brent Snook
 - Ronald Holshausen
 - Beth Skurrie
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2022-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -37,7 +37,7 @@ dependencies:
         version: 0.6.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,7 +47,7 @@ dependencies:
         version: 0.6.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -102,14 +102,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.9
 - !ruby/object:Gem::Dependency
   name: pact-mock_service
   requirement: !ruby/object:Gem::Requirement
@@ -187,33 +193,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: faraday-multipart
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: conventional-changelog
   requirement: !ruby/object:Gem::Requirement
@@ -321,6 +333,7 @@ files:
 - lib/pact/hal/http_client.rb
 - lib/pact/hal/link.rb
 - lib/pact/hal/non_json_entity.rb
+- lib/pact/hash_refinements.rb
 - lib/pact/pact_broker.rb
 - lib/pact/pact_broker/fetch_pact_uris_for_verification.rb
 - lib/pact/pact_broker/fetch_pacts.rb
@@ -378,6 +391,7 @@ files:
 - lib/pact/tasks/verification_task.rb
 - lib/pact/templates/help.erb
 - lib/pact/templates/provider_state.erb
+- lib/pact/utils/metrics.rb
 - lib/pact/utils/string.rb
 - lib/pact/version.rb
 - lib/tasks/pact.rake
@@ -390,7 +404,7 @@ metadata:
   source_code_uri: https://github.com/pact-foundation/pact-ruby
   bug_tracker_uri: https://github.com/pact-foundation/pact-ruby/issues
   documentation_uri: https://github.com/pact-foundation/pact-ruby/blob/master/README.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -405,8 +419,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
-signing_key: 
+rubygems_version: 3.3.22
+signing_key:
 specification_version: 4
 summary: Enables consumer driven contract testing, providing a mock service and DSL
   for the consumer project, and interaction playback and verification for the service