almodovar 0.0.1 → 0.1.0

data/README.rdoc

@@ -1,6 +1,6 @@
 =Almodovar
 
-Almodovar is a client for BeBanjo Movida API written in Ruby
+Almodovar is a client for BeBanjo's Movida API written in Ruby
   
 ==Getting started
 
@@ -38,20 +38,42 @@ Ok. Let's see what we have under _platforms_
   <link href="http://movida.example.com/api/platforms/6/schedule" rel="schedule"/>
   </platform>]
   
-Now, show me the _schedule_ of the first _platform_:
-  
-  >> movida.platforms.first.schedule
+Now, show me the _schedule_ of a _title_ given its external id:
+
+  >> movida.titles(:external_id => "C5134350003").first.schedule(:expand => :schedulings)
   => <schedule>
-  <link href="http://movida.example.com/api/platforms/1/schedule/schedulings" rel="schedulings"/>
-  <link href="http://movida.example.com/api/platforms/1" rel="platform"/>
+  <link href="http://staging.schedule.bebanjo.net/api/titles/498/schedule/schedulings" rel="schedulings"><schedulings type="array">
+  <scheduling>
+  <id type="integer">1122</id>
+  <put-up type="datetime">2010-04-17T00:00:00Z</put-up>
+  <take-down type="datetime">2010-06-17T00:00:00Z</take-down>
+  <scheduling-type>archive</scheduling-type>
+  <link href="http://staging.schedule.bebanjo.net/api/title_groups/129" rel="title_group"/>
+  <link href="http://staging.schedule.bebanjo.net/api/titles/498" rel="title"/>
+  </scheduling>
+  </schedulings>
+  </link>
+  <link href="http://staging.schedule.bebanjo.net/api/titles/498" rel="title"/>
   </schedule>
   
-Next, explore and see the {docs of the API}[http://wiki.github.com/bebanjo/almodovar/] to know about other resources.
+Of course, once you've got the URL of a resource, the next time you don't need to navigate from the root of the API. You can (should!) start from the resource URL:
+
+  >> schedulings = Almodovar::Resource("http://staging.schedule.bebanjo.net/api/titles/498/schedule/schedulings", auth)
+  => [<scheduling>
+  <id type="integer">1122</id>
+  <put-up type="datetime">2010-04-17T00:00:00Z</put-up>
+  <take-down type="datetime">2010-06-17T00:00:00Z</take-down>
+  <scheduling-type>archive</scheduling-type>
+  <link href="http://staging.schedule.bebanjo.net/api/title_groups/129" rel="title_group"/>
+  <link href="http://staging.schedule.bebanjo.net/api/titles/498" rel="title"/>
+  </scheduling>]
+  
+  
+Next, explore the {API docs}[http://wiki.github.com/bebanjo/almodovar/] to learn about other resources.
   
 ==To-do
 
-* Ability to use parameters in linked resource calls (e.g. <tt>movida.titles(:external_id => "C51234500001")</tt>)
-* Memoize linked resource calls so that the same request isn't make several times
-* Ability to take advantage of the API _expand_ functionality (e.g. <tt>movida.titles(:expand => [:schedule, :schedulings]).schedule.schedulings</tt>)
+* Memoize linked resource calls so that the same request isn't made several times
+* See what is preventing latest version of Resourceful from working and fix it (Now we're using a vendorized, patched version based on resourceful 0.5.3)
 
-Copyright (c) 2008 BeBanjo S.L., released under the MIT license
+Copyright (c) 2010 BeBanjo S.L., released under the MIT license

data/lib/almodovar.rb

@@ -1,4 +1,4 @@
-require 'resourceful'
+require File.dirname(__FILE__) + '/../vendor/resourceful-0.5.3-patched/lib/resourceful'
 require 'nokogiri'
 
 module Almodovar
@@ -18,19 +18,22 @@ module Almodovar
     
     private
     
+    undef id
+    
     def method_missing(meth, *args, &blk)
-      attribute = @xml.at_xpath("./*[name()='#{meth}']")
+      attribute = @xml.at_xpath("./*[name()='#{meth}' or name()='#{attribute_name(meth)}']")
       return node_text(attribute) if attribute
       
-      link = @xml.at_xpath("./link[@rel='#{meth}']")
-      return get_linked_resource(link) if link
+      link = @xml.at_xpath("./link[@rel='#{meth}' or @rel='#{attribute_name(meth)}']")
+      return get_linked_resource(link, args.first) if link
       
       super
     end
     
-    def get_linked_resource(link)
+    def get_linked_resource(link, options = {})
+      options ||= {}
       expansion = link.at_xpath("./*")
-      expansion ? Almodovar.instantiate(expansion, @auth) : Almodovar::Resource(link['href'], @auth)
+      options.empty? && expansion ? Almodovar.instantiate(expansion, @auth) : Almodovar::Resource(link['href'], @auth, options)
     end
     
     def node_text(node)
@@ -41,6 +44,10 @@ module Almodovar
         node.text
       end
     end
+    
+    def attribute_name(attribute)
+      attribute.to_s.gsub('_', '-')
+    end
   end
   
   def self.Resource(url, auth, params = {})

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - BeBanjo S.L.
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-09 00:00:00 +02:00
+date: 2010-04-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency