ambition

---

Description:

Content:

Namespaces:

• Ambition -

Classes:

• TemplateCompiler - Functionality to compile Ambition templates into .vala source files. Used by the ambition binary.
• Dispatcher - Core entry point of an Ambition application, providing methods to dispatch a request from a web endpoint to a method or series of methods.
• App - Static methods for keeping global application state.
• Actions - Base class for the auto-generated Actions class, derived from the application's actions.conf.
• Action - Action definition.
• Response - Represents the HTTP response after a request. This is generated by the Ambition engine and passed to a given controller and action.
• Cookie - Represents an HTTP cookie.
• State - Represent the state of the current request, including request, response, session, authorization.
• ActionMethod - Wraps an ActionMethodCall.
• Result - Represents the result of a controller action.
• Component - Base class for each dispatcher- dependent Ambition component.
• Request - Represents the HTTP request. This is generated by the Ambition engine and passed to a given controller and action.
• Config - Singleton class representing the application configuration.
• ConfigInstance -
• Stash - Stash or cache of data that lasts for the life of a request. This is helpful when preparing values during a "begin" or while transferring data between methods.
• Application - Base class for an Application.
• ActionBuilder - Parses action configuration to create an Actions generator.
• RequestFile -
• DispatcherUtils -

Enums:

• HttpMethod - Represents an HTTP method.

Error domains:

• TemplateCompileError - Represents an unrecoverable error during a template compilation.
• ActionBuilderError - Represents an unrecoverable error during action parsing.

Constants:

• public const double VERSION_DOUBLE
• public const unowned string VERSION

Delegates:

• public delegate Result ActionMethodCall (State state)
  Delegate method for a controller method.

Methods:

• public string arraylist_joinv (string separator, ArrayList<string> list)
  This needs to be somewhere else. to_array() combined with joinv is a recipe for segfaults, so this is a layer of protection until I figure out what might be wrong.
• Authorization -

Interfaces:

• IUser - Interface for building a user object from a given authorizer.
• IPasswordType - Interface for building a PasswordType.
• IAuthorizer - Interface for building an authenticator.

Classes:

• Builder - Build authenticators.
• Authorize - Provides authorization functions to a state object.
• Authorizer -

Classes:

• Htpasswd - Authorize users using a standard Apache htpasswd file.
• Flat - Authorize users using a flat file.
• Almanna - Authorize users using an Almanna entity. Requires additional config to work: * entity_type: mapping to the string representation of the GLib type of the entity. Example: ExampleApp.Model.DB.User would be ExampleAppModelDBUser. Optional config: * password_type: Type of password obfuscation/hashing in place. Defaults to a SHA1 PasswordType, but can be changed with password_type and that password type's associated configuration. * id_field: Defaults to first primary key property or "id" * username_field: Defaults to username * password_field: Defaults to password
• PasswordType -

Classes:

• MD5 - MD5 PasswordType, returning a 32 character hex string.
• SHA256 - SHA256 PasswordType, returning a 64 character hex string.
• SHA1 - SHA1 PasswordType, returning a 40 character hex string.
• Hashed - Hashed PasswordType base class, not to be used by itself.
• User -

Classes:

• Htpasswd - Represents a user in a htpasswd file.
• Flat - Represents a user in a flat file.
• Almanna - Represents a user in an Almanna entity.
• Controller -

Classes:

• Static - Generic controller to handle static files from a supplied "static" directory.
• CoreView -

Classes:

• JSON - Renders a JsonNode or serializes a GObject as Json.
• Redirect - Returns a redirect to the browser.
• None - Does nothing, assumes that response handling is done in the controller.
• File - Returns a file.
• Template - Returns a template.
• Couch -

Classes:

• Document - Base class for a Couch DB Database/Document type.

Methods:

• public Session get_couch_session ()
  Retrieve the currently active Couch session, or creates a session if one does not exist.
• Engine -

Classes:

• Test - Test engine, for use by unit tests.
• Base - Base class for an Engine implementation.
• Raw - Raw engine, implemented using sockets.
• SCGI - Threaded SCGI Engine implementation, requiring libgscgi.
• Form -

Interfaces:

• Tag -

Classes:

• HiddenInput - <input type="hidden" />
• RadioGroupInput - <input type= "radio" />
• TextInput - <input type="text" />
• Button - <button type="button" />
• CheckboxGroupInput - <input type= "checkbox" />
• Validator - Provides commonly-used validators for use in forms.
• PasswordInput - <input type="password" />
• ResetButton - <button type="reset" />
• GroupInput -
• FieldRenderer - Base class for a field renderer. Implements render() method.
• SubmitButton - <button type="submit" / >
• Textarea - <textarea /> If the nick is null, this will not render a default nick. Instead, it will add a textarea without a dl->dd/dt.
• SelectGroupInput - <select />
• FormDefinition - Representation of a HTML form, providing form validation, auto-fill, and rendering.
• TBCheckboxGroupInput - <input type="checkbox" />
• TBRadioGroupInput - <input type= "radio" />
• TBResetButton - <button type="reset" / >
• TBTextarea - <textarea />
• TBButton - <button type="button" />
• TBPasswordInput - <input type= "password" />
• TBSelectGroupInput - <select / >
• TBTextInput - <input type="text" />
• TBSubmitButton - <button type= "submit" />
• TBGroupInput -

Enums:

• ButtonType -
• Helper -

Classes:

• TextCaptcha - Helper to provide an interface to TextCaptcha http://textcaptcha.com

Error domains:

• TextCaptchaError -
• Logger - Logging functionality.

Classes:

• Unique -

Constants:

• public const int DEBUG
• public const int INFO
• public const int WARN
• public const int ERROR

Methods:

• public void debug (string message, ...)
• public void info (string message, ...)
• public void warn (string message, ...)
• public void error (string message, ...)
• Plugin -

Interfaces:

• IPluginService - Provides a plugin service.

Classes:

• PluginManifest - Container for a Plugin manifest.json file.
• LocalPluginService - Local plugin service.
• HttpPluginService - HTTP plugin service.
• PluginResult - Container for the result of a Plugin query.
• PluginSupport -

Interfaces:

• IPlugin - Interface for defining a new Ambition plugin.

Classes:

• PluginLoader - Load plugins from plugin directory.
• Session -

Interfaces:

• IStorable - Interface for any class implementing a session store. To use, subclass Object and then Storable, and implement store, retrieve, and set_config. While using the provided config is optional, the method is required to be implemented so other Storables can use it.
• AlmannaSession - Abstract session to store Session data via an Almanna entity. Consumers of this abstract class need to have a table with a session_id integer field and a session_data string field.

Classes:

• Interface - Represents session functionality on top of a session storage engine.
• SessionPlugin - Provides Session support to an Ambition application.
• StorableMemory - Implementation to store sessions in memory in the dumbest way possible. This thing will keep growing and growing, and is designed as a basic example or to test functionality without requiring an external dependency.
• StorableFile - Implementation to store sessions on the filesystem. Not the fastest thing in the world, but probably the easiest. Stores sessions in the system temporary directory by default, or reads "storable.file.path" from the application config.
• StorableAlmanna - Store sessions in an Almanna-managed datastore.
• SessionDocument -
• StorableCouch - Store sessions in an Couch datastore.
• Testing -

Classes:

• TestResponse - Response from a Helper.mock_request.
• Helper - Helper methods for testing an Ambition application.
• Utility -

Interfaces:

• IUtility - Interface for defining a new Ambition Shell plugin.

Classes:

• Run - Compile and run the current application. TODO: Ideally, this should wrap the existing engine type and be able to proxy the application inside. That way, if an error occurs, then the error can be output in dev mode, or captured and parsed in prod. This probably means that a compiled web application should be a library that can be dynamically loaded by Utility. oof.
• Clean - Clean the current application.
• ScaffoldManifest - Container for a scaffold manifest.json file.
• Monitor - Monitor an application for changes, build if it does.
• Scaffold - Scaffold a new application.
• Creator - Scaffold new controller/model/view/forms.
• UtilityLoader - Load utility plugins from directory.
• Plugin - Handle plugins for the current application.

Methods:

• public void ignore_signal (int signum)
• public string? get_application_name ()
  Get current application name.
• public string? wrap_string (string text, int indent = 4)
  Soft wrap a string at a given column.
• public void wrap (string text, int indent = 4)
  Soft wrap a string at a given column.
• public void alter_config (string config_key, string config_value)
  Alter a config key in the current application.
• public bool alter_cmakelists (ArrayList<string> lines)
  Alter a config key in the current application.

Classes:

• UserEntity -