makandra_sidekiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21ef8f6ae9bafcc529abfd8fb14321d25bfbaff6
+  data.tar.gz: 4c57b120923a63024bab5ea9bb018651f5465dd4
+SHA512:
+  metadata.gz: 2018238e3d7d38cd812b63d68c42de8334c0bf91bc0f01d9e99089c95fda2de15028d17dc7d7a7c107440cd8ffb1c37244bcd59355a0aad3a68375648f70db54
+  data.tar.gz: 73a30c082ad3c0c65fda2f054ce36cd3631538e61aea5bf8fa3098722befa581c0b3b8a3db875b16ddb439cd4aeb9ab72e07fab704eae0ca751a2120958e2cb3

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+script: bundle exec rspec spec
+cache: bundler
+notifications:
+  email:
+    - fail@makandra.de
+branches:
+  only:
+    - master

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# makandra_sidekiq change log
+
+All notable changes to this project will be documented in this file.
+
+
+## [0.1.0][] (2016-09-29)
+
+Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in makandra-sidekiq.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Tobias Kraze
+
+MIT License
+
+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,72 @@
+# makandra_sidekiq [![Build Status](https://travis-ci.org/makandra/makandra_sidekiq.svg?branch=master)](https://travis-ci.org/makandra/makandra_sidekiq)
+
+Support code for our default sidekiq setup.
+
+Includes rake tasks to start and stop sidekiq, capistrano recipes for deployment, and a way to restart sidekiq on reboot.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'makandra_sidekiq'
+```
+
+
+## Usage
+
+### Prerequisites
+
+Your sidekiq configuration has to live in `config/sidekiq.yml`.
+
+Make sure you include at least `:pidfile` and `:logfile`. Sane values are
+
+```
+:pidfile: ./tmp/pids/sidekiq.pid
+:logfile: ./log/sidekiq.log
+```
+
+### Capistrano
+
+makandra_sidekiq requires [capistrano](https://github.com/capistrano/capistrano) >= 3.
+
+- Add the following line to your Capfile:
+
+  ```
+  require 'makandra_sidekiq/capistrano'
+  ```
+
+- Give one or more servers the `sidekiq` role.
+
+- Make sure that your pidfile is symlinked to a shared directory. For the example above, make sure that `set :linked_dirs` includes `tmp/pids`.
+
+
+### Restart sidekiq on reboot
+
+Simply add `rake sidekiq:start` as a @reboot task to your crontab.
+
+When using [whenever](https://github.com/javan/whenever), add this to your schedule.rb:
+
+```
+every :reboot do
+  rake 'sidekiq:start'
+end
+```
+
+In case you don't use whenever, this crontab entry will work:
+```
+@reboot /bin/bash -l -c 'cd /path/to/rails/root && RAILS_ENV=environment bundle exec rake sidekiq:start --silent'
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/makandra/makandra_sidekiq.
+
+
+## Credits
+
+Tobias Kraze, makandra GmbH
+
+Arne Hartherz, makandra GmbH

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/makandra_sidekiq/capistrano/tasks/sidekiq.rake

@@ -0,0 +1,37 @@
+namespace :sidekiq do
+
+  def run_task(name)
+    on roles :sidekiq do
+      within release_path do
+        with rails_env: fetch(:rails_env) do
+          execute :rake, "sidekiq:#{name}"
+        end
+      end
+    end
+  end
+
+  desc 'Quiet sidekiq (stop processing new tasks)'
+  task :quiet do
+    run_task('quiet')
+  end
+
+  desc 'Stop sidekiq'
+  task :stop do
+    run_task('stop')
+  end
+
+  desc 'Start sidekiq'
+  task :start do
+    run_task('start')
+  end
+
+  desc 'Restart sidekiq'
+  task :restart do
+    run_task('restart')
+  end
+end
+
+after 'deploy:starting', 'sidekiq:quiet'
+after 'deploy:updated', 'sidekiq:stop'
+after 'deploy:reverted', 'sidekiq:stop'
+after 'deploy:published', 'sidekiq:start'

data/lib/makandra_sidekiq/capistrano.rb

@@ -0,0 +1 @@
+load File.expand_path('capistrano/tasks/sidekiq.rake', __dir__)

data/lib/makandra_sidekiq/railtie.rb

@@ -0,0 +1,11 @@
+module MakandraSidekiq
+  if defined?(::Rails::Railtie)
+    class Railtie < ::Rails::Railtie
+
+      rake_tasks do
+        load File.expand_path('tasks/sidekiq.rake', __dir__)
+      end
+
+    end
+  end
+end

data/lib/makandra_sidekiq/sidekiq_control.rb

@@ -0,0 +1,121 @@
+require 'pathname'
+require 'yaml'
+require 'open3'
+require 'erb'
+
+module MakandraSidekiq
+  class SidekiqControl
+
+    CONFIG_PATH = ['config', 'sidekiq.yml']
+
+    def initialize(root)
+      @root = Pathname.new(root)
+      @config = load_config
+    end
+
+    def quiet
+      if running?
+        puts 'Preventing Sidekiq from accepting new jobs...'
+        run_sidekiqctl('quiet')
+      else
+        puts 'Sidekiq is not running.'
+      end
+    end
+
+    def stop
+      if running?
+        puts 'Stopping Sidekiq...'
+        run_sidekiqctl('stop')
+      else
+        puts 'Sidekiq is not running.'
+      end
+    end
+
+    def start
+      if running?
+        puts 'Sidekiq is already running.'
+      else
+        puts 'Starting Sidekiq...'
+        run_sidekiq
+      end
+    end
+
+    private
+
+    def rails_env
+      @rails_env ||= ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+    end
+
+    def config_path
+      @config_path ||= @root.join(*CONFIG_PATH)
+    end
+
+    def pid_file
+      @pid_file ||= @root.join(@config[:pidfile])
+    end
+
+    def pid
+      @pid ||= if pid_file.file?
+        pid_file.read.to_i
+      end
+    end
+
+    def running?
+      Process.kill(0, pid) if pid
+    rescue Errno::ESRCH
+      # not running
+      false
+    end
+
+    def load_config
+      messages = []
+      begin
+        config_erb = ERB.new(config_path.read)
+        config = YAML.load(config_erb.result)
+      rescue
+        messages << "Error: Could not load #{config_path}."
+      end
+      if config
+        env_config = config[rails_env]
+        config.merge!(env_config) if env_config
+        unless config[:pidfile]
+          messages << "Error: #{config_path} does not set a :pidfile"
+        end
+        unless config[:logfile]
+          messages << "Error: #{config_path} does not set a :logfile."
+        end
+      end
+      if messages.any?
+        fail messages.join("\n")
+      end
+      config
+    end
+
+    def run_sidekiqctl(command)
+      bundle_exec('sidekiqctl', command, pid_file.to_s)
+    end
+
+    def run_sidekiq
+      arguments = [
+        '--index', sidekiq_index.to_s,
+        '--environment', rails_env,
+        '--config', config_path.to_s,
+        '--daemon'
+      ]
+      bundle_exec('sidekiq', *arguments)
+    end
+
+    def sidekiq_index
+      ENV['SIDEKIQ_INDEX'] || 0
+    end
+
+    def bundle_exec(*command)
+      stdout_str, stderr_str, status = Open3.capture3('bundle', 'exec', *command, chdir: @root.to_s)
+      puts stdout_str
+      unless status.success?
+        fail "Sidekiqctl failed with message: #{stderr_str}"
+      end
+    end
+
+  end
+end

data/lib/makandra_sidekiq/tasks/sidekiq.rake

@@ -0,0 +1,31 @@
+require 'makandra_sidekiq/sidekiq_control'
+
+namespace :sidekiq do
+
+  def sidekiq_control
+    root = Rake.application.original_dir
+    @sidekiq_control ||= MakandraSidekiq::SidekiqControl.new(root)
+  end
+
+  desc 'Quiet sidekiq (stop processing new tasks)'
+  task :quiet do
+    sidekiq_control.quiet
+  end
+
+  desc 'Stop sidekiq'
+  task :stop do
+    sidekiq_control.stop
+  end
+
+  desc 'Start sidekiq'
+  task :start do
+    sidekiq_control.start
+  end
+
+  desc 'Restart sidekiq'
+  task :restart do
+    sidekiq_control.stop
+    sidekiq_control.start
+  end
+
+end

data/lib/makandra_sidekiq/version.rb

@@ -0,0 +1,3 @@
+module MakandraSidekiq
+  VERSION = "0.1.0"
+end

data/lib/makandra_sidekiq.rb

@@ -0,0 +1,2 @@
+require "makandra_sidekiq/version"
+require "makandra_sidekiq/railtie"

data/makandra_sidekiq.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'makandra_sidekiq/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "makandra_sidekiq"
+  spec.version       = MakandraSidekiq::VERSION
+  spec.authors       = ["Tobias Kraze"]
+  spec.email         = ["tobias.kraze@makandra.de"]
+
+  spec.summary       = %q{Support code for sidekiq, including rake tasks and capistrano recipes.}
+  spec.homepage      = "https://github.com/makandra/makandra_sidekiq"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'capistrano', '>= 3'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: makandra_sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tobias Kraze
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- tobias.kraze@makandra.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/setup
+- lib/makandra_sidekiq.rb
+- lib/makandra_sidekiq/capistrano.rb
+- lib/makandra_sidekiq/capistrano/tasks/sidekiq.rake
+- lib/makandra_sidekiq/railtie.rb
+- lib/makandra_sidekiq/sidekiq_control.rb
+- lib/makandra_sidekiq/tasks/sidekiq.rake
+- lib/makandra_sidekiq/version.rb
+- makandra_sidekiq.gemspec
+homepage: https://github.com/makandra/makandra_sidekiq
+licenses: []
+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.6
+signing_key: 
+specification_version: 4
+summary: Support code for sidekiq, including rake tasks and capistrano recipes.
+test_files: []
+has_rdoc: