atomPub, ruby y la api de 11870

Atom Publishing
Protocol, ruby y la
api de 11870.com
David Calavera

11870.com

๏ recuerda y comparte negocios ...

David Calavera Conferencia Rails 2007

11870.com

• recuerda y comparte negocios ...
๏ no solo de comentarios vive el hombre


11870.com

• no solo de comentarios vive el hombre
๏ ¿por qué tengo que atarme a la web?


11870.com

• no solo de comentarios vive el hombre
• ¿por qué tengo que atarme a la web?
๏ ¿quien tiene que adaptarse?


“the atom publishing protocol is an
application-level protocol for
publishing and editing web resources”


๏ ¿sabes qué es HTTP y como usarlo?


• ¿sabes qué es HTTP y como usarlo?
๏ ¿sabes qué es XML y como usarlo?


• ¿sabes qué es HTTP y como usarlo?
• ¿sabes qué es XML y como usarlo?
๏ ¿sabes qué es un feed y como crearlo?


estándar

http://ietfreport.isoc.org/idref/rfc5023


basado en atom
<?xml version=quot;1.0quot; encoding=quot;utf-8quot;?>
<feed xmlns=quot;http://www.w3.org/2005/Atomquot; xml:lang=quot;enquot;>
<id>http://www.verbosemode.com/wp-app.php/posts</id>
<updated>2007-11-04T11:38:28Z</updated>
<title type=quot;textquot;>Verbose mode</title>
<subtitle type=quot;textquot;>Verbose mode</subtitle>
<entry>
<id>http://www.verbosemode.com/?p=3</id>
<title type=quot;textquot;>Spanish Rails Conf 07</title>
<published>2007-11-04T11:38:28Z</published>
...


arquitectura REST


arquitectura REST

๏ protocolo sin estado


arquitectura REST

• protocolo sin estado
๏ operaciones bien definidas


arquitectura REST

• protocolo sin estado
• operaciones bien definidas
๏ sintaxis universal (IRI)


IRI

www.
.w3.mag.keio.ac.jp


URI
www.%e3%81%bb%e3%82%93%e3%81%a8%e3%81%86%e3%
81%ab%e3%81%aa%e3%81%8c%e3%81%84%e3%82%8f%e3%
81%91%e3%81%ae%e3%82%8f%e3%81%8b%e3%82%89%e3%
81%aa%e3%81%84%e3%81%a9%e3%82%81%e3%81%84%e3%
82%93%e3%82%81%e3%81%84%e3%81%ae%e3%82%89%
e3%81%b9%e3%82%8b%e3%81%be%e3%81%a0%e3%81%aa%
e3%81%8c%e3%81%8f%e3%81%97%e3%81%aa%e3%81%84%
e3%81%a8%e3%81%9f%e3%82%8a%e3%81%aa%e3%81%
84.w3.mag.keio.ac.jp


introspectivo


introspectivo

documento de servicio


introspectivo

colección
colección


introspectivo

colección
elementos
colección
elementos


fácilmente extensible
<feed xmlns=quot;http://www.w3.org/2005/Atomquot; xml:lang=quot;enquot;
xmlns:openSearch=quot;http://a9.com/-/spec/opensearchrss/1.0/quot;>
<subtitle type=quot;textquot;>Verbose mode</subtitle>
<openSearch:totalResults>1</openSearch:totalResults>
<openSearch:startIndex>1</openSearch:startIndex>
<openSearch:itemsPerPage>25</openSearch:itemsPerPage>
<entry>
...


multimedia


más...

๏ paginación


<feed xmlns=quot;http://www.w3.org/2005/Atomquot; xml:lang=quot;enquot;>
<link rel=quot;selfquot; href=quot;http://www.verbosemode.com/wp-app.php/posts?p=3quot;/>
<link rel=quot;nextquot; href=quot;http://www.verbosemode.com/wp-app.php/posts?p=4quot;/>
<link rel=quot;previousquot; href=quot;http://www.verbosemode.com/wp-app.php/posts?p=2quot;/>
<link rel=quot;firstquot; href=quot;http://www.verbosemode.com/wp-app.php/postsquot;/>
<link rel=quot;lastquot; href=quot;http://www.verbosemode.com/wp-app.php/posts?p=5quot;/>
...


más...

• paginación
๏ caché


POST /wp-app.php/posts
HTTP/1.1 201 Created
Content-Type: application/atom+xml;type=entry;charset=quot;utf-8quot;
ETag: quot;c180de84f991g8quot;



GET /wp-app.php/post/3
HTTP/1.1 304 Not Modified
If-None-Match: quot;c180de84f991g8quot;



GET /wp-app.php/post/3
HTTP/1.1 304 Not Modified
If-None-Match: quot;c180de84f991g8quot;

PUT /wp-app.php/post/3
HTTP/1.1 412 Precondition Failed
If-Match: quot;c180de84f991g8quot;


más...

• paginación
• caché
๏ control de estado


<entry xmlns=quot;http://www.w3.org/2005/Atomquot;
xmlns:app=quot;http://www.w3.org/2007/appquot; xml:lang=quot;enquot;>
<app:control>
<app:draft>no</app:draft>
</app:control>
...


más...

• paginación
• caché
• control de estado
๏ seguridad


atomPub:service

GET 'http://www.verbosemode.com/wp-app.php/service'
HTTP/1.1 200 OK


atomPub:service
<service xmlns=quot;http://www.w3.org/2007/appquot;
xmlns:atom=quot;http://www.w3.org/2005/Atomquot;>
<workspace>
<atom:title>Workspace</atom:title>
<collection href=quot;http://www.verbosemode.com/wp-app.php/postsquot;>
<atom:title>Posts</atom:title>
<accept>application/atom+xml;type=entry</accept>
<categories href=quot;http://www.verbosemode.com/wp-app.php/categoriesquot;/>
</collection>
<collection href=quot;http://www.verbosemode.com/wp-app.php/attachmentsquot;>
<atom:title>Media</atom:title>
<accept>image/*</accept>
<accept>audio/*</accept>
<accept>video/*</accept>
</collection>
</workspace>
</service>


atomPub:categories

GET 'http://www.verbosemode.com/wp-app.php/categories'
HTTP/1.1 200 OK


atomPub:categories
<app:categories xmlns:app=quot;http://www.w3.org/2007/appquot;
xmlns=quot;http://www.w3.org/2005/Atomquot; fixed=quot;yesquot;
scheme=quot;http://www.verbosemode.comquot;>
<category term=quot;atomPubquot; />
<category term=quot;railsquot; />
</app:categories>


atomPub:collection
POST 'http://www.verbosemode.com/wp-app.php/posts'
Content-Type: */*
Location: 'http://www.verbosemode.com/wp-app.php/post/3'
Content-Location: 'http://www.verbosemode.com/wp-app.php/post/3'

GET 'http://www.verbosemode.com/wp-app.php/posts'
HTTP/1.1 200 OK


atomPub:collection
<feed xmlns=quot;http://www.w3.org/2005/Atomquot;
<link rel=quot;firstquot; href=quot;http://www.verbosemode.com/wp-app.php/postsquot;/>
<link rel=quot;lastquot; href=quot;http://www.verbosemode.com/wp-app.php/postsquot;/>
<link rel=quot;selfquot; href=quot;http://www.verbosemode.com/wp-app.php/postsquot;/>
<entry>
<app:edited>2007-11-04T11:38:28Z</app:edited>
<link rel=quot;editquot; href=quot;http://www.verbosemode.com/wp-app.php/post/3quot;/>
<app:control><app:draft>no</app:draft></app:control>
...


atomPub:entry

PUT 'http://www.verbosemode.com/wp-app.php/post/3'
HTTP/1.1 204 No Content
Content-Type: application/atom+xml;type=entry

DELETE 'http://www.verbosemode.com/wp-app.php/post/3'
HTTP/1.1 200 OK

GET 'http://www.verbosemode.com/wp-app.php/post/3'
HTTP/1.1 200 OK


atomPub:entry
<author><name>david</name></author>
<content type=quot;xhtmlquot;><div xmlns='http://www.w3.org/1999/xhtml'>
Next November 22 and 23 I'm going to attend to ...</div></content>
<link rel=quot;editquot; href=quot;http://www.verbosemode.com/wp-app.php/post/3quot; />
<category scheme=quot;http://www.verbosemode.comquot; term=quot;atomPubquot; />
<category scheme=quot;http://www.verbosemode.comquot; term=quot;railsquot; />
<summary type=quot;textquot;>Next November 22 and 23 I’m ...</summary>
</entry>


atomPub:entry
¿y... qué pasa con los otros tipos de recursos?

<id>http://www.verbosemode.com/wp-content/uploads/2007/11/avatar.png</id>
<title type=quot;textquot;>avatar poster</title>
<author><name>david</name></author>
<link rel=quot;edit-mediaquot;
href=quot;http://www.verbosemode.com/wp-app.php/attachment/file/4quot; />
<link rel=quot;editquot; href=quot;http://www.verbosemode.com/wp-app.php/post/4quot; />
<content type=quot;image/pngquot;
src=quot;http://www.verbosemode.com/wp-content/uploads/2007/11/avatar.pngquot;/>
</entry>


atomPub:entry
¿y... qué pasa con los otros tipos de recursos?

PUT 'http://www.verbosemode.com/wp-app.php/attachment/file/4'
HTTP/1.1 204 No Content
Content-Type: */*

DELETE 'http://www.verbosemode.com/wp-app.php/attachment/file/4'
HTTP/1.1 200 OK

GET 'http://www.verbosemode.com/wp-app.php/attachment/file/4'
HTTP/1.1 200 OK


atomPub
¿pero... hay gente que usa esto?

๏ google: gdata, youtube, openSocial


• google: gdata, youtube, openSocial
๏ microsoft: windows live writer


• microsoft: windows live writer
๏ ibm: lotus connections


• ibm: lotus connections
๏ wordpress


• wordpress
๏ nokia: liveblog


• wordpress
• nokia: liveblog
๏ six apart: typepad, movable type


• wordpress
• nokia: liveblog
• six apart: typepad, movable type
๏ 11870.com

Net::HTTP


Net::HTTP

๏ fácil de mantener


Net::HTTP

• fácil de mantener
๏ respuesta condicionada al estado


HTTPResponse
HTTPSuccess # 2xx
HTTPOK # 200
HTTPCreated # 201
HTTPRedirection # 3xx
HTTPNotModified # 304
HTTPClientError # 4xx
HTTPBadRequest # 400
HTTPUnauthorized # 401
HTTPForbidden # 403
HTTPNotFound # 404
HTTPPreconditionFailed # 412
HTTPUnsupportedMediaType # 415
HTTPServerError # 5xx
HTTPInternalServerError # 500


Net:HTTP

• fácil de mantener
• respuesta condicionada al estado
๏ no sabe si estoy en una capa segura


require 'net/http'
require 'net/https'

@uri = 'https://registro.conferenciarails.org'
http = Net::HTTP.new @uri
http.use_ssl = true if @uri =~ /^https/


los cuatro verbos http
Net::HTTP.start(@uri.host, @uri.port) do |http|
end


#POST
http.request Net::HTTP::Post.new(@uri.path), data
end


#POST
#GET
http.request Net::HTTP::Get.new(@uri.path)
end


#POST
#GET
#PUT
http.request Net::HTTP::Put.new(@uri.path), data
end


#POST
#GET
#PUT
http.request Net::HTTP::Put.new(@uri.path), data
#DELETE
http.request Net::HTTP::Delete.new(@uri.path)
end


REXML

๏ parser completo


REXML

• parser completo
๏ escrito completamente en ruby


REXML

• parser completo
• escrito completamente en ruby
๏ pasa los test de aceptación de Oasis


REXML

• parser completo
• escrito completamente en ruby
• pasa los test de aceptación de Oasis
๏ soporta XPath


REXML y xpath
NS = {'atom' => 'http://www.w3.org/2005/Atom',
'app' => 'http://www.w3.org/2007/app',
'georss' => 'http://www.georss.org/georss/10',
'gml' => 'http://www.opengis.net/gml'
}

REXML::XPath.each( feed.root, './atom:entry', NS) do |entry|
title = REXML::XPath.first(entry,
'./atom:title/text()', NS)
edited = REXML::XPath.first(entry,
'./app:edited/text()', NS)
pos = REXML::XPath.first(entry,
'./georss:where/gml:Point/gml:pos/text()', NS)
end


Builder

๏ crea xml fácilmente


require 'builder'

builder = Builder::XmlMarkup.new

xml = builder.feed( 'xmlns' => 'http://www.w3.org/2005/Atom' ) do |feed|
feed.id 'http://conferenciarails.org/atomPub'
feed.updated Time.now
feed.author do |author| author.name 'David Calavera' end

feed.entry do |entry|
entry.title 'entrada para la conferencia rails'
end
end


Builder

• crea xml fácilmente
๏ no solo se usa con rails


๏ in the beginning... was the command line
builder = Builder::XmlMarkup.new(:target=>STDOUT, :indent=>2)


• in the beginning... was the command line
builder = Builder::XmlMarkup.new(:target=>STDOUT, :indent=>2)

๏ vamos de camping
Camping.goes :Atom
module Atom::Views
def index
html do
head do
title 'Atom Publishing Protocol @ conferecia rails'
end
body do ... end
end
end


atom-tools
http://code.necronomicorp.com/atom-tools

๏ parsea y manipula feeds


atom-tools

• parsea y manipula feeds
๏ adaptado al rfc 5023


atom-tools

• parsea y manipula feeds
• adaptado al rfc 5023
๏ abstracción de http y xml


require 'atom-tools'

http = Atom::HTTP.new
http.user = 'david'
http.pass = 'my password'
http.always_auth :basic

service = Atom::Service.new
'http://verbosemode.com/wp-app.php/service', http

service.collections.each do |collection|
puts collection.accepts
end


atom_pub_server
http://svn.thinkincode.net/rails/plugins/atom_pub_server

๏ rails es REST


atom_pub_server

• rails es REST
๏ mejor soporte para atom y atomPub


atom_feed({'xmlns:georss' => 'http://www.georss.org/georss/10',
'xmlns:gml' => 'http://www.opengis.net/gml'}) do |feed|
feed.title(quot;My great blog!quot;)
feed.updated((@posts.first.created_at))

for post in @posts
feed.entry(post) do |entry|
entry.georss:where do |where|
where.gml:Point do |point|
point.tag!('gml:pos', '40.419967 -3.698965')
end
end


atom_pub_server

• rails es REST
• mejor soporte para atom y atomPub
๏ acts_as_collection


class PostsController < ApplicationController
acts_as_collection :title => 'Posts', :workspace => 'Blog',
:accept => Mime::ATOM_ENTRY,
:href => 'http::/verbosemode.com/atomPub/posts',
:categories => [
{
:fixed => 'yes', :scheme => 'http://verbosemode.com/tags',
:category => [{:term => 'rails'}, {:term => 'plugins'}]
},
{:href => 'http://verbosemode.com/mysections'}
]
end


atom_pub_server

• rails es REST
• mejor soporte para atom y atomPub
• acts_as_collection
๏ acts_as_service_document


class ServicesController < ApplicationController
acts_as_service_document

def index
render :xml => service_document
end
end


the ape
http://www.tbray.org/ape

๏ the atom publishing exerciser

the ape

• the atom publishing exerciser
๏ introspección!!!


the ape

• introspección!!!
๏ varios sistemas de autenticación


the ape

• varios sistemas de autenticación
๏ no es muy fácil de instalar (de momento)


the ape

• varios sistemas de autenticación
• no es muy fácil de instalar (de momento)
๏ no es muy fácil de configurar (de momento)


la api de 11870.com
http://11870.com/api

por partes

๏ api de búsqueda
➡ formato openSearch (http://opensearch.org)


<?xml version=quot; 1.0quot; encoding=quot;UTF-8quot;?>
<service xmlns:atom=quot;http://www.w3.org/2005/Atomquot;
xmlns=quot;http://www.w3.org/2007/app quot; xml:base=quot;http://11870.com/quot;>
<workspace>
<atom:title type=quot;textquot;>11870 workspace</atom:title>
<collection href=quot;/api/v1/searchquot;>
<atom:title type=quot;textquot;>Search</atom:title>
</collection>
</workspace>
</service>


por partes

• api de búsqueda
๏ api de gestión de contenidos


<?xml version=quot;1.0quot; encoding=quot;UTF-8quot;?>
<service xmlns:atom=quot;http://www.w3.org/2005/Atomquot; xmlns=quot; http://www.w3.org/2007/appquot;
xml:base=quot;http://localhost/quot;>
<workspace>
<atom:title type=quot;textquot;>11870 workspace</atom:title>
<collection href=quot;/api/v1/sites/calaveraquot;>
<atom:title type=quot;textquot;>Sites</atom:title>
<categories xmlns:oos=quot;http://11870.com/api/oos quot;
href=quot;http://localhost/api/v1/lists/calaveraquot; oos:label=quot;listsquot;/>
<categories xmlns:oos=quot; http://11870.com/api/oosquot;
href=quot;http://localhost/api/v1/tags/calaveraquot; oos:label=quot;tagsquot;/>
href=quot;http://localhost/api/v1/privacyquot; oos:label=quot;privacyquot;/>
</collection>
<collection href=quot;/api/v1/contacts/calaveraquot;>
<atom:title type=quot;textquot;>Contacts</atom:title>
href=quot;http://localhost/api/v1/trustedquot; oos:label=quot;trustedquot;/>
</collection>
<collection href=quot;/api/v1/usersquot;>
<atom:title type=quot;textquot;>Users</atom:title>
<accept>image/*</accept>
</collection>
<collection href=quot;/api/v1/searchquot;>
<atom:title type=quot;textquot;>Search</atom:title>
</collection>
</workspace>
</service>


más allá de atomPub

๏ sintaxis


<entry xmlns:app=quot;http://www.w3.org/2007/appquot;
xmlns:oos=quot;http://11870.com/api/oosquot;
xmlns:georss=quot;http://www.georss.org/georss/10quot;
xmlns=quot;http://www.w3.org/2005/Atomquot; xml:lang=quot;enquot;>
<id>http://11870.com/pro/23474/calavera</id>
<title type=quot;textquot;>Apple Store Fifth Avenue</title>
<oos:useraddress>767 5th Avenue</oos:useraddress>
<oos:url>http://www.apple.com/retail/fifthavenue</oos:url>
<oos:telephone>+1 212 3361440</oos:telephone>
<oos:locality slug=quot;/us/new-yorkquot;>New York</oos:locality>
<oos:country slug=quot;/usquot;>United States</oos:country>



• sintaxis
๏ autenticación



• sintaxis
๏ autenticación
➡ identificar aplicaciones


Net::HTTP.start( '11870.com' ) do |http|
req = Net::HTTP::Get.new('/api/v1')
req['appToken'] = 'el app token que 11870 te ha asignado'
digest = Digest::MD5.hexdigest(quot;#{req['appToken']}#{la clave secreta}quot;)
req['authSign'] = digest
http.request req
end



• sintaxis
๏ autenticación
➡ autenticar usuarios


request['Authorization'] = 'WSSE profile=quot;UsernameTokenquot;'
request['X-WSSE'] = wsse!

def wsse!

nonce = Array.new(10){ rand(0x1000000) }.pack('I*')
nonce_b64 = [nonce].pack(quot;mquot;).chomp
now = Time.now.gmtime.strftime(quot;%FT%TZquot;)
digest = [Digest::SHA1.digest(nonce_b64 + now + @password)].pack(quot;mquot;).chomp

%Q<UsernameToken Username=quot;#{@username}quot;,
PasswordDigest=quot;#{digest}quot;, Nonce=quot;#{nonce_b64}quot;, Created=quot;#{now}quot;>
end



• sintaxis
๏ autenticación
➡ autenticar usuarios
➡ evolucionará a OAuth (http://oauth.net)



• sintaxis
• autenticación
๏ múltiples representaciones


{
quot;idquot;:quot;/api/v1/sites/calaveraquot;,
quot;titlequot;:quot;Sitesquot;,
quot;updatedquot;:quot;2007-09-28T07:53:46.000Zquot;,
quot;authorsquot;:[{
quot;namequot;:quot;calaveraquot;
}
],
quot;linksquot;:[{
quot;hrefquot;:quot;http://11870.com/api/v1/sites/calaveraquot;,
quot;relquot;:quot;selfquot;
},{
quot;hrefquot;:quot;http://11870.com/api/v1/sites/calavera?page=2quot;,
quot;relquot;:quot;nextquot;
}
],
quot;entriesquot;:[{
quot;langquot;:quot;esquot;,
quot;idquot;:quot;http://11870.com/pro/23474/calaveraquot;,
quot;titlequot;:quot;Apple Store Fifth Avenuequot;,
quot;summaryquot;:quot;en directoquot;,
quot;contentquot;:quot;estoy ahora mismo en esta...



• sintaxis
• autenticación
• múltiples representaciones
๏ control de versiones


๏ ahora
http.request Net::HTTP::Get.new('/api/v1')
end


• ahora
http.request Net::HTTP::Get.new('/api/v1')
end

๏ en un futuro
http.request Net::HTTP::Get.new('/api/v1.5')
end



• sintaxis
• autenticación
• control de versiones
๏ soporte de librerías


http://code.google.com/p/api-11870/



• sintaxis
• autenticación
• control de versiones
• soporte de librerías
๏ ¡documentación!

http://groups.google.com/group/api-11870


la api de 11870.com
oos4ruby

búsqueda
require 'oos4ruby'

oos = Oos.new
oos.auth_app 'appToken', 'secretKey'

oos.search q => 'apple store in new york'

oos.search bbox => ['SOUTH', 'WEST', 'NORTH', 'EAST']

oos.search lat => 'LATITUDE', lon => 'LONGITUDE', radius => '3000 METRES'

oos.search tags => ['restaurant', 'cheap', 'clean']


gestión
require 'oos4ruby'

oos = Oos.new
oos.auth_user 'user email', 'auth token'

user = oos.user
user.sites.each do |pro|
unless pro.multimedia.empty?
pro.multimedia.each do |media|
puts media.type
puts media.src
end
end
end

user.contacts.create! :slug => 'calavera', :trusted => 'true'

user.update_avatar! '/Users/david/skull.png'


muchas gracias
http://thinkincode.net

atomPub, ruby y la api de 11870

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (11)

Similar to atomPub, ruby y la api de 11870

Similar to atomPub, ruby y la api de 11870 (20)

More from David Calavera

More from David Calavera (8)

Recently uploaded

Recently uploaded (20)

atomPub, ruby y la api de 11870