scout 2.0.4 → 2.0.5

data/test/scout_test.rb

@@ -0,0 +1,91 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/scout'
+require "logger"
+
+class ScoutTest < Test::Unit::TestCase
+
+  SCOUT_TEST_SERVER = "http://localhost:4000/"
+  SCOUT_TEST_VALID_CLIENT_KEY = "valid key goes here"
+  SCOUT_TEST_VALID_PLUGIN_ID = "valid plugin id goes here"
+
+  def setup
+    @log = Logger.new('test.log')
+    @scout_server = create_scout_server(SCOUT_TEST_SERVER,
+                                        SCOUT_TEST_VALID_CLIENT_KEY)
+  end
+  
+  def teardown
+    File.delete('test.log')
+  end
+
+  def test_create
+    assert @scout_server
+  end
+
+  def test_should_initialize_new_server
+    ["@history_file", "@client_key", "@logger", "@server", "@history"].each do |var|
+      assert @scout_server.instance_variables.include?(var)
+    end
+  end
+  
+  def test_should_send_report
+    report = {:server_load => "99.99"}
+    assert_does_not_exit { @scout_server.send_report(report, SCOUT_TEST_VALID_PLUGIN_ID) }    
+    assert_log_contains("Report sent")
+  end
+  
+  def test_should_not_send_report_with_invalid_client_key
+    @scout_server_invalid_client_key = create_scout_server(SCOUT_TEST_SERVER, 
+                                       "1111-2222-3333-4444-5555")
+    report = {:server_load => "99.99"}
+    assert_does_exit { @scout_server_invalid_client_key.send_report(report, SCOUT_TEST_VALID_PLUGIN_ID) }
+    assert_log_contains("Unable to send report to server")
+    assert_log_contains("An HTTP error occurred:  exit")
+  end
+  
+  def test_should_not_send_report_with_invalid_plugin_id
+    report = {:server_load => "99.99"}
+    assert_does_exit { @scout_server.send_report(report, 9999999999) }
+    assert_log_contains("Unable to send report to server")
+    assert_log_contains("An HTTP error occurred:  exit")
+  end
+  
+  def test_should_not_send_report_with_plugin_not_belonging_to_client
+    report = {:server_load => "99.99"}
+    assert_does_exit { @scout_server.send_report(report, 4) }
+    assert_log_contains("Unable to send report to server")
+    assert_log_contains("An HTTP error occurred:  exit")    
+  end
+  
+  def create_scout_server(server, client_key, history=File.join("/tmp", "client_history.yaml"), logger=@log)
+    Scout::Server.new(server, client_key, history, logger)
+  end
+  
+  def assert_log_contains(pattern)
+    @log_file = File.read('test.log')
+    assert @log_file.include?(pattern), "log does not include the pattern:\n#{pattern}\nlog contains:\n#{@log_file}"
+  end
+  
+  # asserts that the program actually exits, terminating.
+  def assert_does_exit(&block)
+    begin
+      yield
+    rescue SystemExit
+      assert true, "Expected program to not exit, but program did exit."
+      return
+    end
+    flunk "Expected program to exit, but program did not exit."
+  end
+  
+  # asserts that the program does not exit.
+  def assert_does_not_exit(&block)
+    begin
+      yield
+    rescue SystemExit
+      flunk "Expected program to not exit, but program did exit."
+      return
+    end
+    assert true, "Expected program to not exit, but program did exit."
+  end
+  
+end

metadata

@@ -1,88 +1,68 @@
 --- !ruby/object:Gem::Specification 
 name: scout
 version: !ruby/object:Gem::Version 
-  version: 2.0.4
+  version: 2.0.5
 platform: ruby
 authors: 
-- Charles Brian Quinn
+- Highgroove Studios
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-07-18 00:00:00 -04:00
+date: 2008-07-31 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: hoe
-  type: :development
+  name: elif
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: "0"
     version: 
-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.
-email: 
-- hello@highgroove.com
+description: Scout makes monitoring and reporting on your web applications as flexible and simple as possible.  Scout is a product of Highgroove Studios.
+email: scout@highgroove.com
 executables: 
 - scout
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- License.txt
-- Manifest.txt
-- PostInstall.txt
-- README.txt
-- website/index.txt
+- AUTHORS
+- COPYING
+- README
+- INSTALL
+- TODO
+- CHANGELOG
+- LICENSE
 files: 
-- 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
+- lib/scout/command.rb
+- lib/scout/plugin.rb
+- lib/scout/server.rb
+- lib/scout.rb
+- test/scout_test.rb
+- Rakefile
 - 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
+- AUTHORS
+- COPYING
+- README
+- INSTALL
+- TODO
+- CHANGELOG
+- LICENSE
 has_rdoc: true
-homepage: http://scout.rubyforge.org
-post_install_message: |+
-  
-  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.
-  
-  
+homepage: http://scoutapp.com
+post_install_message: 
 rdoc_options: 
+- --title
+- Scout Client Documentation
 - --main
-- README.txt
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -103,7 +83,6 @@ rubyforge_project: scout
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: 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.
-test_files: 
-- test/test_helper.rb
-- test/test_scout.rb
+summary: Scout makes monitoring and reporting on your web applications as flexible and simple as possible.
+test_files: []
+

data/Manifest.txt

@@ -1,33 +0,0 @@
-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

@@ -1,7 +0,0 @@
-
-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/config/hoe.rb

@@ -1,73 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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/version.rb

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

data/script/console

@@ -1,10 +0,0 @@
-#!/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

@@ -1,14 +0,0 @@
-#!/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

@@ -1,14 +0,0 @@
-#!/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

@@ -1,82 +0,0 @@
-#!/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)