RubyGems - m2r - Versions diffs - 0.0.3 → 1.0.0 - Mend

m2r 0.0.3 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (51) hide show

data/Gemfile +6 -0
data/README.md +141 -35
data/Rakefile +13 -45
data/example/Procfile +4 -0
data/example/config.sqlite +0 -0
data/example/http_0mq.rb +37 -19
data/example/lobster.ru +14 -6
data/example/mongrel2.conf +47 -0
data/example/tmp/access.log +505 -0
data/example/uploading.ru +37 -0
data/lib/m2r.rb +49 -3
data/lib/m2r/connection.rb +66 -0
data/lib/m2r/connection_factory.rb +41 -0
data/lib/m2r/handler.rb +130 -0
data/lib/m2r/headers.rb +72 -0
data/lib/m2r/rack_handler.rb +47 -0
data/lib/m2r/request.rb +129 -0
data/lib/m2r/request/base.rb +33 -0
data/lib/m2r/request/upload.rb +60 -0
data/lib/m2r/response.rb +102 -0
data/lib/m2r/response/content_length.rb +18 -0
data/lib/m2r/version.rb +5 -0
data/lib/rack/handler/mongrel2.rb +33 -0
data/m2r.gemspec +30 -63
data/test/acceptance/examples_test.rb +32 -0
data/test/support/capybara.rb +4 -0
data/test/support/mongrel_helper.rb +40 -0
data/test/support/test_handler.rb +51 -0
data/test/support/test_user.rb +37 -0
data/test/test_helper.rb +5 -0
data/test/unit/connection_factory_test.rb +29 -0
data/test/unit/connection_test.rb +49 -0
data/test/unit/handler_test.rb +41 -0
data/test/unit/headers_test.rb +50 -0
data/test/unit/m2r_test.rb +40 -0
data/test/unit/rack_handler_test.rb +52 -0
data/test/unit/request_test.rb +38 -0
data/test/unit/response_test.rb +30 -0
metadata +310 -105
data/.document +0 -5
data/.gitignore +0 -21
data/ISSUES +0 -62
data/VERSION +0 -1
data/benchmarks/jruby +0 -60
data/example/rack_handler.rb +0 -69
data/lib/connection.rb +0 -158
data/lib/fiber_handler.rb +0 -43
data/lib/handler.rb +0 -66
data/lib/request.rb +0 -44
data/test/helper.rb +0 -10
data/test/test_m2r.rb +0 -7

data/example/uploading.ru ADDED

@@ -0,0 +1,37 @@
+# Running this example:
+#
+#   m2sh load -config mongrel2.conf
+#   bundle exec foreman start
+#
+# Browse now to http://localhost:6767/uploading to see the effect.
+#
+# This example is not threadsafe !
+$stdout.sync = true
+$stderr.sync = true
+require 'rack'
+require 'pathname'
+use Rack::ContentLength
+size = 0
+app = Proc.new do |env|
+  req = Rack::Request.new(env)
+  if req.post?
+    size = req.params["file"][:tempfile].size.to_s rescue size = 0
+  end
+  note = req.post?? "You submitted file of size: #{size}" : "Last submitted file was of size: #{size}"
+  body = <<-EOF
+    <html>
+      <body>
+        <form name="uploading" id="uploading_form" method="post" enctype="multipart/form-data" action="/uploading">
+          <input type="file" name="file" id="file"></input>
+          <input type="submit" name="submit" id="submit">Submit</input>
+        </form>
+        <p>#{note}</p>
+      </body>
+    </html>
+  EOF
+  [200, {'Content-Type' => 'text/html'}, [body]]
+end
+run app

data/lib/m2r.rb CHANGED

@@ -1,3 +1,49 @@
-require 'connection'
-require 'request'
-require 'handler'
+require 'ffi-rzmq'
+require 'multi_json'
+require 'tnetstring'
+require 'thread'
+# Allows you to easily interact with Mongrel2 webserver from
+# your ruby code.
+# @api public
+module M2R
+  class << self
+    # Sets ZMQ context used by M2R to create sockets
+    # @param [ZMQ::Context] value Context to by used by M2R
+    # @see #zmq_context
+    # @api public
+    attr_writer :zmq_context
+    # Gets (or sets if not existing) ZMQ context used by M2R
+    # to create sockets.
+    #
+    # @note This method is thread-safe
+    #   but it uses Thread.exclusive to achive that.
+    #   However it is unlikely that it affects the performance as you probably
+    #   do not create more than a dozen of sockets in your code.
+    #
+    # @param [Fixnum] zmq_io_threads Size of the ZMQ thread pool to handle I/O operations.
+    #   The rule of thumb is to make it equal to the number gigabits per second
+    #   that the application will produce.
+    #
+    # @return [ZMQ::Context]
+    # @see #zmq_context=
+    # @api public
+    def zmq_context(zmq_io_threads = 1)
+      Thread.exclusive do
+        @zmq_context ||= ZMQ::Context.new(zmq_io_threads)
+      end
+    end
+  end
+end
+# @deprecated: Use M2R instead
+#   Namespace used in the past in 0.0.* gem releases
+Mongrel2 = M2R
+require 'm2r/request'
+require 'm2r/response'
+require 'm2r/connection'
+require 'm2r/connection_factory'
+require 'm2r/handler'

data/lib/m2r/connection.rb ADDED

@@ -0,0 +1,66 @@
+require 'm2r'
+module M2R
+  # Connection for exchanging data with mongrel2
+  class Connection
+    # @param [ZMQ::Socket] request_socket socket for receiving requests
+    #   from Mongrel2
+    # @param [ZMQ::Socket] response_socket socket for sending responses
+    #   to Mongrel2
+    # @param [#parse] request_parser Object responsible for parsing Mongrel2
+    #   requests
+    # @api public
+    def initialize(request_socket, response_socket, request_parser = Request)
+      @request_socket  = request_socket
+      @response_socket = response_socket
+      @request_parser  = request_parser
+    end
+    # For compatibility with {M2R::ConnectionFactory}
+    #
+    # @return [Connection] self
+    # @api public
+    def connection
+      self
+    end
+    # Returns parsed Mongrel2 request
+    #
+    # @note This is blocking call
+    # @return [Request] Request parsed by {#request_parser}
+    # @api public
+    def receive
+      @request_socket.recv_string(msg = "")
+      @request_parser.parse(msg)
+    end
+    # Sends response to Mongrel2 for given request
+    #
+    # @param [Response, #to_s] response_or_string Response
+    #   for the request. Anything convertable to [String]
+    # @api public
+    def reply(request, response_or_string)
+      deliver(request.sender, request.conn_id, response_or_string.to_s)
+    end
+    # Delivers data to multiple mongrel2 connections.
+    # Useful for streaming.
+    #
+    # @param [String] uuid Mongrel2 instance uuid
+    # @param [Array<String>, String] connection_ids Mongrel2 connections ids
+    # @param [String] data Data that should be delivered to the connections
+    #
+    # @api public
+    def deliver(uuid, connection_ids, data)
+      msg = "#{uuid} #{TNetstring.dump([*connection_ids].join(' '))} #{data}"
+      @response_socket.send_string(msg)
+    end
+    private
+    attr_reader :request_socket
+    attr_reader :response_socket
+    attr_reader :request_parser
+  end
+end

data/lib/m2r/connection_factory.rb ADDED

@@ -0,0 +1,41 @@
+require 'm2r'
+module M2R
+  # {Connection} factory so that every thread can use it generate its own
+  # {Connection} for communication with Mongrel2.
+  #
+  # @api public
+  class ConnectionFactory
+    # @param [String, nil] sender_id {ZMQ::IDENTITY} option for response socket
+    # @param [String] request_addr ZMQ connection address. This is the
+    #   send_spec option from Handler configuration in mongrel2.conf
+    # @param [String] response_addr ZMQ connection address. This is the
+    #   recv_spec option from Handler configuration in mongrel2.conf
+    # @param [#parse] request_parser Mongrel2 request parser
+    # @param [ZMQ::Context] context Context for creating new ZMQ sockets
+    def initialize(sender_id, request_addr, response_addr, request_parser = Request, context = M2R.zmq_context)
+      @sender_id      = sender_id.to_s
+      @request_addr   = request_addr.to_s
+      @response_addr  = response_addr.to_s
+      @request_parser = request_parser
+      @context        = context
+    end
+    # Builds new Connection which can be used to receive, parse
+    # Mongrel2 requests and send responses.
+    #
+    # @return [Connection]
+    def connection
+      request_socket = @context.socket(ZMQ::PULL)
+      request_socket.connect(@request_addr)
+      response_socket = @context.socket(ZMQ::PUB)
+      response_socket.connect(@response_addr)
+      response_socket.setsockopt(ZMQ::IDENTITY, @sender_id) if @sender_id
+      Connection.new(request_socket, response_socket, @request_parser)
+    end
+  end
+end

data/lib/m2r/handler.rb ADDED

@@ -0,0 +1,130 @@
+require 'm2r'
+module M2R
+  # Basic handler, scaffold for your own Handler.
+  # Overwrite hook methods to define behavior.
+  # After calling #listen the Handler will block
+  # waiting for request from connection generated
+  # by {M2R::Handler#connection_factory}, process them and send
+  # reponses back.
+  #
+  # @api public
+  # @abstract Subclass and override method hooks to implement your own Handler
+  class Handler
+    # @return [Connection] used for receiving requests and sending responses
+    attr_accessor :connection
+    # @param [ConnectionFactory, Connection, #connection] connection_factory
+    #   Factory for generating connections
+    def initialize(connection_factory)
+      @connection = connection_factory.connection
+    end
+    # Start processing request
+    def listen
+      catch(:stop) do
+        loop { one_loop }
+      end
+    end
+    # Schedule stop after processing request
+    def stop
+      @stop = true
+    end
+    protected
+    # Callback executed when waiting for a request
+    # @api public
+    # @!visibility public
+    def on_wait()
+    end
+    # Callback when a request is received
+    # @api public
+    # @!visibility public
+    def on_request(request)
+    end
+    # Override to return a response
+    # @api public
+    # @!visibility public
+    # @return [Response, String, #to_s] Response that should be sent to
+    #   Mongrel2 instance
+    def process(request)
+      raise NotImplementedError
+    end
+    # Callback executed when response could not be delivered by Mongrel2
+    # because client already disconnected.
+    # @api public
+    # @!visibility public
+    def on_disconnect(request)
+    end
+    # Callback when async-upload started
+    # @api public
+    # @!visibility public
+    def on_upload_start(request)
+    end
+    # Callback when async-upload finished
+    # @api public
+    # @!visibility public
+    def on_upload_done(request)
+    end
+    # Callback after process_request is done
+    # @api public
+    # @!visibility public
+    def after_process(request, response)
+      return response
+    end
+    # Callback after sending the response back
+    # @api public
+    # @!visibility public
+    def after_reply(request, response)
+    end
+    # Callback after request is processed that is executed
+    # even when execption occured. Useful for releasing
+    # resources (closing files etc)
+    # @api public
+    # @!visibility public
+    def after_all(request, response)
+    end
+    private
+    def one_loop
+      on_wait
+      throw :stop if stop?
+      request_lifecycle(@connection.receive)
+    end
+    def request_lifecycle(request)
+      on_request(request)
+      return on_disconnect(request)   if request.disconnect?
+      return on_upload_start(request) if request.upload_start?
+      on_upload_done(request)         if request.upload_done?
+      response = process(request)
+      response = after_process(request, response)
+      @connection.reply(request, response)
+      after_reply(request, response)
+    ensure
+      after_all(request, response)
+    end
+    def stop?
+      @stop
+    end
+  end
+end

data/lib/m2r/headers.rb ADDED

@@ -0,0 +1,72 @@
+require 'delegate'
+module M2R
+  # Normalize headers access so that it is not case-sensitive
+  # @api public
+  class Headers
+    include Enumerable
+    # @param [Hash, #inject] hash Collection of headers
+    def initialize(hash = {})
+      @headers = hash.inject({}) do |headers,(header,value)|
+        headers[transform_key(header)] = value
+        headers
+      end
+    end
+    # Get header
+    # @param [String, Symbol, #to_s] header HTTP Header key
+    # @return [String, nil] Value of given Header, nil when not present
+    def [](header)
+      @headers[transform_key(header)]
+    end
+    # Set header
+    # @param [String, Symbol, #to_s] header HTTP Header key
+    # @param [String] value HTTP Header value
+    # @return [String] Set value
+    def []=(header, value)
+      @headers[transform_key(header)] = value
+    end
+    # Delete header
+    # @param [String, Symbol, #to_s] header HTTP Header key
+    # @return [String, nil] Value of deleted header, nil when was not present
+    def delete(header)
+      @headers.delete(transform_key(header))
+    end
+    # Iterate over headers
+    # @yield HTTP header and its value
+    # @yieldparam [String] header HTTP Header name (downcased)
+    # @yieldparam [String] value HTTP Header value
+    # @return [Hash, Enumerator]
+    def each(&proc)
+      @headers.each(&proc)
+    end
+    # Fill Hash with Headers compatibile with Rack standard.
+    # Every header except for Content-Length and Content-Type
+    # is capitalized, underscored, and prefixed with HTTP.
+    # Content-Length and Content-Type are not prefixed
+    # (according to the spec)
+    #
+    # @param [Hash] env Hash representing Rack Env or compatible
+    # @return [Hash] same Hash as provided as argument.
+    def rackify(env = {})
+      @headers.each do |header, value|
+        key = "HTTP_" + header.upcase.gsub("-", "_")
+        env[key] = value
+      end
+      env["CONTENT_LENGTH"] = env.delete("HTTP_CONTENT_LENGTH") if env.key?("HTTP_CONTENT_LENGTH")
+      env["CONTENT_TYPE"]   = env.delete("HTTP_CONTENT_TYPE")   if env.key?("HTTP_CONTENT_TYPE")
+      env
+    end
+    protected
+    def transform_key(key)
+      key.to_s.downcase
+    end
+  end
+end

data/lib/m2r/rack_handler.rb ADDED

@@ -0,0 +1,47 @@
+require 'm2r'
+require 'rack'
+module M2R
+  # Handle Mongrel2 requests using Rack application
+  # @private
+  class RackHandler < Handler
+    attr_accessor :app
+    def initialize(app, connection_factory)
+      @app = app
+      super(connection_factory)
+      trap('INT') { stop }
+    end
+    def process(request)
+      script_name = request.pattern.split('(', 2).first.gsub(/\/$/, '')
+      env = {
+        'REQUEST_METHOD'    => request.method,
+        'SCRIPT_NAME'       => script_name,
+        'PATH_INFO'         => request.path.gsub(script_name, ''),
+        'QUERY_STRING'      => request.query || "",
+        'rack.version'      => ::Rack::VERSION,
+        'rack.errors'       => $stderr,
+        'rack.multithread'  => false,
+        'rack.multiprocess' => true,
+        'rack.run_once'     => false,
+        'rack.url_scheme'   => request.scheme,
+        'rack.input'        => request.body_io
+      }
+      env['SERVER_NAME'], env['SERVER_PORT'] = request.headers['Host'].split(':', 2)
+      request.headers.rackify(env)
+      status, headers, body = @app.call(env)
+      buffer = ""
+      body.each { |part| buffer << part }
+      return Response.new(status, headers, buffer)
+    end
+    def after_all(request, response)
+      request.free!
+    end
+  end
+end