Class: JSONAPI::Consumer::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/jsonapi/consumer/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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/jsonapi/consumer/resource.rb', line 341

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.attributes = self.class.default_attributes.merge(params)

  self.class.schema.each_property do |property|
    attributes[property.name] = property.default unless attributes.has_key?(property.name) || property.default.nil?
  end

  self.class.associations.each do |association|
    if params.has_key?(association.attr_name.to_s)
      set_attribute(association.attr_name, params[association.attr_name.to_s])
    end
  end
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

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



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/jsonapi/consumer/resource.rb', line 485

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")
    # included.data_for returns an array, if the association is a has_one, then pick the first, otherise return the whole array
    if association.is_a?(JSONAPI::Consumer::Associations::HasOne::Association)
      return last_result_set.included.data_for(method, relationship_definitions).try(:first)
    else
      return last_result_set.included.data_for(method, relationship_definitions)
    end
  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/jsonapi/consumer/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/jsonapi/consumer/resource.rb', line 16

def links
  @links
end

#relationships ⇒ Object

Returns the value of attribute relationships.



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

def relationships
  @relationships
end

Class Method Details

.authorize_with(jwt, &block) ⇒ Object

Run a command wrapped in an Authorization header



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

def authorize_with(jwt, &block)
  with_headers(authorization: %(Bearer #{jwt}), &block)
end

.authorize_with=(jwt) ⇒ Object

Set the Authorization header to a JWT value



173
174
175
176
177
178
179
 
# File 'lib/jsonapi/consumer/resource.rb', line 173

def authorize_with=(jwt)
  if jwt.nil?
    self._custom_headers = {authorization: nil}
  else
    self._custom_headers = {authorization: %(Bearer #{jwt})}
  end
end

.authorized? ⇒ Boolean

Returns based on the presence of an Authorization header

Returns:

  • (Boolean) 


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

def authorized?
  !custom_headers[:authorization].nil?
end

.authorized_as ⇒ String

Returns The Authorization header.

Returns:

  • (String) —

    The Authorization header



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

def authorized_as
  custom_headers[:authorization]
end

.clear_authorization! ⇒ Object

Clears the Authorization header



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

def clear_authorization!
  self.authorize_with = nil
end

.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/jsonapi/consumer/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/jsonapi/consumer/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. This supports inheritance so it only needs to be set on the base class.

Returns:

  • (Hash) —

    Headers



159
160
161
162
163
 
# File 'lib/jsonapi/consumer/resource.rb', line 159

def custom_headers
  return _header_store.to_h if superclass == Object

  superclass.custom_headers.merge(_header_store.to_h)
end

.default_attributes ⇒ Hash

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

Returns:

  • (Hash) —

    Default attributes



210
211
212
 
# File 'lib/jsonapi/consumer/resource.rb', line 210

def default_attributes
  {type: type}
end

.key_formatter ⇒ Object 



221
222
223
 
# File 'lib/jsonapi/consumer/resource.rb', line 221

def key_formatter
  JSONAPI::Consumer::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/jsonapi/consumer/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/jsonapi/consumer/resource.rb', line 118

def path(params = nil)
  parts = [resource_path]
  if params && _prefix_path.present?
    path_params = params.delete(:path) || params
    parts.unshift(_set_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/jsonapi/consumer/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



202
203
204
 
# File 'lib/jsonapi/consumer/resource.rb', line 202

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/jsonapi/consumer/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/jsonapi/consumer/resource.rb', line 87

def resource_path
  table_name
end

.route_formatter ⇒ Object 



225
226
227
 
# File 'lib/jsonapi/consumer/resource.rb', line 225

def route_formatter
  JSONAPI::Consumer::Formatter.formatter_for(route_format)
end

.schema ⇒ Schema

Returns the schema for this resource class

Returns:

  • (Schema) —

    The schema for this resource class



217
218
219
 
# File 'lib/jsonapi/consumer/resource.rb', line 217

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/jsonapi/consumer/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/jsonapi/consumer/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/jsonapi/consumer/resource.rb', line 147

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

Instance Method Details

#as_json ⇒ Object 



414
415
416
417
418
419
420
421
 
# File 'lib/jsonapi/consumer/resource.rb', line 414

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



405
406
407
408
409
410
411
412
 
# File 'lib/jsonapi/consumer/resource.rb', line 405

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



397
398
399
 
# File 'lib/jsonapi/consumer/resource.rb', line 397

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



468
469
470
471
472
473
474
475
476
477
 
# File 'lib/jsonapi/consumer/resource.rb', line 468

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

#inspect ⇒ Object 



479
480
481
 
# File 'lib/jsonapi/consumer/resource.rb', line 479

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

#mark_as_persisted! ⇒ Object

Mark the record as persisted



376
377
378
 
# File 'lib/jsonapi/consumer/resource.rb', line 376

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) 


390
391
392
 
# File 'lib/jsonapi/consumer/resource.rb', line 390

def new_record?
  !persisted?
end

#persisted? ⇒ Boolean

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

Returns:

  • (Boolean) 


383
384
385
 
# File 'lib/jsonapi/consumer/resource.rb', line 383

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



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/jsonapi/consumer/resource.rb', line 440

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?
    fill_errors
    false
  else
    self.errors.clear if self.errors
    mark_as_persisted!
    if updated = last_result_set.first
      self.attributes = updated.attributes
      self.links.attributes = updated.links.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



424
425
426
427
 
# File 'lib/jsonapi/consumer/resource.rb', line 424

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



371
372
373
 
# File 'lib/jsonapi/consumer/resource.rb', line 371

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



362
363
364
365
 
# File 'lib/jsonapi/consumer/resource.rb', line 362

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

#valid?(context = nil) ⇒ Boolean

Returns:

  • (Boolean) 


429
430
431
432
 
# File 'lib/jsonapi/consumer/resource.rb', line 429

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