rakuna-core

The tiny heart of Rakuna.

Description

rakuna-core is (as the name implies) the core of Rakuna. It provides a number of classes and mixins for Webmachine-powered projects. The intent of these is to simplify development, reduce boilerplate code, and support the composition of interesting systems from simple concepts.

Installation

gem install rakuna-core

Usage

require 'rakuna/core'

Deviations from Webmachine

Mixins

Rakuna::Accepts::Input

Rakuna::Provides::Output

Rakuna::Provides::Text

Rakuna::Provides::HTML

Classes

Rakuna::Resource::Basic

The foundation on which we compose more interesting things, responding to the following methods: * HEAD * GET

Includes

Rakuna::Resource::Action

Action Resources perform tasks. They respond only to POST, and return no content, only status. * POST: Executes the action

Includes

Rakuna::Resource::Item

Item Resources represent specific resources, and respond to the following methods: * HEAD: Does the item exist? * GET: Fetch the item * PUT: Replace the item * DELETE: Delete the resource

Includes

Rakuna::Resource::Collection

Collection Resources contain multiple resources, and respond to the following methods: * HEAD: Does the collection exist? * GET: Fetch the collection * POST: Add to the collection

Includes

Contributing to rakuna-core

License

MIT

Contributors