Class: Comet::Organization

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/organization.rb

Overview

Organization is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Organization

Returns a new instance of Organization.



41
42
43
 
# File 'lib/comet/models/organization.rb', line 41

def initialize
  clear
end

Instance Attribute Details

#branding ⇒ Object

Returns the value of attribute branding.



27
28
29
 
# File 'lib/comet/models/organization.rb', line 27

def branding
  @branding
end

#email ⇒ Object

Returns the value of attribute email.



36
37
38
 
# File 'lib/comet/models/organization.rb', line 36

def email
  @email
end

#hosts ⇒ Object

Returns the value of attribute hosts.



21
22
23
 
# File 'lib/comet/models/organization.rb', line 21

def hosts
  @hosts
end

#name ⇒ Object

Returns the value of attribute name.



18
19
20
 
# File 'lib/comet/models/organization.rb', line 18

def name
  @name
end

#remote_storage ⇒ Object

Returns the value of attribute remote_storage.



30
31
32
 
# File 'lib/comet/models/organization.rb', line 30

def remote_storage
  @remote_storage
end

#software_build_role ⇒ Object

Returns the value of attribute software_build_role.



24
25
26
 
# File 'lib/comet/models/organization.rb', line 24

def software_build_role
  @software_build_role
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



39
40
41
 
# File 'lib/comet/models/organization.rb', line 39

def unknown_json_fields
  @unknown_json_fields
end

#webhook_options ⇒ Object

Returns the value of attribute webhook_options.



33
34
35
 
# File 'lib/comet/models/organization.rb', line 33

def webhook_options
  @webhook_options
end

Instance Method Details

#clear ⇒ Object 



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/comet/models/organization.rb', line 45

def clear
  @name = ''
  @hosts = []
  @software_build_role = Comet::SoftwareBuildRoleOptions.new
  @branding = Comet::BrandingOptions.new
  @remote_storage = []
  @webhook_options = {}
  @email = Comet::AdminEmailOptions.new
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/comet/models/organization.rb', line 64

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'Name'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @name = v
    when 'Hosts'
      if v.nil?
        @hosts = []
      else
        @hosts = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @hosts[i1] = v1
        end
      end
    when 'SoftwareBuildRole'
      @software_build_role = Comet::SoftwareBuildRoleOptions.new
      @software_build_role.from_hash(v)
    when 'Branding'
      @branding = Comet::BrandingOptions.new
      @branding.from_hash(v)
    when 'RemoteStorage'
      if v.nil?
        @remote_storage = []
      else
        @remote_storage = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @remote_storage[i1] = Comet::RemoteStorageOption.new
          @remote_storage[i1].from_hash(v1)
        end
      end
    when 'WebhookOptions'
      @webhook_options = {}
      if v.nil?
        @webhook_options = {}
      else
        v.each do |k1, v1|
          @webhook_options[k1] = Comet::WebhookOption.new
          @webhook_options[k1].from_hash(v1)
        end
      end
    when 'Email'
      @email = Comet::AdminEmailOptions.new
      @email.from_hash(v)
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


57
58
59
60
61
 
# File 'lib/comet/models/organization.rb', line 57

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



136
137
138
 
# File 'lib/comet/models/organization.rb', line 136

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/comet/models/organization.rb', line 120

def to_hash
  ret = {}
  ret['Name'] = @name
  ret['Hosts'] = @hosts
  ret['SoftwareBuildRole'] = @software_build_role
  ret['Branding'] = @branding
  ret['RemoteStorage'] = @remote_storage
  ret['WebhookOptions'] = @webhook_options
  ret['Email'] = @email
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



141
142
143
 
# File 'lib/comet/models/organization.rb', line 141

def to_json(options = {})
  to_hash.to_json(options)
end