Class: Comet::RatelimitOptions

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ RatelimitOptions

Returns a new instance of RatelimitOptions.



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

def initialize
  clear
end

Instance Attribute Details

#rules ⇒ Object

Returns the value of attribute rules.



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

def rules
  @rules
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

Instance Method Details

#clear ⇒ Object 



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

def clear
  @rules = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/comet/models/ratelimit_options.rb', line 38

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 'Rules'
      if v.nil?
        @rules = []
      else
        @rules = Array.new(v.length)
        v.each_with_index do |v1, i1|
          @rules[i1] = Comet::RatelimitRule.new
          @rules[i1].from_hash(v1)
        end
      end
    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) 


31
32
33
34
35
 
# File 'lib/comet/models/ratelimit_options.rb', line 31

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



72
73
74
 
# File 'lib/comet/models/ratelimit_options.rb', line 72

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



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/comet/models/ratelimit_options.rb', line 60

def to_hash
  ret = {}
  unless @rules.nil?
    ret['Rules'] = @rules
  end
  @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



77
78
79
 
# File 'lib/comet/models/ratelimit_options.rb', line 77

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