pact-message 0.6.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 26c0cea21dd41b6f907a255478162aaa8cd51cca
-  data.tar.gz: b62a0f0fb8e0d13abbd996ca86b9ae826ae032b2
+SHA256:
+  metadata.gz: f26e9b2d322f3bb375df2197aa2180f8de0b4d62e45decf77e4c4b3802505ffa
+  data.tar.gz: 130523097c7c65ddc0bf9d9dbf4464d7d17dfb7de97c7ef97471535be265e382
 SHA512:
-  metadata.gz: f816074ffebe0ea7d9a89c21bb971ddee873e67b9a8f872e2077e64ac9e610831c4578680a057e62b719b8de64016c6c76932a377d09e0221615bb3588d069f4
-  data.tar.gz: d64e741d000004653b13b760ad3be4a2cb49a3bc64b45b45d50cf04e9f28b158d4c06cd808206b9729f183870097ef4eba45e7c2f4d049394791eeb9c92f3957
+  metadata.gz: 184da6d526714237d5ec94c7a27b5c8e8562a91023cd6ede596e6a7aa8adf34ba1249650a01f4f50bcdcbd78fa529799cfd04922a00a51f90f832477f7cd35ff
+  data.tar.gz: 8b24b7de4e4d24c41e4520d5ba0008d3ca719f7be4c17fa7c0d70d7bf4ea0fcb32e1910fcb37b543b4040d16e02f9ac672e478dfe06f6961bdbff86a67b7378f

data/.github/workflows/release_gem.yml

@@ -0,0 +1,45 @@
+---
+name: "Release gem"
+
+on:
+  repository_dispatch:
+    types:
+      - release-triggered
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - id: release-gem
+        uses: pact-foundation/release-gem@v0.0.11
+        env:
+          GEM_HOST_API_KEY: "${{ secrets.RUBYGEMS_API_KEY }}"
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          INCREMENT: "${{ github.event.client_payload.increment }}"
+    outputs:
+      gem_name: "${{ steps.release-gem.outputs.gem_name }}"
+      version: "${{ steps.release-gem.outputs.version }}"
+      increment: "${{ steps.release-gem.outputs.increment }}"
+
+  notify-gem-released:
+    needs: release
+    strategy:
+      matrix:
+        repository: [pact-foundation/pact-ruby-cli, pact-foundation/pact-ruby-standalone]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Notify ${{ matrix.repository }} of gem release
+        uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.GHTOKENFORPACTCLIRELEASE }}
+          repository: ${{ matrix.repository }}
+          event-type: gem-released
+          client-payload: |
+              {
+                "name": "${{ needs.release.outputs.gem_name }}",
+                "version": "${{ needs.release.outputs.version }}",
+                "increment": "${{ needs.release.outputs.increment }}"
+              }

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: "ubuntu-latest"
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version: ["2.2", "2.7"]
+        experimental: [false]
+        include:
+          - ruby_version: "3.0"
+            experimental: true
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - run: "bundle install"
+      - run: "bundle exec rake"

data/.gitignore

@@ -12,3 +12,4 @@ spec/pacts/zoo_consumer-zoo_provider.json
 
 # rspec failure tracking
 .rspec_status
+spec/pacts/

data/CHANGELOG.md

@@ -1,3 +1,69 @@
+<a name="v0.11.0"></a>
+### v0.11.0 (2021-03-22)
+
+#### Features
+
+* update thor dependancy	 ([87a5f64](/../../commit/87a5f64))
+
+<a name="v0.10.0"></a>
+### v0.10.0 (2021-01-22)
+
+#### Features
+
+* allow pact-message update to receive JSON via the standard input	 ([5cbb664](/../../commit/5cbb664))
+
+<a name="v0.9.0"></a>
+### v0.9.0 (2020-11-04)
+
+#### Features
+
+* allow pact dir to be configured	 ([f2f9626](/../../commit/f2f9626))
+* verify that each message has been yielded	 ([1d4d92c](/../../commit/1d4d92c))
+
+* **consumer**
+  * only update pact if test suite passes	 ([e99276d](/../../commit/e99276d))
+
+<a name="v0.8.0"></a>
+### v0.8.0 (2020-09-28)
+
+#### Features
+
+* reify message when yielding	 ([d7c0a4a](/../../commit/d7c0a4a))
+
+#### Bug Fixes
+
+* fix bug in Message.to_hash	 ([e354cd2](/../../commit/e354cd2))
+
+<a name="v0.7.0"></a>
+### v0.7.0 (2020-02-10)
+
+
+#### Features
+
+* Add metadata to a message request	 ([796590f](/../../commit/796590f))
+* support the _id attribute from the Pact Broker, and give each message an index	 ([3a05501](/../../commit/3a05501))
+
+
+#### Bug Fixes
+
+* add back support for using providerState instead of providerStates when updating a pact	 ([b494a76](/../../commit/b494a76))
+
+
+<a name="v0.6.0"></a>
+### v0.6.0 (2020-02-10)
+
+
+#### Features
+
+* Add metadata to a message request	 ([796590f](/../../commit/796590f))
+* support the _id attribute from the Pact Broker, and give each message an index	 ([3a05501](/../../commit/3a05501))
+
+
+#### Bug Fixes
+
+* add back support for using providerState instead of providerStates when updating a pact	 ([b494a76](/../../commit/b494a76))
+
+
 <a name="v0.5.0"></a>
 ### v0.5.0 (2018-10-04)
 

data/Dockerfile-bundle-base

@@ -0,0 +1,15 @@
+FROM ruby:2.2.4-alpine
+
+# Installation path
+ENV HOME=/app
+WORKDIR $HOME
+
+RUN set -ex && \
+  adduser -h $HOME -s /bin/false -D -S -G root ruby && \
+  chmod g+w $HOME && \
+  apk add --update --no-cache make gcc libc-dev git
+
+RUN gem install bundler -v 1.17.3
+COPY Gemfile pact-message.gemspec $HOME/
+COPY lib/pact/message/version.rb $HOME/lib/pact/message/version.rb
+RUN bundle install --no-cache

data/README.md

@@ -4,13 +4,14 @@
 
 Create and verify consumer driven contracts for messages.
 
-This project is still under development and is not ready for production use.
+
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
+gem 'pact'
 gem 'pact-message'
 ```
 
@@ -20,15 +21,129 @@ And then execute:
 
 Or install it yourself as:
 
+    $ gem install pact
     $ gem install pact-message
 
 ## Usage
 
+The key to using Message Pact is to completely separate the business logic that creates the message from the transmission protocol (eg. Kafka, Websockets, Lambda). This allows you to write a contract for the message contents, no matter how it is communicated.
+
+### Consumer
+
+Not finished yet as nobody has asked for it. Ping @Beth Skurrie on slack.pact.io if you'd like use this.
+
+### Provider
+
+Also called a "producer". Message pact verification follows all the same principles as HTTP pact verification, except that instead of verifying that a provider can make the expected HTTP response, we are verifying that the provider can create the expected message. Please read the HTTP Pact [verification](https://github.com/pact-foundation/pact-ruby/wiki/Verifying-pacts) documentation. The only difference is in the configuration block. Use `message_provider` instead of `service_provider`, and configure a `builder` block that takes a `|description|` argument, instead of a Rack `app` block.
 
+Make sure you've required 'pact/message' as well as 'pact'.
+
+```ruby
+require 'pact'
+require 'pact/message'
+
+Pact.message_provider "MyMessageProvider" do  
+  honours_pact_with "MyMessageConsumer" do
+    pact_uri "/path/or/url/to/your/pact", { 
+                          username: "optional username", 
+                          password: "optional password", 
+                          token: "optional token"
+                        }
+  end
+  
+  # or
+  
+  honours_pacts_from_pact_broker do
+    # See docs at https://github.com/pact-foundation/pact-ruby/wiki/Verifying-pacts
+  end
+  
+  builder do |message_description|
+    #... code that accepts a message description and returns 
+    # a message hash that should match what is expected in the pact
+  do
+end
+
+```
+
+How you map between the message description and the code that creates the message is up to you. The easiest way is something like this:
+
+```ruby
+class MyMessageProvider
+  def create_hello_message
+    {
+      text: "Hello world"
+    }
+  end
+end
+
+CONFIG = {
+  "a hello message" => lambda { MyMessageProvider.new.create_hello_message }
+}
+
+Pact.message_provider "SomeProvider" do
+  builder do |description|
+    CONFIG[description].call
+  do
+end
+
+```
+
+#### Provider states
+
+Provider states work the same way for Message Pact as they do for HTTP Pact. Please read the [provider state](https://github.com/pact-foundation/pact-ruby#using-provider-states) docs in the HTTP Pact project.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Setup
+
+After checking out the repo, run the following to install dependencies.
+
+```bash
+$ bundle exec bin/setup
+
+bundle install
+\+ bundle install
+...
+Bundle complete! 6 Gemfile dependencies, 29 gems now installed.
+Use `bundle info [gemname]` to see where a bundled gem is installed.
+
+Do any other automated setup that you need to do here
+```
+
+### Tests
+
+Run the following command to run the tests.
+
+```bash
+$ bundle exec rake spec
+
+the CLI
+  creates a pact file with the given message
+  creates a pact file with a message from the standard input
+...
+Finished in 0.50883 seconds (files took 0.15053 seconds to load)
+26 examples, 0 failures, 2 pending
+```
+
+### Interactive Prompt
+
+You can run the following command for an for an interactive prompt that will allow you to experiment.
+
+```bash
+$ bundle exec bin/console
+2.6.6 :001 >
+```
+
+To execute commands on the CLI run the following command followed by command line arguments as you would with the published version.
+
+```bash
+$ bundle exec bin/pact-message
+Commands:
+  pact-message help [COMMAND]                                                                   # Describe available commands or one specific command
+  pact-message reify                                                                            # Take a JSON document with embedded pact matchers and return...
+  pact-message update MESSAGE_JSON --consumer=CONSUMER --pact-dir=PACT_DIR --provider=PROVIDER  # Update/create a pact. If MESSAGE_JSON is omitted or '-', it...
+  pact-message version                                                                          # Show the pact-message gem version
+```
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/pact/consumer_contract/message.rb

@@ -13,7 +13,7 @@ module Pact
       include Pact::ActiveSupportSupport
       include Pact::SymbolizeKeys
 
-        attr_accessor :description, :contents, :provider_state, :provider_states, :metadata
+        attr_accessor :description, :contents, :provider_state, :provider_states, :metadata, :_id, :index
 
         def initialize attributes = {}
           @description = attributes[:description]
@@ -21,6 +21,8 @@ module Pact
           @provider_states = attributes[:provider_states] || []
           @contents = attributes[:contents]
           @metadata = attributes[:metadata]
+          @_id = attributes[:_id]
+          @index = attributes[:index]
         end
 
         def self.from_hash hash, options = {}
@@ -32,11 +34,12 @@ module Pact
           contents_hash = Pact::MatchingRules.merge(hash['contents'], contents_matching_rules, opts)
           contents = Pact::ConsumerContract::Message::Contents.from_hash(contents_hash)
           metadata = hash['metaData'] || hash['metadata']
-          provider_state = hash['providerStates'] && hash['providerStates'].first && hash['providerStates'].first['name']
-          provider_states = parse_provider_states(hash['providerStates'])
+
+          provider_state_name = parse_provider_state_name(hash['providerState'], hash['providerStates'])
+          provider_states = parse_provider_states(provider_state_name, hash['providerStates'])
           new(symbolize_keys(hash).merge(
             contents: contents,
-            provider_state: provider_state,
+            provider_state: provider_state_name,
             provider_states: provider_states,
             metadata: metadata))
         end
@@ -45,7 +48,7 @@ module Pact
           {
             description: description,
             provider_states: [{ name: provider_state }],
-            contents: contents.to_hash,
+            contents: contents.contents,
             metadata: metadata
           }
         end
@@ -61,7 +64,8 @@ module Pact
               providerStates: [{
                 name: provider_state,
                 params: {}
-              }]
+              }],
+              metadata: metadata
             }
           )
         end
@@ -120,9 +124,19 @@ module Pact
 
         private
 
-        def self.parse_provider_states provider_states
-          (provider_states || []).collect do | provider_state_hash |
-            Pact::ProviderState.new(provider_state_hash['name'], provider_state_hash['params'])
+        def self.parse_provider_state_name provider_state, provider_states
+          (provider_states && provider_states.first && provider_states.first['name']) || provider_state
+        end
+
+        def self.parse_provider_states provider_state_name, provider_states
+          if provider_states && provider_states.any?
+            provider_states.collect do | provider_state_hash |
+              Pact::ProviderState.new(provider_state_hash['name'], provider_state_hash['params'])
+            end
+          elsif provider_state_name
+            [Pact::ProviderState.new(provider_state_name, {})]
+          else
+            []
           end
         end
     end

data/lib/pact/consumer_contract/message/contents.rb

@@ -1,3 +1,4 @@
+require 'pact/reification'
 module Pact
   class ConsumerContract
     class Message
@@ -15,13 +16,25 @@ module Pact
         end
 
         def to_s
-          if @contents.is_a?(Hash) || @contents.is_a?(Array)
-            @contents.to_json
+          if contents.is_a?(Hash) || contents.is_a?(Array)
+            contents.to_json
           else
-            @contents.to_s
+            contents.to_s
           end
         end
 
+        def reified_contents_string
+          if contents.is_a?(Hash) || contents.is_a?(Array)
+            Pact::Reification.from_term(contents).to_json
+          else
+            Pact::Reification.from_term(contents).to_s
+          end
+        end
+
+        def reified_contents_hash
+          Pact::Reification.from_term(contents)
+        end
+
         def contents
           @contents
         end

data/lib/pact/message/cli.rb

@@ -9,13 +9,23 @@ module Pact
       method_option :pact_dir, required: true, desc: "The Pact directory"
       method_option :pact_specification_version, required: false, default: "2.0.0", desc: "The Pact Specification version"
 
-      desc 'update MESSAGE_JSON', 'Update a pact with the given message, or create the pact if it does not exist. The MESSAGE_JSON may be in the legacy Ruby JSON format or the v2+ format.'
-      def update(message)
+      # Update a pact with the given message, or create the pact if it does not exist
+      desc 'update MESSAGE_JSON', "Update/create a pact. If MESSAGE_JSON is omitted or '-', it is read from stdin"
+      long_desc <<-MSG, wrapping: false
+        Update a pact with the given message, or create the pact if it does not exist.
+        The MESSAGE_JSON may be in the legacy Ruby JSON format or the v2+ format.
+        If MESSAGE_JSON is not provided or is '-', the content will be read from 
+        standard input.
+      MSG
+      def update(maybe_json = '-')
         require 'pact/message'
-        require 'pact/message/consumer/update_pact'
+        require 'pact/message/consumer/write_pact'
+
+        message_json = JSON.parse(maybe_json == '-' ? $stdin.read : maybe_json)
+
         pact_specification_version = Pact::SpecificationVersion.new(options.pact_specification_version)
-        message = Pact::Message.from_hash(JSON.load(message), { pact_specification_version: pact_specification_version })
-        Pact::Message::Consumer::UpdatePact.call(message, options.pact_dir, options.consumer, options.provider, options.pact_specification_version)
+        message_hash = Pact::Message.from_hash(message_json, { pact_specification_version: pact_specification_version })
+        Pact::Message::Consumer::WritePact.call(message_hash, options.pact_dir, options.consumer, options.provider, options.pact_specification_version, :update)
       end
 
       desc 'reify', "Take a JSON document with embedded pact matchers and return a concrete example"

data/lib/pact/message/consumer/configuration/message_builder.rb

@@ -1,6 +1,6 @@
 require 'pact/message/consumer/consumer_contract_builder'
 require 'pact/message/consumer/consumer_contract_builders'
-# require 'pact/consumer/world'
+require 'pact/message/consumer/world'
 
 module Pact
   module Message
@@ -40,11 +40,11 @@ module Pact
 
           def create_consumer_contract_builder
             consumer_contract_builder_fields = {
-              :consumer_name => consumer_name,
-              :provider_name => provider_name,
+              consumer_name: consumer_name,
+              provider_name: provider_name,
+              pact_specification_version: pact_specification_version,
+              pact_dir: Pact.configuration.pact_dir
             }
-              # :pactfile_write_mode => Pact.configuration.pactfile_write_mode,
-              # :pact_dir => Pact.configuration.pact_dir
             Pact::Message::Consumer::ConsumerContractBuilder.new consumer_contract_builder_fields
           end
 
@@ -58,7 +58,8 @@ module Pact
             Pact::Message::Consumer::ConsumerContractBuilders.send(:define_method, @name.to_sym) do
               consumer_contract_builder
             end
-            # Pact.consumer_world.add_consumer_contract_builder consumer_contract_builder
+
+            Pact::Message.consumer_world.add_consumer_contract_builder consumer_contract_builder
           end
         end
       end

data/lib/pact/message/consumer/configuration/message_provider.rb

@@ -18,9 +18,13 @@ module Pact
           end
 
           dsl do
-            def builder builder_name, &block
+            def mock_provider(builder_name, &block)
               self.builder = MessageBuilder.build(builder_name, consumer_name, name, &block)
             end
+
+            def builder(builder_name, &block)
+              expectation_builder(builder_name, &block)
+            end
           end
 
           def finalize

data/lib/pact/message/consumer/consumer_contract_builder.rb

@@ -1,5 +1,6 @@
 require 'pact/message/consumer/interaction_builder'
-require 'pact/message/consumer/update_pact'
+require 'pact/message/consumer/write_pact'
+require 'pact/errors'
 
 module Pact
   module Message
@@ -10,39 +11,79 @@ module Pact
           @interaction_builder = nil
           @consumer_name = attributes[:consumer_name]
           @provider_name = attributes[:provider_name]
+          @pact_specification_version = attributes[:pact_specification_version]
+          @pact_dir = attributes[:pact_dir]
           @interactions = []
+          @yielded_interaction = false
         end
 
-        def given(provider_state)
-          interaction_builder.given(provider_state)
+        def reset
+          @interaction_builder = nil
+          @yielded_interaction = false
+        end
+
+        def given(provider_state, params = {})
+          interaction_builder.given(provider_state, params)
         end
 
         def is_expected_to_send(description)
           interaction_builder.is_expected_to_send(provider_state)
         end
 
-        def send_message
-          # TODO handle matchers
-          yield @contents_string if block_given?
+        def send_message_string
+          if interaction_builder?
+            if block_given?
+              @yielded_interaction = true
+              yield interaction_builder.interaction.contents.reified_contents_string
+            end
+          else
+            raise Pact::Error.new("No message expectation has been defined")
+          end
+        end
+
+        def send_message_hash
+          if interaction_builder?
+            if block_given?
+              @yielded_interaction = true
+              yield interaction_builder.interaction.contents.reified_contents_hash
+            end
+          else
+            raise Pact::Error.new("No message expectation has been defined")
+          end
         end
 
         def handle_interaction_fully_defined(interaction)
+          @contents = interaction.contents
           @contents_string = interaction.contents.to_s
-          @interactions << interaction
-          @interaction_builder = nil
-          # TODO pull these from pact config
-          Pact::Message::Consumer::UpdatePact.call(interaction, "./spec/pacts", consumer_name, provider_name, "2.0.0")
         end
 
         def verify example_description
-          #
-          # TODO check that message was actually yielded
+          # There may be multiple message providers defined, and not every one of them
+          # has to define a message for every test.
+          if interaction_builder?
+            if yielded_interaction?
+              interactions << interaction_builder.interaction
+            else
+              raise Pact::Error.new("`send_message_string` was not called for message \"#{interaction_builder.interaction.description}\"")
+            end
+          end
+        end
+
+        def write_pact
+          Pact::Message::Consumer::WritePact.call(interactions, pact_dir, consumer_name, provider_name, pact_specification_version, :overwrite)
         end
 
         private
 
-        attr_writer :interaction_builder
-        attr_accessor :consumer_name, :provider_name, :consumer_contract_details
+        attr_accessor :consumer_name, :provider_name, :consumer_contract_details, :contents, :interactions, :pact_specification_version, :pact_dir
+
+        def interaction_builder?
+          !!@interaction_builder
+        end
+
+        def yielded_interaction?
+          @yielded_interaction
+        end
 
         def interaction_builder
           @interaction_builder ||=

data/lib/pact/message/consumer/interaction_builder.rb

@@ -17,13 +17,17 @@ module Pact
           self
         end
 
-        def given provider_state
-          @interaction.provider_state = provider_state.nil? ? nil : provider_state.to_s
+        def given name, params = {}
+          if name
+            @interaction.provider_states << Pact::ProviderState.new(name, params)
+          end
           self
         end
 
+        alias_method :and, :given
+
         def with_metadata(object)
-          # TODO implement this
+          interaction.metadata = object
           self
         end
 

data/lib/pact/message/consumer/interaction_decorator.rb

@@ -17,7 +17,9 @@ module Pact
           hash[:providerStates] = provider_states
           hash[:contents] = extract_contents
           hash[:matchingRules] = extract_matching_rules
-          hash[:metaData] = message.metadata || {}
+          if message.metadata
+            hash[:metaData] = message.metadata
+          end
           fix_all_the_things hash
         end
 
@@ -42,9 +44,14 @@ module Pact
         end
 
         def extract_matching_rules
-          {
-            body: Pact::MatchingRules.extract(message.contents.contents, pact_specification_version: pact_specification_version)
-          }
+          body_matching_rules = Pact::MatchingRules.extract(message.contents.contents, pact_specification_version: pact_specification_version)
+          if body_matching_rules.any?
+            {
+              body: body_matching_rules
+            }
+          else
+            {}
+          end
         end
 
         def pact_specification_version

data/lib/pact/message/consumer/rspec.rb

@@ -20,7 +20,15 @@ hooks = Pact::Message::Consumer::SpecHooks.new
 RSpec.configure do |config|
   config.include Pact::Message::Consumer::RSpec, :pact => :message
 
-  config.after :each, :pact => true do | example |
+  config.before :each, :pact => :message do | example |
+    hooks.before_each Pact::RSpec.full_description(example)
+  end
+
+  config.after :each, :pact => :message do | example |
     hooks.after_each Pact::RSpec.full_description(example)
   end
+
+  config.after :all do
+    hooks.after_suite
+  end
 end

data/lib/pact/message/consumer/spec_hooks.rb

@@ -1,12 +1,25 @@
+require 'pact/message/consumer/world'
+
 module Pact
   module Message
     module Consumer
       class SpecHooks
+        def before_each example_description
+          Pact::Message.consumer_world.register_pact_example_ran
+          Pact::Message.consumer_world.consumer_contract_builders.each(&:reset)
+        end
+
         def after_each example_description
           Pact.configuration.message_provider_verifications.each do | message_provider_verification |
             message_provider_verification.call example_description
           end
         end
+
+        def after_suite
+          if Pact::Message.consumer_world.any_pact_examples_ran?
+            Pact::Message.consumer_world.consumer_contract_builders.each(&:write_pact)
+          end
+        end
       end
     end
   end

data/lib/pact/message/consumer/world.rb

@@ -0,0 +1,36 @@
+module Pact
+  module Message
+    def self.consumer_world
+      @consumer_world ||= Consumer::World.new
+    end
+
+    # internal api, for testing only
+    def self.clear_consumer_world
+      @consumer_world = nil
+    end
+
+    module Consumer
+      class World
+        def initialize
+          @any_pact_examples_ran = false
+        end
+
+        def consumer_contract_builders
+          @consumer_contract_builders ||= []
+        end
+
+        def add_consumer_contract_builder consumer_contract_builder
+          consumer_contract_builders << consumer_contract_builder
+        end
+
+        def register_pact_example_ran
+          @any_pact_examples_ran = true
+        end
+
+        def any_pact_examples_ran?
+          @any_pact_examples_ran
+        end
+      end
+    end
+  end
+end

data/lib/pact/message/consumer/{update_pact.rb → write_pact.rb}

@@ -4,26 +4,27 @@ require 'pact/message/consumer/consumer_contract_decorator'
 module Pact
   module Message
     module Consumer
-      class UpdatePact
+      class WritePact
 
-        def initialize message, pact_dir, consumer_name, provider_name, pact_specification_version
+        def initialize messages, pact_dir, consumer_name, provider_name, pact_specification_version, pactfile_write_mode
           @pact_dir = pact_dir
-          @message = message
+          @messages = messages
           @consumer_name = consumer_name
           @provider_name = provider_name
           @pact_specification_version = pact_specification_version
+          @pactfile_write_mode = pactfile_write_mode
         end
 
-        def self.call(message, pact_dir, consumer_name, provider_name, pact_specification_version)
-          new(message, pact_dir, consumer_name, provider_name, pact_specification_version).call
+        def self.call(messages, pact_dir, consumer_name, provider_name, pact_specification_version, pactfile_write_mode)
+          new(messages, pact_dir, consumer_name, provider_name, pact_specification_version, pactfile_write_mode).call
         end
 
         def call
           details = {
-            consumer: {name: consumer_name},
-            provider: {name: provider_name},
-            interactions: [message],
-            pactfile_write_mode: :update,
+            consumer: { name: consumer_name },
+            provider: { name: provider_name },
+            interactions: [*messages],
+            pactfile_write_mode: pactfile_write_mode,
             pact_dir: pact_dir,
             pact_specification_version: pact_specification_version,
             error_stream: StringIO.new,
@@ -36,7 +37,7 @@ module Pact
 
         private
 
-        attr_reader :message, :pact_dir, :consumer_name, :provider_name, :pact_specification_version
+        attr_reader :messages, :pact_dir, :consumer_name, :provider_name, :pact_specification_version, :pactfile_write_mode
       end
     end
   end

data/lib/pact/message/consumer_contract_parser.rb

@@ -11,7 +11,9 @@ module Pact
       def call(hash)
         hash = symbolize_keys(hash)
         options = { pact_specification_version: pact_specification_version(hash) }
-        interactions = hash[:messages].collect { |hash| Pact::ConsumerContract::Message.from_hash(hash, options)}
+        interactions = hash[:messages].each_with_index.collect do |hash, index|
+          Pact::ConsumerContract::Message.from_hash({ index: index }.merge(hash), options)
+        end
         ConsumerContract.new(
           :consumer => ServiceConsumer.from_hash(hash[:consumer]),
           :provider => ServiceProvider.from_hash(hash[:provider]),

data/lib/pact/message/version.rb

@@ -1,5 +1,5 @@
 module Pact
   module Message
-    VERSION = "0.6.0"
+    VERSION = "0.11.0"
   end
 end

data/lib/pact/pact-message.rb

@@ -0,0 +1 @@
+require 'pact/message'

data/pact-message.gemspec

@@ -34,10 +34,9 @@ Gem::Specification.new do |spec|
   # and Pact::ConsumerContractWriter. Potentially we should extract
   # or duplicate these classes to remove the pact-mock_service dependency.
   spec.add_runtime_dependency "pact-mock_service", "~> 3.1"
-  spec.add_runtime_dependency "thor", "~> 0.20"
+  spec.add_runtime_dependency "thor", '>= 0.20', '< 2.0'
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 12.3", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency 'conventional-changelog', '~>1.2'

data/script/docker-functions

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+export IMAGE=pact_message_ruby_bundle_base
+
+function docker_build_bundle_base() {
+  docker build . -f Dockerfile-bundle-base -t $IMAGE
+}
+
+function bundle_update_on_docker() {
+  rm -rf tmp/Gemfile.lock
+  docker run --rm -v ${PWD}/tmp:/tmp/bundle_update $IMAGE:latest sh -c "bundle update && cp Gemfile.lock /tmp/bundle_update"
+  mv tmp/Gemfile.lock .
+}
+
+function on_docker() {
+  docker run --rm -v ${PWD}:/app $IMAGE:latest sh -c "$@"
+}
+
+gem_version() {
+  on_docker "bundle exec ruby -e \"require 'bump'; puts Bump::Bump.current\""
+}

data/script/functions

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+gem_version() {
+  on_docker "bundle exec ruby -e \"require 'bump'; puts Bump::Bump.current\""
+}

data/script/release.sh

@@ -1,13 +1,26 @@
-#!/bin/bash
+#!/bin/sh
 set -e
 
+source script/docker-functions
+
 # avoid accidentally double incrementing when previous run fails
 git reset HEAD CHANGELOG.md lib/pact/message/version.rb
 git checkout -- lib/pact/message/version.rb
 git checkout -- CHANGELOG.md
-bundle exec bump ${1:-minor} --no-commit
-bundle exec rake generate_changelog
+
+docker_build_bundle_base
+
+script/release/bump-version.sh $1
+script/release/generate-changelog.sh
+
 git add CHANGELOG.md lib/pact/message/version.rb
-git commit -m "chore(release): version $(ruby -r ./lib/pact/message/version.rb -e "puts Pact::Message::VERSION")"
-# bundle exec rake tag_for_release # TODO move release to travis
-bundle exec rake release
+git commit -m "chore(release): version ${VERSION}
+
+[ci-skip]"
+
+VERSION=$(gem_version)
+TAG="v${VERSION}"
+git tag -a "${TAG}" -m "Releasing version ${TAG}"
+git push origin "${TAG}"
+git push origin master
+echo "Releasing from https://travis-ci.org/pact-foundation/pact-message-ruby/builds"

data/script/release/bump-version.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+
+source script/docker-functions
+
+on_docker "bundle exec bump ${1:-minor} --no-commit"

data/script/release/generate-changelog.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env sh
+
+set -e
+
+source script/docker-functions
+on_docker "bundle exec rake generate_changelog"

data/script/trigger-release.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+# Script to trigger release of gem via the pact-foundation/release-gem action
+# Requires a Github API token with repo scope stored in the
+# environment variable GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES
+
+: "${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES:?Please set environment variable GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}"
+
+if [ -n "$1" ]; then
+  increment="\"${1}\""
+else
+  increment="null"
+fi
+
+repository_slug=$(git remote get-url origin | cut -d':' -f2 | sed 's/\.git//')
+
+output=$(curl -v https://api.github.com/repos/${repository_slug}/dispatches \
+      -H 'Accept: application/vnd.github.everest-preview+json' \
+      -H "Authorization: Bearer $GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES" \
+      -d "{\"event_type\": \"release-triggered\", \"client_payload\": {\"increment\": ${increment}}}" 2>&1)
+
+if  ! echo "${output}" | grep "HTTP\/.* 204" > /dev/null; then
+  echo "$output" | sed  "s/${GITHUB_ACCESS_TOKEN_FOR_PF_RELEASES}/********/g"
+  echo "Failed to trigger release"
+  exit 1
+else
+  echo "Release workflow triggered"
+fi
+
+echo "See https://github.com/${repository_slug}/actions?query=workflow%3A%22Release+gem%22"

data/tasks/test.rake

@@ -0,0 +1,60 @@
+require "rspec/core/rake_task"
+
+ZOO_PACT_FILE_PATH = "spec/pacts/zoo_consumer-zoo_provider.json"
+
+RSpec::Core::RakeTask.new(:pass) do | task |
+  task.pattern = "spec/features/create_message_pact_spec.rb"
+end
+
+RSpec::Core::RakeTask.new(:fail) do | task |
+  task.pattern = "spec/features/create_message_pact_with_failure_test.rb"
+end
+
+task :pass_writes_pact_file do
+  require 'json'
+  puts "Ensuring that pact file is written for successful test suites"
+  FileUtils.rm_rf(ZOO_PACT_FILE_PATH)
+  Rake::Task['pass'].execute
+  if !File.exist?(ZOO_PACT_FILE_PATH)
+    raise "Expected pact file to be written at #{ZOO_PACT_FILE_PATH}"
+  end
+
+  pact_hash = JSON.parse(File.read(ZOO_PACT_FILE_PATH))
+  if pact_hash['messages'].size < 2
+    raise "Expected pact file to contain more than 1 message"
+  end
+end
+
+task :fail_does_not_write_pact_file do
+  puts "Ensuring that pact file is NOT written for failed test suites"
+  FileUtils.rm_rf(ZOO_PACT_FILE_PATH)
+  expect_to_fail('bundle exec rake fail')
+  if File.exist?(ZOO_PACT_FILE_PATH)
+    raise "Expected pact file NOT to be written at #{ZOO_PACT_FILE_PATH}"
+  end
+end
+
+task :default => [:pass_writes_pact_file, :fail_does_not_write_pact_file]
+
+def expect_to_fail command, options = {}
+  success = execute_command command, options
+  fail "Expected '#{command}' to fail" if success
+end
+
+def execute_command command, options
+  require 'open3'
+  result = nil
+  Open3.popen3(command) {|stdin, stdout, stderr, wait_thr|
+    result = wait_thr.value
+    ensure_patterns_present(command, options, stdout, stderr) if options[:with]
+  }
+  result.success?
+end
+
+def ensure_patterns_present command, options, stdout, stderr
+  require 'term/ansicolor'
+  output = stdout.read + stderr.read
+  options[:with].each do | pattern |
+    raise (::Term::ANSIColor.red("Could not find #{pattern.inspect} in output of #{command}") + "\n\n#{output}") unless output =~ pattern
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact-message
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pact-support
@@ -42,44 +42,42 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.20'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.20'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -146,12 +144,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/release_gem.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - DEVELOPER_DOCUMENTATION.md
+- Dockerfile-bundle-base
 - Gemfile
 - LICENSE.txt
 - QUESTIONS.md
@@ -177,13 +177,21 @@ files:
 - lib/pact/message/consumer/interaction_decorator.rb
 - lib/pact/message/consumer/rspec.rb
 - lib/pact/message/consumer/spec_hooks.rb
-- lib/pact/message/consumer/update_pact.rb
+- lib/pact/message/consumer/world.rb
+- lib/pact/message/consumer/write_pact.rb
 - lib/pact/message/consumer_contract_parser.rb
 - lib/pact/message/version.rb
+- lib/pact/pact-message.rb
 - pact-message.gemspec
+- script/docker-functions
+- script/functions
 - script/release.sh
+- script/release/bump-version.sh
+- script/release/generate-changelog.sh
+- script/trigger-release.sh
 - script/update-pact.sh
 - tasks/release.rake
+- tasks/test.rake
 homepage: http://pact.io
 licenses:
 - MIT
@@ -204,8 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Consumer contract library for messages

data/.travis.yml

@@ -1,12 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.15.4
-notifications:
-  webhooks:
-    urls:
-      - https://webhooks.gitter.im/e/6523128341fad111ed79
-    on_success: change
-    on_failure: always
-    on_start: never