Class: JSONAPI::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/jsonapi/request.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = nil, options = {}) ⇒ Request

Returns a new instance of Request.



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/jsonapi/request.rb', line 9

def initialize(params = nil, options = {})
  @params = params
  if params
    controller_path = params.fetch(:controller, '')
    @controller_module_path = controller_path.include?('/') ? controller_path.rpartition('/').first + '/' : ''
  else
    @controller_module_path = ''
  end

  @context = options[:context]
  @key_formatter = options.fetch(:key_formatter, JSONAPI.configuration.key_formatter)
  @errors = []
  @warnings = []
  @server_error_callbacks = options.fetch(:server_error_callbacks, [])
  @operations = []

  setup_operations(params)
end

Instance Attribute Details

#context ⇒ Object

Returns the value of attribute context.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def context
  @context
end

#controller_module_path ⇒ Object

Returns the value of attribute controller_module_path.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def controller_module_path
  @controller_module_path
end

#errors ⇒ Object

Returns the value of attribute errors.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def errors
  @errors
end

#fields ⇒ Object

Returns the value of attribute fields.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def fields
  @fields
end

#filters ⇒ Object

Returns the value of attribute filters.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def filters
  @filters
end

#include ⇒ Object

Returns the value of attribute include.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def include
  @include
end

#include_directives ⇒ Object

Returns the value of attribute include_directives.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def include_directives
  @include_directives
end

#operations ⇒ Object

Returns the value of attribute operations.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def operations
  @operations
end

#paginator ⇒ Object

Returns the value of attribute paginator.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def paginator
  @paginator
end

#params ⇒ Object

Returns the value of attribute params.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def params
  @params
end

#server_error_callbacks ⇒ Object

Returns the value of attribute server_error_callbacks.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def server_error_callbacks
  @server_error_callbacks
end

#sort_criteria ⇒ Object

Returns the value of attribute sort_criteria.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def sort_criteria
  @sort_criteria
end

#source_id ⇒ Object

Returns the value of attribute source_id.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def source_id
  @source_id
end

#source_klass ⇒ Object

Returns the value of attribute source_klass.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def source_klass
  @source_klass
end

#warnings ⇒ Object

Returns the value of attribute warnings.



5
6
7
 
# File 'lib/jsonapi/request.rb', line 5

def warnings
  @warnings
end

Instance Method Details

#check_include(resource_klass, include_parts) ⇒ Object 



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/jsonapi/request.rb', line 330

def check_include(resource_klass, include_parts)
  relationship_name = unformat_key(include_parts.first)

  relationship = resource_klass._relationship(relationship_name)
  if relationship && format_key(relationship_name) == include_parts.first
    unless relationship.allow_include?(context)
      fail JSONAPI::Exceptions::InvalidInclude.new(format_key(resource_klass._type), include_parts.first)
    end

    unless include_parts.last.empty?
      check_include(Resource.resource_klass_for(resource_klass.module_path + relationship.class_name.to_s.underscore),
                    include_parts.last.partition('.'))
    end
  else
    fail JSONAPI::Exceptions::InvalidInclude.new(format_key(resource_klass._type), include_parts.first)
  end
end

#check_sort_criteria(resource_klass, sort_criteria) ⇒ Object 



435
436
437
438
439
440
441
 
# File 'lib/jsonapi/request.rb', line 435

def check_sort_criteria(resource_klass, sort_criteria)
  sort_field = sort_criteria[:field]

  unless resource_klass.sortable_field?(sort_field.to_sym, context)
    fail JSONAPI::Exceptions::InvalidSortCriteria.new(format_key(resource_klass._type), sort_field)
  end
end

#error_object_overrides ⇒ Object 



28
29
30
 
# File 'lib/jsonapi/request.rb', line 28

def error_object_overrides
  {}
end

#format_key(key) ⇒ Object 



725
726
727
 
# File 'lib/jsonapi/request.rb', line 725

def format_key(key)
  @key_formatter.format(key)
end

#parse_add_relationship_operation(resource_klass, verified_params, relationship, parent_key) ⇒ Object 



660
661
662
663
664
665
666
667
668
669
670
671
 
# File 'lib/jsonapi/request.rb', line 660

def parse_add_relationship_operation(resource_klass, verified_params, relationship, parent_key)
  if relationship.is_a?(JSONAPI::Relationship::ToMany)
    @operations << JSONAPI::Operation.new(
      :create_to_many_relationships,
      resource_klass,
      context: @context,
      resource_id: parent_key,
      relationship_type: relationship.name,
      data: verified_params[:to_many].values[0]
    )
  end
end

#parse_fields(resource_klass, fields) ⇒ Object 



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
 
# File 'lib/jsonapi/request.rb', line 276

def parse_fields(resource_klass, fields)
  extracted_fields = {}

  return extracted_fields if fields.nil?

  # Extract the fields for each type from the fields parameters
  if fields.is_a?(ActionController::Parameters)
    fields.each do |field, value|
      if value.is_a?(Array)
        resource_fields = value
      else
        resource_fields = value.split(',') unless value.nil? || value.empty?
      end
      extracted_fields[field] = resource_fields
    end
  else
    fail JSONAPI::Exceptions::InvalidFieldFormat.new(error_object_overrides)
  end

  # Validate the fields
  validated_fields = {}
  extracted_fields.each do |type, values|
    underscored_type = unformat_key(type)
    validated_fields[type] = []
    begin
      if type != format_key(type)
        fail JSONAPI::Exceptions::InvalidResource.new(type, error_object_overrides)
      end
      type_resource = Resource.resource_klass_for(resource_klass.module_path + underscored_type.to_s)
    rescue NameError
      fail JSONAPI::Exceptions::InvalidResource.new(type, error_object_overrides)
    end

    if type_resource.nil?
      fail JSONAPI::Exceptions::InvalidResource.new(type, error_object_overrides)
    else
      unless values.nil?
        valid_fields = type_resource.fields.collect { |key| format_key(key) }
        values.each do |field|
          if valid_fields.include?(field)
            validated_fields[type].push unformat_key(field)
          else
            fail JSONAPI::Exceptions::InvalidField.new(type, field, error_object_overrides)
          end
        end
      else
        fail JSONAPI::Exceptions::InvalidField.new(type, 'nil', error_object_overrides)
      end
    end
  end

  validated_fields.deep_transform_keys { |key| unformat_key(key) }
end

#parse_filters(resource_klass, filters) ⇒ Object 



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/jsonapi/request.rb', line 371

def parse_filters(resource_klass, filters)
  parsed_filters = {}

  # apply default filters
  resource_klass._allowed_filters.each do |filter, opts|
    next if opts[:default].nil? || !parsed_filters[filter].nil?
    parsed_filters[filter] = opts[:default]
  end

  return parsed_filters unless filters

  unless filters.class.method_defined?(:each)
    @errors.concat(JSONAPI::Exceptions::InvalidFiltersSyntax.new(filters).errors)
    return {}
  end

  unless JSONAPI.configuration.allow_filter
    fail JSONAPI::Exceptions::ParameterNotAllowed.new(:filter)
  end

  filters.each do |key, value|
    filter = unformat_key(key)
    if resource_klass._allowed_filter?(filter)
      parsed_filters[filter] = value
    else
      fail JSONAPI::Exceptions::FilterNotAllowed.new(key)
    end
  end

  parsed_filters
end

#parse_include_directives(resource_klass, raw_include) ⇒ Object 



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/jsonapi/request.rb', line 348

def parse_include_directives(resource_klass, raw_include)
  raw_include ||= ''

  included_resources = []
  begin
    included_resources += raw_include.is_a?(Array) ? raw_include : CSV.parse_line(raw_include) || []
  rescue CSV::MalformedCSVError
    fail JSONAPI::Exceptions::InvalidInclude.new(format_key(resource_klass._type), raw_include)
  end

  begin
    result = included_resources.compact.map do |included_resource|
      check_include(resource_klass, included_resource.partition('.'))
      unformat_key(included_resource).to_s
    end

    return JSONAPI::IncludeDirectives.new(resource_klass, result)
  rescue JSONAPI::Exceptions::InvalidInclude => e
    @errors.concat(e.errors)
    return {}
  end
end

#parse_modify_relationship_action(modification_type, params, resource_klass) ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/jsonapi/request.rb', line 248

def parse_modify_relationship_action(modification_type, params, resource_klass)
  relationship_type = params.require(:relationship)

  parent_key = params.require(resource_klass._as_parent_key)
  relationship = resource_klass._relationship(relationship_type)

  # Removals of to-one relationships are done implicitly and require no specification of data
  data_required = !(modification_type == :remove && relationship.is_a?(JSONAPI::Relationship::ToOne))

  if data_required
    data = params.fetch(:data)
    object_params = { relationships: { format_key(relationship.name) => { data: data } } }

    verified_params = parse_params(resource_klass, object_params, resource_klass.updatable_fields(@context))

    parse_arguments = [resource_klass, verified_params, relationship, parent_key]
  else
    parse_arguments = [resource_klass, params, relationship, parent_key]
  end

  send(:"parse_#{modification_type}_relationship_operation", *parse_arguments)
end

#parse_pagination(resource_klass, page) ⇒ Object 



271
272
273
274
 
# File 'lib/jsonapi/request.rb', line 271

def parse_pagination(resource_klass, page)
  paginator_name = resource_klass._paginator
  JSONAPI::Paginator.paginator_for(paginator_name).new(page) unless paginator_name == :none
end

#parse_params(resource_klass, params, allowed_fields) ⇒ Object 



486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/jsonapi/request.rb', line 486

def parse_params(resource_klass, params, allowed_fields)
  verify_permitted_params(params, allowed_fields)

  checked_attributes = {}
  checked_to_one_relationships = {}
  checked_to_many_relationships = {}

  params.each do |key, value|
    case key.to_s
    when 'relationships'
      value.each do |link_key, link_value|
        param = unformat_key(link_key)
        relationship = resource_klass._relationship(param)

        if relationship.is_a?(JSONAPI::Relationship::ToOne)
          checked_to_one_relationships[param] = parse_to_one_relationship(resource_klass, link_value, relationship)
        elsif relationship.is_a?(JSONAPI::Relationship::ToMany)
          parse_to_many_relationship(resource_klass, link_value, relationship) do |result_val|
            checked_to_many_relationships[param] = result_val
          end
        end
      end
    when 'id'
      checked_attributes['id'] = unformat_value(resource_klass, :id, value)
    when 'attributes'
      value.each do |key, value|
        param = unformat_key(key)
        checked_attributes[param] = unformat_value(resource_klass, param, value)
      end
    end
  end

  {
    'attributes' => checked_attributes,
    'to_one' => checked_to_one_relationships,
    'to_many' => checked_to_many_relationships
  }.deep_transform_keys { |key| unformat_key(key) }
end

#parse_remove_relationship_operation(resource_klass, params, relationship, parent_key) ⇒ Object 



701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
 
# File 'lib/jsonapi/request.rb', line 701

def parse_remove_relationship_operation(resource_klass, params, relationship, parent_key)
  operation_base_args = [resource_klass].push(
    context: @context,
    resource_id: parent_key,
    relationship_type: relationship.name
  )

  if relationship.is_a?(JSONAPI::Relationship::ToMany)
    operation_args = operation_base_args.dup
    keys = params[:to_many].values[0]
    operation_args[1] = operation_args[1].merge(associated_keys: keys)
    @operations << JSONAPI::Operation.new(:remove_to_many_relationships, *operation_args)
  else
    @operations << JSONAPI::Operation.new(:remove_to_one_relationship, *operation_base_args)
  end
end

#parse_sort_criteria(resource_klass, sort_criteria) ⇒ Object 



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/jsonapi/request.rb', line 403

def parse_sort_criteria(resource_klass, sort_criteria)
  return unless sort_criteria.present?

  unless JSONAPI.configuration.allow_sort
    fail JSONAPI::Exceptions::ParameterNotAllowed.new(:sort)
  end

  if sort_criteria.is_a?(Array)
    sorts = sort_criteria
  elsif sort_criteria.is_a?(String)
    begin
      raw = URI.decode_www_form_component(sort_criteria)
      sorts = CSV.parse_line(raw)
    rescue CSV::MalformedCSVError
      fail JSONAPI::Exceptions::InvalidSortCriteria.new(format_key(resource_klass._type), raw)
    end
  end

  @sort_criteria = sorts.collect do |sort|
    if sort.start_with?('-')
      criteria = { field: unformat_key(sort[1..-1]).to_s }
      criteria[:direction] = :desc
    else
      criteria = { field: unformat_key(sort).to_s }
      criteria[:direction] = :asc
    end

    check_sort_criteria(resource_klass, criteria)
    criteria
  end
end

#parse_to_many_links_object(raw) ⇒ Object 



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/jsonapi/request.rb', line 470

def parse_to_many_links_object(raw)
  fail JSONAPI::Exceptions::InvalidLinksObject.new(error_object_overrides) if raw.nil?

  links_object = {}
  if raw.is_a?(Array)
    raw.each do |link|
      link_object = parse_to_one_links_object(link)
      links_object[link_object[:type]] ||= []
      links_object[link_object[:type]].push(link_object[:id])
    end
  else
    fail JSONAPI::Exceptions::InvalidLinksObject.new(error_object_overrides)
  end
  links_object
end

#parse_to_many_relationship(resource_klass, link_value, relationship, &add_result) ⇒ Object 



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/jsonapi/request.rb', line 551

def parse_to_many_relationship(resource_klass, link_value, relationship, &add_result)
  if (link_value.is_a?(Hash) || link_value.is_a?(ActionController::Parameters))
    linkage = link_value[:data]
  else
    fail JSONAPI::Exceptions::InvalidLinksObject.new(error_object_overrides)
  end

  links_object = parse_to_many_links_object(linkage)

  if links_object.length == 0
    add_result.call([])
  else
    if relationship.polymorphic?
      polymorphic_results = []

      links_object.each_pair do |type, keys|
        type_name = unformat_key(type).to_s

        relationship_resource_klass = resource_klass.resource_klass_for(relationship.class_name)
        relationship_klass = relationship_resource_klass._model_class

        linkage_object_resource_klass = resource_klass.resource_klass_for(type_name)
        linkage_object_klass = linkage_object_resource_klass._model_class

        unless linkage_object_klass == relationship_klass || linkage_object_klass.in?(relationship_klass.subclasses)
          fail JSONAPI::Exceptions::TypeMismatch.new(type_name)
        end

        relationship_ids = relationship_resource_klass.verify_keys(keys, @context)
        polymorphic_results << { type: type, ids: relationship_ids }
      end

      add_result.call polymorphic_results
    else
      relationship_type = unformat_key(relationship.type).to_s

      if links_object.length > 1 || !links_object.has_key?(relationship_type)
        fail JSONAPI::Exceptions::TypeMismatch.new(links_object[:type])
      end

      relationship_resource_klass = Resource.resource_klass_for(resource_klass.module_path + relationship_type)
      add_result.call relationship_resource_klass.verify_keys(links_object[relationship_type], @context)
    end
  end
end

#parse_to_one_links_object(raw) ⇒ Object 



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/jsonapi/request.rb', line 451

def parse_to_one_links_object(raw)
  if raw.nil?
    return {
      type: nil,
      id: nil
    }
  end

  if !(raw.is_a?(Hash) || raw.is_a?(ActionController::Parameters)) ||
    raw.keys.length != 2 || !(raw.key?('type') && raw.key?('id'))
    fail JSONAPI::Exceptions::InvalidLinksObject.new(error_object_overrides)
  end

  {
    type: unformat_key(raw['type']).to_s,
    id: raw['id']
  }
end

#parse_to_one_relationship(resource_klass, link_value, relationship) ⇒ Object 



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/jsonapi/request.rb', line 525

def parse_to_one_relationship(resource_klass, link_value, relationship)
  if link_value.nil?
    linkage = nil
  else
    linkage = link_value[:data]
  end

  links_object = parse_to_one_links_object(linkage)
  if !relationship.polymorphic? && links_object[:type] && (links_object[:type].to_s != relationship.type.to_s)
    fail JSONAPI::Exceptions::TypeMismatch.new(links_object[:type], error_object_overrides)
  end

  unless links_object[:id].nil?
    resource = resource_klass || Resource
    relationship_resource = resource.resource_klass_for(unformat_key(relationship.options[:class_name] || links_object[:type]).to_s)
    relationship_id = relationship_resource.verify_key(links_object[:id], @context)
    if relationship.polymorphic?
      { id: relationship_id, type: unformat_key(links_object[:type].to_s) }
    else
      relationship_id
    end
  else
    nil
  end
end

#parse_update_relationship_operation(resource_klass, verified_params, relationship, parent_key) ⇒ Object 



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'lib/jsonapi/request.rb', line 673

def parse_update_relationship_operation(resource_klass, verified_params, relationship, parent_key)
  options = {
    context: @context,
    resource_id: parent_key,
    relationship_type: relationship.name
  }

  if relationship.is_a?(JSONAPI::Relationship::ToOne)
    if relationship.polymorphic?
      options[:key_value] = verified_params[:to_one].values[0][:id]
      options[:key_type] = verified_params[:to_one].values[0][:type]

      operation_type = :replace_polymorphic_to_one_relationship
    else
      options[:key_value] = verified_params[:to_one].values[0]
      operation_type = :replace_to_one_relationship
    end
  elsif relationship.is_a?(JSONAPI::Relationship::ToMany)
    unless relationship.acts_as_set
      fail JSONAPI::Exceptions::ToManySetReplacementForbidden.new
    end
    options[:data] = verified_params[:to_many].values[0]
    operation_type = :replace_to_many_relationships
  end

  @operations << JSONAPI::Operation.new(operation_type, resource_klass, options)
end

#resolve_singleton_id(params, resource_klass) ⇒ Object 



718
719
720
721
722
723
 
# File 'lib/jsonapi/request.rb', line 718

def resolve_singleton_id(params, resource_klass)
  if resource_klass.singleton? && params[:id].nil?
    key = resource_klass.singleton_key(context)
    params[:id] = key
  end
end

#setup_create_action(params, resource_klass) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/jsonapi/request.rb', line 166

def setup_create_action(params, resource_klass)
  fields = parse_fields(resource_klass, params[:fields])
  include_directives = parse_include_directives(resource_klass, params[:include])

  data = params.require(:data)

  unless data.respond_to?(:each_pair)
    fail JSONAPI::Exceptions::InvalidDataFormat.new(error_object_overrides)
  end

  verify_type(data[:type], resource_klass)

  data = parse_params(resource_klass, data, resource_klass.creatable_fields(@context))

  @operations << JSONAPI::Operation.new(
    :create_resource,
    resource_klass,
    context: @context,
    data: data,
    fields: fields,
    include_directives: include_directives,
    warnings: @warnings
  )
end

#setup_create_relationship_action(params, resource_klass) ⇒ Object 



191
192
193
194
 
# File 'lib/jsonapi/request.rb', line 191

def setup_create_relationship_action(params, resource_klass)
  resolve_singleton_id(params, resource_klass)
  parse_modify_relationship_action(:add, params, resource_klass)
end

#setup_destroy_action(params, resource_klass) ⇒ Object 



234
235
236
237
238
239
240
241
 
# File 'lib/jsonapi/request.rb', line 234

def setup_destroy_action(params, resource_klass)
  resolve_singleton_id(params, resource_klass)
  @operations << JSONAPI::Operation.new(
    :remove_resource,
    resource_klass,
    context: @context,
    resource_id: resource_klass.verify_key(params.require(:id), @context))
end

#setup_destroy_relationship_action(params, resource_klass) ⇒ Object 



243
244
245
246
 
# File 'lib/jsonapi/request.rb', line 243

def setup_destroy_relationship_action(params, resource_klass)
  resolve_singleton_id(params, resource_klass)
  parse_modify_relationship_action(:remove, params, resource_klass)
end

#setup_index_action(params, resource_klass) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/jsonapi/request.rb', line 58

def setup_index_action(params, resource_klass)
  fields = parse_fields(resource_klass, params[:fields])
  include_directives = parse_include_directives(resource_klass, params[:include])
  filters = parse_filters(resource_klass, params[:filter])
  sort_criteria = parse_sort_criteria(resource_klass, params[:sort])
  paginator = parse_pagination(resource_klass, params[:page])

  @operations << JSONAPI::Operation.new(
    :find,
    resource_klass,
    context: context,
    filters: filters,
    include_directives: include_directives,
    sort_criteria: sort_criteria,
    paginator: paginator,
    fields: fields
  )
end

#setup_index_related_resources_action(params, resource_klass) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/jsonapi/request.rb', line 99

def setup_index_related_resources_action(params, resource_klass)
  resolve_singleton_id(params, resource_klass)
  source_klass = Resource.resource_klass_for(params.require(:source))
  source_id = source_klass.verify_key(params.require(source_klass._as_parent_key), @context)

  fields = parse_fields(resource_klass, params[:fields])
  include_directives = parse_include_directives(resource_klass, params[:include])
  filters = parse_filters(resource_klass, params[:filter])
  sort_criteria = parse_sort_criteria(resource_klass, params[:sort])
  paginator = parse_pagination(resource_klass, params[:page])
  relationship_type = params[:relationship]

  @operations << JSONAPI::Operation.new(
    :show_related_resources,
    resource_klass,
    context: @context,
    relationship_type: relationship_type,
    source_klass: source_klass,
    source_id: source_id,
    filters: filters,
    sort_criteria: sort_criteria,
    paginator: paginator,
    fields: fields,
    include_directives: include_directives
  )
end

#setup_operations(params) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/jsonapi/request.rb', line 41

def setup_operations(params)
  return if params.nil?

  resource_klass = Resource.resource_klass_for(params[:controller]) if params[:controller]

  setup_action_method_name = "setup_#{params[:action]}_action"
  if respond_to?(setup_action_method_name)
    raise params[:_parser_exception] if params[:_parser_exception]
    send(setup_action_method_name, params, resource_klass)
  end
rescue ActionController::ParameterMissing => e
  @errors.concat(JSONAPI::Exceptions::ParameterMissing.new(e.param, error_object_overrides).errors)
rescue JSONAPI::Exceptions::Error => e
  e.error_object_overrides.merge! error_object_overrides
  @errors.concat(e.errors)
end

#setup_show_action(params, resource_klass) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/jsonapi/request.rb', line 126

def setup_show_action(params, resource_klass)
  resolve_singleton_id(params, resource_klass)
  fields = parse_fields(resource_klass, params[:fields])
  include_directives = parse_include_directives(resource_klass, params[:include])
  id = params[:id]

  @operations << JSONAPI::Operation.new(
    :show,
    resource_klass,
    context: @context,
    id: id,
    include_directives: include_directives,
    fields: fields,
    allowed_resources: params[:allowed_resources]
  )
end

#setup_show_related_resource_action(params, resource_klass) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/jsonapi/request.rb', line 77

def setup_show_related_resource_action(params, resource_klass)
  resolve_singleton_id(params, resource_klass)
  source_klass = Resource.resource_klass_for(params.require(:source))
  source_id = source_klass.verify_key(params.require(source_klass._as_parent_key), @context)

  fields = parse_fields(resource_klass, params[:fields])
  include_directives = parse_include_directives(resource_klass, params[:include])

  relationship_type = params[:relationship].to_sym

  @operations << JSONAPI::Operation.new(
    :show_related_resource,
    resource_klass,
    context: @context,
    relationship_type: relationship_type,
    source_klass: source_klass,
    source_id: source_id,
    fields: fields,
    include_directives: include_directives
  )
end

#setup_show_relationship_action(params, resource_klass) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/jsonapi/request.rb', line 143

def setup_show_relationship_action(params, resource_klass)
  resolve_singleton_id(params, resource_klass)
  relationship_type = params[:relationship]
  parent_key = params.require(resource_klass._as_parent_key)
  include_directives = parse_include_directives(resource_klass, params[:include])
  filters = parse_filters(resource_klass, params[:filter])
  sort_criteria = parse_sort_criteria(resource_klass, params[:sort])
  paginator = parse_pagination(resource_klass, params[:page])

  @operations << JSONAPI::Operation.new(
    :show_relationship,
    resource_klass,
    context: @context,
    relationship_type: relationship_type,
    parent_key: resource_klass.verify_key(parent_key),
    filters: filters,
    sort_criteria: sort_criteria,
    paginator: paginator,
    fields: fields,
    include_directives: include_directives
  )
end

#setup_update_action(params, resource_klass) ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/jsonapi/request.rb', line 200

def setup_update_action(params, resource_klass)
  resolve_singleton_id(params, resource_klass)
  fields = parse_fields(resource_klass, params[:fields])
  include_directives = parse_include_directives(resource_klass, params[:include])

  data = params.require(:data)
  key = params[:id]

  fail JSONAPI::Exceptions::InvalidDataFormat.new(error_object_overrides) unless data.respond_to?(:each_pair)

  fail JSONAPI::Exceptions::MissingKey.new(error_object_overrides) if data[:id].nil?

  resource_id = data.require(:id)
  # Singleton resources may not have the ID set in the URL
  if key
    fail JSONAPI::Exceptions::KeyNotIncludedInURL.new(resource_id) if key.to_s != resource_id.to_s
  end

  data.delete(:id)

  verify_type(data[:type], resource_klass)

  @operations << JSONAPI::Operation.new(
    :replace_fields,
    resource_klass,
    context: @context,
    resource_id: resource_id,
    data: parse_params(resource_klass, data, resource_klass.updatable_fields(@context)),
    fields: fields,
    include_directives: include_directives,
    warnings: @warnings
  )
end

#setup_update_relationship_action(params, resource_klass) ⇒ Object 



196
197
198
 
# File 'lib/jsonapi/request.rb', line 196

def setup_update_relationship_action(params, resource_klass)
  parse_modify_relationship_action(:update, params, resource_klass)
end

#transactional? ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
35
36
37
38
39
 
# File 'lib/jsonapi/request.rb', line 32

def transactional?
  case params[:action]
  when 'index', 'show_related_resource', 'index_related_resources', 'show', 'show_relationship'
    false
  else
    JSONAPI.configuration.allow_transactions
  end
end

#unformat_key(key) ⇒ Object 



729
730
731
732
 
# File 'lib/jsonapi/request.rb', line 729

def unformat_key(key)
  unformatted_key = @key_formatter.unformat(key)
  unformatted_key.nil? ? nil : unformatted_key.to_sym
end

#unformat_value(resource_klass, attribute, value) ⇒ Object 



597
598
599
600
 
# File 'lib/jsonapi/request.rb', line 597

def unformat_value(resource_klass, attribute, value)
  value_formatter = JSONAPI::ValueFormatter.value_formatter_for(resource_klass._attribute_options(attribute)[:format])
  value_formatter.unformat(value)
end

#verify_permitted_params(params, allowed_fields) ⇒ Object 



602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/jsonapi/request.rb', line 602

def verify_permitted_params(params, allowed_fields)
  formatted_allowed_fields = allowed_fields.collect { |field| format_key(field).to_sym }
  params_not_allowed = []

  params.each do |key, value|
    case key.to_s
    when 'relationships'
      value.keys.each do |links_key|
        unless formatted_allowed_fields.include?(links_key.to_sym)
          if JSONAPI.configuration.raise_if_parameters_not_allowed
            fail JSONAPI::Exceptions::ParameterNotAllowed.new(links_key, error_object_overrides)
          else
            params_not_allowed.push(links_key)
            value.delete links_key
          end
        end
      end
    when 'attributes'
      value.each do |attr_key, _attr_value|
        unless formatted_allowed_fields.include?(attr_key.to_sym)
          if JSONAPI.configuration.raise_if_parameters_not_allowed
            fail JSONAPI::Exceptions::ParameterNotAllowed.new(attr_key, error_object_overrides)
          else
            params_not_allowed.push(attr_key)
            value.delete attr_key
          end
        end
      end
    when 'type'
    when 'id'
      unless formatted_allowed_fields.include?(:id)
        if JSONAPI.configuration.raise_if_parameters_not_allowed
          fail JSONAPI::Exceptions::ParameterNotAllowed.new(:id, error_object_overrides)
        else
          params_not_allowed.push(:id)
          params.delete :id
        end
      end
    else
      if JSONAPI.configuration.raise_if_parameters_not_allowed
        fail JSONAPI::Exceptions::ParameterNotAllowed.new(key, error_object_overrides)
      else
        params_not_allowed.push(key)
        params.delete key
      end
    end
  end

  if params_not_allowed.length > 0
    params_not_allowed_warnings = params_not_allowed.map do |param|
      JSONAPI::Warning.new(code: JSONAPI::PARAM_NOT_ALLOWED,
                           title: 'Param not allowed',
                           detail: "#{param} is not allowed.")
    end
    self.warnings.concat(params_not_allowed_warnings)
  end
end

#verify_type(type, resource_klass) ⇒ Object 



443
444
445
446
447
448
449
 
# File 'lib/jsonapi/request.rb', line 443

def verify_type(type, resource_klass)
  if type.nil?
    fail JSONAPI::Exceptions::ParameterMissing.new(:type)
  elsif unformat_key(type).to_sym != resource_klass._type
    fail JSONAPI::Exceptions::InvalidResource.new(type, error_object_overrides)
  end
end