oos4ruby 0.1.7 → 0.2.0

data/lib/oos4ruby.rb

@@ -1,3 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
 module Oos4ruby
   class UnknownUser < ArgumentError; end
   
@@ -32,7 +35,6 @@ module Oos4ruby
   TRUSTED_URL = API_URL + '/trusted'
   SEARCH_URL = API_URL + '/search'
 end
-%w(rubygems).each { |f| require f }
 
 require 'oos4ruby/http_invoker.rb'
 require 'oos4ruby/auth.rb'

data/lib/oos4ruby/bean.rb

@@ -26,7 +26,7 @@ module Bean #:nodoc:
     end
     
     def set_variable(options = {})
-      if options.empty?
+      unless options.empty?
         options.each_pair { |key, value|
           class_variable_set("@@#{key.to_s}".to_sym, value) 
         }
@@ -197,4 +197,3 @@ module Bean #:nodoc:
   end
 end
 end
-

data/lib/oos4ruby/collection.rb

@@ -11,7 +11,7 @@ class Collection < Array
     @feed = feed
     @auth = auth
     @slug = slug
-    evalued_class = eval(self.class.name.gsub(/s$/, ''))
+    evalued_class = Oos4ruby.const_get(self.class.name.gsub(/s$/, ''))
     @feed.entries.each {|entry| self << evalued_class.new(entry, @auth, @slug) }    
   end
  
@@ -111,7 +111,7 @@ class Collection < Array
         :content_type => file content type
 =end
   def create!(opts = {})    
-    evalued_class = eval(self.class.name.gsub(/s$/, ''))
+    evalued_class = Oos4ruby.const_get(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      
@@ -119,14 +119,13 @@ class Collection < Array
     
     poster = HTTPInvoker.new( @feed.self_link, @auth)
     
-    content_type = opts[:content_type] || AtomEntryContentType
-    opts.reject {|k, v| k == :content_type}
+    content_type = opts.delete(:content_type) || AtomEntryContentType
     opts.each {|k, v| poster.set_header(k, v)}
     
     worked = poster.post content_type, body
         
-    raise RuntimeError.new unless worked
-    return evalued_class.new(poster.entry, @auth, @slug)
+    raise poster.response.message unless worked
+    return get_page(@feed.self_link, @auth).first
   end
 =begin rdoc
   return true if the text of the element is equals to the given value
@@ -163,8 +162,7 @@ class Collection < Array
   end
   
   def convert( body )
-    evalued_class = eval(self.class.name)
-    return evalued_class.new( Feed.read( body ), @auth, @slug )    
+    return self.class.new( Feed.read( body ), @auth, @slug )    
   end
   
 end

data/lib/oos4ruby/http_invoker.rb

@@ -118,7 +118,7 @@ class HTTPInvoker
     unless req
       url = @uri.path
       url += "?#{@uri.query}" if @uri.query
-      req = eval("Net::HTTP::#{option.to_s.capitalize}").new( url )
+      req = Net::HTTP.const_get(option.to_s.capitalize).new( url )
     end
     
     @authent.add_to req
@@ -141,4 +141,4 @@ class HTTPInvoker
   end
   
 end
-end
+end

data/lib/oos4ruby/media.rb

@@ -14,12 +14,8 @@ module Oos4ruby
     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
+      file = opts.delete(:file)
+      file.respond_to?(:path) ? file : File.new(file)
     end
     
     private

data/lib/oos4ruby/search.rb

@@ -1,4 +1,3 @@
-
 require 'cgi'
 
 module Oos4ruby
@@ -20,55 +19,29 @@ class Search
   def Search.find(auth, opts)
     query = SEARCH_URL
     
-    more_params = false
-    unless opts.empty?
-      query += "?"
-      if opts[:q]
-        query += "q=#{CGI.escape(opts[:q])}"
-        more_params = true
-      end
-      if opts[:bbox]
-        query += "&" if more_params
-        query += "bbox=#{opts[:bbox].join(",")}"
-        more_params = true
-      end
-      if opts[:as]
-        query += "&" if more_params
-        query += "as=#{opts[:as]}"
-        more_params = true
-      end
-      if opts[:tags]
-        query += "&" if more_params
-        opts[:tags].each_with_index do |tag, index|
-          query += "tag=#{CGI.escape(tag)}"          
-          query += "&" if index < opts[:tags].length - 1
-        end
-        more_params = true
-      end
-      if opts[:tag_op]
-        query += "&" if more_params
-        query += "tagOp=#{opts[:tag_op]}"
-        more_params = true
-      end
-      if opts[:lat] and opts[:lon] and opts[:radius]
-        query += "&" if more_params
-        query += "lat=#{opts[:lat]}&lon=#{opts[:lon]}&radius=#{opts[:radius]}"
-        more_params = true
-      end
-      if opts[:page]
-        query += "&" if more_params
-        query += "page=#{opts[:page]}"
-      end
-    else
-      raise RuntimeError('a parameter is obligatory at least')
-    end
-    
-    getter = HTTPInvoker.new query, auth
+    getter = HTTPInvoker.new parse_params(opts), auth
     
     worked = getter.get
     raise RuntimeError.new(getter.response.message) unless worked
     Sites.new(Feed.read(getter.body), auth, nil)
   end
+  
+  def Search.parse_params(args)
+    raise "at least a parameter is mandatory" if args.nil? || args.empty?
+
+    args[:q] = CGI.escape(args[:q]) if args.include?(:q)
+    args[:bbox] = args[:bbox].join(",") if args.include?(:bbox)
+    args[:tag] = args.delete(:tags).map {|tag| CGI.escape(tag)} if args.include?(:tags)
+    args[:tagOp] = args.delete(:tag_op) if args.include?(:tag_op)     
+
+    args.map do |k, v|
+      if v.respond_to?(:each_with_index)
+        v.map {|m| "#{k}=#{m}"}
+      else
+        "#{k}=#{v}"
+      end
+    end.flatten.join("&")
+  end
 end
 end
 

data/lib/oos4ruby/site.rb

@@ -61,60 +61,57 @@ class Site < Bean::BeanClass
     
     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?
-    
-    if opts[:privacy]
-      if opts[:privacy].is_a?REXML::Element
-        entry.add_element opts[:privacy]
-      elsif opts[:privacy].is_a?String         
-        add_category entry, opts[:privacy], PRIVACY_URL
+
+    {:id => 'oos:id', :title => 'title', :user_address => 'oos:useraddress',
+        :url => 'oos:url', :telephone => 'oos:telephone', :review_title => 'summary'}.each do |k, v|
+      add_element entry, v, opts.delete(k) if opts.include?(k)
+    end
+
+    add_element entry, 'summary', opts.delete(:summary) if opts.include?(:summary) and REXML::XPath.first(entry, 'summary', XmlNamespaces).nil?
+    
+    if opts.include?(:privacy)
+      privacy = opts.delete(:privacy)
+      if privacy.is_a?REXML::Element
+        entry.add_element privacy
+      elsif privacy.is_a?String         
+        add_category entry, privacy, PRIVACY_URL
       end
     end
       
-    if opts[:review_content] || opts[:content]
-      content = opts[:review_content] || opts[:content]
+    if opts.include?(:review_content) || opts.include?(:content)
+      content = opts.delete(:review_content) || opts.delete(:content)
       attrs = {}
-      text = nil
-      if content.is_a?String
-        text = content
-      elsif content.is_a?Hash
-        text = content[:text]
-        content.delete :text
+      text = content
+      if content.respond_to?(:each_pair)
+        text = content.delete(:text)
         content.each_pair {|key, value| attrs[key.to_s] = value}        
       end
       add_element entry, 'content', text, attrs
     end
     
-    if opts[:locality]
-      name = nil
+    if opts.include?(:locality)
+      locality = opts.delete(:locality)
+      name = locality
       local_slug = nil
       attrs = {}
-      if opts[:locality].is_a?Hash
-        name = opts[:locality][:name]
-        local_slug = opts[:locality][:slug]
-      elsif opts[:locality].is_a?String
-        name = opts[:locality]
+      if locality.respond_to?(:each_pair)
+        name = locality[:name]
+        local_slug = locality[:slug]
       end
       attrs['slug'] = local_slug if local_slug
       add_element entry, 'oos:locality', name, attrs
     end
     
-    if opts[:country]
-      name = opts[:country][:name]
-      opts[:country].delete :name
+    if opts.include?(:country)
+      country = opts.delete(:country)
+      name = country.delete(:name)
       attrs = {}
-      opts[:country].each_pair {|key, value| attrs[key.to_s] = value}
+      country.each_pair {|key, value| attrs[key.to_s] = value}
       add_element entry, 'oos:country', name, attrs
     end
     
-    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]
+    opts.delete(:tags).each { |tag| add_category entry, tag, "#{TAGS_URL}/#{slug}"} if opts.include(:tags)
+    opts.delete(:lists).each { |list| add_category entry, list, "#{LISTS_URL}/#{slug}"} if opts.include?(:lists)
     
     entry
   end
@@ -172,9 +169,7 @@ class Site < Bean::BeanClass
   end
   
   def privacy
-    return @privacy if @privacy
-    @privacy = @xml.category({:scheme => PRIVACY_URL}).attributes['term']
-    @privacy
+    @privacy ||= @xml.category({:scheme => PRIVACY_URL}).attributes['term']
   end
   
   def privacy=(privacy)    
@@ -187,7 +182,7 @@ class Site < Bean::BeanClass
     getter = HTTPInvoker.new href, @auth
     worked = getter.get
     
-    raise RuntimeError unless worked
+    raise getter.response.message unless worked
     Medias.new(Feed.read(getter.body), @auth, @slug)
   end
   

data/lib/oos4ruby/version.rb

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

data/test/test_search.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TestSearch < Test::Unit::TestCase
+
+  VALID_PARAMS = {
+    :q => 'gloria',
+    :tags => ['madrid', 'barcelona'],
+    :as => '/es',
+    :bbox => ['23452345', '345325', '23434', '32453245'],
+    :tag_op => 'and',
+    :lon => '2345',
+    :lat => '234234',
+    :radius => '3'    
+  }
+
+  def test_parse_params_without_arguments
+    assert_raise(RuntimeError) { Oos4ruby::Search.parse_params(nil) }
+    assert_raise(RuntimeError) { Oos4ruby::Search.parse_params({}) }
+  end
+
+  def test_parse_params_with_arguments
+    query = Oos4ruby::Search.parse_params(VALID_PARAMS)
+
+    assert query.include?("q=gloria")
+    assert query.include?("tag=madrid")
+    assert query.include?("tag=barcelona")
+    assert query.include?("as=/es")
+    assert query.include?("bbox=23452345,345325,23434,32453245")
+    assert query.include?("tagOp=and")
+    assert query.include?("lon=2345")
+    assert query.include?("lat=234234")
+    assert query.include?("radius=3")
+  end
+end

data/website/index.html

@@ -60,13 +60,13 @@
 </pre></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>
+<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">&quot;</span><span class="string">this site doesn't exist</span><span class="punct">&quot;,</span> 
+    <span class="symbol">:user_address</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">the address</span><span class="punct">',</span> 
+    <span class="symbol">:locality</span> <span class="punct">=&gt;</span> <span class="punct">{</span><span class="symbol">:name</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">Madrid</span><span class="punct">',</span> <span class="symbol">:slug</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">/es/madrid</span><span class="punct">'},</span>
+    <span class="symbol">:country</span> <span class="punct">=&gt;</span> <span class="punct">{</span><span class="symbol">:name</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">España</span><span class="punct">',</span> <span class="symbol">:slug</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">/es</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>
+    <span class="symbol">:tags</span> <span class="punct">=&gt;</span> <span class="punct">['</span><span class="string">tapas</span><span class="punct">',</span> <span class="punct">'</span><span class="string">tipical spanish</span><span class="punct">'],</span> <span class="symbol">:lists</span> <span class="punct">=&gt;</span> <span class="punct">['</span><span class="string">food</span><span class="punct">']}</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>
@@ -76,6 +76,13 @@
 <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="number">0</span><span class="punct">].</span><span class="ident">multimedia</span></pre></p>
+<p>How to add a new image or video to a review:</p>
+<p><pre class='syntax'><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><span class="punct">.</span><span class="ident">create!</span> <span class="punct">{</span>
+  <span class="symbol">:file</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">image.png</span><span class="punct">',</span>
+  <span class="symbol">:content_length</span> <span class="punct">=&gt;</span> <span class="constant">File</span><span class="punct">.</span><span class="ident">size</span><span class="punct">('</span><span class="string">image.png</span><span class="punct">'),</span>
+  <span class="symbol">:content_type</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">image/png</span><span class="punct">'</span>
+<span class="punct">}</span>
+</pre></p>
 <h2>Forum</h2>
 <p><a href="http://groups.google.com/group/api-11870">http://groups.google.com/group/api-11870</a></p>
 <h2>How to submit patches</h2>
@@ -86,7 +93,7 @@
 <h2>Contact</h2>
 <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 March 2009<br>
+      <a href="FIXME email">David Calavera</a>, 19th November 2009<br>
       Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
     </p>
 </div>

data/website/index.txt

@@ -43,7 +43,7 @@ sites = user.sites
 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', 
+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'} 
@@ -66,6 +66,15 @@ How to obtain the multimedia feed associated with a review:
 
 <pre syntax="ruby">media_collection = user.sites[0].multimedia</pre>
 
+How to add a new image or video to a review:
+
+<pre syntax="ruby">user.sites[0].multimedia.create! {
+  :file => 'image.png',
+  :content_length => File.size('image.png'),
+  :content_type => 'image/png'
+}
+</pre>
+
 h2. Forum
 
 "http://groups.google.com/group/api-11870":http://groups.google.com/group/api-11870

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: oos4ruby
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors: 
 - David Calavera
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-16 00:00:00 +01:00
+date: 2009-11-19 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.0
+        version: 2.3.3
     version: 
 description: oos4ruby is a ruby binding for the 11870 API
 email: david.calavera@gmail.com
@@ -88,6 +88,8 @@ files:
 - website/template.rhtml
 has_rdoc: true
 homepage: http://oos4r.rubyforge.org
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -109,10 +111,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: oos4r
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: oos4ruby is a ruby binding for the 11870 API
 test_files: 
 - test/test_helper.rb
+- test/test_search.rb
 - test/test_oos4ruby.rb