Class: JSONAPI::Resource

Inherits:
Object
  • Object
show all
Includes:
Callbacks
Defined in:
lib/jsonapi/resource.rb

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Callbacks

included

Constructor Details

#initialize(model, context) ⇒ Resource

Returns a new instance of Resource.



23
24
25
26
27
28
29
 
# File 'lib/jsonapi/resource.rb', line 23

def initialize(model, context)
  @model = model
  @context = context
  @reload_needed = false
  @changing = false
  @save_needed = false
end

Class Attribute Details

._allowed_filters ⇒ Object

Returns the value of attribute _allowed_filters.



456
457
458
 
# File 'lib/jsonapi/resource.rb', line 456

def _allowed_filters
  @_allowed_filters
end

._attributes ⇒ Object

Returns the value of attribute _attributes.



456
457
458
 
# File 'lib/jsonapi/resource.rb', line 456

def _attributes
  @_attributes
end

._model_hints ⇒ Object

Returns the value of attribute _model_hints.



456
457
458
 
# File 'lib/jsonapi/resource.rb', line 456

def _model_hints
  @_model_hints
end

._paginator ⇒ Object

Returns the value of attribute _paginator.



456
457
458
 
# File 'lib/jsonapi/resource.rb', line 456

def _paginator
  @_paginator
end

._relationships ⇒ Object

Returns the value of attribute _relationships.



456
457
458
 
# File 'lib/jsonapi/resource.rb', line 456

def _relationships
  @_relationships
end

._type ⇒ Object

Returns the value of attribute _type.



456
457
458
 
# File 'lib/jsonapi/resource.rb', line 456

def _type
  @_type
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



8
9
10
 
# File 'lib/jsonapi/resource.rb', line 8

def context
  @context
end

Class Method Details

._abstract ⇒ Object 



916
917
918
 
# File 'lib/jsonapi/resource.rb', line 916

def _abstract
  @abstract
end

._add_relationship(klass, *attrs) ⇒ Object 



968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/jsonapi/resource.rb', line 968

def _add_relationship(klass, *attrs)
  options = attrs.extract_options!
  options[:parent_resource] = self

  attrs.each do |relationship_name|
    check_reserved_relationship_name(relationship_name)
    check_duplicate_relationship_name(relationship_name)

    JSONAPI::RelationshipBuilder.new(klass, _model_class, options)
      .define_relationship_methods(relationship_name.to_sym)
  end
end

._allowed_filter?(filter) ⇒ Boolean

Returns:

  • (Boolean) 


941
942
943
 
# File 'lib/jsonapi/resource.rb', line 941

def _allowed_filter?(filter)
  !_allowed_filters[filter].nil?
end

._as_parent_key ⇒ Object 



896
897
898
 
# File 'lib/jsonapi/resource.rb', line 896

def _as_parent_key
  @_as_parent_key ||= "#{_type.to_s.singularize}_id"
end

._attribute_options(attr) ⇒ Object

quasi private class methods



871
872
873
 
# File 'lib/jsonapi/resource.rb', line 871

def _attribute_options(attr)
  default_attribute_options.merge(@_attributes[attr])
end

._build_joins(associations) ⇒ Object 



665
666
667
668
669
670
671
672
673
 
# File 'lib/jsonapi/resource.rb', line 665

def _build_joins(associations)
  joins = []

  associations.inject do |prev, current|
    joins << "LEFT JOIN #{current.table_name} AS #{current.name}_sorting ON #{current.name}_sorting.id = #{prev.table_name}.#{current.foreign_key}"
    current
  end
  joins.join("\n")
end

._immutable ⇒ Object 



924
925
926
 
# File 'lib/jsonapi/resource.rb', line 924

def _immutable
  @immutable
end

._lookup_association_chain(model_names) ⇒ Object 



652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/jsonapi/resource.rb', line 652

def _lookup_association_chain(model_names)
  associations = []
  model_names.inject do |prev, current|
    association = prev.classify.constantize.reflect_on_all_associations.detect do |assoc|
      assoc.name.to_s.downcase == current.downcase
    end
    associations << association
    association.class_name
  end

  associations
end

._model_class ⇒ Object 



932
933
934
935
936
937
938
939
 
# File 'lib/jsonapi/resource.rb', line 932

def _model_class
  return nil if _abstract

  return @model if @model
  @model = _model_name.to_s.safe_constantize
  warn "[MODEL NOT FOUND] Model could not be found for #{self.name}. If this a base Resource declare it as abstract." if @model.nil?
  @model
end

._model_name ⇒ Object 



884
885
886
 
# File 'lib/jsonapi/resource.rb', line 884

def _model_name
  _abstract ? '' : @_model_name ||= name.demodulize.sub(/Resource$/, '')
end

._primary_key ⇒ Object 



888
889
890
 
# File 'lib/jsonapi/resource.rb', line 888

def _primary_key
  @_primary_key ||= _model_class.respond_to?(:primary_key) ? _model_class.primary_key : :id
end

._relationship(type) ⇒ Object 



879
880
881
882
 
# File 'lib/jsonapi/resource.rb', line 879

def _relationship(type)
  type = type.to_sym
  @_relationships[type]
end

._resource_name_from_type(type) ⇒ Object 



443
444
445
 
# File 'lib/jsonapi/resource.rb', line 443

def _resource_name_from_type(type)
  "#{type.to_s.underscore.singularize}_resource".camelize
end

._table_name ⇒ Object 



892
893
894
 
# File 'lib/jsonapi/resource.rb', line 892

def _table_name
  @_table_name ||= _model_class.respond_to?(:table_name) ? _model_class.table_name : _model_name.tableize
end

._updatable_relationships ⇒ Object 



875
876
877
 
# File 'lib/jsonapi/resource.rb', line 875

def _updatable_relationships
  @_relationships.map { |key, _relationship| key }
end

.abstract(val = true) ⇒ Object 



912
913
914
 
# File 'lib/jsonapi/resource.rb', line 912

def abstract(val = true)
  @abstract = val
end

.apply_filter(records, filter, value, options = {}) ⇒ Object 



675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/jsonapi/resource.rb', line 675

def apply_filter(records, filter, value, options = {})
  strategy = _allowed_filters.fetch(filter.to_sym, Hash.new)[:apply]

  if strategy
    if strategy.is_a?(Symbol) || strategy.is_a?(String)
      send(strategy, records, value, options)
    else
      strategy.call(records, value, options)
    end
  else
    records.where(filter => value)
  end
end

.apply_filters(records, filters, options = {}) ⇒ Object 



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/jsonapi/resource.rb', line 689

def apply_filters(records, filters, options = {})
  required_includes = []

  if filters
    filters.each do |filter, value|
      if _relationships.include?(filter)
        if _relationships[filter].belongs_to?
          records = apply_filter(records, _relationships[filter].foreign_key, value, options)
        else
          required_includes.push(filter.to_s)
          records = apply_filter(records, "#{_relationships[filter].table_name}.#{_relationships[filter].primary_key}", value, options)
        end
      else
        records = apply_filter(records, filter, value, options)
      end
    end
  end

  if required_includes.any?
    records = apply_includes(records, options.merge(include_directives: IncludeDirectives.new(self, required_includes, force_eager_load: true)))
  end

  records
end

.apply_includes(records, options = {}) ⇒ Object 



616
617
618
619
620
621
622
623
624
 
# File 'lib/jsonapi/resource.rb', line 616

def apply_includes(records, options = {})
  include_directives = options[:include_directives]
  if include_directives
    model_includes = resolve_relationship_names_to_relations(self, include_directives.model_includes, options)
    records = records.includes(model_includes)
  end

  records
end

.apply_pagination(records, paginator, order_options) ⇒ Object 



626
627
628
629
 
# File 'lib/jsonapi/resource.rb', line 626

def apply_pagination(records, paginator, order_options)
  records = paginator.apply(records, order_options) if paginator
  records
end

.apply_sort(records, order_options, _context = {}) ⇒ Object 



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/jsonapi/resource.rb', line 631

def apply_sort(records, order_options, _context = {})
  if order_options.any?
     order_options.each_pair do |field, direction|
      if field.to_s.include?(".")
        *model_names, column_name = field.split(".")

        associations = _lookup_association_chain([records.model.to_s, *model_names])
        joins_query = _build_joins([records.model, *associations])

        # _sorting is appended to avoid name clashes with manual joins eg. overriden filters
        order_by_query = "#{associations.last.name}_sorting.#{column_name} #{direction}"
        records = records.joins(joins_query).order(order_by_query)
      else
        records = records.order(field => direction)
      end
    end
  end

  records
end

.attribute(attr, options = {}) ⇒ Object 



482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/jsonapi/resource.rb', line 482

def attribute(attr, options = {})
  check_reserved_attribute_name(attr)

  if (attr.to_sym == :id) && (options[:format].nil?)
    ActiveSupport::Deprecation.warn('Id without format is no longer supported. Please remove ids from attributes, or specify a format.')
  end

  check_duplicate_attribute_name(attr) if options[:format].nil?

  @_attributes ||= {}
  @_attributes[attr] = options
  define_method attr do
    @model.public_send(options[:delegate] ? options[:delegate].to_sym : attr)
  end unless method_defined?(attr)

  define_method "#{attr}=" do |value|
    @model.public_send("#{options[:delegate] ? options[:delegate].to_sym : attr}=", value)
  end unless method_defined?("#{attr}=")
end

.attributes(*attrs) ⇒ Object

Methods used in defining a resource class



475
476
477
478
479
480
 
# File 'lib/jsonapi/resource.rb', line 475

def attributes(*attrs)
  options = attrs.extract_options!.dup
  attrs.each do |attr|
    attribute(attr, options)
  end
end

.belongs_to(*attrs) ⇒ Object 



525
526
527
528
529
530
531
532
 
# File 'lib/jsonapi/resource.rb', line 525

def belongs_to(*attrs)
  ActiveSupport::Deprecation.warn "In #{name} you exposed a `has_one` relationship "\
                                  " using the `belongs_to` class method. We think `has_one`" \
                                  " is more appropriate. If you know what you're doing," \
                                  " and don't want to see this warning again, override the" \
                                  " `belongs_to` class method on your resource."
  _add_relationship(Relationship::ToOne, *attrs)
end

.construct_order_options(sort_params) ⇒ Object 



957
958
959
960
961
962
963
964
965
966
 
# File 'lib/jsonapi/resource.rb', line 957

def construct_order_options(sort_params)
  sort_params ||= default_sort

  return {} unless sort_params

  sort_params.each_with_object({}) do |sort, order_hash|
    field = sort[:field].to_s == 'id' ? _primary_key : sort[:field].to_s
    order_hash[field] = sort[:direction]
  end
end

.count_records(records) ⇒ Object

Assumes ActiveRecord’s counting. Override if you need a different counting method



724
725
726
 
# File 'lib/jsonapi/resource.rb', line 724

def count_records(records)
  records.count(:all)
end

.creatable_fields(_context = nil) ⇒ Object

Override in your resource to filter the creatable keys



583
584
585
 
# File 'lib/jsonapi/resource.rb', line 583

def creatable_fields(_context = nil)
  _updatable_relationships | _attributes.keys - [:id]
end

.create(context) ⇒ Object 



458
459
460
 
# File 'lib/jsonapi/resource.rb', line 458

def create(context)
  new(create_model, context)
end

.create_model ⇒ Object 



462
463
464
 
# File 'lib/jsonapi/resource.rb', line 462

def create_model
  _model_class.new
end

.default_attribute_options ⇒ Object 



502
503
504
 
# File 'lib/jsonapi/resource.rb', line 502

def default_attribute_options
  { format: :default }
end

.default_sort ⇒ Object 



953
954
955
 
# File 'lib/jsonapi/resource.rb', line 953

def default_sort
  [{field: 'id', direction: :asc}]
end

.fields ⇒ Object 



592
593
594
 
# File 'lib/jsonapi/resource.rb', line 592

def fields
  _relationships.keys | _attributes.keys
end

.filter(attr, *args) ⇒ Object 



554
555
556
 
# File 'lib/jsonapi/resource.rb', line 554

def filter(attr, *args)
  @_allowed_filters[attr.to_sym] = args.extract_options!
end

.filter_records(filters, options, records = records(options)) ⇒ Object 



714
715
716
717
 
# File 'lib/jsonapi/resource.rb', line 714

def filter_records(filters, options, records = records(options))
  records = apply_filters(records, filters, options)
  apply_includes(records, options)
end

.filters(*attrs) ⇒ Object 



550
551
552
 
# File 'lib/jsonapi/resource.rb', line 550

def filters(*attrs)
  @_allowed_filters.merge!(attrs.inject({}) { |h, attr| h[attr] = {}; h })
end

.find(filters, options = {}) ⇒ Object

Override this method if you have more complex requirements than this basic find method provides



733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/jsonapi/resource.rb', line 733

def find(filters, options = {})
  context = options[:context]

  records = filter_records(filters, options)

  sort_criteria = options.fetch(:sort_criteria) { [] }
  order_options = construct_order_options(sort_criteria)
  records = sort_records(records, order_options, context)

  records = apply_pagination(records, options[:paginator], order_options)

  resources_for(records, context)
end

.find_by_key(key, options = {}) ⇒ Object 



764
765
766
767
768
769
770
771
 
# File 'lib/jsonapi/resource.rb', line 764

def find_by_key(key, options = {})
  context = options[:context]
  records = records(options)
  records = apply_includes(records, options)
  model = records.where({_primary_key => key}).first
  fail JSONAPI::Exceptions::RecordNotFound.new(key) if model.nil?
  self.resource_for_model(model).new(model, context)
end

.find_by_keys(keys, options = {}) ⇒ Object 



754
755
756
757
758
759
760
761
762
 
# File 'lib/jsonapi/resource.rb', line 754

def find_by_keys(keys, options = {})
  context = options[:context]
  records = records(options)
  records = apply_includes(records, options)
  models = records.where({_primary_key => keys})
  models.collect do |model|
    self.resource_for_model(model).new(model, context)
  end
end

.find_count(filters, options = {}) ⇒ Object 



728
729
730
 
# File 'lib/jsonapi/resource.rb', line 728

def find_count(filters, options = {})
  count_records(filter_records(filters, options))
end

.has_many(*attrs) ⇒ Object 



534
535
536
 
# File 'lib/jsonapi/resource.rb', line 534

def has_many(*attrs)
  _add_relationship(Relationship::ToMany, *attrs)
end

.has_one(*attrs) ⇒ Object 



521
522
523
 
# File 'lib/jsonapi/resource.rb', line 521

def has_one(*attrs)
  _add_relationship(Relationship::ToOne, *attrs)
end

.immutable(val = true) ⇒ Object 



920
921
922
 
# File 'lib/jsonapi/resource.rb', line 920

def immutable(val = true)
  @immutable = val
end

.inherited(subclass) ⇒ Object 



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

def inherited(subclass)
  subclass.abstract(false)
  subclass.immutable(false)
  subclass._attributes = (_attributes || {}).dup
  subclass._model_hints = (_model_hints || {}).dup

  subclass._relationships = {}
  # Add the relationships from the base class to the subclass using the original options
  if _relationships.is_a?(Hash)
    _relationships.each_value do |relationship|
      options = relationship.options.dup
      options[:parent_resource] = subclass
      subclass._add_relationship(relationship.class, relationship.name, options)
    end
  end

  subclass._allowed_filters = (_allowed_filters || Set.new).dup

  type = subclass.name.demodulize.sub(/Resource$/, '').underscore
  subclass._type = type.pluralize.to_sym

  unless subclass._attributes[:id]
    subclass.attribute :id, format: :id
  end

  check_reserved_resource_name(subclass._type, subclass.name)
end

.inject_method_definition(name, body) ⇒ Object

Allows JSONAPI::RelationshipBuilder to access metaprogramming hooks



982
983
984
 
# File 'lib/jsonapi/resource.rb', line 982

def inject_method_definition(name, body)
  define_method(name, body)
end

.is_filter_relationship?(filter) ⇒ Boolean

Returns:

  • (Boolean) 


788
789
790
 
# File 'lib/jsonapi/resource.rb', line 788

def is_filter_relationship?(filter)
  filter == _type || _relationships.include?(filter)
end

.key_type(key_type) ⇒ Object 



816
817
818
 
# File 'lib/jsonapi/resource.rb', line 816

def key_type(key_type)
  @_resource_key_type = key_type
end

.method_missing(method, *args) ⇒ Object

TODO: remove this after the createable_fields and updateable_fields are phased out :nocov:



564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/jsonapi/resource.rb', line 564

def method_missing(method, *args)
  if method.to_s.match /createable_fields/
    ActiveSupport::Deprecation.warn('`createable_fields` is deprecated, please use `creatable_fields` instead')
    creatable_fields(*args)
  elsif method.to_s.match /updateable_fields/
    ActiveSupport::Deprecation.warn('`updateable_fields` is deprecated, please use `updatable_fields` instead')
    updatable_fields(*args)
  else
    super
  end
end

.model_hint(model: _model_name, resource: _type) ⇒ Object 



544
545
546
547
548
 
# File 'lib/jsonapi/resource.rb', line 544

def model_hint(model: _model_name, resource: _type)
  resource_type = ((resource.is_a?(Class)) && (resource < JSONAPI::Resource)) ? resource._type : resource.to_s

  _model_hints[model.to_s.gsub('::', '/').underscore] = resource_type.to_s
end

.model_name(model, options = {}) ⇒ Object 



538
539
540
541
542
 
# File 'lib/jsonapi/resource.rb', line 538

def model_name(model, options = {})
  @_model_name = model.to_sym

  model_hint(model: @_model_name, resource: self) unless options[:add_model_hint] == false
end

.module_path ⇒ Object 



945
946
947
948
949
950
951
 
# File 'lib/jsonapi/resource.rb', line 945

def module_path
  if name == 'JSONAPI::Resource'
    ''
  else
    name =~ /::[^:]+\Z/ ? ($`.freeze.gsub('::', '/') + '/').underscore : ''
  end
end

.mutable? ⇒ Boolean

Returns:

  • (Boolean) 


928
929
930
 
# File 'lib/jsonapi/resource.rb', line 928

def mutable?
  !@immutable
end

.paginator(paginator) ⇒ Object 



908
909
910
 
# File 'lib/jsonapi/resource.rb', line 908

def paginator(paginator)
  @_paginator = paginator
end

.primary_key(key) ⇒ Object 



558
559
560
 
# File 'lib/jsonapi/resource.rb', line 558

def primary_key(key)
  @_primary_key = key.to_sym
end

.records(_options = {}) ⇒ Object

Override this method if you want to customize the relation for finder methods (find, find_by_key)



775
776
777
 
# File 'lib/jsonapi/resource.rb', line 775

def records(_options = {})
  _model_class.all
end

.register_relationship(name, relationship_object) ⇒ Object 



986
987
988
 
# File 'lib/jsonapi/resource.rb', line 986

def register_relationship(name, relationship_object)
  @_relationships[name] = relationship_object
end

.relationship(*attrs) ⇒ Object 



506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/jsonapi/resource.rb', line 506

def relationship(*attrs)
  options = attrs.extract_options!
  klass = case options[:to]
            when :one
              Relationship::ToOne
            when :many
              Relationship::ToMany
            else
              #:nocov:#
              fail ArgumentError.new('to: must be either :one or :many')
              #:nocov:#
          end
  _add_relationship(klass, *attrs, options.except(:to))
end

.resolve_relationship_names_to_relations(resource_klass, model_includes, options = {}) ⇒ Object 



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/jsonapi/resource.rb', line 596

def resolve_relationship_names_to_relations(resource_klass, model_includes, options = {})
  case model_includes
    when Array
      return model_includes.map do |value|
        resolve_relationship_names_to_relations(resource_klass, value, options)
      end
    when Hash
      model_includes.keys.each do |key|
        relationship = resource_klass._relationships[key]
        value = model_includes[key]
        model_includes.delete(key)
        model_includes[relationship.relation_name(options)] = resolve_relationship_names_to_relations(relationship.resource_klass, value, options)
      end
      return model_includes
    when Symbol
      relationship = resource_klass._relationships[model_includes]
      return relationship.relation_name(options)
  end
end

.resource_for(type) ⇒ Object 



427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/jsonapi/resource.rb', line 427

def resource_for(type)
  type = type.underscore
  type_with_module = type.include?('/') ? type : module_path + type

  resource_name = _resource_name_from_type(type_with_module)
  resource = resource_name.safe_constantize if resource_name
  if resource.nil?
    fail NameError, "JSONAPI: Could not find resource '#{type}'. (Class #{resource_name} not found)"
  end
  resource
end

.resource_for_model(model) ⇒ Object 



439
440
441
 
# File 'lib/jsonapi/resource.rb', line 439

def resource_for_model(model)
  resource_for(resource_type_for(model))
end

.resource_key_type ⇒ Object 



820
821
822
 
# File 'lib/jsonapi/resource.rb', line 820

def resource_key_type
  @_resource_key_type ||= JSONAPI.configuration.resource_key_type
end

.resource_type_for(model) ⇒ Object 



447
448
449
450
451
452
453
454
 
# File 'lib/jsonapi/resource.rb', line 447

def resource_type_for(model)
  model_name = model.class.to_s.underscore
  if _model_hints[model_name]
    _model_hints[model_name]
  else
    model_name.rpartition('/').last
  end
end

.resources_for(records, context) ⇒ Object 



747
748
749
750
751
752
 
# File 'lib/jsonapi/resource.rb', line 747

def resources_for(records, context)
  records.collect do |model|
    resource_class = self.resource_for_model(model)
    resource_class.new(model, context)
  end
end

.routing_options(options) ⇒ Object 



466
467
468
 
# File 'lib/jsonapi/resource.rb', line 466

def routing_options(options)
  @_routing_resource_options = options
end

.routing_resource_options ⇒ Object 



470
471
472
 
# File 'lib/jsonapi/resource.rb', line 470

def routing_resource_options
  @_routing_resource_options ||= {}
end

.sort_records(records, order_options, context = {}) ⇒ Object 



719
720
721
 
# File 'lib/jsonapi/resource.rb', line 719

def sort_records(records, order_options, context = {})
  apply_sort(records, order_options, context)
end

.sortable_fields(_context = nil) ⇒ Object

Override in your resource to filter the sortable keys



588
589
590
 
# File 'lib/jsonapi/resource.rb', line 588

def sortable_fields(_context = nil)
  _attributes.keys
end

.updatable_fields(_context = nil) ⇒ Object

Override in your resource to filter the updatable keys



578
579
580
 
# File 'lib/jsonapi/resource.rb', line 578

def updatable_fields(_context = nil)
  _updatable_relationships | _attributes.keys - [:id]
end

.verify_custom_filter(filter, value, _context = nil) ⇒ Object

Either add a custom :verify labmda or override verify_custom_filter to allow for custom filters



860
861
862
 
# File 'lib/jsonapi/resource.rb', line 860

def verify_custom_filter(filter, value, _context = nil)
  [filter, value]
end

.verify_filter(filter, raw, context = nil) ⇒ Object 



792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
 
# File 'lib/jsonapi/resource.rb', line 792

def verify_filter(filter, raw, context = nil)
  filter_values = []
  if raw.present?
    filter_values += raw.is_a?(String) ? CSV.parse_line(raw) : [raw]
  end

  strategy = _allowed_filters.fetch(filter, Hash.new)[:verify]

  if strategy
    if strategy.is_a?(Symbol) || strategy.is_a?(String)
      values = send(strategy, filter_values, context)
    else
      values = strategy.call(filter_values, context)
    end
    [filter, values]
  else
    if is_filter_relationship?(filter)
      verify_relationship_filter(filter, filter_values, context)
    else
      verify_custom_filter(filter, filter_values, context)
    end
  end
end

.verify_filters(filters, context = nil) ⇒ Object 



779
780
781
782
783
784
785
786
 
# File 'lib/jsonapi/resource.rb', line 779

def verify_filters(filters, context = nil)
  verified_filters = {}
  filters.each do |filter, raw_value|
    verified_filter = verify_filter(filter, raw_value, context)
    verified_filters[verified_filter[0]] = verified_filter[1]
  end
  verified_filters
end

.verify_key(key, context = nil) ⇒ Object 



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/jsonapi/resource.rb', line 824

def verify_key(key, context = nil)
  key_type = resource_key_type

  case key_type
  when :integer
    return if key.nil?
    Integer(key)
  when :string
    return if key.nil?
    if key.to_s.include?(',')
      raise JSONAPI::Exceptions::InvalidFieldValue.new(:id, key)
    else
      key
    end
  when :uuid
    return if key.nil?
    if key.to_s.match(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
      key
    else
      raise JSONAPI::Exceptions::InvalidFieldValue.new(:id, key)
    end
  else
    key_type.call(key, context)
  end
rescue
  raise JSONAPI::Exceptions::InvalidFieldValue.new(:id, key)
end

.verify_keys(keys, context = nil) ⇒ Object

override to allow for key processing and checking



853
854
855
856
857
 
# File 'lib/jsonapi/resource.rb', line 853

def verify_keys(keys, context = nil)
  return keys.collect do |key|
    verify_key(key, context)
  end
end

.verify_relationship_filter(filter, raw, _context = nil) ⇒ Object

Either add a custom :verify labmda or override verify_relationship_filter to allow for custom relationship logic, such as uuids, multiple keys or permission checks on keys



866
867
868
 
# File 'lib/jsonapi/resource.rb', line 866

def verify_relationship_filter(filter, raw, _context = nil)
  [filter, raw]
end

Instance Method Details

#_model ⇒ Object 



31
32
33
 
# File 'lib/jsonapi/resource.rb', line 31

def _model
  @model
end

#change(callback) ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/jsonapi/resource.rb', line 43

def change(callback)
  completed = false

  if @changing
    run_callbacks callback do
      completed = (yield == :completed)
    end
  else
    run_callbacks is_new? ? :create : :update do
      @changing = true
      run_callbacks callback do
        completed = (yield == :completed)
      end

      completed = (save == :completed) if @save_needed || is_new?
    end
  end

  return completed ? :completed : :accepted
end

#create_to_many_links(relationship_type, relationship_key_values, options = {}) ⇒ Object 



70
71
72
73
74
 
# File 'lib/jsonapi/resource.rb', line 70

def create_to_many_links(relationship_type, relationship_key_values, options = {})
  change :create_to_many_link do
    _create_to_many_links(relationship_type, relationship_key_values, options)
  end
end

#custom_links(_options) ⇒ Object

Override this to return custom links must return a hash, which will be merged with the default { self: ‘self-url’ } links hash links keys will be not be formatted with the key formatter for the serializer by default. They can however use the serializer’s format_key and format_value methods if desired the _options hash will contain the serializer and the serialization_options



164
165
166
 
# File 'lib/jsonapi/resource.rb', line 164

def custom_links(_options)
  {}
end

#fetchable_fields ⇒ Object

Override this on a resource instance to override the fetchable keys



113
114
115
 
# File 'lib/jsonapi/resource.rb', line 113

def fetchable_fields
  self.class.fields
end

#id ⇒ Object 



35
36
37
 
# File 'lib/jsonapi/resource.rb', line 35

def id
  _model.public_send(self.class._primary_key)
end

#is_new? ⇒ Boolean

Returns:

  • (Boolean) 


39
40
41
 
# File 'lib/jsonapi/resource.rb', line 39

def is_new?
  id.nil?
end

#meta(_options) ⇒ Object

Override this to return resource level meta data must return a hash, and if the hash is empty the meta section will not be serialized with the resource meta keys will be not be formatted with the key formatter for the serializer by default. They can however use the serializer’s format_key and format_value methods if desired the _options hash will contain the serializer and the serialization_options



155
156
157
 
# File 'lib/jsonapi/resource.rb', line 155

def meta(_options)
  {}
end

#model_error_messages ⇒ Object 



123
124
125
 
# File 'lib/jsonapi/resource.rb', line 123

def model_error_messages
  _model.errors.messages
end

#records_for(relation_name) ⇒ Object

Override this on a resource to customize how the associated records are fetched for a model. Particularly helpful for authorization.



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

def records_for(relation_name)
  _model.public_send relation_name
end

#remove ⇒ Object 



64
65
66
67
68
 
# File 'lib/jsonapi/resource.rb', line 64

def remove
  run_callbacks :remove do
    _remove
  end
end

#remove_to_many_link(relationship_type, key, options = {}) ⇒ Object 



94
95
96
97
98
 
# File 'lib/jsonapi/resource.rb', line 94

def remove_to_many_link(relationship_type, key, options = {})
  change :remove_to_many_link do
    _remove_to_many_link(relationship_type, key, options)
  end
end

#remove_to_one_link(relationship_type, options = {}) ⇒ Object 



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

def remove_to_one_link(relationship_type, options = {})
  change :remove_to_one_link do
    _remove_to_one_link(relationship_type, options)
  end
end

#replace_fields(field_data) ⇒ Object 



106
107
108
109
110
 
# File 'lib/jsonapi/resource.rb', line 106

def replace_fields(field_data)
  change :replace_fields do
    _replace_fields(field_data)
  end
end

#replace_polymorphic_to_one_link(relationship_type, relationship_key_value, relationship_key_type, options = {}) ⇒ Object 



88
89
90
91
92
 
# File 'lib/jsonapi/resource.rb', line 88

def replace_polymorphic_to_one_link(relationship_type, relationship_key_value, relationship_key_type, options = {})
  change :replace_polymorphic_to_one_link do
    _replace_polymorphic_to_one_link(relationship_type, relationship_key_value, relationship_key_type, options)
  end
end

#replace_to_many_links(relationship_type, relationship_key_values, options = {}) ⇒ Object 



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

def replace_to_many_links(relationship_type, relationship_key_values, options = {})
  change :replace_to_many_links do
    _replace_to_many_links(relationship_type, relationship_key_values, options)
  end
end

#replace_to_one_link(relationship_type, relationship_key_value, options = {}) ⇒ Object 



82
83
84
85
86
 
# File 'lib/jsonapi/resource.rb', line 82

def replace_to_one_link(relationship_type, relationship_key_value, options = {})
  change :replace_to_one_link do
    _replace_to_one_link(relationship_type, relationship_key_value, options)
  end
end

#validation_error_metadata ⇒ Object

Add metadata to validation error objects.

Suppose model_error_messages returned the following error messages hash:

{password: ["too_short", "format"]}

Then to add data to the validation error validation_error_metadata could return:

{
  password: {
    "too_short": {"minimum_length" => 6},
    "format": {"requirement" => "must contain letters and numbers"}
  }
}

The specified metadata is then be merged into the validation error object.



146
147
148
 
# File 'lib/jsonapi/resource.rb', line 146

def validation_error_metadata
  {}
end