oat 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d444b3c170713aa0e2ff5c54fec3d55303560de
-  data.tar.gz: 2b0619de2dc37f28043a0d641f96fbc428145cc1
+  metadata.gz: d46e82b85714a233bfeb43fb7fd17484ab5b1bfc
+  data.tar.gz: e5d24b98474b575a26e39f0d5b37f32bd24ba51a
 SHA512:
-  metadata.gz: 5622ecddbad73ddbf6c390fcca1ac44cdd282ab1efc69bac16ea6962b7eea76008461a47eefc549962fb99f1346b928f7622f6e9e9f3d269e420bc23e5bdb6e7
-  data.tar.gz: 8f63e0662b6526536d79c4a07d2aadcb0c91b7ca90b25aa183a92c9b5b566d79b6a18c98807e5b816173ccd431f9cb1c9aae6dac7a99b0952e2396e7d412bb94
+  metadata.gz: 588c0d3d4f3f9feacafed50afba811aa7972b5922147084bb85431c998d86e40787fadd5d9c49ddd27fa227dfd20e698f82605cee1f2134e87a4b1056b21159e
+  data.tar.gz: 8bcace9c58e4c84a973aeaa42b457cdcce1e796562489f978b39c7fa400fe5acd7cfde7b9aa69e0c5213a2cb55bdbff39c37b6065a0dbb4a38bd8b7d96d1976f

data/README.md

@@ -113,6 +113,11 @@ class ProductSerializer < Oat::Serializer
 end
 ```
 
+### Defining Links
+
+Links to other resources can be added by using `link` with a name and an options hash. Most adapters expect just an href in the options hash, but some might support additional properties.
+Some adapters also suport passing `templated: true` in the options hash to indicate special treatment of a link template.
+
 ## Adapters
 
 Using the included [HAL](http://stateless.co/hal_specification.html) adapter, the `ProductSerializer` above would render the following JSON:
@@ -464,7 +469,7 @@ class CustomAdapter < Oat::Adapter
   end
 
   def entity(name, obj, serializer_class = nil, &block)
-    data[:nested_documents] = serializer_from_block_or_class(obj, serializer_class, &block)
+    data[:nested_documents] = serializer_from_block_or_class(obj, serializer_class, &block).to_hash
   end
 
   ... etc
@@ -524,7 +529,7 @@ class SocialAdapter < Oat::Adapter
 
   def friends(friend_list, serializer_class = nil, &block)
     data[:friends] = friend_list.map do |obj|
-      serializer_from_block_or_class(obj, serializer_class, &block)
+      serializer_from_block_or_class(obj, serializer_class, &block).to_hash
     end
   end
 end
@@ -582,7 +587,7 @@ Or install it yourself as:
 
 ## TODO / contributions welcome
 
-* JsonAPI URL and ID modes, top-level links
+* JsonAPI top-level meta
 * testing module that can be used for testing spec-compliance in user apps?
 
 ## Contributing

data/gemfiles/Gemfile.as-1.4.4

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in oat.gemspec
 gem 'activesupport', '1.4.4'
+gem 'rake', '< 10.2'
 gemspec :path => "../"

data/gemfiles/Gemfile.as-2.3.x

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in oat.gemspec
 gem 'activesupport', '~>2.3.18'
+gem 'rake', '< 10.2'
 gemspec :path => "../"

data/gemfiles/Gemfile.as-3.0.x

@@ -3,4 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in oat.gemspec
 gem 'activesupport', '~>3.0.20'
 gem 'i18n'
+gem 'rake', '< 10.2'
 gemspec :path => "../"

data/gemfiles/Gemfile.as-3.1.x

@@ -3,4 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in oat.gemspec
 gem 'activesupport', '~>3.1.12'
 gem 'i18n'
+gem 'rake', '< 10.2'
 gemspec :path => "../"

data/gemfiles/Gemfile.as-3.2.x

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in oat.gemspec
 gem 'activesupport', '~>3.2.16'
+gem 'rake', '< 10.2'
 gemspec :path => "../"

data/lib/oat/adapter.rb

@@ -29,9 +29,9 @@ module Oat
         serializer_class.adapter self.class
         s = serializer_class.new(obj, serializer.context.merge(context_options), serializer.adapter_class, serializer.top)
         serializer.instance_exec(obj, s, &block)
-        s.to_hash
+        s
       else
-        serializer_class.new(obj, serializer.context.merge(context_options), serializer.adapter_class, serializer.top).to_hash
+        serializer_class.new(obj, serializer.context.merge(context_options), serializer.adapter_class, serializer.top)
       end
     end
   end

data/lib/oat/adapters/hal.rb

@@ -15,12 +15,14 @@ module Oat
       end
 
       def entity(name, obj, serializer_class = nil, context_options = {}, &block)
-        data[:_embedded][name] = serializer_from_block_or_class(obj, serializer_class, context_options, &block)
+        entity_serializer = serializer_from_block_or_class(obj, serializer_class, context_options, &block)
+        data[:_embedded][name] = entity_serializer ? entity_serializer.to_hash : nil
       end
 
       def entities(name, collection, serializer_class = nil, context_options = {}, &block)
         data[:_embedded][name] = collection.map do |obj|
-          serializer_from_block_or_class(obj, serializer_class, context_options, &block)
+          entity_serializer = serializer_from_block_or_class(obj, serializer_class, context_options, &block)
+          entity_serializer ? entity_serializer.to_hash : nil
         end
       end
       alias_method :collection, :entities

data/lib/oat/adapters/json_api.rb

@@ -9,11 +9,13 @@ end
 
 module Oat
   module Adapters
+
     class JsonAPI < Oat::Adapter
 
       def initialize(*args)
         super
         @entities = {}
+        @link_templates = {}
       end
 
       def type(*types)
@@ -21,9 +23,34 @@ module Oat
       end
 
       def link(rel, opts = {})
-        data[:links][rel] = opts[:href]
+        if opts.is_a?(Hash)
+          templated = opts.delete(:templated)
+          if templated
+            link_template(rel, opts[:href])
+          else
+            check_link_keys(opts)
+          end
+        end
+        data[:links][rel] = opts
       end
 
+      def check_link_keys(opts)
+        unsupported_opts = opts.keys - [:href, :id, :ids, :type]
+
+        unless unsupported_opts.empty?
+          raise ArgumentError, "Unsupported opts: #{unsupported_opts.join(", ")}"
+        end
+        if opts.has_key?(:id) && opts.has_key?(:ids)
+          raise ArgumentError, "ops canot contain both :id and :ids"
+        end
+      end
+      private :check_link_keys
+
+      def link_template(key, value)
+        @link_templates[key] = value
+      end
+      private :link_template
+
       def properties(&block)
         data.merge! yield_props(&block)
       end
@@ -35,9 +62,10 @@ module Oat
       def entity(name, obj, serializer_class = nil, context_options = {}, &block)
         ent = serializer_from_block_or_class(obj, serializer_class, context_options, &block)
         if ent
+          ent_hash = ent.to_hash
           entity_hash[name.to_s.pluralize.to_sym] ||= []
-          link name, :href => ent[:id]
-          entity_hash[name.to_s.pluralize.to_sym] << ent
+          data[:links][name] = ent_hash[:id]
+          entity_hash[name.to_s.pluralize.to_sym] << ent_hash
         end
       end
 
@@ -50,8 +78,9 @@ module Oat
           entity_hash[link_name] ||= []
           ent = serializer_from_block_or_class(obj, serializer_class, context_options, &block)
           if ent
-            data[:links][link_name] << ent[:id]
-            entity_hash[link_name] << ent
+            ent_hash = ent.to_hash
+            data[:links][link_name] << ent_hash[:id]
+            entity_hash[link_name] << ent_hash
           end
         end
       end
@@ -62,7 +91,7 @@ module Oat
 
         collection.each do |obj|
           ent = serializer_from_block_or_class(obj, serializer_class, context_options, &block)
-          data[:resource_collection] << ent if ent
+          data[:resource_collection] << ent.to_hash if ent
         end
       end
 
@@ -78,6 +107,7 @@ module Oat
             h[root_name] = [data]
           end
           h[:linked] = @entities if @entities.keys.any?
+          h[:links] = @link_templates if @link_templates.keys.any?
           return h
         end
       end
@@ -94,6 +124,11 @@ module Oat
         end
       end
 
+      def entity_without_root(obj, serializer_class = nil, &block)
+        ent = serializer_from_block_or_class(obj, serializer_class, &block)
+        ent.to_hash.values.first.first if ent
+      end
+
     end
   end
 end

data/lib/oat/adapters/siren.rb

@@ -28,7 +28,7 @@ module Oat
 
       def entity(name, obj, serializer_class = nil, context_options = {}, &block)
         ent = serializer_from_block_or_class(obj, serializer_class, context_options, &block)
-        data[:entities] << ent if ent
+        data[:entities] << ent.to_hash if ent
       end
 
       def entities(name, collection, serializer_class = nil, context_options = {}, &block)

data/lib/oat/version.rb

@@ -1,3 +1,3 @@
 module Oat
-  VERSION = "0.2.5"
+  VERSION = "0.3.0"
 end

data/spec/adapters/json_api_spec.rb

@@ -25,7 +25,9 @@ describe Oat::Adapters::JsonAPI do
 
       it 'contains the correct user links' do
         expect(users.first.fetch(:links)).to include(
-          :self => "http://foo.bar.com/#{user.id}",
+          :self => {
+            :href => "http://foo.bar.com/#{user.id}"
+          },
           # these links are added by embedding entities
           :manager => manager.id,
           :friends => [friend.id]
@@ -51,8 +53,9 @@ describe Oat::Adapters::JsonAPI do
 
         it 'contains the correct links' do
           expect(linked_friends.first.fetch(:links)).to include(
-            :self => "http://foo.bar.com/#{friend.id}",
-            :empty => nil
+            :self => {
+              :href => "http://foo.bar.com/#{friend.id}"
+            }
           )
         end
       end
@@ -66,7 +69,7 @@ describe Oat::Adapters::JsonAPI do
             :id => manager.id,
             :name => manager.name,
             :age => manager.age,
-            :links => { :self => "http://foo.bar.com/#{manager.id}" }
+            :links => { :self => { :href => "http://foo.bar.com/#{manager.id}"} }
           )
         end
       end
@@ -84,6 +87,116 @@ describe Oat::Adapters::JsonAPI do
       end
     end
 
+    context 'object links' do
+      context "as string" do
+        let(:serializer_class) do
+          Class.new(Oat::Serializer) do
+            schema do
+              type 'users'
+              link :self, "45"
+            end
+          end
+        end
+
+        it 'renders just the string' do
+          expect(hash.fetch(:users).first.fetch(:links)).to eq({
+            :self => "45"
+          })
+        end
+      end
+
+      context 'as array' do
+        let(:serializer_class) do
+          Class.new(Oat::Serializer) do
+            schema do
+              type 'users'
+              link :self, ["45", "46", "47"]
+            end
+          end
+        end
+
+        it 'renders the array' do
+          expect(hash.fetch(:users).first.fetch(:links)).to eq({
+            :self => ["45", "46", "47"]
+          })
+        end
+      end
+
+      context 'as hash' do
+        context 'with single id' do
+          let(:serializer_class) do
+            Class.new(Oat::Serializer) do
+              schema do
+                type 'users'
+                link :self, :href => "http://foo.bar.com/#{item.id}", :id => item.id.to_s, :type => 'user'
+              end
+            end
+          end
+
+          it 'renders all the keys' do
+            expect(hash.fetch(:users).first.fetch(:links)).to eq({
+              :self => {
+                :href => "http://foo.bar.com/#{user.id}",
+                :id => user.id.to_s,
+                :type => 'user'
+              }
+            })
+          end
+        end
+
+        context 'with ids' do
+          let(:serializer_class) do
+            Class.new(Oat::Serializer) do
+              schema do
+                type 'users'
+                link :self, :href => "http://foo.bar.com/1,2,3", :ids => ["1", "2", "3"], :type => 'user'
+              end
+            end
+          end
+
+          it 'renders all the keys' do
+            expect(hash.fetch(:users).first.fetch(:links)).to eq({
+              :self => {
+                :href => "http://foo.bar.com/1,2,3",
+                :ids => ["1", "2", "3"],
+                :type => 'user'
+              }
+            })
+          end
+        end
+
+        context 'with id and ids' do
+          let(:serializer_class) do
+            Class.new(Oat::Serializer) do
+              schema do
+                type 'users'
+                link :self, :id => "45", :ids => ["1", "2", "3"]
+              end
+            end
+          end
+
+          it "errs" do
+            expect{hash}.to raise_error(ArgumentError)
+          end
+        end
+
+        context 'with invalid keys' do
+          let(:serializer_class) do
+            Class.new(Oat::Serializer) do
+              schema do
+                type 'users'
+                link :self, :not_a_valid_key => "value"
+              end
+            end
+          end
+
+          it "errs" do
+            expect{hash}.to raise_error(ArgumentError)
+          end
+        end
+      end
+    end
+
     context 'with a nil entity relationship' do
       let(:manager) { nil }
       let(:users) { hash.fetch(:users) }
@@ -169,7 +282,7 @@ describe Oat::Adapters::JsonAPI do
 
         it 'contains the correct user links' do
           expect(users.first.fetch(:links)).to include(
-            :self => "http://foo.bar.com/#{user.id}",
+            :self => {:href => "http://foo.bar.com/#{user.id}"},
             # these links are added by embedding entities
             :manager => manager.id,
             :friends => [friend.id]
@@ -185,12 +298,30 @@ describe Oat::Adapters::JsonAPI do
               :id => manager.id,
               :name => manager.name,
               :age => manager.age,
-              :links => { :self => "http://foo.bar.com/#{manager.id}" }
+              :links => { :self => {:href =>"http://foo.bar.com/#{manager.id}"} }
             )
           end
         end
       end
+    end
+
+    context 'link_template' do
+      let(:serializer_class) do
+        Class.new(Oat::Serializer) do
+          schema do
+            type 'users'
+            link "user.managers", :href => "http://foo.bar.com/{user.id}/managers", :templated => true
+            link "user.friends",  :href => "http://foo.bar.com/{user.id}/friends", :templated => true
+          end
+        end
+      end
 
+      it 'renders them top level' do
+        expect(hash.fetch(:links)).to eq({
+          "user.managers" => "http://foo.bar.com/{user.id}/managers",
+          "user.friends"  => "http://foo.bar.com/{user.id}/friends"
+        })
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oat
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport