yakr 0.2.3 → 0.2.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZDNmNTlhMzFmZTg5YzFkZWZkODk2ODIwZmFkMTE5MDEwMDA3NDAyZA==
-  data.tar.gz: !binary |-
-    MGM1M2VkMmI0YTI0MTc2MmQ2MzY4Y2JjOWIyYzlhMWM4ZTE4Y2RjMA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    OGY4ZDVlMTYxM2RjY2UzOGZiMzM2ZmVmOWU4OTYxY2I2OTk2N2ViZjNkYzUy
-    M2Y4MzJkNjE1OWZjNDBmODAxODg3OTczNTg3MmY0ODVhNjNhN2I0MjAyZjUw
-    ZTJiNjczMDg4YTg4MWQ4YWFlMjdkMjM0OWFmMzk4NDlhNGUxMjY=
-  data.tar.gz: !binary |-
-    YzdjOTIwYzhhNjk1MzQ5MDQwMjAxNTQwNzRhZWU2NTUyNjc2NTViOTljODg1
-    NzI1MWFiNzIwMzkxM2QxYTMyOGU1YmYyYzkwN2IzZjY1NzMzMTA1YmJlOTY5
-    YWQ1NTE0YjY2OThhYmM5Mjc3ODMyYTI4YmQzZTQzYTcxODBkZTQ=
+SHA1:
+  metadata.gz: 655f3af8ad49c2ab4d6410243fffe8a214bbcbb8
+  data.tar.gz: e939f4be28c997883fe756ab7985e5f4d68628f7
+SHA512:
+  metadata.gz: 5c6f5f43ddebe3c2ca9adc976b3857a9fb1343d81fa41e7fb99da93caabe5a2991fa4dd61cebfd89ded4da65c1b094e55505e085b996d56ca57590382c0a1e41
+  data.tar.gz: 97e703de77f0e7ac02777c4c8e4d07d187781dc1a1d32a705c1d7d4d5426b00b695bdc266782916e1a4c36cfa2c96d976bfef83b7c9d5016a0ceed1ba8e90036

data/README.md

@@ -44,10 +44,14 @@ The server instance of Yakr can be told to redirect the data it receives to a fi
 For additional options type `yakr --help`.
 
 ##Fun Stuff
-To be added soon.
+It's possible to mimic a simple chat interface using a split terminal window (courtesy of the wonderful [iTerm 2](http://http://www.iterm2.com)):
+
+![Split terminal conversation](http://fidgetbox.co.uk/github/split_yakr.png)
+
+The top pane shows the output of a local instance of Yakr with a remote client connected. This acts as our incoming chat window. The bottom pane shows another local instance of Yakr connected to the remote system as a client. This acts as our outgoing message window. Crude, but perfectly usable.
 
 ##License
 Yakr is free software, and you are welcome to redistribute it under certain conditions.  See the [GNU General Public License](http://www.gnu.org/licenses/gpl.html) for more details.
 
 ##Comments or suggestions?
-Email me at [marc.ransome@fidgetbox.co.uk](marc.ransome@fidgetbox.co.uk) with bug reports, feature requests or general comments and follow [@marcransome](http://www.twitter.com/marcransome) for updates.
+Email me at [marc.ransome@fidgetbox.co.uk](mailto://marc.ransome@fidgetbox.co.uk) with bug reports, feature requests or general comments and follow [@marcransome](http://www.twitter.com/marcransome) for updates.

data/lib/yakr.rb

@@ -27,7 +27,7 @@ require 'timeout'
 
 class Yakr
 	
-	VERSION = "0.2.3"
+	VERSION = "0.2.4"
 	REQUIRE_SERVER = 0.1
 	USAGE_BANNER = "Use `#{File.basename($0)} --help` for available options."
 
@@ -38,8 +38,7 @@ class Yakr
 		
 		# test for zero arguments
 		if ARGV.empty? then
-			puts USAGE_BANNER
-			exit 1
+			self.exit_with_banner(1)
 		end
 		
 		# start processing command line arguments
@@ -47,68 +46,66 @@ class Yakr
 			options = OptionReader.parse(ARGV)
 		rescue OptionParser::InvalidOption => t
 			puts t
-			puts USAGE_BANNER
-			exit
+			self.exit_with_banner(1)
 		rescue OptionParser::MissingArgument => m
 			puts m
-			puts USAGE_BANNER
-			exit
+			self.exit_with_banner(1)
 		end
 		
-		# ensure host argument is specified if a port is specified
-		if options.connect_port.any? and !options.connect_host.any?
-			puts "host connect: no host specified"
-			puts USAGE_BANNER
-			exit 1
+		# validate mode options
+		if (options.connect_host or options.connect_port) and
+			 (options.listen_port or options.limit_lines) then
+			puts "mode options: specify either listen or connect options"
+			self.exit_with_banner(1)
+		elsif not (options.connect_host or options.listen_port)
+			puts "mode options: specify listen or connect options"
+			self.exit_with_banner(1)
 		end
 		
-		if options.connect_host.any? and !options.connect_port.any?
-			puts "host connect: no port specified"
-			puts USAGE_BANNER
-			exit 1
+		# validate server options
+		if options.connect_port and not options.connect_host
+			puts "host connect: no host specified"
+			self.exit_with_banner(1)
 		end
 		
-		# validate host argument
-		if options.connect_host.any?
-			# TODO
+		if options.connect_host and not options.connect_port
+			puts "host connect: no port specified"
+			self.exit_with_banner(1)
 		end
 		
-		# test for invalid host port
-		if options.connect_port.any?
-			if !(options.connect_port.first.to_i > 0) and !(options.connect_port.first.to_i < 65535)
-				puts "invalid port: #{options.connect_port.first.to_s}"
-				puts USAGE_BANNER
-				exit 1
+		# validate connection port
+		if options.connect_port
+			if not (options.connect_port.to_i > 0 and options.connect_port.to_i <= 65535)
+				puts "invalid port: #{options.connect_port.to_s}"
+				self.exit_with_banner(1)
 			end
 		end
 		
 		# validate listen port
-		if options.connect_port.any?
-			if options.connect_port.first.to_i > 0 and options.connect_port.first.to_i < 65535
-				# valid port provided
-				
-			else
-				puts "invalid port: #{options.connect_port.first.to_s}"
-				puts USAGE_BANNER
-				exit 1
+		if options.listen_port
+			if not (options.listen_port.to_i > 0 and options.listen_port.to_i <= 65535)
+				puts "invalid port: #{options.listen_port.to_s}"
+				self.exit_with_banner(1)
 			end
-		else
-			options.connect_port << "4000"
 		end
-	
-		# assume connection mode wherever a host has been specified,
-		# otherwise listen for incoming connections
-		if options.connect_host.any?
-			connect(options.connect_host.first, options.connect_port.first.to_i)
+		
+		# validate line limit
+		if options.limit_lines and not options.limit_lines.to_i > 0
+				puts "invalid max lines: #{options.limit_lines}"
+				self.exit_with_banner(1)
+		end
+		
+		if options.connect_host
+			connect(options.connect_host, options.connect_port.to_i)
 		else
-			listen(options.listen_port.first.to_i, options.limit_lines.to_i)
+			listen(options.listen_port.to_i, options.limit_lines.to_i)
 		end
 	end
 
 	def self.connect(host, port)
 		
 		begin
-			timeout(30) do
+			timeout(20) do
 				
 				puts "Attempting connection.."
 				
@@ -126,13 +123,11 @@ class Yakr
 				# read from standard input and send
 				# text line by line to server
 				STDIN.each do |str|
-					#str.chomp!
 					@server.puts "#{str}"
 				end
 			else
 				puts "host connect: unexpected server response"
-				puts USAGE_BANNER
-				exit 1
+				self.exit_with_banner(1)
 			end
 		
 		rescue Interrupt
@@ -140,35 +135,26 @@ class Yakr
 			exit 1
 		rescue Timeout::Error => ex
 			puts "host connect: timed out"
-			puts USAGE_BANNER
-			exit 1
-		rescue
-			puts "host connect: unable to connect"
-			puts USAGE_BANNER
-			exit 1
+			self.exit_with_banner(1)
+		rescue => e
+			puts "host connect: unable to connect #{e}"
+			self.exit_with_banner(1)
 		ensure
 			@server.close unless @server.nil?
 		end		
 	end
 	
-	def self.listen(port, lines_arg)
+	def self.listen(port, max_lines)
 		begin
+			limit_output = true if max_lines > 0
 			@server = TCPServer.open(port)
 			loop do
 				client = @server.accept
 				client.puts "yakr=>version:#{VERSION}"
-
-				max_lines = lines_arg
-				
-				client.each do |str|
-					
-					exit 0 if max_lines == 0 and lines_arg > 0
-					
-					#str.chomp!
+				client.each do |str|					
+					exit 0 if max_lines <= 0 and limit_output
 					puts "#{str}"
-					
-					# decrement line counter
-					max_lines -= 1
+					max_lines -= 1 if limit_output
 				end
 			end
 		rescue Interrupt
@@ -182,4 +168,9 @@ class Yakr
 			@server.close unless @server.nil?
 		end
 	end
+	
+	def self.exit_with_banner(x)
+		puts USAGE_BANNER
+		exit x
+	end
 end

data/lib/yakr/optionreader.rb

@@ -24,10 +24,6 @@ class OptionReader
 	def self.parse(args)
 
 		options = OpenStruct.new
-		options.connect_host = []
-		options.connect_port = []
-		options.listen_port = []
-		options.limit_lines = 0
 
 		opts = OptionParser.new do |opts|
 			opts.banner = "Usage: #{File.basename($0)} -c HOST -p PORT | -l PORT [-m NUM]"
@@ -36,25 +32,24 @@ class OptionReader
 			opts.separator "Client mode options:"
 
 			opts.on("-c", "--connect HOST", "Specify the remote host to connect to") do |host|
-				options.connect_host << host
+				options.connect_host = host
 			end
 
 			opts.on("-p", "--port PORT", "Port number for outgoing connection") do |port|
-				options.connect_port << port
+				options.connect_port = port
 			end
 
 			opts.separator ""
 			opts.separator "Server mode options:"
 
 			opts.on("-l", "--listen PORT", "Port number for incoming connection") do |port|
-				options.listen_port << port
+				options.listen_port = port
 			end
 			
 			opts.on("-m", "--max NUM", "Limit output to NUM lines, then exit") do |lines|
 				options.limit_lines = lines
 			end
-
-
+			
 			opts.separator ""
 			opts.separator "Misc options:"
 

data/test.sh

@@ -0,0 +1,36 @@
+#!/bin/bash
+#
+#  test.sh
+#
+#  Copyright (c) 2012, Marc Ransome <marc.ransome@fidgetbox.co.uk>
+#
+#  This file is part of Yakr.
+#
+#  Yakr is free software: you can redistribute it and/or modify
+#  it under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  Yakr is distributed in the hope that it will be useful,
+#  but WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#  GNU General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with Yakr.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+version_from_gemspec=$( grep 's.version' yakr.gemspec | cut -c 16-20 )
+gem_file="yakr-$version_from_gemspec.gem"
+
+echo "Removing outdated gem files.."
+rm *.gem
+
+echo "Uninstalling previous versions.."
+gem uninstall -a -x yakr
+
+echo "Building gem.."
+gem build yakr.gemspec
+
+echo "Installing gem file.."
+gem install $gem_file

data/yakr.gemspec

@@ -21,8 +21,8 @@
 
 Gem::Specification.new do |s|
 	s.name			= 'yakr'
-	s.version		= '0.2.3'
-	s.date			= '2013-02-25'
+	s.version		= '0.2.4'
+	s.date			= '2013-04-30'
 	s.summary		= 'TCP/IP output tool'
 	s.description	= 'Yakr is a minimalist network tool for forwarding command output or arbitrary data to a remote host.'
 	s.authors		= ["Marc Ransome"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yakr
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Marc Ransome
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies: []
 description: Yakr is a minimalist network tool for forwarding command output or arbitrary
   data to a remote host.
@@ -23,6 +23,7 @@ files:
 - bin/yakr
 - lib/yakr.rb
 - lib/yakr/optionreader.rb
+- test.sh
 - yakr.gemspec
 homepage: http://marcransome.github.com/Yakr
 licenses:
@@ -34,17 +35,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: TCP/IP output tool