pact 1.0.9 → 1.0.10

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+### 1.0.10 (24 September 2014)
+* Removing unused requires [Beth Skurrie, 20 hours ago]
+* Adding example changes [Beth Skurrie, 20 hours ago]
+* Cleaning up provider configuration DSL. [Beth Skurrie, 6 days ago]
+* Cleaned up consumer configuration DSL. [Beth Skurrie, 6 days ago]
+* Splitting MockService request handlers into their own separate files. Divide and conquer... [Beth Skurrie, 6 days ago]
+* Improving logging in mock service. [Beth Skurrie, 6 days ago]
+* Cleaned up interaction list test. [Beth Skurrie, 6 days ago]
+* Added better messages for matching when arrays are of different lengths. [Beth Skurrie, 6 days ago]
+* Refactoring the Request world. Put each sub class of Request into it's relevant module. [Beth Skurrie, 6 days ago]
+* Renaming request.match to request.matches? [Beth Skurrie, 7 days ago]
+* Commenting and cleaning code. [Beth Skurrie, 7 days ago]
+* Removed horrible as_json_for_mock_service method and created new class to do the same thing. [Beth Skurrie, 7 days ago]
+* Moving rake task files into tasks directory. [Beth Skurrie, 7 days ago]
+* Moving request file into consumer_contract folder. [Beth Skurrie, 7 days ago]
+* Symbolizing keys so from_hash does not have to duplicate so much of the constructor methods. Service provider is now mandatory. [Beth Skurrie, 7 days ago]
+* Removed Hashie from run time dependencies. [Beth Skurrie, 7 days ago]
+* Starting to clean up mock service. Adding integration tests for failure scenarios. (Beth Skurrie, 7 days ago]
+* Added RSpec fire to ensure stubbed methods exist. Pulled the recreation of a repayable request from an expected request out of the TestHelper into its own class. [Beth Skurrie, 7 days ago]
+
 ### 1.0.9 (16 September 2013)
 
 * Fixing pretty generate of json [Beth Skurrie]

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    pact (1.0.9)
+    pact (1.0.10)
       awesome_print (~> 1.1.0)
       find_a_port (~> 1.0.1)
-      hashie (~> 2.0)
       json
       rack-test (~> 0.6.2)
       randexp (~> 0.1.7)
@@ -46,7 +45,7 @@ GEM
       rspec-expectations (~> 2.14.0)
       rspec-mocks (~> 2.14.0)
     rspec-core (2.14.5)
-    rspec-expectations (2.14.2)
+    rspec-expectations (2.14.3)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.3)
     safe_yaml (0.9.5)
@@ -66,6 +65,7 @@ PLATFORMS
 DEPENDENCIES
   fakefs (~> 0.4)
   geminabox-client
+  hashie (~> 2.0)
   pact!
   pry
   rake (~> 10.0.3)

data/example/animal-service/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'bundler', '~> 1.3.0'
+
+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/animal-service/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: ../../
+  specs:
+    pact (1.0.9)
+      awesome_print (~> 1.1.0)
+      find_a_port (~> 1.0.1)
+      hashie (~> 2.0)
+      json
+      rack-test (~> 0.6.2)
+      randexp (~> 0.1.7)
+      rspec (~> 2.12)
+      thin
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.1.0)
+    coderay (1.0.9)
+    daemons (1.1.9)
+    diff-lcs (1.2.4)
+    eventmachine (1.0.3)
+    find_a_port (1.0.1)
+    hashie (2.0.5)
+    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.8.0)
+    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)
+    thin (1.5.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3.0)
+  httparty
+  json (~> 1.6.8)
+  pact!
+  pry
+  rack (~> 1.5.2)
+  rake
+  rspec

data/example/animal-service/Rakefile

@@ -0,0 +1,3 @@
+require 'pact/tasks'
+
+:default => ['pact:verify']

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

@@ -0,0 +1,24 @@
+require 'pact/provider/rspec'
+require_relative "provider_states_for_zoo_app"
+
+
+class AnimalService
+
+  def call env
+    response_body = {}
+    if env['PATH_INFO'] == '/alligators'
+      response_body = {'name' => 'Bob'}.to_json
+    end
+    [200, {'Content-Type' => 'application/json'}, [response_body]]
+  end
+end
+
+Pact.service_provider 'Animal Service' do
+  app do
+    AnimalService.new
+  end
+
+  honours_pact_with "Zoo App" do
+    pact_uri '../zoo-app/spec/pacts/zoo_app-animal_service.json'
+  end
+end

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

@@ -0,0 +1,9 @@
+Pact.provider_states_for "Zoo App" do
+  provider_state "there are alligators" do
+    #AlligatorRepo.save(Alligator.name("Mary"))
+  end
+
+  provider_state "there is not an alligator named Mary" do
+
+  end
+end

data/example/zoo-app/Gemfile.lock

@@ -1,11 +1,10 @@
 PATH
   remote: ../../
   specs:
-    pact (0.1.37)
+    pact (1.0.9)
       awesome_print (~> 1.1.0)
-      capybara (~> 2.1.0)
       find_a_port (~> 1.0.1)
-      hashie (~> 2.0.5)
+      hashie (~> 2.0)
       json
       rack-test (~> 0.6.2)
       randexp (~> 0.1.7)
@@ -17,12 +16,6 @@ GEM
   remote: https://rubygems.org/
   specs:
     awesome_print (1.1.0)
-    capybara (2.1.0)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      xpath (~> 2.0)
     coderay (1.0.9)
     daemons (1.1.9)
     diff-lcs (1.2.4)
@@ -34,12 +27,8 @@ GEM
       multi_xml (>= 0.5.2)
     json (1.6.8)
     method_source (0.8.2)
-    mime-types (1.24)
-    mini_portile (0.5.1)
     multi_json (1.7.9)
     multi_xml (0.5.5)
-    nokogiri (1.6.0)
-      mini_portile (~> 0.5.0)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
@@ -63,8 +52,6 @@ GEM
       eventmachine (>= 0.12.6)
       rack (>= 1.0.0)
     thor (0.18.1)
-    xpath (2.0.0)
-      nokogiri (~> 1.3)
 
 PLATFORMS
   ruby

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

@@ -63,11 +63,9 @@
         "headers": {
           "Content-Type": "application/json"
         },
-        "body": [
-          {
-            "name": "Mary"
-          }
-        ]
+        "body": {
+          "name": "Mary"
+        }
       },
       "provider_state": "there is an alligator named Mary"
     },
@@ -90,11 +88,28 @@
         }
       },
       "provider_state": "an error has occurred"
+    },
+    {
+      "description": "a request for alligator Mary",
+      "request": {
+        "method": "get",
+        "path": "/alligators/Mary",
+        "headers": {
+          "Accept": "application/json"
+        }
+      },
+      "response": {
+        "status": 404,
+        "headers": {
+          "Content-Type": "application/json"
+        }
+      },
+      "provider_state": "there is not an alligator named Mary"
     }
   ],
   "metadata": {
     "pact_gem": {
-      "version": "0.1.37"
+      "version": "1.0.9"
     }
   }
 }

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

@@ -73,7 +73,7 @@ module ZooApp
 
         before do
           animal_service.
-            given("there is an alligator named Mary").
+            given("there is not an alligator named Mary").
               upon_receiving("a request for alligator Mary").
                 with({ method: :get, path: '/alligators/Mary', :headers => {'Accept' => 'application/json'} }).
                   will_respond_with({

data/lib/pact/consumer.rb

@@ -1,11 +1,10 @@
-require_relative 'consumer_contract'
-require_relative 'consumer/consumer_contract_builder'
-require_relative 'consumer/consumer_contract_builders'
-require_relative 'consumer/dsl'
-require_relative 'consumer/interaction_builder'
-require_relative 'consumer/mock_service'
-require_relative 'consumer/mock_service_client'
-require_relative 'consumer/app_manager'
-require_relative 'term'
-require_relative 'something_like'
-require_relative 'request'
+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/consumer/mock_service'
+require 'pact/consumer/mock_service_client'
+require 'pact/consumer/app_manager'
+require 'pact/term'
+require 'pact/something_like'

data/lib/pact/consumer/app_manager.rb

@@ -5,6 +5,7 @@ require 'uri'
 require 'find_a_port'
 require 'pact/logging'
 require 'pact/consumer/server'
+require 'singleton'
 
 module Pact
   module Consumer

data/lib/pact/consumer/configuration.rb

@@ -0,0 +1,179 @@
+require 'pact/configuration'
+require 'pact/consumer/consumer_contract_builders'
+require 'pact/consumer/consumer_contract_builder'
+require 'pact/shared/dsl'
+
+module Pact::Consumer
+
+  module DSL
+    def service_consumer name, &block
+      Configuration::ServiceConsumer.build(name, &block)
+    end
+  end
+
+  module Configuration
+
+    module ConfigurationExtensions
+      def add_provider_verification &block
+        provider_verifications << block
+      end
+      def provider_verifications
+        @provider_verifications ||= []
+      end
+    end
+
+    class ServiceConsumer
+      extend Pact::DSL
+      attr_accessor :app, :port, :name
+
+      def initialize name
+        @name = name
+        @app = nil
+        @port = nil
+      end
+
+      dsl do
+        def app app
+          self.app = app
+        end
+
+        def port port
+          self.port = port
+        end
+
+        def has_pact_with service_provider_name, &block
+          ServiceProvider.build(service_provider_name, name, &block)
+        end
+      end   
+
+      def finalize
+        validate
+        register_consumer_app if @app
+      end
+
+      private
+
+      def validate
+        raise "Please provide a consumer name" unless (name && !name.empty?)
+        raise "Please provide a port for the consumer app" if app && !port
+      end
+
+
+      def register_consumer_app
+        Pact::Consumer::AppManager.instance.register app, port
+      end
+    end
+
+
+    class ServiceProvider
+      extend Pact::DSL
+
+      attr_accessor :service, :consumer_name, :name
+
+      def initialize name, consumer_name
+        @name = name
+        @service = nil
+        @consumer_name = consumer_name
+      end
+
+      dsl do          
+        def mock_service name, &block
+          self.service = MockService.build(name, consumer_name, self.name, &block)
+        end
+      end
+
+      def finalize
+        validate
+      end
+
+      private
+
+      def validate
+        raise "Please configure a service for #{name}" unless service
+      end
+
+    end
+
+    class MockService
+      extend Pact::DSL
+
+      attr_accessor :port, :standalone, :verify, :provider_name, :consumer_name
+
+      def initialize name, consumer_name, provider_name
+        @name = name
+        @consumer_name = consumer_name
+        @provider_name = provider_name
+        @port = nil
+        @standalone = false
+        @verify = true
+      end
+
+      dsl do
+        def port port
+          self.port = port
+        end
+
+        def standalone standalone
+          self.standalone = standalone
+        end
+
+        def verify verify
+          self.verify = verify
+        end
+      end
+
+      def finalize
+        validate
+        register_mock_service
+        configure_consumer_contract_builder
+      end
+
+      private
+
+      def register_mock_service
+        unless standalone
+          AppManager.instance.register_mock_service_for provider_name, "http://localhost:#{port}"
+        end
+      end
+
+      def configure_consumer_contract_builder
+        consumer_contract_builder = create_consumer_contract_builder
+        create_consumer_contract_builders_method consumer_contract_builder
+        setup_verification(consumer_contract_builder) if verify
+        consumer_contract_builder
+      end
+
+      def create_consumer_contract_builder
+        consumer_contract_builder_fields = {
+          :consumer_name => consumer_name,
+          :provider_name => provider_name,
+          :pactfile_write_mode => Pact.configuration.pactfile_write_mode,
+          :port => port
+        }
+        Pact::Consumer::ConsumerContractBuilder.new consumer_contract_builder_fields
+      end
+
+      def setup_verification consumer_contract_builder
+        Pact.configuration.add_provider_verification do | example_description |
+          consumer_contract_builder.verify example_description
+        end
+      end
+
+       # This makes the consumer_contract_builder available via a module method with the given identifier
+       # as the method name.
+       # I feel this should be defined somewhere else, but I'm not sure where
+      def create_consumer_contract_builders_method consumer_contract_builder
+        Pact::Consumer::ConsumerContractBuilders.send(:define_method, @name.to_sym) do
+          consumer_contract_builder
+        end
+      end
+
+      def validate
+        raise "Please provide a port for service #{name}" unless port
+      end
+    end
+  end
+end
+
+Pact.send(:extend, Pact::Consumer::DSL)
+Pact::Configuration.send(:include, Pact::Consumer::Configuration::ConfigurationExtensions)