dredd_hooks 0.0.1 → 0.1.0

data/lib/dredd_hooks/server/buffer.rb

@@ -0,0 +1,49 @@
+require 'json'
+
+module DreddHooks
+  class Server
+
+    # Store JSON messages or part of them
+    class Buffer
+
+      def initialize(message_delimiter)
+        flush!
+        @message_delimiter = message_delimiter
+      end
+
+      # Empty the buffer.
+      #
+      # Returns the buffer content String.
+      def flush!
+        content = @content
+        @content = ""
+        content
+      end
+
+      def <<(string)
+        @content += string
+      end
+
+      def any_message?
+        @content.include? @message_delimiter
+      end
+
+      def unshift_messages
+        flush!.
+        split(@message_delimiter).
+        inject([]) { |messages, message|
+          begin
+            messages.push JSON.parse(message)
+          rescue JSON::ParserError
+            # If the message after the delimiter is not parseable JSON,
+            # then it's a chunk of the next message, and should be put back
+            # into the buffer.
+            @content += message
+            messages
+          end
+        }
+      end
+
+    end
+  end
+end

data/lib/dredd_hooks/server/events_handler.rb

@@ -0,0 +1,33 @@
+require 'dredd_hooks/definitions'
+require 'dredd_hooks/errors'
+require 'dredd_hooks/runner'
+
+module DreddHooks
+
+  class Server
+    class EventsHandler
+
+      attr_reader :events, :runner
+      private :events, :runner
+
+      def initialize(events=EVENTS, runner=Runner.instance)
+        @events = events
+        @runner = runner
+      end
+
+      def handle(event, transaction)
+
+        events.fetch(event.to_sym, []).each do |hook_name|
+          begin
+            transaction = runner.send("run_#{hook_name}_hooks_for_transaction", transaction)
+          rescue NoMethodError
+            raise UnknownHookError.new(hook_name)
+          end
+        end
+
+        transaction
+      end
+    end
+  end
+end
+

data/lib/dredd_hooks/version.rb

@@ -1,3 +1,3 @@
 module DreddHooks
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/integration/definitions_consistency_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module DreddHooks
+  describe 'All the defined hooks', protected: true do
+
+    DEFINED_HOOKS = HOOKS_ON_SINGLE_TRANSACTIONS + HOOKS_ON_MULTIPLE_TRANSACTIONS
+
+    describe 'are runned on least one event' do
+
+      let(:hooks_in_use) { Server::EVENTS.map{ |_event, hooks| hooks }.flatten.uniq }
+
+      DEFINED_HOOKS.each do |hook_name|
+        it ":#{hook_name} is refered to by at least one event" do
+          expect(hooks_in_use).to include(hook_name)
+        end
+      end
+
+    end
+  end
+  
+  describe 'DreddHooks events definition', protected: true do
+
+    describe 'only refers to hooks that are already defined' do
+
+      let(:defined_hooks) { HOOKS_ON_SINGLE_TRANSACTIONS + HOOKS_ON_MULTIPLE_TRANSACTIONS }
+
+      Server::EVENTS.each do |_event, hook_names|
+        hook_names.each do |hook_name|
+          it ":#{hook_name} is defined" do
+            expect(defined_hooks).to include(hook_name)
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/spec/lib/dredd_hooks/methods_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+require 'dredd_hooks/methods'
+
+module DreddHooks
+
+  class DummyHooksFile
+    include DreddHooks::Methods
+  end
+
+  describe Methods do
+
+    let(:hooks_file) { DummyHooksFile.new }
+
+    describe 'exposes the Ruby hooks DSL', public: true do
+
+      it 'defines #before' do
+        expect(hooks_file).to respond_to :before
+      end
+
+      it 'defines #before_validation' do
+        expect(hooks_file).to respond_to :before_validation
+      end
+
+      it 'defines #after' do
+        expect(hooks_file).to respond_to :after
+      end
+
+      it 'defines #before_each' do
+        expect(hooks_file).to respond_to :before_each
+      end
+
+      it 'defines #before_each_validation' do
+        expect(hooks_file).to respond_to :before_each_validation
+      end
+
+      it 'defines #after_each' do
+        expect(hooks_file).to respond_to :after_each
+      end
+
+      it 'defines #before_all' do
+        expect(hooks_file).to respond_to :before_all
+      end
+
+      it 'defines #after_all' do
+        expect(hooks_file).to respond_to :after_all
+      end
+    end
+
+    it 'does not expose its #runner', private: true do
+      expect(hooks_file).not_to respond_to :runner
+    end
+
+    describe 'does not expose its generator methods', private: true do
+
+      it { expect(DreddHooks::Methods).not_to respond_to :define_hooks_on_multiple_transactions }
+      it { expect(DreddHooks::Methods).not_to respond_to :define_hooks_on_single_transactions }
+
+    end
+  end
+end
+

data/spec/lib/dredd_hooks/runner_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+module DreddHooks
+  describe Runner do
+
+    let(:runner) { Runner.instance }
+
+    describe 'exposes an interface to run hooks', protected: true do
+
+      it { expect(runner).to respond_to :run_before_hooks_for_transaction }
+      it { expect(runner).to respond_to :run_before_validation_hooks_for_transaction }
+      it { expect(runner).to respond_to :run_after_hooks_for_transaction }
+      it { expect(runner).to respond_to :run_before_each_hooks_for_transaction }
+      it { expect(runner).to respond_to :run_before_each_validation_hooks_for_transaction }
+      it { expect(runner).to respond_to :run_after_each_hooks_for_transaction }
+      it { expect(runner).to respond_to :run_before_all_hooks_for_transaction }
+      it { expect(runner).to respond_to :run_after_all_hooks_for_transaction }
+    end
+
+    describe 'exposes an interface to register hooks', private: true do
+
+      it { expect(runner).to respond_to :register_before_hook }
+      it { expect(runner).to respond_to :register_before_validation_hook }
+      it { expect(runner).to respond_to :register_after_hook }
+      it { expect(runner).to respond_to :register_before_each_hook }
+      it { expect(runner).to respond_to :register_before_each_validation_hook }
+      it { expect(runner).to respond_to :register_after_each_hook }
+      it { expect(runner).to respond_to :register_before_all_hook }
+      it { expect(runner).to respond_to :register_after_all_hook }
+    end
+
+    describe 'does not expose its generator methods', private: true do
+
+      it { expect(runner.class).not_to respond_to :define_registration_methods_for_hooks_on_single_transactions }
+      it { expect(runner.class).not_to respond_to :define_registration_methods_for_hooks_on_multiple_transactions }
+      it { expect(runner.class).not_to respond_to :define_runners_for_hooks_on_single_transactions }
+      it { expect(runner.class).not_to respond_to :define_runners_for_hooks_on_multiple_transactions }
+    end
+  end
+end
+

data/spec/lib/dredd_hooks/server/buffer_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+module DreddHooks
+  describe Server::Buffer, private: true do
+
+    let(:message_delimiter) { "\t" }
+    let(:buffer) { described_class.new(message_delimiter) }
+
+    it { expect(buffer).to respond_to :<< }
+    it { expect(buffer).to respond_to :flush! }
+    it { expect(buffer).to respond_to :unshift_messages }
+    it { expect(buffer).to respond_to :any_message? }
+
+    it 'is empty by default' do
+      expect(buffer.any_message?).to be false
+    end
+
+    describe '#any_message?' do
+
+      it { expect(buffer.any_message?).to be false }
+
+      context "when the buffer contains part of a message" do
+
+        it {
+          buffer << '{ "note": "This string contains no message delimiter..." }'
+          expect(buffer.any_message?).to be false
+        }
+      end
+
+      context "when the buffer contains at least one message" do
+
+        it {
+          buffer << "{ \"note\": \"This string does contain a message delimiter...\" }\t{ \"and\": \"some\", \"more\": \"stuff which is not even valid JSON.... aAAAah! "
+          expect(buffer.any_message?).to be true
+        }
+      end
+    end
+
+    describe '#unshift_messages' do
+
+      before(:each) do
+        buffer << "{ \"A\": \"JSON message\" }\t"
+        buffer << "{ \"another\": \"message\" }\t{ \"and a\": \"half\","
+      end
+
+      it 'returns an array of messages' do
+        expect(buffer.unshift_messages).to eq [{ 'A' => 'JSON message' }, { 'another' => 'message' }]
+      end
+
+      it 'keeps the uncomplete messages intact' do
+        buffer.unshift_messages
+        expect(buffer.flush!).to eq '{ "and a": "half",'
+      end
+    end
+
+  end
+end
+

data/spec/lib/dredd_hooks/server/events_handler_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+# Runs the 'known' hook but not the 'unknown' one.
+class DummyRunner
+
+  def run_known_hooks_for_transaction(transaction)
+    transaction
+  end
+end
+
+module DreddHooks
+  describe Server::EventsHandler, private: true do
+
+    let(:events_handler) { described_class.new }
+
+    it { expect(events_handler).to respond_to :handle }
+
+    describe '#handle' do
+
+      it 'returns a transaction' do
+       event = 'doNothing'
+       transaction = double()
+       expect(events_handler.handle(event, transaction)).to eq transaction
+      end
+
+      context 'when attempting to handle a hook not defined by the DSL' do
+
+        let(:events_definition) {
+          {
+            beforeAll: [
+              :known,
+            ],
+            afterAll: [
+              :unknown
+            ]
+          }
+        }
+        let(:transaction) { double }
+        let(:runner) { DummyRunner.new }
+        let(:events_handler) { described_class.new(events_definition, runner) }
+
+        it 'raises a UnknownHookError' do
+          expect{ events_handler.handle('beforeAll', transaction) }.not_to raise_error
+          expect{ events_handler.handle('afterAll', transaction) }.to raise_error UnknownHookError
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'dredd_hooks'
+
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f; puts f }
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # make sure the deprecated RSpec 2 syntax is not used
+  config.raise_errors_for_deprecations!
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -1,88 +1,89 @@
 --- !ruby/object:Gem::Specification
 name: dredd_hooks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Adam Kliment
+- Gonzalo Bulnes Guilpain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2016-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: aruba
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.5
 description: Write Dredd hooks in Ruby to glue together API Blueprint with your Ruby
-  project
+  project.
 email:
 - adam@apiary.io
+- gon.bulnes@gmail.com
 executables:
 - dredd-hooks-ruby
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/dredd-hooks-ruby
-- dredd_hooks.gemspec
+- doc/README.md
 - features/execution_order.feature
 - features/failing_transaction.feature
 - features/hook_handlers.feature
@@ -90,13 +91,23 @@ files:
 - features/step_definitions/dredd_steps.rb
 - features/support/env.rb
 - features/support/server.rb
-- features/tcp_server.feature
 - lib/dredd_hooks.rb
+- lib/dredd_hooks/cli.rb
+- lib/dredd_hooks/definitions.rb
+- lib/dredd_hooks/errors.rb
 - lib/dredd_hooks/file_loader.rb
 - lib/dredd_hooks/methods.rb
 - lib/dredd_hooks/runner.rb
 - lib/dredd_hooks/server.rb
+- lib/dredd_hooks/server/buffer.rb
+- lib/dredd_hooks/server/events_handler.rb
 - lib/dredd_hooks/version.rb
+- spec/integration/definitions_consistency_spec.rb
+- spec/lib/dredd_hooks/methods_spec.rb
+- spec/lib/dredd_hooks/runner_spec.rb
+- spec/lib/dredd_hooks/server/buffer_spec.rb
+- spec/lib/dredd_hooks/server/events_handler_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/apiaryio/dredd-hooks-ruby
 licenses:
 - MIT
@@ -107,17 +118,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.6.1
 signing_key: 
 specification_version: 4
 summary: Ruby Hooks Handler for Dredd API Testing Framework
@@ -129,4 +140,9 @@ test_files:
 - features/step_definitions/dredd_steps.rb
 - features/support/env.rb
 - features/support/server.rb
-- features/tcp_server.feature
+- spec/integration/definitions_consistency_spec.rb
+- spec/lib/dredd_hooks/methods_spec.rb
+- spec/lib/dredd_hooks/runner_spec.rb
+- spec/lib/dredd_hooks/server/buffer_spec.rb
+- spec/lib/dredd_hooks/server/events_handler_spec.rb
+- spec/spec_helper.rb