pact 1.3.3 → 1.4.0

data/example/animal-service/spec/service_consumers/provider_states_for_zoo_app.rb

@@ -1,26 +0,0 @@
-require 'sequel'
-require 'animal_service/db'
-require 'animal_service/animal_repository'
-
-Pact.provider_states_for "Zoo App" do
-
-  set_up do
-    AnimalService::DATABASE[:animals].truncate
-  end
-
-  provider_state "there is an alligator named Mary" do
-    set_up do
-      AnimalService::DATABASE[:animals].insert(name: 'Mary')
-    end
-  end
-
-  provider_state "there is not an alligator named Mary" do
-    no_op
-  end
-
-  provider_state "an error occurs retrieving an alligator" do
-    set_up do
-      allow(AnimalService::AnimalRepository).to receive(:find_alligator_by_name).and_raise("Argh!!!")
-    end
-  end
-end

data/example/zoo-app/Gemfile

@@ -1,12 +0,0 @@
-source 'https://rubygems.org'
-
-group :development, :test do
-  gem 'rspec'
-  gem 'pact', path: '../../'
-  gem 'pry'
-end
-
-gem 'rake'
-gem 'rack', '~>1.5.2'
-gem 'json', '~>1.6.8'
-gem 'httparty'

data/example/zoo-app/Gemfile.lock

@@ -1,63 +0,0 @@
-PATH
-  remote: ../../
-  specs:
-    pact (1.1.0.rc3)
-      awesome_print (~> 1.1)
-      find_a_port (~> 1.0.1)
-      json
-      rack-test (~> 0.6.2)
-      randexp (~> 0.1.7)
-      rspec (~> 2.12)
-      term-ansicolor (~> 1.0)
-      thor
-      webrick
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    awesome_print (1.2.0)
-    coderay (1.0.9)
-    diff-lcs (1.2.4)
-    find_a_port (1.0.1)
-    httparty (0.11.0)
-      multi_json (~> 1.0)
-      multi_xml (>= 0.5.2)
-    json (1.6.8)
-    method_source (0.8.2)
-    multi_json (1.7.9)
-    multi_xml (0.5.5)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rack (1.5.2)
-    rack-test (0.6.2)
-      rack (>= 1.0)
-    rake (10.1.0)
-    randexp (0.1.7)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.2)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    slop (3.4.6)
-    term-ansicolor (1.3.0)
-      tins (~> 1.0)
-    thor (0.19.1)
-    tins (1.1.0)
-    webrick (1.3.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  httparty
-  json (~> 1.6.8)
-  pact!
-  pry
-  rack (~> 1.5.2)
-  rake
-  rspec

data/example/zoo-app/Rakefile

@@ -1,5 +0,0 @@
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/example/zoo-app/doc/pacts/markdown/README.md

@@ -1,3 +0,0 @@
-### Pacts for Zoo App
-
-* [Animal Service](Zoo App - Animal Service.md)

data/example/zoo-app/doc/pacts/markdown/Zoo App - Animal Service.md

@@ -1,75 +0,0 @@
-### A pact between Zoo App and Animal Service
-
-#### Requests from Zoo App to Animal Service
-
-* [A request for an alligator](#a_request_for_an_alligator_given_there_is_an_alligator_named_Mary) given there is an alligator named Mary
-
-* [A request for an alligator](#a_request_for_an_alligator_given_there_is_not_an_alligator_named_Mary) given there is not an alligator named Mary
-
-* [A request for an alligator](#a_request_for_an_alligator_given_an_error_occurs_retrieving_an_alligator) given an error occurs retrieving an alligator
-
-#### Interactions
-
-<a name="a_request_for_an_alligator_given_there_is_an_alligator_named_Mary"></a>
-Given **there is an alligator named Mary**, upon receiving **a request for an alligator** from Zoo App, with
-```json
-{
-  "method": "get",
-  "path": "/alligators/Mary",
-  "headers": {
-    "Accept": "application/json"
-  }
-}
-```
-Animal Service will respond with:
-```json
-{
-  "status": 200,
-  "headers": {
-    "Content-Type": "application/json;charset=utf-8"
-  },
-  "body": {
-    "name": "Mary"
-  }
-}
-```
-<a name="a_request_for_an_alligator_given_there_is_not_an_alligator_named_Mary"></a>
-Given **there is not an alligator named Mary**, upon receiving **a request for an alligator** from Zoo App, with
-```json
-{
-  "method": "get",
-  "path": "/alligators/Mary",
-  "headers": {
-    "Accept": "application/json"
-  }
-}
-```
-Animal Service will respond with:
-```json
-{
-  "status": 404
-}
-```
-<a name="a_request_for_an_alligator_given_an_error_occurs_retrieving_an_alligator"></a>
-Given **an error occurs retrieving an alligator**, upon receiving **a request for an alligator** from Zoo App, with
-```json
-{
-  "method": "get",
-  "path": "/alligators/Mary",
-  "headers": {
-    "Accept": "application/json"
-  }
-}
-```
-Animal Service will respond with:
-```json
-{
-  "status": 500,
-  "headers": {
-    "Content-Type": "application/json;charset=utf-8"
-  },
-  "body": {
-    "error": "Argh!!!"
-  }
-}
-```

data/example/zoo-app/lib/zoo_app/animal_service_client.rb

@@ -1,40 +0,0 @@
-require 'httparty'
-require 'zoo_app/models/alligator'
-
-module ZooApp
-  class AnimalServiceClient
-
-    include HTTParty
-    base_uri 'animal-service.com'
-
-    def self.find_alligators
-      response = get("/alligators", :headers => {'Accept' => 'application/json'})
-      handle_response response do
-        parse_body(response).collect do | hash |
-          ZooApp::Animals::Alligator.new(hash)
-        end
-      end
-    end
-
-    def self.find_alligator_by_name name
-      response = get("/alligators/#{name}", :headers => {'Accept' => 'application/json'})
-      when_successful(response) do
-        ZooApp::Animals::Alligator.new(parse_body(response))
-      end
-    end
-
-    def self.when_successful response
-      if response.success?
-        yield
-      elsif response.code == 404
-        nil
-      else
-        raise response.body
-      end
-    end
-
-    def self.parse_body response
-      JSON.parse(response.body, {:symbolize_names => true})
-    end
-  end
-end

data/example/zoo-app/lib/zoo_app/models/alligator.rb

@@ -1,15 +0,0 @@
-module ZooApp
-  module Animals
-    class Alligator
-      attr_reader :name
-      def initialize attributes
-        @name = attributes[:name]
-      end
-
-      def == other
-        other.is_a?(Alligator) && other.name == self.name
-      end
-
-    end
-  end
-end

data/example/zoo-app/spec/pacts/zoo_app-animal_service.json

@@ -1,67 +0,0 @@
-{
-  "provider": {
-    "name": "Animal Service"
-  },
-  "consumer": {
-    "name": "Zoo App"
-  },
-  "interactions": [
-    {
-      "description": "a request for an alligator",
-      "provider_state": "there is an alligator named Mary",
-      "request": {
-        "method": "get",
-        "path": "/alligators/Mary",
-        "headers": {
-          "Accept": "application/json"
-        }
-      },
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/json;charset=utf-8"
-        },
-        "body": {
-          "name": "Mary"
-        }
-      }
-    },
-    {
-      "description": "a request for an alligator",
-      "provider_state": "there is not an alligator named Mary",
-      "request": {
-        "method": "get",
-        "path": "/alligators/Mary",
-        "headers": {
-          "Accept": "application/json"
-        }
-      },
-      "response": {
-        "status": 404
-      }
-    },
-    {
-      "description": "a request for an alligator",
-      "provider_state": "an error occurs retrieving an alligator",
-      "request": {
-        "method": "get",
-        "path": "/alligators/Mary",
-        "headers": {
-          "Accept": "application/json"
-        }
-      },
-      "response": {
-        "status": 500,
-        "headers": {
-          "Content-Type": "application/json;charset=utf-8"
-        },
-        "body": {
-          "error": "Argh!!!"
-        }
-      }
-    }
-  ],
-  "metadata": {
-    "pactSpecificationVersion": "1.0.0"
-  }
-}

data/example/zoo-app/spec/service_providers/animal_service_client_spec.rb

@@ -1,71 +0,0 @@
-require_relative 'pact_helper'
-require 'zoo_app/animal_service_client'
-
-module ZooApp
-  describe AnimalServiceClient, :pact => true do
-
-    before do
-      AnimalServiceClient.base_uri animal_service.mock_service_base_url
-    end
-
-    describe ".find_alligator_by_name" do
-      context "when an alligator by the given name exists" do
-
-        before do
-          animal_service.given("there is an alligator named Mary").
-            upon_receiving("a request for an alligator").with(
-              method: :get,
-              path: '/alligators/Mary',
-              headers: {'Accept' => 'application/json'} ).
-            will_respond_with(
-              status: 200,
-              headers: {'Content-Type' => 'application/json;charset=utf-8'},
-              body: {name: 'Mary'}
-            )
-        end
-
-        it "returns the alligator" do
-          expect(AnimalServiceClient.find_alligator_by_name("Mary")).to eq ZooApp::Animals::Alligator.new(name: 'Mary')
-        end
-
-      end
-
-      context "when an alligator by the given name does not exist" do
-
-        before do
-          animal_service.given("there is not an alligator named Mary").
-            upon_receiving("a request for an alligator").with(
-              method: :get,
-              path: '/alligators/Mary',
-              headers: {'Accept' => 'application/json'} ).
-            will_respond_with(status: 404)
-        end
-
-        it "returns nil" do
-          expect(AnimalServiceClient.find_alligator_by_name("Mary")).to be_nil
-        end
-
-      end
-
-      context "when an error occurs retrieving the alligator" do
-
-        before do
-          animal_service.given("an error occurs retrieving an alligator").
-            upon_receiving("a request for an alligator").with(
-              method: :get,
-              path: '/alligators/Mary',
-              headers: {'Accept' => 'application/json'}).
-            will_respond_with(
-              status: 500,
-              headers: { 'Content-Type' => 'application/json;charset=utf-8'},
-              body: {error: 'Argh!!!'})
-        end
-
-        it "raises an error" do
-          expect{ AnimalServiceClient.find_alligator_by_name("Mary") }.to raise_error /Argh/
-        end
-
-      end
-    end
-  end
-end

data/example/zoo-app/spec/service_providers/pact_helper.rb

@@ -1,15 +0,0 @@
-require_relative '../spec_helper'
-require 'pact/consumer/rspec'
-
-Pact.configure do | config |
-  config.doc_generator = :markdown
-end
-
-Pact.service_consumer 'Zoo App' do
-  has_pact_with "Animal Service" do
-    mock_service :animal_service do
-      port 1234
-    end
-  end
-end
-

data/example/zoo-app/spec/spec_helper.rb

@@ -1,6 +0,0 @@
-$: << File.expand_path("../../lib", __FILE__)
-
-RSpec.configure do | config |
-  config.color = true
-  config.formatter = :documentation
-end

data/lib/pact/configuration.rb

@@ -1,195 +0,0 @@
-require 'ostruct'
-require 'logger'
-require 'pact/doc/markdown/generator'
-require 'pact/matchers/unix_diff_formatter'
-require 'pact/matchers/embedded_diff_formatter'
-require 'pact/matchers/list_diff_formatter'
-require 'pact/shared/json_differ'
-require 'pact/shared/text_differ'
-
-module Pact
-
-  class Configuration
-
-    DOC_GENERATORS = { markdown: Pact::Doc::Markdown::Generator }
-
-    DIFF_FORMATTERS = {
-      :embedded => Pact::Matchers::EmbeddedDiffFormatter,
-      :unix => Pact::Matchers::UnixDiffFormatter,
-      :list => Pact::Matchers::ListDiffFormatter
-    }
-
-
-    class NilMatcher
-      def self.=~ other
-        other == nil ? 0 : nil
-      end
-    end
-
-    DIFF_FORMATTER_REGISTRATIONS = [
-      [/.*/, Pact::Matchers::UnixDiffFormatter],
-      [NilMatcher, Pact::Matchers::UnixDiffFormatter]
-    ]
-
-    DIFFERS = [
-      [/json/, Pact::JsonDiffer],
-      [NilMatcher, Pact::TextDiffer],
-      [/.*/, Pact::TextDiffer]
-    ]
-
-
-    DEFAULT_DIFFER = Pact::TextDiffer
-
-    attr_accessor :pact_dir
-    attr_accessor :log_dir
-    attr_accessor :doc_dir
-    attr_accessor :reports_dir
-    attr_writer :logger
-    attr_accessor :tmp_dir
-    attr_writer :pactfile_write_mode
-
-    attr_accessor :error_stream
-    attr_accessor :output_stream
-
-    def self.default_configuration
-      c = Configuration.new
-      c.pact_dir = File.expand_path('./spec/pacts')
-      c.tmp_dir = File.expand_path('./tmp/pacts')
-      c.log_dir = default_log_dir
-      c.pactfile_write_mode = :overwrite
-      c.reports_dir = File.expand_path('./reports/pacts')
-      c.doc_dir = File.expand_path("./doc/pacts")
-      c.output_stream = $stdout
-      c.error_stream = $stderr
-      c
-    end
-
-    def initialize
-      @differ_registrations = []
-      @diff_formatter_registrations = []
-    end
-
-    def logger
-      @logger ||= create_logger
-    end
-
-    def doc_generator= doc_generator
-      doc_generators << begin
-        if DOC_GENERATORS[doc_generator]
-          DOC_GENERATORS[doc_generator]
-        elsif doc_generator.respond_to?(:call)
-          doc_generator
-        else
-          raise "Pact.configuration.doc_generator needs to respond to call, or be in the preconfigured list: #{DOC_GENERATORS.keys}"
-        end
-      end
-    end
-
-    def doc_generators
-      @doc_generators  ||= []
-    end
-
-    # Should this be deprecated in favour of register_diff_formatter???
-    def diff_formatter= diff_formatter
-      register_diff_formatter /.*/, diff_formatter
-      register_diff_formatter nil, diff_formatter
-    end
-
-    def register_diff_formatter content_type, diff_formatter
-      key = content_type_regexp_for content_type
-      @diff_formatter_registrations << [key, diff_formatter_for(diff_formatter)]
-    end
-
-    def diff_formatter_for_content_type content_type
-      diff_formatter_registrations.find{ | registration | registration.first =~ content_type }.last
-    end
-
-    def register_body_differ content_type, differ
-      key = content_type_regexp_for content_type
-      validate_differ differ
-      @differ_registrations << [key, differ]
-    end
-
-    def body_differ_for_content_type content_type
-      differ_registrations.find{ | registration | registration.first =~ content_type }.last
-    end
-
-    def log_path
-      log_dir + "/pact.log"
-    end
-
-    def pactfile_write_mode
-      if @pactfile_write_mode == :smart
-        is_rake_running? ? :overwrite : :update
-      else
-        @pactfile_write_mode
-      end
-    end
-
-    private
-
-    def diff_formatter_for input
-      if DIFF_FORMATTERS[input]
-        DIFF_FORMATTERS[input]
-      elsif input.respond_to?(:call)
-        input
-      else
-        raise "Pact diff_formatter needs to respond to call, or be in the preconfigured list: #{DIFF_FORMATTERS.keys}"
-      end
-    end
-
-    def validate_differ differ
-      if !differ.respond_to?(:call)
-        raise "Pact.configuration.register_body_differ expects a differ that is a lamda or a class/object that responds to call."
-      end
-    end
-
-    def content_type_regexp_for content_type
-      case content_type
-      when String then Regexp.new(/^#{Regexp.escape(content_type)}$/)
-      when Regexp then content_type
-      when nil then NilMatcher
-      else
-        raise "Invalid content type used to register a differ (#{content_type.inspect}). Please use a Regexp or a String."
-      end
-    end
-
-    def differ_registrations
-      @differ_registrations + DIFFERS
-    end
-
-    def diff_formatter_registrations
-      @diff_formatter_registrations + DIFF_FORMATTER_REGISTRATIONS
-    end
-
-    def self.default_log_dir
-      File.expand_path("./log")
-    end
-
-    #Would love a better way of determining this! It sure won't work on windows.
-    def is_rake_running?
-      `ps -ef | grep rake | grep #{Process.ppid} | grep -v 'grep'`.size > 0
-    end
-
-    def create_logger
-      FileUtils::mkdir_p log_dir
-      logger = Logger.new(log_path)
-      logger.level = Logger::DEBUG
-      logger
-    end
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.default_configuration
-  end
-
-  def self.configure
-    yield configuration
-    FileUtils::mkdir_p configuration.tmp_dir
-  end
-
-  def self.clear_configuration
-    @configuration = nil
-  end
-
-end