https://github.com/zbarnes757/jeaux

A module for validating http params and queries
https://github.com/zbarnes757/jeaux

Last synced: 3 months ago
JSON representation

A module for validating http params and queries

• Host: GitHub
• URL: https://github.com/zbarnes757/jeaux
• Owner: zbarnes757
• License: mit
• Created: 2016-08-10T22:33:17.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-03-03T19:09:17.000Z (almost 5 years ago)
• Last Synced: 2024-10-17T21:50:41.768Z (3 months ago)
• Language: Elixir
• Homepage: https://hex.pm/packages/jeaux
• Size: 25.4 KB
• Stars: 13
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - A light and easy schema validator. (Validations)
• fucking-awesome-elixir - jeaux - A light and easy schema validator. (Validations)
• awesome-elixir - jeaux - A light and easy schema validator. (Validations)

README

        
# Jeaux

[![Hex.pm](https://img.shields.io/hexpm/v/jeaux.svg)](https://hex.pm/packages/jeaux)

[![Build Status](https://travis-ci.org/zbarnes757/jeaux.svg?branch=master)](https://travis-ci.org/zbarnes757/jeaux)

Jeaux is a light and easy schema validator.

## Installation

[Available in Hex](https://hex.pm/packages/jeaux), the package can be installed as:

  1. Add `jeaux` to your list of dependencies in `mix.exs`:

    ```elixir

    def deps do

      [{:jeaux, "~> 0.7.0"}]

    end

    ```

Example:

```elixir

# web/controllers/my_controller.ex

@params_schema %{

  lat!: :float,

  lon!: :float,

  radius: [type: :integer, default: 100, min: 1, max: 100],

  is_point: :boolean,

  properties: %{

    name: :string

  }

}

def index(conn, params) do

    case Jeaux.validate(params, @params_schema) do

      {:ok, valid_params} -> do_your_thing(valid_params)

      {:error, message} -> Explode.bad_request(conn, message)

    end

end

```

Using a `!` in your key denotes it is required.

Currently, the following keys are valid:

* `type:` with `:integer`, `:string`, `:boolean`, `:guid` (`:string` type is implied), `:float`, or `:list` as applicable types

* `default:` Sets a default value if none is currently provided in params

* `min:` Minimum value a param can have

* `max:` Maximum value a param can have

* `valid:` Values that are valid options. Can be a single item or a list.

For `:list` types, if passed an array from a query string (a la `foo=1,2,3`), it will parse into a list (`['1', '2', '3']`). I am still working on finding a way to coerce these into the types they should be.

Params must be a map but the keys can be strings or atoms and in camelCase or snake_case. The keys of the object to be validated will be converted to snake_case prior to validation. Therefore the validation should use snake_case atoms.  Additionally, the result will always be returned as snake_case atom keys as well.

If you want to contribute, feel free to fork and open a pr.

Checkout [Explode](https://github.com/pkinney/explode) for an easy utility for responding with standard HTTP/JSON error payloads in Plug- and Phoenix-based applications.