grimoire.api.web.read — org.clojure-grimoire/lib-grimoire 0.10.10

This namespace implements the reading and listing parts of the Grimoire API using the Grimoire webservice as its backend.

Writing to this datastore is not supported yet™. list-classes is not supported yet™. list-defs lists all defs, not just defs of a type.

To use this backend, you will need to load this namespace, and then invoke the API with a configuration as constructed by grimoire.web/->Config.

Note that the host need not be conj.io, but must host a Grimoire 0.4 or later instance providing the v2 API. The host string should include a http or https protocol specifier as appropriate and should not end in a /.

do-data-req clj

(do-data-req config thing op)

λ [Cfg → Thing → Op] → Either[Success[t], Failure[String]]

Forges and executes a data request agains the Grimoire web API as specified by the various arguments. Returns the entire result of the Grimoire request unaltered and wrapped in Either.

do-thing-req clj

(do-thing-req config op ctor parent)

λ [Cfg → Op → (λ [p → String] → c) → p ⊆ Thing] → Either[Success[Seq[c]], Failure[String]]

Helper, does a data request against the Grimoire web API as specified by the config and op, running the request results through the constructor to yield a seq of Things as constructed from the pair (parent, (:name result)).

grim-result clj

(grim-result result)

λ [t] → y

Helper, destructures out the body of a Grimoire web result.

grim-succeed? clj

(grim-succeed? result)

λ [t] → Bool

Helper, indicates whether a Grimoire web result succeeded or failed.