forwardmachine 0.0.1 → 1.0.0

data/README.md

@@ -5,7 +5,9 @@ Port forwarding service configurable in runtime.
 # How does it work?
 
 ForwardMachine listens on TCP port for forward requests.
-These requests are simple, they consist of host:port, e.g. host.example.com:3000
+
+These requests are simple, they consist of host:port, e.g. host.example.com:3000.
+
 As response, host and port where forwarding has been set up is returned.
 
 ## Installation
@@ -14,21 +16,24 @@ As response, host and port where forwarding has been set up is returned.
 
 ## Usage
 
-1. Start forwarder for host proxy.example.com
+Start forwarder for host proxy.example.com
 
     $ forwardmachine --forwarder-host proxy.example.com --ports-range 8000..9000
 
-2. Control server by default will listen on localhost:8899.
+Control server by default will listen on localhost:8899.
 Connect to it and create a new forwarder (here we use nc tool).
-Below we have created two ports forwards.
 
     $ nc localhost 8899
-    internal1.example.com:7777
-    proxy.example.com:8000
+      internal1.example.com:7777
+      proxy.example.com:8000
+      
+proxy.example.com:8000 is forwarded to internal1.example.com:7777
 
     $ nc localhost 8899
-    internal2.example.com:9999
-    proxy.example.com:8001
+      internal2.example.com:9999
+      proxy.example.com:8001
+      
+proxy.example.com:8001 is forwarded to internal2.example.com:9999
 
 ## Contributing
 

data/examples/forwardmachine

@@ -0,0 +1,138 @@
+#! /bin/sh
+### BEGIN INIT INFO
+# Provides:          forwardmachine
+# Required-Start:    $remote_fs $syslog
+# Required-Stop:     $remote_fs $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Init script for forwardmachine
+# Description:       Init script for forwardmachine
+#
+### END INIT INFO
+
+# Do NOT "set -e"
+
+# PATH should only include /usr/* if it runs after the mountnfs.sh script
+PATH=/usr/local/bin:/sbin:/usr/sbin:/bin:/usr/bin
+DESC="Port forwarding service"
+NAME=forwardmachine
+DAEMON=`which forwardmachine`
+DAEMON_ARGS="--forwarder-host proxy.example.com --ports-range 8000..9000 --log /var/log/forwardmachine/forwardmachine.log"
+PIDFILE=/var/run/$NAME.pid
+SCRIPTNAME=/etc/init.d/$NAME
+
+# Load the VERBOSE setting and other rcS variables
+. /lib/init/vars.sh
+
+# Define LSB log_* functions.
+# Depend on lsb-base (>= 3.2-14) to ensure that this file is present
+# and status_of_proc is working.
+. /lib/lsb/init-functions
+
+#
+# Function that starts the daemon/service
+#
+do_start()
+{
+	# Return
+	#   0 if daemon has been started
+	#   1 if daemon was already running
+	#   2 if daemon could not be started
+	start-stop-daemon --start --quiet --background --chuid nobody --make-pidfile --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
+		|| return 1
+	start-stop-daemon --start --quiet --background --chuid nobody --make-pidfile --pidfile $PIDFILE --exec $DAEMON -- \
+		$DAEMON_ARGS \
+		|| return 2
+	# Add code here, if necessary, that waits for the process to be ready
+	# to handle requests from services started subsequently which depend
+	# on this one.  As a last resort, sleep for some time.
+}
+
+#
+# Function that stops the daemon/service
+#
+do_stop()
+{
+	# Return
+	#   0 if daemon has been stopped
+	#   1 if daemon was already stopped
+	#   2 if daemon could not be stopped
+	#   other if a failure occurred
+	start-stop-daemon --stop --quiet --chuid nobody --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
+	RETVAL="$?"
+	[ "$RETVAL" = 2 ] && return 2
+	# Wait for children to finish too if this is a daemon that forks
+	# and if the daemon is only ever run from this initscript.
+	# If the above conditions are not satisfied then add some other code
+	# that waits for the process to drop all resources that could be
+	# needed by services started subsequently.  A last resort is to
+	# sleep for some time.
+	start-stop-daemon --stop --quiet --chuid nobody --oknodo --retry=0/30/KILL/5 --exec $DAEMON
+	[ "$?" = 2 ] && return 2
+	# Many daemons don't delete their pidfiles when they exit.
+	rm -f $PIDFILE
+	return "$RETVAL"
+}
+
+#
+# Function that sends a SIGHUP to the daemon/service
+#
+do_reload() {
+	#
+	# If the daemon can reload its configuration without
+	# restarting (for example, when it is sent a SIGHUP),
+	# then implement that here.
+	#
+	start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
+	return 0
+}
+
+case "$1" in
+  start)
+	[ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
+	do_start
+	case "$?" in
+		0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+		2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+	esac
+	;;
+  stop)
+	[ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
+	do_stop
+	case "$?" in
+		0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+		2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+	esac
+	;;
+  status)
+	status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?
+	;;
+  restart|force-reload)
+	#
+	# If the "reload" option is implemented then remove the
+	# 'force-reload' alias
+	#
+	log_daemon_msg "Restarting $DESC" "$NAME"
+	do_stop
+	case "$?" in
+	  0|1)
+		do_start
+		case "$?" in
+			0) log_end_msg 0 ;;
+			1) log_end_msg 1 ;; # Old process is still running
+			*) log_end_msg 1 ;; # Failed to start
+		esac
+		;;
+	  *)
+		# Failed to stop
+		log_end_msg 1
+		;;
+	esac
+	;;
+  *)
+	echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
+	exit 3
+	;;
+esac
+
+:

data/forwardmachine.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |gem|
   gem.name          = "forwardmachine"
   gem.require_paths = ["lib"]
   gem.version       = ForwardMachine::VERSION
-  
-  gem.add_runtime_dependency "eventmachine"
+
+  gem.add_runtime_dependency "eventmachine", "~> 0.12"
   gem.add_runtime_dependency "em-logger"
-  
+
   gem.add_development_dependency "rspec"
 end

data/lib/forwardmachine/forwarder.rb

@@ -3,7 +3,7 @@ module ForwardMachine
   # ports pool. Each connection is handled by ForwarderConnection object
   class Forwarder
     # How long server will be open, waiting for the first connetion.
-    FIRST_USE_TIMEOUT = 15
+    FIRST_USE_TIMEOUT = 60
 
     attr_reader :host, :destination, :ports_pool, :port, :connections
 
@@ -25,12 +25,15 @@ module ForwardMachine
     # Public: Start forwarding server on given host and port taken from PortsPool.
     # Returns: Socket address of the server in format "host:port" as String
     def start
-      @server = EM.start_server(host, port, ForwarderConnection, destination, self) {
+      @server = EM.start_server(host, port, ForwarderConnection, destination, self) do
         @connections += 1
         @inactivity_timer.cancel
-      }
-      @inactivity_timer = EM::PeriodicTimer.new(FIRST_USE_TIMEOUT) { stop }
-      logger.info("Started forwarder #{socket_address} to #{destination}")
+      end
+      @inactivity_timer = EM::PeriodicTimer.new(FIRST_USE_TIMEOUT) do
+        logger.info("Forwarder #{self} timed out after #{FIRST_USE_TIMEOUT} seconds")
+        stop
+      end
+      logger.info("Started forwarder #{self}")
       socket_address
     end
 
@@ -48,13 +51,13 @@ module ForwardMachine
     end
 
     def to_s
-      socket_address
+      "#{socket_address}->#{destination}"
     end
 
     private
 
     def stop
-      logger.info("Stopped forwarder #{socket_address} to #{destination}")
+      logger.info("Stopped forwarder #{self}")
       @inactivity_timer.cancel
       EM.stop_server(@server)
       ports_pool.release(port)

data/lib/forwardmachine/forwarder_connection.rb

@@ -16,25 +16,25 @@ module ForwardMachine
     # Internal: After client is connected to forwarder, open connection
     # to destination host and port
     def post_init
-      logger.info("Client #{peer} connected to forwarder #{@forwarder} to #{@destination}")
+      logger.info("Client #{peer} connected to forwarder #{@forwarder}")
       EM.connect(@destination_host, @destination_port,
         ForwardedConnection, self)
     rescue RuntimeError => e
-      logger.error("Client #{peer} on #{@forwarder} couldn't be connected with #{@destination}")
+      logger.error("Client #{peer} on #{@forwarder} couldn't be connected with destination")
       close_connection
     end
 
     # Internal: After forwarder destination disconnected
     # terminate forwarder connection
     def proxy_target_unbound
-      logger.info("Destination #{@destination} disconnected from forwarder #{@forwarder}")
+      logger.info("Destination disconnected from forwarder #{@forwarder}")
       close_connection
     end
 
     # Internal: After client disconnects from forwarder
     # notify forwarder server about it.
     def unbind
-      logger.info("Client #{peer} disconnected from forwarder #{@forwarder} to #{@destination}")
+      logger.info("Client #{peer} disconnected from forwarder #{@forwarder}")
       @forwarder.forwarder_connection_closed
     end
 

data/lib/forwardmachine/version.rb

@@ -1,3 +1,3 @@
 module ForwardMachine
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forwardmachine
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-30 00:00:00.000000000 Z
+date: 2012-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: em-logger
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,7 @@ files:
 - README.md
 - Rakefile
 - bin/forwardmachine
+- examples/forwardmachine
 - forwardmachine.gemspec
 - lib/forwardmachine.rb
 - lib/forwardmachine/controller.rb