roar 0.11.4 → 0.11.5

data/test/dummy/app/representers/representer/xml/album.rb

@@ -2,15 +2,15 @@ module Representer
   module XML
     class Album < Roar::Representer::XML
       self.representation_name= :album
-      
+
       property :id
       property :year
       collection :songs
-      
+
       link :self do
         album_url(represented.id)
       end
-      
+
       link "album-search" do
         album_search_url
       end

data/test/dummy/app/representers/representer/xml/song.rb

@@ -2,7 +2,7 @@ module Representer
   module XML
     class Song < Roar::Representer::XML
       self.representation_name= :song
-      
+
       property :title
     end
   end

data/test/dummy/config/boot.rb

@@ -7,4 +7,4 @@ if File.exist?(gemfile)
   Bundler.setup
 end
 
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/fake_server.rb

@@ -7,46 +7,45 @@ class FakeServer < Sinatra::Base
 
   module BandRepresenter
     include Roar::Representer::JSON
-    
+
     property :name
     property :label
   end
-  
+
   class Band
     attr_reader :name, :label
-    
+
     def name=(value)
       @name = value.upcase
     end
-    
+
     def label=(value)
       @label = value.upcase
     end
   end
-  
+
   def consume_band
     Band.new.extend(BandRepresenter).from_json(request.body.string)
   end
-  
-  
+
   get "/method" do
     "<method>get</method>"
   end
 
   post "/method" do
-    "<method>post</method>"
+    "<method>post - #{request.body.read}</method>"
   end
-  
+
   put "/method" do
-    "<method>put</method>"
+    "<method>put - #{request.body.read}</method>"
   end
-  
+
   delete "/method" do
     "<method>delete</method>"
   end
-  
+
   patch "/method" do
-    "<method>patch</method>"
+    "<method>patch - #{request.body.read}</method>"
   end
 
   get '/deliberate-error' do
@@ -56,10 +55,10 @@ class FakeServer < Sinatra::Base
   post "/bands" do
     #if request.content_type =~ /xml/
     body consume_band.to_json
-    
+
     status 201
   end
-  
+
   put "/bands/strungout" do
     # DISCUSS: as long as we don't agree on what to return in PUT/PATCH, let's return an updated document.
     body consume_band.to_json

data/test/faraday_http_transport_test.rb

@@ -3,28 +3,31 @@ require 'roar/representer/transport/faraday'
 
 class FaradayHttpTransportTest < MiniTest::Spec
   describe 'FaradayHttpTransport' do
+    let(:url) { "http://roar.example.com/method" }
+    let(:body) { "booty" }
+    let(:as) { "application/xml" }
     before do
       @transport = Roar::Representer::Transport::Faraday.new
     end
 
     it "#get_uri returns response" do
-      assert_equal "<method>get</method>",  @transport.get_uri("http://roar.example.com/method", "application/xml").body
+      @transport.get_uri(url, as).must_match_faraday_response :get, url, as
     end
 
     it "#post_uri returns response" do
-      assert_equal "<method>post</method>",  @transport.post_uri("http://roar.example.com/method", "booty", "application/xml").body
+      @transport.post_uri(url, body, as).must_match_faraday_response :post, url, as, body
     end
 
     it "#put_uri returns response" do
-      assert_equal "<method>put</method>",  @transport.put_uri("http://roar.example.com/method", "booty", "application/xml").body
+      @transport.put_uri(url, body, as).must_match_faraday_response :put, url, as, body
     end
 
     it "#delete_uri returns response" do
-      assert_equal "<method>delete</method>",  @transport.delete_uri("http://roar.example.com/method", "application/xml").body
+      @transport.delete_uri(url, as).must_match_faraday_response :delete, url, as
     end
 
     it "#patch_uri returns response" do
-      assert_equal "<method>patch</method>",  @transport.patch_uri("http://roar.example.com/method", "booty", "application/xml").body
+      @transport.patch_uri(url, body, as).must_match_faraday_response :patch, url, as, body
     end
 
     describe 'non-existent resource' do
@@ -34,25 +37,25 @@ class FaradayHttpTransportTest < MiniTest::Spec
 
       it '#get_uri raises a ResourceNotFound error' do
         assert_raises(Faraday::Error::ResourceNotFound) do
-          @transport.get_uri(@not_found_url, "application/xml").body
+          @transport.get_uri(@not_found_url, as).body
         end
       end
 
       it '#post_uri raises a ResourceNotFound error' do
         assert_raises(Faraday::Error::ResourceNotFound) do
-          @transport.post_uri(@not_found_url, 'crisis', "application/xml").body
+          @transport.post_uri(@not_found_url, body, as).body
         end
       end
 
       it '#post_uri raises a ResourceNotFound error' do
         assert_raises(Faraday::Error::ResourceNotFound) do
-          @transport.post_uri(@not_found_url, 'crisis', "application/xml").body
+          @transport.post_uri(@not_found_url, body, as).body
         end
       end
 
       it '#delete_uri raises a ResourceNotFound error' do
         assert_raises(Faraday::Error::ResourceNotFound) do
-          @transport.delete_uri(@not_found_url, "application/xml").body
+          @transport.delete_uri(@not_found_url, as).body
         end
       end
     end
@@ -60,10 +63,22 @@ class FaradayHttpTransportTest < MiniTest::Spec
     describe 'server errors (500 Internal Server Error)' do
       it '#get_uri raises a ClientError' do
         assert_raises(Faraday::Error::ClientError) do
-          @transport.get_uri('http://roar.example.com/deliberate-error', "application/xml").body
+          @transport.get_uri('http://roar.example.com/deliberate-error', as).body
         end
       end
     end
 
   end
 end
+
+module MiniTest::Assertions
+
+  def assert_faraday_response(type, response, url, as, body = nil)
+    headers = response.env[:request_headers]
+    assert_equal [as, as], [headers["Accept"], headers["Content-Type"]]
+    assert_equal "<method>#{type}#{(' - ' + body) if body}</method>", response.body
+  end
+
+end
+
+Faraday::Response.infect_an_assertion :assert_faraday_response, :must_match_faraday_response

data/test/hal_json_test.rb

@@ -2,37 +2,65 @@ require 'test_helper'
 require 'roar/representer/json/hal'
 
 class HalJsonTest < MiniTest::Spec
-  module SongRepresenter
-    include Roar::Representer::JSON
-    include Roar::Representer::JSON::HAL::Links
-    
-    link :self do
-      "http://self"
-    end
-    
-    link :rel => :next, :title => "Hey, @myabc" do
-      "http://hit"
+  let(:rpr) do
+    Module.new do
+      include Roar::Representer::JSON
+      include Roar::Representer::JSON::HAL
+
+      links :self do
+        [{:lang => "en", :href => "http://en.hit"}, 
+         {:lang => "de", :href => "http://de.hit"}]
+      end
+
+      link :next do
+        "http://next"
+      end
     end
   end
-  
-  describe "JSON::HAL::Links" do
-    before do
-      @song = Object.new.extend(SongRepresenter)
+
+  subject { Object.new.extend(rpr) }
+
+  describe "#links" do
+    it "parses link array" do # TODO: remove me.
+      obj = subject.from_json("{\"_links\":{\"self\":[{\"lang\":\"en\",\"href\":\"http://en.hit\"},{\"lang\":\"de\",\"href\":\"http://de.hit\"}]}}")
+      obj.links.must_equal "self" => [link(:rel => :self, :href => "http://en.hit", :lang => :en), link(:rel => :self, :href => "http://de.hit", :lang => :de)]
+    end
+
+    it "parses single links" do # TODO: remove me.
+      obj = subject.from_json("{\"_links\":{\"next\":{\"href\":\"http://next\"}}}")
+      obj.links.must_equal "next" => link(:rel => :next, :href => "http://next")
+    end
+
+    it "parses link and link array" do
+      obj = subject.from_json("{\"_links\":{\"next\":{\"href\":\"http://next\"}, \"self\":[{\"lang\":\"en\",\"href\":\"http://en.hit\"},{\"lang\":\"de\",\"href\":\"http://de.hit\"}]}}")
+      obj.links.must_equal "next" => link(:rel => :next, :href => "http://next"), "self" => [link(:rel => :self, :href => "http://en.hit", :lang => :en), link(:rel => :self, :href => "http://de.hit", :lang => :de)]
+    end
+
+    it "rejects single links declared as array when parsing" do
+      assert_raises TypeError do
+        subject.from_json("{\"_links\":{\"self\":{\"href\":\"http://next\"}}}")
+      end      
+    end
+
+    it "renders link and link array" do
+      subject.to_json.must_equal "{\"_links\":{\"self\":[{\"lang\":\"en\",\"href\":\"http://en.hit\"},{\"lang\":\"de\",\"href\":\"http://de.hit\"}],\"next\":{\"href\":\"http://next\"}}}"
     end
-    
-    it "renders links according to the HAL spec" do
-      assert_equal "{\"links\":{\"self\":{\"href\":\"http://self\"},\"next\":{\"title\":\"Hey, @myabc\",\"href\":\"http://hit\"}}}", @song.to_json
+  end
+
+  describe "#prepare_links!" do
+    it "should map link arrays correctly" do
+      subject.send :prepare_links!
+      subject.links.must_equal "self" => [link(:rel => :self, :href => "http://en.hit", :lang => "en"),link(:rel => :self, :href => "http://de.hit", :lang => "de")], "next" => link(:href => "http://next", :rel => :next)
     end
-    
-    it "parses incoming JSON links correctly" do
-      @song.from_json "{\"links\":{\"self\":{\"href\":\"http://self\",\"title\":\"Hey, @myabc\"}}}"
-      assert_equal "http://self", @song.links[:self].href
-      assert_equal "Hey, @myabc", @song.links[:self].title
-      assert_equal nil, @song.links[:next]
+  end
+
+  describe "#link_array_rels" do
+    it "returns list of rels for array links" do
+      subject.send(:link_array_rels).must_equal [:self]
     end
   end
-  
-  
+
+
   describe "HAL/JSON" do
     before do
       Bla = Module.new do
@@ -42,7 +70,7 @@ class HalJsonTest < MiniTest::Spec
           "http://items/#{value}"
         end
       end
-      
+
       @order_rep = Module.new do
         include Roar::Representer::JSON::HAL
         property :id
@@ -51,14 +79,14 @@ class HalJsonTest < MiniTest::Spec
           "http://orders/#{id}"
         end
       end
-      
+
       @order = Order.new(:items => [Item.new(:value => "Beer")], :id => 1).extend(@order_rep)
     end
-    
+
     it "render links and embedded resources according to HAL" do
       assert_equal "{\"id\":1,\"_embedded\":{\"items\":[{\"value\":\"Beer\",\"_links\":{\"self\":{\"href\":\"http://items/Beer\"}}}]},\"_links\":{\"self\":{\"href\":\"http://orders/1\"}}}", @order.to_json
     end
-    
+
     it "parses links and resources following the mighty HAL" do
       @order.from_json("{\"id\":2,\"_embedded\":{\"items\":[{\"value\":\"Coffee\",\"_links\":{\"self\":{\"href\":\"http://items/Coffee\"}}}]},\"_links\":{\"self\":{\"href\":\"http://orders/2\"}}}")
       assert_equal 2, @order.id
@@ -66,12 +94,26 @@ class HalJsonTest < MiniTest::Spec
       assert_equal "http://items/Coffee", @order.items.first.links[:self].href
       assert_equal "http://orders/2", @order.links[:self].href
     end
-    
+
     it "doesn't require _links and _embedded to be present" do
       @order.from_json("{\"id\":2}")
       assert_equal 2, @order.id
       assert_equal [], @order.items
-      assert_equal [], @order.links
+      @order.links.must_equal({})
     end
   end
 end
+
+class LinkCollectionTest < MiniTest::Spec
+  subject { Roar::Representer::JSON::HAL::LinkCollection.new([:self, "next"]) }
+  describe "#is_array?" do
+    it "returns true for array link" do
+      subject.is_array?(:self).must_equal true
+      subject.is_array?("self").must_equal true
+    end
+
+    it "returns false otherwise" do
+      subject.is_array?("prev").must_equal false
+    end
+  end
+end

data/test/http_verbs_feature_test.rb

@@ -4,38 +4,38 @@ require 'roar/representer/json'
 
 class HttpVerbsTest < MiniTest::Spec
   BandRepresenter = FakeServer::BandRepresenter
-  
+
   # keep this class clear of Roar modules.
   class Band
     attr_accessor :name, :label
   end
-  
-  
+
+
   describe "HttpVerbs" do
     before do
       @band = Band.new
       @band.extend(BandRepresenter)
       @band.extend(Roar::Representer::Feature::HttpVerbs)
     end
-    
+
     describe "transport_engine" do
       before do
         @http_verbs = Roar::Representer::Feature::HttpVerbs
         @net_http   = Roar::Representer::Transport::NetHTTP
       end
-      
+
       it "has a default set in the transport module level" do
         assert_equal @net_http, @band.transport_engine
       end
-      
+
       it "allows changing on instance level" do
         @band.transport_engine = :soap
         assert_equal @net_http, @http_verbs.transport_engine
         assert_equal :soap, @band.transport_engine
       end
     end
-    
-    
+
+
     describe "HttpVerbs.get" do
       it "returns instance from incoming representation" do
         band = @band.get("http://roar.example.com/bands/slayer", "application/json")
@@ -68,18 +68,18 @@ class HttpVerbsTest < MiniTest::Spec
         assert_equal "Canadian Maple", @band.label
       end
     end
-    
+
     describe "#post" do
       it "updates instance with incoming representation" do
         @band.name = "Strung Out"
         assert_equal nil, @band.label
-        
+
         @band.post("http://roar.example.com/bands", "application/xml")
         assert_equal "STRUNG OUT", @band.name
         assert_equal nil, @band.label
       end
     end
-    
+
     describe "#put" do
       it "updates instance with incoming representation" do
         @band.name   = "Strung Out"
@@ -89,7 +89,7 @@ class HttpVerbsTest < MiniTest::Spec
         assert_equal "FAT WRECK", @band.label
       end
     end
-    
+
     describe "#patch" do
       it 'does something' do
         @band.label  = 'Fat Mike'

data/test/hypermedia_feature_test.rb

@@ -4,59 +4,11 @@ require 'roar/representer/json'
 
 class HypermediaTest
   describe "Hypermedia Feature" do
-    describe "Hypermedia.link" do
-      before do
-        @mod = Module.new do
-          include Roar::Representer::JSON
-          include Roar::Representer::Feature::Hypermedia
-        end
-      end
-
-      it "accepts rel symbol, only" do
-        @mod.class_eval do
-          link :self do
-            "http://self"
-          end
-        end
-
-        assert_equal "{\"links\":[{\"rel\":\"self\",\"href\":\"http://self\"}]}", Object.new.extend(@mod).to_json
-      end
-
-      it "accepts any options" do
-        @mod.class_eval do
-          link :rel => :self, :title => "Hey, @myabc" do
-            "http://self"
-          end
-        end
-
-        assert_equal "{\"links\":[{\"rel\":\"self\",\"title\":\"Hey, @myabc\",\"href\":\"http://self\"}]}", Object.new.extend(@mod).to_json
-      end
-      
-      it "receives options from to_*" do
-        @mod.class_eval do
-          link :self do |opts|
-            "http://self/#{opts[:id]}"
-          end
-        end
-
-        assert_equal "{\"links\":[{\"rel\":\"self\",\"href\":\"http://self/1\"}]}", Object.new.extend(@mod).to_json(:id => 1)
-      end
-
-      it "supports returning hash" do
-        @mod.class_eval do
-          link :self do
-            {:href => "http://self", :type => "image/jpg"}
-          end
-        end
-
-        assert_equal "{\"links\":[{\"rel\":\"self\",\"href\":\"http://self\",\"type\":\"image/jpg\"}]}", Object.new.extend(@mod).to_json
-      end
-    end
 
 
     before do
       @bookmarks = Class.new do
-        include AttributesContructor
+        include AttributesConstructor
         include Roar::Representer::XML
         include Roar::Representer::Feature::Hypermedia
 
@@ -111,7 +63,7 @@ class HypermediaTest
 
       it "sets up links even when nested" do
         class Page
-          include AttributesContructor
+          include AttributesConstructor
           include Roar::Representer::JSON
           property :note, :class => Note
           attr_accessor :note
@@ -133,109 +85,52 @@ class HypermediaTest
 
         assert_kind_of Roar::Representer::Feature::Hypermedia::LinkCollection, doc.links
         assert_equal 1, doc.links.size
-        assert_equal(["self", "http://bookmarks"], [doc.links.first.rel, doc.links.first.href])
+        assert_equal(["self", "http://bookmarks"], [doc.links_array.first.rel, doc.links_array.first.href])
       end
 
       it "sets up an empty link list if no links found in the document" do
-        assert_equal [], @bookmarks_with_links.from_xml(%{<bookmarks/>}).links
+        assert_equal [], @bookmarks_with_links.from_xml(%{<bookmarks/>}).links_array
       end
     end
 
 
     describe "#links" do
-      before do
-        @set  = @bookmarks.new
-        hyper = Roar::Representer::Feature::Hypermedia::Hyperlink
-
-        @set.links = [
-          {:rel => "self", :href => "http://self"},
-          {:rel => "next", :href => "http://next"}].collect do |config|
-            link = hyper.new
-            link.rel  = config[:rel]
-            link.href = config[:href]
-            link
-          end
-      end
+      subject { Object.new.extend(rpr).tap do |obj|
+        obj.send :prepare_links!
+      end }
 
-      describe "#links=" do
-        it "wraps links in a LinkCollection" do
-          assert_kind_of Roar::Representer::Feature::Hypermedia::LinkCollection, @set.links
-          assert_equal 2, @set.links.size
-        end
+      representer_for do
+        link(:self) { "//self" }
+        link(:next) { "//next" }
       end
 
-      describe "#link[]" do
         it "returns link object" do
-          assert_equal "http://self", @set.links["self"].href
-          assert_equal "http://self", @set.links[:self].href
-          assert_equal "http://next", @set.links[:next].href
-          assert_equal nil, @set.links[:prev]
-        end
-      end
-
-      it "returns an empty list when no links present" do
-        assert_equal Roar::Representer::Feature::Hypermedia::LinkCollection.new, @bookmarks.new.links
-      end
-    end
-
-
-    describe "#find_links_definition" do
-      it "returns Definition if links are present" do
-        @bookmarks.class_eval do
-          property :id
-          link :self
+          subject.links["self"].href.must_equal "//self"
+          subject.links[:self].href.must_equal "//self"
+          subject.links[:next].href.must_equal "//next"
+          subject.links["unknown"].must_equal nil
         end
 
-        assert_equal "links", @bookmarks.find_links_definition.name
-      end
-
-      it "returns nil if no links defined" do
-        assert_equal nil, @bookmarks.find_links_definition
-      end
+#      it "returns an empty list when no links present" do
+ #       assert_equal Roar::Representer::Feature::Hypermedia::LinkCollection.new, @bookmarks.new.links
+  #    end
     end
   end
 end
 
-class LinksDefinitionTest < MiniTest::Spec
-  describe "LinksDefinition" do
-    before do
-      @d = Roar::Representer::Feature::Hypermedia::LinksDefinition.new(:links)
-    end
-
-    it "accepts options in constructor" do
-      assert_equal [], @d.rel2block
-    end
-
-    it "accepts configuration" do
-      @d.rel2block << {:rel => :self}
-      assert_equal [{:rel=>:self}], @d.rel2block
-    end
-    
-    it "responds to #clone" do
-      @d.rel2block << {:rel => :self}
-      assert @d.clone.rel2block.object_id != @d.rel2block.object_id
-    end
-    
-    
-    it "responds to #each to iterate rel2block" do
-    end
-
-  end
-end
 
 class LinkCollectionTest < MiniTest::Spec
   describe "LinkCollection" do
-    it "provides #update_link" do
-      collection  = Roar::Representer::Feature::Hypermedia::LinkCollection.new
-      link        = Roar::Representer::Feature::Hypermedia::Hyperlink.new
-      link.rel  = "self"
-      link.href = "http://self"
-
-      collection.update_link(link)
-      assert_equal 1, collection.size
-
-      collection.update_link(link)
-      assert_equal 1, collection.size
+    subject { Roar::Representer::Feature::Hypermedia::LinkCollection.new }
+    
+    describe "#add" do
+      it "keys by using rel string" do
+        subject.size.must_equal 0
+        subject.add(link = link(:rel => :self))
+        subject.values.must_equal [link]
+        subject.add(link = link(:rel => "self"))
+        subject.values.must_equal [link]
+      end
     end
   end
 end
@@ -243,30 +138,28 @@ end
 class HyperlinkTest < MiniTest::Spec
   Hyperlink = Roar::Representer::Feature::Hypermedia::Hyperlink
   describe "Hyperlink" do
-    before do
-      @link = Hyperlink.new(:rel => "self", "href" => "http://self", "data-whatever" => "Hey, @myabc")
-    end
+    subject { Hyperlink.new(:rel => "self", "href" => "http://self", "data-whatever" => "Hey, @myabc") }
 
     it "accepts string keys in constructor" do
-      assert_equal "Hey, @myabc", @link.send("data-whatever")
+      assert_equal "Hey, @myabc", subject.send("data-whatever")
     end
 
     it "responds to #rel" do
-      assert_equal "self", @link.rel
+      assert_equal "self", subject.rel
     end
 
     it "responds to #href" do
-      assert_equal "http://self", @link.href
+      assert_equal "http://self", subject.href
     end
-    
+
     it "responds to #replace with string keys" do
-      @link.replace("rel" => "next")
-      assert_equal nil, @link.href
-      assert_equal "next", @link.rel
+      subject.replace("rel" => "next")
+      assert_equal nil, subject.href
+      assert_equal "next", subject.rel
     end
-    
+
     it "responds to #each and implements Enumerable" do
-      assert_equal ["rel:self", "href:http://self", "data-whatever:Hey, @myabc"], @link.collect { |k,v| "#{k}:#{v}" }
+      assert_equal ["rel:self", "href:http://self", "data-whatever:Hey, @myabc"], subject.collect { |k,v| "#{k}:#{v}" }
     end
   end
 end
@@ -300,7 +193,7 @@ class HyperlinkInheritanceTest < MiniTest::Spec
 
     it "should inherit parent links" do
       foo = Object.new.extend(Foo)
-      
+
       assert_equal "{\"links\":[{\"rel\":\"base\",\"href\":\"http://base\"},{\"rel\":\"foo\",\"href\":\"http://foo\"}]}", foo.to_json
     end