restfulie 0.7.1 → 0.7.2

data/README.textile

@@ -13,24 +13,18 @@ h2. Why would I use restfulie?
 
 #  Easy --> writing hypermedia and semantic meaningful media type aware clients
 #  Small -> it's not a bloated solution with a huge list of APIs
-#  HATEOAS --> clients you are unaware of will not bother if you change your URIs
-#  HATEOAS --> resources that you consume will not affect your software whenever they change part of their flow or URIs
+#  HATEOAS --> clients you are unaware of will not bother if you change
+#  HATEOAS --> consumed resources will not affect your software whenever they change their flow
 #  Adaptability --> clients are able to adapt to your changes
  
-h2. Installing
-
-For client side usage, execute:
-
-<pre>
-gem install activesupport
-gem install restfulie
-</pre>
+h2. Documentation
 
-For server side usage, execute:
+Appart from the simple server and client examples provided here, you can find the following links useful:
 
-<pre>
-gem install restfulie
-</pre>
+* "RDocs":http://rdoc.info/projects/caelum/restfulie
+* "Official website":http://restfulie.caelumobjects.com
+* "How-tos":http://restfulie.caelumobjects.com/rails
+* "Buying through Rest: Rest to the enterprise (video)":guilhermesilveira.wordpress.com/2010/04/13/buying-through-rest-applying-rest-to-the-enterprise/
 
 h2. Simple server example
 
@@ -84,6 +78,21 @@ You can view an entire application running Restfulie under *spec/integration/ord
 
 "You can also download a full example of a REST based agent and server":http://github.com/caelum/mikyung using Restfulie and Mikyung, according to the Rest Architecture Maturity Model.
 
+h2. Installing
+
+For client side usage, execute:
+
+<pre>
+gem install activesupport
+gem install restfulie
+</pre>
+
+For server side usage, execute:
+
+<pre>
+gem install restfulie
+</pre>
+
 h2. Building the project
 
 If you want to build the project and run its tests, remember to install all (client and server) required gems and:
@@ -92,6 +101,7 @@ If you want to build the project and run its tests, remember to install all (cli
 gem install rack-conneg
 gem install responders_backport
 gem install json_pure
+gem install sqlite3-ruby
 </pre>
 
 <script type="text/javascript">

data/Rakefile

@@ -6,7 +6,7 @@ require 'spec/rake/spectask'
 require 'rake/rdoctask'
 
 GEM = "restfulie"
-GEM_VERSION = "0.7.1"
+GEM_VERSION = "0.7.2"
 SUMMARY  = "Hypermedia aware resource based library in ruby (client side) and ruby on rails (server side)."
 AUTHOR   = "Guilherme Silveira, Caue Guerra"
 EMAIL    = "guilherme.silveira@caelum.com.br"

data/lib/restfulie/common/builder/builder_base.rb

@@ -19,11 +19,11 @@ class Restfulie::Common::Builder::Base
   undef_method :to_json if respond_to?(:to_json)
 
   def respond_to?(symbol, include_private = false)
-    !marshalling_class(symbol).nil? || super
+    marshalling_class(symbol) || super
   end
 
   def method_missing(symbol, *args)
-    unless (marshalling = marshalling_class(symbol)).nil?
+    unless (marshalling = marshalling_class!(symbol)).nil?
       return builder(marshalling, *args)
     end
     super
@@ -43,16 +43,31 @@ private
     marshalling.new(@object, rules_blocks).builder_collection(@options.merge(options))
   end
 
+  def self.marshalling_classes(media_type)
+      {"application/atom+xml" => Restfulie::Common::Builder::Marshalling::Atom,
+        "application/xml" => Restfulie::Common::Builder::Marshalling::Xml::Marshaller,
+        "application/json" => Restfulie::Common::Builder::Marshalling::Json,
+        "atom" => Restfulie::Common::Builder::Marshalling::Atom, # test only
+        "xml" => Restfulie::Common::Builder::Marshalling::Xml::Marshaller # test only
+        }[media_type.downcase]
+  end
+
   def marshalling_class(method)
+    if (marshalling_name = method.to_s.match(/to_(.*)/))
+      marshalling = marshalling_name[1].downcase
+      Restfulie::Common::Builder::Base.marshalling_classes(marshalling)
+    end
+  end
+  
+  def marshalling_class!(method)
     if marshalling_name = method.to_s.match(/to_(.*)/)
-      marshalling = marshalling_name[1].downcase.capitalize.to_sym
-      if Restfulie::Common::Builder::Marshalling.const_defined?(marshalling)
-        begin
-          Restfulie::Common::Builder::Marshalling.const_get(marshalling) 
-        rescue NameError
-          raise Restfulie::Common::Error::UndefinedMarshallingError.new("Marshalling #{marshalling} not found.")
-        end
+      marshalling = marshalling_name[1].downcase
+      if (marshaller = Restfulie::Common::Builder::Base.marshalling_classes(marshalling))
+        marshaller
+      else
+        raise Restfulie::Common::Error::UndefinedMarshallingError.new("Marshalling #{marshalling} not found.")
       end
     end
   end
-end
+
+end

data/lib/restfulie/common/builder/marshalling/atom.rb

@@ -189,7 +189,7 @@ private
   end
   
   def namespace_enhance(options)
-    if !options[:namespace].nil? && options[:namespace].kind_of?(String)
+    if options[:namespace] && options[:namespace].kind_of?(String)
       options[:namespace] = { :uri => options[:namespace], :eager_load => true }
     end
     options

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

@@ -0,0 +1,183 @@
+# support xml serialization for custom attributes
+module Restfulie::Common::Builder::Rules::CustomAttributes
+  
+  def to_xml(writer)
+    custom_attributes.each do |key, value|
+      writer.tag!(key, value)
+    end
+  end
+  
+end
+
+module Restfulie::Common::Builder::Marshalling::Xml
+end
+
+# Xml collection rule answering to to_xml and allowing any custom element to be inserted
+# All links will be automatically inserted.
+class Restfulie::Common::Builder::Marshalling::Xml::CollectionRule < Restfulie::Common::Builder::CollectionRule
+  
+  include Restfulie::Common::Builder::Rules::CustomAttributes
+
+  def to_xml(writer)
+    super(writer)
+    links.each do |link|
+      writer.link(:rel => link.rel, :href => link.href, :type => (link.type || 'application/xml')) if link.href
+    end
+  end
+
+end
+
+# Xml member rule answering to to_xml and allowing any custom element to be inserted.
+# All links will be automatically inserted.
+class Restfulie::Common::Builder::Marshalling::Xml::MemberRule < Restfulie::Common::Builder::MemberRule
+
+  include ActionController::UrlWriter
+  include Restfulie::Common::Builder::Rules::CustomAttributes
+
+  def to_xml(object, writer)
+    super(writer)
+    # Transitions
+    links.each do |link|
+      atom_link = {:rel => link.rel, :href => link.href, :type => link.type}
+
+      # Self
+      if link.href.nil?
+        if link.rel == "self"
+          path = object
+        else
+          association = object.class.reflect_on_all_associations.find { |a| a.name.to_s == link.rel }
+          path = (association.macro == :has_many) ? [object, association.name] : object.send(association.name) unless association.nil? 
+        end
+        atom_link[:href] = polymorphic_url(path, :host => host) rescue nil
+        atom_link[:type] = link.type || 'application/xml'
+      end
+      writer.link(:rel => atom_link[:rel], :href => atom_link[:href], :type => (link.type || 'application/xml')) if atom_link[:href]
+
+    end
+  end
+
+  private
+  def host
+    # TODO: If we split restfulie into 2 separate gems, we may need not to use Restfulie::Server
+    #       inside Restfulie::Common
+    Restfulie::Server::Configuration.host
+  end
+
+end
+
+class Restfulie::Common::Builder::Marshalling::Xml::Marshaller < Restfulie::Common::Builder::Marshalling::Base
+  include ActionController::UrlWriter
+  include Restfulie::Common::Builder::Helpers
+  include Restfulie::Common::Error
+  
+  def initialize(object, rules)
+    @object = object
+    @rules   = rules
+  end
+
+  def builder_collection(options = {})
+    builder_feed(@object, @rules, options)
+  end
+
+  def builder_member(options = {})
+    options[:indent]   ||= 2
+    options[:builder]  ||= Builder::XmlMarkup.new(:indent => options[:indent])
+    options[:skip_types] = true
+    builder_entry(@object, options[:builder], @object.class.name.underscore, @rules, options)
+  end
+
+private
+
+  def builder_feed(objects, rules_blocks, options = {})
+    rule = Restfulie::Common::Builder::Marshalling::Xml::CollectionRule.new(rules_blocks)
+
+    rule.blocks.unshift(default_collection_rule) if options[:default_rule]
+    rule.apply(objects, options)
+    
+    # setup code from Rails to_xml
+
+     options[:root]     ||= objects.all? { |e| e.is_a?(objects.first.class) && objects.first.class.to_s != "Hash" } ? objects.first.class.to_s.underscore.pluralize : "records"
+     options[:children] ||= options[:root].singularize
+     options[:indent]   ||= 2
+     options[:builder]  ||= Builder::XmlMarkup.new(:indent => options[:indent])
+
+     root     = options.delete(:root).to_s
+     children = options.delete(:children)
+
+     if !options.has_key?(:dasherize) || options[:dasherize]
+       root = root.dasherize
+     end
+
+     options[:builder].instruct! unless options.delete(:skip_instruct)
+
+     opts = options.merge({ :root => children })
+
+     writer = options[:builder]
+
+     # Entries
+     options.delete(:values)
+     member_options = options.merge(rule.members_options || {})
+     member_options[:skip_instruct] = true
+     start_with_namespace(rule.namespaces, writer, root, options[:skip_types] ? {} : {}) do
+       rule.to_xml(writer)
+       yield writer if block_given?
+       
+       objects.each { |e| 
+         builder_entry(e, writer, children, rule.members_blocks || [], member_options)
+       }
+     end
+     
+  end
+  
+  def start_with_namespace(namespaces, writer, root, condition, &block)
+    spaces = condition.dup
+    namespaces.each do |ns|
+      ns.each do |key, value|
+        spaces["xmlns:#{ns.namespace}"] = ns.uri
+      end if ns.uri
+    end
+    result = writer.tag!(root, spaces) do |inner|
+      namespaces.each do |ns|
+        ns.each do |key, value|
+          tag = ns.namespace ? "#{key}" : "#{ns.namespace}:#{key}"
+          inner.tag! tag, value
+        end
+      end
+      block.call inner
+    end
+  end
+  
+  def default_collection_rule
+    Proc.new do |collection_rule, objects, options|
+    end
+  end
+  
+  def builder_entry(object, xml, children, rules_blocks, options)
+    rule    = Restfulie::Common::Builder::Marshalling::Xml::MemberRule.new(rules_blocks)
+    options = namespace_enhance(options)
+
+    rule.blocks.unshift(default_member_rule) if options[:default_rule]
+    rule.apply(object, options)
+    
+    start_with_namespace(rule.namespaces, xml, children, {}) do |inner_xml|
+      rule.to_xml(object, inner_xml)
+    end
+  end
+
+  def default_member_rule
+    Proc.new do |member_rule, object, options|
+      if options[:namespace]
+        member_rule.namespace(object, options[:namespace][:uri], options[:namespace])
+      else
+        member_rule.namespace(object, nil, options[:namespace] || {})
+      end
+    end
+  end
+
+  def namespace_enhance(options)
+    if !options[:namespace].nil? && options[:namespace].kind_of?(String)
+      options[:namespace] = { :uri => options[:namespace], :eager_load => true }
+    end
+    options
+  end
+end

data/lib/restfulie/common/builder/rules/custom_attributes.rb

@@ -0,0 +1,24 @@
+# Rules that allow any type of content shall extend this one and provide valid serialization methods. i.e.: to_xml
+module Restfulie::Common::Builder::Rules::CustomAttributes
+
+  # returns true if it's a valid attribute evaluation or 
+  def method_missing(sym, *args)
+    if sym.to_s.last=="=" && args.size==1
+      custom_attributes[sym.to_s.chop] = args[0]
+    elsif custom_attributes[sym.to_s]
+      custom_attributes[sym.to_s]
+    else
+      super(sym, *args)
+    end
+  end
+  
+  def respond_to?(sym)
+    super(sym) || (sym.to_s.last == "=") || custom_attributes[sym.to_s]
+  end
+  
+  private
+  
+  def custom_attributes
+    @custom_attributes ||= {}
+  end
+end

data/lib/restfulie/common/builder/rules/namespace.rb

@@ -1,3 +1,14 @@
+# Representation of a namespace. Allows any type of attribute setting and grabbing, i.e.:
+#
+# collection.namespace(:basket, "http://openbuy.com/basket") do |ns|
+#   ns.price = @basket.cost
+# end
+#
+# or
+#
+# collection.describe_members(:namespaces => "http://localhost:3000/items") do |member, item|
+#   member.links << link( :rel => :self, :href => item_url(item))
+# end
 class Restfulie::Common::Builder::Rules::Namespace < Hash
   attr_reader :namespace
   attr_reader :uri
@@ -9,7 +20,6 @@ class Restfulie::Common::Builder::Rules::Namespace < Hash
   end
   
   def uri=(value)
-    raise Restfulie::Common::Error::NameSpaceError.new('Namespace can not be blank uri.') if value.blank?
     @uri = value
   end
 

data/lib/restfulie/common/builder/rules/rules_base.rb

@@ -1,5 +1,6 @@
 module Restfulie::Common::Builder::Rules; end
 
+# Set of rules that can be used to describe a resource in a tokamak view.
 class Restfulie::Common::Builder::Rules::Base
   attr_accessor :blocks
   attr_accessor :links
@@ -18,7 +19,7 @@ class Restfulie::Common::Builder::Rules::Base
     end
   end
 
-  # Use to register namespace
+  # Use to register a namespace
   #
   #==Example:
   #

data/lib/restfulie/common/builder.rb

@@ -11,6 +11,7 @@ module Restfulie::Common::Builder; end
   rules/namespace
   rules/member_rule
   rules/collection_rule
+  rules/custom_attributes
 ).each do |file|
   require File.join(File.dirname(__FILE__), 'builder', file)
 end

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

@@ -22,8 +22,10 @@ module Restfulie::Common::Representation
       end
     end
 
-    def marshal(string, rel)
-      string
+    def marshal(entity, rel)
+      return entity if entity.kind_of? String
+      entity.to_xml
+      entity
     end
 
     # transforms this content into a parameter hash for rails (server-side usage)

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

@@ -12,7 +12,8 @@ module Restfulie::Common::Representation
     }
 
     def unmarshal(string)
-      JSON.parse(string)
+      base = JSON.parse(string)
+      base == {} ? {} : base.values.first
     end
 
     def marshal(entity, rel)

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

@@ -39,8 +39,9 @@ module Restfulie::Common::Representation
       Hash.from_xml(string).values.first
     end
 
-    def marshal(string, rel)
-      string
+    def marshal(entity, rel)
+      return entity if entity.kind_of? String
+      entity.to_xml
     end
 
   end

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

@@ -11,7 +11,7 @@ module Restfulie::Server::ActionView::Helpers
   #
   # in partial:
   #
-  #  member.links << link(:rel => :artistis, :href => album_artists_url(album))
+  #  member.links << link(:rel => :artists, :href => album_artists_url(album))
   #
   # Or passing local variables assing
   #  

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

@@ -3,13 +3,12 @@ module Restfulie::Server::ActionView::TemplateHandlers
   class Tokamak < ActionView::TemplateHandler
     include ActionView::TemplateHandlers::Compilable
       
-    # TODO: Implement error for code not return builder
     def compile(template)
       "extend Restfulie::Common::Builder::Helpers; " +
       "extend Restfulie::Server::ActionView::Helpers; " +
       "code_block = lambda { #{template.source} };" + 
       "builder = code_block.call; " +
-      "builder.to_atom "
+      "builder.send \"to_\#{self.response.content_type}\" "
     end
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 1
-  version: 0.7.1
+  - 2
+  version: 0.7.2
 platform: ruby
 authors: 
 - Guilherme Silveira, Caue Guerra
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-21 00:00:00 -03:00
+date: 2010-04-19 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -98,8 +98,10 @@ files:
 - 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