beantool 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75ca861d4936deea02255461f8119d961affa9c3
+  data.tar.gz: b1f994f111ba2f9a6fa5c1f09d83eba842c4c4bc
+SHA512:
+  metadata.gz: 6c2ec98459c4bc053823ff658417ef4cbcb9a722b62ad8fa706f442425ef7d57f6cc346e7d7eabca39dafabbe36c438d5777813760ca01f115a49a0747c384e7
+  data.tar.gz: 9ac90d2cb2b74e3d974ac4bb6127bf4a05e2b5de73875672799dc16a055f3563e7230ffc2df4d9fa14dbe61182fdf961268539ad2d9e1ae59ce605e84e30eb33

data/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (C) 2014 Justin Langhorst 
+
+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,7 @@
+Beantool
+========
+
+Beantool is a command line utility for monitoring and administering a Beanstalkd pool.
+
+Refer to `beantool -h` for usage information.
+

data/bin/beantool

@@ -0,0 +1,176 @@
+#!/usr/bin/env ruby
+
+require 'ostruct'
+require 'optparse'
+require File.expand_path(File.join('..', 'lib', 'beantool'), File.dirname(__FILE__))
+
+options = OpenStruct.new
+beanfile = File.join(ENV['HOME'], '.beantool')
+options.hosts = File.exist?(beanfile) ? IO.readlines(beanfile).map{ |l| l.chomp } : []
+
+OptionParser.new do |opts|
+  opts.program_name = Beantool::NAME
+  opts.banner = "Usage: #{opts.program_name} [options]"
+
+  opts.separator("")
+  opts.separator("General Options:")
+  opts.separator("")
+
+  opts.on("-a", "--address [ADDRESS]",
+          "Beanstalkd address",
+          "    Specify multiple addresses with",
+          "    additional arguments. Permanently",
+          "    set this argument by creating a",
+          "    '.beantool' file in your home",
+          "    directory, each line representing",
+          "    a Beanstalkd address.") do |host|
+    options.hosts << host
+  end
+
+  opts.separator("")
+  opts.separator("Monitoring Options:")
+  opts.separator("")
+
+  opts.on("-l", "--list", "List all tubes") { options.list = true }
+
+  opts.on("-s", "--stats [TUBE]",
+          "Display stats for entire instance",
+          "    Optionally provide a comma separated",
+          "    list of tubes for tube stats.") do |tubes|
+    tubes = tubes.to_s.split(',')
+    options.stats = tubes
+  end
+
+  opts.on("-i", "--inspect-job [ID]",
+          "Inspect job") { |id| options.inspect_job = id }
+
+  opts.on("-p", "--peek-ready [TUBE]",
+          "Peek a ready job") { |tube| options.peek_ready = tube }
+
+  opts.on("-b", "--peek-buried [TUBE]",
+          "Peek a buried job") { |tube| options.peek_buried = tube }
+
+  opts.on("-d", "--peek-delayed [TUBE]",
+          "Peek a delayed job") { |tube| options.peek_delayed = tube }
+
+  opts.separator("")
+  opts.separator("Administering Options:")
+  opts.separator("")
+
+  opts.on("-k", "--kick [NUM]",
+          "Kick each tube NUM times") { |num| options.kick = num.to_i }
+
+  opts.on("-c", "--create [JOB]",
+          "Create a job",
+          "    Use in conjunction with '--move-to',",
+          "    to create a job on a specific tube.",
+          "    The 'default' tube will be used if a",
+          "    '-t' argument is not provided.") { |job| options.create = job }
+
+ opts.on("-m", "--move-from [TUBE]",
+          "Move jobs from tube",
+          "    Use in conjunction with '-t',",
+          "    '--move-to'") { |tube| options.move_from = tube }
+
+  opts.on("-t", "--move-to [TUBE]",
+          "Move jobs to tube",
+          "    Use in conjunction with '-m',",
+          "    '--move-from'. You can also specify",
+          "    this argument in conjunction with '-e',",
+          "    '--export', as a means of backup.") { |tube| options.move_to = tube }
+
+  opts.on("-P", "--purge [TUBE]",
+          "Purge jobs from tube") { |tube| options.purge = tube.split(',') }
+
+  opts.on("-I", "--import [TUBE]",
+          "Import tube from '--filename',",
+          "    A default filename of '[tube].yaml'",
+          "    is used if an '-f' argument is not",
+          "    provided.") { |tube| options.import = tube }
+
+  opts.on("-E", "--export [TUBE]",
+          "Export tube to '--filename'",
+          "    A default filename of '[tube].yaml'",
+          "    is used if an '-f' argument is not",
+          "    provided.") { |tube| options.export = tube }
+
+  opts.on("-f", "--filename [FILENAME]", 
+          "Filename for import/export") { |file| options.filename = file }
+
+  opts.on_tail.separator("")
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-v", "--version", "Show version") do
+    puts Beantool.version
+    exit
+  end
+ 
+end.parse!
+
+options.hosts << 'localhost:11300' if options.hosts.empty?
+
+beantool = nil
+
+begin
+  beantool = Beantool.new(options.hosts)
+rescue Beaneater::NotConnected
+  puts "unable to connect to beanstalkd at #{options.hosts.inspect}"
+  exit
+end
+
+# Handle monitoring options
+
+puts beantool.tubes if options.list
+
+if options.stats
+  if options.stats.empty?
+    puts beantool.stats
+  else
+    options.stats.each_with_index do |tube,index|
+      puts beantool.tube_stats(tube)
+      puts "\n" unless index == options.stats.size-1
+    end
+  end
+end
+
+puts beantool.inspect_job(options.inspect_job) if options.inspect_job
+
+puts beantool.peek(options.peek_ready, :ready) if options.peek_ready
+puts beantool.peek(options.peek_buried, :buried) if options.peek_buried
+puts beantool.peek(options.peek_delayed, :delayed) if options.peek_delayed
+
+# Handle adminstering options
+
+if options.kick
+  beantool.kick(options.kick || 1)
+end
+
+if options.export
+  beantool.move(options.export, options.move_to) if options.move_to
+  beantool.export(options.export, options.filename || options.export+'.yaml')
+end
+
+if options.import
+  begin
+    options.filename ||= options.import+'.yaml'
+    beantool.import(options.import, options.filename)
+  rescue Errno::ENOENT
+    puts "#{options.filename} does not exist"
+  end
+end
+
+if options.move_from && options.move_to
+  beantool.move(options.move_from, options.move_to)
+end
+
+if options.purge
+  beantool.purge(options.purge)
+end
+
+if options.create
+  beantool.create(options.create, options.move_to || 'default')
+end

data/lib/beantool.rb

@@ -0,0 +1,92 @@
+require 'rubygems'
+require 'beaneater'
+
+class Beantool
+  NAME = 'beantool'
+  VERSION = '0.4.0'
+
+  def self.version 
+    [NAME, VERSION].join(' ') 
+  end
+
+  attr_reader :beanstalk
+
+  def initialize(addrs='0.0.0.0:11300')
+    @beanstalk = Beaneater::Pool.new(Array(addrs))
+  end
+
+  #
+  # Monitoring
+  #
+
+  def tubes
+    beanstalk.tubes.all.map{|t| t.name}.join("\n")
+  end
+
+  def stats
+    beanstalk.stats.keys.map{|stat| "#{stat}: #{beanstalk.stats.send(stat)}"}.join("\n")
+  end
+
+  def tube_stats(name)
+    tube = beanstalk.tubes.find(name)
+    tube.stats.keys.map{|stat| "#{stat}: #{tube.stats.send(stat)}"}.join("\n")
+  rescue Beaneater::NotFoundError
+    "#{name} not found"
+  end
+
+  def inspect_job(id)
+    job = beanstalk.jobs.peek(id)
+    return "job #{id} not found" if job.nil?
+    job.stats.keys.map{|stat| "#{stat}: #{job.stats.send(stat)}"}.concat(["body: #{job.body.inspect}"]).join("\n")
+  end
+
+  def peek(name, state)
+    job = beanstalk.tubes.find(name).peek(state.to_sym)
+    return "job not found" if job.nil?
+    ["id: #{job.id}", "body: #{job.body.inspect}"].join("\n")
+  rescue Beaneater::NotFoundError
+    "#{name} not found"
+  end
+
+  #
+  # Administering
+  #
+
+  def kick(num)
+    beanstalk.tubes.all.each{|tube| tube.kick(num)}
+  end
+
+  def import(tubename, filename)
+    tube = beanstalk.tubes.find(tubename)
+    YAML.load_file(filename).each { |job| tube.put(job) }
+  end
+
+  def export(tubename, filename)
+    jobs = Array.new 
+    tube = beanstalk.tubes.find(tubename)
+    while tube.peek(:ready)
+      job = tube.reserve
+      jobs << job.body
+      job.delete
+    end
+    File.open(filename, 'a') { |f| YAML.dump(jobs, f) }
+  end
+
+  def create(job, tubename)
+    beanstalk.tubes.find(tubename).put(job)
+  end
+
+  def move(from, to)
+    source = beanstalk.tubes.find(from)
+    destination = beanstalk.tubes.find(to)
+    while source.peek(:ready)
+      job = source.reserve
+      destination.put(job.body)
+      job.delete
+    end
+  end
+
+  def purge(tubenames)
+    tubenames.each { |tube| beanstalk.tubes.find(tube).clear }
+  end
+end

data/test/beantool_test.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require File.expand_path(File.join('..', 'lib', 'beantool'), File.dirname(__FILE__))
+
+class BeantoolTest < MiniTest::Test
+  def setup
+    @beantool = Beantool.new(['localhost:11300'])
+  end
+
+  def teardown
+    @beantool = nil
+  end
+
+  def test_true
+    assert true
+  end
+end
+

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: beantool
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Justin Langhorst
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: beaneater
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Beantool is a command line utility for monitoring and adminstering a
+  Beanstalkd pool.
+email:
+- the@justinlanghorst.com
+executables:
+- beantool
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- bin/beantool
+- lib/beantool.rb
+- test/beantool_test.rb
+homepage: http://rubygems.org/gems/beantool
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: CLI tool for Beanstalkd
+test_files:
+- test/beantool_test.rb