arpie 0.0.4 → 0.0.5

data/lib/arpie/error.rb

@@ -0,0 +1,39 @@
+module Arpie
+
+  # Raised by arpie when a Protocol thinks the stream got corrupted
+  # (by calling bogon!).
+  # This usually results in a dropped connection.
+  class StreamError < IOError ; end
+  # Raised by arpie when a Protocol needs more data to parse a packet.
+  # Usually only of relevance to the programmer when using Protocol#from directly.
+  class EIncomplete < RuntimeError ; end
+
+  # :stopdoc:
+  # Used internally by arpie.
+  class ETryAgain < RuntimeError ; end
+  class YieldResult < RuntimeError
+    attr_reader :result
+    def initialize result
+      @result = result
+    end
+  end
+  # :startdoc:
+
+  # Call this if you think the stream has been corrupted, or
+  # non-protocol data arrived.
+  # +message+ is the text to display.
+  # +data+ is the optional misbehaving data for printing.
+  # This breaks out of the caller.
+  def bogon! data = nil, message = nil
+    raise StreamError, "#{self.is_a?(Class) ? self.to_s : self.class.to_s}:" +
+      " BOGON#{data.nil? ? "" : " " + data.inspect}" +
+      "#{message.nil? ? "" : " -- #{message}" }"
+  end
+
+  # Tell the caller that the given chunk of data
+  # is not enough to construct a whole message.
+  # This breaks out of the caller.
+  def incomplete!
+    raise EIncomplete, "#{self.is_a?(Class) ? self : self.class} needs more data"
+  end
+end

data/lib/arpie/protocol.rb

@@ -1,28 +1,9 @@
 require 'shellwords'
 require 'yaml'
+require 'zlib'
 
 module Arpie
   MTU = 1024
-  # Raised by arpie when a Protocol thinks the stream got corrupted
-  # (by calling stream_error!).
-  # This usually results in a dropped connection.
-  class StreamError < IOError ; end
-  # Raised by arpie when a Protocol needs more data to parse a packet.
-  # Usually only of relevance to the programmer when using Protocol#from directly.
-  class EIncomplete < RuntimeError ; end
-
-  # :stopdoc:
-  # Used internally by arpie.
-  class ESwallow < RuntimeError ; end
-  class ETryAgain < RuntimeError ; end
-  class YieldResult < RuntimeError
-    attr_reader :result
-    def initialize result
-      @result = result
-    end
-  end
-  # :startdoc:
-
   # A RPC call. You need to wrap all calls sent over RPC protocols in this.
   class RPCall < Struct.new(:ns, :meth, :argv, :uuid); end
 
@@ -30,6 +11,7 @@ module Arpie
   # list, into which io data can be fed and parsed packets received; and
   # vice versa.
   class ProtocolChain
+    include Arpie
 
     # Array of Protocols.
     attr_reader :chain
@@ -67,9 +49,18 @@ module Arpie
     # Convert the given +message+ to wire format by
     # passing it through all protocols in the chain.
     def to message
-      ret = @chain.inject(message) {|msg, p|
-        p.to(msg)
+      messages = [message]
+      @chain.each {|p|
+        for_next = []
+        messages.each {|msg|
+          p.to(msg) do |a|
+            for_next << a
+          end
+        }
+
+        messages = for_next
       }
+      messages
     end
 
     # Convert the given +binary+ to message format
@@ -106,56 +97,54 @@ module Arpie
         cut_to_index = nil
         messages_for_next = []
 
-        messages.each do |message|
+        messages.each_with_index do |message, m_index|
           cut_to_index = p.from(message) do |object|
             messages_for_next << object
           end rescue case $!
-
             when YieldResult
               messages_for_next.concat($!.result)
               next
 
-            when ESwallow
-              messages.delete(message)
-              messages_for_next = messages
-              p_index -= 1
-              break
-
             when EIncomplete
-              # All protocols above the io one need to wait for each
-              # one above to yield more messages.
-              if p_index > 0
-                # Unwind to the parent protocol and let it read in some
-                # more messages ..
-                messages_for_next = messages
-                messages_for_next.shift
-                p_index -= 1
-                break
-
-              # The first protocol manages +io+.
+              if messages.size - 1 - m_index > 0
+                next
               else
-                select([io])
-                @buffer << io.readpartial(MTU) rescue raise $!.class,
-                  "#{$!.to_s}; unparseable bytes remaining in buffer: #{@buffer.size}"
-                retry
+                raise
               end
 
-            when ETryAgain
+            else
+              raise
+          end
+        end rescue case $!
+          when EIncomplete
+            if p_index == 0
+              select([io])
+              @buffer << io.readpartial(MTU) rescue raise $!.class,
+                "#{$!.to_s}; unparseable bytes remaining in buffer: #{@buffer.size}"
               retry
 
             else
-              raise
-          end # rescue case
-        end # messages.each
+              p_index = 0
+              messages_for_next = []
+              messages = [@buffer]
+              next # of loop protocol chain
+            end
 
-         raise "BUG: #{p.class.to_s}#from did not yield a message." if
-           messages_for_next.size == 0
+          else
+            raise
+        end
+
+        if messages_for_next.size == 0
+          # Get back to IO level and retry reading more crud
+          messages_for_next = [@buffer]
+          p_index = -1
+        end
 
         messages = messages_for_next
 
         if p_index == 0
           if cut_to_index.nil? || cut_to_index < 0
-            raise "Protocol '#{p.class.to_s}'implementation faulty: " +
+            raise "Protocol '#{p.class.to_s}' implementation faulty: " +
               "from did return an invalid cut index: #{cut_to_index.inspect}."
           else
             @buffer[0, cut_to_index] = ""
@@ -163,16 +152,18 @@ module Arpie
         end
 
         p_index += 1
-      end # chain loop
+      end # loop chain
 
       message = messages.shift
       @messages = messages
       message
     end
 
+
     # Write +message+ to +io+.
-    def write_message io, message
-      io.write(to message)
+    def write_message io, *messages
+      binary = messages.map {|m| to(m)}
+      io.write(binary)
     end
 
     def reset
@@ -183,17 +174,25 @@ module Arpie
   # A Protocol converts messages (which are arbitary objects)
   # to a suitable on-the-wire format, and back.
   class Protocol
+    include Arpie
 
     # Set this to true in child classes which implement
     # message separation within a stream.
     CAN_SEPARATE_MESSAGES = false
 
+    # :stopdoc:
+    # The stowbuffer hash used by assemble! No need to touch this, usually.
+    attr_reader :stowbuffer
+    # The meta-information hash used by assemble! No need to touch this, usually.
+    attr_reader :metabuffer
+    # :startdoc:
+
     # Convert obj to on-the-wire format.
     def to obj
-      obj
+      yield obj
     end
 
-    # Extract message(s) from +binary+.i
+    # Extract message(s) from +binary+.
     #
     # Yields each message found, with all protocol-specifics stripped.
     #
@@ -219,74 +218,55 @@ module Arpie
       raise ETryAgain
     end
 
-    # Tell the protocol chain that the given chunk of data
-    # is not enough to construct a whole message.
-    # This breaks out of Protocol#from.
-    def incomplete!
-      raise EIncomplete
-    end
-
-    # Swallow the complete message currently passed to Protocol#from.
-    # Not advised for the outermost protocol, which works on io buffer streams
-    # and may swallow more than intended.
-    def gulp!
-      raise ESwallow
-    end
-    alias_method :swallow!, :gulp!
-
     # Stow away a message in this protocols buffer for later reassembly.
     # Optional argument: a token if you are planning to reassemble multiple
     # interleaved/fragmented message streams.
     #
+    # If you pass a block, that block will be called; if no block is given,
+    # Protocol#assemble will be invoked.
+    #
+    # Any leftover binaries passed into assemble! that get not returned in
+    # the assembler will be discarded; they are assumed to be syntax or framework.
+    #
     # +binary+   is the binary packet you want to add to the assembly
-    # +token+    is a object which can be used to re-identify multiple concurrent assemblies
+    # +token+    is a object which can be used to identify multiple concurrent assemblies (think Hash.keys)
     # +meta+     is a hash containing meta-information for this assembly
     #            each call to assemble! will merge these hashes, and pass them
     #            on to Protocol#assemble
-    def assemble! binary, token = :default, meta = {}
+    def assemble! binary, token = :default, meta = {} # :yields: binaries, metadata
       @stowbuffer ||= {}
       @stowbuffer[token] ||= []
       @stowbuffer[token] << binary
 
       @metabuffer ||= {}
       @metabuffer[token] ||= {}
-      @metabuffer[token].merge(meta)
-
-      assembled = []
-
-      assemble @stowbuffer[token], token, meta do |a|
-        assembled << a
-      end  # rescue case $!
-        #when EIncomplet
-        #  puts "Cant reassemble, asking for moarh"
-        #  raise EIncomplete
-        #else
-        #  raise
-      #end
-
-      assembled.size > 0 or raise "assemble! did not return any results."
-      raise YieldResult, assembled
+      @metabuffer[token].merge!(meta)
+
+      assembled = nil
+
+      if block_given?
+        assembled = yield(@stowbuffer[token], @metabuffer[token])
+
+      else
+        # This raises EIncomplete when not enough messages are there,
+        # and passes it straight on to #read_message
+        assembled = assemble(@stowbuffer[token], @metabuffer[token])
+      end
+
+      @stowbuffer.delete(token)
+      @metabuffer.delete(token)
+      raise YieldResult, [assembled]
     end
 
     # Called when we're trying to reassemble a stream of packets.
     #
     # Call incomplete! when not enough data is here to reassemble this stream,
     # and yield all results of the reassembled stream.
-    def assemble binaries, token
+    def assemble binaries, meta
       raise NotImplementedError, "Tried to assemble! something, but no assembler defined."
     end
-
-    # Call this if you think the stream has been corrupted, or
-    # non-protocol data arrived.
-    # +message+ is the text to display.
-    # +data+ is the optional misbehaving data for printing.
-    # This breaks out of Protocol#from.
-    def bogon! data = nil, message = nil
-      raise StreamError, "#{self.class.to_s}#{message.nil? ? " thinks the data is bogus" : ": " + message }#{data.nil? ? "" : ": " + data.inspect}."
-    end
   end
 
-
   # A sample binary protocol, which simply prefixes each message with the
   # size of the data to be expected.
   class SizedProtocol < Protocol
@@ -300,7 +280,7 @@ module Arpie
     end
 
     def to object
-      [object.size, object].pack('Qa*')
+      yield [object.size, object].pack('Qa*')
     end
   end
 
@@ -310,7 +290,7 @@ module Arpie
   # Messages are arbitary objects.
   class MarshalProtocol < Protocol
     def to object
-      Marshal.dump(object)
+      yield Marshal.dump(object)
     end
 
     def from binary
@@ -336,7 +316,7 @@ module Arpie
     end
 
     def to object
-      object.to_s + @separator
+      yield object.to_s + @separator
     end
   end
 
@@ -347,7 +327,7 @@ module Arpie
     def to object
       raise ArgumentError, "#{self.class.to_s} can only encode arrays." unless
         object.is_a?(Array)
-      Shellwords.join(object.map {|x| x.to_s })
+      yield Shellwords.join(object.map {|x| x.to_s })
     end
 
     def from binary
@@ -361,7 +341,7 @@ module Arpie
     CAN_SEPARATE_MESSAGES = true
 
     def to object
-      YAML.dump(object) + "...\n"
+      yield YAML.dump(object) + "...\n"
     end
 
     def from binary
@@ -370,4 +350,21 @@ module Arpie
       4 + index
     end
   end
+
+  # A transparent zlib stream de/compression protocol.
+  class ZlibProtocol < Protocol
+    def initialize
+      @inflater = Zlib::Inflate.new
+      @deflater = Zlib::Deflate.new
+    end
+
+    def to object
+      yield @deflater.deflate(object) + @deflater.flush
+    end
+
+    def from binary
+      yield @inflater.inflate(binary)
+      binary.size
+    end
+  end
 end

data/lib/arpie/xmlrpc.rb

@@ -29,7 +29,7 @@ module Arpie
       raise ArgumentError, "Can only encode Arpie::RPCall" unless
         object.is_a?(Arpie::RPCall)
 
-      @writer.methodCall((object.ns.nil? ? '' : object.ns + '.') + object.meth, *object.argv)
+      yield @writer.methodCall((object.ns.nil? ? '' : object.ns + '.') + object.meth, *object.argv)
     end
 
     def from binary
@@ -43,7 +43,7 @@ module Arpie
 
     def to object
       setup
-      case object
+      yield case object
         when Exception
           # TODO: wrap XMLFault
           raise NotImplementedError, "Cannot encode exceptions"
@@ -93,7 +93,7 @@ module Arpie
     public_class_method :new
 
     def to object
-      "GET / HTTP/1.[01]\r\nContent-Length: #{object.size}\r\n\r\n" + object
+      yield "GET / HTTP/1.[01]\r\nContent-Length: #{object.size}\r\n\r\n" + object
     end
  
   end
@@ -102,7 +102,7 @@ module Arpie
     public_class_method :new
 
     def to object
-      "HTTP/1.0 200 OK\r\nContent-Length: #{object.size}\r\n\r\n" + object
+      yield "HTTP/1.0 200 OK\r\nContent-Length: #{object.size}\r\n\r\n" + object
     end
   end
 end

data/lib/arpie.rb

@@ -1,4 +1,6 @@
+require 'arpie/error'
 require 'arpie/protocol'
+require 'arpie/binary'
 require 'arpie/xmlrpc'
 require 'arpie/server'
 require 'arpie/client'

data/spec/protocol_merge_and_split_spec.rb

@@ -3,25 +3,35 @@ require File.join(File.dirname(__FILE__), 'spec_helper')
 class Splitter < Arpie::Protocol
   def from binary
     yield binary.size
+
     binary.each_char do |c|
       yield c
     end
   end
 end
 
-class Merger < Arpie::Protocol
+class BufferedSplitter < Arpie::Protocol
   def from binary
-    unless @expect
-      @expect = binary or incomplete!
-      gulp!
+    unless defined? @buf
+      yield binary.size * 2
+      @buf = true
     end
 
-    assemble! binary, :d, :size => @expect
+    binary.each_char do |c|
+      yield c
+    end
   end
+end
 
-  def assemble binaries, token, meta
-    binaries.size >= meta[:size] or incomplete!
-    yield binaries.join('')
+
+class Merger < Arpie::Protocol
+  def from binary
+    assemble! binary do |binaries, meta|
+      binaries.size >= 1 or incomplete!
+      binaries.size - 1 >= binaries[0].to_i or incomplete!
+      binaries.shift
+      binaries.join('')
+    end
   end
 end
 
@@ -45,3 +55,13 @@ describe "Merger::Splitter::Sized" do subject { [Merger, Splitter, Arpie::SizedP
     chain_read.should == t
   end
 end
+
+describe "Merger::BufferedSplitter::Sized" do subject { [Merger, BufferedSplitter, Arpie::SizedProtocol] }
+  it_should_behave_like "ProtocolChainSetup"
+
+  it "should re-read io for more data if assembly fails" do
+    @chain.write_message(@w, "split")
+    Thread.new { sleep 0.1; @chain.write_message(@w, "split") }
+    chain_read.should == "splitsplit"
+  end
+end

data/spec/protocol_spec.rb

@@ -112,6 +112,10 @@ describe "Sized::Marshal::Sized" do subject { [Arpie::SizedProtocol, Arpie::Mars
   it_should_behave_like "ProtocolChain"
 end
 
+describe "Zlib::Marshal::Sized" do subject { [Arpie::ZlibProtocol, Arpie::MarshalProtocol, Arpie::SizedProtocol] }
+  it_should_behave_like "ProtocolChain"
+end
+
 # Shellwords is a bit of a special case, because it only encodes arrays.
 describe "Shellwords::Separator" do subject { [Arpie::ShellwordsProtocol, Arpie::SeparatorProtocol] }
   it_should_behave_like "ProtocolChain"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: arpie
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Bernhard Stoeckner
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-16 00:00:00 +01:00
+date: 2009-02-24 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,25 +31,29 @@ extensions: []
 extra_rdoc_files: 
 - README
 - COPYING
+- BINARY_SPEC
 files: 
 - COPYING
 - README
 - Rakefile
-- spec/rcov.opts
-- spec/protocol_merge_and_split_spec.rb
-- spec/spec_helper.rb
 - spec/protocol_spec.rb
 - spec/spec.opts
+- spec/spec_helper.rb
+- spec/protocol_merge_and_split_spec.rb
+- spec/rcov.opts
 - spec/client_server_spec.rb
+- lib/arpie.rb
 - lib/arpie
-- lib/arpie/proxy.rb
-- lib/arpie/xmlrpc.rb
 - lib/arpie/client.rb
+- lib/arpie/error.rb
 - lib/arpie/protocol.rb
+- lib/arpie/binary.rb
+- lib/arpie/proxy.rb
+- lib/arpie/xmlrpc.rb
 - lib/arpie/server.rb
-- lib/arpie.rb
 - tools/benchmark.rb
 - tools/protocol_benchmark.rb
+- BINARY_SPEC
 has_rdoc: true
 homepage: http://arpie.elv.es
 post_install_message: