ruby_ext_direct 0.0.2 → 0.0.3

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in ext_direct.gemspec
+# Specify your gem's dependencies in ruby_ext_direct.gemspec
 gemspec

data/README.markdown

@@ -0,0 +1,60 @@
+This is an attempt to implement **Ext.Direct** (see http://www.sencha.com/products/extjs/extdirect for more info)
+
+I wanted to have a library that did not have to many dependencies. 
+
+The idea is very simple: 
+ 
+>	1.  add an **'api'** and **'router'** endpoint to your backend.  
+>	2.  expose your classes. 
+ 
+and you are set
+
+#INSTALL#
+	gem install ruby_ext_direct
+---
+
+#Example:#
+(For more [examples](https://github.com/mehmetc/ruby_ext_direct_examples "EXAMPLES") )
+##A RACK based example##
+
+###*Gemfile*
+
+	gem 'ruby_ext_direct', :require => 'ext_direct'
+
+
+###*web_service.rb*
+
+	require 'rubygems'
+	require 'bundler/setup'
+	require 'rack'
+	require 'json'
+
+	require 'ext_direct'
+	
+	#Expose all classes in a directory
+	ExtDirect::Api.expose_all("./exposed_classes")
+
+	#Generate a client-side descriptor
+	map '/api' do
+	  run Proc.new { |env|
+	    [200, {'Content-Type' => 'text/json'}, [ExtDirect::Api.to_json]]
+	  }
+	end
+
+	#Route request to methods
+	map '/router' do
+	  run Proc.new { |env|
+	    result = ''
+
+	    req = Rack::Request.new(env)
+	    if req.post?
+	      data = env["rack.input"].gets
+	      result = ExtDirect::Router.route(data)
+	    end
+    
+	    [200, {'Content-Type' => 'text/html'}, [result.to_json]]
+	  }
+	end
+
+TODO: add documentation  
+TODO: add rails engine

data/lib/ext_direct/api.rb

@@ -4,16 +4,17 @@ module ExtDirect
 # Simply expose a class 
 # @author Mehmet Celik
   class Api
-    attr_reader :exposed_api
-
-# Expose a class
+    @exposed_api_raw = nil
+    @router_url = '/router'
+    
+# Expose methods from a class and his ancestor, if class was inherited
 #
 # @author Mehmet Celik
 # @param [Class] class that needs to be exposed
 # @param [Hash] instructions to how to expose the class. For now just the ':only' key is accepted.
 # @return [Hash] returns a list of exposed classes
     def self.expose(class_to_expose, options = {})
-      @exposed_api = {} if @exposed_api.nil?
+      @exposed_api_raw = {} if @exposed_api_raw.nil?
       
       methods = []
       
@@ -21,16 +22,36 @@ module ExtDirect
         raw_methods = options[:only] || []
       else
         raw_methods = class_to_expose.instance_methods(false) - (options[:except] || [])
+        raw_methods += class_to_expose.methods(false) - (options[:except] || [])   
+        raw_methods += class_to_expose.ancestors[1].methods(false) - (options[:except] || [])   
+        raw_methods += class_to_expose.ancestors[1].instance_methods(false) - (options[:except] || [])           
       end
       
       raw_methods.uniq!
       raw_methods.each do |m|
         name = m
-        len = class_to_expose.instance_method(m).parameters.size
-        methods << {:name => name, :len => len}
+        parameters = []
+        method_to_run = nil
+        
+        if class_to_expose.methods(false).include?(m)
+          method_to_run = class_to_expose.method(m) 
+        elsif class_to_expose.instance_methods(false).include?(m)
+          method_to_run = class_to_expose.instance_method(m) 
+        elsif class_to_expose.ancestors[1].methods(false).include?(m)
+          method_to_run = class_to_expose.ancestors[1].method(m) 
+        elsif class_to_expose.ancestors[1].instance_methods(false).include?(m)
+          method_to_run = class_to_expose.ancestors[1].instance_method(m)
+        end
+        
+        unless method_to_run.nil?
+          method_to_run.parameters.each do |p|
+            parameters << {:name => p[1].to_s, :optional => p[0] == :opt}
+          end
+        end
+        methods << {:name => name, :parameters => parameters}
       end
             
-      @exposed_api.store(class_to_expose.name, methods)
+      @exposed_api_raw.store(class_to_expose.name, methods)
     end
     
 # Expose all classes in a directory(conviniance method)
@@ -38,7 +59,7 @@ module ExtDirect
 # @author Mehmet Celik
 # @param [String] Directory where all classes are stored
     def self.expose_all(class_dir)
-      @exposed_api = {}
+      @exposed_api_raw = {}
      
       Dir.glob("#{class_dir}/**/*.rb").each do |r|
         rr = r.split("#{class_dir}/")[1].gsub('.rb','')     
@@ -64,9 +85,46 @@ module ExtDirect
 # @author Mehmet Celik
 # @return [Hash] exposed classes
     def self.to_raw
-      api = {:url => '/router', 
+      
+      api = {:url => @router_url || '/router', 
              :type => 'remoting',
-             :actions => @exposed_api}      
+             :actions => self.exposed_api}
+    end
+# Set the router url
+
+# @author Mehmet Celik   
+# @param [String] router url defaults to '/router'
+    def self.router_url=(url = '/router')
+      @router_url = url
+    end
+    
+# Get the router url
+    
+# @author Mehmet Celik   
+# @return [String] router url
+    def self.router_url
+      @router_url
+    end
+
+# TODO
+    
+# @author Mehmet Celik   
+# @param [String] router url defaults to '/router'
+# @return [Hash] exposed API data
+    def self.exposed_api(show_parameters = false)
+      result = @exposed_api_raw
+      unless show_parameters
+        result = {}
+        @exposed_api_raw.each do |k,v|
+          methods = []
+          v.each do |method|
+            methods << {:name => method[:name], :len => method[:parameters].size}
+          end
+          result.store(k,methods)
+        end
+      end
+      
+      result
     end
   end
 end

data/lib/ext_direct/router.rb

@@ -35,12 +35,32 @@ module ExtDirect
         klass = self.class.const_get(params[:klass_name])
         #call method on class                
         klass_instance = klass.new
-        method_to_call = klass_instance.method(params[:method_to_call_name].to_sym)
+        
+        method_to_call = nil
+                
+        method_to_call_name = params[:method_to_call_name].to_sym
+=begin 
+        if klass_instance.methods(false).include?(method_to_call_name)
+          method_to_call = klass_instance.method(method_to_call_name) 
+        elsif klass_instance.instance_methods(false).include?( params[:method_to_call_name].to_sym)
+          method_to_call = klass_instance.instance_method(method_to_call_name) 
+        elsif klass_instance.ancestors[1].methods(false).include?(method_to_call_name)
+          method_to_call = klass_instance.ancestors[1].method(method_to_call_name) 
+        elsif klass_instance.ancestors[1].instance_methods(false).include?(method_to_call_name)
+          method_to_call = klass_instance.ancestors[1].instance_method(method_to_call_name)
+        end
+=end
+        
+        
+#        method_to_call = klass_instance.method(params[:method_to_call_name].to_sym)
+        method_to_call = klass_instance.method(method_to_call_name)
 
-        if method_to_call.parameters.size > 0
-          data = method_to_call.call(params[:args])
-        else
-          data = method_to_call.call
+        unless method_to_call.nil?
+          if method_to_call.parameters.size > 0
+            data = method_to_call.call(params[:args]) || []
+          else
+            data = method_to_call.call || []
+          end
         end
 
       response = {

data/lib/ext_direct/version.rb

@@ -1,3 +1,3 @@
 module ExtDirect
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/ruby_ext_direct.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"
+  s.add_dependency("json")
 end

data/test/test_ext_direct.rb

@@ -14,6 +14,8 @@ class MyClass
   end
 end
 
+class InheritedFromMyClass < MyClass
+end
 
 
 class TestExtDirect < Test::Unit::TestCase
@@ -125,5 +127,22 @@ class TestExtDirect < Test::Unit::TestCase
         assert_equal(expected, result)        
       end
     end
+    
+    context 'Calling methods in sub classes' do
+      setup do
+        @request_without_arguments   = "{\"action\":\"InheritedFromMyClass\",\"method\":\"method_without_arguments\",\"data\":null,\"type\":\"rpc\",\"tid\":1}"
+        ExtDirect::Api.expose InheritedFromMyClass
+      end
+
+      should "call method without parameters" do
+        expected = "method_without_arguments called"
+
+        result = ExtDirect::Router.route(@request_without_arguments)[:result]
+
+        assert_equal(expected, result)
+      end
+      
+      
+    end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: ruby_ext_direct
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Mehmet Celik
@@ -10,10 +10,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-23 00:00:00 +02:00
-default_executable: 
-dependencies: []
-
+date: 2012-03-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
 description: An attempt to implement Ext.Direct from Sencha
 email: 
 - mehmet@celik.be
@@ -26,7 +35,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- README
+- README.markdown
 - Rakefile
 - doc/ExtDirect.html
 - doc/ExtDirect/Api.html
@@ -46,39 +55,12 @@ files:
 - doc/js/jquery.js
 - doc/method_list.html
 - doc/top-level-namespace.html
-- examples/API/Gemfile
-- examples/API/app/actions/api_action.rb
-- examples/API/app/actions/home_action.rb
-- examples/API/app/actions/router_action.rb
-- examples/API/application.rb
-- examples/API/config.ru
-- examples/API/config/database.yml
-- examples/API/config/routes.rb
-- examples/API/public/NamesApp/app/store/NamesStore.js
-- examples/API/public/NamesApp/app/view/namesWindow.js
-- examples/API/public/NamesApp/app/view/ui/namesWindow.js
-- examples/API/public/NamesApp/designer.html
-- examples/API/public/NamesApp/designer.js
-- examples/API/public/NamesApp/designer_includeOrder.txt
-- examples/API/public/namesApp.xds
-- examples/rack/config.ru
-- examples/rack/exposed_classes/countries.rb
-- examples/rack/exposed_classes/names.rb
-- examples/rack/html/.DS_Store
-- examples/rack/html/NamesApp/app/store/NamesStore.js
-- examples/rack/html/NamesApp/app/view/namesWindow.js
-- examples/rack/html/NamesApp/app/view/ui/namesWindow.js
-- examples/rack/html/NamesApp/designer.html
-- examples/rack/html/NamesApp/designer.js
-- examples/rack/html/NamesApp/designer_includeOrder.txt
-- examples/rack/html/names.xds
 - lib/ext_direct.rb
 - lib/ext_direct/api.rb
 - lib/ext_direct/router.rb
 - lib/ext_direct/version.rb
 - ruby_ext_direct.gemspec
 - test/test_ext_direct.rb
-has_rdoc: true
 homepage: https://github.com/mehmetc/ruby_ext_direct
 licenses: []
 
@@ -102,9 +84,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ruby_ext_direct
-rubygems_version: 1.6.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: An attempt to implement Ext.Direct from Sencha
 test_files: 
 - test/test_ext_direct.rb
+has_rdoc: 

data/README

@@ -1,12 +0,0 @@
-This is an attempt to implement Ext.Direct (see http://www.sencha.com/products/extjs/extdirect for more info)
-
-I wanted to have a library that did not explicitly bind to any ORM(like ActiveRecord, Datamapper, ...).
-The idea is very simple just add an 'api' and 'router' path to your backend point to your exposed classes and you are set.
-
-Example: (See examples directory for more)
-Add this to your Gemfile
-  gem 'ruby_ext_direct', :require => 'ext_direct'
-
-
-TODO: add documentation
-TODO: add rails engine

data/examples/API/Gemfile

@@ -1,29 +0,0 @@
-source :rubygems
-
-gem 'cramp'
-
-# Async webserver for running a cramp application
-gem 'thin'
-
-# Rack based routing
-gem 'http_router'
-
-# Collection of async-proof rack middlewares - https://github.com/rkh/async-rack.git
-gem 'async-rack'
-
-# For async Active Record models
-gem 'mysql2', '~> 0.2.11'
-gem 'activerecord', :require => 'active_record'
-
-gem 'ext_direct', '0.0.1'
-
-# Using Fibers + async callbacks to emulate synchronous programming
-# gem 'em-synchrony'
-
-# Generic interface to multiple Ruby template engines - https://github.com/rtomayko/tilt
-# gem 'tilt'
-
-group :development do
-  # Development gems
-  # gem 'ruby-debug19'
-end

data/examples/API/app/actions/api_action.rb

@@ -1,18 +0,0 @@
-#require 'ext_direct'
-
-class ApiAction < Cramp::Action
-  on_start :render_api
-
-  def render_api
-#    ExtDirect::Api.expose_all "/Users/mehmetc/Sources/LBT/ext_direct/examples/rack/exposed_classes"
-    render ExtDirect::Api.to_json
-    finish
-  end
-
-  def respond_with
-  #  content_type = params[:format] == 'xml' ? 'application/xml' : 'application/json'
-    [200, {'Content-Type' => 'application/json'}]
-  end
-
-
-end

data/examples/API/app/actions/home_action.rb

@@ -1,11 +0,0 @@
-class HomeAction < Cramp::Action
-  use_fiber_pool do |pool|
-    # Checkin database connection after each callback
-    pool.generic_callbacks << proc { ActiveRecord::Base.clear_active_connections! }
-  end
-
-  def start
-    render "Hello World!"
-    finish
-  end
-end

data/examples/API/app/actions/router_action.rb

@@ -1,18 +0,0 @@
-class RouterAction < Cramp::Action
-  on_start :route_data_to_class
-
-  def route_data_to_class
-    ExtDirect::Api.expose_all "/Users/mehmetc/Sources/LBT/ext_direct/examples/rack/exposed_classes"
-    data = ''
-    if request.post?
-      data = request.env['rack.input'].gets
-      result = ExtDirect::Router.route(data)
-    end
-    
-    render result.to_json
-  end
-  
-  def respond_with
-    [200, {'Content-Type' => 'application/json'}]
-  end  
-end