workable-pact-message 0.6.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d03714d68367ea0d1b939b26305c60fd5001fcf06aa799af6104f8af29b63605
+  data.tar.gz: e6d8605e16ebb00fc2e490fff29a89d09c678a67a03f61520e6bf89862e34c09
+SHA512:
+  metadata.gz: c541690678b17da0ac3031efb5500e179ec5db255cbc5ddf8448bf3e523fed70432c014b91696d604932c64bcf8e74c350c43e5af5dd3d91496ac7481047971a
+  data.tar.gz: 1459f7bf5ed5af8fd5b45e015a9d3cf8ea525ec566976c821e750e58336ec9e6e2f8cc69345a9682173fa1ee9369dd68fb1f8859b9b6b52c366ce50ff679ebd6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+spec/pacts/foo_consumer-bar_producer.json
+spec/pacts/zoo_consumer-zoo_provider.json
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper.rb

data/.travis.yml

@@ -0,0 +1,12 @@
+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

data/CHANGELOG.md

@@ -0,0 +1,88 @@
+<a name="v0.5.0"></a>
+### v0.5.0 (2018-10-04)
+
+
+#### Features
+
+* **pact specification v3**
+  * add support for multiple provider states and params	 ([b2c1cc7](/../../commit/b2c1cc7))
+
+
+<a name="v0.4.5"></a>
+### v0.4.5 (2018-07-07)
+
+
+#### Bug Fixes
+
+* include metaData in message pact	 ([e68ca4f](/../../commit/e68ca4f))
+
+
+<a name="v0.4.3"></a>
+### v0.4.3 (2018-05-06)
+
+
+#### Features
+
+* **version**
+  * add version command to CLI, fixes #10	 ([f928248](/../../commit/f928248))
+
+
+#### Bug Fixes
+
+* **content**
+  * rename message content -> contents. fixes #9	 ([0908962](/../../commit/0908962))
+
+
+<a name="v0.4.1"></a>
+### v0.4.1 (2018-04-05)
+
+
+#### Features
+
+* read/write metaData from/to v3 pact files	 ([7dfcbb9](/../../commit/7dfcbb9))
+
+
+#### Bug Fixes
+
+* locate content matching rules from correct path	 ([5254c01](/../../commit/5254c01))
+
+
+<a name="v0.4.0"></a>
+### v0.4.0 (2018-04-03)
+
+
+#### Features
+
+* add *partial* support for reading/writing array of provider states as specified in v3 spec	 ([e9ec6c3](/../../commit/e9ec6c3))
+
+
+<a name="v0.3.0"></a>
+### v0.3.0 (2018-04-03)
+
+
+#### Features
+
+* add pact-message reify to cli	 ([782a09b](/../../commit/782a09b))
+
+
+<a name="v0.1.5"></a>
+### v0.1.5 (2018-03-26)
+
+
+#### Features
+
+* upgrade to pact-support 1.5	 ([20fea42](/../../commit/20fea42))
+* move pact message classes out of pact-support into pact-message	 ([a187c4a](/../../commit/a187c4a))
+* update DSL syntax	 ([8766965](/../../commit/8766965))
+* add cli for other languages to use	 ([b111edd](/../../commit/b111edd))
+* reuse consumer contract writer from pact-mock_service	 ([93aa122](/../../commit/93aa122))
+* create dsl and basic pact file writer	 ([5333564](/../../commit/5333564))
+
+
+#### Bug Fixes
+
+* set pact_specification_version in cli	 ([834d671](/../../commit/834d671))
+* requires	 ([886068c](/../../commit/886068c))
+* change executables path from exe to bin	 ([921a1c3](/../../commit/921a1c3))
+
+

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+# Contributing

data/DEVELOPER_DOCUMENTATION.md

@@ -0,0 +1,33 @@
+# Developer documentation
+
+## Touchpoints with other gems
+
+Because the HTTP interaction is so baked into the pact gems, the changes required to add message support to the existing code have been spread out across the various gems. I've tried to make extension points where possible in each gem so that pact-http code does not know about or rely on pact-message code at all, but in some places it was unavoidable with the current structure.
+
+### pact-support
+
+To get a Pact::ConsumerContract with messages instead of http interactions (extensible design):
+
+    # lib/pact/message/consumer_contract_parser.rb
+    Pact::ConsumerContract.add_parser(Pact::Message::ConsumerContractParser.new)
+
+### pact-mock_service
+
+To write a message pact (extensible design):
+
+    # lib/pact/message/consumer/update_pact.rb
+    Pact::ConsumerContractWriter.new(details, Logger.new(StringIO.new))
+
+### pact
+
+To verify a message pact (yucky design, but too much work to separate it nicely right now):
+
+    # lib/pact/provider/rspec.rb
+
+    if interaction.respond_to?(:message?) && interaction.message?
+      describe_message Pact::Response.new(interaction.response), interaction_context
+    else
+      describe "with #{interaction.request.method_and_path}" do
+        describe_response Pact::Response.new(interaction.response), interaction_context
+      end
+    end

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pact-message.gemspec
+gemspec
+
+if ENV['X_PACT_DEVELOPMENT']
+  gem "pact-support", path: '../pact-support'
+  gem "pact-mock_service", path: '../pact-mock_service'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Beth Skurrie
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/QUESTIONS.md

@@ -0,0 +1,3 @@
+* Do we reuse Pact.configuration or make Pact::Message.configuration?
+* Do we put the pacts in the same directory or a different one?
+* Check the message format

data/README.md

@@ -0,0 +1,41 @@
+# Pact::Message
+
+[![Join the chat at https://gitter.im/pact-foundation/pact-message-ruby](https://badges.gitter.im/pact-foundation/pact-message-ruby.svg)](https://gitter.im/pact-foundation/pact-message-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+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-message'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pact-message
+
+## Usage
+
+
+
+## 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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pact-foundation/pact-message-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+Dir.glob('./lib/tasks/**/*.rake').each { |task| load task }
+Dir.glob('./tasks/**/*.rake').each { |task| load task }
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/pact-message

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'pact/message/cli'
+Pact::Message::CLI.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pact/consumer_contract/message.rb

@@ -0,0 +1,142 @@
+require 'pact/consumer_contract/message/contents'
+require 'pact/symbolize_keys'
+require 'pact/shared/active_support_support'
+require 'pact/matching_rules'
+require 'pact/errors'
+require 'pact/consumer/request'
+require 'pact/consumer_contract/response'
+require 'pact/consumer_contract/message/contents'
+
+module Pact
+  class ConsumerContract
+    class Message
+      include Pact::ActiveSupportSupport
+      include Pact::SymbolizeKeys
+
+        attr_accessor :description, :contents, :provider_state, :provider_states, :metadata
+
+        def initialize attributes = {}
+          @description = attributes[:description]
+          @provider_state = attributes[:provider_state] || attributes[:providerState]
+          @provider_states = attributes[:provider_states] || []
+          @contents = attributes[:contents]
+          @metadata = attributes[:metadata]
+        end
+
+        def self.from_hash hash, options = {}
+          opts = options.dup
+          unless opts[:pact_specification_version]
+            opts[:pact_specification_version] = Pact::SpecificationVersion::NIL_VERSION
+          end
+          contents_matching_rules = hash['matchingRules'] && hash['matchingRules']['body']
+          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'])
+          new(symbolize_keys(hash).merge(
+            contents: contents,
+            provider_state: provider_state,
+            provider_states: provider_states,
+            metadata: metadata))
+        end
+
+        def to_hash
+          {
+            description: description,
+            provider_states: [{ name: provider_state }],
+            contents: contents.to_hash,
+            metadata: metadata
+          }
+        end
+
+        def request
+          @request ||= Pact::Consumer::Request::Actual.from_hash(
+            path: '/',
+            method: 'POST',
+            query: nil,
+            headers: { 'Content-Type' => 'application/json' },
+            body: {
+              description: description,
+              providerStates: [{
+                name: provider_state,
+                params: {}
+              }]
+            }
+          )
+        end
+
+        # custom media type?
+        def response
+          @response ||= Pact::Response.new(
+            status: 200,
+            headers: {'Content-Type' => 'application/json'},
+            body: {
+              contents: contents
+            }
+          )
+        end
+
+        def http?
+          false
+        end
+
+        def message?
+          true
+        end
+
+        def validate!
+          raise Pact::InvalidMessageError.new(self) unless description && contents
+        end
+
+        def == other
+          other.is_a?(Message) && to_hash == other.to_hash
+        end
+
+        def matches_criteria? criteria
+          criteria.each do | key, value |
+            unless match_criterion self.send(key.to_s), value
+              return false
+            end
+          end
+          true
+        end
+
+        def match_criterion target, criterion
+          target == criterion || (criterion.is_a?(Regexp) && criterion.match(target))
+        end
+
+        def eq? other
+          self == other
+        end
+
+        def description_with_provider_state_quoted
+          provider_state ? "\"#{description}\" given \"#{provider_state}\"" : "\"#{description}\""
+        end
+
+        def to_s
+          to_hash.to_s
+        end
+
+        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'])
+          end
+        end
+    end
+  end
+end
+
+module Pact
+  module Message
+    def self.new *args
+      Pact::ConsumerContract::Message.new(*args)
+    end
+
+    def self.from_hash *args
+      Pact::ConsumerContract::Message.from_hash(*args)
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+module Pact
+  class ConsumerContract
+    class Message
+      class Contents
+        include ActiveSupportSupport
+        include SymbolizeKeys
+
+        # Could technically be an array
+        def self.from_hash contents, options = {}
+          new(contents)
+        end
+
+        def initialize contents
+          @contents = contents
+        end
+
+        def to_s
+          if @contents.is_a?(Hash) || @contents.is_a?(Array)
+            @contents.to_json
+          else
+            @contents.to_s
+          end
+        end
+
+        def contents
+          @contents
+        end
+
+        def as_json
+          @contents
+        end
+      end
+    end
+  end
+end
+
+module Pact
+  module Message
+    class Contents
+      def self.new *args
+        Pact::ConsumerContract::Message::Contents.new(*args)
+      end
+
+      def self.from_hash *args
+        Pact::ConsumerContract::Message::Contents.from_hash(*args)
+      end
+    end
+  end
+end