dredd_hooks 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e812ae943d277f3163afe9c084e48aacce110730
-  data.tar.gz: e6b2557296918b237c4a67ead7267ead330cc1bf
+  metadata.gz: 0a973e6c81a178f196919b8b84438a95ba0b7b2d
+  data.tar.gz: 448ecde2a65cedf46e9ae08a6233080be172a9b2
 SHA512:
-  metadata.gz: b99c296c26c164cd209f597563be725b8d9d7795d646c2d8b7e32f47333daf55c428c7fa4fe4083218f9cfd74d68e68b9ec7346966a02c65bcbfcfa2f946041d
-  data.tar.gz: 6c601a534be422f7b24e33df2834580e9d854f74ab0b157d62dd4bf07c8fe796920bf1572f6f461236aac1835354b3d7e01a89f571592f623e21851f9eba4eec
+  metadata.gz: 2c655cdc6b3b4c974ec79588ce426f5f8e13c65371668712d3516aa3ff6d4730d368cd3465defd56740230ba1fbd0b3519922f3562a264b7a7f7a48f003d4546
+  data.tar.gz: c2bd886fad87c7c805687890ee301349a23de809a869f081a17d2dce6fada88efb0076597a933360bef39ca010fa118dfc1af036c73c4a8a2efbeed42e49e2f3

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [0.1.0] - 2016-08-06
+
+### Added
+
+- This change log : )
+- Possibility to use DreddHooks::Server as a library (see DreddHooks::CLI for an example)
+
+### Changed
+
+- Started using the Semantic Versioning convention
+
+### Fixed
+
+- The test suite can be used locally (it is a workaround only)
+
+## 0.0.1 - 2015-07-07
+
+### Added
+
+- Ability to write Dredd hooks in Ruby
+
+## Previously
+
+The original [proof of concept][poc] was written by @netmilk.
+
+
+[0.1.0]: https://github.com/apiaryio/dredd-hooks-ruby/compare/v0.0.1...v0.1.0
+[poc]: https://github.com/gonzalo-bulnes/dredd-rack/issues/7#issue-70936733
+
+## Inspiration
+
+See http://keepachangelog.com and take part of the discussion!
+

data/LICENSE.txt

@@ -1,6 +1,6 @@
-Copyright (c) 2015 Adam Kliment
-
-MIT License
+The MIT License
+Copyright (c) 2015, 2016 Adam Kliment
+Copyright (c) 2016 Gonzalo Bulnes Guilpain
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,31 +1,38 @@
-
-# Ruby Hooks Handler for Dredd API Testing Framework
+Ruby Hooks Handler for Dredd API Testing Framework
+==================================================
 
 [![Build Status](https://travis-ci.org/apiaryio/dredd-hooks-ruby.svg?branch=master)](https://travis-ci.org/apiaryio/dredd-hooks-ruby)
+[![Dependency Status](https://gemnasium.com/badges/github.com/apiaryio/dredd-hooks-ruby.svg)](https://gemnasium.com/github.com/apiaryio/dredd-hooks-ruby)
+[![Code Climate](https://codeclimate.com/github/apiaryio/dredd-hooks-ruby/badges/gpa.svg)](https://codeclimate.com/github/apiaryio/dredd-hooks-ruby)
+[![Inline Docs](http://inch-ci.org/github/apiaryio/dredd-hooks-ruby.svg?branch=master)](http://inch-ci.org/github/apiaryio/dredd-hooks-ruby)
 
-Test your api with [Dredd API testing framework](https://github.com/apiaryio/dredd) and write [hooks](http://dredd.readthedocs.org/en/latest/hooks/) in Ruby to glue together API Blueprint with your Ruby project.
-
-## Installation
+Test your API with the [Dredd HTTP API testing framework](https://github.com/apiaryio/dredd) and write [hooks](http://dredd.readthedocs.org/en/latest/hooks/) in Ruby!
 
-Add this line to your application's Gemfile:
+> **DISCLAIMER**: This is an early version of _dred-hooks-ruby_, please be aware that it will not be stable until **v1.0.0**. At any moment, [feedback][issues] is welcome! : )
 
-```ruby
-gem 'dredd_worker'
-```
+  [issues]: https://github.com/apiaryio/dredd-hooks-ruby/issues
 
-And then execute:
+Installation
+------------
 
-    $ bundle
+Add the gem to your `Gemfile`:
 
-Or install it yourself as:
+```ruby
+# Gemfile
 
-    $ gem install dredd_hooks
+gem 'dredd_hooks', '0.1.0' # see semver.org
+```
 
-## Usage
+Usage
+-----
 
-1. Create a hook file in `hooks.rb`:
+Create a hook file (the file name is arbitrary):
 
 ```ruby
+# ./hooks.rb
+
+require 'dredd_hooks/methods'
+
 include DreddHooks::Methods
 
 before "Machines > Machines collection > Get Machines" do |transaction|
@@ -33,24 +40,91 @@ before "Machines > Machines collection > Get Machines" do |transaction|
 end
 ```
 
-2. Run it with Dredd
+Run it with Dredd:
 
+```bash
+# note that the hooks file was named ./hooks.rb
+dredd apiary.apib localhost:3000 --language ruby --hookfiles ./hooks.rb
 ```
-$ dredd apiary.apib localhost:3000 --language ruby --hookfiles hooks.rb
+
+Documentation
+-------------
+
+### API
+
+The `DreddHooks::Methods` module provides the following methods to be used with [transaction names][doc-names]:
+
+- `before`
+- `after`
+- `before_validation`
+
+And these ones to be used without them:
+
+- `before_all`
+- `after_all`
+- `before_each`
+- `after_each`
+- `before_each_validation`
+
+See also the official [Hooks documentation][doc-hooks].
+
+  [doc-names]: http://dredd.readthedocs.org/en/latest/hooks/#getting-transaction-names
+  [doc-hooks]: https://dredd.readthedocs.org/en/latest/hooks
+
+Change log
+----------
+
+Releases are commented to provide a [brief change log][releases], details can be found in the [`CHANGELOG`][changelog] file.
+
+  [releases]: https://github.com/gonzalo-bulnes/dredd-hooks-ruby/releases
+  [changelog]: ./CHANGELOG.md
+
+Development
+-----------
+
+### Testing
+
+```bash
+# Run the test suite
+rake
 ```
 
-## API
+A few [Cucumber][cucumber] features provide an end-to-end test harness, and a set of [RSpec][rspec] specs provide both a more granular documentation and a unit test harness.
+
+RSpec [tags][tags] are used to categorize the spec examples.
+
+Spec examples that are tagged as `public` describe aspects of the gem public API, and MAY be considered as its documentation.
 
-Module `DreddHooks::Methods` mixes in following methods `before`, `after`, `before_all`, `after_all`, `before_each`, `after_each`, `before_validation`, `before_each_validation`
+The `private` or `protected` specs are written for development purpose only. Because they describe internal behaviour which may change at any moment without notice, they are only executed as a secondary task by the [continuous integration service][travis] and SHOULD be ignored.
 
-`before`, `before_validation` `after` hooks are identified by [transaction name](http://dredd.readthedocs.org/en/latest/hooks/#getting-transaction-names).
+Run `rake spec:public` to print the gem public documentation.
 
-Usage is very similar to [sync JS hooks API](http://dredd.readthedocs.org/en/latest/hooks/#sync-api)
+  [cucumber]: https://github.com/cucumber/cucumber-rails
+  [rspec]: https://www.relishapp.com/rspec
+  [tags]: https://www.relishapp.com/rspec/rspec-core/v/3-4/docs/command-line/tag-option
+  [travis]: https://travis-ci.org/gonzalo-bulnes/simple_token_authentication/builds
 
-## Contributing
+### Maintenance
+
+Extending the DSL to support new hooks is meant to be easy, see the [maintenance documentation][doc-maintenance] for details. : )
+
+  [doc-maintenance]: ./doc/README.md
+
+> Refactored with [love, internet style](https://www.youtube.com/watch?v=Xe1TZaElTAs).
+
+Contributing
+------------
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request
+
+License
+-------
+
+See [`LICENSE`][license].
+
+  [license]: ./LICENSE.txt
+

data/Rakefile

@@ -1,2 +1,33 @@
 require "bundler/gem_tasks"
+require "cucumber/rake/task"
+
+Cucumber::Rake::Task.new
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Provide private interfaces documentation'
+  RSpec::Core::RakeTask.new(:spec)
+
+  namespace :spec do
+    desc 'Provide public interfaces documentation'
+    RSpec::Core::RakeTask.new(:public) do |t|
+      t.rspec_opts = "--tag public"
+    end
+  end
+
+  namespace :spec do
+    desc 'Provide private interfaces documentation for development purpose'
+    RSpec::Core::RakeTask.new(:development) do |t|
+      t.rspec_opts = "--tag protected --tag private"
+    end
+  end
+rescue LoadError
+  desc 'RSpec rake task not available'
+  task :spec do
+    abort 'RSpec rake task is not available. Be sure to install rspec-core as a gem or plugin'
+  end
+end
+
+task default: ['spec:public', 'spec:development', :cucumber]
 

data/bin/dredd-hooks-ruby

@@ -1,16 +1,6 @@
 #!/usr/bin/env ruby
+$LOAD_PATH.push File.join(File.dirname(__FILE__), "/../lib" )
 
-require 'dredd_hooks'
+require 'dredd_hooks/cli'
 
-# Disables stdout buffering. This makes node.js able to capture stdout of this process with no delay
-# http://stackoverflow.com/questions/23001033/how-to-live-stream-output-from-ruby-script-using-child-process-spawn
-$stdout.sync = true
-
-# Load all files given on the command-line
-DreddHooks::FileLoader.load ARGV
-
-# Run the server
-
-puts 'Starting Ruby Dredd Hooks Worker'
-server = DreddHooks::Server.new
-server.run
+DreddHooks::CLI.start(ARGV)

data/doc/README.md

@@ -0,0 +1,26 @@
+How to Add New Hooks
+====================
+
+Dredd does support new hooks? It's time to extend the Ruby DSL!
+
+In order to enable your new hook:
+
+1. Determine if the hook is specific to a transaction or applies to all of them
+1. Add the _registration_ and _run_ method to the [runner spec][runner-spec]
+1. Add the DSL method to the [DSL spec][methods-spec]
+1. Add the usage example to the [**Execution order** feature][feature]
+1. Run the entire test suite and watch the tests fail (start worrying if they don't!)
+1. Add the hook name to the corresponding list in the [definitions file][def]
+1. Add the corresponding Dredd **event** to the [events definition][def] (be careful, the hooks order does matter!)
+1. Run the test suite and watch it pass : )
+
+Finally, bump the [_minor_][semver] version number, update the `README`, the `CHANGELOG` and do anything you need to do in order to release!
+
+  [def]: ../lib/dredd_hooks/definitions.rb
+  [events-handler]: ../lib/dredd_hooks/server/events_handler.rb
+
+  [runner-spec]: ../spec/lib/dredd_hooks/runner_spec.rb
+  [methods-spec]: ../spec/lib/dredd_hooks/methods_spec.rb
+  [feature]: ../features/execution_order.feature
+  [semver]: http://semver.org
+

data/features/execution_order.feature

@@ -23,47 +23,48 @@ Feature: Execution order
   Scenario:
     Given a file named "hookfile.rb" with:
       """
+      require 'dredd_hooks/methods'
       include DreddHooks::Methods
 
       key = 'hooks_modifications'
 
       before("/message > GET") do |transaction|
-        transaction[key] = [] if transaction[key].nil?
+        transaction[key] ||= []
         transaction[key].push "before modification"
       end
 
       after("/message > GET") do |transaction|
-        transaction[key] = [] if transaction[key].nil?
+        transaction[key] ||= []
         transaction[key].push "after modification"
       end
 
       before_validation("/message > GET") do |transaction|
-        transaction[key] = [] if transaction[key].nil?
+        transaction[key] ||= []
         transaction[key].push "before validation modification"
       end
 
       before_all do |transaction|
-        transaction[0][key] = [] if transaction[0][key].nil?
+        transaction[0][key] ||= []
         transaction[0][key].push "before all modification"
       end
 
       after_all do |transaction|
-        transaction[0][key] = [] if transaction[0][key].nil?
+        transaction[0][key] ||= []
         transaction[0][key].push "after all modification"
       end
 
       before_each do |transaction|
-        transaction[key] = [] if transaction[key].nil?
+        transaction[key] ||= []
         transaction[key].push "before each modification"
       end
 
       before_each_validation do |transaction|
-        transaction[key] = [] if transaction[key].nil?
+        transaction[key] ||= []
         transaction[key].push "before each validation modification"
       end
 
       after_each do |transaction|
-        transaction[key] = [] if transaction[key].nil?
+        transaction[key] ||= []
         transaction[key].push "after each modification"
       end
 

data/features/failing_transaction.feature

@@ -23,6 +23,7 @@ Feature: Failing a transacstion
   Scenario:
     Given a file named "hookfile.rb" with:
       """
+      require 'dredd_hooks/methods'
       include DreddHooks::Methods
       before("/message > GET") do |transaction|
         transaction['fail'] = "Yay! Failed in ruby!"

data/features/hook_handlers.feature

@@ -23,6 +23,7 @@ Feature: Hook handlers
   Scenario:
     Given a file named "hookfile.rb" with:
       """
+      require 'dredd_hooks/methods'
       include DreddHooks::Methods
 
       before("/message > GET") do |transaction|

data/features/multiple_hookfiles.feature

@@ -23,6 +23,7 @@ Feature: Multiple hookfiles with a glob
   Scenario:
     Given a file named "hookfile1.rb" with:
       """
+      require 'dredd_hooks/methods'
       include DreddHooks::Methods
       before("/message > GET") do |transaction|
         puts "It's me, File1"
@@ -30,6 +31,7 @@ Feature: Multiple hookfiles with a glob
       """
     And a file named "hookfile2.rb" with:
       """
+      require 'dredd_hooks/methods'
       include DreddHooks::Methods
       before("/message > GET") do |transaction|
         puts "It's me, File2"
@@ -37,6 +39,7 @@ Feature: Multiple hookfiles with a glob
       """
     And a file named "hookfile_to_be_globed.rb" with:
       """
+      require 'dredd_hooks/methods'
       include DreddHooks::Methods
       before("/message > GET") do |transaction|
         puts "It's me, File3"
@@ -55,4 +58,4 @@ Feature: Multiple hookfiles with a glob
     And the output should contain:
       """
       It's me, File3
-      """
+      """

data/features/support/env.rb

@@ -4,9 +4,6 @@ require "sinatra/base"
 Before do
   puts "Killing server..."
   system "for i in `ps axu | grep 'server.rb' | grep ruby | awk '{print $2}'`; do kill -9 $i; done > /dev/null 2>&1"
-  puts "Killing handler..."
-  system "for i in `ps axu | grep 'dredd-hooks' | grep ruby | awk '{print $2}'`; do kill -9 $i; done > /dev/null 2>&1"
-  sleep 3
 
-  @aruba_timeout_seconds = 10
-end
+  @aruba_timeout_seconds = 20
+end

data/lib/dredd_hooks.rb

@@ -1,6 +1,5 @@
-require "dredd_hooks/version"
+require 'dredd_hooks/file_loader'
+require 'dredd_hooks/server'
+
+module DreddHooks; end
 
-require File.join(File.dirname(__FILE__), './dredd_hooks/methods.rb')
-require File.join(File.dirname(__FILE__), './dredd_hooks/runner.rb')
-require File.join(File.dirname(__FILE__), './dredd_hooks/file_loader.rb')
-require File.join(File.dirname(__FILE__), './dredd_hooks/server.rb')

data/lib/dredd_hooks/cli.rb

@@ -0,0 +1,18 @@
+require 'dredd_hooks'
+
+module DreddHooks
+  class CLI
+
+    def self.start(error=STDERR, out=STDOUT, files)
+
+      # Load all files given on the command-line
+      DreddHooks::FileLoader.load(files)
+
+      # Run the server
+      out.puts 'Starting Ruby Dredd Hooks Worker...'
+      server = DreddHooks::Server.new(error, out)
+      server.run
+    end
+  end
+end
+