telnetd 0.0.1.alpha.1

data/README.md

@@ -0,0 +1,4 @@
+telnetd
+=======
+
+Simple ruby telnet server.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/telnetd

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'telnetd'
+
+Telnetd.run

data/lib/telnetd/telnet_client.rb

@@ -0,0 +1,49 @@
+# Represent a telnet client. 
+# This class is used to be executed in a single thread
+
+class TelnetClient
+
+	# Create a new instance of the telnet client
+	# ==== Arguments
+	# *+client+ The socket client connection to be wrapped. Must be connected.
+	def initialize(client)
+		raise ArgumentError, "Client not connected" if client.closed?
+		@client = client
+
+		@port, @ip = Socket.unpack_sockaddr_in(client.getpeername)
+	end
+
+	# Starts the client processing by sending the welcome message.
+	# Also enter the processing loop to handle client commands
+	def handle()
+		welcome_message()
+		promt()
+		while line = @client.gets
+			process_cmd(line)
+  			promt()
+		end
+	end
+
+	# Close the client connection with sending a bye message and close the socket.
+	def close()
+  		@client.print "\r\nClosing the connection. Bye!"
+  		@client.close
+	end
+
+private
+
+	def process_cmd(cmd)
+		puts cmd
+	end
+
+	def promt
+		@client.print "\r\n>>"
+	end
+
+	def welcome_message
+		@client.print "Welcome to telnetd.\r\n"
+		@client.print "===================\r\n"
+		@client.print "Type 'help' to get a list of all commands or 'exit' to end the session.\r\n"
+	end
+
+end

data/lib/telnetd/telnet_server.rb

@@ -0,0 +1,65 @@
+# The Telnet daemon main class. Create a new thread for each client
+
+require 'socket'
+require 'telnetd/telnet_client'
+
+class TelnetServer
+
+	# Create a new instance of the Telnet Server class.
+	def initialize
+		@client_list = []
+	end
+
+	# Start the server in a new thread. This method will return immediately after the server thread is running.
+	# You must use the same instance of the TelnetServer class to stop an existing server by calling the stop
+	# method. Otherwise the socket listening thread could not be stopped.
+	# * By default the server creates an socket listening on port 23.
+	# * Each new connection on this server will be handled by a separate thread.
+	def start
+		@server_thread = Thread.new do
+			begin
+			server = TCPServer.open(23)
+			loop {
+				begin
+					client = TelnetClient.new(server.accept)
+					@client_list << client
+	  				t = Thread.new do
+	  					handleNewClient(client) 
+	  				end
+	  			rescue Exception => e 
+					puts "Client Error: #{e.message}" 
+				end
+			}
+			rescue Interrupt => e
+				puts "Server is interrupted"
+			ensure
+				close_all()
+			end
+		end
+	end
+
+	# Used to stop a running server instance.
+	# This method will cause all connected clients to be disconnected.
+	# ===== Throws
+	# * ArgumentError if server is not running or server thread is not alive. Maybe you miss to start the server first.
+	def stop
+		raise ArgumentError, "Server has not be started." if @server_thread.nil? or @server_thread.alive? == false
+		@server_thread.exit
+	end
+
+private
+	def close_all()
+		@client_list.each { |client|
+			client.close()
+		}
+	end
+
+	def handleNewClient(client)
+		begin
+			client.handle()
+  		rescue Exception => e 
+			puts "Client Error: #{e.message}" 
+		end			
+	end
+
+end

data/lib/telnetd.rb

@@ -0,0 +1,17 @@
+# telnetd console runner
+
+require 'telnetd/telnet_server'
+
+class Telnetd
+
+	def self.run
+		telnetd = TelnetServer.new
+		telnetd.start
+		puts "Telnet server started."
+		puts "Press any key to stop."
+		STDIN.getc
+		telnetd.stop
+		puts "Telnet server stopped."
+	end
+
+end

data/make_rdoc.bat

@@ -0,0 +1,3 @@
+@echo on
+rmdir /S /Q .\doc
+rdoc --main Readme.txt

data/telnetd.gemspec

@@ -0,0 +1,14 @@
+require 'rake'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'telnetd'
+  spec.version     = '0.0.1.alpha.1'
+  spec.date        = '2013-04-04'
+  spec.summary     = "Simple telnet daemon"
+  spec.description = "Simple telnet daemon to be used from the command line or as embedded service."
+  spec.authors     = ["Promotos"]
+  spec.email       = 'promotos@gmx.de'
+  spec.files = FileList['lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
+  spec.executables << 'telnetd'
+  spec.homepage    = 'http://rubygems.org/gems/telnetd'
+end

data/test/test_telnet_server.rb

@@ -0,0 +1,21 @@
+# Tests used for the telnet server
+
+require 'test/unit'
+require 'socket'
+require 'telnetd/telnet_server'
+
+class TelnetServerTest < Test::Unit::TestCase
+
+	def test_get_welcome_message
+		server = TelnetServer.new
+		server.start()
+
+		s = TCPSocket.open("localhost", 23)
+		line = s.gets
+		s.close
+
+		assert_equal("Welcome to telnetd.\r\n", line)
+		server.stop()
+	end
+
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: telnetd
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha.1
+  prerelease: 6
+platform: ruby
+authors:
+- Promotos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-04 00:00:00.000000000 Z
+dependencies: []
+description: Simple telnet daemon to be used from the command line or as embedded
+  service.
+email: promotos@gmx.de
+executables:
+- telnetd
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/telnetd/telnet_client.rb
+- lib/telnetd/telnet_server.rb
+- lib/telnetd.rb
+- bin/telnetd
+- make_rdoc.bat
+- Rakefile
+- README.md
+- telnetd-0.0.1.gem
+- telnetd.gemspec
+- test/test_telnet_server.rb
+homepage: http://rubygems.org/gems/telnetd
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Simple telnet daemon
+test_files: []