Class: JSONAPI::RequestParser

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RequestParser.



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

def initialize(params = nil, options = {})
  @params = params
  @context = options[:context]
  @key_formatter = options.fetch(:key_formatter, JSONAPI.configuration.key_formatter)
  @errors = []
  @warnings = []
  @operations = []
  @fields = {}
  @filters = {}
  @sort_criteria = nil
  @source_klass = nil
  @source_id = nil
  @include_directives = nil
  @paginator = nil
  @id = nil
  @server_error_callbacks = options.fetch(:server_error_callbacks, [])

  setup_action(@params)
end

Instance Attribute Details

#context ⇒ Object

Returns the value of attribute context.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def context
  @context
end

#errors ⇒ Object

Returns the value of attribute errors.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def errors
  @errors
end

#fields ⇒ Object

Returns the value of attribute fields.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def fields
  @fields
end

#filters ⇒ Object

Returns the value of attribute filters.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def filters
  @filters
end

#include ⇒ Object

Returns the value of attribute include.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def include
  @include
end

#include_directives ⇒ Object

Returns the value of attribute include_directives.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def include_directives
  @include_directives
end

#operations ⇒ Object

Returns the value of attribute operations.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def operations
  @operations
end

#paginator ⇒ Object

Returns the value of attribute paginator.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def paginator
  @paginator
end

#params ⇒ Object

Returns the value of attribute params.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def params
  @params
end

#resource_klass ⇒ Object

Returns the value of attribute resource_klass.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def resource_klass
  @resource_klass
end

#server_error_callbacks ⇒ Object

Returns the value of attribute server_error_callbacks.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def server_error_callbacks
  @server_error_callbacks
end

#sort_criteria ⇒ Object

Returns the value of attribute sort_criteria.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def sort_criteria
  @sort_criteria
end

#source_id ⇒ Object

Returns the value of attribute source_id.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def source_id
  @source_id
end

#source_klass ⇒ Object

Returns the value of attribute source_klass.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def source_klass
  @source_klass
end

#warnings ⇒ Object

Returns the value of attribute warnings.



6
7
8
 
# File 'lib/jsonapi/request_parser.rb', line 6

def warnings
  @warnings
end

Instance Method Details

#add_find_operation ⇒ Object 



291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/jsonapi/request_parser.rb', line 291

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

#add_show_operation ⇒ Object 



303
304
305
306
307
308
309
310
311
 
# File 'lib/jsonapi/request_parser.rb', line 303

def add_show_operation
  @operations.push JSONAPI::Operation.new(:show,
    @resource_klass,
    context: @context,
    id: @id,
    include_directives: @include_directives,
    fields: @fields
  )
end

#add_show_related_resource_operation(relationship_type) ⇒ Object 



322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/jsonapi/request_parser.rb', line 322

def add_show_related_resource_operation(relationship_type)
  @operations.push 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

#add_show_related_resources_operation(relationship_type) ⇒ Object 



334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/jsonapi/request_parser.rb', line 334

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

#add_show_relationship_operation(relationship_type, parent_key) ⇒ Object 



313
314
315
316
317
318
319
320
 
# File 'lib/jsonapi/request_parser.rb', line 313

def add_show_relationship_operation(relationship_type, parent_key)
  @operations.push JSONAPI::Operation.new(:show_relationship,
    @resource_klass,
    context: @context,
    relationship_type: relationship_type,
    parent_key: @resource_klass.verify_key(parent_key)
  )
end

#check_include(resource_klass, include_parts) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/jsonapi/request_parser.rb', line 198

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 include_parts.last.empty?
      check_include(Resource.resource_for(@resource_klass.module_path + relationship.class_name.to_s.underscore), include_parts.last.partition('.'))
    end
  else
    @errors.concat(JSONAPI::Exceptions::InvalidInclude.new(format_key(resource_klass._type),
                                                           include_parts.first).errors)
  end
end

#check_sort_criteria(resource_klass, sort_criteria) ⇒ Object 



281
282
283
284
285
286
287
288
289
 
# File 'lib/jsonapi/request_parser.rb', line 281

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

  unless sortable_fields.include? sort_field.to_sym
    @errors.concat(JSONAPI::Exceptions::InvalidSortCriteria
                     .new(format_key(resource_klass._type), sort_field).errors)
  end
end

#creatable_fields ⇒ Object

TODO: Please remove after ‘createable_fields` is removed :nocov:



351
352
353
354
355
356
357
 
# File 'lib/jsonapi/request_parser.rb', line 351

def creatable_fields
  if @resource_klass.respond_to?(:createable_fields)
    creatable_fields = @resource_klass.createable_fields(@context)
  else
    creatable_fields = @resource_klass.creatable_fields(@context)
  end
end

#format_key(key) ⇒ Object 



700
701
702
 
# File 'lib/jsonapi/request_parser.rb', line 700

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

#initialize_source(params) ⇒ Object 



135
136
137
138
 
# File 'lib/jsonapi/request_parser.rb', line 135

def initialize_source(params)
  @source_klass = Resource.resource_for(params.require(:source))
  @source_id = @source_klass.verify_key(params.require(@source_klass._as_parent_key), @context)
end

#parse_add_operation(data) ⇒ Object

:nocov:



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/jsonapi/request_parser.rb', line 360

def parse_add_operation(data)
  Array.wrap(data).each do |params|
    verify_type(params[:type])

    data = parse_params(params, creatable_fields)
    @operations.push JSONAPI::Operation.new(:create_resource,
      @resource_klass,
      context: @context,
      data: data,
      fields: @fields,
      include_directives: @include_directives
    )
  end
rescue JSONAPI::Exceptions::Error => e
  @errors.concat(e.errors)
end

#parse_add_relationship_operation(verified_params, relationship, parent_key) ⇒ Object

:nocov:



581
582
583
584
585
586
587
588
589
590
591
 
# File 'lib/jsonapi/request_parser.rb', line 581

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

#parse_fields(fields) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/jsonapi/request_parser.rb', line 147

def parse_fields(fields)
  return if fields.nil?

  extracted_fields = {}

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

  # Validate the fields
  extracted_fields.each do |type, values|
    underscored_type = unformat_key(type)
    extracted_fields[type] = []
    begin
      if type != format_key(type)
        fail JSONAPI::Exceptions::InvalidResource.new(type)
      end
      type_resource = Resource.resource_for(@resource_klass.module_path + underscored_type.to_s)
    rescue NameError
      @errors.concat(JSONAPI::Exceptions::InvalidResource.new(type).errors)
    rescue JSONAPI::Exceptions::InvalidResource => e
      @errors.concat(e.errors)
    end

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

  @fields = extracted_fields.deep_transform_keys { |key| unformat_key(key) }
end

#parse_filters(filters) ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/jsonapi/request_parser.rb', line 231

def parse_filters(filters)
  return unless filters

  unless JSONAPI.configuration.allow_filter
    fail JSONAPI::Exceptions::ParametersNotAllowed.new([:filter])
  end

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

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

#parse_include_directives(include) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/jsonapi/request_parser.rb', line 212

def parse_include_directives(include)
  return if include.nil?

  unless JSONAPI.configuration.allow_include
    fail JSONAPI::Exceptions::ParametersNotAllowed.new([:include])
  end

  included_resources = CSV.parse_line(include)
  return if included_resources.nil?

  include = []
  included_resources.each do |included_resource|
    check_include(@resource_klass, included_resource.partition('.'))
    include.push(unformat_key(included_resource).to_s)
  end

  @include_directives = JSONAPI::IncludeDirectives.new(@resource_klass, include)
end

#parse_key_array(raw) ⇒ Object 



696
697
698
 
# File 'lib/jsonapi/request_parser.rb', line 696

def parse_key_array(raw)
  @resource_klass.verify_keys(raw.split(/,/), context)
end

#parse_modify_relationship_action(params, modification_type) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/jsonapi/request_parser.rb', line 114

def parse_modify_relationship_action(params, modification_type)
  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(object_params, updatable_fields)

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

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

#parse_pagination(page) ⇒ Object 



140
141
142
143
144
145
 
# File 'lib/jsonapi/request_parser.rb', line 140

def parse_pagination(page)
  paginator_name = @resource_klass._paginator
  @paginator = JSONAPI::Paginator.paginator_for(paginator_name).new(page) unless paginator_name == :none
rescue JSONAPI::Exceptions::Error => e
  @errors.concat(e.errors)
end

#parse_params(params, allowed_fields) ⇒ Object 



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

def parse_params(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(link_value, relationship)
        elsif relationship.is_a?(JSONAPI::Relationship::ToMany)
          parse_to_many_relationship(link_value, relationship) do |result_val|
            checked_to_many_relationships[param] = result_val
          end
        end
      end
    when 'id'
      checked_attributes['id'] = unformat_value(:id, value)
    when 'attributes'
      value.each do |key, value|
        param = unformat_key(key)
        checked_attributes[param] = unformat_value(param, value)
      end
    end
  end

  return {
    '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_operation(params) ⇒ Object 



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

def parse_remove_operation(params)
  keys = parse_key_array(params.require(:id))

  keys.each do |key|
    @operations.push JSONAPI::Operation.new(:remove_resource,
      @resource_klass,
      context: @context,
      resource_id: key
    )
  end
rescue JSONAPI::Exceptions::Error => e
  @errors.concat(e.errors)
end

#parse_remove_relationship_operation(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
 
# File 'lib/jsonapi/request_parser.rb', line 673

def parse_remove_relationship_operation(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)
    keys = params[:to_many].values[0]
    keys.each do |key|
      operation_args = operation_base_args.dup
      operation_args[1] = operation_args[1].merge(associated_key: key)
      @operations.push JSONAPI::Operation.new(:remove_to_many_relationship,
        *operation_args
      )
    end
  else
    @operations.push JSONAPI::Operation.new(:remove_to_one_relationship,
      *operation_base_args
    )
  end
end

#parse_replace_operation(data, keys) ⇒ Object 



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/jsonapi/request_parser.rb', line 643

def parse_replace_operation(data, keys)
  if data.is_a?(Array)
    fail JSONAPI::Exceptions::CountMismatch if keys.count != data.count

    data.each do |object_params|
      parse_single_replace_operation(object_params, keys)
    end
  else
    parse_single_replace_operation(data, [keys],
                                   id_key_presence_check_required: keys.present?)
  end

rescue JSONAPI::Exceptions::Error => e
  @errors.concat(e.errors)
end

#parse_single_replace_operation(data, keys, id_key_presence_check_required: true) ⇒ Object 



621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/jsonapi/request_parser.rb', line 621

def parse_single_replace_operation(data, keys, id_key_presence_check_required: true)
  fail JSONAPI::Exceptions::MissingKey.new if data[:id].nil?

  key = data[:id].to_s
  if id_key_presence_check_required && !keys.include?(key)
    fail JSONAPI::Exceptions::KeyNotIncludedInURL.new(key)
  end

  data.delete(:id) unless keys.include?(:id)

  verify_type(data[:type])

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

#parse_sort_criteria(sort_criteria) ⇒ Object 



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/jsonapi/request_parser.rb', line 260

def parse_sort_criteria(sort_criteria)
  return unless sort_criteria.present?

  unless JSONAPI.configuration.allow_sort
    fail JSONAPI::Exceptions::ParametersNotAllowed.new([:sort])
  end

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

    check_sort_criteria(@resource_klass, sort_criteria)
    sort_criteria
  end
end

#parse_to_many_links_object(raw) ⇒ Object 



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/jsonapi/request_parser.rb', line 404

def parse_to_many_links_object(raw)
  fail JSONAPI::Exceptions::InvalidLinksObject.new 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
  end
  links_object
end

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



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

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

  links_object = parse_to_many_links_object(linkage)

  # Since we do not yet support polymorphic to_many relationships we will raise an error if the type does not match the
  # relationship's type.
  # ToDo: Support Polymorphic relationships

  if links_object.length == 0
    add_result.call([])
  else
    if links_object.length > 1 || !links_object.has_key?(unformat_key(relationship.type).to_s)
      fail JSONAPI::Exceptions::TypeMismatch.new(links_object[:type])
    end

    links_object.each_pair do |type, keys|
      relationship_resource = Resource.resource_for(@resource_klass.module_path + unformat_key(type).to_s)
      add_result.call relationship_resource.verify_keys(keys, @context)
    end
  end
end

#parse_to_one_links_object(raw) ⇒ Object 



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/jsonapi/request_parser.rb', line 385

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
  end

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

#parse_to_one_relationship(link_value, relationship) ⇒ Object 



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

def parse_to_one_relationship(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])
  end

  unless links_object[:id].nil?
    resource = self.resource_klass || Resource
    relationship_resource = resource.resource_for(unformat_key(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(verified_params, relationship, parent_key) ⇒ Object 



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/jsonapi/request_parser.rb', line 593

def parse_update_relationship_operation(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_relationship
  end

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

#set_default_filters ⇒ Object 



253
254
255
256
257
258
 
# File 'lib/jsonapi/request_parser.rb', line 253

def set_default_filters
  @resource_klass._allowed_filters.each do |filter, opts|
    next if opts[:default].nil? || !@filters[filter].nil?
    @filters[filter] = opts[:default]
  end
end

#setup_action(params) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/jsonapi/request_parser.rb', line 30

def setup_action(params)
  return if params.nil?

  @resource_klass ||= Resource.resource_for(params[:controller]) if params[:controller]

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

#setup_create_action(params) ⇒ Object 



86
87
88
89
90
 
# File 'lib/jsonapi/request_parser.rb', line 86

def setup_create_action(params)
  parse_fields(params[:fields])
  parse_include_directives(params[:include])
  parse_add_operation(params.require(:data))
end

#setup_create_relationship_action(params) ⇒ Object 



92
93
94
 
# File 'lib/jsonapi/request_parser.rb', line 92

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

#setup_destroy_action(params) ⇒ Object 



106
107
108
 
# File 'lib/jsonapi/request_parser.rb', line 106

def setup_destroy_action(params)
  parse_remove_operation(params)
end

#setup_destroy_relationship_action(params) ⇒ Object 



110
111
112
 
# File 'lib/jsonapi/request_parser.rb', line 110

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

#setup_get_related_resource_action(params) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/jsonapi/request_parser.rb', line 53

def setup_get_related_resource_action(params)
  initialize_source(params)
  parse_fields(params[:fields])
  parse_include_directives(params[:include])
  set_default_filters
  parse_filters(params[:filter])
  parse_sort_criteria(params[:sort])
  parse_pagination(params[:page])
  add_show_related_resource_operation(params[:relationship])
end

#setup_get_related_resources_action(params) ⇒ Object 



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/jsonapi/request_parser.rb', line 64

def setup_get_related_resources_action(params)
  initialize_source(params)
  parse_fields(params[:fields])
  parse_include_directives(params[:include])
  set_default_filters
  parse_filters(params[:filter])
  parse_sort_criteria(params[:sort])
  parse_pagination(params[:page])
  add_show_related_resources_operation(params[:relationship])
end

#setup_index_action(params) ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/jsonapi/request_parser.rb', line 43

def setup_index_action(params)
  parse_fields(params[:fields])
  parse_include_directives(params[:include])
  set_default_filters
  parse_filters(params[:filter])
  parse_sort_criteria(params[:sort])
  parse_pagination(params[:page])
  add_find_operation
end

#setup_show_action(params) ⇒ Object 



75
76
77
78
79
80
 
# File 'lib/jsonapi/request_parser.rb', line 75

def setup_show_action(params)
  parse_fields(params[:fields])
  parse_include_directives(params[:include])
  @id = params[:id]
  add_show_operation
end

#setup_show_relationship_action(params) ⇒ Object 



82
83
84
 
# File 'lib/jsonapi/request_parser.rb', line 82

def setup_show_relationship_action(params)
  add_show_relationship_operation(params[:relationship], params.require(@resource_klass._as_parent_key))
end

#setup_update_action(params) ⇒ Object 



100
101
102
103
104
 
# File 'lib/jsonapi/request_parser.rb', line 100

def setup_update_action(params)
  parse_fields(params[:fields])
  parse_include_directives(params[:include])
  parse_replace_operation(params.require(:data), params[:id])
end

#setup_update_relationship_action(params) ⇒ Object 



96
97
98
 
# File 'lib/jsonapi/request_parser.rb', line 96

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

#unformat_key(key) ⇒ Object 



704
705
706
707
 
# File 'lib/jsonapi/request_parser.rb', line 704

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

#unformat_value(attribute, value) ⇒ Object 



514
515
516
517
 
# File 'lib/jsonapi/request_parser.rb', line 514

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

#updatable_fields ⇒ Object

TODO: Please remove after ‘updateable_fields` is removed :nocov:



572
573
574
575
576
577
578
 
# File 'lib/jsonapi/request_parser.rb', line 572

def updatable_fields
  if @resource_klass.respond_to?(:updateable_fields)
    @resource_klass.updateable_fields(@context)
  else
    @resource_klass.updatable_fields(@context)
  end
end

#verify_permitted_params(params, allowed_fields) ⇒ Object 



519
520
521
522
523
524
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
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'lib/jsonapi/request_parser.rb', line 519

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)
          params_not_allowed.push(links_key)
          unless JSONAPI.configuration.raise_if_parameters_not_allowed
            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)
          params_not_allowed.push(attr_key)
          unless JSONAPI.configuration.raise_if_parameters_not_allowed
            value.delete attr_key
          end
        end
      end
    when 'type'
    when 'id'
      unless formatted_allowed_fields.include?(:id)
        params_not_allowed.push(:id)
        unless JSONAPI.configuration.raise_if_parameters_not_allowed
          params.delete :id
        end
      end
    else
      params_not_allowed.push(key)
    end
  end

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

#verify_type(type) ⇒ Object 



377
378
379
380
381
382
383
 
# File 'lib/jsonapi/request_parser.rb', line 377

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