rails-extjs-direct 0.0.1

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>rails-extjs-direct</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.rubypeople.rdt.core.rubybuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.rubypeople.rdt.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-04-29
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,17 @@
+.project
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/rails-extjs-direct.rb
+lib/rails-extjs-direct/mixins/action_controller/direct_controller.rb
+lib/rails-extjs-direct/rack/remoting_provider.rb
+lib/rails-extjs-direct/xexception.rb
+lib/rails-extjs-direct/xrequest.rb
+lib/rails-extjs-direct/xresponse.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_rails-extjs-direct.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on rails-extjs-direct, see http://rails-extjs-direct.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,75 @@
+= rails-extjs-direct
+THIS GEM IS UNDER DEVELOPMENT AND WILL NOT YET WORK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+http://rubyforge.org/projects/rails-extjs/
+http://www.extjs.com
+
+== DESCRIPTION:
+
+A series of components for implementing the Ext.Direct API specification in Rails 2.3 and higher.
+Ext.Direct in Rails is implementede with Rack Middleware.
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+<script>
+Ext.Direct.addProvider({
+    url: '/admin/rpc',  //<-- Note the url corresponding to Admin above.
+    type: 'remoting',
+    actions: {
+        Users : [
+            {name: 'load', len: 1},
+            {name: 'save', len: 2},
+            {name: 'create', len: 1},
+            {name: 'destroy', len: 1}
+        ]
+    }
+});
+</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?)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIX
+
+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,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/rails-extjs-direct'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('rails-extjs-direct', Rails::ExtJS::Direct::VERSION) do |p|
+  p.developer('Chris Scott', 'christocracy@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = "rails-extjs"
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/lib/rails-extjs-direct.rb

@@ -0,0 +1,15 @@
+#$:.unshift(File.dirname(__FILE__)) unless
+#  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Rails
+    module ExtJS
+        module Direct
+            VERSION = '0.0.1'
+        end
+    end
+end
+require File.join(File.dirname(__FILE__), 'rails-extjs-direct', 'xresponse')
+require File.join(File.dirname(__FILE__), 'rails-extjs-direct', 'xrequest')
+require File.join(File.dirname(__FILE__), 'rails-extjs-direct', 'xexception')
+require File.join(File.dirname(__FILE__), 'rails-extjs-direct', 'rack', 'remoting_provider')
+require File.join(File.dirname(__FILE__), 'rails-extjs-direct', 'mixins', 'action_controller', 'direct_controller')

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

@@ -0,0 +1,12 @@
+module Rails::ExtJS::Direct::Controller
+
+    # standard ruby method called when some class does:
+    # include Merb::ExtJS::Direct::RemotingProvider
+    def self.included(base)
+        base.before_filter :extjs_direct_prepare_request
+    end
+
+    def extjs_direct_prepare_request
+        params["xrequest"] = "XRequest.new" # <-- TODO: prepare XRequest
+    end
+end

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

@@ -0,0 +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)
+
+        if env["PATH_INFO"].match("^"+@router_path)
+            parse_params(env)
+            @logger.info('chris is here bitches ' + @params["foo"].to_s)
+            @logger.info('env: ' + env.to_yaml)
+
+            output = []
+            ["company", "users"].each do |c|
+                env["PATH_INFO"] = "/#{c}/load"
+                env["REQUEST_URI"] = "/#{c}/load"
+                status, headers, response = @app.call(env)
+                output << response.body
+                @logger.info('---------------------- RESPONSE ----------------------------')
+                @logger.info(response.body)
+            end
+            res = output.join(',')
+            res = "[" + res + "]" if output.length > 1
+
+            #status, headers, response = @app.call(env)
+            [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"] = {}
+
+    end
+
+end
+

data/lib/rails-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/rails-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/rails-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/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rails-extjs-direct.rb'}"
+puts "Loading rails-extjs-direct gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/rails-extjs-direct'

data/test/test_rails-extjs-direct.rb

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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: rails-extjs-direct
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: A series of components for implementing the Ext.Direct API specification in Rails 2.3 and higher. Ext.Direct in Rails is implementede with Rack Middleware.
+email: 
+- christocracy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- .project
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/rails-extjs-direct.rb
+- lib/rails-extjs-direct/mixins/action_controller/direct_controller.rb
+- lib/rails-extjs-direct/rack/remoting_provider.rb
+- lib/rails-extjs-direct/xexception.rb
+- lib/rails-extjs-direct/xrequest.rb
+- lib/rails-extjs-direct/xresponse.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_rails-extjs-direct.rb
+has_rdoc: true
+homepage: THIS GEM IS UNDER DEVELOPMENT AND WILL NOT YET WORK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: rails-extjs
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A series of components for implementing the Ext.Direct API specification in Rails 2.3 and higher
+test_files: 
+- test/test_helper.rb
+- test/test_rails-extjs-direct.rb