Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexocode/etag_plug
A simple to use shallow ETag plug
https://github.com/alexocode/etag_plug
drop-in elixir etag hacktoberfest plug
Last synced: about 1 month ago
JSON representation
A simple to use shallow ETag plug
- Host: GitHub
- URL: https://github.com/alexocode/etag_plug
- Owner: alexocode
- License: mit
- Created: 2018-10-26T09:59:17.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-16T14:44:10.000Z (8 months ago)
- Last Synced: 2024-05-21T19:17:32.566Z (7 months ago)
- Topics: drop-in, elixir, etag, hacktoberfest, plug
- Language: Elixir
- Homepage:
- Size: 75.2 KB
- Stars: 22
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - A simple to use shallow ETag plug. (HTTP)
- fucking-awesome-elixir - etag_plug - A simple to use shallow ETag plug. (HTTP)
- awesome-elixir - etag_plug - A simple to use shallow ETag plug. (HTTP)
README
# ETagPlug
[](https://circleci.com/gh/alexocode/etag_plug)
[](https://coveralls.io/github/alexocode/etag_plug?branch=master)
[](https://hex.pm/packages/etag_plug/)
[](https://github.com/alexocode/etag_plug/blob/master/LICENSE.md)
This plug generates shallow [ETags](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag).
Shallow means that it uses the whole response to generate the ETag and does not care about the specific content of each response. It is not context sensitive. For a deep (speak context sensitive) generation of ETags you can take a look at [Phoenix ETag](https://github.com/michalmuskala/phoenix_etag).
**NOTE**:
While this plug may seem stale, it's just stable.
There is nothing else to do, it "just works".
As such don't be afraid to use it in production. 🙂
## Installation
The plug can be installed by adding `etag_plug` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:etag_plug, "~> 1.0"}
]
end
```
Documentation can be found at: [https://hexdocs.pm/etag_plug](https://hexdocs.pm/etag_plug)
# Usage
You can simply use the plug without any configuration, it then defaults to the configuration as specified in the "Configuration" section.
```elixir
plug ETag.Plug
```
You can also provide a number of options, see the "Configuration" section for details.
```elixir
plug ETag.Plug,
generator: MyCustomGenerator,
methods: ["GET", "HEAD"],
status_codes: [:ok, 201, :not_modified]
```
## Configuration
A full configuration equal to the defaults could look like this:
```elixir
config :etag_plug,
generator: ETag.Generator.SHA1,
methods: ["GET"],
status_codes: [200]
```
Each of these options is explained in detail below.
### `generator`
Expects a module implementing the `ETag.Generator` behaviour. The plug ships with a number of "default" generators:
- `ETag.Generator.MD5`
- `ETag.Generator.SHA1`
- `ETag.Generator.SHA512`
__Default__: `Application.get_env(:etag_plug, :generator, ETag.Generator.SHA1)`
### `methods`
Expects a list of strings, describing the HTTP methods for which ETags should be generated and evaluated.
__Default__: `Application.get_env(:etag_plug, :methods, ["GET"])`
### `status_codes`
Expects an enumerable of integers (or status atoms) which define the statuses for which ETags should be handled and generated.
__Default__: `Application.get_env(:etag_plug, :status_codes, [200])`