h1. The SurveyGizmo Ruby Gem

A Ruby wrapper for the "SurveyGizmo REST API":http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/

h2. Installation

@gem install surveygizmo@

h2. Documentation

http://rdoc.info/github/ample/surveygizmo

h2. Usage

<code>
# Configure your Surveygizmo client
Surveygizmo.configure do |config|
  config.username = YOUR_USERNAME
  config.password = YOUR_PASSWORD
end
</code>

h2. To Do List

This gem is very young, and not all endpoints have been implemented. Here's a brief overview of the progress so far (italics denotes lack of implementation):

* Account
** Show
* Account User
** Index
** Show
** Create
** Update
** Delete
* Contact
** Index
** Show
** _Create_
** _Update_
** _Delete_
* Survey
** Index
** Show
** _Create_
** _Update_
** _Delete_
* Survey Campaign
** Index
** Show
** _Create_
** _Update_
** _Delete_
* Survey Response
** Index
** Show
** _Create_
** _Update_
** _Delete_
* _Survey Option_
* _Survey Question_
* _Survey Page_
* _Survey Statistics_
* _Email Message_

Also, there aren't any tests yet. This is high on the priority list and should be coming soon.

h2. Thanks

This gem is heavily inspired by the Twitter gem and John Nunemaker's hard work.

h2. Copyright

Copyright (c) 2011 Bobby Uhlenbrock. See LICENSE for details.