oat 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA1: 
-  metadata.gz: 89c8d41bf1fe016c6e714fc2cf8884de9b3b8af9
-  data.tar.gz: 2022badfdfa88afe0677b21203efa51ba5e05eba
-SHA512: 
-  metadata.gz: c819633a5ad0726b9176ddd90abd7548a53b29a123ee078815e54f275484b1b2c36dd035e0beeef89ff152ccad4b0a912a94884c03527f3b192fc1437538992e
-  data.tar.gz: a55145b6cecfd76f845e5ab7e952302545369d9bbeb7c558979f6ad7ac13397e94cd2ee39461be1278c5fa1c654729f5df1eba2d7d6d9d04df045e058656e535
+---
+SHA1:
+  metadata.gz: 893259bf479fe9a2252a4808283fb66b61a072c1
+  data.tar.gz: ff6de9dc5fdb82bdb5f8488bed683289921b65c7
+SHA512:
+  metadata.gz: d9210ee288987100dddc96fe006c0285d0f28f225a70fb6f38119fa4c36ccc723e90fe603312e9be5df1bdde2161870e0df632d67c32e79e7e13af6458af3b61
+  data.tar.gz: 05d979883b19f1b84c7299c5bc3cf630f55e19ab336f3c77b33d059a1db51fdd29648a2c0f3981e632b4cc3a9215c29c2cf107176329013c8d63a9808e388217

data/README.md

@@ -118,6 +118,12 @@ end
 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.
 
+
+### Adding meta-information
+
+You can add meta-information about your JSON document via `meta :property, "value"`. When using the [JsonAPI](http://jsonapi.org/) adapter these properties are rendered in a [top level "meta" node](http://jsonapi.org/format/#document-top-level). When using the HAL or Siren adapters `meta` just acts as an alias to `property`, so the properties are rendered like normal properties.
+
+
 ## Adapters
 
 Using the included [HAL](http://stateless.co/hal_specification.html) adapter, the `ProductSerializer` above would render the following JSON:

data/lib/oat/adapters/hal.rb

@@ -14,6 +14,8 @@ module Oat
         data[key] = value
       end
 
+      alias_method :meta, :property
+
       def entity(name, obj, serializer_class = nil, 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

data/lib/oat/adapters/json_api.rb

@@ -16,6 +16,7 @@ module Oat
         super
         @entities = {}
         @link_templates = {}
+        @meta = {}
       end
 
       def type(*types)
@@ -59,6 +60,10 @@ module Oat
         data[key] = value
       end
 
+      def meta(key, value)
+        @meta[key] = value
+      end
+
       def entity(name, obj, serializer_class = nil, context_options = {}, &block)
         ent = serializer_from_block_or_class(obj, serializer_class, context_options, &block)
         if ent
@@ -108,6 +113,7 @@ module Oat
           end
           h[:linked] = @entities if @entities.keys.any?
           h[:links] = @link_templates if @link_templates.keys.any?
+          h[:meta] = @meta if @meta.keys.any?
           return h
         end
       end

data/lib/oat/adapters/siren.rb

@@ -26,6 +26,8 @@ module Oat
         data[:properties][key] = value
       end
 
+      alias_method :meta, :property
+
       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.to_hash if ent
@@ -36,6 +38,7 @@ module Oat
           entity name, obj, serializer_class, context_options, &block
         end
       end
+
       alias_method :collection, :entities
 
       def action(name, &block)

data/lib/oat/serializer.rb

@@ -45,7 +45,6 @@ module Oat
       end
     end
 
-
     def respond_to_missing?(method_name, include_private = false)
       adapter.respond_to? method_name
     end

data/lib/oat/version.rb

@@ -1,3 +1,3 @@
 module Oat
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/spec/adapters/hal_spec.rb

@@ -16,7 +16,9 @@ describe Oat::Adapters::HAL do
         :name => user.name,
         :age => user.age,
         :controller_name => 'some_controller',
-        :message_from_above => nil
+        :message_from_above => nil,
+        # Meta property
+        :nation => 'zulu'
       )
 
       # links

data/spec/adapters/json_api_spec.rb

@@ -35,6 +35,28 @@ describe Oat::Adapters::JsonAPI do
       end
     end
 
+    context 'meta' do
+      subject(:meta) { hash.fetch(:meta) }
+
+      it 'contains meta properties' do
+        expect(meta[:nation]).to eq('zulu')
+      end
+
+      context 'without meta' do
+        let(:serializer_class) {
+           Class.new(Oat::Serializer) do
+              schema do
+                type 'users'
+              end
+            end
+        }
+
+        it 'does not contain meta information' do
+          expect(hash[:meta]).to be_nil
+        end
+      end
+    end
+
     context 'linked' do
       context 'using #entities' do
         subject(:linked_friends){ hash.fetch(:linked).fetch(:friends) }

data/spec/adapters/siren_spec.rb

@@ -17,7 +17,9 @@ describe Oat::Adapters::Siren do
         :name => user.name,
         :age => user.age,
         :controller_name => 'some_controller',
-        :message_from_above => nil
+        :message_from_above => nil,
+        # Meta property
+        :nation => 'zulu'
       )
 
       expect(hash.fetch(:links).size).to be 2
@@ -57,7 +59,7 @@ describe Oat::Adapters::Siren do
 
       # action close_account
       actions = hash.fetch(:actions)
-      expect(actions.size).to be 1
+      expect(actions.size).to eql(1)
       expect(actions.first).to include(
         :name => :close_account,
         :href => "http://foo.bar.com/#{user.id}/close_account",

data/spec/fixtures.rb

@@ -14,6 +14,8 @@ module Fixtures
           link :self, :href => url_for(item.id)
           link :empty, :href => nil
 
+          meta :nation, 'zulu'
+
           property :id, item.id
           map_properties :name, :age
           properties do |attrs|
@@ -33,7 +35,7 @@ module Fixtures
             end
           end
 
-          if respond_to?(:action)
+          if adapter.respond_to?(:action)
             action :close_account do |action|
               action.href "http://foo.bar.com/#{item.id}/close_account"
               action.class 'danger'

metadata

@@ -1,63 +1,80 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: oat
-version: !ruby/object:Gem::Version 
-  version: 0.4.0
+version: !ruby/object:Gem::Version
+  version: 0.4.1
 platform: ruby
-authors: 
+authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-04-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - &id003 
-      - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id003
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    requirements: 
-    - *id003
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-description: Oat helps you separate your API schema definitions from the underlying media type. Media types can be plugged or swapped on demand globally or on the content-negotiation phase
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Oat helps you separate your API schema definitions from the underlying
+  media type. Media types can be plugged or swapped on demand globally or on the content-negotiation
+  phase
+email:
 - ismaelct@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
@@ -89,33 +106,33 @@ files:
 - spec/serializer_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ismasan/oat
-licenses: 
+licenses:
 - MIT
 metadata: {}
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id003
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - *id003
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Adapters-based serializers with Hypermedia support
-test_files: 
+test_files:
 - spec/adapters/hal_spec.rb
 - spec/adapters/json_api_spec.rb
 - spec/adapters/siren_spec.rb
 - spec/fixtures.rb
 - spec/serializer_spec.rb
 - spec/spec_helper.rb
-has_rdoc: