json_api_responders 2.1.3 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1183871fbe98771c58abcc316bf0f38bdb631668
-  data.tar.gz: 454bfdb1b9172646beee12f2fae8f8b7407aa6d7
+SHA256:
+  metadata.gz: 3794bc90736ec72822b7e6fede32050da28652027b3a5199dd7fc49c57fd78f6
+  data.tar.gz: a154672fc186290a4de9354ad918d282838d691bec4f652d21c0aef487b13d28
 SHA512:
-  metadata.gz: c5a94081106448d1522331b5ea27a66b8c9ccd5fdf99060f7943ca9f7e9a2b788826029b9c69ab506df77429901cc5da2db65bce5d7bf488ac73b759f7b18acc
-  data.tar.gz: 6cb309410bc083aa6084a179dae0fd8a8bbf839a55294ba163001f1ea5acd43eeba2a3e0e57c83fbd5b9f83830b7ca1637f0118abfc980369186289f73f128d0
+  metadata.gz: 1c71f1a4ce435cdb8d5cdbfeae05c1a822ee4e253d1a30184c000de7d9e1c3e9731042950d53bb9a844637fc47b664011859475a07b49a2d85b4b01ff77ab752
+  data.tar.gz: 44c54e7096f25bd0b8f40f25c005be086f9015acfb4b427be22eaa83f8483f02473c0f92b8cfa6f6d0b2dfa27c32e6b4c8e2fad0540f2d916fac6fdbf094e590

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)
-[![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)
+[![Build Status](https://semaphoreci.com/api/v1/infinum/json_api_responders/branches/master/shields_badge.svg)](https://semaphoreci.com/infinum/json_api_responders)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f0735e647a41336a7f0a/maintainability)](https://codeclimate.com/github/infinum/json_api_responders/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/f0735e647a41336a7f0a/test_coverage)](https://codeclimate.com/github/infinum/json_api_responders/test_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,27 +19,56 @@ 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:
 
+    # config/initializers/json_api_responders.rb
     JsonApiResponders.configure do |config|
         config.required_options = {
           index: [:each_serializer],
           create: [:serializer]
         }
     end
-    ...
+
+    # app/controllers/v1/users_controller.rb
     def create
       user = User.create(...)
       respond_with user, serializer: UserSerializer
@@ -63,6 +92,7 @@ If `:serializer` was left out of the above `respond_with` method you would see t
       render json: resource, status: 201
     else
       render error: errors, status: 409
+    end
 
 ### update
 
@@ -70,11 +100,36 @@ If `:serializer` was left out of the above `respond_with` method you would see t
       render json: resource, status: 200
     else
       render error: errors, status: 409
+    end
 
 ### destroy
 
     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.rb

@@ -33,12 +33,12 @@ module JsonApiResponders
 
   private
 
-  def record_not_found!
-    respond_with_error(:not_found)
+  def record_not_found!(reason)
+    respond_with_error(:not_found, reason.message)
   end
 
   def parameter_missing!(reason)
-    respond_with_error(:parameter_missing, reason.message)
+    respond_with_error(:unprocessable_entity, reason.message)
   end
 
   def json_api_parse_options

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.rb

@@ -65,9 +65,17 @@ module JsonApiResponders
 
       errors[:errors] << { detail: on_error(:detail) } if on_error(:detail)
 
-      resource.errors.each do |attribute, message|
-        errors[:errors] << error_response(attribute, message)
-      end if resource.respond_to?(:errors)
+      if resource.respond_to?(:errors)
+        if ActiveModel.version >= Gem::Version.new("6.1")
+          resource.errors.each do |error|
+            errors[:errors] << error_response(error.attribute, error.message)
+          end
+        else
+          resource.errors.each do |attribute, message|
+            errors[:errors] << error_response(attribute, message)
+          end
+        end
+      end
 
       errors
     end

data/lib/json_api_responders/responder/actions.rb

@@ -14,22 +14,22 @@ module JsonApiResponders
       end
 
       def respond_to_create_action
-        if resource.valid?
-          self.status ||= :created
-          render_resource
-        else
+        if has_errors?
           self.status ||= :unprocessable_entity
           render_error
+        else
+          self.status ||= :created
+          render_resource
         end
       end
 
       def respond_to_update_action
-        if resource.valid?
-          self.status ||= :ok
-          render_resource
-        else
+        if has_errors?
           self.status ||= :unprocessable_entity
           render_error
+        else
+          self.status ||= :ok
+          render_resource
         end
       end
 
@@ -43,8 +43,19 @@ module JsonApiResponders
       end
 
       def resource_render_options
-        render_options.merge(json: resource, **options)
+        render_options.merge(Hash[render_method, resource].merge(**options))
       end
+
+      private
+
+      def has_errors?
+        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 = 1
-  PATCH = 3
+  MINOR = 6
+  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.1.3
+  version: 2.6.0
 platform: ruby
 authors:
 - Stanko Krtalić Rusendić
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-10-11 00:00:00.000000000 Z
+date: 2021-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,7 +137,7 @@ homepage: https://github.com/infinum/json_api_responders
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -152,9 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Automatically respond to JSON::API requests
 test_files: []