rails-extjs-direct 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,5 +1,5 @@
 = rails-extjs-direct
-THIS GEM IS UNDER DEVELOPMENT AND WILL NOT YET WORK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+THIS GEM IS UNDER DEVELOPMENT AND NOT A FULL IMLPLEMENTATION OF THE Ext.Direct specification
 
 http://rubyforge.org/projects/rails-extjs/
 http://www.extjs.com
@@ -13,12 +13,48 @@ Ext.Direct in Rails is implementede with Rack Middleware.
 
 == SYNOPSIS:
 
+* STEP1:  Attach Rack MiddleWare to Rails config in environment.rb.  The "/direct" bit is the url
+designated as Ext.Direct request.
+
+require 'rails-extjs-direct'
+Rails::Initializer.run do |config|
+  config.middleware.use Rails::ExtJS::Direct::RemotingProvider, "/direct"
+  .
+  .
+  .
+end
+
+* STEP2:  Include Rails::ExtJS::Direct::Controller mixin into each controller you wish to be "Directable":
+
+class CompanyController < ApplicationController
+  include Rails::ExtJS::Direct::Controller
+
+  def destroy
+    # The Direct::Controller mixin will provide an instance variable @xrequest to each action.
+    # @xrequest is an instance of class XRequest provided by the rails-extjs-direct gem.
+    # XRequest contains accessor methods for each parameter in the Ajax request, including "tid", "type",
+    # "data", and "id"
+    #
+    # You must always render an instance of XResponse.  Use the @request instance when instantiating
+    # your XResponse.  This will ensure that Ext.Direct receives the correct "tid" (transaction id).
+    #
+    res = XResponse.new(@xrequest)
+    res.status = true
+    res.message = "Company#destroy"
+    res.result = {:foo => 'bar'}
+    render(:json => res)
+  end
+end
+
+* STEP 3 -- Define your Ext.Direct client-API
+
 <script>
 Ext.Direct.addProvider({
-    url: '/admin/rpc',  //<-- Note the url corresponding to Admin above.
+    // Set url corresponding to:  config.middleware.use Rails::ExtJS::Direct::RemotingProvider, "/direct"
+    url: '/direct',
     type: 'remoting',
     actions: {
-        Users : [
+        Company : [
             {name: 'load', len: 1},
             {name: 'save', len: 2},
             {name: 'create', len: 1},
@@ -26,34 +62,26 @@ Ext.Direct.addProvider({
         ]
     }
 });
+
+// The following series of actions will generate just 1 Ajax request.
+Company.create({name: "Slate International"});
+Company.destroy(1, function(result, response) { console.info(arguments);});
+Company.destroy(2);
+Company.destroy(3);
+
 </script>
 
 == REQUIREMENTS:
 
-merb-parts
-
 == INSTALL:
 
-sudo gem install merb-extjs-parts
-
-IMPORTANT:  This gem includes a required javascript file named "merb-extjs-direct.js" in the root of this gem.
-Currently you MUST copy this file to your /public/javascripts directory and included it immediately the ext
-framework's assets (ie: immediately after "ext-all.js").
-
-merb-extjs-direct.js contains a couple of simple overrides of the Ext.Direct library which will rename two
-HTTP request parameters to be more Merb/Rails-like.  By default, Ext.Direct uses the word "action" where Merb
-uses "controller" and "method" vs "action".  Confusing, eh?  The HTTP params are actually renamed xcontroller
-and xaction to not interfere with Merb reserved words.  If you don't see "xcontroller" / "xaction" params
-in your Ajax requests, make sure you've got merb-ext-direct.js included.
-
-In the future, I'll have >rake install automaticlly copy this file to /public/javascripts (Would anyone like to
-contribute some code to do that?)
+sudo gem install rails-extjs-direct
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 FIX
+Copyright (c) 2009 Chris Scott
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/rails-extjs-direct/mixins/action_controller/direct_controller.rb

@@ -7,6 +7,6 @@ module Rails::ExtJS::Direct::Controller
     end
 
     def extjs_direct_prepare_request
-        params["xrequest"] = "XRequest.new" # <-- TODO: prepare XRequest
+        @xrequest = XRequest.new(params)
     end
 end

data/lib/rails-extjs-direct/rack/remoting_provider.rb

@@ -1,54 +1,49 @@
+
 require 'json'
 class Rails::ExtJS::Direct::RemotingProvider
     def initialize(app, rpath)
         @app = app
         @router_path = rpath
-        @logger = RAILS_DEFAULT_LOGGER
-        @params = {}
     end
 
     def call(env)
-        @logger.info('---------------- PARAMS ---------------------')
-        #@logger.info(env.to_yaml)
-
-
-        @logger.info(env["action_controller.request.request_parameters"].to_yaml)
+        if env["PATH_INFO"].match("^"+@router_path)
+            output = []
+            parse(env["action_controller.request.request_parameters"]).each do |req|
+                # have to dup the env for each request
+                request_env = env.dup
 
+                # pop poorly-named Ext.Direct params off.
+                controller = req.delete("action").downcase
+                action =  req.delete("method")
 
-        if env["PATH_INFO"].match("^"+@router_path)
-            parse_params(env)
+                # set env URI and PATH_INFO for each request
+                request_env["PATH_INFO"] = "/#{controller}/#{action}"
+                request_env["REQUEST_URI"] = "/#{controller}/#{action}"
 
-            @logger.info('env: ' + env.to_yaml)
+                # set request params
+                request_env["action_controller.request.request_parameters"] = req
 
-            output = []
-            ["company", "users"].each do |c|
-                env["PATH_INFO"] = "/#{c}/load"
-                env["REQUEST_URI"] = "/#{c}/load"
-                status, headers, response = @app.call(env)
+                # call the app!
+                status, headers, response = @app.call(request_env)
                 output << response.body
-                @logger.info('---------------------- RESPONSE ----------------------------')
-                @logger.info(response.body)
             end
+            # join all responses together
             res = output.join(',')
+
+            # [wrap in array] if multiple responses.  Each controller response will have returned json already
+            # so we don't want to re-encode.
             res = "[" + res + "]" if output.length > 1
 
-            #status, headers, response = @app.call(env)
+            # return response
             [200, {"Content-Type" => "text/html"}, res]
-
         else
             @app.call(env)
         end
     end
 
-    def parse_params(env)
-        @params = env["REQUEST_METHOD"] == "GET" ? CGI.parse(env["QUERY_STRING"]) : env["rack.request.form_hash"]
-        #@params.each do |k,v|
-        #    @params[k] = @params[k].first
-        #end
-        #@params["data"] = JSON.parse(@params["data"]) if @params["data"]
-        #@logger.info('params: ' + @params.to_yaml)
-        #env["QUERY_STRING"] = {}
-
+    def parse(data)
+        return (data["_json"]) ? data["_json"] : [data]
     end
 
 end

data/lib/rails-extjs-direct.rb

@@ -4,7 +4,7 @@
 module Rails
     module ExtJS
         module Direct
-            VERSION = '0.0.2'
+            VERSION = '0.0.3'
         end
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rails-extjs-direct
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Chris Scott
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-30 00:00:00 -04:00
+date: 2009-05-01 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -63,7 +63,7 @@ files:
 - test/test_helper.rb
 - test/test_rails-extjs-direct.rb
 has_rdoc: true
-homepage: THIS GEM IS UNDER DEVELOPMENT AND WILL NOT YET WORK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+homepage: THIS GEM IS UNDER DEVELOPMENT AND NOT A FULL IMLPLEMENTATION OF THE Ext.Direct specification
 post_install_message: PostInstall.txt
 rdoc_options: 
 - --main