Module: WebhookSystem::Encoder

Defined in:
lib/webhook_system/encoder.rb

Overview

Class in charge of encoding and decoding encrypted payload

Class Method Summary collapse

Class Method Details

.decode(secret_string, payload_string, headers = {}) ⇒ Object

Given a secret string, and an encrypted payload, unwrap it, bas64 decode it decrypt it, and JSON decode it

Parameters:

  • secret_string (String) —

    some secret string

  • payload_string (String) —

    String as returned from #encode

Returns:

  • (Object) —

    return the JSON decode of the encrypted payload



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/webhook_system/encoder.rb', line 24

def self.decode(secret_string, payload_string, headers = {})
  signature = headers['X-Hub-Signature']
  format = format_for_content_type(headers.fetch('Content-Type'))

  payload_signature = hub_signature(payload_string, secret_string)
  if signature && signature != payload_signature
    raise DecodingError, 'signature mismatch'
  end

  Payload.decode(payload_string, secret: secret_string, format: format)
end

.encode(secret_string, payload, format:) ⇒ String

Given a secret string, encode the passed payload to json encrypt it, base64 encode that, and wrap it in its own json wrapper

Parameters:

  • secret_string (String) —

    some secret string

  • payload (Object#to_json) —

    Any object that responds to to_json

Returns:

  • (String) —

    The encoded string payload (its a JSON string)



11
12
13
14
15
16
 
# File 'lib/webhook_system/encoder.rb', line 11

def self.encode(secret_string, payload, format:)
  response_hash = Payload.encode(payload, secret: secret_string, format: format)
  payload_string = JSON.generate(response_hash)
  signature = hub_signature(payload_string, secret_string)
  [payload_string, { 'X-Hub-Signature' => signature, 'Content-Type' => content_type_for_format(format) }]
end