surro-gate 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad375981bd8f2b842ba825df243cd373b6a458a6
-  data.tar.gz: 6b56516f80d5e2c0487f8a6ae694245287f7cf69
+  metadata.gz: e7ca2413b4164e0b24ab63bc4045b6032f547a98
+  data.tar.gz: 4d962b753c9dc1fd90c6eb4ba1d8f4608fbb36eb
 SHA512:
-  metadata.gz: 71e1ea8a327d5ded2f9fef6ba217cb46a473054cdbedafbbde8b7646ab8ea98080cf4e1a6c4c2817143644dc8e47231a9dc6e1cab0ab0078875520d6b36da475
-  data.tar.gz: c9493e2bf69920c0d4ffe86c1ec2ce1ae27bb85e34c9a7365c2955cbeac24f16c7820537de70efda17b58c31d961c82a2b797d7f27262c096abf2ec20342a7fe
+  metadata.gz: d77bfb4c20a74d1551f0946cd600e01c26d5cdae9bcc8ba23788f6503edc78fd4871534a0a74e186b6e8cec29a8e0fcb764ba9c1ad6b6607330da47c80b8e203
+  data.tar.gz: a46c65fb6da65c8735dc35fc37f7965081ce4070e0f1fb68044fdce1530f2379893255e7eb50c61c5745e9a4632fe0766663649159a4303aa8cb47534f2b4613

data/README.md

@@ -1,5 +1,6 @@
 # SurroGate
 
+[![Gem Version](https://badge.fury.io/rb/surro-gate.svg)](https://badge.fury.io/rb/surro-gate)
 [![Build Status](https://travis-ci.org/skateman/surro-gate.svg?branch=master)](https://travis-ci.org/skateman/surro-gate)
 [![Dependency Status](https://gemnasium.com/skateman/surro-gate.svg)](https://gemnasium.com/skateman/surro-gate)
 [![Inline docs](http://inch-ci.org/github/skateman/surro-gate.svg?branch=master)](http://inch-ci.org/github/skateman/surro-gate)

data/codecov.yml

@@ -0,0 +1 @@
+comment: off

data/lib/surro-gate/proxy.rb

@@ -1,4 +1,5 @@
 require 'nio'
+require 'logger'
 
 module SurroGate
   # This class is responsible for connecting TCP socket pairs and proxying between them.
@@ -10,9 +11,11 @@ module SurroGate
   #
   # The proxy was designed to be highly reusable and it can handle multiple socket pairs.
   class Proxy
-    def initialize
+    def initialize(logger)
       @mutex = Mutex.new
       @selector = NIO::Selector.new
+      @log = logger || Logger.new(STDOUT)
+      @log.level = Logger::WARN
     end
 
     # Registers a pair of socket for proxying.
@@ -22,12 +25,15 @@ module SurroGate
     # @raise [ProxyError] when at least one of the pushed sockets is already registered
     # @param left [TCPSocket]
     # @param right [TCPSocket]
+    # @yield The block responsible for additional cleanup
     # @return the registered socket pair as an array
-    def push(left, right)
+    def push(left, right, &block)
       raise ProxyError, 'Socket already handled by the proxy' if includes?(left, right)
 
+      @log.info("Connecting #{left} <-> #{right}")
+
       @mutex.synchronize do
-        proxy(left, right)
+        proxy(left, right, block)
       end
 
       [left, right]
@@ -45,7 +51,7 @@ module SurroGate
 
     private
 
-    def proxy(left, right)
+    def proxy(left, right, block = nil)
       # Pass boths sockets to the Nio4r selector
       monitors = [left, right].map { |socket| @selector.register(socket, :rw) }
 
@@ -56,9 +62,9 @@ module SurroGate
         # Set up a proc for future transmissions
         src.value = proc do
           # Clean up the connection if one of the endpoints gets closed
-          cleanup(src.io, dst.io) if src.io.closed? || dst.io.closed?
+          cleanup(src.io, dst.io, &block) if src.io.closed? || dst.io.closed?
           # Do the transmission and return with the bytes transferred
-          transmit(src.io, dst.io) if src.readable? && dst.writable?
+          transmit(src.io, dst.io, block) if src.readable? && dst.writable?
         end
       end
 
@@ -66,10 +72,11 @@ module SurroGate
       thread_start unless @selector.empty?
     end
 
-    def transmit(src, dst)
+    def transmit(src, dst, block)
       dst.write_nonblock(src.read_nonblock(4096))
     rescue # Clean up both sockets if something bad happens
-      cleanup(src, dst)
+      @log.warn("Transmission failure between #{src} <-> #{dst}")
+      cleanup(src, dst, &block)
     end
 
     def cleanup(*sockets)
@@ -79,11 +86,16 @@ module SurroGate
         socket.close unless socket.closed?
       end
 
+      @log.info("Disconnecting #{sockets.join(' <-> ')}")
+
+      yield if block_given?
+
       # Make sure that the internal thread is stopped if no sockets remain
       thread_stop if @selector.empty?
     end
 
     def thread_start
+      @log.debug('Starting the internal thread')
       @thread ||= Thread.new do
         loop do
           reactor
@@ -93,6 +105,7 @@ module SurroGate
 
     def thread_stop
       return if @thread.nil?
+      @log.debug('Stopping the internal thread')
       thread = @thread
       @thread = nil
       thread.kill

data/lib/surro-gate/version.rb

@@ -1,3 +1,3 @@
 module SurroGate
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/surro-gate.rb

@@ -7,8 +7,8 @@ module SurroGate
   class << self
     # Initializes a new Proxy instance
     # @return [Proxy]
-    def new
-      Proxy.new
+    def new(logger = nil)
+      Proxy.new(logger)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surro-gate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dávid Halász
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-24 00:00:00.000000000 Z
+date: 2017-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -127,6 +127,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- codecov.yml
 - lib/surro-gate.rb
 - lib/surro-gate/proxy.rb
 - lib/surro-gate/proxy_error.rb
@@ -152,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A general purrpose TCP-to-TCP proxy written in Ruby