Class: Comet::WebhookOption

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

Overview

HTTP POST event to the webhook URL when certain events happen.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WebhookOption

Returns a new instance of WebhookOption.



40
41
42
 
# File 'lib/comet/models/webhook_option.rb', line 40

def initialize
  clear
end

Instance Attribute Details

#custom_headers ⇒ Object

CustomHeaders allows specifying custom headers which are added to the outgoing POST request from Comet Server. Custom headers are specified as (header name, header value) pairs. If a custom header conflicts with a header required by HTTP or the Comet tracing ID header (‘x-Comet-Tracing-Id`), it will be ignored.



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

def custom_headers
  @custom_headers
end

#level ⇒ Object

One of the STREAM_LEVEL_ constants. This controls how much data is sent in the webhook event.



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

def level
  @level
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



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

def unknown_json_fields
  @unknown_json_fields
end

#url ⇒ Object

The target URL to POST the event data to



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

def url
  @url
end

#white_listed_event_types ⇒ Object

Configure a subset of allowed event types (see SEVT_ constants). If the array is empty, all events will be sent



35
36
37
 
# File 'lib/comet/models/webhook_option.rb', line 35

def white_listed_event_types
  @white_listed_event_types
end

Instance Method Details

#clear ⇒ Object 



44
45
46
47
48
49
50
 
# File 'lib/comet/models/webhook_option.rb', line 44

def clear
  @url = ''
  @custom_headers = {}
  @level = ''
  @white_listed_event_types = []
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


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
92
93
94
95
96
97
98
99
 
# File 'lib/comet/models/webhook_option.rb', line 60

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

      @url = v
    when 'CustomHeaders'
      @custom_headers = {}
      if v.nil?
        @custom_headers = {}
      else
        v.each do |k1, v1|
          raise TypeError, "'v1' expected String, got #{v1.class}" unless v1.is_a? String

          @custom_headers[k1] = v1
        end
      end
    when 'Level'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @level = v
    when 'WhiteListedEventTypes'
      if v.nil?
        @white_listed_event_types = []
      else
        @white_listed_event_types = Array.new(v.length)
        v.each_with_index do |v1, i1|
          raise TypeError, "'v1' expected Numeric, got #{v1.class}" unless v1.is_a? Numeric

          @white_listed_event_types[i1] = 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) 


53
54
55
56
57
 
# File 'lib/comet/models/webhook_option.rb', line 53

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



115
116
117
 
# File 'lib/comet/models/webhook_option.rb', line 115

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



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/comet/models/webhook_option.rb', line 102

def to_hash
  ret = {}
  ret['URL'] = @url
  ret['CustomHeaders'] = @custom_headers
  ret['Level'] = @level
  ret['WhiteListedEventTypes'] = @white_listed_event_types
  @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



120
121
122
 
# File 'lib/comet/models/webhook_option.rb', line 120

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