sweet-tooth.endpoint.liberator — sweet-tooth/endpoint 0.10.10

Includes:

• Utility functions for retrieving common values from the context (record, errrors, params)
• A template of decision defaults appropriate for an SPA
• Utility functions for auth

Introduces loose convention of putting a record under :record in the context

Extends liberator's representations to handle transit

->ctx clj

(->ctx x k)

Make it easy to thread data into liberator context

assoc-in-params clj

(assoc-in-params ctx path v)

assoc-param clj

(assoc-param ctx k v)

assoc-params clj

(assoc-params ctx params)

assoc-user clj

(assoc-user ctx user-key)

auth clj

auth-id clj

(auth-id {:keys [auth-id-key] :as ctx})

Retrieve the ID of authenticated user. Assumes :auth-id-key is in the ctx

auth-with clj

(auth-with & fns)

If any auth function authenticates the context, return true. Used to e.g. auth by ownership or adminship

authenticated? clj

(authenticated? ctx)

To use with liberator's :authorized? decision

authentication-error clj

authorization-error clj

ctx-id clj

(ctx-id ctx & [id-key])

Get id from the params

decision-defaults clj

A base set of liberator resource decisions

error-response clj

(error-response status errors)

For cases where the error happens before the request gets to liberator

errors clj

errors-map clj

(errors-map errors)

Add errors to context, setting media-type in case liberator doesn't get to that decision

exists-fn clj

(exists-fn ent-fn)

Given a function to retrieve a record, store it under :record in the context if it exists

get-ctx clj

(get-ctx path)

html-resource clj

(html-resource path)

Serve resource at path as html

initialize-decisions clj

(initialize-decisions decisions context-initializer)

Adds :initalize to multiple decisions. Used by sweet-tooth.endpoint.module.liberator-reitit-router to inject context values set in routes.

params clj

raw clj

(raw response)

record clj

req-id-key clj

(req-id-key ctx & [id-key])

segment-response clj

(segment-response data ctx)

transit-response clj

(transit-response payload & [opts])

TransitResponse clj

update-params clj

(update-params ctx f & args)

validate-describe clj

(validate-describe rules & [describe-context])

Use describe lib to validate a request. Returns a function that's meant to be used with the :malformed? liberator decision

validator clj macro

(validator validation)

(validator ctx-sym validation)

Used in invalid? which is why truth values are reversed