background_queue 0.2.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p125@bg_q"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.10.3" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "json"
+gem "rufus-scheduler"
+gem "eventmachine", "~>0.12.10"
+gem "ipaddress", "~> 0.8.0"
+  
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", ">= 2.9.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "yard", "~> 0.7"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "redcarpet", "~>2.1.1"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 MarkPent
+
+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,69 @@
+# background_queue
+
+This is a gem to manage background tasks. The primary focus is organising the tasks so they will not overload the machine(s) running the tasks, while
+still giving a fair, balanced allocation of running time to members in the queue.
+
+
+## Usage
+
+### Initializing
+In your environment, initialize a constant BackgroundQueue::Client
+
+     BG_QUEUE = BackgroundQueue::Client.new(_PATH_TO_CONFIG_)
+ 
+### Starting a single task
+Now you can use your BG\_QUEUE to add a single task. Note: the "task_id" should be unique, even between owners/jobs. If there is an existing task with the same id in any queue,
+even if its a different owner/job, the existing task will be removed before this task is added the the ownerjob queue.
+
+     job_handle = BG_QUEUE.add_task(:worker_name, "owner identifier", "job identifier", "task_id", priority, {:some_task=>:params}, {:priority=>1})
+  
+  
+### Starting multiple tasks
+Or you can queue multiple tasks at once. 
+
+     job_handle = BG_QUEUE.add_tasks(:worker_name, "owner identifier", "job identifier", [["task1_id" , {:some_task=>:params}], ["task2_id" , {:some_task=>:params}]], priority, {:shared=>:params}, {:priority=>1})
+
+### Job Status
+Get the status of the job
+
+    status = BG_QUEUE.get_status(job_handle)
+
+
+## Queue Management
+* Each task on the queue is associated with an 'owner', 'job' and 'id'
+* Each job has a priority (0=highest).
+* An 'owner' has a queue of 'job' which is a list of tasks.
+* Status is tracked per job.
+* Tasks within a job can be weighted.
+
+### Finding the next task to run
+1. Get the next owner with the highest priority subject
+2. Get the next job within the above owner with the highest priority
+3. Pop the next task off the job queue.
+4. Push the job to the end of the owners job queue.
+5. Push the owner to the end of the queue.
+
+## Worker Managment
+* The actual workers are implimented using passenger.
+* The queue calls the passenger server(s) through HTTP.
+* The queue limits the number of simultaneous workers at any one time.
+* Using passenger to manage the workers means workers are efficiently re-used, with a full Rails enviroment loaded and ready to go.
+* The status of the task is streamed to the queue manager. 
+
+
+
+## Contributing to background_queue
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 MarkPent. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "background_queue"
+  gem.homepage = "http://github.com/markpent/background_queue"
+  gem.license = "MIT"
+  gem.summary = %Q{Background processing}
+  gem.description = %Q{Organise background tasks so they will not overload the machine(s) running the tasks, while still giving a fair, balanced allocation of running time to members in the queue}
+  gem.email = "mark.pent@gmail.com"
+  gem.authors = ["MarkPent"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/TODO

@@ -0,0 +1,2 @@
+Server
+    Raise priority of tasks that have been waiting a long time

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/background_queue.gemspec

@@ -0,0 +1,158 @@
+# 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 = "background_queue"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["MarkPent"]
+  s.date = "2012-10-09"
+  s.description = "Organise background tasks so they will not overload the machine(s) running the tasks, while still giving a fair, balanced allocation of running time to members in the queue"
+  s.email = "mark.pent@gmail.com"
+  s.executables = ["bg_queue"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "TODO"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".rvmrc",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "TODO",
+    "VERSION",
+    "background_queue.gemspec",
+    "bin/bg_queue",
+    "lib/background_queue.rb",
+    "lib/background_queue/client.rb",
+    "lib/background_queue/client_lib/command.rb",
+    "lib/background_queue/client_lib/config.rb",
+    "lib/background_queue/client_lib/connection.rb",
+    "lib/background_queue/client_lib/job_handle.rb",
+    "lib/background_queue/command.rb",
+    "lib/background_queue/config.rb",
+    "lib/background_queue/server_lib/balanced_queue.rb",
+    "lib/background_queue/server_lib/config.rb",
+    "lib/background_queue/server_lib/event_connection.rb",
+    "lib/background_queue/server_lib/event_server.rb",
+    "lib/background_queue/server_lib/job.rb",
+    "lib/background_queue/server_lib/job_registry.rb",
+    "lib/background_queue/server_lib/lru.rb",
+    "lib/background_queue/server_lib/owner.rb",
+    "lib/background_queue/server_lib/priority_queue.rb",
+    "lib/background_queue/server_lib/queue_registry.rb",
+    "lib/background_queue/server_lib/server.rb",
+    "lib/background_queue/server_lib/sorted_workers.rb",
+    "lib/background_queue/server_lib/task.rb",
+    "lib/background_queue/server_lib/task_registry.rb",
+    "lib/background_queue/server_lib/thread_manager.rb",
+    "lib/background_queue/server_lib/worker.rb",
+    "lib/background_queue/server_lib/worker_balancer.rb",
+    "lib/background_queue/server_lib/worker_client.rb",
+    "lib/background_queue/server_lib/worker_thread.rb",
+    "lib/background_queue/utils.rb",
+    "lib/background_queue/worker/base.rb",
+    "lib/background_queue/worker/calling.rb",
+    "lib/background_queue/worker/config.rb",
+    "lib/background_queue/worker/environment.rb",
+    "lib/background_queue/worker/worker_loader.rb",
+    "lib/background_queue_server.rb",
+    "lib/background_queue_worker.rb",
+    "spec/background_queue/client_lib/command_spec.rb",
+    "spec/background_queue/client_lib/config_spec.rb",
+    "spec/background_queue/client_lib/connection_spec.rb",
+    "spec/background_queue/client_spec.rb",
+    "spec/background_queue/command_spec.rb",
+    "spec/background_queue/config_spec.rb",
+    "spec/background_queue/server_lib/balanced_queue_spec.rb",
+    "spec/background_queue/server_lib/config_spec.rb",
+    "spec/background_queue/server_lib/event_connection_spec.rb",
+    "spec/background_queue/server_lib/event_server_spec.rb",
+    "spec/background_queue/server_lib/integration/full_test_spec.rb",
+    "spec/background_queue/server_lib/integration/queue_integration_spec.rb",
+    "spec/background_queue/server_lib/integration/serialize_spec.rb",
+    "spec/background_queue/server_lib/job_registry_spec.rb",
+    "spec/background_queue/server_lib/job_spec.rb",
+    "spec/background_queue/server_lib/owner_spec.rb",
+    "spec/background_queue/server_lib/priority_queue_spec.rb",
+    "spec/background_queue/server_lib/server_spec.rb",
+    "spec/background_queue/server_lib/sorted_workers_spec.rb",
+    "spec/background_queue/server_lib/task_registry_spec.rb",
+    "spec/background_queue/server_lib/task_spec.rb",
+    "spec/background_queue/server_lib/thread_manager_spec.rb",
+    "spec/background_queue/server_lib/worker_balancer_spec.rb",
+    "spec/background_queue/server_lib/worker_client_spec.rb",
+    "spec/background_queue/server_lib/worker_thread_spec.rb",
+    "spec/background_queue/utils_spec.rb",
+    "spec/background_queue/worker/base_spec.rb",
+    "spec/background_queue/worker/calling_spec.rb",
+    "spec/background_queue/worker/environment_spec.rb",
+    "spec/background_queue/worker/worker_loader_spec.rb",
+    "spec/background_queue_spec.rb",
+    "spec/resources/config-client.yml",
+    "spec/resources/config-serialize.yml",
+    "spec/resources/config.yml",
+    "spec/resources/example_worker.rb",
+    "spec/resources/example_worker_with_error.rb",
+    "spec/resources/test_worker.rb",
+    "spec/shared/queue_registry_shared.rb",
+    "spec/spec_helper.rb",
+    "spec/support/default_task.rb",
+    "spec/support/private.rb",
+    "spec/support/simple_server.rb",
+    "spec/support/simple_task.rb",
+    "spec/support/test_worker_server.rb"
+  ]
+  s.homepage = "http://github.com/markpent/background_queue"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.17"
+  s.summary = "Background processing"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<rufus-scheduler>, [">= 0"])
+      s.add_runtime_dependency(%q<eventmachine>, ["~> 0.12.10"])
+      s.add_runtime_dependency(%q<ipaddress>, ["~> 0.8.0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.9.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<yard>, ["~> 0.7"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<redcarpet>, ["~> 2.1.1"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rufus-scheduler>, [">= 0"])
+      s.add_dependency(%q<eventmachine>, ["~> 0.12.10"])
+      s.add_dependency(%q<ipaddress>, ["~> 0.8.0"])
+      s.add_dependency(%q<rspec>, [">= 2.9.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<yard>, ["~> 0.7"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<redcarpet>, ["~> 2.1.1"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rufus-scheduler>, [">= 0"])
+    s.add_dependency(%q<eventmachine>, ["~> 0.12.10"])
+    s.add_dependency(%q<ipaddress>, ["~> 0.8.0"])
+    s.add_dependency(%q<rspec>, [">= 2.9.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<yard>, ["~> 0.7"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<redcarpet>, ["~> 2.1.1"])
+  end
+end
+

data/bin/bg_queue

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'background_queue_server'
+
+server = BackgroundQueue::ServerLib::Server.new
+
+begin
+  options = server.process_args(ARGV)
+  if options[:command] == :stop
+    server.stop_pid(options)
+  else
+    server.start(options)
+  end
+rescue SystemExit=>se
+  
+rescue BackgroundQueue::ServerLib::InitError=>ie
+  puts ie.message
+  exit(1)
+rescue Exception=>e
+  puts "#{e.class.name} : #{e.message}"
+  puts e.backtrace.join("\n")
+  exit(1)
+end
+
+
+

data/lib/background_queue.rb

@@ -0,0 +1,8 @@
+require "background_queue/utils"
+require "background_queue/config"
+require "background_queue/command"
+require "background_queue/client_lib/config"
+require "background_queue/client_lib/command"
+require "background_queue/client_lib/connection"
+require "background_queue/client_lib/job_handle"
+require "background_queue/client"

data/lib/background_queue/client.rb

@@ -0,0 +1,96 @@
+#The Background Queue will schedule tasks in the background. Refer to README for more details. 
+module BackgroundQueue
+  #The main interface to the background queue from the client.
+  #this class will look after sending a command to the server, using a failover server if needed.
+  class Client
+    
+    attr_accessor :config
+    
+    def initialize(path)
+      @config = BackgroundQueue::ClientLib::Config.load_file(path)
+    end
+    
+    #add a task to the background
+    def add_task(worker, owner_id, job_id, task_id, priority, task_parameters={}, options={}, server=nil )
+      job_id, task_id = generate_ids(worker, owner_id, job_id, task_id)
+      result, server = send_command(BackgroundQueue::ClientLib::Command.add_task_command(worker, owner_id, job_id, task_id, priority, task_parameters, options ), server)
+      #the server currently either returns :ok or an exception would have been thrown
+      BackgroundQueue::ClientLib::JobHandle.new(owner_id, job_id, server)
+    end
+    
+    #add multiple tasks to the background, all with the same worker/owner/job
+    def add_tasks(worker, owner_id, job_id, tasks, priority, shared_parameters={}, options={}, server=nil )
+      send_command(BackgroundQueue::ClientLib::Command.add_tasks_command(worker, owner_id, job_id, tasks, priority, shared_parameters, options ), server)
+    end
+    
+    def get_status(job_handle, options={})
+      result, server = send_command(BackgroundQueue::ClientLib::Command.get_status_command(job_handle.job_id, options ), job_handle.server)
+      result
+    end
+    
+    def get_stats(server, options={})
+      result, server = send_command(BackgroundQueue::ClientLib::Command.stats_command(options ), server)
+      result.args
+    end
+    
+    
+    #removed for now
+    #remove tasks from the background queue
+    #def remove_tasks(tasks, options={})
+    #  send_command(BackgroundQueue::ClientLib::Command.remove_tasks_command(tasks, options))
+    #end
+    
+    
+    private
+    
+    #generate what should be a unique id for a job/task
+    def generate_ids(worker, owner_id, job_id, task_id)
+      if job_id.nil?
+        job_id = "#{worker}-#{get_node_name}-#{Process.pid}-#{Time.now.to_i}"
+      end
+      
+      if task_id.nil?
+        task_id = "#{job_id}-#{Time.now.to_i}"
+      end
+      
+      [job_id, task_id]
+    end
+    
+    def get_node_name
+      if @@this_node_name.nil?
+        hostname = Socket.gethostname
+        @@this_node_name = hostname.index(".").nil? ? hostname : hostname[0, hostname.index(".")]
+      end
+      @@this_node_name
+    end
+    
+    def send_command(command, server=nil)
+      server = @config.server if server.nil?
+      begin
+        send_command_to_server(command, server)
+      rescue BackgroundQueue::ClientLib::ConnectionError=>e
+        failures = []
+        failures << e.message
+        @config.failover.each_with_index do |server, idx| 
+          begin
+            return send_command_to_server(command, server)
+          rescue BackgroundQueue::ClientLib::ConnectionError=>e2
+            failures << ", Attempt #{idx + 2}: #{e2.message}"
+          end
+        end
+        raise ClientException, failures.join("")
+      end
+    end
+    
+    def send_command_to_server(command, server)
+      connection = BackgroundQueue::ClientLib::Connection.new(self, server)
+      [connection.send_command(command), server]
+    end
+  end
+  
+  
+  #Error raised when unable to send command
+  class ClientException < Exception
+    
+  end
+end