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.



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/jsonapi/request.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 = [{ field: 'id', direction: :asc }]
  @source_klass = nil
  @source_id = nil
  @include_directives = nil
  @paginator = nil
  @id = nil

  setup_action(@params)
end

Instance Attribute Details

#context ⇒ Object

Returns the value of attribute context.



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

def context
  @context
end

#errors ⇒ Object

Returns the value of attribute errors.



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

def errors
  @errors
end

#fields ⇒ Object

Returns the value of attribute fields.



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

def fields
  @fields
end

#filters ⇒ Object

Returns the value of attribute filters.



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

def filters
  @filters
end

#include ⇒ Object

Returns the value of attribute include.



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

def include
  @include
end

#include_directives ⇒ Object

Returns the value of attribute include_directives.



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

def include_directives
  @include_directives
end

#operations ⇒ Object

Returns the value of attribute operations.



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

def operations
  @operations
end

#paginator ⇒ Object

Returns the value of attribute paginator.



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

def paginator
  @paginator
end

#params ⇒ Object

Returns the value of attribute params.



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

def params
  @params
end

#resource_klass ⇒ Object

Returns the value of attribute resource_klass.



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

def resource_klass
  @resource_klass
end

#sort_criteria ⇒ Object

Returns the value of attribute sort_criteria.



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

def source_klass
  @source_klass
end

#warnings ⇒ Object

Returns the value of attribute warnings.



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

def warnings
  @warnings
end

Instance Method Details

#add_find_operation ⇒ Object 



276
277
278
279
280
281
282
283
284
285
 
# File 'lib/jsonapi/request.rb', line 276

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

#add_show_operation ⇒ Object 



287
288
289
290
291
292
293
294
 
# File 'lib/jsonapi/request.rb', line 287

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

#add_show_related_resource_operation(relationship_type) ⇒ Object 



305
306
307
308
309
310
311
312
313
 
# File 'lib/jsonapi/request.rb', line 305

def add_show_related_resource_operation(relationship_type)
  @operations.push JSONAPI::ShowRelatedResourceOperation.new(
    @resource_klass,
    context: @context,
    relationship_type: relationship_type,
    source_klass: @source_klass,
    source_id: @source_id
  )
end

#add_show_related_resources_operation(relationship_type) ⇒ Object 



315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/jsonapi/request.rb', line 315

def add_show_related_resources_operation(relationship_type)
  @operations.push JSONAPI::ShowRelatedResourcesOperation.new(
    @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
  )
end

#add_show_relationship_operation(relationship_type, parent_key) ⇒ Object 



296
297
298
299
300
301
302
303
 
# File 'lib/jsonapi/request.rb', line 296

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

#check_include(resource_klass, include_parts) ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/jsonapi/request.rb', line 183

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 



266
267
268
269
270
271
272
273
274
 
# File 'lib/jsonapi/request.rb', line 266

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:



330
331
332
333
334
335
336
 
# File 'lib/jsonapi/request.rb', line 330

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 



686
687
688
 
# File 'lib/jsonapi/request.rb', line 686

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

#initialize_source(params) ⇒ Object 



119
120
121
122
 
# File 'lib/jsonapi/request.rb', line 119

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:



339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/jsonapi/request.rb', line 339

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

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

#parse_add_relationship_operation(data, relationship_type, parent_key) ⇒ Object

:nocov:



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/jsonapi/request.rb', line 538

def parse_add_relationship_operation(data, relationship_type, parent_key)
  relationship = resource_klass._relationship(relationship_type)

  if relationship.is_a?(JSONAPI::Relationship::ToMany)
    object_params = { relationships: { format_key(relationship.name) => { data: data } } }
    verified_param_set = parse_params(object_params, updatable_fields)

    @operations.push JSONAPI::CreateToManyRelationshipOperation.new(
      resource_klass,
      context: @context,
      resource_id: parent_key,
      relationship_type: relationship_type,
      data: verified_param_set[:to_many].values[0]
    )
  end
end

#parse_fields(fields) ⇒ Object 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
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
 
# File 'lib/jsonapi/request.rb', line 131

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? || !(@resource_klass._type == underscored_type ||
      @resource_klass._has_relationship?(underscored_type))
      @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 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/jsonapi/request.rb', line 216

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 



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/jsonapi/request.rb', line 197

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(include)
end

#parse_key_array(raw) ⇒ Object 



682
683
684
 
# File 'lib/jsonapi/request.rb', line 682

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

#parse_pagination(page) ⇒ Object 



124
125
126
127
128
129
 
# File 'lib/jsonapi/request.rb', line 124

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 



396
397
398
399
400
401
402
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
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
 
# File 'lib/jsonapi/request.rb', line 396

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)
          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?
            relationship_resource = Resource.resource_for(@resource_klass.module_path + unformat_key(links_object[:type]).to_s)
            relationship_id = relationship_resource.verify_key(links_object[:id], @context)
            if relationship.polymorphic?
              checked_to_one_relationships[param] = { id: relationship_id, type: unformat_key(links_object[:type].to_s) }
            else
              checked_to_one_relationships[param] = relationship_id
            end
          else
            checked_to_one_relationships[param] = nil
          end
        elsif relationship.is_a?(JSONAPI::Relationship::ToMany)
          if link_value.is_a?(Array) && link_value.length == 0
            linkage = []
          elsif link_value.is_a?(Hash)
            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 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
            checked_to_many_relationships[param] = []
          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)
              checked_to_many_relationships[param] = relationship_resource.verify_keys(keys, @context)
            end
          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 



641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/jsonapi/request.rb', line 641

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

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

#parse_remove_relationship_operation(params) ⇒ Object 



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/jsonapi/request.rb', line 655

def parse_remove_relationship_operation(params)
  relationship_type = params[:relationship]

  parent_key = params[resource_klass._as_parent_key]

  relationship = resource_klass._relationship(relationship_type)
  if relationship.is_a?(JSONAPI::Relationship::ToMany)
    keys = parse_key_array(params[:keys])
    keys.each do |key|
      @operations.push JSONAPI::RemoveToManyRelationshipOperation.new(
        resource_klass,
        context: @context,
        resource_id: parent_key,
        relationship_type: relationship_type,
        associated_key: key
      )
    end
  else
    @operations.push JSONAPI::RemoveToOneRelationshipOperation.new(
      resource_klass,
      context: @context,
      resource_id: parent_key,
      relationship_type: relationship_type
    )
  end
end

#parse_replace_operation(data, keys) ⇒ Object 



625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/jsonapi/request.rb', line 625

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 



600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/jsonapi/request.rb', line 600

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

  type = data[:type]
  if type.nil? || type != format_key(@resource_klass._type).to_s
    fail JSONAPI::Exceptions::ParameterMissing.new(:type)
  end

  key = data[:id]
  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::ReplaceFieldsOperation.new(
    @resource_klass,
    context: @context,
    resource_id: key,
    data: parse_params(data, updatable_fields)
  )
end

#parse_sort_criteria(sort_criteria) ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/jsonapi/request.rb', line 245

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 



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/jsonapi/request.rb', line 380

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_one_links_object(raw) ⇒ Object 



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/jsonapi/request.rb', line 362

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

  if !raw.is_a?(Hash) || raw.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_update_relationship_operation(data, relationship_type, parent_key) ⇒ Object 



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
596
597
598
 
# File 'lib/jsonapi/request.rb', line 555

def parse_update_relationship_operation(data, relationship_type, parent_key)
  relationship = resource_klass._relationship(relationship_type)
  if relationship.is_a?(JSONAPI::Relationship::ToOne)
    if relationship.polymorphic?
      object_params = { relationships: { format_key(relationship.name) => { data: data } } }
      verified_param_set = parse_params(object_params, updatable_fields)

      @operations.push JSONAPI::ReplacePolymorphicToOneRelationshipOperation.new(
                         resource_klass,
                         context: @context,
                         resource_id: parent_key,
                         relationship_type: relationship_type,
                         key_value: verified_param_set[:to_one].values[0][:id],
                         key_type: verified_param_set[:to_one].values[0][:type]
                       )
    else
      object_params = { relationships: { format_key(relationship.name) => { data: data } } }
      verified_param_set = parse_params(object_params, updatable_fields)

      @operations.push JSONAPI::ReplaceToOneRelationshipOperation.new(
                         resource_klass,
                         context: @context,
                         resource_id: parent_key,
                         relationship_type: relationship_type,
                         key_value: verified_param_set[:to_one].values[0]
                       )
    end
  elsif relationship.is_a?(JSONAPI::Relationship::ToMany)
    unless relationship.acts_as_set
      fail JSONAPI::Exceptions::ToManySetReplacementForbidden.new
    end

    object_params = { relationships: { format_key(relationship.name) => { data: data } } }
    verified_param_set = parse_params(object_params, updatable_fields)

    @operations.push JSONAPI::ReplaceToManyRelationshipOperation.new(
                       resource_klass,
                       context: @context,
                       resource_id: parent_key,
                       relationship_type: relationship_type,
                       data: verified_param_set[:to_many].values[0]
                     )
  end
end

#set_default_filters ⇒ Object 



238
239
240
241
242
243
 
# File 'lib/jsonapi/request.rb', line 238

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 



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

def setup_action(params)
  return if params.nil?

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

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

#setup_create_action(params) ⇒ Object 



87
88
89
90
91
 
# File 'lib/jsonapi/request.rb', line 87

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 



93
94
95
96
97
 
# File 'lib/jsonapi/request.rb', line 93

def setup_create_relationship_action(params)
  parse_add_relationship_operation(params.require(:data),
                                  params.require(:relationship),
                                  params.require(@resource_klass._as_parent_key))
end

#setup_destroy_action(params) ⇒ Object 



111
112
113
 
# File 'lib/jsonapi/request.rb', line 111

def setup_destroy_action(params)
  parse_remove_operation(params)
end

#setup_destroy_relationship_action(params) ⇒ Object 



115
116
117
 
# File 'lib/jsonapi/request.rb', line 115

def setup_destroy_relationship_action(params)
  parse_remove_relationship_operation(params)
end

#setup_get_related_resource_action(params) ⇒ Object 



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

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 



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

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 



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

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 



76
77
78
79
80
81
 
# File 'lib/jsonapi/request.rb', line 76

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 



83
84
85
 
# File 'lib/jsonapi/request.rb', line 83

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 



105
106
107
108
109
 
# File 'lib/jsonapi/request.rb', line 105

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 



99
100
101
102
103
 
# File 'lib/jsonapi/request.rb', line 99

def setup_update_relationship_action(params)
  parse_update_relationship_operation(params.fetch(:data),
                                     params.require(:relationship),
                                     params.require(@resource_klass._as_parent_key))
end

#unformat_key(key) ⇒ Object 



690
691
692
693
 
# File 'lib/jsonapi/request.rb', line 690

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

#unformat_value(attribute, value) ⇒ Object 



478
479
480
481
 
# File 'lib/jsonapi/request.rb', line 478

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:



529
530
531
532
533
534
535
 
# File 'lib/jsonapi/request.rb', line 529

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 



483
484
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
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/jsonapi/request.rb', line 483

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.each_key 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', 'id'
    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 



354
355
356
357
358
359
360
 
# File 'lib/jsonapi/request.rb', line 354

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