mrpin-rocketamf 1.0.4 → 2.0.0

data/spec/spec_helper.rb

@@ -1,55 +1,10 @@
 require 'rubygems'
 require 'rspec'
-require 'rspec/autorun'
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
-require 'rocketamf'
-require 'rocketamf/pure/io_helpers' # Just to make sure they get loaded
-
-def request_fixture(binary_path)
-  data = File.open(File.dirname(__FILE__) + '/fixtures/request/' + binary_path, "rb").read
-  data.force_encoding("ASCII-8BIT") if data.respond_to?(:force_encoding)
-  data
-end
-
-def object_fixture(binary_path)
-  data = File.open(File.dirname(__FILE__) + '/fixtures/objects/' + binary_path, "rb").read
-  data.force_encoding("ASCII-8BIT") if data.respond_to?(:force_encoding)
-  data
-end
-
-def create_envelope(binary_path)
-  RocketAMF::Envelope.new.populate_from_stream(StringIO.new(request_fixture(binary_path)))
-end
 
-# Helper classes
-class RubyClass; attr_accessor :baz, :foo; end;
-class OtherClass; attr_accessor :bar, :foo; end;
-class ClassMappingTest
-  attr_accessor :prop_a
-  attr_accessor :prop_b
-end
-class ClassMappingTest2 < ClassMappingTest
-  attr_accessor :prop_c
-end
-module ANamespace; class TestRubyClass; end; end
-class ExternalizableTest
-  include RocketAMF::Pure::ReadIOHelpers
-  include RocketAMF::Pure::WriteIOHelpers
-
-  attr_accessor :one, :two
-
-  def encode_amf serializer
-    serializer.write_object(self, nil, {:class_name => 'ExternalizableTest', :dynamic => false, :externalizable => true, :members => []})
-  end
-
-  def read_external des
-    @one = read_double(des.source)
-    @two = read_double(des.source)
-  end
+require 'rocketamf'
+require 'rocketamf/pure/helpers/io_helper_write' # Just to make sure they get loaded
+require 'rocketamf/pure/helpers/io_helper_read' # Just to make sure they get loaded
 
-  def write_external ser
-    ser.stream << pack_double(@one)
-    ser.stream << pack_double(@two)
-  end
-end
+Dir[File.dirname(__FILE__) + '/helpers/*.rb'].each { |file| require file }

metadata

@@ -1,34 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: mrpin-rocketamf
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Jacob Henry
 - Stephen Augenstein
 - Joc O'Connor
+- Gregory Tkach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-26 00:00:00.000000000 Z
+date: 2015-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: Fast AMF3 serializer/deserializer with remoting request/response wrappers
+  to simplify integration
 email:
-- perl.programmer@gmail.com
+- gregory.tkach@gmail.com
 executables: []
 extensions:
 - ext/rocketamf_ext/extconf.rb
@@ -36,46 +38,41 @@ extra_rdoc_files:
 - README.rdoc
 files:
 - README.rdoc
-- benchmark.rb
-- mrpin-rocketamf.gemspec
 - Rakefile
-- lib/rocketamf/class_mapping.rb
+- benchmark.rb
+- ext/rocketamf_ext/class_mapping.c
+- ext/rocketamf_ext/constants.h
+- ext/rocketamf_ext/deserializer.c
+- ext/rocketamf_ext/deserializer.h
+- ext/rocketamf_ext/extconf.rb
+- ext/rocketamf_ext/remoting.c
+- ext/rocketamf_ext/rocketamf_ext.c
+- ext/rocketamf_ext/serializer.c
+- ext/rocketamf_ext/serializer.h
+- ext/rocketamf_ext/utility.h
+- lib/rocketamf.rb
 - lib/rocketamf/constants.rb
+- lib/rocketamf/errors.rb
+- lib/rocketamf/errors/amf_error.rb
+- lib/rocketamf/errors/amf_error_incomplete.rb
 - lib/rocketamf/ext.rb
 - lib/rocketamf/extensions.rb
+- lib/rocketamf/mapping/class_mapping.rb
+- lib/rocketamf/mapping/mapping_set.rb
+- lib/rocketamf/pure.rb
 - lib/rocketamf/pure/deserializer.rb
-- lib/rocketamf/pure/io_helpers.rb
-- lib/rocketamf/pure/remoting.rb
+- lib/rocketamf/pure/helpers/io_helper_base.rb
+- lib/rocketamf/pure/helpers/io_helper_read.rb
+- lib/rocketamf/pure/helpers/io_helper_write.rb
+- lib/rocketamf/pure/helpers/object_cache.rb
+- lib/rocketamf/pure/helpers/string_cache.rb
 - lib/rocketamf/pure/serializer.rb
-- lib/rocketamf/pure.rb
-- lib/rocketamf/remoting.rb
-- lib/rocketamf/values/messages.rb
-- lib/rocketamf/values/typed_hash.rb
-- lib/rocketamf.rb
+- lib/rocketamf/types.rb
+- lib/rocketamf/types/typed_hash.rb
+- mrpin-rocketamf.gemspec
 - spec/class_mapping_spec.rb
 - spec/deserializer_spec.rb
 - spec/fast_class_mapping_spec.rb
-- spec/messages_spec.rb
-- spec/remoting_spec.rb
-- spec/serializer_spec.rb
-- spec/spec_helper.rb
-- spec/fixtures/objects/amf0-boolean.bin
-- spec/fixtures/objects/amf0-complex-encoded-string.bin
-- spec/fixtures/objects/amf0-date.bin
-- spec/fixtures/objects/amf0-ecma-ordinal-array.bin
-- spec/fixtures/objects/amf0-empty-string-key-hash.bin
-- spec/fixtures/objects/amf0-hash.bin
-- spec/fixtures/objects/amf0-null.bin
-- spec/fixtures/objects/amf0-number.bin
-- spec/fixtures/objects/amf0-object.bin
-- spec/fixtures/objects/amf0-ref-test.bin
-- spec/fixtures/objects/amf0-strict-array.bin
-- spec/fixtures/objects/amf0-string.bin
-- spec/fixtures/objects/amf0-time.bin
-- spec/fixtures/objects/amf0-typed-object.bin
-- spec/fixtures/objects/amf0-undefined.bin
-- spec/fixtures/objects/amf0-untyped-object.bin
-- spec/fixtures/objects/amf0-xml-doc.bin
 - spec/fixtures/objects/amf3-0.bin
 - spec/fixtures/objects/amf3-array-collection.bin
 - spec/fixtures/objects/amf3-array-ref.bin
@@ -130,18 +127,18 @@ files:
 - spec/fixtures/request/simple-request.bin
 - spec/fixtures/request/simple-response.bin
 - spec/fixtures/request/unsupportedCommandMessage.bin
-- ext/rocketamf_ext/class_mapping.c
-- ext/rocketamf_ext/deserializer.c
-- ext/rocketamf_ext/remoting.c
-- ext/rocketamf_ext/rocketamf_ext.c
-- ext/rocketamf_ext/serializer.c
-- ext/rocketamf_ext/constants.h
-- ext/rocketamf_ext/deserializer.h
-- ext/rocketamf_ext/serializer.h
-- ext/rocketamf_ext/utility.h
-- ext/rocketamf_ext/extconf.rb
+- spec/helpers/class_mapping_test.rb
+- spec/helpers/class_mapping_test2.rb
+- spec/helpers/externalizable_test.rb
+- spec/helpers/fixtures.rb
+- spec/helpers/other_class.rb
+- spec/helpers/ruby_class.rb
+- spec/helpers/test_ruby_class.rb
+- spec/serializer_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/mrpin/mrpin-rocketamf
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options:
@@ -162,15 +159,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Fast AMF serializer/deserializer with remoting request/response wrappers
-  to simplify integration
+summary: Fast AMF3 serializer/deserializer
 test_files:
 - spec/class_mapping_spec.rb
 - spec/deserializer_spec.rb
 - spec/fast_class_mapping_spec.rb
-- spec/messages_spec.rb
-- spec/remoting_spec.rb
 - spec/serializer_spec.rb

data/lib/rocketamf/pure/io_helpers.rb

@@ -1,94 +0,0 @@
-module RocketAMF
-  module Pure
-    module ReadIOHelpers #:nodoc:
-      def read_int8 source
-        source.read(1).unpack('c').first
-      end
-
-      def read_word8 source
-        source.read(1).unpack('C').first
-      end
-
-      def read_double source
-        source.read(8).unpack('G').first
-      end
-
-      def read_word16_network source
-        source.read(2).unpack('n').first
-      end
-
-      def read_int16_network source
-        str = source.read(2)
-        str.reverse! if byte_order_little? # swap bytes as native=little (and we want network)
-        str.unpack('s').first
-      end
-
-      def read_word32_network source
-        source.read(4).unpack('N').first
-      end
-
-      def byte_order
-        if [0x12345678].pack("L") == "\x12\x34\x56\x78"
-          :BigEndian
-        else
-          :LittleEndian
-        end
-      end
-
-      def byte_order_little?
-        (byte_order == :LittleEndian) ? true : false;
-      end
-    end
-
-    module WriteIOHelpers #:nodoc:
-      def pack_integer(integer)
-        integer = integer & 0x1fffffff
-        if(integer < 0x80)
-          [integer].pack('c')
-        elsif(integer < 0x4000)
-          [integer >> 7 & 0x7f | 0x80].pack('c')+
-          [integer & 0x7f].pack('c')
-        elsif(integer < 0x200000)
-          [integer >> 14 & 0x7f | 0x80].pack('c') +
-          [integer >> 7 & 0x7f | 0x80].pack('c') +
-          [integer & 0x7f].pack('c')
-        else
-          [integer >> 22 & 0x7f | 0x80].pack('c')+
-          [integer >> 15 & 0x7f | 0x80].pack('c')+
-          [integer >> 8 & 0x7f | 0x80].pack('c')+
-          [integer & 0xff].pack('c')
-        end
-      end
-
-      def pack_double(double)
-        [double].pack('G')
-      end
-
-      def pack_int8(val)
-        [val].pack('c')
-      end
-
-      def pack_int16_network(val)
-        [val].pack('n')
-      end
-
-      def pack_word32_network(val)
-        str = [val].pack('L')
-        str.reverse! if byte_order_little? # swap bytes as native=little (and we want network)
-        str
-      end
-
-      def byte_order
-        if [0x12345678].pack("L") == "\x12\x34\x56\x78"
-          :BigEndian
-        else
-          :LittleEndian
-        end
-      end
-
-      def byte_order_little?
-        (byte_order == :LittleEndian) ? true : false;
-      end
-    end
-  end
-end

data/lib/rocketamf/pure/remoting.rb

@@ -1,117 +0,0 @@
-require 'rocketamf/pure/io_helpers'
-
-module RocketAMF
-  module Pure
-    # 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, class_mapper=nil
-        stream = StringIO.new(stream) unless StringIO === stream
-        des = Deserializer.new(class_mapper || RocketAMF::ClassMapper.new)
-        des.source = stream
-
-        # Initialize
-        @amf_version = 0
-        @headers = {}
-        @messages = []
-
-        # Read AMF version
-        @amf_version = read_word16_network stream
-
-        # Read in headers
-        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 = des.deserialize(0, nil)
-
-          @headers[name] = RocketAMF::Header.new(name, must_understand, data)
-        end
-
-        # Read in messages
-        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 = des.deserialize(0, nil)
-          if data.is_a?(Array) && data.length == 1 && data[0].is_a?(::RocketAMF::Values::AbstractMessage)
-            data = data[0]
-          end
-
-          @messages << RocketAMF::Message.new(target_uri, response_uri, data)
-        end
-
-        self
-      end
-
-      # Included into RocketAMF::Envelope, this method handles serializing an
-      # AMF request/response into a string
-      def serialize class_mapper=nil
-        ser = Serializer.new(class_mapper || RocketAMF::ClassMapper.new)
-        stream = ser.stream
-
-        # Write version
-        stream << pack_int16_network(@amf_version)
-
-        # Write headers
-        stream << pack_int16_network(@headers.length) # Header count
-        @headers.each_value do |h|
-          # Write header 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
-
-          # Write must understand flag
-          stream << pack_int8(h.must_understand ? 1 : 0)
-
-          # Serialize data
-          stream << pack_word32_network(-1) # length of data - -1 if you don't know
-          ser.serialize(0, h.data)
-        end
-
-        # Write messages
-        stream << pack_int16_network(@messages.length) # Message count
-        @messages.each do |m|
-          # Write 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
-
-          # Write 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
-
-          # Serialize data
-          stream << pack_word32_network(-1) # length of data - -1 if you don't know
-          if @amf_version == 3
-            stream << AMF0_AMF3_MARKER
-            ser.serialize(3, m.data)
-          else
-            ser.serialize(0, m.data)
-          end
-        end
-
-        stream
-      end
-
-      private
-      include RocketAMF::Pure::ReadIOHelpers
-      include RocketAMF::Pure::WriteIOHelpers
-    end
-  end
-end

data/lib/rocketamf/remoting.rb

@@ -1,196 +0,0 @@
-module RocketAMF
-  # Container for the AMF request/response.
-  class Envelope
-    attr_reader :amf_version, :headers, :messages
-
-    def initialize props={}
-      @amf_version = props[:amf_version] || 0
-      @headers = props[:headers] || {}
-      @messages = props[:messages] || []
-    end
-
-    # Populates the envelope from the given stream or string using the given
-    # class mapper, or creates a new one. Returns self for easy chaining.
-    #
-    # Example:
-    #
-    #    req = RocketAMF::Envelope.new.populate_from_stream(env['rack.input'].read)
-    #--
-    # Implemented in pure/remoting.rb RocketAMF::Pure::Envelope
-    def populate_from_stream stream, class_mapper=nil
-      raise AMFError, 'Must load "rocketamf/pure"'
-    end
-
-    # Creates the appropriate message and adds it to <tt>messages</tt> to call
-    # the given target using the standard (old) remoting APIs. You can call multiple
-    # targets in the same request, unlike with the flex remotings APIs.
-    #
-    # Example:
-    #
-    #    req = RocketAMF::Envelope.new
-    #    req.call 'test', "arg_1", ["args", "args"]
-    #    req.call 'Controller.action'
-    def call target, *args
-      raise "Cannot use different call types" unless @call_type.nil? || @call_type == :simple
-      @call_type = :simple
-
-      msg_num = messages.length+1
-      @messages << RocketAMF::Message.new(target, "/#{msg_num}", args)
-    end
-
-    # Creates the appropriate message and adds it to <tt>messages</tt> using the
-    # new flex (RemoteObject) remoting APIs. You can only make one flex remoting
-    # call per envelope, and the AMF version must be set to 3.
-    #
-    # Example:
-    #
-    #    req = RocketAMF::Envelope.new :amf_version => 3
-    #    req.call_flex 'Controller.action', "arg_1", ["args", "args"]
-    def call_flex target, *args
-      raise "Can only call one flex target per request" if @call_type == :flex
-      raise "Cannot use different call types" if @call_type == :simple
-      raise "Cannot use flex remoting calls with AMF0" if @amf_version != 3
-      @call_type = :flex
-
-      flex_msg = RocketAMF::Values::RemotingMessage.new
-      target_parts = target.split(".")
-      flex_msg.operation = target_parts.pop # Use pop so that a missing source is possible without issues
-      flex_msg.source = target_parts.pop
-      flex_msg.body = args
-      @messages << RocketAMF::Message.new('null', '/2', flex_msg) # /2 because it always sends a command message before
-    end
-
-    # Serializes the envelope to a string using the given class mapper, or creates
-    # a new one, and returns the result
-    #--
-    # Implemented in pure/remoting.rb RocketAMF::Pure::Envelope
-    def serialize class_mapper=nil
-      raise AMFError, 'Must load "rocketamf/pure"'
-    end
-
-    # Builds response from the request, iterating over each method call and using
-    # the return value as the method call's return value. Marks as envelope as
-    # constructed after running.
-    #--
-    # Iterate over all the sent messages. If they're somthing we can handle, like
-    # a command message, then simply add the response message ourselves. If it's
-    # a method call, then call the block with the method and args, catching errors
-    # for handling. Then create the appropriate response message using the return
-    # value of the block as the return value for the method call.
-    def each_method_call request, &block
-      raise 'Response already constructed' if @constructed
-
-      # Set version from response
-      # Can't just copy version because FMS sends version as 1
-      @amf_version = request.amf_version == 3 ? 3 : 0 
-
-      request.messages.each do |m|
-        # What's the request body?
-        case m.data
-        when Values::CommandMessage
-          # Pings should be responded to with an AcknowledgeMessage built using the ping
-          # Everything else is unsupported
-          command_msg = m.data
-          if command_msg.operation == Values::CommandMessage::CLIENT_PING_OPERATION
-            response_value = Values::AcknowledgeMessage.new(command_msg)
-          else
-            e = Exception.new("CommandMessage #{command_msg.operation} not implemented")
-            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)
-          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)
-            response_value = body
-          else
-            acknowledge_msg.body = body
-            response_value = acknowledge_msg
-          end
-        else
-          # Standard response message
-          response_value = dispatch_call :method => m.target_uri, :args => m.data, :source => m, :block => block
-        end
-
-        target_uri = m.response_uri
-        target_uri += response_value.is_a?(Values::ErrorMessage) ? '/onStatus' : '/onResult'
-        @messages << ::RocketAMF::Message.new(target_uri, '', response_value)
-      end
-
-      @constructed = true
-    end
-
-    # Returns the result of a response envelope, or an array of results if there
-    # are multiple action call messages. It automatically unwraps flex-style
-    # RemoteObject response messages, where the response result is inside a
-    # RocketAMF::Values::AcknowledgeMessage.
-    #
-    # Example:
-    #
-    #    req = RocketAMF::Envelope.new
-    #    req.call('TestController.test', 'first_arg', 'second_arg')
-    #    res = RocketAMF::Envelope.new
-    #    res.each_method_call req do |method, args|
-    #      ['a', 'b']
-    #    end
-    #    res.result     #=> ['a', 'b']
-    def result
-      results = []
-      messages.each do |msg|
-        if msg.data.is_a?(Values::AcknowledgeMessage)
-          results << msg.data.body
-        else
-          results << msg.data
-        end
-      end
-      results.length > 1 ? results : results[0]
-    end
-
-    # Whether or not the response has been constructed. Can be used to prevent
-    # serialization when no processing has taken place.
-    def constructed?
-      @constructed
-    end
-
-    # Return the serialized envelope as a string
-    def to_s
-      serialize
-    end
-
-    def dispatch_call p #:nodoc:
-      begin
-        p[:block].call(p[:method], p[:args])
-      rescue Exception => e
-        # Create ErrorMessage object using the source message as the base
-        Values::ErrorMessage.new(p[:source], e)
-      end
-    end
-  end
-
-  # RocketAMF::Envelope header
-  class Header
-    attr_accessor :name, :must_understand, :data
-
-    def initialize name, must_understand, data
-      @name = name
-      @must_understand = must_understand
-      @data = data
-    end
-  end
-
-  # RocketAMF::Envelope message
-  class Message
-    attr_accessor :target_uri, :response_uri, :data
-
-    def initialize target_uri, response_uri, data
-      @target_uri = target_uri
-      @response_uri = response_uri
-      @data = data
-    end
-  end
-end