jsonapi-utils 0.5.0.beta4 → 0.5.0.beta5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68e34821e946ce803f78ad83fa6515c99dd7e847
-  data.tar.gz: 52e3849ce3f372eeed8276e4c2ba62815e413e30
+  metadata.gz: 9e497750ffb06aad8803f1fb6e85d513ca8eafd4
+  data.tar.gz: 7516ec26de1efe29f1666ba3aa49381d0bd033ec
 SHA512:
-  metadata.gz: 5b2c8f3ac88c7571ca61148f657de7ffbdf8607a4e22a4136f877801cb2be8ff2e74ba1031c8beec5133fea62d8dad5be1f7199310a9a0011149c035c893d09b
-  data.tar.gz: f9b02d37f90f04e7e2c224381ace8744127173a9fdba7ce05b1ae8992a4476ca01a59ae8f12dd4de390c17ec4f05009767846af4781806a2de4359904ca0e1c8
+  metadata.gz: b1fbb7ff07c127c0f627f2a222f123aae26b6e1782d25f396d35e709ee589fe49a681185c4a350bfb4d43b54972068d70ac9055bef3fa4fe6ac2b2b7478bdc91
+  data.tar.gz: 599cf401067538fade2cdc0a75e8c533f8bcd1f313973da8d272d09e5a07bbb4a74c118073e229ae689931ca0f45b6d6cd02fe0c25b21be2a63e8419ded50530

data/README.md

@@ -40,18 +40,18 @@ Simple yet powerful way to get your Rails API compliant with [JSON API](http://j
 Support:
 
 * Ruby 2.x with Rails 4.x
-* Ruby 2.2.2+ with Rails 5
+* Ruby 2.3+ with Rails 5
 
 For Rails 4.x add this to your application's Gemfile:
 
 ```ruby
-gem 'jsonapi-utils', '~> 0.4.6'
+gem 'jsonapi-utils', '~> 0.4.7'
 ```
 
 For Rails 5, specify the beta version in the Gemfile:
 
 ```ruby
-gem 'jsonapi-utils', '0.5.0.beta3'
+gem 'jsonapi-utils', '0.5.0.beta5'
 ```
 
 And then execute:

data/lib/jsonapi/utils/exceptions.rb

@@ -4,22 +4,88 @@ module JSONAPI
   module Utils
     module Exceptions
       class ActiveRecord < ::JSONAPI::Exceptions::Error
-        attr_accessor :object
+        attr_reader :object, :resource, :relationships, :relationship_keys, :foreign_keys
 
-        def initialize(object)
+        def initialize(object, resource_klass, context)
           @object = object
+          @resource = resource_klass.new(object, context)
+
+          # Need to reflect on resource's relationships for error reporting.
+          @relationships     = resource_klass._relationships.values
+          @relationship_keys = @relationships.map(&:name).map(&:to_sym)
+          @foreign_keys      = @relationships.map(&:foreign_key).map(&:to_sym)
         end
 
         def errors
-          object.errors.keys.map do |key|
-            JSONAPI::Error.new(
-              code: JSONAPI::VALIDATION_ERROR,
-              status: :unprocessable_entity,
-              id: key,
-              title: object.errors.full_messages_for(key).first
-            )
+          object.errors.messages.flat_map do |key, messages|
+            messages.map do |message|
+              error_meta = error_base
+                .merge(title: title_member(key, message))
+                .merge(id: id_member(key))
+                .merge(source_member(key))
+
+              JSONAPI::Error.new(error_meta)
+            end
+          end
+        end
+
+        private
+
+        def id_member(key)
+          id = resource_key_for(key)
+          key_formatter = JSONAPI.configuration.key_formatter
+          key_formatter.format(id).to_sym
+        end
+
+        # Determine if this is a foreign key, which will need to look up its
+        # matching association name.
+        def resource_key_for(key)
+          if foreign_keys.include?(key)
+            relationships.find { |r| r.foreign_key == key }.name.to_sym
+          else
+            key
           end
         end
+
+        def source_member(key)
+          Hash.new.tap do |hash|
+            resource_key = resource_key_for(key)
+
+            # Pointer should only be created for whitelisted attributes.
+            return hash unless resource.fetchable_fields.include?(resource_key) || key == :base
+
+            id = id_member(key)
+
+            hash[:source] = {}
+            hash[:source][:pointer] =
+              # Relationship
+              if relationship_keys.include?(resource_key)
+                "/data/relationships/#{id}"
+              # Base
+              elsif key == :base
+                '/data'
+              # Attribute
+              else
+                "/data/attributes/#{id}"
+              end
+          end
+        end
+
+        def title_member(key, message)
+          if key == :base
+            message
+          else
+            resource_key = resource_key_for(key)
+            [resource_key.to_s.tr('.', '_').humanize, message].join(' ')
+          end
+        end
+
+        def error_base
+          {
+            code: JSONAPI::VALIDATION_ERROR,
+            status: :unprocessable_entity
+          }
+        end
       end
 
       class BadRequest < ::JSONAPI::Exceptions::Error

data/lib/jsonapi/utils/request.rb

@@ -1,47 +1,87 @@
-module JSONAPI
-  module Utils
-    module Request
-      def jsonapi_request_handling
-        setup_request
-        check_request
-      end
+module JSONAPI::Utils
+  module Request
+    # Setup and check request before action gets actually evaluated.
+    #
+    # @api public
+    def jsonapi_request_handling
+      setup_request
+      check_request
+    end
 
-      def setup_request
-        @request ||=
-          JSONAPI::RequestParser.new(
-            params.dup,
-            context: context,
-            key_formatter: key_formatter,
-            server_error_callbacks: (self.class.server_error_callbacks || [])
-          )
-      end
+    # Instantiate the request object.
+    #
+    # @return [JSONAPI::RequestParser]
+    #
+    # @api public
+    def setup_request
+      @request ||= JSONAPI::RequestParser.new(
+        params,
+        context: context,
+        key_formatter: key_formatter,
+        server_error_callbacks: (self.class.server_error_callbacks || [])
+      )
+    end
 
-      def check_request
-        @request.errors.blank? || jsonapi_render_errors(json: @request)
-      end
+    # Render an error response if the parsed request got any error.
+    #
+    # @api public
+    def check_request
+      @request.errors.blank? || jsonapi_render_errors(json: @request)
+    end
 
-      def resource_params
-        build_params_for(:resource)
-      end
+    # Override the JSONAPI::ActsAsResourceController#process_request method.
+    #
+    # It might be removed when the following line on JR is fixed:
+    # https://github.com/cerebris/jsonapi-resources/blob/release-0-8/lib/jsonapi/acts_as_resource_controller.rb#L62
+    #
+    # @return [String]
+    #
+    # @api public
+    def process_request
+      process_operations
+      render_results(@operation_results)
+    rescue => e
+      handle_exceptions(e)
+    end
 
-      def relationship_params
-        build_params_for(:relationship)
-      end
+    # Helper to get params for the main resource.
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def resource_params
+      build_params_for(:resource)
+    end
+
+    # Helper to get params for relationship params.
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def relationship_params
+      build_params_for(:relationship)
+    end
+
+    private
 
-      private
+    # Extract params from request and build a Hash with params
+    # for either the main resource or relationships.
+    #
+    # @return [Hash]
+    #
+    # @api private
+    def build_params_for(param_type)
+      return {} if @request.operations.empty?
 
-      def build_params_for(param_type)
-        return {} if @request.operations.empty?
+      keys = %i(attributes to_one to_many)
+      operation = @request.operations.find { |e| e.options[:data].keys & keys == keys }
 
-        keys      = %i(attributes to_one to_many)
-        operation = @request.operations.find { |e| e.options[:data].keys & keys == keys }
-        if operation.nil?
-          {}
-        elsif param_type == :relationship
-          operation.options[:data].values_at(:to_one, :to_many).compact.reduce(&:merge)
-        else
-          operation.options[:data][:attributes]
-        end
+      if operation.nil?
+        {}
+      elsif param_type == :relationship
+        operation.options[:data].values_at(:to_one, :to_many).compact.reduce(&:merge)
+      else
+        operation.options[:data][:attributes]
       end
     end
   end

data/lib/jsonapi/utils/response/formatters.rb

@@ -14,7 +14,7 @@ module JSONAPI
         alias_method :jsonapi_serialize, :jsonapi_format
 
         def jsonapi_format_errors(data)
-          data   = JSONAPI::Utils::Exceptions::ActiveRecord.new(data) if data.is_a?(ActiveRecord::Base)
+          data   = JSONAPI::Utils::Exceptions::ActiveRecord.new(data, @request.resource_klass, context) if data.is_a?(ActiveRecord::Base)
           errors = data.respond_to?(:errors) ? data.errors : data
           JSONAPI::Utils::Support::Error.sanitize(errors).uniq
         end

data/lib/jsonapi/utils/support/pagination.rb

@@ -47,7 +47,7 @@ module JSONAPI
           @paginator ||= paginator_klass.new(page_params)
         end
 
-        # Returns the paginator class to be used in the response's pagination.
+        # Return the paginator class to be used in the response's pagination.
         #
         # @return [Paginator]
         #

data/lib/jsonapi/utils/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Utils
-    VERSION = '0.5.0.beta4'.freeze
+    VERSION = '0.5.0.beta5'.freeze
   end
 end

data/lib/jsonapi/utils.rb

@@ -9,11 +9,10 @@ JSONAPI::Resource.extend JSONAPI::Utils::Support::Filter::Custom
 
 module JSONAPI
   module Utils
-    include Request
-    include Response
-
     def self.included(base)
       base.include ActsAsResourceController
+      base.include Request
+      base.include Response
 
       if base.respond_to?(:before_action)
         base.before_action :jsonapi_request_handling

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-utils
 version: !ruby/object:Gem::Version
-  version: 0.5.0.beta4
+  version: 0.5.0.beta5
 platform: ruby
 authors:
 - Tiago Guedes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-14 00:00:00.000000000 Z
+date: 2016-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-resources
@@ -71,16 +71,16 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 5.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 5.0.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -101,28 +101,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.8'
 - !ruby/object:Gem::Dependency
   name: smart_rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: JSON::Utils is a simple way to get a full-featured JSON API serialization