restfulie 0.7.2 → 0.8.0

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

@@ -1,19 +1,12 @@
+module Restfulie::Common::Converter
+end
+module Restfulie::Common::Converter::Xml
+end
+
 class Hash
   def links(*args)
     links = fetch("link", [])
-    links = [links] unless links.kind_of? Array
-    links = [] unless links
-    links = links.map do |l|
-      Restfulie::Client::Link.new(l)
-    end
-    if args.empty?
-      links
-    else
-      found = links.find do |link|
-        link.rel == args[0].to_s
-      end
-      found
-    end
+    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]
@@ -23,27 +16,220 @@ class Hash
   end
 end
 
-module Restfulie::Common::Representation
+class Restfulie::Common::Converter::Xml::Links
 
-  # Implements the interface for marshal Xml media type requests (application/xml)
-  class XmlD
-    cattr_reader :media_type_name
+  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
+
+class Restfulie::Common::Converter::Xml::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
+
+# Implements the interface for marshal Xml media type requests (application/xml)
+module Restfulie::Common::Converter::Xml
+
+    mattr_reader :media_type_name
     @@media_type_name = 'application/xml'
 
-    cattr_reader :headers
+    mattr_reader :headers
     @@headers = { 
       :post => { 'Content-Type' => media_type_name }
     }
 
-    def unmarshal(string)
-      Hash.from_xml(string).values.first
+    def self.marshal(entity, options = {})
+      to_xml(entity, options)
     end
 
-    def marshal(entity, rel)
-      return entity if entity.kind_of? String
-      entity.to_xml
+    def self.unmarshal(string)
+      Hash.from_xml string
     end
 
+    mattr_reader :recipes
+    @@recipes = {}
+
+    def self.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 self.to_xml(obj, options = {}, &block)
+      return obj if obj.kind_of?(String)
+      
+      if block_given?
+        recipe = block 
+      elsif options[:recipe]
+        recipe = @@recipes[options[:recipe]]
+      else
+        return obj.values.first.to_xml(:root => obj.keys.first) if obj.kind_of?(Hash) && obj.size==1
+        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 self.helper
+      Restfulie::Common::Converter::Xml::Helpers
+    end
+
+end
+class Restfulie::Common::Converter::Xml::Builder
+  attr_reader :doc
+  def initialize(obj, options = {})
+    @doc    = Nokogiri::XML::Document.new
+    @obj    = obj
+    if options[:root]
+      root = options[:root]
+    else
+      root = root_element_for(obj)
+    end
+    @parent = @doc.create_element(root)
+    @parent.parent = @doc
+  end
+  
+  def values(options = nil, &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 if options
+    
+    yield Restfulie::Common::Converter::Components::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 Restfulie::Common::Error::BuilderError("Members method require a collection to execute") unless collection.respond_to?(:each)
+    collection.each do |member|
+      entry = @doc.create_element(root_element_for(member))
+      entry.parent = @parent
+      @parent = entry
+      block.call(self, member)
+      @parent = entry.parent
+    end
   end
+  
+  private
 
+  def root_element_for(obj)
+    if obj.kind_of?(Hash) && obj.size==1
+      obj.keys.first.to_s
+    elsif obj.kind_of?(Array) && !obj.empty?
+      root_element_for(obj.first).underscore.pluralize
+    else
+      obj.class.to_s.underscore
+    end
+  end
+  
+  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            
+          arg.kind_of?(Time) || arg.kind_of?(DateTime) ? content = arg.xmlschema : content = arg
+          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
+
+module Restfulie::Common::Converter::Xml::Helpers
+  def collection(obj, *args, &block)
+    Restfulie::Common::Converter::Xml.to_xml(obj, {}, &block)
+  end
+
+  def member(obj, *args, &block)
+    Restfulie::Common::Converter::Xml.to_xml(obj, {}, &block)
+  end
 end

data/lib/restfulie/common/representation.rb

@@ -9,4 +9,3 @@ module Restfulie::Common::Representation; end
 ).each do |file|
   require File.join(File.dirname(__FILE__), 'representation', file)
 end
-

data/lib/restfulie/common.rb

@@ -5,8 +5,6 @@ require 'rubygems'
 require 'active_support'
 require 'action_controller'
 
-require 'vendor/atom'
-
 module Restfulie
   module Common; end
 end
@@ -14,8 +12,9 @@ end
 %w(
   errors
   logger
-  builder
+  core_ext
   representation
+  converter
 ).each do |file| 
   require "restfulie/common/#{file}"
 end

data/lib/restfulie/server/action_controller/base.rb

@@ -8,8 +8,27 @@ module Restfulie
           # Sets a default responder for this controller. 
           # Needs to require responder_legacy.rb
           base.responder = Restfulie::Server::ActionController::RestfulResponder
+          base.extend(Restfulie::Server::ActionController::Base::ClassMethods)
           # Atom representation is added by default
-          ParamsParser.register('application/atom+xml', Restfulie::Common::Representation::Atom)
+          ParamsParser.register('application/atom+xml', Restfulie::Common::Converter::Atom)
+        end
+
+        module ClassMethods
+          def call(env)
+            if include_restfulie? && env.has_key?("action_controller.restfulie.response")
+              if logger && logger.info?
+                information = "Status: #{env["action_controller.restfulie.response"][0]} "
+                information << ::ActionController::StatusCodes::STATUS_CODES[env["action_controller.restfulie.response"][0]]
+                logger.info(information) 
+              end
+              return env["action_controller.restfulie.response"] 
+            end
+            super
+          end
+
+          def include_restfulie?
+            defined?(Restfulie::Server::ActionController::Base) && controller_class_name.constantize.include?(Restfulie::Server::ActionController::Base)
+          end
         end
 
       protected
@@ -17,7 +36,7 @@ module Restfulie
         # If your controller inherits from Restfulie::Server::Controller::Base,
         # it will have an :atom option, very similar to render :xml
         def render(options = {}, extra_options = {}, &block)
-          if atom = options[:atom]
+          if options && atom = options[:atom]
             response.content_type ||= Mime::ATOM
             render_for_text(atom.respond_to?(:to_atom) ? atom.to_atom.to_xml : atom.to_xml, options[:status])
           else

data/lib/restfulie/server/action_controller/params_parser.rb

@@ -42,21 +42,21 @@ end
 # extensions are handled by the Rack stack
 #
 # TODO Change this when porting this code to Rails 3
-#::ActionController::ParamsParser.class_eval do
-  #def call(env)
-    #begin
-      #if params = parse_formatted_parameters(env)
-        #env["action_controller.request.request_parameters"] = params
-      #else
-        #if env["CONTENT_LENGTH"] && (env["CONTENT_LENGTH"] != "0")
-          #return [415, {'Content-Type' => 'text/html'}, "<html><body><h1>415 Unsupported Media Type</h1></body></html>"]
-        #end
-      #end
-    #rescue
-      #return [400, {'Content-Type' => 'text/html'}, "<html><body><h1>400 Bad Request</h1></body></html>"]
-    #end
+::ActionController::ParamsParser.class_eval do
+  def call(env)
+    begin
+      if params = parse_formatted_parameters(env)
+        env["action_controller.request.request_parameters"] = params
+      elsif !(env["CONTENT_TYPE"] == "application/x-www-form-urlencoded") #do not override rails default behaviour for this media type, it's dangerous... (o.O)
+        if env["CONTENT_LENGTH"] && (env["CONTENT_LENGTH"] != "0")
+          env["action_controller.restfulie.response"] = [415, {'Content-Type' => 'text/html'}, ["<html><body><h1>415 Unsupported Media Type</h1></body></html>"]]
+        end
+      end
+    rescue
+      env["action_controller.restfulie.response"] = [400, {'Content-Type' => 'text/html'}, ["<html><body><h1>400 Bad Request</h1></body></html>"]]
+    end
 
-    #@app.call(env)
-  #end
-#end
+    @app.call(env)
+  end
+end
 

data/lib/restfulie/server/action_controller/restful_responder.rb

@@ -29,11 +29,11 @@ module Restfulie::Server::ActionController
     end
     
     def set_public_cache_control!
-      cache_control = response.headers["Cache-Control"].split(",").map {|k| k.strip }
+      cache_control = controller.response.headers["Cache-Control"].split(",").map {|k| k.strip }
       cache_control.delete("private")
       cache_control.delete("no-cache")
       cache_control << "public"
-      response.headers["Cache-Control"] = cache_control.join(', ')
+      controller.response.headers["Cache-Control"] = cache_control.join(', ')
     end
   end
-end
+end

data/lib/restfulie/server/action_controller/routing/patch.rb

@@ -0,0 +1,6 @@
+module ActionController::Routing
+  HTTP_METHODS = [:get, :head, :post, :put, :delete, :options, :patch]
+end
+
+ActionController::Request::HTTP_METHODS << "patch"
+ActionController::Request::HTTP_METHOD_LOOKUP["PATCH"] = :patch

data/lib/restfulie/server/action_view/helpers.rb

@@ -5,7 +5,7 @@ module Restfulie::Server::ActionView::Helpers
   #
   # Passing the current context to partial in template:
   #
-  #  describe_member(@album) do |member, album|
+  #  member(@album) do |member, album|
   #    partial('member', binding)
   #  end
   #
@@ -14,12 +14,12 @@ module Restfulie::Server::ActionView::Helpers
   #  member.links << link(:rel => :artists, :href => album_artists_url(album))
   #
   # Or passing local variables assing
-  #  
-  #  descirbe_collection(@albums) do |collection|
-  #    collection.describe_members do |member, album|
-  #      partial('member', :locals => {:member => member, :album => album})
-  #    end
-  #  end
+  #
+  # collection(@albums) do |collection|
+  #   collection.members do |member, album|
+  #     partial("member", :locals => {:member => member, :album => album})
+  #   end
+  # end
   #
   def partial(partial_path, caller_binding = nil)
     template = _pick_partial_template(partial_path)
@@ -27,7 +27,7 @@ module Restfulie::Server::ActionView::Helpers
     # Create a context to assing variables
     if caller_binding.kind_of?(Hash)
       Proc.new do
-        extend Restfulie::Common::Builder::Helpers
+        extend @restfulie_type_helpers
         context = eval("(class << self; self; end)", binding)
         
         unless caller_binding[:locals].nil?

data/lib/restfulie/server/action_view/template_handlers/tokamak.rb

@@ -4,11 +4,12 @@ module Restfulie::Server::ActionView::TemplateHandlers
     include ActionView::TemplateHandlers::Compilable
       
     def compile(template)
-      "extend Restfulie::Common::Builder::Helpers; " +
+      "@restfulie_type_helpers = Restfulie::Client::HTTP::RequestMarshaller.content_type_for(self.response.content_type).helper; " +
+      "extend @restfulie_type_helpers; " +
       "extend Restfulie::Server::ActionView::Helpers; " +
       "code_block = lambda { #{template.source} };" + 
       "builder = code_block.call; " +
-      "builder.send \"to_\#{self.response.content_type}\" "
+      "builder.to_s"
     end
   end
 end

data/lib/restfulie/server/core_ext/array.rb

@@ -9,20 +9,21 @@ class Array
       options[:skip_attributes]         = true      
     end
     
-    Atom::Feed.new do |feed|
-      # TODO: Define better feed attributes
-      # Array#to_s can return a very long string
-      feed.title   = "Collection of #{map {|i| i.class.name }.uniq.to_sentence}"
-      # TODO: this id does not comply with Rest standards yet
-      feed.id      = hash
-      feed.updated = updated_at
+    feed = Restfulie::Common::Representation::Atom::Feed.new
+    # TODO: Define better feed attributes
+    # Array#to_s can return a very long string
+    feed.title = "Collection of #{map {|i| i.class.name }.uniq.to_sentence}"
+    feed.updated = updated_at
+    # TODO: this id does not comply with Rest standards yet
+    feed.id = hash
     
-      each do |element|
-        feed.entries << element.to_atom(options)
-      end
-      
-      yield feed if block_given?
+    each do |element|
+      feed.entries << element.to_atom(options)
     end
+    
+    yield feed if block_given?
+    
+    feed
   end
   
   # Return max update date for items in collection, for it uses the updated_at of items.

metadata

@@ -4,23 +4,37 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 2
-  version: 0.7.2
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
-- Guilherme Silveira, Caue Guerra
+- "Guilherme Silveira, Caue Guerra, Luis Cipriani, \xC3\x89verton Ribeiro, George Guimar\xC3\xA3es, Paulo Ahagon"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-04-19 00:00:00 -03:00
+date: 2010-05-27 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: actionpack
+  name: nokogiri
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -30,11 +44,11 @@ dependencies:
         - 2
         version: 2.3.2
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -44,11 +58,11 @@ dependencies:
         - 2
         version: 2.3.2
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: responders_backport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -58,11 +72,11 @@ dependencies:
         - 0
         version: 0.1.0
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: json_pure
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -72,7 +86,7 @@ dependencies:
         - 4
         version: 1.2.4
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id005
 description: 
 email: guilherme.silveira@caelum.com.br
 executables: []
@@ -87,29 +101,33 @@ files:
 - lib/restfulie/client/http/adapter.rb
 - lib/restfulie/client/http/atom_ext.rb
 - lib/restfulie/client/http/cache.rb
+- lib/restfulie/client/http/core_ext/http.rb
+- lib/restfulie/client/http/core_ext.rb
 - lib/restfulie/client/http/error.rb
-- lib/restfulie/client/http/link.rb
 - lib/restfulie/client/http/marshal.rb
-- lib/restfulie/client/http/xml.rb
+- lib/restfulie/client/http/xml_ext.rb
 - lib/restfulie/client/http.rb
+- lib/restfulie/client/mikyung/concatenator.rb
+- lib/restfulie/client/mikyung/core.rb
+- lib/restfulie/client/mikyung/languages.rb
+- lib/restfulie/client/mikyung/rest_process_model.rb
+- lib/restfulie/client/mikyung/steady_state_walker.rb
+- lib/restfulie/client/mikyung/then_condition.rb
+- lib/restfulie/client/mikyung/when_condition.rb
+- lib/restfulie/client/mikyung.rb
 - lib/restfulie/client.rb
-- lib/restfulie/common/builder/builder_base.rb
-- lib/restfulie/common/builder/helpers.rb
-- lib/restfulie/common/builder/marshalling/atom.rb
-- lib/restfulie/common/builder/marshalling/base.rb
-- lib/restfulie/common/builder/marshalling/json.rb
-- lib/restfulie/common/builder/marshalling/xml.rb
-- lib/restfulie/common/builder/marshalling.rb
-- lib/restfulie/common/builder/rules/collection_rule.rb
-- lib/restfulie/common/builder/rules/custom_attributes.rb
-- lib/restfulie/common/builder/rules/link.rb
-- lib/restfulie/common/builder/rules/links.rb
-- lib/restfulie/common/builder/rules/member_rule.rb
-- lib/restfulie/common/builder/rules/namespace.rb
-- lib/restfulie/common/builder/rules/rules_base.rb
-- lib/restfulie/common/builder.rb
+- lib/restfulie/common/converter/atom/builder.rb
+- lib/restfulie/common/converter/atom/helpers.rb
+- lib/restfulie/common/converter/atom.rb
+- lib/restfulie/common/converter/values.rb
+- lib/restfulie/common/converter.rb
+- lib/restfulie/common/core_ext/proc.rb
+- lib/restfulie/common/core_ext.rb
 - lib/restfulie/common/errors.rb
 - lib/restfulie/common/logger.rb
+- lib/restfulie/common/representation/atom/base.rb
+- lib/restfulie/common/representation/atom/entry.rb
+- lib/restfulie/common/representation/atom/feed.rb
 - lib/restfulie/common/representation/atom.rb
 - lib/restfulie/common/representation/generic.rb
 - lib/restfulie/common/representation/json.rb
@@ -119,6 +137,7 @@ files:
 - lib/restfulie/server/action_controller/base.rb
 - lib/restfulie/server/action_controller/params_parser.rb
 - lib/restfulie/server/action_controller/restful_responder.rb
+- lib/restfulie/server/action_controller/routing/patch.rb
 - lib/restfulie/server/action_controller/routing/restful_route.rb
 - lib/restfulie/server/action_controller/routing.rb
 - lib/restfulie/server/action_controller.rb
@@ -132,13 +151,11 @@ files:
 - lib/restfulie/server/restfulie_controller.rb
 - lib/restfulie/server.rb
 - lib/restfulie.rb
-- lib/vendor/atom/configuration.rb
-- lib/vendor/atom/pub.rb
-- lib/vendor/atom/xml/parser.rb
-- lib/vendor/atom.rb
+- Gemfile
 - LICENSE
 - Rakefile
 - README.textile
+- lib/restfulie/common/representation/atom/atom.rng
 has_rdoc: true
 homepage: http://restfulie.caelumobjects.com
 licenses: []

data/lib/restfulie/client/http/link.rb

@@ -1,39 +0,0 @@
-module Restfulie::Client
-
-  # Offer easy access to link relationships, such as <tt>post.next</tt> for 
-  # <tt>&lt;link rel="next" href="http://resource.entrypoint.com/post/12" type="application/atom+xml" /&gt;</tt> relationships.
-  module LinkShortcut
-    def method_missing(method_sym,*args)#:nodoc:
-      selected_links = links.select{ |l| l.rel == method_sym.to_s }
-      super if selected_links.empty?
-      link = (selected_links.size == 1) ? selected_links.first : selected_links
-    
-      return link unless link.instance_variable_defined?(:@type)
-      link.accepts(link.type)
-    
-      representation = Restfulie::Client::HTTP::RequestMarshaller.content_type_for(link.type)
-      return representation.prepare_link_for(link) if representation
-      link
-
-    end
-  end
-
-  class Link
-
-    include Restfulie::Client::HTTP::LinkRequestBuilder
-
-    def initialize(options = {})
-      @options = options
-    end
-    def href
-      @options["href"]
-    end
-    def rel
-      @options["rel"]
-    end
-    def content_type
-      @options["type"]
-    end
-  end
-
-end

data/lib/restfulie/client/http/xml.rb

@@ -1,4 +0,0 @@
-::Hash.instance_eval {
-  include Restfulie::Client::LinkShortcut
-}
-