feat(meta): Add metadata to rendered resources.

Adding a root metadata key to responses. By default this will count the number
of items in the response collection. You are also able to pass in a `meta` key
to `#render_resource`. This will be merged into the response's `meta` key.

CHANGELOG.md

@@ -1,3 +1,13 @@
+# Version 1.2.2
+
+## Released February 23, 2019
+
+###
+
+- Feat: Allow passing in a metadata object to `#render_resource`.
+
+---
+
 # Version 1.2.1
 
 ## Released February 23, 2019

lib/onsi/controller.rb

@@ -49,8 +49,10 @@ def inherited(subclass)
     #
     #   - The other keys for opts will be passed directly the #render method.
     def render_resource(resource, opts = {})
+      metadata = opts.delete(:meta)
       version = opts.delete(:version) || self.class.render_version || Model::DEFAULT_API_VERSION
       payload = Resource.render(resource, version)
+      payload[Resource::META_KEY].merge!(metadata) if metadata
       render_options = {}
       render_options[:json] = payload
       render_options.merge!(opts)

lib/onsi/resource.rb

@@ -32,16 +32,16 @@ class Resource
     RELATIONSHIPS_KEY = 'relationships'.freeze
 
     ##
-    # Root object meta key
+    # Root object data key
     #
     # @private
-    META_KEY = 'meta'.freeze
+    DATA_KEY = 'data'.freeze
 
     ##
-    # Root object data key
+    # Metadata key
     #
     # @private
-    DATA_KEY = 'data'.freeze
+    META_KEY = 'meta'.freeze
 
     ##
     # Root object included key
@@ -95,6 +95,9 @@ def render(resource, version)
           if included.any?
             root[INCLUDED_KEY] = included
           end
+          root[META_KEY] = {}.tap do |meta|
+            meta[:count] = resources.count if resources.respond_to?(:count)
+          end
         end
       end
 

lib/onsi/version.rb

@@ -1,5 +1,5 @@
 module Onsi
   ##
   # The current version of Onsi
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.2.2'.freeze
 end