rack-amf 0.0.4 → 1.0.0

data/README.rdoc

@@ -1,6 +1,8 @@
 == DESCRIPTION:
 
-A full featured AMF gateway implemented as a Rack middleware. Includes fully compliant AMF0/AMF3 serializers and deserializers and a Rack middleware that includes a service handler and the ability to easily handle requests yourself if you don't want to use the service handler.
+A full featured AMF gateway implemented as a Rack middleware. Includes a service
+handler mode that simplifies service mappings, as well as a mode that simply
+processes requests and lets you handle the response how you want.
 
 == INSTALL:
 
@@ -12,28 +14,35 @@ config.ru:
 
   require 'rack/amf'
   use Rack::AMF
-  
+
+  class User
+    attr_accessor :username
+  end
+
   class TestService
     def sayHello
       'Hello'
     end
+
+    def getUser
+      u = User.new
+      u.username = "user"
+      u
+    end
   end
   
   Rack::AMF::Environment.register_service 'TestService', TestService.new
+  RocketAMF::ClassMapper.define do |m|
+    m.map :as => 'User', :ruby => 'User'
+  end
   
   run lambda {|env| [200, { 'Content-Type' => 'text/plain', 'Content-Length' => '16' }, ["Rack AMF gateway"] ] }
 
-== TODO:
-
-* Write some Rails helpers so that using Rack AMF as a Rails Metal is easy.
-  * Support ActiveRecord serialization/deserialization
-  * Auto-map to Rails controllers
-
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 Tony Hillerson based on work by Aaron Smith
+Copyright (c) 2010 Stephen Augenstein
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -2,53 +2,38 @@ require 'rubygems'
 require 'rake'
 require 'rake/rdoctask'
 require 'rake/gempackagetask'
-
 require 'spec/rake/spectask'
 
-desc 'Default: run the specs.'
-task :default => :spec
-
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = ['--options', 'spec/spec.opts']
-end
-
-desc 'Generate documentation for the rubyamf plugin.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Rack AMF'
-  rdoc.options << '--line-numbers' << '--main' << 'README.rdoc'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
 spec = Gem::Specification.new do |s|
-  s.name    = 'rack-amf'
-  s.version = '0.0.4'
-  s.summary = 'AMF serializer/deserializer and AMF gateway packaged as a rack middleware'
+  s.name     = 'rack-amf'
+  s.version  = '1.0.0'
+  s.summary  = 'AMF gateway packaged as a rack middleware'
+  s.authors  = ['Stephen Augenstein']
+  s.email    = 'perl.programmer@gmail.com'
+  s.homepage = 'http://github.com/warhammerkid/rack-amf'
 
-  s.files        = FileList['README.rdoc', 'Rakefile', 'lib/**/*.rb', 'spec/**/*.rb', 'spec/**/*.bin', 'spec/spec.opts']
-  s.require_path = 'lib'
+  s.platform     = Gem::Platform::RUBY
+  s.rdoc_options << '--line-numbers' << '--main' << 'README.rdoc'
+  s.rdoc_options += FileList['README.rdoc']
+  s.files        = FileList['README.rdoc', 'Rakefile', 'lib/**/*.rb', 'spec/**/*.{rb,opts}']
   s.test_files   = Dir[*['spec/**/*_spec.rb']]
 
-  s.has_rdoc         = true
-  s.extra_rdoc_files = ['README.rdoc']
-  s.rdoc_options     = ['--line-numbers', '--main', 'README.rdoc']
+  s.add_dependency('RocketAMF')
+end
 
-  s.authors  = ['Tony Hillerson', 'Stephen Augenstein']
-  s.email    = 'perl.programmer@gmail.com'
-  s.homepage = 'http://github.com/warhammerkid/rack-amf'
+desc 'Default: Run the specs'
+task :default => :spec
 
-  s.platform = Gem::Platform::RUBY
-end
+Rake::GemPackageTask.new(spec).define
 
-Rake::GemPackageTask.new spec do |pkg|
-  pkg.need_tar = true
-  pkg.need_zip = true
+desc "Generate documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'rack-amf'
+  rdoc.options  = spec.rdoc_options
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-desc 'Generate a gemspec file'
-task :gemspec do
-  File.open("#{spec.name}.gemspec", 'w') do |f|
-    f.write spec.to_ruby
-  end
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', 'spec/spec.opts']
 end

data/lib/rack/amf/environment.rb

@@ -1,8 +1,11 @@
 module Rack::AMF
+  # Manages services if using the ServiceManager middleware, as well as the url
+  # to restrict AMF requests to, and the mode. The URL and mode are automatically
+  # set when you call <code>use Rack::AMF, options</code> in your rack
+  # application.
   module Environment
     class << self
-      attr_accessor :url, :mode, :debug, :services
-      debug = false # Set to off by default
+      attr_accessor :url, :mode, :services
 
       # Used to register a service for use with the ServiceManager middleware.
       # To register a service, simply pass in the root path for the service and
@@ -21,14 +24,8 @@ module Rack::AMF
       # in through rack
       def populate options={} #:nodoc:
         url = options[:url] if options.key?(:url)
-        debug = options[:debug] if options.key?(:debug)
         mode = options[:mode] if options.key?(:mode)
       end
-
-      def log data #:nodoc:
-        return if !debug
-        puts data
-      end
     end
   end
 end

data/lib/rack/amf/middleware/pass_through.rb

@@ -1,10 +1,11 @@
 require 'rack/amf/middleware'
 
 module Rack::AMF::Middleware #:nodoc:
-  # Middleware which simply passes AMF requests through. Sets env['rack-amf.request']
-  # to the Rack::AMF::Request object and env['rack-amf.response'] to the
-  # Rack::AMF::Response object. Simply modify the response as necessary and it
-  # will be automatically serialized and sent.
+  # Middleware which simply passes AMF requests through. If the request is a
+  # valid AMF request to be handled, sets <tt>env ['rack-amf.request']</tt> to
+  # an initialized RocketAMF::Request object and <tt>env ['rack-amf.response']</tt>
+  # to a RocketAMF::Response object. Simply modify the response as necessary
+  # and it will be automatically serialized and sent.
   class PassThrough
     include Rack::AMF::Middleware
 

data/lib/rack/amf/middleware/service_manager.rb

@@ -1,4 +1,5 @@
 require 'rack/amf/middleware'
+require 'logger'
 
 module Rack::AMF::Middleware #:nodoc:
   # Internal AMF handler, it uses the ServiceManager to handle request service
@@ -12,13 +13,17 @@ module Rack::AMF::Middleware #:nodoc:
     end
 
     def handle env
-      env['rack-amf.response'].each_method_call do |method, args|
-        handle_method method, args
+      req = env['rack-amf.request']
+      res = env['rack-amf.response']
+
+      logger = ::Logger.new(env['rack.errors'])
+      res.each_method_call req do |method, args|
+        handle_method method, args, logger
       end
     end
 
     private
-    def handle_method method, args
+    def handle_method method, args, logger = nil
       path = method.split('.')
       method_name = path.pop
       path = path.join('.')
@@ -26,11 +31,14 @@ module Rack::AMF::Middleware #:nodoc:
       s = Rack::AMF::Environment.services
       if s[path]
         if s[path].respond_to?(method_name)
+          logger.info("Handling call to #{path}##{method_name}") if logger
           s[path].send(method_name, *args)
         else
+          logger.error("Service #{path} does not respond to #{method_name}") if logger
           raise "Service #{path} does not respond to #{method_name}"
         end
       else
+        logger.error("Service #{path} does not respond to #{method_name}") if logger
         raise "Service #{path} does not exist"
       end
     end

data/lib/rack/amf/middleware.rb

@@ -14,7 +14,8 @@ module Rack::AMF
       return @app.call(env) unless should_handle?(env)
 
       # Wrap request and response
-      env['rack-amf.request'] = Request.new(env)
+      env['rack.input'].rewind
+      env['rack-amf.request'] = Request.new.populate_from_stream(env['rack.input'].read)
       env['rack-amf.response'] = Response.new(env['rack-amf.request'])
 
       # Call handle on "inheriting" class

data/lib/rack/amf/request.rb

@@ -1,21 +1,8 @@
 module Rack::AMF
-  # Rack specific wrapper around AMF::Request
-  class Request
-    attr_reader :raw_request
-
-    def initialize env
-      env['rack.input'].rewind
-      @raw_request = ::AMF::Request.new.populate_from_stream(env['rack.input'].read)
-    end
-
-    # Returns the request AMF version
+  class Request < RocketAMF::Request #:nodoc:
     def version
-      raw_request.amf_version
-    end
-
-    # Returns all messages in the request
-    def messages
-      @raw_request.messages
+      $stderr.puts("DEPRECATION WARNING: use amf_version instead of version")
+      amf_version
     end
   end
 end

data/lib/rack/amf/response.rb

@@ -1,77 +1,18 @@
 module Rack::AMF
-  # Rack specific wrapper around AMF::Response
-  class Response
-    attr_reader :raw_response
-
-    V = ::AMF::Values
-
+  class Response < RocketAMF::Response #:nodoc:
     def initialize request
       @request = request
-      @raw_response = ::AMF::Response.new
-      @raw_response.amf_version = @request.version == 3 ? 3 : 0 # Can't just copy version because FMS sends version as 1
+      super()
     end
 
     # Builds response, iterating over each method call and using the return value
     # as the method call's return value
-    #--
-    # 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 &block
-      raise 'Response already constructed' if @constructed
-
-      @request.messages.each do |m|
-        # What's the request body?
-        case m.data
-        when V::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 == V::CommandMessage::CLIENT_PING_OPERATION
-            response_value = V::AcknowledgeMessage.new(command_msg)
-          else
-            response_value = V::ErrorMessage.new(Exception.new("CommandMessage #{command_msg.operation} not implemented"), command_msg)
-          end
-        when V::RemotingMessage
-          # Using RemoteObject style message calls
-          remoting_msg = m.data
-          acknowledge_msg = V::AcknowledgeMessage.new(remoting_msg)
-          body = dispatch_call :method => remoting_msg.source+'.'+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?(V::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?(V::ErrorMessage) ? '/onStatus' : '/onResult'
-        @raw_response.messages << ::AMF::Message.new(target_uri, '', response_value)
-      end
-
-      @constructed = true
-    end
-
-    # Return the serialized response as a string
-    def to_s
-      raw_response.serialize
-    end
-
-    private
-    def dispatch_call p
-      begin
-        p[:block].call(p[:method], p[:args])
-      rescue Exception => e
-        # Create ErrorMessage object using the source message as the base
-        V::ErrorMessage.new(p[:source], e)
+    def each_method_call *args, &block
+      if args.length == 0
+        $stderr.puts("DEPRECATION WARNING: Use each_method_call request, &block instead of each_method_call &block")
+        super(@request, &block)
+      else
+        super(*args, &block)
       end
     end
   end

data/lib/rack/amf.rb

@@ -1,7 +1,35 @@
+require 'rubygems'
 require 'rack'
-require 'amf'
+require 'rocketamf'
+
 require 'rack/amf/environment'
 
+module Rack #:nodoc:
+end
+
+# Simple rack middleware that processes amf requests as a standard AMF gateway.
+# To use, simply run <tt>use Rack::AMF</tt> in your rackup script. rack-amf
+# support two options: <tt>:url</tt> and <tt>:mode</tt>. Setting the url makes
+# rack-amf only handle AMF requests that match the given url. The mode can
+# either by <tt>:service_manager</tt> or <tt>:pass_through</tt>, defaulting to
+# <tt>:service_manager</tt>.
+#
+# In pass-through mode, rack-amf will set <tt>env ["rack-amf.request"]</tt> and
+# <tt>env ["rack-amf.response"]</tt>. See <tt>Rack::AMF::Middleware::PassThrough</tt>
+# for more information.
+#
+# In service-manager mode, you can register a given object to handle all method
+# calls for a given path. AMF calls to "TestService.sayHello" will call the
+# object's <tt>sayHello</tt> method and return "Hello".
+#
+# Example:
+#   use Rack::AMF :url => "/amf"
+#   class TestService
+#     def sayHello
+#       'Hello'
+#     end
+#   end
+#   Rack::AMF::Environment.register_service 'TestService', TestService.new
 module Rack::AMF
   def self.new app, options={} #:nodoc:
     # Set default mode
@@ -18,4 +46,16 @@ module Rack::AMF
       raise "Invalide mode: #{options[:mode]}"
     end
   end
+end
+
+# For compatibility
+module AMF #:nodoc:
+  def self.const_missing const
+    if const == :ClassMapper
+      $stderr.puts("DEPRECATION WARNING: Please use RocketAMF::ClassMapper instead of AMF::ClassMapper")
+      AMF.const_set(:ClassMapper, RocketAMF::ClassMapper)
+    else
+      super(const)
+    end
+  end
 end

data/spec/{rack/service_manager_spec.rb → service_manager_spec.rb}

@@ -1,5 +1,4 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-require 'rack/amf'
+require File.dirname(__FILE__) + '/spec_helper.rb'
 require 'rack/amf/middleware/service_manager'
 
 describe Rack::AMF::Middleware::ServiceManager do

data/spec/spec.opts

@@ -1 +1,2 @@
---colour
+--colour
+-f nested

data/spec/spec_helper.rb

@@ -8,27 +8,4 @@ end
 require 'spec/autorun'
 
 $:.unshift(File.dirname(__FILE__) + '/../lib')
-require 'amf'
-
-def request_fixture(binary_path)
-  File.open(File.dirname(__FILE__) + '/fixtures/request/' + binary_path).read
-end
-
-def object_fixture(binary_path)
-  File.open(File.dirname(__FILE__) + '/fixtures/objects/' + binary_path).read
-end
-
-def create_rack_request(binary_path)
-  require 'rack/amf/request'
-  env = {'rack.input' => StringIO.new(request_fixture(binary_path))}
-  Rack::AMF::Request.new(env)
-end
-
-# Add reset support to ClassMapping
-module AMF
-  class ClassMapping
-    def reset
-      @mappings = nil
-    end
-  end
-end
+require 'rack/amf'

metadata

@@ -1,43 +1,38 @@
 --- !ruby/object:Gem::Specification 
 name: rack-amf
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors: 
-- Tony Hillerson
 - Stephen Augenstein
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-25 00:00:00 -04:00
+date: 2010-03-20 00:00:00 -04:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: RocketAMF
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: 
 email: perl.programmer@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - README.rdoc
 - Rakefile
-- lib/amf/class_mapping.rb
-- lib/amf/common.rb
-- lib/amf/constants.rb
-- lib/amf/pure/deserializer.rb
-- lib/amf/pure/io_helpers.rb
-- lib/amf/pure/remoting.rb
-- lib/amf/pure/serializer.rb
-- lib/amf/pure.rb
-- lib/amf/values/array_collection.rb
-- lib/amf/values/messages.rb
-- lib/amf/values/typed_hash.rb
-- lib/amf/version.rb
-- lib/amf.rb
 - lib/rack/amf/environment.rb
 - lib/rack/amf/middleware/pass_through.rb
 - lib/rack/amf/middleware/service_manager.rb
@@ -45,60 +40,8 @@ files:
 - lib/rack/amf/request.rb
 - lib/rack/amf/response.rb
 - lib/rack/amf.rb
-- spec/amf/class_mapping_set_spec.rb
-- spec/amf/class_mapping_spec.rb
-- spec/amf/deserializer_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
-- spec/rack/request_spec.rb
-- spec/rack/response_spec.rb
-- spec/rack/service_manager_spec.rb
+- spec/service_manager_spec.rb
 - spec/spec_helper.rb
-- spec/fixtures/objects/amf0-boolean.bin
-- spec/fixtures/objects/amf0-date.bin
-- spec/fixtures/objects/amf0-ecma-ordinal-array.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-typed-object.bin
-- spec/fixtures/objects/amf0-undefined.bin
-- spec/fixtures/objects/amf0-untyped-object.bin
-- spec/fixtures/objects/amf3-0.bin
-- spec/fixtures/objects/amf3-arrayRef.bin
-- spec/fixtures/objects/amf3-bigNum.bin
-- spec/fixtures/objects/amf3-date.bin
-- spec/fixtures/objects/amf3-datesRef.bin
-- spec/fixtures/objects/amf3-dynObject.bin
-- spec/fixtures/objects/amf3-emptyArray.bin
-- spec/fixtures/objects/amf3-emptyArrayRef.bin
-- spec/fixtures/objects/amf3-emptyStringRef.bin
-- spec/fixtures/objects/amf3-false.bin
-- spec/fixtures/objects/amf3-graphMember.bin
-- spec/fixtures/objects/amf3-hash.bin
-- spec/fixtures/objects/amf3-largeMax.bin
-- spec/fixtures/objects/amf3-largeMin.bin
-- spec/fixtures/objects/amf3-max.bin
-- spec/fixtures/objects/amf3-min.bin
-- spec/fixtures/objects/amf3-mixedArray.bin
-- spec/fixtures/objects/amf3-null.bin
-- spec/fixtures/objects/amf3-objRef.bin
-- spec/fixtures/objects/amf3-primArray.bin
-- spec/fixtures/objects/amf3-string.bin
-- spec/fixtures/objects/amf3-stringRef.bin
-- spec/fixtures/objects/amf3-symbol.bin
-- spec/fixtures/objects/amf3-true.bin
-- spec/fixtures/objects/amf3-typedObject.bin
-- spec/fixtures/request/acknowledge-response.bin
-- spec/fixtures/request/amf0-error-response.bin
-- spec/fixtures/request/commandMessage.bin
-- spec/fixtures/request/remotingMessage.bin
-- spec/fixtures/request/simple-response.bin
 - spec/spec.opts
 has_rdoc: true
 homepage: http://github.com/warhammerkid/rack-amf
@@ -109,6 +52,7 @@ rdoc_options:
 - --line-numbers
 - --main
 - README.rdoc
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -129,15 +73,6 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: AMF serializer/deserializer and AMF gateway packaged as a rack middleware
+summary: AMF gateway packaged as a rack middleware
 test_files: 
-- spec/amf/class_mapping_set_spec.rb
-- spec/amf/class_mapping_spec.rb
-- spec/amf/deserializer_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
-- spec/rack/request_spec.rb
-- spec/rack/response_spec.rb
-- spec/rack/service_manager_spec.rb
+- spec/service_manager_spec.rb