Class: CtdDocumentation::Entity

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/ctd_documentation/models/entity.rb

Overview

Entity Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(user_id = SKIP, type = SKIP, object = SKIP) ⇒ Entity

Returns a new instance of Entity.



47
48
49
50
51
52
53
 
# File 'lib/ctd_documentation/models/entity.rb', line 47

def initialize(user_id = SKIP,
               type = SKIP,
               object = SKIP)
  @user_id = user_id unless user_id == SKIP
  @type = type unless type == SKIP
  @object = object unless object == SKIP
end

Instance Attribute Details

#object ⇒ Object

TODO: Write general description for this method

Returns:



22
23
24
 
# File 'lib/ctd_documentation/models/entity.rb', line 22

def object
  @object
end

#type ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/ctd_documentation/models/entity.rb', line 18

def type
  @type
end

#user_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/ctd_documentation/models/entity.rb', line 14

def user_id
  @user_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/ctd_documentation/models/entity.rb', line 56

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
  type = hash.key?('type') ? hash['type'] : SKIP
  object = Object.from_hash(hash['object']) if hash['object']

  # Create object from extracted values.

  Entity.new(user_id,
             type,
             object)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/ctd_documentation/models/entity.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['user_id'] = 'user_id'
  @_hash['type'] = 'type'
  @_hash['object'] = 'object'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/ctd_documentation/models/entity.rb', line 43

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
39
40
 
# File 'lib/ctd_documentation/models/entity.rb', line 34

def self.optionals
  %w[
    user_id
    type
    object
  ]
end