kristianmandrup / cantango-core

The core functionality of CanTango

CanTango Core

Core functionality for CanTango

Core should not have dependencies to any other CanTango components but should stand on its own. All other CanTango components can rely on core for "core" functionality :)

Status: Aug 2012

The core CanTango component is under development with specs: Current status:

71 examples, 22 failures

Please help out if you like the ideas behind this project ;)

Installation

CanTango has been tested to work with Ruby 1.9+ and currently doesn't support Ruby 1.8.7 If you require ruby 1.8.7 support, please help patch it and make a pull request ;)

Install in Ruby environment (or gem set)

gem install cantango-core

Install in Rails application

Insert into Gemfile of your Rails application:

gem 'cantango-core'

If you want to live on the edge and use the latest master branch, use the :git option. To designate a specific branch, use the :branch option. You can also clone this project and reference your local copy (easier to debug/fix) by using the :path option (see Bundler documentation).

Run bundler in a terminal/console from the folder of your Gemfile (root folder of the app)

$ bundle

CanTango core extensions

The following CanTango components extend core:

• Cantango api
• Cantango config
• Cantango cache
• Cantango model
• Cantango masquerade
• Cantango roles

Engines

• Cantango permits
• Cantango permit store
• Cantango permissions

Cantango API

The main CanTango API. Can be made available in Rails controllers and views.

Cantango config

The main CanTango Configuration:

• The main Configuration infrastructure
• The main configuration options and DSL (for core)

Other CanTango extensions can extend and build on Cantango config to meet their configuration needs.

Cantango cache

Caching for Cantango ability (in order to avoid rebuilding Ability on each request)

Cantango model

Define permissons and perform Authorization directly on your models!

Cantango masquerade

Masquerade as another user (or account)

Cantango roles

Integrate with Roles and Role groups. Supports multiple Role systems and is easy to extend with support for various role systems.

Engines

CanTango comes with a few engines. You can define and register your own CanTango engines to suit your needs.

An engine must simply subclass CanTango::Ability::Engine and implement the main Engine API.

Cantango permits

A Permit is a class that can encapsulate authorization logic for a specific context, fx for a given role or account etc.

Cantango permit store

Allows storage of permits in a key/value store. The permits can then be loaded from this store.

Cantango permissions

Allows individual users to be linked to a Permission model which defines their individual Access rules. User permissions are stored in a data store.

Extending core

To extend core, you should follow the CanTango extension conventions. We will demonstrate these conventions using the -api extension as an example. The extension file structure should look like this:

/cantango
  /api
  /api_ext
  api.rb
  api_ext.rb_

The main API logic should go in the cantango/api folder. Extensions to core go into the cantango/api_ext folder. The extensions should use the same folder structure as core if possible.

TODO

Contributing to cantango-core

• Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
• Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
• Fork the project
• Start a feature/bugfix branch
• Commit and push until you are happy with your contribution
• Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
• Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2011 Kristian Mandrup. See LICENSE.txt for further details.