pact-v2 2.0.0.pre.preview1

data/lib/pact/consumer/rspec.rb

@@ -0,0 +1,35 @@
+require 'pact/consumer'
+require 'pact/consumer/spec_hooks'
+require 'pact/rspec'
+require 'pact/helpers'
+
+module Pact
+  module Consumer
+    module RSpec
+      include Pact::Consumer::ConsumerContractBuilders
+      include Pact::Helpers
+    end
+  end
+end
+
+hooks = Pact::Consumer::SpecHooks.new
+
+RSpec.configure do |config|
+  config.include Pact::Consumer::RSpec, :pact => true
+
+  config.before :all, :pact => true do
+    hooks.before_all
+  end
+
+  config.before :each, :pact => true do | example |
+    hooks.before_each Pact::RSpec.full_description(example)
+  end
+
+  config.after :each, :pact => true do | example |
+    hooks.after_each Pact::RSpec.full_description(example)
+  end
+
+  config.after :suite do
+    hooks.after_suite
+  end
+end

data/lib/pact/consumer/spec_hooks.rb

@@ -0,0 +1,40 @@
+require 'pact/doc/generate'
+require 'pact/consumer/world'
+require 'pact/mock_service/app_manager'
+require 'pact/mock_service/client'
+
+module Pact
+  module Consumer
+    class SpecHooks
+
+      def before_all
+        Pact::MockService::AppManager.instance.spawn_all
+        FileUtils.mkdir_p Pact.configuration.pact_dir
+      end
+
+      def before_each example_description
+        Pact.consumer_world.register_pact_example_ran
+        Pact.configuration.logger.info "Clearing all expectations"
+        Pact::MockService::AppManager.instance.urls_of_mock_services.each do | url |
+          Pact::MockService::Client.clear_interactions url, example_description
+        end
+      end
+
+      def after_each example_description
+        Pact.configuration.logger.info "Verifying interactions for #{example_description}"
+        Pact.configuration.provider_verifications.each do | provider_verification |
+          provider_verification.call example_description
+        end
+      end
+
+      def after_suite
+        if Pact.consumer_world.any_pact_examples_ran?
+          Pact.consumer_world.consumer_contract_builders.each(&:write_pact)
+          Pact::Doc::Generate.call
+          Pact::MockService::AppManager.instance.kill_all
+          Pact::MockService::AppManager.instance.clear_all
+        end
+      end
+    end
+  end
+end

data/lib/pact/consumer/world.rb

@@ -0,0 +1,37 @@
+module Pact
+
+  def self.consumer_world
+    @consumer_world ||= Pact::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

data/lib/pact/consumer.rb

@@ -0,0 +1,7 @@
+require 'pact/consumer_contract'
+require 'pact/consumer/configuration'
+require 'pact/consumer/consumer_contract_builder'
+require 'pact/consumer/consumer_contract_builders'
+require 'pact/consumer/interaction_builder'
+require 'pact/term'
+require 'pact/something_like'

data/lib/pact/doc/README.md

@@ -0,0 +1,13 @@
+# How to roll your own Doc Generator
+
+1. Create a ConsumerContractRenderer that responds to `call` and accepts a `ConsumerContract` (this is the name for the domain model of a "pact"). This should return a String. For an example, see the [Markdown::ConsumerContractRenderer][consumer_contract_renderer].
+2. Create an IndexRenderer. This allows you to create an index file for your docs. It should respond to `call` and accept the String name of the consumer, and a hash of Hash of `pact title => file_name`, and return a String. For an example, see the [Markdown::IndexRenderer][index_renderer].
+3. Create a Generator. This is responsible for the overall file generating and writing process. Copy the [Markdown::Generator][generator] and configure it with your own ConsumerContractRenderer, IndexRenderer and file details.
+
+If you would like to generate HTML documentation, see how the [HTMLPactRenderer][html_pact_renderer] in the Pact Broker does it.
+
+[consumer_contract_renderer]: https://github.com/pact-foundation/pact-ruby/blob/master/lib/pact/doc/markdown/consumer_contract_renderer.rb
+[index_renderer]: https://github.com/pact-foundation/pact-ruby/blob/master/lib/pact/doc/markdown/index_renderer.rb
+[generator]: https://github.com/pact-foundation/pact-ruby/blob/master/lib/pact/doc/markdown/generator.rb
+[html_pact_renderer]: https://github.com/pact-foundation/pact_broker/blob/master/lib/pact_broker/api/renderers/html_pact_renderer.rb
+

data/lib/pact/doc/doc_file.rb

@@ -0,0 +1,40 @@
+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,26 @@
+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,43 @@
+require 'erb'
+
+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}](#{ERB::Util.url_encode(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,43 @@
+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,16 @@
+module Pact
+  module Doc
+    class SortInteractions
+
+      def self.call interactions
+        interactions.sort_by { |interaction| sortable_id(interaction) }
+      end
+
+      private
+
+      def self.sortable_id interaction
+        "#{interaction.description.downcase} #{interaction.response.status} #{(interaction.provider_state || '').downcase}"
+      end
+    end
+  end
+end

data/lib/pact/hal/authorization_header_redactor.rb

@@ -0,0 +1,32 @@
+require 'delegate'
+
+module Pact
+  module Hal
+    class AuthorizationHeaderRedactor < SimpleDelegator
+      def puts(*args)
+        __getobj__().puts(*redact_args(args))
+      end
+
+      def print(*args)
+        __getobj__().puts(*redact_args(args))
+      end
+
+      def <<(*args)
+        __getobj__().send(:<<, *redact_args(args))
+      end
+
+      private
+
+      attr_reader :redactions
+
+      def redact_args(args)
+        args.collect{ | s| redact(s) }
+      end
+
+      def redact(string)
+        return string unless string.is_a?(String)
+        string.gsub(/Authorization: .*\\r\\n/, "Authorization: [redacted]\\r\\n")
+      end
+    end
+  end
+end