resque-serializable 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.project

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in resque-serializable.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/resque-serializable.rb

@@ -0,0 +1,9 @@
+require "resque-serializable/version"
+require "resque-serializable/job"
+require 'yaml'
+
+module Resque #:nodoc:
+  class Job #:nodoc:
+    include Resque::Serializable::Job
+  end
+end

data/lib/resque-serializable/job.rb

@@ -0,0 +1,64 @@
+module Resque
+  module Serializable
+    module Job
+    
+      def self.included(base)
+    
+        base.class_eval do
+          
+          # Alias Resque's Job.perform to Job.perform_after_deserializing
+          alias_method :perform_after_deserializing, :perform
+          
+          # Deserializes serialized arguments from YAML.
+          # Looks for an argument of type Hash with a key :serialize and deserializes its value.
+          
+          def perform
+            args.collect! do |arg|
+              if arg.is_a?(Hash) && arg.key?('serialize')
+                if arg['serialize'].is_a?(Hash)
+                  arg['serialize'].values.collect{|a| YAML::load(a) }
+                elsif arg['serialize'].is_a?(Array)
+                  arg['serialize'].collect{|a| YAML::load(a) }
+                end
+              else
+                arg
+              end
+            end
+            args.flatten!
+            perform_after_deserializing
+          end # perform
+          
+          class << self
+            
+            # Alias Resque's Job.create to Job.create_after_serializing
+            alias_method :create_after_serializing, :create
+            
+            # Attempts to serialize job arguments before creating a new job, by looking for
+            # an argument of type Hash with a key :serialize and serializing its value to YAML.
+            #
+            # @param [Symbol] Current Resque job's queue name
+            # @param [Class] Resque job worker class
+            # @param [Array] anonymous arguments passed to the Resque worker class. A hash argument with key :serialize will be serialized to YAML
+            def create(queue, klass, *args)
+              args.collect! do |arg|
+                if arg.is_a?(Hash) && arg.key?(:serialize)
+                  if arg[:serialize].is_a?(Hash)
+                    arg[:serialize].each{|k,v| arg[:serialize][k] = v.to_yaml }
+                  elsif arg[:serialize].is_a?(Array)
+                    arg[:serialize].collect!{|a| a.to_yaml }
+                  end
+                end
+                arg
+              end
+              create_after_serializing(queue, klass, *args)
+            end #create
+  
+          end #class << self
+          
+        end# base.class_eval
+      
+      end #self.included
+    
+    end #Job
+  end
+end

data/lib/resque-serializable/version.rb

@@ -0,0 +1,5 @@
+module Resque
+  module Serializable
+    VERSION = "0.0.2"
+  end
+end

data/resque-serializable.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "resque-serializable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "resque-serializable"
+  s.version     = Resque::Serializable::VERSION
+  s.authors     = ["Zohar Arad"]
+  s.email       = ["zohar@zohararad.com"]
+  s.homepage    = ""
+  s.summary     = %q{Serialize & Unserialize Resque job arguments}
+  s.description = %q{Adds support for serializable arguments in a Resque job. Serializable arguments can be passed to a Resque job via a Hash containing a :serialize key. If such arguments are found, they will be deserialized before calling the job's perform method}
+
+  s.rubyforge_project = "resque-serializable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "resque", "~>1.19.0"
+end

data/test/redis-test.conf

@@ -0,0 +1,115 @@
+# Redis configuration file example
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize yes
+
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./test/redis-test.pid
+
+# Accept connections on the specified port, default is 6379
+port 9736
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./test/
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+
+# slaveof <masterip> <masterport>
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+
+# maxmemory <bytes>
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes

data/test/serializable_job_args_test.rb

@@ -0,0 +1,43 @@
+dir = File.dirname(File.expand_path(__FILE__))
+require dir + '/test_helper'
+
+class SerializableJobArgsTest < Test::Unit::TestCase
+  def setup
+    $job_args = nil
+    Resque.redis.flushall
+    @worker = Resque::Worker.new(:test)
+  end
+
+  def test_version
+    major, minor, patch = Resque::Version.split('.')
+    assert_equal 1, major.to_i
+    assert minor.to_i >= 19
+  end
+
+  def test_normal_job_args
+    Resque.enqueue(MockJob,1,'hello',{'key' => 'value'})
+    @worker.process
+    assert_equal 1, $job_args['i'], 'integer argument should be equal 1'
+    assert_equal "hello", $job_args['s'], 'string argument should be equal "hello"'
+    assert $job_args['h'].is_a?(Hash), 'hash argument should be a hash'
+    assert_equal 'value', $job_args['h']['key'], 'hash "key" property should equal "value"'
+  end
+  
+  def test_serializable_job_args_array
+    Resque.enqueue(MockJob,1,'hello',:serialize => [{'key' => 'value'}])
+    @worker.process
+    assert_equal 1, $job_args['i'], 'integer argument should be equal 1'
+    assert_equal "hello", $job_args['s'], 'string argument should be equal "hello"'
+    assert $job_args['h'].is_a?(Hash), 'hash argument should be a hash'
+    assert_equal 'value', $job_args['h']['key'], 'hash "key" property should equal "value"'
+  end
+  
+  def test_serializable_job_args_hash
+    Resque.enqueue(MockJob,1,'hello',:serialize => {'some_hash' => {'key' => 'value'}})
+    @worker.process
+    assert_equal 1, $job_args['i'], 'integer argument should be equal 1'
+    assert_equal "hello", $job_args['s'], 'string argument should be equal "hello"'
+    assert $job_args['h'].is_a?(Hash), 'hash argument should be a hash'
+    assert_equal 'value', $job_args['h']['key'], 'hash "key" property should equal "value"'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,41 @@
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+$TESTING = true
+
+require 'rubygems'
+require 'test/unit'
+require 'resque'
+
+require 'resque-serializable'
+require dir + '/test_jobs'
+
+##
+# make sure we can run redis
+if !system("which redis-server")
+  puts '', "** can't find `redis-server` in your path"
+  puts "** try running `sudo rake install`"
+  abort ''
+end
+
+##
+# start our own redis when the tests start,
+# kill it when they end
+at_exit do
+  next if $!
+
+  if defined?(MiniTest)
+    exit_code = MiniTest::Unit.new.run(ARGV)
+  else
+    exit_code = Test::Unit::AutoRunner.run
+  end
+
+  pid = `ps -e -o pid,command | grep [r]edis-test`.split(" ")[0]
+  puts "Killing test redis server..."
+  `rm -f #{dir}/dump.rdb`
+  Process.kill("KILL", pid.to_i)
+  exit exit_code
+end
+
+puts "Starting redis for testing at localhost:9736..."
+`redis-server #{dir}/redis-test.conf`
+Resque.redis = '127.0.0.1:9736'

data/test/test_jobs.rb

@@ -0,0 +1,14 @@
+# Mock job for unit tests
+class MockJob #:nodoc:
+
+  @queue = :test
+
+  def self.perform(i,s,h)
+    $job_args = {
+      'i' => i,
+      's' => s,
+      'h' => h
+    }
+  end
+
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: resque-serializable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Zohar Arad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &70114808583480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70114808583480
+description: Adds support for serializable arguments in a Resque job. Serializable
+  arguments can be passed to a Resque job via a Hash containing a :serialize key.
+  If such arguments are found, they will be deserialized before calling the job's
+  perform method
+email:
+- zohar@zohararad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/resque-serializable.rb
+- lib/resque-serializable/job.rb
+- lib/resque-serializable/version.rb
+- resque-serializable.gemspec
+- test/redis-test.conf
+- test/serializable_job_args_test.rb
+- test/test_helper.rb
+- test/test_jobs.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+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: resque-serializable
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Serialize & Unserialize Resque job arguments
+test_files:
+- test/redis-test.conf
+- test/serializable_job_args_test.rb
+- test/test_helper.rb
+- test/test_jobs.rb