The ELC Community Blog

A knowledge exchange on Ruby on Rails and Agile Development

OpenSocial container plugin 0.0.1

by Ryan Garver on November 27, 2007

I've just tagged off a 0.0.1 version of the opensocial_container plugin that I've been working on in bits and pieces for the last few weeks. This is a very early version, but it is under very active development (I've been steadily devoting more and more of my time to it). If you do decide to risk trying it let me know how it goes. I'd like to have a 0.1.0 release later this week, so if you have problems toss them in our RubyForge tracker.

The installation is pretty easy:

ruby script/plugin install http://opensocial.rubyforge.org/svn/plugin/tags/0_0_1/opensocial_container

Keep an eye on this. More to come soon!

README

OpensocialContainer
===================

This plugin is designed to pull together all of the neccessary components involved in turning your application in to an OpenSocial container capable of hosting OpenSocial applications.  Beyond the raw functionality this plugin is being built to make the practice of presenting a secure and stable container simple and straightforward by adopting best practices as they are defined.

Reference Links
===============

http://code.google.com/apis/opensocial/
http://code.google.com/apis/gadgets/

Example
=======

In the config/routes.rb file:

ActionController::Routing::Routes.draw do |map|
  ...

  map.opensocial_container :contain
end

To add the "feeds" resources:
ruby script/generator opensocial

To bootstrap the static assets you need to run the generator:
ruby script/generator opensocial_assets

And finally to embed the container in a ERb template use the helper:
<%= opensocial_container('http://www.last.fm/opensocial/myfavouritemusic.xml') %>

Caveats
=======
This plugin is in very early development and should be used with that in mind.  While hopefully not too buggy, it may be feature lacking in a number of respects.


Copyright (c) 2007 ELC Technologies, released under the MIT license