overwatch 0.2.0 → 0.2.1

data/README.md

@@ -1,19 +1,34 @@
 # Installation
 
-  gem install overwatch-cli
+  gem install overwatch
 
-  
+# Configuration
+
+Configuration of `overwatch` can be done in one of two ways: command-line options, and a config file in the YAML format. If no config options are specified, the `overwatch` executable will look for a file called `.overwatchrc` in the `HOME_DIR` of the user that is executing the command. Parameters that can be configured in the config file are:
+
+* Server
+* Port
+* API key
+
+Even if an option is specified in the config file, it can be overridden with a command-line argument. Options ommitted will use the default values.
+
+## Example configuration file
+
+    server: overwatch.example.com
+    port: 9090
+    key: asdf1234asdf1234asdf1234asdf234
+      
 # Usage
 
 I'm going to assume you've got overwatch-collection running somewhere on your local machine for the purpose of this documention.
-
+    
 ## 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).
+When you install `overwatch` 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] ...
@@ -30,6 +45,14 @@ When you install `overwatch-cli` via RubyGems, an executable, `overwatch`, is in
     snapshot                      Snapshots
     
 
+#### Options
+    -c, --config CONFIG    Overwatch config file
+    -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")
+
+
 ## Subcommands
 
 ### overwatch run
@@ -43,14 +66,6 @@ When you install `overwatch-cli` via RubyGems, an executable, `overwatch`, is in
     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
@@ -71,24 +86,12 @@ When you install `overwatch-cli` via RubyGems, an executable, `overwatch`, is in
     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:
@@ -124,9 +127,6 @@ Plaintext format for easy piping/grepping/awking:
 #### 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
 

data/lib/overwatch/command.rb

@@ -15,13 +15,39 @@ module Overwatch
       puts "Overwatch v#{Overwatch::VERSION} (Codename: Snickelfritz)"
       exit(0)
     end
+    
+    option ['-c', '--config'], "CONFIG", "config file"
+    option ['--dry-run'], :flag, "Dry run"
+    option ["-s", "--server"], "SERVER", "collection server"
+    option ["-p", "--port"], "PORT", "collection port"
+    option ["-f", "--format"], "[FORMAT]", "format (choices: pretty, json, text)"
+    option ["-k", "--key"], "KEY", "API key"
+
+    def config=(file)
+      YAML.load_file(File.expand_path(file))
+    end
+    
+    def default_config
+      YAML.load_file(File.expand_path("~/.overwatchrc"))
+    end
 
+    def default_server
+      config['server'] || 'localhost'
+    end
+    
+    def default_port
+      config['port'] || '9001'
+    end
+    
+    def default_key
+      config['key'] || nil
+    end
+    
+    def default_format
+      config['format'] || 'pretty'
+    end
+    
     subcommand "run", "Run the client" do
-      option ["-k", "--key"], "KEY", "API key", :default => nil
-      option ["-s", "--server"], "SERVER", "collection server", :default => "localhost"
-      option ["-p", "--port"], "PORT", "collection port", :default => "9001"
-      option ["-f", "--format"], "[FORMAT]", "format (choices: pretty, json, text)", :default => "pretty"
-
       unless Ohai::Config[:plugin_path].include?(Overwatch.plugin_path)
         Ohai::Config[:plugin_path] << Overwatch.plugin_path
       end
@@ -41,9 +67,6 @@ module Overwatch
     end
 
     subcommand "resource", "Resources" do
-      option ["-s", "--server"], "SERVER", "collection server", :default => "localhost"
-      option ["-p", "--port"], "PORT", "collection port", :default => "9001"
-      option ["-f", "--format"], "[FORMAT]", "format (choices: pretty, json, text)", :default => "pretty"
 
       subcommand "list", "list all resources" do
         def execute

data/lib/overwatch/version.rb

@@ -1,3 +1,3 @@
 module Overwatch
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: overwatch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-08-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70099985810320 !ruby/object:Gem::Requirement
+  requirement: &70112145225220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.8.2
   type: :runtime
   prerelease: false
-  version_requirements: *70099985810320
+  version_requirements: *70112145225220
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70099985807460 !ruby/object:Gem::Requirement
+  requirement: &70112145222840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.6.3
   type: :runtime
   prerelease: false
-  version_requirements: *70099985807460
+  version_requirements: *70112145222840
 - !ruby/object:Gem::Dependency
   name: clamp
-  requirement: &70099985791040 !ruby/object:Gem::Requirement
+  requirement: &70112145221540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 0.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *70099985791040
+  version_requirements: *70112145221540
 - !ruby/object:Gem::Dependency
   name: formatador
-  requirement: &70099985790200 !ruby/object:Gem::Requirement
+  requirement: &70112145219940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 0.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70099985790200
+  version_requirements: *70112145219940
 - !ruby/object:Gem::Dependency
   name: hirb
-  requirement: &70099985789020 !ruby/object:Gem::Requirement
+  requirement: &70112145218420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 0.4.5
   type: :runtime
   prerelease: false
-  version_requirements: *70099985789020
+  version_requirements: *70112145218420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70099985787780 !ruby/object:Gem::Requirement
+  requirement: &70112145217220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70099985787780
+  version_requirements: *70112145217220
 - !ruby/object:Gem::Dependency
   name: spork
-  requirement: &70099985786240 !ruby/object:Gem::Requirement
+  requirement: &70112145216160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: 0.9.0.rc8
   type: :development
   prerelease: false
-  version_requirements: *70099985786240
+  version_requirements: *70112145216160
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &70099985784720 !ruby/object:Gem::Requirement
+  requirement: &70112145213420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70099985784720
+  version_requirements: *70112145213420
 - !ruby/object:Gem::Dependency
   name: json_spec
-  requirement: &70099985782820 !ruby/object:Gem::Requirement
+  requirement: &70112145212060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: 0.5.0
   type: :development
   prerelease: false
-  version_requirements: *70099985782820
+  version_requirements: *70112145212060
 description: overwatch is the command-line interface to the Overwatch monitoring suite
 email:
 - dan@appliedawesome.com
@@ -146,7 +146,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3947530879652547069
+      hash: -2779688634827524436
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3947530879652547069
+      hash: -2779688634827524436
 requirements: []
 rubyforge_project: overwatch
 rubygems_version: 1.8.6