restfulie 0.8.0 → 0.8.1

data/lib/restfulie/common/converter/values.rb

@@ -1,29 +1,33 @@
-module Restfulie::Common::Converter::Components
-  # This is a Blank Slate class to support the renderization of the values block for Resource Representation Interfaces
-  # Every Media type should implement a Builder with a insert_value method that renders the values block to a specific format
-  class Values
-    attr_accessor :builder
-
-    # BlankSlate
-    instance_methods.each do |m|
-      undef_method m unless m.to_s =~ /\[\]|method_missing|respond_to\?|^__/
-    end
-
-    def initialize(builder)
-      @builder = builder
-      @current_prefix = nil
-    end
-
-    def [](prefix)
-      @current_prefix = prefix
-      self
-    end
-
-    def method_missing(symbol, *args, &block)
-      name = symbol.to_s
-      prefix = @current_prefix
-      @current_prefix = nil
-      @builder.insert_value(name, prefix, *args, &block)
+module Restfulie
+  module Common
+    module Converter
+      # This is a Blank Slate class to support the renderization of the values block for Resource Representation Interfaces
+      # Every Media type should implement a Builder with a insert_value method that renders the values block to a specific format
+      class Values
+        attr_accessor :builder
+    
+        # BlankSlate
+        instance_methods.each do |m|
+          undef_method m unless m.to_s =~ /\[\]|method_missing|respond_to\?|^__/
+        end
+    
+        def initialize(builder)
+          @builder = builder
+          @current_prefix = nil
+        end
+    
+        def [](prefix)
+          @current_prefix = prefix
+          self
+        end
+    
+        def method_missing(symbol, *args, &block)
+          name = symbol.to_s
+          prefix = @current_prefix
+          @current_prefix = nil
+          @builder.insert_value(name, prefix, *args, &block)
+        end
+      end
     end
   end
 end

data/lib/restfulie/common/converter/xml.rb

@@ -0,0 +1,14 @@
+module Restfulie
+  module Common
+    module Converter
+      module Xml
+        autoload :Base, 'restfulie/common/converter/xml/base'
+        autoload :Builder, 'restfulie/common/converter/xml/builder'
+        autoload :Helpers, 'restfulie/common/converter/xml/helpers'
+        autoload :Links, 'restfulie/common/converter/xml/links'
+        autoload :Link, 'restfulie/common/converter/xml/link'
+        extend Base::ClassMethods
+      end
+    end
+  end
+end

data/lib/restfulie/common/converter/xml/base.rb

@@ -0,0 +1,61 @@
+module Restfulie
+  module Common
+    module Converter
+      module Xml
+        module Base
+          module ClassMethods
+            mattr_reader :media_type_name
+            @@media_type_name = 'application/xml'
+        
+            mattr_reader :headers
+            @@headers = { 
+              :post => { 'Content-Type' => media_type_name }
+            }
+        
+            def marshal(entity, options = {})
+              to_xml(entity, options)
+            end
+        
+            def unmarshal(string)
+              Hash.from_xml string
+            end
+        
+            mattr_reader :recipes
+            @@recipes = {}
+        
+            def describe_recipe(recipe_name, options={}, &block)
+              raise 'Undefined recipe' unless block_given?
+              raise 'Undefined recipe_name'   unless recipe_name
+              @@recipes[recipe_name] = block
+            end
+        
+            def to_xml(obj, options = {}, &block)
+              return obj if obj.kind_of?(String)
+              
+              if block_given?
+                recipe = block 
+              elsif options[:recipe]
+                recipe = @@recipes[options[:recipe]]
+              elsif obj.kind_of?(Hash) && obj.size==1
+                return obj.values.first.to_xml(:root => obj.keys.first)
+              else
+                return obj.to_xml
+              end
+              
+              # Create representation and proxy
+              builder = Builder.new(obj)
+        
+              # Check recipe arity size before calling it
+              recipe.call(*[builder, obj, options][0,recipe.arity])
+              builder.doc.to_xml
+            end
+            
+            def helper
+              Helpers
+            end
+          end
+        end
+      end
+    end
+  end
+end 

data/lib/restfulie/common/converter/xml/builder.rb

@@ -0,0 +1,112 @@
+module Restfulie
+  module Common
+    module Converter
+      module Xml
+        # Implements the interface for marshal Xml media type requests (application/xml)
+        class Builder
+          attr_reader :doc
+          def initialize(obj, options = {})
+            @doc    = Nokogiri::XML::Document.new
+            @obj    = obj
+            root = options[:root] || Restfulie::Common::Converter.root_element_for(obj)
+            @parent = @doc.create_element(root)
+            @parent.parent = @doc
+          end
+          
+          def values(options = {}, &block)
+            options.each do |key,value|
+              attr = key.to_s
+              if attr =~ /^xmlns(:\w+)?$/
+                ns = attr.split(":", 2)[1]
+                @parent.add_namespace_definition(ns, value)
+              end
+            end             
+            yield Values.new(self)
+          end
+        
+          def insert_value(name, prefix, *args, &block)
+            node = create_element(name.to_s, prefix, *args)
+            node.parent = @parent
+            
+            if block_given?
+              @parent = node
+              block.call
+              @parent = node.parent
+            end
+          end
+          
+          def link(relationship, uri, options = {})
+            options["rel"] = relationship.to_s
+            options["href"] = uri
+            options["type"] ||= "application/xml"
+            insert_value("link", nil, options)
+          end
+          
+          def members(a_collection = nil, &block)
+            collection = a_collection || @obj 
+            raise Error::BuilderError("Members method require a collection to execute") unless collection.respond_to?(:each)
+            collection.each do |member|
+              entry = @doc.create_element(Restfulie::Common::Converter.root_element_for(member))
+              entry.parent = @parent
+              @parent = entry
+              block.call(self, member)
+              @parent = entry.parent
+            end
+          end
+          
+          private
+          
+          def create_element(node, prefix, *args)
+            node = @doc.create_element(node) do |n|
+              if prefix
+                if namespace = prefix_valid?(prefix)
+                  # Adding namespace prefix
+                  n.namespace = namespace
+                  namespace = nil
+                end
+              end
+        
+              args.each do |arg|
+                case arg
+                # Adding XML attributes
+                when Hash
+                  arg.each { |k,v|
+                    key = k.to_s
+                    if key =~ /^xmlns(:\w+)?$/
+                      ns_name = key.split(":", 2)[1]
+                      n.add_namespace_definition(ns_name, v)
+                      next
+                    end
+                    n[k.to_s] = v.to_s
+                  }
+                # Adding XML node content
+                else            
+                  content = if arg.kind_of?(Time) || arg.kind_of?(DateTime)
+                      arg.xmlschema
+                    else
+                      arg
+                    end
+                  n.content = content
+                end
+              end
+            end
+          end
+          
+          def prefix_valid?(prefix)
+            ns = @parent.namespace_definitions.find { |x| x.prefix == prefix.to_s }
+            
+            unless ns
+              @parent.ancestors.each do |a|
+                next if a == @doc
+                ns = a.namespace_definitions.find { |x| x.prefix == prefix.to_s }
+                break if ns
+              end      
+            end
+            
+            return ns
+          end
+        end
+      end
+    end
+  end
+end

data/lib/restfulie/common/converter/xml/helpers.rb

@@ -0,0 +1,17 @@
+module Restfulie
+  module Common
+    module Converter
+      module Xml
+        module Helpers
+          def collection(obj, *args, &block)
+            Xml.to_xml(obj, {}, &block)
+          end
+        
+          def member(obj, *args, &block)
+            Xml.to_xml(obj, {}, &block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/restfulie/common/converter/xml/link.rb

@@ -0,0 +1,25 @@
+module Restfulie
+  module Common
+    module Converter
+      module Xml
+        class Link
+          def initialize(options = {})
+            @options = options
+          end
+          def href
+            @options["href"]
+          end
+          def rel
+            @options["rel"]
+          end
+          def content_type
+            @options["type"]
+          end
+          def type
+            content_type
+          end
+        end
+      end
+    end
+  end
+end

data/lib/restfulie/common/converter/xml/links.rb

@@ -0,0 +1,25 @@
+module Restfulie
+  module Common
+    module Converter
+      module Xml
+        class Links
+          def initialize(links)
+            links = [links] unless links.kind_of? Array
+            links = [] unless links
+            @links = links.map do |l|
+              link = Restfulie::Common::Converter::Xml::Link.new(l)
+              link.instance_eval { self.class.send :include, ::Restfulie::Client::HTTP::LinkRequestBuilder }
+              link
+            end
+          end
+          
+          def method_missing(sym, *args)
+            @links.find do |link|
+              link.rel == sym.to_s
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/restfulie/common/core_ext.rb

@@ -1,5 +1 @@
-%w(
-  proc
-).each do |file|
-  require File.join(File.dirname(__FILE__), 'core_ext', file)
-end
+require 'restfulie/common/core_ext/hash'

data/lib/restfulie/common/core_ext/hash.rb

@@ -0,0 +1,12 @@
+class Hash
+  def links(*args)
+    links = fetch("link", [])
+    Restfulie::Common::Converter::Xml::Links.new(links)
+  end
+  def method_missing(sym, *args)
+    self[sym.to_s].nil? ? super(sym, args) : self[sym.to_s]
+  end
+  def respond_to?(sym)
+    include?(sym.to_s) || super(sym)
+  end
+end

data/lib/restfulie/common/error.rb

@@ -0,0 +1,19 @@
+module Restfulie
+  module Common
+    module Error
+      class RestfulieError < StandardError; end
+      class MarshallingError < RestfulieError; end
+      class UndefinedMarshallingError < MarshallingError; end
+      
+      # Atom marshallinh error
+      class AtomMarshallingError < MarshallingError; end
+      class NameSpaceError < AtomMarshallingError; end
+    
+      # Converter
+      class ConverterError < RestfulieError; end
+      
+      # builder
+      class BuilderError < RestfulieError; end
+    end
+  end
+end

data/lib/restfulie/common/logger.rb

@@ -1,11 +1,19 @@
-module Restfulie::Common::Logger
-  # Configure the logger used by Restfulie
-  # 
-  # The logger defaults to ActiveSupport::BufferedLogger.new(STDOUT)
-  class << self
-    attr_accessor :logger
+module Restfulie
+  module Common
+    class Logger
+      # Configure the logger used by Restfulie
+      # 
+      # The logger defaults to ActiveSupport::BufferedLogger.new(STDOUT)
+      def self.logger
+        @@logger
+      end
+
+      def self.logger=(value)
+        @@logger = value
+      end
+
+      @@logger = ActiveSupport::BufferedLogger.new(STDOUT)
+      @@logger.level = ::Logger::DEBUG
+    end
   end
 end
-
-Restfulie::Common::Logger.logger = ActiveSupport::BufferedLogger.new(STDOUT)
-Restfulie::Common::Logger.logger.level = Logger::DEBUG

data/lib/restfulie/common/representation.rb

@@ -1,11 +1,10 @@
-#initialize namespace
-module Restfulie::Common::Representation; end
-
-%w(
-  atom
-  generic
-  json
-  xml
-).each do |file|
-  require File.join(File.dirname(__FILE__), 'representation', file)
+module Restfulie
+  module Common
+    module Representation
+      autoload :Atom, 'restfulie/common/representation/atom'
+      autoload :Generic, 'restfulie/common/representation/generic'
+      autoload :Json, 'restfulie/common/representation/json'
+      autoload :XmlD, 'restfulie/common/representation/xml'
+    end
+  end
 end

data/lib/restfulie/common/representation/atom.rb

@@ -1,52 +1,20 @@
 require 'nokogiri'
 
-#initialize namespace
-module Restfulie::Common::Representation::Atom
-  
-  # Create a new Representation::Atom object using a +string_or_io+
-  # object.
-  #
-  # Examples
-  #   xml  = IO.read("spec/units/lib/atoms/full_atom.xml")
-  #   atom = Restfulie::Common::Representation::Atom.new(xml)
-  class Factory
-    # RelaxNG file to validate atom
-    RELAXNG_ATOM = File.join(File.dirname(__FILE__), 'atom', 'atom.rng')
-    
-    if Nokogiri::VERSION_INFO["libxml"]["loaded"] < "2.7.7"
-      puts "WARNING! In order to use schema validation on atom representations you need libxml version 2.7.7 or superior loaded in your system." 
-      SCHEMA       = nil
-    else
-      SCHEMA       = ::Nokogiri::XML::RelaxNG(File.open(RELAXNG_ATOM))
+module Restfulie
+  module Common
+    module Representation
+      module Atom
+        autoload :Factory, 'restfulie/common/representation/atom/factory'
+        autoload :XML, 'restfulie/common/representation/atom/xml'
+        autoload :Base, 'restfulie/common/representation/atom/base'
+        autoload :TagCollection, 'restfulie/common/representation/atom/tag_collection'
+        autoload :Link, 'restfulie/common/representation/atom/link'
+        autoload :Person, 'restfulie/common/representation/atom/person'
+        autoload :Category, 'restfulie/common/representation/atom/category'
+        autoload :Feed, 'restfulie/common/representation/atom/feed'
+        autoload :Entry, 'restfulie/common/representation/atom/entry'
+        autoload :Source, 'restfulie/common/representation/atom/source'
+      end
     end
-
-    class << self
-      def create(string_or_io)
-        doc = string_or_io.kind_of?(Nokogiri::XML::Document) ? string_or_io : Nokogiri::XML(string_or_io) 
-        
-        if SCHEMA && !(errors = SCHEMA.validate(doc)).empty?
-          raise Restfulie::Common::Representation::Atom::AtomInvalid.new("Invalid Atom: "+ errors.join(", "))
-        end
-        
-        if doc.root.name == "feed"
-          Restfulie::Common::Representation::Atom::Feed.new(doc)
-        elsif doc.root.name == "entry"
-          Restfulie::Common::Representation::Atom::Entry.new(doc)
-        end        
-      end      
-    end
-    
   end
-  
-  class AtomInvalid < StandardError; end
-  
 end
-
-%w(
-  base
-  feed
-  entry
-).each do |file|
-  require File.join(File.dirname(__FILE__), 'atom', file)
-end
-