proxo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b0790fc6dcd6f7d999b10bae2403f876d4d4a0a89cce3c14306b10f621ec370
+  data.tar.gz: b71aaad1fc3617318a43576679067875859f03e63ccee11f87554ee37e8fd4bd
+SHA512:
+  metadata.gz: 93ccc36f23c2b79abc9e9f88ea4f6960e7a2da0cf0a158044b0bae0d00363241bc836232b0bc389394baa2389f21878afba95490bdea163513cfdcc44078ce5d
+  data.tar.gz: 30dbc8c9aa697e4ee2cb36005390046c30a928882a7cd322602086b94bfcdb5eadbffd6e7f84e42b94ea5fc57e50c995b8b0609319d2e37d7438ef4a1a24a252

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.7
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,70 @@
+# generic stuff
+.env
+*.gem
+*.rbc
+log/*.log
+/.config
+/InstalledFiles
+/pkg/
+/tmp/
+
+# testy stuff
+.rspec
+.rspec_status
+*.orig
+/coverage/
+/coverage/
+/db/*.sqlite3
+/db/*.sqlite3-[0-9]*
+/db/*.sqlite3-journal
+/public/system
+/spec/examples.txt
+/spec/reports/
+/spec/tmp
+/test/tmp/
+/test/version_tmp/
+capybara-*.html
+pickle-email-*.html
+rerun.txt
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/node_modules/
+test/dummy/storage/
+test/dummy/tmp/
+test/dummy/yarn-error.log
+
+# debuggy stuff
+.byebug_history
+
+## doccy stuff
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## bundly stuff
+/.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"
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# rvmmy stuff
+.rvmrc
+
+# editory stuff
+.idea
+.vscode
+*.rdb
+
+# systemy stuff
+*.swm
+*.swn
+*.swo
+*.swp
+*.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-07-29
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in proxo.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Keegan Leitz
+
+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,105 @@
+# Proxo
+
+Proxy one port to another port, and intercept/transform/log inbound and outbound TCP messages.
+
+## Installation
+
+### In your application
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'proxo'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+### Globally (to your system)
+
+Or install it globally:
+
+```sh
+gem install proxo
+```
+
+## Usage
+
+### On the command line
+
+#### Option flags
+
+```
+> proxo --help
+Usage: proxo [options]
+    -h, --help                       Show this help message
+    -v, --verbose                    Log all data received and republished, as well as lifecycle events
+    -i, --input-host INPUT_HOST      Host to listen to (default: 127.0.0.1)
+    -p, --input-port INPUT_PORT      Port to listen on (required)
+    -o, --output-host OUTPUT_HOST    Host to republish to (default: 127.0.0.1)
+    -q, --output-port OUTPUT_PORT    Port to republish to (will NOT republish if no output port is given)
+    -l, --log LOG_FILE               File to log to (default: logs to STDOUT)
+```
+
+#### Common examples
+
+Listen to all messages and activity sent to port 5000:
+
+```bash
+proxo --verbose --input-port 5000
+```
+
+Proxy messages from port 5000 to 8080, and log the contents of all messages and activity:
+
+```bash
+proxo --verbose --input-port 5000 --output-port 8080
+```
+
+### In an application
+
+```rb
+require "proxo"
+require "json"
+require "logger"
+
+logger = Logger.new("log/log_file.log")
+logger.level = Logger::INFO
+
+proxy = Proxo::Proxomaton.new(
+  input_port: 5000,
+  output_port: 8080,
+  verbose: true,
+  logger: logger
+)
+
+proxy.on_the_way_there do |data|
+  puts "I'm sending this data: #{data}."
+  puts "I'm also throttling this request."
+  sleep 0.5
+
+  puts "I'm also remembering to return data to send to the output port."
+  puts "If I didn't return any data, the output port wouldn't receive any."
+  data
+end
+
+proxy.on_the_way_back do |data|
+  puts "I'm adding an unexpected field to the data coming back from the"
+  puts "application running on the output port."
+  payload = JSON.parse(data)
+  payload["foobar"] = "whoa"
+  payload.to_json
+end
+
+proxy.start!
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kjleitz/proxo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "proxo"
+
+# 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(__FILE__)

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/exe/proxo

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require "proxo"
+require "optparse"
+
+options = {}
+
+arguments_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: proxo [options]"
+
+  opts.on("-h", "--help", "Show this help message") do
+    puts opts
+    exit
+  end
+
+  opts.on("-v", "--verbose", TrueClass,
+          "Log all data received and republished, as well as lifecycle events") do |verbose|
+    options[:verbose] = verbose
+  end
+
+  opts.on("-iINPUT_HOST", "--input-host INPUT_HOST", "Host to listen to (default: 127.0.0.1)") do |input_host|
+    options[:input_host] = input_host
+  end
+
+  opts.on(:REQUIRED, "-pINPUT_PORT", "--input-port INPUT_PORT", Integer, "Port to listen on (required)") do |input_port|
+    options[:input_port] = input_port
+  end
+
+  opts.on("-oOUTPUT_HOST", "--output-host OUTPUT_HOST", "Host to republish to (default: 127.0.0.1)") do |output_host|
+    options[:output_host] = output_host
+  end
+
+  opts.on("-qOUTPUT_PORT", "--output-port OUTPUT_PORT", Integer,
+          "Port to republish to (will NOT republish if no output port is given)") do |output_port|
+    options[:output_port] = output_port
+  end
+
+  opts.on("-lLOG_FILE", "--log LOG_FILE", "File to log to (default: logs to STDOUT)") do |log_file|
+    logger = Logger.new(log_file)
+    logger.level = Logger::INFO
+    options[:logger] = logger
+  end
+end
+
+arguments_parser.parse!
+
+raise OptionParser::MissingArgument, "--input-port (see --help for details)" if options[:input_port].nil?
+
+proxomaton = Proxo::Proxomaton.new(**options)
+
+proxomaton.start!

data/lib/proxo.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+require "socket"
+require "logger"
+
+require_relative "proxo/version"
+
+module Proxo
+  class Error < StandardError; end
+  # Your code goes here...
+
+  class Proxomaton
+    VALID_LOG_LEVELS = %i[unknown fatal error warn info].freeze
+
+    attr_reader(*%i[
+                  input_host
+                  input_port
+                  output_host
+                  output_port
+                  logger
+                  outbound_middleman
+                  inbound_middleman
+                ])
+
+    def initialize(input_port:, input_host: "127.0.0.1", output_host: nil, output_port: nil, verbose: false, logger: nil)
+      # The host to listen to
+      @input_host = input_host
+
+      # The port to listen on
+      @input_port = input_port.to_i
+
+      # The host to publish to
+      @output_host = output_host || input_host
+
+      # The port to publish to (`nil` if you don't want to republish)
+      @output_port = output_port.to_i unless output_port.nil?
+
+      # Print all received data before running middleman, and some other info
+      @verbose = !!verbose
+
+      # Logger for printing (defaults to STDOUT)
+      @logger = logger || Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+
+      # If no middlemen are given, it'll just pass the data through unmodified
+      @outbound_middleman = proc(&:itself)
+      @inbound_middleman = proc(&:itself)
+    end
+
+    # The given block will be called when data is received from the "input"
+    # socket. The block takes one argument: the data received.
+    def on_the_way_there(&block)
+      @outbound_middleman = block
+    end
+
+    # The given block will be called when data is received back from the
+    # "output" socket. The block takes one argument: the data received.
+    def on_the_way_back(&block)
+      @inbound_middleman = block
+    end
+
+    def start!
+      Thread.abort_on_exception = true
+
+      input_server = TCPServer.new(input_host, input_port)
+
+      loop do
+        Thread.start(input_server.accept) do |input_socket|
+          output_socket = TCPSocket.new(output_host, output_port)
+
+          loop do
+            # Waiting for sockets to be ready...
+            ready_sockets, * = IO.select([input_socket, output_socket], nil, nil)
+
+            if ready_sockets && ready_sockets.include?(input_socket)
+              # Waiting for output to be writable...
+              _, write_sockets, * = IO.select(nil, [output_socket], nil, 0)
+
+              if write_sockets && write_sockets.include?(output_socket)
+                # Receiving data from input port...
+                data = input_socket.gets
+                break if data.nil?
+
+                log("Received data from input port: #{data.chomp}")
+                new_data = outbound_middleman.call(data)
+                log("Writing transformed data to output port: #{new_data.chomp}")
+                output_socket.write(new_data)
+              end
+            end
+
+            next unless ready_sockets && ready_sockets.include?(output_socket)
+
+            # Waiting for input to be writable...
+            _, write_sockets, * = IO.select(nil, [input_socket], nil, 0)
+
+            next unless write_sockets && write_sockets.include?(input_socket)
+
+            # Receiving data from output port...
+            data = output_socket.gets
+            break if data.nil?
+
+            log("Received data from output port: #{data.chomp}")
+            new_data = inbound_middleman.call(data)
+            log("Writing transformed data to input port: #{new_data.chomp}")
+            input_socket.write(new_data)
+          end
+
+          input_socket.close
+          output_socket.close
+        end
+      end
+    end
+
+    private
+
+    def verbose?
+      @verbose
+    end
+
+    def should_republish?
+      !output_port.nil?
+    end
+
+    def log(message, level: :info)
+      return unless verbose?
+
+      log_level = level.to_s.downcase.to_sym
+
+      unless VALID_LOG_LEVELS.include?(level.to_sym)
+        raise ArgumentError,
+              "Invalid log level '#{level}'. Valid levels are #{listify(VALID_LOG_LEVELS, connect: "or")}"
+      end
+
+      logger.public_send(level, message)
+    end
+
+    def listify(raw_list, connect: "and")
+      list = raw_list.reduce([]) do |memo, item|
+        item_string = item.to_s.strip
+        item_string.empty? ? memo : [*memo, item]
+      end
+
+      return "" if list.empty?
+      return list.first if list.count == 1
+      return list.join(connect) if list.count == 2
+
+      *first_items, last_item = list
+      "#{first_items.join(",")}, #{connect} #{last_item}"
+    end
+  end
+end

data/lib/proxo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Proxo
+  VERSION = "0.1.0"
+end

data/proxo.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/proxo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "proxo"
+  spec.version       = Proxo::VERSION
+  spec.authors       = ["Keegan Leitz"]
+  spec.email         = ["kjleitz@gmail.com"]
+
+  spec.summary       = "Proxy one port to another port, and intercept/transform/log inbound and outbound TCP messages."
+  spec.description   = "Proxy one port to another port, and intercept/transform/log inbound and outbound TCP messages."
+  spec.homepage      = "https://github.com/kjleitz/proxo"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/kjleitz/proxo"
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/proxo/#{Proxo::VERSION}"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: proxo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keegan Leitz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-29 00:00:00.000000000 Z
+dependencies: []
+description: Proxy one port to another port, and intercept/transform/log inbound and
+  outbound TCP messages.
+email:
+- kjleitz@gmail.com
+executables:
+- proxo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/proxo
+- lib/proxo.rb
+- lib/proxo/version.rb
+- proxo.gemspec
+homepage: https://github.com/kjleitz/proxo
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kjleitz/proxo
+  source_code_uri: https://github.com/kjleitz/proxo
+  documentation_uri: https://www.rubydoc.info/gems/proxo/0.1.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key: 
+specification_version: 4
+summary: Proxy one port to another port, and intercept/transform/log inbound and outbound
+  TCP messages.
+test_files: []