Class: LWS::Generic::Model

Inherits:
Spyke::Base
  • Object
show all
Includes:
ActiveModel::Dirty
Defined in:
lib/lws/apps/generic.rb

Overview

The generic model class

This model forms the base for all LWS models.

Direct Known Subclasses

Auth::Account, Auth::App, Auth::Company, Auth::Contract, Auth::Device, Auth::License, Auth::Token, Auth::UsageReport, Auth::User, CorporateWebsite::Article, CorporateWebsite::OfficeTime, CorporateWebsite::Page, CorporateWebsite::SocialPage, CorporateWebsite::SocialPost, DigitalSignage::Channel, DigitalSignage::Channel::Group, DigitalSignage::Channel::Group::Tag, DigitalSignage::Channel::Tag, DigitalSignage::Channel::TimeSchedule, DigitalSignage::Channel::TimeSchedule::Day, DigitalSignage::Channel::TimeScheduleOverride, DigitalSignage::Display, DigitalSignage::Display::Input, DigitalSignage::Display::Resolution, DigitalSignage::Layout, DigitalSignage::Layout::Category, DigitalSignage::Layout::Element, DigitalSignage::Layout::Element::Customizable, DigitalSignage::Layout::Element::Property, DigitalSignage::Layout::Version, DigitalSignage::Player, DigitalSignage::Player::Component, DigitalSignage::Player::Component::Part, DigitalSignage::Player::Configuration, DigitalSignage::Player::Configuration::Setting, DigitalSignage::Player::Log, DigitalSignage::Player::Model, DigitalSignage::Player::Model::Capability, DigitalSignage::Player::Notification, DigitalSignage::Player::Os::Branch, DigitalSignage::Player::Os::Branch::Release, DigitalSignage::Player::Os::Package, DigitalSignage::Player::Os::Package::Version, DigitalSignage::Player::Os::Package::VersionChange, DigitalSignage::Player::Os::ReleaseChannel, DigitalSignage::Player::PredefinedConfiguration, DigitalSignage::Player::PredefinedConfiguration::Setting, DigitalSignage::Player::Request, DigitalSignage::Player::Screenshot, DigitalSignage::Player::Tag, DigitalSignage::Slide, DigitalSignage::Slide::Schedule, Configuration, Maps::Map, Maps::Marker, Maps::Source, Presence::Appointment, Presence::Journal, Presence::Location, Presence::Location::Map, Presence::Location::Map::Position, Presence::Notification, Presence::Person, Presence::Reader, Resource::Collection, Resource::Collection::Item, Resource::Folder, Ticket::Attachment, Ticket::Group, Ticket::Message, Ticket::Tag, Ticket::Ticket

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#created_at ⇒ String (readonly)

Returns the timestamp of when the model was created.

Returns:

  • (String) —

    the timestamp of when the model was created



96
 
# File 'lib/lws/apps/generic.rb', line 96

attribute :created_at

#id ⇒ Integer (readonly)

Returns the (unique) ID of the model.

Returns:

  • (Integer) —

    the (unique) ID of the model



92
 
# File 'lib/lws/apps/generic.rb', line 92

attribute :id

#updated_at ⇒ String (readonly)

Returns the timestamp of when the model was last updated.

Returns:

  • (String) —

    the timestamp of when the model was last updated



100
 
# File 'lib/lws/apps/generic.rb', line 100

attribute :updated_at

#url ⇒ String (readonly)

Returns the URL of the model on the REST API.

Returns:

  • (String) —

    the URL of the model on the REST API



104
 
# File 'lib/lws/apps/generic.rb', line 104

attribute :url

#url_html ⇒ String (readonly)

Returns the URL of the web/HTML page of the model.

Returns:

  • (String) —

    the URL of the web/HTML page of the model



108
 
# File 'lib/lws/apps/generic.rb', line 108

attribute :url_html

Instance Method Details

#deep_dup ⇒ Model

Returns a deep copy of the model.

Returns:

  • (Model) —

    a deep copy of the model



167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/lws/apps/generic.rb', line 167

def deep_dup
  dup_obj = super
  dup_obj.instance_eval do
    @changed_attributes = @changed_attributes.deep_dup
    @previously_changed = @previously_changed.deep_dup
    @scope = @scope.deep_dup
    @spyke_attributes = @spyke_attributes.deep_dup
    @uri_template = @uri_template.deep_dup
  end
  dup_obj
end

#dig(*attrs) ⇒ Object?

Extracts a nested attribute value specified by the sequence of attribute names by calling dig at each step, returning nil if any intermediate step is nil.

Returns:

  • (Object, nil) —

    the digged up value or nil

Raises:

  • (TypeError) 


156
157
158
159
160
161
162
163
 
# File 'lib/lws/apps/generic.rb', line 156

def dig(*attrs)
  attr = attrs.shift
  value = send(attr)
  return nil if value.nil?
  return value if attrs.empty?
  raise TypeError, "#{value.class} does not have #dig method" unless value.respond_to? :dig
  value.dig(*attrs)
end

#reload ⇒ Hash

Reloads the attributes of this model by retrieving it from LWS via HTTP.

This also clears information about tracked changes to attribute values!

Returns:

  • (Hash) —

    a mapping of retrieved attribute names to values



129
130
131
132
133
 
# File 'lib/lws/apps/generic.rb', line 129

def reload
  result = super
  clear_changes_information if result
  result
end

#rollback ⇒ Array<String>

Restore the attributes of this model to the previous (original) values.

Returns:

  • (Array<String>) —

    list of attribute names that were rolled back



138
139
140
 
# File 'lib/lws/apps/generic.rb', line 138

def rollback
  restore_attributes
end

#save ⇒ Hash, Trueclass

Saves the model to LWS via HTTP if there are any changes.

Returns:

  • (Hash, Trueclass) —

    a mapping of attributes names to values, or true if no save action was necessary.



146
147
148
149
150
151
 
# File 'lib/lws/apps/generic.rb', line 146

def save
  return true unless changed? || !persisted?
  result = super
  changes_applied if result
  result
end