oos4ruby 0.1.2 → 0.1.3

data/History.txt

@@ -15,3 +15,10 @@
 * some bugs fixed
 * README.txt completed
 * more rdoc
+
+== 0.1.3 2007-11-02
+
+* 1 major enhancement:
+  * collection goes to array (deprecated sintax "entries")
+* contacts bugs fixed
+* collections total size bug fixed

data/README.txt

@@ -29,7 +29,7 @@ How to obtain the services or places saved by a user:
     #if your app is authenticated to expore contents
     user = oos.user 'user slug in 11870'
 
-    sites = user.sites.entries
+    sites = user.sites
 
 How to add a review from a site that doesn't exist in 11870:
 
@@ -47,8 +47,8 @@ How to add a review from a site that exists in 11870:
 
 How to obtain all user contacts in 11870:
 
-    contacts = user.contacts.entries
+    contacts = user.contacts
 
 How to obtain the multimedia feed associated with a review:
 
-    media_collection = user.sites.entries[0].multimedia
+    media_collection = user.sites[0].multimedia

data/lib/oos4ruby.rb

@@ -7,13 +7,15 @@ module Oos4ruby
   XhtmlNamespace = 'http://www.w3.org/1999/xhtml'
   GeoRSSNamespace = 'http://www.georss.org/georss/10'
   GmlNamespace = 'http://www.opengis.net/gml'
+  OsNamespace = 'http://a9.com/-/spec/opensearch/1.1/'
   XmlNamespaces = {
     'app' => AppNamespace,
     'atom' =>  AtomNamespace,    
     'xhtml' => XhtmlNamespace,
     'oos' => OosNamespace,
     'georss' => GeoRSSNamespace,
-    'gml' => GmlNamespace
+    'gml' => GmlNamespace,
+    'os' => OsNamespace
   }
   
   AtomEntryContentType = 'application/atom+xml;type=entry'
@@ -30,7 +32,7 @@ module Oos4ruby
   TRUSTED_URL = API_URL + '/trusted'
   SEARCH_URL = API_URL + '/search'
 end
-%w(rubygems builder).each { |f| require f }
+%w(rubygems).each { |f| require f }
 
 require 'oos4ruby/http_invoker.rb'
 require 'oos4ruby/auth.rb'

data/lib/oos4ruby/collection.rb

@@ -5,16 +5,14 @@ module Oos4ruby
   
   API feed response is paginated, so, this class provides some methods to explore the feed.
 =end
-class Collection  
-  
-  attr_reader :entries
+class Collection < Array
   
   def initialize(feed, auth, slug = nil)
     @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) }
+    feed.entries.each {|entry| self << evalued_class.new(entry, @auth, @slug) }    
   end
  
 =begin rdoc
@@ -58,30 +56,23 @@ class Collection
   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
+    return @feed.total_size
   end
   
 =begin rdoc
   return all entries into the feed.
 =end
   def all
-    all = @entries
+    all = self.to_a
     aux = self
     while aux.next_page?
       next_page = aux.next_page
-      next_page.entries.each {|entry| all << entry}
+      next_page.each {|entry| all << entry}
       aux = next_page
     end
     return all
@@ -157,7 +148,7 @@ class Collection
     worked = getter.get
     if worked
       @feed = Feed.read(getter.body)
-      @entries = convert(getter.body).entries
+      convert(getter.body)
       return self
     end
   end

data/lib/oos4ruby/contact.rb

@@ -16,6 +16,9 @@ class Contact < BeanClass
     @slug = slug
   end
   
+=begin rdoc
+  find all user contacts
+=end
   def Contact.find_by_user( auth, slug, opts = {} )
     raise Oos4ruby::UnknownUser if slug.nil?
     
@@ -28,6 +31,9 @@ class Contact < BeanClass
     Contacts.new(Feed.read(getter.body), auth, slug) if worked
   end
   
+=begin rdoc
+  returns the user associated with this contact
+=end
   def data         
     @data = User.find @auth, @xml.link('userInfo') unless @data
     @data

data/lib/oos4ruby/user.rb

@@ -14,6 +14,8 @@ class User < Bean::BeanClass
   alias :nick :title
   alias :about_me :content
   
+  attr_reader :slug
+  
   attr_writer :nick, :about_me, :name, :surname, :no_mails, :only_contacts, :no_newsletter
   
   def initialize(entry, auth, slug = nil)
@@ -25,15 +27,15 @@ class User < Bean::BeanClass
   def User.find( auth, slug = nil )
     raise Oos4ruby::UnknownUser if auth.method?(:app) && slug.nil?
     
-    begin
-      uri = URI.parse(slug)
-    rescue
-      uri = nil
-    end
-    
-    unless uri
-      uri = USERS_URL
-      uri = uri + "/#{slug}" if slug
+    uri = USERS_URL
+    if slug
+      if slug.is_a?URI
+        uri = slug      
+      elsif slug.is_a?String and slug =~ /^http/
+        uri = URI.parse(slug)
+      else
+        uri += "/#{slug}" 
+      end
     end
     
     getter = HTTPInvoker.new uri.to_s, auth
@@ -111,9 +113,9 @@ class User < Bean::BeanClass
       
       @xml.child('name', OosNamespace).text = @name if @name
       @xml.child('surname', OosNamespace).text = @surname if @surname
-      @xml.child('nomails', OosNamespace).text = @no_mails.to_s if !@no_mails.nil?
-      @xml.child('nonewsletter', OosNamespace).text = @no_newsletter.to_s if !@no_newsletter.nil?
-      @xml.child('onlycontacts', OosNamespace).text = @only_contacts.to_s if !@only_contacts.nil?
+      @xml.child('nomails', OosNamespace).text = @no_mails.to_s unless @no_mails.nil?
+      @xml.child('nonewsletter', OosNamespace).text = @no_newsletter.to_s unless @no_newsletter.nil?
+      @xml.child('onlycontacts', OosNamespace).text = @only_contacts.to_s unless @only_contacts.nil?
   end
 end
 end

data/lib/oos4ruby/version.rb

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

data/tasks/deployment.rake

@@ -25,3 +25,9 @@ desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
 task :install_gem_no_doc => [:clean, :package] do
   sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
 end
+
+desc 'Tag the latest release'
+task :tag_version do
+    sh "svn copy https://api-11870.googlecode.com/svn/trunk/oos4ruby " +
+      "https://api-11870.googlecode.com/svn/tags/oos4ruby/REL-#{VERS} --username david.calavera"
+end

data/test/test_oos4ruby.rb

@@ -3,10 +3,7 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 require 'rubygems'
 require File.dirname(__FILE__) + '/../lib/oos4ruby.rb'
 
-oos = Oos4ruby::Oos.new
-
-oos.auth_user('david.calavera@11870.com', 'asdf')
-
+=begin
 puts user.name
 puts user.surname
 puts user.no_mails
@@ -48,7 +45,7 @@ sites = user.sites.entries
 new_site = user.sites.create! :title => 'asdfasdf', :user_address => 'asdfasdf', 
   :country => {:name => 'España', :slug => '/es'}, :locality => {:name => 'Madrid', :slug => '/es/madrid'},
   :summary => 'nueva opinion desde la API', :review_content => 'asdfasdf',
-  :tags => [:asdfd, :dfgfg], :lists => [:comida]
+  :tags => ['tapas', 'tipical spanish'], :lists => ['food']
   
 puts new_site.to_xml || 'NOOOOOO'
 
@@ -83,16 +80,59 @@ puts media.to_s
 site.multimedia.refresh!
 
 puts site.multimedia.entries.to_s
+=end
 
 class TestOos4ruby < Test::Unit::TestCase
 
   def setup
+    @oos = Oos4ruby::Oos.new
+    @oos.auth_user('david.calavera@11870.com', 'deadbeeff00')
+  end
+  
+  def assert_user_not_nil(user)
+    assert_not_nil user, ''
   end
   
-  def test_truth
-    assert true
+  def test_user_without_slug
+    user = @oos.user
+    assert_user_not_nil(user) 
   end
   
+  def test_user_with_slug
+    user = @oos.user('mamuso')
+    assert_user_not_nil(user)   
+  end
+  
+  def test_user_with_uri
+    user = @oos.user('http://11870.com/api/v1/users/peralta')
+    assert_user_not_nil(user)
+  end
+  
+  def test_contacts
+    user = @oos.user
+    assert_not_nil user.contacts, ''
+    assert (not user.contacts.empty?), ''
+    
+    contact = user.contacts[0]
+    assert_not_nil contact, ''
+    assert_not_nil contact.data, ''
+    assert_not_nil contact.data.nick, ''
+    assert_not_nil contact.data.slug, ''
+  end
+  
+  def test_sites
+    user = @oos.user
+    assert_not_nil user.sites, ''
+    assert_not_nil user.sites.size, ''
+    assert_not_nil user.sites.total_size, ''
+    assert_not_nil user.sites[0], ''
+  end
+  
+  def test_all_sites
+    user = @oos.user
+    assert_not_nil user.sites.all, ''
+    assert (user.sites.total_size == user.sites.all.size)
+  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.2</a>
+      <a href="http://rubyforge.org/projects/oos4ruby" class="numbers">0.1.3</a>
     </div>
     <h1>&#x2192; &#8216;oos4ruby&#8217;</h1>
 
@@ -86,7 +86,7 @@
 <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>
+<span class="ident">sites</span> <span class="punct">=</span> <span class="ident">user</span><span class="punct">.</span><span class="ident">sites</span>
 </pre></p>
 
 
@@ -115,13 +115,13 @@
 	<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><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></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>
+	<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="number">0</span><span class="punct">].</span><span class="ident">multimedia</span></pre></p>
 
 
 	<h2>Forum</h2>
@@ -150,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>, 16th October 2007<br>
+      <a href="FIXME email">David Calavera</a>, 2nd November 2007<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -37,7 +37,7 @@ user = oos.user
 #if your app is authenticated to expore contents
 user = oos.user 'user slug in 11870'
 
-sites = user.sites.entries
+sites = user.sites
 </pre>
 
 How to add a review from a site that doesn't exist in 11870:
@@ -60,11 +60,11 @@ oos.user.sites.create! {:id => '11870 site id',
 
 How to obtain all user contacts in 11870:
 
-<pre syntax="ruby">contacts = user.contacts.entries</pre>
+<pre syntax="ruby">contacts = user.contacts</pre>
 
 How to obtain the multimedia feed associated with a review:
 
-<pre syntax="ruby">media_collection = user.sites.entries[0].multimedia</pre>
+<pre syntax="ruby">media_collection = user.sites[0].multimedia</pre>
 
 h2. Forum
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: oos4ruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2007-10-16 00:00:00 +02:00
+  version: 0.1.3
+date: 2007-11-02 00:00:00 +01:00
 summary: oos4ruby is a ruby binding for the 11870 API
 require_paths: 
 - lib