Module: JSONAPI::Serializer

Defined in:
lib/jsonapi-serializers.rb,
lib/jsonapi-serializers/version.rb,
lib/jsonapi-serializers/serializer.rb

Defined Under Namespace

Modules: ClassMethods, InstanceMethods Classes: AmbiguousCollectionError, Error, InvalidIncludeError

Constant Summary collapse

VERSION = 
'0.14.0'

Class Method Summary collapse

Class Method Details

.activemodel_errors(raw_errors) ⇒ Object 



341
342
343
344
345
 
# File 'lib/jsonapi-serializers/serializer.rb', line 341

def self.activemodel_errors(raw_errors)
  raw_errors.to_hash(full_messages: true).inject([]) do |result, (attribute, messages)|
    result += messages.map { |message| single_error(attribute.to_s, message) }
  end
end

.find_recursive_relationships(root_object, root_inclusion_tree, results, options) ⇒ Object

Recursively find object relationships and returns a tree of related objects. Example return: 

['comments', '1'] => {object: <Comment>, include_linkages: ['author'],
['users', '1'] => <User>, include_linkages: [],
['users', '2'] => <User>, include_linkages: [],

}



411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/jsonapi-serializers/serializer.rb', line 411

def self.find_recursive_relationships(root_object, root_inclusion_tree, results, options)
  root_inclusion_tree.each do |attribute_name, child_inclusion_tree|
    # Skip the sentinal value, but we need to preserve it for siblings.
    next if attribute_name == :_include

    serializer = JSONAPI::Serializer.find_serializer(root_object, options)
    unformatted_attr_name = serializer.unformat_name(attribute_name).to_sym

    # We know the name of this relationship, but we don't know where it is stored internally.
    # Check if it is a has_one or has_many relationship.
    object = nil
    is_collection = false
    is_valid_attr = false
    if serializer.has_one_relationships.has_key?(unformatted_attr_name)
      is_valid_attr = true
      attr_data = serializer.has_one_relationships[unformatted_attr_name]
      object = serializer.has_one_relationship(unformatted_attr_name, attr_data)
    elsif serializer.has_many_relationships.has_key?(unformatted_attr_name)
      is_valid_attr = true
      is_collection = true
      attr_data = serializer.has_many_relationships[unformatted_attr_name]
      object = serializer.has_many_relationship(unformatted_attr_name, attr_data)
    end

    if !is_valid_attr
      raise JSONAPI::Serializer::InvalidIncludeError.new(
        "'#{attribute_name}' is not a valid include.")
    end

    if attribute_name != serializer.format_name(attribute_name)
      expected_name = serializer.format_name(attribute_name)

      raise JSONAPI::Serializer::InvalidIncludeError.new(
        "'#{attribute_name}' is not a valid include.  Did you mean '#{expected_name}' ?"
      )
    end

    # We're finding relationships for compound documents, so skip anything that doesn't exist.
    next if object.nil?

    # Full linkage: a request for comments.author MUST automatically include comments
    # in the response.
    objects = is_collection ? object : [object]
    if child_inclusion_tree[:_include] == true
      # Include the current level objects if the _include attribute exists.
      # If it is not set, that indicates that this is an inner path and not a leaf and will
      # be followed by the recursion below.
      objects.each do |obj|
        obj_serializer = JSONAPI::Serializer.find_serializer(obj, options)
        # Use keys of ['posts', '1'] for the results to enforce uniqueness.
        # Spec: A compound document MUST NOT include more than one resource object for each
        # type and id pair.
        # http://jsonapi.org/format/#document-structure-compound-documents
        key = [obj_serializer.type, obj_serializer.id]

        # This is special: we know at this level if a child of this parent will also been
        # included in the compound document, so we can compute exactly what linkages should
        # be included by the object at this level. This satisfies this part of the spec:
        #
        # Spec: Resource linkage in a compound document allows a client to link together
        # all of the included resource objects without having to GET any relationship URLs.
        # http://jsonapi.org/format/#document-structure-resource-relationships
        current_child_includes = []
        inclusion_names = child_inclusion_tree.keys.reject { |k| k == :_include }
        inclusion_names.each do |inclusion_name|
          if child_inclusion_tree[inclusion_name][:_include]
            current_child_includes << inclusion_name
          end
        end

        # Special merge: we might see this object multiple times in the course of recursion,
        # so merge the include_linkages each time we see it to load all the relevant linkages.
        current_child_includes += results[key] && results[key][:include_linkages] || []
        current_child_includes.uniq!
        results[key] = {object: obj, include_linkages: current_child_includes}
      end
    end

    # Recurse deeper!
    if !child_inclusion_tree.empty?
      # For each object we just loaded, find all deeper recursive relationships.
      objects.each do |obj|
        find_recursive_relationships(obj, child_inclusion_tree, results, options)
      end
    end
  end
  nil
end

.find_serializer(object, options) ⇒ Object 



234
235
236
 
# File 'lib/jsonapi-serializers/serializer.rb', line 234

def self.find_serializer(object, options)
  find_serializer_class(object, options).new(object, options)
end

.find_serializer_class(object, options) ⇒ Object 



229
230
231
232
 
# File 'lib/jsonapi-serializers/serializer.rb', line 229

def self.find_serializer_class(object, options)
  class_name = find_serializer_class_name(object, options)
  class_name.constantize
end

.find_serializer_class_name(object, options) ⇒ Object 



219
220
221
222
223
224
225
226
227
 
# File 'lib/jsonapi-serializers/serializer.rb', line 219

def self.find_serializer_class_name(object, options)
  if options[:namespace]
    return "#{options[:namespace]}::#{object.class.name}Serializer"
  end
  if object.respond_to?(:jsonapi_serializer_class_name)
    return object.jsonapi_serializer_class_name.to_s
  end
  "#{object.class.name}Serializer"
end

.included(target) ⇒ Object 



6
7
8
9
10
11
12
 
# File 'lib/jsonapi-serializers/serializer.rb', line 6

def self.included(target)
  target.send(:include, InstanceMethods)
  target.extend ClassMethods
  target.class_eval do
    include JSONAPI::Attributes
  end
end

.is_activemodel_errors?(raw_errors) ⇒ Boolean

Returns:

  • (Boolean) 


347
348
349
 
# File 'lib/jsonapi-serializers/serializer.rb', line 347

def self.is_activemodel_errors?(raw_errors)
  raw_errors.respond_to?(:to_hash) && raw_errors.respond_to?(:full_messages)
end

.merge_relationship_path(path, data) ⇒ Object 



518
519
520
521
522
523
524
525
526
527
 
# File 'lib/jsonapi-serializers/serializer.rb', line 518

def self.merge_relationship_path(path, data)
  parts = path.split('.', 2)
  current_level = parts[0].strip
  data[current_level] ||= {_include: true}

  if parts.length == 2
    # Need to recurse more.
    merge_relationship_path(parts[1], data[current_level])
  end
end

.parse_relationship_paths(paths) ⇒ Object

Takes a list of relationship paths and returns a hash as deep as the given paths. The _include: true is a sentinal value that specifies whether the parent level should be included.

Example:

Given: ['author', 'comments', 'comments.user']
Returns: {
  'author' => {_include: true},
  'comments' => {_include: true, 'user' => {_include: true}},
}



511
512
513
514
515
 
# File 'lib/jsonapi-serializers/serializer.rb', line 511

def self.parse_relationship_paths(paths)
  relationships = {}
  paths.each { |path| merge_relationship_path(path, relationships) }
  relationships
end

.serialize(objects, options = {}) ⇒ Object 



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/jsonapi-serializers/serializer.rb', line 238

def self.serialize(objects, options = {})
  # Normalize option strings to symbols.
  options[:is_collection] = options.delete('is_collection') || options[:is_collection] || false
  options[:include] = options.delete('include') || options[:include]
  options[:serializer] = options.delete('serializer') || options[:serializer]
  options[:namespace] = options.delete('namespace') || options[:namespace]
  options[:context] = options.delete('context') || options[:context] || {}
  options[:skip_collection_check] = options.delete('skip_collection_check') || options[:skip_collection_check] || false
  options[:base_url] = options.delete('base_url') || options[:base_url]
  options[:meta] = options.delete('meta') || options[:meta]
  options[:links] = options.delete('links') || options[:links]

  # Deprecated: use serialize_errors method instead
  options[:errors] = options.delete('errors') || options[:errors]

  # Normalize includes.
  includes = options[:include]
  includes = (includes.is_a?(String) ? includes.split(',') : includes).uniq if includes

  # An internal-only structure that is passed through serializers as they are created.
  passthrough_options = {
    context: options[:context],
    serializer: options[:serializer],
    namespace: options[:namespace],
    include: includes,
    base_url: options[:base_url]
  }

  if !options[:skip_collection_check] && options[:is_collection] && !objects.respond_to?(:each)
    raise JSONAPI::Serializer::AmbiguousCollectionError.new(
      'Attempted to serialize a single object as a collection.')
  end

  # Automatically include linkage data for any relation that is also included.
  if includes
    direct_children_includes = includes.reject { |key| key.include?('.') }
    passthrough_options[:include_linkages] = direct_children_includes
  end

  # Spec: Primary data MUST be either:
  # - a single resource object or null, for requests that target single resources.
  # - an array of resource objects or an empty array ([]), for resource collections.
  # http://jsonapi.org/format/#document-structure-top-level
  if options[:is_collection] && !objects.any?
    primary_data = []
  elsif !options[:is_collection] && objects.nil?
    primary_data = nil
  elsif options[:is_collection]
    # Have object collection.
    primary_data = serialize_primary_multi(objects, passthrough_options)
  else
    # Duck-typing check for a collection being passed without is_collection true.
    # We always must be told if serializing a collection because the JSON:API spec distinguishes
    # how to serialize null single resources vs. empty collections.
    if !options[:skip_collection_check] && objects.respond_to?(:each)
      raise JSONAPI::Serializer::AmbiguousCollectionError.new(
        'Must provide `is_collection: true` to `serialize` when serializing collections.')
    end
    # Have single object.
    primary_data = serialize_primary(objects, passthrough_options)
  end
  result = {
    'data' => primary_data,
  }
  result['meta'] = options[:meta] if options[:meta]
  result['links'] = options[:links] if options[:links]
  result['errors'] = options[:errors] if options[:errors]

  # If 'include' relationships are given, recursively find and include each object.
  if includes
    relationship_data = {}
    inclusion_tree = parse_relationship_paths(includes)

    # Given all the primary objects (either the single root object or collection of objects),
    # recursively search and find related associations that were specified as includes.
    objects = options[:is_collection] ? objects.to_a : [objects]
    objects.compact.each do |obj|
      # Use the mutability of relationship_data as the return datastructure to take advantage
      # of the internal special merging logic.
      find_recursive_relationships(obj, inclusion_tree, relationship_data, passthrough_options)
    end

    result['included'] = relationship_data.map do |_, data|
      included_passthrough_options = {}
      included_passthrough_options[:base_url] = passthrough_options[:base_url]
      included_passthrough_options[:context] = passthrough_options[:context]
      included_passthrough_options[:serializer] = find_serializer_class(data[:object], options)
      included_passthrough_options[:namespace] = passthrough_options[:namespace]
      included_passthrough_options[:include_linkages] = data[:include_linkages]
      serialize_primary(data[:object], included_passthrough_options)
    end
  end
  result
end

.serialize_errors(raw_errors) ⇒ Object 



333
334
335
336
337
338
339
 
# File 'lib/jsonapi-serializers/serializer.rb', line 333

def self.serialize_errors(raw_errors)
  if is_activemodel_errors?(raw_errors)
    {'errors' => activemodel_errors(raw_errors)}
  else
    {'errors' => raw_errors}
  end
end

.serialize_primary(object, options = {}) ⇒ Object 



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/jsonapi-serializers/serializer.rb', line 360

def self.serialize_primary(object, options = {})
  serializer_class = options[:serializer] || find_serializer_class(object, options)

  # Spec: Primary data MUST be either:
  # - a single resource object or null, for requests that target single resources.
  # http://jsonapi.org/format/#document-structure-top-level
  return if object.nil?

  serializer = serializer_class.new(object, options)
  data = {
    'type' => serializer.type.to_s,
  }

  # "The id member is not required when the resource object originates at the client
  #  and represents a new resource to be created on the server."
  # http://jsonapi.org/format/#document-resource-objects
  # We'll assume that if the id is blank, it means the resource is to be created.
  data['id'] = serializer.id.to_s if serializer.id && !serializer.id.empty?

  # Merge in optional top-level members if they are non-nil.
  # http://jsonapi.org/format/#document-structure-resource-objects
  # Call the methods once now to avoid calling them twice when evaluating the if's below.
  attributes = serializer.attributes
  links = serializer.links
  relationships = serializer.relationships
  meta = serializer.meta
  data['attributes'] = attributes if !attributes.empty?
  data['links'] = links if !links.empty?
  data['relationships'] = relationships if !relationships.empty?
  data['meta'] = meta if !meta.nil?
  data
end

.serialize_primary_multi(objects, options = {}) ⇒ Object 



394
395
396
397
398
399
400
401
 
# File 'lib/jsonapi-serializers/serializer.rb', line 394

def self.serialize_primary_multi(objects, options = {})
  # Spec: Primary data MUST be either:
  # - an array of resource objects or an empty array ([]), for resource collections.
  # http://jsonapi.org/format/#document-structure-top-level
  return [] if !objects.any?

  objects.map { |obj| serialize_primary(obj, options) }
end

.single_error(attribute, message) ⇒ Object 



351
352
353
354
355
356
357
358
 
# File 'lib/jsonapi-serializers/serializer.rb', line 351

def self.single_error(attribute, message)
  {
    'source' => {
      'pointer' => "/data/attributes/#{attribute.dasherize}"
    },
    'detail' => message
  }
end