jsonapi-resources 0.4.2 → 0.4.3

data/Rakefile

@@ -1,6 +1,6 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 require './test/test_helper.rb'
 
 TestApp.load_tasks

data/jsonapi-resources.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = JSONAPI::Resources::VERSION
   spec.authors       = ['Dan Gebhardt', 'Larry Gebhardt']
   spec.email         = ['dan@cerebris.com', 'larry@cerebris.com']
-  spec.summary       = %q{Easily support JSON API in Rails.}
-  spec.description   = %q{A resource-centric approach to implementing the controllers, routes, and serializers needed to support the JSON API spec.}
+  spec.summary       = 'Easily support JSON API in Rails.'
+  spec.description   = 'A resource-centric approach to implementing the controllers, routes, and serializers needed to support the JSON API spec.'
   spec.homepage      = 'https://github.com/cerebris/jsonapi-resources'
   spec.license       = 'MIT'
 

data/lib/jsonapi-resources.rb

@@ -20,4 +20,3 @@ require 'jsonapi/include_directives'
 require 'jsonapi/operation_result'
 require 'jsonapi/operation_results'
 require 'jsonapi/callbacks'
-

data/lib/jsonapi/active_record_operations_processor.rb

@@ -1,6 +1,6 @@
 class ActiveRecordOperationsProcessor < JSONAPI::OperationsProcessor
-
   private
+
   def transaction
     if @transactional
       ActiveRecord::Base.transaction do
@@ -12,7 +12,7 @@ class ActiveRecordOperationsProcessor < JSONAPI::OperationsProcessor
   end
 
   def rollback
-    raise ActiveRecord::Rollback if @transactional
+    fail ActiveRecord::Rollback if @transactional
   end
 
   def process_operation(operation)
@@ -24,5 +24,13 @@ class ActiveRecordOperationsProcessor < JSONAPI::OperationsProcessor
   rescue ActiveRecord::RecordNotFound
     record_not_found = JSONAPI::Exceptions::RecordNotFound.new(operation.associated_key)
     return JSONAPI::ErrorsOperationResult.new(record_not_found.errors[0].code, record_not_found.errors)
+
+  rescue JSONAPI::Exceptions::Error => e
+    raise e
+
+  rescue => e
+    internal_server_error = JSONAPI::Exceptions::InternalServerError.new(e)
+    Rails.logger.error { "Internal Server Error: #{e.message} #{e.backtrace.join("\n")}" }
+    return JSONAPI::ErrorsOperationResult.new(internal_server_error.errors[0].code, internal_server_error.errors)
   end
 end

data/lib/jsonapi/acts_as_resource_controller.rb

@@ -6,7 +6,7 @@ module JSONAPI
 
     included do
       before_filter :ensure_correct_media_type, only: [:create, :update, :create_association, :update_association]
-      before_filter :setup_request
+      append_before_filter :setup_request
       after_filter :setup_response
     end
 
@@ -60,6 +60,7 @@ module JSONAPI
     end
 
     private
+
     def resource_klass
       @resource_klass ||= resource_klass_name.safe_constantize
     end
@@ -78,17 +79,14 @@ module JSONAPI
 
     def ensure_correct_media_type
       unless request.content_type == JSONAPI::MEDIA_TYPE
-        raise JSONAPI::Exceptions::UnsupportedMediaTypeError.new(request.content_type)
+        fail JSONAPI::Exceptions::UnsupportedMediaTypeError.new(request.content_type)
       end
     rescue => e
       handle_exceptions(e)
     end
 
     def setup_request
-      @request = JSONAPI::Request.new(params, {
-                                              context: context,
-                                              key_formatter: key_formatter
-                                            })
+      @request = JSONAPI::Request.new(params, context: context, key_formatter: key_formatter)
       render_errors(@request.errors) unless @request.errors.empty?
     rescue => e
       handle_exceptions(e)
@@ -105,6 +103,11 @@ module JSONAPI
       {}
     end
 
+    # override to set scope_id
+    def scope_id
+      nil
+    end
+
     # Control by setting in an initializer:
     #     JSONAPI.configuration.json_key_format = :camelized_key
     #     JSONAPI.configuration.route = :camelized_route
@@ -128,7 +131,7 @@ module JSONAPI
     end
 
     def render_errors(errors)
-      operation_results = JSONAPI::OperationResults.new()
+      operation_results = JSONAPI::OperationResults.new
       result = JSONAPI::ErrorsOperationResult.new(errors[0].status, errors)
       operation_results.add_result(result)
 
@@ -143,18 +146,17 @@ module JSONAPI
     def create_response_document(operation_results)
       JSONAPI::ResponseDocument.new(
         operation_results,
-        {
-          primary_resource_klass: resource_klass,
-          include_directives: @request ? @request.include_directives : nil,
-          fields: @request ? @request.fields : nil,
-          base_url: base_url,
-          key_formatter: key_formatter,
-          route_formatter: route_formatter,
-          base_meta: base_response_meta,
-          base_links: base_response_links,
-          resource_serializer_klass: resource_serializer_klass,
-          request: @request
-        }
+        primary_resource_klass: resource_klass,
+        include_directives: @request ? @request.include_directives : nil,
+        fields: @request ? @request.fields : nil,
+        base_url: base_url,
+        key_formatter: key_formatter,
+        route_formatter: route_formatter,
+        base_meta: base_response_meta,
+        base_links: base_response_links,
+        resource_serializer_klass: resource_serializer_klass,
+        request: @request,
+        scope_id: scope_id
       )
     end
 
@@ -169,11 +171,11 @@ module JSONAPI
     # Note: Be sure to either call super(e) or handle JSONAPI::Exceptions::Error and raise unhandled exceptions
     def handle_exceptions(e)
       case e
-        when JSONAPI::Exceptions::Error
-          render_errors(e.errors)
-        else # raise all other exceptions
-          # :nocov:
-          raise e
+      when JSONAPI::Exceptions::Error
+        render_errors(e.errors)
+      else # raise all other exceptions
+        # :nocov:
+        fail e
         # :nocov:
       end
     end

data/lib/jsonapi/association.rb

@@ -1,34 +1,69 @@
 module JSONAPI
   class Association
-    attr_reader :acts_as_set, :foreign_key, :type, :options, :name, :class_name
-
-    def initialize(name, options={})
-      @name                = name.to_s
-      @options             = options
-      @acts_as_set         = options.fetch(:acts_as_set, false) == true
-      @foreign_key         = options[:foreign_key ] ? options[:foreign_key ].to_sym : nil
-      @module_path         = options[:module_path] || ''
+    attr_reader :acts_as_set, :foreign_key, :type, :options, :name,
+                :class_name, :polymorphic
+
+    def initialize(name, options = {})
+      @name = name.to_s
+      @options = options
+      @acts_as_set = options.fetch(:acts_as_set, false) == true
+      @foreign_key = options[:foreign_key] ? options[:foreign_key].to_sym : nil
+      @module_path = options[:module_path] || ''
+      @relation_name = options.fetch(:relation_name, @name)
+      @polymorphic = options.fetch(:polymorphic, false) == true
     end
 
+    alias_method :polymorphic?, :polymorphic
+
     def primary_key
-      @primary_key ||= Resource.resource_for(@module_path + @name)._primary_key
+      @primary_key ||= resource_klass._primary_key
+    end
+
+    def resource_klass
+      @resource_klass ||= Resource.resource_for(@module_path + @class_name)
+    end
+
+    def relation_name(options = {})
+      case @relation_name
+        when Symbol
+          # :nocov:
+          @relation_name
+          # :nocov:
+        when String
+          @relation_name.to_sym
+        when Proc
+          @relation_name.call(options)
+      end
+    end
+
+    def type_for_source(source)
+      if polymorphic?
+        resource = source.public_send(name)
+        resource.class._type if resource
+      else
+        type
+      end
     end
 
     class HasOne < Association
-      def initialize(name, options={})
+      def initialize(name, options = {})
         super
-        @class_name = options.fetch(:class_name, name.to_s.capitalize)
+        @class_name = options.fetch(:class_name, name.to_s.camelize)
         @type = class_name.underscore.pluralize.to_sym
-        @foreign_key ||= @key.nil? ? "#{name}_id".to_sym : @key
+        @foreign_key ||= "#{name}_id".to_sym
+      end
+
+      def polymorphic_type
+        "#{type.to_s.singularize}_type" if polymorphic?
       end
     end
 
     class HasMany < Association
-      def initialize(name, options={})
+      def initialize(name, options = {})
         super
-        @class_name = options.fetch(:class_name, name.to_s.capitalize.singularize)
+        @class_name = options.fetch(:class_name, name.to_s.camelize.singularize)
         @type = class_name.underscore.pluralize.to_sym
-        @foreign_key  ||= @key.nil? ? "#{name.to_s.singularize}_ids".to_sym : @key
+        @foreign_key ||= "#{name.to_s.singularize}_ids".to_sym
       end
     end
   end

data/lib/jsonapi/callbacks.rb

@@ -2,7 +2,6 @@ require 'active_support/callbacks'
 
 module JSONAPI
   module Callbacks
-
     def self.included(base)
       base.class_eval do
         include ActiveSupport::Callbacks
@@ -49,4 +48,4 @@ module JSONAPI
       end
     end
   end
-end
+end

data/lib/jsonapi/configuration.rb

@@ -62,37 +62,21 @@ module JSONAPI
       @operations_processor = JSONAPI::OperationsProcessor.operations_processor_for(@operations_processor_name)
     end
 
-    def allowed_request_params=(allowed_request_params)
-      @allowed_request_params = allowed_request_params
-    end
+    attr_writer :allowed_request_params
 
-    def default_paginator=(default_paginator)
-      @default_paginator = default_paginator
-    end
+    attr_writer :default_paginator
 
-    def default_page_size=(default_page_size)
-      @default_page_size = default_page_size
-    end
+    attr_writer :default_page_size
 
-    def maximum_page_size=(maximum_page_size)
-      @maximum_page_size = maximum_page_size
-    end
+    attr_writer :maximum_page_size
 
-    def use_text_errors=(use_text_errors)
-      @use_text_errors = use_text_errors
-    end
+    attr_writer :use_text_errors
 
-    def top_level_links_include_pagination=(top_level_links_include_pagination)
-      @top_level_links_include_pagination = top_level_links_include_pagination
-    end
+    attr_writer :top_level_links_include_pagination
 
-    def top_level_meta_include_record_count=(top_level_meta_include_record_count)
-      @top_level_meta_include_record_count = top_level_meta_include_record_count
-    end
+    attr_writer :top_level_meta_include_record_count
 
-    def top_level_meta_record_count_key=(top_level_meta_record_count_key)
-      @top_level_meta_record_count_key = top_level_meta_record_count_key
-    end
+    attr_writer :top_level_meta_record_count_key
   end
 
   class << self

data/lib/jsonapi/error.rb

@@ -1,9 +1,8 @@
 module JSONAPI
   class Error
-
     attr_accessor :title, :detail, :id, :href, :code, :path, :links, :status
 
-    def initialize(options={})
+    def initialize(options = {})
       @title          = options[:title]
       @detail         = options[:detail]
       @id             = options[:id]

data/lib/jsonapi/error_codes.rb

@@ -24,6 +24,7 @@ module JSONAPI
   RECORD_NOT_FOUND = 404
   UNSUPPORTED_MEDIA_TYPE = 415
   LOCKED = 423
+  INTERNAL_SERVER_ERROR = 500
 
   TEXT_ERRORS =
     { VALIDATION_ERROR => 'VALIDATION_ERROR',
@@ -50,6 +51,7 @@ module JSONAPI
       FORBIDDEN => 'FORBIDDEN',
       RECORD_NOT_FOUND => 'RECORD_NOT_FOUND',
       UNSUPPORTED_MEDIA_TYPE => 'UNSUPPORTED_MEDIA_TYPE',
-      LOCKED => 'LOCKED'
+      LOCKED => 'LOCKED',
+      INTERNAL_SERVER_ERROR => 'INTERNAL_SERVER_ERROR'
     }
 end

data/lib/jsonapi/exceptions.rb

@@ -2,6 +2,21 @@ module JSONAPI
   module Exceptions
     class Error < RuntimeError; end
 
+    class InternalServerError < Error
+      attr_accessor :exception
+
+      def initialize(exception)
+        @exception = exception
+      end
+
+      def errors
+        [JSONAPI::Error.new(code: JSONAPI::INTERNAL_SERVER_ERROR,
+                            status: 500,
+                            title: 'Internal Server Error',
+                            detail: 'Internal Server Error')]
+      end
+    end
+
     class InvalidResource < Error
       attr_accessor :resource
       def initialize(resource)
@@ -10,9 +25,9 @@ module JSONAPI
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_RESOURCE,
-                             status: :bad_request,
-                             title: 'Invalid resource',
-                             detail: "#{resource} is not a valid resource.")]
+                            status: :bad_request,
+                            title: 'Invalid resource',
+                            detail: "#{resource} is not a valid resource.")]
       end
     end
 
@@ -24,9 +39,9 @@ module JSONAPI
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::RECORD_NOT_FOUND,
-                             status: :not_found,
-                             title: 'Record not found',
-                             detail: "The record identified by #{id} could not be found.")]
+                            status: :not_found,
+                            title: 'Record not found',
+                            detail: "The record identified by #{id} could not be found.")]
       end
     end
 
@@ -38,9 +53,9 @@ module JSONAPI
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::UNSUPPORTED_MEDIA_TYPE,
-                             status: :unsupported_media_type,
-                             title: 'Unsupported media type',
-                             detail: "All requests that create or update resources must use the '#{JSONAPI::MEDIA_TYPE}' Content-Type. This request specified '#{media_type}.'")]
+                            status: :unsupported_media_type,
+                            title: 'Unsupported media type',
+                            detail: "All requests that create or update resources must use the '#{JSONAPI::MEDIA_TYPE}' Content-Type. This request specified '#{media_type}.'")]
       end
     end
 
@@ -75,9 +90,9 @@ module JSONAPI
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_FILTERS_SYNTAX,
-                             status: :bad_request,
-                             title: 'Invalid filters syntax',
-                             detail: "#{filters} is not a valid syntax for filtering.")]
+                            status: :bad_request,
+                            title: 'Invalid filters syntax',
+                            detail: "#{filters} is not a valid syntax for filtering.")]
       end
     end
 
@@ -89,9 +104,9 @@ module JSONAPI
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::FILTER_NOT_ALLOWED,
-                             status: :bad_request,
-                             title: 'Filter not allowed',
-                             detail: "#{filter} is not allowed.")]
+                            status: :bad_request,
+                            title: 'Filter not allowed',
+                            detail: "#{filter} is not allowed.")]
       end
     end
 
@@ -104,9 +119,9 @@ module JSONAPI
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_FILTER_VALUE,
-                             status: :bad_request,
-                             title: 'Invalid filter value',
-                             detail: "#{value} is not a valid value for #{filter}.")]
+                            status: :bad_request,
+                            title: 'Invalid filter value',
+                            detail: "#{value} is not a valid value for #{filter}.")]
       end
     end
 
@@ -119,9 +134,9 @@ module JSONAPI
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_FIELD_VALUE,
-                             status: :bad_request,
-                             title: 'Invalid field value',
-                             detail: "#{value} is not a valid value for #{field}.")]
+                            status: :bad_request,
+                            title: 'Invalid field value',
+                            detail: "#{value} is not a valid value for #{field}.")]
       end
     end
 
@@ -166,9 +181,9 @@ module JSONAPI
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::INVALID_FIELD,
-                             status: :bad_request,
-                             title: 'Invalid field',
-                             detail: "#{field} is not a valid field for #{type}.")]
+                            status: :bad_request,
+                            title: 'Invalid field',
+                            detail: "#{field} is not a valid field for #{type}.")]
       end
     end
 
@@ -209,13 +224,12 @@ module JSONAPI
       end
 
       def errors
-            params.collect { |param|
-              JSONAPI::Error.new(code: JSONAPI::PARAM_NOT_ALLOWED,
+        params.collect do |param|
+          JSONAPI::Error.new(code: JSONAPI::PARAM_NOT_ALLOWED,
                              status: :bad_request,
                              title: 'Param not allowed',
                              detail: "#{param} is not allowed.")
-            }
-
+        end
       end
     end
 
@@ -227,18 +241,18 @@ module JSONAPI
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::PARAM_MISSING,
-                             status: :bad_request,
-                             title: 'Missing Parameter',
-                             detail: "The required parameter, #{param}, is missing.")]
+                            status: :bad_request,
+                            title: 'Missing Parameter',
+                            detail: "The required parameter, #{param}, is missing.")]
       end
     end
 
     class CountMismatch < Error
       def errors
         [JSONAPI::Error.new(code: JSONAPI::COUNT_MISMATCH,
-                              status: :bad_request,
-                              title: 'Count to key mismatch',
-                              detail: 'The resource collection does not contain the same number of objects as the number of keys.')]
+                            status: :bad_request,
+                            title: 'Count to key mismatch',
+                            detail: 'The resource collection does not contain the same number of objects as the number of keys.')]
       end
     end
 
@@ -250,18 +264,18 @@ module JSONAPI
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::KEY_NOT_INCLUDED_IN_URL,
-                              status: :bad_request,
-                              title: 'Key is not included in URL',
-                              detail: "The URL does not support the key #{key}")]
+                            status: :bad_request,
+                            title: 'Key is not included in URL',
+                            detail: "The URL does not support the key #{key}")]
       end
     end
 
     class MissingKey < Error
       def errors
         [JSONAPI::Error.new(code: JSONAPI::KEY_ORDER_MISMATCH,
-                              status: :bad_request,
-                              title: 'A key is required',
-                              detail: 'The resource object does not contain a key.')]
+                            status: :bad_request,
+                            title: 'A key is required',
+                            detail: 'The resource object does not contain a key.')]
       end
     end
 
@@ -273,9 +287,9 @@ module JSONAPI
 
       def errors
         [JSONAPI::Error.new(code: JSONAPI::LOCKED,
-                             status: :locked,
-                             title: 'Locked resource',
-                             detail: "#{message}")]
+                            status: :locked,
+                            title: 'Locked resource',
+                            detail: "#{message}")]
       end
     end
 
@@ -323,7 +337,6 @@ module JSONAPI
       end
     end
 
-
     class PageParametersNotAllowed < Error
       attr_accessor :params
       def initialize(params)
@@ -331,13 +344,12 @@ module JSONAPI
       end
 
       def errors
-        params.collect { |param|
+        params.collect do |param|
           JSONAPI::Error.new(code: JSONAPI::PARAM_NOT_ALLOWED,
                              status: :bad_request,
                              title: 'Page parameter not allowed',
                              detail: "#{param} is not an allowed page parameter.")
-        }
-
+        end
       end
     end