experella-proxy 0.0.10 → 0.0.11

data/lib/experella-proxy/connection_manager.rb

@@ -1,5 +1,4 @@
 module ExperellaProxy
-
   # static getter for the connection_manager variable
   #
   # @return [ConnectionManager] connection_manager
@@ -9,13 +8,12 @@ module ExperellaProxy
 
   # The ConnectionManager is responsible for queueing and matching frontend {Connection} and {BackendServer} objects
   class ConnectionManager
-
     # The constructor
     #
     def initialize
-      @connection_queue = [] #array queue of client connection objects
-      @backend_queue = [] #array queue of available backend servers
-      @backend_list = {} #list of all backend servers
+      @connection_queue = [] # array queue of client connection objects
+      @backend_queue = [] # array queue of available backend servers
+      @backend_list = {} # list of all backend servers
     end
 
     # Matches {Request} to queued {BackendServer}
@@ -34,16 +32,16 @@ module ExperellaProxy
     def backend_available?(request)
       @backend_queue.each do |backend|
         if backend.accept?(request)
-          #connect backend to requests connection if request matches
+          # connect backend to requests connection if request matches
           backend.workload += 1
           ret = @backend_queue.delete(backend)
-          #requeue backend if concurrency isnt maxed
+          # requeue backend if concurrency isnt maxed
           @backend_queue.push(backend) if backend.workload < backend.concurrency
           return ret
         end
       end
       if match_any_backend?(request)
-        #push requests connection on queue if no backend was connected
+        # push requests connection on queue if no backend was connected
         @connection_queue.push(request.conn)
         :queued
       else
@@ -58,14 +56,14 @@ module ExperellaProxy
     # @param backend [BackendServer] BackendServer which got free
     # @return [NilClass]
     def free_backend(backend)
-      #check if any queued connections match new available backend
+      # check if any queued connections match new available backend
       conn = match_connections(backend)
       if conn
-        #return matching connection
-        #you should try to connect the new backend to this connection
+        # return matching connection
+        # you should try to connect the new backend to this connection
         return conn
       else
-        #push free backend on queue if it wasn't used for a queued conn or is already queued (concurrency)
+        # push free backend on queue if it wasn't used for a queued conn or is already queued (concurrency)
         @backend_queue.push(backend) if @backend_list.include?(backend.name) && !@backend_queue.include?(backend)
         backend.workload -= 1
       end
@@ -78,17 +76,16 @@ module ExperellaProxy
     # @return [Connection] a queued connection that would match the BackendServer
     # @return [Boolean] true if backend was added to list
     def add_backend(backend)
-
       @backend_list[backend.name] = backend
 
-      #check if any queued connections match new available backend
+      # check if any queued connections match new available backend
       conn = match_connections(backend)
       if conn
-        #return matching connection
-        #you should try to connect the new backend to this connection
+        # return matching connection
+        # you should try to connect the new backend to this connection
         return conn
       else
-        #queue new backend
+        # queue new backend
         @backend_queue.push(backend)
       end
       true
@@ -99,7 +96,6 @@ module ExperellaProxy
     # @param backend [BackendServer] the BackendServer to be removed
     # @return [Boolean] true if a backend was removed, else returns false
     def remove_backend(backend)
-
       ret = @backend_list.delete(backend.name)
       @backend_queue.delete(backend)
 
@@ -138,7 +134,7 @@ module ExperellaProxy
       @connection_queue.size
     end
 
-    private
+  private
 
     # Matches request to all known backends
     #
@@ -162,6 +158,5 @@ module ExperellaProxy
       end
       nil
     end
-
   end
-end
+end

data/lib/experella-proxy/globals.rb

@@ -1,14 +1,12 @@
 module ExperellaProxy
-
   # defined hop by hop header fields
-  HOP_HEADERS = ["Connection", "Keep-Alive", "Proxy-Authorization", "TE", "Trailer", "Transfer-Encoding", "Upgrade"]
+  HOP_HEADERS = %w(Connection Keep-Alive Proxy-Authorization TE Trailer Transfer-Encoding Upgrade)
 
   # Provides getters for global variables
   #
   # All methods are private. The module needs to be included in every Class which needs it.
   module Globals
-
-    private
+  private
 
     # @!visibility public
 
@@ -25,8 +23,8 @@ module ExperellaProxy
     # @param [Hash] details contains details of the event
     # see ExperellaProxy::Configuration#on_event
 
-    def event(name,details={})
-      config.on_event.call(name,details)
+    def event(name, details={})
+      config.on_event.call(name, details)
     end
 
     # Get the global connection manager
@@ -40,4 +38,4 @@ module ExperellaProxy
       config.logger
     end
   end
-end
+end

data/lib/experella-proxy/http_status_codes.rb

@@ -1,45 +1,44 @@
 module ExperellaProxy
-
   # Every standard HTTP code mapped to the appropriate message.
   #
   # @author Mongrel.
   HTTP_STATUS_CODES = {
-      100 => 'Continue',
-      101 => 'Switching Protocols',
-      200 => 'OK',
-      201 => 'Created',
-      202 => 'Accepted',
-      203 => 'Non-Authoritative Information',
-      204 => 'No Content',
-      205 => 'Reset Content',
-      206 => 'Partial Content',
-      300 => 'Multiple Choices',
-      301 => 'Moved Permanently',
-      302 => 'Moved Temporarily',
-      303 => 'See Other',
-      304 => 'Not Modified',
-      305 => 'Use Proxy',
-      400 => 'Bad Request',
-      401 => 'Unauthorized',
-      402 => 'Payment Required',
-      403 => 'Forbidden',
-      404 => 'Not Found',
-      405 => 'Method Not Allowed',
-      406 => 'Not Acceptable',
-      407 => 'Proxy Authentication Required',
-      408 => 'Request Time-out',
-      409 => 'Conflict',
-      410 => 'Gone',
-      411 => 'Length Required',
-      412 => 'Precondition Failed',
-      413 => 'Request Entity Too Large',
-      414 => 'Request-URI Too Large',
-      415 => 'Unsupported Media Type',
-      500 => 'Internal Server Error',
-      501 => 'Not Implemented',
-      502 => 'Bad Gateway',
-      503 => 'Service Unavailable',
-      504 => 'Gateway Time-out',
-      505 => 'HTTP Version not supported'
+    100 => 'Continue',
+    101 => 'Switching Protocols',
+    200 => 'OK',
+    201 => 'Created',
+    202 => 'Accepted',
+    203 => 'Non-Authoritative Information',
+    204 => 'No Content',
+    205 => 'Reset Content',
+    206 => 'Partial Content',
+    300 => 'Multiple Choices',
+    301 => 'Moved Permanently',
+    302 => 'Moved Temporarily',
+    303 => 'See Other',
+    304 => 'Not Modified',
+    305 => 'Use Proxy',
+    400 => 'Bad Request',
+    401 => 'Unauthorized',
+    402 => 'Payment Required',
+    403 => 'Forbidden',
+    404 => 'Not Found',
+    405 => 'Method Not Allowed',
+    406 => 'Not Acceptable',
+    407 => 'Proxy Authentication Required',
+    408 => 'Request Time-out',
+    409 => 'Conflict',
+    410 => 'Gone',
+    411 => 'Length Required',
+    412 => 'Precondition Failed',
+    413 => 'Request Entity Too Large',
+    414 => 'Request-URI Too Large',
+    415 => 'Unsupported Media Type',
+    500 => 'Internal Server Error',
+    501 => 'Not Implemented',
+    502 => 'Bad Gateway',
+    503 => 'Service Unavailable',
+    504 => 'Gateway Time-out',
+    505 => 'HTTP Version not supported'
   }
 end

data/lib/experella-proxy/proxy.rb

@@ -11,8 +11,7 @@ module ExperellaProxy
     # @param options [Hash] option Hash passed to the {Connection}
     # @param blk [Block] Block evaluated in each new {Connection}
     def self.start(options, &blk)
-
-      #initalize backend servers from config
+      # initalize backend servers from config
       config.backends.each do |backend|
         connection_manager.add_backend(BackendServer.new(backend[:host], backend[:port], backend))
         logger.info "Initializing backend #{backend[:name]} at #{backend[:host]}:#{backend[:port]} with concurrency\
@@ -21,11 +20,11 @@ module ExperellaProxy
         logger.info "Backend mangles: #{backend[:mangle].inspect}"
       end
 
-      #start eventmachine
+      # start eventmachine
       EM.epoll
       EM.run do
-        trap("TERM") { stop }
-        trap("INT") { stop }
+        trap("TERM"){ stop }
+        trap("INT"){ stop }
 
         if config.proxy.empty?
           logger.fatal "No proxy host:port address configured. Stopping experella-proxy."
@@ -37,10 +36,10 @@ module ExperellaProxy
             unless proxy[:options].nil?
               opts = options.merge(proxy[:options])
             end
-            logger.info "Launching experella-proxy at #{proxy[:host]}:#{proxy[:port]} with #{config.timeout}s timeout..."
+            logger.info "Launching experella-proxy (#{ExperellaProxy::VERSION}) at #{proxy[:host]}:#{proxy[:port]} with #{config.timeout}s timeout..."
             logger.info "with options: #{opts.inspect}"
-            EventMachine::start_server(proxy[:host], proxy[:port],
-                                       Connection, opts) do |conn|
+            EventMachine.start_server(proxy[:host], proxy[:port],
+                                      Connection, opts) do |conn|
               conn.instance_eval(&blk)
             end
           end
@@ -53,7 +52,7 @@ module ExperellaProxy
     #
     def self.stop
       if EM.reactor_running?
-        EventMachine::stop_event_loop
+        EventMachine.stop_event_loop
       end
     end
   end

data/lib/experella-proxy/request.rb

@@ -5,7 +5,6 @@ module ExperellaProxy
   # Every Request belongs to a client {Connection}
   #
   class Request
-
     include ExperellaProxy::Globals
 
     attr_accessor :keep_alive, :chunked
@@ -18,9 +17,9 @@ module ExperellaProxy
       @conn = conn
       @header = {}
       @chunked = false # if true the parsed body will be chunked
-      @uri = {} #contains port, path and query information for faster backend selection
+      @uri = {} # contains port, path and query information for faster backend selection
       @keep_alive = true
-      @send_buffer = String.new
+      @send_buffer = ''
       @response = Response.new(self)
     end
 
@@ -64,21 +63,21 @@ module ExperellaProxy
     # First Header after Startline will always be "Host: ", after that order is determined by {#header}.each
     #
     def reconstruct_header
-      #split send_buffer into header and body part
+      # split send_buffer into header and body part
       buf = @send_buffer.split(/\r\n\r\n/, 2) unless flushed?
       @send_buffer = ""
-      #start line
+      # start line
       @send_buffer << @header[:http_method] + ' '
       @send_buffer << @header[:request_url] + ' '
       @send_buffer << "HTTP/1.1\r\n"
-      @send_buffer << "Host: " + @header[:Host] + "\r\n" #add Host first for better header readability
-      #header fields
+      @send_buffer << "Host: " + @header[:Host] + "\r\n" # add Host first for better header readability
+      # header fields
       @header.each do |key, value|
-        unless  key == :http_method || key == :request_url || key == :http_version || key == :Host #exclude startline parameters
+        unless  key == :http_method || key == :request_url || key == :http_version || key == :Host # exclude startline parameters
           @send_buffer << key.to_s + ": "
           if value.is_a?(Array)
             @send_buffer << value.shift
-            until value.empty? do
+            until value.empty?
               @send_buffer << "," + value.shift
             end
           else
@@ -88,8 +87,8 @@ module ExperellaProxy
         end
       end
       @send_buffer << "\r\n"
-      #reconstruction complete
-      @send_buffer << buf[1] unless buf.nil? #append buffered body
+      # reconstruction complete
+      @send_buffer << buf[1] unless buf.nil? # append buffered body
       event(:request_reconstruct_header, :data => @send_buffer)
     end
 
@@ -99,8 +98,8 @@ module ExperellaProxy
     #
     # @param hsh [Hash] hash with HTTP header Key:Value pairs
     def update_header(hsh)
-      hsh = hsh.inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo }
+      hsh = hsh.reduce({}){ |memo, (k, v)| memo[k.to_sym] = v; memo }
       @header.update(hsh)
     end
   end
-end
+end

data/lib/experella-proxy/response.rb

@@ -5,7 +5,6 @@ module ExperellaProxy
   # Every Response belongs to a request {Request}
   #
   class Response
-
     include ExperellaProxy::Globals
 
     attr_reader :header
@@ -18,12 +17,12 @@ module ExperellaProxy
       @conn = request.conn
       @header = {}
       @status_code = 500
-      @no_length = false #set true if no content-length or transfer-encoding given
-      @keep_parsing = true #used for special no length case
+      @no_length = false # set true if no content-length or transfer-encoding given
+      @keep_parsing = true # used for special no length case
       @chunked = false # if true the parsed body will be chunked
       @buffer = false # default is false, so incoming data will be streamed,
       # used for http1.0 clients and transfer-encoding chunked backend responses
-      @send_buffer = String.new
+      @send_buffer = ''
       @response_parser = Http::Parser.new
       init_http_parser
     end
@@ -36,33 +35,29 @@ module ExperellaProxy
     #
     # @param str [String] data as string
     def <<(str)
-      begin
-        if @keep_parsing
-          offset = @response_parser << str
-
-        #edge case for message without content-length and transfer encoding
-          @conn.send_data str[offset..-1] unless @keep_parsing
-        else
-          @conn.send_data str
-        end
-
-      rescue Http::Parser::Error
-        event(:response_add, :signature => @conn.signature, :error => true,
-              :description => "parser error caused by invalid response data")
-        # on error unbind response_parser object, so additional data doesn't get parsed anymore
-        #
-        # assigning a string to the parser variable, will cause incoming data to get buffered
-        # imho this is a better solution than adding a condition for this rare error case
-        @response_parser = ""
-        @conn.close
+      if @keep_parsing
+        offset = (@response_parser << str)
+       # edge case for message without content-length and transfer encoding
+        @conn.send_data str[offset..-1] unless @keep_parsing
+      else
+        @conn.send_data str
       end
+     rescue Http::Parser::Error
+      event(:response_add, :signature => @conn.signature, :error => true,
+            :description => "parser error caused by invalid response data")
+      # on error unbind response_parser object, so additional data doesn't get parsed anymore
+      #
+      # assigning a string to the parser variable, will cause incoming data to get buffered
+      # imho this is a better solution than adding a condition for this rare error case
+      @response_parser = ""
+      @conn.close
     end
 
     # Returns the data in send_buffer and empties the send_buffer
     #
     # @return [String] data to send
     def flush
-      event(:response_flush,:data => @send_buffer)
+      event(:response_flush, :data => @send_buffer)
       @send_buffer.slice!(0, @send_buffer.length)
     end
 
@@ -81,16 +76,16 @@ module ExperellaProxy
     #
     def reconstruct_header
       @send_buffer = ""
-      #start line
+      # start line
       @send_buffer << "HTTP/1.1 "
       @send_buffer << @status_code.to_s + ' '
       @send_buffer << HTTP_STATUS_CODES[@status_code] + "\r\n"
-      #header fields
+      # header fields
       @header.each do |key, value|
         @send_buffer << key.to_s + ": "
         if value.is_a?(Array)
           @send_buffer << value.shift
-          until value.empty? do
+          until value.empty?
             @send_buffer << "," + value.shift
           end
         else
@@ -99,7 +94,7 @@ module ExperellaProxy
         @send_buffer << "\r\n"
       end
       @send_buffer << "\r\n"
-      #reconstruction complete
+      # reconstruction complete
       event(:response_reconstruct_header, :data => @send_buffer)
     end
 
@@ -109,15 +104,15 @@ module ExperellaProxy
     #
     # @param hsh [Hash] hash with HTTP header Key:Value pairs
     def update_header(hsh)
-      hsh = hsh.inject({}) { |memo, (k, v)| memo[k.to_sym] = v; memo }
+      hsh = hsh.reduce({}){ |memo, (k, v)| memo[k.to_sym] = v; memo }
       @header.update(hsh)
     end
 
-    private
+  private
 
     # initializes the response http parser
     def init_http_parser
-      #called when response headers are completely parsed (first \r\n\r\n triggers this)
+      # called when response headers are completely parsed (first \r\n\r\n triggers this)
       @response_parser.on_headers_complete = proc do |h|
 
         @status_code = @response_parser.status_code
@@ -142,7 +137,7 @@ module ExperellaProxy
             @no_length = true
             @header[:Connection] = "close"
           end
-        #chunked encoded
+        # chunked encoded
         else
           # buffer response data if client uses http 1.0 until message complete
           if @request.header[:http_version][0] == 1 && @request.header[:http_version][1] == 0
@@ -168,7 +163,6 @@ module ExperellaProxy
           h.delete(s)
         end
 
-
         via = h.delete("Via")
         if via.nil?
           via = "1.1 experella"
@@ -219,4 +213,4 @@ module ExperellaProxy
       end
     end
   end
-end
+end

data/lib/experella-proxy/server.rb

@@ -7,7 +7,7 @@ module ExperellaProxy
     #
     # @param options [Hash] options Hash passed to the proxy
     def initialize(options)
-      @options=options
+      @options = options
     end
 
     attr_reader :options
@@ -25,7 +25,6 @@ module ExperellaProxy
     # {Connection#unbind} in on_unbind
     #
     def run
-
       Proxy.start(options = {}) do |conn|
         event(:server_new_connection, :msec => msec, :signature => signature)
 
@@ -58,10 +57,6 @@ module ExperellaProxy
 
         end
       end
-
     end
-
   end
-
 end
-

data/lib/experella-proxy/version.rb

@@ -1,5 +1,9 @@
 module ExperellaProxy
   # ExperellaProxy Gemversion
+  # 0.0.11
+  # * output version on start
+  # * rubocup config file
+  # * applied rubyocop config file
   # 0.0.10
   # * no logging any more just firing events
   # 0.0.9
@@ -23,5 +27,5 @@ module ExperellaProxy
   # * added self-signed SSL certificate for TLS/HTTPS
   # * added config template init functionality
   #
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/lib/experella-proxy.rb

@@ -1,6 +1,7 @@
 require 'optparse'
 require 'eventmachine'
 require 'http_parser.rb'
+require 'experella-proxy/version'
 require 'experella-proxy/globals'
 require 'experella-proxy/http_status_codes'
 require 'experella-proxy/configuration'
@@ -35,7 +36,6 @@ require 'experella-proxy/response'
 # @see file:README.md README
 # @author Dennis-Florian Herr 2014 @Experteer GmbH
 module ExperellaProxy
-
   # Initializes ExperellaProxy's {Configuration} and {ConnectionManager}
   #
   # @param [Hash] options Hash passed to the configuration
@@ -43,11 +43,11 @@ module ExperellaProxy
   # @return [Boolean] true if successful false if NoConfigError was raised
   def self.init(options={})
     begin
-    Configuration.new(options)
-    rescue Configuration::NoConfigError => e
-      puts e.message
-      puts e.backtrace.join("\n\t")
-      return false
+      Configuration.new(options)
+      rescue Configuration::NoConfigError => e
+        puts e.message
+        puts e.backtrace.join("\n\t")
+        return false
     end
     @connection_manager = ConnectionManager.new
     true
@@ -66,19 +66,18 @@ module ExperellaProxy
   # Loses all buffered data
   def self.restart
     opts = @server.options
-    self.stop
+    stop
     Server.new(opts).run if ExperellaProxy.init(opts)
   end
 
   # Stops ExperellaProxy
   #
   def self.stop
-     Proxy.stop
+    Proxy.stop
   end
-
 end
 
-#startup
+# startup
 ARGV << '--help' if ARGV.empty?
 
 options = {}

data/spec/echo-server/echo_server.rb

@@ -1,10 +1,9 @@
 require 'eventmachine'
 require 'http_parser.rb'
 module EchoServer
-
   def post_init
     @parser = Http::Parser.new
-    @buffer = String.new
+    @buffer = ''
 
     @parser.on_headers_complete = proc do |h|
       if @parser.request_path == "/chunked"
@@ -30,15 +29,14 @@ module EchoServer
     end
   end
 
-  def receive_data data
+  def receive_data(data)
     @buffer << data
     @parser << data
   end
-
 end
 
 EventMachine.run do
-  trap("QUIT") { EM.stop }
+  trap("QUIT"){ EM.stop }
 
   if ARGV.count == 2
     EventMachine.start_server ARGV.first, ARGV.last.to_i, EchoServer
@@ -46,4 +44,4 @@ EventMachine.run do
     raise "invalid number of params, expected [server] [port]"
   end
 
-end
+end