pacto 0.3.1 → 0.4.0.rc1

data/samples/scripts/bootstrap

@@ -0,0 +1,2 @@
+#!/bin/bash
+bundle install

data/samples/scripts/wrapper

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# Polytrix should probably support different wrappers for different langauges
+extension="${1##*.}"
+if [ $extension = "rb" ];
+then
+  bundle exec ruby "$@"
+elif [ $extension = "sh" ];
+then
+  bash "$@"
+fi

data/samples/server.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+require 'pacto/rspec'
+require 'pacto/test_helper'
+
+describe 'ping service' do
+  include Pacto::TestHelper
+
+  it 'pongs' do
+    with_pacto(
+      port: 6000,
+      backend_host: 'http://localhost:5000',
+      live: true,
+      stub: false,
+      generate: false,
+      directory: 'contracts'
+      ) do |pacto_endpoint|
+      # call your code
+      system "curl #{pacto_endpoint}/api/ping"
+    end
+
+    # check citations
+    expect(Pacto).to have_validated(:get, 'http://localhost:5000/api/ping')
+  end
+end

data/samples/server_cli.sh

@@ -0,0 +1,12 @@
+# # Standalone server
+
+# You can run Pacto as a server in order to test non-Ruby projects. In order to get the full set
+# of options, run:
+bundle exec pacto-server -h
+
+# You probably want to run with the -sv option, which will display verbose output to stdout. You can
+# run server that proxies to a live endpoint:
+bundle exec pacto-server -sv --port 9000 --live http://example.com &
+bundle exec pacto-server -sv --port 9001 --stub &
+
+pkill -f pacto-server

data/samples/stenographer.rb

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+require 'pacto'
+Pacto.configure do |c|
+  c.contracts_path = 'contracts'
+end
+contracts = Pacto.load_contracts('contracts', 'http://localhost:5000')
+contracts.stub_providers
+
+Pacto.simulate_consumer do
+  request 'Echo', values: nil, response: { status: 200 } # 0 contract violations
+  request 'Ping', values: nil, response: { status: 200 } # 0 contract violations
+  request 'Unknown (http://localhost:8000/404)', values: nil, response: { status: 500 } # 0 contract violations
+end
+
+Pacto.simulate_consumer :my_consumer do
+  playback 'pacto_stenographer.log'
+end

data/spec/coveralls_helper.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 unless ENV['NO_COVERAGE']
   require 'simplecov'
   require 'coveralls'

data/spec/fabricators/contract_fabricator.rb

@@ -0,0 +1,94 @@
+# -*- encoding : utf-8 -*-
+require 'pacto'
+require 'hashie/mash'
+
+# Fabricators for contracts or parts of contracts
+
+Fabricator(:contract, from: Pacto::Contract) do
+  initialize_with { @_klass.new to_hash } # Hash based initialization
+  transient example_count: 0
+  name { 'Dummy Contract' }
+  file { 'file:///does/not/exist/dummy_contract.json' }
+  request { Fabricate(:request_clause).to_hash }
+  response { Fabricate(:response_clause).to_hash }
+  examples do |attr|
+    example_count = attr[:example_count]
+    if example_count
+      examples = attr[:example_count].times.each_with_object({}) do |i, h|
+        name = i.to_s
+        h[name] = Fabricate(:an_example, name: name)
+      end
+      examples
+    else
+      nil
+    end
+  end
+end
+
+Fabricator(:partial_contract, from: Pacto::Contract) do
+  initialize_with { @_klass.new to_hash } # Hash based initialization
+  name { 'Dummy Contract' }
+  file { 'file:///does/not/exist/dummy_contract.json' }
+  request { Fabricate(:request_clause).to_hash }
+end
+
+Fabricator(:request_clause, from: Pacto::RequestClause) do
+  initialize_with { @_klass.new to_hash } # Hash based initialization
+  host { 'example.com' }
+  http_method { 'GET' }
+  path { '/abcd' }
+  headers do
+    {
+      'Server' => ['example.com'],
+      'Connection' => ['Close'],
+      'Content-Length' => [1234],
+      'Via' => ['Some Proxy'],
+      'User-Agent' => ['rspec']
+    }
+  end
+  params {}
+end
+
+Fabricator(:response_clause, from: Pacto::ResponseClause) do
+  initialize_with { @_klass.new to_hash } # Hash based initialization
+  status { 200 }
+  headers do
+    {
+      'Content-Type' => 'application/json'
+    }
+  end
+  schema { Fabricate(:schema).to_hash }
+end
+
+Fabricator(:schema, from: Hashie::Mash) do
+  transient :version
+  initialize_with { @_klass.new to_hash } # Hash based initialization
+  type { 'object' }
+  required do |attrs|
+    attrs[:version] == :draft3 ? true : []
+  end
+  properties do
+    {
+      type: 'string'
+    }
+  end
+end
+
+Fabricator(:an_example, from: Hashie::Mash) do
+  initialize_with { @_klass.new to_hash } # Hash based initialization
+  transient name: 'default'
+  request do |attr|
+    {
+      body: {
+        message: "I am example request #{attr[:name]}"
+      }
+    }
+  end
+  response do |attr|
+    {
+      body: {
+        message: "I am example response #{attr[:name]}"
+      }
+    }
+  end
+end

data/spec/fabricators/http_fabricator.rb

@@ -0,0 +1,48 @@
+# -*- encoding : utf-8 -*-
+require 'pacto'
+require 'hashie/mash'
+
+# Fabricators for Pacto objects representing HTTP transactions
+
+Fabricator(:pacto_request, from: Pacto::PactoRequest) do
+  initialize_with { @_klass.new @_transient_attributes } # Hash based initialization
+  # These transient attributes turn into the URI
+  transient host: 'example.com'
+  transient path: '/abcd'
+  transient params: {}
+  method { :get }
+  uri do |attr|
+    Addressable::URI.heuristic_parse(attr[:host]).tap do |uri|
+      uri.path = attr[:path]
+      uri.query_values = attr[:params]
+    end
+  end
+  headers do
+    {
+      'Server' => ['example.com'],
+      'Connection' => ['Close'],
+      'Content-Length' => [1234],
+      'Via' => ['Some Proxy'],
+      'User-Agent' => ['rspec']
+    }
+  end
+  body do |attr|
+    case attr[:method]
+    when :get, :head, :options
+      nil
+    else
+      '{"data": "something"}'
+    end
+  end
+end
+
+Fabricator(:pacto_response, from: Pacto::PactoResponse) do
+  initialize_with { @_klass.new to_hash } # Hash based initialization
+  status { 200 }
+  headers do
+    {
+      'Content-Type' => 'application/json'
+    }
+  end
+  body { '' }
+end

data/spec/fabricators/webmock_fabricator.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+# Fabricators for WebMock objects
+
+Fabricator(:webmock_request_signature, from: WebMock::RequestSignature) do
+  initialize_with do
+    uri = _transient_attributes[:uri]
+    method = _transient_attributes[:method]
+    uri = Addressable::URI.heuristic_parse(uri) unless uri.is_a? Addressable::URI
+    WebMock::RequestSignature.new method, uri
+  end
+  transient method: :get
+  transient uri: 'www.example.com'
+end
+
+Fabricator(:webmock_request_pattern, from: Pacto::RequestPattern) do
+  initialize_with do
+    uri = _transient_attributes[:uri]
+    method = _transient_attributes[:method]
+    uri = Addressable::URI.heuristic_parse(uri) unless uri.is_a? Addressable::URI
+    Pacto::RequestPattern.new method, uri
+  end
+  transient method: :get
+  transient uri: 'www.example.com'
+end

data/spec/{unit/data → fixtures/contracts}/contract.json

@@ -1,6 +1,6 @@
 {
   "request": {
-    "method": "GET",
+    "http_method": "GET",
     "path": "/hello_world",
     "headers": {
       "Accept": "application/json"
@@ -13,7 +13,7 @@
     "headers": {
       "Content-Type": "application/json"
     },
-    "body": {
+    "schema": {
       "description": "A simple response",
       "type": "object",
       "properties": {

data/spec/fixtures/contracts/contract_with_examples.json

@@ -0,0 +1,58 @@
+{
+  "request": {
+    "headers": {
+    },
+    "http_method": "get",
+    "path": "/api/echo",
+    "schema": {
+      "type": "object",
+      "required": ["message"],
+      "properties": {
+        "message": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "response": {
+    "headers": {
+      "Content-Type": "application/json"
+    },
+    "status": 200,
+    "schema": {
+      "type": "object",
+      "required": ["message"],
+      "properties": {
+        "message": {
+          "type": "string"
+        }
+      }
+    }
+  },
+  "examples": {
+    "max": {
+      "request": {
+        "body": {
+          "message": "max"
+        }
+      },
+      "response": {
+        "body": {
+          "message": "max"
+        }
+      }
+    },
+    "12345": {
+      "request": {
+        "body": {
+          "message": 12345
+        }
+      },
+      "response": {
+        "body": {
+          "message": 12345
+        }
+      }
+    }
+  }
+}

data/spec/{unit/data → fixtures/contracts}/simple_contract.json

@@ -1,6 +1,7 @@
 {
+  "name": "Simple Contract",
   "request": {
-    "method": "GET",
+    "http_method": "GET",
     "path": "/hello",
     "headers": {
       "Accept": "application/json"
@@ -10,8 +11,9 @@
 
   "response": {
     "status": 200,
-    "headers": { "Content-Type": "application/json" },
-    "body": {
+    "headers": { "Content-Type": "application/json", "Vary": "Accept" },
+    "schema": {
+      "$schema": "http://json-schema.org/draft-03/schema#",
       "type": "object",
       "required": true,
       "properties": {

data/spec/{integration/data → fixtures/contracts}/strict_contract.json

@@ -1,6 +1,7 @@
 {
+  "name": "Strict Contract",
   "request": {
-    "method": "GET",
+    "http_method": "GET",
     "path": "/strict",
     "headers": {
       "Accept": "application/json"
@@ -11,7 +12,8 @@
   "response": {
     "status": 200,
     "headers": { "Content-Type": "application/json" },
-    "body": {
+    "schema": {
+      "$schema": "http://json-schema.org/draft-03/schema#",
       "type": "object",
       "required": true,
       "properties": {
@@ -30,4 +32,4 @@
       }
     }
   }
-}
+}

data/spec/{integration/data → fixtures/contracts}/templating_contract.json

@@ -1,6 +1,6 @@
 {
   "request": {
-    "method": "GET",
+    "http_method": "GET",
     "path": "/echo",
     "headers": {
       "Accept": "application/json",
@@ -14,7 +14,8 @@
   "response": {
     "status": 200,
     "headers": { "Content-Type": "application/json" },
-    "body": {
+    "schema": {
+      "$schema": "http://json-schema.org/draft-03/schema#",
       "type": "object",
       "required": true,
       "properties": {

data/spec/{integration/data/simple_contract.json → fixtures/deprecated_contracts/deprecated_contract.json}

@@ -12,6 +12,7 @@
     "status": 200,
     "headers": { "Content-Type": "application/json", "Vary": "Accept" },
     "body": {
+      "$schema": "http://json-schema.org/draft-03/schema#",
       "type": "object",
       "required": true,
       "properties": {
@@ -19,4 +20,4 @@
       }
     }
   }
-}
+}

data/spec/fixtures/swagger/petstore.yaml

@@ -0,0 +1,101 @@
+swagger: 2.0
+info:
+  version: 1.0.0
+  title: Swagger Petstore
+  license:
+    name: MIT
+host: petstore.swagger.wordnik.com
+basePath: /v1
+schemes:
+  - http
+consumes:
+  - application/json
+produces:
+  - application/json
+paths:
+  /pets:
+    get:
+      summary: List all pets
+      operationId: listPets
+      tags:
+        - pets
+      parameters:
+        - name: limit
+          in: query
+          description: How many items to return at one time (max 100)
+          required: false
+          type: integer
+          format: int32
+      responses:
+        200:
+          description: An paged array of pets
+          headers:
+            - x-next:
+              type: string
+              description: A link to the next page of responses
+          schema:
+            $ref: Pets
+        default:
+          description: unexpected error
+          schema:
+            $ref: Error
+    post:
+      summary: Create a pet
+      operationId: createPets
+      tags:
+        - pets
+      responses:
+        201:
+          description: Null response
+        default:
+          description: unexpected error
+          schema:
+            $ref: Error
+  /pets/{petId}:
+    get:
+      summary: Info for a specific pet
+      operationId: showPetById
+      tags:
+        - pets
+      parameters:
+        - name: petId
+          in: path
+          description: The id of the pet to retrieve
+          type: string
+      responses:
+        200:
+          description: Expected response to a valid request
+          schema:
+            $ref: Pets
+        default:
+          description: unexpected error
+          schema:
+            $ref: Error
+definitions:
+  Pet:
+    required:
+      - id
+      - name
+    properties:
+      id:
+        type: integer
+        format: int64
+      name:
+        type: string
+      tag:
+        type: string
+  Pets:
+    type: array
+    items:
+      $ref: Pet
+  Error:
+    required:
+      - code
+      - message
+    properties:
+      code:
+        type: integer
+        format: int32
+      message:
+        type: string
+