pacto 0.3.1 → 0.4.0.rc1

data/lib/pacto/server.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+require 'goliath'
+require 'pacto'
+require 'pacto/server/api'

data/lib/pacto/stubs/uri_pattern.rb

@@ -1,22 +1,32 @@
+# -*- encoding : utf-8 -*-
 module Pacto
   class UriPattern
     class << self
-      def for(request)
-        if Pacto.configuration.strict_matchers
-          build_strict_uri_pattern(request)
+      def for(request, strict = Pacto.configuration.strict_matchers)
+        fix_deprecations(request)
+
+        build_template_uri_pattern(request, strict)
+      end
+
+      def build_template_uri_pattern(request, strict)
+        path = request.path.respond_to?(:pattern) ? request.path.pattern : request.path
+        host = request.host ||= '{server}'
+        scheme, host = host.split('://') if host.include?('://')
+        scheme ||= '{scheme}'
+
+        if strict
+          Addressable::Template.new("#{scheme}://#{host}#{path}")
         else
-          build_relaxed_uri_pattern(request)
+          Addressable::Template.new("#{scheme}://#{host}#{path}{?anyvars*}")
         end
       end
 
-      def build_strict_uri_pattern(request)
-        "#{request.host}#{request.path}"
-      end
+      def fix_deprecations(request)
+        return if request.path.is_a? Addressable::Template
+        return if request.path == (corrected_path = request.path.gsub(/\/:(\w+)/, '/{\\1}'))
 
-      def build_relaxed_uri_pattern(request)
-        path_pattern = request.path.gsub(/\/:\w+/, '/[^\/\?#]+')
-        host_pattern = Regexp.quote(request.host)
-        /#{host_pattern}#{path_pattern}/
+        Pacto::UI.deprecation "Please change path #{request.path} to uri template: #{corrected_path}"
+        request.path = Addressable::Template.new(corrected_path)
       end
     end
   end

data/lib/pacto/stubs/webmock_adapter.rb

@@ -1,47 +1,86 @@
-require 'pacto/stubs/webmock_helper'
-
+# -*- encoding : utf-8 -*-
 module Pacto
+  module Adapters
+    module WebMock
+      class PactoRequest < Pacto::PactoRequest
+        extend Forwardable
+        def_delegators :@webmock_request_signature, :headers, :method, :body, :uri, :to_s, :inspect
+
+        def initialize(webmock_request_signature)
+          @webmock_request_signature = webmock_request_signature
+        end
+
+        def params
+          @webmock_request_signature.uri.query_values
+        end
+
+        def path
+          @webmock_request_signature.uri.path
+        end
+      end
+
+      class PactoResponse < Pacto::PactoResponse
+        extend Forwardable
+        def_delegators :@webmock_response, :body, :body=, :headers=, :status=, :to_s, :inspect
+
+        def initialize(webmock_response)
+          @webmock_response = webmock_response
+        end
+
+        def headers
+          @webmock_response.headers || {}
+        end
+
+        def status
+          status, _ = @webmock_response.status
+          status
+        end
+      end
+    end
+  end
   module Stubs
     class WebMockAdapter
-      def initialize
-        register_hooks
+      include Resettable
+
+      def initialize(middleware)
+        @middleware = middleware
+
+        WebMock.after_request do |webmock_request_signature, webmock_response|
+          process_hooks webmock_request_signature, webmock_response
+        end
       end
 
-      def stub_request!(request, response)
-        uri_pattern = UriPattern.for(request)
-        stub = WebMock.stub_request(request.method, uri_pattern)
+      def stub_request!(contract)
+        request_clause = contract.request
+        uri_pattern = UriPattern.for(request_clause)
+        stub = WebMock.stub_request(request_clause.http_method, uri_pattern)
 
-        stub.request_pattern.with(strict_details(request)) if Pacto.configuration.strict_matchers
+        stub.request_pattern.with(strict_details(request_clause)) if Pacto.configuration.strict_matchers
 
-        stub.to_return(
-          :status => response.status,
-          :headers => response.headers,
-          :body => format_body(response.body)
-        )
+        stub.to_return do |request|
+          pacto_request = Pacto::Adapters::WebMock::PactoRequest.new request
+          response = contract.response_for pacto_request
+          {
+            status: response.status,
+            headers: response.headers,
+            body: format_body(response.body)
+          }
+        end
       end
 
-      def reset!
+      def self.reset!
         WebMock.reset!
         WebMock.reset_callbacks
       end
 
-      def process_hooks(request_signature, response)
-        WebMockHelper.generate(request_signature, response) if Pacto.generating?
-
-        contracts = Pacto.contracts_for request_signature
-        Pacto.configuration.hook.process contracts, request_signature, response
-
-        WebMockHelper.validate(request_signature, response) if Pacto.validating?
+      def process_hooks(webmock_request_signature, webmock_response)
+        pacto_request = Pacto::Adapters::WebMock::PactoRequest.new webmock_request_signature
+        pacto_response = Pacto::Adapters::WebMock::PactoResponse.new webmock_response
+        @middleware.process pacto_request, pacto_response
       end
 
       private
 
-      def register_hooks
-        WebMock.after_request do |request_signature, response|
-          process_hooks request_signature, response
-        end
-      end
-
       def format_body(body)
         if body.is_a?(Hash) || body.is_a?(Array)
           body.to_json
@@ -52,17 +91,13 @@ module Pacto
 
       def strict_details(request)
         {}.tap do |details|
-          unless request.params.empty?
-            details[webmock_params_key(request)] = request.params
-          end
-          unless request.headers.empty?
-            details[:headers] = request.headers
-          end
+          details[webmock_params_key(request)] = request.params unless request.params.empty?
+          details[:headers] = request.headers unless request.headers.empty?
         end
       end
 
       def webmock_params_key(request)
-        request.method == :get ? :query : :body
+        request.http_method == :get ? :query : :body
       end
     end
   end

data/lib/pacto/swagger_contract_factory.rb

@@ -0,0 +1,90 @@
+# -*- encoding : utf-8 -*-
+require 'swagger'
+
+module Pacto
+  # Builds {Pacto::Contract} instances from Swagger documents
+  class SwaggerContractFactory
+    include Logger
+
+    def load_hints(contract_path, host = nil)
+      app = Swagger.load(contract_path)
+      app.operations.map do |op|
+        Pacto::Generator::Hint.new(request_clause_hash(op, host).merge(
+          service_name: op.fetch(:summary)
+        ))
+      end
+    end
+
+    def build_from_file(contract_path, host = nil)
+      app = Swagger.load(contract_path)
+      app.operations.map do |op|
+        default_response = op.default_response
+        request = Pacto::RequestClause.new(request_clause_hash(op, host))
+        response = Pacto::ResponseClause.new(response_clause_hash(op, default_response, host))
+        Contract.new(
+          id: op.operationId,
+          name: op.full_name,
+          file: contract_path,
+          request: request, response: response,
+          examples: build_examples(op, default_response)
+        )
+      end
+    rescue ArgumentError => e
+      raise "Could not load #{contract_path}: #{e.message}"
+    end
+
+    def files_for(contracts_dir)
+      full_path = Pathname.new(contracts_dir).realpath
+
+      if  full_path.directory?
+        all_json_files = "#{full_path}/**/*.{json,yaml,yml}"
+        Dir.glob(all_json_files).map do |f|
+          Pathname.new(f)
+        end
+      else
+        [full_path]
+      end
+    end
+
+    private
+
+    def request_clause_hash(op, host)
+      {
+        host: op.host || host,
+        http_method: op.verb,
+        path: op.path
+      }
+    end
+
+    def response_clause_hash(op, response, _host)
+      if response.nil?
+        logger.warn("No response defined for #{op.full_name}")
+        return Pacto::ResponseClause.new(status: 200)
+      end
+
+      {}.tap do | response_clause |
+        response_clause[:status] = response.status_code || 200
+        response_clause[:schema] = response.schema.parse unless response.schema.nil?
+      end
+    end
+
+    def build_examples(op, response)
+      return nil if response.nil? || response.examples.nil? || response.examples.empty?
+
+      {
+        default: {
+          request: {}, # Swagger doesn't have a clear way to capture request examples
+          response: {
+            body: response.examples.values.first.parse
+          }
+        }
+      }
+    rescue => e # FIXME: Only parsing errors?
+      logger.warn("Error while trying to parse response example for #{op.full_name}")
+      logger.debug("  Error details: #{e.inspect}")
+      nil
+    end
+  end
+end
+
+Pacto::ContractFactory.add_factory(:swagger, Pacto::SwaggerContractFactory.new)

data/lib/pacto/test_helper.rb

@@ -0,0 +1,37 @@
+# -*- encoding : utf-8 -*-
+begin
+  require 'pacto'
+  require 'goliath/test_helper'
+  require 'pacto/server'
+rescue LoadError
+  raise 'pacto/test_helper requires the goliath and pacto-server gems'
+end
+
+module Pacto
+  module TestHelper
+    include Goliath::TestHelper
+    DEFAULT_ARGS = {
+      stdout: true,
+      log_file: 'pacto.log',
+      # :config => 'pacto/config/pacto_server.rb',
+      strict: false,
+      stub: true,
+      live: false,
+      generate: false,
+      verbose: true,
+      validate: true,
+      directory: File.join(Dir.pwd, 'spec', 'fixtures', 'contracts'),
+      port: 9000
+    }
+
+    def with_pacto(args = DEFAULT_ARGS)
+      args = DEFAULT_ARGS.merge args
+      with_api(Pacto::Server::API, args) do
+        EM::Synchrony.defer do
+          yield "http://localhost:#{@test_server_port}"
+          EM.stop
+        end
+      end
+    end
+  end
+end

data/lib/pacto/ui.rb

@@ -1,7 +1,37 @@
-require 'term/ansicolor'
+# -*- encoding : utf-8 -*-
+require 'thor'
 
 module Pacto
   module UI
-    extend Term::ANSIColor
+    # Colors for HTTP Methods, intended to match colors of Swagger-UI (as close as possible with ANSI Colors)
+    METHOD_COLORS = {
+      'POST' => :green,
+      'PUT'  => :yellow,
+      'DELETE' => :red,
+      'GET' => :blue,
+      'PATCH' => :yellow,
+      'HEAD' => :green
+    }
+
+    def self.shell
+      @shell ||= Thor::Shell::Color.new
+    end
+
+    def self.deprecation(msg)
+      $stderr.puts colorize(msg, :yellow) unless Pacto.configuration.hide_deprecations
+    end
+
+    def self.colorize(msg, color)
+      return msg unless Pacto.configuration.color
+
+      shell.set_color(msg, color)
+    end
+
+    def self.colorize_method(method)
+      method_string = method.to_s.upcase
+
+      color = METHOD_COLORS[method_string] || :red # red for unknown methods
+      colorize(method_string, color)
+    end
   end
 end

data/lib/pacto/uri.rb

@@ -1,8 +1,9 @@
+# -*- encoding : utf-8 -*-
 module Pacto
   class URI
     def self.for(host, path, params = {})
       Addressable::URI.heuristic_parse("#{host}#{path}").tap do |uri|
-        uri.query_values = params unless params.empty?
+        uri.query_values = params unless params.nil? || params.empty?
       end
     end
   end

data/lib/pacto/version.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Pacto
-  VERSION = '0.3.1'
+  VERSION = '0.4.0.rc1'
 end

data/pacto-server.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pacto/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'pacto-server'
+  gem.version       = Pacto::VERSION
+  gem.authors       = ['ThoughtWorks']
+  gem.email         = ['pacto-gem@googlegroups.com']
+  gem.description   = "Pacto Server let's you run Pacto as a standalone server to arbitrate contract disputes between a service provider and one or more consumers in any programming language. It's Pacto beyond Ruby"
+  gem.summary       = 'Polyglot Integration Contract Testing server'
+  gem.homepage      = 'http://thoughtworks.github.io/pacto/'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files -- bin/pacto-server lib/pacto/server`.split($/) # rubocop:disable SpecialGlobalVars
+  gem.executables   = gem.files.grep(/^bin\//).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'pacto', Pacto::VERSION
+  gem.add_dependency 'goliath', '~> 1.0'
+  gem.add_dependency 'em-synchrony', '~> 1.0'
+  gem.add_dependency 'em-http-request', '~> 1.1'
+end

data/pacto.gemspec

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'pacto/version'
@@ -12,8 +11,8 @@ Gem::Specification.new do |gem|
   gem.version       = Pacto::VERSION
   gem.authors       = ['ThoughtWorks & Abril']
   gem.email         = ['pacto-gem@googlegroups.com']
-  gem.description   = %q{Pacto is a judge that arbitrates contract disputes between a service provider and one or more consumers. In other words, it is a framework for Integration Contract Testing, and helps guide service evolution patterns like Consumer-Driven Contracts or Documentation-Driven Contracts.}
-  gem.summary       = %q{Integration Contract Testing framework}
+  gem.description   = 'Pacto is a judge that arbitrates contract disputes between a service provider and one or more consumers. In other words, it is a framework for Integration Contract Testing, and helps guide service evolution patterns like Consumer-Driven Contracts or Documentation-Driven Contracts.'
+  gem.summary       = 'Integration Contract Testing framework'
   gem.homepage      = 'http://thoughtworks.github.io/pacto/'
   gem.license       = 'MIT'
 
@@ -22,27 +21,32 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'webmock', '~> 1.17'
+  gem.add_dependency 'webmock', '~> 1.18', '< 1.20.3'
+  gem.add_dependency 'swagger-core', '~> 0.2', '>= 0.2.1'
   gem.add_dependency 'middleware', '~> 0.1'
   gem.add_dependency 'multi_json', '~> 1.8'
   gem.add_dependency 'json-schema', '~> 2.0'
   gem.add_dependency 'json-generator', '~> 0.0', '>= 0.0.5'
-  gem.add_dependency 'hash-deep-merge', '~> 0.1'
+  gem.add_dependency 'hashie', '~> 3.0'
   gem.add_dependency 'faraday', '~> 0.9'
   gem.add_dependency 'addressable', '~> 2.3'
   gem.add_dependency 'json-schema-generator', '~> 0.0', '>= 0.0.7'
-  gem.add_dependency 'term-ansicolor', '~> 1.3'
+  gem.add_dependency 'thor', '~> 0.19'
 
+  gem.add_development_dependency 'polytrix', '~> 0.1', '>= 0.1.4'
   gem.add_development_dependency 'coveralls', '~> 0'
+  gem.add_development_dependency 'fabrication', '~> 2.11'
   gem.add_development_dependency 'rake', '~> 10.0'
   gem.add_development_dependency 'rake-notes', '~> 0'
-  gem.add_development_dependency 'rspec', '~> 2.14'
-  gem.add_development_dependency 'should_not', '~> 1.0'
+  gem.add_development_dependency 'rspec', '~> 3.0'
   gem.add_development_dependency 'aruba', '~> 0'
+  gem.add_development_dependency 'json_spec', '~> 1.0'
   # Only required to push documentation, and not easily installed on Windows
   # gem.add_development_dependency 'relish'
   gem.add_development_dependency 'guard-rspec', '~> 4.2'
-  gem.add_development_dependency 'rubocop', '~> 0.16'
+  # FIXME: Rubocop upgrade needed... rubocop -a will do most of the work
+  gem.add_development_dependency 'rubocop', '~> 0.23', '< 0.27.0'
+  gem.add_development_dependency 'rubocop-rspec', '~> 1.0.rc3'
   gem.add_development_dependency 'guard-rubocop', '~> 1.0'
   gem.add_development_dependency 'guard-cucumber', '~> 1.4'
   gem.add_development_dependency 'rb-fsevent', '~> 0' if RUBY_PLATFORM =~ /darwin/i