sneakers 0.0.7 → 0.1.0.pre

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# 0.1.0, Not released yet
+ 
++ Added newrelic stats reporter (@arielze)
++ Added explicit routing_key at queue (@arielze)
++ Depracating self-daemonization (@jondot)
++ updating bunny (@michaelklishin)
++ Fix reference in publisher (@sergei-matheson)
++ Allow binding of multiple routing keys (@SebastianEdwards)
++ added work_with_params for advanced handling of work items with amqp
+headers. (#12)
++ Bunny.not_environmental! will no disable auto-environment discovery.
+(#15)
+
+
+
+
+# 0.0.7
+
++ Sneakers core.
+

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    sneakers (0.0.6)
-      bunny (>= 0.10.0)
+    sneakers (0.1.0)
+      bunny (~> 1.0.7)
       serverengine
       thor
       thread
@@ -13,12 +13,12 @@ GEM
     activesupport (3.2.15)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
-    amq-protocol (1.8.0)
+    amq-protocol (1.9.2)
     arrayfields (4.9.0)
     awesome_print (1.2.0)
     bluff (0.1.0)
-    bunny (0.10.8)
-      amq-protocol (>= 1.6.0)
+    bunny (1.0.7)
+      amq-protocol (>= 1.9.2)
     cane (2.6.0)
       parallel
     celluloid (0.15.2)
@@ -124,7 +124,7 @@ GEM
       sexp_processor (~> 4.0)
     ruby_parser (3.2.2)
       sexp_processor (~> 4.1)
-    serverengine (1.5.5)
+    serverengine (1.5.7)
       sigdump (~> 0.2.2)
     sexp_processor (4.3.0)
     sigdump (0.2.2)
@@ -135,7 +135,7 @@ GEM
     simplecov-rcov-text (0.0.2)
     slop (3.4.6)
     thor (0.18.1)
-    thread (0.1.1)
+    thread (0.1.3)
     timers (1.1.0)
 
 PLATFORMS

data/README.md

@@ -12,6 +12,10 @@
 A high-performance RabbitMQ background processing framework for
 Ruby.
 
+
+Sneakers is being used in production for both I/O and CPU intensive workloads, and have achieved the goals of high-performance and 0-maintenance, as designed.
+
+
 Visit the [wiki](https://github.com/jondot/sneakers/wiki) for
 complete docs.
 
@@ -146,6 +150,17 @@ From here, you can continue over to the
 
 Fork, implement, add tests, pull request, get my everlasting thanks and a respectable place here :).
 
+
+### Thanks:
+
+* Michael Klishin - @michaelklishin 
+* Ariel Zerahia - @arielze
+* @sergei-matheson
+* Sebastian Edwards - @SebastianEdwards
+* Tor Ivry - @torkale
+
+
+
 # Copyright
 
 Copyright (c) 2013 [Dotan Nahum](http://gplus.to/dotan) [@jondot](http://twitter.com/jondot). See MIT-LICENSE for further details.

data/ROADMAP.md

@@ -0,0 +1,18 @@
+# Roadmap
+
+It is essential to keep a clear roadmap.
+In its core, Sneakers is already production-ready. However, it is vital
+to take in feedback and improve what can be improved :)
+
+This document will communicate the stages that the next version is at.
+See `CHANGELOG.md` for new features that are in.
+
+
+# v0.1.0 (next version)
+
+- Taking in community pull requests and feedback
+- Verify production readiness and performance
+- Full performance test suite
+
+
+

data/lib/sneakers.rb

@@ -65,6 +65,10 @@ module Sneakers
     @configured = false
   end
 
+  def self.not_environmental!
+    Config[:env] = nil
+  end
+
   def self.daemonize!(loglevel=Logger::INFO)
     Config[:log] = 'sneakers.log'
     Config[:daemonize] = true

data/lib/sneakers/cli.rb

@@ -35,6 +35,10 @@ module Sneakers
 
       opts[:log] =  opts[:daemonize] ? 'sneakers.log' : STDOUT
 
+      if opts[:daemonize]
+        puts "*** DEPRACATED: self-daemonization '--daemonize' is considered a bad practice, which is why this feature will be removed in future versions. Please run Sneakers in front, and use things like upstart, systemd, or supervisor to manage it as a daemon."
+      end
+
 
       Sneakers.configure(opts)
 

data/lib/sneakers/metrics/newrelic_metrics.rb

@@ -0,0 +1,37 @@
+module Sneakers
+  module Metrics
+    class NewrelicMetrics
+
+      def self.eagent(eagent = nil)
+        @eagent = eagent || @eagent
+      end
+
+      def initialize()
+        #@connection = conn
+      end
+
+      def increment(metric)
+        record_stat metric, 1
+      end
+
+      def record_stat(metric, num)
+        stats(metric).record_data_point(num)
+      rescue Exception => e
+        puts "NewrelicMetrics#record_stat: #{e}"
+      end
+
+      def timing(metric, &block)
+        start = Time.now
+        block.call
+        record_stat(metric, ((Time.now - start)*1000).floor)
+      end
+
+      def stats(metric)
+        metric.gsub! "\.", "\/"
+        NewrelicMetrics.eagent::Agent.get_stats("Custom/#{metric}")
+      end
+
+    end
+  end
+end
+

data/lib/sneakers/queue.rb

@@ -28,8 +28,14 @@ class Sneakers::Queue
 
     handler = @handler_klass.new(@channel)
 
+    routing_key = @opts[:routing_key] || @name
+    routing_keys = [*routing_key]
+
     queue = @channel.queue(@name, :durable => @opts[:durable])
-    queue.bind(@exchange, :routing_key => @name)
+
+    routing_keys.each do |key|
+      queue.bind(@exchange, :routing_key => key)
+    end
 
     @consumer = queue.subscribe(:block => false, :ack => @opts[:ack]) do | hdr, props, msg | 
       worker.do_work(hdr, props, msg, handler)

data/lib/sneakers/version.rb

@@ -1,3 +1,3 @@
 module Sneakers
-  VERSION = "0.0.7"
+  VERSION = "0.1.0.pre"
 end

data/lib/sneakers/worker.rb

@@ -23,6 +23,7 @@ module Sneakers
       @should_ack =  opts[:ack]
       @timeout_after = opts[:timeout_job_after]
       @pool = pool || Thread.pool(opts[:threads]) # XXX config threads
+      @call_with_params = respond_to?(:work_with_params)
 
       @queue = queue || Sneakers::Queue.new(
         queue_name,
@@ -39,7 +40,7 @@ module Sneakers
 
     def publish(msg, routing)
       return unless routing[:to_queue]
-      @queue.exchange.publish(msg, :routing_key => QueueName.new(routing[:to_queue], @opts).to_s)
+      @queue.exchange.publish(msg, :routing_key => Support::QueueName.new(routing[:to_queue], @opts).to_s)
     end
 
     def do_work(hdr, props, msg, handler)
@@ -53,7 +54,11 @@ module Sneakers
           metrics.increment("work.#{self.class.name}.started")
           Timeout.timeout(@timeout_after) do
             metrics.timing("work.#{self.class.name}.time") do
-              res = work(msg)
+              if @call_with_params
+                res = work_with_params(msg, hdr, props)
+              else
+                res = work(msg)
+              end
             end
           end
         rescue Timeout::Error

data/sneakers.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
   gem.add_dependency "serverengine"
-  gem.add_dependency "bunny", ">= 0.10.0"
+  gem.add_dependency "bunny", "~> 1.0.7"
   gem.add_dependency "thread"
   gem.add_dependency "thor"
 

data/spec/sneakers/queue_spec.rb

@@ -9,8 +9,8 @@ describe Sneakers::Queue do
   end
 
   describe "#subscribe" do
-    it "should setup a bunny queue according to configuration values" do
-      q = Sneakers::Queue.new("downloads", 
+    let :queue_vars do
+      {
         :prefetch => 25,
         :durable => true,
         :ack => true,
@@ -18,22 +18,40 @@ describe Sneakers::Queue do
         :vhost => '/',
         :exchange => "sneakers",
         :exchange_type => :direct
-      )
-      mkbunny = Object.new
-      mkchan = Object.new
-      mkex = Object.new
-      mkqueue = Object.new
-
-      mock(mkbunny).start {}
-      mock(mkbunny).create_channel{ mkchan }
-      mock(Bunny).new(anything, :vhost => '/', :heartbeat => 2){ mkbunny }
-
-      mock(mkchan).prefetch(25)
-      mock(mkchan).exchange("sneakers", :type => :direct, :durable => true){ mkex }
-      mock(mkchan).queue("downloads", :durable => true){ mkqueue }
-
-      mock(mkqueue).bind(mkex, :routing_key => "downloads")
-      mock(mkqueue).subscribe(:block => false, :ack => true)
+      }
+    end
+
+    before do
+      @mkbunny = Object.new
+      @mkchan = Object.new
+      @mkex = Object.new
+      @mkqueue = Object.new
+
+      mock(@mkbunny).start {}
+      mock(@mkbunny).create_channel{ @mkchan }
+      mock(Bunny).new(anything, :vhost => '/', :heartbeat => 2){ @mkbunny }
+
+      mock(@mkchan).prefetch(25)
+      mock(@mkchan).exchange("sneakers", :type => :direct, :durable => true){ @mkex }
+      mock(@mkchan).queue("downloads", :durable => true){ @mkqueue }
+    end
+
+    it "should setup a bunny queue according to configuration values" do
+      q = Sneakers::Queue.new("downloads", queue_vars)
+
+      mock(@mkqueue).bind(@mkex, :routing_key => "downloads")
+      mock(@mkqueue).subscribe(:block => false, :ack => true)
+
+      q.subscribe(Object.new)
+    end
+
+    it "supports multiple routing_keys" do
+      q = Sneakers::Queue.new("downloads",
+                              queue_vars.merge(:routing_key => ["alpha", "beta"]))
+
+      mock(@mkqueue).bind(@mkex, :routing_key => "alpha")
+      mock(@mkqueue).bind(@mkex, :routing_key => "beta")
+      mock(@mkqueue).subscribe(:block => false, :ack => true)
 
       q.subscribe(Object.new)
     end

data/spec/sneakers/sneakers_spec.rb

@@ -1,6 +1,13 @@
 require 'spec_helper'
 require 'sneakers'
 
+class EnvWorker
+  include Sneakers::Worker
+  from_queue 'defaults'
+
+  def work(msg)
+  end
+end
 
 
 describe Sneakers do
@@ -33,6 +40,19 @@ describe Sneakers do
     end
   end
 
+  describe '.not_environmental!' do
+    it 'should ignore environment (RACK_ENV) for all workers' do
+      Sneakers.configure(:env => 'production')
+      Sneakers.not_environmental!
+      EnvWorker.new.queue.name.must_equal('defaults')
+    end
+
+    it 'should ignore environment (RACK_ENV) for all workers' do
+      Sneakers.configure(:env => 'production')
+      EnvWorker.new.queue.name.must_equal('defaults_production')
+    end
+  end
+
   describe '.clear!' do
     it 'must reset dirty configuration to default' do
       Sneakers::Config[:log].must_equal(STDOUT)

data/spec/sneakers/worker_spec.rb

@@ -91,6 +91,16 @@ class MetricsWorker
   end
 end
 
+class WithParamsWorker
+  include Sneakers::Worker
+  from_queue 'defaults',
+             :ack => true,
+             :timeout_job_after => 0.5
+
+  def work_with_params(msg, header, props)
+    msg
+  end
+end
 
 
 class TestPool
@@ -124,8 +134,10 @@ end
 describe Sneakers::Worker do
   before do
     @queue = Object.new
+    @exchange = Object.new
     stub(@queue).name { 'test-queue' }
     stub(@queue).opts { {} }
+    stub(@queue).exchange { @exchange }
 
     Sneakers.configure(:env => 'test', :daemonize => true, :log => 'sneakers.log')
     Sneakers::Worker.configure_logger(Logger.new('/dev/null'))
@@ -275,9 +287,8 @@ describe Sneakers::Worker do
   describe 'publish' do
     it 'should be able to publish a message from working context' do
       w = PublishingWorker.new(@queue, TestPool.new)
-      mock(w).publish('msg', :to_queue => 'target').once
+      mock(@exchange).publish('msg', :routing_key => 'target_test').once
       w.do_work(nil, nil, 'msg', nil)
-
     end
   end
 
@@ -338,4 +349,27 @@ describe Sneakers::Worker do
     end
   end
 
+
+
+  describe 'With Params' do
+    before do
+      @handler = Object.new
+      stub(@handler).acknowledge("tag")
+      stub(@handler).reject("tag")
+      stub(@handler).timeout("tag")
+      stub(@handler).error("tag", anything)
+      stub(@handler).noop("tag")
+
+      @header = Object.new
+      stub(@header).delivery_tag { "tag" }
+
+      @w = WithParamsWorker.new(@queue, TestPool.new)
+      mock(@w.metrics).timing("work.WithParamsWorker.time").yields.once
+    end
+
+    it 'should call work_with_params and not work' do
+      mock(@w).work_with_params(:ack, @header, {:foo => 1}).once
+      @w.do_work(@header, {:foo => 1 }, :ack, @handler)
+    end
+  end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sneakers
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 0.1.0.pre
+  prerelease: 6
 platform: ruby
 authors:
 - Dotan Nahum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-03 00:00:00.000000000 Z
+date: 2014-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverengine
@@ -32,17 +32,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.7
 - !ruby/object:Gem::Dependency
   name: thread
   requirement: !ruby/object:Gem::Requirement
@@ -212,11 +212,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
+- ROADMAP.md
 - Rakefile
 - bin/sneakers
 - examples/benchmark_worker.rb
@@ -231,6 +233,7 @@ files:
 - lib/sneakers/concerns/metrics.rb
 - lib/sneakers/handlers/oneshot.rb
 - lib/sneakers/metrics/logging_metrics.rb
+- lib/sneakers/metrics/newrelic_metrics.rb
 - lib/sneakers/metrics/null_metrics.rb
 - lib/sneakers/metrics/statsd_metrics.rb
 - lib/sneakers/publisher.rb
@@ -268,9 +271,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23