jsonapi-renderer 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2ad0e1040698f179b39b373d7aa49c33dfb7b4d
-  data.tar.gz: ac1e411ed64f21568d6c1844e2ca454ea06c3c3f
+  metadata.gz: 64a6b359e09767d1fb82f5c99e5c00493180fee2
+  data.tar.gz: 7cbe497431c5af06536206776c5ea4c791085e3c
 SHA512:
-  metadata.gz: 9c2d55ff1104119ece672fec2c54f6c5dafbc6e1633337540297c792de794630d59c398591fa8d8c2c47b4ce8b68dd286242143959666a8132253a5b5c7b0798
-  data.tar.gz: a6433aae68a2d73985a9ffff73fef853a6ede4bca8d614b8ba098bf54d3e8ba03c4692dbcedba8e6a400648b58ecf7411484ff4a890576e317f30a2a6d9178a7
+  metadata.gz: 560dd5946e8a744de498eabc762f1f90f4c834a215a2b57e58adba24b9b5f6d6e1e5b878123195b82c2ec6f58f64468cdb530159cd30e5bb99f226134238d66a
+  data.tar.gz: 4fdf98ad9829edfc5e254b4df9a7a7f765ee9de05784c76c6f6e35ee73f64b154e75bf40af6953873f0d1cfdeb0dbb096401cc982eac546388930b0219a5741b

data/README.md

@@ -8,6 +8,12 @@ Ruby gem for rendering [JSON API](http://jsonapi.org) documents.
 [![codecov](https://codecov.io/gh/jsonapi-rb/jsonapi-renderer/branch/master/graph/badge.svg)](https://codecov.io/gh/jsonapi-rb/renderer)
 [![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/jsonapi-rb/Lobby)
 
+## Resources
+
+* Chat: [gitter](http://gitter.im/jsonapi-rb)
+* Twitter: [@jsonapirb](http://twitter.com/jsonapirb)
+* Docs: [jsonapi-rb.org](http://jsonapi-rb.org)
+
 ## Installation
 ```ruby
 # In Gemfile
@@ -44,15 +50,15 @@ class ResourceInterface
 
   # Returns a hash containing, for each included relationship, an array of the 
   # resources to be included from that one.
-  # @param [Array<Symbol>] included_relationships The keys of the relationships
+  # @param included_relationships [Array<Symbol>] The keys of the relationships
   #   to be included.
   # @return [Hash{Symbol => Array<#ResourceInterface>}]
   def jsonapi_related(included_relationships); end
 
   # Returns a JSON API-compliant representation of the resource as a hash.
-  # @param [Hash] options
-  #   @option [Array<Symbol>, Nil] fields The requested fields, or nil.
-  #   @option [Array<Symbol>] include The requested relationships to 
+  # @param options [Hash]
+  #   @option fields [Array<Symbol>, Nil] The requested fields, or nil.
+  #   @option include [Array<Symbol>] The requested relationships to 
   #     include (defaults to []).
   # @return [Hash]
   def as_jsonapi(options = {}); end

data/lib/jsonapi/renderer.rb

@@ -1,25 +1,32 @@
 require 'jsonapi/renderer/document'
 
 module JSONAPI
+  class Renderer
+    # Render a JSON API document.
+    #
+    # @param params [Hash]
+    #   @option data [(#jsonapi_id, #jsonapi_type, #jsonapi_related, #as_jsonapi),
+    #           Array<(#jsonapi_id, #jsonapi_type, #jsonapi_related,
+    #           #as_jsonapi)>,
+    #           nil] Primary resource(s) to be rendered.
+    #   @option errors [Array<#jsonapi_id>] Errors to be rendered.
+    #   @option include Relationships to be included. See
+    #     JSONAPI::IncludeDirective.
+    #   @option fields [Hash{Symbol, Array<Symbol>}, Hash{String, Array<String>}]
+    #     List of requested fields for some or all of the resource types.
+    #   @option meta [Hash] Non-standard top-level meta information to be
+    #     included.
+    #   @option links [Hash] Top-level links to be included.
+    #   @option jsonapi_object [Hash] JSON API object.
+    def render(params)
+      Document.new(params).to_hash
+    end
+  end
+
   module_function
 
-  # Render a JSON API document.
-  #
-  # @param [Hash] params
-  #   @option [(#jsonapi_id, #jsonapi_type, #jsonapi_related, #as_jsonapi),
-  #           Array<(#jsonapi_id, #jsonapi_type, #jsonapi_related,
-  #           #as_jsonapi)>,
-  #           nil] data Primary resource(s) to be rendered.
-  #   @option [Array<#jsonapi_id>] errors Errors to be rendered.
-  #   @option include Relationships to be included. See
-  #     JSONAPI::IncludeDirective.
-  #   @option [Hash{Symbol, Array<Symbol>}, Hash{String, Array<String>}] fields
-  #     List of requested fields for some or all of the resource types.
-  #   @option [Hash] meta Non-standard top-level meta information to be
-  #     included.
-  #   @option [Hash] links Top-level links to be included.
-  #   @option [Hash] jsonapi_object JSON API object.
+  # @see JSONAPI::Renderer#render
   def render(params)
-    Renderer::Document.new(params).to_hash
+    Renderer.new.render(params)
   end
 end

data/lib/jsonapi/renderer/document.rb

@@ -2,16 +2,16 @@ require 'jsonapi/include_directive'
 require 'jsonapi/renderer/resources_processor'
 
 module JSONAPI
-  module Renderer
+  class Renderer
     class Document
       def initialize(params = {})
         @data    = params.fetch(:data,    :no_data)
         @errors  = params.fetch(:errors,  [])
-        @meta    = params.fetch(:meta,    nil)
-        @links   = params.fetch(:links,   {})
-        @fields  = _symbolize_fields(params.fetch(:fields, {}))
-        @jsonapi = params.fetch(:jsonapi, nil)
-        @include = JSONAPI::IncludeDirective.new(params.fetch(:include, {}))
+        @meta    = params[:meta]
+        @links   = params[:links] || {}
+        @fields  = _symbolize_fields(params[:fields] || {})
+        @jsonapi = params[:jsonapi]
+        @include = JSONAPI::IncludeDirective.new(params[:include] || {})
       end
 
       def to_hash

data/lib/jsonapi/renderer/resources_processor.rb

@@ -1,7 +1,7 @@
 require 'set'
 
 module JSONAPI
-  module Renderer
+  class Renderer
     class ResourcesProcessor
       def initialize(resources, include, fields)
         @resources = resources

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-renderer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-12 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Render JSONAPI documents.