Module: Flapjack::Gateways::JSONAPI::Helpers::Serialiser

Defined in:
lib/flapjack/gateways/jsonapi/helpers/serialiser.rb

Instance Method Summary collapse

Instance Method Details

#as_jsonapi(klass, resources, resources_ids, options = {}) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/flapjack/gateways/jsonapi/helpers/serialiser.rb', line 11

def as_jsonapi(klass, resources, resources_ids, options = {})
  included = options[:include]
  fields   = options[:fields]
  query_type = options[:query_type]

  payload = {}

  unless included.nil? || included.empty?
    payload = collect_included_data(klass, resources,
      :include => included, :query_type => query_type)
  end

  ret = {
    :data => as_jsonapi_data(klass, resources, resources_ids,
      :primary => true, :payload => payload, :fields => fields,
      :unwrap => options[:unwrap])
  }
  unless payload.nil? || payload.empty?
    ret[:included] = included_data_from_payload(payload, :fields => fields)
  end
  ret
end

#as_jsonapi_data(klass, resources, resources_ids, options = {}) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/flapjack/gateways/jsonapi/helpers/serialiser.rb', line 44

def as_jsonapi_data(klass, resources, resources_ids, options = {})
  unwrap  = options[:unwrap]
  payload = options[:payload]

  relationship_scopes = options[:relationship_scopes]

  fields = extract_fields(options[:fields], klass)

  whitelist = if klass.respond_to?(:jsonapi_methods)
    method_def = klass.jsonapi_methods[:get] || klass.jsonapi_methods[:post]
    method_def.nil? ? [] : method_def.attributes
  else
    []
  end

  jsonapi_fields = if fields.nil?
    whitelist
  else
    Set.new(fields).keep_if {|f| whitelist.include?(f) }.to_a
  end

  links = jsonapi_linkages(klass, resources_ids, :primary => options[:primary],
    :payload => payload, :relationship_scopes => relationship_scopes)

  resources_as_json = resources.collect do |r|
    r_id = r.id

    l = links[r_id]

    data = {
      :type => klass.short_model_name.singular,
      :id => r_id
    }
    attrs = r.as_json(:only => jsonapi_fields)
    data[:attributes] = attrs unless attrs.empty?
    data[:relationships] = l unless l.nil? || l.empty?
    data
  end

  unless (resources_as_json.size == 1) && unwrap.is_a?(TrueClass)
    return resources_as_json
  end

  resources_as_json.first
end

#as_jsonapi_included(klass, resources, options = {}) ⇒ Object 



34
35
36
37
38
39
40
41
42
 
# File 'lib/flapjack/gateways/jsonapi/helpers/serialiser.rb', line 34

def as_jsonapi_included(klass, resources, options = {})
  included = options[:include]
  fields   = options[:fields]

  payload = collect_included_data(klass, resources,
    :include => included, :query_type => :association)

  included_data_from_payload(payload, :fields => fields)
end

#collect_included_data(klass, resources, options = {}) ⇒ Object 



130
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
 
# File 'lib/flapjack/gateways/jsonapi/helpers/serialiser.rb', line 130

def collect_included_data(klass, resources, options = {})
  included = options[:include]
  query_type = options[:query_type]

  payload = {}

  init_node = [klass, nil => resources.ids]

  included_parts = included.map {|i| i.split('.')}.sort_by(&:length)

  included_parts.each do |incl_fragments|
    incl_todo = incl_fragments
    incl_done = []

    last_node = init_node

    until incl_todo.empty?
      fragment = incl_todo.shift

      last_node = resolve_include_fragment(last_node, fragment,
        incl_todo, incl_done, :query_type => query_type)
      incl_done.push(fragment)

      # store new klass, resources as appropriate by joined incl_done
      k = incl_done.join(".")

      payload[k] ||= [last_node.first]
      payload[k] << last_node.last
    end
  end

  payload
end

#extract_fields(fields, klass) ⇒ Object 



252
253
254
255
256
257
258
 
# File 'lib/flapjack/gateways/jsonapi/helpers/serialiser.rb', line 252

def extract_fields(fields, klass)
  return if fields.nil?
  raise "Field limits must be passed as a Hash" unless fields.is_a?(Hash)
  resource_name = klass.short_model_name.singular
  return unless fields.has_key?(resource_name)
  fields[resource_name].split(',').map(&:to_sym)
end

#included_data_from_payload(payload, options = {}) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/flapjack/gateways/jsonapi/helpers/serialiser.rb', line 216

def included_data_from_payload(payload, options = {})
  fields = options[:fields]

  scopes_by_klass = {}
  names_by_klass  = {}

  payload.each do |name, pl|
    local_klass = pl.first

    scopes_by_klass[local_klass] ||= Set.new
    names_by_klass[local_klass] ||= []
    names_by_klass[local_klass] << name

    data = pl[1..-1].map {|d| d.values }.flatten(1)

    if data.all? {|d| d.is_a?(Set) || d.is_a?(Array)}
      data.each do |sd|
        scopes_by_klass[local_klass] |= sd
      end
    else
      scopes_by_klass[local_klass] |= data
    end
  end

  result = scopes_by_klass.inject([]) do |memo, (local_klass, scopes)|

    memo += as_jsonapi_data(local_klass,
      local_klass.intersect(:id => scopes), scopes,
      :relationship_scopes => names_by_klass[local_klass],
      :payload => payload, :fields => fields)
    memo
  end

  result
end

#jsonapi_linkages(klass, resource_ids, opts = {}) ⇒ Object 



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/flapjack/gateways/jsonapi/helpers/serialiser.rb', line 260

def jsonapi_linkages(klass, resource_ids, opts = {})
  payload = opts[:payload]

  relationship_scopes = opts[:relationship_scopes]

  jsonapi_assocs = klass.jsonapi_associations.reject do |jl_name, jl_data|
    jl_data.link.is_a?(FalseClass) && jl_data.includable.is_a?(FalseClass)
  end

  resources_name = klass.short_model_name.plural

  resource_ids.each_with_object({}) do |r_id, memo|

    memo[r_id] = jsonapi_assocs.keys.each_with_object({}) do |jl_name, a_memo|
      linked = {}

      if opts[:primary]
        linked[:links] = {
          :self    => "#{request.base_url}/#{resources_name}/#{r_id}/relationships/#{jl_name}",
          :related => "#{request.base_url}/#{resources_name}/#{r_id}/#{jl_name}"
        }
      end

      payload_scopes = if relationship_scopes.nil? || relationship_scopes.empty?
        opts[:primary] ? [jl_name.to_s] : []
      else
        relationship_scopes.map {|rls| "#{rls}.#{jl_name}" }
      end

      payload_scopes.each do |pls|

        if payload.has_key?(pls) && payload[pls].last.has_key?(r_id)

          klass = payload[pls].first
          d = payload[pls].last[r_id]
          linked[:data] = case d
          when Set, Array
            d.map {|da| {:type => klass.short_model_name.singular, :id => da} }
          when String
            {:type => klass.short_model_name.singular, :id => d}
          end
        end
      end

      next if linked.empty?
      a_memo[jl_name] = linked
    end
  end
end

#lock_for_include_clause(klass, options = {}) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/flapjack/gateways/jsonapi/helpers/serialiser.rb', line 90

def lock_for_include_clause(klass, options = {})
  included = options[:include]

  locks = Set.new

  included_parts = included.map {|i| i.split('.')}.sort_by(&:length)

  included_parts.each do |incl_fragments|
    incl_todo = incl_fragments
    incl_done = []

    last_klass = klass

    until incl_todo.empty?
      fragment = incl_todo.shift
      last_klass, lock_k = resolve_include_locks(last_klass, fragment)
      incl_done.push(fragment)
      locks |= lock_k
    end
  end

  locks.to_a
end

#resolve_include_fragment(node, name, incl_todo, incl_done, options = {}) ⇒ Object 



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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/flapjack/gateways/jsonapi/helpers/serialiser.rb', line 164

def resolve_include_fragment(node, name, incl_todo, incl_done,
  options = {})

  query_type = options[:query_type]

  parent_klass = node.first
  nlv = node.last.values
  parent_resources = if nlv.all? {|v| v.is_a?(Set) || v.is_a?(Array)}
    nlv.reduce(Set.new, :|)
  else
    nlv
  end

  parent_links = if parent_klass.respond_to?(:jsonapi_associations)
    parent_klass.jsonapi_associations || {}
  else
    {}
  end

  assoc_data = parent_links[name.to_sym]

  return [] if assoc_data.nil? ||
    (:resource.eql?(query_type) && !assoc_data.includable) ||
    (:association.eql?(query_type) && !assoc_data.link)

  fragment_klass = assoc_data.data_klass

  # NB: if anything's limiting the returned data, it would need
  # to be included here
  scope = parent_klass.intersect(:id => parent_resources)

  data = if assoc_data.association_data.nil?
    scope.all.each_with_object({}) do |r, memo|
      d = r.send(name.to_sym)
      memo[r.id] = case d
      when nil
        nil
      when Zermelo::Filter, Zermelo::Associations::Multiple
        d.ids
      when Array, Set
        d.map(&:id)
      else
        d.id
      end
    end
  else
    scope.associated_ids_for(name.to_sym)
  end

  [fragment_klass, data]
end

#resolve_include_locks(parent_klass, name) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/flapjack/gateways/jsonapi/helpers/serialiser.rb', line 114

def resolve_include_locks(parent_klass, name)
  links = if parent_klass.respond_to?(:jsonapi_associations)
    parent_klass.jsonapi_associations || {}
  else
    {}
  end

  assoc_data = links[name.to_sym]

  return if assoc_data.nil? || !assoc_data.link

  klass = assoc_data.data_klass

  [klass, assoc_data.lock_klasses]
end