extjs-direct 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-04-09
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/merb-extjs-direct.rb
+lib/merb-extjs-direct/xrequest.rb
+lib/merb-extjs-direct/xresponse.rb
+lib/merb-extjs-direct/xexception.rb
+lib/merb-extjs-direct/mixins/remoting_provider.rb
+test/test_merb-extjs-direct.rb

data/README.rdoc

@@ -0,0 +1,48 @@
+= merb-ext-direct
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/merb-extjs-direct.rb'
+
+Hoe.new('extjs-direct', Merb::ExtJS::Direct::VERSION) do |p|
+  # p.rubyforge_name = 'merb_extjs_directx' # if different than lowercase project name
+  p.developer('christocracy', 'chris.scott@extjs.com')
+end
+
+# vim: syntax=Ruby

data/lib/merb-extjs-direct.rb

@@ -0,0 +1,13 @@
+module Merb
+    module ExtJS
+        module Direct
+            VERSION = '0.0.1'
+        end
+    end
+end
+
+require File.join(File.dirname(__FILE__), 'merb-extjs-direct', 'xrequest')
+require File.join(File.dirname(__FILE__), 'merb-extjs-direct', 'xresponse')
+require File.join(File.dirname(__FILE__), 'merb-extjs-direct', 'xexception')
+require File.join(File.dirname(__FILE__), 'merb-extjs-direct', 'mixins', 'remoting_provider')
+

data/lib/merb-extjs-direct/mixins/remoting_provider.rb

@@ -0,0 +1,156 @@
+##
+# Meb::ExtJS::Direct::RemotingProvider
+# @mixin
+# This is a mixin which provides support Merb support for ExtJS's Ext.Direct mechanism in Ext3.x
+# <h3>Defining and registering the Ext.Direct api</h3>
+# <code>
+# <script>
+#   var api : {
+#       url: 'my_controller/rpc',
+#       type: 'remoting',
+#       actions: []
+#   };
+#
+#   Ext.onReady(function() {
+#       // Add some actions from ArtistPart
+#       api.actions.push({
+#           ArtistPart : [
+#               {"name" : "create"},
+#               {"name" : "destroy"}
+#           ];
+#       });
+#       .
+#       .
+#       .
+#       // add some more actions from AlbumPart
+#       api.actions.push({
+#           AlbumPart : [
+#               {"name" : "create"},
+#               {"name" : "destroy"}
+#           ];
+#       });
+#
+#       // register api with Ext.Direct
+#       Ext.Direct.addProvider(api);
+#
+#       // Executing Ext.Direct actions.  (very much like using irb console)
+#       ArtistPart.destroy(1);
+#       AlbumCreate.create({name : "Joe Puke and the Chunky Bits"});
+#
+#   });
+# </script>
+# </code>
+#
+# <h3>Configuring your Merb Ext.Direct controller</h3>
+# <code>
+# class MyController
+#     include Merb::Ext::Direct::RemotingProvider   # <-- include this mixin.
+# end
+# </code>
+#
+# <p>By including RemotingProvider mixin, your controller will have added to it a single action called "rpc"
+# with which you can send all you Ext.Direct actions to.  Take note of the url specified in the first step.</p>
+#
+# <h3>Merb-parts</h3>
+# Ext.Direct is implemented in Merb by taking advantage of "Parts".  The nice thing about parts is that they
+# have both a view (for rendering you Ext controls and api along with a controller for executing your api actions.
+#
+#
+#
+# The Merb RemotingProvider mixin takes advantage of the merb-parts gem.
+#
+# Ext.Direct router
+# @usage include Ext::Direct::RemotingProvider
+# @author Chris Scott
+# @TODO before_actions
+#
+module Merb::ExtJS::Direct
+    module RemotingProvider
+
+        # standard ruby method called when some class does:
+        # include Merb::ExtJS::Direct::RemotingProvider
+        def self.included(base)
+            # must explicity specify controller-actions to make callable.  security-wise, this is a *good* thing.
+            # just one action is added.
+            base.show_action(:rpc)
+        end
+
+        ##
+        # rpc
+        # remote procedure call handler for Ext.direct requests.
+        #
+        def rpc
+            if !request.ajax? && !params["extAction"]
+                return "Ext::Direct::RemotingProvider#rpc -- This method is an ajax-handler only"
+            end
+
+            is_form = false
+            is_upload = false
+            if params["extAction"] && params["extMethod"]
+                # create fake response here.
+                is_form = true
+                is_upload = params.delete("extUpload") == 'true'
+
+                request = {
+                    "xcontroller"   => params.delete("extAction"),
+                    "xaction"       => params.delete("extMethod"),
+                    "type"          => "rpc",
+                    "id"            => params.delete("id"),
+                    "tid"           => params.delete("extTID"),
+                    "format"        => params.delete("format"),
+                    "data"          => params
+                }
+                params.delete('controller')
+                params.delete('action')
+                res = "<html><body><textarea>#{handle_request(request).gsub(/&quot;/, "\&quot;")}</textarea></body></html>"
+                return res
+            elsif (params[:inflated_object])
+                # multiple requests found.  I'm not sure how this "inflated_object" mechanism works.  This is Merb magic?
+                # controllers always return a string, so each response has already been json-encoded.
+                # since we're dealing with multiple requests here, we have to manually string-concat-wrap the retured
+                # string-of-json.
+                #
+                return "[" + params[:inflated_object].collect {|req| handle_request(req)}.join(',') + "]"
+            else
+                ##
+                # just a single request found
+                #
+                return handle_request(params)
+            end
+        end
+
+        ##
+        #
+        protected
+        #
+        ##
+
+        ##
+        # handle_request
+        # # @throws XException when anything goes wrong to gracefully handle on client.
+        # @see Merb::Controller#part method, google: "merb parts".  A Merb "part" is a kind of sub-controller
+        # with its onwn view capabilites but cannot be directly routed-to.  Using part() method here is similar
+        # to using Ext.getCmp(id), eg: part(req.controller => req.action) ~ Ext.getCmp(controller).doSomething(action);
+        # However, unlike Ext.getCmp(), part(controller => action) returns a string to be added to the render stream
+        # and not a component instance, just as all merb render actions.
+        #
+        def handle_request(req)
+            req = XRequest.new(req)
+
+            begin
+                # here be your Ext.direct.Transaction as a ruby Hash.
+                # turn it into an offical ruby XRequest instance.
+                # constantize the "controller" (ie: String "ArtistPart" becomes Class ArtistPart) and send "action" to it.
+                # NOTE:  Extlib has nothing to do with ExtJS -- just a coincidence.  Extlib is a Merb gem.
+                return part(Extlib::Inflection.constantize(req.controller) => req.action, :xrequest => req)
+            rescue XException => e
+                # caught an XException...return an Ext.Direct-friendly XExceptionResponse
+                return XExceptionResponse.new(req, e).to_json
+            rescue StandardError => e
+                # might be an invalid controller and/or action if we got here.
+                # we can be more specific here and trap on NameError if we wish, intead of base StandardError
+                return XExceptionResponse.new(req, e).to_json
+            end
+        end
+    end
+end

data/lib/merb-extjs-direct/xexception.rb

@@ -0,0 +1,36 @@
+##
+# XException
+# General exception class for all Ext application exceptions.
+# @author Chris Scott
+#
+class XException < StandardError
+end
+
+##
+# XExceptionResponse
+# A special extension of XResponse for returning responses where an Exception was raised.  includes a back-trace in the response which
+# should probably be turned on with a debug switch only.
+# @author Chris Scott
+#
+class XExceptionResponse < XResponse
+    attr_accessor :where
+
+    ##
+    # initialize
+    # @param {XRequest}
+    # @param {StandardError}
+    #
+    def initialize(req, e)
+        super(req)
+        @type       = 'exception'
+        @message    = e.message
+        @where      = e.backtrace
+    end
+
+    def to_h
+        data = super
+        data[:type]     = 'exception'
+        data[:where]    = @where.join("\n")
+        data
+    end
+end

data/lib/merb-extjs-direct/xrequest.rb

@@ -0,0 +1,31 @@
+###
+# XRequest
+# A standard response class suitable for Ext.Direct requests.
+# @author Chris Scott
+#
+class XRequest
+    attr_reader :id, :tid, :controller, :action, :type, :params
+
+    def initialize(params)
+        # TODO: simply setting @id, @params
+        @id         = (params["id"].to_i > 0) ? params["id"].to_i : (params["data"].kind_of?(Array) && (params["data"].first.kind_of?(Integer) || params["data"].first.nil?)) ? params["data"].shift: nil
+        @tid        = params["tid"]
+        @type       = params["type"]
+        @params     = (params["data"].kind_of?(Array) && params["data"].length == 1 && params["data"].first.kind_of?(Hash)) ? params["data"].first : params["data"] || []
+        @controller = params["xcontroller"]
+        @action     = params["xaction"]
+    end
+
+    ##
+    # arg
+    # return a request argument at index.  can be used to access either [] or {}
+    # @param {String/Integer} index
+    # @raises XException if params doesn't exist.
+    #
+    def arg(index)
+        if params[index].nil?
+            raise XException.new("Attempt to access unknown request argument '#{index.to_s}' on transaction #{@tid}")
+        end
+        @params[index]
+    end
+end

data/lib/merb-extjs-direct/xresponse.rb

@@ -0,0 +1,26 @@
+###
+# XResponse
+# A standard response class suitable for Ext.Direct AJAX responses.
+# @author Chris Scott
+#
+class XResponse
+    attr_accessor :type, :status, :errors, :success, :message, :result
+    attr_reader :tid
+
+    def initialize(req)
+        @tid    = req.tid
+        @type   = req.type
+        @status = false
+        @message = ''
+        @result = []
+        @errors = []
+    end
+
+    def to_h
+        {:tid => @tid, :status => @status, :type => @type, :message => @message, :result => @result, :errors => @errors}
+    end
+
+    def to_json
+        self.to_h.to_json
+    end
+end

data/test/test_merb-extjs-direct.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestMerb-ext-direct < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: extjs-direct
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- christocracy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-09 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.12.1
+    version: 
+description: FIX (describe your package)
+email: 
+- chris.scott@extjs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/merb-extjs-direct.rb
+- lib/merb-extjs-direct/xrequest.rb
+- lib/merb-extjs-direct/xresponse.rb
+- lib/merb-extjs-direct/xexception.rb
+- lib/merb-extjs-direct/mixins/remoting_provider.rb
+- test/test_merb-extjs-direct.rb
+has_rdoc: true
+homepage: FIX (url)
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: extjs-direct
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: FIX (describe your package)
+test_files: 
+- test/test_merb-extjs-direct.rb