wol 0.2.1 → 0.2.2

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.2

data/bin/wol

@@ -106,7 +106,7 @@ class Runner
   end
 
   def self.version
-    "Ruby Wake-On-LAN version 0.2.1"
+    "Ruby Wake-On-LAN version 0.2.2"
   end
 
   def self.wake(options = {})

data/lib/parsefile.rb

@@ -1,5 +1,7 @@
+# Parse a text file containing hardware addresses, host names/addresses, and port numbers
 class ParseFile
 
+  # Parse a given text file and return a hash containing the results 
   def self.parse(file)
     hosts = []
     if File.exist?(file) && File.readable?(file)
@@ -22,14 +24,19 @@ class ParseFile
     return hosts
   end
 
+private
+
+  # Check if a given hardware address is correctly formed.
   def self.check_mac(mac)
     /^(\S{1,2}:\S{1,2}:\S{1,2}:\S{1,2}:\S{1,2}:\S{1,2})?$/.match(mac)
   end
 
+  # Check that a host/ip address doesn't contain any illegal characters.
   def self.check_host(host)
     /(^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$)|(^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z]|[A-Za-z][A-Za-z0-9\-]*[A-Za-z0-9])$)/.match(host)
   end
 
+  # Make sure that a given port number is an integer in the correct range (1..61000).
   def self.sanitize_port(port)
     p = port.to_i
     return (1..61000).include?(p) ? p : 9

data/lib/wol.rb

@@ -35,7 +35,7 @@ class Wol
     @socket.setsockopt(Socket::SOL_SOCKET,Socket::SO_BROADCAST,1)
   end
 
-  # Close the socket opened by WakeOnLan initialization
+  # Close the socket opened by Wol initialization
   def close
     @socket.close
     @socket=""

data/spec/hosts.wol

@@ -0,0 +1,24 @@
+# File structure
+# --------------
+# - blank lines are ignored
+# - comment lines are ignored (lines starting with a hash mark '#')
+# - other lines are considered valid records and can have 3 columns:
+#
+#       Hardware address, IP address, destination port
+#
+#   the last two are optional, in which case the following defaults
+#   are used:
+#
+#       IP address: 255.255.255.255 (the limited broadcast address)
+#       port:       9 (the discard port)
+#
+
+01:02:03:04:05:06   192.168.1.255       9
+01:02:03:04:05:06   192.168.2.230       12
+07:09:09:0A:0B:0C   example.com
+0D:0E:0F:00:10:11
+
+# Invalid entries
+FF:FF:aa
+0D:0E:0F:00:10:11  ;
+07:09:09:0A:0B:0C  192.168.1.254	a

data/spec/parsefile_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ParseFile" do
+  it "be able to parse a test file correctly" do
+    expected = [{:port=>9, :mac=>"01:02:03:04:05:06", :address=>"192.168.1.255"},
+                {:port=>12, :mac=>"01:02:03:04:05:06", :address=>"192.168.2.230"},
+                {:port=>9, :mac=>"07:09:09:0A:0B:0C", :address=>"example.com"},
+                {:port=>9, :mac=>"07:09:09:0A:0B:0C", :address=>"192.168.1.254"}]
+    
+    ParseFile.parse(File.expand_path(File.dirname(__FILE__) + '/hosts.wol')).should == expected
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'wol'
+require "parsefile"
 require 'spec'
 require 'spec/autorun'
 

data/spec/wol_spec.rb

@@ -21,6 +21,10 @@ describe "Wake-On-LAN" do
     Wol.new(:macs => "00:08:a1:a9:58:f6", :address => "example.com", :port => 80).wake.should == "Sending magic packet to example.com:80 with 00:08:a1:a9:58:f6\n"
   end
 
+  it "should send MagicPackets to several hardware addresses at once" do
+    Wol.new(:macs => ["ff:ff:ff:ff:ff:cc", "ff:ff:ff:ff:cc:cc", "ff:ff:ff:ccf:cc:cc"]).wake.should == "Sending magic packet to 255.255.255.255:9 with ff:ff:ff:ff:ff:cc\nSending magic packet to 255.255.255.255:9 with ff:ff:ff:ff:cc:cc\nSending magic packet to 255.255.255.255:9 with ff:ff:ff:ccf:cc:cc\n"
+  end
+
   it "should return nil if quiet is set to true" do
     Wol.new(:quiet => true).wake.should == nil
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wol
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Matias Korhonen
@@ -42,6 +42,8 @@ files:
 - bin/wol
 - lib/parsefile.rb
 - lib/wol.rb
+- spec/hosts.wol
+- spec/parsefile_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/wol_spec.rb
@@ -78,5 +80,6 @@ summary: Ruby WoL
 test_files: 
 - spec/spec_helper.rb
 - spec/wol_spec.rb
+- spec/parsefile_spec.rb
 - test/test_wol.rb
 - test/helper.rb