Module: Legion::Webhooks

Extended by:
Logging::Helper
Defined in:
lib/legion/webhooks.rb

Constant Summary collapse

DISPATCH_CACHE_TTL = 
5

Class Method Summary collapse

Class Method Details

.compute_signature(secret, body) ⇒ Object 



93
94
95
 
# File 'lib/legion/webhooks.rb', line 93

def compute_signature(secret, body)
  OpenSSL::HMAC.hexdigest('SHA256', secret, body)
end

.deliver(webhook, event_name, payload, attempt: 1) ⇒ Object 



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/legion/webhooks.rb', line 58

def deliver(webhook, event_name, payload, attempt: 1)
  log.info "[Webhooks] delivery attempt #{attempt} for event=#{event_name} url=#{webhook[:url]}"
  body = delivery_body(event_name, payload)
  signature = compute_signature(webhook[:secret], body)

  response = perform_delivery_request(webhook[:url], event_name, body, signature)
  success = response.code.to_i < 400

  if success
    log.info "[Webhooks] delivered event=#{event_name} status=#{response.code}"
  else
    log.warn "[Webhooks] delivery failed event=#{event_name} status=#{response.code} url=#{webhook[:url]}"
  end

  handle_delivery_response(
    webhook:    webhook,
    event_name: event_name,
    payload:    payload,
    response:   response,
    success:    success,
    attempt:    attempt
  )
rescue StandardError => e
  handle_exception(
    e,
    level:      :error,
    operation:  'webhooks.deliver',
    event_name: event_name,
    webhook_id: webhook[:id],
    attempt:    attempt,
    url:        webhook[:url]
  )
  handle_delivery_exception(webhook, event_name, payload, attempt, e)
end

.dispatch(event_name, payload) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/legion/webhooks.rb', line 45

def dispatch(event_name, payload)
  return unless db_available?

  webhooks = active_dispatch_webhooks
  webhooks.each do |wh|
    patterns = event_patterns_for(wh, event_name: event_name)
    next unless patterns.any? { |p| File.fnmatch?(p, event_name) }

    log.debug { "[Webhooks] dispatching event=#{event_name} webhook_id=#{wh[:id]} patterns=#{patterns.size}" }
    deliver(wh, event_name, payload)
  end
end

.list ⇒ Object 



39
40
41
42
43
 
# File 'lib/legion/webhooks.rb', line 39

def list(**)
  return [] unless db_available?

  Legion::Data.connection[:webhooks].where(status: 'active').all
end

.register(url:, secret:, event_types: ['*'], max_retries: 5) ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/legion/webhooks.rb', line 15

def register(url:, secret:, event_types: ['*'], max_retries: 5, **)
  return { error: 'data_unavailable' } unless db_available?

  id = Legion::Data.connection[:webhooks].insert(
    url:         url,
    secret:      secret,
    event_types: Legion::JSON.dump(event_types),
    max_retries: max_retries,
    status:      'active',
    created_at:  Time.now.utc,
    updated_at:  Time.now.utc
  )
  invalidate_dispatch_cache!
  { registered: true, id: id }
end

.unregister(id:) ⇒ Object 



31
32
33
34
35
36
37
 
# File 'lib/legion/webhooks.rb', line 31

def unregister(id:, **)
  return { error: 'data_unavailable' } unless db_available?

  Legion::Data.connection[:webhooks].where(id: id).delete
  invalidate_dispatch_cache!
  { unregistered: true }
end