sidejobs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13c5ef1d9d233c888d758b942da10a980b46d75d
+  data.tar.gz: 7efac020aee70f251f7ce5d2682899d078e5a2bb
+SHA512:
+  metadata.gz: d50fda67d9726aa4bf94aabba4defcb04d7ec19e45b23060ab16e3b345b0e615183b10430d8ec68af4c240cc6af34c7f5087cbf7a3bee0f9ecdc72d7609931e8
+  data.tar.gz: d7a52d18d78bcfe948ab762399bcab78592209042ca9b0749398db947ac82100e76fd8813fc856a196bc0ff84ae5407ec5333dc508d57f404baae17ae5b71a4b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Mathías Montossi
+
+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,80 @@
+[![Gem Version](https://badge.fury.io/rb/sidejobs.svg)](http://badge.fury.io/rb/sidejobs)
+[![Code Climate](https://codeclimate.com/github/mmontossi/sidejobs/badges/gpa.svg)](https://codeclimate.com/github/mmontossi/sidejobs)
+[![Build Status](https://travis-ci.org/mmontossi/sidejobs.svg)](https://travis-ci.org/mmontossi/sidejobs)
+[![Dependency Status](https://gemnasium.com/mmontossi/sidejobs.svg)](https://gemnasium.com/mmontossi/sidejobs)
+
+# Sidejobs
+
+Versatile async database based jobs for rails.
+
+## Install
+
+Put this line in your Gemfile:
+```ruby
+gem 'sidejobs'
+```
+
+Then bundle:
+```
+$ bundle
+```
+
+## Configuration
+
+Generate the sidejobs configuration and migration file:
+```
+bundle exec rails g sidejobs:install
+```
+
+The default configuration options are:
+```ruby
+Sidejobs.configure do |config|
+  config.max_attempts = 3
+  config.sleep_delay = 15
+  config.batch_size = 20
+end
+```
+
+Run the migration to create the sidejobs table:
+```
+bundle exec rake db:migrate
+```
+
+Assign the sidejobs adapter to the environments:
+```ruby
+Rails.application.configure do
+  config.active_job.queue_adapter = :sidejobs
+end
+```
+
+## Usage
+
+Start the daemon using the rake task:
+```
+bundle exec rake sidejobs:start
+```
+
+Now you can deliver mails using deliver_later:
+```ruby
+UserMailer.invite('someone@mail.com').deliver_later
+```
+
+Or perform jobs using perform_later:
+```ruby
+SendNewsletterJob.perform_later
+```
+
+Management is done programtically using Sidejobs::Job model:
+```ruby
+Sidejobs::Job.failing.where('attempts > ?', 3).destroy_all
+```
+
+NOTE: Is better to do it this way to have the freedom to integrate the code anyway you want.
+
+## Credits
+
+This gem is maintained and funded by [mmontossi](https://github.com/mmontossi).
+
+## License
+
+It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/sidejobs/install_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+
+module Sidejobs
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_configuration_file
+        copy_file 'configuration.rb', 'config/initializers/sidejobs.rb'
+      end
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/create_sidejobs.rb'
+      end
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime '%Y%m%d%H%M%S'
+      end
+
+    end
+  end
+end

data/lib/generators/sidejobs/templates/configuration.rb

@@ -0,0 +1,7 @@
+Sidejobs.configure do |config|
+
+  config.max_attempts = 3
+  config.sleep_delay = 15
+  config.batch_size = 20
+
+end

data/lib/generators/sidejobs/templates/migration.rb

@@ -0,0 +1,25 @@
+class CreateSidejobs < ActiveRecord::Migration
+  def change
+    create_table :sidejobs do |t|
+      if ActiveRecord::Base.connection_config[:adapter] == 'postgresql'
+        t.jsonb :data
+      else
+        t.string :data
+      end
+      t.string :queue
+      t.string :status, default: 'pending'
+      t.integer :priority, default: 0
+      t.integer :attempts, default: 0
+      t.text :error
+      t.datetime :failed_at
+      t.datetime :completed_at
+      t.datetime :processed_at
+      t.datetime :scheduled_at
+
+      t.timestamps null: false
+    end
+
+    add_index :sidejobs, %i(status scheduled_at attempts)
+    add_index :sidejobs, :priority
+  end
+end

data/lib/sidejobs.rb

@@ -0,0 +1,34 @@
+require 'sidejobs/extensions/active_job/queue_adapter'
+require 'sidejobs/configuration'
+require 'sidejobs/daemon'
+require 'sidejobs/job'
+require 'sidejobs/processor'
+require 'sidejobs/queue'
+require 'sidejobs/railtie'
+require 'sidejobs/version'
+
+module Sidejobs
+  class << self
+
+    def daemon
+      @daemon ||= Daemon.new
+    end
+
+    def queue
+      @queue ||= Queue.new
+    end
+
+    def logger
+      @logger ||= Logger.new(Rails.root.join('log/sidejobs.log'))
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+  end
+end

data/lib/sidejobs/configuration.rb

@@ -0,0 +1,7 @@
+module Sidejobs
+  class Configuration
+
+    attr_accessor :max_attempts, :sleep_delay, :batch_size
+
+  end
+end

data/lib/sidejobs/daemon.rb

@@ -0,0 +1,104 @@
+module Sidejobs
+  class Daemon
+
+    def initialize
+      @stopping = false
+    end
+
+    def running?
+      if pid
+        begin
+          Process.kill 0, pid
+          true
+        rescue Errno::ESRCH
+          false
+        end
+      else
+        false
+      end
+    end
+
+    def start
+      unless running?
+        daemonize
+        write_pid
+        trap_signals
+        process
+      end
+    end
+
+    def stop
+      if running?
+        Process.kill :TERM, pid
+        delete_pid
+      end
+    end
+
+    def restart
+      if running?
+        stop
+        start
+      else
+        start
+      end
+    end
+
+    def pid
+      File.read(pid_path).to_i rescue nil
+    end
+
+    def stopping?
+      @stopping == true
+    end
+
+    private
+
+    def daemonize
+      exit if fork
+      Process.setsid
+      exit if fork
+      Dir.chdir '/'
+      File.umask 0000
+      $stdout.reopen log_path, 'a'
+      $stderr.reopen $stdout
+      $stdout.sync = true
+    end
+
+    def trap_signals
+      trap :TERM do
+        @stopping = true
+      end
+    end
+
+    def delete_pid
+      File.unlink pid_path
+    end
+
+    def write_pid
+      FileUtils.mkdir_p pid_path.dirname
+      File.write pid_path, Process.pid
+    end
+
+    def log_path
+      Rails.root.join 'log/sidejobs.log'
+    end
+
+    def pid_path
+      Rails.root.join 'tmp/pids/sidejobs.pid'
+    end
+
+    def processor
+      @processor ||= Processor.new
+    end
+
+    def process
+      Sidejobs.logger.info 'Starting'
+      until stopping? do
+        processor.process
+        sleep Sidejobs.configuration.sleep_delay
+      end
+      Sidejobs.logger.info 'Stopping'
+    end
+
+  end
+end

data/lib/sidejobs/extensions/active_job/queue_adapter.rb

@@ -0,0 +1,47 @@
+module Sidejobs
+  module Extensions
+    module ActiveJob
+      module QueueAdapters
+        class SidejobsAdapter
+          class << self
+
+            def enqueue(job)
+              Sidejobs.queue.add(
+                job.serialize,
+                queue: job.queue_name,
+                priority: calculate_priority(job.queue_name)
+              )
+            end
+
+            def enqueue_at(job, timestamp)
+              Sidejobs.queue.add(
+                job.serialize,
+                queue: job.queue_name,
+                priority: calculate_priority(job.queue_name),
+                schedule_at: Time.at(timestamp)
+              )
+            end
+
+            private
+
+            def calculate_priority(queue)
+              case queue
+              when 'mailers'
+                80
+              when 'high_priority'
+                60
+              when 'default'
+                40
+              when 'low_priority'
+                20
+              else
+                0
+              end
+            end
+
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidejobs/job.rb

@@ -0,0 +1,21 @@
+module Sidejobs
+  class Job < ActiveRecord::Base
+    self.table_name = 'sidejobs'
+    STATUS = %w(pending processing failing complete)
+
+    STATUS.each do |name|
+      scope name, -> { where(status: name) }
+      define_method "#{name}?" do
+        status == name
+      end
+    end
+
+    validates_presence_of :queue, :data, :status
+    validates_presence_of :error, :failed_at, if: :failing?
+    validates_presence_of :completed_at, if: :complete?
+    validates_presence_of :processed_at, if: :processing?
+    validates_inclusion_of :status, within: STATUS
+    validates_numericality_of :priority, :attempts, only_integer: true
+
+  end
+end

data/lib/sidejobs/processor.rb

@@ -0,0 +1,23 @@
+module Sidejobs
+  class Processor
+
+    def process
+      original_logger = ActiveJob::Base.logger
+      ActiveJob::Base.logger = Sidejobs.logger
+      Sidejobs.queue.fetch.each do |job|
+        Sidejobs.logger.info "Processing ##{job.id} attempt #{job.attempts} of #{job.data['job_class']}"
+        job.update status: 'processing', processed_at: Time.now, attempts: job.attempts+1
+        begin
+          ActiveJob::Base.execute job.data
+          job.update status: 'complete', completed_at: Time.now
+          Sidejobs.logger.info 'Done'
+        rescue => exception
+          job.update status: 'failing', failed_at: Time.now, error: exception.message
+          Sidejobs.logger.info "Error: #{exception.message}"
+        end
+      end
+      ActiveJob::Base.logger = original_logger
+    end
+
+  end
+end

data/lib/sidejobs/queue.rb

@@ -0,0 +1,24 @@
+module Sidejobs
+  class Queue
+
+    def add(data, options={})
+      Job.create(
+        data: data.to_json,
+        queue: (options[:queue] || 'default'),
+        priority: (options[:priority] || 0),
+        scheduled_at: options[:schedule_at]
+      )
+    end
+
+    def fetch
+      Job.where(status: %w(pending failing)).where(
+        'attempts < ?',
+        Sidejobs.configuration.max_attempts
+      ).where(
+        'scheduled_at <= ? OR scheduled_at IS NULL',
+        Time.now
+      ).order(priority: :desc).limit(Sidejobs.configuration.batch_size)
+    end
+
+  end
+end