wol 0.3.0 → 0.3.1

data/Rakefile

@@ -35,11 +35,21 @@ task :spec => :check_dependencies
 task :default => :spec
 
 require 'rake/rdoctask'
+gem 'rdoc'
+require 'rdoc/rdoc'
+
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "test #{version}"
+  rdoc.title = "Ruby Wake-On-LAN #{version}"
   rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('COPYING')
+  rdoc.rdoc_files.include('LICENSE')
   rdoc.rdoc_files.include('lib/**/*.rb')
+  
+  rdoc.options += [
+          '-HN',
+          '-f', 'darkfish',
+  ]
 end

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/wol/parsefile.rb

@@ -1,5 +1,11 @@
-# Parse a text file containing hardware addresses, host names/addresses, and port numbers
+# Copyright (C) 2009 Matias Korhonen
+#
+# Licensed under the Ruby License: http://www.ruby-lang.org/en/LICENSE.txt
+# and the GNU General Public License: http://www.gnu.org/copyleft/gpl.html
+
+# Ruby Wake-On-LAN
 module Wol
+  # Parse a text file containing hardware addresses, host names/addresses, and port numbers
   module ParseFile
 
     # Parse a given string and return a hash containing the results

data/lib/wol/runner.rb

@@ -1,6 +1,12 @@
+# Copyright (C) 2009 Matias Korhonen
+#
+# Licensed under the Ruby License: http://www.ruby-lang.org/en/LICENSE.txt
+# and the GNU General Public License: http://www.gnu.org/copyleft/gpl.html
+#
 require 'optparse'
 
 module Wol
+  # Run the Ruby-Wake-On-LAN command, +wol+, and parse the given options
   module Runner
     @sample_file = %{# File structure
 # --------------
@@ -21,6 +27,7 @@ module Wol
 07:09:09:0A:0B:0C   example.com
 0D:0E:0F:00:10:11}
 
+    # Parse the give arguments
     def self.parse(args)
       args = ["-h"] if args.empty?
 
@@ -102,10 +109,13 @@ module Wol
       end
     end
 
+    # Return the version string.
+    # TODO: Fix the way the version is defined.
     def self.version
-      "Ruby Wake-On-LAN version 0.3.0"
+      "Ruby Wake-On-LAN version 0.3.1"
     end
 
+    # Send WOL MagicPackets based on the parsed options
     def self.wake(options = {})
       begin
         if options[:file]
@@ -132,6 +142,7 @@ module Wol
       end
     end
 
+    # Parse the command line options, then use them to wake up any given hosts.
     def self.run!
       options = parse(ARGV)
 

data/lib/wol/wakeonlan.rb

@@ -1,9 +1,6 @@
-# Copyright (C) 2000-2003  K.Kodama
+# Copyright (C) 2000-2009  K.Kodama, Matias Korhonen
 # Original: http://www.math.kobe-u.ac.jp/~kodama/tips-WakeOnLAN.html
 #
-# Modified by Matias Korhonen (26.09.2009: Removed command line options, changed to
-# send the magic packet straight to the IP, not the broadcast address)
-#
 # Licensed under the Ruby License: http://www.ruby-lang.org/en/LICENSE.txt
 # and the GNU General Public License: http://www.gnu.org/copyleft/gpl.html
 #
@@ -13,17 +10,28 @@ require "socket"
 
 module Wol
   class WakeOnLan
-    attr_accessor :mac, :address, :port, :count, :delay, :quiet
+    # Specify the destination MAC Address. Defaults to the broadcast MAC, "ff:ff:ff:ff:ff:ff"
+    attr_accessor :mac
+
+    # Specify the destination address.  Either a IP or hostname.  Defaults to "255.255.255.255"
+    attr_accessor :address
+
+    # The destination port. Defaults to the discard port, 9
+    attr_accessor :port
+
+    # How many times to send the MagicPacket.  Defaults to 1
+    attr_accessor :count
+
+    # How many seconds to wait between sending packets. Defaults to 0.01
+    attr_accessor :delay
+
+    # What to return?  Returns a string summary if false, else returns nil
+    attr_accessor :quiet
+
+    # The socket opened by WakeOnLan initialization
     attr_reader :socket
 
-    # Create a new instance
-    # == Options
-    # * <tt>:mac => "ff:ff:ff:ff:ff:ff"</tt> - Specify the destination MAC Address. Defaults to the broadcast MAC, "ff:ff:ff:ff:ff:ff"
-    # * <tt>:address => "255.255.255.255"</tt> - Specify the destination address.  Either a IP or hostname.  Defaults to "255.255.255.255"
-    # * <tt>:port => 9</tt> - The destination port. Defaults to the discard port, 9
-    # * <tt>:count => 1</tt> - How many times to send the MagicPacket.  Defaults to 1
-    # * <tt>:delay => 0.01</tt> - How many seconds to wait between sending packets. Defaults to 0.01
-    # * <tt>:quiet => false</tt> - What to return?  Returns a string summary if false, else returns nil
+    # Create a new WakeOnLan instance. See the WakeOnLan class documentation for options.
     def initialize(options = {})
       @mac = options[:mac] ||= "ff:ff:ff:ff:ff:ff"
       @address = options[:address] ||= "255.255.255.255"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wol
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Matias Korhonen