calcinator v1.0.0 Calcinator.Resources behaviour

A module that exposes Ecto schema structs

Summary

Types

filter()

Invoke name filter with value

id()

ID that uniquely identifies the struct

pagination()

Pagination information returned from the backing store

params()

query_options()

:associations - associations to load in the struct
:filters - filters on the result
:page - the page used for pagination. nil implies no pagination, not default pagination.
:sorts - the directions to sort fields on the primary resource or its associations

sandbox_access_token()

t()

A module that implements the Resources behaviour

Callbacks

allow_sandbox_access(sandbox_access_token)

Allows access to sandbox for testing

changeset(params)

Changeset for creating a struct from the params

changeset(arg0, params)

Changeset for updating struct with params

delete(struct)

Deletes a single struct

get(id, query_options)

Gets a single struct

insert(params, query_options)

Inserts params into a single new struct

list(query_options)

Gets a list of structs

sandboxed?()

Returns

update(arg0, query_options)

Applies updates in changeset

update(arg0, params, query_options)

Updates struct

Types

filter()

filter() :: %{optional(name :: String.t) => value :: term}

Invoke name filter with value.

id()

id() :: term

ID that uniquely identifies the struct

pagination()

pagination() :: map

Pagination information returned from the backing store.

params()

params() :: map

query_options()

query_options() :: %{optional(:associations) => atom | [atom], optional(:filters) => [filter], optional(:page) => Resources.Page.t | nil, optional(:sorts) => Sorts.t}

:associations - associations to load in the struct
:filters - filters on the result
:page - the page used for pagination. nil implies no pagination, not default pagination.
:sorts - the directions to sort fields on the primary resource or its associations

sandbox_access_token()

sandbox_access_token() :: %{:owner => term, optional(atom) => any}

t()

t() :: module

A module that implements the Resources behaviour

Callbacks

allow_sandbox_access(sandbox_access_token)

allow_sandbox_access(sandbox_access_token) ::
  :ok |
  {:already, :owner | :allowed} |
  :not_found

Allows access to sandbox for testing

changeset(params)

changeset(params) :: Ecto.Changeset.t

Changeset for creating a struct from the params

changeset(arg0, params)

changeset(Ecto.Schema.t, params) :: Ecto.Changeset.t

Changeset for updating struct with params

delete(struct)

delete(struct) :: {:ok, struct} | {:error, Ecto.Changeset.t}

Deletes a single struct

Returns

{:ok, struct} - the delete succeeded and the returned struct is the state before delete
{:error, Ecto.Changeset.t} - errors while deleting the struct. Ecto.Changeset.t errors contains errors.

get(id, query_options)

get(id, query_options) ::
  {:ok, struct} |
  {:error, :not_found} |
  {:error, :timeout} |
  {:error, reason :: term}

Gets a single struct

Returns

{:ok, struct} - id was found.
{:error, :not_found} - id was not found.
{:error, :timeout} - timeout occured while getting id from backing store .
{:error, reason} - an error occurred with the backing store for reason that is backing store specific.

insert(params, query_options)

insert(params, query_options) ::
  {:ok, struct} |
  {:error, Ecto.Changeset.t}

insert(Ecto.Changeset.t, query_options) ::
  {:ok, struct} |
  {:error, Ecto.Changeset.t}

Inserts params into a single new struct

Returns

{:ok, struct} - params were inserted into struct
{:error, Ecto.Changeset.t} - insert failed. Ecto.Changeset.t errors contain errors.

list(query_options)

list(query_options) ::
  {:ok, [struct], pagination | nil} |
  {:error, :timeout} |
  {:error, reason :: term}

Gets a list of structs.

Returns

{:ok, [resource], nil} - all resources matching query
{:ok, [resource], pagination} - page of resources matching query
{:error, :timeout} - timeout occured while getting resources from backing store .
{:error, reason} - an error occurred with the backing store for reason that is backing store specific.

sandboxed?()

sandboxed?() :: boolean

Returns

true - if allow_sandbox_access/1 should be called before any of the query methods are called
false - otherwise

update(arg0, query_options)

update(Ecto.Changeset.t, query_options) ::
  {:ok, struct} |
  {:error, Ecto.Changeset.t}

Applies updates in changeset

Returns

{:ok, struct} - the update succeeded and the returned struct contains the updates
{error, Ecto.Changeset.t} - errors while updating struct with params. Ecto.Changeset.t errors contains errors.

update(arg0, params, query_options)

update(Ecto.Schema.t, params, query_options) ::
  {:ok, struct} |
  {:error, Ecto.Changeset.t} |
  {:error, :bad_gateway} |
  {:error, :not_found}

Updates struct

Returns

{:ok, struct} - the update succeeded and the returned struct contains the updates
{:error, Ecto.Changeset.t} - errors while updating struct with params. Ecto.Changeset.t errors contains errors.
{:error, :bad_gateway} - error in backing store that cannot be represented as another type of error
{:error, :not_found} - the resource in the changeset was not found and so cannot be updated. This may mean that the resource was deleted with delete/1 after the get/2 or list/1 returned.