IPCse11 Nicolas Pastorino Launching content in mobility with REST and eZ Publish

Launching content in mobility withREST & eZ Publish


Nicolas Pastorino - [email protected] Community - eZ Systems@jeanvoye - http://share.ez.no

mailto:[email protected]


http://share.ez.no

http://share.ez.no

Mobile



International PHP Conference, SE 2011 - Berlin - May 30th

#ipcse11



http://share.ez.no

http://share.ez.no

Mobile



International PHP Conference, SE 2011 - Berlin - May 30th

#ipcse11



http://share.ez.no

http://share.ez.no

Our agenda :

Multichannel : why ?Our agenda :

Multichannel : why ?REST

Our agenda :


Extensible REST API

Our agenda :


Extensible REST APIDemo

Our agenda :

Multichannel : why ?

3

How would you feel playing Pacman on a single, straight line of dots ?



Boring,right ?

Multichannel content distribution is the real Pacman

Multichannel content distribution is the real Pacman

30/05/2011Nicolas Pastorino - IPCse11

Pre-requisites to multichannel distribution

7



7

Separation of layout and content at the content source level

1



7


1



7


1

Do not compromise on user experience 2



7

“The Superman Effect” Aral Balkan, DPC11


1




7


“There is a lot of effort going into improving customer experience. It is key to get consistency across different channels so their experience does not vary” Jim Daviesni


1




7




1


Have a single source of content 3



7




1


Have a single source of content 3

“Publishers usually can't afford a dedicated editorial team per channel”

Are 3 rules of thumb

enough ?

Are 3 rules of thumb

enough ? We’re

hardly off the ground.

Let’s dig further...

CMSSingle Content Source /



Monetized Content Streams



Mobile ApplicationsSmartphones, Tablets




Push ContentNewsletters

3rd partyCRM, ERP





PrintLegacy publication chains

3rd partyCRM, ERP





PrintLegacy publication chains

Social Media

3rd partyCRM, ERP

"Multichannel media consumers have higher levels of engagement than those present in only one channel.

The more one watches TV, listens to the radio, spends time online, etc., the more advertising they consume.

This shows that multichannel content distribution will also have an important impact on the publishers revenue structure. It will evolve to become a competitive, critical, enabling technology for marketing communications."

Having a REST ?

:)

Having a REST ?

:)

A touch more of

insight will help...

“Media companies as well as consumer brands must recognize that adding mobile to the multichannel mix does not mean creating a mini-channel. Those building mobile strategies should recognize that:

• Mobile is not just about shrinking the desktop experience,

• The user environment is an element of the mobile experience,

• Mobile users are not simply a subset of online users – some are new.”

Least Common

Denominator :

Least Common

Denominator :

a REST API

Those were the basics to increase

your REACHthrough multiple

channels

REST

15

REpresentational State Transfer


REST is a set of principles that define how Web standards, such as HTTP and URIs, are supposed to be used.

• Give every “thing” an ID• Link things together (“HATEOAS”)• Use standard methods• Resources with multiple representations• Communicate statelessly


REST is a set of principles that define how Web standards, such as HTTP and URIs, are supposed to be used.

• Give every “thing” an ID• Link things together (“HATEOAS”)• Use standard methods• Resources with multiple representations• Communicate statelessly

h"p://en.wikipedia.org/wiki/Representa4onal_State_Transferh"p://www.infoq.com/ar4cles/rest-‐introduc4on

http://www.infoq.com/articles/rest-introduction


http://en.wikipedia.org/wiki/Representational_State_Transfer









Key goals of REST include:

• Scalability of component interactions• Generality of interfaces• Independent deployment of components• Intermediary components to reduce latency, enforce security and encapsulate legacy systems


http://en.wikipedia.org/wiki/Scalability

http://en.wikipedia.org/wiki/Scalability

http://en.wikipedia.org/wiki/Interface_(computer_science)

http://en.wikipedia.org/wiki/Interface_(computer_science)

http://en.wikipedia.org/wiki/Software_deployment

http://en.wikipedia.org/wiki/Software_deployment

http://en.wikipedia.org/wiki/Latency_(engineering)

http://en.wikipedia.org/wiki/Latency_(engineering)

http://en.wikipedia.org/wiki/Data_security

http://en.wikipedia.org/wiki/Data_security

http://en.wikipedia.org/wiki/Information_hiding

http://en.wikipedia.org/wiki/Information_hiding

http://en.wikipedia.org/wiki/Legacy_system

http://en.wikipedia.org/wiki/Legacy_system





Extensible REST API

18

at the core of the eZ Publish CMS


At the core of the eZ Publish CMS

REST as a core feature

19

Extensible REST API


Dedicated front-controller

20

At the core of the eZ Publish CMS Extensible REST API

30/05/2011Nicolas Pastorino - IPCse11 21

REST setup

REST

FC

eZPREST request

eZ Publishweb-‐request



REST setup

REST

FC

eZPREST request

eZ Publishweb-‐request



Mapping content into resources



Makes data availableMakes data available



Makes data reusableMakes data reusable



Content is essentially liberated



URI pattern

25



Prefix Provider VersionGET Host / / / / Call + params

Just a token to trigger your rewrite rule

ezpRestPrefixFilterInterface



Prefix

Provider

Version





Prefix

Provider

Version





Prefix

Provider

Version





Prefix filter

27

Current provider

Current parsed version value



Versioned API

28

class ezpRestRouter extends ezcMvcRouter{ public function createRoutes() { // ezpRestApiProvider $routes = array( new ezcMvcRailsRoute( '/content/node/:nodeId/listAtom', 'ezpRestAtomController', 'collection' ), new ezcMvcRailsRoute( '/content/node/:nodeId/list', 'ezpRestContentController', 'list' ), new ezcMvcRailsRoute( '/content/node/:nodeId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/node/:nodeId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/node/:nodeId/field/:fieldIdentifier', 'ezpRestContentController', 'viewField' ), new ezcMvcRailsRoute( '/content/object/:objectId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/object/:objectId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/object/:objectId/field/:fieldIdentifier', 'ezpRestContentController', 'viewField' ),

new ezpRestVersionedRoute( new ezcMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ), new ezpRestVersionedRoute( new ezcMvcRailsRoute( 'e/foo', 'myController2 or myControlerWhichExtendsmyController', 'myBetterAndScalingAction' ), 2 ), ); return ezcMvcRouter::prefix( '/api', $routes ); }}


Versioned API

makes the notion version a part of the routing decision

29

Version

ezpRestVersionedRoute


Build your own flavor,extend the interface(s)

30



Extending the interface

31

REST providers


Extending the interface

ezpRestProviderInterface

32

Overview of hooksthe places where you can go wild.



Route setup - Example

35

class ezpRestRouter extends ezcMvcRouter{ public function createRoutes() { $providerRoutes = ezpRestProvider::getProvider( ezpRestPrefixFilterInterface::getApiProviderName() )->getRoutes();

$routes = array( new ezpMvcRailsRoute( '/fatal', 'ezpRestErrorController', 'show' ), new ezpMvcRailsRoute( '/http-basic-auth', 'ezpRestAuthController', 'basicAuth' ), new ezpMvcRailsRoute( '/login/oauth', 'ezpRestAuthController', 'oauthRequired' ), new ezpMvcRailsRoute( '/oauth/token', 'ezpRestOauthTokenController', 'handleRequest'),

// ezpRestVersionedRoute( $route, $version ) // $version == 1 should be the same as if the only the $route had been present new ezpRestVersionedRoute( new ezpMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ), new ezpRestVersionedRoute( new ezpMvcRailsRoute( '/foo', 'myController', 'myActionOneBetter' ), 2 ),

);

return ezcMvcRouter::prefix( '/api', array_merge( $providerRoutes, $routes ) ); }}

Extensible REST API

36

Key features


Content resources

37

Key featuresExtensible REST API


Key features

GET /[api]/v1/content/object/<objectId>/fields HTTP/1.1

38


Key features

fields/<fieldname>

type (datatype string)

identifier (attribute identifier)

value (string representation of data)

id (object attribute numerical ID)

classattribute_id (class attribute numerical ID)

39


Key features

GET /[api]/v1/content/object/<objectId>/field/

<FieldIdentifier> HTTP/1.1

40

Demo

41

Web + Android, eZ Publish powered

Famous Last Slides

42


Extensible REST APIDemo

RECAP

You won’t ever play Pacman the same way again :)



eZ Communityhttp://share.ez.no

eZ Publish Community Projecthttps://github.com/ezsystems/ezpublishhttp://share.ez.no/download http://share.ez.no/get-involved

eZ Systems & eZ Publish Enterprise Editionhttp://ez.no

Find me on Twitter : @jeanvoye

Rate this talk : http://joind.in/3482 Slides available soon at http://slideshare.net/jeanvoye

eZ Conference, June 16th&17th, London : Rasmus Lerdorf, Derick Rethans, Tobias Schlitt Get a 20% off coupon at the eZ booth in the hall, and register : http://london2011.ez.no

Thank you !

https://github.com/ezsystems/ezpublish

https://github.com/ezsystems/ezpublish

http://share.ez.no/download






http://joind.in/3482

http://joind.in/3482

http://slideshare.net/jeanvoye

http://slideshare.net/jeanvoye

http://london2011.ez.no

http://london2011.ez.no

IPCse11 Nicolas Pastorino Launching content in mobility with REST and eZ Publish

Technology

wont everplay

1content source

id link things

standard methods

straight lineof

international

improving

single source