roar 0.11.8 → 0.11.9

data/CHANGES.markdown

@@ -1,3 +1,8 @@
+## 0.11.9
+
+* When using `Feature::Client` hyperlinks are no longer rendered in POST and PUT since we pass `links: false`.
+* `Transport::NetHttp` now sets both `Accept:` and `Content-type:` header since Rails services seems to get confused.
+
 ## 0.11.8
 
 * Fixed `JSON::HAL::Links` so that it keys links with `links` and not `_links`. The latter is still done by `JSON::HAL`.

data/Gemfile

@@ -3,7 +3,7 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in roar.gemspec
 gemspec
 
-gem "representable", "~> 1.2.9"
+gem "representable", ">= 1.3.1"
 
 
 group :test do

data/TODO.markdown

@@ -1 +1,3 @@
 * Add proxies, so nested models can be lazy-loaded.
+* move #prepare_links! call to #_links or something so it doesn't need to be called in #serialize.
+* alias Roar::Representer to Representer

data/gemfiles/Gemfile.representable-1.3

@@ -2,7 +2,7 @@ source "http://rubygems.org"
 
 gemspec :path => '../'
 
-gem 'representable', '1.3.0'
+gem 'representable', '>= 1.3.1'
 group :test do
   gem 'faraday'
   gem 'turn'

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

@@ -26,6 +26,10 @@ module Roar
             end
           end
         end
+
+        def before_serialize(options={})
+          super({:links => false}.merge!(options))
+        end
       end
     end
   end

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

@@ -57,9 +57,7 @@ module Roar
         def links_array=(ary)
           # FIXME: move to LinkCollection
           self.links= LinkCollection.new
-          ary.each do |lnk|
-            self.links[lnk.rel.to_s] = lnk
-          end
+          ary.each { |lnk| links.add(lnk) }
         end
 
       private
@@ -69,12 +67,19 @@ module Roar
 
         # Setup hypermedia links by invoking their blocks. Usually called by #serialize.
         def prepare_links!(*args)
-          links_definition.each do |config|  # config is [{..}, block]
+          # TODO: move this method to _links or something so it doesn't need to be called in #serialize.
+          compile_links_for(links_definition, *args).each do |lnk|
+            links.add(lnk)  # TODO: move to LinkCollection.new.
+          end
+        end
+
+        def compile_links_for(configs, *args)
+          configs.collect do |config|
             options, block  = config.first, config.last
             href            = run_link_block(block, *args) or next
 
-            links.add(prepare_link_for(href, options))
-          end
+            prepare_link_for(href, options)
+          end.compact # FIXME: make this less ugly.
         end
 
         def prepare_link_for(href, options)
@@ -93,7 +98,7 @@ module Roar
             self.fetch(rel.to_s, nil)
           end
 
-          def add(link) # FIXME: use Hash API.
+          def add(link)
             self[link.rel.to_s] = link
           end
         end

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

@@ -0,0 +1,208 @@
+module Roar::Representer::JSON
+  # Implementation of the Collection+JSON media format, http://amundsen.com/media-types/collection/format/
+  #
+  # When clients want to add or update an item the collection's filled out template is POSTed or PUT. You can parse that using the
+  # +SongCollectionRepresenter::template_representer+ module.
+  #
+  #   Song.new.extend(SongCollectionRepresenter.template_representer).from_json("{template: ...")
+  module CollectionJSON
+    def self.included(base)
+      base.class_eval do
+        include Roar::Representer
+        include Roar::Representer::JSON
+        include Roar::Representer::Feature::Hypermedia
+
+        extend ClassMethods
+
+        self.representation_wrap= :collection # FIXME: move outside of this block for inheritance!
+
+        property :__template, :as => :template, :extend => lambda {|*| representable_attrs.collection_representers[:template] }, :class => Array
+        def __template
+          OpenStruct.new  # TODO: handle preset values.
+        end
+
+        collection :queries, :extend => Roar::Representer::JSON::HyperlinkRepresenter
+        def queries
+          compile_links_for(representable_attrs.collection_representers[:queries].representable_attrs.first)
+        end
+        def queries=(v)
+        end
+
+
+        def items
+          self
+        end
+        def items=(v)
+          replace(v)
+        end
+
+        property :__version, :as => :version
+        def __version
+          representable_attrs.collection_representers[:version]
+        end
+
+        property :__href, :as => :href
+        def __href
+          compile_links_for(representable_attrs.collection_representers[:href].representable_attrs.first).first.href
+        end
+        
+
+        
+        include ClientMethods
+      end
+    end
+
+    module ClassMethods
+      module PropertyWithRenderNil
+        def property(name, options={})
+          super(name, options.merge!(:render_nil => true))
+        end
+      end
+
+      # TODO: provide automatic copying from the ItemRepresenter here.
+      def template(&block)
+        mod = representable_attrs.collection_representers[:object_template] = Module.new do
+          include Roar::Representer::JSON
+          include Roar::Representer::JSON::CollectionJSON::DataMethods
+          
+          extend PropertyWithRenderNil
+
+          module_exec(&block)
+
+          #self.representation_wrap = :template
+          def from_hash(hash, *args)  # overridden in :template representer.
+            super(hash["template"])
+          end
+        end
+
+        representable_attrs.collection_representers[:template] = Module.new do
+          include Roar::Representer::JSON
+          include mod
+
+          #self.representation_wrap = false
+
+          # DISCUSS: currently we skip real deserialization here and just store the :data hash.
+          def from_hash(hash, *args)
+            replace(hash["data"])
+          end
+        end
+      end
+      def template_representer
+        representable_attrs.collection_representers[:object_template]
+      end
+
+      def queries(&block)
+        mod = representable_attrs.collection_representers[:queries] = Module.new do
+          include Roar::Representer::JSON
+          include Roar::Representer::Feature::Hypermedia
+          
+          module_exec(&block)
+
+          def to_hash(*)
+            hash = super
+            hash["links"] # TODO: make it easier to render collection of links.
+          end
+        end
+      end
+
+      def items(options={}, &block)
+        collection :items, { :extend => lambda {|*| representable_attrs.collection_representers[:items] } }.merge!(options)
+
+        mod = representable_attrs.collection_representers[:items] = Module.new do
+          include Roar::Representer::JSON
+          include Roar::Representer::Feature::Hypermedia
+          include Roar::Representer::JSON::CollectionJSON::DataMethods
+          extend SharedClassMethodsBullshit
+
+          module_exec(&block)
+
+          # TODO: share with main module!
+          property :__href, :as => :href
+          def __href
+            compile_links_for(representable_attrs.collection_representers[:href].representable_attrs.first).first.href
+          end
+          def __href=(v)
+            @__href = Roar::Representer::Feature::Hypermedia::Hyperlink.new(:href => v)
+          end
+          def href
+            @__href
+          end
+        end
+      end
+
+      def version(v)
+        representable_attrs.collection_representers[:version] = v
+      end
+
+      module SharedClassMethodsBullshit
+        def href(&block)
+          mod = representable_attrs.collection_representers[:href] = Module.new do
+            include Roar::Representer::JSON
+            include Roar::Representer::Feature::Hypermedia
+
+
+            link(:href, &block)
+          end
+        end
+
+        def representable_attrs
+          super.tap do |attrs|
+            attrs.instance_eval do # FIXME: of course, this is WIP.
+              def collection_representers
+                @collection_representers ||= {}
+              end
+            end
+          end
+        end
+      end
+      include SharedClassMethodsBullshit
+    end
+
+    module DataMethods
+      def to_hash(*)
+        hash = super.tap do |hsh|
+          data = []
+          hsh.keys.each do |n|
+            next if ["href", "links"].include?(n)
+
+            v = hsh.delete(n.to_s)
+            data << {:name => n, :value => v} # TODO: get :prompt from Definition.
+          end
+          hsh[:data] = data
+        end
+      end
+
+      def from_hash(hash, *args)
+        data = {}
+        hash.delete("data").collect do |item|
+          data[item["name"]] = item["value"]
+        end
+        super(hash.merge!(data))
+      end
+    end
+
+    module ClientMethods
+      def __version=(v)
+        @__version = v
+      end
+      def version
+        @__version
+      end
+
+      def __href=(v)
+        @__href = Roar::Representer::Feature::Hypermedia::Hyperlink.new(:href => v)
+      end
+      def href
+        @__href
+      end
+
+      def __template=(v)
+        @__template = v
+      end
+      # DISCUSS: this might return a Template instance, soon.
+      def template
+        @__template
+      end
+    end
+  end
+end

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

@@ -35,6 +35,7 @@ module Roar
           http  = Net::HTTP.new(uri.host, uri.port)
           req   = what.new(uri.request_uri)
           req.content_type  = as
+          req["accept"]     = as  # TODO: test me. # DISCUSS: if Accept is not set, rails treats this request as as "text/html".
           req.body          = body if body
           http.request(req)
         end

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "0.11.8"
+  VERSION = "0.11.9"
 end

data/test/client_test.rb

@@ -2,23 +2,29 @@ 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
+  representer_for([Roar::Representer]) do
+    property :name
+    property :band
+  end
+
+  let(:song) { Object.new.extend(rpr).extend(Roar::Representer::Feature::Client) }
+
+  it "adds accessors" do
+    song.name = "Social Suicide"
+    song.band = "Bad Religion"
+    assert_equal "Social Suicide", song.name
+    assert_equal "Bad Religion", song.band
+  end
 
-      @song = Object.new.extend(@representer)
+  describe "links" do
+    representer_for([Roar::Representer::JSON, Roar::Representer::Feature::Hypermedia]) do
+      property :name
+      link(:self) { never_call_me! }
     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
+    it "suppresses rendering" do
+      song.name = "Silenced"
+      song.to_json.must_equal %{{\"name\":\"Silenced\",\"links\":[]}}
     end
   end
 end

data/test/collection_json_test.rb

@@ -0,0 +1,130 @@
+require 'test_helper'
+require 'roar/representer/json/collection_json'
+
+class CollectionJsonTest < MiniTest::Spec
+  let(:song) { OpenStruct.new(:title => "scarifice", :length => 43) }
+
+  representer_for([Roar::Representer::JSON::CollectionJSON]) do
+    version "1.0"
+    href { "//songs/" }
+
+    link(:feed) { "//songs/feed" }
+
+    items(:class => Song) do
+      href { "//songs/scarifice" }
+
+      property :title, :prompt => "Song title"
+      property :length, :prompt => "Song length"
+
+      link(:download) { "//songs/scarifice.mp3" }
+      link(:stats) { "//songs/scarifice/stats" }
+    end
+
+    template do
+      property :title, :prompt => "Song title"
+      property :length, :prompt => "Song length"
+    end
+
+    queries do
+      link :search do
+        {:href => "//search", :data => [{:name => "q", :value => ""}]}
+      end
+    end
+  end
+
+  describe "#to_json" do
+    it "renders document" do
+      [song].extend(rpr).to_hash.must_equal(
+      {
+        :collection=>{
+          "version"=>"1.0",
+          "href"=>"//songs/",
+
+          "template"=>{
+            :data=>[
+              {:name=>"title", :value=>nil},
+              {:name=>"length", :value=>nil}
+            ]
+          },
+
+          "queries"=>[
+            {:rel=>:search, :href=>"//search", 
+              :data=>[
+                {:name=>"q", :value=>""}
+              ]
+            }
+          ],
+
+          "items"=>[
+            {
+              "links"=>[
+                {:rel=>:download, :href=>"//songs/scarifice.mp3"},
+                {:rel=>:stats, :href=>"//songs/scarifice/stats"}
+              ],
+              "href"=>"//songs/scarifice",
+              :data=>[
+                {:name=>"title", :value=>"scarifice"},
+                {:name=>"length", :value=>43}
+              ]
+            }
+          ],
+
+          "links"=>[
+            {:rel=>:feed, :href=>"//songs/feed"}
+          ]
+        }
+      })# %{{"collection":{"version":"1.0","href":"//songs/","items":[{"href":"//songs/scarifice","links":[{"rel":"download","href":"//songs/scarifice.mp3"},{"rel":"stats","href":"//songs/scarifice/stats"}],"data":[{"name":"title","value":"scarifice"},{"name":"length","value":43}]}],"template":{"data":[{"name":"title","value":null},{"name":"length","value":null}]},"queries":[{"rel":"search","href":"//search","data":[{"name":"q","value":""}]}],"links":[{"rel":"feed","href":"//songs/feed"}]}}}
+    end
+  end
+
+  describe "#from_json" do
+    subject { [].extend(rpr).from_json [song].extend(rpr).to_json }
+
+    it "provides #version" do
+      subject.version.must_equal "1.0"
+    end
+
+    it "provides #href" do
+      subject.href.must_equal link(:href => "//songs/")
+    end
+
+    it "provides #template" do
+      # DISCUSS: this might return a Template instance, soon.
+      subject.template.must_equal([
+        {"name"=>"title", "value"=>nil},
+        {"name"=>"length", "value"=>nil}])
+    end
+
+    it "provides #queries" do
+      # DISCUSS: this might return CollectionJSON::Hyperlink instances that support some kind of substitution operation for the :data attribute.
+      # FIXME: this is currently _not_ parsed!
+      subject.queries.must_equal([link(:rel => :search, :href=>"//search", :data=>[{:name=>"q", :value=>""}])])
+    end
+
+    it "provides #items" do
+      subject.items.must_equal([Song.new(:title => "scarifice", :length => "43")])
+      song = subject.items.first
+      song.title.must_equal "scarifice"
+      song.length.must_equal 43
+      song.links.must_equal("download" => link({:rel=>:download, :href=>"//songs/scarifice.mp3"}), "stats" => link({:rel=>:stats, :href=>"//songs/scarifice/stats"}))
+      song.href.must_equal link(:href => "//songs/scarifice")
+    end
+
+    it "provides #links" do
+      subject.links.must_equal({"feed" => link(:rel => :feed, :href => "//songs/feed")})
+    end
+  end
+
+  describe "template_representer#from_json" do
+    it "parses object" do
+      song = OpenStruct.new.extend(rpr.template_representer).from_hash(
+        "template"=>{
+          "data"=>[
+            {"name"=>"title",  "value"=>"Black Star"},
+            {"name"=>"length", "value"=>"4.53"}
+          ]
+        })
+      song.title.must_equal "Black Star"
+    end
+  end
+end

data/test/test_helper.rb

@@ -26,6 +26,7 @@ module AttributesConstructor  # TODO: remove me.
   end
 end
 
+# FIXME: provide a real #== for OpenStruct.
 class Song < OpenStruct
   def ==(other)
     name == other.name and track == other.track
@@ -55,7 +56,7 @@ MiniTest::Spec.class_eval do
       Module.new do
         include *modules.reverse
 
-        instance_exec(&block)
+        module_exec(&block)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roar
 version: !ruby/object:Gem::Version
-  version: 0.11.8
+  version: 0.11.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-25 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -98,6 +98,7 @@ files:
 - lib/roar/representer/feature/http_verbs.rb
 - lib/roar/representer/feature/hypermedia.rb
 - lib/roar/representer/json.rb
+- lib/roar/representer/json/collection_json.rb
 - lib/roar/representer/json/hal.rb
 - lib/roar/representer/transport/faraday.rb
 - lib/roar/representer/transport/net_http.rb
@@ -107,6 +108,7 @@ files:
 - test/Gemfile
 - test/client_test.rb
 - test/coercion_feature_test.rb
+- test/collection_json_test.rb
 - test/fake_server.rb
 - test/faraday_http_transport_test.rb
 - test/hal_json_test.rb