proxymachine 1.0.0 → 1.1.0

data/History.txt

@@ -1,3 +1,12 @@
+= 1.1.0 / 2009-11-05
+  * New Features
+    * Add { :remote, :data, :reply } command [github.com/coderrr]
+  * Minor Changes
+    * Namespace connection classes under ProxyMachine instead of EM [github.com/cmelbye]
+    * Require socket [github.com/cmelbye]
+    * Up EM dep to 0.12.10
+    * Add SOCKS4 Proxy example [github.com/coderrr]
+
 = 1.0.0 / 2009-10-19
   * No changes. Production ready!
 

data/README.md

@@ -26,7 +26,9 @@ backend connections are hooked up to form a transparent proxy. This
 bidirectional proxy continues to exist until either the client or backend
 close the connection.
 
-ProxyMachine was developed for GitHub's federated architecture and is successfully used in production to proxy millions of requests every day. The performance and memory profile have both proven to be excellent.
+ProxyMachine was developed for GitHub's federated architecture and is
+successfully used in production to proxy millions of requests every day. The
+performance and memory profile have both proven to be excellent.
 
 
 Installation
@@ -86,11 +88,26 @@ Example routing config file
     end
 
 
+Example SOCKS4 Proxy in 7 Lines
+-------------------------------
+
+    proxy do |data|
+      return  if data.size < 9
+      v, c, port, o1, o2, o3, o4, user = data.unpack("CCnC4a*")
+      return { :close => "\0\x5b\0\0\0\0\0\0" }  if v != 4 or c != 1
+      return  if ! idx = user.index("\0")
+      { :remote => "#{[o1,o2,o3,o4]*'.'}:#{port}",
+        :reply => "\0\x5a\0\0\0\0\0\0",
+        :data => data[idx+9..-1] }
+    end
+
+
 Valid return values
 -------------------
 
 `{ :remote => String }` - String is the host:port of the backend server that will be proxied.  
 `{ :remote => String, :data => String }` - Same as above, but send the given data instead.  
+`{ :remote => String, :data => String, :reply => String}` - Same as above, but reply with given data back to the client
 `{ :noop => true }` - Do nothing.  
 `{ :close => true }` - Close the connection.  
 `{ :close => String }` - Close the connection after sending the String.  
@@ -120,4 +137,4 @@ your changes merged back into core is as follows:
 Copyright
 ---------
 
-Copyright (c) 2009 Tom Preston-Werner. See LICENSE for details.
+Copyright (c) 2009 Tom Preston-Werner. See LICENSE for details.

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.email = "tom@mojombo.com"
     gem.homepage = "http://github.com/mojombo/proxymachine"
     gem.authors = ["Tom Preston-Werner"]
-    gem.add_dependency('eventmachine', '>= 0.12.9')
+    gem.add_dependency('eventmachine', '>= 0.12.10')
 
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 0
-:patch: 0
 :major: 1
+:minor: 1
+:patch: 0

data/lib/proxymachine.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'eventmachine'
 require 'logger'
+require 'socket'
 
 require 'proxymachine/client_connection'
 require 'proxymachine/server_connection'
@@ -79,7 +80,7 @@ class ProxyMachine
     EM.epoll
 
     EM.run do
-      EventMachine::Protocols::ClientConnection.start(host, port)
+      ProxyMachine::ClientConnection.start(host, port)
       trap('QUIT') do
         self.graceful_shutdown('QUIT')
       end

data/lib/proxymachine/client_connection.rb

@@ -1,104 +1,105 @@
-module EventMachine
-  module Protocols
-    class ClientConnection < Connection
-      def self.start(host, port)
-        $server = EM.start_server(host, port, self)
-        LOGGER.info "Listening on #{host}:#{port}"
-        LOGGER.info "Send QUIT to quit after waiting for all connections to finish."
-        LOGGER.info "Send TERM or INT to quit after waiting for up to 10 seconds for connections to finish."
-      end
+class ProxyMachine
+  class ClientConnection < EventMachine::Connection
+    def self.start(host, port)
+      $server = EM.start_server(host, port, self)
+      LOGGER.info "Listening on #{host}:#{port}"
+      LOGGER.info "Send QUIT to quit after waiting for all connections to finish."
+      LOGGER.info "Send TERM or INT to quit after waiting for up to 10 seconds for connections to finish."
+    end
 
-      def post_init
-        LOGGER.info "Accepted #{peer}"
-        @buffer = []
-        @tries = 0
-        ProxyMachine.incr
-      end
+    def post_init
+      LOGGER.info "Accepted #{peer}"
+      @buffer = []
+      @tries = 0
+      ProxyMachine.incr
+    end
 
-      def peer
-        @peer ||=
-        begin
-          port, ip = Socket.unpack_sockaddr_in(get_peername)
-          "#{ip}:#{port}"
-        end
+    def peer
+      @peer ||=
+      begin
+        port, ip = Socket.unpack_sockaddr_in(get_peername)
+        "#{ip}:#{port}"
       end
+    end
 
-      def receive_data(data)
-        if !@server_side
-          @buffer << data
-          ensure_server_side_connection
-        end
-      rescue => e
-        close_connection
-        LOGGER.info "#{e.class} - #{e.message}"
+    def receive_data(data)
+      if !@server_side
+        @buffer << data
+        ensure_server_side_connection
       end
+    rescue => e
+      close_connection
+      LOGGER.info "#{e.class} - #{e.message}"
+    end
 
-      def ensure_server_side_connection
-        @timer.cancel if @timer
-        unless @server_side
-          commands = ProxyMachine.router.call(@buffer.join)
-          LOGGER.info "#{peer} #{commands.inspect}"
-          close_connection unless commands.instance_of?(Hash)
-          if remote = commands[:remote]
-            m, host, port = *remote.match(/^(.+):(.+)$/)
-            if try_server_connect(host, port.to_i)
-              if data = commands[:data]
-                @buffer = [data]
-              end
-              send_and_clear_buffer
+    def ensure_server_side_connection
+      @timer.cancel if @timer
+      unless @server_side
+        commands = ProxyMachine.router.call(@buffer.join)
+        LOGGER.info "#{peer} #{commands.inspect}"
+        close_connection unless commands.instance_of?(Hash)
+        if remote = commands[:remote]
+          m, host, port = *remote.match(/^(.+):(.+)$/)
+          if try_server_connect(host, port.to_i)
+            if data = commands[:data]
+              @buffer = [data]
             end
-          elsif close = commands[:close]
-            if close == true
-              close_connection
-            else
-              send_data(close)
-              close_connection_after_writing
+            if reply = commands[:reply]
+              send_data(reply)
             end
-          elsif commands[:noop]
-            # do nothing
-          else
+            send_and_clear_buffer
+          end
+        elsif close = commands[:close]
+          if close == true
             close_connection
+          else
+            send_data(close)
+            close_connection_after_writing
           end
+        elsif commands[:noop]
+          # do nothing
+        else
+          close_connection
         end
       end
+    end
 
-      def try_server_connect(host, port)
-        @server_side = ServerConnection.request(host, port, self)
-        proxy_incoming_to(@server_side, 10240)
-        LOGGER.info "Successful connection to #{host}:#{port}."
-        true
-      rescue => e
-        if @tries < 10
-          @tries += 1
-          LOGGER.info "Failed on server connect attempt #{@tries}. Trying again..."
-          @timer.cancel if @timer
-          @timer = EventMachine::Timer.new(0.1) do
-            self.ensure_server_side_connection
-          end
-        else
-          LOGGER.info "Failed after ten connection attempts."
+    def try_server_connect(host, port)
+      @server_side = ServerConnection.request(host, port, self)
+      proxy_incoming_to(@server_side, 10240)
+      LOGGER.info "Successful connection to #{host}:#{port}."
+      true
+    rescue => e
+      if @tries < 10
+        @tries += 1
+        LOGGER.info "Failed on server connect attempt #{@tries}. Trying again..."
+        @timer.cancel if @timer
+        @timer = EventMachine::Timer.new(0.1) do
+          self.ensure_server_side_connection
         end
-        false
+      else
+        LOGGER.info "Failed after ten connection attempts."
       end
+      false
+    end
 
-      def send_and_clear_buffer
-        if !@buffer.empty?
-          @buffer.each do |x|
-            @server_side.send_data(x)
-          end
-          @buffer = []
+    def send_and_clear_buffer
+      if !@buffer.empty?
+        @buffer.each do |x|
+          @server_side.send_data(x)
         end
+        @buffer = []
       end
+    end
 
-      def unbind
-        @server_side.close_connection_after_writing if @server_side
-        ProxyMachine.decr
-      end
+    def unbind
+      @server_side.close_connection_after_writing if @server_side
+      ProxyMachine.decr
+    end
 
-      # Proxy connection has been lost
-      def proxy_target_unbound
-        @server_side = nil
-      end
+    # Proxy connection has been lost
+    def proxy_target_unbound
+      @server_side = nil
     end
   end
 end

data/lib/proxymachine/server_connection.rb

@@ -1,21 +1,19 @@
-module EventMachine
-  module Protocols
-    class ServerConnection < Connection
-      def self.request(host, port, client_side)
-        EventMachine.connect(host, port, self, client_side)
-      end
+class ProxyMachine
+  class ServerConnection < EventMachine::Connection
+    def self.request(host, port, client_side)
+      EventMachine.connect(host, port, self, client_side)
+    end
 
-      def initialize(conn)
-        @client_side = conn
-      end
+    def initialize(conn)
+      @client_side = conn
+    end
 
-      def post_init
-        proxy_incoming_to(@client_side, 10240)
-      end
+    def post_init
+      proxy_incoming_to(@client_side, 10240)
+    end
 
-      def unbind
-        @client_side.close_connection_after_writing
-      end
+    def unbind
+      @client_side.close_connection_after_writing
     end
   end
 end

data/proxymachine.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{proxymachine}
-  s.version = "1.0.0"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tom Preston-Werner"]
-  s.date = %q{2009-10-19}
+  s.date = %q{2009-11-05}
   s.default_executable = %q{proxymachine}
   s.email = %q{tom@mojombo.com}
   s.executables = ["proxymachine"]
@@ -56,11 +56,11 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.9"])
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.10"])
     else
-      s.add_dependency(%q<eventmachine>, [">= 0.12.9"])
+      s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
     end
   else
-    s.add_dependency(%q<eventmachine>, [">= 0.12.9"])
+    s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
   end
 end

data/test/configs/simple.rb

@@ -13,6 +13,8 @@ proxy do |data|
     { :noop => true }
   elsif data == 'e' * 2048 + 'f'
     { :remote => "localhost:9980" }
+  elsif data == 'g'
+    { :remote => "localhost:9980", :data => 'g2', :reply => 'g3-' }
   else
     { :close => true }
   end

data/test/proxymachine_test.rb

@@ -28,6 +28,10 @@ class ProxymachineTest < Test::Unit::TestCase
     assert_proxy('localhost', 9990, 'd', 'ddd')
   end
 
+  should "handle data plus reply" do
+    assert_proxy('localhost', 9990, 'g', 'g3-9980:g2')
+  end
+
   should "handle noop" do
     sock = TCPSocket.new('localhost', 9990)
     sock.write('e' * 2048)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: proxymachine
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Tom Preston-Werner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-19 00:00:00 -07:00
+date: 2009-11-05 00:00:00 -08:00
 default_executable: proxymachine
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.12.9
+        version: 0.12.10
     version: 
 description: 
 email: tom@mojombo.com