Class: Comet::WinSMBAuth

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WinSMBAuth

Returns a new instance of WinSMBAuth.



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

def initialize
  clear
end

Instance Attribute Details

#password ⇒ Object

The password might be hashed. To set this in cleartext, set PasswordFormat to 0 (PASSWORD_FORMAT_PLAINTEXT).



26
27
28
 
# File 'lib/comet/models/win_smbauth.rb', line 26

def password
  @password
end

#password_format ⇒ Object

The hash algorithm that is used for the Password field. It is one of the PASSWORD_FORMAT_ constants.



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

def password_format
  @password_format
end

#share_path ⇒ Object

The UNC path for the Windows network share (SMB).



17
18
19
 
# File 'lib/comet/models/win_smbauth.rb', line 17

def share_path
  @share_path
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



34
35
36
 
# File 'lib/comet/models/win_smbauth.rb', line 34

def unknown_json_fields
  @unknown_json_fields
end

#username ⇒ Object

The username to log in to the Windows network share (SMB).



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

def username
  @username
end

Instance Method Details

#clear ⇒ Object 



40
41
42
43
44
45
46
 
# File 'lib/comet/models/win_smbauth.rb', line 40

def clear
  @share_path = ''
  @username = ''
  @password = ''
  @password_format = 0
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
 
# File 'lib/comet/models/win_smbauth.rb', line 56

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

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

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

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

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


49
50
51
52
53
 
# File 'lib/comet/models/win_smbauth.rb', line 49

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



97
98
99
 
# File 'lib/comet/models/win_smbauth.rb', line 97

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



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/comet/models/win_smbauth.rb', line 84

def to_hash
  ret = {}
  ret['SharePath'] = @share_path
  ret['Username'] = @username
  ret['Password'] = @password
  ret['PasswordFormat'] = @password_format
  @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



102
103
104
 
# File 'lib/comet/models/win_smbauth.rb', line 102

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