You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@shindig.apache.org by csev <cs...@umich.edu> on 2010/07/05 14:31:27 UTC

Adding a Feature to SHindig - Blog Post

Hello all,

Thanks for your help last week as I muddled through adding a feature and osapi service to Shindig.  The results of my wandering are captured in six blog posts starting here:

http://www.dr-chuck.com/csev-blog/2010/07/playing-with-shindigopensocial-adding-a-new-feature-and-a-service/

Feel free to review and comment and suggest improvements.  I only started playing with this a few weeks back so I may have truly missed something.

As I said in my note last week, if you would like me to recast this material for the wiki - I am happy to do so - just tell me where it fits.  There are several independent pieces so they might go several places in the wiki.

Again, thanks so much.

Chuck Severance
www.dr-chuck.com

Re: Adding a Feature to SHindig - Blog Post

Posted by ๏̯͡๏ Jasvir Nagra <ja...@google.com>.
On Wed, Jul 7, 2010 at 4:15 PM, John Hjelmstad <fa...@google.com> wrote:

> @Chuck, I agree that slightly cleaning it up for Wiki consumption and
> enhancement would be of benefit. Most important though is just to get the
> content up!
>
> @Jasvir, perhaps Chuck's documentation could serve as a larger bootstrap of
> documentation on exposing tamed services :)
>

Agreed.  This <http://code.google.com/p/google-caja/wiki/LibraryTaming> is
another source of documentation on taming although in general rather than
specifically for gadgets.


> --j
>
> 2010/7/7 ๏̯͡๏ Jasvir Nagra <ja...@google.com>
>
> > Hi Chuck,
> >
> > I like this write up.  A suggestion for the section on taming.js - this
> > file
> > whitelists your library calls so that cajoled programs can call them.
> >  ___.grantRead grants access to read the value (but not call it).  In
> your
> > example, you are creating functions, the correct way to expose these
> > library
> > functions so cajoled programs can call them will be as:
> >
> > var tamings___ = tamings___ || [];
> > tamings___.push(function(imports) {
> >  caja___.whitelistFuncs([
> >    [gadgets.learning, 'getContextLabel'],
> >    [gadgets.learning, 'getContextName'],
> >    [gadgets.learning, 'setOutcome']
> >  ]);
> > });
> >
> > For methods you would similarly use caja___.whiteListMethods() and for
> > constructors, caja___.whiteListCtors().
> >
> > Regards
> > Jasvir
> >
> > On Wed, Jul 7, 2010 at 3:46 PM, csev <cs...@umich.edu> wrote:
> >
> > > John - Thanks.
> > >
> > > Would you prefer I write up a few pages in the wiki and point to them
> in
> > > the FAQ - or should I just point to my blog posts.
> > >
> > > I would think it more valuable to redo the text in the wiki so others
> can
> > > improve it.  It will take a bit of rewrite - but I am happy to do that.
> > >
> > > /Chuck
> > >
> > > On Jul 7, 2010, at 6:36 PM, John Hjelmstad wrote:
> > >
> > > > Hey Chuck:
> > > >
> > > > This is great documentation, thanks for writing it up! I'd love to
> see
> > > this
> > > > in the Wiki or the Shindig docs page itself.
> > > >
> > > > A quick place to put it would be in the FAQs section:
> > > >
> > >
> >
> https://cwiki.apache.org/confluence/display/SHINDIG/Index;jsessionid=30570F2F77512F0AA53B6CDCCD7694E8
> > > >
> > > > --John
> > > >
> > > > On Tue, Jul 6, 2010 at 8:47 PM, csev <cs...@umich.edu> wrote:
> > > >
> > > >> Thanks for your comment - I approved it and updated the post.
> > > >>
> > > >> /Chuck
> > > >>
> > > >> On Jul 6, 2010, at 5:26 PM, Michael Young wrote:
> > > >>
> > > >>> Hey Chuck,
> > > >>>
> > > >>> Thanks for writing this. Helped explain a few things to me that
> I've
> > > been
> > > >> wondering about.
> > > >>>
> > > >>> - Mike
> > > >>> --
> > > >>> Liferay West Coast Symposium
> > > >>> September 8-9, 2010
> > > >>> Anaheim, CA
> > > >>> www.liferay.com/wcs
> > > >>> --
> > > >>> Follow us on Twitter: liferay
> > > >>>
> > > >>> On Jul 5, 2010, at 5:31 AM, csev wrote:
> > > >>>
> > > >>>> Hello all,
> > > >>>>
> > > >>>> Thanks for your help last week as I muddled through adding a
> feature
> > > and
> > > >> osapi service to Shindig.  The results of my wandering are captured
> in
> > > six
> > > >> blog posts starting here:
> > > >>>>
> > > >>>>
> > > >>
> > >
> >
> http://www.dr-chuck.com/csev-blog/2010/07/playing-with-shindigopensocial-adding-a-new-feature-and-a-service/
> > > >>>>
> > > >>>> Feel free to review and comment and suggest improvements.  I only
> > > >> started playing with this a few weeks back so I may have truly
> missed
> > > >> something.
> > > >>>>
> > > >>>> As I said in my note last week, if you would like me to recast
> this
> > > >> material for the wiki - I am happy to do so - just tell me where it
> > > fits.
> > > >> There are several independent pieces so they might go several places
> > in
> > > the
> > > >> wiki.
> > > >>>>
> > > >>>> Again, thanks so much.
> > > >>>>
> > > >>>> Chuck Severance
> > > >>>> www.dr-chuck.com
> > > >>>
> > > >>
> > > >>
> > >
> > >
> >
>

Re: Adding a Feature to SHindig - Blog Post

Posted by John Hjelmstad <fa...@google.com>.
@Chuck, I agree that slightly cleaning it up for Wiki consumption and
enhancement would be of benefit. Most important though is just to get the
content up!

@Jasvir, perhaps Chuck's documentation could serve as a larger bootstrap of
documentation on exposing tamed services :)

--j

2010/7/7 ๏̯͡๏ Jasvir Nagra <ja...@google.com>

> Hi Chuck,
>
> I like this write up.  A suggestion for the section on taming.js - this
> file
> whitelists your library calls so that cajoled programs can call them.
>  ___.grantRead grants access to read the value (but not call it).  In your
> example, you are creating functions, the correct way to expose these
> library
> functions so cajoled programs can call them will be as:
>
> var tamings___ = tamings___ || [];
> tamings___.push(function(imports) {
>  caja___.whitelistFuncs([
>    [gadgets.learning, 'getContextLabel'],
>    [gadgets.learning, 'getContextName'],
>    [gadgets.learning, 'setOutcome']
>  ]);
> });
>
> For methods you would similarly use caja___.whiteListMethods() and for
> constructors, caja___.whiteListCtors().
>
> Regards
> Jasvir
>
> On Wed, Jul 7, 2010 at 3:46 PM, csev <cs...@umich.edu> wrote:
>
> > John - Thanks.
> >
> > Would you prefer I write up a few pages in the wiki and point to them in
> > the FAQ - or should I just point to my blog posts.
> >
> > I would think it more valuable to redo the text in the wiki so others can
> > improve it.  It will take a bit of rewrite - but I am happy to do that.
> >
> > /Chuck
> >
> > On Jul 7, 2010, at 6:36 PM, John Hjelmstad wrote:
> >
> > > Hey Chuck:
> > >
> > > This is great documentation, thanks for writing it up! I'd love to see
> > this
> > > in the Wiki or the Shindig docs page itself.
> > >
> > > A quick place to put it would be in the FAQs section:
> > >
> >
> https://cwiki.apache.org/confluence/display/SHINDIG/Index;jsessionid=30570F2F77512F0AA53B6CDCCD7694E8
> > >
> > > --John
> > >
> > > On Tue, Jul 6, 2010 at 8:47 PM, csev <cs...@umich.edu> wrote:
> > >
> > >> Thanks for your comment - I approved it and updated the post.
> > >>
> > >> /Chuck
> > >>
> > >> On Jul 6, 2010, at 5:26 PM, Michael Young wrote:
> > >>
> > >>> Hey Chuck,
> > >>>
> > >>> Thanks for writing this. Helped explain a few things to me that I've
> > been
> > >> wondering about.
> > >>>
> > >>> - Mike
> > >>> --
> > >>> Liferay West Coast Symposium
> > >>> September 8-9, 2010
> > >>> Anaheim, CA
> > >>> www.liferay.com/wcs
> > >>> --
> > >>> Follow us on Twitter: liferay
> > >>>
> > >>> On Jul 5, 2010, at 5:31 AM, csev wrote:
> > >>>
> > >>>> Hello all,
> > >>>>
> > >>>> Thanks for your help last week as I muddled through adding a feature
> > and
> > >> osapi service to Shindig.  The results of my wandering are captured in
> > six
> > >> blog posts starting here:
> > >>>>
> > >>>>
> > >>
> >
> http://www.dr-chuck.com/csev-blog/2010/07/playing-with-shindigopensocial-adding-a-new-feature-and-a-service/
> > >>>>
> > >>>> Feel free to review and comment and suggest improvements.  I only
> > >> started playing with this a few weeks back so I may have truly missed
> > >> something.
> > >>>>
> > >>>> As I said in my note last week, if you would like me to recast this
> > >> material for the wiki - I am happy to do so - just tell me where it
> > fits.
> > >> There are several independent pieces so they might go several places
> in
> > the
> > >> wiki.
> > >>>>
> > >>>> Again, thanks so much.
> > >>>>
> > >>>> Chuck Severance
> > >>>> www.dr-chuck.com
> > >>>
> > >>
> > >>
> >
> >
>

Re: Adding a Feature to SHindig - Blog Post

Posted by csev <cs...@umich.edu>.
Thanks.

@John - I will reformat and edit a few Wiki pages and then link them in.

@Jasvir - I will adjust my taming discussion as you describe and then you can look at the pages on the wiki after I am don and make future adjustments.  

/Chuck

On Jul 7, 2010, at 7:08 PM, ๏̯͡๏ Jasvir Nagra wrote:

> Hi Chuck,
> 
> I like this write up.  A suggestion for the section on taming.js - this file
> whitelists your library calls so that cajoled programs can call them.
> ___.grantRead grants access to read the value (but not call it).  In your
> example, you are creating functions, the correct way to expose these library
> functions so cajoled programs can call them will be as:
> 
> var tamings___ = tamings___ || [];
> tamings___.push(function(imports) {
>  caja___.whitelistFuncs([
>    [gadgets.learning, 'getContextLabel'],
>    [gadgets.learning, 'getContextName'],
>    [gadgets.learning, 'setOutcome']
>  ]);
> });
> 
> For methods you would similarly use caja___.whiteListMethods() and for
> constructors, caja___.whiteListCtors().
> 
> Regards
> Jasvir
> 
> On Wed, Jul 7, 2010 at 3:46 PM, csev <cs...@umich.edu> wrote:
> 
>> John - Thanks.
>> 
>> Would you prefer I write up a few pages in the wiki and point to them in
>> the FAQ - or should I just point to my blog posts.
>> 
>> I would think it more valuable to redo the text in the wiki so others can
>> improve it.  It will take a bit of rewrite - but I am happy to do that.
>> 
>> /Chuck
>> 
>> On Jul 7, 2010, at 6:36 PM, John Hjelmstad wrote:
>> 
>>> Hey Chuck:
>>> 
>>> This is great documentation, thanks for writing it up! I'd love to see
>> this
>>> in the Wiki or the Shindig docs page itself.
>>> 
>>> A quick place to put it would be in the FAQs section:
>>> 
>> https://cwiki.apache.org/confluence/display/SHINDIG/Index;jsessionid=30570F2F77512F0AA53B6CDCCD7694E8
>>> 
>>> --John
>>> 
>>> On Tue, Jul 6, 2010 at 8:47 PM, csev <cs...@umich.edu> wrote:
>>> 
>>>> Thanks for your comment - I approved it and updated the post.
>>>> 
>>>> /Chuck
>>>> 
>>>> On Jul 6, 2010, at 5:26 PM, Michael Young wrote:
>>>> 
>>>>> Hey Chuck,
>>>>> 
>>>>> Thanks for writing this. Helped explain a few things to me that I've
>> been
>>>> wondering about.
>>>>> 
>>>>> - Mike
>>>>> --
>>>>> Liferay West Coast Symposium
>>>>> September 8-9, 2010
>>>>> Anaheim, CA
>>>>> www.liferay.com/wcs
>>>>> --
>>>>> Follow us on Twitter: liferay
>>>>> 
>>>>> On Jul 5, 2010, at 5:31 AM, csev wrote:
>>>>> 
>>>>>> Hello all,
>>>>>> 
>>>>>> Thanks for your help last week as I muddled through adding a feature
>> and
>>>> osapi service to Shindig.  The results of my wandering are captured in
>> six
>>>> blog posts starting here:
>>>>>> 
>>>>>> 
>>>> 
>> http://www.dr-chuck.com/csev-blog/2010/07/playing-with-shindigopensocial-adding-a-new-feature-and-a-service/
>>>>>> 
>>>>>> Feel free to review and comment and suggest improvements.  I only
>>>> started playing with this a few weeks back so I may have truly missed
>>>> something.
>>>>>> 
>>>>>> As I said in my note last week, if you would like me to recast this
>>>> material for the wiki - I am happy to do so - just tell me where it
>> fits.
>>>> There are several independent pieces so they might go several places in
>> the
>>>> wiki.
>>>>>> 
>>>>>> Again, thanks so much.
>>>>>> 
>>>>>> Chuck Severance
>>>>>> www.dr-chuck.com
>>>>> 
>>>> 
>>>> 
>> 
>> 


Re: Adding a Feature to SHindig - Blog Post

Posted by ๏̯͡๏ Jasvir Nagra <ja...@google.com>.
Hi Chuck,

I like this write up.  A suggestion for the section on taming.js - this file
whitelists your library calls so that cajoled programs can call them.
 ___.grantRead grants access to read the value (but not call it).  In your
example, you are creating functions, the correct way to expose these library
functions so cajoled programs can call them will be as:

var tamings___ = tamings___ || [];
tamings___.push(function(imports) {
  caja___.whitelistFuncs([
    [gadgets.learning, 'getContextLabel'],
    [gadgets.learning, 'getContextName'],
    [gadgets.learning, 'setOutcome']
  ]);
});

For methods you would similarly use caja___.whiteListMethods() and for
constructors, caja___.whiteListCtors().

Regards
Jasvir

On Wed, Jul 7, 2010 at 3:46 PM, csev <cs...@umich.edu> wrote:

> John - Thanks.
>
> Would you prefer I write up a few pages in the wiki and point to them in
> the FAQ - or should I just point to my blog posts.
>
> I would think it more valuable to redo the text in the wiki so others can
> improve it.  It will take a bit of rewrite - but I am happy to do that.
>
> /Chuck
>
> On Jul 7, 2010, at 6:36 PM, John Hjelmstad wrote:
>
> > Hey Chuck:
> >
> > This is great documentation, thanks for writing it up! I'd love to see
> this
> > in the Wiki or the Shindig docs page itself.
> >
> > A quick place to put it would be in the FAQs section:
> >
> https://cwiki.apache.org/confluence/display/SHINDIG/Index;jsessionid=30570F2F77512F0AA53B6CDCCD7694E8
> >
> > --John
> >
> > On Tue, Jul 6, 2010 at 8:47 PM, csev <cs...@umich.edu> wrote:
> >
> >> Thanks for your comment - I approved it and updated the post.
> >>
> >> /Chuck
> >>
> >> On Jul 6, 2010, at 5:26 PM, Michael Young wrote:
> >>
> >>> Hey Chuck,
> >>>
> >>> Thanks for writing this. Helped explain a few things to me that I've
> been
> >> wondering about.
> >>>
> >>> - Mike
> >>> --
> >>> Liferay West Coast Symposium
> >>> September 8-9, 2010
> >>> Anaheim, CA
> >>> www.liferay.com/wcs
> >>> --
> >>> Follow us on Twitter: liferay
> >>>
> >>> On Jul 5, 2010, at 5:31 AM, csev wrote:
> >>>
> >>>> Hello all,
> >>>>
> >>>> Thanks for your help last week as I muddled through adding a feature
> and
> >> osapi service to Shindig.  The results of my wandering are captured in
> six
> >> blog posts starting here:
> >>>>
> >>>>
> >>
> http://www.dr-chuck.com/csev-blog/2010/07/playing-with-shindigopensocial-adding-a-new-feature-and-a-service/
> >>>>
> >>>> Feel free to review and comment and suggest improvements.  I only
> >> started playing with this a few weeks back so I may have truly missed
> >> something.
> >>>>
> >>>> As I said in my note last week, if you would like me to recast this
> >> material for the wiki - I am happy to do so - just tell me where it
> fits.
> >> There are several independent pieces so they might go several places in
> the
> >> wiki.
> >>>>
> >>>> Again, thanks so much.
> >>>>
> >>>> Chuck Severance
> >>>> www.dr-chuck.com
> >>>
> >>
> >>
>
>

Re: Adding a Feature to SHindig - Blog Post

Posted by csev <cs...@umich.edu>.
John - Thanks.

Would you prefer I write up a few pages in the wiki and point to them in the FAQ - or should I just point to my blog posts.

I would think it more valuable to redo the text in the wiki so others can improve it.  It will take a bit of rewrite - but I am happy to do that.

/Chuck

On Jul 7, 2010, at 6:36 PM, John Hjelmstad wrote:

> Hey Chuck:
> 
> This is great documentation, thanks for writing it up! I'd love to see this
> in the Wiki or the Shindig docs page itself.
> 
> A quick place to put it would be in the FAQs section:
> https://cwiki.apache.org/confluence/display/SHINDIG/Index;jsessionid=30570F2F77512F0AA53B6CDCCD7694E8
> 
> --John
> 
> On Tue, Jul 6, 2010 at 8:47 PM, csev <cs...@umich.edu> wrote:
> 
>> Thanks for your comment - I approved it and updated the post.
>> 
>> /Chuck
>> 
>> On Jul 6, 2010, at 5:26 PM, Michael Young wrote:
>> 
>>> Hey Chuck,
>>> 
>>> Thanks for writing this. Helped explain a few things to me that I've been
>> wondering about.
>>> 
>>> - Mike
>>> --
>>> Liferay West Coast Symposium
>>> September 8-9, 2010
>>> Anaheim, CA
>>> www.liferay.com/wcs
>>> --
>>> Follow us on Twitter: liferay
>>> 
>>> On Jul 5, 2010, at 5:31 AM, csev wrote:
>>> 
>>>> Hello all,
>>>> 
>>>> Thanks for your help last week as I muddled through adding a feature and
>> osapi service to Shindig.  The results of my wandering are captured in six
>> blog posts starting here:
>>>> 
>>>> 
>> http://www.dr-chuck.com/csev-blog/2010/07/playing-with-shindigopensocial-adding-a-new-feature-and-a-service/
>>>> 
>>>> Feel free to review and comment and suggest improvements.  I only
>> started playing with this a few weeks back so I may have truly missed
>> something.
>>>> 
>>>> As I said in my note last week, if you would like me to recast this
>> material for the wiki - I am happy to do so - just tell me where it fits.
>> There are several independent pieces so they might go several places in the
>> wiki.
>>>> 
>>>> Again, thanks so much.
>>>> 
>>>> Chuck Severance
>>>> www.dr-chuck.com
>>> 
>> 
>> 


Re: Adding a Feature to SHindig - Blog Post

Posted by John Hjelmstad <fa...@google.com>.
Hey Chuck:

This is great documentation, thanks for writing it up! I'd love to see this
in the Wiki or the Shindig docs page itself.

A quick place to put it would be in the FAQs section:
https://cwiki.apache.org/confluence/display/SHINDIG/Index;jsessionid=30570F2F77512F0AA53B6CDCCD7694E8

--John

On Tue, Jul 6, 2010 at 8:47 PM, csev <cs...@umich.edu> wrote:

> Thanks for your comment - I approved it and updated the post.
>
> /Chuck
>
> On Jul 6, 2010, at 5:26 PM, Michael Young wrote:
>
> > Hey Chuck,
> >
> > Thanks for writing this. Helped explain a few things to me that I've been
> wondering about.
> >
> > - Mike
> > --
> > Liferay West Coast Symposium
> > September 8-9, 2010
> > Anaheim, CA
> > www.liferay.com/wcs
> > --
> > Follow us on Twitter: liferay
> >
> > On Jul 5, 2010, at 5:31 AM, csev wrote:
> >
> >> Hello all,
> >>
> >> Thanks for your help last week as I muddled through adding a feature and
> osapi service to Shindig.  The results of my wandering are captured in six
> blog posts starting here:
> >>
> >>
> http://www.dr-chuck.com/csev-blog/2010/07/playing-with-shindigopensocial-adding-a-new-feature-and-a-service/
> >>
> >> Feel free to review and comment and suggest improvements.  I only
> started playing with this a few weeks back so I may have truly missed
> something.
> >>
> >> As I said in my note last week, if you would like me to recast this
> material for the wiki - I am happy to do so - just tell me where it fits.
>  There are several independent pieces so they might go several places in the
> wiki.
> >>
> >> Again, thanks so much.
> >>
> >> Chuck Severance
> >> www.dr-chuck.com
> >
>
>

Re: Adding a Feature to SHindig - Blog Post

Posted by csev <cs...@umich.edu>.
Thanks for your comment - I approved it and updated the post.

/Chuck

On Jul 6, 2010, at 5:26 PM, Michael Young wrote:

> Hey Chuck,
> 
> Thanks for writing this. Helped explain a few things to me that I've been wondering about. 
> 
> - Mike
> --
> Liferay West Coast Symposium
> September 8-9, 2010
> Anaheim, CA
> www.liferay.com/wcs
> --
> Follow us on Twitter: liferay
> 
> On Jul 5, 2010, at 5:31 AM, csev wrote:
> 
>> Hello all,
>> 
>> Thanks for your help last week as I muddled through adding a feature and osapi service to Shindig.  The results of my wandering are captured in six blog posts starting here:
>> 
>> http://www.dr-chuck.com/csev-blog/2010/07/playing-with-shindigopensocial-adding-a-new-feature-and-a-service/
>> 
>> Feel free to review and comment and suggest improvements.  I only started playing with this a few weeks back so I may have truly missed something.
>> 
>> As I said in my note last week, if you would like me to recast this material for the wiki - I am happy to do so - just tell me where it fits.  There are several independent pieces so they might go several places in the wiki.
>> 
>> Again, thanks so much.
>> 
>> Chuck Severance
>> www.dr-chuck.com
> 


Re: Adding a Feature to SHindig - Blog Post

Posted by Michael Young <mi...@liferay.com>.
Hey Chuck,

Thanks for writing this. Helped explain a few things to me that I've been wondering about. 

- Mike
--
Liferay West Coast Symposium
September 8-9, 2010
Anaheim, CA
www.liferay.com/wcs
--
Follow us on Twitter: liferay

On Jul 5, 2010, at 5:31 AM, csev wrote:

> Hello all,
> 
> Thanks for your help last week as I muddled through adding a feature and osapi service to Shindig.  The results of my wandering are captured in six blog posts starting here:
> 
> http://www.dr-chuck.com/csev-blog/2010/07/playing-with-shindigopensocial-adding-a-new-feature-and-a-service/
> 
> Feel free to review and comment and suggest improvements.  I only started playing with this a few weeks back so I may have truly missed something.
> 
> As I said in my note last week, if you would like me to recast this material for the wiki - I am happy to do so - just tell me where it fits.  There are several independent pieces so they might go several places in the wiki.
> 
> Again, thanks so much.
> 
> Chuck Severance
> www.dr-chuck.com