RubyGems - ext_direct - Versions diffs - 0.0.0 → 0.1.0 - Mend

ext_direct 0.0.0 → 0.1.0

Files changed (12) hide show

data/README.rdoc +9 -1
data/VERSION +1 -1
data/ext_direct.gemspec +8 -2
data/lib/ext_direct/dispatcher.rb +41 -0
data/lib/ext_direct/request.rb +48 -0
data/lib/ext_direct/response.rb +5 -0
data/lib/ext_direct/router.rb +29 -0
data/lib/ext_direct/service/base.rb +31 -0
data/lib/ext_direct/service/provider.rb +33 -0
data/lib/ext_direct.rb +31 -1
data/rails/init.rb +5 -0
metadata +9 -3

data/README.rdoc CHANGED Viewed

@@ -18,7 +18,15 @@ Install as a gem:
   gem install ext_direct
-This release is tested and runs with Rails 2.3.
+Then in "config/environment.rb" require middleware:
+  config.middleware.use "ExtDirect::Router", "/direct"
+Great job! Now you are ready to use this library. Remember, this release is tested and runs with Rails 2.3.
+== Example usage
+Of course, I'd drink beer :)
 == Copyright

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.0.0
1	+ 0.1.0

data/ext_direct.gemspec CHANGED Viewed

@@ -5,11 +5,11 @@
 Gem::Specification.new do |s|
   s.name = %q{ext_direct}
-  s.version = "0.0.0"
+  s.version = "0.1.0"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marcin Lewandowski"]
-  s.date = %q{2010-05-08}
+  s.date = %q{2010-05-28}
   s.description = %q{The Ext Direct plugin is a simple implementation of Ext Direct router to call server-side methods on the client-side.}
   s.email = %q{marcin.martio.lewandowski@gmail.com}
   s.extra_rdoc_files = [
@@ -25,6 +25,12 @@ Gem::Specification.new do |s|
      "ext_direct.gemspec",
      "install.rb",
      "lib/ext_direct.rb",
+     "lib/ext_direct/dispatcher.rb",
+     "lib/ext_direct/request.rb",
+     "lib/ext_direct/response.rb",
+     "lib/ext_direct/router.rb",
+     "lib/ext_direct/service/base.rb",
+     "lib/ext_direct/service/provider.rb",
      "rails/init.rb",
      "test/ext_direct_test.rb",
      "test/test_helper.rb",

data/lib/ext_direct/dispatcher.rb ADDED Viewed

@@ -0,0 +1,41 @@
+module ExtDirect
+  class Dispatcher
+    # dispatch to a service method
+    def self.dispatch(request, response)
+      params = request.data # the class to use
+      action = request.action.underscore.to_sym # the method to execute
+      method = request.method.underscore.to_sym # the arguments to be passed to the method
+      tid    = request.tid # the transaction id to associate with this request
+      begin
+        data = {} # the response will be json encoded
+        # the result of the method call
+        result = ExtDirect::Service::Provider.execute(action, method, params)
+        if request.event?
+          data["type"] = "event"
+          data["name"] = "message"
+          data["data"] = result
+        else
+          data["type"]   = request.type
+          data["action"] = request.action
+          data["method"] = request.method
+          data["tid"]    = tid
+          data["result"] = result
+        end
+      rescue Exception => e
+        # a exception on the server-side
+        data["type"]    = "exception"
+        data["message"] = e.message
+        data["where"]   = e.backtrace
+      ensure
+        if request.rpc? and request.upload?
+          response.write "<html><body><textarea>#{data.to_json}</textarea></body></html>"
+        else
+          response.write data.to_json
+        end
+      end
+    end
+  end
+end

data/lib/ext_direct/request.rb ADDED Viewed

@@ -0,0 +1,48 @@
+module ExtDirect
+  class Request < Rack::Request
+    def action
+      params.fetch("extAction", params.fetch("action", "unknown"))
+    end
+    def method
+      params.fetch("extMethod", params.fetch("method", "unknown"))
+    end
+    def data
+      if type == :event
+        event_params = params.dup
+        event_params.delete("action")
+        event_params.delete("method")
+        event_params
+      else
+        params.fetch("data", [])
+      end
+    end
+    def tid
+      params.fetch("extTID", params.fetch("tid", 0))
+    end
+    def type
+      if get?
+        :event
+      elsif post? and params.include? "type"
+        params.fetch("type").to_sym
+      else
+        :unknown
+      end
+    end
+    def event?
+      (type == :event)
+    end
+    def rpc?
+      (type == :rpc)
+    end
+    def upload?
+      params.include? "extUpload"
+    end
+  end
+end

data/lib/ext_direct/response.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module ExtDirect
+  class Response < Rack::Response
+    # to-do: to implement :)
+  end
+end

data/lib/ext_direct/router.rb ADDED Viewed

@@ -0,0 +1,29 @@
+require 'json'
+module ExtDirect
+  class Router
+    def initialize(app, route_path)
+      @app, @route_path = app, route_path
+    end
+    def call(env)
+      if env["PATH_INFO"].match("^#{@route_path}")
+        if env["CONTENT_TYPE"] and env["CONTENT_TYPE"].match("^application/json")
+          # support for parsing a POST body data in a JSON format
+          env["rack.input"].rewind
+          env.update("rack.request.form_hash" => JSON.parse(env["rack.input"].read), "rack.request.form_input" => env["rack.input"])
+        end
+        request  = ExtDirect::Request.new(env)
+        response = ExtDirect::Response.new("", 200, {"Content-Type" => "application/json"})
+        # direct requests from the client
+        ExtDirect::Dispatcher.dispatch(request, response)
+        response.finish
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/ext_direct/service/base.rb ADDED Viewed

@@ -0,0 +1,31 @@
+module ExtDirect
+  module Service
+    class Base
+      class << self
+        def service(name, &proc)
+          action = action_name_format(self.model_name)
+          method = method_name_format(name)
+          ExtDirect::Service::Provider.register(:remoting, action, method, proc)
+        end
+        alias_method :remoting_service, :service
+        def polling_service(name, &proc)
+          action = action_name_format(self.model_name)
+          method = method_name_format(name)
+          ExtDirect::Service::Provider.register(:polling, action, method, proc)
+        end
+        private
+        def action_name_format(name)
+          name.to_s.underscore.gsub("_service", "")
+        end
+        def method_name_format(name)
+          name.to_s.underscore
+        end
+      end
+    end
+  end
+end

data/lib/ext_direct/service/provider.rb ADDED Viewed

@@ -0,0 +1,33 @@
+module ExtDirect
+  module Service
+    class Provider
+      @@store = {}
+      class << self
+        def register(type, action, method, proc)
+          action = action.to_sym
+          method = method.to_sym
+          @@store[action] = {} unless @@store[action]
+          @@store[action][method] = {} unless @@store[action][method]
+          @@store[action][method][:type] = type
+          @@store[action][method][:proc] = proc
+        end
+        def exist?(action, method)
+          (@@store[action.to_sym] and @@store[action.to_sym][method.to_sym])
+        end
+        def type_of(action, method)
+          false unless exist?(action, method)
+          @@store[action.to_sym][method.to_sym][:type]
+        end
+        def execute(action, method, params = nil)
+          raise "Unknown action or method" unless exist?(action, method)
+          @@store[action.to_sym][method.to_sym][:proc].call(params)
+        end
+      end
+    end
+  end
+end

data/lib/ext_direct.rb CHANGED Viewed

@@ -1 +1,31 @@
-# Ext Direct (on Rails)
+#--
+# Copyright (c) 2010 Marcin Lewandowski
+#
+# 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.
+#++
+require 'ext_direct/router'
+require 'ext_direct/dispatcher'
+require 'ext_direct/request'
+require 'ext_direct/response'
+require 'ext_direct/service/base'
+require 'ext_direct/service/provider'
+module ExtDirect; end

data/rails/init.rb CHANGED Viewed

@@ -1 +1,6 @@
 require 'ext_direct'
+# rails initialization hook
+Rails.configuration.after_initialize do
+  Dir["#{Rails.root}/app/services/*_service.rb"].each { |service| require service }
+end if defined?(Rails)

metadata CHANGED Viewed

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments:
   - 0
+  - 1
   - 0
-  - 0
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Marcin Lewandowski
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-05-08 00:00:00 +02:00
+date: 2010-05-28 00:00:00 +02:00
 default_executable:
 dependencies: []
@@ -36,6 +36,12 @@ files:
 - ext_direct.gemspec
 - install.rb
 - lib/ext_direct.rb
+- lib/ext_direct/dispatcher.rb
+- lib/ext_direct/request.rb
+- lib/ext_direct/response.rb
+- lib/ext_direct/router.rb
+- lib/ext_direct/service/base.rb
+- lib/ext_direct/service/provider.rb
 - rails/init.rb
 - test/ext_direct_test.rb
 - test/test_helper.rb