Class: Comet::MSSQLConnection

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeMSSQLConnection

Returns a new instance of MSSQLConnection.



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

def initialize
  clear
end

Instance Attribute Details

#hostnameObject

Returns the value of attribute hostname.



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

def hostname
  @hostname
end

#instance_nameObject

Returns the value of attribute instance_name.



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

def instance_name
  @instance_name
end

#methodObject

Returns the value of attribute method.



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

def method
  @method
end

#passwordObject

Returns the value of attribute password.



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

def password
  @password
end

#typeObject

Returns the value of attribute type.



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

def type
  @type
end

#unknown_json_fieldsObject

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#usernameObject

Returns the value of attribute username.



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

def username
  @username
end

Instance Method Details

#clearObject



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

def clear
  @type = ''
  @username = ''
  @password = ''
  @hostname = ''
  @instance_name = ''
  @method = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash)

    The complete object as a Ruby hash

Raises:

  • (TypeError)


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

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

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

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

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

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


51
52
53
54
55
# File 'lib/comet/models/mssqlconnection.rb', line 51

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_hHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



109
110
111
# File 'lib/comet/models/mssqlconnection.rb', line 109

def to_h
  to_hash
end

#to_hashHash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash)

    The complete object as a Ruby hash



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

def to_hash
  ret = {}
  ret['Type'] = @type
  ret['Username'] = @username
  ret['Password'] = @password
  ret['Hostname'] = @hostname
  ret['InstanceName'] = @instance_name
  ret['Method'] = @method
  @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



114
115
116
# File 'lib/comet/models/mssqlconnection.rb', line 114

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