roar 0.9.2 → 0.10.0

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm: 1.9.3
+notifications:
+  irc: "irc.freenode.org#cells"

data/CHANGES.markdown

@@ -1,27 +1,36 @@
-h2. 0.9.2
+## 0.10.0
+
+* Requiring representable-0.1.3.
+* Added JSON-HAL support.
+* Links are no longer rendered when `href` is `nil` or `false`.
+* `Representer.link` class method now accepts either the `rel` value, only, or a hash of link attributes (defined in `Hypermedia::Hyperlink.params`), like `link :rel => :self, :title => "You're good" do..`
+* API CHANGE: `Representer#links` no longer returns the `href` value but the link object. Use it like `object.links[:self].href` to retrieve the URL.
+* `#from_json` won't throw an exception anymore when passed an empty json document.
+
+## 0.9.2
 
 * Using representable-1.1.
 
-h2. 0.9.1
+## 0.9.1
 
 * Removed @Representer#to_attributes@ and @#from_attributes@.
 * Using representable-1.0.1 now.
 
-h2. 0.9.0
+## 0.9.0
 
 * Using representable-0.12.x.
 * `Representer::Base` is now simply `Representer`.
 * Removed all the class methods from `HttpVerbs` except for `get`.
 
 
-h2. 0.8.3
+## 0.8.3
 
 * Maintenance release for representable compat.
 
-h2. 0.8.2
+## 0.8.2
 
 * Removing `restfulie` dependency - we now use `Net::HTTP`.
 
-h2. 0.8.1
+## 0.8.1
 
 * Added the :except and :include options to `#from_*`.

data/README.textile

@@ -2,28 +2,14 @@ h1. ROAR
 
 _Resource-Oriented Architectures in Ruby._
 
-"Lets make documents suit our models and not models fit to documents."
-
-Questions? Need help? Free 1st Level Support on irc.freenode.org#roar !
-
 h2. Introduction
 
-REST is about representations. Representations are documents. Documents are pushed back and forth between clients and REST services. Roar focuses on providing object-oriented representations.
-
-Most REST gems provide a neat HTTP interface, automatic parsing of documents and a more or less convenient way for rendering representations. Roar is different. The central concept of Roar are *representers* - object-oriented documents suitable for parsing _and_ rendering, extendable at runtime and with hypermedia support. The Representer concept is the answer to the missing REST abstraction layer in most frameworks.
-
-
-h2. Features
-
-* OOP access to documents.
-* Parsing _and_ rendering of representations in one place.
-* Declaratively define document syntax and semantics.
-* Hypermedia support.
-* ActiveResource-like client support.
-* Useable in both client _and_ server.
-* Framework agnostic, runs with sinatra, Rails, webmachine and friends.
+Roar is a framework for parsing and rendering REST documents. Nothing more. With Roar, REST documents - also known as representations - are defined using a new concept called representers. Both syntax and semantics are declared in Ruby modules that can be mixed into your domain models, following clean OOP patterns.
 
+Roar comes with built-in JSON, JSON::HAL and XML support. It exposes a highly modular architecture and makes it very simple to add new media types and functionality where needed. Additional features include client HTTP support, coercion, client-side caching, awesome hypermedia support and more. Representers feel pretty well in DCI environments, too.
 
+Roar is completely framework-agnostic and loves being used in web kits like Rails, Webmachine, Sinatra, Padrino, etc. Actually, Roar makes it fun designing real, hypermedia-driven, and resource-oriented systems that will even make Steve sleep happily at night so he finally gets some REST! 
+ 
 h2. Example
 
 Say your webshop consists of two completely separated apps. The REST backend, a Sinatra app, serves articles and processes orders. The frontend, being browsed by your clients, is a rich Rails application. It queries the services for articles, renders them nicely and reads or writes orders with REST calls. That being said, the frontend turns out to be a pure REST client.
@@ -307,3 +293,6 @@ Making that system RESTful basically means
 # Do _not_ let the frontend compute any URLs to further actions.
 # Showing articles, creating a new order, adding articles to it and finally placing the order - this all requires further URLs. These URLs are embedded as _hypermedia_ in the representations sent by the REST backend.
 
+h2. Support
+
+Questions? Need help? Free 1st Level Support on irc.freenode.org#roar !

data/lib/roar/representer/feature/client.rb

@@ -0,0 +1,32 @@
+require "roar/representer/feature/http_verbs"
+
+module Roar
+  # Automatically add accessors for properties and collections. Also mixes in HttpVerbs.
+  module Representer
+    module Feature
+      module Client
+        include HttpVerbs
+        
+        def self.extended(base)
+          base.instance_eval do
+            representable_attrs.each do |attr|
+              next unless attr.instance_of? Representable::Definition # ignore hyperlinks etc for now.
+              name = attr.name
+              
+              # TODO: could anyone please make this better?
+              instance_eval %Q{
+                def #{name}=(v)
+                  @#{name} = v
+                end
+                
+                def #{name}
+                  @#{name}
+                end
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/roar/representer/feature/http_verbs.rb

@@ -27,7 +27,7 @@ module Roar
         # and updates properties accordingly.
         def post(url, format)
           # DISCUSS: what if a redirect happens here?
-          document = http.post_uri(url, serialize(:links => false), format).body
+          document = http.post_uri(url, serialize, format).body
           deserialize(document)
         end
         

data/lib/roar/representer/feature/hypermedia.rb

@@ -1,7 +1,7 @@
 module Roar
   module Representer
     module Feature
-      # Adds #link to the representer to define hypermedia links in the representation.
+      # Define hypermedia links in your representations.
       #
       # Example:
       #
@@ -13,6 +13,12 @@ module Roar
       #     link :self do
       #       "http://orders/#{id}"
       #     end
+      #
+      # If you want more attributes, just pass a hash to #link.
+      #
+      #     link :rel => :next, :title => "Next, please!" do
+      #       "http://orders/#{id}"
+      #     end
       module Hypermedia
         def self.included(base)
           base.extend ClassMethods
@@ -34,14 +40,13 @@ module Roar
       protected
         # Setup hypermedia links by invoking their blocks. Usually called by #serialize.
         def prepare_links!
-          links_def       = find_links_definition or return
-          hyperlink_class = links_def.sought_type
+          links_def = find_links_definition or return
           
-          links_def.rel2block.each do |link|
-            links.update_link(hyperlink_class.new.tap do |hyperlink|  # create Hyperlink representer.
-              hyperlink.rel   = link[:rel]
-              hyperlink.href  = run_link_block(link[:block])
-            end)
+          links_def.rel2block.each do |config|  # config is [{..}, block]
+            options = config.first
+            options[:href] = run_link_block(config.last) or next
+            
+            links.update_link(Feature::Hypermedia::Hyperlink.new(options))
           end
         end
         
@@ -56,7 +61,7 @@ module Roar
         
         class LinkCollection < Array
           def [](rel)
-            link = find { |l| l.rel.to_s == rel.to_s } and return link.href
+            link = find { |l| l.rel.to_s == rel.to_s } and return link
           end
           
           # Checks if the link is already contained by querying for its +rel+.
@@ -81,18 +86,23 @@ module Roar
           #
           # The block is executed in instance context, so you may call properties or other accessors.
           # Note that you're free to put decider logic into #link blocks, too.
-          def link(rel, &block)
-            unless links = find_links_definition
-              links = LinksDefinition.new(:links, links_definition_options)
-              representable_attrs << links
-            end
+          def link(options, &block)
+            links = find_links_definition || create_links
             
-            links.rel2block << {:rel => rel, :block => block}
+            options = {:rel => options} if options.is_a?(Symbol)
+            links.rel2block << [options, block]
           end
           
           def find_links_definition
             representable_attrs.find { |d| d.is_a?(LinksDefinition) }
           end
+          
+        private
+          def create_links
+            LinksDefinition.new(*links_definition_options).tap do |links|
+              representable_attrs << links
+            end
+          end
         end
         
         
@@ -102,6 +112,24 @@ module Roar
             @rel2block ||= []
           end
         end
+        
+        
+        # An abstract hypermedia link with +rel+, +href+ and other attributes.
+        # Overwrite the Hyperlink.params method if you need more link attributes.
+        class Hyperlink
+          def self.params
+            [:rel, :href, :media, :title, :hreflang]
+          end
+          
+          attr_accessor *params
+          
+          def initialize(options={})
+            options.each do |k,v|
+              next unless self.class.params.include?(k.to_sym)
+              instance_variable_set("@#{k}", v)
+            end
+          end
+        end
       end
     end
   end

data/lib/roar/representer/json.rb

@@ -1,4 +1,5 @@
 require 'roar/representer'
+require 'roar/representer/feature/hypermedia'
 require 'representable/json'
 
 module Roar
@@ -21,7 +22,7 @@ module Roar
         end
         
         def from_json(document, options={})
-          document ||= "{}" # DISCUSS: provide this for convenience, or better not?
+          document = '{}' if document.nil? or document.empty?
           
           super
         end
@@ -38,24 +39,23 @@ module Roar
       
       
       module ClassMethods
-        def deserialize(json)
-          from_json(json)
+        def deserialize(*args)
+          from_json(*args)
         end
         
         # TODO: move to instance method, or remove?
         def links_definition_options
-          {:class => Hyperlink , :collection => true}
+          [:links, {:class => Feature::Hypermedia::Hyperlink, :extend => HyperlinkRepresenter, :collection => true}]
         end
       end
       
       
-      # Encapsulates a hypermedia link.
-      class Hyperlink
+      # Represents a hyperlink in standard roar+json. 
+      module HyperlinkRepresenter
         include JSON
-        attr_accessor :rel, :href
-        
-        property :rel
-        property :href
+        Feature::Hypermedia::Hyperlink.params.each do |attr|
+          property attr
+        end
       end
     end
   end

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

@@ -0,0 +1,109 @@
+module Roar::Representer
+  module JSON
+    # Including the JSON::HAL module in your representer will render and parse documents
+    # following the HAL specification: http://stateless.co/hal_specification.html
+    # Links will be embedded using the +_links+ key, nested resources with the +_embedded+ key.
+    #
+    # Embedded resources can be specified when calling #property or +collection using the
+    # :embedded => true option.
+    #
+    # Example:
+    # 
+    #   module OrderRepresenter
+    #     include Roar::Representer::JSON::HAL
+    #     
+    #     property :id
+    #     collection :items, :class => Item, :extend => ItemRepresenter, :embedded => true
+    #
+    #     link :self do
+    #       "http://orders/#{id}"
+    #     end
+    #   end
+    #
+    # Renders to
+    #
+    #   "{\"id\":1,\"_embedded\":{\"items\":[{\"value\":\"Beer\",\"_links\":{\"self\":{\"href\":\"http://items/Beer\"}}}]},\"_links\":{\"self\":{\"href\":\"http://orders/1\"}}}"
+    module HAL
+      def self.included(base)
+        base.class_eval do
+          include Roar::Representer::JSON
+          include Links       # overwrites #links_definition_options.
+          extend ClassMethods # overwrites #links_definition_options, again.
+          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.definition.options[:embedded]
+          super(bin, doc[:_embedded] ||= {})
+        end
+        
+        def uncompile_fragment(bin, doc)
+          return super unless bin.definition.options[:embedded]
+          super(bin, doc["_embedded"])
+        end
+      end
+      
+      module ClassMethods
+        def links_definition_options
+          super.tap { |options| options[1].merge!({:from => :_links}) }
+        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
+      #
+      # Renders to
+      #
+      #   {"links":{"self":{"href":"http://self"}}}
+      #
+      # 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
+            extend Links::ClassMethods
+          end
+        end
+        
+        
+        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(:except => [:rel])
+              end
+            end
+          end
+          
+          def from_hash(json, *)
+            json.each do |k, v|
+              self << Feature::Hypermedia::Hyperlink.new(v.merge :rel => k)
+            end
+            self
+          end
+        end
+        
+        
+        module ClassMethods
+          def links_definition_options
+            super.tap { |options| options[1] = {:class => Feature::Hypermedia::LinkCollection, :extend => LinkCollectionRepresenter} }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/roar/representer/xml.rb

@@ -1,4 +1,5 @@
 require 'roar/representer'
+require 'roar/representer/feature/hypermedia'
 require 'representable/xml'
 
 module Roar
@@ -37,7 +38,7 @@ module Roar
         include Representable::XML::ClassMethods
         
         def links_definition_options
-          {:from => :link, :class => Hyperlink, :collection => true}
+          [:links, {:from => :link, :class => Feature::Hypermedia::Hyperlink, :collection => true, :extend => XML::HyperlinkRepresenter}]
         end
         
         # Generic entry-point for parsing.
@@ -46,19 +47,15 @@ module Roar
         end
       end
       
-            
-      # Encapsulates a hypermedia <link ...>.
-      class Hyperlink
-        # TODO: make XML a module to include in Hyperlink < Base.
-        attr_accessor :rel, :href
+      module HyperlinkRepresenter
         include XML
         
         self.representation_wrap = :link
         
-        property :rel,  :from => "rel", :attribute => true
-        property :href, :from => "href", :attribute => true
+        Feature::Hypermedia::Hyperlink.params.each do |attr|
+          property attr, :attribute => true
+        end
       end
-      
     end
   end
 end

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "0.9.2"
+  VERSION = "0.10.0"
 end

data/roar.gemspec

@@ -19,9 +19,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
   
-  s.add_runtime_dependency "representable", "~> 1.1"
+  s.add_runtime_dependency "representable", ">= 1.1.3"
   
+  s.add_development_dependency "rake"
   s.add_development_dependency "test_xml"
   s.add_development_dependency "minitest",	">= 2.8.1"
   s.add_development_dependency "sinatra",   "~> 1.2.6"
+  s.add_development_dependency "sham_rack", "~> 1.3.0"
 end

data/test/client_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+require 'roar/representer/feature/client'
+
+class ClientTest < MiniTest::Spec
+  describe "Client" do
+    before do
+      @representer = Module.new do
+        include Roar::Representer
+        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"
+      @song.band = "Bad Religion"
+      assert_equal "Social Suicide", @song.name
+      assert_equal "Bad Religion", @song.band
+    end
+  end
+end

data/test/fake_server.rb

@@ -36,13 +36,13 @@ class FakeServer < Sinatra::Base
   end
   
   
-  require Dir.pwd + '/order_representers'
+  require './test/order_representers'
   JSON::Order.class_eval do
     def items_url
-      "http://localhost:9999/orders/1/items"
+      "http://roar.example.com/orders/1/items"
     end
     def order_url(order)
-      "http://localhost:9999/orders/#{order}"
+      "http://roar.example.com/orders/#{order}"
     end
     def represented
       1
@@ -72,4 +72,3 @@ class FakeServer < Sinatra::Base
   
 end
 
-FakeServer.run! :host => 'localhost', :port => 9999

data/test/hal_json_test.rb

@@ -0,0 +1,69 @@
+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"
+    end
+  end
+  
+  describe "JSON::HAL::Links" do
+    before do
+      @song = Object.new.extend(SongRepresenter)
+    end
+    
+    it "renders links according to the HAL spec" do
+      assert_equal "{\"links\":{\"self\":{\"href\":\"http://self\"},\"next\":{\"href\":\"http://hit\",\"title\":\"Hey, @myabc\"}}}", @song.to_json
+    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
+  end
+  
+  
+  describe "HAL/JSON" do
+    before do
+      Bla = Module.new do
+        include Roar::Representer::JSON::HAL
+        property :value
+        link :self do
+          "http://items/#{value}"
+        end
+      end
+      
+      @order_rep = Module.new do
+        include Roar::Representer::JSON::HAL
+        property :id
+        collection :items, :class => Item, :extend => Bla, :embedded => true
+        link :self do
+          "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
+      assert_equal "Coffee", @order.items.first.value
+      assert_equal "http://items/Coffee", @order.items.first.links[:self].href
+      assert_equal "http://orders/2", @order.links[:self].href
+    end
+  end
+end

data/test/http_verbs_feature_test.rb

@@ -32,7 +32,7 @@ class HttpVerbsTest < MiniTest::Spec
           include Roar::Representer::Feature::HttpVerbs
           attr_accessor :name, :label
         end
-        @band = @Band.get("http://localhost:9999/bands/slayer", "application/json")
+        @band = @Band.get("http://roar.example.com/bands/slayer", "application/json")
         assert_equal "Slayer", @band.name
         assert_equal "Canadian Maple", @band.label
       end
@@ -40,7 +40,7 @@ class HttpVerbsTest < MiniTest::Spec
     
     describe "#get" do
       it "updates instance with incoming representation" do
-        @band.get("http://localhost:9999/bands/slayer", "application/json")
+        @band.get("http://roar.example.com/bands/slayer", "application/json")
         assert_equal "Slayer", @band.name
         assert_equal "Canadian Maple", @band.label
       end
@@ -51,7 +51,7 @@ class HttpVerbsTest < MiniTest::Spec
         @band.name = "Strung Out"
         assert_equal nil, @band.label
         
-        @band.post("http://localhost:9999/bands", "application/xml")
+        @band.post("http://roar.example.com/bands", "application/xml")
         assert_equal "Strung Out", @band.name
         assert_equal "n/a", @band.label
       end
@@ -61,7 +61,7 @@ class HttpVerbsTest < MiniTest::Spec
       it "updates instance with incoming representation" do
         @band.name   = "Strung Out"
         @band.label  = "Fat Wreck"
-        @band.put("http://localhost:9999/bands/strungout", "application/xml")
+        @band.put("http://roar.example.com/bands/strungout", "application/xml")
         assert_equal "Strung Out", @band.name
         assert_equal "Fat Wreck", @band.label
       end

data/test/hypermedia_feature_test.rb

@@ -4,6 +4,36 @@ 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\",\"href\":\"http://self\",\"title\":\"Hey, @myabc\"}]}", Object.new.extend(@mod).to_json
+      end
+    end
+    
+    
     before do
       @bookmarks = Class.new do
         include AttributesContructor
@@ -67,7 +97,7 @@ class HypermediaTest
           attr_accessor :note
         end
         
-        assert_equal "{\"note\":{\"links\":[{\"rel\":\"self\",\"href\":\"http://me\"}]}}", Page.new(note: Note.new).to_json
+        assert_equal "{\"note\":{\"links\":[{\"rel\":\"self\",\"href\":\"http://me\"}]}}", Page.new(:note => Note.new).to_json
       end
     end
     
@@ -95,7 +125,7 @@ class HypermediaTest
     describe "#links" do
       before do
         @set  = @bookmarks.new
-        hyper = Roar::Representer::XML::Hyperlink
+        hyper = Roar::Representer::Feature::Hypermedia::Hyperlink
         
         @set.links = [
           {:rel => "self", :href => "http://self"}, 
@@ -115,10 +145,10 @@ class HypermediaTest
       end
       
       describe "#link[]" do
-        it "provides shorthand accessor for rels" do
-          assert_equal "http://self", @set.links["self"]
-          assert_equal "http://self", @set.links[:self]
-          assert_equal "http://next", @set.links[:next]
+        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
@@ -171,7 +201,9 @@ class LinkCollectionTest < MiniTest::Spec
   describe "LinkCollection" do
     it "provides #update_link" do
       collection  = Roar::Representer::Feature::Hypermedia::LinkCollection.new
-      link        = Roar::Representer::XML::Hyperlink.new(rel: "self", href: "http://self")
+      link        = Roar::Representer::Feature::Hypermedia::Hyperlink.new
+      link.rel  = "self"
+      link.href = "http://self"
       
       collection.update_link(link)
       assert_equal 1, collection.size
@@ -182,3 +214,27 @@ class LinkCollectionTest < MiniTest::Spec
   end
 end
 
+class HyperlinkTest < MiniTest::Spec
+  Hyperlink = Roar::Representer::Feature::Hypermedia::Hyperlink
+  describe "Hyperlink" do
+    before do
+      @link = Hyperlink.new(:rel => "self", :href => "http://self")
+    end
+    
+    it "accepts string keys in constructor" do
+      assert_equal "Hey, @myabc", Hyperlink.new("title" => "Hey, @myabc").title
+    end
+    
+    it "responds to #media" do
+      assert_equal nil, @link.media
+    end
+    
+    it "responds to #rel" do
+      assert_equal "self", @link.rel
+    end
+    
+    it "responds to #href" do
+      assert_equal "http://self", @link.href
+    end
+  end
+end

data/test/json_representer_test.rb

@@ -30,6 +30,10 @@ class JsonRepresenterTest < MiniTest::Spec
       it "is aliased by #serialize" do
         assert_equal '{"id":1}', @order.serialize
       end
+      
+      it "accepts :include and :except" do
+        assert_equal '{}', @order.to_json(:except => [:id])
+      end
     end
     
     describe "#from_json" do
@@ -46,6 +50,15 @@ class JsonRepresenterTest < MiniTest::Spec
       it "works with a nil document" do
         assert @order.from_json(nil)
       end
+
+      it "works with an empty document" do
+        assert @order.from_json('')
+      end
+      
+      it "accepts :include and :except" do
+        @order.from_json('{"id":1}', :except => [:id])
+        assert_equal nil, @order.id
+      end
     end
     
     describe "JSON.from_json" do
@@ -57,18 +70,27 @@ class JsonRepresenterTest < MiniTest::Spec
   end
 end
 
+# test the generic roar+json HyperlinkRepresenter
 class JsonHyperlinkRepresenterTest
   describe "API" do
     before do
-      @l = Roar::Representer::JSON::Hyperlink.from_json({:rel => :self, :href => "http://roar.apotomo.de"}.to_json)
+      @link = Roar::Representer::Feature::Hypermedia::Hyperlink.new.extend(Roar::Representer::JSON::HyperlinkRepresenter).from_json({:rel => :self, :href => "http://roar.apotomo.de", :media => "web"}.to_json)
     end
     
     it "responds to #rel" do
-      assert_equal "self", @l.rel
+      assert_equal "self", @link.rel
     end
     
     it "responds to #href" do
-      assert_equal "http://roar.apotomo.de", @l.href
+      assert_equal "http://roar.apotomo.de", @link.href
+    end
+    
+    it "responds to #media" do
+      assert_equal "web", @link.media
+    end
+    
+    it "responds to #to_json" do
+      assert_equal "{\"rel\":\"self\",\"href\":\"http://roar.apotomo.de\",\"media\":\"web\"}", @link.to_json
     end
   end
 end
@@ -105,6 +127,17 @@ class JsonHypermediaTest
     it "renders link: correctly in JSON" do
       assert_equal "{\"id\":1,\"links\":[{\"rel\":\"self\",\"href\":\"http://self\"},{\"rel\":\"next\",\"href\":\"http://next/1\"}]}", @c.new(:id => 1).to_json
     end
+    
+    it "doesn't render links when empty" do
+      assert_equal("{\"links\":[]}", Class.new do
+        include Roar::Representer::JSON
+        include Roar::Representer::Feature::Hypermedia
+        
+        link :self do nil end
+        link :next do false end
+      end.new.to_json)
+    end
+    
   end
 end
 

data/test/test_helper.rb

@@ -5,7 +5,6 @@ require 'test/unit'
 require 'minitest/spec'
 
 require 'roar/representer'
-require 'roar/representer/feature/hypermedia'
 require 'roar/representer/feature/http_verbs'
 
 
@@ -34,3 +33,10 @@ end
 
 require "test_xml/mini_test"
 require "roar/representer/xml"
+
+require 'sham_rack'
+require './test/fake_server'
+
+ShamRack.at('roar.example.com').rackup do
+  run FakeServer
+end

data/test/transport_test.rb

@@ -8,24 +8,24 @@ class TransportTest < MiniTest::Spec
     end
     
     it "#get_uri returns response" do
-      assert_equal "<method>get</method>",  @transport.get_uri("http://localhost:9999/method", "application/xml").body
+      assert_equal "<method>get</method>",  @transport.get_uri("http://roar.example.com/method", "application/xml").body
     end
     
     it "#post_uri returns response" do
-      assert_equal "<method>post</method>",  @transport.post_uri("http://localhost:9999/method", "booty", "application/xml").body
+      assert_equal "<method>post</method>",  @transport.post_uri("http://roar.example.com/method", "booty", "application/xml").body
     end
     
     it "#put_uri returns response" do
-      assert_equal "<method>put</method>",  @transport.put_uri("http://localhost:9999/method", "booty", "application/xml").body
+      assert_equal "<method>put</method>",  @transport.put_uri("http://roar.example.com/method", "booty", "application/xml").body
     end
     
     it "#delete_uri returns response" do
-      assert_equal "<method>delete</method>",  @transport.delete_uri("http://localhost:9999/method", "application/xml").body
+      assert_equal "<method>delete</method>",  @transport.delete_uri("http://roar.example.com/method", "application/xml").body
     end
     
     # TODO: how to get PATCH into Sinatra?
     #it "#patch_uri returns Restfulie response" do
-    #  assert_equal "<method>patch</method>",  @o.patch_uri("http://localhost:9999/method", "booty", "application/xml").body
+    #  assert_equal "<method>patch</method>",  @o.patch_uri("http://roar.example.com/method", "booty", "application/xml").body
     #end
   end
 end

data/test/xml_representer_test.rb

@@ -18,34 +18,15 @@ class PositionRepresenter
 end
 
 
-
-
-class XMLRepresenterUnitTest < MiniTest::Spec
-  describe "XmlRepresenter" do
-    describe "#link" do
-      class Rapper
-        include Roar::Representer::XML
-        include Roar::Representer::Feature::Hypermedia
-        
-        link :self
-        link :next
-      end
-      
-      it "creates a LinksDefinition" do
-        assert_equal 1, Rapper.representable_attrs.size
-        assert_equal [{:rel=>:self, :block=>nil}, {:rel=>:next, :block=>nil}], Rapper.representable_attrs.first.rel2block
-      end
-    end
-  end
-end
-
-
 class XMLRepresenterFunctionalTest < MiniTest::Spec
-  class GreedyOrder
+  class Order
     include AttributesContructor
     attr_accessor :id, :items
   end
   
+  class GreedyOrder < Order
+  end
+  
   class TestXmlRepresenter
     include Roar::Representer::XML
     self.representation_wrap= :order
@@ -58,6 +39,7 @@ class XMLRepresenterFunctionalTest < MiniTest::Spec
     before do
       @m = {"id" => "1"}
       @o = Order.new(@m)
+      
       @r = TestXmlRepresenter.new
       @i = ItemRepresenter.new
       @i.value = "Beer"
@@ -77,6 +59,10 @@ class XMLRepresenterFunctionalTest < MiniTest::Spec
       it "is aliased by #serialize" do
         assert_equal @r.to_xml, @r.serialize
       end
+      
+      it "accepts :include and :except" do
+        assert_equal '<order/>', @r.to_xml(:except => [:id])
+      end
     end
     
     describe "#from_xml" do
@@ -89,6 +75,11 @@ class XMLRepresenterFunctionalTest < MiniTest::Spec
         @order = Order.new.deserialize("<order><id>1</id></order>")
         assert_equal "1", @order.id
       end
+      
+      it "accepts :include and :except" do
+        @order = Order.new.deserialize("<order><id>1</id></order>", :except => [:id])
+        assert_equal nil, @order.id
+      end
     end
     
     
@@ -195,20 +186,23 @@ end
 class XmlHyperlinkRepresenterTest < MiniTest::Spec
   describe "API" do
     before do
-      @l = Roar::Representer::XML::Hyperlink.from_xml(%{<link rel="self" href="http://roar.apotomo.de"/>})
+      @link = Roar::Representer::Feature::Hypermedia::Hyperlink.new.extend(Roar::Representer::XML::HyperlinkRepresenter).from_xml(%{<link rel="self" href="http://roar.apotomo.de" media="web"/>})
     end
     
-    it "responds to #to_xml" do
-      assert_xml_equal %{<link rel=\"self\" href=\"http://roar.apotomo.de\"/>}, @l.to_xml
+    it "responds to #rel" do
+      assert_equal "self", @link.rel
     end
     
+    it "responds to #href" do
+      assert_equal "http://roar.apotomo.de", @link.href
+    end
     
-    it "responds to #rel" do
-      assert_equal "self", @l.rel
+    it "responds to #media" do
+      assert_equal "web", @link.media
     end
     
-    it "responds to #href" do
-      assert_equal "http://roar.apotomo.de", @l.href
+    it "responds to #to_xml" do
+      assert_xml_equal %{<link rel=\"self\" href=\"http://roar.apotomo.de\" media="web"/>}, @link.to_xml
     end
   end
 end

metadata

@@ -1,90 +1,92 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: roar
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 9
-  - 2
-  version: 0.9.2
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-02-06 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: representable
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &82244490 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 1
-        version: "1.1"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: test_xml
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *82244490
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &82244190 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *82244190
+- !ruby/object:Gem::Dependency
+  name: test_xml
+  requirement: &82243710 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 8
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *82243710
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &82243040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.8.1
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: sinatra
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *82243040
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &82242340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 2
-        - 6
+      - !ruby/object:Gem::Version
         version: 1.2.6
   type: :development
-  version_requirements: *id004
-description: Streamlines the development of RESTful, resource-oriented architectures in Ruby.
-email: 
+  prerelease: false
+  version_requirements: *82242340
+- !ruby/object:Gem::Dependency
+  name: sham_rack
+  requirement: &82241770 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *82241770
+description: Streamlines the development of RESTful, resource-oriented architectures
+  in Ruby.
+email:
 - apotonick@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - CHANGES.markdown
 - Gemfile
 - README.textile
@@ -93,14 +95,17 @@ files:
 - lib/roar.rb
 - lib/roar/rails.rb
 - lib/roar/representer.rb
+- lib/roar/representer/feature/client.rb
 - lib/roar/representer/feature/http_verbs.rb
 - lib/roar/representer/feature/hypermedia.rb
 - lib/roar/representer/feature/transport.rb
 - lib/roar/representer/json.rb
+- lib/roar/representer/json/hal.rb
 - lib/roar/representer/xml.rb
 - lib/roar/version.rb
 - roar.gemspec
 - test/Gemfile
+- test/client_test.rb
 - test/dummy/Rakefile
 - test/dummy/app/controllers/albums_controller.rb
 - test/dummy/app/controllers/application_controller.rb
@@ -137,6 +142,7 @@ files:
 - test/dummy/tmp/app/cells/blog/post/latest.html.erb
 - test/dummy/tmp/app/cells/blog/post_cell.rb
 - test/fake_server.rb
+- test/hal_json_test.rb
 - test/http_verbs_feature_test.rb
 - test/hypermedia_feature_test.rb
 - test/integration_test.rb
@@ -148,37 +154,28 @@ files:
 - test/test_helper.rb
 - test/transport_test.rb
 - test/xml_representer_test.rb
-has_rdoc: true
 homepage: http://rubygems.org/gems/roar
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: roar
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Resource-oriented architectures in Ruby.
 test_files: []
-