RocketAMF 0.0.7 → 0.1.0

data/README.rdoc

@@ -1,51 +1,23 @@
 == DESCRIPTION:
 
-A fast AMF serializer/deserializer and request/response wrappers to simplify remoting implementation.
+RocketAMF is a full featured AMF0/3 serializer and deserializer with support for
+Flash -> Ruby and Ruby -> Flash class mapping, custom serializers, remoting
+gateway helpers that follow AMF0/3 messaging specs, and a suite of specs to
+ensure adherence to the specification documents put out by Adobe.
 
 == INSTALL:
 
   gem install RocketAMF --source="http://gemcutter.org"
 
-== EXAMPLE:
-
-  # helloworld.ru
+== SIMPLE EXAMPLE:
 
   require 'rocketamf'
 
-  class HelloWorldApp
-    APPLICATION_AMF = 'application/x-amf'.freeze
-
-    def call env
-      if is_amf?(env)
-        # Wrap request and response
-        env['rack.input'].rewind
-        request = RocketAMF::Request.new.populate_from_stream(env['rack.input'].read)
-        response = RocketAMF::Response.new
-
-        # Handle request
-        response.each_method_call request do |method, args|
-          raise "Service #{method} does not exists" unless method == 'App.helloWorld'
-          'Hello world'
-        end
-
-        # Pass back response
-        response_str = response.serialize
-        return [200, {'Content-Type' => APPLICATION_AMF, 'Content-Length' => response_str.length.to_s}, [response_str]]
-      else
-        return [200, {'Content-Type' => 'text/plain', 'Content-Length' => '16' }, ["Rack AMF gateway"]]
-      end
-    end
-
-    private
-    def is_amf? env
-      return false unless env['CONTENT_TYPE'] == APPLICATION_AMF
-      return false unless env['PATH_INFO'] == '/amf'
-      return true
-    end
+  hash = {:apple => "Apfel", :red => "Rot", :eyes => "Augen"}
+  File.open("amf.dat", 'w') do |f|
+    f.write RocketAMF.serialize(hash, 3) # Use AMF3 encoding because it's smaller
   end
 
-  run HelloWorldApp.new
-
 == LICENSE:
 
 (The MIT License)

data/Rakefile

@@ -23,8 +23,8 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name    = 'RocketAMF'
-  s.version = '0.0.7'
-  s.summary = 'Fast AMF serializer/deserializer and request/response wrappers to simplify remoting implementation'
+  s.version = '0.1.0'
+  s.summary = 'Fast AMF serializer/deserializer with remoting request/response wrappers to simplify integration'
 
   s.files        = FileList['README.rdoc', 'Rakefile', 'lib/**/*.rb', 'spec/**/*.rb', 'spec/**/*.bin', 'spec/spec.opts']
   s.require_path = 'lib'
@@ -34,7 +34,7 @@ spec = Gem::Specification.new do |s|
   s.extra_rdoc_files = ['README.rdoc']
   s.rdoc_options     = ['--line-numbers', '--main', 'README.rdoc']
 
-  s.authors  = ['Tony Hillerson', 'Stephen Augenstein']
+  s.authors  = ['Jacob Henry', 'Stephen Augenstein']
   s.email    = 'perl.programmer@gmail.com'
   s.homepage = 'http://github.com/warhammerkid/rocket-amf'
 

data/lib/rocketamf.rb

@@ -1,11 +1,77 @@
 $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 $:.unshift "#{File.expand_path(File.dirname(__FILE__))}/rocketamf/"
 
-require 'rocketamf/version'
 require 'rocketamf/class_mapping'
 require 'rocketamf/constants'
 require 'rocketamf/remoting'
 
+# RocketAMF is a full featured AMF0/3 serializer and deserializer with support
+# for Flash -> Ruby and Ruby -> Flash class mapping, custom serializers,
+# remoting gateway helpers that follow AMF0/3 messaging specs, and a suite of
+# specs to ensure adherence to the specification documents put out by Adobe.
+#
+# == Serialization & Deserialization
+#
+# RocketAMF provides two main methods - <tt>RocketAMF.serialize(obj, amf_version=0)</tt>
+# and <tt>RocketAMF.deserialize(source, amf_version=0)</tt>. To use, simple pass
+# in the string to deserialize and the version if different from the default. To
+# serialize an object, simply call <tt>RocketAMF.serialize</tt> with the object
+# and the proper version. If you're working only with AS3, it is more effiecient
+# to use the version 3 encoding, as it caches duplicate string to reduce
+# serialized size. However for greater compatibility the default, AMF version 0,
+# should work fine.
+#
+# == Mapping Classes Between Flash and Ruby
+#
+# RocketAMF provides a simple class mapping tool to facilitate serialization and
+# deserialization of typed objects. Refer to the documentation of
+# <tt>RocketAMF::ClassMapping</tt> for more details. If the provided class
+# mapping tool is not sufficient for your needs, you also have the option to
+# replace it with a class mapper of your own devising that matches the documented
+# API.
+#
+# == Remoting
+#
+# You can use RocketAMF bare to write an AMF gateway using the following code.
+# In addition, you can use rack-amf (http://github.com/warhammerkid/rack-amf)
+# which simplifies the code necessary to set up a functioning AMF gateway.
+#
+#   # helloworld.ru
+#   require 'rocketamf'
+#
+#   class HelloWorldApp
+#     APPLICATION_AMF = 'application/x-amf'.freeze
+#
+#     def call env
+#       if is_amf?(env)
+#         # Wrap request and response
+#         env['rack.input'].rewind
+#         request = RocketAMF::Request.new.populate_from_stream(env['rack.input'].read)
+#         response = RocketAMF::Response.new
+#
+#         # Handle request
+#         response.each_method_call request do |method, args|
+#           raise "Service #{method} does not exists" unless method == 'App.helloWorld'
+#           'Hello world'
+#         end
+#
+#         # Pass back response
+#         response_str = response.serialize
+#         return [200, {'Content-Type' => APPLICATION_AMF, 'Content-Length' => response_str.length.to_s}, [response_str]]
+#       else
+#         return [200, {'Content-Type' => 'text/plain', 'Content-Length' => '16' }, ["Rack AMF gateway"]]
+#       end
+#     end
+#
+#     private
+#     def is_amf? env
+#       return false unless env['CONTENT_TYPE'] == APPLICATION_AMF
+#       return false unless env['PATH_INFO'] == '/amf'
+#       return true
+#     end
+#   end
+#
+#   run HelloWorldApp.new
 module RocketAMF
   begin
     raise LoadError, 'C extensions not implemented'
@@ -40,7 +106,7 @@ module RocketAMF
   # We use const_missing to define the active ClassMapper at runtime. This way,
   # heavy modification of class mapping functionality is still possible without
   # forcing extenders to redefine the constant.
-  def self.const_missing const
+  def self.const_missing const #:nodoc:
     if const == :ClassMapper
       RocketAMF.const_set(:ClassMapper, RocketAMF::ClassMapping.new)
     else

data/lib/rocketamf/class_mapping.rb

@@ -3,8 +3,6 @@ require 'rocketamf/values/array_collection'
 require 'rocketamf/values/messages'
 
 module RocketAMF
-  # == Class Mapping
-  #
   # Handles class name mapping between actionscript and ruby and assists in
   # serializing and deserializing data between them. Simply map an AS class to a
   # ruby class and when the object is (de)serialized it will end up as the
@@ -29,8 +27,6 @@ module RocketAMF
   # Populators are processed in insert order and must respond to the <tt>can_handle?</tt>
   # and <tt>populate</tt> methods.
   #
-  # Example:
-  #
   #   class CustomPopulator
   #     def can_handle? obj
   #       true
@@ -43,11 +39,10 @@ module RocketAMF
   #   end
   #   RocketAMF::ClassMapper.object_populators << CustomPopulator.new
   #
+  #
   # Serializers are also processed in insert order and must respond to the
   # <tt>can_handle?</tt> and <tt>serialize</tt> methods.
   #
-  # Example:
-  #
   #   class CustomSerializer
   #     def can_handle? obj
   #       true
@@ -65,7 +60,9 @@ module RocketAMF
   # mapping completely. In this case, simply assign an instance of your own class
   # mapper to <tt>RocketAMF::ClassMapper</tt> after loading RocketAMF. Through
   # the magic of <tt>const_missing</tt>, <tt>ClassMapper</tt> is only defined after
-  # the first access by default, so you get no annoying warning messages.
+  # the first access by default, so you get no annoying warning messages. Custom
+  # class mappers must implement the following methods: <tt>get_as_class_name</tt>,
+  # <tt>get_ruby_obj</tt>, <tt>populate_ruby_obj</tt>, <tt>props_for_serialization</tt>.
   #
   # Example:
   #
@@ -163,7 +160,8 @@ module RocketAMF
     end
 
     # Instantiates a ruby object using the mapping configuration based on the
-    # source AS class name. If there is no mapping defined, it returns a hash.
+    # source AS class name. If there is no mapping defined, it returns a
+    # <tt>RocketAMF::Values::TypedHash</tt> with the serialized class name.
     def get_ruby_obj as_class_name
       ruby_class_name = mappings.get_ruby_class_name as_class_name
       if ruby_class_name.nil?
@@ -220,7 +218,7 @@ module RocketAMF
       (ruby_obj.public_methods - @ignored_props).each do |method_name|
         # Add them to the prop hash if they take no arguments
         method_def = ruby_obj.method(method_name)
-        props[method_name] = ruby_obj.send(method_name) if method_def.arity == 0
+        props[method_name.to_s] = ruby_obj.send(method_name) if method_def.arity == 0
       end
       props
     end

data/lib/rocketamf/constants.rb

@@ -33,11 +33,10 @@ module RocketAMF
   AMF3_OBJECT_MARKER       =  0x0A #"\n"
   AMF3_XML_MARKER          =  0x0B #"\v"
   AMF3_BYTE_ARRAY_MARKER   =  0x0C #"\f"
+  AMF3_DICT_MARKER         =  0x11 #"\021"
 
   # Other AMF3 Markers
   AMF3_EMPTY_STRING             = 0x01
-  AMF3_ANONYMOUS_OBJECT         = 0x01
-  AMF3_DYNAMIC_OBJECT           = 0x0B
   AMF3_CLOSE_DYNAMIC_OBJECT     = 0x01
   AMF3_CLOSE_DYNAMIC_ARRAY      = 0x01
 

data/lib/rocketamf/pure/deserializer.rb

@@ -39,7 +39,7 @@ module RocketAMF
         when AMF0_UNSUPPORTED_MARKER
           nil
         when AMF0_XML_MARKER
-          #read_xml source
+          read_string source, true
         when AMF0_TYPED_OBJECT_MARKER
           read_typed_object source
         when AMF0_AMF3_MARKER
@@ -63,7 +63,9 @@ module RocketAMF
 
       def read_string source, long=false
         len = long ? read_word32_network(source) : read_word16_network(source)
-        source.read(len)
+        str = source.read(len)
+        str.force_encoding("UTF-8") if str.respond_to?(:force_encoding)
+        str
       end
 
       def read_object source, add_to_ref_cache=true
@@ -180,18 +182,18 @@ module RocketAMF
           read_number source
         when AMF3_STRING_MARKER
           read_string source
-        when AMF3_XML_DOC_MARKER
-          #read_xml_string
+        when AMF3_XML_DOC_MARKER, AMF3_XML_MARKER
+          read_xml source
         when AMF3_DATE_MARKER
           read_date source
         when AMF3_ARRAY_MARKER
           read_array source
         when AMF3_OBJECT_MARKER
           read_object source
-        when AMF3_XML_MARKER
-          #read_amf3_xml
         when AMF3_BYTE_ARRAY_MARKER
           read_amf3_byte_array source
+        when AMF3_DICT_MARKER
+          read_dict source
         else
           raise AMFError, "Invalid type: #{type}"
         end
@@ -245,12 +247,32 @@ module RocketAMF
           str = ""
           if length > 0
             str = source.read(length)
+            str.force_encoding("UTF-8") if str.respond_to?(:force_encoding)
             @string_cache << str
           end
           return str
         end
       end
 
+      def read_xml source
+        type = read_integer source
+        isReference = (type & 0x01) == 0
+
+        if isReference
+          reference = type >> 1
+          return @object_cache[reference]
+        else
+          length = type >> 1
+          str = ""
+          if length > 0
+            str = source.read(length)
+            str.force_encoding("UTF-8") if str.respond_to?(:force_encoding)
+            @object_cache << str
+          end
+          return str
+        end
+      end
+
       def read_amf3_byte_array source
         type = read_integer source
         isReference = (type & 0x01) == 0
@@ -314,37 +336,39 @@ module RocketAMF
 
           if class_is_reference
             reference = class_type >> 1
-            class_definition = @trait_cache[reference]
+            traits = @trait_cache[reference]
           else
-            class_name = read_string source
             externalizable = (class_type & 0x02) != 0
             dynamic = (class_type & 0x04) != 0
             attribute_count = class_type >> 3
+            class_name = read_string source
 
             class_attributes = []
             attribute_count.times{class_attributes << read_string(source)} # Read class members
 
-            class_definition = {"class_name" => class_name,
-                                "members" => class_attributes,
-                                "externalizable" => externalizable,
-                                "dynamic" => dynamic}
-            @trait_cache << class_definition
+            traits = {
+                      :class_name => class_name,
+                      :members => class_attributes,
+                      :externalizable => externalizable,
+                      :dynamic => dynamic
+                     }
+            @trait_cache << traits
           end
 
-          obj = RocketAMF::ClassMapper.get_ruby_obj class_definition["class_name"]
+          obj = RocketAMF::ClassMapper.get_ruby_obj traits[:class_name]
           @object_cache << obj
 
-          if class_definition['externalizable']
+          if traits[:externalizable]
             obj.externalized_data = deserialize(source)
           else
             props = {}
-            class_definition['members'].each do |key|
+            traits[:members].each do |key|
               value = deserialize(source)
               props[key.to_sym] = value
             end
 
             dynamic_props = nil
-            if class_definition['dynamic']
+            if traits[:dynamic]
               dynamic_props = {}
               while (key = read_string source) && key.length != 0  do # read next key
                 value = deserialize(source)
@@ -371,6 +395,25 @@ module RocketAMF
           time
         end
       end
+
+      def read_dict source
+        type = read_integer source
+        # Currently duplicate dictionaries send false, but I'll leave this in here just in case
+        isReference = (type & 0x01) == 0
+        if isReference
+          reference = type >> 1
+          return @object_cache[reference]
+        else
+          dict = {}
+          @object_cache << dict
+          length = type >> 1
+          skip = read_integer source # TODO: Handle when specs are updated
+          0.upto(length - 1) do |i|
+            dict[deserialize(source)] = deserialize(source)
+          end
+          dict
+        end
+      end
     end
   end
 end

data/lib/rocketamf/pure/remoting.rb

@@ -20,6 +20,7 @@ module RocketAMF
         header_count = read_word16_network stream
         0.upto(header_count-1) do
           name = stream.read(read_word16_network(stream))
+          name.force_encoding("UTF-8") if name.respond_to?(:force_encoding)
           must_understand = read_int8(stream) != 0
           length = read_word32_network stream
           data = RocketAMF.deserialize stream
@@ -30,7 +31,9 @@ module RocketAMF
         message_count = read_word16_network stream
         0.upto(message_count-1) do
           target_uri = stream.read(read_word16_network(stream))
+          target_uri.force_encoding("UTF-8") if target_uri.respond_to?(:force_encoding)
           response_uri = stream.read(read_word16_network(stream))
+          response_uri.force_encoding("UTF-8") if response_uri.respond_to?(:force_encoding)
           length = read_word32_network stream
           data = RocketAMF.deserialize stream
           if data.is_a?(Array) && data.length == 1 && data[0].is_a?(::RocketAMF::Values::AbstractMessage)
@@ -58,8 +61,10 @@ module RocketAMF
         # Write headers
         stream << pack_int16_network(@headers.length) # Header count
         @headers.each do |h|
-          stream << pack_int16_network(h.name.length)
-          stream << h.name
+          name_str = h.name
+          name_str.encode!("UTF-8").force_encoding("ASCII-8BIT") if name_str.respond_to?(:encode)
+          stream << pack_int16_network(name_str.bytesize)
+          stream << name_str
           stream << pack_int8(h.must_understand ? 1 : 0)
           stream << pack_word32_network(-1)
           stream << RocketAMF.serialize(h.data, 0)
@@ -68,11 +73,15 @@ module RocketAMF
         # Write messages
         stream << pack_int16_network(@messages.length) # Message count
         @messages.each do |m|
-          stream << pack_int16_network(m.target_uri.length)
-          stream << m.target_uri
+          uri_str = m.target_uri
+          uri_str.encode!("UTF-8").force_encoding("ASCII-8BIT") if uri_str.respond_to?(:encode)
+          stream << pack_int16_network(uri_str.bytesize)
+          stream << uri_str
 
-          stream << pack_int16_network(m.response_uri.length)
-          stream << m.response_uri
+          uri_str = m.response_uri
+          uri_str.encode!("UTF-8").force_encoding("ASCII-8BIT") if uri_str.respond_to?(:encode)
+          stream << pack_int16_network(uri_str.bytesize)
+          stream << uri_str
 
           stream << pack_word32_network(-1)
           stream << AMF0_AMF3_MARKER if @amf_version == 3

data/lib/rocketamf/pure/serializer.rb

@@ -52,7 +52,8 @@ module RocketAMF
       end
 
       def write_string str, stream
-        len = str.length
+        str = str.encode("UTF-8").force_encoding("ASCII-8BIT") if str.respond_to?(:encode)
+        len = str.bytesize
         if len > 2**16-1
           stream << AMF0_LONG_STRING_MARKER
           stream << pack_word32_network(len)
@@ -100,8 +101,9 @@ module RocketAMF
         # Is it a typed object?
         class_name = RocketAMF::ClassMapper.get_as_class_name obj
         if class_name
+          class_name = class_name.encode("UTF-8").force_encoding("ASCII-8BIT") if class_name.respond_to?(:encode)
           stream << AMF0_TYPED_OBJECT_MARKER
-          stream << pack_int16_network(class_name.length)
+          stream << pack_int16_network(class_name.bytesize)
           stream << class_name
         else
           stream << AMF0_OBJECT_MARKER
@@ -116,7 +118,8 @@ module RocketAMF
         # Write prop list
         props = RocketAMF::ClassMapper.props_for_serialization obj
         props.sort.each do |key, value| # Sort keys before writing
-          stream << pack_int16_network(key.length)
+          key = key.encode("UTF-8").force_encoding("ASCII-8BIT") if key.respond_to?(:encode)
+          stream << pack_int16_network(key.bytesize)
           stream << key
           serialize value, stream
         end
@@ -134,6 +137,7 @@ module RocketAMF
       def initialize
         @string_cache = SerializerCache.new :string
         @object_cache = SerializerCache.new :object
+        @trait_cache = SerializerCache.new :trait
       end
 
       def version
@@ -159,6 +163,8 @@ module RocketAMF
           write_date obj, stream
         elsif obj.is_a?(StringIO)
           write_byte_array obj, stream
+        elsif obj.is_a?(RocketAMF::Values::ArrayCollection)
+          write_array_collection obj, stream
         elsif obj.is_a?(Array)
           write_array obj, stream
         elsif obj.is_a?(Hash) || obj.is_a?(Object)
@@ -229,6 +235,10 @@ module RocketAMF
         end
       end
 
+      def write_array_collection array, stream
+        write_object array, stream, {:class_name => RocketAMF::ClassMapper.get_as_class_name(array), :members => [], :externalizable => true, :dynamic => false}
+      end
+
       def write_array array, stream
         stream << AMF3_ARRAY_MARKER
         if @object_cache[array] != nil
@@ -248,7 +258,7 @@ module RocketAMF
         end
       end
 
-      def write_object obj, stream
+      def write_object obj, stream, traits=nil
         stream << AMF3_OBJECT_MARKER
         if @object_cache[obj] != nil
           write_reference @object_cache[obj], stream
@@ -256,26 +266,59 @@ module RocketAMF
           # Cache object
           @object_cache.add_obj obj
 
-          # Always serialize things as dynamic objects
-          stream << AMF3_DYNAMIC_OBJECT
+          # Calculate traits if not given
+          if traits.nil?
+            traits = {
+                      :class_name => RocketAMF::ClassMapper.get_as_class_name(obj),
+                      :members => [],
+                      :externalizable => false,
+                      :dynamic => true
+                     }
+          end
 
-          # Write class name/anonymous
-          class_name = RocketAMF::ClassMapper.get_as_class_name obj
-          if class_name
-            write_utf8_vr class_name, stream
+          # Write out traits
+          if traits[:class_name] && @trait_cache[traits] != nil
+            stream << pack_integer(@trait_cache[traits] << 2 | 0x01)
           else
-            stream << AMF3_ANONYMOUS_OBJECT
+            @trait_cache.add_obj traits if traits[:class_name]
+
+            # Write out trait header
+            header = 0x03 # Not object ref and not trait ref
+            header |= 0x02 << 2 if traits[:dynamic]
+            header |= 0x01 << 2 if traits[:externalizable]
+            header |= traits[:members].length << 4
+            stream << pack_integer(header)
+
+            # Write out class name
+            write_utf8_vr(traits[:class_name].to_s, stream)
+
+            # Write out members
+            traits[:members].each {|m| write_utf8_vr(m, stream)}
+          end
+
+          # If externalizable, take externalized data shortcut
+          if traits[:externalizable]
+            serialize obj.externalized_data, stream
+            return
           end
 
-          # Write out properties
+          # Write out sealed properties
           props = RocketAMF::ClassMapper.props_for_serialization obj
-          props.sort.each do |key, val| # Sort props until Ruby 1.9 becomes common
-            write_utf8_vr key.to_s, stream
-            serialize val, stream
+          traits[:members].each do |m|
+            serialize props[m], stream
+            props.delete(m)
           end
 
-          # Write close
-          stream << AMF3_CLOSE_DYNAMIC_OBJECT
+          if traits[:dynamic]
+            # Write out dynamic properties
+            props.sort.each do |key, val| # Sort props until Ruby 1.9 becomes common
+              write_utf8_vr key.to_s, stream
+              serialize val, stream
+            end
+
+            # Write close
+            stream << AMF3_CLOSE_DYNAMIC_OBJECT
+          end
         end
       end
 
@@ -283,6 +326,8 @@ module RocketAMF
       include RocketAMF::Pure::WriteIOHelpers
 
       def write_utf8_vr str, stream
+        str = str.encode("UTF-8").force_encoding("ASCII-8BIT") if str.respond_to?(:encode)
+
         if str == ''
           stream << AMF3_EMPTY_STRING
         elsif @string_cache[str] != nil
@@ -292,7 +337,7 @@ module RocketAMF
           @string_cache.add_obj str
 
           # Build AMF string
-          header = str.length << 1 # make room for a low bit of 1
+          header = str.bytesize << 1 # make room for a low bit of 1
           header = header | 1 # set the low bit to 1
           stream << pack_integer(header)
           stream << str
@@ -306,6 +351,8 @@ module RocketAMF
           StringCache.new
         elsif type == :object
           ObjectCache.new
+        elsif type == :trait
+          TraitCache.new
         end
       end
 
@@ -334,6 +381,21 @@ module RocketAMF
           @cache_index += 1
         end
       end
+
+      class TraitCache < Hash #:nodoc:
+        def initialize
+          @cache_index = 0
+        end
+
+        def [] obj
+          super(obj[:class_name])
+        end
+
+        def add_obj obj
+          self[obj[:class_name]] = @cache_index
+          @cache_index += 1
+        end
+      end
     end
   end
 end

data/lib/rocketamf/values/array_collection.rb

@@ -1,6 +1,10 @@
 module RocketAMF
   module Values #:nodoc:
     class ArrayCollection < Array
+      def externalized_data
+        [] + self # Duplicate as an array
+      end
+
       def externalized_data=(data)
         push(*data)
       end

data/spec/amf/class_mapping_spec.rb

@@ -1,14 +1,15 @@
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
-describe RocketAMF::ClassMapping do
-  before(:all) do
-    class ClassMappingTest
-      attr_accessor :prop_a
-      attr_accessor :prop_b
-      attr_accessor :prop_c
-    end
-  end
+class ClassMappingTest
+  attr_accessor :prop_a
+  attr_accessor :prop_b
+  attr_accessor :prop_c
+end
+class ClassMappingTest2 < ClassMappingTest; end;
 
+module ANamespace; class TestRubyClass; end; end
+
+describe RocketAMF::ClassMapping do
   before :each do
     @mapper = RocketAMF::ClassMapping.new
     @mapper.define do |m|
@@ -34,7 +35,6 @@ describe RocketAMF::ClassMapping do
     end
 
     it "should properly instantiate namespaced classes" do
-      module ANamespace; class TestRubyClass; end; end
       @mapper.define {|m| m.map :as => 'ASClass', :ruby => 'ANamespace::TestRubyClass'}
       @mapper.get_ruby_obj('ASClass').should be_a(ANamespace::TestRubyClass)
     end
@@ -110,7 +110,7 @@ describe RocketAMF::ClassMapping do
 
   describe "property extractor" do
     it "should extract hash properties" do
-      hash = {:a => 'test1', :b => 'test2'}
+      hash = {:a => 'test1', 'b' => 'test2'}
       props = @mapper.props_for_serialization(hash)
       props.should == {'a' => 'test1', 'b' => 'test2'}
     end
@@ -125,8 +125,6 @@ describe RocketAMF::ClassMapping do
     end
 
     it "should extract inherited object properties" do
-      class ClassMappingTest2 < ClassMappingTest
-      end
       obj = ClassMappingTest2.new
       obj.prop_a = 'Test A'
       obj.prop_b = 'Test B'

data/spec/amf/deserializer_spec.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 describe "when deserializing" do
@@ -18,7 +20,7 @@ describe "when deserializing" do
       output.should === true
     end
 
-    it "should deserialize strings" do
+    it "should deserialize UTF8 strings" do
       input = object_fixture('amf0-string.bin')
       output = RocketAMF.deserialize(input, 0)
       output.should == "this is a テスト"
@@ -74,7 +76,11 @@ describe "when deserializing" do
       output.should == Time.utc(2003, 2, 13, 5)
     end
 
-    it "should deserialize XML"
+    it "should deserialize an XML document" do
+      input = object_fixture('amf0-xmlDoc.bin')
+      output = RocketAMF.deserialize(input, 0)
+      output.should == '<parent><child prop="test" /></parent>'
+    end
 
     it "should deserialize an unmapped object as a dynamic anonymous object" do
       input = object_fixture("amf0-typed-object.bin")
@@ -85,9 +91,6 @@ describe "when deserializing" do
     end
 
     it "should deserialize a mapped object as a mapped ruby class instance" do
-      class RubyClass
-        attr_accessor :foo, :baz
-      end
       RocketAMF::ClassMapper.define {|m| m.map :as => 'org.rocketAMF.ASClass', :ruby => 'RubyClass'}
 
       input = object_fixture("amf0-typed-object.bin")
@@ -167,8 +170,17 @@ describe "when deserializing" do
         output.should == Time.at(0)
       end
 
-      #BAH! Who sends XML over AMF?
-      it "should deserialize XML"
+      it "should deserialize XML" do
+        # XMLDocument tag
+        input = object_fixture("amf3-xmlDoc.bin")
+        output = RocketAMF.deserialize(input, 3)
+        output.should == '<parent><child prop="test" /></parent>'
+
+        # XML tag
+        input = object_fixture("amf3-xml.bin")
+        output = RocketAMF.deserialize(input, 3)
+        output.should == '<parent><child prop="test"/></parent>'
+      end
     end
 
     describe "objects" do
@@ -186,9 +198,6 @@ describe "when deserializing" do
       end
 
       it "should deserialize a mapped object as a mapped ruby class instance" do
-        class RubyClass
-          attr_accessor :foo, :baz
-        end
         RocketAMF::ClassMapper.define {|m| m.map :as => 'org.rocketAMF.ASClass', :ruby => 'RubyClass'}
 
         input = object_fixture("amf3-typedObject.bin")
@@ -231,8 +240,29 @@ describe "when deserializing" do
         input = object_fixture("amf3-byteArray.bin")
         output = RocketAMF.deserialize(input, 3)
 
-        output.should be_a StringIO
-        output.string.should == "\000\003これtest\100"
+        output.should be_a(StringIO)
+        expected = "\000\003これtest\100"
+        expected.force_encoding("ASCII-8BIT") if expected.respond_to?(:force_encoding)
+        output.string.should == expected
+      end
+
+      it "should deserialize an empty dictionary" do
+        input = object_fixture("amf3-emptyDictionary.bin")
+        output = RocketAMF.deserialize(input, 3)
+        output.should == {}
+      end
+
+      it "should deserialize a dictionary" do
+        input = object_fixture("amf3-dictionary.bin")
+        output = RocketAMF.deserialize(input, 3)
+
+        keys = output.keys
+        keys.length.should == 2
+        obj_key, str_key = keys[0].is_a?(RocketAMF::Values::TypedHash) ? [keys[0], keys[1]] : [keys[1], keys[0]]
+        obj_key.type.should == 'org.rocketAMF.ASClass'
+        output[obj_key].should == "asdf2"
+        str_key.should == "bar"
+        output[str_key].should == "asdf1"
       end
     end
 
@@ -274,9 +304,6 @@ describe "when deserializing" do
       end
 
       it "should keep reference of duplicate object traits" do
-        class RubyClass
-          attr_accessor :foo, :baz
-        end
         RocketAMF::ClassMapper.define {|m| m.map :as => 'org.rocketAMF.ASClass', :ruby => 'RubyClass'}
 
         input = object_fixture("amf3-traitRef.bin")
@@ -304,7 +331,11 @@ describe "when deserializing" do
         output.should == [a,b,a,b]
       end
 
-      it "should keep references of duplicate XML and XMLDocuments"
+      it "should keep references of duplicate XML and XMLDocuments" do
+        input = object_fixture("amf3-xmlRef.bin")
+        output = RocketAMF.deserialize(input, 3)
+        output.should == ['<parent><child prop="test"/></parent>', '<parent><child prop="test"/></parent>']
+      end
 
       it "should keep references of duplicate byte arrays" do
         input = object_fixture("amf3-byteArrayRef.bin")

data/spec/amf/serializer_spec.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require File.dirname(__FILE__) + '/../spec_helper.rb'
 
 require 'rexml/document'
@@ -34,9 +36,6 @@ describe "when serializing" do
     end
 
     it "should serialize references" do
-      class OtherClass
-        attr_accessor :foo, :bar
-      end
       obj = OtherClass.new
       obj.foo = "baz"
       obj.bar = 3.14
@@ -51,14 +50,11 @@ describe "when serializing" do
     end
   
     it "should serialize hashes" do
-      output = RocketAMF.serialize({:a => 'b', :c => 'd'}, 0)
+      output = RocketAMF.serialize({:a => 'b', 'c' => 'd'}, 0)
       output.should == object_fixture('amf0-hash.bin')
     end
 
     it "should serialize unmapped objects" do
-      class RubyClass
-        attr_accessor :foo, :baz
-      end
       obj = RubyClass.new
       obj.foo = "bar"
 
@@ -67,9 +63,6 @@ describe "when serializing" do
     end
 
     it "should serialize mapped objects" do
-      class RubyClass
-        attr_accessor :foo, :baz
-      end
       obj = RubyClass.new
       obj.foo = "bar"
       RocketAMF::ClassMapper.define {|m| m.map :as => 'org.rocketAMF.ASClass', :ruby => 'RubyClass'}
@@ -77,6 +70,15 @@ describe "when serializing" do
       output = RocketAMF.serialize(obj, 0)
       output.should == object_fixture('amf0-typed-object.bin')
     end
+
+    if "".respond_to?(:force_encoding)
+      it "should support multiple encodings" do
+        shift_str = "\x53\x68\x69\x66\x74\x20\x83\x65\x83\x58\x83\x67".force_encoding("Shift_JIS") # "Shift テスト"
+        utf_str = "\x55\x54\x46\x20\xe3\x83\x86\xe3\x82\xb9\xe3\x83\x88".force_encoding("UTF-8") # "UTF テスト"
+        output = RocketAMF.serialize({"0" => 5, "1" => shift_str, "2" => utf_str, "3" => 5}, 0)
+        output.should == object_fixture("amf0-complexEncodedStringArray.bin")
+      end
+    end
   end
 
   describe "AMF3" do
@@ -153,9 +155,6 @@ describe "when serializing" do
         output = RocketAMF.serialize(input, 3)
         output.should == expected
       end
-
-      #BAH! Who sends XML over AMF?
-      it "should serialize XML"
     end
 
     describe "objects" do
@@ -188,7 +187,7 @@ describe "when serializing" do
       it "should serialize a hash as a dynamic anonymous object" do
         hash = {}
         hash[:answer] = 42
-        hash[:foo] = "bar"
+        hash['foo'] = "bar"
 
         expected = object_fixture("amf3-hash.bin")
         input = hash
@@ -278,6 +277,28 @@ describe "when serializing" do
         output.should == expected
       end
 
+      it "should keep reference of duplicate object traits" do
+        obj1 = RubyClass.new
+        obj1.foo = "foo"
+        def obj1.to_amf serializer
+          stream = ""
+          serializer.write_object(self, stream, {:class_name => 'org.rocketAMF.ASClass', :dynamic => false, :externalizable => false, :members => ["baz", "foo"]})
+          stream
+        end
+        obj2 = RubyClass.new
+        obj2.foo = "bar"
+        def obj2.to_amf serializer
+          stream = ""
+          serializer.write_object(self, stream, {:class_name => 'org.rocketAMF.ASClass', :dynamic => false, :externalizable => false, :members => ["baz", "foo"]})
+          stream
+        end
+        input = [obj1, obj2]
+
+        expected = object_fixture("amf3-traitRef.bin")
+        output = RocketAMF.serialize(input, 3)
+        output.should == expected
+      end
+
       it "should keep references of duplicate arrays" do
         a = [1,2,3]
         b = %w{ a b c }
@@ -300,8 +321,6 @@ describe "when serializing" do
         output.should == expected
       end
 
-      it "should keep references of duplicate XML and XMLDocuments"
-
       it "should keep references of duplicate byte arrays" do
         b = StringIO.new "ASDF"
 
@@ -313,8 +332,8 @@ describe "when serializing" do
 
       it "should serialize a deep object graph with circular references" do
         class GraphMember
-          attr_accessor :parent
           attr_accessor :children
+          attr_accessor :parent
 
           def initialize
             self.children = []
@@ -337,5 +356,26 @@ describe "when serializing" do
         output.should == expected
       end
     end
+
+    if "".respond_to?(:force_encoding)
+      describe "and handling encodings" do
+        it "should support multiple encodings" do
+          shift_str = "\x53\x68\x69\x66\x74\x20\x83\x65\x83\x58\x83\x67".force_encoding("Shift_JIS") # "Shift テスト"
+          utf_str = "\x55\x54\x46\x20\xe3\x83\x86\xe3\x82\xb9\xe3\x83\x88".force_encoding("UTF-8") # "UTF テスト"
+          output = RocketAMF.serialize([5, shift_str, utf_str, 5], 3)
+          output.should == object_fixture("amf3-complexEncodedStringArray.bin")
+        end
+
+        it "should keep references of duplicate strings with different encodings" do
+          # String is "this is a テスト"
+          shift_str = "\x74\x68\x69\x73\x20\x69\x73\x20\x61\x20\x83\x65\x83\x58\x83\x67".force_encoding("Shift_JIS")
+          utf_str   = "\x74\x68\x69\x73\x20\x69\x73\x20\x61\x20\xe3\x83\x86\xe3\x82\xb9\xe3\x83\x88".force_encoding("UTF-8")
+
+          expected = object_fixture("amf3-encodedStringRef.bin")
+          output = RocketAMF.serialize([shift_str, utf_str], 3)
+          output.should == expected
+        end
+      end
+    end
   end
 end

data/spec/amf/values/array_collection_spec.rb

@@ -1,6 +1,19 @@
 require File.dirname(__FILE__) + '/../../spec_helper.rb'
 
 describe RocketAMF::Values::ArrayCollection do
-  it "should deserialize properly"
-  it "should serialize properly"
+  it "should deserialize properly" do
+    input = object_fixture("amf3-arrayCollection.bin")
+    output = RocketAMF.deserialize(input, 3)
+
+    output.should be_a(RocketAMF::Values::ArrayCollection)
+    output.should == ["foo", "bar"]
+  end
+
+  it "should serialize properly" do
+    expected = object_fixture('amf3-arrayCollection.bin')
+    input = RocketAMF::Values::ArrayCollection.new
+    input.push("foo", "bar")
+    output = RocketAMF.serialize(input, 3)
+    output.should == expected
+  end
 end

data/spec/fixtures/objects/amf3-arrayCollection.bin

@@ -0,0 +1,2 @@
+
+Cflex.messaging.io.ArrayCollection	
foobar

data/spec/fixtures/objects/amf3-complexEncodedStringArray.bin

@@ -0,0 +1 @@
+		
Shift テストUTF テスト

data/spec/fixtures/objects/amf3-xml.bin

@@ -0,0 +1 @@
+K<parent><child prop="test"/></parent>

data/spec/fixtures/objects/amf3-xmlDoc.bin

@@ -0,0 +1 @@
+M<parent><child prop="test" /></parent>

data/spec/fixtures/objects/amf3-xmlRef.bin

@@ -0,0 +1 @@
+	
K<parent><child prop="test"/></parent>

data/spec/spec_helper.rb

@@ -11,13 +11,21 @@ $:.unshift(File.dirname(__FILE__) + '/../lib')
 require 'rocketamf'
 
 def request_fixture(binary_path)
-  File.open(File.dirname(__FILE__) + '/fixtures/request/' + binary_path).read
+  data = File.open(File.dirname(__FILE__) + '/fixtures/request/' + binary_path).read
+  data.force_encoding("ASCII-8BIT") if data.respond_to?(:force_encoding)
+  data
 end
 
 def object_fixture(binary_path)
-  File.open(File.dirname(__FILE__) + '/fixtures/objects/' + binary_path).read
+  data = File.open(File.dirname(__FILE__) + '/fixtures/objects/' + binary_path).read
+  data.force_encoding("ASCII-8BIT") if data.respond_to?(:force_encoding)
+  data
 end
 
 def create_request(binary_path)
   RocketAMF::Request.new.populate_from_stream(StringIO.new(request_fixture(binary_path)))
-end
+end
+
+# Helper classes
+class RubyClass; attr_accessor :baz, :foo; end;
+class OtherClass; attr_accessor :bar, :foo; end;

metadata

@@ -1,16 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: RocketAMF
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
-- Tony Hillerson
+- Jacob Henry
 - Stephen Augenstein
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-03-30 00:00:00 -04:00
+date: 2010-07-04 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -36,7 +42,6 @@ files:
 - lib/rocketamf/values/array_collection.rb
 - lib/rocketamf/values/messages.rb
 - lib/rocketamf/values/typed_hash.rb
-- lib/rocketamf/version.rb
 - lib/rocketamf.rb
 - spec/amf/class_mapping_spec.rb
 - spec/amf/deserializer_spec.rb
@@ -47,6 +52,7 @@ files:
 - spec/amf/values/messages_spec.rb
 - spec/spec_helper.rb
 - spec/fixtures/objects/amf0-boolean.bin
+- spec/fixtures/objects/amf0-complexEncodedStringArray.bin
 - spec/fixtures/objects/amf0-date.bin
 - spec/fixtures/objects/amf0-ecma-ordinal-array.bin
 - spec/fixtures/objects/amf0-hash.bin
@@ -59,20 +65,27 @@ files:
 - spec/fixtures/objects/amf0-typed-object.bin
 - spec/fixtures/objects/amf0-undefined.bin
 - spec/fixtures/objects/amf0-untyped-object.bin
+- spec/fixtures/objects/amf0-xmlDoc.bin
 - spec/fixtures/objects/amf3-0.bin
+- spec/fixtures/objects/amf3-arrayCollection.bin
 - spec/fixtures/objects/amf3-arrayRef.bin
 - spec/fixtures/objects/amf3-bigNum.bin
 - spec/fixtures/objects/amf3-byteArray.bin
 - spec/fixtures/objects/amf3-byteArrayRef.bin
+- spec/fixtures/objects/amf3-complexEncodedStringArray.bin
 - spec/fixtures/objects/amf3-date.bin
 - spec/fixtures/objects/amf3-datesRef.bin
+- spec/fixtures/objects/amf3-dictionary.bin
 - spec/fixtures/objects/amf3-dynObject.bin
 - spec/fixtures/objects/amf3-emptyArray.bin
 - spec/fixtures/objects/amf3-emptyArrayRef.bin
+- spec/fixtures/objects/amf3-emptyDictionary.bin
 - spec/fixtures/objects/amf3-emptyStringRef.bin
+- spec/fixtures/objects/amf3-encodedStringRef.bin
 - spec/fixtures/objects/amf3-false.bin
 - spec/fixtures/objects/amf3-graphMember.bin
 - spec/fixtures/objects/amf3-hash.bin
+- spec/fixtures/objects/amf3-intVector.bin
 - spec/fixtures/objects/amf3-largeMax.bin
 - spec/fixtures/objects/amf3-largeMin.bin
 - spec/fixtures/objects/amf3-max.bin
@@ -80,6 +93,7 @@ files:
 - spec/fixtures/objects/amf3-mixedArray.bin
 - spec/fixtures/objects/amf3-null.bin
 - spec/fixtures/objects/amf3-objRef.bin
+- spec/fixtures/objects/amf3-objVector.bin
 - spec/fixtures/objects/amf3-primArray.bin
 - spec/fixtures/objects/amf3-string.bin
 - spec/fixtures/objects/amf3-stringRef.bin
@@ -87,6 +101,9 @@ files:
 - spec/fixtures/objects/amf3-traitRef.bin
 - spec/fixtures/objects/amf3-true.bin
 - spec/fixtures/objects/amf3-typedObject.bin
+- spec/fixtures/objects/amf3-xml.bin
+- spec/fixtures/objects/amf3-xmlDoc.bin
+- spec/fixtures/objects/amf3-xmlRef.bin
 - spec/fixtures/request/acknowledge-response.bin
 - spec/fixtures/request/amf0-error-response.bin
 - spec/fixtures/request/commandMessage.bin
@@ -106,24 +123,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Fast AMF serializer/deserializer and request/response wrappers to simplify remoting implementation
+summary: Fast AMF serializer/deserializer with remoting request/response wrappers to simplify integration
 test_files: 
 - spec/amf/class_mapping_spec.rb
 - spec/amf/deserializer_spec.rb

data/lib/rocketamf/version.rb

@@ -1,9 +0,0 @@
-module RocketAMF
-  # AMF version
-  VERSION         = '0.0.7'
-  VERSION_ARRAY   = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
-  VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
-  VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:
-  VERSION_BUILD   = VERSION_ARRAY[2] # :nodoc:
-  VARIANT_BINARY  = false
-end