gofer 0.1.0 → 0.1.1

data/.gitignore

@@ -3,3 +3,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+doc

data/HISTORY.md

@@ -1,5 +1,9 @@
 # Revision History
 
+### v0.1.1 23/04/2011
+
+ * Minimal RDoc added.
+
 ### v0.1.0 20/04/2011
 
  * Replace string return from run with a 'response' object

data/lib/gofer.rb

@@ -3,3 +3,6 @@ require 'gofer/response'
 require 'gofer/host'
 require 'gofer/version'
 
+# See Gofer::Host
+module Gofer
+end

data/lib/gofer/host.rb

@@ -1,12 +1,12 @@
 module Gofer
-  class HostError < Exception
+  class HostError < Exception # :nodoc:
     def initialize host, message
       super "#{host.hostname}: #{message}"
     end
   end
  
   class Host
-
+    
     attr_reader :hostname
 
     def initialize username, _hostname, identity_file=nil
@@ -14,6 +14,19 @@ module Gofer
       @ssh = SshWrapper.new(username, hostname, identity_file)
     end
 
+    # Run +command+.
+    #
+    # Raise an error if +command+ exits with a non-zero status.
+    #
+    # Print +stdout+ and +stderr+ as they're received. 
+    #
+    # Return a Gofer::Response object.
+    # 
+    # Options:
+    #
+    # +quiet+:: Don't print +stdout+
+    # +quiet_stderr+:: Don't print +stderr+
+    # +capture_exit_status+:: Don't raise an error on a non-zero exit status
     def run command, opts={}
       response = @ssh.run command, opts
       if !opts[:capture_exit_status] && response.exit_status != 0
@@ -22,18 +35,22 @@ module Gofer
       response
     end
 
+    # Return +true+ if +path+ exits.
     def exists? path
       @ssh.run("sh -c '[ -e #{path} ]'").exit_status == 0
     end
 
+    # Return the contents of the file at +path+. 
     def read path
       @ssh.read_file path
     end
 
+    # Return +true+ if +path+ is a directory.
     def directory? path
       @ssh.run("sh -c '[ -d #{path} ]'").exit_status == 0
     end
 
+    # Return a list of files in the directory at +path+.
     def ls path
       response = @ssh.run "ls -1 #{path}", :quiet => true
       if response.exit_status == 0
@@ -43,10 +60,12 @@ module Gofer
       end
     end
 
+    # Upload the file or directory at +from+ to +to+. 
     def upload from, to
       @ssh.upload from, to, :recursive => File.directory?(from)
     end
 
+    # Download the file or directory at +from+ to +to+
     def download from, to
       @ssh.download from, to, :recursive => directory?(from)
     end

data/lib/gofer/response.rb

@@ -1,4 +1,6 @@
 module Gofer
+
+  # Response container for the various outputs from Gofer::Host#run  
   class Response < String
     attr_reader :stdout, :stderr, :output, :exit_status
     

data/lib/gofer/ssh_wrapper.rb

@@ -2,7 +2,7 @@ require 'net/ssh'
 require 'net/scp'
 
 module Gofer
-  class SshWrapper
+  class SshWrapper # :nodoc:
 
     attr_reader :last_output, :last_exit_status
 

data/lib/gofer/version.rb

@@ -1,3 +1,3 @@
-module Gofer
-  VERSION = "0.1.0"
+module Gofer # :nodoc:
+  VERSION = "0.1.1"
 end

metadata

@@ -2,7 +2,7 @@
 name: gofer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Michael Pearson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-20 00:00:00 +10:00
+date: 2011-04-23 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency