Pivo v0.1.0 Pivo.Resource behaviour View Source

Resource behaviour module.

Defines the behaviour and a generic implementation of the callbacks for a given resource.

This module is meant to be use'd in custom modules in order to support different resources of the Pivotal's Tracker API.

Example

defmodule Pivo.Resources.TimeZone do
  @enforce_keys [:olson_name, :offset, :kind]
  use Pivo.Resource
  defstruct @enforce_keys
end

t()

Builds the current resource struct from a map.

Builds a list of ids of the current resource from a list of maps.

Builds a list of ids of the current resource from a list of maps and an accessor function.

Builds a list of the current resource from a list of maps.

t() :: module()

build(arg :: map()) :: struct()

Builds the current resource struct from a map.

build_ids_list(args :: list()) :: [integer()]

Builds a list of ids of the current resource from a list of maps.

build_ids_list(args :: list(), accessor :: (... -> any())) :: [integer()]

Builds a list of ids of the current resource from a list of maps and an accessor function.

build_items_list(args :: list()) :: [struct()]

Builds a list of the current resource from a list of maps.