Class: JSONAPI::Resource

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

Constant Summary collapse

@@resource_types = 
{}

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ResourceFor

included

Constructor Details

#initialize(model, context = nil) ⇒ Resource

Returns a new instance of Resource.



14
15
16
17
 
# File 'lib/jsonapi/resource.rb', line 14

def initialize(model, context = nil)
  @model = model
  @context = context
end

Class Attribute Details

._allowed_filters ⇒ Object

Returns the value of attribute _allowed_filters.



126
127
128
 
# File 'lib/jsonapi/resource.rb', line 126

def _allowed_filters
  @_allowed_filters
end

._associations ⇒ Object

Returns the value of attribute _associations.



126
127
128
 
# File 'lib/jsonapi/resource.rb', line 126

def _associations
  @_associations
end

._attributes ⇒ Object

Returns the value of attribute _attributes.



126
127
128
 
# File 'lib/jsonapi/resource.rb', line 126

def _attributes
  @_attributes
end

._type ⇒ Object

Returns the value of attribute _type.



126
127
128
 
# File 'lib/jsonapi/resource.rb', line 126

def _type
  @_type
end

Instance Attribute Details

#context ⇒ Object (readonly)

Returns the value of attribute context.



11
12
13
 
# File 'lib/jsonapi/resource.rb', line 11

def context
  @context
end

#model ⇒ Object (readonly)

Returns the value of attribute model.



12
13
14
 
# File 'lib/jsonapi/resource.rb', line 12

def model
  @model
end

Class Method Details

._allowed_filter?(filter) ⇒ Boolean

Returns:

  • (Boolean) 


338
339
340
 
# File 'lib/jsonapi/resource.rb', line 338

def _allowed_filter?(filter)
  _allowed_filters.include?(filter)
end

._as_parent_key ⇒ Object 



311
312
313
 
# File 'lib/jsonapi/resource.rb', line 311

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

._association(type) ⇒ Object 



298
299
300
301
 
# File 'lib/jsonapi/resource.rb', line 298

def _association(type)
  type = type.to_sym
  @_associations[type]
end

._attribute_options(attr) ⇒ Object

quasi private class methods



278
279
280
 
# File 'lib/jsonapi/resource.rb', line 278

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

._has_association?(type) ⇒ Boolean

Returns:

  • (Boolean) 


293
294
295
296
 
# File 'lib/jsonapi/resource.rb', line 293

def _has_association?(type)
  type = type.to_s
  @_associations.has_key?(type.singularize.to_sym) || @_associations.has_key?(type.pluralize.to_sym)
end

._key ⇒ Object 



307
308
309
 
# File 'lib/jsonapi/resource.rb', line 307

def _key
  @_key ||= :id
end

._model_name ⇒ Object 



303
304
305
 
# File 'lib/jsonapi/resource.rb', line 303

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

._resource_name_from_type(type) ⇒ Object 



319
320
321
322
323
324
325
326
 
# File 'lib/jsonapi/resource.rb', line 319

def _resource_name_from_type(type)
  class_name = @@resource_types[type]
  if class_name.nil?
    class_name = type.to_s.singularize.camelize + 'Resource'
    @@resource_types[type] = class_name
  end
  return class_name
end

._updateable_associations ⇒ Object 



282
283
284
285
286
287
288
289
290
291
 
# File 'lib/jsonapi/resource.rb', line 282

def _updateable_associations
  associations = []

  @_associations.each do |key, association|
    if association.is_a?(JSONAPI::Association::HasOne) || association.acts_as_set
      associations.push(key)
    end
  end
  associations
end

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



151
152
153
154
155
156
157
158
159
160
 
# File 'lib/jsonapi/resource.rb', line 151

def attribute(attr, options = {})
  @_attributes[attr] = options
  define_method attr do
    @model.send(attr)
  end unless method_defined?(attr)

  define_method "#{attr}=" do |value|
    @model.send "#{attr}=", value
  end unless method_defined?("#{attr}=")
end

.attributes(*attrs) ⇒ Object

Methods used in defining a resource class



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

def attributes(*attrs)
  attrs.each do |attr|
    attribute(attr)
  end
end

.create(context) ⇒ Object 



128
129
130
 
# File 'lib/jsonapi/resource.rb', line 128

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

.create_model ⇒ Object 



132
133
134
 
# File 'lib/jsonapi/resource.rb', line 132

def create_model
  _model_class.new
end

.createable_fields(context = nil) ⇒ Object

Override in your resource to filter the createable keys



196
197
198
 
# File 'lib/jsonapi/resource.rb', line 196

def createable_fields(context = nil)
  _updateable_associations | _attributes.keys
end

.default_attribute_options ⇒ Object 



162
163
164
 
# File 'lib/jsonapi/resource.rb', line 162

def default_attribute_options
  {format: :default}
end

.fields ⇒ Object 



200
201
202
 
# File 'lib/jsonapi/resource.rb', line 200

def fields
  _associations.keys | _attributes.keys
end

.filter(attr) ⇒ Object 



182
183
184
 
# File 'lib/jsonapi/resource.rb', line 182

def filter(attr)
  @_allowed_filters.add(attr.to_sym)
end

.filters(*attrs) ⇒ Object 



178
179
180
 
# File 'lib/jsonapi/resource.rb', line 178

def filters(*attrs)
  @_allowed_filters.merge(attrs)
end

.find(filters, context = nil) ⇒ Object

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/jsonapi/resource.rb', line 205

def find(filters, context = nil)
  includes = []
  where_filters = {}

  filters.each do |filter, value|
    if _associations.include?(filter)
      if _associations[filter].is_a?(JSONAPI::Association::HasMany)
        includes.push(filter)
        where_filters["#{filter}.#{_associations[filter].primary_key}"] = value
      else
        where_filters["#{_associations[filter].key}"] = value
      end
    else
      where_filters[filter] = value
    end
  end

  resources = []
  _model_class.where(where_filters).includes(includes).each do |model|
    resources.push self.new(model, context)
  end

  return resources
end

.find_by_key(key, context = nil) ⇒ Object 



230
231
232
233
234
235
236
 
# File 'lib/jsonapi/resource.rb', line 230

def find_by_key(key, context = nil)
  model = _model_class.where({_key => key}).first
  if model.nil?
    raise JSONAPI::Exceptions::RecordNotFound.new(key)
  end
  self.new(model, context)
end

.has_many(*attrs) ⇒ Object 



170
171
172
 
# File 'lib/jsonapi/resource.rb', line 170

def has_many(*attrs)
  _associate(Association::HasMany, *attrs)
end

.has_one(*attrs) ⇒ Object 



166
167
168
 
# File 'lib/jsonapi/resource.rb', line 166

def has_one(*attrs)
  _associate(Association::HasOne, *attrs)
end

.inherited(base) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/jsonapi/resource.rb', line 113

def inherited(base)
  base._attributes = (_attributes || {}).dup
  base._associations = (_associations || {}).dup
  base._allowed_filters = (_allowed_filters || Set.new).dup

  type = base.name.demodulize.sub(/Resource$/, '').underscore
  base._type = type.pluralize.to_sym
  # If eager loading is on this is how all the resource types are setup
  # If eager loading is off some resource types will be initialized in
  # _resource_name_from_type
  @@resource_types[base._type] ||= base.name.demodulize
end

.is_filter_association?(filter) ⇒ Boolean

Returns:

  • (Boolean) 


247
248
249
 
# File 'lib/jsonapi/resource.rb', line 247

def is_filter_association?(filter)
  filter == _type || _associations.include?(filter)
end

.key(key) ⇒ Object 



186
187
188
 
# File 'lib/jsonapi/resource.rb', line 186

def key(key)
  @_key = key.to_sym
end

.model_name(model) ⇒ Object 



174
175
176
 
# File 'lib/jsonapi/resource.rb', line 174

def model_name(model)
  @_model_name = model.to_sym
end

.routing_options(options) ⇒ Object 



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

def routing_options(options)
  @_routing_resource_options = options
end

.routing_resource_options ⇒ Object 



140
141
142
 
# File 'lib/jsonapi/resource.rb', line 140

def routing_resource_options
  @_routing_resource_options ||= {}
end

.updateable_fields(context = nil) ⇒ Object

Override in your resource to filter the updateable keys



191
192
193
 
# File 'lib/jsonapi/resource.rb', line 191

def updateable_fields(context = nil)
  _updateable_associations | _attributes.keys
end

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

override to allow for custom association logic, such as uuids, multiple keys or permission checks on keys



273
274
275
 
# File 'lib/jsonapi/resource.rb', line 273

def verify_association_filter(filter, raw, context = nil)
  return filter, raw
end

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

override to allow for custom filters



268
269
270
 
# File 'lib/jsonapi/resource.rb', line 268

def verify_custom_filter(filter, value, context = nil)
  return filter, value
end

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



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/jsonapi/resource.rb', line 251

def verify_filter(filter, raw, context = nil)
  filter_values = []
  filter_values += CSV.parse_line(raw) unless raw.nil? || raw.empty?

  if is_filter_association?(filter)
    verify_association_filter(filter, filter_values, context)
  else
    verify_custom_filter(filter, filter_values, context)
  end
end

.verify_filters(filters, context = nil) ⇒ Object 



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

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

override to allow for key processing and checking



263
264
265
 
# File 'lib/jsonapi/resource.rb', line 263

def verify_key(key, context = nil)
  return key
end

Instance Method Details

#_model_class ⇒ Object 



329
330
331
 
# File 'lib/jsonapi/resource.rb', line 329

def _model_class
  @model ||= Object.const_get(_model_name)
end

#create_has_many_link(association_type, association_key_value) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/jsonapi/resource.rb', line 23

def create_has_many_link(association_type, association_key_value)
  association = self.class._associations[association_type]
  related_resource = self.class.resource_for(association.type).find_by_key(association_key_value, @context)

  # ToDo: Add option to skip relations that already exist instead of returning an error?
  relation = @model.send(association.type).where(association.primary_key => association_key_value).first
  if relation.nil?
    @model.send(association.type) << related_resource.model
  else
    raise JSONAPI::Exceptions::HasManyRelationExists.new(association_key_value)
  end
end

#create_has_one_link(association_type, association_key_value) ⇒ Object 



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

def create_has_one_link(association_type, association_key_value)
  association = self.class._associations[association_type]

  # ToDo: Add option to skip relations that already exist instead of returning an error?
  relation = @model.send("#{association.key}")
  if relation.nil?
    @model.send("#{association.key}=", association_key_value)
  else
    raise JSONAPI::Exceptions::HasOneRelationExists.new
  end
end

#fetchable_fields ⇒ Object

Override this on a resource instance to override the fetchable keys



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

def fetchable_fields
  self.class.fields
end

#remove ⇒ Object 



19
20
21
 
# File 'lib/jsonapi/resource.rb', line 19

def remove
  @model.destroy
end

#remove_has_many_link(association_type, key) ⇒ Object 



60
61
62
63
64
 
# File 'lib/jsonapi/resource.rb', line 60

def remove_has_many_link(association_type, key)
  association = self.class._associations[association_type]

  @model.send(association.type).delete(key)
end

#remove_has_one_link(association_type) ⇒ Object 



66
67
68
69
70
 
# File 'lib/jsonapi/resource.rb', line 66

def remove_has_one_link(association_type)
  association = self.class._associations[association_type]

  @model.send("#{association.key}=", nil)
end

#replace_fields(field_data) ⇒ Object 



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

def replace_fields(field_data)
  field_data[:attributes].each do |attribute, value|
    send "#{attribute}=", value
  end

  field_data[:has_one].each do |association_type, value|
    if value.nil?
      remove_has_one_link(association_type)
    else
      replace_has_one_link(association_type, value)
    end
  end if field_data[:has_one]

  field_data[:has_many].each do |association_type, values|
    replace_has_many_links(association_type, values)
  end if field_data[:has_many]
end

#replace_has_many_links(association_type, association_key_values) ⇒ Object 



36
37
38
39
40
 
# File 'lib/jsonapi/resource.rb', line 36

def replace_has_many_links(association_type, association_key_values)
  association = self.class._associations[association_type]

  @model.send("#{association.key}=", association_key_values)
end

#replace_has_one_link(association_type, association_key_value) ⇒ Object 



54
55
56
57
58
 
# File 'lib/jsonapi/resource.rb', line 54

def replace_has_one_link(association_type, association_key_value)
  association = self.class._associations[association_type]

  @model.send("#{association.key}=", association_key_value)
end

#save ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/jsonapi/resource.rb', line 90

def save
  @model.save!
rescue ActiveRecord::RecordInvalid => e
  errors = []
  e.record.errors.messages.each do |element|
    element[1].each do |message|
      errors.push(JSONAPI::Error.new(
                      code: JSONAPI::VALIDATION_ERROR,
                      status: :bad_request,
                      title: "#{element[0]} - #{message}",
                      detail: "can't be blank",
                      path: "\\#{element[0]}"))
    end
  end
  raise JSONAPI::Exceptions::ValidationErrors.new(errors)
end