jbuilder-json_api 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ff4461806b35c5a3d74588a69c25b2114cb229f
-  data.tar.gz: 14b6437c8ca3707ee94b7ecea417655976fb06d8
+  metadata.gz: bc772003535f958b77e4eca0eca1f9d7daa901bf
+  data.tar.gz: aef3eb54b4d987dc446dc548cd679af965fe692f
 SHA512:
-  metadata.gz: 243d498cce513d4794dfa8babe42ee888f102b5dd328679bf923873597d5c4232425bcb67d329ed5a69ef3808e244066466b4133412b27709ee847ba21d23fc0
-  data.tar.gz: 297d98968a8d93e6628f309e5b21ad9954216327dca0d4962405233c540496f60a588d60a7cca8ba1ce226ecca74d1a356012fe8f42781d54c50e9d14e78b733
+  metadata.gz: 5153c6bda708041667eef1daf765a93ed8f148518fe0f0904d2fbcd969468ad4ecb83219710502433f1c81da32b61c5c9eb48d19c1ee03ecfbd3e90f3e2cbf31
+  data.tar.gz: 4b23517ae45d402b430595420d6845d96f460027700116f2dbbc21177bee1de5f0498d177d4fe34ef66e5a9dfa7aacd33754f6e11e6ec786022a77bac83cc581

data/README.md

@@ -1,13 +1,15 @@
-# Jbuilder::JsonApi | [![Build Status](https://travis-ci.org/vladfaust/jbuilder-json_api.svg?branch=master)](https://travis-ci.org/vladfaust/jbuilder-json_api) [![Code Climate](https://codeclimate.com/github/vladfaust/jbuilder-json_api/badges/gpa.svg)](https://codeclimate.com/github/vladfaust/jbuilder-json_api) [![Test Coverage](https://codeclimate.com/github/vladfaust/jbuilder-json_api/badges/coverage.svg)](https://codeclimate.com/github/vladfaust/jbuilder-json_api/coverage)
+# Jbuilder::JsonApi | [![Gem Version](https://badge.fury.io/rb/jbuilder-json_api.svg)](https://badge.fury.io/rb/jbuilder-json_api) ![](http://ruby-gem-downloads-badge.herokuapp.com/jbuilder-json_api?color=brightgreen) [![Build Status](https://travis-ci.org/vladfaust/jbuilder-json_api.svg?branch=master)](https://travis-ci.org/vladfaust/jbuilder-json_api) [![Dependency Status](https://gemnasium.com/vladfaust/jbuilder-json_api.svg)](https://gemnasium.com/vladfaust/jbuilder-json_api)
 
 Adds a `json.api_format!(resources)` method to quickly represent a resource or collection in a valid [JSON API](http://jsonapi.org/) format without any new superclasses or weird setups. Set'n'go! :rocket:
 
 ## Motivation
 
-Official JSON API [implementations page](http://jsonapi.org/implementations/#server-libraries-ruby) shows us a variety of different serializers and other heavy-weight stuff. I' in love with [Jbuilder](https://github.com/rails/jbuilder), as it allows to format json responses with ease. Therefore I wanted to connect Jbuilder and JsonApi.org specs.
+Official JSON API [implementations page](http://jsonapi.org/implementations/#server-libraries-ruby) shows us a variety of different serializers and other heavy-weight stuff. I'm in love with [Jbuilder](https://github.com/rails/jbuilder), as it allows to format json responses with ease. Therefore I wanted to connect Jbuilder and JsonApi.org specs.
 
 I'd like to notice that there already is one gem called [jbuilder-jsonapi](https://github.com/csexton/jbuilder-jsonapi) by [csexton](https://github.com/csexton), but it adds a links helper only. It's not enough for me! :facepunch:
 
+As a result, I've created a **very** lightweight & flexible solution - all you need is Jbuilder and this gem. Then you should delete everything within your `*.json.jbuilder` files and replace it with below recommendations (just one line! :flushed:). After you are free to customize parsed attributes and relationships with three tiny methods.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -29,10 +31,13 @@ Or install it yourself as:
 Replace any content within any `*.json.jbuilder` file with the code below:
 ```ruby
 # Common example
-json.api_format! @resources, @errors, meta: @meta, access_level: @user_access_level
+json.api_format! @resources, @errors, meta, options
+
+# Items example
+json.api_format! @items, @errors, nil, access_level: :admin
 
-# Articles w/o meta or access levels example
-json.api_format! @articles, @errors
+# A simple items example
+json.api_format! @items
 ```
 You can also render formatted JSON straight from controller actions:
 ```ruby
@@ -41,24 +46,24 @@ respond_to do |f|
     f.html { render nothing: true, status: :bad_request }
 end
 ```
-Each resource instance, as well as the included one, will be invoked with `json_api_attrs` & `json_api_relations` methods. These methods **MAY** be implemented within each model. `api_format!` method will try to get an object's permitted (**you are free do define authentication logic yourself!**) attributes and relations via those two methods.
+Each resource instance, as well as the included one, will be invoked with `json_api_attrs (options)`, `json_api_relations (options)` & `json_api_meta (options)` methods. These methods **MAY** be implemented within each model. `api_format!` method will try to get an object's permitted attributes (**remember, you are free do define authentication logic yourself!**) and relations and meta information via those three methods.
 
 Here is an example of implementation:
 ```ruby
-# Item model
+# Inside Item model
 
-def json_api_attr (access_level = nil)
+def json_api_attrs (options = {})
   attrs = []
-  attrs += %w(name description price buyoutable item_type category) if %i(user admin).include?access_level
-  attrs += %w(real_price in_stock) if access_level == :admin
+  attrs += %w(name description price buyoutable item_type category) if %i(user admin).include?options[:access_level]
+  attrs += %w(real_price in_stock) if options[:access_level] == :admin
   attrs
 end
 
-def json_api_relations (access_level = nil)
+def json_api_relations (options = {})
   %w(category orders)
 end
 ```
-**Note** that the gem will call methods pulled with `json_api_relations and _attrs`. As for the above example, methods like `:name`, `:description`, `:orders` will be invoked for an Item instance. And yes, relations are fetched properly if an object responds to `orders`.
+**Note** that the gem will call methods pulled via `json_api_relations and _attrs`. As for the above example, methods like `:name`, `:description`, `:real_price`, `:orders` will be invoked for an Item instance. And yes, relations are fetched properly and recursively if the object responds to `orders`.
 
 ## Development
 
@@ -73,5 +78,17 @@ Bug reports and pull requests are welcome on GitHub at [https://github.com/vladf
 ## ToDo
 
 - [ ] Maybe add `Content-Type: application/vnd.api+json`. This spec is ignored right now :smirk:
-- [ ] Add links tests
-- [ ] Somehow implement `[fields]` parameter
+- [ ] Add links tests and improve them. Links now work only within views (where `@context` is present).
+- [ ] Somehow implement `[fields]` parameter
+
+## Versions
+
+#### 0.0.1 -> 1.0.0
+
+**Breaking:**
+- [x] Now any value can be forwarded to resources' methods via last `options` argument.
+- [x] Added third argument `meta`, which is used to show meta information in the context of request
+
+**Not breaking:**
+- [x] Added support for `json_api_meta (options)` method.
+- [x] Any internal error is now properly handled.

data/lib/jbuilder/json_api.rb

@@ -5,84 +5,91 @@ module JsonAPI
   # Returns a valid-formatted JSON which follows JSON-API specifications:
   # http://jsonapi.org/
   #
-  # Arguments:
-  #   :resources: - list of resources to render (may be even one or nil)
-  #   :errors: - array of errors in below format:
+  # ==== Arguments
+  # * +resources+ - list of resources to render (may be even one or nil);
+  # * +errors+ - array of hashes in the below format:
   #     [{ status: 422, detail: 'This error occurs because...' }, {...}]
+  # * +meta+ - a hash representing any meta (additional) information.
   #
-  # Options:
-  #   :access_level: - access level, e.g. nil, :user, :admin
-  #   :meta: - a hash representing meta (additional) information
+  # ==== Options
+  # Any information can be passed as +options+ argument; resources' class methods
+  # +json_api_attrs+, +json_api_relations+ and +json_api_meta+
+  # will be invoked with this argument.
   #
-  def api_format! (resources = nil, errors = nil, options = {})
-    options.merge access_level: nil
-    options.merge meta: nil
-
-    # Firstly, print meta
-    # http://jsonapi.org/format/#document-meta
-    #
-    if options[:meta] && !options[:meta].empty?
-      meta options[:meta]
-    end
+  def api_format! (resources = nil, errors = nil, meta = nil, options = {})
+    begin
+      # Firstly, print meta
+      # http://jsonapi.org/format/#document-meta
+      #
+      if meta && !meta.empty?
+        meta meta
+      end
+
+      # Secondly, take care of errors. If there are any,
+      # no 'data' section should be represented.
+      # http://jsonapi.org/format/#document-top-level
+      #
+      # Read more at
+      # http://jsonapi.org/format/#errors
+      #
+      if errors && !errors.empty?
+        ignore_nil! true
+        errors errors do |error|
+          id     error[:id]
+          status error[:status]
+          detail error[:detail]
+          code   error[:code]
+          title  error[:title]
+
+          if error[:source]
+            source do
+              pointer   error[:source][:pointer]
+              paramater error[:source][:parameter]
+            end
+          end
 
-    # Secondly, take care of errors. If there are any,
-    # no 'data' section should be represented.
-    # http://jsonapi.org/format/#document-top-level
-    #
-    # Read more at
-    # http://jsonapi.org/format/#errors
-    #
-    if errors && !errors.empty?
-      ignore_nil! (@ignore_nil.nil? ? true : @ignore_nil)
-      errors errors do |error|
-        id     error[:id]
-        status error[:status]
-        detail error[:detail]
-        code   error[:code]
-        title  error[:title]
-
-        source do
-          pointer   error[:pointer]
-          paramater error[:parameter]
+          if error[:links]
+            links do
+              about error[:links][:about]
+            end
+          end
         end
+        return self
+      end
+
+      resources = [*resources]
 
+      # http://jsonapi.org/format/#document-links
+      #
+      if @context
         links do
-          about error[:about]
+          set! 'self', @context.request.path
         end
       end
-      return self
-    end
-
-    resources = ::Kernel::Array resources
 
-    # http://jsonapi.org/format/#document-links
-    #
-    links do
-      begin
-        set! 'self', @context.request.path
-      rescue
-        # No @context given, cannot find path
+      data do
+        resources.blank? ? array! : _api_resource_objects(resources, options)
       end
-    end
 
-    data do
-      resources.blank? ? array! : _api_resource_objects(resources, options[:access_level])
-    end
+      included = []
+      resources.each do |resource|
+        next unless resource.respond_to?'json_api_relations'
+        resource.json_api_relations(options).each do |relationship|
+          included += [*(resource.send(relationship))]
+        end
+      end
+      included.uniq!
 
-    included = []
-    resources.each do |resource|
-      next unless resource.respond_to?'json_api_relations'
-      resource.json_api_relations(options[:access_level]).each do |relationship|
-        included += ::Kernel::Array(resource.send(relationship))
+      included do
+        _api_resource_objects(included, options, resources) unless included.blank?
       end
-    end
-    included.uniq!
 
-    included do
-      _api_resource_objects(included, options[:access_level], resources) unless included.blank?
+      self
+    rescue Exception => e
+      @attributes = {}
+      message = Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3.0') ? e.original_message : e.message
+      return api_format! nil, [{ status: 500, title: e.class.to_s, detail: message }]
     end
-
-    self
   end
 
   private
@@ -90,7 +97,7 @@ module JsonAPI
   # Formats a resources array properly
   # http://jsonapi.org/format/#document-resource-objects
   #
-  def _api_resource_objects (resources, access_level, parent_resources = nil)
+  def _api_resource_objects (resources, options, parent_resources = nil)
     resources.each do |resource|
       child! do
         type resource.class.name.demodulize.to_s.downcase
@@ -100,7 +107,7 @@ module JsonAPI
         #
         if resource.respond_to?'json_api_attrs'
           attributes do
-            resource.json_api_attrs(access_level).each do |attribute|
+            resource.json_api_attrs(options).each do |attribute|
               set! attribute, resource.send(attribute)
             end
           end
@@ -109,21 +116,19 @@ module JsonAPI
         # http://jsonapi.org/format/#document-resource-object-relationships
         #
         if resource.respond_to?'json_api_relations'
-          unless resource.json_api_relations(access_level).blank?
+          unless resource.json_api_relations(options).blank?
             relationships do
-              resource.json_api_relations(access_level).each do |relationship|
+              resource.json_api_relations(options).each do |relationship|
                 set! relationship do
-                  links do
-                    begin
+                  if @context
+                    links do
                       related @context.send("#{ relationship.pluralize }_path")
-                    rescue
-                      # No @context given, cannot find path
+                      # TODO add a link to the relationship itself
                     end
-                    # TODO add a link to the relationship itself
                   end
 
                   data do
-                    ::Kernel::Array(resource.send(relationship)).each do |relationship_instance|
+                    [*(resource.send(relationship))].each do |relationship_instance|
                       # Relationships shouldn't ever link to the parent resource
                       #
                       next if !parent_resources.nil? && parent_resources.include?(relationship_instance)
@@ -139,11 +144,16 @@ module JsonAPI
           end
         end
 
-        links do
-          begin
+        if resource.respond_to?'json_api_meta'
+          # We don't want to see 'meta': null
+          ignore_nil! true
+          meta resource.json_api_meta(options)
+          ignore_nil! @ignore_nil
+        end
+
+        if @context
+          links do
             set! 'self', @context.send("#{ resource.class.name.demodulize.to_s.downcase }_path", resource)
-          rescue
-            # No @context given, cannot find path
           end
         end
       end

data/lib/jbuilder/json_api/version.rb

@@ -1,3 +1,3 @@
 module JsonAPI
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder-json_api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Vlad Faust