eventmachine-maglev- 0.12.10 → 1.0.0.beta.4

data/lib/em/protocols/httpclient2.rb

@@ -26,6 +26,8 @@
 module EventMachine
   module Protocols
 
+    # <b>Note:</b> This class is deprecated and will be removed. Please use EM-HTTP-Request instead.
+    #
     # === Usage
     #
     #  EM.run{
@@ -42,12 +44,15 @@ module EventMachine
       include LineText2
       
       def initialize
+        warn "HttpClient2 is deprecated and will be removed. EM-Http-Request should be used instead."
+
         @authorization = nil
         @closed = nil
         @requests = nil
       end
 
-      class Request # :nodoc:
+      # @private
+      class Request
         include Deferrable
 
         attr_reader :version
@@ -279,12 +284,12 @@ module EventMachine
         request args
       end
 
-      # :stopdoc:
 
       #--
       # Compute and remember a string to be used as the host header in HTTP requests
       # unless the user overrides it with an argument to #request.
       #
+      # @private
       def set_default_host_header host, port, ssl
         if (ssl and port != 443) or (!ssl and port != 80)
           @host_header = "#{host}:#{port}"
@@ -294,11 +299,13 @@ module EventMachine
       end
 
 
+      # @private
       def post_init
         super
         @connected = EM::DefaultDeferrable.new
       end
 
+      # @private
       def connection_completed
         super
         @connected.succeed
@@ -316,12 +323,14 @@ module EventMachine
       # Set and remember a flag (@closed) so we can immediately fail any
       # subsequent requests.
       #
+      # @private
       def unbind
         super
         @closed = true
         (@requests || []).each {|r| r.fail}
       end
 
+      # @private
       def request args
         args[:host_header] = @host_header unless args.has_key?(:host_header)
         args[:authorization] = @authorization unless args.has_key?(:authorization)
@@ -335,6 +344,7 @@ module EventMachine
         r
       end
 
+      # @private
       def receive_line ln
         if req = @requests.last
           req.receive_line ln
@@ -342,8 +352,9 @@ module EventMachine
           p "??????????"
           p ln
         end
-
       end
+
+      # @private
       def receive_binary_data text
         @requests.last.receive_text text
       end
@@ -351,11 +362,10 @@ module EventMachine
       #--
       # Called by a Request object when it completes.
       #
+      # @private
       def pop_request
         @requests.pop
       end
-
-      # :startdoc:
     end
 
 

data/lib/em/protocols/line_protocol.rb

@@ -0,0 +1,29 @@
+module EventMachine
+  module Protocols
+    # LineProtocol will parse out newline terminated strings from a receive_data stream
+    #
+    #  module Server
+    #    include EM::P::LineProtocol
+    #
+    #    def receive_line(line)
+    #      send_data("you said: #{line}")
+    #    end
+    #  end
+    #
+    module LineProtocol
+      # @private
+      def receive_data data
+        (@buf ||= '') << data
+
+        while line = @buf.slice!(/(.*)\r?\n/)
+          receive_line(line)
+        end
+      end
+
+      # Invoked with lines received over the network
+      def receive_line(line)
+        # stub
+      end
+    end
+  end
+end

data/lib/em/protocols/memcache.rb

@@ -32,18 +32,23 @@ module EventMachine
       ##
       # constants
 
-      # :stopdoc:
       unless defined? Cempty
+        # @private
         Cstored    = 'STORED'.freeze
+        # @private
         Cend       = 'END'.freeze
+        # @private
         Cdeleted   = 'DELETED'.freeze
+        # @private
         Cunknown   = 'NOT_FOUND'.freeze
+        # @private
         Cerror     = 'ERROR'.freeze
 
+        # @private
         Cempty     = ''.freeze
+        # @private
         Cdelimiter = "\r\n".freeze
       end
-      # :startdoc:
 
       ##
       # commands
@@ -110,9 +115,7 @@ module EventMachine
         EM.connect host, port, self, host, port
       end
 
-      # :stopdoc:
-
-      def send_cmd cmd, key, flags = 0, exptime = 0, bytes = 0, noreply = false # :nodoc:
+      def send_cmd cmd, key, flags = 0, exptime = 0, bytes = 0, noreply = false
         send_data "#{cmd} #{key} #{flags} #{exptime} #{bytes}#{noreply ? ' noreply' : ''}\r\n"
       end
       private :send_cmd
@@ -120,16 +123,19 @@ module EventMachine
       ##
       # errors
 
+      # @private
       class ParserError < StandardError
       end
 
       ##
       # em hooks
 
+      # @private
       def initialize host, port = 11211
         @host, @port = host, port
       end
 
+      # @private
       def connection_completed
         @get_cbs = []
         @set_cbs = []
@@ -148,6 +154,7 @@ module EventMachine
       # 19Feb09 Switched to a custom parser, LineText2 is recursive and can cause
       #         stack overflows when there is too much data.
       # include EM::P::LineText2
+      # @private
       def receive_data data
         (@buffer||='') << data
 
@@ -164,6 +171,7 @@ module EventMachine
 
       #--
       # def receive_line line
+      # @private
       def process_cmd line
         case line.strip
         when /^VALUE\s+(.+?)\s+(\d+)\s+(\d+)/ # VALUE <key> <flags> <bytes>
@@ -209,6 +217,7 @@ module EventMachine
       #   @values[@cur_key] = data[0..-3]
       # end
 
+      # @private
       def unbind
         if @connected or @reconnecting
           EM.add_timer(1){ reconnect @host, @port }
@@ -219,8 +228,6 @@ module EventMachine
           raise 'Unable to connect to memcached server'
         end
       end
-
-      # :startdoc:
     end
   end
 end
@@ -229,7 +236,8 @@ if __FILE__ == $0
   # ruby -I ext:lib -r eventmachine -rubygems lib/protocols/memcache.rb
   require 'em/spec'
 
-  class TestConnection # :nodoc:
+  # @private
+  class TestConnection
     include EM::P::Memcache
     def send_data data
       sent_data << data
@@ -320,4 +328,4 @@ if __FILE__ == $0
     end
 
   end
-end
+end

data/lib/em/protocols/object_protocol.rb

@@ -17,7 +17,8 @@ module EventMachine
         Marshal
       end
 
-      def receive_data data # :nodoc:
+      # @private
+      def receive_data data
         (@buf ||= '') << data
 
         while @buf.size >= 4

data/lib/em/protocols/postgres3.rb

@@ -29,7 +29,8 @@ require 'postgres-pr/message'
 require 'postgres-pr/connection'
 require 'stringio'
 
-class StringIO # :nodoc:
+# @private
+class StringIO
   # Reads exactly +n+ bytes.
   #
   # If the data read is nil an EOFError is raised.

data/lib/em/protocols/smtpclient.rb

@@ -3,7 +3,7 @@
 # Author:: Francis Cianfrocca (gmail: blackhedd)
 # Homepage::  http://rubyeventmachine.com
 # Date:: 16 July 2006
-# 
+#
 # See EventMachine and EventMachine::Connection for documentation and
 # usage examples.
 #
@@ -11,17 +11,17 @@
 #
 # Copyright (C) 2006-07 by Francis Cianfrocca. All Rights Reserved.
 # Gmail: blackhedd
-# 
+#
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of either: 1) the GNU General Public License
 # as published by the Free Software Foundation; either version 2 of the
 # License, or (at your option) any later version; or 2) Ruby's License.
-# 
+#
 # See the file COPYING for complete licensing information.
 #
 #---------------------------------------------------------------------------
 #
-# 
+#
 
 require 'ostruct'
 
@@ -30,6 +30,7 @@ module EventMachine
 
     # Simple SMTP client
     #
+    # @example
     #  email = EM::Protocols::SmtpClient.send(
     #    :domain=>"example.com",
     #    :host=>'localhost',
@@ -66,7 +67,7 @@ module EventMachine
     class SmtpClient < Connection
       include EventMachine::Deferrable
       include EventMachine::Protocols::LineText2
-      
+
       def initialize
         @succeeded = nil
         @responder = nil
@@ -91,7 +92,10 @@ module EventMachine
       #   depending on the type.
       #   Currently only :type => :plain is supported. Pass additional parameters :username (String),
       #   and :password (either a String or a Proc that will be called at auth-time).
-      #   Example: :auth => {:type=>:plain, :username=>"mickey@disney.com", :password=>"mouse"}
+      #
+      #   @example
+      #     :auth => {:type=>:plain, :username=>"mickey@disney.com", :password=>"mouse"}
+      #
       # :from => required String
       #   Specifies the sender of the message. Will be passed as the argument
       #   to the MAIL FROM. Do NOT enclose the argument in angle-bracket (<>) characters.
@@ -109,7 +113,9 @@ module EventMachine
       #   containing the header values. TODO, support Arrays of header values, which would cause us to
       #   send that specific header line more than once.
       #
-      #   Example: :header => {"Subject" => "Bogus", "CC" => "myboss@example.com"}
+      #   @example
+      #     :header => {"Subject" => "Bogus", "CC" => "myboss@example.com"}
+      #
       # :body => Optional string, defaults blank.
       #   This will be passed as the body of the email message.
       #   TODO, this needs to be significantly beefed up. As currently written, this requires the caller
@@ -156,15 +162,15 @@ module EventMachine
         }
       end
 
-      # :stopdoc:
-
       attr_writer :args
 
+      # @private
       def post_init
         @return_values = OpenStruct.new
         @return_values.start_time = Time.now
       end
 
+      # @private
       def connection_completed
         @responder = :receive_signon
         @msg = []
@@ -175,6 +181,7 @@ module EventMachine
       # set a deferred success because the caller will already have done it
       # (no need to wait until the connection closes to invoke the callbacks).
       #
+      # @private
       def unbind
         unless @succeeded
           @return_values.elapsed_time = Time.now - @return_values.start_time
@@ -185,6 +192,7 @@ module EventMachine
         end
       end
 
+      # @private
       def receive_line ln
         $>.puts ln if @args[:verbose]
         @range = ln[0...1].to_i
@@ -197,6 +205,8 @@ module EventMachine
         end
       end
 
+      private
+
       # We encountered an error from the server and will close the connection.
       # Use the error and message the server returned.
       #
@@ -350,8 +360,6 @@ module EventMachine
         @return_values.message = @msg
         set_deferred_status :succeeded, @return_values
       end
-
-      # :startdoc:
     end
   end
 end

data/lib/em/protocols/smtpserver.rb

@@ -32,6 +32,86 @@ module EventMachine
     # and data to user code. User code is responsible for doing the right things with the
     # data in order to get complete and correct SMTP server behavior.
     #
+    # Simple SMTP server example:
+    #
+    #  class EmailServer < EM::P::SmtpServer
+    #    def receive_plain_auth(user, pass)
+    #      true
+    #    end
+    #
+    #    def get_server_domain
+    #      "mock.smtp.server.local"
+    #    end
+    #
+    #    def get_server_greeting
+    #      "mock smtp server greets you with impunity"
+    #    end
+    #
+    #    def receive_sender(sender)
+    #      current.sender = sender
+    #      true
+    #    end
+    #
+    #    def receive_recipient(recipient)
+    #      current.recipient = recipient
+    #      true
+    #    end
+    #
+    #    def receive_message
+    #      current.received = true
+    #      current.completed_at = Time.now
+    #
+    #      p [:received_email, current]
+    #      @current = OpenStruct.new
+    #      true
+    #    end
+    #
+    #    def receive_ehlo_domain(domain)
+    #      @ehlo_domain = domain
+    #      true
+    #    end
+    #
+    #    def receive_data_command
+    #      current.data = ""
+    #      true
+    #    end
+    #
+    #    def receive_data_chunk(data)
+    #      current.data << data.join("\n")
+    #      true
+    #    end
+    #
+    #    def receive_transaction
+    #      if @ehlo_domain
+    #        current.ehlo_domain = @ehlo_domain
+    #        @ehlo_domain = nil
+    #      end
+    #      true
+    #    end
+    #
+    #    def current
+    #      @current ||= OpenStruct.new
+    #    end
+    #
+    #    def self.start(host = 'localhost', port = 1025)
+    #      require 'ostruct'
+    #      @server = EM.start_server host, port, self
+    #    end
+    #
+    #    def self.stop
+    #      if @server
+    #        EM.stop_server @server
+    #        @server = nil
+    #      end
+    #    end
+    #
+    #    def self.running?
+    #      !!@server
+    #    end
+    #  end
+    #
+    #  EM.run{ EmailServer.start }
+    #
     #--
     # Useful paragraphs in RFC-2821:
     # 4.3.2: Concise list of command-reply sequences, in essence a text representation
@@ -114,6 +194,7 @@ module EventMachine
         @@parms[:verbose] and $>.puts ">>> #{ln}"
 
         return process_data_line(ln) if @state.include?(:data)
+        return process_auth_line(ln) if @state.include?(:auth_incomplete)
 
         case ln
         when EhloRegex
@@ -216,7 +297,7 @@ module EventMachine
             send_data "250-STARTTLS\r\n"
           end
           if @@parms[:auth]
-            send_data "250-AUTH PLAIN LOGIN\r\n"
+            send_data "250-AUTH PLAIN\r\n"
           end
           send_data "250-NO-SOLICITING\r\n"
           # TODO, size needs to be configurable.
@@ -259,14 +340,14 @@ module EventMachine
       def process_auth str
         if @state.include?(:auth)
           send_data "503 auth already issued\r\n"
-        elsif str =~ /\APLAIN\s+/i
-          plain = ($'.dup).unpack("m").first # Base64::decode64($'.dup)
-          discard,user,psw = plain.split("\000")
-          if receive_plain_auth user,psw
-            send_data "235 authentication ok\r\n"
-            @state << :auth
+        elsif str =~ /\APLAIN\s?/i
+          if $'.length == 0
+            # we got a partial response, so let the client know to send the rest
+            @state << :auth_incomplete
+            send_data("334 \r\n")
           else
-            send_data "535 invalid authentication\r\n"
+            # we got the initial response, so go ahead & process it
+            process_auth_line($')
           end
           #elsif str =~ /\ALOGIN\s+/i
         else
@@ -274,6 +355,18 @@ module EventMachine
         end
       end
 
+      def process_auth_line(line)
+        plain = line.unpack("m").first
+        _,user,psw = plain.split("\000")
+        if receive_plain_auth user,psw
+          send_data "235 authentication ok\r\n"
+          @state << :auth
+        else
+          send_data "535 invalid authentication\r\n"
+        end
+        @state.delete :auth_incomplete
+      end
+
       #--
       # Unusually, we can deal with a Deferrable returned from the user application.
       # This was added to deal with a special case in a particular application, but

data/lib/em/protocols/stomp.rb

@@ -64,12 +64,14 @@ module EventMachine
         # Body of the message
         attr_accessor :body
 
-        def initialize # :nodoc:
+        # @private
+        def initialize
           @header = {}
           @state = :precommand
           @content_length = nil
         end
-        def consume_line line # :nodoc:
+        # @private
+        def consume_line line
           if @state == :precommand
             unless line =~ /\A\s*\Z/
               @command = line
@@ -100,19 +102,19 @@ module EventMachine
         end
       end
 
-      # :stopdoc:
-
+      # @private
       def send_frame verb, headers={}, body=""
         ary = [verb, "\n"]
         headers.each {|k,v| ary << "#{k}:#{v}\n" }
         ary << "content-length: #{body.to_s.length}\n"
-        ary << "content-type: text/plain; charset=UTF-8\n"
+        ary << "content-type: text/plain; charset=UTF-8\n" unless headers.has_key? 'content-type'
         ary << "\n"
         ary << body.to_s
         ary << "\0"
         send_data ary.join
       end
 
+      # @private
       def receive_line line
         @stomp_initialized || init_message_reader
         @stomp_message.consume_line(line) {|outcome|
@@ -127,12 +129,14 @@ module EventMachine
         }
       end
 
+      # @private
       def receive_binary_data data
         @stomp_message.body = data[0..-2]
         receive_msg(@stomp_message) if respond_to?(:receive_msg)
         init_message_reader
       end
 
+      # @private
       def init_message_reader
         @stomp_initialized = true
         set_delimiter "\n"
@@ -140,8 +144,6 @@ module EventMachine
         @stomp_message = Message.new
       end
 
-      # :startdoc:
-
       # Invoked with an incoming Stomp::Message received from the STOMP server
       def receive_msg msg
         # stub, overwrite this in your handler

data/lib/em/protocols/tcptest.rb

@@ -27,7 +27,8 @@
 module EventMachine
   module Protocols
 
-    class TcpConnectTester < Connection # :nodoc:
+    # @private
+    class TcpConnectTester < Connection
       include EventMachine::Deferrable
 
       def self.test( host, port )
@@ -50,4 +51,4 @@ module EventMachine
     end
 
   end
-end
+end

data/lib/em/protocols.rb

@@ -5,7 +5,7 @@ module EventMachine
   # - Memcache
   # - SmtpClient and SmtpServer
   # - SASLauth and SASLauthclient
-  # - LineAndTextProtocol and LineText2
+  # - LineProtocol, LineAndTextProtocol and LineText2
   # - HeaderAndContentProtocol
   # - Postgres3
   # - ObjectProtocol