Class: JsonApiClient::Resource

Inherits:
Object
  • Object
show all
Extended by:
ActiveModel::Naming, ActiveModel::Translation, Forwardable
Includes:
ActiveModel::Conversion, ActiveModel::Serialization, ActiveModel::Validations, Associations::BelongsTo, Associations::HasMany, Associations::HasOne, Helpers::Dirty, Helpers::DynamicAttributes
Defined in:
lib/json_api_client/resource.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers::Dirty

#attribute_change, #attribute_changed?, #attribute_was, #attribute_will_change!, #changed, #changed?, #changed_attributes, #clear_changes_information, #set_all_attributes_dirty, #set_attribute_was

Methods included from Helpers::DynamicAttributes

#[], #[]=, #attributes, #attributes=

Constructor Details

#initialize(params = {}) ⇒ Resource

Instantiate a new resource object

Parameters:

  • params (Hash) (defaults to: {}) —

    Attributes, links, and relationships



292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/json_api_client/resource.rb', line 292

def initialize(params = {})
  @persisted = nil
  self.links = self.class.linker.new(params.delete("links") || {})
  self.relationships = self.class.relationship_linker.new(self.class, params.delete("relationships") || {})
  self.class.associations.each do |association|
    if params.has_key?(association.attr_name.to_s)
      set_attribute(association.attr_name, association.parse(params[association.attr_name.to_s]))
    end
  end
  self.attributes = params.merge(self.class.default_attributes)
  self.class.schema.each_property do |property|
    attributes[property.name] = property.default unless attributes.has_key?(property.name) || property.default.nil?
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args) ⇒ Object (protected) 



438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/json_api_client/resource.rb', line 438

def method_missing(method, *args)
  association = association_for(method)

  return super unless association || (relationships && relationships.has_attribute?(method))

  return nil unless relationship_definitions = relationships[method]

  # look in included data
  if relationship_definitions.key?("data")
    return last_result_set.included.data_for(method, relationship_definitions)
  end

  if association = association_for(method)
    # look for a defined relationship url
    if relationship_definitions["links"] && url = relationship_definitions["links"]["related"]
      return association.data(url)
    end
  end
  nil
end

Instance Attribute Details

#last_result_set ⇒ Object

Returns the value of attribute last_result_set.



16
17
18
 
# File 'lib/json_api_client/resource.rb', line 16

def last_result_set
  @last_result_set
end

#links ⇒ Object

Returns the value of attribute links.



16
17
18
 
# File 'lib/json_api_client/resource.rb', line 16

def links
  @links
end

#relationships ⇒ Object

Returns the value of attribute relationships.



16
17
18
 
# File 'lib/json_api_client/resource.rb', line 16

def relationships
  @relationships
end

Class Method Details

.connection(rebuild = false, &block) ⇒ Connection

Return/build a connection object

Returns:

  • (Connection) —

    The connection to the json api server



104
105
106
107
 
# File 'lib/json_api_client/resource.rb', line 104

def connection(rebuild = false, &block)
  _build_connection(rebuild, &block)
  connection_object
end

.create(attributes = {}) ⇒ Resource

Create a new instance of this resource class

Parameters:

  • attributes (Hash) (defaults to: {}) —

    The attributes to create this resource with

Returns:

  • (Resource) —

    The instance you tried to create. You will have to check the persisted state or errors on this object to see success/failure.



136
137
138
139
140
 
# File 'lib/json_api_client/resource.rb', line 136

def create(attributes = {})
  new(attributes).tap do |resource|
    resource.save
  end
end

.custom_headers ⇒ Hash

The current custom headers to send with any request made by this resource class

Returns:

  • (Hash) —

    Headers



158
159
160
 
# File 'lib/json_api_client/resource.rb', line 158

def custom_headers
  _header_store.to_h
end

.default_attributes ⇒ Hash

Default attributes that every instance of this resource should be intialized with. Optionally, override this method in a subclass.

Returns:

  • (Hash) —

    Default attributes



173
174
175
 
# File 'lib/json_api_client/resource.rb', line 173

def default_attributes
  {type: type}
end

.key_formatter ⇒ Object 



184
185
186
 
# File 'lib/json_api_client/resource.rb', line 184

def key_formatter
  JsonApiClient::Formatter.formatter_for(json_key_format)
end

.load(params) ⇒ Resource

Load a resource object from attributes and consider it persisted

Returns:

  • (Resource) —

    Persisted resource object



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

def load(params)
  new(params).tap do |resource|
    resource.mark_as_persisted!
    resource.clear_changes_information
  end
end

.path(params = nil) ⇒ Object

Return the path or path pattern for this resource



118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/json_api_client/resource.rb', line 118

def path(params = nil)
  parts = [resource_path]
  if params && _prefix_path.present?
    path_params = params.delete(:path) || params
    parts.unshift(_prefix_path % path_params.symbolize_keys)
  else
    parts.unshift(_prefix_path)
  end
  parts.reject!(&:blank?)
  File.join(*parts)
rescue KeyError
  raise ArgumentError, "Not all prefix parameters specified"
end

.prefix_params ⇒ Array

Param names that will be considered path params. They will be used to build the resource path rather than treated as attributes

Returns:

  • (Array) —

    Param name symbols of parameters that will be treated as path parameters



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

def prefix_params
  _belongs_to_associations.map(&:param)
end

.requestor ⇒ Requestor

Returns the requestor for this resource class

Returns:

  • (Requestor) —

    The requestor for this resource class



165
166
167
 
# File 'lib/json_api_client/resource.rb', line 165

def requestor
  @requestor ||= requestor_class.new(self)
end

.resource_name ⇒ String

The name of a single resource. i.e. Article -> article, Person -> person

Returns:

  • (String) 


71
72
73
 
# File 'lib/json_api_client/resource.rb', line 71

def resource_name
  name.demodulize.underscore
end

.resource_path ⇒ String

Specifies the relative path that should be used for this resource; by default, this is inferred from the resource class name.

Returns:

  • (String) —

    Resource path



87
88
89
 
# File 'lib/json_api_client/resource.rb', line 87

def resource_path
  table_name
end

.route_formatter ⇒ Object 



188
189
190
 
# File 'lib/json_api_client/resource.rb', line 188

def route_formatter
  JsonApiClient::Formatter.formatter_for(route_format)
end

.schema ⇒ Schema

Returns the schema for this resource class

Returns:

  • (Schema) —

    The schema for this resource class



180
181
182
 
# File 'lib/json_api_client/resource.rb', line 180

def schema
  @schema ||= Schema.new
end

.table_name ⇒ String

The table name for this resource. i.e. Article -> articles, Person -> people

Returns:

  • (String) —

    The table name for this resource



64
65
66
 
# File 'lib/json_api_client/resource.rb', line 64

def table_name
  route_formatter.format(resource_name.pluralize)
end

.type ⇒ String

Specifies the JSON API resource type. By default this is inferred from the resource class name.

Returns:

  • (String) —

    Resource path



79
80
81
 
# File 'lib/json_api_client/resource.rb', line 79

def type
  table_name
end

.with_headers(headers) ⇒ Object

Within the given block, add these headers to all requests made by the resource class

Parameters:

  • headers (Hash) —

    The headers to send along

  • block (Block) —

    The block where headers will be set for



147
148
149
150
151
152
 
# File 'lib/json_api_client/resource.rb', line 147

def with_headers(headers)
  self._custom_headers = headers
  yield
ensure
  self._custom_headers = {}
end

Instance Method Details

#as_json ⇒ Object 



363
364
365
366
367
368
369
370
 
# File 'lib/json_api_client/resource.rb', line 363

def as_json(*)
  attributes.slice(:id, :type).tap do |h|
    relationships.as_json.tap do |r|
      h[:relationships] = r unless r.empty?
    end
    h[:attributes] = attributes.except(:id, :type).as_json
  end
end

#as_json_api ⇒ Hash

When we represent this resource for serialization (create/update), we do so with this implementation

Returns:

  • (Hash) —

    Representation of this object as JSONAPI object



354
355
356
357
358
359
360
361
 
# File 'lib/json_api_client/resource.rb', line 354

def as_json_api(*)
  attributes.slice(:id, :type).tap do |h|
    relationships_for_serialization.tap do |r|
      h[:relationships] = self.class.key_formatter.format_keys(r) unless r.empty?
    end
    h[:attributes] = self.class.key_formatter.format_keys(attributes_for_serialization)
  end
end

#as_relation ⇒ Hash

When we represent this resource as a relationship, we do so with id & type

Returns:

  • (Hash) —

    Representation of this object as a relation



346
347
348
 
# File 'lib/json_api_client/resource.rb', line 346

def as_relation
  attributes.slice(:type, self.class.primary_key)
end

#destroy ⇒ Boolean

Try to destroy this resource

Returns:

  • (Boolean) —

    Whether or not the destroy succeeded



422
423
424
425
426
427
428
429
430
 
# File 'lib/json_api_client/resource.rb', line 422

def destroy
  self.last_result_set = self.class.requestor.destroy(self)
  if !last_result_set.has_errors?
    self.attributes.clear
    true
  else
    false
  end
end

#inspect ⇒ Object 



432
433
434
 
# File 'lib/json_api_client/resource.rb', line 432

def inspect
  "#<#{self.class.name}:@attributes=#{attributes.inspect}>"
end

#mark_as_persisted! ⇒ Object

Mark the record as persisted



325
326
327
 
# File 'lib/json_api_client/resource.rb', line 325

def mark_as_persisted!
  @persisted = true
end

#new_record? ⇒ Boolean

Returns true if this is a new record (never persisted to the database)

Returns:

  • (Boolean) 


339
340
341
 
# File 'lib/json_api_client/resource.rb', line 339

def new_record?
  !persisted?
end

#persisted? ⇒ Boolean

Whether or not this record has been persisted to the database previously

Returns:

  • (Boolean) 


332
333
334
 
# File 'lib/json_api_client/resource.rb', line 332

def persisted?
  !!@persisted && has_attribute?(self.class.primary_key)
end

#save ⇒ Boolean

Commit the current changes to the resource to the remote server. If the resource was previously loaded from the server, we will try to update the record. Otherwise if it’s a new record, then we will try to create it

Returns:

  • (Boolean) —

    Whether or not the save succeeded



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/json_api_client/resource.rb', line 389

def save
  return false unless valid?

  self.last_result_set = if persisted?
    self.class.requestor.update(self)
  else
    self.class.requestor.create(self)
  end

  if last_result_set.has_errors?
    last_result_set.errors.each do |error|
      if error.source_parameter
        errors.add(error.source_parameter, error.title || error.detail)
      else
        errors.add(:base, error.title || error.detail)
      end
    end
    false
  else
    self.errors.clear if self.errors
    mark_as_persisted!
    if updated = last_result_set.first
      self.attributes = updated.attributes
      self.relationships.attributes = updated.relationships.attributes
      clear_changes_information
    end
    true
  end
end

#set_all_dirty! ⇒ Object

Mark all attributes for this record as dirty



373
374
375
376
 
# File 'lib/json_api_client/resource.rb', line 373

def set_all_dirty!
  set_all_attributes_dirty
  relationships.set_all_attributes_dirty if relationships
end

#update(attrs = {}) ⇒ Boolean

Alias to update_attributes

Parameters:

  • attrs (Hash) (defaults to: {}) —

    Attributes to update

Returns:

  • (Boolean) —

    Whether the update succeeded or not



320
321
322
 
# File 'lib/json_api_client/resource.rb', line 320

def update(attrs = {})
  update_attributes(attrs)
end

#update_attributes(attrs = {}) ⇒ Boolean

Set the current attributes and try to save them

Parameters:

  • attrs (Hash) (defaults to: {}) —

    Attributes to update

Returns:

  • (Boolean) —

    Whether the update succeeded or not



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

def update_attributes(attrs = {})
  self.attributes = attrs
  save
end

#valid?(context = nil) ⇒ Boolean

Returns:

  • (Boolean) 


378
379
380
381
 
# File 'lib/json_api_client/resource.rb', line 378

def valid?(context = nil)
  context ||= (new_record? ? :create : :update)
  super(context)
end