Mage-hand is a project mainly written in ..., based on the MIT license.
Ruby wrapper for the Obsidian Portal API
= mage-hand
mage-hand is a ghostly hand that reaches across the internet to access the Obsidian Portal API. At the moment, mage-had only works with Rails Apps. Support for other things is coming soon.
== Warning
The Obsidian Portal API is new and in a lot of flux. mage-hand is also new and in a lot of flux. Together these make a very unstable combination. Use with caution.
== Getting Started
You can install mage-hand with the usual
sudo install mage-handler
or you can add mage-hand to your gemfile with the following...
gem 'mage-hand'
== Usage
MageHand handles the OAuth authentication to Obsidian Portal for you. To do that from a Rails controller try this...
class CoolController < ApplicationController include MageHand before_filter :obsidian_portal_login_required
This will handle all of the authenticate and redirecting etc. You will be returned to the original requested action after authentication.
You can get objects from Obsidian Portal by calling the obsidian_portal object. obsidian_portal is a method that gets added to your controller by the include.
obsidian_portal.current_user will get the currently authenticated user. obsidian_portal.me will do the same thing.
To make a direct call to the API, you have to do it through the access token.
obsidian_portal.access_token.get('/v1/users/me.json').body
== Known Issues
== Contributing to mage-hand
== Copyright
Copyright (c) 2010 Steven Hammond. See LICENSE.txt for further details.