jsonapi-rails 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29c73976a2fb4451e84ad275247518ed54bfe660
-  data.tar.gz: 58417d63bcfc17109fce8a6e8527ef1324c234e8
+  metadata.gz: c4ddfbba5b18351a7d69d74537a47c821e717397
+  data.tar.gz: 79ec8e0be87a8aa3110e0e927b449fbf46e85ce6
 SHA512:
-  metadata.gz: ef952c74fbf3c00e06ce25bfc7775ff92faf25c59fd080b64a9ceec0755ba5235e8f883986f411e24bf664de0ad22fcd947ddd49492f2b6fb0c435f379c042c8
-  data.tar.gz: 03b7cd4763b50cab7a90e357216f21fe7df4f2c892271896e76710d4e3fc084c4a7ceabdfd4e11d4cea988422a64ccb752146de9b6cb41d206eed0d9ab1c6e2f
+  metadata.gz: 8d2958f2136d6a613ade5d7a713dbfa7d12f4d6d233a1e23f119b2d8a2fd57d8052c9d821a2993b1377b6fa843b250cc4bf59b5205fcb345cdd98de7851083fd
+  data.tar.gz: e42703a777344cc33da29a6a2ccae04f68f58c4fdcf399d5e20fedc30a7033c9646941aa2bd1b5712756e008999f11c2a782ffb1438f5c82fa6ac1300f9007c6

data/lib/generators/jsonapi/initializer/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Generates an initializer for jsonapi-rails.
+
+Example:
+    `rails generate jsonapi:initializer`

data/lib/generators/jsonapi/initializer/initializer_generator.rb

@@ -0,0 +1,7 @@
+class InitializerGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def copy_initializer_file
+    copy_file 'initializer.rb', 'config/initializers/jsonapi.rb'
+  end
+end

data/lib/generators/jsonapi/initializer/templates/initializer.rb

@@ -0,0 +1,31 @@
+JSONAPI::Rails.configure do |config|
+  # # Set a default serializable class mapping.
+  # config.jsonapi_class = Hash.new { |h, k|
+  #   names = k.to_s.split('::')
+  #   klass = names.pop
+  #   h[k] = [*names, "Serializable#{klass}"].join('::').safe_constantize
+  # }
+  #
+  # # Set a default serializable class mapping for errors.
+  # config.jsonapi_errors_class = Hash.new { |h, k|
+  #   names = k.to_s.split('::')
+  #   klass = names.pop
+  #   h[k] = [*names, "Serializable#{klass}"].join('::').safe_constantize
+  # }.tap { |h|
+  #   h[:'ActiveModel::Errors'] = JSONAPI::Rails::SerializableActiveModelErrors
+  #   h[:Hash] = JSONAPI::Rails::SerializableErrorHash
+  # }
+  #
+  # # Set a default JSON API object.
+  # config.jsonapi_object = {
+  #   version: '1.0'
+  # }
+  #
+  # # Set default exposures.
+  # config.jsonapi_expose = {
+  #   url_helpers: ::Rails.application.routes.url_helpers
+  # }
+  #
+  # # Set a default pagination scheme.
+  # config.jsonapi_pagination = ->(_) { nil }
+end

data/lib/jsonapi/rails/configuration.rb

@@ -0,0 +1,45 @@
+require 'jsonapi/rails/serializable_active_model_errors'
+require 'jsonapi/rails/serializable_error_hash'
+
+module JSONAPI
+  module Rails
+    class Configuration < ActiveSupport::InheritableOptions; end
+    DEFAULT_JSONAPI_CLASS = Hash.new do |h, k|
+      names = k.to_s.split('::')
+      klass = names.pop
+      h[k] = [*names, "Serializable#{klass}"].join('::').safe_constantize
+    end.freeze
+
+    DEFAULT_JSONAPI_ERRORS_CLASS = DEFAULT_JSONAPI_CLASS.dup.merge!(
+      'ActiveModel::Errors'.to_sym =>
+        JSONAPI::Rails::SerializableActiveModelErrors,
+      'Hash'.to_sym => JSONAPI::Rails::SerializableErrorHash
+    ).freeze
+
+    DEFAULT_JSONAPI_OBJECT = {
+      version: '1.0'
+    }.freeze
+
+    DEFAULT_JSONAPI_EXPOSE = {
+      url_helpers: ::Rails.application.routes.url_helpers
+    }.freeze
+
+    DEFAULT_JSONAPI_PAGINATION = ->(_) { nil }
+
+    DEFAULT_CONFIG = {
+      jsonapi_class: DEFAULT_JSONAPI_CLASS,
+      jsonapi_errors_class: DEFAULT_JSONAPI_ERRORS_CLASS,
+      jsonapi_object: DEFAULT_JSONAPI_OBJECT,
+      jsonapi_expose: DEFAULT_JSONAPI_EXPOSE,
+      jsonapi_pagination: DEFAULT_JSONAPI_PAGINATION
+    }.freeze
+
+    def self.configure
+      yield config
+    end
+
+    def self.config
+      @config ||= JSONAPI::Rails::Configuration.new(DEFAULT_CONFIG)
+    end
+  end
+end

data/lib/jsonapi/rails/controller.rb

@@ -0,0 +1,126 @@
+require 'jsonapi/deserializable'
+require 'jsonapi/parser'
+require 'jsonapi/rails/configuration'
+
+module JSONAPI
+  module Rails
+    module Deserializable
+      # @private
+      class Resource < JSONAPI::Deserializable::Resource
+        id
+        type
+        attributes
+        has_one do |_rel, id, type, key|
+          type = type.to_s.singularize.camelize
+          { "#{key}_id".to_sym => id, "#{key}_type".to_sym => type }
+        end
+        has_many do |_rel, ids, types, key|
+          key   = key.to_s.singularize
+          types = types.map { |t| t.to_s.singularize.camelize }
+          { "#{key}_ids".to_sym => ids, "#{key}_types".to_sym => types }
+        end
+      end
+    end
+
+    # ActionController methods and hooks for JSON API deserialization and
+    #   rendering.
+    module Controller
+      extend ActiveSupport::Concern
+
+      JSONAPI_POINTERS_KEY = 'jsonapi-rails.jsonapi_pointers'.freeze
+
+      class_methods do
+        # Declare a deserializable resource.
+        #
+        # @param key [Symbol] The key under which the deserialized hash will be
+        #   available within the `params` hash.
+        # @param options [Hash]
+        # @option class [Class] A custom deserializer class. Optional.
+        # @option only List of actions for which deserialization should happen.
+        #   Optional.
+        # @option except List of actions for which deserialization should not
+        #   happen. Optional.
+        # @yieldreturn Optional block for in-line definition of custom
+        #   deserializers.
+        #
+        # @example
+        #   class ArticlesController < ActionController::Base
+        #     deserializable_resource :article, only: [:create, :update]
+        #
+        #     def create
+        #       article = Article.new(params[:article])
+        #
+        #       if article.save
+        #         render jsonapi: article
+        #       else
+        #         render jsonapi_errors: article.errors
+        #       end
+        #     end
+        #
+        #     # ...
+        #   end
+        #
+        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def deserializable_resource(key, options = {}, &block)
+          options = options.dup
+          klass = options.delete(:class) ||
+                  Class.new(JSONAPI::Rails::Deserializable::Resource, &block)
+
+          before_action(options) do |controller|
+            # TODO(lucas): Fail with helpful error message if _jsonapi not
+            #   present.
+            hash = controller.params[:_jsonapi].to_unsafe_hash
+            ActiveSupport::Notifications
+              .instrument('parse.jsonapi', payload: hash, class: klass) do
+              JSONAPI::Parser::Resource.parse!(hash)
+              resource = klass.new(hash[:data])
+              controller.request.env[JSONAPI_POINTERS_KEY] =
+                resource.reverse_mapping
+              controller.params[key.to_sym] = resource.to_hash
+            end
+          end
+        end
+        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+      end
+
+      # Hook for serializable class mapping (for resources).
+      # Overridden by the `class` renderer option.
+      # @return [Hash{Symbol=>Class}]
+      def jsonapi_class
+        JSONAPI::Rails.config[:jsonapi_class]
+      end
+
+      # Hook for serializable class mapping (for errors).
+      # Overridden by the `class` renderer option.
+      # @return [Hash{Symbol=>Class}]
+      def jsonapi_errors_class
+        JSONAPI::Rails.config[:jsonapi_errors_class]
+      end
+
+      # Hook for the jsonapi object.
+      # Overridden by the `jsonapi_object` renderer option.
+      # @return [Hash]
+      def jsonapi_object
+        JSONAPI::Rails.config[:jsonapi_object]
+      end
+
+      # Hook for default exposures.
+      # @return [Hash]
+      def jsonapi_expose
+        JSONAPI::Rails.config[:jsonapi_expose]
+      end
+
+      # Hook for pagination scheme.
+      # @return [Hash]
+      def jsonapi_pagination(resources)
+        instance_exec(resources, &JSONAPI::Rails.config[:jsonapi_pagination])
+      end
+
+      # JSON pointers for deserialized fields.
+      # @return [Hash{Symbol=>String}]
+      def jsonapi_pointers
+        request.env[JSONAPI_POINTERS_KEY] || {}
+      end
+    end
+  end
+end

data/lib/jsonapi/rails/railtie.rb

@@ -2,61 +2,66 @@ require 'rails/railtie'
 require 'action_controller'
 require 'active_support'
 
-require 'jsonapi/rails/parser'
 require 'jsonapi/rails/renderer'
 
 module JSONAPI
   module Rails
+    # @private
     class Railtie < ::Rails::Railtie
       MEDIA_TYPE = 'application/vnd.api+json'.freeze
+      PARSER = lambda do |body|
+        data = JSON.parse(body)
+        hash = { _jsonapi: data }
+
+        hash.with_indifferent_access
+      end
       RENDERERS = {
-        jsonapi:       SuccessRenderer.new,
-        jsonapi_error: ErrorsRenderer.new
+        jsonapi:        SuccessRenderer.new,
+        jsonapi_errors: ErrorsRenderer.new
       }.freeze
 
-      initializer 'jsonapi-rails.action_controller' do
+      initializer 'jsonapi-rails.init' do
+        register_mime_type
+        register_parameter_parser
+        register_renderers
         ActiveSupport.on_load(:action_controller) do
-          require 'jsonapi/rails/action_controller'
-          include ::JSONAPI::Rails::ActionController
-
-          Mime::Type.register MEDIA_TYPE, :jsonapi
-
-          if ::Rails::VERSION::MAJOR >= 5
-            ::ActionDispatch::Request.parameter_parsers[:jsonapi] = PARSER
-          else
-            ::ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime[:jsonapi]] = PARSER
-          end
+          require 'jsonapi/rails/controller'
+          include ::JSONAPI::Rails::Controller
+        end
+      end
 
-          ::ActionController::Renderers.add(:jsonapi) do |resources, options|
-            self.content_type ||= Mime[:jsonapi]
+      private
 
-            RENDERERS[:jsonapi].render(resources, options).to_json
-          end
-
-          ::ActionController::Renderers.add(:jsonapi_error) do |errors, options|
-            # Renderer proc is evaluated in the controller context, so it
-            # has access to the jsonapi_pointers method.
-            options = options.merge(_jsonapi_pointers: jsonapi_pointers)
-            self.content_type ||= Mime[:jsonapi]
+      def register_mime_type
+        Mime::Type.register(MEDIA_TYPE, :jsonapi)
+      end
 
-            RENDERERS[:jsonapi_error].render(errors, options).to_json
-          end
+      def register_parameter_parser
+        if ::Rails::VERSION::MAJOR >= 5
+          ActionDispatch::Request.parameter_parsers[:jsonapi] = PARSER
+        else
+          ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime[:jsonapi]] = PARSER
+        end
+      end
 
-          JSONAPI::Deserializable::Resource.configure do |config|
-            config.default_has_one do |key, _rel, id, type|
-              key  = key.to_s.singularize
-              type = type.to_s.singularize.camelize
-              { "#{key}_id".to_sym => id, "#{key}_type".to_sym => type }
-            end
+      # rubocop:disable Metrics/MethodLength
+      def register_renderers
+        ActiveSupport.on_load(:action_controller) do
+          RENDERERS.each do |name, renderer|
+            ::ActionController::Renderers.add(name) do |resources, options|
+              # Renderer proc is evaluated in the controller context.
+              self.content_type ||= Mime[:jsonapi]
 
-            config.default_has_many do |key, _rel, ids, types|
-              key   = key.to_s.singularize
-              types = types.map { |t| t.to_s.singularize.camelize }
-              { "#{key}_ids".to_sym => ids, "#{key}_types".to_sym => types }
+              ActiveSupport::Notifications.instrument('render.jsonapi',
+                                                      resources: resources,
+                                                      options: options) do
+                renderer.render(resources, options, self).to_json
+              end
             end
           end
         end
       end
+      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/jsonapi/rails/renderer.rb

@@ -2,36 +2,63 @@ require 'jsonapi/serializable/renderer'
 
 module JSONAPI
   module Rails
+    # @private
     class SuccessRenderer
-      def initialize(renderer = JSONAPI::Serializable::SuccessRenderer.new)
+      def initialize(renderer = JSONAPI::Serializable::Renderer.new)
         @renderer = renderer
 
         freeze
       end
 
-      def render(resources, options)
-        opts = options.dup
-        # TODO(beauby): Move this to a global configuration.
-        default_exposures = {
-          url_helpers: ::Rails.application.routes.url_helpers
-        }
-        opts[:expose] = default_exposures.merge!(opts[:expose] || {})
-        opts[:jsonapi] = opts.delete(:jsonapi_object)
+      def render(resources, options, controller)
+        options = default_options(options, controller, resources)
 
-        @renderer.render(resources, opts)
+        @renderer.render(resources, options)
+      end
+
+      private
+
+      def default_options(options, controller, resources)
+        options.dup.tap do |opts|
+          opts[:class] ||= controller.jsonapi_class
+          if (pagination_links = controller.jsonapi_pagination(resources))
+            opts[:links] = (opts[:links] || {}).merge(pagination_links)
+          end
+          opts[:expose]  = controller.jsonapi_expose.merge(opts[:expose] || {})
+          opts[:jsonapi] = opts.delete(:jsonapi_object) ||
+                           controller.jsonapi_object
+        end
       end
     end
 
+    # @private
     class ErrorsRenderer
-      def initialize(renderer = JSONAPI::Serializable::ErrorsRenderer.new)
+      def initialize(renderer = JSONAPI::Serializable::Renderer.new)
         @renderer = renderer
 
         freeze
       end
 
-      def render(errors, options)
-        # TODO(beauby): SerializableError inference on AR validation errors.
-        @renderer.render(errors, options)
+      def render(errors, options, controller)
+        options = default_options(options, controller)
+
+        errors = [errors] unless errors.is_a?(Array)
+
+        @renderer.render_errors(errors, options)
+      end
+
+      private
+
+      def default_options(options, controller)
+        options.dup.tap do |opts|
+          opts[:class] ||= controller.jsonapi_errors_class
+          opts[:expose] =
+            controller.jsonapi_expose
+                      .merge(opts[:expose] || {})
+                      .merge!(_jsonapi_pointers: controller.jsonapi_pointers)
+          opts[:jsonapi] = opts.delete(:jsonapi_object) ||
+                           controller.jsonapi_object
+        end
       end
     end
   end

data/lib/jsonapi/rails/serializable_active_model_errors.rb

@@ -0,0 +1,38 @@
+module JSONAPI
+  module Rails
+    # @private
+    class SerializableActiveModelError < Serializable::Error
+      title do
+        "Invalid #{@field}" unless @field.nil?
+      end
+
+      detail do
+        @message
+      end
+
+      source do
+        pointer @pointer unless @pointer.nil?
+      end
+    end
+
+    # @private
+    class SerializableActiveModelErrors
+      def initialize(exposures)
+        @errors = exposures[:object]
+        @reverse_mapping = exposures[:_jsonapi_pointers] || {}
+
+        freeze
+      end
+
+      def as_jsonapi
+        @errors.keys.flat_map do |key|
+          @errors.full_messages_for(key).map do |message|
+            SerializableActiveModelError.new(field: key, message: message,
+                                             pointer: @reverse_mapping[key])
+              .as_jsonapi
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jsonapi/rails/serializable_error_hash.rb

@@ -0,0 +1,13 @@
+module JSONAPI
+  module Rails
+    # @private
+    class SerializableErrorHash < JSONAPI::Serializable::Error
+      def initialize(exposures)
+        super
+        exposures[:object].each do |k, v|
+          instance_variable_set("@_#{k}", v)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Lucas Hosseini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-22 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-rb
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: jsonapi-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Efficient, convenient, non-intrusive JSONAPI framework for Rails.
 email:
 - lucas.hosseini@gmail.com
@@ -88,14 +116,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/generators/jsonapi/initializer/USAGE
+- lib/generators/jsonapi/initializer/initializer_generator.rb
+- lib/generators/jsonapi/initializer/templates/initializer.rb
 - lib/generators/jsonapi/serializable/USAGE
 - lib/generators/jsonapi/serializable/serializable_generator.rb
 - lib/generators/jsonapi/serializable/templates/serializable.rb.erb
 - lib/jsonapi/rails.rb
-- lib/jsonapi/rails/action_controller.rb
-- lib/jsonapi/rails/parser.rb
+- lib/jsonapi/rails/configuration.rb
+- lib/jsonapi/rails/controller.rb
 - lib/jsonapi/rails/railtie.rb
 - lib/jsonapi/rails/renderer.rb
+- lib/jsonapi/rails/serializable_active_model_errors.rb
+- lib/jsonapi/rails/serializable_error_hash.rb
 homepage: https://github.com/jsonapi-rb/jsonapi-rails
 licenses:
 - MIT
@@ -116,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: jsonapi-rb integrations for Rails.

data/lib/jsonapi/rails/action_controller.rb

@@ -1,41 +0,0 @@
-require 'jsonapi/deserializable'
-require 'jsonapi/parser'
-
-module JSONAPI
-  module Rails
-    module ActionController
-      extend ActiveSupport::Concern
-
-      JSONAPI_POINTERS_KEY = 'jsonapi_deserializable.jsonapi_pointers'.freeze
-
-      class_methods do
-        def deserializable_resource(key, options = {}, &block)
-          _deserializable(key, options,
-                          JSONAPI::Deserializable::Resource, &block)
-        end
-
-        def deserializable_relationship(key, options = {}, &block)
-          _deserializable(key, options,
-                          JSONAPI::Deserializable::Relationship, &block)
-        end
-
-        # @api private
-        def _deserializable(key, options, fallback, &block)
-          options = options.dup
-          klass = options.delete(:class) || Class.new(fallback, &block)
-
-          before_action(options) do |controller|
-            resource = klass.new(controller.params[:_jsonapi].to_unsafe_hash)
-            controller.request.env[JSONAPI_POINTERS_KEY] =
-              resource.reverse_mapping
-            controller.params[key.to_sym] = resource.to_hash
-          end
-        end
-      end
-
-      def jsonapi_pointers
-        request.env[JSONAPI_POINTERS_KEY]
-      end
-    end
-  end
-end

data/lib/jsonapi/rails/parser.rb

@@ -1,12 +0,0 @@
-require 'jsonapi/deserializable'
-
-module JSONAPI
-  module Rails
-    PARSER = lambda do |body|
-      data = JSON.parse(body)
-      hash = { _jsonapi: data }
-
-      hash.with_indifferent_access
-    end
-  end
-end