pact_broker 2.13.0 → 2.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7427bd8d5ba4ffcaead942be481675c3a275774
-  data.tar.gz: 86b168d56a8937c4b4461fee9a21f6d4af626c33
+  metadata.gz: 6493a06ed84ec11bd1c966faddbe3ddb2b948dc1
+  data.tar.gz: f2edee66e10d7ab2fbc8183ff3a685eca1fb20b6
 SHA512:
-  metadata.gz: ddd1b99c2162ab7d736f5680c779b1f733c34841959f8803e6289eabdfb9a8d2840188b9af7ab643cf57f86d29a5130ef490a09954db36c001f564c2d6edc10c
-  data.tar.gz: fec0eaa9e4d5f661e3962010cbe87a22db04de9fdd17bcf46adb8653286bd6f0a3e54c31b5e3be651a21acc40f15013c4ff549efd7b6ed0cc608456c7c1fe4f9
+  metadata.gz: 0ddb05561ad94aeb5a3faef53dd0a96b7ca5550f312810f47e1640303298d3f6ef065e29b30d1b41a5928e46d6cba568bacf7c311c745d4f3af0d66d19cb3342
+  data.tar.gz: 905912e0bb8021d08d1d6f8f9ca9cc6d45cc3eafa0fd51dbbfb33ab8297627d3ad437472b5b3b2cf5de6ef5fdce736a14066591f8221a239c2ac56ad8e41483a

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+<a name="v2.13.1"></a>
+### v2.13.1 (2018-01-12)
+
+
+#### Features
+
+* remove runtime dependency on webrick	 ([1ae7a6e](/../../commit/1ae7a6e))
+
+
 <a name="v2.13.0"></a>
 ### v2.13.0 (2018-01-11)
 

data/lib/pact/doc/README.md

@@ -0,0 +1,5 @@
+# Pact::Doc
+
+The code in pact/doc has been copied from the pact gem to break the runtime dependency between the pact_broker and the pact gem, which requires the pact_mock-service, which requires webrick.
+
+This was required as there is a vulnerability in webrick <= 1.3.1 that we don't want to include in the pact_broker gem, but webrick > 1.3.1 requires ruby 2.3.0, but we need ruby 2.2 for Travelling Ruby, which we use to package the Ruby codebase so it can be shared with implementations in other langauges.

data/lib/pact/doc/doc_file.rb

@@ -0,0 +1,39 @@
+module Pact
+  module Doc
+    class DocFile
+
+      def initialize consumer_contract, dir, consumer_contract_renderer, file_extension
+        @dir = dir
+        @consumer_contract = consumer_contract
+        @consumer_contract_renderer = consumer_contract_renderer
+        @file_extension = file_extension
+      end
+
+      def write
+        File.open(path, "w") { |io|  io << doc_file_contents }
+      end
+
+      def title
+        consumer_contract.provider.name
+      end
+
+      def name
+        "#{consumer_contract.consumer.name} - #{consumer_contract.provider.name}#{file_extension}"
+      end
+
+      private
+
+      attr_reader :dir, :consumer_contract, :consumer_contract_renderer, :file_extension
+
+
+      def path
+        File.join(dir, name)
+      end
+
+      def doc_file_contents
+        consumer_contract_renderer.call(consumer_contract)
+      end
+
+    end
+  end
+end

data/lib/pact/doc/generate.rb

@@ -0,0 +1,11 @@
+module Pact
+  module Doc
+    class Generate
+
+      def self.call pact_dir  = Pact.configuration.pact_dir, doc_dir = Pact.configuration.doc_dir, doc_generators = Pact.configuration.doc_generators
+        doc_generators.each{| doc_generator| doc_generator.call pact_dir, doc_dir }
+      end
+
+    end
+  end
+end

data/lib/pact/doc/generator.rb

@@ -0,0 +1,82 @@
+require 'pact/doc/doc_file'
+require 'fileutils'
+
+module Pact
+  module Doc
+
+    class Generator
+
+      def initialize pact_dir, doc_dir, options
+        @doc_dir = doc_dir
+        @pact_dir = pact_dir
+        @consumer_contract_renderer = options[:consumer_contract_renderer]
+        @doc_type = options[:doc_type]
+        @file_extension = options[:file_extension]
+        @index_renderer = options[:index_renderer]
+        @index_name = options[:index_name]
+        @after = options.fetch(:after, lambda{|pact_dir, target_dir, consumer_contracts| })
+      end
+
+      def call
+        ensure_target_dir_exists_and_is_clean
+        write_index if consumer_contracts.any?
+        write_doc_files
+        perform_after_hook
+      end
+
+      private
+
+      attr_reader :doc_dir, :pact_dir, :consumer_contract_renderer, :doc_type, :file_extension, :index_renderer, :after
+
+      def write_index
+        File.open(index_file_path, "w") { |io|  io << index_file_contents }
+      end
+
+      def index_file_path
+        File.join(target_dir, "#{@index_name}#{file_extension}")
+      end
+
+      def index_file_contents
+        index_renderer.call(consumer_contracts.first.consumer.name, index_data)
+      end
+
+      def index_data
+        doc_files.each_with_object({}) do | doc_file, data |
+          data[doc_file.title] = doc_file.name
+        end
+      end
+
+      def write_doc_files
+        doc_files.each(&:write)
+      end
+
+      def doc_files
+        consumer_contracts.collect do | consumer_contract |
+          DocFile.new(consumer_contract, target_dir, consumer_contract_renderer, file_extension)
+        end
+      end
+
+      def consumer_contracts
+        @consumer_contracts ||= begin
+          Dir.glob("#{pact_dir}/**").collect do |file|
+            Pact::ConsumerContract.from_uri file
+          end
+        end
+      end
+
+      def perform_after_hook
+        after.call(pact_dir, target_dir, consumer_contracts)
+      end
+
+      def ensure_target_dir_exists_and_is_clean
+        FileUtils.rm_rf target_dir
+        FileUtils.mkdir_p target_dir
+      end
+
+      def target_dir
+        File.join(doc_dir, doc_type)
+      end
+
+    end
+  end
+end

data/lib/pact/doc/interaction_view_model.rb

@@ -0,0 +1,124 @@
+require 'pact/shared/active_support_support'
+require 'pact/reification'
+require 'cgi'
+
+module Pact
+  module Doc
+    class InteractionViewModel
+
+      include Pact::ActiveSupportSupport
+
+      def initialize interaction, consumer_contract
+        @interaction = interaction
+        @consumer_contract = consumer_contract
+      end
+
+      def id
+        @id ||= begin
+          full_desc = if has_provider_state?
+            "#{description} given #{interaction.provider_state}"
+          else
+            description
+          end
+          CGI.escapeHTML(full_desc.gsub(/\s+/,'_'))
+        end
+      end
+
+      def request_method
+        interaction.request.method.upcase
+      end
+
+      def request_path
+        interaction.request.path
+      end
+
+      def response_status
+        interaction.response.status
+      end
+
+      def consumer_name
+        markdown_escape @consumer_contract.consumer.name
+      end
+
+      def provider_name
+        markdown_escape @consumer_contract.provider.name
+      end
+
+      def has_provider_state?
+        @interaction.provider_state && !@interaction.provider_state.empty?
+      end
+
+      def provider_state start_of_sentence = false
+        markdown_escape apply_capitals(@interaction.provider_state.strip, start_of_sentence)
+      end
+
+      def description start_of_sentence = false
+        return '' unless @interaction.description
+        markdown_escape apply_capitals(@interaction.description.strip, start_of_sentence)
+      end
+
+      def request
+        fix_json_formatting JSON.pretty_generate(clean_request)
+      end
+
+      def response
+        fix_json_formatting JSON.pretty_generate(clean_response)
+      end
+
+      private
+
+      attr_reader :interaction, :consumer_contract
+
+      def clean_request
+        reified_request = Reification.from_term(interaction.request)
+        ordered_clean_hash(reified_request).tap do | hash |
+          hash[:body] = reified_request[:body] if reified_request[:body]
+        end
+      end
+
+      def clean_response
+        ordered_clean_hash Reification.from_term(interaction.response)
+      end
+
+      # Remove empty body and headers hashes from response, and empty headers from request,
+      # as an empty hash means "allow anything" - it's more intuitive and cleaner to just
+      # remove the empty hashes from display.
+      def ordered_clean_hash source
+        ordered_keys.each_with_object({}) do |key, target|
+          if source.key? key
+            target[key] = source[key] unless value_is_an_empty_hash(source[key])
+          end
+        end
+      end
+
+      def value_is_an_empty_hash value
+        value.is_a?(Hash) && value.empty?
+      end
+
+      def ordered_keys
+        [:method, :path, :query, :status, :headers, :body]
+      end
+
+      def remove_key_if_empty key, hash
+        hash.delete(key) if hash[key].is_a?(Hash) && hash[key].empty?
+      end
+
+      def apply_capitals string, start_of_sentence = false
+        start_of_sentence ? capitalize_first_letter(string) : lowercase_first_letter(string)
+      end
+
+      def capitalize_first_letter string
+        string[0].upcase + string[1..-1]
+      end
+
+      def lowercase_first_letter string
+        string[0].downcase + string[1..-1]
+      end
+
+      def markdown_escape string
+        return nil unless string
+        string.gsub('*','\*').gsub('_','\_')
+      end
+    end
+  end
+end

data/lib/pact/doc/markdown/consumer_contract_renderer.rb

@@ -0,0 +1,68 @@
+require 'pact/doc/markdown/interaction_renderer'
+require 'pact/doc/sort_interactions'
+
+module Pact
+  module Doc
+    module Markdown
+      class ConsumerContractRenderer
+
+        def initialize consumer_contract
+          @consumer_contract = consumer_contract
+        end
+
+        def self.call consumer_contract
+          new(consumer_contract).call
+        end
+
+        def call
+          title + summaries_title + summaries.join + interactions_title + full_interactions.join
+        end
+
+        private
+
+        attr_reader :consumer_contract
+
+        def title
+          "### A pact between #{consumer_name} and #{provider_name}\n\n"
+        end
+
+        def interaction_renderers
+          @interaction_renderers ||= sorted_interactions.collect{|interaction| InteractionRenderer.new interaction, @consumer_contract}
+        end
+
+        def summaries_title
+          "#### Requests from #{consumer_name} to #{provider_name}\n\n"
+        end
+
+        def interactions_title
+          "#### Interactions\n\n"
+        end
+
+        def summaries
+          interaction_renderers.collect(&:render_summary)
+        end
+
+        def full_interactions
+          interaction_renderers.collect(&:render_full_interaction)
+        end
+
+        def sorted_interactions
+          SortInteractions.call(consumer_contract.interactions)
+        end
+
+        def consumer_name
+          markdown_escape consumer_contract.consumer.name
+        end
+
+        def provider_name
+          markdown_escape consumer_contract.provider.name
+        end
+
+        def markdown_escape string
+          string.gsub('*','\*').gsub('_','\_')
+        end
+
+      end
+    end
+  end
+end

data/lib/pact/doc/markdown/generator.rb

@@ -0,0 +1,24 @@
+require 'pact/doc/generator'
+require 'pact/doc/markdown/consumer_contract_renderer'
+require 'pact/doc/markdown/index_renderer'
+
+module Pact
+  module Doc
+    module Markdown
+      class Generator < Pact::Doc::Generator
+        def initialize pact_dir, doc_dir
+          super(pact_dir, doc_dir,
+            consumer_contract_renderer: ConsumerContractRenderer,
+            doc_type: 'markdown',
+            file_extension: '.md',
+            index_renderer: IndexRenderer,
+            index_name: 'README')
+        end
+
+        def self.call pact_dir, doc_dir
+          new(pact_dir, doc_dir).call
+        end
+      end
+    end
+  end
+end

data/lib/pact/doc/markdown/index_renderer.rb

@@ -0,0 +1,40 @@
+module Pact
+  module Doc
+    module Markdown
+      class IndexRenderer
+        attr_reader :consumer_name
+        attr_reader :docs # Hash of pact title => file_name
+
+        def initialize consumer_name, docs
+          @consumer_name = consumer_name
+          @docs = docs
+        end
+
+        def self.call consumer_name, docs
+          new(consumer_name, docs).call
+        end
+
+        def call
+          title + "\n\n" + table_of_contents + "\n"
+        end
+
+        private
+
+        def table_of_contents
+          docs.collect do | title, file_name |
+            item title, file_name
+          end.join("\n")
+        end
+
+        def title
+          "### Pacts for #{consumer_name}"
+        end
+
+        def item title, file_name
+          "* [#{title}](#{file_name})"
+        end
+
+      end
+    end
+  end
+end

data/lib/pact/doc/markdown/interaction.erb

@@ -0,0 +1,14 @@
+<a name="<%= interaction.id %>"></a>
+<%= if interaction.has_provider_state?
+  "Given **#{interaction.provider_state}**, upon receiving"
+   else
+  "Upon receiving"
+   end
+%> **<%= interaction.description %>** from <%= interaction.consumer_name %>, with
+```json
+<%= interaction.request  %>
+```
+<%= interaction.provider_name %> will respond with:
+```json
+<%= interaction.response %>
+```

data/lib/pact/doc/markdown/interaction_renderer.rb

@@ -0,0 +1,42 @@
+require 'erb'
+require 'pact/doc/interaction_view_model'
+
+module Pact
+  module Doc
+    module Markdown
+      class InteractionRenderer
+        attr_reader :interaction
+
+        def initialize interaction, pact
+          @interaction = InteractionViewModel.new(interaction, pact)
+        end
+
+        def render_summary
+          suffix = interaction.has_provider_state? ? " given #{interaction.provider_state}" : ""
+          "* [#{interaction.description(true)}](##{interaction.id})#{suffix}\n\n"
+        end
+
+        def render_full_interaction
+          render('/interaction.erb')
+        end
+
+        def render template_file
+          ERB.new(template_string(template_file)).result(binding)
+        end
+
+        # The template file is written with only ASCII range characters, so we
+        # can read as UTF-8. But rendered strings must have same encoding as
+        # script encoding because it will joined to strings which are produced by
+        # string literal.
+        def template_string(template_file)
+          File.read(template_contents(template_file), external_encoding: Encoding::UTF_8).force_encoding(__ENCODING__)
+        end
+
+        def template_contents(template_file)
+          File.dirname(__FILE__) + template_file
+        end
+
+      end
+    end
+  end
+end

data/lib/pact/doc/sort_interactions.rb

@@ -0,0 +1,15 @@
+module Pact
+  module Doc
+    class SortInteractions
+      def self.call interactions
+        interactions.sort{|a, b| sortable_id(a) <=> sortable_id(b)}
+      end
+
+      private
+
+      def self.sortable_id interaction
+        "#{interaction.description.downcase} #{interaction.response.status} #{(interaction.provider_state || '').downcase}"
+      end
+    end
+  end
+end

data/lib/pact_broker/version.rb

@@ -1,3 +1,3 @@
 module PactBroker
-  VERSION = '2.13.0'
+  VERSION = '2.13.1'
 end

data/pact_broker.gemspec

@@ -31,15 +31,15 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'semver2', '~> 3.4.2'
   gem.add_runtime_dependency 'rack', '~>2.0'
   gem.add_runtime_dependency 'redcarpet', '>=3.3.2', '~>3.3'
-  gem.add_runtime_dependency 'pact', '~>1.14'
+  gem.add_runtime_dependency 'pact-support'
   gem.add_runtime_dependency 'padrino-core', '~>0.14.1'
   gem.add_runtime_dependency 'haml', '~>4.0'
   gem.add_runtime_dependency 'sucker_punch', '~>2.0'
   gem.add_runtime_dependency 'rack-protection', '~>2.0'
   gem.add_runtime_dependency 'dry-types', '~> 0.10.3' # https://travis-ci.org/pact-foundation/pact_broker/jobs/249448621
   gem.add_runtime_dependency 'table_print', '~> 1.5'
-  gem.add_runtime_dependency 'webrick', '~>1.3.0' # Webrick requires Ruby version >= 2.5.0dev. TODO remove dependency on Pact gem.
 
+  gem.add_development_dependency 'pact', '~>1.14'
   gem.add_development_dependency 'bundler-audit', '~>0.4'
   gem.add_development_dependency 'sqlite3', '~>1.3'
   gem.add_development_dependency 'pry-byebug'

data/spec/lib/pact/doc/generator_spec.rb

@@ -0,0 +1,80 @@
+require 'pact/doc/generator'
+require 'fileutils'
+
+module Pact
+  module Doc
+    describe Generator do
+
+      let(:doc_dir) { './tmp/doc' }
+      let(:pact_dir) { './tmp/pacts' }
+      let(:file_name) { "Some Consumer - Some Provider#{file_extension}" }
+      let(:consumer_contract_renderer) { double("ConsumerContractRenderer", :call => doc_content) }
+      let(:doc_content) { "doc_content" }
+      let(:index_content) { "index_content" }
+      let(:expected_doc_path) { "#{doc_dir}/#{doc_type}/#{file_name}" }
+      let(:expected_index_path) { "#{doc_dir}/#{doc_type}/#{index_name}#{file_extension}" }
+      let(:doc_type) { 'markdown' }
+      let(:file_extension) { ".md" }
+      let(:actual_file_contents) { File.read(expected_doc_path) }
+      let(:actual_index_contents) { File.read(expected_index_path)}
+      let(:index_renderer) { double("IndexRenderer", :call => index_content)}
+      let(:index_name) { 'README' }
+      let(:after_hook) { double("hook", :call => nil)}
+
+      before do
+        FileUtils.rm_rf doc_dir
+        FileUtils.rm_rf pact_dir
+        FileUtils.mkdir_p doc_dir
+        FileUtils.mkdir_p pact_dir
+        FileUtils.cp './spec/support/markdown_pact.json', pact_dir
+      end
+
+      let(:options) { { consumer_contract_renderer: consumer_contract_renderer, doc_type: doc_type, file_extension: file_extension, index_renderer: index_renderer, index_name: index_name } }
+
+      subject { Generator.new(pact_dir, doc_dir, options) }
+
+      context "when there are existing files" do
+        let(:existing_doc_file_path) { File.join(doc_dir, doc_type, "leftover") }
+
+        before do
+          FileUtils.mkdir_p File.dirname(existing_doc_file_path)
+          FileUtils.touch existing_doc_file_path
+        end
+
+        it "clears the existing files" do
+          expect(File.exist?(existing_doc_file_path)).to be true
+          subject.call
+          expect(File.exist?(existing_doc_file_path)).to be false
+        end
+      end
+
+      it "creates an index" do
+        expect(index_renderer).to receive(:call).with("Some Consumer", {"Some Provider"=>"Some Consumer - Some Provider.md"})
+        subject.call
+        expect(actual_index_contents).to eq(index_content)
+      end
+
+      it "creates documentation" do
+        subject.call
+        expect(actual_file_contents).to eq(doc_content)
+      end
+
+      context "with an after hook specified" do
+
+        subject { Generator.new(pact_dir, doc_dir, options.merge(:after => after_hook)) }
+
+        it "executes the hook" do
+          expect(after_hook).to receive(:call).with(pact_dir, "#{doc_dir}/#{doc_type}", instance_of(Array))
+          subject.call
+        end
+
+        it "passes in the consumer_contracts" do
+          expect(after_hook).to receive(:call) do | _, _, consumer_contracts |
+            expect(consumer_contracts.first).to be_instance_of(Pact::ConsumerContract)
+          end
+          subject.call
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact/doc/interaction_view_model_spec.rb

@@ -0,0 +1,186 @@
+require 'pact/doc/interaction_view_model'
+
+module Pact
+  module Doc
+    describe InteractionViewModel do
+      let(:consumer_contract) { Pact::ConsumerContract.from_uri './spec/support/interaction_view_model.json' }
+      let(:interaction_with_request_with_body_and_headers) { consumer_contract.find_interaction description: "a request with a body and headers" }
+      let(:interaction_with_request_without_body_and_headers) { consumer_contract.find_interaction description: "a request with an empty body and empty headers" }
+      let(:interaction_with_response_with_body_and_headers) { consumer_contract.find_interaction description: "a response with a body and headers" }
+      let(:interaction_with_response_without_body_and_headers) { consumer_contract.find_interaction description: "a response with an empty body and empty headers" }
+      let(:interaction) { consumer_contract.interactions.first }
+
+      subject { InteractionViewModel.new interaction, consumer_contract}
+
+      describe "id" do
+        context "with HTML characters in the description" do
+          before do
+            interaction.description = "an alligator with > 100 legs exists"
+            interaction.provider_state = "a thing exists"
+          end
+
+          it "escapes the HTML characters" do
+            expect(subject.id).to eq "an_alligator_with_>_100_legs_exists_given_a_thing_exists"
+          end
+        end
+      end
+
+      describe "consumer_name" do
+        context "with markdown characters in the name" do
+          it "escapes the markdown characters" do
+            expect(subject.consumer_name).to eq "a\\*consumer"
+          end
+        end
+      end
+
+      describe "provider_name" do
+        context "with markdown characters in the name" do
+          it "escapes the markdown characters" do
+            expect(subject.provider_name).to eq "a\\_provider"
+          end
+        end
+      end
+
+      describe "request" do
+        let(:interaction) { interaction_with_request_with_body_and_headers }
+
+        it "includes the method" do
+          expect(subject.request).to include('"method"')
+          expect(subject.request).to include('"get"')
+        end
+
+        it "includes the body" do
+          expect(subject.request).to include('"body"')
+          expect(subject.request).to include('"a body"')
+        end
+
+        it "includes the headers" do
+          expect(subject.request).to include('"headers"')
+          expect(subject.request).to include('"a header"')
+        end
+
+        it "includes the query" do
+          expect(subject.request).to include('"query"')
+          expect(subject.request).to include('"some=thing"')
+        end
+
+        it "includes the path" do
+          expect(subject.request).to include('"path"')
+          expect(subject.request).to include('"/path"')
+        end
+
+        it "renders the keys in a meaningful order" do
+          expect(subject.request).to match /"method".*"path".*"query".*"headers".*"body"/m
+        end
+
+        context "when the body hash is empty" do
+          let(:interaction) { interaction_with_request_without_body_and_headers }
+
+          it "includes the body" do
+            expect(subject.request).to include("body")
+          end
+        end
+        context "when the headers hash is empty" do
+          let(:interaction) { interaction_with_request_without_body_and_headers }
+
+          it "does not include the headers" do
+            expect(subject.request).to_not include("headers")
+          end
+        end
+
+        context "when a Pact::Term is present" do
+          let(:consumer_contract) { Pact::ConsumerContract.from_uri './spec/support/interaction_view_model_with_terms.json'}
+          let(:interaction) { consumer_contract.interactions.first }
+
+          it "uses the generated value" do
+            expect(subject.request).to_not include("Term")
+            expect(subject.request).to include("sunny")
+          end
+        end
+      end
+
+      describe "response" do
+        let(:interaction) { interaction_with_response_with_body_and_headers }
+
+        it "includes the status" do
+          expect(subject.response).to include('"status"')
+        end
+
+        it "includes the body" do
+          expect(subject.response).to include('"body"')
+          expect(subject.response).to include('"a body"')
+        end
+        it "includes the headers" do
+          expect(subject.response).to include('"headers"')
+          expect(subject.response).to include('"a header"')
+        end
+
+        it "renders the keys in a meaningful order" do
+          expect(subject.response).to match /"status".*"headers".*"body"/m
+        end
+
+        context "when the body hash is empty" do
+          let(:interaction) { interaction_with_response_without_body_and_headers }
+
+          it "does not include the body" do
+            expect(subject.response).to_not include("body")
+          end
+        end
+
+        context "when the headers hash is empty" do
+          let(:interaction) { interaction_with_response_without_body_and_headers }
+
+          it "does not include the headers" do
+            expect(subject.response).to_not include("headers")
+          end
+        end
+
+        context "when a Pact::Term is present" do
+          let(:consumer_contract) { Pact::ConsumerContract.from_uri './spec/support/interaction_view_model_with_terms.json'}
+          let(:interaction) { consumer_contract.interactions.first }
+
+          it "uses the generated value" do
+            expect(subject.response).to_not include("Term")
+            expect(subject.response).to include("rainy")
+          end
+        end
+      end
+
+      describe "description" do
+        context "with a nil description" do
+          let(:interaction) do
+            interaction_with_request_with_body_and_headers.description = nil
+            interaction_with_request_with_body_and_headers
+          end
+
+          it "does not blow up" do
+            expect(subject.description(true)).to eq ''
+            expect(subject.description(false)).to eq ''
+          end
+        end
+
+        context "with markdown characters in the name" do
+          let(:interaction) do
+            interaction_with_request_with_body_and_headers.description = 'a *description'
+            interaction_with_request_with_body_and_headers
+          end
+          it "escapes the markdown characters" do
+            expect(subject.description).to eq "a \\*description"
+          end
+        end
+      end
+
+      describe "provider_state" do
+        context "with markdown characters in the name" do
+          let(:interaction) do
+            interaction_with_request_with_body_and_headers.provider_state = 'a *provider state'
+            interaction_with_request_with_body_and_headers
+          end
+          it "escapes the markdown characters" do
+            expect(subject.provider_state).to eq "a \\*provider state"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/pact/doc/markdown/consumer_contract_renderer_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'pact/doc/markdown/consumer_contract_renderer'
+require 'pact/support'
+
+module Pact
+  module Doc
+    module Markdown
+      describe ConsumerContractRenderer do
+
+        subject { ConsumerContractRenderer.new(consumer_contract) }
+        let(:consumer_contract) { Pact::ConsumerContract.from_uri './spec/support/markdown_pact.json' }
+
+        let(:expected_output) { File.read("./spec/support/generated_markdown.md", external_encoding: Encoding::UTF_8) }
+
+        describe "#call" do
+
+          context "with markdown characters in the pacticipant names" do
+            let(:consumer_contract) { Pact::ConsumerContract.from_uri './spec/support/markdown_pact_with_markdown_chars_in_names.json' }
+
+            it "escapes the markdown characters" do
+              expect(subject.call).to include '### A pact between Some\*Consumer\*App and Some\_Provider\_App'
+              expect(subject.call).to include '#### Requests from Some\*Consumer\*App to Some\_Provider\_App'
+            end
+          end
+
+          context "with ruby's default external encoding is not UTF-8" do
+            around do |example|
+              back = nil
+              WarningSilencer.enable { back, Encoding.default_external = Encoding.default_external, Encoding::ASCII_8BIT }
+              example.run
+              WarningSilencer.enable { Encoding.default_external = back }
+            end
+
+            it "renders the interactions" do
+              expect(subject.call).to eq(expected_output)
+            end
+          end
+
+          it "renders the interactions" do
+            expect(subject.call).to eq(expected_output)
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/lib/pact/doc/markdown/index_renderer_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'pact/doc/markdown/index_renderer'
+
+module Pact
+  module Doc
+    module Markdown
+      describe IndexRenderer do
+
+        let(:consumer_name) { "Some Consumer" }
+        let(:docs) {  {"Some Provider" => "Some Provider.md", "Some other provider" => "Some other provider.md"} }
+        let(:subject) { IndexRenderer.new(consumer_name, docs) }
+        let(:expected_content) { File.read('./spec/support/generated_index.md')}
+
+        describe "#call" do
+          it "renders the index" do
+            expect(subject.call).to eq expected_content
+          end
+        end
+
+        describe ".call" do
+          it "renders the index" do
+            expect(IndexRenderer.call(consumer_name, docs) ).to eq expected_content
+          end
+        end
+
+      end
+    end
+  end
+end

data/spec/support/generated_index.md

@@ -0,0 +1,4 @@
+### Pacts for Some Consumer
+
+* [Some Provider](Some Provider.md)
+* [Some other provider](Some other provider.md)

data/spec/support/generated_markdown.md

@@ -0,0 +1,55 @@
+### A pact between Some Consumer and Some Provider
+
+#### Requests from Some Consumer to Some Provider
+
+* [A request for alligators in Brüssel](#a_request_for_alligators_in_Brüssel_given_alligators_exist) given alligators exist
+
+* [A request for polar bears](#a_request_for_polar_bears)
+
+#### Interactions
+
+<a name="a_request_for_alligators_in_Brüssel_given_alligators_exist"></a>
+Given **alligators exist**, upon receiving **a request for alligators in Brüssel** from Some Consumer, with
+```json
+{
+  "method": "get",
+  "path": "/alligators"
+}
+```
+Some Provider will respond with:
+```json
+{
+  "status": 200,
+  "headers": {
+    "Content-Type": "application/json"
+  },
+  "body": {
+    "alligators": [
+      {
+        "name": "Bob",
+        "phoneNumber": "12345678"
+      }
+    ]
+  }
+}
+```
+<a name="a_request_for_polar_bears"></a>
+Upon receiving **a request for polar bears** from Some Consumer, with
+```json
+{
+  "method": "get",
+  "path": "/polar-bears"
+}
+```
+Some Provider will respond with:
+```json
+{
+  "status": 404,
+  "headers": {
+    "Content-Type": "application/json"
+  },
+  "body": {
+    "message": "Sorry, due to climate change, the polar bears are currently unavailable."
+  }
+}
+```

data/spec/support/interaction_view_model.json

@@ -0,0 +1,63 @@
+{
+    "provider": {
+        "name": "a_provider"
+    },
+    "consumer": {
+        "name": "a*consumer"
+    },
+    "interactions": [
+        {
+            "description": "a request with a body and headers",
+            "request": {
+                "method": "get",
+                "path": "/path",
+                "query": "some=thing",
+                "headers": {
+                    "key": "a header"
+                },
+                "body": {
+                    "key": "a body"
+                }
+            },
+            "response": {}
+        },
+        {
+            "description": "a request with an empty body and empty headers",
+            "request": {
+                "method": "get",
+                "path": "/",
+                "headers": {},
+                "body": {}
+            },
+            "response": {}
+        },
+        {
+            "description": "a response with a body and headers",
+            "request": {
+                "method": "get",
+                "path": "/"
+            },
+            "response": {
+                "headers": {
+                    "key": "a header"
+                },
+                "body": {
+                    "key": "a body"
+                },
+                "status": 200
+            }
+        },
+        {
+            "description": "a response with an empty body and empty headers",
+            "request": {
+                "method": "get",
+                "path": "/"
+            },
+            "response": {
+                "status": 200,
+                "headers": {},
+                "body": {}
+            }
+        }
+    ]
+}

data/spec/support/interaction_view_model_with_terms.json

@@ -0,0 +1,50 @@
+{
+    "provider": {
+        "name": "a provider"
+    },
+    "consumer": {
+        "name": "a consumer"
+    },
+    "interactions": [
+        {
+            "description": "an interaction with terms",
+            "request": {
+                "method": "post",
+                "path": "/path",
+                "query": "some=thing",
+                "headers": {
+                    "key": "a header"
+                },
+                "body": {
+                    "term": {
+                      "json_class": "Pact::Term",
+                      "data": {
+                        "generate": "sunny",
+                        "matcher": {
+                          "json_class": "Regexp",
+                          "o": 0,
+                          "s": "sun"
+                        }
+                      }
+                    }
+                }
+            },
+            "response": {
+                "status": 200,
+                "body": {
+                    "term": {
+                      "json_class": "Pact::Term",
+                      "data": {
+                        "generate": "rainy",
+                        "matcher": {
+                          "json_class": "Regexp",
+                          "o": 0,
+                          "s": "rain"
+                        }
+                      }
+                    }
+                }
+            }
+        }
+    ]
+}

data/spec/support/markdown_pact.json

@@ -0,0 +1,48 @@
+{
+  "provider": {
+    "name": "Some Provider"
+  },
+  "consumer": {
+    "name": "Some Consumer"
+  },
+  "interactions": [
+    {
+      "description": "a request for alligators in Brüssel",
+      "provider_state": "alligators exist",
+      "request": {
+        "method": "get",
+        "path": "/alligators"
+      },
+      "response": {
+        "headers" : {"Content-Type": "application/json"},
+        "status" : 200,
+        "body" : {
+          "alligators": [{
+            "name": "Bob",
+            "phoneNumber" : {
+              "json_class": "Pact::Term",
+              "data": {
+                "generate": "12345678",
+                "matcher": {"json_class":"Regexp","o":0,"s":"\\d+"}
+              }
+            }
+          }]
+        }
+      }
+    },{
+      "description": "a request for polar bears",
+      "provider_state": null,
+      "request": {
+        "method": "get",
+        "path": "/polar-bears"
+      },
+      "response": {
+        "headers" : {"Content-Type": "application/json"},
+        "status" : 404,
+        "body" : {
+          "message": "Sorry, due to climate change, the polar bears are currently unavailable."
+        }
+      }
+    }
+  ]
+}

data/spec/support/markdown_pact_with_markdown_chars_in_names.json

@@ -0,0 +1,11 @@
+{
+  "provider": {
+    "name": "Some_Provider_App"
+  },
+  "consumer": {
+    "name": "Some*Consumer*App"
+  },
+  "interactions": [
+
+  ]
+}

data/spec/support/warning_silencer.rb

@@ -0,0 +1,10 @@
+module WarningSilencer
+  extend self
+
+  def enable
+    old, $VERBOSE = $VERBOSE, nil
+    yield
+  ensure
+    $VERBOSE = old
+  end
+end

data/tasks/database/table_dependency_calculator.rb

@@ -20,8 +20,9 @@ module PactBroker
           .collect{|it| @connection.foreign_key_list(it)
           .collect{|fk| {from: it, to: fk[:table]} } }
           .flatten
-          .uniq - [:schema_migrations]
-        check(@connection.tables, dependencies, ordered_table_names)
+          .uniq
+        table_names = @connection.tables - [:schema_migrations, :schema_info]
+        check(table_names, dependencies, ordered_table_names)
         ordered_table_names
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pact_broker
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.13.1
 platform: ruby
 authors:
 - Bethany Skurrie
@@ -165,19 +165,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: pact
+  name: pact-support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: padrino-core
   requirement: !ruby/object:Gem::Requirement
@@ -263,19 +263,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: webrick
+  name: pact
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :runtime
+        version: '1.14'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -602,6 +602,17 @@ files:
 - example/example_data.sql
 - example/pact_broker_database.sqlite3
 - lib/db.rb
+- lib/pact/doc/README.md
+- lib/pact/doc/doc_file.rb
+- lib/pact/doc/generate.rb
+- lib/pact/doc/generator.rb
+- lib/pact/doc/interaction_view_model.rb
+- lib/pact/doc/markdown/consumer_contract_renderer.rb
+- lib/pact/doc/markdown/generator.rb
+- lib/pact/doc/markdown/index_renderer.rb
+- lib/pact/doc/markdown/interaction.erb
+- lib/pact/doc/markdown/interaction_renderer.rb
+- lib/pact/doc/sort_interactions.rb
 - lib/pact_broker.rb
 - lib/pact_broker/api.rb
 - lib/pact_broker/api/contracts/pacticipant_name_contract.rb
@@ -919,6 +930,10 @@ files:
 - spec/integration/endpoints/group_spec.rb
 - spec/integration/ui/index_spec.rb
 - spec/integration/webhooks/certificate_spec.rb
+- spec/lib/pact/doc/generator_spec.rb
+- spec/lib/pact/doc/interaction_view_model_spec.rb
+- spec/lib/pact/doc/markdown/consumer_contract_renderer_spec.rb
+- spec/lib/pact/doc/markdown/index_renderer_spec.rb
 - spec/lib/pact_broker/api/contracts/put_pact_params_contract_spec.rb
 - spec/lib/pact_broker/api/contracts/verification_contract_spec.rb
 - spec/lib/pact_broker/api/contracts/webhook_contract_spec.rb
@@ -1040,12 +1055,19 @@ files:
 - spec/spec_helper.rb
 - spec/support/database_cleaner.rb
 - spec/support/fixture_helpers.rb
+- spec/support/generated_index.md
+- spec/support/generated_markdown.md
+- spec/support/interaction_view_model.json
+- spec/support/interaction_view_model_with_terms.json
+- spec/support/markdown_pact.json
+- spec/support/markdown_pact_with_markdown_chars_in_names.json
 - spec/support/migration_helpers.rb
 - spec/support/rspec_match_hash.rb
 - spec/support/rspec_matchers.rb
 - spec/support/shared_examples_for_responses.rb
 - spec/support/ssl_webhook_server.rb
 - spec/support/test_data_builder.rb
+- spec/support/warning_silencer.rb
 - tasks/database.rb
 - tasks/database/table_dependency_calculator.rb
 - tasks/db.rake
@@ -1170,6 +1192,10 @@ test_files:
 - spec/integration/endpoints/group_spec.rb
 - spec/integration/ui/index_spec.rb
 - spec/integration/webhooks/certificate_spec.rb
+- spec/lib/pact/doc/generator_spec.rb
+- spec/lib/pact/doc/interaction_view_model_spec.rb
+- spec/lib/pact/doc/markdown/consumer_contract_renderer_spec.rb
+- spec/lib/pact/doc/markdown/index_renderer_spec.rb
 - spec/lib/pact_broker/api/contracts/put_pact_params_contract_spec.rb
 - spec/lib/pact_broker/api/contracts/verification_contract_spec.rb
 - spec/lib/pact_broker/api/contracts/webhook_contract_spec.rb
@@ -1291,9 +1317,16 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/database_cleaner.rb
 - spec/support/fixture_helpers.rb
+- spec/support/generated_index.md
+- spec/support/generated_markdown.md
+- spec/support/interaction_view_model.json
+- spec/support/interaction_view_model_with_terms.json
+- spec/support/markdown_pact.json
+- spec/support/markdown_pact_with_markdown_chars_in_names.json
 - spec/support/migration_helpers.rb
 - spec/support/rspec_match_hash.rb
 - spec/support/rspec_matchers.rb
 - spec/support/shared_examples_for_responses.rb
 - spec/support/ssl_webhook_server.rb
 - spec/support/test_data_builder.rb
+- spec/support/warning_silencer.rb