oos4ruby 0.1.1 → 0.1.2

data/History.txt

@@ -7,3 +7,11 @@
 
 * 1 major enhancement:
   * Changed MIT license to BSD license
+
+== 0.1.2 2007-10-16
+
+* 1 major enhancement:
+  * added multimedia management
+* some bugs fixed
+* README.txt completed
+* more rdoc

data/Manifest.txt

@@ -15,6 +15,8 @@ lib/oos4ruby/contacts.rb
 lib/oos4ruby/entry.rb
 lib/oos4ruby/feed.rb
 lib/oos4ruby/http_invoker.rb
+lib/oos4ruby/media.rb
+lib/oos4ruby/medias.rb
 lib/oos4ruby/oos.rb
 lib/oos4ruby/search.rb
 lib/oos4ruby/service.rb

data/README.txt

@@ -1 +1,54 @@
-README
+oos4ruby is a ruby library to interact with the 11870 API.
+
+== Installing
+
+    sudo gem install oos4ruby
+
+== The basics
+
+The class Oos4ruby::Oos is the endpoint to interact with the api. This class provides the authentication methods in addition to the search and user management methods.
+
+    oos = Oos4ruby::Oos.new
+
+Authenticate as an application in order to perform searches or explore the user contents:
+
+    oos.auth_app 'your appToken', 'your secret key'
+
+Authenticate as a user in order to manage his contents:
+
+    oos.auth_user 'user email in 11870.com', 'user authorization token'
+
+How to perform a search inside 11870:
+
+    oos.search :q => 'cheap restaurants in new york'
+
+How to obtain the services or places saved by a user:
+
+    #if your app is authenticated with this user authorization token
+    user = oos.user
+    #if your app is authenticated to expore contents
+    user = oos.user 'user slug in 11870'
+
+    sites = user.sites.entries
+
+How to add a review from a site that doesn't exist in 11870:
+
+    oos.user.sites.create! {:title => 'this site doesn't exist', 
+        :user_address => 'the address', 
+        :locality => {:name => 'Madrid', :slug => '/es/madrid'},
+        :country => {:name => 'España', :slug => '/es'}, 
+        :summary => 'review title', :content => 'review content',
+        :tags => ['tapas', 'tipical spanish'], :lists => ['food']}
+
+How to add a review from a site that exists in 11870:
+
+    oos.user.sites.create! {:id => '11870 site id',
+        :summary => 'review title', :content => 'review content'}
+
+How to obtain all user contacts in 11870:
+
+    contacts = user.contacts.entries
+
+How to obtain the multimedia feed associated with a review:
+
+    media_collection = user.sites.entries[0].multimedia

data/lib/oos4ruby/bean.rb

@@ -1,12 +1,12 @@
 include Oos4ruby
 
-module Bean
-  def self.append_features(base) #:nodoc:
+module Bean #:nodoc:
+  def self.append_features(base)
     super
     base.extend(ClassMethods)
   end
   
-  module ClassMethods
+  module ClassMethods #:nodoc:
     def define_el_reader(opts = {})
       if !opts.empty?
         opts.each_pair { |key, value|

data/lib/oos4ruby/collection.rb

@@ -1,4 +1,10 @@
 module Oos4ruby
+  
+=begin rdoc
+  This class wraps feed response. You must use its subclass, Oos4ruby::Sites, Oos4ruby::Contacts, Oos4ruby::Medias
+  
+  API feed response is paginated, so, this class provides some methods to explore the feed.
+=end
 class Collection  
   
   attr_reader :entries
@@ -7,32 +13,69 @@ class Collection
     @feed = feed
     @auth = auth
     @slug = slug
+    evalued_class = eval(self.class.name.gsub(/s$/, ''))
+    @entries = feed.entries.map {|entry| evalued_class.new(entry, @auth, @slug) }
   end
-  
+ 
+=begin rdoc
+  returns true if next page exists into the feed
+=end  
   def next_page?
     @feed.next?
   end
   
+=begin rdoc
+  returns true if previous page exists into the feed
+=end
   def previous_page?
     @feed.previous?
   end
   
+=begin rdoc
+  returns the next feed as a new Collection subclass.
+=end
   def next_page    
     return get_page(@feed.next) if next_page?
   end
   
+=begin rdoc
+  returns the previous feed as a new Collection subclass.
+=end
   def previous_page
     return get_page(@feed.previous) if previous_page?   
   end
   
+=begin rdoc
+  updats the current Collection with the next feed response.
+=end
   def next_page!
     return get_page!(@feed.next)
   end
   
+=begin rdoc
+  updates the current Collection with the precious feed response.
+=end
   def previous!
     return get_page!(@feed.previous)
   end
   
+=begin rdoc
+  returns the size of the current collection.
+=end
+  def size
+    @feed.size
+  end
+  
+=begin rdoc
+  returns the total size of the feed.
+=end
+  def total_size
+    @feed.total_size
+  end
+  
+=begin rdoc
+  return all entries into the feed.
+=end
   def all
     all = @entries
     aux = self
@@ -44,6 +87,9 @@ class Collection
     return all
   end
     
+=begin rdoc
+  reload the current collection
+=end
   def refresh!
     return get_page!(@feed.self_link)
   end
@@ -52,19 +98,50 @@ class Collection
     @entries.join("\n")
   end
   
+=begin rdoc
+  method to create a resource into a collection.
+  opts available keys:
+  * if you want to create a Site:
+        :id => 11870 service/place id if it already exists in 11780
+        if the service/place doesn't exit in 11870 then
+          :title => service/place name (required)
+          :user_address (required)
+          :url (optional)
+          :telephone (optional)
+          :locality => a hash with :name and :slug (required)
+          :country => a hash with :name and :slug (required)
+        :summary => review title
+        :content or :review_content => review_content
+        :privacy => a REXML::Element from 11870 privacy scheme or a string with "true" or "false"
+        :tags => an array of tags
+        :lists => an array of lists
+  * if you want to create a Contact:
+        :contact or :slug or :title => the new contact slug
+        :trusted => a REXML::Element from 11870 trusted scheme or one of the next strings => "public", "trustedContacts", "contacts", "private"
+  * if you want to create a Media:
+        :file => the new media file system path or a File object
+        :content_length => file size
+        :content_type => file content type
+=end
   def create!(opts = {})
     opts[:author] = REXML::XPath.first(@feed.xml, 'author', XmlNamespaces)
     
-    new_entry = Site.dump! opts, @slug if self.instance_of?Sites
-    new_entry = Contact.dump! opts, @slug if self.instance_of?Contacts
+    evalued_class = eval(self.class.name.gsub(/s$/, ''))
+    body = evalued_class.dump! opts, @slug
+    unless self.instance_of?Medias      
+      body = "<?xml version='1.0' ?>\n" + body.to_s      
+    end
     
     poster = HTTPInvoker.new( @feed.self_link, @auth)
     
-    worked = poster.post AtomEntryContentType, "<?xml version='1.0' ?>\n" + new_entry.to_s
+    content_type = opts[:content_type] || AtomEntryContentType
+    opts.reject {|k, v| k == :content_type}
+    opts.each {|k, v| poster.set_header(k, v)}
+    
+    worked = poster.post content_type, body
         
     raise RuntimeError.new unless worked
-    return Site.new(poster.entry, @auth, @slug) if self.instance_of?Sites
-    return Contact.new(poster.entry, @auth, @slug) if self.instance_of?Contacts
+    return evalued_class.new(poster.entry, @auth, @slug)
   end
   
   private
@@ -86,8 +163,8 @@ class Collection
   end
   
   def convert( body )
-    return Sites.new( Feed.read( body ), @auth, @slug ) if self.instance_of?(Sites)
-    return Contacts.new( Feed.read( body ), @auth, @slug ) if self.instance_of?(Contacts)
+    evalued_class = eval(self.class.name)
+    return evalued_class.new( Feed.read( body ), @auth, @slug )    
   end
   
 end

data/lib/oos4ruby/contact.rb

@@ -42,8 +42,11 @@ class Contact < BeanClass
   def Contact.dump!(opts, slug)
     entry = create_entry
     
-    entry.add_element opts[:author]    
-    add_element entry, 'updated', DateTime.now
+    entry.add_element opts[:author]
+
+    updated = DateTime::now.strftime("%Y-%m-%dT%H:%M:%S%z").sub(/(..)$/, ':\1')
+    
+    add_element entry, 'updated', updated
     add_element entry, 'id', make_id
     
     add_element entry, 'title', (opts[:contact] || opts[:slug] || opts[:title])

data/lib/oos4ruby/contacts.rb

@@ -1,10 +1,6 @@
 
 module Oos4ruby
-class Contacts < Collection
-  def initialize(feed, auth, slug)
-    super(feed, auth, slug)
-    @entries = feed.entries.map {|entry| Contact.new(entry, @auth, @slug) }
-  end
+class Contacts < Collection  
 end
 end
 

data/lib/oos4ruby/feed.rb

@@ -4,7 +4,7 @@ require 'rexml/xpath'
 module Oos4ruby
 class Feed
 
-  attr_reader :previous, :next, :entries, :xml
+  attr_reader :previous, :next, :entries, :xml, :size, :total_size
   
   def initialize(entries, xml)
     @entries = entries
@@ -12,6 +12,8 @@ class Feed
     @next = Feed.get_link('next', xml)
     @previous = Feed.get_link 'previous', xml
     @self = Feed.get_link 'self', xml
+    @size = REXML::XPath.first(xml, "./os:itemsPerPage/text()", XmlNamespaces)
+    @total_size = REXML::XPath.first(xml, "./os:totalResults/text()", XmlNamespaces)
   end
   
   def self.get_link(rel, xml)

data/lib/oos4ruby/http_invoker.rb

@@ -15,7 +15,7 @@ class HTTPInvoker
   end
   
   def set_header(name, val)
-    @headers[name] = val
+    @headers[name.to_s.gsub(/_/, '-')] = val
   end
   
   def get(depth = 0, req = nil)           
@@ -48,7 +48,12 @@ class HTTPInvoker
     @headers.each { |k, v| req[k]= v }
 
     http.start do |connection|
-      @response = connection.request(req, body)
+      if body.instance_of?String
+        @response = connection.request(req, body)
+      else
+        req.body_stream = body
+        @response = connection.request(req)
+      end
 
       return post(contentType, body, depth + 1, req) if need_authentication?(req)
 
@@ -113,12 +118,10 @@ class HTTPInvoker
     unless req
       url = @uri.path
       url += "?#{@uri.query}" if @uri.query
-      req = Net::HTTP::Get.new( url ) if option == :get
-      req = Net::HTTP::Post.new( url ) if option == :post
-      req = Net::HTTP::Put.new( url ) if option == :put
-      req = Net::HTTP::Delete.new( url ) if option == :delete
+      req = eval("Net::HTTP::#{option.to_s.capitalize}").new( url )
     end
     
+    @authent.add_to req
     return http, req
   end
   
@@ -126,6 +129,7 @@ class HTTPInvoker
     if @response.instance_of?(Net::HTTPUnauthorized) && @authent      
       @authent.add_to req      
       req.body = nil unless req.body.nil?
+      req.body_stream = nil unless req.body_stream.nil?
       return true
     end
     return false 

data/lib/oos4ruby/media.rb

@@ -0,0 +1,34 @@
+
+include Bean 
+
+module Oos4ruby
+  class Media < Bean::BeanClass
+    
+    define_el_reader AtomNamespace => [:title, :updated, :content]
+    
+    attr_writer :title
+    
+    def initialize(entry, auth, slug = nil)
+      @xml = entry
+      @auth = auth
+      @slug = slug || @xml.child('slug', OosNamespace).text      
+    end
+    
+    def Media.dump!(opts, slug)
+      if (opts[:file].instance_of?File)
+        file = opts[:file]
+      elsif (opts[:file].instance_of?String)
+        file = File.new( opts[:file ])
+      end      
+      return file
+    end
+    
+    private
+    def load!
+      if @title
+        @xml.child('title').text = @title
+      end
+    end
+    
+  end
+end

data/lib/oos4ruby/medias.rb

@@ -0,0 +1,6 @@
+
+ 
+module Oos4ruby
+class Medias < Collection
+end
+end

data/lib/oos4ruby/search.rb

@@ -5,7 +5,7 @@ module Oos4ruby
 class Search
   
 =begin rdoc
-  Method to search places into 11870
+  Method to search services/places into 11870. Returns a Sites collection
   available parameters:
   <tt>q</tt>:: string that represents a siple query.
   <tt>bbox</tt>:: array of points that delimiters a rectangle, SW and NE.

data/lib/oos4ruby/site.rb

@@ -1,4 +1,5 @@
 
+require 'date'
 include Bean
 
 module Oos4ruby
@@ -21,13 +22,6 @@ class Site < Bean::BeanClass
     
   attr_writer :review_title, :review_content, :user_address, :url, :locality, :telephone
   
-  def country=(name, slug)
-    @country = REXML::Element.new('oos:country')
-    @country.add_namespace('oos', OosNamespace)
-    @country.add_text name 
-    @country.add_attribute 'slug', slug
-  end
-  
   def initialize(xml, auth, slug = nil)
     @xml = xml
     @auth = auth
@@ -40,6 +34,13 @@ class Site < Bean::BeanClass
     @categories_removed = []
   end
   
+  def country=(name, slug)
+    @country = REXML::Element.new('oos:country')
+    @country.add_namespace('oos', OosNamespace)
+    @country.add_text name 
+    @country.add_attribute 'slug', slug
+  end
+  
   def Site.find_by_user( auth, slug, opts = {} )
     raise Oos4ruby::UnknownUser if slug.nil?
     
@@ -57,12 +58,15 @@ class Site < Bean::BeanClass
     
     entry.add_element opts[:author]
     
-    add_element entry, 'updated', DateTime.now
+    updated = DateTime::now.strftime("%Y-%m-%dT%H:%M:%S%z").sub(/(..)$/, ':\1')
+    
+    add_element entry, 'updated', updated
     add_element entry, 'id', make_id
     add_element entry, 'oos:id', opts[:id] if opts[:id]
     add_element entry, 'title', opts[:title] if opts[:title]
     add_element entry, 'oos:useraddress', opts[:user_address] if opts[:user_address]
     add_element entry, 'oos:url', opts[:url] if opts[:url]
+    add_element entry, 'oos:telephone', opts[:telephone] if opts[:telephone]
     add_element entry, 'summary', opts[:review_title] if opts[:review_title]
     add_element entry, 'summary', opts[:summary] if opts[:summary] and REXML::XPath.first(entry, 'summary', XmlNamespaces).nil?
     
@@ -110,8 +114,8 @@ class Site < Bean::BeanClass
       add_element entry, 'oos:country', name, attrs
     end
     
-    opts[:tags].each { |tag| add_category entry, tag.to_s, "#{TAGS_URL}/#{slug}"} if opts[:tags]
-    opts[:lists].each { |list| add_category entry, list.to_s, "#{LISTS_URL}/#{slug}"} if opts[:lists]
+    opts[:tags].each { |tag| add_category entry, tag, "#{TAGS_URL}/#{slug}"} if opts[:tags]
+    opts[:lists].each { |list| add_category entry, list, "#{LISTS_URL}/#{slug}"} if opts[:lists]
     
     entry
   end
@@ -178,6 +182,16 @@ class Site < Bean::BeanClass
     @privacy_updated = privacy
   end
   
+  def multimedia    
+    href = @xml.first('./atom:source/app:collection').attributes['href']
+    
+    getter = HTTPInvoker.new href, @auth
+    worked = getter.get
+    
+    raise RuntimeError unless worked
+    Medias.new(Feed.read(getter.body), @auth, @slug)
+  end
+  
   private
   def load!
     if @title_review

data/lib/oos4ruby/sites.rb

@@ -1,10 +1,6 @@
 
 module Oos4ruby
-class Sites < Collection  
-  def initialize(feed, auth, slug = nil)
-    super( feed, auth, slug )    
-    @entries = feed.entries.map {|entry| Site.new(entry, @auth, slug) }
-  end    
+class Sites < Collection      
 end
 end
 

data/lib/oos4ruby/version.rb

@@ -2,7 +2,7 @@ module Oos4ruby #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/oos4ruby.rb

@@ -41,6 +41,8 @@ require 'oos4ruby/contact.rb'
 require 'oos4ruby/contacts.rb'
 require 'oos4ruby/entry.rb'
 require 'oos4ruby/feed.rb'
+require 'oos4ruby/media.rb'
+require 'oos4ruby/medias.rb'
 require 'oos4ruby/oos.rb'
 require 'oos4ruby/search.rb'
 require 'oos4ruby/service.rb'
@@ -50,7 +52,7 @@ require 'oos4ruby/user.rb'
 require 'oos4ruby/version.rb'
 
 
-class String
+class String #:nodoc:
   def underscore
      self.to_s.gsub(/::/, '/').
      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
@@ -61,7 +63,8 @@ class String
 end
 
 require 'rexml/element'
-class REXML::Element
+module REXML #:nodoc:
+class REXML::Element #:nodoc:
   def add_category(term, scheme = nil, label = nil)
     c = REXML::Element.new('category', self)
     c.add_attribute('term', term)
@@ -70,3 +73,4 @@ class REXML::Element
     c
   end
 end
+end

data/test/test_oos4ruby.rb

@@ -7,7 +7,6 @@ oos = Oos4ruby::Oos.new
 
 oos.auth_user('david.calavera@11870.com', 'asdf')
 
-user = oos.user
 puts user.name
 puts user.surname
 puts user.no_mails
@@ -73,6 +72,17 @@ site.update!
 
 site.tags.each { |tag| puts "TAG : #{tag.term}, #{tag.scheme} "}
 
+file_path = '/home/david/media_api_test.png'
+
+medias = site.multimedia
+
+media = medias.create!(:file => file_path,
+   :content_length => File.size(file_path), :content_type => 'image/png' )
+
+puts media.to_s
+site.multimedia.refresh!
+
+puts site.multimedia.entries.to_s
 
 class TestOos4ruby < Test::Unit::TestCase
 
@@ -82,4 +92,7 @@ class TestOos4ruby < Test::Unit::TestCase
   def test_truth
     assert true
   end
+  
+
 end
+

data/website/index.html

@@ -33,7 +33,7 @@
     <h1>oos4ruby</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/oos4ruby"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/oos4ruby" class="numbers">0.1.1</a>
+      <a href="http://rubyforge.org/projects/oos4ruby" class="numbers">0.1.2</a>
     </div>
     <h1>&#x2192; &#8216;oos4ruby&#8217;</h1>
 
@@ -77,23 +77,53 @@
 	<p><pre class='syntax'><span class="ident">oos</span><span class="punct">.</span><span class="ident">search</span> <span class="symbol">:q</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">cheap restaurants in new york</span><span class="punct">'</span></pre></p>
 
 
-	<p>Method to obtain the services or places saved by a user:</p>
+	<p>How to obtain the services or places saved by a user:</p>
 
 
 	<p><pre class='syntax'>
-<span class="ident">user</span> <span class="punct">=</span> <span class="ident">oos</span><span class="punct">.</span><span class="ident">user</span> <span class="comment">#if your app is authenticated with this user authorization token</span>
-<span class="ident">user</span> <span class="punct">=</span> <span class="ident">oos</span><span class="punct">.</span><span class="ident">user</span> <span class="punct">'</span><span class="string">user slug in 11870</span><span class="punct">'</span> <span class="comment">#if your app is authenticated to expore contents</span>
+<span class="comment">#if your app is authenticated with this user authorization token</span>
+<span class="ident">user</span> <span class="punct">=</span> <span class="ident">oos</span><span class="punct">.</span><span class="ident">user</span>
+<span class="comment">#if your app is authenticated to expore contents</span>
+<span class="ident">user</span> <span class="punct">=</span> <span class="ident">oos</span><span class="punct">.</span><span class="ident">user</span> <span class="punct">'</span><span class="string">user slug in 11870</span><span class="punct">'</span>
 
 <span class="ident">sites</span> <span class="punct">=</span> <span class="ident">user</span><span class="punct">.</span><span class="ident">sites</span><span class="punct">.</span><span class="ident">entries</span>
 </pre></p>
 
 
-	<p>Method to obtain all user contacts in 11870:</p>
+	<p>How to add a review from a site that doesn&#8217;t exist in 11870:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">oos</span><span class="punct">.</span><span class="ident">user</span><span class="punct">.</span><span class="ident">sites</span><span class="punct">.</span><span class="ident">create!</span> <span class="punct">{</span><span class="symbol">:title</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">this site doesn</span><span class="punct">'</span><span class="ident">t</span> <span class="ident">exist</span><span class="punct">'</span><span class="string">, 
+    :user_address =&gt; </span><span class="punct">'</span><span class="ident">the</span> <span class="ident">address</span><span class="punct">'</span><span class="string">, 
+    :locality =&gt; {:name =&gt; </span><span class="punct">'</span><span class="constant">Madrid</span><span class="punct">'</span><span class="string">, :slug =&gt; </span><span class="punct">'/</span><span class="ident">es</span><span class="punct">/</span><span class="ident">madrid</span><span class="punct">'</span><span class="string">},
+    :country =&gt; {:name =&gt; </span><span class="punct">'</span><span class="constant">Españ</span><span class="ident">a</span><span class="punct">'</span><span class="string">, :slug =&gt; </span><span class="punct">'/</span><span class="ident">es</span><span class="punct">'</span><span class="string">} 
+    :summary =&gt; </span><span class="punct">'</span><span class="ident">review</span> <span class="ident">title</span><span class="punct">'</span><span class="string">, :content =&gt; </span><span class="punct">'</span><span class="ident">review</span> <span class="ident">content</span><span class="punct">'</span><span class="string">
+    :tags =&gt; [</span><span class="punct">'</span><span class="ident">tapas</span><span class="punct">'</span><span class="string">, </span><span class="punct">'</span><span class="ident">tipical</span> <span class="ident">spanish</span><span class="punct">'</span><span class="string">], :lists =&gt; [</span><span class="punct">'</span><span class="ident">food</span><span class="punct">'</span><span class="string">]}<span class="normal">
+</span></span></pre></p>
+
+
+	<p>How to add a review from a site that exists in 11870:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">oos</span><span class="punct">.</span><span class="ident">user</span><span class="punct">.</span><span class="ident">sites</span><span class="punct">.</span><span class="ident">create!</span> <span class="punct">{</span><span class="symbol">:id</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">11870 site id</span><span class="punct">',</span>
+    <span class="symbol">:summary</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">review title</span><span class="punct">',</span> <span class="symbol">:content</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">review content</span><span class="punct">'}</span>
+</pre></p>
+
+
+	<p>How to obtain all user contacts in 11870:</p>
 
 
 	<p><pre class='syntax'><span class="ident">contacts</span> <span class="punct">=</span> <span class="ident">user</span><span class="punct">.</span><span class="ident">contacts</span><span class="punct">.</span><span class="ident">entries</span></pre></p>
 
 
+	<p>How to obtain the multimedia feed associated with a review:</p>
+
+
+	<p><pre class='syntax'><span class="ident">media_collection</span> <span class="punct">=</span> <span class="ident">user</span><span class="punct">.</span><span class="ident">sites</span><span class="punct">.</span><span class="ident">entries</span><span class="punct">[</span><span class="number">0</span><span class="punct">].</span><span class="ident">multimedia</span></pre></p>
+
+
 	<h2>Forum</h2>
 
 
@@ -120,7 +150,7 @@
 
 	<p>Comments are welcome. Send an email to <a href="mailto:david.calavera@gmail.com">David Calavera</a> email via the <a href="http://groups.google.com/group/api-11870">forum</a></p>
     <p class="coda">
-      <a href="FIXME email">David Calavera</a>, 28th September 2007<br>
+      <a href="FIXME email">David Calavera</a>, 16th October 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -29,19 +29,43 @@ Method to perform a search inside 11870:
 
 <pre syntax="ruby">oos.search :q => 'cheap restaurants in new york'</pre>
 
-Method to obtain the services or places saved by a user:
+How to obtain the services or places saved by a user:
 
 <pre syntax="ruby">
-user = oos.user #if your app is authenticated with this user authorization token
-user = oos.user 'user slug in 11870' #if your app is authenticated to expore contents
+#if your app is authenticated with this user authorization token
+user = oos.user
+#if your app is authenticated to expore contents
+user = oos.user 'user slug in 11870'
 
 sites = user.sites.entries
 </pre>
 
-Method to obtain all user contacts in 11870:
+How to add a review from a site that doesn't exist in 11870:
+
+<pre syntax="ruby">
+oos.user.sites.create! {:title => 'this site doesn't exist', 
+    :user_address => 'the address', 
+    :locality => {:name => 'Madrid', :slug => '/es/madrid'},
+    :country => {:name => 'España', :slug => '/es'} 
+    :summary => 'review title', :content => 'review content'
+    :tags => ['tapas', 'tipical spanish'], :lists => ['food']}
+</pre>
+
+How to add a review from a site that exists in 11870:
+
+<pre syntax="ruby">
+oos.user.sites.create! {:id => '11870 site id',
+    :summary => 'review title', :content => 'review content'}
+</pre>
+
+How to obtain all user contacts in 11870:
 
 <pre syntax="ruby">contacts = user.contacts.entries</pre>
 
+How to obtain the multimedia feed associated with a review:
+
+<pre syntax="ruby">media_collection = user.sites.entries[0].multimedia</pre>
+
 h2. Forum
 
 "http://groups.google.com/group/api-11870":http://groups.google.com/group/api-11870

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: oos4ruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2007-09-28 00:00:00 +02:00
+  version: 0.1.2
+date: 2007-10-16 00:00:00 +02:00
 summary: oos4ruby is a ruby binding for the 11870 API
 require_paths: 
 - lib
@@ -46,6 +46,8 @@ files:
 - lib/oos4ruby/entry.rb
 - lib/oos4ruby/feed.rb
 - lib/oos4ruby/http_invoker.rb
+- lib/oos4ruby/media.rb
+- lib/oos4ruby/medias.rb
 - lib/oos4ruby/oos.rb
 - lib/oos4ruby/search.rb
 - lib/oos4ruby/service.rb