Class: Comet::InstallToken

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ InstallToken

Returns a new instance of InstallToken.



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

def initialize
  clear
end

Instance Attribute Details

#create_time ⇒ Object

Unix timestamp, in seconds.



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

def create_time
  @create_time
end

#expire_time ⇒ Object

Unix timestamp, in seconds.



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

def expire_time
  @expire_time
end

#server ⇒ Object

The URL of the Comet Server (Auth Role) for the target user to log in to.



20
21
22
 
# File 'lib/comet/models/install_token.rb', line 20

def server
  @server
end

#token ⇒ Object

The token for use with the “/TOKEN=” silent install flag.



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

def token
  @token
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#used ⇒ Object

If the token has been used, it cannot be used again.



32
33
34
 
# File 'lib/comet/models/install_token.rb', line 32

def used
  @used
end

#username ⇒ Object

Returns the value of attribute username.



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

def username
  @username
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @username = ''
  @server = ''
  @token = ''
  @create_time = 0
  @expire_time = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


62
63
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
 
# File 'lib/comet/models/install_token.rb', line 62

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

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

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

      @token = v
    when 'CreateTime'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

      @create_time = v
    when 'Used'
      @used = v
    when 'ExpireTime'
      raise TypeError, "'v' expected Numeric, got #{v.class}" unless v.is_a? Numeric

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


55
56
57
58
59
 
# File 'lib/comet/models/install_token.rb', line 55

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



111
112
113
 
# File 'lib/comet/models/install_token.rb', line 111

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



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/comet/models/install_token.rb', line 96

def to_hash
  ret = {}
  ret['Username'] = @username
  ret['Server'] = @server
  ret['Token'] = @token
  ret['CreateTime'] = @create_time
  ret['Used'] = @used
  ret['ExpireTime'] = @expire_time
  @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



116
117
118
 
# File 'lib/comet/models/install_token.rb', line 116

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