overwatch 0.0.3.pre → 0.2.0

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+Gemfile.lock

data/.watchr

@@ -16,7 +16,3 @@ end
 watch("lib/(.*/.*)\.rb") do |match|
   run_spec %{spec/#{match[1]}_spec.rb}
 end
-
-watch("lib/monitaur.rb") do |match|
-	run_spec %{spec/monitaur_spec.rb}
-end

data/Gemfile

@@ -1,18 +1,14 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-gem 'rest-client', '>= 1.6.3'
-gem 'json', '>= 1.5.1'
-gem 'ohai', '>= 0.6.4'
-# gem 'SystemTimer', :require => 'system_timer'
+gemspec
 
-group :development do
-  gem "rspec", ">= 2.5.0"
-  gem "yard", ">= 0.6.0"
-  gem "bundler", ">= 1.0.0"
-  gem "jeweler", ">= 1.5.2"
-  gem "watchr"
-  gem 'spork', '>= 0.9.0.rc'
-  gem 'fuubar'
-  gem 'fakefs', :git => 'git://github.com/danryan/fakefs.git'
-  gem 'webmock'
+group :development, :test do
+  gem 'rspec', '>= 2.6.0'
+  gem 'spork', '>= 0.9.0.rc8'
+  gem 'watchr', '>= 0.7'
+  gem 'json_spec', '>= 0.5.0'
+end
+
+group :doc do
+  gem 'yard'
 end

data/README.md

@@ -1,29 +1,171 @@
-# overwatch-client
+# Installation
 
-Client for the Overwatch monitoring service
+  gem install overwatch-cli
 
-## Installation
+  
+# Usage
 
-The client is installed via rubygems
+I'm going to assume you've got overwatch-collection running somewhere on your local machine for the purpose of this documention.
 
-    gem install overwatch
+## Help!
+
+All commands provide a contextual help menu. Apped `--selp` to the end of any command or subcommand to bring up its specific help menu.
+
+## Main command
+
+When you install `overwatch-cli` via RubyGems, an executable, `overwatch`, is installed somewhere in your $PATH (the exact location is entirely dependent upon your Ruby/Gems setup).
+
+#### Usage:
+    overwatch [OPTIONS] SUBCOMMAND [ARGS] ...
+
+#### Parameters
+
+    SUBCOMMAND                    subcommand name
+    [ARGS] ...                    subcommand arguments
+
+#### Subcommands
+
+    run                           Compile and send a new snapshot to the server
+    resource                      Resources
+    snapshot                      Snapshots
+    
+
+## Subcommands
+
+### overwatch run
+
+#### Usage
+
+    overwatch run [OPTIONS] [ARGS] ...
+    
+#### Parameters
+
+    SUBCOMMAND                    subcommand name
+    [ARGS] ...                    subcommand arguments
+
+#### Options
+
+    -k, --key KEY          API key (default: nil)
+    -s, --server SERVER    collection server (default: "localhost")
+    -p, --port PORT        collection port (default: "9001")
+    -f, --format [FORMAT]  format (choices: pretty, json, text) (default: "pretty")
+
+
+### overwatch resource
+
+#### Usage
+    
+    overwatch resource [OPTIONS] SUBCOMMAND [ARGS] ...
+
+#### Parameters
+        
+    SUBCOMMAND                    subcommand name
+    [ARGS] ...                    subcommand arguments
+
+#### Subcommands
+
+    list                          list all resources
+    show                          show a specific resource
+    create                        create a new resource
+    update                        update an existing resource
+    delete                        delete an existing resource
+    regenerate                    regenerate a resource's API key
+
+#### Options
+
+    -s, --server SERVER               overwatch-collection server (default: "localhost")
+    -p, --port PORT               overwatch-collection port (default: "9001")
+    -f, --format [FORMAT]         format (choices: pretty, json, text) (default: "pretty")
+
+### overwatch resource list
+
+#### Usage
+      
+    overwatch resource list [OPTIONS]
+
+#### Options
+
+    -s, --server SERVER               overwatch-collection server (default: "localhost")
+    -p, --port PORT               overwatch-collection port (default: "9001")
+    -f, --format [FORMAT]         format (choices: pretty, json, text) (default: "pretty")
+
+#### Examples:
+
+Pretty format:
+
+    $ overwatch resource list --format pretty
+    +----+------+--------------------------------+
+    | id | name | api_key                        |
+    +----+------+--------------------------------+
+    | 1  | foo  | 3ec97eb0d2870db4b061533812d8a1 |
+    | 2  | bar  | e0a5f1baf553f27115cb45ea1ef51a |
+    | 3  | baz  | 5273d592d9a7465ed1b3ae820d06a1 |
+    +----+------+--------------------------------+
+    3 rows in set
+        
+Plaintext format for easy piping/grepping/awking:
+
+    $ overwatch resource list --format text
+    1  foo  3ec97eb0d2870db4b061533812d8a1 
+    2  bar  e0a5f1baf553f27115cb45ea1ef51a 
+    3  baz  5273d592d9a7465ed1b3ae820d06a1
+
+
+### overwatch resource show
+
+#### Usage
     
-This creates the executable `overwatch`. Currently there is no daemon, so you can run it as a cron job:
+    overwatch resource show [OPTIONS] NAME_OR_ID
+
+#### Parameters
 
-    * * * * * overwatch <api key>
+    NAME_OR_ID                    resource name or id
+
+#### Options
+
+    -a, --attributes              list all resource attributes
+    -s, --server SERVER               overwatch-collection server (default: "localhost")
+    -p, --port PORT               overwatch-collection port (default: "9001")
+    -f, --format [FORMAT]         format (choices: pretty, json, text) (default: "pretty")
+
+#### Example
+
+Find a resource by _name_ and display it
+
+    $ overwatch resource show foo
+    +----+------+--------------------------------+
+    | id | name | api_key                        |
+    +----+------+--------------------------------+
+    | 1  | foo  | 3ec97eb0d2870db4b061533812d8a1 |
+    +----+------+--------------------------------+
+    1 row in set
+
+Find a resource by _id_ and display it in plain text:
+
+    $ overwatch resource show --format text 2
+    2  bar  e0a5f1baf553f27115cb45ea1ef51a
+
+### overwatch resource delete
+  
+    raise NotImplementedError, "This will be available in a future release."
+
+### overwatch resource update
+
+    raise NotImplementedError, "This will be available in a future release."
     
-## Plugins
+### overwatch resource regenerate
+
+    raise NotImplementedError, "This will be available in a future release."
+
+### overwatch snapshot
 
-Plugins are stored client-side for ease of deployment by your configuration management service. See the Plugin wiki for more info.
+    raise NotImplementedError, "This will be available in a future release."
 
-## Client run
 
-* Client compiles the plugins and executes each, storing the result of each into a hash
-* Client sends the resultant hash to the server for processing.
-* That's it!
 
-## Copyright
+## TODO
 
-Copyright (c) 2011 Dan Ryan. See LICENSE.txt for
-further details.
+* dotfile for configuration of defaults
+* expand command set as other overwatch pieces are implemented
+* user authentication/authorization (done in the other apps, but we'll need support here)
 

data/Rakefile

@@ -1,50 +1,42 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
 require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "overwatch"
-  gem.homepage = "http://github.com/danryan/overwatch-client"
-  gem.license = "MIT"
-  gem.summary = %Q{Client for Overwatch monitoring service}
-  gem.description = %Q{The client to communicate with the Overwatch monitoring service}
-  gem.email = "hi@iamdanryan.com"
-  gem.authors = ["Dan Ryan"]
-  gem.executables = ["overwatch"]
-  
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
+# require 'resque/tasks'
+# require 'resque_scheduler/tasks'    
+
+require 'bundler/gem_tasks'
 
-require 'rspec/core'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |task|
+  task.pattern = "spec/**/*_spec.rb"
+end
+  
+desc "Run watchr"
+task :watchr do
+  sh %{bundle exec watchr .watchr}
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+desc "Run spork"
+task :spork do
+  sh %{bundle exec spork}
 end
 
-task :default => :spec
 
-require 'yard'
-YARD::Rake::YardocTask.new
+Bundler.require(:doc)
+desc "Generate documentation"
+YARD::Rake::YardocTask.new do |t|
+  t.files = [ 'lib/**/*.rb' ]
+end
 
-desc "Run watchr"
-task :watchr do
-  sh %{bundle exec watchr .watchr}
+namespace :overwatch do
+  namespace :test do 
+    task :snapshot => :environment do
+      a = Resource.first
+      a.snapshots.create(:data => {:one => rand(10), :two => { :three => rand(10) }})
+    end
+  end
 end

data/bin/overwatch

@@ -1,18 +1,8 @@
 #!/usr/bin/env ruby
-# encoding: utf-8
 
-require 'rubygems'
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), *%w[.. lib])
+$: << File.expand_path(File.dirname(__FILE__) + "/../lib")
 
 require 'overwatch'
-require 'overwatch/client'
-
-raise "You must supply an agent key as the first argument" unless ARGV[0]
-api_key = ARGV[0]
+require 'clamp'
 
-begin
-  Overwatch.run api_key
-rescue => e
-  puts e
-end
+Overwatch::Command.run

data/config/overwatchrc

@@ -0,0 +1,6 @@
+collection:
+  host: localhost
+events:
+  host: localhost
+checks:
+  host: localhost

data/lib/overwatch.rb

@@ -1,106 +1,12 @@
-require 'logger'
-require 'fileutils'
-require 'rest-client'
-require 'yajl'
-
-require 'overwatch/client'
-
 module Overwatch
-  VERSION = IO.read(File.join(File.dirname(File.expand_path(__FILE__)), "../VERSION"))
-  
-  class << self    
-    attr_accessor :log_file_path, :config_dir, :raw_config,
-                  :config_file_path, :env, :cache_dir
-    
-    def run(api_key)
-      # Overwatch.install
-      Overwatch::Client.new(api_key).run
-    end
-    
-    # def install
-    #   create_base_dir
-    #   create_log_file
-    #   create_cache_dir
-    #   create_plugin_dir
-    #   create_config_dir
-    #   generate_client_config unless File.exist?(config_file_path)
-    # end
-    # 
-    # def env=(environment)
-    #   @env = environment 
-    # end
-    # 
-    # def env
-    #   @env ||= "production"
-    # end
-    # 
-    # def base_dir
-    #   @base_dir ||= "#{ENV['HOME']}/.overwatch"
-    # end
-    # 
-    # def log
-    #   @log ||= Logger.new(log_file_path)
-    # end
-    # 
-    # def log_file_path
-    #   @log_file_path ||= File.join(base_dir, "client.log")
-    # end
-    # 
-    # def config_dir
-    #   @config_dir ||= File.join(base_dir, "")
-    # end
-    # 
-    # def cache_dir
-    #   @cache_dir ||= File.join(base_dir, "cache")
-    # end
-    # 
-    # def plugin_dir
-    #   @plugin_dir ||= File.join(cache_dir, "plugins")
-    # end
-    # 
-    
+  class << self
     def plugin_path
       @plugin_path ||= File.expand_path(File.join(File.dirname(__FILE__), "../plugins"))
     end
-    
-    # 
-    # def config_file_path
-    #   @config_file_path ||= File.join(base_dir, "config.yml")
-    # end
-    # 
-    # def raw_config
-    #   @raw_config ||= IO.read(config_file_path)
-    # end
-    # 
-    # def create_log_file
-    #   FileUtils.touch(log_file_path)
-    # end
-    # 
-    # def create_base_dir
-    #   FileUtils.mkdir_p(base_dir)
-    # end
-    # 
-    # def create_config_dir
-    #   FileUtils.mkdir_p(config_dir)
-    # end
-    # 
-    # def create_cache_dir
-    #   FileUtils.mkdir_p(cache_dir)
-    # end
-    # 
-    # def create_plugin_dir
-    #   FileUtils.mkdir_p(plugin_dir)
-    # end
-    # 
-    # def generate_client_config
-    #   File.open(config_file_path, "w") do |file|
-    #     file.puts(%q{server_url: http://api.overwatchapp.com})
-    #     file.puts(%q{client_key: CHANGEME})
-    #   end
-    # end
-    # 
-    # def raw_config
-    #   @raw_config ||= IO.read(config_file_path)
-    # end
   end
 end
+
+require 'overwatch/command'
+require 'overwatch/helpers'
+require 'overwatch/version'
+