subservient 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e6dc9fb826381c68f4d1f9f7f04f40e0dfb3a46
+  data.tar.gz: ced144a849ef9933b5b760c39f68c8c6d357ea48
+SHA512:
+  metadata.gz: c85bf058fd785ad5ebf06c0001d7409910931478787ff35f2cceaf857a271ad9470bddfd4c7a1e1c4df55d8cd50295bb55756c7664caedbf7f7afea228a02a71
+  data.tar.gz: 650f9a4bebac9ace6a6e75fb55cfb06561948d8dab7b55bf32a30997638e7f512946bf32614842f9a98c3270e983ca0c75dba398dead29d01f9218c363204ae2

data/.gitignore

@@ -0,0 +1,3 @@
+pkg
+.DS_Store
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in subservient.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    subservient (0.0.1)
+      beaneater
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    beaneater (0.3.2)
+    rake (10.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  rake
+  subservient!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Crane7
+
+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,29 @@
+# Subservient
+
+Job queue processor using Beanstalkd
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'subservient'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install subservient
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/bin/subservient

@@ -0,0 +1,8 @@
+#! /usr/bin/env ruby
+require 'subservient'
+
+# Try and load tasks from the working directory
+Dir["**/*.rb"].each { |f| require File.expand_path(f) }
+
+subservient = Subservient::Worker.new
+subservient.go

data/example_task.rb

@@ -0,0 +1,41 @@
+require 'subservient'
+require 'json'
+
+module Subservient
+  class Worker
+    ## Generate some example jobs
+    def generate_example_jobs n=20, clear: true
+      conn = Beaneater::Pool.new(Subservient::pool)
+      tube = conn.tubes[@tube]
+      tube.clear if clear
+
+      n.times do |i|
+        push_job tube, "Example#puts_input", data: { n: (i+1) }
+        push_job tube, "Example#puts_rand"
+      end
+      push_job tube, "Example#divide_by_zero"
+
+      conn.close
+    end
+
+    def push_job tube, task, input={}
+      tube.put ({ task: task }.merge(input).to_json)
+    end
+
+  end
+end
+
+class Example < Subservient::Task
+  def puts_input
+    puts @job.input.inspect
+  end
+
+  def puts_rand
+    puts SecureRandom.hex
+  end
+
+  def divide_by_zero
+    # This will raise ZeroDivisionError
+    puts 1/0
+  end
+end

data/lib/subservient.rb

@@ -0,0 +1,9 @@
+require "beaneater"
+
+require "subservient/version"
+require "subservient/errors"
+require "subservient/config"
+
+require "subservient/job"
+require "subservient/task"
+require "subservient/worker"

data/lib/subservient/config.rb

@@ -0,0 +1,18 @@
+module Subservient
+  @@namespace = 'subservient'
+  def self.namespace
+    @@namespace
+  end
+  def self.namespace= value
+    @@namespace = value
+  end
+
+
+  @@pool_urls = ['localhost:11300']
+  def self.pool
+    @@pool_urls
+  end
+  def self.pool= value
+    @@pool_urls = value
+  end
+end

data/lib/subservient/errors.rb

@@ -0,0 +1,14 @@
+module Subservient
+  class SubservientError    < RuntimeError;     end # Never raised directly
+
+  class WorkerError         < SubservientError; end # Never raised directly
+  class AlreadyRunningError < WorkerError;      end # Raised if worker running when Worker#start called
+
+  class JobError            < SubservientError; end # Never raised directly
+  class MalformedJobError   < JobError;         end # Raised if job from BS is malformed
+  class MissingTaskError    < JobError;         end # Raised if task cannot be found
+
+  class TaskError           < SubservientError; end # Never raised directly
+  class RetryJob            < TaskError;        end # Raised to retry a job
+  class BuryJob             < TaskError;        end # Raised to bury a job
+end

data/lib/subservient/job.rb

@@ -0,0 +1,29 @@
+require 'json'
+
+module Subservient
+  class Job
+    attr_reader :bs_job, :input, :task, :task_method
+
+    def initialize bs_job
+      @bs_job      = bs_job
+      @input       = JSON.parse (@bs_job.body)
+
+      task_str     = @input.fetch('task')
+      arr          = task_str.rpartition('#').reject { |e| e.empty? or e == '#' }
+      @task_method = (arr[1] || :process).to_sym
+      task_class   = Object.const_get(arr[0])
+      raise MissingTaskError unless task_class.ancestors.include? Subservient::Task
+      @task        = task_class.new self
+      raise MissingTaskError unless @task.respond_to? @task_method
+    rescue JSON::JSONError, KeyError
+      raise MalformedJobError
+    rescue NameError
+      raise MissingTaskError
+    end
+
+    def execute
+      @task.execute_job
+    end
+
+  end
+end

data/lib/subservient/task.rb

@@ -0,0 +1,49 @@
+require 'json'
+
+module Subservient
+  class Task
+    attr_reader :job
+    def initialize job
+      @job = job
+    end
+
+    def execute_job
+      self.send(@job.task_method)
+      @job.bs_job.delete
+    rescue NoMethodError
+      raise MissingTaskError
+    rescue RetryJob, *@@retry_on => e
+      raise BuryJob if @job.bs_job.stats.releases > @@max_retries
+      puts "#{e.inspect} - RELEASING JOB #{@job.bs_job.id}"
+      puts e.backtrace
+      @job.bs_job.release
+    rescue BuryJob, StandardError => e
+      puts "#{e.inspect} - BURYING JOB #{@job.bs_job.id}"
+      puts e.backtrace
+      @job.bs_job.bury
+    end
+
+    private
+    @@retry_on = []
+    def self.retry_on err
+      @@retry_on << err
+    end
+
+    @@max_retries = 3
+    def self.max_retries n
+      @@max_retries = n
+    end
+  end
+
+
+  @@tasks = []
+  def self.tasks
+    if @@tasks.empty?
+      ObjectSpace.each_object(Module) do |m|
+        @@tasks << m if m.ancestors.include? Subservient::Task
+      end
+      @@tasks -= [Subservient::Task]
+    end
+    return @@tasks
+  end
+end

data/lib/subservient/version.rb

@@ -0,0 +1,3 @@
+module Subservient
+  VERSION = '0.0.1'
+end

data/lib/subservient/worker.rb

@@ -0,0 +1,76 @@
+module Subservient
+  class Worker
+    attr_reader :tube, :state
+    def initialize tube='default'
+      @tube    = [Subservient::namespace, tube].join('.')
+      @state   = :stopped
+      @thread_pool = []
+    end
+
+    def go threads: 5
+      start threads: threads
+
+      trap('SIGINT') do
+        exit
+      end
+      at_exit do
+        Thread.main.wakeup
+        stop
+      end
+      sleep
+    end
+    def start threads: 5
+      raise MissingTaskError if Subservient::tasks.empty?
+      raise AlreadyRunningError if @state != :stopped
+      @state = :started
+      threads.times do
+        start_worker_thread
+      end
+    end
+    def stop timeout: 30
+      @state = :shutdown        # Tell worker threads not to accept any more jobs
+      @thread_pool.each do |thread|
+        thread.join(timeout)    # Wait for all workers to exit gracefully...
+        thread.kill             # but kill them if they take too long
+      end
+      @state = :stopped
+    end
+
+    private
+
+    def start_worker_thread
+      @thread_pool << Thread.new do
+        conn = Beaneater::Pool.new(Subservient::pool)
+        begin
+          work conn
+        ensure
+          conn.close
+        end
+      end
+    end
+
+    def work conn
+      puts "Worker started"
+      conn.tubes.watch!(@tube)
+      while @state == :started do
+        begin
+          # Increasing this will decrease load on beanstalkd, but will
+          # also increase the time it takes to shut down the worker
+          timeout = 2
+
+          bs_job = conn.tubes.reserve(timeout)
+          begin
+            job = Job.new bs_job
+            job.execute
+          rescue JobError => e
+            puts "#{e} - BURYING JOB #{bs_job.id}"
+            bs_job.bury
+          end
+        rescue Beaneater::TimedOutError
+        end
+      end
+      puts "Worker stopped"
+    end
+
+  end
+end

data/subservient.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'subservient/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "subservient"
+  spec.version       = Subservient::VERSION
+  spec.authors       = ["David Robertson"]
+  spec.email         = ["david@davidr.me"]
+  spec.summary       = "Job queue processor using Beanstalkd"
+  # spec.description   = "TODO: Write a longer description. Optional."
+  spec.homepage      = "http://crane7.co.uk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency "beaneater"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: subservient
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Robertson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: beaneater
+  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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 
+email:
+- david@davidr.me
+executables:
+- subservient
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/subservient
+- example_task.rb
+- lib/subservient.rb
+- lib/subservient/config.rb
+- lib/subservient/errors.rb
+- lib/subservient/job.rb
+- lib/subservient/task.rb
+- lib/subservient/version.rb
+- lib/subservient/worker.rb
+- subservient.gemspec
+homepage: http://crane7.co.uk
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Job queue processor using Beanstalkd
+test_files: []