wol 0.3.3 → 0.4.0

data/LICENSE

@@ -1,6 +1,6 @@
-Copyright (c) 2009 Matias Korhonen
+Copyright (c) 2009-2010 Matias Korhonen
 
-Ruby Wake-On-LAN is copyrighted free software by Matias Korhonen <korhonen.matt@gmail.com>.
+Ruby Wake-On-LAN is copyrighted free software by Matias Korhonen <me@matiaskorhonen.fi>.
 
 You can redistribute it and/or modify it under either the terms of the GPL
 (see COPYING.txt file), or the conditions below:
@@ -41,12 +41,7 @@ You can redistribute it and/or modify it under either the terms of the GPL
        d) make other distribution arrangements with the author.
 
   4. You may modify and include the part of the software into any other
-     software (possibly commercial).  But some files in the distribution
-     are not written by the author, so that they are not under this terms.
-
-     They are gc.c(partly), utils.c(partly), regex.[ch], st.[ch] and some
-     files under the ./missing directory.  See each file for the copying
-     condition.
+     software (possibly commercial).
 
   5. The scripts and library files supplied as input to or produced as
      output from the software do not automatically fall under the

data/README.rdoc

@@ -1,26 +1,25 @@
 = WOL
 
-Ruby Wake-On-LAN gem. While the basic functionality is in place, this gem is still under heavy development, and some things may yet change.
+Ruby Wake-On-LAN gem.
 
 == To Do
 
-* Write further tests (IMPORTANT!)
-* Refactor the gem structure to something sane
+* Write further tests for teh CLI functionality
 
 == Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Check that the test pass at least under Ruby 1.8.7, 1.9.x, and JRuby.
 * Commit, do not mess with rakefile, version, or history.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+* Send me a pull request.
 
 == Copyright
 
-Copyright (c) 2009 Matias Korhonen. This project is dual licensed under the Ruby License and the GNU General Public License v3.
+Copyright (c) 2009-2010 Matias Korhonen. This project is dual licensed under the Ruby License and the GNU General Public License v3.
 
-This project contains code originally written by K.Kodama. He has been identified as the original author where appropriate.
+This project contains a small amount of code originally written by K.Kodama. He has been identified as the original author where appropriate.
 
 See LICENSE for details.

data/bin/wol

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-
 require 'wol'
 
-exit Wol::Runner.run!(ARGV)
+exit Wol::Runner.run(ARGV)

data/lib/wol.rb

@@ -1,3 +1,4 @@
 require 'wol/wakeonlan'
 require 'wol/runner'
-require 'wol/parsefile'
+require 'wol/parsefile'
+require 'wol/version'

data/lib/wol/runner.rb

@@ -5,10 +5,10 @@
 #
 require 'optparse'
 
+# Run the Ruby-Wake-On-LAN command, +wol+, and parse the given options
 module Wol
-  # Run the Ruby-Wake-On-LAN command, +wol+, and parse the given options
   module Runner
-    @sample_file = %{# File structure
+  @sample_file = %{# File structure
 # --------------
 # - blank lines are ignored
 # - comment lines are ignored (lines starting with a hash mark '#')
@@ -34,125 +34,120 @@ module Wol
                  :count => 3,
                  :macs => [],
                  :file => nil,
-                 :nothing_to_wake => false}
+                 :nothing_to_wake => false }                
 
-    # Parse the give arguments
-    def self.parse!(args)
-      args = ["-h"] if args.empty?
+  # Parse the give arguments
+  def self.parse!(args)
+    args = ["-h"] if args.empty?
 
-      opts = OptionParser.new do |opts|
-        # Set a banner, displayed at the top
-        # of the help screen.
-        opts.banner = "Ruby Wake-On-LAN #{version}\nUsage: wol -i ADDRESS ff:ff:ff:ff:ff:ff"
+    opts = OptionParser.new do |opts|
+      # Set a banner, displayed at the top
+      # of the help screen.
+      opts.banner = "Ruby Wake-On-LAN #{Wol::VERSION}\nUsage: wol -i ADDRESS ff:ff:ff:ff:ff:ff"
 
-        opts.separator "\nSpecific options:"
+      opts.separator "\nSpecific options:"
 
-        opts.on( '-q', '--quiet', 'No console output' ) do
-          @options[:quiet] = true
-        end
-
-        opts.on( '-i', '--address 255.255.255.255', 'Set the destination address' ) do |address|
-          @options[:address] = address
-        end
+      opts.on( '-q', '--quiet', 'No console output' ) do
+        @options[:quiet] = true
+      end
 
-        opts.on( '-p', '--port 9', Integer, 'Set the destination port' ) do |port|
-          @options[:port] = port
-        end
+      opts.on( '-i', '--address 255.255.255.255', 'Set the destination address' ) do |address|
+        @options[:address] = address
+      end
 
-        opts.on( '-d', '--delay 0.01', Float, 'Delay between sending packets in seconds') do |delay|
-          @options[:delay] = delay
-        end
+      opts.on( '-p', '--port 9', Integer, 'Set the destination port' ) do |port|
+        @options[:port] = port
+      end
 
-        opts.on( '-c', '--count 3', Integer, 'Number of packets to send. Default 3') do |count|
-          @options[:count] = count
-        end
+      opts.on( '-d', '--delay 0.01', Float, 'Delay between sending packets in seconds') do |delay|
+        @options[:delay] = delay
+      end
 
-        opts.on( '-f', '--file FILE', 'TODO: Uses a file as a source of addresses') do |file|
-          @options[:file] = file
-        end
+      opts.on( '-c', '--count 3', Integer, 'Number of packets to send. Default 3') do |count|
+        @options[:count] = count
+      end
 
-        opts.separator "\nCommon options:"
+      opts.on( '-f', '--file FILE', 'TODO: Uses a file as a source of addresses') do |file|
+        @options[:file] = file
+      end
 
-        opts.on_tail( '-h', '--help', 'Display this message' ) do
-          @options[:nothing_to_wake] = true
-          puts opts
-        end
+      opts.separator "\nCommon options:"
 
-        opts.on_tail( '-s', '--sample-file', 'Display a sample file') do
-          @options[:nothing_to_wake] = true
-          puts @sample_file
-        end
+      opts.on_tail( '-h', '--help', 'Display this message' ) do
+        @options[:nothing_to_wake] = true
+        puts opts
+      end
 
-        opts.on_tail( '-v', '--version', 'Show version') do
-          @options[:nothing_to_wake] = true
-          puts "Ruby Wake-On-LAN #{version}"
-        end
+      opts.on_tail( '-s', '--sample-file', 'Display a sample file') do
+        @options[:nothing_to_wake] = true
+        puts @sample_file
       end
 
-      begin
-        opts.parse!(args)
+      opts.on_tail( '-v', '--version', 'Show version') do
+        @options[:nothing_to_wake] = true
+        puts "Ruby Wake-On-LAN #{Wol::VERSION}"
+      end
+    end
 
-        if @options[:file].nil?
-          args.each do |arg|
-            @options[:macs] << arg if /^(\S{1,2}:\S{1,2}:\S{1,2}:\S{1,2}:\S{1,2}:\S{1,2})?$/.match(arg)
-          end
+    begin
+      opts.parse!(args)
 
-          @options[:macs].uniq!
+      if @options[:file].nil?
+        args.each do |arg|
+          @options[:macs] << arg if /^(\S{1,2}:\S{1,2}:\S{1,2}:\S{1,2}:\S{1,2}:\S{1,2})?$/.match(arg)
         end
 
-        return @options
-      rescue OptionParser::InvalidOption => e
-        STDERR.puts e.message, "\n", opts
-        return -1
+        @options[:macs].uniq!
       end
-    end
 
-    # Return the version from the VERSION file if it exists
-    def self.version
-      File.exist?('VERSION') ? File.read('VERSION') : ""
+      return @options
+    rescue OptionParser::InvalidOption => e
+      STDERR.puts e.message, "\n", opts
+      return -1
     end
+  end
 
-    # Send WOL MagicPackets based on the parsed options
-    def self.wake!
-      if @options[:file]
-        hosts = ParseFile.read_and_parse_file(@options[:file])
-
-        hosts.each do |host|
-          @options[:address], @options[:macs], @options[:port] = host[:address], host[:mac], host[:port]
+  # Send WOL MagicPackets based on the parsed options
+  def self.wake
+    if @options[:file]
+      hosts = ParseFile.read_and_parse_file(@options[:file])
 
-          message = WakeOnLan.new(@options).wake.to_s
-          puts message unless options[:quiet]
+      hosts.each do |host|
+        @options[:address], @options[:macs], @options[:port] = host[:address], host[:mac], host[:port]
 
-          return 0
-        end
-      elsif !@options[:macs].empty?
-        @options[:macs].each do |mac|
-          @options[:mac] = mac
-          message = WakeOnLan.new(@options).wake.to_s
-          puts message unless @options[:quiet]
-        end
+        message = WakeOnLan.new(@options).wake.to_s
+        puts message unless options[:quiet]
 
         return 0
-      elsif @options[:macs].empty? && @options[:file].nil? && !@options[:nothing_to_wake]
-        raise Exception, "You must supply a MAC address or a file"
-      else
-        return -1
       end
+    elsif !@options[:macs].empty?
+      @options[:macs].each do |mac|
+        @options[:mac] = mac
+        message = WakeOnLan.new(@options).wake.to_s
+        puts message unless @options[:quiet]
+      end
+
+      return 0
+    elsif @options[:macs].empty? && @options[:file].nil? && !@options[:nothing_to_wake]
+      raise Exception, "You must supply a MAC address or a file"
+    else
+      return -1
     end
+  end
 
-    # Parse the command line options, then use them to wake up any given hosts.
-    def self.run!(argv)
-      begin
-        parse!(argv)
-
-        return wake!
-      rescue SocketError => e
-        puts e.message
-        return -1
-      rescue Exception => e
-        STDERR.puts e.message
-        return -1
-      end
+  # Parse the command line options, then use them to wake up any given hosts.
+  def self.run(argv)
+    begin
+      parse!(argv)
+
+      return wake
+    rescue SocketError => e
+      puts e.message
+      return -1
+    rescue Exception => e
+      STDERR.puts e.message
+      return -1
     end
   end
+  end
 end

data/lib/wol/version.rb

@@ -0,0 +1,3 @@
+module Wol
+  VERSION = "0.4.0"
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: wol
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Matias Korhonen
@@ -9,79 +14,60 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-21 00:00:00 +02:00
-default_executable: wol
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-description: Ruby Wake-On-LAN
-email: korhonen.matt@gmail.com
+date: 2010-05-17 00:00:00 +03:00
+default_executable: 
+dependencies: []
+
+description: Send Wake-On-LAN magic packets from Ruby or from CLI
+email: 
+- me@matiaskorhonen.fi
 executables: 
 - wol
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- .document
-- .gitignore
-- COPYING
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
-- bin/wol
-- lib/wol.rb
 - lib/wol/parsefile.rb
-- lib/wol/runner.rb
+- lib/wol/version.rb
 - lib/wol/wakeonlan.rb
-- spec/hosts.wol
-- spec/parsefile_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- spec/wakeonlan_spec.rb
-- test/helper.rb
-- test/test_wol.rb
+- lib/wol/runner.rb
+- lib/wol.rb
+- bin/wol
+- LICENSE
+- COPYING
+- README.rdoc
 has_rdoc: true
-homepage: http://github.com/k33l0r/wol
+homepage: http://wol.matiaskorhonen.fi
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: wol
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Ruby WoL
-test_files: 
-- spec/wakeonlan_spec.rb
-- spec/spec_helper.rb
-- spec/parsefile_spec.rb
-- test/test_wol.rb
-- test/helper.rb
+summary: Ruby Wake-On-LAN
+test_files: []
+

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,22 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
-.idea

data/Rakefile

@@ -1,55 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "wol"
-    gem.summary = %Q{Ruby WoL}
-    gem.description = %Q{Ruby Wake-On-LAN}
-    gem.email = "korhonen.matt@gmail.com"
-    gem.homepage = "http://github.com/k33l0r/wol"
-    gem.authors = ["Matias Korhonen"]
-    gem.rubyforge_project = 'wol'
-    gem.add_development_dependency "rspec", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-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 = "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 +0,0 @@
-0.3.3

data/spec/hosts.wol

@@ -1,24 +0,0 @@
-# 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

@@ -1,42 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-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"}]
-
-TEST_STRING = %{# 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}
-
-describe "ParseFile" do
-  it "be able to parse a test file correctly" do
-
-    Wol::ParseFile.read_and_parse_file(File.expand_path(File.dirname(__FILE__) + '/hosts.wol')).should == EXPECTED
-  end
-
-  it "should be able to parse a test string correctly" do
-    Wol::ParseFile.parse(TEST_STRING).should == EXPECTED
-  end
-end

data/spec/spec.opts

@@ -1 +0,0 @@
---color

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'wol'
-require 'spec'
-require 'spec/autorun'
-
-Spec::Runner.configure do |config|
-  
-end

data/spec/wakeonlan_spec.rb

@@ -1,27 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "Wake-On-LAN" do
-  it "should send a MagicPacket to the broadcast addresses" do
-    Wol::WakeOnLan.new.wake.should == "Sending magic packet to 255.255.255.255:9 with ff:ff:ff:ff:ff:ff"
-  end
-
-  it "should send a MagicPacket to a specified mac" do
-    Wol::WakeOnLan.new(:mac => "ff:ff:ff:ff:ff:cc").wake.should == "Sending magic packet to 255.255.255.255:9 with ff:ff:ff:ff:ff:cc"
-  end
-
-  it "should send a MagicPacket to a specified address" do
-    Wol::WakeOnLan.new(:address => "example.com").wake.should == "Sending magic packet to example.com:9 with ff:ff:ff:ff:ff:ff"
-  end
-
-  it "should send a MagicPacket to a specified port" do
-    Wol::WakeOnLan.new(:port => 12).wake.should == "Sending magic packet to 255.255.255.255:12 with ff:ff:ff:ff:ff:ff"
-  end
-
-  it "should send a MagicPacket to a specified mac, address, and port" do
-    Wol::WakeOnLan.new(:mac => "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"
-  end
-
-  it "should return nil if quiet is set to true" do
-    Wol::WakeOnLan.new(:quiet => true).wake.should == nil
-  end
-end

data/test/helper.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'wol'
-
-class Test::Unit::TestCase
-end

data/test/test_wol.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestWol < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end