scout 1.1.8 → 2.0.4

data/{CHANGELOG → History.txt}

@@ -1,3 +1,31 @@
+== 2.0.4 2008-07-18
+
+* Switched to NewGem/Hoe Generators to generate gem
+
+== 2.0.3 
+
+* Added documentation for Scout#data_for_server method for new plugin creation
+* Added Version option for printing the current version
+* Removed a spurious "puts" debug statement
+
+== 2.0.2
+
+* Fixed the logging bug I introduced by moving the PID check into the Command
+  class
+
+== 2.0.1
+
+* Added some safety code to ensure SystemExit exceptions are not caught in our
+  rescue clauses
+
+== 2.0.0
+
+* Reworked scout executable to work off an underlying command structure, similar
+  to Subversion (a bare call and a call with just the key are supported for
+  backward compatibility)
+* Added various helper functions to Scout::Plugin to ease development
+* Added a client clone command for instant setups
+
 == 1.1.8
 
 * Rectifying missing checkin -- this unifies 1.1.6 and 1.1.7 changes to gem

data/{LICENSE → License.txt}

@@ -1,6 +1,7 @@
-= License Terms
+Copyright (c) 2008 Highgroove Studios
 
 Distributed under the user's choice of the {GPL Version 2}[http://www.gnu.org/licenses/old-licenses/gpl-2.0.html] (see COPYING for details) or the
 {Ruby software license}[http://www.ruby-lang.org/en/LICENSE.txt].
 
 Please contact {Highroove Studios}[http://www.highgroove.com] with any questions.
+

data/Manifest.txt

@@ -0,0 +1,33 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+bin/scout
+config/hoe.rb
+config/requirements.rb
+lib/scout.rb
+lib/scout/version.rb
+lib/scout/server.rb
+lib/scout/plugin.rb
+lib/scout/command.rb
+lib/scout/command/clone.rb
+lib/scout/command/install.rb
+lib/scout/command/run.rb
+lib/scout/command/test.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_scout.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on scout, see http://scout.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.txt

@@ -0,0 +1,76 @@
+= scout
+
+* http://scout.rubyforge.org/
+* http://scoutapp.com/
+
+== DESCRIPTION:
+
+The easier way to monitor servers and web applications.
+
+Scout makes monitoring and reporting on your web applications as flexible 
+and simple as possible.
+
+Scout is a product of Highgroove Studios.  Please visit http://scoutapp.com 
+for more information.
+
+== FEATURES/PROBLEMS:
+
+* Easy to Install
+* Leverage the Scout Plugin Community
+
+== SYNOPSIS:
+
+The Scout client has several modes of operation and commands.  The normal, intended usage is through a scheduled interval with no output.
+
+Normal checkin with server:
+  $ scout [OPTIONS] CLIENT_KEY
+  ... OR ...
+  $ scout [OPTIONS] run CLIENT_KEY
+
+Install:
+  $ scout
+  ... OR ...
+  $ scout [OPTIONS] install
+
+Local plugin testing:
+  $ scout [OPTIONS] test PATH_TO_PLUGIN [PLUGIN_OPTIONS]
+
+Clone a client setup:
+  $ scout [OPTIONS] clone CLIENT_KEY NEW_CLIENT_NAME
+
+CLIENT_KEY is the indentification key assigned to
+this client by the server.
+
+PATH_TO_PLUGIN is the file system path to a Ruby file
+that contains a Scout plugin.
+
+PLUGIN_OPTIONS can be the code for a Ruby Hash or the
+path to a YAML options file containing defaults.  These
+options will be used for the plugin run.
+
+NEW_CLIENT_NAME is name you wish to use for the new
+client the server creates.
+
+== REQUIREMENTS:
+
+* elif gem
+
+== INSTALL:
+
+After installing the scout gem:
+
+  $ sudo gem install scout
+
+Simply run:
+
+  $ scout
+
+to run the installation wizard.  You'll need your Client Key to continue.
+
+== LICENSE:
+
+Distributed under the user's choice of the {GPL Version 2}[http://www.gnu.org/licenses/old-licenses/gpl-2.0.html] (see COPYING for details) or the
+{Ruby software license}[http://www.ruby-lang.org/en/LICENSE.txt].
+
+Please contact {Highroove Studios}[http://www.highgroove.com] with any questions.
+

data/Rakefile

@@ -1,134 +1,4 @@
-require "rake/rdoctask"
-require "rake/testtask"
-require "rake/gempackagetask"
-require "rake/contrib/rubyforgepublisher"
-require "net/ssh"
-
-require "rubygems"
-require "rubyforge"
-
-dir     = File.dirname(__FILE__)
-lib     = File.join(dir, "lib", "scout.rb")
-version = File.read(lib)[/^\s*VERSION\s*=\s*(['"])(\d\.\d\.\d)\1/, 2]
-history = File.read("CHANGELOG").split(/^(===.*)/)
-changes ||= history[0..2].join.strip
-
-need_tar = true
-need_zip = true
-
-task :default => [:test]
-
-Rake::TestTask.new do |test|
-  test.libs       << "test"
-  test.test_files = [ "test/scout_test.rb" ]
-  test.verbose    = true
-end
-
-Rake::RDocTask.new do |rdoc|
-	rdoc.main     = "README"
-	rdoc.rdoc_dir = "doc/html"
-	rdoc.title    = "Scout Client Documentation"
-	rdoc.rdoc_files.include( "README",  "INSTALL",
-	                         "TODO",    "CHANGELOG",
-	                         "AUTHORS", "COPYING",
-	                         "LICENSE", "lib/" )
-end
-
-spec = Gem::Specification.new do |spec|
-	spec.name    = "scout"
-	spec.version = version
-
-	spec.platform = Gem::Platform::RUBY
-	spec.summary  = "Scout makes monitoring and reporting on your web applications as flexible and simple as possible."
-
-  # TODO: test suite
-	# spec.test_suite_file = "test/ts_all.rb"
-	spec.files           = Dir.glob("{lib,test,examples}/**/*.rb").
-	                           reject { |item| item.include?(".svn") } +
-	                       Dir.glob("{test,examples}/**/*.csv").
-	                           reject { |item| item.include?(".svn") } +
-	                           ["Rakefile", "setup.rb"]
-  spec.executables     = ["scout"]
-
-	spec.has_rdoc         = true
-	spec.extra_rdoc_files = %w[ AUTHORS COPYING README INSTALL TODO CHANGELOG
-	                            LICENSE ]
-	spec.rdoc_options     << "--title" << "Scout Client Documentation" <<
-	                         "--main"  << "README"
-
-	spec.require_path = "lib"
-	
-  spec.add_dependency "elif"
-  # spec.add_dependency "hpricot", "=0.6"
-
-	spec.author            = "Highgroove Studios"
-	spec.email             = "scout@highgroove.com"
-	spec.rubyforge_project = "scout"
-	spec.homepage          = "http://scoutapp.com"
-	spec.description       = <<END_DESC
-Scout makes monitoring and reporting on your web applications as flexible and simple as possible.
-
-Scout is a product of Highgroove Studios.
-END_DESC
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-	pkg.need_zip = need_tar
-	pkg.need_tar = need_zip
-end
-
-desc "Publishes to Scout Gem Server and Rubyforge"
-task :publish => [:package, :publish_scout, :publish_rubyforge]
-
-desc "Publish Gem to Scout Gem Server"
-task :publish_scout => [:package] do
-
-  puts "Publishing on Scout Server"
-	sh "scp -r pkg/*.gem " +
-	   "deploy@gems.scoutapp.com:/var/www/gems/gems"
-	ssh = Net::SSH.start('gems.scoutapp.com','deploy')
-	ssh_shell = ssh.shell.sync
-	ssh_out = ssh_shell.send_command "/usr/bin/gem generate_index -d /var/www/gems"
-  puts "Published, and updated gem server." if ssh_out.stdout.empty? && !ssh_out.stderr
-end
-
-desc "Publishes Gem to Rubyforge"
-task :publish_rubyforge => [:package] do
-  pkg = "pkg/#{spec.name}-#{version}"
-
-  if $DEBUG then
-    puts "release_id = rf.add_release #{spec.rubyforge_project.inspect}, #{spec.name.inspect}, #{spec.version.inspect}, \"#{pkg}.tgz\""
-    puts "rf.add_file #{spec.rubyforge_project.inspect}, #{spec.name.inspect}, release_id, \"#{pkg}.gem\""
-  end
-
-  puts "Publishing on RubyForge"
-  rf = RubyForge.new
-  puts "Logging in"
-  rf.login
-
-  c = rf.userconfig
-  c["release_notes"] = spec.description if spec.description
-  c["release_changes"] = changes if changes
-  c["preformatted"] = true
-
-  files = [(need_tar ? "#{pkg}.tgz" : nil),
-           (need_zip ? "#{pkg}.zip" : nil),
-           "#{pkg}.gem"].compact
-
-  puts "Releasing #{spec.name} v. #{version}"
-  rf.add_release spec.rubyforge_project, spec.name, version, *files
-end
-
-desc "Upload current documentation to Scout Gem Server and RubyForge"
-task :upload_docs => [:rdoc] do
-	sh "scp -r doc/html/* " +
-	   "deploy@gems.scoutapp.com:/var/www/gems/docs"
-	   
-  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
-  host = "#{config["username"]}@rubyforge.org"
-
-  remote_dir = "/var/www/gforge-projects/#{spec.rubyforge_project}"
-  local_dir = 'doc/html'
-
-  sh %{rsync -av --delete #{local_dir}/ #{host}:#{remote_dir}}
-end
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/scout

@@ -5,204 +5,5 @@ $KCODE   = "u"  # -Ku
 
 $LOAD_PATH << File.join(File.dirname(__FILE__), *%w[.. lib])
 require "scout"
-require "optparse"
-require "logger"
-require "fileutils"
-require "pp"
 
-CONFIG_DIR = File.join((File.expand_path("~") rescue "/"), ".scout")
-USER       = ENV["USER"] || ENV["USERNAME"] || "root"
-
-options = { :server  => "https://scoutapp.com/",
-            :history => File.join(CONFIG_DIR , "client_history.yaml"),
-            :verbose => false,
-            :level   => "info" }
-
-ARGV.options do |opts|
-  opts.banner = "Usage:  #{File.basename($PROGRAM_NAME)} [OPTIONS] CLIENT_KEY"
-  
-  opts.separator ""
-  opts.separator "CLIENT_KEY is the indentification key assigned to this " +
-                 "client by the server."
-  opts.separator ""
-  opts.separator "Note: This client is meant to be installed and invoked " +
-                 "through cron or any other scheduler."
-  opts.separator ""
-  opts.separator "Specific Options:"
-  
-  opts.on( "-s", "--server SERVER", String,
-           "The URL for the server this client reports to." ) do |url|
-    options[:server] = url
-  end
-  opts.on( "-p", "--plugin PLUGIN", String,
-           "The path to a plugin to run locally. " +
-           "Useful for Testing." ) do |plugin|
-    options[:plugin] = plugin
-  end  
-
-  opts.separator ""
-  
-  opts.on( "-d", "--data DATA", String,
-           "The data file used to track the history of executions." ) do |file|
-    options[:history] = file
-  end
-  opts.on( "-l", "--level LEVEL", Logger::SEV_LABEL.map { |l| l.downcase },
-           "The level of logging to report." ) do |level|
-    options[:level] = level
-  end
-  opts.on( "-o", "--plugin-options PLUGIN_OPTIONS", String,
-           "The options YAML file to pass to the plugin." ) do |plugin_options|
-    options[:plugin_options] = plugin_options
-  end  
-  
-  opts.separator "Common Options:"
-  
-  opts.on( "-h", "--help",
-           "Show this message." ) do
-    puts opts
-    exit
-  end
-  opts.on( "-v", "--[no-]verbose",
-           "Turn on logging to STDOUT" ) do |bool|
-    options[:verbose] = bool
-  end
-  
-  begin
-    opts.parse!
-    options[:client_key] = ARGV.shift if ARGV.size == 1
-  rescue
-    puts opts
-    exit
-  end
-end
-
-log                 = Logger.new($stdout)
-log.datetime_format = "%Y-%m-%d %H:%M:%S "
-log.level           = Logger.const_get(options[:level].upcase) \
-                        rescue Logger::INFO
-
-real_config_dir = File.dirname(options[:history])
-FileUtils.mkdir_p(real_config_dir) # ensure dir exists
-
-# make sure only one copy is ever running at a time
-pid_file = File.join(real_config_dir, "scout_client_pid.txt")
-begin
-  File.open(pid_file, File::CREAT|File::EXCL|File::WRONLY) { |pid| pid.puts $$ }
-  at_exit do
-    begin
-      File.unlink(pid_file)
-    rescue
-      log.error "Unable to unlink pid file:  #{$!.message}"
-    end
-  end
-rescue
-  pid     = File.read(pid_file).strip.to_i rescue "unknown"
-  running = true
-  begin
-    Process.kill(0, pid)
-  rescue Errno::ESRCH
-    running = false
-  rescue
-    # do nothing, we didn't have permission to the running process
-  end
-  if running
-    log.warn "Process #{pid} was already running"
-    exit
-  else
-    log.info "Stale PID file found.  Clearing it and reloading..."
-    File.unlink(pid_file)
-    retry
-  end
-end
-
-if [:client_key, :plugin].all? { |o| options[o].nil? } and
-   $stdin.tty?  # install wizard
-  puts <<-END_INTRO.gsub(/^ {2}/, "")
-  == Scout Installation Wizard ==
-  
-  You need the Client Key displayed in the Client Settings
-  tab. It looks like:
-  
-    6ecad322-0d17-4cb8-9b2c-a12c4541853f
-  
-  Enter the Client Key:
-  END_INTRO
-  options[:client_key] = gets.to_s.strip
-  
-  # puts "Attempting to contact the server..."
-  begin
-    Scout::Server.new( options[:server],
-                       options[:client_key],
-                       options[:history],
-                       options[:verbose] ? log : nil ) { |server| server.test }
-  
-    puts <<-END_SUCCESS.gsub(/^ {4}/, "")
-    
-    Success!
-    
-    Now, you must setup Scout to run on a scheduled basis.
-  
-    If you are using the system crontab (usually located at /etc/crontab):
-  
-    ****** START CRONTAB SAMPLE ******
-    */30 * * * *  #{USER} #{File.expand_path($PROGRAM_NAME)} #{options[:client_key]}
-    ******* END CRONTAB SAMPLE *******
-    
-    If you are using this current user's crontab (using crontab -e to edit):
-  
-    ****** START CRONTAB SAMPLE ******
-    */30 * * * *  #{File.expand_path($PROGRAM_NAME)} #{options[:client_key]}
-    ******* END CRONTAB SAMPLE *******
-    
-    For help setting up Scout with crontab, please visit:
-
-      http://scoutapp.com/help#cron
-    
-    END_SUCCESS
-  rescue SystemExit
-    puts <<-END_ERROR.gsub(/^ {4}/, "")
-    
-    Could not contact server. The client key may be incorrect. For more help,
-    please visit:
-    
-    http://scoutapp.com/help
-    
-    END_ERROR
-  end
-elsif options[:plugin]                        # local plugin
-  # read the plugin_code from the file specified
-  plugin_code = File.read(options[:plugin])
-
-  plugin_options = if options[:plugin_options].to_s[0..0] == "{"
-    eval(options[:plugin_options])  # options from command-line
-  elsif options[:plugin_options]
-    # 
-    # read the plugin_options from the YAML file specified,
-    # parse each option and use the default value specified
-    # in the options as the value to be passed to the test plugin
-    # 
-    Hash[ *File.open(options[:plugin_options]) { |f| YAML.load(f) }["options"].
-           map { |name, details| [name, details["default"]] }.flatten ]
-  else
-    Hash.new
-  end
-
-  Scout::Server.new( nil,
-                     options[:client_key],
-                     options[:history],
-                     options[:verbose] ? log : nil ) do |server|
-    pp server.process_plugin( { :interval  => 0,
-                                :plugin_id => 1,
-                                :name      => "Local Plugin",
-                                :code      => plugin_code,
-                                :options   => plugin_options,
-                                :path      => options[:plugin] } )
-  end  
-else                                          # normal run
-  Scout::Server.new( options[:server],
-                     options[:client_key],
-                     options[:history],
-                     options[:verbose] ? log : nil ) do |server|
-    server.run_plugins_by_plan
-  end
-end
+Scout::Command.dispatch(ARGV)

data/config/hoe.rb

@@ -0,0 +1,73 @@
+require 'scout/version'
+
+AUTHOR = 'Charles Brian Quinn'
+EMAIL = "hello@highgroove.com"
+DESCRIPTION = "Scout is a simple web monitoring and reporting client. It can connect to a plugin server, download plugins (written in Ruby) and run them on at specified intervals."
+GEM_NAME = 'scout' 
+RUBYFORGE_PROJECT = 'scout' 
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+EXTRA_DEPENDENCIES = [
+  ['elif', '>= 0.1.0']
+]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "seebq"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Scout::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'scout documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/scout/command/clone.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby -wKU
+
+require "uri"
+
+module Scout
+  class Command
+    class Clone < Command
+      def run
+        key, name = @args
+        abort usage if [key, name].any? { |arg| arg.nil? or arg.empty? }
+        
+        Scout::Server.new(server, key, history, log) do |scout|
+          scout.clone_client(
+            name,
+            "*/30 * * * *  #{user} #{program_path} CLIENT_KEY"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/scout/command/install.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby -wKU
+
+module Scout
+  class Command
+    class Install < Command
+      def run
+        abort usage unless $stdin.tty?
+        
+        puts <<-END_INTRO.gsub(/^ {8}/, "")
+        === Scout Installation Wizard ===
+
+        You need the Client Key displayed in the Client Settings tab.
+        It looks like:
+
+          6ecad322-0d17-4cb8-9b2c-a12c4541853f
+
+        Enter the Client Key:
+        END_INTRO
+        key = gets.to_s.strip
+
+        puts "\nAttempting to contact the server..."
+        begin
+          Scout::Server.new(server, key, history, log) { |scout| scout.test }
+
+          puts <<-END_SUCCESS.gsub(/^ {10}/, "")
+          Success!
+
+          Now, you must setup Scout to run on a scheduled basis.
+
+          If you are using the system crontab
+          (usually located at /etc/crontab):
+
+          ****** START CRONTAB SAMPLE ******
+          */30 * * * *  #{user} #{program_path} #{key}
+          ******  END CRONTAB SAMPLE  ******
+
+          If you are using this current user's crontab
+          (using crontab -e to edit):
+
+          ****** START CRONTAB SAMPLE ******
+          */30 * * * *  #{program_path} #{key}
+          ******  END CRONTAB SAMPLE  ******
+
+          For help setting up Scout with crontab, please visit:
+
+            http://scoutapp.com/help#cron
+
+          END_SUCCESS
+        rescue SystemExit
+          puts <<-END_ERROR.gsub(/^ {10}/, "")
+
+          Could not contact server. The client key may be incorrect.
+          For more help, please visit:
+
+          http://scoutapp.com/help
+
+          END_ERROR
+        end
+      end
+    end
+  end
+end

data/lib/scout/command/run.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby -wKU
+
+module Scout
+  class Command
+    class Run < Command
+      def run
+        key = @args.first
+        Scout::Server.new(server, key, history, log) do |scout|
+          scout.run_plugins_by_plan
+        end
+      end
+    end
+  end
+end