roar 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ce6093e4d27114a605b64621c20ab9f5e156266
-  data.tar.gz: ac05b9e8989952f88b86caaf2d344a2467f48968
+  metadata.gz: c60a365b03b4c4196033eccc186b649c50f8f40a
+  data.tar.gz: 4e5dfbfe2caa91f334c2568d6a563c223776cdab
 SHA512:
-  metadata.gz: 334f83c90798c648945a3d1f0077e503a26f6a51bd2499a3878f48bdb845ad3815a55f8e372078ac28cf5fba628043e7b4edb031625e1abf14ff36dc4fee890d
-  data.tar.gz: 329f87d78af5d6e8f214e5dc71a22ff9ce932967bc8bb0e86f5b45ecad6a21eabf546afecd0690ab05dc8e5ccbcfe5f98cfccddc2ddd18f381e6a7ddaf2e441e
+  metadata.gz: f2ea14d0d3b644f2f0f4c0677e35419a91955e97f6357a283a2f21206c19a35fd19ef8c166f3b4540449fc09cf3c70ab54688c4266bfca1aa00c2a33bf6e3769
+  data.tar.gz: ee6b42fc8b33f3e21955d6ee4ba658a4903503c4208cfc766017123ddceb802a906c759a845dbe9e9a202cd3465f0ad9db5e1c835a61adeb420a2f4308a0d07b

data/.travis.yml

@@ -3,6 +3,7 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
+  - rbx-2
 gemfile:
   - gemfiles/Gemfile.representable-2.0
   - gemfiles/Gemfile.representable-2.1

data/CHANGES.markdown

@@ -1,3 +1,12 @@
+# 1.0.2
+
+* Roar runs on Rubinius.
+
+## JSON::HAL
+
+* `"_embedded"` will always be rendered before `"_links"`.
+* `render_nil: false` is now respected.
+
 # 1.0.1
 
 * Allow calling `::has_one`, `::links` and `::has_many` in any order in JSON-API. This requires representable >= 2.1.4.
@@ -14,7 +23,7 @@
 
 ## Added
 
-* `Roar::JSON::JsonApi` supports JSON-API. A big thanks to @oliverbarnes for his continous help, support and research on how to implement this standard.
+* `Roar::JSON::JSONAPI` supports JSON-API. A big thanks to @oliverbarnes for his continous help, support and research on how to implement this standard.
 
 
 ## Relevant

data/Gemfile

@@ -3,8 +3,5 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in roar.gemspec
 gemspec
 
-# gem "representable", "~> 2.1.0"
-gem "representable", :path => "../representable"
-
 # as long as this is not merged, i'll vendor the runner file.
 # gem "sinatra-contrib", :git => "git@github.com:apotonick/sinatra-contrib.git", :branch => "runner"

data/README.markdown

@@ -2,6 +2,8 @@
 
 _Resource-Oriented Architectures in Ruby._
 
+[![Build Status](https://travis-ci.org/apotonick/roar.svg?branch=master)](https://travis-ci.org/apotonick/roar)
+
 ## Introduction
 
 Roar is a framework for parsing and rendering REST documents. Nothing more.
@@ -24,6 +26,30 @@ Roar is just a thin layer on top of the [representable](https://github.com/apoto
 
 If in need for a feature, make sure to check the [representable API docs](https://github.com/apotonick/representable) first.
 
+## Installation
+
+The roar gem runs with all Ruby versions >= 1.9.3.
+
+```ruby
+gem 'roar'
+```
+
+### Dependencies
+
+Roar does not bundle dependencies for JSON and XML.
+
+If you want to use JSON, add the following to your Gemfile:
+
+```ruby
+gem 'multi_json'
+```
+
+If you want to use XML, add the following to your Gemfile:
+
+```ruby
+gem 'nokogiri'
+```
+
 
 ## Defining Representers
 
@@ -375,7 +401,7 @@ module SongRepresenter
 end
 ```
 
-Documentation for HAL can be found in the [API docs](http://rdoc.info/github/apotonick/roar/Roar/Representer/JSON/HAL).
+Documentation for HAL can be found in the [API docs](http://rdoc.info/github/apotonick/roar/Roar/JSON/HAL).
 
 Make sure you [understand the different contexts](#hypermedia) for links when using decorators.
 
@@ -418,7 +444,7 @@ album.to_json
 
 HAL keys nested resources under the `_embedded` key and then by their type.
 
-All HAL features in Roar are discussed in the [API docs](http://rdoc.info/github/apotonick/roar/Roar/Representer/JSON/HAL), including [array links](https://github.com/apotonick/roar/blob/master/lib/roar/json/hal.rb#L176).
+All HAL features in Roar are discussed in the [API docs](http://rdoc.info/github/apotonick/roar/Roar/JSON/HAL), including [array links](https://github.com/apotonick/roar/blob/master/lib/roar/json/hal.rb#L196).
 
 
 ## JSON-API
@@ -662,7 +688,7 @@ As `GET` is not supposed to send any data, you can use `#get` on an empty object
 Roar supports SSL connections - they are automatically detected via the protocol.
 
 ```ruby
-song.get(uri: "https://localhost:4567/songs/1")`
+song.get(uri: "https://localhost:4567/songs/1")
 ```
 
 ### Basic Authentication
@@ -713,8 +739,8 @@ Roar also comes with XML support.
 
 ```ruby
 module SongRepresenter
-  include Roar::Representer::XML
-  include Roar::Representer::Hypermedia
+  include Roar::XML
+  include Roar::Hypermedia
 
   property :title
   property :id
@@ -725,7 +751,7 @@ module SongRepresenter
 end
 ```
 
-Include the `Roar::Representer::XML` engine and get bi-directional XML for your objects.
+Include the `Roar::XML` engine and get bi-directional XML for your objects.
 
 ```ruby
 song = Song.new(title: "Roxanne", id: 42)

data/gemfiles/Gemfile.representable-1.7

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec path: '../'
+
+gem 'representable', '~> 1.7.0'
+gem 'sinatra-contrib', github: 'apotonick/sinatra-contrib', branch: 'runner'

data/gemfiles/Gemfile.representable-1.8

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec path: '../'
+
+gem 'representable', '~> 1.8.0'
+gem 'sinatra-contrib', github: 'apotonick/sinatra-contrib', branch: 'runner'

data/gemfiles/Gemfile.representable-head

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gemspec path: '../'
+
+gem 'representable', github: 'apotonick/representable'
+gem 'sinatra-contrib', github: 'apotonick/sinatra-contrib', branch: 'runner'

data/lib/roar/coercion.rb

@@ -5,8 +5,8 @@ require 'representable/coercion'
 module Roar
   # Use the +:type+ option to specify the conversion type.
   # class ImmigrantSong
-  #   include Roar::Representer::JSON
-  #   include Roar::Representer::Feature::Coercion
+  #   include Roar::JSON
+  #   include Roar::Coercion
   #
   #   property :composed_at, :type => DateTime, :default => "May 12th, 2012"
   # end

data/lib/roar/hypermedia.rb

@@ -4,7 +4,7 @@ module Roar
   # Example:
   #
   #   class Order
-  #     include Roar::Representer::JSON
+  #     include Roar:JSON
   #
   #     property :id
   #

data/lib/roar/json/hal.rb

@@ -16,7 +16,7 @@ module Roar
     # Example:
     #
     #   module OrderRepresenter
-    #     include Roar::Representer::JSON::HAL
+    #     include Roar::JSON::HAL
     #
     #     property :id
     #     collection :items, :class => Item, :extend => ItemRepresenter, :embedded => true
@@ -48,27 +48,26 @@ module Roar
           include Links       # overwrites #links_definition_options.
           extend ClassMethods # overwrites #links_definition_options, again.
           include Resources
-
-          def representable_mapper(*) # TODO: make this easier to override.
-            super.tap do |map|
-              map.extend Resources
-            end
-          end
         end
       end
 
       module Resources
-        # Write the property to the +_embedded+ hash when it's a resource.
-        def compile_fragment(bin, doc)
-          embedded = bin[:embedded]
-          return super unless embedded
-          super(bin, doc[:_embedded] ||= {})
+        def to_hash(*)
+          super.tap do |hash|
+            embedded = {}
+            representable_attrs.find_all do |dfn|
+              next unless dfn[:embedded] and fragment = hash.delete(dfn.name)
+              embedded[dfn.name] = fragment
+            end
+
+            hash["_embedded"] = embedded if embedded.any?
+            hash["_links"]    = hash.delete("_links") if hash["_links"] # always render _links after _embedded.
+          end
         end
 
-        def uncompile_fragment(bin, doc)
-          embedded = bin[:embedded]
-          return super unless embedded
-          super(bin, doc["_embedded"] || {})
+        def from_hash(hash, *)
+          hash.fetch("_embedded", []).each { |name, fragment| hash[name] = fragment }
+          super
         end
       end
 
@@ -93,8 +92,8 @@ module Roar
       # following the HAL specification: http://stateless.co/hal_specification.html
       #
       #   module SongRepresenter
-      #     include Roar::Representer::JSON
-      #     include Roar::Representer::JSON::HAL::Links
+      #     include Roar::JSON
+      #     include Roar::JSON::HAL::Links
       #
       #     link :self { "http://self" }
       #   end

data/lib/roar/json/json_api.rb

@@ -14,6 +14,11 @@ module Roar
           extend ForCollection
 
           representable_attrs[:resource_representer] = Class.new(Resource::Representer)
+
+          private
+            def create_representation_with(doc, options, format)
+              super(doc, options.merge(:only_body => true), format)
+            end
         end
       end
 

data/lib/roar/version.rb

@@ -1,3 +1,3 @@
 module Roar
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/test/collection_json_test.rb

@@ -1,130 +1,132 @@
 require 'test_helper'
 require 'roar/json/collection_json'
 
-class CollectionJsonTest < MiniTest::Spec
-  let(:song) { OpenStruct.new(:title => "scarifice", :length => 43) }
+if RUBY_ENGINE != "rbx"
+  class CollectionJsonTest < MiniTest::Spec
+    let(:song) { OpenStruct.new(:title => "scarifice", :length => 43) }
 
-  representer_for([Roar::JSON::CollectionJSON]) do
-    version "1.0"
-    href { "//songs/" }
+    representer_for([Roar::JSON::CollectionJSON]) do
+      version "1.0"
+      href { "//songs/" }
 
-    link(:feed) { "//songs/feed" }
+      link(:feed) { "//songs/feed" }
 
-    items(:class => Song) do
-      href { "//songs/scarifice" }
+      items(:class => Song) do
+        href { "//songs/scarifice" }
 
-      property :title, :prompt => "Song title"
-      property :length, :prompt => "Song length"
+        property :title, :prompt => "Song title"
+        property :length, :prompt => "Song length"
 
-      link(:download) { "//songs/scarifice.mp3" }
-      link(:stats) { "//songs/scarifice/stats" }
-    end
+        link(:download) { "//songs/scarifice.mp3" }
+        link(:stats) { "//songs/scarifice/stats" }
+      end
 
-    template do
-      property :title, :prompt => "Song title"
-      property :length, :prompt => "Song length"
-    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 => ""}]}
+      queries do
+        link :search do
+          {:href => "//search", :data => [{:name => "q", :value => ""}]}
+        end
       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}
-            ]
-          },
+    describe "#to_json" do
+      it "renders document" do
+        [song].extend(rpr).to_hash.must_equal(
+        {
+          "collection"=>{
+            "version"=>"1.0",
+            "href"=>"//songs/",
 
-          "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",
+            "template"=>{
               :data=>[
-                {:name=>"title", :value=>"scarifice"},
-                {:name=>"length", :value=>43}
+                {:name=>"title", :value=>nil},
+                {:name=>"length", :value=>nil}
               ]
-            }
-          ],
-
-          "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"}]}}}
+            },
+
+            "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
-  end
 
-  describe "#from_json" do
-    subject { [].extend(rpr).from_json [song].extend(rpr).to_json }
+    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 #version" do
+        subject.version.must_equal "1.0"
+      end
 
-    it "provides #href" do
-      subject.href.must_equal link(:href => "//songs/")
-    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 #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 #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 #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")})
+      it "provides #links" do
+        subject.links.must_equal({"feed" => link(:rel => "feed", :href => "//songs/feed")})
+      end
     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"
+    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
 end

data/test/hal_json_test.rb

@@ -126,8 +126,39 @@ class HalJsonTest < MiniTest::Spec
       @album.links.must_equal nil
     end
   end
+
+end
+
+class JsonHalTest < MiniTest::Spec
+  Album  = Struct.new(:artist, :songs)
+  Artist = Struct.new(:name)
+  Song = Struct.new(:title)
+
+  def self.representer!
+    super([Roar::JSON::HAL])
+  end
+
+  def representer
+    rpr
+  end
+
+  describe "render_nil: false" do
+    representer! do
+      property :artist, embedded: true, render_nil: false do
+        property :name
+      end
+
+      collection :songs, embedded: true, render_empty: false do
+        property :title
+      end
+    end
+
+    it { Album.new(Artist.new("Bare, Jr."), [Song.new("Tobacco Spit")]).extend(representer).to_hash.must_equal({"_embedded"=>{"artist"=>{"name"=>"Bare, Jr."}, "songs"=>[{"title"=>"Tobacco Spit"}]}}) }
+    it { Album.new.extend(representer).to_hash.must_equal({}) }
+  end
 end
 
+
 class LinkCollectionTest < MiniTest::Spec
   subject { Roar::JSON::HAL::LinkCollection.new([:self, "next"]) }
   describe "#is_array?" do
@@ -157,4 +188,4 @@ class HalCurieTest < MiniTest::Spec
   end
 
   it { Object.new.extend(rpr).to_hash.must_equal({"_links"=>{"doc:self"=>{"href"=>"/"}, :curies=>[{"name"=>:doc, "href"=>"//docs/{rel}", "templated"=>true}]}}) }
-end
+end

data/test/integration/runner.rb

@@ -30,13 +30,20 @@ class SslServerRunner < ServerRunner
   end
 end
 
-runner = ServerRunner.new
-runner.run
+begin
+  runner = ServerRunner.new
+  runner.run
 
-ssl_runner = SslServerRunner.new
-ssl_runner.run
+  ssl_runner = SslServerRunner.new
+  ssl_runner.run
 
-Minitest.after_run do
+  Minitest.after_run do
+    runner.kill
+    ssl_runner.kill
+  end
+rescue Exception => e
   runner.kill
   ssl_runner.kill
-end
+
+  raise e
+end

data/test/integration/ssl_server.rb

@@ -15,6 +15,7 @@ crt.issuer = ca
 crt.public_key = key.public_key
 crt.not_before = Time.now
 crt.not_after  = Time.now + 1 * 365 * 24 * 60 * 60 # 1 year
+crt.sign(key, OpenSSL::Digest::SHA1.new)
 webrick_options = {
     :Port               => 8443,
     :SSLEnable          => true,

data/test/json_api_test.rb

@@ -349,6 +349,47 @@ if Gem::Version.new(Representable::VERSION) >= Gem::Version.new("2.1.4") # TODO:
       end
     end
 
+    class CompoundCollectionUsingExtend < self
+      module SongRepresenter
+        include Roar::JSON::JSONAPI
+
+        type :songs
+        property :id
+        property :title
+      end
+
+      module AlbumRepresenter
+        include Roar::JSON::JSONAPI
+
+        type :albums
+        property :id
+        compound do
+          collection :songs, extend: SongRepresenter
+        end
+      end
+
+      let(:songs) do
+        struct = Struct.new(:id, :title)
+        [struct.new(1, 'Stand Up'), struct.new(2, 'Audition Mantra')]
+      end
+
+      let(:album) { Struct.new(:id, :songs).new(1, songs) }
+
+      subject { album.extend(AlbumRepresenter) }
+
+      # to_hash
+      it do
+        subject.to_hash.must_equal({
+          'albums' => { 'id' => 1 },
+          'linked' => {
+            'songs' => [
+              {'id' => 1, 'title' => 'Stand Up'},
+              {'id' => 2, 'title' => 'Audition Mantra'}
+            ]
+          }
+        })
+      end
+    end
 
     class ExplicitMeta < self
       module Representer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-26 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -160,8 +160,11 @@ files:
 - TODO.markdown
 - examples/example.rb
 - examples/example_server.rb
+- gemfiles/Gemfile.representable-1.7
+- gemfiles/Gemfile.representable-1.8
 - gemfiles/Gemfile.representable-2.0
 - gemfiles/Gemfile.representable-2.1
+- gemfiles/Gemfile.representable-head
 - lib/roar.rb
 - lib/roar/client.rb
 - lib/roar/coercion.rb
@@ -227,8 +230,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Parse and render REST API documents using representers.
 test_files: []
+has_rdoc: