sidekiq-bossman 0.0.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p374@sidekiq-bossman"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.18.5 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,5 @@
+Copyright (c) 2013 Nick Zalabak
+
+sidekiq-bossman is an Open Source project licensed under the terms of
+the LGPLv3 license (same as sidekiq).  Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
+for license text.

data/README.md

@@ -0,0 +1,61 @@
+# Sidekiq::Bossman
+
+The goal of Sidekiq::Bossman is to provide an easy programmatic approach
+to starting and stopping Sidekiq workers. Everything in Sidekiq::Bossman
+is nothing more than an idiomatic Ruby abstraction atop what already exists in Sidekiq.
+I was compelled to write this abstraction because I have many projects that
+have the following commands scattered about in Rake tasks, shell scripts, etc:
+
+    system "nohup bundle exec sidekiq -e #{Rails.env} -C #{Rails.root}/config/sidekiq.yml -P #{Rails.root}/tmp/pids/sidekiq.pid >> #{Rails.root}/log/sidekiq.log 2>&1 &"
+    system "if [ -f tmp/pids/sidekiq.pid ]; then bundle exec sidekiqctl stop tmp/pids/sidekiq.pid; fi"
+
+While there is nothing wrong with these commands, it felt error prone and sloppy to be
+copying and pasting this across new projects. Since it has become a pattern with some of my projects I find
+it useful.
+
+Thanks to Mike Perham for providing us such a great framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-bossman'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-bossman
+
+## Usage
+
+Start your Sidekiq workers
+
+    Sidekiq::Bossman.new(Rails.root.to_s).start_workers
+
+Stop your Sidekiq workers
+
+    Sidekiq::Bossman.new(Rails.root.to_s).stop_workers
+
+When initializing Sidekiq::Bossman it can take an options Hash, these are the defaults:
+
+    {:config => "#{project_root}/config/sidekiq.yml",
+     :pidfile => "#{project_root}/tmp/pids/sidekiq.pid",
+     :logfile => "#{project_root}/log/sidekiq.log",
+     :require => "#{project_root}",
+     :timeout => 10,
+     :verbose => false,
+     :queue => nil,
+     :concurrency => nil,
+     :daemon => true}
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/sidekiq-bossman/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  class Bossman
+    VERSION = "0.0.3"
+  end
+end

data/lib/sidekiq-bossman.rb

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'sidekiq/cli'
+
+module Sidekiq
+  class Bossman
+
+    attr_accessor :config, :pidfile,
+                  :logfile, :require,
+                  :daemon, :timeout,
+                  :verbose, :concurrency,
+                  :queue, :environment
+
+
+    ##
+    # Takes the following options that currently match the version
+    # of Sidekiq this gem depends upon:
+    # :config, :pidfile, :logfile, :require, :timeout, :verbose, :queue,
+    # :concurrency, :daemon
+    def initialize(project_root, options = {})
+
+      default_options = {:config => "#{project_root}/config/sidekiq.yml",
+                         :pidfile => "#{project_root}/tmp/pids/sidekiq.pid",
+                         :logfile => "#{project_root}/log/sidekiq.log",
+                         :require => "#{project_root}",
+                         :environment => "development",
+                         :timeout => 10,
+                         :verbose => false,
+                         :queue => nil,
+                         :concurrency => nil,
+                         :daemon => true}
+      options = default_options.merge(options)
+      options.each { |k, v| send("#{k}=", v) }
+    end
+
+    def start_workers
+      sidekiq = Sidekiq::CLI.instance
+
+      args = []
+
+      ["-r", @require].each { |arg| args << arg } unless @require.nil?
+      ["-t", @timeout.to_s].each { |arg| args << arg } unless @timeout.nil?
+      ["-L", @logfile].each { |arg| args << arg } unless @logfile.nil?
+      ["-C", @config].each { |arg| args << arg } unless @config.nil?
+      ["-P", @pidfile].each { |arg| args << arg } unless @pidfile.nil?
+      ["-q", @queue].each { |arg| args << arg } unless @queue.nil?
+      ["-c", @concurrency].each { |arg| args << arg } unless @concurrency.nil?
+      ["-e", @environment].each { |arg| args << arg } unless @environment.nil?
+      args << "-d" if @daemon == true
+      args << "-v" if @verbose == true
+
+      sidekiq.parse args
+
+      sidekiq.run
+    end
+
+    def stop_workers
+      system "if [ -f #{@pidfile} ]; then bundle exec sidekiqctl stop #{@pidfile}; fi"
+    end
+
+  end
+end

data/sidekiq-bossman.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq-bossman/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sidekiq-bossman"
+  gem.version       = Sidekiq::Bossman::VERSION
+  gem.authors       = ["Nick Zalabak"]
+  gem.email         = ["techwhizbang@gmail.com"]
+  gem.description   = %q{A Sidekiq utility that takes a programmatic approach to starting|stopping Sidekiq workers}
+  gem.summary       = %q{Start|stop your Sidekiq workers with ease}
+  gem.homepage      = "https://github.com/techwhizbang/sidekiq-bossman"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency(%q<sidekiq>, ["~> 2.7.1"])
+  gem.add_development_dependency(%q<rspec>, ["~> 2.12.0"])
+  gem.add_development_dependency(%q<rake>, ["~> 10.0.3"])
+end

data/spec/sidekiq_bossman_spec.rb

@@ -0,0 +1,47 @@
+require 'rspec'
+require File.expand_path(File.dirname(__FILE__) + "/../lib/sidekiq-bossman")
+
+describe Sidekiq::Bossman do
+
+  before do
+    @sidekiq_bossman = Sidekiq::Bossman.new(File.expand_path(File.dirname(__FILE__) + "/sidekiq_project"),
+                                            :require => "#{File.expand_path(File.dirname(__FILE__) + "/sidekiq_project")}/boot.rb",
+                                            :environment => "test",
+                                            :daemon => true)
+  end
+
+  after do
+    begin
+      Process.kill("TERM", File.read(@sidekiq_bossman.pidfile).to_i)
+    rescue
+    end
+  end
+
+  context ".start" do
+
+    it 'successfully starts the Sidekiq workers' do
+      begin
+        fork { @sidekiq_bossman.start_workers }
+        sleep 2
+      ensure
+        File.exists?(@sidekiq_bossman.pidfile).should be_true
+      end
+    end
+
+  end
+
+  context ".stop" do
+
+    it 'successfully stops the Sidekiq workers' do
+      begin
+        fork { @sidekiq_bossman.start_workers }
+        sleep 2
+        @sidekiq_bossman.stop_workers
+      ensure
+        File.exists?(@sidekiq_bossman.pidfile).should be_false
+      end
+    end
+
+  end
+
+end

data/spec/sidekiq_project/boot.rb

@@ -0,0 +1,2 @@
+require 'rubygems'
+require 'sidekiq'

data/spec/sidekiq_project/config/sidekiq.yml

@@ -0,0 +1,6 @@
+---
+:verbose: false
+:concurrency: 7
+:queues:
+  - [q1, 1]
+  - [q2, 1]

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-bossman
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Nick Zalabak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.0.3
+description: A Sidekiq utility that takes a programmatic approach to starting|stopping
+  Sidekiq workers
+email:
+- techwhizbang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq-bossman.rb
+- lib/sidekiq-bossman/version.rb
+- sidekiq-bossman.gemspec
+- spec/sidekiq_bossman_spec.rb
+- spec/sidekiq_project/boot.rb
+- spec/sidekiq_project/config/sidekiq.yml
+homepage: https://github.com/techwhizbang/sidekiq-bossman
+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'
+      segments:
+      - 0
+      hash: 1911942347009138160
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1911942347009138160
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Start|stop your Sidekiq workers with ease
+test_files:
+- spec/sidekiq_bossman_spec.rb
+- spec/sidekiq_project/boot.rb
+- spec/sidekiq_project/config/sidekiq.yml