wakeonlan 0.0.1

data/Manifest

@@ -0,0 +1,5 @@
+Manifest
+README.rdoc
+Rakefile
+bin/wakeonlan
+lib/wakeonlan.rb

data/README.rdoc

@@ -0,0 +1,41 @@
+= Wake On LAN
+
+* http://wakeonlan.rubyforge.com/
+* mailto:jens@hilli.dk
+
+== Description
+
+Wake On LAN library and system executable
+
+== Prerequisites
+
+Ruby 1.8.6 or later
+
+== Installation
+
+You can use RubyGems [rubyforge.org/projects/rubygems] to install the latest version of the WakeOnLAN library remotely.
+
+  gem install --remote wakeonlan
+
+
+== Usage
+
+  require 'wakeonlan'
+
+   wol = WakeOnLan.new
+   wol.wake("00:14:5e:2a:1c:f7") # Send magic packet to the machine with the MAC address 00:14:5e:2a:1c:f7
+   wol.close
+
+or just simply:
+
+  WakeOnLan.wake!("00:14:5e:2a:1c:f7") 
+
+or
+
+  WakeOnLan.wake!("my-sleepy-host")
+
+if you have a /etc/ethers file. See `man 5 ethers` on a UNIX/BSD/Linux system
+
+== LICENSE
+
+WakeOnLAN library is Copyright (c) 2009 by Jens Hilligsoe. It is free software. Redistribution is permitted under the same terms and conditions as the standard Ruby distribution. See the COPYING file in the Ruby distribution for details. 

data/Rakefile

@@ -0,0 +1,51 @@
+$:.unshift(File.dirname(__FILE__) + "/lib")
+
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'wakeonlan'
+
+
+# Common package properties
+PKG_NAME    = ENV['PKG_NAME']    || WakeOnLan::GEM
+PKG_VERSION = ENV['PKG_VERSION'] || WakeOnLan::VERSION
+RUBYFORGE_PROJECT = 'wakeonlan'
+
+if ENV['SNAPSHOT'].to_i == 1
+  PKG_VERSION << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
+end
+
+
+Echoe.new(PKG_NAME, PKG_VERSION) do |p|
+  p.author        = "Jens Hilligsoe"
+  p.email         = "jens@hilli.dk"
+  p.summary       = "A Wake On LAN (WOL) client and library."
+  p.url           = "http://wakeonlan.rubyforge.com/"
+  p.project       = RUBYFORGE_PROJECT
+  p.description   = <<-EOD
+    WakeOnLAN is a WOL client and library written in pure Ruby.
+  EOD
+  p.ignore_pattern = [ "nbproject/**/*", "docs/**/*"]
+  p.need_zip = true
+  p.has_rdoc = true
+  p.files = FileList["{bin,lib,docs}/**/*"].exclude("rdoc").to_a
+
+  p.development_dependencies += ["rake  ~>0.8",
+                                 "echoe ~>3.1"]
+end
+
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r wakeonlan.rb"
+end
+
+begin
+  require 'code_statistics'
+  desc "Show library's code statistics"
+  task :stats do
+    CodeStatistics.new(["WakeOnLan", "lib"]).to_s
+  end
+rescue LoadError
+  puts "CodeStatistics (Rails) is not available"
+end

data/bin/wakeonlan

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+# $Id: wakeonlan 1 2009-10-27 22:43:55Z hilli $
+
+require 'optparse'
+require 'rubygems'
+require File.dirname(__FILE__) + '/../lib/wakeonlan'
+
+options = {
+  :ethers => nil,
+  :ip => "255.255.255.255",
+  :port => 9,
+  :verbose => false
+}
+
+opts = OptionParser.new do |opts|
+  opts.banner = "WakeOnLan: Ruby WakeOnLan Client"
+  opts.define_head "Usage: wakeonlan [options] [[MAC|IP|hostname] ...]"
+  opts.separator " "
+  opts.separator "Examples:"
+  opts.separator " wakeonlan 00:1e:4f:43:6d:f4"
+  opts.separator " wakeonlan 192.168.1.2"
+  opts.separator " "
+  opts.separator "Options:"
+
+  opts.on("-e FILE", "--ethers FILE", String, "Use FILE instead of /etc/ethers [default]") do |e|
+    options[:ethers] = e
+  end
+
+  opts.on("-p PORT", "--port PORT", Integer, "Port number to send the magick packet to - Default is 9") do |p|
+    options[:port] = p
+  end
+
+  opts.on("-v", "--verbose", "Verbose output") do |p|
+    options[:verbose] = true
+  end
+
+  opts.on("-a IP", "--dest-ip IP", String, "IP address to send magic packet to. " +
+      " This can be a gateway to another subnet. The default is the broadcast address 255.255.255.255") do |i|
+    options[:ip] = i
+  end
+  
+  opts.separator " "
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("-V", "--version", "Show version") do
+    puts "#{WakeOnLan::NAME} #{WakeOnLan::VERSION}"
+    exit
+  end
+end
+opts.parse!
+
+wakies = ARGV.shift
+
+if wakies.to_s.strip.empty?
+  puts opts
+  exit 1
+end
+
+@wol = WakeOnLan.new
+@wol.ethers = options[:ethers] if options[:ethers]
+@wol.verbose = options[:verbose] if options[:verbose]
+wakies.split.each do |wake|
+  @wol.wake(@wol.resolve_to_mac(wake), options[:ip], options[:port])
+end
+@wol.close

data/lib/wakeonlan.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+# $Id: wakeonlan.rb 1 2009-10-27 22:43:55Z hilli $
+# Jens Hilligsoe <jens@hilli.dk>, 2009
+#
+# Based on work by
+# Kevin R. Bullock <kbullock@ringworld.org>, K.Kodama <kodama@math.kobe-u.ac.jp>,
+# Jose Pedro Oliveira <jpo@di.uminho.pt> and Ico Doornekamp <ico@edd.dhs.org>
+#
+# Licensed under the Ruby licence
+
+require "socket"
+
+class WakeOnLan
+
+  GEM = "wakeonlan"
+  NAME = "WakeOnLan"
+  VERSION = "0.0.1"
+
+  attr_reader :socket
+  attr_accessor :ethers
+  attr_accessor :verbose
+  
+  # Exceptions
+  class AddressException < RuntimeError; end
+  class SetupException < RuntimeError; end
+
+  def initialize
+    @ethers = "/etc/ethers"
+    # Create socket and set options
+    @socket = UDPSocket.open
+    @socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, 1)
+    if "".respond_to?(:lines) then # Ruby 1.9 check
+      @@Regexp_MAC_addr = Regexp.new( '^' + (('[0-9A-Fa-f]' * 2).lines.to_a * 6).join(':') + '$' )
+      @@Regexp_IP_addr = Regexp.new( '^' + ('(([0-9][0-9]?)|([01][0-9][0-9])|(2[0-4][0-9])|(2[0-5][0-5]))'.lines.to_a * 4).join('\.') + '$' )
+    else
+      @@Regexp_MAC_addr = Regexp.new( '^' + (('[0-9A-Fa-f]' * 2).to_a * 6).join(':') + '$' )
+      @@Regexp_IP_addr = Regexp.new( '^' + ('(([0-9][0-9]?)|([01][0-9][0-9])|(2[0-4][0-9])|(2[0-5][0-5]))'.to_a * 4).join('\.') + '$' )
+    end
+  end
+
+  # Do the waking up bits
+  def wake(mac, ip="255.255.255.255", port=9)
+    # Validate mac
+    raise AddressException, 'Invalid MAC address' unless self.valid_mac?( mac )
+    # Validate ip
+    raise AddressException, 'Invalid IP address' unless self.valid_ip?( ip )
+    # Create Magic Packet
+    magic = 0xFF.chr * 6 + (mac.split(/:/).pack("H*H*H*H*H*H*") * 16)
+    @socket.connect(ip,port)
+    puts "Sending magic packet to #{ip}:#{port} with #{mac}" if @verbose
+    3.times{ socket.send(magic,0) }
+  end
+
+  # Shorthand class method to facilitate WakeOnLan.wake!(MAC) kind of action
+  def self.wake!(mac, ip="255.255.255.255", port=9)
+    wol = WakeOnLan.new
+    wol.wake(resolve_to_mac(mac), ip, port)
+    wol.close
+  end
+  
+  # Try to resolve the input given to a MAC address. Input can be either a hostname, IP or MAC address
+  def resolve_to_mac(input)
+    if valid_mac?(input)
+      return input
+    end
+    lookup_in_ethers(input)
+  end
+
+  # Given a hostname or IP, look it up in the ethers file and return the associated MAC address
+  def lookup_in_ethers(input)
+    if File.exist?(@ethers) and File.readable?(@ethers)
+      File.open(@ethers,'r') do |f|
+        f.each_line do |line|
+          mac, host = line.split
+          if input.match(host)
+            return mac
+          end
+        end
+      end
+    end
+  end
+
+  # MAC address validation
+  def valid_mac?(mac)
+    if mac =~ @@Regexp_MAC_addr
+      true
+    else 
+      false  
+    end
+  end
+
+  # IP address validation
+  def valid_ip?( ip )
+    if ip =~ @@Regexp_IP_addr
+      true
+    else 
+      false
+    end
+  end
+
+  # Close the socket after use
+  def close
+    @socket.close
+    @socket=""
+  end
+end # WakeOnLan
+

data/wakeonlan.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{wakeonlan}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jens Hilligsoe"]
+  s.date = %q{2009-10-27}
+  s.default_executable = %q{wakeonlan}
+  s.description = %q{    WakeOnLAN is a WOL client and library written in pure Ruby.
+}
+  s.email = %q{jens@hilli.dk}
+  s.executables = ["wakeonlan"]
+  s.extra_rdoc_files = ["README.rdoc", "bin/wakeonlan", "lib/wakeonlan.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "bin/wakeonlan", "lib/wakeonlan.rb", "wakeonlan.gemspec"]
+  s.homepage = %q{http://wakeonlan.rubyforge.com/}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Wakeonlan", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{wakeonlan}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Wake On LAN (WOL) client and library.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rake>, ["~> 0.8"])
+      s.add_development_dependency(%q<echoe>, ["~> 3.1"])
+    else
+      s.add_dependency(%q<rake>, ["~> 0.8"])
+      s.add_dependency(%q<echoe>, ["~> 3.1"])
+    end
+  else
+    s.add_dependency(%q<rake>, ["~> 0.8"])
+    s.add_dependency(%q<echoe>, ["~> 3.1"])
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: wakeonlan
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jens Hilligsoe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-27 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.8"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.1"
+    version: 
+description: "    WakeOnLAN is a WOL client and library written in pure Ruby.\n"
+email: jens@hilli.dk
+executables: 
+- wakeonlan
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- bin/wakeonlan
+- lib/wakeonlan.rb
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- bin/wakeonlan
+- lib/wakeonlan.rb
+- wakeonlan.gemspec
+has_rdoc: true
+homepage: http://wakeonlan.rubyforge.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Wakeonlan
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: wakeonlan
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A Wake On LAN (WOL) client and library.
+test_files: []
+