Class: Comet::Office365Credential

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Office365Credential

Returns a new instance of Office365Credential.



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

def initialize
  clear
end

Instance Attribute Details

#app_cert ⇒ Object

Returns the value of attribute app_cert.



25
26
27
 
# File 'lib/comet/models/office_365credential.rb', line 25

def app_cert
  @app_cert
end

#app_id ⇒ Object

Returns the value of attribute app_id.



16
17
18
 
# File 'lib/comet/models/office_365credential.rb', line 16

def app_id
  @app_id
end

#region ⇒ Object

Returns the value of attribute region.



28
29
30
 
# File 'lib/comet/models/office_365credential.rb', line 28

def region
  @region
end

#secret ⇒ Object

Returns the value of attribute secret.



22
23
24
 
# File 'lib/comet/models/office_365credential.rb', line 22

def secret
  @secret
end

#tenant_id ⇒ Object

Returns the value of attribute tenant_id.



19
20
21
 
# File 'lib/comet/models/office_365credential.rb', line 19

def tenant_id
  @tenant_id
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



31
32
33
 
# File 'lib/comet/models/office_365credential.rb', line 31

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



37
38
39
40
41
42
43
44
 
# File 'lib/comet/models/office_365credential.rb', line 37

def clear
  @app_id = ''
  @tenant_id = ''
  @secret = ''
  @app_cert = ''
  @region = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/comet/models/office_365credential.rb', line 54

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 'AppID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @app_id = v
    when 'TenantID'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @tenant_id = v
    when 'Secret'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @secret = v
    when 'AppCert'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @app_cert = v
    when 'Region'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @region = 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) 


47
48
49
50
51
 
# File 'lib/comet/models/office_365credential.rb', line 47

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



100
101
102
 
# File 'lib/comet/models/office_365credential.rb', line 100

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



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/comet/models/office_365credential.rb', line 86

def to_hash
  ret = {}
  ret['AppID'] = @app_id
  ret['TenantID'] = @tenant_id
  ret['Secret'] = @secret
  ret['AppCert'] = @app_cert
  ret['Region'] = @region
  @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



105
106
107
 
# File 'lib/comet/models/office_365credential.rb', line 105

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