pact-message 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 26c0cea21dd41b6f907a255478162aaa8cd51cca
-  data.tar.gz: b62a0f0fb8e0d13abbd996ca86b9ae826ae032b2
+SHA256:
+  metadata.gz: d44fac4a872e57e964a935d228261c50773a4f90249bcdd979420b390b057b73
+  data.tar.gz: ea1c430bf254ae94970eaedb568d578cab98d1e68d6ad9e0dcd16322e0775eb1
 SHA512:
-  metadata.gz: f816074ffebe0ea7d9a89c21bb971ddee873e67b9a8f872e2077e64ac9e610831c4578680a057e62b719b8de64016c6c76932a377d09e0221615bb3588d069f4
-  data.tar.gz: d64e741d000004653b13b760ad3be4a2cb49a3bc64b45b45d50cf04e9f28b158d4c06cd808206b9729f183870097ef4eba45e7c2f4d049394791eeb9c92f3957
+  metadata.gz: 4c9e77894059e089b6f3239727abe57425b2256d203b2ed6d66a6ee3b94f6ba063b9871198c18ace55dfb74a7d8c1d509f9ee17076df4d89c87657999a26b2fd
+  data.tar.gz: 0230fe4dde29531395c5a8153ecf6e718669c412e0088e4eb957131d5c55a64ea4d7eaffc441816b7a8d9c1fa838ee798ee4148a7857e53736534616bc3ef8d5

data/.travis.yml

@@ -1,12 +1,33 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.15.4
+- 2.2.4
+before_install:
+- rvm use @global
+- gem uninstall bundler -x || gem uninstall bundler -a || true
+- gem install bundler -v 1.17.3
+- bundler --version
+script:
+- rvm use @global
+- bundle exec rake
+jobs:
+  include:
+  - stage: gem release
+    rvm: 2.2.4
+    script: echo "Deploying to rubygems.org ..."
+    deploy:
+      provider: rubygems
+      api_key:
+        secure: NEA7BYENheSN8qF/6BP52uQjTS5U43MXsyxBeqxbp1JOkJxVSNzQw14xy41aXX0gphT7wEVHinnWS+1slLKXvu4OzGKKzcUsnekYFZoGW7eTyKUx7lh/XtFejQ/Mm4P5t75GBgMoaIi+Pa1rD4fcE7zYGrgCvTwIrOGb/SPIKILj0yT8UXMFod8yDDmxzivSSKYe4rgWYlq8aiidDZr2M5ypBR4WcOptCrkBCF8XxXzhFMY4QtrXLsLFRyCzCrDHmosCfC/bLJQltlJjLXfB5ksgaImWAD7wZ6Q4uC5QqmPShonQiPlLEh53Q5nkEWPIcsV7FVZqzXUjPN3LYHlRv+7D3AvbHmJggSt7fXr8YxbzVUkviBlKqNmc9cqM6CSO++QT3UShNgH5b03YKI8rRjFMWYKn1DrN5F5rFNDoGFcZtQSjFN5g/fEiSYsdkNsIeTp4YFxMkTztAYT8TxgcBvCnfXox6xDaLaPWh13UrUL2VL7O7uDK06xWUCp9Hm3/AXz0wRzya1tK9dCWamE5BOzk2ScOiLOgmpgwNHFVA1U93rkHq7Ixr11wazP3Dcinv0kWcW7hdMcI7VA0DUesxLKw6mkcQpd3NLgSU4mWtpoVFcmdERQUGsNM1d5NjGjBeyVMpC0I9NXM1Wv6cLENSX9b4GR7lkwGG/IHRFNciHk=
+      gem: pact-message
+      on:
+        tags: true
+        repo: pact-foundation/pact-message-ruby
 notifications:
   webhooks:
     urls:
-      - https://webhooks.gitter.im/e/6523128341fad111ed79
+    - https://webhooks.gitter.im/e/6523128341fad111ed79
     on_success: change
     on_failure: always
     on_start: never
+

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+<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,11 +21,76 @@ 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
 

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
@@ -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/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.7.0"
   end
 end

data/pact-message.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "pact-mock_service", "~> 3.1"
   spec.add_runtime_dependency "thor", "~> 0.20"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 1.17.3"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry-byebug"

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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pact-message
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Beth Skurrie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pact-support
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 1.17.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: 1.17.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -152,6 +152,7 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - DEVELOPER_DOCUMENTATION.md
+- Dockerfile-bundle-base
 - Gemfile
 - LICENSE.txt
 - QUESTIONS.md
@@ -181,7 +182,11 @@ files:
 - lib/pact/message/consumer_contract_parser.rb
 - lib/pact/message/version.rb
 - pact-message.gemspec
+- script/docker-functions
+- script/functions
 - script/release.sh
+- script/release/bump-version.sh
+- script/release/generate-changelog.sh
 - script/update-pact.sh
 - tasks/release.rake
 homepage: http://pact.io
@@ -205,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Consumer contract library for messages