json_api_responders 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 200e399a5830497129bc96622521fb1babb4439a
-  data.tar.gz: 3e6e7b7f11eee794f26cb7716e82810b82c11256
+  metadata.gz: 6082cfc85b741c549db6f0d8c2a3c430c4723c96
+  data.tar.gz: d60acf9a61be1307044fb219dded909308438b0d
 SHA512:
-  metadata.gz: 52b66e6ad1823e222a2b12ee78ff147dda45b87ff085a47eadfbb439edfd99d340304d7390cf34d037978983c7aafd4053b2a47b2c179203d6365fe3f35c051b
-  data.tar.gz: 28b6d03dc79cc014aac159f5cc1058d17823d0fcc7fd170971374192110f39870da102f71cf53726a45d85728824f8eb7e5e6e941e782eecf27fc575e8d9cb43
+  metadata.gz: 120db92c0eeb5c5daec62e49903df4561ea56a24661c67fcbe873511a9a68569181eb40332d76f1abc75aac8a272b098ffccbeca0b4cce1bcb7e43470da09d03
+  data.tar.gz: b580a033b90d92a053ab0ea37de03d6c809613343230f9b2b6de11641119452572f2b4d0a25886d201e9dfd02fbbf4c16dfd017fb00531ec62da65314177dd4e

data/README.md

@@ -1,11 +1,11 @@
 # JsonApiResponders
 
 [![Gem Version](https://badge.fury.io/rb/json_api_responders.svg)](https://badge.fury.io/rb/json_api_responders)
-[![Build Status](https://semaphoreci.com/api/v1/infinum/json_api_responders/branches/features-missing_responses/shields_badge.svg)](https://semaphoreci.com/infinum/json_api_responders)
+[![Build Status](https://semaphoreci.com/api/v1/infinum/json_api_responders/branches/master/shields_badge.svg)](https://semaphoreci.com/infinum/json_api_responders)
 [![Code Climate](https://codeclimate.com/github/infinum/json_api_responders/badges/gpa.svg)](https://codeclimate.com/github/infinum/json_api_responders)
 [![Test Coverage](https://codeclimate.com/github/infinum/json_api_responders/badges/coverage.svg)](https://codeclimate.com/github/infinum/json_api_responders/coverage)
 
-This gem gives a few convinient methods for working with JSONAPI. It is inspired by responders gem.
+This gem gives a few convenient methods for working with JSONAPI. It is inspired by the [responders](https://github.com/plataformatec/responders) gem.
 
 ## Installation
 
@@ -19,16 +19,43 @@ And then execute:
 
     $ bundle
 
+Inside your base controller, include the module:
+
+```ruby
+module Api
+  module V1
+    class BaseController < ApplicationController
+      include JsonApiResponders
+    end
+  end
+end
+```
+
 ## Usage
 
+This gem comes with the two following methods `respond_with` and `respond_with_error`.
+
+#### `respond_with(resource, options = {}) `
+This method requires a resource as a parameter, and you can pass some options if you wish. Any options you do choose to pass into `respond_with` will be passed on to the `controller.render` method. In the [Configuration section](#configuration) you can learn how to set mandatory options. Bellow you will find a few examples on how to use this method:
+
     user = User.first
     respond_with user
-    respond_with user, on_error: { status: :unauthorized, detail: 'Invalid user or password' }
-    respond_with_error, status: 401, detail: 'Bad credentials'
 
-whatever can be passed to controller.render can be passed here:
+The above example will render the **User** object.
+
+    user = User.first
+    respond_with user, on_error: { 
+    : :unauthorized, detail: 'Invalid user or password' }
+
+The above example will render an **Error** response if an error would occur.
+
+#### `respond_with_error(status, detail = nil)`
+This method requires HTTP status code and an optional parameter explaining the error. This method will render an error message as described in the JSON API specification. Below you can see an example of how it should be used:
+
+    respond_with_error(401, 'Bad credentials')
+    respond_with_error(404, 'Not found')
+    respond_with_error(400, 'Bad request')
 
-    respond_with user, serializer: UserSerializer
 
 ## Configuration
 Currently you can only configure which options are required to be passed through the `respond_with` method. These required options are categorized by the controller's actions. Bellow you can find an example:
@@ -75,6 +102,30 @@ If `:serializer` was left out of the above `respond_with` method you would see t
 
     head status: 204
 
+## Error translations
+
+`json_api_responders` has translation support for error title and details. Copy & paste this file to your `config/locales` folder:
+
+```yml
+en:
+  json_api:
+    errors:
+      not_found:
+        title: Not found
+        detail: Resource not found
+      forbidden:
+        title: Unauthorized
+        detail: User is not authorized to use this resource
+      unprocessable_entity:
+        title: Unprocessable Entity
+        details: Cannot process request
+      conflict:
+        title: Invalid Attribute
+        details: Something is missing
+```
+
+It translates using the format `I18n.t("json_api.errors.#{human_readable_status_code}.title")`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/infinum/json_api_responders.

data/lib/json_api_responders/config.rb

@@ -1,6 +1,8 @@
 module JsonApiResponders
   class Config
     attr_reader :required_options
+    DEFAULT_RENDER_METHOD = :json
+    RENDER_METHODS = [:jsonapi, :json]
 
     def required_options=(opts = {})
       @required_options = opts
@@ -17,6 +19,18 @@ module JsonApiResponders
       end
     end
 
+    def render_method
+      @render_method || DEFAULT_RENDER_METHOD
+    end
+
+    def render_method=(render_method)
+      if RENDER_METHODS.include?(render_method)
+        @render_method = render_method
+      else
+        raise JsonApiResponders::Errors::InvalidRenderMethodError, render_method
+      end
+    end
+
     private
 
     def action(options)

data/lib/json_api_responders/errors.rb

@@ -33,6 +33,19 @@ module JsonApiResponders
       end
     end
 
+    class InvalidRenderMethodError < StandardError
+      attr_reader :render_method
+
+      def initialize(render_method)
+        @render_method = render_method
+        super(message)
+      end
+
+      def message
+        "#{render_method} render method is invalid, must be one of: #{JsonApiResponders::Config::RENDER_METHODS}"
+      end
+    end
+
     class UnknownAction < StandardError
       attr_reader :action
 

data/lib/json_api_responders/responder/actions.rb

@@ -43,7 +43,7 @@ module JsonApiResponders
       end
 
       def resource_render_options
-        render_options.merge(json: resource, **options)
+        render_options.merge(Hash[render_method, resource].merge(**options))
       end
 
       private
@@ -52,6 +52,10 @@ module JsonApiResponders
         resource.respond_to?(:errors) && resource.errors.any?
       end
 
+      def render_method
+        JsonApiResponders.config.render_method
+      end
+
     end
   end
 end

data/lib/json_api_responders/version.rb

@@ -1,6 +1,6 @@
 module JsonApiResponders
   MAJOR = 2
-  MINOR = 2
+  MINOR = 3
   PATCH = 0
   VERSION = [MAJOR, MINOR, PATCH].join('.').freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_responders
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Stanko Krtalić Rusendić
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2017-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Automatically respond to JSON::API requests