RocketAMF 0.0.5 → 0.0.6

data/Rakefile

@@ -23,7 +23,7 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name    = 'RocketAMF'
-  s.version = '0.0.5'
+  s.version = '0.0.6'
   s.summary = 'Fast AMF serializer/deserializer and request/response wrappers to simplify remoting implementation'
 
   s.files        = FileList['README.rdoc', 'Rakefile', 'lib/**/*.rb', 'spec/**/*.rb', 'spec/**/*.bin', 'spec/spec.opts']

data/lib/rocketamf.rb

@@ -1,7 +1,10 @@
 $:.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/common'
+require 'rocketamf/version'
+require 'rocketamf/class_mapping'
+require 'rocketamf/constants'
+require 'rocketamf/remoting'
 
 module RocketAMF
   begin
@@ -9,4 +12,42 @@ module RocketAMF
   rescue LoadError
     require 'rocketamf/pure'
   end
+
+  # Deserialize the AMF string _source_ of the given AMF version into a Ruby
+  # data structure and return it
+  def self.deserialize source, amf_version = 0
+    if amf_version == 0
+      RocketAMF::Deserializer.new.deserialize(source)
+    elsif amf_version == 3
+      RocketAMF::AMF3Deserializer.new.deserialize(source)
+    else
+      raise AMFError, "unsupported version #{amf_version}"
+    end
+  end
+
+  # Serialize the given Ruby data structure _obj_ into an AMF stream using the
+  # given AMF version
+  def self.serialize obj, amf_version = 0
+    if amf_version == 0
+      RocketAMF::Serializer.new.serialize(obj)
+    elsif amf_version == 3
+      RocketAMF::AMF3Serializer.new.serialize(obj)
+    else
+      raise AMFError, "unsupported version #{amf_version}"
+    end
+  end
+
+  # 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
+    if const == :ClassMapper
+      RocketAMF.const_set(:ClassMapper, RocketAMF::ClassMapping.new)
+    else
+      super(const)
+    end
+  end
+
+  # The base exception for AMF errors.
+  class AMFError < StandardError; end
 end

data/lib/rocketamf/class_mapping.rb

@@ -14,7 +14,7 @@ module RocketAMF
   #
   #   RocketAMF::ClassMapper.define do |m|
   #     m.map :as => 'AsClass', :ruby => 'RubyClass'
-  #     m.map :as => 'vo.User', :ruby => 'User'
+  #     m.map :as => 'vo.User', :ruby => 'Model::User'
   #   end
   #
   # == Object Population/Serialization
@@ -58,6 +58,23 @@ module RocketAMF
   #     end
   #   end
   #   RocketAMF::ClassMapper.object_serializers << CustomSerializer.new
+  #
+  # == Complete Replacement
+  #
+  # In some cases, it may be beneficial to replace the default provider of class
+  # 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.
+  #
+  # Example:
+  #
+  #   require 'rubygems'
+  #   require 'rocketamf'
+  #   
+  #   RocketAMF::ClassMapper = MyCustomClassMapper.new
+  #   # No warning about already initialized constant ClassMapper
+  #   RocketAMF::ClassMapper.class # MyCustomClassMapper
   class ClassMapping
     # Container for all mapped classes
     class MappingSet
@@ -124,8 +141,13 @@ module RocketAMF
       yield mappings
     end
 
+    # Reset all class mappings except the defaults
+    def reset
+      @mappings = nil
+    end
+
     # Returns the AS class name for the given ruby object. Will also take a string
-    # containing the ruby class name
+    # containing the ruby class name.
     def get_as_class_name obj
       # Get class name
       if obj.is_a?(String)

data/lib/rocketamf/pure.rb

@@ -3,13 +3,14 @@ require 'rocketamf/pure/serializer'
 require 'rocketamf/pure/remoting'
 
 module RocketAMF
-  # This module holds all the modules/classes that implement AMF's
-  # functionality in pure ruby.
+  # This module holds all the modules/classes that implement AMF's functionality
+  # in pure ruby
   module Pure
     $DEBUG and warn "Using pure library for RocketAMF."
   end
 
-  # Import Deserializer
+  #:stopdoc:
+  # Import deserializer
   Deserializer = RocketAMF::Pure::Deserializer
   AMF3Deserializer = RocketAMF::Pure::AMF3Deserializer
 
@@ -27,4 +28,5 @@ module RocketAMF
     remove_method :serialize
     include RocketAMF::Pure::Response
   end
+  #:startdoc:
 end

data/lib/rocketamf/pure/deserializer.rb

@@ -44,6 +44,8 @@ module RocketAMF
           read_typed_object source
         when AMF0_AMF3_MARKER
           AMF3Deserializer.new.deserialize(source)
+        else
+          raise AMFError, "Invalid type: #{type}"
         end
       end
 
@@ -139,14 +141,14 @@ module RocketAMF
       def read_typed_object source
         # Create object to add to ref cache
         class_name = read_string source
-        obj = ClassMapper.get_ruby_obj class_name
+        obj = RocketAMF::ClassMapper.get_ruby_obj class_name
         @ref_cache << obj
 
         # Read object props
         props = read_object source, false
 
         # Populate object
-        ClassMapper.populate_ruby_obj obj, props, {}
+        RocketAMF::ClassMapper.populate_ruby_obj obj, props, {}
         return obj
       end
     end
@@ -164,32 +166,34 @@ module RocketAMF
         source = StringIO.new(source) unless StringIO === source
         type = read_int8 source unless type
         case type
-          when AMF3_UNDEFINED_MARKER
-            nil
-          when AMF3_NULL_MARKER
-            nil
-          when AMF3_FALSE_MARKER
-            false
-          when AMF3_TRUE_MARKER
-            true
-          when AMF3_INTEGER_MARKER
-            read_integer source
-          when AMF3_DOUBLE_MARKER
-            read_number source
-          when AMF3_STRING_MARKER
-            read_string source
-          when AMF3_XML_DOC_MARKER
-            #read_xml_string
-          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
+        when AMF3_UNDEFINED_MARKER
+          nil
+        when AMF3_NULL_MARKER
+          nil
+        when AMF3_FALSE_MARKER
+          false
+        when AMF3_TRUE_MARKER
+          true
+        when AMF3_INTEGER_MARKER
+          read_integer source
+        when AMF3_DOUBLE_MARKER
+          read_number source
+        when AMF3_STRING_MARKER
+          read_string source
+        when AMF3_XML_DOC_MARKER
+          #read_xml_string
+        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
+        else
+          raise AMFError, "Invalid type: #{type}"
         end
       end
 
@@ -316,7 +320,7 @@ module RocketAMF
             @trait_cache << class_definition
           end
 
-          obj = ClassMapper.get_ruby_obj class_definition["class_name"]
+          obj = RocketAMF::ClassMapper.get_ruby_obj class_definition["class_name"]
           @object_cache << obj
 
           if class_definition['externalizable']
@@ -337,7 +341,7 @@ module RocketAMF
               end
             end
 
-            ClassMapper.populate_ruby_obj obj, props, dynamic_props
+            RocketAMF::ClassMapper.populate_ruby_obj obj, props, dynamic_props
           end
           obj
         end

data/lib/rocketamf/pure/serializer.rb

@@ -98,7 +98,7 @@ module RocketAMF
         @ref_cache.add_obj obj
 
         # Is it a typed object?
-        class_name = ClassMapper.get_as_class_name obj
+        class_name = RocketAMF::ClassMapper.get_as_class_name obj
         if class_name
           stream << AMF0_TYPED_OBJECT_MARKER
           stream << pack_int16_network(class_name.length)
@@ -114,7 +114,7 @@ module RocketAMF
       include RocketAMF::Pure::WriteIOHelpers
       def write_prop_list obj, stream
         # Write prop list
-        props = ClassMapper.props_for_serialization obj
+        props = RocketAMF::ClassMapper.props_for_serialization obj
         props.sort.each do |key, value| # Sort keys before writing
           stream << pack_int16_network(key.length)
           stream << key
@@ -248,7 +248,7 @@ module RocketAMF
           stream << AMF3_DYNAMIC_OBJECT
 
           # Write class name/anonymous
-          class_name = ClassMapper.get_as_class_name obj
+          class_name = RocketAMF::ClassMapper.get_as_class_name obj
           if class_name
             write_utf8_vr class_name, stream
           else
@@ -256,7 +256,7 @@ module RocketAMF
           end
 
           # Write out properties
-          props = ClassMapper.props_for_serialization obj
+          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

data/lib/rocketamf/remoting.rb

@@ -10,7 +10,7 @@ module RocketAMF
     end
 
     # Populates the request from the given stream or string. Returns self for easy
-    # chaining
+    # chaining.
     #
     # Example:
     #
@@ -33,7 +33,7 @@ module RocketAMF
       @messages = []
     end
 
-    # Serializes the response to a string and returns it.
+    # Serializes the response to a string and returns it
     #--
     # Implemented in pure/remoting.rb RocketAMF::Pure::Response
     def serialize
@@ -65,7 +65,9 @@ module RocketAMF
           if command_msg.operation == Values::CommandMessage::CLIENT_PING_OPERATION
             response_value = Values::AcknowledgeMessage.new(command_msg)
           else
-            response_value = Values::ErrorMessage.new(Exception.new("CommandMessage #{command_msg.operation} not implemented"), command_msg)
+            e = Exception.new("CommandMessage #{command_msg.operation} not implemented")
+            e.set_backtrace ["RocketAMF::Response each_method_call"]
+            response_value = Values::ErrorMessage.new(command_msg, e)
           end
         when Values::RemotingMessage
           # Using RemoteObject style message calls

data/lib/rocketamf/values/messages.rb

@@ -1,7 +1,7 @@
 module RocketAMF
   module Values #:nodoc:
     # Base class for all special AS3 response messages. Maps to
-    # <tt>flex.messaging.messages.AbstractMessage</tt>
+    # <tt>flex.messaging.messages.AbstractMessage</tt>.
     class AbstractMessage
       attr_accessor :clientId
       attr_accessor :destination

data/lib/rocketamf/version.rb

@@ -1,6 +1,6 @@
 module RocketAMF
   # AMF version
-  VERSION         = '0.0.4'
+  VERSION         = '0.0.6'
   VERSION_ARRAY   = VERSION.split(/\./).map { |x| x.to_i } # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/spec/amf/class_mapping_spec.rb

@@ -16,19 +16,19 @@ describe RocketAMF::ClassMapping do
     end
   end
 
-  it "should return AS class name for ruby objects" do
-    @mapper.get_as_class_name(ClassMappingTest.new).should == 'ASClass'
-    @mapper.get_as_class_name('ClassMappingTest').should == 'ASClass'
-  end
+  describe "class name mapping" do
+    it "should allow resetting of mappings back to defaults" do
+      @mapper.reset
+      @mapper.get_as_class_name('ClassMappingTest').should be_nil
+      @mapper.get_as_class_name('RocketAMF::Values::AcknowledgeMessage').should_not be_nil
+    end
 
-  it "should allow config modification" do
-    @mapper.define do |m|
-      m.map :as => 'SecondClass', :ruby => 'ClassMappingTest'
+    it "should return AS class name for ruby objects" do
+      @mapper.get_as_class_name(ClassMappingTest.new).should == 'ASClass'
+      @mapper.get_as_class_name('ClassMappingTest').should == 'ASClass'
+      @mapper.get_as_class_name('BadClass').should be_nil
     end
-    @mapper.get_as_class_name(ClassMappingTest.new).should == 'SecondClass'
-  end
 
-  describe "ruby object generator" do
     it "should instantiate a ruby class" do
       @mapper.get_ruby_obj('ASClass').should be_a(ClassMappingTest)
     end
@@ -44,6 +44,38 @@ describe RocketAMF::ClassMapping do
       obj.should be_a(RocketAMF::Values::TypedHash)
       obj.type.should == 'UnmappedClass'
     end
+
+    it "should map special classes from AS by default" do
+      as_classes = [
+        'flex.messaging.messages.AcknowledgeMessage',
+        'flex.messaging.messages.CommandMessage',
+        'flex.messaging.messages.RemotingMessage',
+        'flex.messaging.io.ArrayCollection'
+      ]
+
+      as_classes.each do |as_class|
+        @mapper.get_ruby_obj(as_class).should_not be_a(RocketAMF::Values::TypedHash)
+      end
+    end
+
+    it "should map special classes from ruby by default" do
+      ruby_classes = [
+        'RocketAMF::Values::AcknowledgeMessage',
+        'RocketAMF::Values::ErrorMessage',
+        'RocketAMF::Values::ArrayCollection'
+      ]
+
+      ruby_classes.each do |obj|
+        @mapper.get_as_class_name(obj).should_not be_nil
+      end
+    end
+
+    it "should allow config modification" do
+      @mapper.define do |m|
+        m.map :as => 'SecondClass', :ruby => 'ClassMappingTest'
+      end
+      @mapper.get_as_class_name(ClassMappingTest.new).should == 'SecondClass'
+    end
   end
 
   describe "ruby object populator" do

data/spec/amf/deserializer_spec.rb

@@ -211,7 +211,7 @@ describe "when deserializing" do
         output.should == []
       end
 
-      it "should deserialize an array of primatives" do
+      it "should deserialize an array of primitives" do
         input = object_fixture("amf3-primArray.bin")
         output = RocketAMF.deserialize(input, 3)
         output.should == [1,2,3,4,5]
@@ -267,6 +267,19 @@ describe "when deserializing" do
         output.should == [[obj1, obj2], "bar", [obj1, obj2]]
       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")
+        output = RocketAMF.deserialize(input, 3)
+
+        output[0].foo.should == "foo"
+        output[1].foo.should == "bar"
+      end
+
       it "should keep references of duplicate arrays" do
         input = object_fixture("amf3-arrayRef.bin")
         output = RocketAMF.deserialize(input, 3)

data/spec/amf/response_spec.rb

@@ -40,6 +40,18 @@ describe RocketAMF::Response do
     res.messages[0].data.should be_a(RocketAMF::Values::AcknowledgeMessage)
   end
 
+  it "should fail on unsupported command" do
+    res = RocketAMF::Response.new
+    req = create_request('unsupportedCommandMessage.bin')
+    res.each_method_call req do |method, args|
+      nil
+    end
+
+    res.messages.length.should == 1
+    res.messages[0].data.should be_a(RocketAMF::Values::ErrorMessage)
+    res.messages[0].data.faultString.should == "CommandMessage 10000 not implemented"
+  end
+
   it "should handle RemotingMessages properly" do
     res = RocketAMF::Response.new
     req = create_request('remotingMessage.bin')

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

@@ -0,0 +1,3 @@
+	

+#+org.rocketAMF.ASClassbazfoo

+

bar

data/spec/spec_helper.rb

@@ -20,13 +20,4 @@ end
 
 def create_request(binary_path)
   RocketAMF::Request.new.populate_from_stream(StringIO.new(request_fixture(binary_path)))
-end
-
-# Add reset support to ClassMapping
-module RocketAMF
-  class ClassMapping
-    def reset
-      @mappings = nil
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: RocketAMF
 version: !ruby/object:Gem::Version 
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Tony Hillerson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-29 00:00:00 -04:00
+date: 2010-01-22 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -26,7 +26,6 @@ files:
 - README.rdoc
 - Rakefile
 - lib/rocketamf/class_mapping.rb
-- lib/rocketamf/common.rb
 - lib/rocketamf/constants.rb
 - lib/rocketamf/pure/deserializer.rb
 - lib/rocketamf/pure/io_helpers.rb
@@ -39,7 +38,6 @@ files:
 - lib/rocketamf/values/typed_hash.rb
 - lib/rocketamf/version.rb
 - lib/rocketamf.rb
-- spec/amf/class_mapping_set_spec.rb
 - spec/amf/class_mapping_spec.rb
 - spec/amf/deserializer_spec.rb
 - spec/amf/request_spec.rb
@@ -84,6 +82,7 @@ files:
 - spec/fixtures/objects/amf3-string.bin
 - spec/fixtures/objects/amf3-stringRef.bin
 - spec/fixtures/objects/amf3-symbol.bin
+- spec/fixtures/objects/amf3-traitRef.bin
 - spec/fixtures/objects/amf3-true.bin
 - spec/fixtures/objects/amf3-typedObject.bin
 - spec/fixtures/request/acknowledge-response.bin
@@ -91,6 +90,7 @@ files:
 - spec/fixtures/request/commandMessage.bin
 - spec/fixtures/request/remotingMessage.bin
 - spec/fixtures/request/simple-response.bin
+- spec/fixtures/request/unsupportedCommandMessage.bin
 - spec/spec.opts
 has_rdoc: true
 homepage: http://github.com/warhammerkid/rocket-amf
@@ -123,7 +123,6 @@ signing_key:
 specification_version: 3
 summary: Fast AMF serializer/deserializer and request/response wrappers to simplify remoting implementation
 test_files: 
-- spec/amf/class_mapping_set_spec.rb
 - spec/amf/class_mapping_spec.rb
 - spec/amf/deserializer_spec.rb
 - spec/amf/request_spec.rb

data/lib/rocketamf/common.rb

@@ -1,35 +0,0 @@
-require 'rocketamf/version'
-require 'rocketamf/class_mapping'
-require 'rocketamf/constants'
-require 'rocketamf/remoting'
-
-module RocketAMF
-  class << self
-    # Deserialize the AMF string _source_ into a Ruby data structure and return it.
-    def deserialize source, amf_version = 0
-      if amf_version == 0
-        RocketAMF::Deserializer.new.deserialize(source)
-      elsif amf_version == 3
-        RocketAMF::AMF3Deserializer.new.deserialize(source)
-      else
-        raise AMFError, "unsupported version #{amf_version}"
-      end
-    end
-
-    # Serialize the given Ruby data structure _obj_ into an AMF stream
-    def serialize obj, amf_version = 0
-      if amf_version == 0
-        RocketAMF::Serializer.new.serialize(obj)
-      elsif amf_version == 3
-        RocketAMF::AMF3Serializer.new.serialize(obj)
-      else
-        raise AMFError, "unsupported version #{amf_version}"
-      end
-    end
-  end
-
-  ClassMapper = RocketAMF::ClassMapping.new
-
-  # The base exception for AMF errors.
-  class AMFError < StandardError; end
-end

data/spec/amf/class_mapping_set_spec.rb

@@ -1,34 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-
-describe RocketAMF::ClassMapping::MappingSet do
-  before :each do
-    @config = RocketAMF::ClassMapping::MappingSet.new
-  end
-
-  it "should retrieve AS mapping for ruby class" do
-    @config.map :as => 'ASTest', :ruby => 'RubyTest'
-    @config.get_as_class_name('RubyTest').should == 'ASTest'
-    @config.get_as_class_name('BadClass').should be_nil
-  end
-
-  it "should retrive ruby class name mapping for AS class" do
-    @config.map :as => 'ASTest', :ruby => 'RubyTest'
-    @config.get_ruby_class_name('ASTest').should == 'RubyTest'
-    @config.get_ruby_class_name('BadClass').should be_nil
-  end
-
-  it "should map special classes by default" do
-    SPECIAL_CLASSES = [
-      'flex.messaging.messages.AcknowledgeMessage',
-      'flex.messaging.messages.ErrorMessage',
-      'flex.messaging.messages.CommandMessage',
-      'flex.messaging.messages.ErrorMessage',
-      'flex.messaging.messages.RemotingMessage',
-      'flex.messaging.io.ArrayCollection'
-    ]
-
-    SPECIAL_CLASSES.each do |as_class|
-      @config.get_ruby_class_name(as_class).should_not be_nil
-    end
-  end
-end