collective.oembed 2.0.1

Introduction

This addon integrate oembed into Plone. You can find a demo at http://youtu.be/kHikGIWrvCs

oEmbed official documentation: http://oembed.com/

You have to know this addon try to go beyond already supported website and with as many providers as possible without third party services.

How to install

This addon can be installed has any other addons. Please follow official documentation.

oembed provider

Your site will become an oembed provider using @@oembed view as an endpoint:

URL Scheme: http://mysite.com/*
API endpoint: http://mysite.com/@@oembed
Supports discovery via <link> tags

This addon use archetypes getPrimaryField to get the most representative field of your content type and then build information on how to embed this content

To change this behavior you can override the view for specific context:

<browser:page
    name="oembed"
    for="my.specific.context.IMYContent"
    class="my.specific.provider.OEmbedProvider"
    permission="zope2.View"
    layer="my.specific.layer.Layer"
    />


from collective.oembed.provider.
class OEmbedProvider(OEmbedProvider):
    def add_context_info(self, ob, site):
        self.embed['type'] = 'rich'
        ...

oembed client

This addon provide an integration of jquery.oembed plugin. Because there are many fork you have to choose the one you will use. The official plugin has been integrated to plone throw the addon collective.js.oembed

The oembed client is integrated using a viewlet that is not activated by default. You have to activate it throw the controlpanel. It is configured that way:

<script type="text/javascript">
  jqueryOmebedSettings = {...} //extracted from the controlpanel
</script>
<script type="text/javascript">
        $(document).ready(function() {
            $(".oembed").oembed(null,jqueryOmebedSettings);
        });
</script>

consumer

A consumer is availabe throw a utility:

>>> url = "http://www.youtube.com/watch?v=it1hMtZKle8"
>>> consumer = component.getUtility(collective.oembed.interfaces.IConsumer)
>>> consumer.get_data(url, maxwidth=300, maxheight=None, format='json')
{...}

There is also a @@collective.oembed.consumer view, which can take params throw attributes:

>>> consumer_view = component.queryMultiAdapter((self.context,self.request),
...                                 name=u'collective.oembed.consumer')
>>> consumer_view._url = url
>>> consumer_view.embed_auto()
<div class="oembed-wrapper oembed-video">...</div>

OEmbed link view

This addon register an oembed view to the Link content type. It displays content provided from the remote url and do not set maxwidth & maxheight. It should be achieved by integrators.

The link view stores 3 different lists of components:

• oembed

• api2embed

• url2embed

While the returned data will be sufficient to embed the target
widget in your view, you won't be able to access the metadata which
could have been associated with it in a straight oEmbed format.

Embed.ly

This addon can use embed.ly service. You can set the embed.ly api key in the control panel or install and configure collective.embedly, this addon will use the configuration provided by this one.

Providers

embed.ly is activated only if you have added an api_key or configured collective.embedly. The addon provide native support for the following services:

External providers:

• Embedly (http://embed.ly)

Video providers:

• 5min (http://www.5min.com/)

• Youtube (http://www.youtube.com/)

• Qik (http://qik.com/)

• Revision3 (http://revision3.com/)

• Hulu (http://www.hulu.com/)

• Vimeo (http://vimeo.com/)

• CollegeHumor (http://www.collegehumor.com/)

• Kinomap (http://wwww.kinomap.com/)

• Dailymotion (http://www.dailymotion.com/)

• Clikthrough (http://clikthrough.com)

• Dotsub (http://dotsub.com/)

• Vhx.tv (http://vhx.tv) NOTE: only works with the dedicated URL for sharing

• Nfb.ca (http://http://www.nfb.ca/)

• Wordpress TV (http://wordpress.tv/)

• Screenr (http://screenr.com/)

Photo providers:

• 23hq (http://www.23hq.com/)

• Flickr (http://www.flickr.com/)

• SmugMug (http://www.smugmug.com/)

• Photobucket (http://photobucket.com)

• Instagr (http://instagr.am/)

• Picasa (https://picasa.google.com/)

Rich providers:

• Occipital (http://360.io)

• iFixit (http://www.iFixit.com)

• Apple (http://itunes.apple.com)

• Poll Everywhere (http://www.polleverywhere.com/)

• SlideShare (http://www.slideshare.net/)

• WordPress (http://wordpress.com/)

• Official.FM (http://official.fm)

• Gist Github (https://gist.github.com)

• Google Calendar (https://www.google.com/calendar)

• Google Docs (https://docs.google.com/)

• Google Maps (http://maps.google.com)

• Issuu (http://issuu.com)

• Scribd (http://www.scribd.com)

• SoundCloud (http://soundcloud.com/)

• Spotify (http://open.spotify.com/)

Proxy OEmbed Endpoint

This addon provide consumer and provider. Both can be used at the same time in the proxy oembed endpoint. It means you can ask your site how to display an URL what ever it comes from the site itself or from outside.

Other Plone addons

• collective.portlet.oembed

• collective.js.oembed

• collective.embedly

Addon design (targeted to 2.0)

The internal code has been completly redone on 2.0

Goals:

• code easier to understand

• less components

• performance optimization

The provided integration use only json throw ajax request.

We have one main view which achieve the job: @@proxy-oembed-provider

This one use a ram cache with a cache-key based on: * url + max-width + max-height * 1 hour (in case distant html has changed)

There is a structure key/value with hostname as keys and low level consumer name as values which are instanciated when needed (lazy loading) so it use less memory.

Credits

Companies

• Planet Makina Corpus

• Contact us

Authors

• JeanMichel FRANCOIS aka toutpt <toutpt@gmail.com>

Contributors

• Raphael Gaziano aka raphigaziano <r.gaziano@gmail.com>

• Alejandro Pereira aka aleGpereira <alepereira86@gmail.com>

• Sylvain Bouchard aka bouchardsyl <sylvain.bouchard@savoirfairelinux.com>

Changelog