dima / restfulx Goto Github PK

View Code? Open in Web Editor NEW

106.0 4.0 33.0 2.56 MB

RestfulX Framework Code Generation Engine / Rails 2.1+ Integration Support

Home Page: http://restfulx.github.com

Ruby 67.21% JavaScript 27.87% Python 4.93%

restfulx's Introduction

RestfulX Framework: The RESTful way to develop Adobe Flex and AIR applications¶ ↑

Description¶ ↑

Here’s some of the things you can do with RestfulX:

Create a complete Adobe Flex or AIR application in less than 5 minutes.

Use our lightweight Ruby-based code generation toolkit to create a fully functional CRUD application. Simply do:
```
sudo gem install restfulx
```
And then run:
```
rx-gen -h
```
Integrate with Ruby On Rails, Merb or Sinatra applications that use ActiveRecord, DataMapper, CouchRest, ActiveCouch and so on.
Communicate between your Flex/AIR Rich Internet Application and service providers using either AMF, XML or JSON.
Persist your data directly in Adobe AIR SQLite database or CouchDB without any additional infrastructure or intermediate servers.
Deploy your RestfulX application on the Google App Engine and use Google DataStore for persistence.
Synchronize your data between AIR SQLite and other service providers.

Getting Started¶ ↑

For details on how to get started with the RestfulX framework refer to:

http://restfulx.github.com

Getting Involved¶ ↑

Report bugs or track framework development progress:

http://github.com/dima/restfulx_framework/issues

Get involved with the community:

http://groups.google.com/group/restfulx-framework

License¶ ↑

restfulx's People

Contributors

Stargazers

Watchers

restfulx's Issues

[NamedScopes] NoMethodError (undefined method `to_amf' for #<Class:0x...>)

It's late for me and I can't test this further.

On the Rails (server) side, AMF seems to work great now except I get:

NoMethodError (undefined method `to_amf' for #Class:0x...)

NoMethodError (undefined method `to_fxml' for #Class:0x...)

when I try to render results from a named scope.
I have jumped in with the debugger and:

@results.class ouputs ActiveRecord::NamedScope::Scope

not sure why the error says its an instance of Class and not ActiveRecord::NamedScope::Scope but thats probably a limitation of my knowledge of ruby.

Seems the AMF and FXML foo isn't getting to ActiveRecord::NamedScope::Scope

Performance tests for various serialization options (FXML, JSON, AMF)

Should be possible to compare-contrast various serialization options available with RestfulX

rake rx:flex:build seems to call mxmlc twice

Process not explicitly referenced relationships

We should be able to at least send ids over the client and attempt to merge with whatever is currently in the cache for that model.

C-based AMF serializer for Rails

In order to speed up Rails response times AMF Serializer should ideally be performance tuned and better still implemented in C.

Rails 3 Compatibility

Some of the generators will need to be rewritten for Rails 3

Fix tests

The testing suite is currently extremely minimal and partially broken (on restfulx gem side). This needs to be fixed and generally improved.

Replace Rubigen based code generation with Thor

[SystemStackError] recursive madness when calling render

In 1.3.0 prerelease I get this when I try to render anything:

SystemStackError (stack level too deep):
/Users/johnwest/.bundle/ruby/1.8/bundler/gems/restfulx-4c800dcb763416a71965ab45e5fadba4eb9ef01d-master/rails/./lib/restfulx/action_controller.rb:18:in render_without_fxml' /Users/johnwest/.bundle/ruby/1.8/bundler/gems/restfulx-4c800dcb763416a71965ab45e5fadba4eb9ef01d-master/lib/restfulx/action_controller.rb:31:inrender_without_amf'
(...)

render code is
format.fxml { render :fxml @projects }

The problem is in the render overrides in /lib/restfulx/action_controller.rb, they call themselves, I'm suprised I'm the first to encounter this.

Changing the only two functions to this 1.2.4ish way of doing it solved it:

def render_with_amf(options=nil, extra_options={}, &block)
  if Hash === options and options.key?(:amf)
    object = options.delete(:amf)
    unless String === object
      object = object.to_amf(options, &block) if object.respond_to?(:to_amf)
    end
    response.content_type ||= RestfulX::Types::APPLICATION_AMF
    render_for_text(object)
  else
    render_without_amf(options, extra_options, &block)
  end
end

def render_with_fxml(options=nil, extra_options={}, &block)
  if Hash === options and options.key?(:fxml)
    object = options.delete(:fxml)
    unless String === object
      object = object.to_fxml(options, &block) if object.respond_to?(:to_fxml)
    end
    response.content_type ||= RestfulX::Types::APPLICATION_FXML
    render_for_text(object)
  else
    render_without_fxml(options, extra_options, &block)
  end
end

The sweet spot is:
response.content_type ||= RestfulX::Types::APPLICATION_AMF
render_for_text(object)

[SystemStackError] recursive madness when calling render

In 1.3.0 prerelease I get this when I try to render anything:

render code is
format.fxml { render :fxml @projects }
format.amf { render :amf @projects }

The problem is in the render overrides in /lib/restfulx/action_controller.rb, they call themselves, I'm suprised I'm the first to encounter this.

Changing the only two functions to this 1.2.4ish way of doing it solved it:

def render_with_amf(options=nil, extra_options={}, &block)
  if Hash === options and options.key?(:amf)
    object = options.delete(:amf)
    unless String === object
      object = object.to_amf(options, &block) if object.respond_to?(:to_amf)
    end
    response.content_type ||= RestfulX::Types::APPLICATION_AMF
    render_for_text(object)
  else
    render_without_amf(options, extra_options, &block)
  end
end

def render_with_fxml(options=nil, extra_options={}, &block)
  if Hash === options and options.key?(:fxml)
    object = options.delete(:fxml)
    unless String === object
      object = object.to_fxml(options, &block) if object.respond_to?(:to_fxml)
    end
    response.content_type ||= RestfulX::Types::APPLICATION_FXML
    render_for_text(object)
  else
    render_without_fxml(options, extra_options, &block)
  end
end

The sweet spot is:
response.content_type ||= RestfulX::Types::APPLICATION_AMF
render_for_text(object)

Serialization of Trees (child-parent relationships is still pretty flaky)

This doesn't work as expected, investigate

uninitialized constant RestfulX::ActiveRecord::Serialization

Had a problem loading 1.3.0:

`load_missing_constant': uninitialized constant RestfulX::ActiveRecord::Serialization (NameError)
(...)
from /Users/johnwest/.bundle/ruby/1.8/bundler/gems/restfulx-4c800dcb763416a71965ab45e5fadba4eb9ef01d-master/rails/../lib/restfulx/active_record.rb:6
(...)

The following change did the trick:

lib/restfulx/active_record.rb:6

- - class AMFSerializer < ActiveRecord::Serialization::Serializer
+++class AMFSerializer < ::ActiveRecord::Serialization::Serializer

Running Rails 2.3.5
gems loaded via Bundler
OSX
ruby 1.8.7 (system)

(copy paste from my comment on the google group)

Improve testing suite and add performance tests for various serialization formats

Should have a better testing suite and performance tests for:

fXML, JSON, pure AMF, native AMF

AMFSerializer should hook up the reverse of the relationships

This can be post-processed on the client-side or embedded on the server-side

rails g rx_config error

Bundler could not find compatible versions for gem "activesupport": (Bundler::VersionConflict)
In Gemfile:
restfulx depends on
activesupport (~> 2.3.5)

rails (= 3.0.3) depends on
  activesupport (3.0.3)

AMF error serialization

@model.errors.to_amf should produce a result that can be parsed and understood on the client side.

AMF serialization of polymorphic relationships

Needs to be tested/investigated.

error serialization with to_fxml

This seems to be broken

Flex4 Generated Code compatibility

AMF serialization of multiple nested relationships is broken

The following works:

@projects.to_amf(:include => [:sprints])

However, the following is broken:

@project.to_amf(:include => {:sprints => {:include => [:tasks]}})

Needs to be investigated.

Issues link pointing to restfulx_framework project

The link to the "issues" page is pointing to the restfulx_project issues page.

I would change it and send a pull request, but I wondered if it was intentional to centralize all issues into one project.

rake db:schema:to_yaml with Rails 2.3 - nil object

On a Rails 2.3 project
rake db:schema:to_yaml
breaks with
You have a nil object when you didn't expect it!
The error occurred while evaluating nil.gsub

I fixed it by replacing

schema_to_yaml.rb line number 98

last_in_array_fix = last_in_array_fix.gsub(', ','')

with

last_in_array_fix = last_in_array_fix.gsub(', ','') unless last_in_array_fix.nil?

RxAutoComplete could have an option to always hit the server

It would be useful if RxAutoComplete had a flag to indicate if it should search the typed word in cache before trying to hit the server or always ask the server, without to consider the cached objects.

Flex 4 generator compatibility

Generated can be updated to produce code for Flex 4 and Flex 3.

Enhance GAE backend with partial requests.

Google App Engine is very sensitive to retrievals that take a long time or use too much CPU. In my existing application I'm getting log messages like this: /payments.xml 200 1624ms 3670cpu_ms 2368api_cpu_ms 193kb with a tooltip message that says "This request used a high amount of CPU and may soon exceed its quota."

My request-for-enhancement, then, is a way to request partial amounts of data.