sidejobs 0.0.1 → 4.0.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13c5ef1d9d233c888d758b942da10a980b46d75d
-  data.tar.gz: 7efac020aee70f251f7ce5d2682899d078e5a2bb
+  metadata.gz: 149454f6f7e3af76c6730bacd7116b802ebaf558
+  data.tar.gz: 72f425083d2c8c139cb0aaa532c01582a6c1a161
 SHA512:
-  metadata.gz: d50fda67d9726aa4bf94aabba4defcb04d7ec19e45b23060ab16e3b345b0e615183b10430d8ec68af4c240cc6af34c7f5087cbf7a3bee0f9ecdc72d7609931e8
-  data.tar.gz: d7a52d18d78bcfe948ab762399bcab78592209042ca9b0749398db947ac82100e76fd8813fc856a196bc0ff84ae5407ec5333dc508d57f404baae17ae5b71a4b
+  metadata.gz: b56514cc63f9d71506a7478e8f78a9c1cdaa002e3cf9f42ca43acde04aba81a9c64eb5e2c13f3e84c201a0e5f47835099d11ab25f1ba109c3809455c2475ab2d
+  data.tar.gz: b7d5da12f866ef3a038b82a19bf18bc2cda862e12710819ed2d8d5e32aa7d9bc855148751d3554fd1dfd1f1b8b270485060b3159053466cba0fad3e253d7d2c7

data/README.md

@@ -7,6 +7,14 @@
 
 Versatile async database based jobs for rails.
 
+## Why
+
+I did this gem to:
+
+- Avoid the need to install another admin interface.
+- Simplify the job api by having close integration to rails.
+- Using sql instead of redis to never lose jobs.
+
 ## Install
 
 Put this line in your Gemfile:
@@ -23,10 +31,10 @@ $ bundle
 
 Generate the sidejobs configuration and migration file:
 ```
-bundle exec rails g sidejobs:install
+$ bundle exec rails g sidejobs:install
 ```
 
-The default configuration options are:
+Set the global settings:
 ```ruby
 Sidejobs.configure do |config|
   config.max_attempts = 3
@@ -37,7 +45,7 @@ end
 
 Run the migration to create the sidejobs table:
 ```
-bundle exec rake db:migrate
+$ bundle exec rake db:migrate
 ```
 
 Assign the sidejobs adapter to the environments:
@@ -49,12 +57,18 @@ end
 
 ## Usage
 
-Start the daemon using the rake task:
+### Daemon
+
+To control the daemon, use the rake tasks:
 ```
-bundle exec rake sidejobs:start
+$ bundle exec rake sidejobs:start
+$ bundle exec rake sidejobs:stop
+$ bundle exec rake sidejobs:restart
 ```
 
-Now you can deliver mails using deliver_later:
+### Queue
+
+You can deliver mails using deliver_later:
 ```ruby
 UserMailer.invite('someone@mail.com').deliver_later
 ```
@@ -64,13 +78,13 @@ Or perform jobs using perform_later:
 SendNewsletterJob.perform_later
 ```
 
-Management is done programtically using Sidejobs::Job model:
+### Management
+
+No admin interface, all is done 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).

data/Rakefile

@@ -13,6 +13,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
 task default: :test

data/lib/generators/sidejobs/{install_generator.rb → install/install_generator.rb}

@@ -2,13 +2,13 @@ require 'rails/generators'
 
 module Sidejobs
   module Generators
-    class InstallGenerator < Rails::Generators::Base
+    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'
+      def create_initializer_file
+        copy_file 'initializer.rb', 'config/initializers/sidejobs.rb'
       end
 
       def create_migration_file

data/lib/generators/sidejobs/{templates → install/templates}/migration.rb

@@ -1,11 +1,7 @@
 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.jsonb :data
       t.string :queue
       t.string :status, default: 'pending'
       t.integer :priority, default: 0

data/lib/sidejobs/job.rb

@@ -1,6 +1,6 @@
 module Sidejobs
   class Job < ActiveRecord::Base
-    self.table_name = 'sidejobs'
+
     STATUS = %w(pending processing failing complete)
 
     STATUS.each do |name|
@@ -17,5 +17,9 @@ module Sidejobs
     validates_inclusion_of :status, within: STATUS
     validates_numericality_of :priority, :attempts, only_integer: true
 
+    def self.table_name
+      'sidejobs'
+    end
+
   end
 end

data/lib/sidejobs/railtie.rb

@@ -1,7 +1,7 @@
 module Sidejobs
   class Railtie < Rails::Railtie
 
-    initializer :sidejobs do
+    initializer 'sidejobs.extensions' do
       ::ActiveJob::QueueAdapters.include(
         Sidejobs::Extensions::ActiveJob::QueueAdapters
       )

data/lib/sidejobs/version.rb

@@ -1,3 +1,5 @@
 module Sidejobs
-  VERSION = '0.0.1'
+
+  VERSION = '4.0.0.0'
+
 end

data/lib/tasks/sidejobs.rake

@@ -1,10 +1,15 @@
 namespace :sidejobs do
+  desc 'Start daemon.'
   task start: :environment do
     Sidejobs.daemon.start
   end
+
+  desc 'Stop daemon.'
   task stop: :environment do
     Sidejobs.daemon.stop
   end
+
+  desc 'Restart daemon.'
   task restart: :environment do
     Sidejobs.daemon.restart
   end

data/test/dummy/bin/bundle

@@ -1,3 +1,4 @@
 #!/usr/bin/env ruby
+
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
 load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+
 APP_PATH = File.expand_path('../../config/application', __FILE__)
 require_relative '../config/boot'
 require 'rails/commands'

data/test/dummy/bin/rake

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+
 require_relative '../config/boot'
 require 'rake'
 Rake.application.run

data/test/dummy/bin/setup

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+
 require 'pathname'
 
 # path to your application root.
@@ -8,7 +9,7 @@ Dir.chdir APP_ROOT do
   # This script is a starting point to setup your application.
   # Add necessary setup steps to this file:
 
-  puts "== Installing dependencies =="
+  puts '== Installing dependencies =='
   system 'gem install bundler --conservative'
   system 'bundle check || bundle install'
 

data/test/dummy/config/database.yml.travis

@@ -1,12 +1,3 @@
-mysql: &mysql
-  adapter: <%= 'jdbc' if RUBY_ENGINE == 'jruby' %>mysql<%= '2' if RUBY_ENGINE != 'jruby' %>
-
-postgres: &postgres
-  adapter: <%= 'jdbc' if RUBY_ENGINE == 'jruby' %>postgresql
-
-sqlite: &sqlite
-  adapter: <%= 'jdbc' if RUBY_ENGINE == 'jruby' %>sqlite3
-
 test:
-  <<: *<%= ENV['DB'] %>
-  database: <%= ENV['DB'] == 'sqlite' ? 'db/travis.sqlite3' : 'travis' %>
+  adapter: <%= 'jdbc' if RUBY_ENGINE == 'jruby' %>postgresql
+  database: travis

data/test/dummy/config/environments/development.rb

@@ -39,11 +39,6 @@ Rails.application.configure do
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
 
-  # Set activejob adapter.
+  # Set queue adapter.
   config.active_job.queue_adapter = :sidejobs
-
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
 end

data/test/dummy/config/environments/test.rb

@@ -13,7 +13,7 @@ Rails.application.configure do
   config.eager_load = false
 
   # Configure static file server for tests with Cache-Control for performance.
-  config.serve_static_files  = true
+  config.serve_static_files = true
   config.static_cache_control = 'public, max-age=3600'
 
   # Show full error reports and disable caching.
@@ -40,6 +40,6 @@ Rails.application.configure do
   # Raises error for missing translations
   # config.action_view.raise_on_missing_translations = true
 
-  # Set activejob adapter.
+  # Set queue adapter.
   config.active_job.queue_adapter = :sidejobs
 end

data/test/dummy/config/initializers/mime_types.rb

@@ -1,4 +1,4 @@
 # Be sure to restart your server when you modify this file.
 
 # Add new mime types for use in respond_to blocks:
-# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register 'text/richtext', :rtf

data/test/dummy/config/secrets.yml

@@ -11,12 +11,12 @@
 # if you're sharing your code publicly.
 
 development:
-  secret_key_base: ed24994bc56ed26e162af469d5bcc0b7e9bd3ce6aad6613e2415d07c459264c337ecde0a8a346137f6647ddbb8a19bbe4c3ca4428a08e2656b098b6c2131ef15
+  secret_key_base: 2c1c8d4cbaa726b21aa6483b7d556125f4897508e2b94f8b3ddaec675168382c9b3b6eb5a9359d2fade03f539c16ac1ef905891c2410f2fd00b83b76c1666feb
 
 test:
-  secret_key_base: 68a2537b2e96696ba28be32feb40fcbd35d7783afbcedf2139f054b1d79ffc31c1f26a9bf9a916cb67f191a6c69a3660878d825cc888c2598a15ab779df6f10c
+  secret_key_base: 9dd531171128e7c3d11dd2c5c18c84ba43d29b677043002634a6f4d58bf2687a283b7b6dc6af741d63c3824f11fa1f858010d7c2509a932023f2ece0d3bfe6cf
 
 # Do not keep production secrets in the repository,
 # instead read values from the environment.
 production:
-  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>
+  secret_key_base: <%= ENV['SECRET_KEY_BASE'] %>

data/test/dummy/db/migrate/20161022211612_create_sidejobs.rb

@@ -1,11 +1,7 @@
 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.jsonb :data
       t.string :queue
       t.string :status, default: 'pending'
       t.integer :priority, default: 0