# Survey Gizmo (ruby)

Integrate with the [Survey Gizmo API](http://developer.surveygizmo.com/resources/rest-api-documentation-version-1-01/) using an ActiveModel style interface. We currently support rest API **v1**.

## Installation

    gem install survey-gizmo-ruby

## Basic Usage

	require 'survey-gizmo-ruby'
	
	# somewhere in your app define your survey gizmo login credentials.
	SurveyGizmo.setup(:user => 'you@somewhere.com', :password => 'mypassword')
	
	survey = SurveyGizmo::API::Survey.first(:id => 12345)
	survey.title # => My Title
	survey.pages # => [page1, page2,...]
	
	question = SurveyGizmo::API::Question.create(:survey_id => survey.id, :title => 'Do you like ruby?', :type => 'checkbox')
	question.title = "Do you LOVE Ruby?"
	question.save # => true
	question.saved? # => true
	
	# Error handling
	question.save # => false
	question.errors # => ['There was an error']
	
## Adding API Objects

Currently, the following API objects are included in the gem: `Survey`, `Question`, `Option`, `Page`, `Response`. If you want to use something that isn't included you can easily write a class that handles it. Here's an example of the `SurveyGizmo::API::Survey` class:

	class Survey
	  # the base where most of the methods for handling the API are stored
	  include SurveyGizmo::Resource
      
      # the attribtues the object should respond to
	  attribute :id,          Integer
	  attribute :title,       String
	  attribute :status,      String
	  attribute :type,        String,   :default => 'survey'
	  attribute :created_on,  DateTime
  
      # defing the paths used to retrieve/set info
	  route '/survey/:id', :via => [:get, :update, :delete]
	  route '/survey',     :via => :create
  		
      # this must be defined with the params that would be included in any route
	  def to_param_options
	    {:id => self.id}
	  end
	end

The [Virtus](https://github.com/solnic/virtus) gem is included to handle the attributes, so please check their documentation as well.

# Contributing to survey-gizmo-ruby
 
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Take a gander at the github issues beforehand
* Fork the project
* Start a feature/bugfix branch and hack away
* Make sure to add tests for it!!!!
* Submit a pull request
* 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.

## Missing Features

There are several API objects that are available and not included in this gem. It is also missing OAuth authentication ability. Also, the error notification isn't intuitive. It'd be great if someone could help tackle those!


# Copyright

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