oni 3.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e99a96dc46db570b1065827caf321fd84ce594a
-  data.tar.gz: f503693b9833520c2fb0af1ad727e6e40c84744a
+  metadata.gz: e86f0fc6b0d6056128511d7a55a0d6be22b4830a
+  data.tar.gz: 67bb84f5831cfcaa771103bfa81e5bc96c052054
 SHA512:
-  metadata.gz: 899afbc20589b9c182fddd5df27a87b48dbea3148d7fdedbbcd05174c58b0b0a5164400c4a0bdd80562d971a28ba6374e150c1e9b3c038a590c8dc28a7b57b8f
-  data.tar.gz: 0f5db4e324ed9172647fbaee4378dcb103f827baafa7026e72069cf465c7978e399b453c054030326480d107200cb369a2c0b448cf9d3251f748b774063156fa
+  metadata.gz: 3da0297aec49385fe97d280906ef75dc89f24e0c571baab7ebc3dde484e13ea31e47f0b7dd80928dfd5da8b0d4adab10d3a8aa33b30daa63e5872f38dfac6b7c
+  data.tar.gz: ca0126f07de0d95b51e5abc149435450c573672352b7525b2acabbba010d812fa17e83736828bf98706515d40b568e21b1c5c66d4e908425c77a23203214199a

data/README.md

@@ -138,17 +138,17 @@ Basic usage of Oni is as following:
       end
 
       # This would get executed upon completion of a job.
-      def complete(message, result, timings)
+      def complete(message, result)
         puts result
       end
     end
 
     class MyMapper < Oni::Mapper
       # Map the input given by MyDaemon#receive into the right arguments
-      # for MyWorker#initialize. 
+      # for MyWorker#initialize.
       #
-      # NOTE: the return value should be an Array. 
-      # Oni calls #to_a on the output (more specifically we use a splat) so your 
+      # NOTE: the return value should be an Array.
+      # Oni calls #to_a on the output (more specifically we use a splat) so your
       # return value should be an Array. If you do not return an Array you risk
       # that the object you return will wrongfully be converted into an Array.
       # This is painful when it comes to Hashes, which, after the #to_a call

data/lib/oni.rb

@@ -1,5 +1,4 @@
 require 'thread'
-require 'benchmark'
 
 require_relative 'oni/version'
 require_relative 'oni/configurable'

data/lib/oni/daemon.rb

@@ -82,12 +82,9 @@ module Oni
     # @param [Mixed] message
     #
     def process(message)
-      output  = nil
-      timings = Benchmark.measure do
-        output = run_worker(message)
-      end
+      output = run_worker(message)
 
-      complete(message, output, timings)
+      complete(message, output)
     end
 
     ##
@@ -101,9 +98,7 @@ module Oni
       mapper = create_mapper
       input  = mapper.map_input(message)
       worker = option(:worker).new(*input)
-      output = Timeout.timeout option :worker_timeout do
-        worker.process
-      end
+      output = worker.process
 
       return mapper.map_output(output)
     end
@@ -119,18 +114,15 @@ module Oni
 
     ##
     # Called when a job has been completed, by default this method is a noop.
-    # This method is passed 3 arguments:
+    # This method is passed 2 arguments:
     #
     # 1. The raw input message.
     # 2. The output of the worker (remapped by the mapper).
-    # 3. A Benchmark::Tms instance that contains the timings for processing the
-    #    message.
     #
     # @param [Mixed] message The raw input message (e.g. an AWS SQS message)
     # @param [Mixed] output The output of the worker.
-    # @param [Benchmark::Tms] timings
     #
-    def complete(message, output, timings)
+    def complete(message, output)
     end
 
     ##

data/lib/oni/daemons/sqs.rb

@@ -1,4 +1,4 @@
-require 'aws-sdk-v1'
+require 'aws-sdk'
 
 module Oni
   module Daemons
@@ -49,13 +49,21 @@ module Oni
       ##
       # Returns the queue to use for the current thread.
       #
-      # @return [AWS::SQS::Queue]
+      # @return [Aws::SQS::QueuePoller]
       #
-      #:nocov:
       def queue
-        return AWS::SQS.new.queues.named(option(:queue_name))
+        return Aws::SQS::QueuePoller.new(queue_url)
+      end
+
+      ##
+      # @return [String]
+      #
+      def queue_url
+        sqs      = Aws::SQS::Client.new
+        response = sqs.get_queue_url(:queue_name => option(:queue_name))
+
+        return response.queue_url
       end
-      #:nocov:
     end # SQS
   end # Daemons
 end # Oni

data/lib/oni/version.rb

@@ -1,3 +1,3 @@
 module Oni
-  VERSION = '3.2.0'
+  VERSION = '4.0.0'
 end # Oni

data/oni.gemspec

@@ -15,9 +15,14 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 1.9.3'
 
-  gem.files       = `git ls-files`.split("\n").sort
-  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files  = gem.files.grep(%r{^(test|spec|features)/})
+  gem.files = Dir.glob([
+    'doc/**/*',
+    'lib/**/*.rb',
+    'README.md',
+    'LICENSE',
+    'oni.gemspec',
+    '.yardopts'
+  ]).select { |file| File.file?(file) }
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'bundler'
@@ -25,5 +30,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'simplecov'
   gem.add_development_dependency 'kramdown'
-  gem.add_development_dependency 'aws-sdk-v1'
+  gem.add_development_dependency 'aws-sdk', '~> 2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oni
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Yorick Peterse
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -96,37 +96,30 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk-v1
+  name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: Framework for building concurrent daemons in Ruby.
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".travis.yml"
 - ".yardopts"
-- Gemfile
-- Gemfile.lock
 - 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
@@ -136,19 +129,6 @@ files:
 - lib/oni/worker.rb
 - lib/oni/wrapped_error.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/oni/wrapped_error_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:
 - MIT
@@ -169,16 +149,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 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/oni/wrapped_error_spec.rb
-- spec/spec_helper.rb
-- spec/support/simplecov.rb
+test_files: []
+has_rdoc: yard

data/.gitignore

@@ -1,14 +0,0 @@
-# package
-pkg
-*.gem
-
-# tests
-coverage
-
-# docs
-yardoc
-
-# editors
-*.swp
-*~
-

data/.travis.yml

@@ -1,23 +0,0 @@
----
-script: bundle exec rake
-
-rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - jruby
-  - rbx-2.2
-
-notifications:
-  email:
-    recipients:
-      - development@olery.com
-    email:
-      on_success: change
-      on_failure: change
-
-branches:
-  only:
-    - master
-
-#cache: bundler

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org/'
-
-gemspec

data/Gemfile.lock

@@ -1,54 +0,0 @@
-PATH
-  remote: .
-  specs:
-    oni (3.1.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    aws-sdk-v1 (1.67.0)
-      json (~> 1.4)
-      nokogiri (~> 1)
-    diff-lcs (1.3)
-    docile (1.1.5)
-    json (1.8.6)
-    kramdown (1.15.0)
-    mini_portile2 (2.3.0)
-    nokogiri (1.8.1)
-      mini_portile2 (~> 2.3.0)
-    rake (12.1.0)
-    rspec (3.6.0)
-      rspec-core (~> 3.6.0)
-      rspec-expectations (~> 3.6.0)
-      rspec-mocks (~> 3.6.0)
-    rspec-core (3.6.0)
-      rspec-support (~> 3.6.0)
-    rspec-expectations (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-mocks (3.6.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.6.0)
-    rspec-support (3.6.0)
-    simplecov (0.15.1)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    yard (0.9.9)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  aws-sdk-v1
-  bundler
-  kramdown
-  oni!
-  rake
-  rspec (~> 3.0)
-  simplecov
-  yard
-
-BUNDLED WITH
-   1.15.4

data/Rakefile

@@ -1,12 +0,0 @@
-require_relative 'lib/oni/version'
-
-require 'rake/clean'
-require 'bundler/gem_tasks'
-
-CLEAN.include('coverage', 'yardoc')
-
-Dir['./task/*.rake'].each do |task|
-  import(task)
-end
-
-task :default => :test

data/examples/github_status.rb

@@ -1,75 +0,0 @@
-require_relative '../lib/oni'
-require 'net/https'
-require 'json'
-
-module GithubStatus
-  class Mapper < Oni::Mapper
-    def map_input(input)
-      return input['url']
-    end
-
-    def map_output(output)
-      return output['status']
-    end
-  end
-
-  class Worker < Oni::Worker
-    attr_reader :url
-
-    def initialize(url)
-      @url = url
-    end
-
-    def process
-      uri_object   = URI.parse(url)
-      http         = Net::HTTP.new(uri_object.host, uri_object.port)
-      http.use_ssl = true
-      request      = Net::HTTP::Get.new(uri_object.request_uri)
-      response     = http.request(request)
-
-      return JSON(response.body)
-    end
-  end
-
-  class Daemon < Oni::Daemon
-    # Check GitHub every 10 minutes.
-    set :interval, 600
-
-    # Since this daemon does the same thing over and over we'll only run 1
-    # thread instead of multiple ones.
-    set :threads, 1
-
-    # The URL to check.
-    set :status_url, 'https://status.github.com/api/status.json'
-
-    set :mapper, Mapper
-    set :worker, Worker
-
-    def receive
-      loop do
-        # This is to mimic some kind of job coming from a queue.
-        yield({'url' => option(:status_url)})
-
-        sleep(option(:interval))
-      end
-    end
-
-    def complete(message, output, timings)
-      sec = timings.real.round(3)
-
-      puts "GitHub status: #{output}, retrieved in #{sec} seconds"
-    end
-  end # Daemon
-end # GithubStatus
-
-daemon = GithubStatus::Daemon.new
-
-%w{INT TERM}.each do |signal|
-  trap(signal) do
-    puts 'Shutting down...'
-
-    daemon.stop
-  end
-end
-
-daemon.start

data/jenkins.sh

@@ -1,16 +0,0 @@
-# This configuration file is used to test/build the project on Olery's private
-# Jenkins instance. Patches containing changes to this file made by people
-# outside of Olery will most likely be rejected.
-
-# The name of the project, used for other settings such as the MySQL database
-# and the package name.
-PROJECT_NAME="oni"
-
-# Whether or not to use a MySQL database, set to a non empty value to enable
-# this. Enabling this will tell Jenkins to create/drop the database and to
-# import any migrations if needed.
-unset USE_MYSQL
-
-# The command to run for the test suite. Junction itself doesn't have a test
-# suite so we'll use a noop.
-TEST_COMMAND="rake jenkins --trace"

data/spec/oni/configurable_spec.rb

@@ -1,56 +0,0 @@
-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

@@ -1,158 +0,0 @@
-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 error(error, extra_data = nil)
-        raise "#{error.message}: #{extra_data}"
-      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, extra_data = nil)
-          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

@@ -1,31 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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

@@ -1,33 +0,0 @@
-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/oni/wrapped_error_spec.rb

@@ -1,44 +0,0 @@
-require 'spec_helper'
-
-describe Oni::WrappedError do
-  before do
-    @original_error = StandardError.new('Hello world')
-    @parameters     = {:foo => :bar}
-  end
-
-  context 'manually creating instances' do
-    example 'set the message' do
-      Oni::WrappedError.new('foo').message.should == 'foo'
-    end
-
-    example 'set the original error' do
-      error = Oni::WrappedError.new('foo', :original_error => @original_error)
-
-      error.original_error.should == @original_error
-    end
-
-    example 'set the parameters' do
-      error = Oni::WrappedError.new('foo', :parameters => @parameters)
-
-      error.parameters.should == @parameters
-    end
-  end
-
-  context 'creating instances from other errors' do
-    before do
-      @error = Oni::WrappedError.from(@original_error, @parameters)
-    end
-
-    example 'set the message' do
-      @error.message.should == @original_error.message
-    end
-
-    example 'set the original error' do
-      @error.original_error.should == @original_error
-    end
-
-    example 'set the parameters' do
-      @error.parameters.should == @parameters
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,16 +0,0 @@
-require 'rspec'
-
-require_relative 'support/simplecov' if ENV['COVERAGE']
-require_relative '../lib/oni'
-
-RSpec.configure do |config|
-  config.color = true
-
-  config.expect_with :rspec do |c|
-    c.syntax = [:should, :expect]
-  end
-
-  config.mock_with :rspec do |c|
-    c.syntax = [:should, :expect]
-  end
-end

data/spec/support/simplecov.rb

@@ -1,12 +0,0 @@
-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

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

data/task/doc.rake

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

data/task/jenkins.rake

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

data/task/tag.rake

@@ -1,6 +0,0 @@
-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

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