line_up 0.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 Bukowskis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# LineUp
+
+With LineUp you can enqueue Resque jobs in arbitrary Redis namespaces.
+
+[Resque](https://github.com/defunkt/resque) uses a [Set](http://redis.io/commands#set) and a [List](http://redis.io/commands#list) to keep track of all Queues and their Jobs.
+
+* The Set is usually located at `resque:queues` and contains a list of (lower-cased, underscored) Strings, each representing a queue name
+* Each queue is a List located at `resque:queue:my_job` (with `my_job` as queue name for `MyJob`-jobs in this example)
+* Each job inside of a queue is a JSON or Marshal'ed Hash with the keys `class` and `args`, for example `{ class: 'MyJob', args: [123, some: thing] }.to_json`
+
+Depending on how you configure the Redis backend for Resque, you will end up in a different namespace:
+
+* If you use `Resque.redis = Redis::Namespace.new(:bob, ...)`, Resque [detects](https://github.com/defunkt/resque/blob/master/lib/resque.rb#L55) that you passed in an `Redis::Namespace` object and will __not__ add any additional namespace. So the queue Set in this example will be located at `bob:queues`
+* Any other `Redis.new`-compatible object will get the `resque`-namespace added. So `Resque.redis = Redis.new(...)` will cause the queue Set to be located at `resque:queues`
+
+If you use multiple applications, you should make sure that each of them has its own namespace. You would normally achieve that with `Resque.redis = Redis::Namespace.new('myapp:resque', ...)` so that the queue Set would be located at `myapp:resque:queues`.
+
+So far so good, __but__ there is no way to enqueue a Job for an application from inside another namespace, say `otherapp:resque:queues`, without maintaining an additional connection to Redis in the other app's namespace. So far, the only solution has been to share the `resque:queues` namespace between all applications and have separate queue-names, such as `myapp-myjob` and `otherapp-myjob`, but that is not really separating namespaces.
+
+That's where LineUp comes in, it doesn't even need Resque. It goes right into Redis (scary huh?), just as Resque does [internally](https://github.com/defunkt/resque/blob/master/lib/resque/queue.rb).
+
+# Examples
+
+### Setup
+
+If you use the `Raidis` gem, you _do not need_ any setup. Otherwise, a manual setup would look like this:
+
+```ruby
+redis = Redis::Namespace.new 'myapp:resque', redis: Redis.new(...)
+
+Resque.redis = redis
+LineUp.redis = redis
+````
+
+### Usage
+
+With the setup above, Resque lies in the `myapp:resque`-namespace. So you can enqeueue jobs to the very same application by using `Resque.enqueue(...)`.
+
+This is how you can enqueue a job for another applications:
+
+```ruby
+if LineUp.push :otherApp, :SomeJob, 12345, some: thing
+# Yey, everything went well
+else
+# The "Trouble"-gem, has been notified and I can process the failure if I like
+end
+```
+
+This will enqueue to `other_app:resque:some_job` with arguments `[12345, { 'some' => 'thing' }]` and make sure that the `other_app:resque:queues` Set references the queue List.
+
+# Gotchas
+
+* `Resque.redis` MUST respond to a method called `#namespace` which takes a block and yields a new namespace. See [this commit](https://github.com/defunkt/redis-namespace/pull/50). Currently LineUp [requires a non-rubygems fork](https://github.com/bukowskis/line_up/blob/master/Gemfile) of `Redis::Namespace` in order to be able to use this cutting-edge method.
+* Currently the jobs are encoded using `MultiJson` only, not `Marshal`, feel free to commit a patch if you need the latter
+* You cannot share the `resque` root namespace. LineUp defaults to the `application:resque` namespace (because that's the only scenario I can think of that would make you want to use LineUp in the first place :)

data/lib/line_up/configuration.rb

@@ -0,0 +1,49 @@
+require 'logger'
+
+module LineUp
+  class Configuration
+    attr_accessor :logger, :redis
+
+    def initialize(options={})
+      @logger = options[:logger] || default_logger
+      @redis  = options[:redis]  || default_redis
+    end
+
+    private
+
+    def default_logger
+      if defined?(Rails)
+        Rails.logger
+      else
+        Logger.new(STDOUT)
+      end
+    end
+
+    def default_redis
+      return Raidis.redis if defined?(Raidis)
+      return Resque.redis if defined?(Resque)
+      Redis::Namespace.new nil
+    end
+  end
+end
+
+module LineUp
+
+  # Public: Returns the the Configuration instance.
+  #
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  # Public: Yields the Configuration instance.
+  #
+  def self.configure(&block)
+    yield config
+  end
+
+  # Public: Reset the Configuration (useful for testing)
+  #
+  def self.reset!
+    @config = nil
+  end
+end

data/lib/line_up/job.rb

@@ -0,0 +1,23 @@
+require 'line_up/string_extensions'
+require 'multi_json'
+
+module LineUp
+  class Job
+
+    attr_reader :klass, :args
+
+    def initialize(klass, *args)
+      @klass = klass
+      @args = args
+    end
+
+    def encode
+      MultiJson.dump class: klass.to_s, args: args
+    end
+
+    def queue_name
+      StringExtensions.underscore(klass)
+    end
+
+  end
+end

data/lib/line_up/string_extensions.rb

@@ -0,0 +1,16 @@
+module LineUp
+  class StringExtensions
+
+    # See https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L90
+    def self.underscore(word)
+      word = word.to_s
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+
+  end
+end

data/lib/line_up/version.rb

@@ -0,0 +1,9 @@
+module LineUp
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
+end

data/lib/line_up.rb

@@ -0,0 +1,38 @@
+require 'trouble'
+
+require 'line_up/configuration'
+require 'line_up/job'
+
+module LineUp
+  RedisNotConfiguredError = Class.new(RuntimeError)
+
+  def self.push(application, jobclass, *args)
+    redis_for application do |redis|
+      job = Job.new jobclass, *args
+      redis.sadd 'queues', job.queue_name
+      redis.rpush "queue:#{job.queue_name}", job.encode
+    end
+    log caller, application, jobclass, *args
+    true
+  rescue Exception => exception
+    Trouble.notify exception, caller: caller[1], message: "LineUp could not enqueue a Job", code: :enqueue_failed, redis: config.redis.inspect, application: application.inspect, job: jobclass.inspect, args: args.inspect
+    false
+  end
+
+  private
+
+  def self.redis_for(application, &block)
+    config.redis.namespace "#{StringExtensions.underscore(application)}:resque", &block
+  end
+
+  def self.log(caller, application, jobclass, *args)
+    return unless config.logger
+    rows = ['LINEUP ENQUEUED A JOB']
+    rows << "   | Location:    #{caller.first}"
+    rows << "   | Application: #{application.inspect}"
+    rows << "   | Job Class:   #{jobclass.inspect}"
+    rows << "   \\ Arguments:  #{args.inspect}\n"
+    config.logger.debug rows.join("\n")
+  end
+
+end

data/spec/lib/line_up_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+
+describe LineUp do
+
+  let(:application) { :otherApp }
+  let(:job)         { :SendEmail }
+  let(:args)        { [123, some: :thing] }
+  let(:redis)       { $raw_redis }
+  let(:logger)      { mock(:logger) }
+
+  let(:lineup) { LineUp }
+
+  describe '.push' do
+    it 'returns true if successful' do
+      lineup.push(application, job, *args).should be_true
+    end
+
+    it 'registers the queue' do
+      lineup.push application, job, *args
+      queues = redis.smembers('other_app:resque:queues').should == %w{ send_email }
+    end
+
+    it 'enqueues the job' do
+      lineup.push application, job, *args
+      jobs = redis.lrange('other_app:resque:queue:send_email', 0, -1)
+      jobs.size.should == 1
+      MultiJson.load(jobs.first).should == { 'class' => 'SendEmail', 'args' => [123, 'some' => 'thing'] }
+    end
+
+    context 'with a Logger' do
+      before do
+        lineup.config.logger = logger
+      end
+
+      it 'logs the enqueueing and returns true' do
+        logger.should_receive(:debug) do |string|
+          string.should include('LINEUP ENQUEUED')
+          string.should include('line_up_spec.rb')
+          string.should include(':otherApp')
+          string.should include(':SendEmail')
+          string.should include('[123, {:some=>:thing}]')
+        end
+        lineup.push(application, job, *args).should be_true
+      end
+    end
+
+    context 'when the key for the Queue Set is occupied by the wrong data format' do
+      before do
+        redis.set 'other_app:resque:queues', :anything_but_a_list
+      end
+
+      it 'catches the error and returns false' do
+        Trouble.should_receive(:notify) do |exception, metadata|
+          exception.should be_instance_of Redis::CommandError
+          metadata[:code].should == :enqueue_failed
+          metadata[:application].should == ':otherApp'
+          metadata[:job].should == ':SendEmail'
+          metadata[:args].should == '[123, {:some=>:thing}]'
+          metadata[:caller].should include('line_up_spec.rb')
+        end
+        lineup.push(application, job, *args).should be_false
+      end
+    end
+
+    context 'when the key for the List Job Queue is occupied by the wrong data format' do
+      before do
+        redis.set 'other_app:resque:queue:send_email', :anything_but_a_list
+      end
+
+      it 'catches the error and returns false' do
+        Trouble.should_receive(:notify) do |exception, metadata|
+          exception.should be_instance_of Redis::CommandError
+          metadata[:code].should == :enqueue_failed
+          metadata[:application].should == ':otherApp'
+          metadata[:job].should == ':SendEmail'
+          metadata[:args].should == '[123, {:some=>:thing}]'
+          metadata[:caller].should include('line_up_spec.rb')
+        end
+        lineup.push(application, job, *args).should be_false
+      end
+    end
+  end
+
+  describe '.config' do
+    before do
+      LineUp.reset!
+    end
+
+    it 'is an STDOUT logger' do
+      Logger.should_receive(:new).with(STDOUT).and_return logger
+      lineup.config.logger.should be logger
+    end
+
+    context 'with Rails' do
+      before do
+        ensure_module :Rails
+        Rails.stub!(:logger).and_return(logger)
+      end
+
+      it 'is the Rails logger' do
+        lineup.config.logger.should be Rails.logger
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+require 'redis-namespace'
+require 'line_up'
+
+def ensure_class_or_module(full_name, class_or_module)
+  full_name.to_s.split(/::/).inject(Object) do |context, name|
+    begin
+      context.const_get(name)
+    rescue NameError
+      if class_or_module == :class
+        context.const_set(name, Class.new)
+      else
+        context.const_set(name, Module.new)
+      end
+    end
+  end
+end
+
+def ensure_module(name)
+  ensure_class_or_module(name, :module)
+end
+
+def ensure_class(name)
+  ensure_class_or_module(name, :class)
+end
+
+RSpec.configure do |config|
+
+  config.before do
+    $raw_redis = Redis.new(db: 14)
+    LineUp.config.redis = Redis::Namespace.new :myapp, redis: $raw_redis
+    LineUp.config.logger = nil
+    Trouble.stub!(:notify)
+  end
+
+  config.after do
+    $raw_redis.flushdb
+    LineUp.reset!
+  end
+
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: line_up
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- bukowskis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trouble
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: No more need to maintain two separate redis connections when using namespaces.
+  LineUp does not even need Resque itself.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/line_up/configuration.rb
+- lib/line_up/job.rb
+- lib/line_up/string_extensions.rb
+- lib/line_up/version.rb
+- lib/line_up.rb
+- spec/lib/line_up_spec.rb
+- spec/spec_helper.rb
+- README.md
+- LICENSE
+homepage: https://github.com/bukowskis/line_up
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --encoding
+- UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Enqueue Resque Jobs directly via Redis so that you can choose the namespace
+  yourself
+test_files: []