oni 0.0.1 → 1.0.0

data/spec/oni/configurable_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Oni::Configurable do
+  let :example_class do
+    Class.new do
+      include Oni::Configurable
+    end
+  end
+
+  example 'setting an option' do
+    example_class.set(:number, 10)
+
+    example_class.options[:number].should == 10
+  end
+
+  example 'setting multiple options' do
+    example_class.set_multiple(:a => 10, :b => 20)
+
+    example_class.options[:a].should == 10
+    example_class.options[:b].should == 20
+  end
+
+  example 'retrieve an option' do
+    example_class.set(:number, 10)
+
+    example_class.new.option(:number).should == 10
+  end
+
+  example 'retrieve an option with a default value' do
+    example_class.new.option(:number, 20).should == 20
+  end
+
+  example 'evaluate an option value upon retrieval' do
+    example_class.set(:dynamic, proc { Struct.new(:example) })
+
+    instance = example_class.new
+
+    instance.option(:dynamic).should_not == instance.option(:dynamic)
+  end
+
+  example 'raise for a required but unset option' do
+    instance = example_class.new
+    block    = lambda { instance.require_option!(:another_number) }
+
+    block.should raise_error(ArgumentError)
+  end
+
+  example 'do not raise for a required option with a value' do
+    example_class.set(:another_number, 20)
+
+    instance = example_class.new
+
+    instance.require_option!(:another_number)
+    instance.option(:another_number).should == 20
+  end
+end

data/spec/oni/daemon_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+describe Oni::Daemon do
+  let :example_daemon do
+    mapper = Class.new(Oni::Mapper) do
+      attr_reader :number
+
+      def map_input(input)
+        return input[:number]
+      end
+
+      def map_output(number)
+        return {:new_number => number}
+      end
+    end
+
+    worker = Class.new(Oni::Worker) do
+      def initialize(number)
+        @number = number
+      end
+
+      def process
+        return @number * 2
+      end
+    end
+
+    Class.new(Oni::Daemon) do
+      attr_reader :number, :number2, :message, :output, :timings
+
+      set :mapper, mapper
+      set :worker, worker
+      set :threads, 2
+
+      def after_initialize
+        @number = 10
+      end
+
+      def before_start
+        @number2 = 20
+      end
+
+      def receive
+        yield({:number => 10})
+      end
+
+      def complete(message, output, timings)
+        @message = message
+        @output  = output
+        @timings = timings
+      end
+    end
+  end
+
+  example 'call #after_initialize' do
+    example_daemon.new.number.should == 10
+  end
+
+  example 'call #before_start' do
+    daemon = example_daemon.new
+    daemon.start
+    daemon.stop
+
+    daemon.number2.should == 20
+  end
+
+  example 'raise for the default receive method' do
+    daemon = Oni::Daemon.new
+
+    lambda { daemon.receive }.should raise_error(NotImplementedError)
+  end
+
+  example 'return the amount of threads to use' do
+    example_daemon.set(:threads, 10)
+
+    example_daemon.new.threads.should == 10
+  end
+
+  example 'use the default amount of threads' do
+    example_daemon.set(:threads, nil)
+
+    example_daemon.new.threads.should == Oni::Daemon::DEFAULT_THREAD_AMOUNT
+  end
+
+  example 'create the mapper without any arguments' do
+    mapper = example_daemon.new.create_mapper
+
+    mapper.is_a?(Oni::Mapper).should == true
+    mapper.number.nil?.should        == true
+  end
+
+  example 'start and stop the thread daemon' do
+    instance = example_daemon.new
+    instance.start
+
+    instance.workers.length.should == instance.threads
+
+    instance.stop
+
+    instance.workers.length.should == 0
+  end
+
+  example 'process a job' do
+    instance = example_daemon.new
+
+    instance.start
+    instance.stop
+
+    instance.message.should == {:number => 10}
+    instance.output.should  == {:new_number => 20}
+  end
+
+  example 'measure the execution time' do
+    instance = example_daemon.new
+
+    instance.start
+    instance.stop
+
+    instance.timings.is_a?(Benchmark::Tms).should == true
+  end
+
+  context 'error handling' do
+    let :example_daemon do
+      Class.new(Oni::Daemon) do
+        set :threads, 0
+
+        def receive
+          yield 10
+        end
+      end
+    end
+
+    let :custom_error_daemon do
+      Class.new(example_daemon) do
+        set :threads, 0
+
+        def error(error)
+          raise 'custom error'
+        end
+      end
+    end
+
+    example 'should raise by default' do
+      daemon = example_daemon.new
+
+      lambda { daemon.start }.should raise_error(ArgumentError)
+    end
+
+    example 'allow custom error callbacks' do
+      daemon = custom_error_daemon.new
+
+      lambda { daemon.start }.should raise_error(RuntimeError, 'custom error')
+    end
+  end
+end

data/spec/oni/daemons/sqs_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require_relative '../../../lib/oni/daemons/sqs'
+
+describe Oni::Daemons::SQS do
+  let :example_daemon do
+    Class.new(Oni::Daemons::SQS)
+  end
+
+  example 'require the queue name to be set' do
+    block = lambda { example_daemon.new }
+
+    block.should raise_error(ArgumentError, /The option queue_name is required/)
+  end
+
+  example 'receive a message' do
+    example_daemon.set(:queue_name, 'example')
+
+    instance = example_daemon.new
+    queue    = Class.new do
+      def poll(options = {})
+        yield 10
+      end
+    end
+
+    instance.stub(:queue).and_return(queue.new)
+
+    instance.receive do |number|
+      number.should == 10
+    end
+  end
+end

data/spec/oni/mapper_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Oni::Mapper do
+  let :example_mapper do
+    Class.new(Oni::Mapper)
+  end
+
+  example 'set an option of the class' do
+    example_mapper.set(:number, 10)
+
+    example_mapper.new.option(:number).should == 10
+  end
+
+  example 'return the raw input' do
+    input = {:number => 10}
+
+    example_mapper.new.map_input(input).should == input
+  end
+
+  example 'return the raw output' do
+    output = {:number => 10}
+
+    example_mapper.new.map_output(output).should == output
+  end
+end

data/spec/oni/worker_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Oni::Worker do
+  let :example_worker do
+    Class.new(Oni::Worker) do
+      def initialize(number = 10)
+        @number = number
+      end
+
+      def process
+        return @number * 2
+      end
+    end
+  end
+
+  example 'raise for the default process method' do
+    worker = Oni::Worker.new
+
+    lambda { worker.process }.should raise_error(NotImplementedError)
+  end
+
+  example 'set an option of the class' do
+    example_worker.set(:number, 10)
+
+    example_worker.new.option(:number).should == 10
+  end
+
+  example 'process a job' do
+    worker = example_worker.new(10)
+
+    worker.process.should == 20
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+
+require_relative 'support/simplecov' if ENV['COVERAGE']
+require_relative '../lib/oni'
+
+RSpec.configure do |config|
+  config.color = true
+end

data/spec/support/simplecov.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+
+SimpleCov.configure do
+  root         File.expand_path('../../../', __FILE__)
+  command_name 'rspec'
+  project_name 'oni'
+
+  add_filter 'spec'
+  add_filter 'lib/oni/version'
+end
+
+SimpleCov.start

data/task/coverage.rake

@@ -0,0 +1,6 @@
+desc 'Generates code coverage'
+task :coverage do
+  ENV['COVERAGE'] = '1'
+
+  Rake::Task['test'].invoke
+end

data/task/doc.rake

@@ -0,0 +1,4 @@
+desc 'Builds the documentation'
+task :doc do
+  sh('yard doc')
+end

data/task/jenkins.rake

@@ -0,0 +1,2 @@
+desc 'Runs all the tests for Jenkins'
+task :jenkins => ['ci:setup:rspec', 'test']

data/task/tag.rake

@@ -0,0 +1,6 @@
+desc 'Creates a Git tag for the current version'
+task :tag do
+  version = Oni::VERSION
+
+  sh %Q{git tag -a -m "Version #{version}" #{version}}
+end

data/task/test.rake

@@ -0,0 +1,4 @@
+desc 'Runs the tests'
+task :test do
+  sh 'rspec spec'
+end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: oni
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Olery <info@olery.com>
-- Yorick Peterse <yorickpeterse@gmail.com>
-- Wilco van Duinkerken <wilcovanduinkerken@olery.com>
+- Yorick Peterse
+- Wilco van Duinkerken
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-09 00:00:00.000000000 Z
+date: 2013-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -110,16 +109,60 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby framework for building concurrent job processing applications.
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Framework for building concurrent daemons in Ruby.
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- doc/changelog.md
+- doc/css/common.css
+- examples/github_status.rb
+- jenkins.sh
 - lib/oni.rb
+- lib/oni/configurable.rb
+- lib/oni/daemon.rb
+- lib/oni/daemons/sqs.rb
+- lib/oni/mapper.rb
 - lib/oni/version.rb
+- lib/oni/worker.rb
+- oni.gemspec
+- spec/oni/configurable_spec.rb
+- spec/oni/daemon_spec.rb
+- spec/oni/daemons/sqs_spec.rb
+- spec/oni/mapper_spec.rb
+- spec/oni/worker_spec.rb
+- spec/spec_helper.rb
+- spec/support/simplecov.rb
+- task/coverage.rake
+- task/doc.rake
+- task/jenkins.rake
+- task/tag.rake
+- task/test.rake
 homepage: 
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -140,6 +183,13 @@ rubyforge_project:
 rubygems_version: 2.1.2
 signing_key: 
 specification_version: 4
-summary: Ruby framework for building concurrent job processing applications.
-test_files: []
+summary: Framework for building concurrent daemons in Ruby.
+test_files:
+- spec/oni/configurable_spec.rb
+- spec/oni/daemon_spec.rb
+- spec/oni/daemons/sqs_spec.rb
+- spec/oni/mapper_spec.rb
+- spec/oni/worker_spec.rb
+- spec/spec_helper.rb
+- spec/support/simplecov.rb
 has_rdoc: yard