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

*sni-client* clj

add-column clj

(add-column schema column-ns column-name column-type & options)

Creates a schema column object with a required schema map/object, column namespace, column name, and column type. Additional parameters can be provided as key/value pairs after the required arguments.

CloudAPI clj protocol

select-one-data clj

(select-one-data _ 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.

delete-data! clj

(delete-data! _ data-namespace data-schema id)

insert-data! clj

(insert-data! _ 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.

ping clj

(ping _)

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.

request clj

(request _ req)

upsert-data! clj

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

The same as insert-data! except it updates if the id field is present.

upsert-meta! clj

(upsert-meta! _ schema-list)

Similar to upsert-data! except for metadata.

update-data! clj

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

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

login clj

(login _ 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.

set-password! clj

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

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

select-meta clj

(select-meta _)

(select-meta _ meta-namespace)

(select-meta _ meta-namespace meta-name)

select-data clj

(select-data _ 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.

COLUMN_DEFAULTS clj

config->session clj

(config->session config)

Takes a configuration map and returns a logged in session.

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.

full-url clj

(full-url endpoint session)

Creates a full url using the non-hostnamed endpoint and the current session to determine a fully qualified URI that can be used for REST requests..

include-auth clj

(include-auth request session)

Takes a request and a session and adds the JWT auth token iff the session is logged in and the request isn't explicitly excluding auth.

include-json clj

(include-json request)

Takes a http request and converts the body into JSON with the appropriate content type if the json? key has a truthy value or if the body is a collection.

make-cloud-response clj

(make-cloud-response {:keys [body error status] :as resp})

Parses the cloud response to ensure that it's valid, then extracts the parsed JSON body and attaches the HTTP response to it as metadata.

make-schema clj

(make-schema schema-ns schema-name & options)

Creates a schema object with a required namespace and name plus any additional options provided as key/value pairs.

make-sni-client clj

(make-sni-client)

Creates a HTTP-Kit client using a special SSL engine to handle SNI.

process-json clj

(process-json response)

Takes a ring response and checks to see if it contains a JSON string that can be parsed and parses it if it does.

retry-codes clj

SCHEMA_DEFAULTS clj

sni-configure clj

(sni-configure ssl-engine uri)

Configures HTTP-Kit's SSL engine to handle SNI (Server Name Indication).