labor 0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Brett Buddin
+
+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,70 @@
+# Labor
+
+A wrapper for "gearman-ruby" which provides an easy mechanism for managing your jobs. Jobs are just Ruby classes/modules which respond to the `perform` method.
+
+## Get Started
+
+Basic `Rakefile`:
+  
+    require 'labor'
+    require 'labor/tasks'
+
+    class TestJob
+      def self.perform
+        puts "Hello, world!"
+
+        true
+      end
+    end
+
+    class AnotherTest
+      def self.perform
+        puts "Hello, world... again!"
+
+        true
+      end
+    end
+
+    Labor.servers = ["10.0.0.1:4370", "10.0.0.2:4370"]
+
+Let's run the worker:
+
+    $ export ABILITIES=test-job,another-test
+    $ rake labor:work
+
+The `ABILITIES` environment variable can accept multiple job names; each seperated by a comma.
+
+## Configuration
+
+Labor also allows you to load in a configuration file along with your worker. This configuration file is written in Ruby and offers a simple DSL (similar to the one present in Capistrano) for setting variables.
+
+Configs look like this:
+   
+    # settings.rb
+
+    set :foo, "bar"
+    set :i_am, "at the #{bar}"
+
+    group :credentials do
+      set :username, "murkturgler"
+      set :password, "supersecret"
+    end
+
+
+The config file would then be loaded in like this:
+
+    Labor.config File.join(File.dirname(__FILE__), 'settings.rb')
+
+When the worker is started up, Labor will load this config into the `@config` instance variable of your job class/module. You'll then be able to retrieve keys from the config within your job.
+
+    class TestJob
+      def self.perform
+        puts "Hey! I'm #{@config[:i_am]}"
+        #=> "Hey! I'm at the bar"
+
+        puts "Here's my username: #{@config.credentials.username}"
+        #=> "Here's my username: murkturgler"
+
+        true
+      end
+    end

data/Rakefile

@@ -0,0 +1,38 @@
+begin
+  require "jeweler"
+
+  Jeweler::Tasks.new do |gem|
+    gem.name = "labor"
+    gem.version = "0.1"
+    gem.summary = "More portable jobs for Gearman workers."
+    gem.description = <<-desc
+      Wrapper for gearman-ruby that provides a different, and more portable, way of defining jobs.
+    desc
+    gem.email = "brett@intraspirit.net"
+    gem.homepage = "http://github.com/brettbuddin/labor"
+    gem.date = Time.now.strftime('%Y-%m-%d')
+    gem.authors = ["Brett Buddin"]
+    gem.files = %w( README.md Rakefile LICENSE )
+    gem.files += Dir["*", "{lib}/**/*"]
+    gem.add_dependency "gearman-ruby"
+    gem.add_dependency "json"
+
+    gem.has_rdoc = false
+  end
+  
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new('spec') do |t|
+    t.pattern = FileList['spec/**/*_spec.rb']
+  end
+
+  task :test do
+    Rake::Task['spec'].invoke
+  end
+end

data/labor.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{labor}
+  s.version = "0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brett Buddin"]
+  s.date = %q{2011-02-19}
+  s.description = %q{      Wrapper for gearman-ruby that provides a different, and more portable, way of defining jobs.
+}
+  s.email = %q{brett@intraspirit.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "labor.gemspec",
+    "lib/labor.rb",
+    "lib/labor/config.rb",
+    "lib/labor/core_ext.rb",
+    "lib/labor/helpers.rb",
+    "lib/labor/tasks.rb",
+    "lib/labor/version.rb",
+    "lib/labor/worker.rb"
+  ]
+  s.homepage = %q{http://github.com/brettbuddin/labor}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{More portable jobs for Gearman workers.}
+  s.test_files = [
+    "spec/config_spec.rb",
+    "spec/files/sample_config.rb",
+    "spec/labor_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/worker_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<gearman-ruby>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<gearman-ruby>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<gearman-ruby>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end
+

data/lib/labor.rb

@@ -0,0 +1,58 @@
+require 'gearman'
+require 'json'
+
+require 'labor/version'
+require 'labor/core_ext'
+require 'labor/helpers'
+require 'labor/worker'
+require 'labor/config'
+
+module Labor
+  # Sets the server addresses that we'd like to connect to.
+  #
+  # servers - The String address of the server or an Array 
+  #   of server addresses.
+  # 
+  # Examples
+  #
+  #   Labor.servers '10.3.4.19:4730'
+  #   Labor.servers ['10.3.4.19:4730', '10.3.4.20:4730']
+  #
+  # Returns the Array of server addresses or String if only one was given.
+  def self.servers=(servers)
+    @servers = servers 
+  end
+
+  # Returns the list of server addresses we'd like to connect to.
+  #
+  # Returns the Array of server addresses. Defaults to localhost:4730 
+  #   if nothing has been set.
+  def self.servers
+    @servers || ["localhost:#{Gearman::Util::DEFAULT_PORT}"]
+  end
+
+  # Loads in a config file.
+  #
+  # file_name - The String path to the file.
+  #
+  # Examples
+  #
+  #   Labor.config 'settings.rb'
+  #
+  # Returns the Labor::Config instance.
+  def self.config=(file_name)
+    @config = Labor::Config.new.load file_name
+  end
+
+  # Returns the configuration object for our application.
+  #
+  # Returns the Labor::Config instance. Defaults to a new config
+  #   if nothing has been set.
+  def self.config
+    @config ||= Labor::Config.new
+  end
+
+  class << self
+    attr_accessor :verbose 
+  end
+end

data/lib/labor/config.rb

@@ -0,0 +1,103 @@
+# Configuration manager for the worker. Treat it like a Hash.
+# A hash that has a tiny DSL for setting values to it and 
+# supports grouping.
+#
+# For example:
+#
+#   config = Config.new
+#   config[:foo] = "bar"
+#   config.set :hello, "world"
+#   config.group :a_group do
+#     set :three_two_one, "let's jam!"
+#   end
+#
+#   config.foo #=> "bar"
+#   config.hello #=> "world"
+#   config.a_group.three_two_one #=> "let's jam"
+#
+module Labor
+  class Config
+    include Enumerable
+
+    def initialize
+      @config = {}
+    end
+
+    # Loads a config file.
+    #
+    # file_name - The String path to the file.
+    #
+    # Returns Config instance.
+    def load(file_name)
+      instance_eval(File.read(file_name))
+      self
+    end
+      
+    # Assigns a value to a key.
+    #
+    # key - The Symbol key name.
+    # value - Anything you'd like to assign to the key.
+    #
+    # Returns the value of the key.
+    def set(key, value)
+      @config[key.to_sym] = value
+    end
+    alias_method :[]=, :set
+
+    # Retreives the value of a key.
+    #
+    # key - The Symbol key name.
+    #
+    # Returns the value of the key.
+    def get(key)
+      @config[key.to_sym] 
+    end
+    alias_method :[], :get
+
+    # Deletes a key from the config.
+    #
+    # key - The Symbol key name.
+    #
+    # Returns the value of the key.
+    def delete(key)
+      @config.delete key.to_sym
+    end
+
+    # Checks if a key is set in the config.
+    #
+    # key - The Symbol key name.
+    #
+    # Returns a Boolean of whether or not the key exists.
+    def exists?(key)
+      @config.has_key? key.to_sym
+    end
+
+    # Call a block for each key in the config.
+    #
+    # block - The Block to execute for each element.
+    #
+    # Returns a Boolean of whether or not the key exists.
+    def each(&block)
+      @config.each(&block)
+    end
+
+
+    # Checks if a key is set in the config.
+    #
+    # key - The Symbol key name
+    #
+    # Returns a Boolean of whether or not the key exists.
+    def group(key, &block)
+      @config[key.to_sym] ||= Config.new
+      @config[key.to_sym].instance_eval(&block) if block_given?
+    end
+
+    private
+
+    def method_missing(sym, *args)
+      if args.length == 0 && @config.has_key?(sym)
+        get(sym)
+      end
+    end
+  end
+end

data/lib/labor/core_ext.rb

@@ -0,0 +1,3 @@
+Dir["#{File.dirname(__FILE__)}/core_ext/*.rb"].each do |path|
+  require "labor/core_ext/#{File.basename(path, '.rb')}"
+end

data/lib/labor/helpers.rb

@@ -0,0 +1,30 @@
+module Labor
+  module Helpers
+    def classify(word)
+      word.split('-').each { |part| part[0] = part[0].chr.upcase }.join
+    end
+
+    def constantize(camel_cased_word)
+      camel_cased_word = camel_cased_word.to_s
+
+      if camel_cased_word.include?('-')
+        camel_cased_word = classify(camel_cased_word)
+      end
+
+      names = camel_cased_word.split('::')
+      names.shift if names.empty? || names.first.empty?
+
+      constant = Object
+      names.each do |name|
+        constant = constant.const_get(name) || constant.const_missing(name)
+      end
+      constant
+    end
+
+    def log(str)
+      if Labor.verbose
+        puts "#{Time.now.strftime('%I:%M:%S %d-%m-%Y')}: #{str}"
+      end
+    end
+  end
+end

data/lib/labor/tasks.rb

@@ -0,0 +1,24 @@
+# Rake tasks for Labor
+#
+# require 'labor/tasks'
+
+namespace :labor do
+  task :work do
+    require 'labor'
+
+    abilities = ENV['ABILITIES'].to_s.split(',')
+
+    unless abilities.empty?
+      worker = Labor::Worker.new *abilities
+    else
+      abort "Please set ABILITIES environment variable (e.g. ABILITIES=say-hai,say-hello)"
+    end
+
+    if ENV['PIDFILE']
+      File.open(ENV['PIDFILE'], 'w') { |f| f << Process.pid.to_s }
+    end
+    Labor.verbose = ENV['VERBOSE']
+
+    worker.work
+  end
+end

data/lib/labor/version.rb

@@ -0,0 +1,3 @@
+module Labor
+  VERSION = Version = 0.1
+end

data/lib/labor/worker.rb

@@ -0,0 +1,78 @@
+module Labor
+  class Worker
+    include Helpers
+
+    def initialize(*abilities)
+      @worker = Gearman::Worker.new(Labor.servers)
+      add_abilities(abilities)
+    end
+
+    # Starts the work loop.
+    #
+    # Returns nothing.
+    def work
+      register_signals
+      loop { @worker.work or break }
+    end
+
+    private
+
+    # Registers abilities with the worker and announces them to the server.
+    # 
+    # abilities - The Array of ability strings.
+    #
+    # Returns nothing.
+    def add_abilities(abilities)
+      abilities.each do |ability|
+        klass = constantize(classify(ability))
+        klass.instance_variable_set(:@config, Labor.config)
+
+        @worker.add_ability(ability) do |data, job|
+          begin
+            payload = JSON.parse data
+            klass.perform(payload, job)
+          rescue Exception => e
+            log "Job failed: #{e.inspect}"
+            return false
+          end
+        end
+
+        if klass.respond_to?(:after_perform)
+          @worker.after_ability(ability) do |result, data|
+          begin
+            payload = JSON.parse data
+            klass.after_perform(payload, result)
+          rescue Exception => e
+            log "After job failed: #{e.inspect}"
+          end
+          end
+        end
+      end
+    end
+
+    # Sets the procline of the program. You can observe it via `top`.
+    #
+    # str - The String to be assigned to the procline.
+    #
+    # Returns the String assigned to the procline.
+    def procline=(str)
+      $0 = "labor: #{str}"
+    end
+
+    # Registers trapping signals with the worker.
+    #
+    # Returns nothing.
+    def register_signals
+      %w(INT TERM).each do |signal|
+        trap signal do
+          @worker.worker_enabled = false
+          if @worker.status == :waiting
+            trap signal, "DEFAULT"
+            exit
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,80 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Labor::Config do
+  before(:each) do
+    @config = Labor::Config.new
+  end
+
+  it "loads config from a file" do
+    @config.load File.join(File.dirname(__FILE__), 'files', 'sample_config.rb')
+    @config.get(:foo).should == "bar"
+  end
+
+  it "allows write access to a key" do
+    @config.set(:foo, "bar")
+    @config.get(:foo).should == "bar"
+  end
+
+  it "allows read access to a key" do
+    @config.set(:foo, "bar")
+    @config.get(:foo).should == "bar"
+  end
+
+  it "allows read access to keys via bracket method" do
+    @config.set(:foo, "bar")
+    @config[:foo].should == "bar"
+  end
+
+  it "provides access to keys using methods" do
+    @config.set(:foo, "bar")
+    @config.foo.should == "bar"
+  end
+
+  it "allows write access to keys via bracket method" do
+    @config[:foo] = "bar"
+    @config.get(:foo).should == "bar"
+  end
+
+  it "allows deletion of a key" do
+    @config.set(:foo, "a noob")
+    @config.delete(:foo)
+    @config.get(:foo).should be_nil
+  end
+
+  it "allows checking existence of a key" do
+    @config.set(:foo, "bar")
+    @config.exists?(:foo)
+  end
+
+  it "have each defined" do
+    @config.respond_to?(:each)
+  end
+
+  it "allow configs to use keys as in-line variables" do
+    @config.instance_eval <<-CONFIG
+      set :foo, "bar"
+      set :i_am, "at the \#{foo}"
+    CONFIG
+    @config.get(:i_am).should == "at the bar"
+  end
+
+  describe :grouping do
+    before(:each) do
+      @config.instance_eval <<-CONFIG
+        group :test do
+          set :foo, "bar"
+          set :i_am, "at the \#{foo}"
+        end
+      CONFIG
+    end
+
+    it "can retreive a key from a group" do
+      @config.get(:test).get(:foo).should == "bar"
+    end
+
+    it "can assign a key to a group" do
+      @config.test[:omg] = "wtf"
+      @config.get(:test).get(:omg).should == "wtf"
+    end
+  end
+end

data/spec/files/sample_config.rb

@@ -0,0 +1 @@
+set :foo, "bar"

data/spec/labor_spec.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Labor do
+  describe :servers do
+    it "assigns a single server" do
+      Labor.servers = "10.0.0.1:4370"
+      Labor.servers.should == "10.0.0.1:4370"
+    end
+
+    it "assigns a list of servers" do
+      Labor.servers = ["10.0.0.1:4370", "10.0.0.2:4370"]
+      Labor.servers.should == ["10.0.0.1:4370", "10.0.0.2:4370"]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path("../lib", File.dirname(__FILE__))
+
+require 'rspec'
+require 'labor'

data/spec/worker_spec.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+class Test
+  def self.perform
+    puts "Hello"
+  end
+end
+
+describe Labor::Worker do
+  before(:each) do
+    @worker = Labor::Worker.new 'test'
+  end
+
+  it "assigns abilities" do
+    real_worker = @worker.instance_variable_get(:@worker)
+    real_worker.instance_variable_get(:@abilities).should have_key("test")
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: labor
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Brett Buddin
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-19 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gearman-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: "      Wrapper for gearman-ruby that provides a different, and more portable, way of defining jobs.\n"
+email: brett@intraspirit.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- labor.gemspec
+- lib/labor.rb
+- lib/labor/config.rb
+- lib/labor/core_ext.rb
+- lib/labor/helpers.rb
+- lib/labor/tasks.rb
+- lib/labor/version.rb
+- lib/labor/worker.rb
+- spec/config_spec.rb
+- spec/files/sample_config.rb
+- spec/labor_spec.rb
+- spec/spec_helper.rb
+- spec/worker_spec.rb
+has_rdoc: true
+homepage: http://github.com/brettbuddin/labor
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: More portable jobs for Gearman workers.
+test_files: 
+- spec/config_spec.rb
+- spec/files/sample_config.rb
+- spec/labor_spec.rb
+- spec/spec_helper.rb
+- spec/worker_spec.rb