almodovar 0.1.2 → 0.2.0

data/README.rdoc

@@ -1,6 +1,6 @@
 =Almodovar
 
-Almodovar is a client for BeBanjo's Movida API written in Ruby
+Almodovar is a client for BeBanjo's Sequence & Movida API written in Ruby (it's actually a generic client which plays nice with any RESTful API following some conventions).
   
 ==Getting started
 
@@ -16,9 +16,9 @@ Now, let's play with irb:
 First you need an authentication token:  
 
   >> auth = Almodovar::DigestAuth.new("realm", "user", "password")
-  => #<Almodovar::DigestAuth:0x101f846c8 @password="secret", @username="robot_five", @realm="Staging Movida", @domain=nil>
+  => #<Almodovar::DigestAuth:0x101f846c8 ... >
   
-Now you have to instantiate a resource given its URL. Let's try with the root of the api:
+Now you have to instantiate a resource given its URL. Let's try with the root of the Movida API:
   
   >> movida = Almodovar::Resource("http://movida.example.com/api", auth)
   => <movida>
@@ -67,13 +67,52 @@ Of course, once you've got the URL of a resource, the next time you don't need t
   <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>]
+
+What if I want to access a specific node? Just do it:
+  
+  >> schedulings.first.id
+  => 112
+  >> schedulings.first.scheduling_type
+  => "archive"
   
+Note that fields with a hyphen are accessed with an underscore instead, otherwise ruby will think you are trying to substract ('-')
   
 Next, explore the {API docs}[http://wiki.github.com/bebanjo/almodovar/] to learn about other resources.
+
+==Creating resources
+
+Resource collections have the _create_ method. Just call it with the attributes you want your new resource to have!
+
+  >> jobs = Almodovar::Resource("http://sequence.example.com/api/work_areas/52/jobs", auth)
+  => [<job> ... </job>, <job> ... </job>]
+  >> job = jobs.create(:name => "Wadus")
+  => <job> ... </job>
+  >> job.name
+  => "Wadus"
   
+==Modifying resources
+
+You can use the _update_ method:
+
+  >> job = Almodovar::Resource("http://sequence.example.com/api/work_areas/52/jobs", auth).first
+  => <job> ... </job>
+  >> job.update(:name => "Wadus wadus")
+  => ...
+  >> job.name
+  => "Wadus wadus"
+
+== Deleting resources
+
+And exactly the same with the _delete_ method:
+
+  >> job = Almodovar::Resource("http://sequence.example.com/api/work_areas/52/jobs", auth).first
+  => <job> ... </job>
+  >> job.delete
+
 ==To-do
 
-* 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)
+* Better error management
+* Write the conventions Almodovar expects in an API
 
 Copyright (c) 2010 BeBanjo S.L., released under the MIT license

data/lib/almodovar.rb

@@ -1,41 +1,82 @@
 require File.dirname(__FILE__) + '/../vendor/resourceful-0.5.3-patched/lib/resourceful'
 require 'nokogiri'
+require 'active_support'
+require 'uri'
 
 module Almodovar
   
   class DigestAuth < Resourceful::DigestAuthenticator
   end
   
-  class Resource
-    def initialize(auth, xml)
+  module HttpAccessor
+    
+    def xml
+      @xml ||= begin
+        response = http.resource(url_with_params).get
+        Nokogiri.parse(response.body).root
+      end
+    end
+    
+    private
+    
+    def url_with_params
+      @options[:expand] = @options[:expand].join(",") if @options[:expand].is_a?(Array)
+      params = @options.map { |k, v| "#{k}=#{v}" }.join("&")
+      params = "?#{params}" unless params.empty?
+      @url + params
+    end
+    
+    def http
+      Resourceful::HttpAccessor.new(:authenticator => @auth)
+    end
+    
+  end
+  
+  class SingleResource
+    
+    include HttpAccessor
+    
+    undef id
+    
+    def initialize(url, auth, xml = nil, options = {})
+      @url = url
       @auth = auth
       @xml = xml
+      @options = options
+    end
+    
+    def update(attrs = {})
+      response = http.resource(@url).put(attrs.to_xml(:root => object_type), :content_type => "application/xml")
+      @xml = Nokogiri.parse(response.body).root
+    end
+    
+    def delete
+      http.resource(@url).delete
     end
     
-    def inspect
-      @xml.to_s
+    def url
+      @url ||= xml.at_xpath("./link[@rel='self']").try(:[], "href")
     end
     
+    delegate :to_xml, :to => :xml
+    alias_method :inspect, :to_xml
+    
     private
     
-    undef id
+    def object_type
+      @object_type ||= URI.parse(@url).path.split("/")[-2].singularize
+    end
     
     def method_missing(meth, *args, &blk)
-      attribute = @xml.at_xpath("./*[name()='#{meth}' or name()='#{attribute_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}' or @rel='#{attribute_name(meth)}']")
-      return get_linked_resource(link, args.first) if link
+      link = xml.at_xpath("./link[@rel='#{meth}' or @rel='#{attribute_name(meth)}']")
+      return Resource.new(link["href"], @auth, link.at_xpath("./*"), *args) if link
       
       super
     end
     
-    def get_linked_resource(link, options = {})
-      options ||= {}
-      expansion = link.at_xpath("./*")
-      options.empty? && expansion ? Almodovar.instantiate(expansion, @auth) : Almodovar::Resource(link['href'], @auth, options)
-    end
-    
     def node_text(node)
       case node['type']
       when "integer": node.text.to_i
@@ -48,31 +89,79 @@ module Almodovar
     def attribute_name(attribute)
       attribute.to_s.gsub('_', '-')
     end
+    
   end
   
-  def self.Resource(url, auth, params = {})
-    http = Resourceful::HttpAccessor.new(:authenticator => auth)
-    response = http.resource(add_params(url, params)).get
-    instantiate Nokogiri.parse(response.body).root, auth
-  end
-  
-  def self.instantiate(node, auth)
-    if node['type'] == 'array'
-      node.xpath("./*").map { |subnode| Resource.new(auth, subnode) }
-    else
-      Resource.new(auth, node)
+  class ResourceCollection
+    
+    include HttpAccessor
+    
+    delegate :inspect, :to => :resources
+    
+    def initialize(url, auth, xml = nil, options = {})
+      @url = url
+      @auth = auth
+      @xml = xml if options.empty?
+      @options = options
+    end
+    
+    def create(attrs = {})
+      response = http.resource(@url).post(attrs.to_xml(:root => object_type), :content_type => "application/xml")
+      Resource.new(nil, @auth, Nokogiri.parse(response.body).root)
+    end
+    
+    private
+    
+    def object_type
+      @object_type ||= URI.parse(@url).path.split("/").last.singularize
+    end
+    
+    def resources
+      @resources ||= xml.xpath("./*").map { |subnode| Resource.new(subnode.at_xpath("./link[@rel='self']").try(:[], "href"), @auth, subnode, @options) }
+    end
+    
+    def method_missing(meth, *args, &blk)
+      resources.send(meth, *args, &blk)
     end
   end
   
-  def self.add_params(url, options)
-    options[:expand] = options[:expand].join(",") if options[:expand].is_a?(Array)
-    params = options.map { |k, v| "#{k}=#{v}" }.join("&")
-    params = "?#{params}" unless params.empty?
-    url + params
+  class Resource
+    
+    include HttpAccessor
+    
+    undef id
+    
+    delegate :inspect, :to => :get!
+    
+    def initialize(url, auth, xml = nil, options = {})
+      @url = url
+      @auth = auth
+      @xml = xml
+      @options = options
+    end
+    
+    def method_missing(meth, *args, &blk)
+      @resource_object ||= resource_class(meth).new(@url, @auth, @xml, @options)
+      @resource_object.send(meth, *args, &blk)
+    end
+    
+    def resource_class(meth)
+      @resource_class ||= if [:create, :[], :first, :last, :size].include?(meth)
+        ResourceCollection
+      else
+        SingleResource
+      end
+    end
+    
+    def get!
+      klass = xml['type'] == 'array' ? ResourceCollection : SingleResource
+      @resource_object = klass.new(@url, @auth, @xml, @options)
+    end
+        
   end
   
-  def self.ResourceCollection(*args)
-    ResourceCollection.new(*args)
+  def self.Resource(url, auth, params = {})
+    Resource.new(url, auth, nil, params)
   end
   
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - BeBanjo S.L.
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-12 00:00:00 +02:00
+date: 2010-05-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,7 +44,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: steak
+  name: activesupport
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
@@ -53,10 +53,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: webmock
+  name: steak
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
@@ -67,6 +67,18 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: 
 email: ballsbreaking@bebanjo.com
 executables: []