djwrapper 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2012-09-29
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/djwrapper.rb
+lib/djwrapper/job.rb
+lib/djwrapper/background_process.rb
+lib/djwrapper/delayed_background_process.rb
+header.txt
+script/console
+script/destroy
+script/generate
+test/test_djwrapper.rb
+test/test_helper.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on djwrapper, see http://djwrapper.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,61 @@
+= djwrapper
+
+* http://github.com/cmdjohnson/djwrapper
+
+== DESCRIPTION:
+
+Wrapper gem for Delayed Job.
+
+== FEATURES/PROBLEMS:
+
+A job class that gives you some nifty methods:
+ - process! (immediately process this job)
+ - enqueue (wrap a Delayed::Job object around this job so it will be picked up by a worker process)
+ - log (log messages)
+ - time (pass a block and it will log the elapsed time)
+
+== SYNOPSIS:
+
+class Myjob < Djwrapper::DelayedBackgroundProcess
+    def self.process!(params = {})
+        # do stuff here ...
+    end
+end
+
+# Process the job immediately. Useful for testing purposes.
+Myjob.process!
+# Create a background job.
+Myjob.enqueue
+
+== REQUIREMENTS:
+
+ - delayed_job
+
+== INSTALL:
+
+ - sudo gem install djwrapper
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2012 Commander Johnson <commanderjohnson@gmail.com>
+
+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/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/djwrapper'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'djwrapper' do
+  self.developer 'Commander Johnson', 'commanderjohnson@gmail.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps           = [[ 'delayed_job', ">= 0.0.1" ]]
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/header.txt

@@ -0,0 +1,5 @@
+################################################################################
+# Written by Commander Johnson <commanderjohnson@gmail.com>
+# Year: 2012
+# Licensed under the MIT license
+################################################################################

data/lib/djwrapper/background_process.rb

@@ -0,0 +1,43 @@
+# -*- encoding : utf-8 -*-
+# -- begin header --
+################################################################################
+# Written by Commander Johnson <commanderjohnson@gmail.com>
+# Year: 2012
+# Licensed under the MIT license
+################################################################################# -- end header --
+module Djwrapper
+  class BackgroundProcess
+    ##############################################################################
+    # class methods
+    ##############################################################################
+    
+    def self.process!(params = {})
+      # Add code here that should be processed by every BackgroundProcess 
+      # right before it starts executing its own process! method.
+      log("started.")
+    end
+    
+    def self.log(str)
+      # TODO: uncomment this
+      # When Heroku properly acknowledges Rails.logger
+      # And stops thinking its nil
+      #Rails.logger.info("[#{Time.now.utc.utc}] Billing::BackgroundProcess: #{str}")
+    end
+    
+    def self.time
+      start = Time.now.utc
+      yield
+      delta = Time.now.utc - start
+      log("Finished in #{delta} seconds.")
+    end
+  
+    ##############################################################################
+    # constructor
+    ##############################################################################
+  
+    ##############################################################################
+    # instance methods
+    ##############################################################################
+   
+  end
+end

data/lib/djwrapper/delayed_background_process.rb

@@ -0,0 +1,27 @@
+# -*- encoding : utf-8 -*-
+# -- begin header --
+################################################################################
+# Written by Commander Johnson <commanderjohnson@gmail.com>
+# Year: 2012
+# Licensed under the MIT license
+################################################################################# -- end header --
+module Djwrapper
+  class DelayedBackgroundProcess < BackgroundProcess
+    ##############################################################################
+    # class methods
+    ##############################################################################
+    
+    def self.enqueue
+      Delayed::Job.enqueue(Billing::Job.new(self.name.to_s))
+    end
+    
+    ##############################################################################
+    # constructor
+    ##############################################################################
+  
+    ##############################################################################
+    # instance methods
+    ##############################################################################
+   
+  end
+end

data/lib/djwrapper/job.rb

@@ -0,0 +1,53 @@
+# -*- encoding : utf-8 -*-
+# -- begin header --
+################################################################################
+# Written by Commander Johnson <commanderjohnson@gmail.com>
+# Year: 2012
+# Licensed under the MIT license
+################################################################################# -- end header --
+module Djwrapper
+  class Job < Struct.new(:class_name, :params, :method_name)
+    ##############################################################################
+    # class methods
+    ##############################################################################
+    
+    ##############################################################################
+    # constructor
+    ##############################################################################
+  
+    ##############################################################################
+    # instance methods
+    ##############################################################################
+    
+    def perform
+      # default parameters
+      params ||= {}
+      method_name ||= "process!"
+      
+      ret = false
+      
+      #Rails.logger.info("Billing::Job: starting 'perform' method ...")
+      
+      raise "class_name must be a String!" unless class_name.is_a?(String)
+      raise "params must be a Hash!" unless params.is_a?(Hash)
+      
+      klazz = eval(class_name)
+      
+      # u kidding me? :'(
+      #>> Billing::DelayedBackgroundProcess.is_a?(Billing::DelayedBackgroundProcess)
+      #=> false
+
+      #raise "class #{klazz.to_s} must be subclass of ::Billing::BackgroundProcess" unless klazz.is_a?(Billing::BackgroundProcess)
+      
+      #Rails.logger.info("Billing::Job: Calling '#{method_name}' method on class #{klazz.to_s} with parameters: #{params}")
+
+      # dont wrap this in a begin rescue end block.
+      # it wont crash since it's a delayed job, and otherwise we could not ask DJ what the error was.
+      ret = klazz.send(method_name, params)
+      
+      #Rails.logger.info("Billing::Job: done with 'perform' method.")
+      
+      ret
+    end
+  end
+end

data/lib/djwrapper.rb

@@ -0,0 +1,17 @@
+# -*- encoding : utf-8 -*-
+# -- begin header --
+################################################################################
+# Written by Commander Johnson <commanderjohnson@gmail.com>
+# Year: 2012
+# Licensed under the MIT license
+################################################################################# -- end header --
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'djwrapper/job'
+require 'djwrapper/background_process'
+require 'djwrapper/delayed_background_process'
+
+module Djwrapper
+  VERSION = '0.0.1'
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/djwrapper.rb'}"
+puts "Loading djwrapper gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_djwrapper.rb

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+# -- begin header --
+################################################################################
+# Written by Commander Johnson <commanderjohnson@gmail.com>
+# Year: 2012
+# Licensed under the MIT license
+################################################################################# -- end header --
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestDjwrapper < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# -*- encoding : utf-8 -*-
+# -- begin header --
+################################################################################
+# Written by Commander Johnson <commanderjohnson@gmail.com>
+# Year: 2012
+# Licensed under the MIT license
+################################################################################# -- end header --
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/djwrapper'

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification 
+name: djwrapper
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Commander Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-01 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: delayed_job
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 10
+        version: "3.10"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        - 3
+        version: 1.5.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  type: :development
+  version_requirements: *id004
+description: Wrapper gem for Delayed Job.
+email: 
+- commanderjohnson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- header.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/djwrapper.rb
+- lib/djwrapper/job.rb
+- lib/djwrapper/background_process.rb
+- lib/djwrapper/delayed_background_process.rb
+- header.txt
+- script/console
+- script/destroy
+- script/generate
+- test/test_djwrapper.rb
+- test/test_helper.rb
+- .gemtest
+homepage: http://github.com/cmdjohnson/djwrapper
+licenses: []
+
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: djwrapper
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Wrapper gem for Delayed Job.
+test_files: 
+- test/test_djwrapper.rb
+- test/test_helper.rb