afterparty 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: d5a18d9460144527504869b72c7a377ce2c6eda0
+  data.tar.gz: 4d9b52a88c5fea21d37da73b1a13f5f5bf180c9e
+!binary "U0hBNTEy":
+  metadata.gz: d6323eb6eb7a72b1090207d498ae02890dbfca347bdc37414453f67441725e966b4205651d53d4756e15ce7a786ff1a1058c98572439c67e931ab0f150ce70c7
+  data.tar.gz: 1888cd7d556ee3f5164935ac9fb7a9b57dcf9fb1808ff8eae57315bd8175f3080e2a1dca599437bbf87770f11acc48b598fd62a1272a4c8077f0c7385304d9a1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+services:
+  - redis-server

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in afterparty.gemspec
+gemspec
+gem 'rspec'
+gem 'rails', github: "rails/rails", branch: "jobs", tag: "v4.0.0.rc1"
+gem 'awesome_print'
+gem 'guard-rspec'
+gem 'ruby_gntp'
+gem 'redis'

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Hank Stoever
+
+MIT License
+
+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,57 @@
+# Afterparty
+
+A Rails 4 compatible queue with support for executing jobs in the future and serialization with Redis.
+
+## Installation
+
+Make sure you've installed [redis](http://redis.io) on your machine.
+
+Add this line to your application's Gemfile:
+
+~~~Ruby
+gem 'afterparty'
+~~~
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install afterparty
+
+In your desired application environment, like `application.rb`:
+
+~~~Ruby
+config.queue = Afterparty::RedisQueue.new
+~~~
+
+## Usage
+
+A `job` is a ruby object with a `run` method.
+
+~~~Ruby
+class Job
+  def run
+    puts "Hello!"
+  end
+end
+~~~
+
+Then add it to the queue at any time.
+
+~~~Ruby
+Rails.queue << Job.new
+~~~
+
+If your job responds to an `execute_at` method, the queue will wait to process that job until the specified time.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add a test in `spec/redis_queue_spec.rb`
+4. Make sure tests pass when you run `rake`
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/afterparty.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'afterparty/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "afterparty"
+  spec.version       = Afterparty::VERSION
+  spec.authors       = ["Hank Stoever"]
+  spec.email         = ["hstove@gmail.com"]
+  spec.description   = %q{Rails 4 compatible queue with support for executing jobs later.}
+  spec.summary       = %q{Rails 4 compatible queue with support for executing jobs later.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "redis"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/afterparty/queue_helpers.rb

@@ -0,0 +1,67 @@
+module Afterparty
+  module QueueHelpers
+    def [] namespace
+      @temp_namespace = namespace
+    end
+
+    def redis_queue_name
+      "afterparty_#{@temp_namespace || @options[:namespace]}_queue"  
+    end
+
+    def clear
+      redis_call :del
+    end
+
+    def redis_call command, *args
+      result = Afterparty.redis.send(command, redis_queue_name, *args)
+      @temp_namespace = nil
+      result
+    end
+
+    def async_redis_call &block
+      Afterparty.redis.pipelined &block
+    end
+
+    def jobs
+      _jobs = redis_call(:zrange, 0, -1)
+      _jobs.each_with_index do |job, i|
+        _jobs[i] = Marshal.load(job)
+      end
+      _jobs
+    end
+
+    def jobs_with_scores
+      redis_call :zrange, 0, -1, {withscores: true}
+    end
+
+    def valid_jobs
+      redis_call :zrangebyscore, 0, Time.now.to_i
+    end
+
+    def jobs_empty?
+      count = total_jobs_count
+      # ap count
+      count == 0
+    end
+
+    def total_jobs_count
+      redis_call(:zcount, "-inf", "+inf")
+    end
+
+    def redis
+      @@redis
+    end
+
+    private
+
+    # returns true if job has an :execute_at value
+    def job_valid? job
+      job.respond_to?(:execute_at) && !job.execute_at.nil?
+    end
+
+    # return timestamp of :execute_at or current time
+    def queue_time job
+      time = job_valid?(job) ? job.execute_at.to_i : Time.now.to_i
+    end
+  end
+end

data/lib/afterparty/redis_queue.rb

@@ -0,0 +1,57 @@
+module Afterparty
+  class RedisQueue
+    attr_accessor :redis, :options, :temp_namespace, :consumer
+    include Afterparty::QueueHelpers
+
+    def initialize options={}, consumer_options={}
+      @consumer = ThreadedQueueConsumer.new(self, consumer_options).start
+      @options = options
+      @options[:namespace] ||= "default"
+      @options[:sleep] ||= 5
+      @mutex = Mutex.new
+    end
+
+    def push job
+      @mutex.synchronize do
+        return nil if job.nil?
+        async_redis_call{ redis_call :zadd, queue_time(job), Marshal.dump(job) }
+        @consumer.start unless @consumer.thread.alive?
+        @temp_namespace = nil
+      end
+    end
+    alias :<< :push
+    alias :eng :push
+
+    def pop
+      @mutex.synchronize do
+        while true do
+          if jobs_empty?
+            @consumer.shutdown
+          elsif !(_jobs = valid_jobs).empty?
+            job_dump = _jobs[0]
+            async_redis_call do
+              redis_call :zrem, job_dump
+              @temp_namespace = "completed"
+              redis_call :zadd, Time.now.to_i, job_dump
+            end
+            return Marshal.load(job_dump)
+          end
+          sleep(@options[:sleep])
+        end
+      end
+    end
+  end
+
+  class TestRedisQueue < RedisQueue
+    attr_accessor :completed_jobs
+    
+    def initialize opts={}, consumer_opts={}
+      super
+      @completed_jobs = []
+      @exceptions = []
+    end
+    def handle_exception job, exception
+      @exceptions << [job, exception]
+    end
+  end
+end

data/lib/afterparty/threaded_queue_consumer.rb

@@ -0,0 +1,58 @@
+module Afterparty  
+
+  # inspired by the rails 4 implementation: 
+  # https://github.com/rails/rails/blob/jobs/activesupport/lib/active_support/queueing.rb
+
+  # The threaded consumer will run jobs in a background thread in
+  # development mode or in a VM where running jobs on a thread in
+  # production mode makes sense.
+  #
+  # When the process exits, the consumer pushes a nil onto the
+  # queue and joins the thread, which will ensure that all jobs
+  # are executed before the process finally dies.
+  class ThreadedQueueConsumer
+    attr_accessor :logger, :thread
+
+    def initialize(queue, options = {})
+      @queue = queue
+      @logger = options[:logger]
+      @fallback_logger = Logger.new($stderr)
+    end
+
+    def start
+      @thread = Thread.new { consume }
+      self
+    end
+
+    def shutdown
+      @queue.push nil
+      @thread.join
+    end
+
+    def drain
+      while job = @queue.pop(true)
+        job.run
+      end
+    rescue ThreadError
+    end
+
+    def consume
+      while job = @queue.pop
+        if @queue.respond_to? :completed_jobs
+          @queue.completed_jobs << job
+        end
+        run job
+      end
+    end
+
+    def run(job)
+      job.run
+    rescue Exception => exception
+      handle_exception job, exception
+    end
+
+    def handle_exception(job, exception)
+      (logger || @fallback_logger).error "Job Error: #{job.inspect}\n#{exception.message}\n#{exception.backtrace.join("\n")}"
+    end
+  end
+end

data/lib/afterparty/version.rb

@@ -0,0 +1,3 @@
+module Afterparty
+  VERSION = "0.0.2"
+end

data/lib/afterparty.rb

@@ -0,0 +1,14 @@
+require 'logger'
+require 'afterparty/queue_helpers'
+require 'afterparty/redis_queue'
+Dir[File.expand_path('../afterparty/*', __FILE__)].each { |f| require f }
+
+
+module Afterparty
+  def self.redis
+    @@redis
+  end
+  def self.redis=(redis)
+    @@redis = redis
+  end
+end

data/spec/helpers.rb

@@ -0,0 +1,28 @@
+module Afterparty
+  module QueueTestHelpers
+
+    def test_job later=false, &block
+      job = block ? TestJob.new(block) : TestJob.new
+      job.execute_at = Time.now + (later) if later
+      @block = block
+      job
+    end
+
+    def chill seconds
+      t = Time.now
+      while Time.now < (t + seconds); end
+    end
+  end
+end
+
+class TestJob
+  attr_accessor :execute_at
+
+  def initialize &block
+    @block = block
+  end
+
+  def run
+    @block.call if @block
+  end
+end

data/spec/redis_queue_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+describe Afterparty::RedisQueue do
+  before do
+    require 'open-uri'
+    uri = URI.parse("redis://localhost:6379")
+    redis = Redis.new(:host => uri.host, :port => uri.port, :password => uri.password)
+    Afterparty.redis = redis
+    @q = Afterparty::TestRedisQueue.new({sleep: 0.5})
+  end
+
+  before :each do
+    @q.completed_jobs.clear
+    @q.clear
+    Afterparty.redis.quit
+  end
+
+  it "pushes nil without errors" do
+    @q.push(nil)
+    @q.jobs.should eq([])
+  end
+
+  it "adds items to the queue" do
+    @q.push(test_job)
+    @q.total_jobs_count.should eq(1)
+  end
+
+  it "executes the job" do
+    job = TestJob.new
+    @q.push(job)
+    complete.size.should eq(0)
+    chill(3)
+    complete.size.should eq(1)
+  end
+
+  it "removes items from the queue after running them" do
+    @q.push TestJob.new
+    chill(1)
+    @q.jobs.should_not include(@job)
+  end
+
+  it "doesn't execute jobs that execute in a while" do
+    job = TestJob.new
+    job.execute_at = Time.now + 200
+    @q.push job
+    chill(3)
+    complete.size.should eq(0)
+  end
+
+  it "waits the correct amount of time to execute a job" do
+    job = TestJob.new
+    job.execute_at = Time.now + 2
+    @q.push(job)
+    chill(8)
+    complete.size.should eq(1)
+  end
+
+  it "doesn't execute the job synchronously when added" do
+    job = test_job 100
+    t = Time.now
+    @q.push(job)
+    (Time.now - t).should <= 1
+  end
+
+  it "executes jobs in the right order" do
+    late_job = test_job 60*10
+    early_job = test_job
+    @q.push(late_job)
+    @q.push(early_job)
+    chill(3)
+    complete.size.should eq(1)
+    complete[0].execute_at.should be(nil)
+  end
+
+  class ErrorJob
+    attr_accessor :execute_at
+
+    def run
+      raise "hello"
+    end
+  end
+
+  def complete
+    @q.completed_jobs
+  end
+
+  def error_job later=nil
+    job = ErrorJob.new
+    job.execute_at = Time.now + later if later
+    job
+  end
+
+  def chill seconds
+    t = Time.now
+    while Time.now < (t + seconds); end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'awesome_print'
+require 'redis'
+require 'afterparty' # and any other gems you need
+require 'helpers'
+
+RSpec.configure do |config|
+  # some (optional) config here
+  config.include Afterparty::QueueTestHelpers
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: afterparty
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Hank Stoever
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Rails 4 compatible queue with support for executing jobs later.
+email:
+- hstove@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- afterparty.gemspec
+- dump.rdb
+- lib/afterparty.rb
+- lib/afterparty/queue_helpers.rb
+- lib/afterparty/redis_queue.rb
+- lib/afterparty/threaded_queue_consumer.rb
+- lib/afterparty/version.rb
+- spec/helpers.rb
+- spec/redis_queue_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Rails 4 compatible queue with support for executing jobs later.
+test_files:
+- spec/helpers.rb
+- spec/redis_queue_spec.rb
+- spec/spec_helper.rb
+has_rdoc: