Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dbernheisel/sanity_webhook_plug
Elixir Sanity Webhook Plug
https://github.com/dbernheisel/sanity_webhook_plug
Last synced: 4 months ago
JSON representation
Elixir Sanity Webhook Plug
- Host: GitHub
- URL: https://github.com/dbernheisel/sanity_webhook_plug
- Owner: dbernheisel
- License: apache-2.0
- Created: 2023-01-05T17:10:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-24T14:50:27.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T04:27:39.651Z (10 months ago)
- Language: Elixir
- Size: 126 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://hex.pm/packages/sanity_webhook_plug)
[](https://hexdocs.pm/sanity_webhook_plug)
[](./LICENSE)
# Sanity Webhook Plug
You're reading the main branch's readme. Please visit
[hexdocs](https://hexdocs.pm/sanity_webhook_plug) for the latest published documentation.
SanityWebhookPlug is a Plug that verifies Sanity webhooks for your Elixir Plug
application. Designed to work with [Sanity GROQ-powered
webhooks](https://www.sanity.io/docs/webhooks)
## Installation
```elixir
def deps do
[
{:sanity_webhook_plug, "~> 0.1.3"}
]
end
```
## Usage
Use this plug in your endpoint:
```elixir
# If using Plug or Phoenix, place before `plug Plug.Parsers`
# For Phoenix apps, in lib/my_app_web/endpoint.ex:
plug SanityWebhookPlug,
at: "/webhooks/sanity",
handler: MyAppWeb.SanityWebhookHandler
```
You may alternatively configure the secret in config, which will be read during
runtime:
```elixir
# in config/runtime.exs
config :sanity_webhook_plug,
webhook_secret: System.get_env("SANITY_WEBHOOK_SECRET")
```
Define a handler to handle webhooks:
```elixir
defmodule MyAppWeb.SanityWebhookHandler do
@behaviour SanityWebhookPlug.Handler
alias Plug.Conn
# see below for an example using Phoenix
@impl SanityWebhookPlug.Handler
def handle_event(conn, params) do
# Process and return the conn
conn
|> Conn.put_resp_header("content-type", "application/json")
|> Conn.send_resp(200, Jason.encode!(%{success: "yay!"}))
end
@impl SanityWebhookPlug.Handler
def handle_error(conn, error) do
# Process and return the conn
conn
|> Conn.put_resp_header("content-type", "application/json")
|> Conn.send_resp(500, Jason.encode!(%{error: "uh oh!"}))
end
end
```
### Options:
- `:at` (required): The request path to match against. eg, `"/webhooks/sanity"`
- `:handler` (required): The controller-like module that responds to
`handle_event/2` that is passed the conn and the params, and
`handle_error/2` that is passed the conn and the error. The error may be an
exception or a string.
- `:secret`: The Sanity webhook secret. eg: `123abc`. Supplying an MFA tuple will
be called at runtime, otherwise it will be compiled. If not set, it will
obtain via `Application.get_env(:sanity_webhook_plug, :webhook_secret)`.
If supplying an MFA or function reference, it must return `{:ok, my_secret}`
or a string.
- `:json_decoder`: JSON encoding library. When not supplied, it will use choose
Phoenix's configured library, `Jason`, or `Poison`. Sanity requires
JSON-encoded responses.
Options forwarded to `Plug.Conn.read_body/2`:
- `:length` - sets the number of bytes to read from the request at a time.
- `:read_length` - sets the amount of bytes to read at one time from the
underlying socket to fill the chunk.
- `:read_timeout` - sets the timeout for each socket read.
Verifying the signature requires reading the body, but its best to do this
before _interpreting_ the body into JSON or other parsed formats. Plug can
protect your system by limiting how much of body to read to prevent exhaustion.
Ideally, any of these settings you have for `Plug.Parsers` in your endpoint, you
should also have for SanityWebhookPlug.
The body and query params will be merged and given to your handler, which
matches Phoenix behavior.
### Example
An example using Phoenix
```elixir
## In lib/my_app_web/endpoint.ex
# place before Plug.Parsers
defmodule MyAppWeb.Endpoint do
use Phoenix.Endpoint, otp_app: :my_app
# ...
plug SanityWebhookPlug,
at: "/webhooks/sanity",
handler: MyAppWeb.SanityWebhookHandler
# Plug.Parsers down here somewhere
end
## in lib/my_app_web/controllers/sanity_webhook_handler.ex
def MyAppWeb.SanityWebhookHandler do
use MyAppWeb, :controller
require Logger
@behaviour SanityWebhookPlug.Handler
# handle known events
def handle_event(conn, %{"_type" => type, "_id" => id}) do
# do something
json(conn, %{success: "Did the thing!"})
end
def handle_event(conn, params) do
Logger.warn("SanityWebhook: unhandled webhook: #{inspect(params)}")
conn
|> put_status(500)
|> json(%{error: "unhandled webhook"})
end
def handle_error(conn, error) do
debug = SanityWebhookPlug.get_debug(conn)
Logger.error("SanityWebhook error: #{inspect(debug)}")
conn
|> put_status(400)
|> json(%{error: inspect(error)})
end
end
```