https://github.com/remi/plug_best

PlugBest parses HTTP “Accept-*” headers and returns the best match based on a list of values.
https://github.com/remi/plug_best

elixir http language localization plug

Last synced: 27 days ago
JSON representation

PlugBest parses HTTP “Accept-*” headers and returns the best match based on a list of values.

• Host: GitHub
• URL: https://github.com/remi/plug_best
• Owner: remi
• License: mit
• Created: 2016-05-25T13:03:07.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-08-23T09:45:09.000Z (about 3 years ago)
• Last Synced: 2024-04-16T17:35:37.169Z (7 months ago)
• Topics: elixir, http, language, localization, plug
• Language: Elixir
• Homepage: https://hex.pm/packages/plug_best
• Size: 58.6 KB
• Stars: 12
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# PlugBest





`PlugBest` parses HTTP `Accept-*` headers and returns the best match based on a list of values.

## Installation

Add `plug_best` to the `deps` function in your project's `mix.exs` file:

```elixir

defp deps do

  [

    …,

    {:plug_best, "~> 0.3"}

  ]

end

```

Then run `mix do deps.get, deps.compile` inside your project's directory.

## Usage

`PlugBest` currently provides eight methods:

- `best_language/2`

- `best_language_or_first/2`

- `best_charset/2`

- `best_charset_or_first/2`

- `best_encoding/2`

- `best_encoding_or_first/2`

- `best_type/2`

- `best_type_or_first/2`

To find out which language is the best one to use among a list of supported languages:

```elixir

conn |> Plug.Conn.get_req_header("accept-language")

# => ["fr-CA,fr;q=0.8,en;q=0.6,en-US;q=0.4"]

conn |> PlugBest.best_language(["en", "fr"])

# => {"fr-CA", "fr", 1.0}

```

If no values in the header is support, `PlugBest` will return the first `nil`. However,

you can use the `_or_first` suffix to make it return the first value in those cases.

```elixir

conn |> Plug.Conn.get_req_header("accept-language")

# => ["fr-CA,fr;q=0.8,en;q=0.6,en-US;q=0.4"]

conn |> PlugBest.best_language(["es", "ru"])

# => nil

conn |> PlugBest.best_language_or_first(["es", "ru"])

# => {"es", "es", 0.0}

```

## License

`PlugBest` is © 2016-2017 [Rémi Prévost](http://exomel.com) and may be

freely distributed under the [MIT license](https://github.com/remiprev/plug_best/blob/master/LICENSE.md). See the

`LICENSE.md` file for more information.