ruby-vnc 1.0.1 → 1.1.0

data/ChangeLog

@@ -1,9 +1,13 @@
-== 1.0.1 / 2011-09-15
-
-- Split out gemspec into separate file and use for Rakefile.
-- Add homepage and rubyforge project to gemspec.
-
-== 1.0.0 / 2008-08-29
-
-- First public release
-
+== 1.1.0 / 2012-06-03
+
+- Fixes to support ruby 1.9 (jedi4ever & codemonkeyjohn).
+
+== 1.0.1 / 2011-09-15
+
+- Split out gemspec into separate file and use for Rakefile.
+- Add homepage and rubyforge project to gemspec.
+
+== 1.0.0 / 2008-08-29
+
+- First public release
+

data/README

@@ -1,26 +1,26 @@
-= Introduction
-
-The ruby-vnc library provides for simple rfb-protocol based control of a
-VNC server. This can be used, eg, to automate applications (sometimes there
-is no better way), or script some sort of interaction.
-
-Being VNC based gives it the advantage of being able to be run against
-servers on any platform.
-
-The primary documentation is for the Net::VNC class.
-
-= Thanks
-
-Code borrows a lot from Tim Waugh's excellent rfbplaymacro. So far all it
-really offers on top of that is access to the host clipboard, and the ease
-with which it can be scripted, ie taking conditional actions based on the
-contents thereof.
-
-= TODO
-
-* Having the ability to take and analyse screen dumps would be useful.
-
-* Finish the specs.
-
-* Fix issues with the way we use a background thread to handle the clipboard
-  etc chatter from the server.
+= Introduction
+
+The ruby-vnc library provides for simple rfb-protocol based control of a
+VNC server. This can be used, eg, to automate applications (sometimes there
+is no better way), or script some sort of interaction.
+
+Being VNC based gives it the advantage of being able to be run against
+servers on any platform.
+
+The primary documentation is for the Net::VNC class.
+
+= Thanks
+
+Code borrows a lot from Tim Waugh's excellent rfbplaymacro. So far all it
+really offers on top of that is access to the host clipboard, and the ease
+with which it can be scripted, ie taking conditional actions based on the
+contents thereof.
+
+= TODO
+
+* Having the ability to take and analyse screen dumps would be useful.
+
+* Finish the specs.
+
+* Fix issues with the way we use a background thread to handle the clipboard
+  etc chatter from the server.

data/Rakefile

@@ -46,7 +46,7 @@ end
 
 Rake::GemPackageTask.new(spec) do |t|
 	t.gem_spec = spec
-	t.need_tar = true
+	t.need_tar = false
 	t.need_zip = false
 	t.package_dir = 'build'
 end

data/lib/cipher/des.rb

@@ -169,7 +169,7 @@ module Cipher
 				pc1m = (0...56).map do |j|
 					l = PC1[j]
 					m = l & 07
-					(key[l >> 3] & BYTEBIT[m]) != 0 ? 1 : 0;
+					(key[l >> 3].ord & BYTEBIT[m]) != 0 ? 1 : 0;
 				end
 
 				16.times do |i|

data/lib/net/vnc.rb

@@ -1,306 +1,306 @@
-require 'socket'
-require 'yaml'
-require 'thread'
-require 'cipher/des'
-require 'net/vnc/version'
-
-module Net
-	#
-	# The VNC class provides for simple rfb-protocol based control of
-	# a VNC server. This can be used, eg, to automate applications.
-	#
-	# Sample usage:
-	#
-	#	  # launch xclock on localhost. note that there is an xterm in the top-left
-	#   Net::VNC.open 'localhost:0', :shared => true, :password => 'mypass' do |vnc|
-	#     vnc.pointer_move 10, 10
-	#     vnc.type 'xclock'
-	#     vnc.key_press :return
-	#   end
-	#
-	# = TODO
-	#
-	# * The server read loop seems a bit iffy. Not sure how best to do it.
-	# * Should probably be changed to be more of a lower-level protocol wrapping thing, with the
-	#   actual VNCClient sitting on top of that. all it should do is read/write the packets over
-	#   the socket.
-	#
-	class VNC
-		class PointerState
-			attr_reader :x, :y, :button
-
-			def initialize vnc
-				@x = @y = @button = 0
-				@vnc = vnc
-			end
-
-			# could have the same for x=, and y=
-			def button= button
-				@button = button
-				refresh
-			end
-
-			def update x, y, button=@button
-				@x, @y, @button = x, y, button
-				refresh
-			end
-
-			def refresh
-				packet = 0.chr * 6
-				packet[0] = 5
-				packet[1] = button
-				packet[2, 2] = [x].pack 'n'
-				packet[4, 2] = [y].pack 'n'
-				@vnc.socket.write packet
-			end
-		end
-
-		BASE_PORT = 5900
-		CHALLENGE_SIZE = 16
-		DEFAULT_OPTIONS = {
-			:shared => false,
-			:wait => 0.1
-		}
-
-		keys_file = File.dirname(__FILE__) + '/../../data/keys.yaml'
-		KEY_MAP = YAML.load_file(keys_file).inject({}) { |h, (k, v)| h.update k.to_sym => v }
-		def KEY_MAP.[] key
-			super or raise ArgumentError.new('Invalid key name - %s' % key)
-		end
-
-		attr_reader :server, :display, :options, :socket, :pointer
-
-		def initialize display=':0', options={}
-			@server = 'localhost'
-			if display =~ /^(.*)(:\d+)$/
-				@server, display = $1, $2
-			end
-			@display = display[1..-1].to_i
-			@options = DEFAULT_OPTIONS.merge options
-			@clipboard = nil
-			@pointer = PointerState.new self
-			@mutex = Mutex.new
-			connect
-			@packet_reading_state = nil
-			@packet_reading_thread = Thread.new { packet_reading_thread }
-		end
-
-		def self.open display=':0', options={}
-			vnc = new display, options
-			if block_given?
-				begin
-					yield vnc
-				ensure
-					vnc.close
-				end
-			else
-				vnc
-			end
-		end
-
-		def port
-			BASE_PORT + @display
-		end
-
-		def connect
-			@socket = TCPSocket.open server, port
-			unless socket.read(12) =~ /^RFB (\d{3}.\d{3})\n$/
-				raise 'invalid server response'
-			end
-			@server_version = $1
-			socket.write "RFB 003.003\n"
-			data = socket.read(4)
-			auth = data.to_s.unpack('N')[0]
-			case auth
-			when 0, nil
-				raise 'connection failed'
-			when 1
-				# ok...
-			when 2
-				password = @options[:password] or raise 'Need to authenticate but no password given'
-				challenge = socket.read CHALLENGE_SIZE
-				response = Cipher::DES.encrypt password, challenge
-				socket.write response
-				ok = socket.read(4).to_s.unpack('N')[0]
-				raise 'Unable to authenticate - %p' % ok unless ok == 0
-			else
-				raise 'Unknown authentication scheme - %d' % auth
-			end
-
-			# ClientInitialisation
-			socket.write((options[:shared] ? 1 : 0).chr)
-
-			# ServerInitialisation
-			# TODO: parse this.
-			socket.read(20)
-			data = socket.read(4)
-			# read this many bytes in chunks of 20
-			size = data.to_s.unpack('N')[0]
-			while size > 0
-				len = [20, size].min
-				# this is the hostname, and other stuff i think...
-				socket.read(len)
-				size -= len
-			end
-		end
-
-		# this types +text+ on the server
-		def type text, options={}
-			packet = 0.chr * 8
-			packet[0] = 4
-			text.split(//).each do |char|
-				packet[7] = char[0]
-				packet[1] = 1
-				socket.write packet
-				packet[1] = 0
-				socket.write packet
-			end
-			wait options
-		end
-
-		# this takes an array of keys, and successively holds each down then lifts them up in
-		# reverse order.
-		# FIXME: should wait. can't recurse in that case.
-		def key_press(*args)
-			options = Hash === args.last ? args.pop : {}
-			keys = args
-			raise ArgumentError, 'Must have at least one key argument' if keys.empty?
-			begin
-				key_down keys.first
-				if keys.length == 1
-					yield if block_given?
-				else
-					key_press(*(keys[1..-1] + [options]))
-				end
-			ensure
-				key_up keys.first
-			end
-		end
-
-		def get_key_code which
-			if String === which
-				if which.length != 1
-					raise ArgumentError, 'can only get key_code of single character strings'
-				end
-				which[0]
-			else
-				KEY_MAP[which]
-			end
-		end
-		private :get_key_code
-
-		def key_down which, options={}
-			packet = 0.chr * 8
-			packet[0] = 4
-			key_code = get_key_code which
-			packet[4, 4] = [key_code].pack('N')
-			packet[1] = 1
-			socket.write packet
-			wait options
-		end
-
-		def key_up which, options={}
-			packet = 0.chr * 8
-			packet[0] = 4
-			key_code = get_key_code which
-			packet[4, 4] = [key_code].pack('N')
-			packet[1] = 0
-			socket.write packet
-			wait options
-		end
-
-		def pointer_move x, y, options={}
-			# options[:relative]
-			pointer.update x, y
-			wait options
-		end
-
-		BUTTON_MAP = {
-			:left => 0
-		}
-
-		def button_press button=:left, options={}
-			begin
-				button_down button, options
-				yield if block_given?
-			ensure
-				button_up button, options
-			end
-		end
-
-		def button_down which=:left, options={}
-			button = BUTTON_MAP[which] || which
-			raise ArgumentError, 'Invalid button - %p' % which unless (0..2) === button
-			pointer.button |= 1 << button
-			wait options
-		end
-
-		def button_up which=:left, options={}
-			button = BUTTON_MAP[which] || which
-			raise ArgumentError, 'Invalid button - %p' % which unless (0..2) === button
-			pointer.button &= ~(1 << button)
-			wait options
-		end
-
-		def wait options={}
-			sleep options[:wait] || @options[:wait]
-		end
-
-		def close
-			# destroy packet reading thread
-			if @packet_reading_state == :loop
-				@packet_reading_state = :stop
-				while @packet_reading_state
-					# do nothing
-				end
-			end
-			socket.close
-		end
-
-		def clipboard
-			if block_given?
-				@clipboard = nil
-				yield
-				60.times do
-					clipboard = @mutex.synchronize { @clipboard }
-					return clipboard if clipboard
-					sleep 0.5
-				end
-				warn 'clipboard still empty after 30s'
-				nil
-			else
-				@mutex.synchronize { @clipboard }
-			end
-		end
-
-		private
-
-		def read_packet type
-			case type
-			when 3 # ServerCutText
-				socket.read 3 # discard padding bytes
-				len = socket.read(4).unpack('N')[0]
-				@mutex.synchronize { @clipboard = socket.read len }
-			else
-				raise NotImplementedError, 'unhandled server packet type - %d' % type
-			end
-		end
-
-		def packet_reading_thread
-			@packet_reading_state = :loop
-			loop do
-				begin
-					break if @packet_reading_state != :loop
-					next unless IO.select [socket], nil, nil, 2
-					type = socket.read(1)[0]
-					read_packet type
-				rescue
-					warn "exception in packet_reading_thread: #{$!.class}:#{$!}"
-					break
-				end
-			end
-			@packet_reading_state = nil
-		end
-	end
-end
-
+require 'socket'
+require 'yaml'
+require 'thread'
+require 'cipher/des'
+require 'net/vnc/version'
+
+module Net
+	#
+	# The VNC class provides for simple rfb-protocol based control of
+	# a VNC server. This can be used, eg, to automate applications.
+	#
+	# Sample usage:
+	#
+	#	  # launch xclock on localhost. note that there is an xterm in the top-left
+	#   Net::VNC.open 'localhost:0', :shared => true, :password => 'mypass' do |vnc|
+	#     vnc.pointer_move 10, 10
+	#     vnc.type 'xclock'
+	#     vnc.key_press :return
+	#   end
+	#
+	# = TODO
+	#
+	# * The server read loop seems a bit iffy. Not sure how best to do it.
+	# * Should probably be changed to be more of a lower-level protocol wrapping thing, with the
+	#   actual VNCClient sitting on top of that. all it should do is read/write the packets over
+	#   the socket.
+	#
+	class VNC
+		class PointerState
+			attr_reader :x, :y, :button
+
+			def initialize vnc
+				@x = @y = @button = 0
+				@vnc = vnc
+			end
+
+			# could have the same for x=, and y=
+			def button= button
+				@button = button
+				refresh
+			end
+
+			def update x, y, button=@button
+				@x, @y, @button = x, y, button
+				refresh
+			end
+
+			def refresh
+				packet = 0.chr * 6
+				packet[0] = 5.chr
+				packet[1] = button.chr
+				packet[2, 2] = [x].pack 'n'
+				packet[4, 2] = [y].pack 'n'
+				@vnc.socket.write packet
+			end
+		end
+
+		BASE_PORT = 5900
+		CHALLENGE_SIZE = 16
+		DEFAULT_OPTIONS = {
+			:shared => false,
+			:wait => 0.1
+		}
+
+		keys_file = File.dirname(__FILE__) + '/../../data/keys.yaml'
+		KEY_MAP = YAML.load_file(keys_file).inject({}) { |h, (k, v)| h.update k.to_sym => v }
+		def KEY_MAP.[] key
+			super or raise ArgumentError.new('Invalid key name - %s' % key)
+		end
+
+		attr_reader :server, :display, :options, :socket, :pointer
+
+		def initialize display=':0', options={}
+			@server = 'localhost'
+			if display =~ /^(.*)(:\d+)$/
+				@server, display = $1, $2
+			end
+			@display = display[1..-1].to_i
+			@options = DEFAULT_OPTIONS.merge options
+			@clipboard = nil
+			@pointer = PointerState.new self
+			@mutex = Mutex.new
+			connect
+			@packet_reading_state = nil
+			@packet_reading_thread = Thread.new { packet_reading_thread }
+		end
+
+		def self.open display=':0', options={}
+			vnc = new display, options
+			if block_given?
+				begin
+					yield vnc
+				ensure
+					vnc.close
+				end
+			else
+				vnc
+			end
+		end
+
+		def port
+			BASE_PORT + @display
+		end
+
+		def connect
+			@socket = TCPSocket.open server, port
+			unless socket.read(12) =~ /^RFB (\d{3}.\d{3})\n$/
+				raise 'invalid server response'
+			end
+			@server_version = $1
+			socket.write "RFB 003.003\n"
+			data = socket.read(4)
+			auth = data.to_s.unpack('N')[0]
+			case auth
+			when 0, nil
+				raise 'connection failed'
+			when 1
+				# ok...
+			when 2
+				password = @options[:password] or raise 'Need to authenticate but no password given'
+				challenge = socket.read CHALLENGE_SIZE
+				response = Cipher::DES.encrypt password, challenge
+				socket.write response
+				ok = socket.read(4).to_s.unpack('N')[0]
+				raise 'Unable to authenticate - %p' % ok unless ok == 0
+			else
+				raise 'Unknown authentication scheme - %d' % auth
+			end
+
+			# ClientInitialisation
+			socket.write((options[:shared] ? 1 : 0).chr)
+
+			# ServerInitialisation
+			# TODO: parse this.
+			socket.read(20)
+			data = socket.read(4)
+			# read this many bytes in chunks of 20
+			size = data.to_s.unpack('N')[0]
+			while size > 0
+				len = [20, size].min
+				# this is the hostname, and other stuff i think...
+				socket.read(len)
+				size -= len
+			end
+		end
+
+		# this types +text+ on the server
+		def type text, options={}
+			packet = 0.chr * 8
+			packet[0] = 4.chr
+			text.split(//).each do |char|
+				packet[7] = char[0]
+				packet[1] = 1.chr
+				socket.write packet
+				packet[1] = 0.chr
+				socket.write packet
+			end
+			wait options
+		end
+
+		# this takes an array of keys, and successively holds each down then lifts them up in
+		# reverse order.
+		# FIXME: should wait. can't recurse in that case.
+		def key_press(*args)
+			options = Hash === args.last ? args.pop : {}
+			keys = args
+			raise ArgumentError, 'Must have at least one key argument' if keys.empty?
+			begin
+				key_down keys.first
+				if keys.length == 1
+					yield if block_given?
+				else
+					key_press(*(keys[1..-1] + [options]))
+				end
+			ensure
+				key_up keys.first
+			end
+		end
+
+		def get_key_code which
+			if String === which
+				if which.length != 1
+					raise ArgumentError, 'can only get key_code of single character strings'
+				end
+				which[0]
+			else
+				KEY_MAP[which]
+			end
+		end
+		private :get_key_code
+
+		def key_down which, options={}
+			packet = 0.chr * 8
+			packet[0] = 4.chr
+			key_code = get_key_code which
+			packet[4, 4] = [key_code].pack('N')
+			packet[1] = 1.chr
+			socket.write packet
+			wait options
+		end
+
+		def key_up which, options={}
+			packet = 0.chr * 8
+			packet[0] = 4.chr
+			key_code = get_key_code which
+			packet[4, 4] = [key_code].pack('N')
+			packet[1] = 0.chr
+			socket.write packet
+			wait options
+		end
+
+		def pointer_move x, y, options={}
+			# options[:relative]
+			pointer.update x, y
+			wait options
+		end
+
+		BUTTON_MAP = {
+			:left => 0
+		}
+
+		def button_press button=:left, options={}
+			begin
+				button_down button, options
+				yield if block_given?
+			ensure
+				button_up button, options
+			end
+		end
+
+		def button_down which=:left, options={}
+			button = BUTTON_MAP[which] || which
+			raise ArgumentError, 'Invalid button - %p' % which unless (0..2) === button
+			pointer.button |= 1 << button
+			wait options
+		end
+
+		def button_up which=:left, options={}
+			button = BUTTON_MAP[which] || which
+			raise ArgumentError, 'Invalid button - %p' % which unless (0..2) === button
+			pointer.button &= ~(1 << button)
+			wait options
+		end
+
+		def wait options={}
+			sleep options[:wait] || @options[:wait]
+		end
+
+		def close
+			# destroy packet reading thread
+			if @packet_reading_state == :loop
+				@packet_reading_state = :stop
+				while @packet_reading_state
+					# do nothing
+				end
+			end
+			socket.close
+		end
+
+		def clipboard
+			if block_given?
+				@clipboard = nil
+				yield
+				60.times do
+					clipboard = @mutex.synchronize { @clipboard }
+					return clipboard if clipboard
+					sleep 0.5
+				end
+				warn 'clipboard still empty after 30s'
+				nil
+			else
+				@mutex.synchronize { @clipboard }
+			end
+		end
+
+		private
+
+		def read_packet type
+			case type
+			when 3 # ServerCutText
+				socket.read 3 # discard padding bytes
+				len = socket.read(4).unpack('N')[0]
+				@mutex.synchronize { @clipboard = socket.read len }
+			else
+				raise NotImplementedError, 'unhandled server packet type - %d' % type
+			end
+		end
+
+		def packet_reading_thread
+			@packet_reading_state = :loop
+			loop do
+				begin
+					break if @packet_reading_state != :loop
+					next unless IO.select [socket], nil, nil, 2
+					type = socket.read(1)[0]
+					read_packet type
+				rescue
+					warn "exception in packet_reading_thread: #{$!.class}:#{$!}"
+					break
+				end
+			end
+			@packet_reading_state = nil
+		end
+	end
+end
+

data/lib/net/vnc/version.rb

@@ -1,6 +1,6 @@
-module Net
-	class VNC
-		VERSION = '1.0.1'
-	end
-end
-
+module Net
+	class VNC
+		VERSION = '1.1.0'
+	end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-vnc
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Charles Lowe
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-15 00:00:00 -04:00
+date: 2012-06-03 00:00:00 +10:00
 default_executable: 
 dependencies: []