Module: JsonapiCompliable::Base

Extended by:
ActiveSupport::Concern
Includes:
Deserializable
Defined in:
lib/jsonapi_compliable/base.rb

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

MAX_PAGE_SIZE = 
1_000

Instance Method Summary collapse

Methods included from Deserializable

#deserialize_jsonapi!

Instance Method Details

#default_ams_options ⇒ Object

render_ams(foo) equivalent to render json: foo, ams_default_options



63
64
65
66
67
 
# File 'lib/jsonapi_compliable/base.rb', line 63

def default_ams_options
  {}.tap do |options|
    options[:adapter] = :json_api
  end
end

#default_page_number ⇒ Object 



16
17
18
 
# File 'lib/jsonapi_compliable/base.rb', line 16

def default_page_number
  1
end

#default_page_size ⇒ Object 



20
21
22
 
# File 'lib/jsonapi_compliable/base.rb', line 20

def default_page_size
  20
end

#force_includes? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
93
 
# File 'lib/jsonapi_compliable/base.rb', line 90

def force_includes?
  %w(PUT PATCH POST).include?(request.method) and
    raw_params[:data][:relationships].present?
end

#forced_includes(data = nil) ⇒ Object

TODO: This nastiness likely goes away once jsonapi standardizes a spec for nested relationships. See: https://github.com/json-api/json-api/issues/1089



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/jsonapi_compliable/base.rb', line 72

def forced_includes(data = nil)
  return unless force_includes?
  data = raw_params[:data] unless data

  {}.tap do |forced|
    (data[:relationships] || {}).each_pair do |relation_name, relation|
      if relation[:data].is_a?(Array)
        forced[relation_name] = {}
        relation[:data].each do |datum|
          forced[relation_name].deep_merge!(forced_includes(datum))
        end
      else
        forced[relation_name] = forced_includes(relation[:data])
      end
    end
  end
end

#jsonapi_scope(scope, filter: true, includes: true, paginate: true, extra_fields: true, sort: true) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/jsonapi_compliable/base.rb', line 24

def jsonapi_scope(scope,
                  filter: true,
                  includes: true,
                  paginate: true,
                  extra_fields: true,
                  sort: true)
  scope = JsonapiCompliable::Scope::DefaultFilter.new(self, scope).apply
  scope = JsonapiCompliable::Scope::Filter.new(self, scope).apply if filter
  scope = JsonapiCompliable::Scope::ExtraFields.new(self, scope).apply if extra_fields
  scope = JsonapiCompliable::Scope::Sideload.new(self, scope).apply if includes
  scope = JsonapiCompliable::Scope::Sort.new(self, scope).apply if sort
  scope = JsonapiCompliable::Scope::Paginate.new(self, scope).apply if paginate
  @_jsonapi_scoped = true
  scope
end

#parse_fieldsets! ⇒ Object 



44
45
46
47
 
# File 'lib/jsonapi_compliable/base.rb', line 44

def parse_fieldsets!
  Util::FieldParams.parse!(params, :fields)
  Util::FieldParams.parse!(params, :extra_fields)
end

#render_ams(scope, opts = {}) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/jsonapi_compliable/base.rb', line 49

def render_ams(scope, opts = {})
  scope = jsonapi_scope(scope) if Util::Scoping.apply?(self, scope, opts.delete(:scope))
  options = default_ams_options
  options[:include] = forced_includes || Util::IncludeParams.scrub(self)
  options[:json] = scope
  options[:fields] = Util::FieldParams.fieldset(params, :fields) if params[:fields]
  options[:extra_fields] = Util::FieldParams.fieldset(params, :extra_fields) if params[:extra_fields]

  options.merge!(opts)
  render(options)
end

#reset_scope_flag ⇒ Object 



40
41
42
 
# File 'lib/jsonapi_compliable/base.rb', line 40

def reset_scope_flag
  @_jsonapi_scoped = false
end