experella-proxy 0.0.10 → 0.0.11

data/bin/experella-proxy

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 if ENV["COVERAGE"]
-  #simplecov support for integration specs
+  # simplecov support for integration specs
   require 'simplecov'
   SimpleCov.start do
     command_name ENV["TESTNAME"] || "integration-test"
@@ -17,14 +17,14 @@ ARGV << '--help' if ARGV.empty?
 if ARGV[0] == "init"
   if ARGV[1] && File.directory?(File.expand_path(ARGV[1]))
     source_dir = File.expand_path(File.join(File.dirname(__FILE__), "/../config/default/"))
-      dest_dir = File.join(File.expand_path(ARGV[1]), "proxy")
-      FileUtils.copy_entry source_dir, dest_dir
-      puts "Initialized template config to #{dest_dir}"
+    dest_dir = File.join(File.expand_path(ARGV[1]), "proxy")
+    FileUtils.copy_entry source_dir, dest_dir
+    puts "Initialized template config to #{dest_dir}"
     else
       puts "ERROR: #{File.expand_path(ARGV[1])} is not a directory"
       puts "Please provide an existing directory to initialize to as second argument"
   end
-elsif ["start", "stop", "restart", "reload", "run", "zap", "status"].include? ARGV[0]
+elsif %w(start stop restart reload run zap status).include? ARGV[0]
   require 'daemons'
   Daemons.run(File.join(lib, 'experella-proxy.rb'))
 else

data/config/default/config.rb

@@ -1,7 +1,7 @@
-#Backend Server
-base_backend_port=(ENV["BASE_PORT"] || 4000).to_i
-backend1_port=base_backend_port+1
-backend2_port=base_backend_port+2
+# Backend Server
+base_backend_port = (ENV["BASE_PORT"] || 4000).to_i
+backend1_port = base_backend_port + 1
+backend2_port = base_backend_port + 2
 
 # add servers in schema, :name, :host, :port, :concurrency,
 # :host and :port are required, everything else is optional though name needs to be unique!
@@ -12,21 +12,21 @@ backend2_port=base_backend_port+2
 # always ignore the settings of any other backend server.
 # use ^((?!pattern).)*$ to negate matching
 
-#template backend servers
+# template backend servers
 
 backend(:name => "srv1", :host => "localhost", :port => backend1_port, :concurrency => "1000",
-        :accepts => {"request_url" => "^((?!/(srv2)($|/)).)*$"}
+        :accepts => { "request_url" => "^((?!/(srv2)($|/)).)*$" }
 )
 
 backend(:name => "srv2", :host_port => "localhost:#{backend2_port}", :concurrency => "1",
-        :accepts => {"request_url" => "/(srv2)($|/)"},
-        :mangle => {"Host" => lambda { |host|
+        :accepts => { "request_url" => "/(srv2)($|/)" },
+        :mangle => { "Host" => lambda do |host|
           if host.match(/127.0.0/)
             'localhost'
           else
             host
           end
-        }
+        end
         }
 )
 
@@ -48,12 +48,11 @@ logger.level = Logger::WARN
 # additionally you can activate ssl with provided private_key and cert_chain files
 set_proxy(:host => "localhost", :port => base_backend_port)
 set_proxy(:host => "localhost", :port => base_backend_port + 443,
-          :options => {:tls => true,
-                       :private_key_file => 'ssl/private/experella-proxy.key',
-                       :cert_chain_file => 'ssl/certs/experella-proxy.pem'}
+          :options => { :tls              => true,
+                        :private_key_file => 'ssl/private/experella-proxy.key',
+                        :cert_chain_file  => 'ssl/certs/experella-proxy.pem' }
 )
 
-
 # set the timeout in seconds. Will unbind a keep-alive connection
 # if no send/receive event occured in specified seconds
 set_timeout(30.0)
@@ -62,11 +61,11 @@ set_timeout(30.0)
 set_error_pages(404, "404.html")
 set_error_pages(503, "503.html")
 
-#you can log things as you want:
-#set_on_event(lambda do |name,detail| 
+# you can log things as you want:
+# set_on_event(lambda do |name,detail|
 # if detail.delete(:error)
 #   Experella.config.logger.error([name,detail.inspect])
 # else
 #   Experella.config.logger.debug([name,detail.inspect])
 # end
-#end)
+# end)

data/dev/experella-proxy

@@ -5,10 +5,10 @@ require 'rubygems'
 require 'bundler'
 Bundler.setup
 
-#NOTE: This is exactly the same as /bin/experella-proxy from here
+# NOTE: This is exactly the same as /bin/experella-proxy from here
 
 if ENV["COVERAGE"]
-  #simplecov support for integration specs
+  # simplecov support for integration specs
   require 'simplecov'
   SimpleCov.start do
     command_name ENV["TESTNAME"] || "integration-test"
@@ -31,7 +31,7 @@ if ARGV[0] == "init"
     puts "ERROR: #{File.expand_path(ARGV[1])} is not a directory"
     puts "Please provide an existing directory to initialize to as second argument"
   end
-elsif ["start", "stop", "restart", "reload", "run", "zap", "status"].include? ARGV[0]
+elsif %w(start stop restart reload run zap status).include? ARGV[0]
   require 'daemons'
   Daemons.run(File.join(lib, 'experella-proxy.rb'))
 else
@@ -67,4 +67,3 @@ else
   puts "  -h, --help    Show this message"
   puts "  --version     Show daemons version"
 end
-

data/experella-proxy.gemspec

@@ -28,13 +28,13 @@ Gem::Specification.new do |spec|
   # documentation tool
   spec.add_development_dependency "yard", "~> 0.8.7.3"
   spec.add_development_dependency "redcarpet", "~> 2.3.0"
-  #code coverage
+  # code coverage
   spec.add_development_dependency "simplecov", "~> 0.7.1"
 
   spec.files         = Dir["bin/*"] + Dir["dev/*"] + Dir["lib/**/*"] + Dir["config/default/**/*"]
   spec.files        += Dir["spec/**/*"] + Dir["test/sinatra/*"]
   spec.files        += [".gitignore", "Gemfile", "experella-proxy.gemspec", "README.md", "TODO.txt", "Rakefile"]
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^bin/}){ |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec)/})
   spec.extra_rdoc_files = ['README.md']
   spec.require_paths = ["lib"]

data/lib/experella-proxy/backend.rb

@@ -3,7 +3,6 @@ module ExperellaProxy
   #
   # This class will never be directly initiated by user code, but initializing gets triggered in client {Connection}
   class Backend < EventMachine::Connection
-
     include ExperellaProxy::Globals
 
     # @!visibility private
@@ -36,23 +35,22 @@ module ExperellaProxy
     # @param data [String] data to be send to the connected backend server
     def send(data)
       event(:backend_send_data, :data => data)
-      @connected.callback { send_data data }
+      @connected.callback{ send_data data }
     end
 
     # Notify upstream plexer that the backend server is done processing the request
     #
     def unbind
-       event(:backend_unbind, :name => @name)
+      event(:backend_unbind, :name => @name)
       @plexer.unbind_backend(@name)
     end
 
-    private
+  private
 
     # @private constructor, gets called by EventMachine::Connection's overwritten new method
     #
     def initialize
       @connected = EM::DefaultDeferrable.new
     end
-
   end
 end

data/lib/experella-proxy/backend_server.rb

@@ -1,12 +1,10 @@
 module ExperellaProxy
-
   # BackendServer objects contain information on available BackendServers
   #
   # Accepts Requests based on Request header information and it's message_matcher
   #
   # See {#initialize}
   class BackendServer
-
     attr_accessor :host, :port, :concurrency, :workload, :name
     attr_reader :message_matcher, :mangle
 
@@ -42,9 +40,9 @@ module ExperellaProxy
     # @option options [Hash|Proc] :accepts  message_pattern that will be converted to a message_matcher or an arbitrary message_matcher as proc
     #   Empty Hash is default
     # @option options [Hash] :mangle Hash which can modify request headers. Keys get symbolized. nil is default
-    def initialize(host, port, options = {})
-      @host = host #host URL as string
-      @port = port #port as string
+    def initialize(host, port, options={})
+      @host = host # host URL as string
+      @port = port # port as string
       @name = options[:name] || "#{host}:#{port}"
       if options[:concurrency].nil?
         @concurrency = 1
@@ -55,10 +53,10 @@ module ExperellaProxy
 
       make_message_matcher(options[:accepts])
 
-      #mangle can be nil
+      # mangle can be nil
       @mangle = options[:mangle]
-                   #convert keys to symbols to match request header keys
-      @mangle = @mangle.inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo } unless @mangle.nil?
+                   # convert keys to symbols to match request header keys
+      @mangle = @mangle.reduce({}){ |memo, (k, v)| memo[k.to_sym] = v; memo } unless @mangle.nil?
     end
 
     # compares Backend servers message_matcher to request object
@@ -66,8 +64,8 @@ module ExperellaProxy
     # @param request [Request] a request object
     # @return [Boolean] true if BackendServer accepts the Request, false otherwise
     def accept?(request)
-      res=@message_matcher.call(request)
-      #puts "#{name} #{request.header['request_url']} #{res}"
+      res = @message_matcher.call(request)
+      # puts "#{name} #{request.header['request_url']} #{res}"
       res
     end
 
@@ -75,24 +73,24 @@ module ExperellaProxy
     #
     # @param obj [Hash|Proc] hash containing a message_pattern that will be converted to a message_matcher proc or an arbitrary own message_matcher
     def make_message_matcher(obj)
-      @message_matcher =if obj.respond_to?(:call)
-        obj
+      @message_matcher = if obj.respond_to?(:call)
+                           obj
       else
-        #precompile message pattern keys to symbols and values to regexp objects
-        keys = (obj||{}).inject({}) { |memo, (k, v)| memo[k.to_sym] = Regexp.new(v); memo }
-        lambda do |request| #TODO: ugly!
-          ret=true
+        # precompile message pattern keys to symbols and values to regexp objects
+        keys = (obj || {}).reduce({}){ |memo, (k, v)| memo[k.to_sym] = Regexp.new(v); memo }
+        lambda do |request| # TODO: ugly!
+          ret = true
           keys.each do |key, pattern|
-            #use uri for :port :path and :query keys
+            # use uri for :port :path and :query keys
             if key == :port || key == :path || key == :query
-              ret=false unless request.uri[key] && request.uri[key].match(pattern)
-            else #use headers
-              ret=false unless request.header[key] && request.header[key].match(pattern)
+              ret = false unless request.uri[key] && request.uri[key].match(pattern)
+            else # use headers
+              ret = false unless request.header[key] && request.header[key].match(pattern)
             end
-            break unless ret #stop as soon as possible
+            break unless ret # stop as soon as possible
           end
           ret
-        end #lambda
+        end # lambda
       end
     end
   end

data/lib/experella-proxy/configuration.rb

@@ -1,5 +1,4 @@
 module ExperellaProxy
-
   # static getter for the config variable
   #
   # @return [Configuration] config
@@ -12,7 +11,7 @@ module ExperellaProxy
   # @param config [Configuration] a config object
   # @return [Configuration] config
   def self.config=(config)
-    @config=config
+    @config = config
   end
   # The Configuration loader
   #
@@ -38,12 +37,10 @@ module ExperellaProxy
   #  Currently 404 and 503 error codes are supported
   #
   class Configuration
-
     # Error raised if the Config couldn't be load successfully
     #
     # Currently only raised if config filepath is invalid
     class NoConfigError < StandardError
-
     end
 
     attr_reader :logger, :proxy, :timeout, :backends, :error_pages, :on_event
@@ -55,18 +52,18 @@ module ExperellaProxy
     # @param [Hash] options
     # @option options [String] :configfile the config filepath
     def initialize(options={})
-      @backends=[]
-      @proxy=[]
-      @error_pages = {404 => "", 503 => ""}
-      @on_event=lambda { |name, data|}
-      default_options={:timeout => 15.0, :logger => Logger.new($stdout)}
-      options=options.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
-      options=default_options.merge(options)
-      options.each do |k,v|
-        self.instance_variable_set("@#{k}",v)
+      @backends = []
+      @proxy = []
+      @error_pages = { 404 => "", 503 => "" }
+      @on_event = lambda{ |name, data| }
+      default_options = { :timeout => 15.0, :logger => Logger.new($stdout) }
+      options = options.reduce({}){ |memo, (k, v)| memo[k.to_sym] = v; memo }
+      options = default_options.merge(options)
+      options.each do |k, v|
+        instance_variable_set("@#{k}", v)
       end
       read_config_file(@configfile) if @configfile
-      ExperellaProxy.config=self
+      ExperellaProxy.config = self
     end
 
     # Return filenames fullpath relative to configfile directory
@@ -82,16 +79,16 @@ module ExperellaProxy
     # @param configfile [String] the config filepath
     # @return [Boolean] true on success, false if file can't be found
     def read_config_file(configfile)
-      if !File.exists?(configfile)
+      unless File.exist?(configfile)
         puts "error reading #{configfile}"
         raise NoConfigError.new("unable to read config file #{configfile}")
       end
-      content=File.read(configfile)
+      content = File.read(configfile)
       instance_eval(content)
       true
     end
 
-    #DSL:
+    # DSL:
 
     # Adds a {BackendServer} specified in the config file to {#backends}
     # It allows some syntactic sugar to pass :host_port as an abbrev of host and port keys separated by ':'.
@@ -100,9 +97,9 @@ module ExperellaProxy
     # @param backend_options [Hash] backends option hash
 
     def backend(backend_options)
-      host_port=backend_options.delete(:host_port)
+      host_port = backend_options.delete(:host_port)
       if host_port
-        host,port = host_port.split(":")
+        host, port = host_port.split(":")
         backend_options[:host] = host
         backend_options[:port] = port
       end
@@ -110,13 +107,13 @@ module ExperellaProxy
     end
 
     def set_on_event(lambda)
-      @on_event=lambda
+      @on_event = lambda
     end
     # Sets the {Connection} timeout specified in the config file
     #
     # @param to [Float] timeout as float
     def set_timeout(to)
-      @timeout=to
+      @timeout = to
     end
 
     # Sets the global Logger object specified in the config file
@@ -125,7 +122,7 @@ module ExperellaProxy
     #
     # @param logger [Logger] the logger object
     def set_logger(logger)
-      @logger=logger
+      @logger = logger
     end
 
     # Adds a Proxy specified in the config file to {#proxy}
@@ -153,6 +150,5 @@ module ExperellaProxy
     def set_error_pages(key, page_path)
       @error_pages[key] = File.read(join_config_path(page_path))
     end
-
   end
 end

data/lib/experella-proxy/connection.rb

@@ -1,7 +1,6 @@
 require 'uri'
 
 module ExperellaProxy
-
   # The proxies TCP Connection to the client
   #
   # Responsible for parsing and buffering the clients http requests,
@@ -105,11 +104,11 @@ module ExperellaProxy
     def connect_backendserver(backend)
       @backend = backend
       connection_manager.free_connection(self)
-      #mangle http headers
+      # mangle http headers
       mangle
       # reconstruct the request header
       get_request.reconstruct_header
-      #special web support for unknown hosts
+      # special web support for unknown hosts
       if @backend.name.eql?("web")
         xport = get_request.header[:Host].match(/:[0-9]+/)
         if xport.nil? || xport.to_s.empty?
@@ -197,7 +196,7 @@ module ExperellaProxy
     # @param name [String] name of the Server used for logging
     # @param opts [Hash] Hash containing connection parameters
     def server(name, opts)
-      srv = EventMachine::bind_connect(opts[:bind_host], opts[:bind_port], opts[:host], opts[:port], Backend) do |c|
+      srv = EventMachine.bind_connect(opts[:bind_host], opts[:bind_port], opts[:host], opts[:port], Backend) do |c|
         c.name = name
         c.plexer = self
       end
@@ -246,7 +245,6 @@ module ExperellaProxy
       end
     end
 
-
     # Called by EventMachine when the SSL/TLS handshake has been completed, as a result of calling start_tls to
     # initiate SSL/TLS on the connection.
     #
@@ -275,7 +273,7 @@ module ExperellaProxy
 
       @server = nil
 
-      #if backend responded or client unbound connection (timeout probably triggers this too)
+      # if backend responded or client unbound connection (timeout probably triggers this too)
       if @got_response || @unbound
         event(:connection_unbind_backend_request_done,
               :msec => msec,
@@ -286,21 +284,21 @@ module ExperellaProxy
           close
           event(:connection_unbind_backend_close, :msec => msec, :signature => @signature)
         end
-        @requests.shift #pop first element,request is done
-        @got_response = false #reset response flag
+        @requests.shift # pop first element,request is done
+        @got_response = false # reset response flag
 
-        #free backend server and connect to next conn if matching conn exists
+        # free backend server and connect to next conn if matching conn exists
         unless @backend.nil?
           connect_next
         end
 
-        #check if queued requests find a matching backend
+        # check if queued requests find a matching backend
         unless @requests.empty? || @unbound
-          #try to dispatch first request to backend
+          # try to dispatch first request to backend
           dispatch_request
         end
       else
-        #handle no backend response here
+        # handle no backend response here
         event(:connection_unbind_backend_error, :msec => msec, :error => true, :error_code => 503)
         error_page = "HTTP/1.1 503 Service unavailable\r\nContent-Length: #{config.error_pages[503].length}\r\nContent-Type: text/html;charset=utf-8\r\nConnection: close\r\n\r\n"
         unless get_request.header[:http_method].eql? "HEAD"
@@ -326,11 +324,11 @@ module ExperellaProxy
       @on_unbind.call if @on_unbind
 
       event(:connection_unbind_client, :msec => msec, :signature => @signature)
-      #lazy evaluated. if first is true, second would cause a nil-pointer!
-      unless @requests.empty? || get_request.flushed? #what does this mean?
-        #log.debug [msec, @requests.inspect]
+      # lazy evaluated. if first is true, second would cause a nil-pointer!
+      unless @requests.empty? || get_request.flushed? # what does this mean?
+        # log.debug [msec, @requests.inspect]
       end
-      #delete conn from queue if still queued
+      # delete conn from queue if still queued
       connection_manager.free_connection(self)
 
       # reconnect backend to new connection if this has not happened already
@@ -343,8 +341,7 @@ module ExperellaProxy
       end
     end
 
-
-    private
+  private
 
     # @private constructor, gets called by EventMachine::Connection's overwritten new method
     # Initializes http parser and timeout_timer
@@ -354,7 +351,7 @@ module ExperellaProxy
       @options = options
       @backend = nil
       @server = nil
-      @requests = [] #contains request objects
+      @requests = [] # contains request objects
       @unbound = false
       @got_response = false
       @request_parser = Http::Parser.new
@@ -370,7 +367,7 @@ module ExperellaProxy
     # did this for testability. 27.11.2013
     #
     def connect_next
-      #free backend server and connect to next conn if matching conn exists
+      # free backend server and connect to next conn if matching conn exists
       next_conn = connection_manager.free_backend(@backend)
       unless next_conn.nil?
         next_conn.connect_backendserver(@backend)
@@ -407,14 +404,13 @@ module ExperellaProxy
 
     # initializes http parser callbacks and blocks
     def init_http_parser
-
       @request_parser.on_message_begin = proc do
         @requests.push(Request.new(self))
         # this log also triggers if client sends new keep-alive request before backend was unbound
-        event(:connection_http_parser_start, :msec => msec, :pipelined => (@requests.length>1))
+        event(:connection_http_parser_start, :msec => msec, :pipelined => (@requests.length > 1))
       end
 
-      #called when request headers are completely parsed (first \r\n\r\n triggers this)
+      # called when request headers are completely parsed (first \r\n\r\n triggers this)
       @request_parser.on_headers_complete = proc do |h|
         event(:connection_http_parser_headers_complete_start, :msec => msec, :signature => @signature, :request_path => @request_parser.request_url, :host => h["Host"])
         request = @requests.last
@@ -425,13 +421,13 @@ module ExperellaProxy
         else
           request.keep_alive = false if h["Connection"].to_s.downcase.include? "close"
         end
-        request.update_header({:Connection => "close"}) #update Connection header to close for backends
+        request.update_header(:Connection => "close") # update Connection header to close for backends
 
         # if there is a transfer-encoding, stream the message as Transfer-Encoding: chunked to backends
         unless h["Transfer-Encoding"].nil?
           h.delete("Content-Length")
           request.chunked = true
-          request.update_header({:"Transfer-Encoding" => "chunked"})
+          request.update_header(:"Transfer-Encoding" => "chunked")
         end
 
         # remove all hop-by-hop header fields
@@ -448,19 +444,18 @@ module ExperellaProxy
           h.delete(s)
         end
 
-
         via = h.delete("Via")
         if via.nil?
           via = "1.1 experella"
         else
           via << "1.1 experella"
         end
-        request.update_header({:Via => via})
+        request.update_header(:Via => via)
 
         request.update_header(h)
-        request.update_header({:http_version => @request_parser.http_version})
-        request.update_header({:http_method => @request_parser.http_method}) # for requests
-        request.update_header({:request_url => @request_parser.request_url})
+        request.update_header(:http_version => @request_parser.http_version)
+        request.update_header(:http_method => @request_parser.http_method) # for requests
+        request.update_header(:request_url => @request_parser.request_url)
         if @request_parser.request_url.include? "http://"
           u = URI.parse(@request_parser.request_url)
           request.update_header(:Host => u.host)
@@ -471,7 +466,6 @@ module ExperellaProxy
 
         request.add_uri(:port => u.port, :path => u.path, :query => u.query)
 
-
         # try to connect request to backend
         # but only try to connect if this (.last) equals (.first), true at length == 1
         # according to http-protocol requests must always be handled in order.
@@ -502,7 +496,6 @@ module ExperellaProxy
           request << "0\r\n\r\n"
         end
       end
-
     end
 
     # Mangles http headers based on backend specific mangle configuration
@@ -511,9 +504,9 @@ module ExperellaProxy
       unless @backend.mangle.nil?
         @backend.mangle.each do |k, v|
           if v.respond_to?(:call)
-            get_request.update_header({k => v.call(get_request.header[k])})
+            get_request.update_header(k => v.call(get_request.header[k]))
           else
-            get_request.update_header({k => v})
+            get_request.update_header(k => v)
           end
         end
       end
@@ -527,7 +520,7 @@ module ExperellaProxy
     # If the backend server is not yet connected, data is already buffered to be sent when the connection gets established
     #
     def relay_to_server
-      if @backend && !@requests.empty? && !get_request.flushed? && !@server.nil?
+      if @backend && !@requests.empty? && !get_request.flushed? && @server
         # save some memory here if logger isn't set on debug
         data = get_request.flush
         @server.send_data data
@@ -539,7 +532,7 @@ module ExperellaProxy
       end
     end
 
-    #returns milliseconds since connection startup as string
+    # returns milliseconds since connection startup as string
     def msec
       (((Time.now.tv_sec - @start.tv_sec) * 1000) + ((Time.now.tv_usec - @start.tv_usec) / 1000.0)).to_s + "ms: "
     end
@@ -556,6 +549,5 @@ module ExperellaProxy
         end
       end
     end
-
   end
 end