pacto 0.2.5 → 0.3.0.pre

data/.gitignore

@@ -18,3 +18,6 @@ tmp
 *.swp
 *.swo
 .idea/
+.floo*
+.sublime*
+

data/.rspec

@@ -1,4 +1,2 @@
 --colour
 --require spec_helper
---require integration/spec_helper
---require unit/spec_helper

data/.rubocop-todo.yml

@@ -0,0 +1,51 @@
+# This configuration was generated by `rubocop --auto-gen-config`.
+# The point is for the user to remove these configuration records
+# one by one as the offences are removed from the code base.
+
+Blocks:
+  Enabled: false
+
+CollectionMethods:
+  Enabled: false
+
+ColonMethodCall:
+  Enabled: false
+
+DefWithoutParentheses:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+HashSyntax:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+
+MethodAndVariableSnakeCase:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+SymbolName:
+  Enabled: false
+
+Void:
+  Enabled: false
+
+WordArray:
+  Enabled: false

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop-todo.yml

data/.travis.yml

@@ -3,5 +3,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - jruby
-env:
-  - CI=true
+  - 1.8.7
+matrix:
+  allow_failures:
+      - rvm: 1.8.7

data/Guardfile

@@ -1,16 +1,30 @@
-guard :rspec do
-  # Unit tests
-  watch(%r{^spec/unit/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})            { |m| "spec/unit/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')         { "spec/unit" }
-  watch('spec/unit/spec_helper.rb')    { "spec/unit" }
-  watch(%r{^spec/unit/data/.+\.json$}) { "spec/unit" }
+guard :rubocop, all_on_start: false do
+  watch(%r{.+\.rb$})
+  watch('.rubocop.yml')      { '.' }
+  watch('.rubocop-todo.yml') { '.' }
+end
+
+group :tests, halt_on_fail: true do
+  guard :rspec do
+    # Unit tests
+    watch(%r{^spec/unit/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$})            { |m| "spec/unit/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')         { "spec/unit" }
+    watch('spec/unit/spec_helper.rb')    { "spec/unit" }
+    watch(%r{^spec/unit/data/.+\.json$}) { "spec/unit" }
+
+    # Integration tests
+    watch(%r{^spec/integration/.+_spec\.rb$})
+    watch(%r{^spec/integration/utils/.+\.rb$})  { "spec/integration" }
+    watch(%r{^lib/.+.rb$})                      { "spec/integration" }
+    watch('spec/spec_helper.rb')                { "spec/integration" }
+    watch('spec/integration/spec_helper.rb')    { "spec/integration" }
+    watch(%r{^spec/integration/data/.+\.json$}) { "spec/integration" }
+  end
 
-  # Integration tests
-  watch(%r{^spec/integration/.+_spec\.rb$})
-  watch(%r{^spec/integration/utils/.+\.rb$})  { "spec/integration" }
-  watch(%r{^lib/.+.rb$})                      { "spec/integration" }
-  watch('spec/spec_helper.rb')                { "spec/integration" }
-  watch('spec/integration/spec_helper.rb')    { "spec/integration" }
-  watch(%r{^spec/integration/data/.+\.json$}) { "spec/integration" }
+  guard :cucumber, all_on_start: false do
+    watch(%r{^features/.+\.feature$})
+    watch(%r{^features/support/.+$})          { 'features' }
+    watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  end
 end

data/README.md

@@ -1,3 +1,8 @@
+[![Build Status](https://travis-ci.org/thoughtworks/pacto.png)](https://travis-ci.org/thoughtworks/pacto)
+[![Code Climate](https://codeclimate.com/github/thoughtworks/pacto.png)](https://codeclimate.com/github/thoughtworks/pacto)
+[![Dependency Status](https://gemnasium.com/thoughtworks/pacto.png)](https://gemnasium.com/thoughtworks/pacto)
+[![Coverage Status](https://coveralls.io/repos/thoughtworks/pacto/badge.png)](https://coveralls.io/r/thoughtworks/pacto)
+
 # Pacto
 
 Pacto is a Ruby implementation of the [Consumer-Driven Contracts](http://martinfowler.com/articles/consumerDrivenContracts.html)
@@ -32,32 +37,34 @@ A response has the following attributes:
 Pacto relies on a simple, JSON based language for defining contracts. Below is an example contract for a GET request
 to the /hello_world endpoint of a provider:
 
-    {
-      "request": {
-        "method": "GET",
-        "path": "/hello_world",
-        "headers": {
-          "Accept": "application/json"
-        },
-        "params": {}
-      },
-
-      "response": {
-        "status": 200,
-        "headers": {
-          "Content-Type": "application/json"
-        },
-        "body": {
-          "description": "A simple response",
-          "type": "object",
-          "properties": {
-            "message": {
-              "type": "string"
-            }
-          }
+```json
+{
+  "request": {
+    "method": "GET",
+    "path": "/hello_world",
+    "headers": {
+      "Accept": "application/json"
+    },
+    "params": {}
+  },
+
+  "response": {
+    "status": 200,
+    "headers": {
+      "Content-Type": "application/json"
+    },
+    "body": {
+      "description": "A simple response",
+      "type": "object",
+      "properties": {
+        "message": {
+          "type": "string"
         }
       }
     }
+  }
+}
+```
 
 The host address is intentionally left out of the request specification so that we can validate a contract against any provider.
 It also reinforces the fact that a contract defines the expectation of a consumer, and not the implementation of any specific provider.
@@ -68,13 +75,23 @@ There are two ways to validate a contract against a provider: through a Rake tas
 
 ### Rake Task
 
-Pacto includes a default Rake task. To use it, include it in your Rakefile:
+Pacto includes two Rake tasks.  In order to use them, include this in your Rakefile:
+
+```ruby
+require 'pacto/rake_task'
+```
 
-    require 'pacto/rake_task'
+Pacto can validate the contract files:
 
-Validating a contract against a provider is as simple as running:
+```sh
+$ rake pacto:meta_validate[dir]  # Validates a directory of contract definitions
+```
 
-    $ rake pacto:validate[host,dir] # Validates all contracts in a given directory against a given host
+Or it can validate contracts against a provider:
+
+```sh
+$ rake pacto:validate[host,dir] # Validates all contracts in a given directory against a given host
+```
 
 It is recommended that you also include [colorize](https://github.com/fazibear/colorize) to get prettier, colorful output.
 
@@ -82,11 +99,27 @@ It is recommended that you also include [colorize](https://github.com/fazibear/c
 
 The easiest way to load a contract from a file and validate it against a host is by using the builder interface:
 
-    require 'pacto'
+```ruby
+require 'pacto'
+
+WebMock.allow_net_connect!
+contract = Pacto.build_from_file('/path/to/contract.json', 'http://dummyprovider.com')
+contract.validate
+```
+
+If you don't want to depend on Pacto to do the request you can also validate a response from a real request:
 
-    WebMock.allow_net_connect!
-    contract = Pacto.build_from_file('/path/to/contract.json', 'http://dummyprovider.com')
-    contract.validate
+```ruby
+require 'pacto'
+
+WebMock.allow_net_connect!
+contract = Pacto.build_from_file('/path/to/contract.json', 'http://dummyprovider.com')
+# Doing the request with ruby stdlib, you can use your favourite lib to do the request
+response = Net::HTTP.get_response(URI.parse('http://dummyprovider.com')).body
+contract.validate response, body_only: true
+```
+
+Pacto also has the ability to match a request signature to a contract that is currently in used, via ```Pacto.contract_for request_signature```
 
 ## Auto-Generated Stubs
 
@@ -95,31 +128,28 @@ to generate a valid JSON document as the response body, and relies on [WebMock](
 to stub any HTTP requests made by your application. Important: the JSON generator is in very early stages and does not work
 with the entire JSON Schema specification.
 
-First, register the contracts that are going to be used in the acceptance tests suite:
-
-    require 'pacto'
-
-    contract = Pacto.build_from_file('/path/to/contract.json', 'http://dummyprovider.com')
-    Pacto.register('my_contract', contract)
-
+First, register the contracts that are going to be used in the acceptance tests suite.  The register_contract method accepts zero or more tags:
+```ruby
+require 'pacto'
+
+contract1 = Pacto.build_from_file('/path/to/contract1.json', 'http://dummyprovider.com')
+contract2 = Pacto.build_from_file('/path/to/contract2.json', 'http://dummyprovider.com')
+contract3 = Pacto.build_from_file('/path/to/contract3.json', 'http://dummyprovider.com')
+Pacto.register_contract(contract1)
+Pacto.register_contract(contract2, :public_api)
+Pacto.register_contract(contract3, :public_api, :wip)
+```
 Then, in the setup phase of the test, specify which contracts will be used for that test:
-
-    Pacto.use('my_contract')
-
+```ruby
+Pacto.use('my_tag')
+```
 If default values are not specified in the contract's response body, a default value will be automatically generated. It is possible
 to overwrite those values, however, by passing a second argument:
-
-    Pacto.use('my_contract', :value => 'new value')
-
+```ruby
+Pacto.use('my_tag', :value => 'new value')
+```
 The values are merged using [hash-deep-merge](https://github.com/Offirmo/hash-deep-merge).
 
-## Code status
-
-[![Build Status](https://travis-ci.org/thoughtworks/pacto.png)](https://travis-ci.org/thoughtworks/pacto)
-[![Code Climate](https://codeclimate.com/github/thoughtworks/pacto.png)](https://codeclimate.com/github/thoughtworks/pacto)
-[![Dependency Status](https://gemnasium.com/thoughtworks/pacto.png)](https://gemnasium.com/thoughtworks/pacto)
-[![Coverage Status](https://coveralls.io/repos/thoughtworks/pacto/badge.png)](https://coveralls.io/r/thoughtworks/pacto)
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,16 +1,29 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'pacto/rake_task'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'coveralls/rake/task'
+require 'rubocop/rake_task'
 
-if defined?(RSpec)
-  desc "Run unit tests"
-  task :unit do
-    abort unless system('rspec --option .rspec_unit')
-  end
+Coveralls::RakeTask.new
 
-  desc "Run integration tests"
-  task :integration do
-    abort unless system('rspec --option .rspec_integration')
-  end
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['**/*.rb', 'Rakefile']
+  # abort rake on failure
+  task.fail_on_error = false
+end
+
+Cucumber::Rake::Task.new(:journeys) do |t|
+  t.cucumber_opts = 'features --format pretty'
+end
 
-  task :default => [:unit, :integration]
+RSpec::Core::RakeTask.new(:unit) do |t|
+  t.pattern = 'spec/unit/**/*_spec.rb'
 end
+
+RSpec::Core::RakeTask.new(:integration) do |t|
+  t.pattern = 'spec/integration/**/*_spec.rb'
+end
+
+task :default => [:unit, :integration, :journeys, :rubocop, 'coveralls:push']

data/features/generation/generation.feature

@@ -0,0 +1,25 @@
+@needs_server
+Feature: Contract Generation
+  Scenario: Generating a contract from a partial contract
+    Given a directory named "contracts"
+    Given a file named "requests/my_contract.json" with:
+    """
+        {
+        "request": {
+          "method": "GET",
+          "path": "/hello",
+          "headers": {
+            "Accept": "application/json"
+          },
+          "params": {}
+        },
+        "response": {
+          "status": 200,
+          "body": {
+            "required": true
+          }
+        }
+      }
+    """
+    When I successfully run `bundle exec rake --trace pacto:generate['tmp/aruba/requests','tmp/aruba/contracts','http://localhost:8000']`
+    Then the output should contain "Successfully generated all contracts"

data/features/journeys/validation.feature

@@ -0,0 +1,74 @@
+Feature: Validation journey
+  Scenario: Meta-validation of a valid contract
+    Given a file named "contracts/my_contract.json" with:
+    """
+        {
+        "request": {
+          "method": "GET",    
+          "path": "/hello_world",
+          "headers": {
+            "Accept": "application/json"
+          },
+          "params": {}
+        },
+
+        "response": {
+          "status": 200,
+          "headers": {
+            "Content-Type": "application/json"
+          },
+          "body": {
+            "description": "A simple response",
+            "type": "object",
+            "properties": {
+              "message": {
+                "type": "string"
+              }
+            }
+          }
+        }
+      }
+    """
+    When I successfully run `bundle exec rake pacto:meta_validate['tmp/aruba/contracts/my_contract.json']`
+    Then the output should contain "All contracts successfully meta-validated"
+
+
+  Scenario: Meta-validation of an invalid contract
+    Given a file named "contracts/my_contract.json" with:
+    """
+    {"request": "yes"}
+    """
+    When I run `bundle exec rake pacto:meta_validate['tmp/aruba/contracts/my_contract.json']`
+    Then the exit status should be 1
+    And the output should contain "did not match the following type"
+
+
+  Scenario: Meta-validation of a contract with empty request and response
+    Given a file named "contracts/my_contract.json" with:
+    """
+    {"request": {}, "response": {}}
+    """
+    When I run `bundle exec rake pacto:meta_validate['tmp/aruba/contracts/my_contract.json']`
+    Then the exit status should be 1
+    And the output should contain "did not contain a required property"
+
+  Scenario: Meta-validation of a contracts response body
+    Given a file named "contracts/my_contract.json" with:
+    """
+        {
+        "request": {
+          "method": "GET",
+          "path": "/hello_world"
+        },
+
+        "response": {
+          "status": 200,
+          "body": {
+            "required": "anystring"
+            }
+          }
+        }
+    """
+    When I run `bundle exec rake pacto:meta_validate['tmp/aruba/contracts/my_contract.json']`
+    Then the exit status should be 1
+    And the output should contain "did not match the following type"

data/features/support/env.rb

@@ -0,0 +1,16 @@
+require_relative '../../spec/coveralls_helper'
+require 'rake'
+require 'aruba'
+require 'aruba/cucumber'
+require 'aruba/in_process'
+require 'aruba/jruby' if RUBY_PLATFORM == 'java'
+require 'pacto/server'
+
+Before do
+  @aruba_timeout_seconds = RUBY_PLATFORM == 'java' ? 60 : 10
+end
+
+Before('@needs_server') do
+  @server = Pacto::Server::Dummy.new 8000, '/hello', '{"message": "Hello World!"}'
+  @server.start
+end