soter 1.0.0

data/lib/soter.rb

@@ -0,0 +1,83 @@
+require_relative 'soter/config'
+require_relative 'soter/job_worker'
+
+require 'mongo'
+require 'mongo_queue'
+
+module Soter
+
+  require 'mongo_queue'
+
+  def self.config
+    @config ||= Soter::Config.new
+  end
+
+  def self.enqueue(handler, job_params={}, queue_options={})
+    job = {
+      'job' => {
+        'params' => job_params,
+        'class' => handler.to_s
+      },
+      'queue_options' => queue_options,
+      'active_at' => queue_options.delete(:active_at)
+    }
+
+    queue.insert(job)
+    dispatch_worker
+  end
+
+  def self.dequeue(job_params)
+    queue.remove('job_params' => job_params)
+  end
+
+  private
+
+  # First 8 retry values in minutes are: 
+  # 2.minutes, 17.minutes, 2.hours, 6.hours,
+  # 16.hours, 31.hours, 54.hours, 85.hours
+  def self.retry_offset(retries)
+    ( (retries-1) ** 3) * (15 * 60)  + 120
+  end
+
+  def self.database
+    if Soter.config.host
+      @database ||= Mongo::Connection.new(Soter.config.host, Soter.config.port)
+    else
+      @database ||= Mongo::ReplSetConnection.new(Soter.config.hosts.first)
+    end
+  end
+
+  def self.queue
+    @queue ||= Mongo::Queue.new(database, Soter.config.queue_settings)
+  end
+
+  def self.workers
+    begin
+      result = @queue.send(:collection).
+        distinct(:locked_by, {:locked_by => {"$ne" => nil}})
+    rescue
+      result = []
+    end
+
+    result || []
+  end
+
+  def self.dispatch_worker
+    if workers.count < max_workers
+      JobWorker.new.start
+    else
+      queue.cleanup! #remove stuck locks
+    end
+  end
+
+  def self.max_workers
+    Soter.config.workers || 5
+  end
+
+  def self.recursive_const_get(name)
+    name.to_s.split("::").inject(self) do |b, c|
+      b.const_get(c)
+    end
+  end
+
+end

data/lib/soter/config.rb

@@ -0,0 +1,18 @@
+module Soter
+  class Config < Struct.new(:fork, :logfile, :logger, :host, :port, :db,
+                            :workers, :attempts, :hosts)
+
+    def queue_settings
+      host_settings = host ? {host: host} : {hosts: hosts}
+
+      host_settings.merge({
+        port:       port,
+        database:   db,
+        collection: "soter_queue",
+        timeout:    300,
+        attempts:   (attempts || 3)
+      })
+    end
+
+  end
+end

data/lib/soter/job_worker.rb

@@ -0,0 +1,84 @@
+module Soter  
+  class JobWorker
+
+    require 'digest/md5'
+
+    def start
+      if fork?
+        fork do
+          perform
+        end
+      else
+        perform
+      end
+    end
+
+    def initialize
+      @queue         = Soter.queue
+      @log           = Soter.config.logger || File.open("#{logfile}", "a")
+
+      @log.sync = true if @log.respond_to?(:sync=)
+      @queue.cleanup! # remove expired locks
+    end
+
+    def perform
+      process_id = Digest::MD5.
+        hexdigest("#{Socket.gethostname}-#{Process.pid}-#{Thread.current}")
+
+      log "#{process_id}: Spawning"
+
+      while(job = @queue.lock_next(process_id))
+        log "#{process_id}: Starting work on job #{job['_id']}"
+        log "#{process_id}: Job info =>"
+
+        job.each {
+          |key, value| log  "#{process_id}: {#{key} : #{value}}" }
+
+          begin
+            handler_class = Soter.recursive_const_get(job['job']['class'])
+            job_handler   = handler_class.new(job['job']['params'])
+
+            job_handler.perform
+
+            log "#{process_id}: " + job_handler.message
+
+            if job_handler.success?
+              @queue.complete(job, process_id)
+              log "#{process_id}: Completed job #{job['_id']}"
+            else
+              offset           = Soter.retry_offset(job['attempts']+1)
+              job['active_at'] = Time.now.utc + offset 
+              @queue.error(job, job_handler.message)
+
+              log "#{process_id}: Failed job #{job['_id']}"
+            end
+
+            sleep(1) if fork?
+          rescue Exception => e
+            @queue.complete(job, e.message)
+            log "#{process_id}: Failed job #{job['_id']}" +
+              " with error #{e.message}"
+            log "#{process_id}: Backtrace =>"
+            e.backtrace.each { |line| log "#{process_id}: #{line}"}
+          end
+      end #while
+      log "#{process_id}: Harakiri"
+      @log.close
+    end #start
+
+    private
+
+    def fork?
+      Soter.config.fork
+    end
+
+    def logfile
+      Soter.config.logfile || 'log/soter.log'
+    end
+
+    def log(message)
+      @log << message + "\n"
+    end
+
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: soter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- andresf
+- solojavier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ruby + mongoid background jobs library
+email: 1.27201@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/soter/config.rb
+- lib/soter/job_worker.rb
+- lib/soter.rb
+homepage: https://github.com/wowzerinc/soter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Background jobs
+test_files: []
+has_rdoc: