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.



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

def initialize
  clear
end

Instance Attribute Details

#create_time ⇒ Object

Returns the value of attribute create_time.



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

def create_time
  @create_time
end

#expire_time ⇒ Object

Returns the value of attribute expire_time.



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

def expire_time
  @expire_time
end

#server ⇒ Object

Returns the value of attribute server.



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

def server
  @server
end

#token ⇒ Object

Returns the value of attribute token.



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.



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

def unknown_json_fields
  @unknown_json_fields
end

#used ⇒ Object

Returns the value of attribute used.



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

def used
  @used
end

#username ⇒ Object

Returns the value of attribute username.



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

def username
  @username
end

Instance Method Details

#clear ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/comet/models/install_token.rb', line 42

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) 


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
84
85
86
87
88
89
90
 
# File 'lib/comet/models/install_token.rb', line 59

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) 


52
53
54
55
56
 
# File 'lib/comet/models/install_token.rb', line 52

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



108
109
110
 
# File 'lib/comet/models/install_token.rb', line 108

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



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/comet/models/install_token.rb', line 93

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



113
114
115
 
# File 'lib/comet/models/install_token.rb', line 113

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