jsonapi-resources 0.9.12 → 0.10.0.beta1

data/lib/jsonapi/{cached_resource_fragment.rb → cached_response_fragment.rb}

@@ -1,37 +1,26 @@
 module JSONAPI
-  class CachedResourceFragment
-    def self.fetch_fragments(resource_klass, serializer, context, cache_ids)
-      serializer_config_key = serializer.config_key(resource_klass).gsub("/", "_")
+  class CachedResponseFragment
+    def self.fetch_cached_fragments(resource_klass, serializer_config_key, cache_ids, context)
       context_json = resource_klass.attribute_caching_context(context).to_json
       context_b64 = JSONAPI.configuration.resource_cache_digest_function.call(context_json)
       context_key = "ATTR-CTX-#{context_b64.gsub("/", "_")}"
 
       results = self.lookup(resource_klass, serializer_config_key, context, context_key, cache_ids)
 
-      miss_ids = results.select{|k,v| v.nil? }.keys
-      unless miss_ids.empty?
-        find_filters = {resource_klass._primary_key => miss_ids.uniq}
-        find_options = {context: context}
-        resource_klass.find(find_filters, find_options).each do |resource|
-          (id, cr) = write(resource_klass, resource, serializer, serializer_config_key, context, context_key)
-          results[id] = cr
-        end
-      end
-
       if JSONAPI.configuration.resource_cache_usage_report_function
+        miss_ids = results.select{|_k,v| v.nil? }.keys
         JSONAPI.configuration.resource_cache_usage_report_function.call(
-          resource_klass.name,
-          cache_ids.size - miss_ids.size,
-          miss_ids.size
+            resource_klass.name,
+            cache_ids.size - miss_ids.size,
+            miss_ids.size
         )
       end
 
-      return results
+      results
     end
 
     attr_reader :resource_klass, :id, :type, :context, :fetchable_fields, :relationships,
-                :links_json, :attributes_json, :meta_json,
-                :preloaded_fragments
+                :links_json, :attributes_json, :meta_json
 
     def initialize(resource_klass, id, type, context, fetchable_fields, relationships,
                    links_json, attributes_json, meta_json)
@@ -47,9 +36,6 @@ module JSONAPI
       @links_json = CompiledJson.of(links_json)
       @attributes_json = CompiledJson.of(attributes_json)
       @meta_json = CompiledJson.of(meta_json)
-
-      # A hash of hashes
-      @preloaded_fragments ||= Hash.new
     end
 
     def to_cache_value
@@ -64,11 +50,6 @@ module JSONAPI
       }
     end
 
-    def to_real_resource
-      rs = Resource.resource_for(self.type).find_by_keys([self.id], {context: self.context})
-      return rs.try(:first)
-    end
-
     private
 
     def self.lookup(resource_klass, serializer_config_key, context, context_key, cache_ids)
@@ -103,12 +84,14 @@ module JSONAPI
       )
     end
 
-    def self.write(resource_klass, resource, serializer, serializer_config_key, context, context_key)
+    def self.write(resource_klass, resource, serializer, serializer_config_key, context, context_key, relationship_data )
       (id, cache_key) = resource.cache_id
-      json = serializer.object_hash(resource) # No inclusions passed to object_hash
+
+      json = serializer.object_hash(resource, relationship_data)
+
       cr = self.new(
         resource_klass,
-        json['id'],
+        id,
         json['type'],
         context,
         resource.fetchable_fields,

data/lib/jsonapi/compiled_json.rb

@@ -5,6 +5,7 @@ module JSONAPI
     end
 
     def self.of(obj)
+      # :nocov:
       case obj
         when NilClass then nil
         when CompiledJson then obj
@@ -12,6 +13,7 @@ module JSONAPI
         when Hash then CompiledJson.compile(obj)
         else raise "Can't figure out how to turn #{obj.inspect} into CompiledJson"
       end
+      # :nocov:
     end
 
     def initialize(json, h = nil)
@@ -19,7 +21,7 @@ module JSONAPI
       @h = h
     end
 
-    def to_json(*args)
+    def to_json(*_args)
       @json
     end
 
@@ -27,9 +29,17 @@ module JSONAPI
       @json
     end
 
+    # :nocov:
     def to_h
       @h ||= JSON.parse(@json)
     end
+    # :nocov:
+
+    def [](key)
+      # :nocov:
+      to_h[key]
+      # :nocov:
+    end
 
     undef_method :as_json
   end

data/lib/jsonapi/configuration.rb

@@ -1,5 +1,6 @@
 require 'jsonapi/formatter'
 require 'jsonapi/processor'
+require 'jsonapi/active_relation_resource_finder'
 require 'concurrent'
 
 module JSONAPI
@@ -8,13 +9,15 @@ module JSONAPI
                 :resource_key_type,
                 :route_format,
                 :raise_if_parameters_not_allowed,
-                :warn_on_missing_routes,
-                :allow_include,
+                :warn_on_route_setup_issues,
+                :default_allow_include_to_one,
+                :default_allow_include_to_many,
                 :allow_sort,
                 :allow_filter,
                 :default_paginator,
                 :default_page_size,
                 :maximum_page_size,
+                :resource_finder,
                 :default_processor_klass,
                 :use_text_errors,
                 :top_level_links_include_pagination,
@@ -24,6 +27,7 @@ module JSONAPI
                 :top_level_meta_page_count_key,
                 :allow_transactions,
                 :include_backtraces_in_errors,
+                :include_application_backtraces_in_errors,
                 :exception_class_whitelist,
                 :whitelist_all_exceptions,
                 :always_include_to_one_linkage_data,
@@ -31,10 +35,10 @@ module JSONAPI
                 :cache_formatters,
                 :use_relationship_reflection,
                 :resource_cache,
+                :default_caching,
                 :default_resource_cache_field,
                 :resource_cache_digest_function,
-                :resource_cache_usage_report_function,
-                :default_exclude_links
+                :resource_cache_usage_report_function
 
     def initialize
       #:underscored_key, :camelized_key, :dasherized_key, or custom
@@ -47,13 +51,14 @@ module JSONAPI
       self.resource_key_type = :integer
 
       # optional request features
-      self.allow_include = true
+      self.default_allow_include_to_one = true
+      self.default_allow_include_to_many = true
       self.allow_sort = true
       self.allow_filter = true
 
       self.raise_if_parameters_not_allowed = true
 
-      self.warn_on_missing_routes = true
+      self.warn_on_route_setup_issues = true
 
       # :none, :offset, :paged, or a custom paginator name
       self.default_paginator = :none
@@ -75,8 +80,12 @@ module JSONAPI
       self.use_text_errors = false
 
       # Whether or not to include exception backtraces in JSONAPI error
-      # responses.  Defaults to `false` in production, and `true` otherwise.
-      self.include_backtraces_in_errors = !Rails.env.production?
+      # responses.  Defaults to `false` in anything other than development or test.
+      self.include_backtraces_in_errors = (Rails.env.development? || Rails.env.test?)
+
+      # Whether or not to include exception application backtraces in JSONAPI error
+      # responses.  Defaults to `false` in anything other than development or test.
+      self.include_application_backtraces_in_errors = (Rails.env.development? || Rails.env.test?)
 
       # List of classes that should not be rescued by the operations processor.
       # For example, if you use Pundit for authorization, you might
@@ -96,6 +105,12 @@ module JSONAPI
       self.always_include_to_one_linkage_data = false
       self.always_include_to_many_linkage_data = false
 
+      # ResourceFinder Mixin
+      # The default ResourceFinder is the ActiveRelationResourceFinder which provides
+      # access to ActiveRelation backed models. Custom ResourceFinders can be specified
+      # in order to support other ORMs.
+      self.resource_finder = JSONAPI::ActiveRelationResourceFinder
+
       # The default Operation Processor to use if one is not defined specifically
       # for a Resource.
       self.default_processor_klass = JSONAPI::Processor
@@ -121,6 +136,11 @@ module JSONAPI
       # Rails cache store.
       self.resource_cache = nil
 
+      # Cache resources by default
+      # Cache resources by default. Individual resources can be excluded from caching by calling:
+      # `caching false`
+      self.default_caching = false
+
       # Default resource cache field
       # On Resources with caching enabled, this field will be used to check for out-of-date
       # cache entries, unless overridden on a specific Resource. Defaults to "updated_at".
@@ -135,12 +155,6 @@ module JSONAPI
       # Optionally provide a callable which JSONAPI will call with information about cache
       # performance. Should accept three arguments: resource name, hits count, misses count.
       self.resource_cache_usage_report_function = nil
-
-      # Global configuration for links exclusion
-      # Controls whether to generate links like `self`, `related` with all the resources
-      # and relationships. Accepts either `:default`, `:none`, or array containing the
-      # specific default links to exclude, which may be `:self` and `:related`.
-      self.default_exclude_links = :none
     end
 
     def cache_formatters=(bool)
@@ -211,7 +225,17 @@ module JSONAPI
       @default_processor_klass = default_processor_klass
     end
 
-    attr_writer :allow_include, :allow_sort, :allow_filter
+    def resource_finder=(resource_finder)
+      @resource_finder = resource_finder
+    end
+
+    def allow_include=(allow_include)
+      ActiveSupport::Deprecation.warn('`allow_include` has been replaced by `default_allow_include_to_one` and `default_allow_include_to_many` options.')
+      @default_allow_include_to_one = allow_include
+      @default_allow_include_to_many = allow_include
+    end
+
+    attr_writer :allow_sort, :allow_filter, :default_allow_include_to_one, :default_allow_include_to_many
 
     attr_writer :default_paginator
 
@@ -235,6 +259,8 @@ module JSONAPI
 
     attr_writer :include_backtraces_in_errors
 
+    attr_writer :include_application_backtraces_in_errors
+
     attr_writer :exception_class_whitelist
 
     attr_writer :whitelist_all_exceptions
@@ -245,19 +271,19 @@ module JSONAPI
 
     attr_writer :raise_if_parameters_not_allowed
 
-    attr_writer :warn_on_missing_routes
+    attr_writer :warn_on_route_setup_issues
 
     attr_writer :use_relationship_reflection
 
     attr_writer :resource_cache
 
+    attr_writer :default_caching
+
     attr_writer :default_resource_cache_field
 
     attr_writer :resource_cache_digest_function
 
     attr_writer :resource_cache_usage_report_function
-
-    attr_writer :default_exclude_links
   end
 
   class << self

data/lib/jsonapi/error.rb

@@ -24,6 +24,33 @@ module JSONAPI
       instance_variables.each {|var| hash[var.to_s.delete('@')] = instance_variable_get(var) unless instance_variable_get(var).nil? }
       hash
     end
+
+    def update_with_overrides(error_object_overrides)
+      @title          = error_object_overrides[:title] || @title
+      @detail         = error_object_overrides[:detail] || @detail
+      @id             = error_object_overrides[:id] || @id
+      @href           = error_object_overrides[:href] || href
+
+      if error_object_overrides[:code]
+        # :nocov:
+        @code           = if JSONAPI.configuration.use_text_errors
+                            TEXT_ERRORS[error_object_overrides[:code]]
+                          else
+                            error_object_overrides[:code]
+                          end
+        # :nocov:
+      end
+
+      @source         = error_object_overrides[:source] || @source
+      @links          = error_object_overrides[:links] || @links
+
+      if error_object_overrides[:status]
+        # :nocov:
+        @status         = Rack::Utils::SYMBOL_TO_STATUS_CODE[error_object_overrides[:status]].to_s
+        # :nocov:
+      end
+      @meta           = error_object_overrides[:meta] || @meta
+    end
   end
 
   class Warning

data/lib/jsonapi/exceptions.rb

@@ -1,7 +1,7 @@
 module JSONAPI
   module Exceptions
     class Error < RuntimeError
-      attr :error_object_overrides
+      attr_reader :error_object_overrides
 
       def initialize(error_object_overrides = {})
         @error_object_overrides = error_object_overrides
@@ -18,6 +18,22 @@ module JSONAPI
       end
     end
 
+    class Errors < Error
+      def initialize(errors, error_object_overrides = {})
+        @errors = errors
+
+        @errors.each do |error|
+          error.update_with_overrides(error_object_overrides)
+        end
+
+        super(error_object_overrides)
+      end
+
+      def errors
+        @errors
+      end
+    end
+
     class InternalServerError < Error
       attr_accessor :exception
 
@@ -33,6 +49,12 @@ module JSONAPI
           meta[:backtrace] = exception.backtrace
         end
 
+        if JSONAPI.configuration.include_application_backtraces_in_errors
+          meta ||= Hash.new
+          meta[:exception] ||= exception.message
+          meta[:application_backtrace] = exception.backtrace.select{|line| line =~ /#{Rails.root}/}
+        end
+
         [create_error_object(code: JSONAPI::INTERNAL_SERVER_ERROR,
                              status: :internal_server_error,
                              title: I18n.t('jsonapi-resources.exceptions.internal_server_error.title',
@@ -119,49 +141,30 @@ module JSONAPI
       end
     end
 
-
-    class HasManyRelationExists < Error
-      attr_accessor :id
-
-      def initialize(id, error_object_overrides = {})
-        @id = id
-        super(error_object_overrides)
-      end
-
-      def errors
-        [create_error_object(code: JSONAPI::RELATION_EXISTS,
-                             status: :bad_request,
-                             title: I18n.translate('jsonapi-resources.exceptions.has_many_relation.title',
-                                                   default: 'Relation exists'),
-                             detail: I18n.translate('jsonapi-resources.exceptions.has_many_relation.detail',
-                                                    default: "The relation to #{id} already exists.",
-                                                    id: id))]
-      end
-    end
-
     class BadRequest < Error
-      def initialize(exception)
+      def initialize(exception, error_object_overrides = {})
         @exception = exception
+        super(error_object_overrides)
       end
 
       def errors
-        [JSONAPI::Error.new(code: JSONAPI::BAD_REQUEST,
-                            status: :bad_request,
-                            title: I18n.translate('jsonapi-resources.exceptions.bad_request.title',
-                                                  default: 'Bad Request'),
-                            detail: I18n.translate('jsonapi-resources.exceptions.bad_request.detail',
-                                                   default: @exception))]
+        [create_error_object(code: JSONAPI::BAD_REQUEST,
+                             status: :bad_request,
+                             title: I18n.translate('jsonapi-resources.exceptions.bad_request.title',
+                                                   default: 'Bad Request'),
+                             detail: I18n.translate('jsonapi-resources.exceptions.bad_request.detail',
+                                                    default: @exception))]
       end
     end
 
     class InvalidRequestFormat < Error
       def errors
-        [JSONAPI::Error.new(code: JSONAPI::BAD_REQUEST,
-                            status: :bad_request,
-                            title: I18n.translate('jsonapi-resources.exceptions.invalid_request_format.title',
-                                                  default: 'Bad Request'),
-                            detail: I18n.translate('jsonapi-resources.exceptions.invalid_request_format.detail',
-                                                   default: 'Request must be a hash'))]
+        [create_error_object(code: JSONAPI::BAD_REQUEST,
+                             status: :bad_request,
+                             title: I18n.translate('jsonapi-resources.exceptions.invalid_request_format.title',
+                                                   default: 'Bad Request'),
+                             detail: I18n.translate('jsonapi-resources.exceptions.invalid_request_format.detail',
+                                                    default: 'Request must be a hash'))]
       end
     end
 
@@ -339,7 +342,7 @@ module JSONAPI
                              title: I18n.translate('jsonapi-resources.exceptions.invalid_include.title',
                                                    default: 'Invalid field'),
                              detail: I18n.translate('jsonapi-resources.exceptions.invalid_include.detail',
-                                                    default: "#{relationship} is not a valid relationship of #{resource}",
+                                                    default: "#{relationship} is not a valid includable relationship of #{resource}",
                                                     relationship: relationship, resource: resource))]
       end
     end
@@ -374,11 +377,11 @@ module JSONAPI
 
       def errors
         [create_error_object(code: JSONAPI::PARAM_NOT_ALLOWED,
-                             status: :bad_request,
-                             title: I18n.translate('jsonapi-resources.exceptions.parameter_not_allowed.title',
-                                                   default: 'Param not allowed'),
-                             detail: I18n.translate('jsonapi-resources.exceptions.parameter_not_allowed.detail',
-                                                    default: "#{param} is not allowed.", param: param))]
+                            status: :bad_request,
+                            title: I18n.translate('jsonapi-resources.exceptions.parameter_not_allowed.title',
+                                                  default: 'Param not allowed'),
+                            detail: I18n.translate('jsonapi-resources.exceptions.parameters_not_allowed.detail',
+                                                   default: "#{param} is not allowed.", param: param))]
       end
     end