class ShopifyAPI::Webhooks::Request

Public Class Methods

new(raw_body:, headers:) click to toggle source
# File lib/shopify_api/webhooks/request.rb, line 46
def initialize(raw_body:, headers:)
  # normalize the headers by forcing lowercase, removing any prepended "http"s, and changing underscores to dashes
  headers = headers.to_h { |k, v| [k.to_s.downcase.sub("http_", "").gsub("_", "-"), v] }

  missing_headers = []
  [
    "x-shopify-topic",
    "x-shopify-hmac-sha256",
    "x-shopify-shop-domain",
  ].each { |header| missing_headers << header unless headers.include?(header) }
  unless missing_headers.empty?
    raise Errors::InvalidWebhookError,
      "Missing one or more of the required HTTP headers to process webhooks: #{missing_headers}"
  end

  @headers = headers
  @raw_body = raw_body
end

Public Instance Methods

api_version() click to toggle source
# File lib/shopify_api/webhooks/request.rb, line 26
def api_version
  T.cast(@headers["x-shopify-api-version"], String)
end
hmac() click to toggle source
# File lib/shopify_api/webhooks/request.rb, line 11
def hmac
  Digest.hexencode(Base64.decode64(T.cast(@headers["x-shopify-hmac-sha256"], String)))
end
parsed_body() click to toggle source
# File lib/shopify_api/webhooks/request.rb, line 41
def parsed_body
  JSON.parse(@raw_body)
end
shop() click to toggle source
# File lib/shopify_api/webhooks/request.rb, line 21
def shop
  T.cast(@headers["x-shopify-shop-domain"], String)
end
to_signable_string() click to toggle source
# File lib/shopify_api/webhooks/request.rb, line 36
def to_signable_string
  @raw_body
end
topic() click to toggle source
# File lib/shopify_api/webhooks/request.rb, line 16
def topic
  T.cast(@headers["x-shopify-topic"], String)
end
webhook_id() click to toggle source
# File lib/shopify_api/webhooks/request.rb, line 31
def webhook_id
  T.cast(@headers["x-shopify-webhook-id"], String)
end