almodovar 0.5.6 → 0.6.0

data/README.rdoc

@@ -1,4 +1,4 @@
-=Almodovar
+=Almodovar {<img src="http://travis-ci.org/bebanjo/almodovar.png" />}[http://travis-ci.org/bebanjo/almodovar]
 
 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).
   
@@ -85,7 +85,7 @@ Resource collections have the _create_ method. Just call it with the attributes
 
   >> jobs = Almodovar::Resource("http://sequence.example.com/api/work_areas/52/jobs", auth)
   => [<job> ... </job>, <job> ... </job>]
-  >> job = jobs.create(:name => "Wadus")
+  >> job = jobs.create(:job => {:name => "Wadus"})
   => <job> ... </job>
   >> job.name
   => "Wadus"
@@ -96,7 +96,7 @@ 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.update(:job => {:name => "Wadus wadus"})
   => ...
   >> job.name
   => "Wadus wadus"
@@ -111,8 +111,8 @@ And exactly the same with the _delete_ method:
 
 ==To-do
 
-* 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
+* Other authentication methods than digest
 
 Copyright (c) 2010 BeBanjo S.L., released under the MIT license

data/lib/almodovar.rb

@@ -1,183 +1,17 @@
-require File.dirname(__FILE__) + '/../vendor/resourceful-0.5.3-patched/lib/resourceful'
+require 'patron'
 require 'nokogiri'
-require 'active_support'
-require 'to_xml'
-require 'uri'
+begin
+  require 'active_support/all'
+rescue LoadError
+  require 'active_support'
+end
 
-module Almodovar
-  
-  class DigestAuth < Resourceful::DigestAuthenticator
-  end
-  
-  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, type
-    
-    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 url
-      @url ||= xml.at_xpath("./link[@rel='self']").try(:[], "href")
-    end
-    
-    delegate :to_xml, :to => :xml
-    alias_method :inspect, :to_xml
-    
-    private
-    
-    def object_type
-      uri_parts = URI.parse(@url).path.split("/")
-      @object_type ||= (uri_parts.last =~ /^\d$/ ? uri_parts[-2].singularize : uri_parts.last.singularize)
-    end
-    
-    def [](key) # for resources with type "document"
-      return super unless xml.at_xpath("/*[@type='document']")
-      Hash.from_xml(xml.to_xml).values.first[key]
-    end
-    
-    def method_missing(meth, *args, &blk)
-      document = xml.at_xpath("./*[(name()='#{meth}' or name()='#{attribute_name(meth)}') and @type='document']")
-      return Resource.from_xml(document.to_xml) if document
-      
-      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 Resource.new(link["href"], @auth, link.at_xpath("./*"), *args) if link
-      
-      super
-    end
-    
-    def node_text(node)
-      case node['type']
-      when "integer": node.text.to_i
-      when "datetime": Time.parse(node.text)
-      else
-        node.text
-      end
-    end
-    
-    def attribute_name(attribute)
-      attribute.to_s.gsub('_', '-')
-    end
-    
-  end
-  
-  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_with_params).post(attrs.to_xml(:root => object_type, :convert_links => true), :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
-  
-  class Resource
-    
-    include HttpAccessor
-    
-    undef id, type
-    
-    delegate :inspect, :to => :get!
-    
-    def self.from_xml(xml, auth = nil)
-      new(nil, auth, Nokogiri.parse(xml).root)
-    end
-    
-    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, *args)
-      @resource_class ||= collection_call?(meth, *args) ? ResourceCollection : SingleResource
-    end
-    
-    def get!
-      klass = xml['type'] == 'array' ? ResourceCollection : SingleResource
-      @resource_object = klass.new(@url, @auth, @xml, @options)
-    end
-    
-    private
-    
-    def collection_call?(meth, *args)
-      (Array.instance_methods + ["create"] - ["delete", "id", "[]"]).include?(meth.to_s) ||
-      (meth.to_s == "[]" && args.size == 1 && args.first.is_a?(Fixnum))
-    end
-  end
-  
-  def self.Resource(url, auth, params = {})
-    Resource.new(url, auth, nil, params)
-  end
-  
-end
+require 'almodovar/digest_auth'
+require 'almodovar/http_accessor'
+require 'almodovar/resource'
+require 'almodovar/resource_collection'
+require 'almodovar/single_resource'
+require 'almodovar/to_xml'
+require 'almodovar/resource_presenter'
+require 'almodovar/resource_presenter/collection'
+require 'almodovar/resource_presenter/link'

data/lib/almodovar/digest_auth.rb

@@ -0,0 +1,4 @@
+module Almodovar
+  class DigestAuth < Struct.new(:realm, :username, :password)
+  end
+end

data/lib/almodovar/http_accessor.rb

@@ -0,0 +1,26 @@
+module Almodovar
+  module HttpAccessor
+    def xml
+      @xml ||= begin
+        response = http.get(url_with_params)
+        Nokogiri::XML.parse(response.body).root
+      end
+    end
+    
+    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
+      @http ||= Patron::Session.new.tap do |session|
+        session.username = @auth.username
+        session.password = @auth.password
+        session.auth_type = :digest
+      end
+    end
+  end
+  
+end

data/lib/almodovar/resource.rb

@@ -0,0 +1,56 @@
+module Almodovar
+  class Resource
+    include HttpAccessor
+
+    undef_method :id if instance_methods.include?("id")
+    undef_method :type if instance_methods.include?("type")
+  
+    delegate :inspect, :to => :get!
+  
+    def self.from_xml(xml, auth = nil)
+      new(nil, auth, Nokogiri::XML.parse(xml).root)
+    end
+  
+    def initialize(url, auth, xml = nil, options = {})
+      @url = url
+      @auth = auth
+      @xml = xml
+      @options = options
+    end
+  
+    def method_missing(meth, *args, &blk)
+      resource_object(meth).send(meth, *args, &blk)
+    end
+    
+    def get!
+      klass = xml['type'] == 'array' ? ResourceCollection : SingleResource
+      @resource_object = klass.new(@url, @auth, @xml, @options)
+    end
+    
+    def respond_to?(meth)
+      super || resource_object(meth).respond_to?(meth)
+    end
+  
+    private
+  
+    def collection_call?(meth, *args)
+      ([].respond_to?(meth) && !["delete", "id", "[]"].include?(meth.to_s)) ||
+      ["create"].include?(meth.to_s) ||
+      (meth.to_s == "[]" && args.size == 1 && args.first.is_a?(Fixnum))
+    end
+    
+    def resource_object(meth)
+      @resource_object ||= resource_class(meth).new(@url, @auth, @xml, @options)
+    end
+  
+    def resource_class(meth, *args)
+      @resource_class ||= collection_call?(meth, *args) ? ResourceCollection : SingleResource
+    end
+  
+  end
+  
+  def self.Resource(url, auth = nil, params = {})
+    Resource.new(url, auth, nil, params)
+  end
+  
+end

data/lib/almodovar/resource_collection.rb

@@ -0,0 +1,31 @@
+module Almodovar
+  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 = {})
+      raise ArgumentError.new("You must specify one only root element which is the type of resource (e.g. `:project => { :name => 'Wadus' }` instead of just `:name => 'Wadus'`)") if attrs.size > 1
+      root, body = attrs.first
+      response = http.post(url_with_params, body.to_xml(:root => root, :convert_links => true), :content_type => "application/xml")
+      Resource.new(nil, @auth, Nokogiri::XML.parse(response.body).root)
+    end
+    
+    private
+    
+    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
+end

data/lib/almodovar/resource_presenter.rb

@@ -0,0 +1,110 @@
+module Almodovar
+  
+  class ResourcePresenter
+    
+    attr_accessor :url
+    
+    def attributes
+      @attributes ||= ActiveSupport::OrderedHash.new
+    end
+    
+    def links
+      @links ||= []
+    end
+    
+    def self.resource_type
+      name.gsub(/Resource$/, '').underscore
+    end
+    
+    def resource_type
+      self.class.resource_type
+    end
+
+    def to_xml(options = {})
+      XmlSerializer.new(self, options).to_xml
+    end
+    
+    def to_json(options = {})
+      JsonSerializer.new(self, options).to_json
+    end
+    
+    def as_json(options = {})
+      JsonSerializer.new(self, options).as_json
+    end
+    
+    def all_links
+      ([link_to_self] + links).compact
+    end
+    
+    def link_to_self
+      Link.new(:self, @url) if @url
+    end
+    
+    class Serializer
+      
+      attr_reader :resource, :options
+      
+      def initialize(resource, options)
+        @resource = resource
+        @options  = options
+      end
+
+      def options_for_link
+        options.merge(:dont_expand => Array(options[:dont_expand]) << resource.url)
+      end
+      
+    end
+    
+    class XmlSerializer < Serializer
+      
+      def to_xml
+        attributes_to_xml do |builder|
+          links_to_xml builder
+        end
+      end
+      
+      private
+      
+      def attributes_to_xml(&block)
+        resource.attributes.to_xml(options.merge(:root => resource.resource_type), &block)
+      end
+
+      def links_to_xml(builder)
+        resource.all_links.each do |link|
+          link.to_xml(options_for_link.merge(:builder => builder))
+        end
+      end
+
+    end
+    
+    class JsonSerializer < Serializer
+      
+      def to_json
+        require 'yajl'
+        Yajl::Encoder.encode(as_json, :pretty => true) + "\n"
+      end
+      
+      def as_json
+        ActiveSupport::OrderedHash[:resource_type, resource.resource_type].tap do |message|
+          message.merge! attributes_as_json
+          message.merge! links_as_json
+        end
+      end
+      
+      private
+      
+      def attributes_as_json
+        resource.attributes
+      end
+
+      def links_as_json
+        resource.all_links.inject(ActiveSupport::OrderedHash.new) do |message, link|
+          message.merge! link.as_json(options_for_link)
+        end
+      end
+      
+    end
+
+  end
+  
+end