m2r 0.0.3 → 1.0.0

data/lib/m2r/request.rb

@@ -0,0 +1,129 @@
+require 'm2r'
+require 'm2r/request/base'
+require 'm2r/request/upload'
+require 'm2r/headers'
+
+module M2R
+  # Abstraction over Mongrel 2 request
+  # @api public
+  class Request
+    # @api private
+    TRUE_STRINGS     = %w(true yes on 1).map(&:freeze).freeze
+
+    include Base
+    include Upload
+
+    # @return [String] UUID of mongrel2 origin instance
+    attr_reader :sender
+
+    # @return [String] Mongrel2 connection id sending this request
+    attr_reader :conn_id
+
+    # @return [String] HTTP Path of request
+    attr_reader :path
+
+    # @return [String] HTTP Body of request
+    attr_reader :body
+
+    # @param [String] sender UUID of mongrel2 origin instance
+    # @param [String] conn_id Mongrel2 connection id sending this request
+    # @param [String] path HTTP Path of request
+    # @param [M2R::Headers] headers HTTP headers of request
+    # @param [String] body HTTP Body of request
+    def initialize(sender, conn_id, path, headers, body)
+      @http_headers, @mongrel_headers = split_headers(headers)
+      @sender  = sender
+      @conn_id = conn_id
+      @path    = path
+      @body    = body
+      @data    = MultiJson.load(@body) if json?
+    end
+
+    # Parse Mongrel2 request received via ZMQ message
+    #
+    # @param [String] msg Monrel2 Request message formatted according to rules
+    #   of creating it described it m2 manual.
+    # @return [Request]
+    #
+    # @api public
+    def self.parse(msg)
+      sender, conn_id, path, rest = msg.split(' ', 4)
+
+      headers, rest = TNetstring.parse(rest)
+      body, _       = TNetstring.parse(rest)
+      headers       = Headers.new MultiJson.load(headers)
+      self.new(sender, conn_id, path, headers, body)
+    end
+
+    # @return [M2R::Headers] HTTP headers
+    def headers
+      @http_headers
+    end
+
+    # @return [String] Mongrel2 pattern used to match this request
+    def pattern
+      @mongrel_headers['pattern']
+    end
+
+    # @return [String] HTTP method
+    def method
+      @mongrel_headers['method']
+    end
+
+    # @return [String] Request query string
+    def query
+      @mongrel_headers['query']
+    end
+
+    # return [String] URL scheme
+    def scheme
+      @mongrel_headers['url_scheme'] || mongrel17_scheme
+    end
+
+    # @return [true, false] Internal mongrel2 message to handler issued when
+    #   message delivery is not possible because the client already
+    #   disconnected and there is no connection with such {#conn_id}
+    def disconnect?
+      json? and @data['type'] == 'disconnect'
+    end
+
+    # @return [true, false] Information whether HTTP Connection should
+    #   be closed after processing the request. Happens when HTTP/1.0
+    #   or request has Connection=close header.
+    def close?
+      unsupported_version? or connection_close?
+    end
+
+    protected
+
+    def mongrel17_scheme
+      return 'https' if TRUE_STRINGS.include? env_https
+      return 'http'
+    end
+
+    def env_https
+      (ENV['HTTPS'] || "").downcase
+    end
+
+    def unsupported_version?
+      @http_headers['version'] != 'HTTP/1.1'
+    end
+
+    def connection_close?
+      @http_headers['connection'] == 'close'
+    end
+
+    def json?
+      method == 'JSON'
+    end
+
+    def split_headers(headers)
+      mongrel = Headers.new
+      mongrel_headers.each do |header|
+        next unless headers[header]
+        mongrel[header] = headers.delete(header)
+      end
+      return headers, mongrel
+    end
+  end
+end

data/lib/m2r/request/base.rb

@@ -0,0 +1,33 @@
+module M2R
+  # Logic for typical Mongrel2 request with no fancy features such as
+  # async upload
+  #
+  # @private
+  module Base
+    MONGREL2_BASE_HEADERS = %w(pattern method path query url_scheme).map(&:freeze).freeze
+
+    # @return [StringIO] Request body encapsulated in IO compatible object
+    # @api public
+    def body_io
+      @body_io ||= begin
+        b = StringIO.new(body)
+        b.set_encoding(Encoding::BINARY) if b.respond_to?(:set_encoding)
+        b
+      end
+    end
+
+    # @return [nil] Free external resources such as files or sockets
+    # @api public
+    def free!
+      body_io.close
+    end
+
+    protected
+
+    def mongrel_headers
+      MONGREL2_BASE_HEADERS
+    end
+
+  end
+end
+

data/lib/m2r/request/upload.rb

@@ -0,0 +1,60 @@
+module M2R
+  # Logic for Mongrel2 request delivered using async-upload feature
+  # Contains methods for recognizing such requests and reading them.
+  # @private
+  module Upload
+    # Headers related to async-upload feature
+    # @private
+    MONGREL2_UPLOAD_HEADERS = %w(x-mongrel2-upload-start x-mongrel2-upload-done).map(&:freeze).freeze
+
+    # @return [true,false] True if this is async-upload related request
+    # @api public
+    def upload?
+      !!@mongrel_headers['x-mongrel2-upload-start']
+    end
+
+    # @return [true,false] True if this is async-upload start notification
+    # @api public
+    def upload_start?
+      upload? and not upload_path
+    end
+
+    # @return [true,false] True if this is final async-upload request
+    # @api public
+    def upload_done?
+      upload? and upload_path
+    end
+
+    # @return [String] Relative path to file containing body of HTTP
+    #   request.
+    # @api public
+    def upload_path
+      @mongrel_headers['x-mongrel2-upload-done']
+    end
+
+    # @return [File] Request body encapsulated in IO compatible object
+    # @api public
+    def body_io
+      return super unless upload_done?
+      @body_io ||= begin
+        f = File.open(upload_path, "r+b")
+        f.set_encoding(Encoding::BINARY) if f.respond_to?(:set_encoding)
+        f
+      end
+    end
+
+    # @return [nil] Free external resources such as files or sockets
+    # @api public
+    def free!
+      super
+      File.delete(body_io.path) if upload_done?
+    end
+
+    protected
+
+    def mongrel_headers
+      super + MONGREL2_UPLOAD_HEADERS
+    end
+  end
+end
+

data/lib/m2r/response.rb

@@ -0,0 +1,102 @@
+require 'm2r'
+require 'm2r/response/content_length'
+
+module M2R
+  # Simplest possible abstraction layer over HTTP request
+  #
+  # @api public
+  class Response
+
+    # @private
+    VERSION      = "HTTP/1.1".freeze
+
+    # @private
+    CRLF         = "\r\n".freeze
+
+    # @private
+    STATUS_CODES = {
+      100 => 'Continue',
+      101 => 'Switching Protocols',
+      102 => 'Processing',
+      200 => 'OK',
+      201 => 'Created',
+      202 => 'Accepted',
+      203 => 'Non-Authoritative Information',
+      204 => 'No Content',
+      205 => 'Reset Content',
+      206 => 'Partial Content',
+      207 => 'Multi-Status',
+      226 => 'IM Used',
+      300 => 'Multiple Choices',
+      301 => 'Moved Permanently',
+      302 => 'Found',
+      303 => 'See Other',
+      304 => 'Not Modified',
+      305 => 'Use Proxy',
+      306 => 'Reserved',
+      307 => 'Temporary Redirect',
+      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 Timeout',
+      409 => 'Conflict',
+      410 => 'Gone',
+      411 => 'Length Required',
+      412 => 'Precondition Failed',
+      413 => 'Request Entity Too Large',
+      414 => 'Request-URI Too Long',
+      415 => 'Unsupported Media Type',
+      416 => 'Requested Range Not Satisfiable',
+      417 => 'Expectation Failed',
+      418 => "I'm a Teapot",
+      422 => 'Unprocessable Entity',
+      423 => 'Locked',
+      424 => 'Failed Dependency',
+      426 => 'Upgrade Required',
+      500 => 'Internal Server Error',
+      501 => 'Not Implemented',
+      502 => 'Bad Gateway',
+      503 => 'Service Unavailable',
+      504 => 'Gateway Timeout',
+    }
+    STATUS_CODES.freeze
+
+    # @return [Fixnum] HTTP Status code
+    attr_reader :status
+
+    # @return [Hash, Headers] Collection of response HTTP Headers
+    attr_reader :headers
+
+    # @return [String] HTTP Body
+    attr_reader :body
+
+    # @return [String] HTTP Status code description
+    attr_reader :reason
+
+    # @param [Fixnum, #to_i] status HTTP status code
+    # @param [Hash] headers HTTP headers
+    # @param [String, nil] body HTTP body
+    def initialize(status, headers, body = nil)
+      @status  = status.to_i
+      @headers = headers
+      @body    = body || ""
+      @reason  = STATUS_CODES[status.to_i]
+    end
+
+    # @return [String] HTTP Response
+    def to_s
+      response = "#{VERSION} #{status} #{reason}#{CRLF}"
+      unless headers.empty?
+        response << headers.map { |h, v| "#{h}: #{v}" }.join(CRLF) << CRLF
+      end
+      response << CRLF
+      response << body
+      response
+    end
+  end
+end

data/lib/m2r/response/content_length.rb

@@ -0,0 +1,18 @@
+require 'm2r/response'
+
+module M2R
+  class Response
+    # Adds Content-Length header based on body size
+    # This is mostly required when you use bare
+    # Response class without any framework on top of it.
+    # HTTP clients require such header when there is
+    # body in response. Otherwise they hang out.
+    #
+    # @api public
+    module ContentLength
+      def headers
+        super.merge('Content-Length' => body.bytesize)
+      end
+    end
+  end
+end

data/lib/m2r/version.rb

@@ -0,0 +1,5 @@
+module M2R
+  # m2r gem version
+  # @api public
+  VERSION = '1.0.0'
+end

data/lib/rack/handler/mongrel2.rb

@@ -0,0 +1,33 @@
+require 'rack/handler'
+require 'm2r/rack_handler'
+require 'securerandom'
+require 'ostruct'
+
+module Rack
+  module Handler
+    class Mongrel2
+      DEFAULT_OPTIONS = {
+        'recv_addr' => 'tcp://127.0.0.1:9997',
+        'send_addr' => 'tcp://127.0.0.1:9996',
+        'sender_id' => SecureRandom.uuid
+      }
+
+      def self.run(app, options = {})
+        options = OpenStruct.new( DEFAULT_OPTIONS.merge(options) )
+        factory = M2R::ConnectionFactory.new(options.sender_id, options.recv_addr, options.send_addr)
+        adapter = M2R::RackHandler.new(app, factory)
+        adapter.listen
+      end
+
+      def self.valid_options
+        {
+          'recv_addr=RECV_ADDR' => 'Receive address',
+          'send_addr=SEND_ADDR' => 'Send address',
+          'sender_id=UUID' => 'Sender UUID'
+        }
+      end
+    end
+
+    register :mongrel2, ::Rack::Handler::Mongrel2
+  end
+end

data/m2r.gemspec

@@ -1,69 +1,36 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/m2r/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = %q{m2r}
-  s.version = "0.0.3"
+Gem::Specification.new do |gem|
+  gem.authors          = ["Colin Curtin", "Pradeep Elankumaran", "Pawel Pacana", "Robert Pankowecki"]
+  gem.email            = ["colin.t.curtin+m2r@gmail.com", "pawel.pacana+m2r@gmail.com", "robert.pankowecki+m2r@gmail.com"]
+  gem.description      = "A Mongrel2 interface and handler library for JRuby, and hopefully other Ruby implementations in the future. Works with Rack, so it works with Rails! (Rails installation guide forthcoming)."
+  gem.homepage         = "http://github.com/perplexes/m2r"
+  gem.summary          = "Mongrel2 interface and handler library for JRuby."
+  gem.license          = "MIT"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Colin Curtin", "Pradeep Elankumaran"]
-  s.date = %q{2010-10-23}
-  s.description = %q{A Mongrel2 interface and handler library for JRuby, and hopefully other Ruby implementations in the future. Works with Rack, so it works with Rails! (Rails installation guide forthcoming.)}
-  s.email = %q{colin.t.curtin+m2r@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.md"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "ISSUES",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "benchmarks/jruby",
-     "example/http_0mq.rb",
-     "example/lobster.ru",
-     "example/rack_handler.rb",
-     "lib/connection.rb",
-     "lib/fiber_handler.rb",
-     "lib/handler.rb",
-     "lib/m2r.rb",
-     "lib/request.rb",
-     "m2r.gemspec",
-     "test/helper.rb",
-     "test/test_m2r.rb"
-  ]
-  s.homepage = %q{http://github.com/perplexes/m2r}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Mongrel2 interface and handler library for JRuby}
-  s.test_files = [
-    "test/helper.rb",
-     "test/test_m2r.rb"
-  ]
+  gem.files            = Dir.glob("{lib,example,test}/**/*") + %w(LICENSE README.md Rakefile Gemfile m2r.gemspec)
+  gem.test_files       = Dir.glob("test/**/*")
+  gem.extra_rdoc_files = ["LICENSE", "README.md" ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  gem.name             = "m2r"
+  gem.date             = "2010-10-23"
+  gem.require_path     = "lib"
+  gem.version          = M2R::VERSION
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ffi>, [">= 0"])
-      s.add_runtime_dependency(%q<ffi-rzmq>, [">= 0"])
-      s.add_runtime_dependency(%q<json>, [">= 0"])
-    else
-      s.add_dependency(%q<ffi>, [">= 0"])
-      s.add_dependency(%q<ffi-rzmq>, [">= 0"])
-      s.add_dependency(%q<json>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<ffi>, [">= 0"])
-    s.add_dependency(%q<ffi-rzmq>, [">= 0"])
-    s.add_dependency(%q<json>, [">= 0"])
-  end
-end
+  gem.add_dependency "ffi-rzmq", "~> 0.9.3"
+  gem.add_dependency "ffi", ">= 1.0.0"
+  gem.add_dependency "multi_json"
+  gem.add_dependency "tnetstring"
+
+  gem.add_development_dependency "rack"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest",            "= 3.2.0"
+  gem.add_development_dependency "mocha",               "~> 0.12.1"
+  gem.add_development_dependency "bbq",                 "= 0.0.4"
+  gem.add_development_dependency "capybara-mechanize",  "= 0.3.0"
+  gem.add_development_dependency "activesupport",       "~> 3.2.7"
+  gem.add_development_dependency "yard",                "~> 0.8.2"
+  gem.add_development_dependency "kramdown",            "~> 0.13.7"
 
+end