delayed_job_maintenance 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4a6a047839e720b1804f931baeeea23c316aa220
+  data.tar.gz: 950eeee5f16fd791269d98086530502e93068f6a
+SHA512:
+  metadata.gz: 51fa7da64c3d98b4d67d278b8665a88f334dcf009158bb066c4f80711e160af81c6726259716e793d1579574b6841bb83ef92a81bf1bf3653cfc99191b3cd369
+  data.tar.gz: 831185187025ab0654ff1a55209936e2c6d2092c0b314b23d725164fc044aedbe1b1f062c16a3a94e1f2878c8fa7017e7a1f7e709a5dcb5f3acf60c3b796211f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 John Naegle
+
+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,59 @@
+# Delayed Job Maintenance
+
+Extends [capistrano-maitenance](https://github.com/capistrano/maintenance) to stop delayed job while the maintenance page is displayed.
+
+## Usage
+
+After capistrano-maintenence is installed and configured, your application's web
+interface will be disabled when the maintenance page is written to the server.  To
+also disable backend processing in delayed job, you need to configure
+capistrano-maintenance to also write to the delayed-job servers.
+
+In your deployment configuration, add the queue server, or whichever role you
+use for capistrano deployments to your delayed job servers:
+
+```ruby
+set :maintenance_roles, -> { roles([:web, :queue]) }
+```
+
+By default, capistrano-maintnance will write the maintenance template to
+`"#{shared_path}/public/system"`.  However, `shared_path` is a capistrano variable
+and is not available in delayed_job.  If this is different than `Rails.root.join("public", "system")`
+or you are using a different maintenance file, you will need to configure the maintenance file:
+
+Add this as an initializer:
+```ruby
+DelayedJobMaintenance.configure do |config|
+  config.maintenance_file = Rails.root.join("public", "system", "maintenance.html")
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delayed_job_maintenance'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install delayed_job_maintenance
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/GoodMeasuresLLC/delayed_job_maintenance. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/GoodMeasuresLLC/delayed_job_maintenance/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DelayedJobMaintenance'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/delayed_job_maintenance/configuration.rb

@@ -0,0 +1,22 @@
+module DelayedJobMaintenance
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  class Configuration
+    def maintenance_file=(value)
+      @maintenance_file = value
+    end
+
+    def maintenance_file
+      @maintenance_file ||= Rails.root.join("public", "system", "maintenance.html")
+    end
+  end
+end
+
+DelayedJobMaintenance.configure {}

data/lib/delayed_job_maintenance/extensions.rb

@@ -0,0 +1,5 @@
+module Delayed
+  class Worker
+    prepend Delayed::Maintenance
+  end
+end

data/lib/delayed_job_maintenance/maintenance.rb

@@ -0,0 +1,11 @@
+module Delayed
+  module Maintenance
+    def work_off(num=100)
+      if File.exist?(DelayedJobMaintenance.configuration.maintenance_file)
+        return [0,0]
+      end
+
+      super(num)
+    end
+  end
+end

data/lib/delayed_job_maintenance/version.rb

@@ -0,0 +1,3 @@
+module DelayedJobMaintenance
+  VERSION = '0.1.0'
+end

data/lib/delayed_job_maintenance.rb

@@ -0,0 +1,4 @@
+require 'delayed_job_maintenance/configuration'
+require 'delayed_job_maintenance/maintenance'
+require 'delayed_job_maintenance/extensions'
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: delayed_job_maintenance
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Naegle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: In conjunction with capistrano-maintenance, stop delayed jobs during
+  maintenance
+email:
+- john.naegle@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/delayed_job_maintenance.rb
+- lib/delayed_job_maintenance/configuration.rb
+- lib/delayed_job_maintenance/extensions.rb
+- lib/delayed_job_maintenance/maintenance.rb
+- lib/delayed_job_maintenance/version.rb
+homepage: https://github.com/goodmeasures/delayed_job_maintenance
+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.6.13
+signing_key: 
+specification_version: 4
+summary: In conjunction with capistrano-maintenance, stop delayed jobs during maintenance
+test_files: []