roar 0.0.1.alpha1 → 0.8.0

data/test/model_representing_test.rb

@@ -0,0 +1,121 @@
+require 'test_helper'
+require 'roar/representer/feature/model_representing'
+
+class ModelRepresentingTest < MiniTest::Spec
+  describe "ModelRepresenting" do
+    class ItemRepresenter < Roar::Representer::XML
+      include Roar::Representer::Feature::ModelRepresenting # TODO: move to abstract!
+      self.representation_name= :item
+      representable_property :value
+    end
+    
+    class PositionRepresenter < Roar::Representer::XML
+      include Roar::Representer::Feature::ModelRepresenting # TODO: move to abstract! 
+      self.representation_name= :position
+      representable_property :id
+      representable_property :item, :as => ItemRepresenter
+    end
+    
+    class OrderRepresenter < Roar::Representer::XML
+      include Roar::Representer::Feature::ModelRepresenting # TODO: move to abstract!
+      self.representation_name= :order
+      representable_property :id
+      representable_property :items, :as => [ItemRepresenter]
+    end
+    
+    describe "#definition_class" do
+      it "returns ModelDefinition" do
+        assert_equal Roar::Representer::Feature::ModelRepresenting::ModelDefinition, OrderRepresenter.send(:definition_class)
+      end
+      
+    end
+    
+    describe "#for_model" do
+      it "copies represented model attributes, nothing more" do
+        @o = Position.new("id" => 1, "item" => Item.new("value" => "Beer"))
+        
+        @r = PositionRepresenter.for_model(@o)
+        assert_kind_of PositionRepresenter, @r
+        assert_equal 1, @r.id
+        
+        @i = @r.item
+        assert_kind_of ItemRepresenter, @i
+        assert_equal "Beer", @i.value
+      end
+      
+      it "copies the model to @represented" do
+        @o = Position.new("id" => 1, "item" => @i = Item.new("value" => "Beer"))
+        
+        @r = PositionRepresenter.for_model(@o)
+        assert_equal @o, @r.represented
+        assert_equal @i, @r.item.represented
+      end
+      
+      
+      it "works with Hyperlink attributes" do
+        @c = Class.new(ItemRepresenter) do
+          link :self do "http://self" end
+        end
+        
+        assert_equal({"value"=>"Beer", "links"=>[{"rel"=>:self, "href"=>"http://self"}]}, @c.for_model(Item.new("value" => "Beer")).to_attributes)
+      end
+      
+    end
+    
+    describe "#serialize_model" do
+      it "skips empty :item" do
+        @o = Position.new("id" => 1)
+        assert_xml_equal "<position><id>1</id></position>", PositionRepresenter.serialize_model(@o)
+      end
+      
+      it "skips empty [:items]" do
+        assert_xml_equal "<order><id>1</id></order>", OrderRepresenter.serialize_model(Order.new("id" => 1))
+      end
+      
+      it "serializes the model" do
+        @o = Order.new("id" => 1, "items" => [Item.new("value" => "Beer")])
+        assert_xml_equal %{
+<order>
+  <id>1</id>
+  <item>
+    <value>Beer</value>
+  </item>
+</order>}"", OrderRepresenter.serialize_model(@o)
+      end
+      
+    end
+    
+    describe "#to_nested_attributes" do
+      it "provides a AR-compatible hash" do
+        @o = Order.new("id" => 1, "items" => [Item.new("value" => "Beer")])
+        @r = OrderRepresenter.for_model(@o)
+        
+        OrderRepresenter.class_eval do
+          include Roar::Representer::Feature::ActiveRecordMethods
+        end
+        assert_equal({"id" => 1, "items_attributes" => [{"value" => "Beer"}]}, @r.to_nested_attributes) # DISCUSS: overwrite #to_attributes.
+      end
+      
+      it "doesn't include :links" do
+        @o = Order.new("id" => 1, "items" => [Item.new("value" => "Beer")])
+        
+        
+        
+        OrderRepresenter.class_eval do
+          include Roar::Representer::Feature::ActiveRecordMethods
+          link :self do
+        #    "bla"
+          end
+        end
+        ItemRepresenter.class_eval do
+          link :self do
+            
+          end
+        end
+        @r = OrderRepresenter.for_model(@o)
+        
+        assert_equal({"id" => 1, "items_attributes" => [{"value" => "Beer"}]}, @r.to_nested_attributes) # DISCUSS: overwrite #to_attributes.
+      end
+    end
+  end
+end

data/test/model_test.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+class ModelTest < MiniTest::Spec
+  describe "HttpVerbs" do
+    before do
+      @klass = Class.new(TestModel) do
+        include Roar::Model::HttpVerbs
+        
+        self.resource_base = "http://localhost:9999/test/"
+      end
+      @o = @klass.new
+    end
+    
+    it "has resource_base* accessors for setting the uri base path" do
+      assert_equal "http://localhost:9999/test/", @klass.resource_base
+    end
+    
+    it ".get returns deserialized object from " do
+      assert_equal({"id" => "4711"},  @klass.get(4711).attributes)
+    end
+  end
+  
+  
+  describe "The Model API" do
+    class Dog
+      include Roar::Model
+      
+      accessors :name
+    end
+      
+    before do
+      @klass = Dog
+    end
+    
+    it "the constructor accepts attributes" do
+      assert_equal({"id" => "4711"},  @klass.new({"id" => "4711"}).attributes)
+    end
+    
+    it "responds to .model_name" do
+      assert_equal "model_test/dog", @klass.model_name
+    end
+    
+    it "lets .accessors create accessors" do
+      @o = @klass.new({"name" => "Joe"})
+      assert_equal "Joe", @o.name
+      @o.name= "Noe"
+      assert_equal "Noe", @o.name
+    end
+  end
+end

data/test/order_representers.rb

@@ -0,0 +1,34 @@
+require 'roar/representer/json'
+require 'roar/representer/feature/http_verbs'
+require 'roar/representer/feature/hypermedia'
+
+module JSON
+  
+  class Item < Roar::Representer::JSON
+    property :article_id
+    property :amount
+    
+    include Roar::Representer::Feature::HttpVerbs
+    include Roar::Representer::Feature::Hypermedia
+  end
+  
+  
+  class Order < Roar::Representer::JSON
+    property :client_id
+    collection :items, :as => Item
+    
+    
+    include Roar::Representer::Feature::HttpVerbs
+    include Roar::Representer::Feature::Hypermedia
+    
+    
+    link :items do
+      items_url
+    end
+    
+    link :self do
+      order_url(represented)
+    end
+  end
+  
+end

data/test/proxy_test.rb

@@ -0,0 +1,89 @@
+require 'test_helper'
+
+class ProxyTest < MiniTest::Spec
+  describe "Transport" do
+    before do
+      @klass = Class.new(Object) do
+        include Roar::Client::Transport
+      end
+      @o = @klass.new
+    end
+    
+    it "#get_uri returns Restfulie response" do
+      assert_equal "<test><id>4711</id></test>",  @o.get_uri("http://localhost:9999/test/4711").body
+    end
+  end
+  
+  
+  describe "The public Proxy API" do
+    before do
+      @klass = Class.new(TestModel) do
+        extend Roar::Client::Proxy
+      end
+    end
+    
+    it "responds to .get_model" do
+      @o = @klass.get_model("http://localhost:9999/test/1", TestModel)
+      assert_kind_of TestModel, @o
+      assert_equal({"id" => "1"}, @o.attributes)
+    end
+  end
+  
+  describe "EntityProxy" do
+    before do
+      Proxy = Roar::Client::EntityProxy
+      @proxy_class = Proxy.class_for(:class => TestModel)
+    end
+    
+    it ".class_for returns an EntityProxy subclass" do
+      @proxy = @proxy_class.new
+      assert_kind_of Proxy, @proxy
+    end
+    
+    it "responds to .options" do
+      assert_equal({:class => TestModel}, @proxy_class.send(:options))
+    end
+    
+    it "doesn't override superclass options" do
+      assert_equal nil, Proxy.options
+    end
+    
+    it "responds to .from_attributes and responds to #original_attributes" do
+      assert_equal({:urn => "urn:item"}, @proxy_class.from_attributes(:urn => "urn:item").send(:original_attributes))
+    end
+    
+    it "responds to .model_name with the proxied name" do
+      assert_equal "test", @proxy_class.model_name
+    end
+    
+    # finalize!
+    describe "#finalize!" do
+      before do
+        @o = @proxy_class.from_attributes("uri" => "http://localhost:9999/test/1")
+      end
+      
+      it "responds to #proxied_resource" do
+        assert_nil @o.send(:proxied_resource)
+      end
+      
+      it "#finalize! retrieves proxied resource" do
+        @o.finalize!
+        assert_kind_of TestModel, @o.send(:proxied_resource)
+      end
+      
+      # delegation:
+      it "#attributes are delegated" do
+        @o.finalize!
+        assert_equal({"id" => "1"}, @o.attributes)
+      end
+      
+      it "#to_xml renders the unproxied entity" do
+        assert_equal "<test>\n  <uri>http://localhost:9999/test/1</uri>\n</test>\n", @o.to_xml
+      end
+      
+      it "#attributes_for_xml returns the unfinalized EntityProxy#attributes hash" do
+        assert_equal({"uri"=>"http://localhost:9999/test/1"}, @o.attributes_for_xml)
+      end
+    end
+  end
+end

data/test/rails/controller_methods_test.rb

@@ -0,0 +1,147 @@
+require 'test_helper'
+require 'roar/rails/test_case'
+require "dummy/config/environment"
+require "rails/test_help" # adds stuff like @routes, etc.
+
+module Representer
+  module BMP
+    class Album; end
+  end
+end
+    
+class ControllerMethodsTest < ActionController::TestCase
+  tests AlbumsController
+  
+  test "responds to #responder" do
+    assert_equal Roar::Rails::ControllerMethods::Responder, @controller.class.responder
+  end
+  
+  test "responds to #represents" do
+    @controller = Class.new(AlbumsController)
+    assert_equal Album, @controller.represented_class
+    @controller.represents Song
+    assert_equal Song, @controller.represented_class
+  end
+  
+  test "responds to #representer_class_for" do
+    assert_equal Representer::BMP::Album, @controller.representer_class_for(Album, :bmp)
+  end
+  
+  test "responds to #representation" do
+    post :create, %{<album>
+      <year>2011</year>
+      <song>
+        <title>Walking In Your Footsteps</title>
+      </song>
+    </album>}, :format => :xml
+    
+     
+    assert_equal({"id"=>"", "year"=>"2011",
+      "songs_attributes"=>[{"title"=>"Walking In Your Footsteps"}]}, @controller.representation)
+  end
+  
+  test "responds to #incoming" do
+    post :create, %{<album>
+      <year>2011</year>
+      <song>
+        <title>Walking In Your Footsteps</title>
+      </song>
+    </album>}, :format => :xml
+    
+     
+    assert_equal({"id"=>"", "year"=>"2011",
+      "songs"=>[{"title"=>"Walking In Your Footsteps"}], "links"=>[]}, @controller.incoming.to_attributes)
+  end
+end
+
+
+class ControllerFunctionalTest < ActionController::TestCase
+  tests AlbumsController
+  
+  test "GET: returns a xml representation" do
+    get :show, :id => 1, :format => :xml
+    
+    assert_response 200
+    assert_body %{
+    <album>
+      <id>1</id>  
+      <year>2011</year>
+      <song>
+        <title>Alltax</title>
+      </song>
+      <song>
+        <title>Bali</title>
+      </song>
+      
+      <link rel="self"      href="http://test.host/albums/1" />
+      <link rel="album-search"  href="http://test.host/articles/starts_with/{query}" />
+    </album>}, :format => :xml
+  end
+  
+  test "POST: creates a new album and returns the xml representation" do
+    post :create, %{<album>
+      <year>1997</year>
+      <song>
+        <title>Cooler Than You</title>
+      </song>
+    </album>}, :format => :xml
+    
+    assert @album = Album.find(:last)
+    assert_equal "1997", @album.year
+    assert_equal "Cooler Than You", @album.songs.first.title
+    
+    assert_response 201, "Location" => album_url(@album) # Created
+    assert_body %{
+    <album>
+      <id>2</id>  
+      <year>1997</year>
+      <song>
+        <title>Cooler Than You</title>
+      </song>
+      
+      <link rel="self"      href="http://test.host/albums/2" />
+      <link rel="album-search"  href="http://test.host/articles/starts_with/{query}" />
+    </album>}, :format => :xml
+  end
+  
+  test "POST: invalid incoming representations yields to 422" do
+    post :create, :format => :xml
+    
+    assert_response 422  # Unprocessable Entity
+  end
+  
+  test "PUT: updates album and returns the xml representation" do
+    put :update, %{
+    <album>
+      <year>1997</year>
+      <song>
+        <title>Cooler Than You</title>
+      </song>
+      <song>
+        <title>Rubbing The Elf</title>
+      </song>
+    </album>}, :id => 1, :format => :xml
+    
+    assert @album = Album.find(1)
+    assert_equal "1997", @album.year
+    assert_equal 2, @album.songs.size
+    assert_equal "Cooler Than You", @album.songs.first.title
+    assert_equal "Rubbing The Elf", @album.songs.last.title
+    
+    assert_response 200
+    assert_body %{
+    <album>
+      <id>1</id>
+      <year>1997</year>
+      <song>
+        <title>Cooler Than You</title>
+      </song>
+      <song>
+        <title>Rubbing The Elf</title>
+      </song>
+      
+      <link rel="self"      href="http://test.host/albums/1" />
+      <link rel="album-search"  href="http://test.host/articles/starts_with/{query}" />
+    </album>}, :format => :xml
+  end
+end

data/test/rails/rails_representer_methods_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+require "dummy/config/environment"
+require 'roar/rails'
+
+module Representer
+  module JPG
+    class Song; end
+    class Album < Roar::Representer::XML; end
+  end
+end
+
+
+
+class RailsRepresenterMethodsTest < MiniTest::Spec
+  describe "Rails::RepresenterMethods" do
+    before do
+      @c = Representer::JPG::Album  # TODO: mix Rails into Base, not XML only.
+    end
+    
+    it "provides conventions for #collection" do
+      @c.collection :songs
+      
+      @d = @c.representable_attrs.first
+      assert_equal Representer::JPG::Song, @d.sought_type
+      assert @d.array?
+    end
+    
+    it "provides conventions for #representation_name" do
+      assert_equal "album", @c.representation_name
+    end
+  end
+end