roar 0.11.4 → 0.11.5

data/lib/roar/representer/json.rb

@@ -9,48 +9,48 @@ module Roar
         base.class_eval do
           include Representer
           include Representable::JSON
-          
+
           extend ClassMethods
           include InstanceMethods # otherwise Representable overrides our #to_json.
         end
       end
-      
+
       module InstanceMethods
         def to_hash(*args)
           before_serialize(*args)
           super
         end
-        
+
         def from_json(document, options={})
           document = '{}' if document.nil? or document.empty?
-          
+
           super
         end
-        
+
         # Generic entry-point for rendering.
         def serialize(*args)
           to_json(*args)
         end
-        
+
         def deserialize(*args)
           from_json(*args)
         end
       end
-      
-      
+
+
       module ClassMethods
         def deserialize(*args)
           from_json(*args)
         end
-        
+
         # TODO: move to instance method, or remove?
         def links_definition_options
-          [:links, {:class => Feature::Hypermedia::Hyperlink, :extend => HyperlinkRepresenter, :collection => true}]
+          [:links_array, {:from => :links, :class => Feature::Hypermedia::Hyperlink, :extend => HyperlinkRepresenter, :collection => true}]
         end
       end
-      
+
       require "representable/json/hash"
-      # Represents a hyperlink in standard roar+json hash representation. 
+      # Represents a hyperlink in standard roar+json hash representation.
       module HyperlinkRepresenter
         include Representable::JSON::Hash
       end

data/lib/roar/representer/json/hal.rb

@@ -8,10 +8,10 @@ module Roar::Representer
     # :embedded => true option.
     #
     # Example:
-    # 
+    #
     #   module OrderRepresenter
     #     include Roar::Representer::JSON::HAL
-    #     
+    #
     #     property :id
     #     collection :items, :class => Item, :extend => ItemRepresenter, :embedded => true
     #
@@ -32,33 +32,48 @@ module Roar::Representer
           include Resources
         end
       end
-      
+
       module Resources
         # Write the property to the +_embedded+ hash when it's a resource.
         def compile_fragment(bin, doc)
           return super unless bin.options[:embedded]
           super(bin, doc[:_embedded] ||= {})
         end
-        
+
         def uncompile_fragment(bin, doc)
           return super unless bin.options[:embedded]
           super(bin, doc["_embedded"] || {})
         end
       end
-      
+
       module ClassMethods
         def links_definition_options
-          super.tap { |options| options[1].merge!({:from => :_links}) }
+          super.tap { |options| options[1].merge!(
+            :from     => :_links, 
+            :extend   => HAL::Links::LinkCollectionRepresenter,
+            :instance => lambda { |hsh| LinkCollection.new(link_array_rels) })  # defined in InstanceMethods as this is executed in represented context.
+           }
+        end
+      end
+
+      class LinkCollection < Feature::Hypermedia::LinkCollection
+        def initialize(array_rels, *args)
+          super(*args)
+          @array_rels = array_rels.map(&:to_s)
+        end
+
+        def is_array?(rel)
+          @array_rels.include?(rel.to_s)
         end
       end
-      
+
       # Including this module in your representer will render and parse your embedded hyperlinks
       # following the HAL specification: http://stateless.co/hal_specification.html
       #
       #   module SongRepresenter
       #     include Roar::Representer::JSON
       #     include Roar::Representer::JSON::HAL::Links
-      #     
+      #
       #     link :self { "http://self" }
       #   end
       #
@@ -68,40 +83,98 @@ module Roar::Representer
       #
       # Note that the HAL::Links module alone doesn't prepend an underscore to +links+. Use the JSON::HAL module for that.
       module Links
-        # TODO: allow more attributes besides :href in Hyperlink.
         def self.included(base)
           base.class_eval do
             include Roar::Representer::Feature::Hypermedia
+            include InstanceMethods
             extend Links::ClassMethods
           end
         end
         
+        module InstanceMethods
+        private
+          def prepare_link_for(href, options)
+            return super(href, options) unless options[:array]  # TODO: remove :array and use special instan
+            
+            list = href.collect { |opts| Feature::Hypermedia::Hyperlink.new(opts.merge!(:rel => options[:rel])) }
+            LinkArray.new(list)
+          end
+        
+          # TODO: move to LinksDefinition.
+          def link_array_rels
+            links_definition.collect { |cfg| cfg.first[:array] ? cfg.first[:rel] : nil }.compact
+          end
+        end
+        
         
+        require 'representable/json/hash'
         module LinkCollectionRepresenter
-          include JSON
-          
-          def to_hash(*)
-            {}.tap do |hash|
-              each do |link|
-                # TODO: we statically use JSON::HyperlinkRepresenter here.
-                hash[link.rel] = link.extend(JSON::HyperlinkRepresenter).to_hash(:exclude => [:rel])
-              end
+          include Representable::JSON::Hash
+
+          values :extend => lambda { |item| item.is_a?(Array) ? LinkArrayRepresenter : Roar::Representer::JSON::HyperlinkRepresenter },
+            :class => lambda { |hsh| hsh.is_a?(LinkArray) ? nil : Roar::Representer::Feature::Hypermedia::Hyperlink }
+
+          def to_hash(options)
+            super.tap do |hsh|  # TODO: cool: super(:exclude => [:rel]).
+              hsh.each { |k,v| v.delete(:rel) }
             end
           end
           
-          def from_hash(json, *)
-            json ||= {} # since we override #from_hash we're responsible for this.
-            json.each do |k, v|
-              self << Feature::Hypermedia::Hyperlink.new(v.merge :rel => k)
+
+          def from_hash(hash, options={})
+            hash.each { |k,v| hash[k] = LinkArray.new(v) if is_array?(k) }
+            
+            hsh = super(hash) # this is where :class and :extend do the work.
+
+            hsh.each { |k, v| v.rel = k }
+          end
+        end
+
+        class LinkArray < Array
+          def rel
+            first.rel
+          end
+
+          def rel=(rel)
+            each { |lnk| lnk.rel = rel }
+          end
+        end
+
+        require 'representable/json/collection'
+        module LinkArrayRepresenter
+          include Representable::JSON::Collection
+
+          items :extend => Roar::Representer::JSON::HyperlinkRepresenter,
+            :class => Roar::Representer::Feature::Hypermedia::Hyperlink
+
+          def to_hash(*)
+            super.tap do |ary|
+              ary.each { |lnk| rel = lnk.delete(:rel) }
             end
-            self
           end
         end
-        
-        
+
+
         module ClassMethods
+          # TODO: remove Links support in non-HAL.
           def links_definition_options
-            super.tap { |options| options[1] = {:class => Feature::Hypermedia::LinkCollection, :extend => LinkCollectionRepresenter} }
+            super.tap { |options|
+              options[0] = :links
+              options[1] = {:class => Feature::Hypermedia::LinkCollection, :extend => LinkCollectionRepresenter, :from => :_links} 
+            }
+
+          end
+
+          # Use this to define link arrays. It accepts the shared rel attribute and an array of options per link object.
+          #
+          #   links :self do
+          #     [{:lang => "en", :href => "http://en.hit"}, 
+          #      {:lang => "de", :href => "http://de.hit"}]
+          #   end
+          def links(options, &block)
+            options = {:rel => options} if options.is_a?(Symbol)
+            options[:array] = true  # FIXME: we need to save this information somewhere.
+            link(options, &block)
           end
         end
       end

data/lib/roar/representer/transport/faraday.rb

@@ -1,9 +1,4 @@
-begin
-  require 'faraday'
-rescue LoadError
-  puts 'You must add faraday as a dependency to use the FaradayTransport'
-end
-require 'logger'
+require 'faraday'
 
 module Roar
   module Representer
@@ -23,15 +18,15 @@ module Roar
         end
 
         def post_uri(uri, body, as)
-          build_connection(uri, as).post
+          build_connection(uri, as).post(nil, body)
         end
 
         def put_uri(uri, body, as)
-          build_connection(uri, as).put
+          build_connection(uri, as).put(nil, body)
         end
 
         def patch_uri(uri, body, as)
-          build_connection(uri, as).patch
+          build_connection(uri, as).patch(nil, body)
         end
 
         def delete_uri(uri, as)
@@ -43,9 +38,8 @@ module Roar
         def build_connection(uri, as)
           ::Faraday::Connection.new(
             :url => uri,
-            :headers => { :accept => as }
+            :headers => { :accept => as, :content_type => as }
           ) do |builder|
-            # builder.use Faraday::Response::Logger, Logger.new('faraday.log')
             builder.use ::Faraday::Response::RaiseError
             builder.adapter ::Faraday.default_adapter
           end

data/lib/roar/representer/transport/net_http.rb

@@ -11,23 +11,23 @@ module Roar
         def get_uri(uri, as)
           do_request(Net::HTTP::Get, uri, as)
         end
-        
+
         def post_uri(uri, body, as)
           do_request(Net::HTTP::Post, uri, as, body)
         end
-        
+
         def put_uri(uri, body, as)
           do_request(Net::HTTP::Put, uri, as, body)
         end
-        
+
         def patch_uri(uri, body, as)
           do_request(Net::HTTP::Patch, uri, as, body)
         end
-        
+
         def delete_uri(uri, as)
           do_request(Net::HTTP::Delete, uri, as)
         end
-      
+
       private
         def do_request(what, uri, as, body="")
           # DISCUSS: can this be made easier?

data/lib/roar/representer/xml.rb

@@ -16,42 +16,42 @@ module Roar
           include InstanceMethods # otherwise Representable overrides our #to_xml.
         end
       end
-      
+
       module InstanceMethods
         def to_xml(*args)
           before_serialize(*args)
           super
         end
-        
+
         # Generic entry-point for rendering.
         def serialize(*args)
           to_xml(*args)
         end
-        
+
         def deserialize(*args)
           from_xml(*args)
         end
       end
-      
-      
+
+
       module ClassMethods
         include Representable::XML::ClassMethods
-        
+
         def links_definition_options
-          [:links, {:from => :link, :class => Feature::Hypermedia::Hyperlink, :collection => true, :extend => XML::HyperlinkRepresenter}]
+          [:links_array, {:from => :link, :class => Feature::Hypermedia::Hyperlink, :collection => true, :extend => XML::HyperlinkRepresenter}]
         end
-        
+
         # Generic entry-point for parsing.
         def deserialize(*args)
           from_xml(*args)
         end
       end
-      
-      
+
+
       require 'representable/xml/hash'
       module HyperlinkRepresenter
         include Representable::XML::AttributeHash
-        
+
         self.representation_wrap = :link
       end
     end

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "0.11.4"
+  VERSION = "0.11.5"
 end

data/roar.gemspec

@@ -18,9 +18,9 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
   s.add_runtime_dependency "representable", ">= 1.2.8"
-  
+
   s.add_development_dependency "rake"
   s.add_development_dependency "test_xml"
   s.add_development_dependency "minitest",	">= 2.8.1"

data/test/client_test.rb

@@ -9,10 +9,10 @@ class ClientTest < MiniTest::Spec
         property :name
         property :band
       end
-      
+
       @song = Object.new.extend(@representer)
     end
-    
+
     it "should add accessors" do
       @song.extend Roar::Representer::Feature::Client
       @song.name = "Social Suicide"

data/test/coercion_feature_test.rb

@@ -6,10 +6,10 @@ class CoercionFeatureTest < MiniTest::Spec
     class ImmigrantSong
       include Roar::Representer::JSON
       include Roar::Representer::Feature::Coercion
-      
+
       property :composed_at, :type => DateTime, :default => "May 12th, 2012"
     end
-    
+
     it "coerces into the provided type" do
       song = ImmigrantSong.new.from_json("{\"composed_at\":\"November 18th, 1983\"}")
       assert_equal DateTime.parse("Fri, 18 Nov 1983 00:00:00 +0000"), song.composed_at

data/test/dummy/app/controllers/albums_controller.rb

@@ -2,26 +2,26 @@ require 'roar/rails'
 
 class AlbumsController < ActionController::Base
   include Roar::Rails::ControllerMethods
-  
+
   respond_to :xml
   represents Album
-  
+
   def show
     @album = Album.find(params[:id])
     respond_with @album
   end
-  
+
   def create
     @album = Album.create(representation)
-    
+
     respond_with @album
   end
-  
+
   def update
     @album = Album.find(params[:id])
     @album.songs.delete_all # make PUT behave REST-compliant.
     @album.update_attributes(representation)
-    
+
     respond_with @album
   end
 end

data/test/dummy/app/models/album.rb

@@ -1,6 +1,6 @@
 class Album < ActiveRecord::Base
   has_many :songs
   validates_presence_of :year
-  
+
   accepts_nested_attributes_for :songs, :allow_destroy => true
 end