resque-access_worker_from_job 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kali Donovan
+
+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.rdoc

@@ -0,0 +1,32 @@
+= Resque-AccessWorkerFromJob
+
+Small plugin appending the calling worker to the argument list received by the +perform+ method of Resque jobs.  Developed against Resque 1.8.0.
+
+Purpose: this allows jobs to access shared sockets in the parent worker.
+
+=== Warning
+Be careful to note that each job forks before running, so ivars will be a COPY and, if changed,
+their changes won't persist into the next job's perform method.  However, since sockets ARE persisted, this
+allows multiple jobs to share a single persistent socket kept alive in the worker.
+
+=== Only running in certain workers
+As additional functionality, this plugin can also abort a job gracefully if it's picked up by the wrong worker 
+class, which is useful if you've subclassed Resque::Worker to add your own functionality and need to ensure
+your jobs aren't accidentally run against the original superclass.
+
+== Usage
+To use, add 
+
+ extend Resque::Plugins::AccessWorkerFromJob
+
+to the class with the perform method.
+
+To implement the additional requiring-certain-worker-class feature, add 
+
+ self.required_worker_class = 'ClassName'
+
+as well.
+
+== Copyright
+
+Copyright (c) 2010 Kali Donovan. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "resque-access_worker_from_job"
+    gem.summary = %Q{Resque plugin to allow jobs access to their calling worker at runtime.}
+    gem.description = %Q{By allowing multiple jobs to share a single socket, which is persisted over the life of the worker, this plugin is an important building block for implementing a Resque-based service send background iPhone messages via the Apple Push Notification servers.}
+    gem.email = "kali.donovan@gmail.com"
+    gem.homepage = "http://github.com/kdonovan/resque-access_worker_from_job"
+    gem.authors = ["Kali Donovan"]
+    gem.add_dependency "resque", ">1.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "resque-access_worker_from_job #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/lib/resque-access_worker_from_job.rb

@@ -0,0 +1 @@
+require 'lib/resque/plugins/access_worker_from_job'

data/lib/resque/plugins/access_worker_from_job.rb

@@ -0,0 +1,46 @@
+module Resque
+  module Plugins
+    # Adds a Resque plugin to allow jobs to access the worker running them as the last argument in the call
+    # to +perform+.  Purpose: this allows jobs to access shared sockets in the parent worker.
+    #
+    # Be careful to note that each job forks before running, however, so ivars will be a COPY and, if changed,
+    # their changes won't persist into the next job's perform method.  However, since sockets ARE persisted, this
+    # allows multiple jobs to share a single persistent socket kept alive in the worker.
+    #
+    # As additional functionality, this plugin can also abort a job gracefully if it's picked up by the wrong worker 
+    # class, which is useful if you've subclassed Resque::Worker to add your own functionality and need to ensure
+    # your jobs aren't accidentally run against the original superclass.
+    #
+    # To use, add 
+    #
+    #   extend Resque::Plugins::AccessWorkerFromJob
+    #
+    # to the class with the perform method.
+    # 
+    # To implement the additional requiring-certain-worker-class feature, add 
+    #
+    #   self.required_worker_class = 'ClassName'
+    #
+    # as well.
+    module AccessWorkerFromJob
+      attr_accessor :required_worker_class
+      
+      # Overrides args to append the worker when returning the list of args represented in this job's payload.
+      def args
+        @payload['args'] + [worker]
+      end
+      
+      # Abort gracefully if picked up by the wrong worker, so message remains in queue to be sent
+      def before_perform_ensure_proper_worker(*args)
+        worker = args.last
+        if required_worker_class && worker.class.name != required_worker_class
+          raise ::Resque::Job::DontPerform
+        end
+
+        # TODO: Make sure this keeps the job in the queue! seems to just skip it and remove from queue, so it'll never be performed
+        # raise ::Resque::Job::DontPerform
+      end
+      
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/../lib/resque-access_worker_from_job.rb"

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: resque-access_worker_from_job
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kali Donovan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: "1.8"
+    version: 
+description: By allowing multiple jobs to share a single socket, which is persisted over the life of the worker, this plugin is an important building block for implementing a Resque-based service send background iPhone messages via the Apple Push Notification servers.
+email: kali.donovan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/resque-access_worker_from_job.rb
+- lib/resque/plugins/access_worker_from_job.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/kdonovan/resque-access_worker_from_job
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Resque plugin to allow jobs access to their calling worker at runtime.
+test_files: []
+