surro-gate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23723ea57a4d00802173cfd2f9701b79a5815385
+  data.tar.gz: f9f596cea08d8bcf926823ccfc3599e0d5c618c9
+SHA512:
+  metadata.gz: 6660ec99537aa1994670ea471d8b4df099cfa376b22d5bd403dcd2652d302374824d3ef22b16ea177ee62b17a5d169a0ef9eb97c4a8d8dfe6e30a37d17f2b943
+  data.tar.gz: 9666acf2ab83171d83f997f80d784b740a499ad6458cd57c9887562c4f6cc94822b7eefd8d4302c379ea921ea282095ffe6a5ebf4b1b1f3bcebca9246da5a773

data/.codeclimate.yml

@@ -0,0 +1,25 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- spec/

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,22 @@
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Style/RedundantFreeze:
+  Enabled: false
+Style/IndentationConsistency:
+  EnforcedStyle: normal
+Metrics/LineLength:
+  Max: 140
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 20
+Style/FileName:
+  Exclude:
+    - lib/surro-gate.rb
+    - spec/surro-gate_spec.rb

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install:
+  - "echo 'gem: --no-ri --no-rdoc --no-document' > ~/.gemrc"
+  - "gem install bundler -v 1.13.0"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in surro-gate.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Dávid Halász
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dávid Halász
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# SurroGate
+
+[![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)
+[![Code Climate](https://codeclimate.com/github/skateman/surro-gate/badges/gpa.svg)](https://codeclimate.com/github/skateman/surro-gate)
+[![codecov](https://codecov.io/gh/skateman/surro-gate/branch/master/graph/badge.svg)](https://codecov.io/gh/skateman/surro-gate)
+
+SurroGate is a general purpose TCP-to-TCP proxy implemented in Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'surro-gate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install surro-gate
+
+## Usage
+
+```ruby
+require 'surro-gate'
+
+proxy = SurroGate.new
+
+# Create two TCP socket connections
+left = TCPSocket.new('localhost', 3333)
+right = TCPSocket.new('localhost', 2222)
+
+# Push the sockets to the proxy
+proxy.push(left, right)
+
+# Wait for the communication to finish
+proxy.wait
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/skateman/surro-gate.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'surro-gate'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/surro-gate.rb

@@ -0,0 +1,14 @@
+require 'surro-gate/version'
+require 'surro-gate/proxy_error'
+require 'surro-gate/proxy'
+
+# A generic purpose TCP-to-TCP proxy
+module SurroGate
+  class << self
+    # Initializes a new Proxy instance
+    # @return [Proxy]
+    def new
+      Proxy.new
+    end
+  end
+end

data/lib/surro-gate/proxy.rb

@@ -0,0 +1,110 @@
+require 'nio'
+
+module SurroGate
+  # This class is responsible for connecting TCP socket pairs and proxying between them.
+  #
+  # It uses a lazily-forked thread to handle the non blocking read and write operations.
+  # If one of the sockets get closed, the proxy automatically cleans up by deregistering
+  # and closing its pair. When the last socket pair gets cleaned up, the internal thread
+  # is killed automatically.
+  #
+  # The proxy was designed to be highly reusable and it can handle multiple socket pairs.
+  class Proxy
+    def initialize
+      @mutex = Mutex.new
+      @selector = NIO::Selector.new
+    end
+
+    # Registers a pair of socket for proxying.
+    #
+    # It also forks the internal thread if it is not running yet.
+    #
+    # @raise [ProxyError] when at least one of the pushed sockets is already registered
+    # @param left [TCPSocket]
+    # @param right [TCPSocket]
+    # @return the registered socket pair as an array
+    def push(left, right)
+      raise ProxyError, 'Socket already handled by the proxy' if includes?(left, right)
+
+      @mutex.synchronize do
+        proxy(left, right)
+      end
+
+      [left, right]
+    end
+
+    # Blocking wait until the internal thread is doing something useful.
+    def wait
+      @thread.join if alive?
+    end
+
+    # Determine if the internal thread is currently running or not.
+    def alive?
+      !@thread.nil? && @thread.alive?
+    end
+
+    private
+
+    def proxy(left, right)
+      # Pass boths sockets to the Nio4r selector
+      monitors = [left, right].map { |socket| @selector.register(socket, :rw) }
+
+      # Set up handlers for both monitors
+      monitors.each do |src|
+        # Get the destination paired with the source
+        dst = monitors.reject { |m| m == src }.first
+        # Set up a proc for future transmissions
+        src.value = proc do
+          transmit(src.io, dst.io) if src.readable? && dst.writable?
+        end
+      end
+
+      # Make sure that the internal thread is started
+      thread_start unless @selector.empty?
+    end
+
+    def transmit(src, dst)
+      dst.write_nonblock(src.read_nonblock(4096))
+    rescue # Clean up both sockets if something bad happens
+      cleanup(src, dst)
+    end
+
+    def cleanup(*sockets)
+      # Deregister and close the sockets
+      sockets.each do |socket|
+        @selector.deregister(socket) if @selector.registered?(socket)
+        socket.close unless socket.closed?
+      end
+
+      # Make sure that the internal thread is stopped if no sockets remain
+      thread_stop if @selector.empty?
+    end
+
+    def thread_start
+      @thread ||= Thread.new do
+        loop do
+          reactor
+        end
+      end
+    end
+
+    def thread_stop
+      return if @thread.nil?
+      @thread.kill
+      @thread = nil
+    end
+
+    def reactor
+      # Atomically get an array of readable/writable monitors
+      monitors = @mutex.synchronize { @selector.select(0.1) || [] }
+      # Call each transmission proc and collect the results
+      callers = monitors.map { |m| m.value.call }
+      # Sleep for a short time if there was no transmission
+      sleep(0.1) if callers.none? && monitors.any?
+    end
+
+    def includes?(*sockets)
+      sockets.map { |socket| @selector.registered?(socket) }.any?
+    end
+  end
+end

data/lib/surro-gate/proxy_error.rb

@@ -0,0 +1,5 @@
+module SurroGate
+  # This error is raised when at least one of the pushed sockets is already registered
+  class ProxyError < StandardError
+  end
+end

data/lib/surro-gate/version.rb

@@ -0,0 +1,3 @@
+module SurroGate
+  VERSION = '0.1.0'.freeze
+end

data/surro-gate.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'surro-gate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'surro-gate'
+  spec.version       = SurroGate::VERSION
+  spec.authors       = ['Dávid Halász']
+  spec.email         = ['skateman@skateman.eu']
+
+  spec.summary       = 'A general purrpose TCP-to-TCP proxy written in Ruby'
+  spec.description   = 'A general purrpose TCP-to-TCP proxy written in Ruby'
+  spec.homepage      = 'https://github.com/skateman/surro-gate'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nio4r', '~> 1.2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'codecov', '~> 0.1.0'
+  spec.add_development_dependency 'nyan-cat-formatter', '~> 0.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: surro-gate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dávid Halász
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nio4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: nyan-cat-formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: A general purrpose TCP-to-TCP proxy written in Ruby
+email:
+- skateman@skateman.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/surro-gate.rb
+- lib/surro-gate/proxy.rb
+- lib/surro-gate/proxy_error.rb
+- lib/surro-gate/version.rb
+- surro-gate.gemspec
+homepage: https://github.com/skateman/surro-gate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A general purrpose TCP-to-TCP proxy written in Ruby
+test_files: []