pacto 0.3.1 → 0.4.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18ae0d545ae833247f073b842eb80cae0bfe15bd
-  data.tar.gz: 7bbc42514d8b1efecaa5dd650d042f4135ead5da
+  metadata.gz: c6cc06d1907fec1501c7069081e958eaac9068d7
+  data.tar.gz: 4b6dcac0163d858ed9e085c345a3b956b9ad8621
 SHA512:
-  metadata.gz: b3518a69c9f3d65f241f23ed2879349b6016f9411c2991e2bbed85a63ad0091959aedb5d829f7111f14c47a4596a158bf5b3294e8e8c8a951c45f63629cd374a
-  data.tar.gz: 22d00ac297683e0233c7d002891f5a5f26e133dbc8f7590a3431b567b48200ddd5c0fc02750f9eb17dcd077480a8fe15a9846c8d885f84c51595c1c3cc290fbb
+  metadata.gz: e980441e1894a466b5818e099f49523cb0d61b5bc414389186ba57bfb143caf4ee59086aa480c8e9d7c78b3f53ceb4a43c2e91ca55cbf76c04a4b696e459659c
+  data.tar.gz: 3611106a78d817d26c98ac7769ac88766f9d0db0f793016066b87e255194466e51340bde66e3509f779e25d92b01e3f9b6d2d2d3b793775ada0f232297438529

data/.gitignore

@@ -1,4 +1,6 @@
 *.gem
+*.log
+*.pid
 *.rbc
 .bundle
 .config
@@ -22,3 +24,4 @@ tmp
 .sublime*
 tags
 pacto.log
+.polytrix/

data/.rubocop.yml

@@ -1,10 +1,32 @@
-inherit_from: .rubocop-todo.yml
+require: rubocop-rspec
+
+Documentation:
+  Enabled: false
+
+DotPosition:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+
+MethodLength:
+  Max: 15
+
+Style/Encoding:
+  EnforcedStyle: when_needed
 
 AllCops:
-  Includes:
+  Include:
     - Guardfile
-    - Rakefile
-    - pacto.gemspec
-  Excludes:
-    - bin/**
-    - tmp/**
+    - '**/Rakefile'
+    - pacto*.gemspec
+  Exclude:
+    - bin/**/*
+    - tmp/**/*
+RSpec/DescribeClass:
+  Exclude:
+    - samples/**/*
+    - spec/integration/**/*
+RSpec/MultipleDescribes:
+  Exclude:
+    - samples/**/*

data/.travis.yml

@@ -1,8 +1,15 @@
 language: ruby
-before_install: gem update --remote bundler
 rvm:
   - 2.1.0
   - 2.0.0
   - 1.9.3
+  # There is a bug in jruby-1.7.15
+  # that is blocking testing
   - jruby
+before_script:
+  - gem install foreman
+  - foreman start &
+matrix:
+  allow_failures:
+    - rvm: jruby
 

data/CONTRIBUTING.md

@@ -63,10 +63,7 @@ the analyzer just run:
 
 Pacto unit tests and integration test are written in RSpec and the user journey
 tests are written in Cucumber. For the RSpec tests we suggest to follow the
-[Better Specs](http://betterspecs.org/) guideline. For Cucumber test keep in
-mind that those will be published on
-[Relish](https://www.relishapp.com/maxlinc/pacto/docs), so try to make them
-Relish friendly ;).
+[Better Specs](http://betterspecs.org/) guideline.
 
 ## <a name="run-tests"></a>Running tests
 
@@ -75,7 +72,7 @@ tasks:
 
 - Unit tests (`bundle exec rake unit`).
 - Integration tests (`bundle exec rake integration`).
-- User journey tests (`bundle exec rake journey`).
+- User journey tests (`bundle exec rake journeys`).
 
 It is also possible run specific tests:
 
@@ -110,7 +107,7 @@ details what Pacto is doing behind the scenes.
 ### Gemfile.lock
 
 Because Pacto is a gem we don't include the Gemfile.lock into the repository
-([here is the reason])(http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/).
+([here is the reason](http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/)).
 This could lead to some problems in your daily job as contributor specially
 when there is an upgrade in any of the gems that Pacto depends upon. That is
 why we recomend you to remove the Gemfile.lock and generate it

data/Gemfile

@@ -1,14 +1,25 @@
 source 'https://rubygems.org'
+PACTO_HOME = File.expand_path '..', __FILE__
 
 # Specify your gem's dependencies in pacto.gemspec
 gemspec :name => 'pacto'
 
-Dir['pacto-*.gemspec'].each do |gemspec|
+Dir["#{PACTO_HOME}/pacto-*.gemspec"].each do |gemspec|
   plugin = gemspec.scan(/pacto-(.*)\.gemspec/).flatten.first
-  gemspec(:name => "pacto-#{plugin}", :development_group => plugin)
+  gemspec(:name => "pacto-#{plugin}", :path => PACTO_HOME, :development_group => plugin)
 end
 
 # This is only used by Relish tests.  Putting it here let's travis
 # pre-install so we can speed up the test with `bundle install --local`,
 # avoiding Aruba timeouts.
 gem 'excon'
+gem 'octokit'
+
+group :samples do
+  gem 'grape'
+  gem 'grape-swagger'
+  gem 'puma'
+  gem 'rake'
+  gem 'pry'
+  gem 'rack'
+end

data/Guardfile

@@ -10,10 +10,10 @@ guard :rubocop, all_on_start: false do
 end
 
 group :tests, halt_on_fail: true do
-  guard :rspec do
+  guard :rspec, cmd: 'bundle exec rspec' do
     # Unit tests
     watch(%r{^spec/unit/.+_spec\.rb$})
-    watch(/^lib\/(.+)\.rb$/)             { |m| 'spec/unit/#{m[1]}_spec.rb' }
+    watch(/^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' }
@@ -27,9 +27,9 @@ group :tests, halt_on_fail: true do
     watch(%r{^spec/integration/data/.+\.json$}) { 'spec/integration' }
   end
 
-  guard :cucumber, all_on_start: false do
+  guard :cucumber, cmd: 'bundle exec cucumber', all_on_start: false do
     watch(/^features\/.+\.feature$/)
     watch(%r{^features/support/.+$})                      { 'features' }
-    watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join('**/#{m[1]}.feature')][0] || 'features' }
+    watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |_m| Dir[File.join('**/#{m[1]}.feature')][0] || 'features' }
   end
 end

data/Procfile

@@ -0,0 +1 @@
+sample_apis: sh -c 'bundle exec rackup -s puma -o localhost -p $PORT sample_apis/config.ru'

data/README.md

@@ -48,9 +48,11 @@ Pacto can provide a [**contract writer**](#generating) that tries to strike a ba
 
 Pacto can perform three activities: generating, validating, or stubbing services.  You can do each of these activities against either live or stubbed services.
 
+You can also use [Pacto Server](#pacto-server-non-ruby-usage) if you are working with non-Ruby projects.
+
 ### Configuration
 
-In order to start with Pacto, you just need to require it and optionally customize the default [Configuration](https://www.relishapp.com/maxlinc/pacto/docs/configuration).  For example:
+In order to start with Pacto, you just need to require it and optionally customize the default [Configuration](docs/configuration.md).  For example:
 
 ```ruby
 require 'pacto'
@@ -75,7 +77,7 @@ We know we cannot generate perfect Contracts, especially if we only have one sam
 
 ### Contract Lists
 
-In order to stub or validate or stub a group of contracts you need to create a ContractList.
+In order to stub or validate a group of contracts you need to create a ContractList.
 A ContractList represent a collection of endpoints attached to the same host.
 
 ```ruby
@@ -92,7 +94,7 @@ Once you have a ContractList, you can validate all the contracts against the liv
 
 ```ruby
 contracts = Pacto.load_contracts('contracts/services', 'http://example.com')
-contracts.validate_all
+contracts.simulate_consumers
 ```
 
 This method will hit the real endpoint, with a request created based on the request part of the contract.  
@@ -108,36 +110,68 @@ To generate stubs based on a ContractList you can run:
 
 ```ruby
 contracts = Pacto.load_contracts('contracts/services', 'http://example.com')
-contracts.stub_all
+contracts.stub_providers
 ```
 
 This method uses webmock to ensure that whenever you make a request against one of contracts you actually get a stubbed response,
 based on the default values specified on the contract, instead of hitting the real provider. 
 
-You can override any default value on the contracts by providing a hash of optional values to the stub_all method. This
+You can override any default value on the contracts by providing a hash of optional values to the stub_providers method. This
 will override the keys for every contract in the list
 
 ```ruby
 contracts = Pacto.load_contracts('contracts/services', 'http://example.com')
-contracts.stub_all(request_id: 14, name: "Marcos")
+contracts.stub_providers(request_id: 14, name: "Marcos")
 ```
 
 ## Pacto Server (non-Ruby usage)
 
 **See also: http://thoughtworks.github.io/pacto/patterns/polyglot/**
 
-It is really easy to embed Pacto inside a small server.  We haven't bundled a server inside of Pacto, but check out [pacto-demo](https://github.com/thoughtworks/pacto-demo) to see how easily you can expose Pacto via server.
+We've bundled a small server that embeds pacto so you can use it for non-Ruby projects.  If you want to take advantage of the full features, you'll still need to use Ruby (usually rspec) to drive your API testing.  You can run just the server in order to stub or to write validation issues to a log, but you won't have access to the full API fail your tests if there were validation problems.
+
+### Command-line
+
+The command-line version of the server will show you all the options.  These same options are used when you launch the server from within rspec.  In order to see the options:
+`bundle exec pacto-server --help`
 
-That demo lets you easily run a server in several modes:
+Some examples:
 ```sh
-$ bundle exec ruby pacto_server.rb -sv --generate
+$ bundle exec pacto-server -sv --generate
 # Runs a server that will generate Contracts for each request received
-$ bundle exec ruby pacto_server.rb -sv --validate
+$ bundle exec pacto-server -sv --stub --validate
 # Runs the server that provides stubs and checks them against Contracts
-$ bundle exec ruby pacto_server.rb -sv --validate --host http://example.com
+$ bundle exec pacto-server -sv --live --validate --host
 # Runs the server that acts as a proxy to http://example.com, validating each request/response against a Contract
 ```
 
+### RSpec test helper
+
+You can also launch a server from within an rspec test.  The server does start up an external port and runs asynchronously so it doens't block your main test thread from kicking off your consumer code.  This gives you an externally accessable server that non-Ruby clients can hit, but still gives you the full Pacto API in order to validate and spy on HTTP interactions.
+
+Example usage of the rspec test helper:
+```ruby
+require 'rspec'
+require 'pacto/rspec'
+require 'pacto/test_helper'
+
+describe 'my consumer' do
+  include Pacto::TestHelper
+
+  it 'calls a service' do
+    with_pacto(
+      :port => 5000,
+      :directory => '../spec/integration/data',
+      :stub => true) do |pacto_endpoint|
+      # call your code
+      system "curl #{pacto_endpoint}/echo"
+      # check results
+      expect(Pacto).to have_validated(:get, 'https://localhost/echo')
+    end
+  end
+end
+```
+
 ## Rake Tasks
 
 Pacto includes a few Rake tasks to help with common tasks.  If you want to use these tasks, just add this top your Rakefile:
@@ -153,7 +187,7 @@ rake pacto:meta_validate[dir]                   # Validates a directory of contr
 rake pacto:validate[host,dir]                   # Validates all contracts in a given directory against a given host
 ```
 
-The pacto:generate task will take partially defined Contracts and generate the missing pieces.  See [Generate](https://www.relishapp.com/maxlinc/pacto/docs/generate) for more details.
+The pacto:generate task will take partially defined Contracts and generate the missing pieces.  See [Generate](docs/generation.md) for more details.
 
 The pacto:meta_validate task makes sure that your Contracts are valid.  It only checks the Contracts, not the services that implement them.
 
@@ -216,4 +250,4 @@ to the /hello_world endpoint of a provider:
 
 ## Contributing
 
-Read the CONTRIBUTING.md file.
+Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.

data/Rakefile

@@ -1,15 +1,17 @@
 require 'rspec/core/rake_task'
-require 'pacto/rake_task'
 require 'cucumber'
 require 'cucumber/rake/task'
 require 'coveralls/rake/task'
 require 'rubocop/rake_task'
 require 'rake/notes/rake_task'
-
+require 'rake/packagetask'
+Dir.glob('tasks/*.rake').each { |r| import r }
 Coveralls::RakeTask.new
 
-Rubocop::RakeTask.new(:rubocop) do |task|
-  # abort rake on failure
+require 'pacto/rake_task' # FIXME: This require turns on WebMock
+WebMock.allow_net_connect!
+
+RuboCop::RakeTask.new(:rubocop) do |task|
   task.fail_on_error = true
 end
 
@@ -25,7 +27,23 @@ RSpec::Core::RakeTask.new(:integration) do |t|
   t.pattern = 'spec/integration/**/*_spec.rb'
 end
 
-task :default => [:unit, :integration, :journeys, :rubocop, 'coveralls:push']
+task default: [:unit, :integration, :journeys, :samples, :rubocop, 'coveralls:push']
+
+%w(unit integration journeys samples).each do |taskname|
+  task taskname => 'smoke_test_services'
+end
+
+desc 'Run the samples'
+task :samples do
+  FileUtils.rm_rf('samples/tmp')
+  sh 'bundle exec polytrix exec --solo=samples --solo-glob="*.{rb,sh}"'
+  sh 'bundle exec polytrix generate code2doc --solo=samples --solo-glob="*.{rb,sh}"'
+end
+
+desc 'Build the documentation from the samples'
+task :documentation do
+  sh "docco -t #{Dir.pwd}/docco_embeddable_layout/docco.jst samples/*"
+end
 
 desc 'Build gems into the pkg directory'
 task :build do
@@ -37,28 +55,57 @@ task :build do
   FileUtils.mv(Dir['*.gem'], 'pkg')
 end
 
-desc 'Tags version, pushes to remote, and pushes gems'
-task :release => :build do
-  sh 'git', 'tag', '-m', changelog, "v#{Pacto::VERSION}"
-  sh 'git push origin master'
-  sh "git push origin v#{Pacto::VERSION}"
-  sh 'ls pkg/*.gem | xargs -n 1 gem push'
-end
-
-task :changelog do
-  changelog
+Rake::PackageTask.new('pacto_docs', Pacto::VERSION) do |p|
+  p.need_zip = true
+  p.need_tar = true
+  p.package_files.include('docs/**/*')
 end
 
 def changelog
   changelog = File.read('CHANGELOG').split("\n\n\n", 2).first
-  confirm "Does the CHANGELOG look correct? ", changelog
+  confirm 'Does the CHANGELOG look correct? ', changelog
 end
 
 def confirm(question, data)
-  puts "Please confirm..."
+  puts 'Please confirm...'
   puts data
   print question
-  abort "Aborted" unless $stdin.gets.strip == 'y'
-  puts "Confirmed"
+  abort 'Aborted' unless $stdin.gets.strip == 'y'
+  puts 'Confirmed'
   data
 end
+
+desc 'Make sure the sample services are running'
+task :smoke_test_services do
+  require 'faraday'
+  begin
+    retryable(tries: 5, sleep: 1) do
+      Faraday.get('http://localhost:5000/api/ping')
+    end
+  rescue
+    abort 'Could not connect to the demo services, please start them with `foreman start`'
+  end
+end
+
+# Retries a given block a specified number of times in the
+# event the specified exception is raised. If the retries
+# run out, the final exception is raised.
+#
+# This code is slightly adapted from https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/util/retryable.rb,
+# which is in turn adapted slightly from the following blog post:
+# http://blog.codefront.net/2008/01/14/retrying-code-blocks-in-ruby-on-exceptions-whatever/
+def retryable(opts = nil)
+  opts   = { tries: 1, on: Exception }.merge(opts || {})
+
+  begin
+    return yield
+  rescue *opts[:on] => e
+    if (opts[:tries] -= 1) > 0
+      $stderr.puts("Retryable exception raised: #{e.inspect}")
+
+      sleep opts[:sleep].to_f if opts[:sleep]
+      retry
+    end
+    raise
+  end
+end

data/TODO.md

@@ -1,19 +1,42 @@
 # TODO
 
+# v0.4
+
+## Thor
+- Kill rake tasks, replace w/ pacto binary
+- Split Pacto server to separate repo??
+
+## Swagger converter
+- Legacy contracts -> Swagger
+
+## Swagger concepts not yet supported by Pacto
+- Support schemes (multiple)
+- Support multiple report types
+- Validate parameters
+- Support Swagger formats/serializations
+- Support Swagger examples, or extension for examples
+
+## Documentation
+
+- Polytrix samples -> docs
+
+# v0.5
+
+## Swagger
+- Support multiple media types (not just JSON)
+- Extension: templates for more advanced stubbing
+- Patterns: detect creation, auto-delete
+- Configure multiple producers: pacto server w/ multiple ports
+
+# v0.6
+
 ## Nice to have
 
-- Cucumber Tests as docs (see https://relishapp.com/cucumber/cucumber/docs/);
-- Fake Server (sinatra app generating fake responses based on the contracts);
-- Optional "require" format for JSON Schema: # 'required': ['id', 'categorias', 'titulo', ...];
-- Contract variables for easy writing. Such as: 'path': '/member/{id}';
-- Add JSHint rake task to validate contracts syntax;
+
+# Someday
+
 - Pretty output for hash difference (using something like [hashdiff](https://github.com/liufengyun/hashdiff)).
 - A default header in the response marking the response as "mocked"
-- Parameter matcher should use an idea of "subset" instead of matching all the parameters
-- 'default' value to be used when it is present with an array of types
-- Support 'null' attribute type
-- Validate contract structure in a rake task. Then assume all contracts are valid.
-- When a request is not OK (200), the body may not be a json. Add support to ignore the body.
 
 ## Assumptions