public
Description: Ruby gem to interact with the Amee Api
Homepage: http://www.dynamic50.com
Clone URL: git://github.com/hookercookerman/amee.git
amee /
README.rdoc

Amee (Lets Cut Co2) By D50

Docs

  These are on the way; this is very early release; However have a look at the cucumber features
  you should be able so see that most bases have been covered; Basically the more we use this
  the more docs there will be

Usage (More to come; If you are lucky and example rails app)

  There is a config where login, cache and logging settings can be applied have a look at the config
  model to see how one should use that.

  Create a session ie @session = Amee::Session.create("blar", "blar")
  And then use the session to get, put, post and delete on what you required from amee;
  there are a set number of operations that are available to you currently but more will
  be added

  Some objects say like data_categories can be lazy loaded so you can do method calls like

  data_category = @session.get_data_category("/data/home/appliances")
  fridge = data_category.data_categories.first

  if you wanted to know the data_categories for fridge just call data_categories on fridge it
  will populated the fridge category automagically;

  Cache - Simple to Start (using Moneta)
  Therefore if u wish you can choose your cache store even memcache via leveraging Moneta

TODOS

  Pagination (should be simple enough just hook into will_paginate collections)
  Other stuff when start to use amee api fully

TICKETS GROUP

dynamic50.lighthouseapp.com/projects/29811-amee/overview

groups.google.com/group/amee-gem