Class: CtdDocumentation::Object

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

Overview

Object Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(description = SKIP, user_id = SKIP, resolved = SKIP) ⇒ Object

Returns a new instance of Object.



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

def initialize(description = SKIP,
               user_id = SKIP,
               resolved = SKIP)
  @description = description unless description == SKIP
  @user_id = user_id unless user_id == SKIP
  @resolved = resolved unless resolved == SKIP
end

Instance Attribute Details

#description ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def description
  @description
end

#resolved ⇒ TrueClass|FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass|FalseClass) 


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

def resolved
  @resolved
end

#user_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

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/object.rb', line 56

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  description = hash.key?('description') ? hash['description'] : SKIP
  user_id = hash.key?('user_id') ? hash['user_id'] : SKIP
  resolved = hash.key?('resolved') ? hash['resolved'] : SKIP

  # Create object from extracted values.

  Object.new(description,
             user_id,
             resolved)
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/object.rb', line 25

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

.nullables ⇒ Object

An array for nullable fields



43
44
45
 
# File 'lib/ctd_documentation/models/object.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/object.rb', line 34

def self.optionals
  %w[
    description
    user_id
    resolved
  ]
end