scout 1.1.8 → 2.0.4

data/lib/scout/command/test.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby -wKU
+
+require "pp"
+
+module Scout
+  class Command
+    class Test < Command
+      def run
+        plugin, options = @args
+        
+        # read the plugin_code from the file specified
+        plugin_code    = File.read(plugin)
+        plugin_options = if options.to_s[0, 1] == "{"
+          eval(options)  # options from command-line
+        elsif 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) { |f| YAML.load(f) }["options"].
+                 map { |name, details| [name, details["default"]] }.flatten ]
+        else
+          Hash.new
+        end
+
+        Scout::Server.new(nil, nil, history, log) do |scout|
+          pp scout.process_plugin( :interval  => 0,
+                                   :plugin_id => 1,
+                                   :name      => "Local Plugin",
+                                   :code      => plugin_code,
+                                   :options   => plugin_options,
+                                   :path      => plugin )
+        end  
+      end
+    end
+  end
+end

data/lib/scout/command.rb

@@ -0,0 +1,225 @@
+#!/usr/bin/env ruby -wKU
+
+require "optparse"
+require "logger"
+require "fileutils"
+
+module Scout
+  class Command
+    def self.user
+      @user ||= ENV["USER"] || ENV["USERNAME"] || "root"
+    end
+    
+    def self.program_name
+      @program_name ||= File.basename($PROGRAM_NAME)
+    end
+
+    def self.program_path
+      @program_path ||= File.expand_path($PROGRAM_NAME)
+    end
+    
+    def self.usage
+      @usage
+    end
+
+    def self.parse_options(argv)
+      options = { }
+
+      ARGV.options do |opts|
+        opts.banner = "Usage:"
+
+        opts.separator "  Normal checkin with server:"
+        opts.separator "    #{program_name} [OPTIONS] CLIENT_KEY"
+        opts.separator "    ... OR ..."
+        opts.separator "    #{program_name} [OPTIONS] run CLIENT_KEY"
+        opts.separator "  Install:"
+        opts.separator "    #{program_name}"
+        opts.separator "    ... OR ..."
+        opts.separator "    #{program_name} [OPTIONS] install"
+        opts.separator "  Local plugin testing:"
+        opts.separator "    #{program_name} [OPTIONS] test " +
+                       "PATH_TO_PLUGIN [PLUGIN_OPTIONS]"
+        opts.separator "  Clone a client setup:"
+        opts.separator "    #{program_name} [OPTIONS] clone " +
+                       "CLIENT_KEY NEW_CLIENT_NAME"
+        opts.separator ""
+        opts.separator "CLIENT_KEY is the indentification key assigned to"
+        opts.separator "this client by the server."
+        opts.separator ""
+        opts.separator "PATH_TO_PLUGIN is the file system path to a Ruby file"
+        opts.separator "that contains a Scout plugin."
+        opts.separator ""
+        opts.separator "PLUGIN_OPTIONS can be the code for a Ruby Hash or the"
+        opts.separator "path to a YAML options file containing defaults.  These"
+        opts.separator "options will be used for the plugin run."
+        opts.separator ""
+        opts.separator "NEW_CLIENT_NAME is name you wish to use for the new"
+        opts.separator "client the server creates."
+        opts.separator ""
+        opts.separator "Note: This client is meant to be installed and"
+        opts.separator "invoked through cron or any other scheduler."
+        opts.separator ""
+        opts.separator "Specific Options:"
+
+        opts.on( "-s", "--server SERVER", String,
+                 "The URL for the server to report to." ) do |url|
+          options[:server] = url
+        end
+
+        opts.separator ""
+
+        opts.on( "-d", "--data DATA", String,
+                 "The data file used to track history." ) 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.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
+        
+        opts.on( "-V", "--version",
+                 "Display the current version") do |version|
+          puts Scout::VERSION::STRING
+          exit
+        end
+
+        begin
+          opts.parse!
+          @usage = opts.to_s
+        rescue
+          puts opts
+          exit
+        end
+      end
+      
+      options
+    end
+    private_class_method :parse_options
+    
+    def self.dispatch(argv)
+      options = parse_options(argv)
+      command = if name_or_key = argv.shift
+                  if cls = Scout::Command.const_get(name_or_key.capitalize) \
+                             rescue nil
+                    cls.new(options, argv)
+                  else
+                    Run.new(options, [name_or_key] + argv)
+                  end
+                else
+                  Install.new(options, argv)
+                end
+      command.create_pid_file_or_exit.run
+    end
+    
+    def initialize(options, args)
+      @server  = options[:server]  || "https://scoutapp.com/"
+      @history = options[:history] ||
+                 File.join( File.join( (File.expand_path("~") rescue "/"),
+                                       ".scout" ),
+                            "client_history.yaml" )
+      @verbose = options[:verbose] || false
+      @level   = options[:level]   || "info"
+      
+      @args    = args
+    end
+    
+    attr_reader :server, :history
+    
+    def config_dir
+      return @config_dir if defined? @config_dir
+      @config_dir = File.dirname(history)
+      FileUtils.mkdir_p(@config_dir) # ensure dir exists
+      @config_dir
+    end
+    
+    def verbose?
+      @verbose
+    end
+    
+    def log
+      return @log if defined? @log
+      @log = if verbose?
+               log                 = Logger.new($stdout)
+               log.datetime_format = "%Y-%m-%d %H:%M:%S "
+               log.level           = level
+               log
+             else
+               nil
+             end
+    end
+    
+    def level
+      Logger.const_get(@level.upcase) rescue Logger::INFO
+    end
+    
+    def user
+      @user ||= Command.user
+    end
+    
+    def program_name
+      @program_name ||= Command.program_name
+    end
+
+    def program_path
+      @program_path ||= Command.program_path
+    end
+    
+    def usage
+      @usage ||= Command.usage
+    end
+    
+    def create_pid_file_or_exit
+      pid_file = File.join(config_dir, "scout_client_pid.txt")
+      begin
+        File.open(pid_file, File::CREAT|File::EXCL|File::WRONLY) do |pid|
+          pid.puts $$
+        end
+        at_exit do
+          begin
+            File.unlink(pid_file)
+          rescue
+            log.error "Unable to unlink pid file:  #{$!.message}" if log
+          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 check the running process
+        end
+        if running
+          log.warn "Process #{pid} was already running" if log
+          exit
+        else
+          log.info "Stale PID file found.  Clearing it and reloading..." if log
+          File.unlink(pid_file) rescue nil
+          retry
+        end
+      end
+      
+      self
+    end
+  end
+end
+
+# dynamically load all available commands
+Dir.glob(File.join(File.dirname(__FILE__), *%w[command *.rb])) do |command|
+  require command
+end

data/lib/scout/plugin.rb

@@ -15,11 +15,107 @@ module Scout
     end
 
     # Creates a new Scout Plugin to run.
-    # 
     def initialize(last_run, memory, options)
       @last_run = last_run
       @memory   = memory
       @options  = options
     end
+    
+    def option(name)
+      @options[name] ||
+      @options[name.is_a?(String) ? name.to_sym : String(name)]
+    end
+
+    # Builds the data to send to the server.
+    #
+    # We programatically define several helper methods for creating this data.
+    # 
+    # Usage:
+    # 
+    #   reports << {:data => "here"}
+    #   report(:data => "here")
+    #   add_report(:data => "here")
+    # 
+    #   alerts << {:subject => "subject", :body => "body"}
+    #   alert("subject", "body")
+    #   alert(:subject => "subject", :body => "body")
+    #   add_alert("subject", "body")
+    #   add_alert(:subject => "subject", :body => "body")
+    # 
+    #   errors << {:subject => "subject", :body => "body"}
+    #   error("subject", "body")
+    #   error(:subject => "subject", :body => "body")
+    #   add_error("subject", "body")
+    #   add_error(:subject => "subject", :body => "body")
+    #     
+    def data_for_server
+      @data_for_server ||= { :reports => [ ],
+                             :alerts  => [ ],
+                             :errors  => [ ],
+                             :memory  => { } }
+    end
+    
+    %w[report alert error].each do |kind|
+      class_eval <<-END
+        def #{kind}s
+          data_for_server[:#{kind}s]
+        end
+        
+        if "#{kind}" == "report"
+          def report(new_entry)
+            reports << new_entry
+          end
+        else
+          def #{kind}(*fields)
+            #{kind}s << ( fields.first.is_a?(Hash) ?
+                          fields.first :
+                          {:subject => fields.first, :body => fields.last} )
+          end
+        end
+        alias_method :add_#{kind}, :#{kind}
+      END
+    end
+    
+    #
+    # Usage:
+    # 
+    #   memory(:no_track)
+    #   memory.delete(:no_track)
+    #   memory.clear
+    # 
+    def memory(name = nil)
+      if name.nil?
+        data_for_server[:memory]
+      else
+        @memory[name] ||
+        @memory[name.is_a?(String) ? name.to_sym : String(name)]
+      end
+    end
+    
+    #
+    # Usage:
+    # 
+    #   remember(:name, value)
+    #   remember(:name1, value1, :name2, value2)
+    #   remember(:name => value)
+    #   remember(:name1 => value1, :name2 => value2)
+    #   remember(:name1, value1, :name2 => value2)
+    # 
+    def remember(*args)
+      hashes, other = args.partition { |value| value.is_a? Hash }
+      hashes.each { |hash| memory.merge!(hash) }
+      (0...other.size).step(2) { |i| memory.merge!(other[i] => other[i + 1]) }
+    end
+    
+    #
+    # Old plugins will work because they override this method.  New plugins can
+    # now leave this method in place, add a build_report() method instead, and
+    # use the new helper methods to build up content inside which will
+    # automatically be returned as the end result of the run.
+    # 
+    def run
+      build_report
+      data_for_server
+    end
   end
 end

data/lib/scout/server.rb

@@ -14,7 +14,8 @@ module Scout
     URLS = { :plan   => "/clients/CLIENT_KEY/plugins.scout?version=CLIENT_VERSION",
              :report => "/clients/CLIENT_KEY/plugins/PLUGIN_ID/reports.scout?version=CLIENT_VERSION",
              :error  => "/clients/CLIENT_KEY/plugins/PLUGIN_ID/errors.scout?version=CLIENT_VERSION",
-             :alert  => "/clients/CLIENT_KEY/plugins/PLUGIN_ID/alerts.scout?version=CLIENT_VERSION" }
+             :alert  => "/clients/CLIENT_KEY/plugins/PLUGIN_ID/alerts.scout?version=CLIENT_VERSION",
+             :clone  => "/clients/CLIENT_KEY/clone_from?version=CLIENT_VERSION" }
 
     # 
     # A plugin cannot take more than PLUGIN_TIMEOUT seconds to execute, 
@@ -96,6 +97,7 @@ module Scout
           eval(plugin[:code], TOPLEVEL_BINDING, plugin[:path] || plugin[:name])
           info "Plugin compiled."
         rescue Exception
+          raise if $!.is_a? SystemExit
           error "Plugin would not compile: #{$!.message}"
           return
         end
@@ -113,6 +115,7 @@ module Scout
             error "Plugin took too long to run."
             return
           rescue Exception
+            raise if $!.is_a? SystemExit
             error "Plugin failed to run: #{$!.backtrace}"
           end
           info "Plugin completed its run."
@@ -151,6 +154,7 @@ module Scout
           Plugin.last_defined = nil
           info "Plugin Removed."
         rescue
+          raise if $!.is_a? SystemExit
           error "Unable to remove plugin."
         end
       end
@@ -223,11 +227,28 @@ module Scout
       info "Error sent."
     end
     
+    def clone_client(new_name, success_output)
+      url = urlify(:clone)
+      debug "Sending clone request to #{url}..."
+      post( url,
+            "Unable to send clone request to server.",
+            "client[name]" => new_name ) do |response|
+        case server_reply = response.body
+        when /\AError:/i
+          fatal "Clone error."
+          abort server_reply
+        else
+          info "Client cloned."
+          puts success_output.gsub(/\bCLIENT_KEY\b/, server_reply.strip)
+        end
+      end
+    end
+    
     private
 
     def urlify(url_name, options = Hash.new)
       return unless @server
-      options.merge!(:client_version => Scout::VERSION)
+      options.merge!(:client_version => Scout::VERSION::STRING)
       URI.join( @server,
                 URLS[url_name].
                   gsub(/\bCLIENT_KEY\b/, @client_key).
@@ -278,6 +299,7 @@ module Scout
       fatal "Request timed out."
       exit
     rescue Exception
+      raise if $!.is_a? SystemExit
       fatal "An HTTP error occurred:  #{$!.message}"
       exit
     end

data/lib/scout/version.rb

@@ -0,0 +1,9 @@
+module Scout
+  module VERSION #:nodoc:
+    MAJOR = 2
+    MINOR = 0
+    TINY  = 4
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/scout.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby -wKU
 
+require "scout/version"
+require "scout/command"
 require "scout/plugin"
 require "scout/server"
-
-module Scout
-  VERSION = "1.1.8".freeze
-end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/scout.rb'}"
+puts "Loading scout gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+GEM_NAME = 'scout' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'scout'
+
+require 'rubygems'
+begin
+  require 'newgem'
+  require 'rubyforge'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + "/../lib/#{GEM_NAME}/version.rb"
+
+version  = Scout::VERSION::STRING
+download = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+def rubyforge_project_id
+  RubyForge.new.autoconfig["group_ids"][RUBYFORGE_PROJECT]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)