Skip to content

Latest commit

 

History

History
437 lines (348 loc) · 8.58 KB

validation.md

File metadata and controls

437 lines (348 loc) · 8.58 KB

Validation

back

Table of Contents

Basolato has it's own validation function. It recieves request and check request params.
There are two validation type. One is used in controller that recieve request and return errors array. Another is more simple. Recieve value and return bool.

Simple Validation

import basolato/validation

Available Rules

email

echo Validation().email("[email protected]")
>> true

echo Validation().email("sample@example")
>> false

domain

echo Validation().domain("example.com")
>> true

echo Validation().domain("example")
>> false

strictEmail

echo Validation().strictEmail("[email protected]")
>> true

echo Validation().strictEmail("sample@example")
>> false

equals

echo Validation().equals("a", "a")
>> true

echo Validation().equals(1, 2)
>> false

gratorThan

echo Validation().gratorThan(1.2, 1.1)
>> true

echo Validation().gratorThan(3, 2)
>> false

inRange

echo Validation().inRange(2, 1, 3)
>> true

echo Validation().gratorThan(1.5, 1, 1.4)
>> false

ip

echo Validation().ip("12.0.0.1")
>> true

echo Validation().ip("255.255.255.256")
>> false

lessThan

echo Validation().lessThan(1.1, 1.2)
>> true

echo Validation().lessThan(3, 2)
>> false

numeric

echo Validation().numeric("1")
>> true

echo Validation().numeric("a")
>> false

password

echo Validation().password("Password1")
>> true

echo Validation().password("pass")
>> false

Request Validation

import basolato/request_validation

sample

Controller

import json

type SignUpController = ref object
  request:Request
  auth: Auth

proc newSignUpController*(request:Request): SignUpController =
  return SignUpController(
    request: request,
    auth: initAuth(request)
  )

proc store*(this:SignUpController): Response =
  let name = this.request.params["name"]
  let email = this.request.params["email"]
  let password = this.request.params["password"]
  # validation
  var v = this.request.validate()
  v.required(["name", "email", "password"])
  v.email("email")
  v.unique("email", "users", "email")
  v.password("password")
  if v.errors.len > 0:
    return render(createHtml(this.auth, name, email, v.errors))

View

import json

proc createHtmlImpl(name:string, email:string, errors:JsonNode): string = tmpli html"""
  <form method="post">
    $(csrfToken())
    <div>
      <p>name</p>
      $if errors.hasKey("name") {
        <ul>
          $for error in errors["name"] {
            <li>$error</li>
          }
        </ul>
      }
      <p><input type="text" value="$name" name="name"></p>
    </div>
    .
    .
    .

Custom Validation

You can also create your own validation middleware. It should recieve RequestValidation object and return it.
putValidate() proc is useful to create/add error in RequestValidation object.

middleware/custom_validate_middleware.nim

import json, tables
import bcrypt
import allographer/query_builder
import basolato/request_validation

proc checkPassword*(this:RequestValidation, key:string): RequestValidation =
  let password = this.params["password"]
  let response = RDB().table("users")
                  .select("password")
                  .where("email", "=", this.params["email"])
                  .first()
  let dbPass = if response.kind != JNull: response["password"].getStr else: ""
  let hash = dbPass.substr(0, 28)
  let hashed = hash(password, hash)
  let isMatch = compare(hashed, dbPass)
  if not isMatch:
    this.putValidate(key, "password is not match")
  return this

Available Rules

accepted

This will add errors if not checked in checkbox. Default checked value is on and if you want overwrite it, set in arg.

<input type="checkbox" name="sample">
>> If it checked, it return {"sample", "on"}

<input type="checkbox" name="sample2" value="checked">
>> If it checked, it return {"sample2", "checked"}
var v = validate(request)
v.accepted("sample")
v.accepted("sample2", "checked")

contains

This will add errors if value in request doesn't contain a expected string.

{"email": "[email protected]"}
var v = validate(request)
v.contains("email", "user")

email, strictEmail

This will add errors if value is not match a style of email address.
strictEmail supports RFC5321 and RFC5322 completely. References this Python code https://gist.github.com/frodo821/681869a36148b5214632166e0ad293a9

Original articles メイルアドレス正規表現ふたたび
正規表現でのメールアドレスチェックは見直すべき – ReDoS

{"address": "[email protected]"}
var v = validate(request)
v.email("address")
v.strictEmail("address")

equals

This will add errors if value is not same against expectd string.

{"name": "John"}
var v = validate(request)
v.equals("name", "John")

exists

This will add errors if key is not exist in request params.

{"name": "John", "email": "[email protected]"}
var v = validate(request)
v.exists("name")

gratorThan

This will add errors if value is not grater/larger than expected value.

{"age": "25"}
var v = validate(request)
v.gratorThan("age", 26)

inRange

This will add errors if value is not in rage of expected value.

{"age": "25"}
var v = validate(request)
v.inRange("age", min=20, max=60)

ip

This will add errors if value is not match a style of IP address.

{"ip_address": "127.0.0.1"}
var v = validate(request)
v.ip("ip_address")

isIn

This will add errors if value is not match for one of expected values.

{"name": "John"}
var v = validate(request)
v.isIn("name", ["John", "Paul", "George", "Ringo"])

lessThan

This will add errors if value is not less/smaller than expected value.

{"age": "25"}
var v = validate(request)
v.gratorThan("age", 24)

numeric

This will add errors if value is not number.

{"num": 36.2}
var v = validate(request)
v.numeric("num")

oneOf

This will add errors if one of expected keys is not present in request.

{"name": "John", "email": "[email protected]"}
var v = validate(request)
v.oneOf(["name", "birth_date", "job"])

password

This will add errors if value is not match a style of password.
It needs at least 8 chars, one upper and lower letter, symbol(ex: @-_?!) is available.

{"pass": "Password1!"}
var v = validate(request)
v.password("pass")

required

This will add errors if all of expected keys is not present in request.

{"name": "John", "email": "[email protected]"}
var v = validate(request)
v.required(["name", "email"])

unique

This will add errors if expected value is not unique in database.

table: users

id name email
1 user1 [email protected]
2 user2 [email protected]
3 user3 [email protected]
4 user4 [email protected] 
{"mail": "[email protected]"}
var v = validate(request)
v.unique("mail", "users", "email")
arg position example content
1 "mail" response params key
2 "users" RDB table name
3 "email" RDB column name