cloud-clj.api — com.motivislearning/cloud-clj 0.1.3

bulk-data! clj

(bulk-data! session payload)

CloudAPI clj protocol

request clj

(request _ req)

config->session clj

(config->session config)

Takes a configuration map and returns a logged in session.

delete-data! clj

(delete-data! session data-namespace data-schema data)

file->session clj

(file->session path)

Takes a string path, reads the edn file at that location, then returns a logged in session for that configuration.

get-file clj

(get-file session file-id)

Takes a session and a file(_version) UUID and fetches the file. Unlike a lot of the other functions, this one returns the raw HTTP response since the full response describes what happened since the payload is a file as opposed to JSON.

insert-data! clj

(insert-data! session data-namespace data-schema data)

Performs an insert for a new record in the Cloud API.

This function takes 4 arguments: session: Is the session record we're using to make the assertion. data-namespace: Is the namespace of the object we're asserting against. data-schema: Is the schema name for the object we're asserting against. data: Is the data for the record being asserted.

login clj

(login session instance username password)

This function takes the session, instance, username, and password and attempts to login. If the login is successful, a new session is returned containing authentication information for future requests. If an error occurs, an exception will be thrown.

ping clj

(ping session)

This function calls the 'ping' API. This would be used to check the health of the session or the host the session is connected to.

select-data clj

(select-data session data-namespace data-schema q)

This function selects data out of the Cloud API for the current session.

This function takes 4 parameters, the last one is optional. session: Is the session record we're using to query. data-namespace: Is the namespace of the records being queried. data-schema: Is the schema name of the records being queried. q: Is a map representing a query filter in the cloud API.

This function returns a vector of maps. The vector itself will contain metadata describing the actual HTTP response that contained the data and each map inside of the vector will describe the entire payload from the cloud and not just the 'data' attribute for the record.

select-meta clj

(select-meta session)

select-one-data clj

(select-one-data session data-namespace data-schema id)

This function selects a single record by id out of the cloud api.

This function takes 4 parameters, all of them are required. session: Is the session record we're using to query. data-namespace: Is the namespace of the records being queried. data-schema: Is the schema name of the records being queried. id: The id of the record that's being fetched.

This function returns a single map describing the record and is merely the JSON parsed response. This is similar to select-data but, with the expectation that only one object will be returned since we're getting it by id.

set-password! clj

(set-password! session instance username new-password)

This function resets the password of the currently logged in user.

su clj

(su session instance username)

This function is very similar to login except this one expects a logged in session with root or superuser access, an instance string, and a username. If access criteria are satisifed, a new session is created for that user.

update-data! clj

(update-data! session data-namespace data-schema data)

The same as insert-data! but, expects an id field to update against.

upload-file! clj

(upload-file! session
              file-ns
              file-name
              file
              {:keys [content-type storage-provider]})

Takes a session, namespace, file name, file and optional options and uploads it to the Cloud API to be stored.

The file can be anything that http-kit accepts as a body which includes but may not be limited to: java.io.File, Byte Array, InputStream, or a String.

upsert-data! clj

(upsert-data! session data-namespace data-schema data)

(upsert-data! session data-namespace data-schema data options)

The same as insert-data! except it updates if the id field is present with an additional fourth parameter which is provided as a query string.

upsert-meta! clj

(upsert-meta! session metadata-list)

Similar to upsert-data! except for metadata. The 2-tuple arity variant is the legacy implementation for backwards compatibility.