RocketAMF 0.1.0 → 0.2.0

data/README.rdoc

@@ -3,7 +3,8 @@
 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.
+ensure adherence to the specification documents put out by Adobe. In addition,
+it now fully supports Ruby 1.9.
 
 == INSTALL:
 

data/Rakefile

@@ -23,7 +23,7 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name    = 'RocketAMF'
-  s.version = '0.1.0'
+  s.version = '0.2.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']

data/lib/rocketamf.rb

@@ -46,8 +46,8 @@ require 'rocketamf/remoting'
 #       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
+#         request = RocketAMF::Envelope.new.populate_from_stream(env['rack.input'].read)
+#         response = RocketAMF::Envelope.new
 #
 #         # Handle request
 #         response.each_method_call request do |method, args|

data/lib/rocketamf/pure.rb

@@ -18,15 +18,11 @@ module RocketAMF
   Serializer = RocketAMF::Pure::Serializer
   AMF3Serializer = RocketAMF::Pure::AMF3Serializer
 
-  # Modify request and response so they can serialize/deserialize
-  class Request
+  # Modify envelope so it can serialize/deserialize
+  class Envelope
     remove_method :populate_from_stream
-    include RocketAMF::Pure::Request
-  end
-
-  class Response
     remove_method :serialize
-    include RocketAMF::Pure::Response
+    include RocketAMF::Pure::Envelope
   end
   #:startdoc:
 end

data/lib/rocketamf/pure/remoting.rb

@@ -2,9 +2,11 @@ require 'rocketamf/pure/io_helpers'
 
 module RocketAMF
   module Pure
-    # Request deserialization module - provides a method that can be included into
-    # RocketAMF::Request for deserializing the given stream.
-    module Request
+    # Included into RocketAMF::Envelope, this module replaces the
+    # populate_from_stream and serialize methods with actual working versions
+    module Envelope
+      # Included into RocketAMF::Envelope, this method handles deserializing an
+      # AMF request/response into the envelope
       def populate_from_stream stream
         stream = StringIO.new(stream) unless StringIO === stream
 
@@ -45,13 +47,8 @@ module RocketAMF
         self
       end
 
-      private
-      include RocketAMF::Pure::ReadIOHelpers
-    end
-
-    # Response serialization module - provides a method that can be included into
-    # RocketAMF::Response for deserializing the given stream.
-    module Response
+      # Included into RocketAMF::Envelope, this method handles serializing an
+      # AMF request/response into the envelope
       def serialize
         stream = ""
 
@@ -92,6 +89,7 @@ module RocketAMF
       end
 
       private
+      include RocketAMF::Pure::ReadIOHelpers
       include RocketAMF::Pure::WriteIOHelpers
     end
   end

data/lib/rocketamf/remoting.rb

@@ -1,41 +1,29 @@
 module RocketAMF
-  # Container for the AMF request.
-  class Request
+  # Container for the AMF request/response.
+  class Envelope
     attr_reader :amf_version, :headers, :messages
 
-    def initialize
-      @amf_version = 0
-      @headers = []
-      @messages = []
+    def initialize props={}
+      @amf_version = props[:amf_version] || 0
+      @headers = props[:headers] || []
+      @messages = props[:messages] || []
     end
 
-    # Populates the request from the given stream or string. Returns self for easy
+    # Populates the envelope from the given stream or string. Returns self for easy
     # chaining.
     #
     # Example:
     #
-    #    req = RocketAMF::Request.new.populate_from_stream(env['rack.input'].read)
+    #    req = RocketAMF::Envelope.new.populate_from_stream(env['rack.input'].read)
     #--
-    # Implemented in pure/remoting.rb RocketAMF::Pure::Request
+    # Implemented in pure/remoting.rb RocketAMF::Pure::Envelope
     def populate_from_stream stream
       raise AMFError, 'Must load "rocketamf/pure"'
     end
-  end
-
-  # Container for the response of the AMF call. Includes serialization and request
-  # handling code.
-  class Response
-    attr_accessor :amf_version, :headers, :messages
 
-    def initialize
-      @amf_version = 0
-      @headers = []
-      @messages = []
-    end
-
-    # Serializes the response to a string and returns it
+    # Serializes the envelope to a string and returns it
     #--
-    # Implemented in pure/remoting.rb RocketAMF::Pure::Response
+    # Implemented in pure/remoting.rb RocketAMF::Pure::Envelope
     def serialize
       raise AMFError, 'Must load "rocketamf/pure"'
     end
@@ -66,14 +54,15 @@ module RocketAMF
             response_value = Values::AcknowledgeMessage.new(command_msg)
           else
             e = Exception.new("CommandMessage #{command_msg.operation} not implemented")
-            e.set_backtrace ["RocketAMF::Response each_method_call"]
+            e.set_backtrace ["RocketAMF::Envelope each_method_call"]
             response_value = Values::ErrorMessage.new(command_msg, e)
           end
         when Values::RemotingMessage
           # Using RemoteObject style message calls
           remoting_msg = m.data
           acknowledge_msg = Values::AcknowledgeMessage.new(remoting_msg)
-          body = dispatch_call :method => remoting_msg.source+'.'+remoting_msg.operation, :args => remoting_msg.body, :source => remoting_msg, :block => block
+          method_base = remoting_msg.source.to_s.empty? ? '' : remoting_msg.source+'.'
+          body = dispatch_call :method => method_base+remoting_msg.operation, :args => remoting_msg.body, :source => remoting_msg, :block => block
 
           # Response should be the bare ErrorMessage if there was an error
           if body.is_a?(Values::ErrorMessage)
@@ -95,7 +84,7 @@ module RocketAMF
       @constructed = true
     end
 
-    # Return the serialized response as a string
+    # Return the serialized envelope as a string
     def to_s
       serialize
     end
@@ -111,7 +100,21 @@ module RocketAMF
     end
   end
 
-  # RocketAMF::Request or RocketAMF::Response header
+  class Request < Envelope #:nodoc:
+    def initialize props={}
+      $stderr.puts("DEPRECATION WARNING: Use RocketAMF::Envelope instead of RocketAMF::Request")
+      super(props)
+    end
+  end
+
+  class Response < Envelope #:nodoc:
+    def initialize props={}
+      $stderr.puts("DEPRECATION WARNING: Use RocketAMF::Envelope instead of RocketAMF::Request")
+      super(props)
+    end
+  end
+
+  # RocketAMF::Envelope header
   class Header
     attr_accessor :name, :must_understand, :data
 
@@ -122,7 +125,7 @@ module RocketAMF
     end
   end
 
-  # RocketAMF::Request or RocketAMF::Response message
+  # RocketAMF::Envelope message
   class Message
     attr_accessor :target_uri, :response_uri, :data
 

data/lib/rocketamf/values/messages.rb

@@ -105,13 +105,15 @@ module RocketAMF
       # Optional "root cause" of the error
       attr_accessor :rootCause
 
-      def initialize message, exception
+      def initialize message=nil, exception=nil
         super message
 
-        @e = exception
-        @faultCode = @e.class.name
-        @faultDetail = @e.backtrace.join("\n")
-        @faultString = @e.message
+        unless exception.nil?
+          @e = exception
+          @faultCode = @e.class.name
+          @faultDetail = @e.backtrace.join("\n")
+          @faultString = @e.message
+        end
       end
 
       def to_amf serializer

data/spec/amf/remoting_spec.rb

@@ -0,0 +1,117 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe RocketAMF::Envelope do
+  describe 'deserializer' do
+    it "should handle remoting message from remote object" do
+      req = create_envelope("remotingMessage.bin")
+
+      req.headers.length.should == 0
+      req.messages.length.should == 1
+      message = req.messages[0].data
+      message.should be_a(RocketAMF::Values::RemotingMessage)
+      message.messageId.should == "FE4AF2BC-DD3C-5470-05D8-9971D51FF89D"
+      message.body.should == [true]
+    end
+
+    it "should handle command message from remote object" do
+      req = create_envelope("commandMessage.bin")
+
+      req.headers.length.should == 0
+      req.messages.length.should == 1
+      message = req.messages[0].data
+      message.should be_a(RocketAMF::Values::CommandMessage)
+      message.messageId.should == "7B0ACE15-8D57-6AE5-B9D4-99C2D32C8246"
+      message.body.should == {}
+    end
+  end
+
+  describe 'serializer' do
+    it "should serialize response when converted to string" do
+      res = RocketAMF::Envelope.new
+      res.should_receive(:serialize).and_return('serialized')
+      res.to_s.should == 'serialized'
+    end
+
+    it "should serialize a simple call" do
+      res = RocketAMF::Envelope.new :amf_version => 3
+      res.messages << RocketAMF::Message.new('/1/onResult', '', 'hello')
+
+      expected = request_fixture('simple-response.bin')
+      res.serialize.should == expected
+    end
+
+    it "should serialize a AcknowledgeMessage response" do
+      ak = RocketAMF::Values::AcknowledgeMessage.new
+      ak.clientId = "7B0ACE15-8D57-6AE5-B9D4-99C2D32C8246"
+      ak.messageId = "7B0ACE15-8D57-6AE5-B9D4-99C2D32C8246"
+      ak.timestamp = 0
+      res = RocketAMF::Envelope.new :amf_version => 3
+      res.messages << RocketAMF::Message.new('/1/onResult', '', ak)
+
+      expected = request_fixture('acknowledge-response.bin')
+      res.serialize.should == expected
+    end
+  end
+
+  describe 'message handler' do
+    it "should respond to ping command" do
+      res = RocketAMF::Envelope.new
+      req = create_envelope('commandMessage.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::AcknowledgeMessage)
+    end
+
+    it "should fail on unsupported command" do
+      res = RocketAMF::Envelope.new
+      req = create_envelope('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::Envelope.new
+      req = create_envelope('remotingMessage.bin')
+      res.each_method_call req do |method, args|
+        method.should == 'WritesController.save'
+        args.should == [true]
+        true
+      end
+
+      res.messages.length.should == 1
+      res.messages[0].data.should be_a(RocketAMF::Values::AcknowledgeMessage)
+      res.messages[0].data.body.should == true
+    end
+
+    it "should catch exceptions properly" do
+      res = RocketAMF::Envelope.new
+      req = create_envelope('remotingMessage.bin')
+      res.each_method_call req do |method, args|
+        raise 'Error in call'
+      end
+
+      res.messages.length.should == 1
+      res.messages[0].data.should be_a(RocketAMF::Values::ErrorMessage)
+      res.messages[0].target_uri.should =~ /onStatus$/
+    end
+
+    it "should not crash if source missing on RemotingMessage" do
+      res = RocketAMF::Envelope.new
+      req = create_envelope('remotingMessage.bin')
+      req.messages[0].data.instance_variable_set("@source", nil)
+      lambda {
+        res.each_method_call req do |method,args|
+          true
+        end
+      }.should_not raise_error
+    end
+  end
+end

data/spec/amf/values/messages_spec.rb

@@ -18,7 +18,7 @@ describe RocketAMF::Values::ErrorMessage do
   end
 
   it "should serialize as a hash in AMF0" do
-    response = RocketAMF::Response.new
+    response = RocketAMF::Envelope.new
     response.messages << RocketAMF::Message.new('1/onStatus', '', @message)
     response.serialize.should == request_fixture('amf0-error-response.bin')
   end

data/spec/spec_helper.rb

@@ -22,8 +22,8 @@ def object_fixture(binary_path)
   data
 end
 
-def create_request(binary_path)
-  RocketAMF::Request.new.populate_from_stream(StringIO.new(request_fixture(binary_path)))
+def create_envelope(binary_path)
+  RocketAMF::Envelope.new.populate_from_stream(StringIO.new(request_fixture(binary_path)))
 end
 
 # Helper classes

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: RocketAMF
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jacob Henry
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-04 00:00:00 -04:00
+date: 2010-07-29 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -45,8 +45,7 @@ files:
 - lib/rocketamf.rb
 - spec/amf/class_mapping_spec.rb
 - spec/amf/deserializer_spec.rb
-- spec/amf/request_spec.rb
-- spec/amf/response_spec.rb
+- spec/amf/remoting_spec.rb
 - spec/amf/serializer_spec.rb
 - spec/amf/values/array_collection_spec.rb
 - spec/amf/values/messages_spec.rb
@@ -85,7 +84,6 @@ files:
 - 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
@@ -93,7 +91,6 @@ 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
@@ -150,8 +147,7 @@ summary: Fast AMF serializer/deserializer with remoting request/response wrapper
 test_files: 
 - spec/amf/class_mapping_spec.rb
 - spec/amf/deserializer_spec.rb
-- spec/amf/request_spec.rb
-- spec/amf/response_spec.rb
+- spec/amf/remoting_spec.rb
 - spec/amf/serializer_spec.rb
 - spec/amf/values/array_collection_spec.rb
 - spec/amf/values/messages_spec.rb

data/spec/amf/request_spec.rb

@@ -1,25 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-
-describe RocketAMF::Request do
-  it "should handle remoting message from remote object" do
-    req = create_request("remotingMessage.bin")
-
-    req.headers.length.should == 0
-    req.messages.length.should == 1
-    message = req.messages[0].data
-    message.should be_a(RocketAMF::Values::RemotingMessage)
-    message.messageId.should == "FE4AF2BC-DD3C-5470-05D8-9971D51FF89D"
-    message.body.should == [true]
-  end
-
-  it "should handle command message from remote object" do
-    req = create_request("commandMessage.bin")
-
-    req.headers.length.should == 0
-    req.messages.length.should == 1
-    message = req.messages[0].data
-    message.should be_a(RocketAMF::Values::CommandMessage)
-    message.messageId.should == "7B0ACE15-8D57-6AE5-B9D4-99C2D32C8246"
-    message.body.should == {}
-  end
-end

data/spec/amf/response_spec.rb

@@ -1,80 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-
-describe RocketAMF::Response do
-  it "should serialize response when converted to string" do
-    res = RocketAMF::Response.new
-    res.should_receive(:serialize).and_return('serialized')
-    res.to_s.should == 'serialized'
-  end
-
-  it "should serialize a simple call" do
-    res = RocketAMF::Response.new
-    res.amf_version = 3
-    res.messages << RocketAMF::Message.new('/1/onResult', '', 'hello')
-
-    expected = request_fixture('simple-response.bin')
-    res.serialize.should == expected
-  end
-
-  it "should serialize a AcknowledgeMessage response" do
-    ak = RocketAMF::Values::AcknowledgeMessage.new
-    ak.clientId = "7B0ACE15-8D57-6AE5-B9D4-99C2D32C8246"
-    ak.messageId = "7B0ACE15-8D57-6AE5-B9D4-99C2D32C8246"
-    ak.timestamp = 0
-    res = RocketAMF::Response.new
-    res.amf_version = 3
-    res.messages << RocketAMF::Message.new('/1/onResult', '', ak)
-
-    expected = request_fixture('acknowledge-response.bin')
-    res.serialize.should == expected
-  end
-
-  it "should respond to ping command" do
-    res = RocketAMF::Response.new
-    req = create_request('commandMessage.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::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')
-    res.each_method_call req do |method, args|
-      method.should == 'WritesController.save'
-      args.should == [true]
-      true
-    end
-
-    res.messages.length.should == 1
-    res.messages[0].data.should be_a(RocketAMF::Values::AcknowledgeMessage)
-    res.messages[0].data.body.should == true
-  end
-
-  it "should catch exceptions properly" do
-    res = RocketAMF::Response.new
-    req = create_request('remotingMessage.bin')
-    res.each_method_call req do |method, args|
-      raise 'Error in call'
-    end
-
-    res.messages.length.should == 1
-    res.messages[0].data.should be_a(RocketAMF::Values::ErrorMessage)
-    res.messages[0].target_uri.should =~ /onStatus$/
-  end
-end