Class: GameDig::QueryResult

Inherits:
Object
  • Object
show all
Defined in:
lib/game_dig/query_result.rb

Overview

Typed container for a normalized GameDig server response.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hash) ⇒ QueryResult 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/game_dig/query_result.rb', line 33

def initialize(hash)
  @name        = hash['name']
  @map         = hash['map']
  @password    = hash['password']
  @num_players = hash['num_players']
  @max_players = hash['max_players']
  @players     = hash['players'] || []
  @bots        = hash['bots'] || []
  @connect     = hash['connect']
  @ping        = hash['ping']
  @query_port  = hash['query_port']
  @version     = hash['version']
  @raw         = hash['raw'] || {}
end

Instance Attribute Details

#bots ⇒ Array<Hash> 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

#connect ⇒ String 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

#map ⇒ String 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

#max_players ⇒ Integer 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

#name ⇒ String 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

#num_players ⇒ Integer 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

#password ⇒ Boolean 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

#ping ⇒ Integer 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

#players ⇒ Array<Hash> 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

#query_port ⇒ Integer 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

#raw ⇒ Hash{String=>Object} 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

#version ⇒ String 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/game_dig/query_result.rb', line 29

class QueryResult
  attr_accessor :name, :map, :password, :num_players, :max_players, :players, :bots,
                :connect, :ping, :query_port, :version, :raw

  def initialize(hash)
    @name        = hash['name']
    @map         = hash['map']
    @password    = hash['password']
    @num_players = hash['num_players']
    @max_players = hash['max_players']
    @players     = hash['players'] || []
    @bots        = hash['bots'] || []
    @connect     = hash['connect']
    @ping        = hash['ping']
    @query_port  = hash['query_port']
    @version     = hash['version']
    @raw         = hash['raw'] || {}
  end

  # Convenience: turn back into plain Hash.
  # @return [Hash{String=>Object}]
  def to_h
    {
      'name' => @name,
      'map' => @map,
      'password' => @password,
      'num_players' => @num_players,
      'max_players' => @max_players,
      'players' => @players,
      'bots' => @bots,
      'connect' => @connect,
      'ping' => @ping,
      'query_port' => @query_port,
      'version' => @version,
      'raw' => @raw
    }
  end

  def to_json
    to_h.to_json
  end
end

Instance Method Details

#to_h ⇒ Hash{String=>Object}

Convenience: turn back into plain Hash.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/game_dig/query_result.rb', line 50

def to_h
  {
    'name' => @name,
    'map' => @map,
    'password' => @password,
    'num_players' => @num_players,
    'max_players' => @max_players,
    'players' => @players,
    'bots' => @bots,
    'connect' => @connect,
    'ping' => @ping,
    'query_port' => @query_port,
    'version' => @version,
    'raw' => @raw
  }
end

#to_json ⇒ Object 



67
68
69
 
# File 'lib/game_dig/query_result.rb', line 67

def to_json
  to_h.to_json
end