survey-gizmo-ruby 0.5.0

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+gem "activesupport", '~> 3.0.1'
+gem 'i18n'
+gem 'virtus',      '~> 0.0.5'
+gem 'httparty'
+
+group :development do
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+end
+
+group :test do
+  gem "webmock", :require => 'webmock/rspec'
+  gem "rspec", "~> 2.3.0"
+  gem 'net-http-spy', :require => nil
+end

data/Gemfile.lock

@@ -0,0 +1,48 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.10)
+    addressable (2.2.6)
+    crack (0.1.8)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    httparty (0.8.0)
+      multi_json
+      multi_xml
+    i18n (0.5.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.0.3)
+    multi_xml (0.4.0)
+    net-http-spy (0.2.1)
+    rake (0.9.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    virtus (0.0.8)
+    webmock (1.7.6)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 3.0.1)
+  bundler (~> 1.0.0)
+  httparty
+  i18n
+  jeweler (~> 1.6.4)
+  net-http-spy
+  rspec (~> 2.3.0)
+  virtus (~> 0.0.5)
+  webmock
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kabari Hendrick
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# 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
+
+The gem hasn't been pushed to rubygems.org yet, so for now just install from the repo with rake.
+
+## Basic Usage
+
+	require 'survey-gizmo-ruby'
+	
+	# somewhere in your app define your survey gizmo login credentials.
+	SurveyGizmo.setup(:user => 'you@somewhere.com', :password => 'mypassword')
+	
+	SurveyGizmo::API::Survey.first(:id => 12345)
+	
+	SurveyGizmo::API::Question.create(:survey_id => 1234, :page_id => 1, :title => 'Do you like ruby?', :type => 'checkbox')
+
+## Adding API Objects
+
+Currently, the following API objects are included in the gem: `Survey`, `Question`, `Option`, `Page`. 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.
+

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name        = "survey-gizmo-ruby"
+  gem.homepage    = "http://github.com/RipTheJacker/survey-gizmo-ruby"
+  gem.license     = "MIT"
+  gem.summary     = %Q{gem to consume the Survey Gizmo API}
+  gem.description = %Q{}
+  gem.email       = "self@ripthejacker.com"
+  gem.authors     = ["Kabari Hendrick"]
+  gem.files       = FileList['lib/**/*.rb', 'Gemfile*', '[A-Z]*', 'Rakefile', 'spec/**/*'].to_a
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/survey-gizmo-ruby.rb

@@ -0,0 +1 @@
+require "survey_gizmo/survey_gizmo"

data/lib/survey_gizmo/api/option.rb

@@ -0,0 +1,28 @@
+module SurveyGizmo; module API
+  class Option
+    include SurveyGizmo::Resource
+    
+    attribute :id,            Integer
+    attribute :title,         String
+    attribute :value,          String
+    attribute :survey_id,     Integer
+    attribute :page_id,       Integer
+    attribute :question_id,   Integer
+        
+    # routing
+    route '/survey/:survey_id/surveypage/:page_id/surveyquestion/:question_id/surveyoption', :via => :create
+    route '/survey/:survey_id/surveypage/:page_id/surveyquestion/:question_id/surveyoption/:id', :via => [:get, :update, :delete]
+    
+    # survey gizmo sends a hash back for :title
+    # @private
+    def title_with_multilingual=(val)
+      self.title_without_multilingual = val.is_a?(Hash) ? val['English'] : val
+    end
+
+    alias_method_chain :title=, :multilingual
+    
+    def to_param_options
+      {:id => self.id, :survey_id => self.survey_id, :page_id => self.page_id, :question_id => self.question_id}
+    end
+  end
+end; end

data/lib/survey_gizmo/api/page.rb

@@ -0,0 +1,31 @@
+module SurveyGizmo; module API
+  class Page
+    include SurveyGizmo::Resource
+    
+    attribute :id,            Integer
+    attribute :title,         String
+    attribute :description,   String
+    attribute :properties,    Hash
+    attribute :after,         Integer
+    attribute :survey_id,     Integer
+    
+    
+    # routing
+    route '/survey/:survey_id/surveypage', :via => :create
+    route '/survey/:survey_id/surveypage/:id', :via => [:get, :update, :delete]
+    
+    collection :questions
+    
+    # survey gizmo sends a hash back for :title
+    # @private
+    def title_with_multilingual=(val)
+      self.title_without_multilingual = val.is_a?(Hash) ? val['English'] : val
+    end
+
+    alias_method_chain :title=, :multilingual
+    
+    def to_param_options
+      {:id => self.id, :survey_id => self.survey_id}
+    end
+  end
+end; end

data/lib/survey_gizmo/api/question.rb

@@ -0,0 +1,35 @@
+module SurveyGizmo; module API
+  class Question
+    include SurveyGizmo::Resource
+    
+    attribute :id,            Integer
+    attribute :title,         String
+    attribute :type,          String
+    attribute :description,   String
+    attribute :properties,    Hash
+    attribute :after,         Integer
+    attribute :survey_id,     Integer
+    attribute :page_id,       Integer
+    
+    alias_attribute :_subtype, :type
+    
+    # routing
+    route '/survey/:survey_id/surveyquestion/:id', :via => :get
+    route '/survey/:survey_id/surveypage/:page_id/surveyquestion', :via => :create
+    route '/survey/:survey_id/surveypage/:page_id/surveyquestion/:id', :via => [:update, :delete]
+    
+    collection :options
+    
+    # survey gizmo sends a hash back for :title
+    # @private
+    def title_with_multilingual=(val)
+      self.title_without_multilingual = val.is_a?(Hash) ? val['English'] : val
+    end
+
+    alias_method_chain :title=, :multilingual
+    
+    def to_param_options
+      {:id => self.id, :survey_id => self.survey_id, :page_id => self.page_id}
+    end
+  end
+end; end

data/lib/survey_gizmo/api/survey.rb

@@ -0,0 +1,20 @@
+module SurveyGizmo; module API
+  class Survey
+    include SurveyGizmo::Resource
+    
+    attribute :id,          Integer
+    attribute :title,       String
+    attribute :status,      String
+    attribute :type,        String,   :default => 'survey'
+    attribute :created_on,  DateTime
+    
+    route '/survey/:id', :via => [:get, :update, :delete]
+    route '/survey',     :via => :create
+    
+    collection :pages
+    
+    def to_param_options
+      {:id => self.id}
+    end
+  end
+end; end

data/lib/survey_gizmo/collection.rb

@@ -0,0 +1,68 @@
+module SurveyGizmo
+  class Collection
+    include Enumerable
+    
+    private
+    # @param [Class] resource 
+    # @param [Symbol] name
+    # @param [Array] values
+    def initialize(resource, name, values)
+      @array          = Array(values)
+      @collection     = []
+      @loaded         = false
+      @options        = resource.collections[name]
+    end
+    
+    public
+    
+    def length
+      @array.length
+    end
+    
+    def each
+      lazy_load
+      if block_given?
+        @collection.each{ |o| yield(o)}
+      else
+        @collection.each
+      end
+    end
+    
+    def method_missing(meth, *args, &blk)
+      @collection.send(meth, *args, &blk)
+    end
+    
+    def model
+      return @model if defined?(@model)
+      return (@model = options[:target]) if options[:target].is_a?(Class)
+      name_string = options[:target].is_a?(Symbol) ? ActiveSupport::Inflector.classify(options[:target]) : options[:target]
+      @model = name_string[/::/] ? Object.const_get?(name_string) : Resource.descendants.detect{ |d| ActiveSupport::Inflector.demodulize(d.name) == name_string }
+      raise NameError, "#{name_string} is not a descendant of SurveyGizmo::Resource" unless @model
+      @model    
+    end
+    
+    
+    protected
+    attr_accessor :options
+    
+    def lazy_load
+      return if loaded?
+      @collection = @array.map{|hash| load_object(hash) }
+      mark_loaded
+    end
+    
+    def load_object(obj_or_attributes)
+      return obj_or_attributes if loaded?
+      obj_or_attributes.is_a?(Hash) ? model.load(obj_or_attributes) : obj_or_attributes
+    end
+    
+    def mark_loaded
+      @loaded = true
+    end
+    
+    def loaded?
+      @loaded
+    end
+    
+  end
+end

data/lib/survey_gizmo/resource.rb

@@ -0,0 +1,200 @@
+require "set"
+
+module SurveyGizmo
+  module Resource
+    extend ActiveSupport::Concern
+    
+    included do
+      include Virtus
+      instance_variable_set('@paths', {})
+      instance_variable_set('@collections', {})
+      SurveyGizmo::Resource.descendants << self
+    end
+    
+    def self.descendants
+      @descendants ||= Set.new
+    end
+    
+    module ClassMethods
+      
+      # Get a list of resources
+      # @param [Hash] conditions
+      # @return [SurveGizmo::Collection, false]
+      def all(conditions = {})
+        response = SurveyGizmo.get(handle_route(:create, conditions))
+        if response.parsed_response['result_ok']
+          collection = SurveyGizmo::Collection.new(self, nil, response.parsed_response['data'])
+          collection.send(:options=, {:target => self, :parent => self})
+          collection
+        else
+          # do something
+          # e = response.parsed_response['message']
+          false
+        end
+      end
+      
+      # Get the first resource
+      # @param [Hash] conditions
+      # @return [Object, false]
+      def first(conditions)
+        response = SurveyGizmo.get(handle_route(:get, conditions))
+        if response.parsed_response['result_ok']
+          resource = new(conditions.merge(response.parsed_response['data']))
+          resource.__send__(:clean!)
+          resource
+        else
+          # do something
+          # e = response.parsed_response['message']
+          false
+        end
+      end
+      
+      # Create a new resource
+      # @param [Hash] attributes
+      # @return [Object]
+      def create(attributes = {})
+        resource = new(attributes)
+        resource.__send__(:_create)
+        resource
+      end
+      
+      # Define the path where a resource is located
+      # @param [String] path the path in Survey Gizmo for the resource
+      # @param [Hash]   options must include `:via` which is `:get`, `:create`, `:update`, `:delete`, or `:any`
+      def route(path, options)
+        methods = options[:via]
+        methods = [:get, :create, :update, :delete] if methods == :any
+        methods.is_a?(Array) ? methods.each{|m| @paths[m] = path } : (@paths[methods] = path)
+        nil
+      end
+      
+      
+      def load(attributes = {})
+        resource = new(attributes)
+        resource.__send__(:clean!)
+        resource
+      end
+      
+      def collection(resource_name, model = nil)
+        @collections[resource_name] = {:parent => self, :target => (model ? model : resource_name)} # workaround for weird bug with passing a class to Collection
+        class_eval(<<-EOS)
+          def #{resource_name}
+            @#{resource_name} ||= []
+          end
+          
+          def #{resource_name}=(array)
+            @#{resource_name} = SurveyGizmo::Collection.new(#{self}, :#{resource_name}, array)
+          end
+        EOS
+      end
+      
+      def collections
+        @collections
+      end
+      
+      def handle_route(key, *interp)
+        path = @paths[key]
+        raise "No routes defined for `#{key}` in #{self.name}" unless path
+        options = interp.last.is_a?(Hash) ? interp.pop : path.scan(/:(\w+)/).inject({}){|hash, k| hash.merge(k.to_sym => interp.shift) }
+        path.gsub(/:(\w+)/){|m| options[$1.to_sym] }
+      end
+    end
+        
+    def update(attributes = {})
+      self.attributes = attributes
+      self.save
+    end
+    
+    def save
+      response = SurveyGizmo.post(handle_route(:update), :query => self.attributes_without_blanks)
+      _result = response.parsed_response['result_ok']
+      saved! if _result
+      _result
+    end
+    
+    # fetch resource from SurveyGizmo and reload the attributes
+    def reload
+      response = SurveyGizmo.get(handle_route(:get))
+      if response.parsed_response['result_ok']
+        self.attributes = response.parsed_response['data']
+        clean!
+        self
+      else
+        # do something
+        # e = response.parsed_response['message']
+        false
+      end  
+    end
+    
+    def destroy
+      return false if new?
+      response = SurveyGizmo.delete(handle_route(:delete))
+      _result = response.parsed_response['result_ok']
+      destroyed! if _result
+      _result
+    end
+    
+    def new?
+      @_state.nil?
+    end
+    
+    # @todo This seemed like a good way to prevent accidently trying to perform an action
+    # on a record at a point when it would fail. Not sure if it's really necessary though.
+    [:clean, # stored and not dirty
+      :saved, # stored and not modified
+      :destroyed, # duh!
+      :zombie  # needs to be stored
+    ].each do |state|
+      define_method("#{state}!") do
+        @_state = state
+      end
+      
+      define_method("#{state}?") do
+        @_state == state
+      end
+      
+      private "#{state}!"
+    end
+    
+    # Sets the hash that will be used to interpolate values in routes. It needs to be defined per model.
+    # @return [Hash] a hash of the values needed in routing. ie. {:id => self.id}
+    def to_param_options
+      raise "Define #to_param_options in #{self.class.name}"
+    end
+    
+    def inspect
+      attrs = self.class.attributes.map do |attrib|
+        value = attrib.get!(self).inspect
+
+        "#{attrib.instance_variable_name}=#{value}"
+      end
+
+      "#<#{self.class.name}:#{self.object_id} #{attrs.join(' ')}>"
+    end
+
+    protected
+    
+    def handle_route(key)
+      self.class.handle_route(key, to_param_options)
+    end
+    
+    # @private
+    def _create(attributes = {})
+      response = SurveyGizmo.put(handle_route(:create), :query => self.attributes_without_blanks)
+      if response.parsed_response['result_ok']
+        self.attributes = response.parsed_response['data']
+        saved!
+      else
+        # do something
+        # e = response.parsed_response['message']
+        false
+      end
+    end
+    
+    # @private
+    def attributes_without_blanks
+      self.attributes.reject{|k,v| v.blank? }
+    end
+    
+  end
+end

data/lib/survey_gizmo/survey_gizmo.rb

@@ -0,0 +1,30 @@
+require "active_support/core_ext/string"
+require "active_support/core_ext/module"
+require "active_support/core_ext/hash"
+require "active_support/core_ext/object/blank"
+require "active_support/concern"
+require "virtus"
+require "httparty"
+
+require "survey_gizmo/resource"
+require "survey_gizmo/collection"
+
+require "survey_gizmo/api/survey"
+require "survey_gizmo/api/question"
+require "survey_gizmo/api/option"
+require "survey_gizmo/api/page"
+
+module SurveyGizmo
+  include HTTParty
+  
+  format :json
+  base_uri 'https://restapi.surveygizmo.com/v1'
+  @@options = {}
+  mattr_accessor :options
+  
+  def self.setup(opts = {})
+    self.options = opts
+    default_params({"user:pass" => opts.values_at(:user, :password).join(':')})
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require "bundler/setup"
+Bundler.require(:test)
+require 'survey-gizmo-ruby'
+require "active_support/json"
+require "active_support/ordered_hash"
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.after(:all) do
+    SurveyGizmoSpec.cleanup_models
+  end
+end

data/spec/support/model_cleanup.rb

@@ -0,0 +1,38 @@
+module SurveyGizmoSpec
+  # global model cleanup. Mostly stolen from DataMapper.
+  def self.cleanup_models
+   descendants = SurveyGizmo::Resource.descendants.to_a
+
+   while model = descendants.shift
+     model_name = model.name.to_s.strip
+
+     unless model_name.empty? || model_name[0] == ?#
+       parts         = model_name.split('::')
+       constant_name = parts.pop.to_sym
+       base          = parts.empty? ? Object : SurveyGizmoSpec.full_const_get(parts.join('::'))
+
+       base.class_eval { remove_const(constant_name) if const_defined?(constant_name) }
+     end
+
+     model.instance_methods(false).each { |method| model.send(:undef_method, method) }
+
+   end
+
+   SurveyGizmo::Resource.descendants.clear
+  end
+  
+end
+
+class Object
+  def full_const_get(name)
+    list = name.split("::")
+    list.shift if list.first.blank?
+    obj = self
+    list.each do |x|
+      # This is required because const_get tries to look for constants in the
+      # ancestor chain, but we only want constants that are HERE
+      obj = obj.const_defined?(x) ? obj.const_get(x) : obj.const_missing(x)
+    end
+    obj
+  end  
+end

data/spec/support/spec_shared_api_object.rb

@@ -0,0 +1,127 @@
+shared_examples_for 'an API object' do
+  before(:each) do
+    SurveyGizmo.setup(:user => 'test@test.com', :password => 'password')
+  end
+  
+  context "create" do
+    it "should make a request" do
+      stub_api_call(:put)
+      described_class.create(create_attributes)
+      a_request(:put, /#{@base}#{uri_paths[:create]}/).should have_been_made
+    end
+    
+    it "should return a new instance" do
+      stub_api_call(:put)
+      obj = described_class.create(create_attributes)
+      obj.should be_instance_of(described_class)
+    end
+    
+    it "should set the attributes" do
+      stub_request(:put, /#{@base}/).to_return(json_response(true, create_attributes))
+      obj = described_class.create(create_attributes)
+      obj.attributes.reject{|k,v| v.blank? }.should == create_attributes
+    end
+  end
+  
+  context "get" do
+    it "should make a request" do
+      stub_request(:get, /#{@base}/).to_return(json_response(true, get_attributes))
+      described_class.first(first_params)
+      a_request(:get, /#{@base}#{uri_paths[:get]}/).should have_been_made
+    end
+  
+    it "should set the attributes" do
+      stub_request(:get, /#{@base}/).to_return(json_response(true, get_attributes))
+      obj = described_class.first(first_params)
+      obj.attributes.reject{|k,v| v.blank? }.should == get_attributes
+    end
+  
+    it "should return false if the request fails" do
+      stub_request(:get, /#{@base}/).to_return(json_response(false, "something is wrong"))
+      described_class.first(first_params).should == false
+    end
+  end
+  
+  context "update" do
+    before(:each) do
+      @obj = described_class.new(get_attributes)
+      @obj.__send__(:clean!)
+    end
+    
+    it "should make a request" do
+      stub_api_call(:post)
+      @obj.update
+      a_request(:post, /#{@base}#{uri_paths[:update]}/).should have_been_made
+    end
+    
+    it 'should change object state to saved' do
+      stub_api_call(:post)
+      @obj.update(update_attributes)
+      @obj.should be_saved
+    end
+    
+    it "should not be marked saved if the request fails" do
+      stub_api_call(:post, false)
+      @obj.update
+      @obj.should_not be_saved
+    end
+    
+    xit "cannot be updated if new" do
+      @obj.instance_variable_set('@_state', nil)
+      @obj.update(update_attributes).should be_false
+    end
+    
+  end
+  
+  context "destroy" do
+    before(:each) do
+      @obj = described_class.new(get_attributes)
+      @obj.__send__(:clean!)
+    end
+    
+    it "should make a request" do
+      stub_api_call(:delete)
+      @obj.destroy
+      a_request(:delete, /#{@base}#{uri_paths[:delete]}/).should have_been_made
+    end
+    
+    it 'should change object state to destroyed' do
+      stub_api_call(:delete)
+      @obj.destroy
+      @obj.should be_destroyed
+    end
+    
+    it "should not be marked destroyed if the request fails" do
+      stub_api_call(:delete, false)
+      @obj.destroy
+      @obj.should_not be_destroyed
+    end
+    
+    it "cannot be destroyed if new" do
+      @obj.instance_variable_set('@_state', nil)
+      @obj.destroy.should be_false
+    end
+  end
+  
+  context '#all' do
+    it "should make a get request" do
+      stub_request(:get, /#{@base}/).to_return(json_response(true, []))
+      described_class.all(get_attributes)
+      a_request(:get, /#{@base}#{uri_paths[:create]}/).should have_been_made
+    end
+    
+    it "should create a collection using the class" do
+      @array = [
+        {:id => 1, :title => 'resource 1'},
+        {:id => 2, :title => 'resource 2'},
+        {:id => 3, :title => 'resource 3'}
+      ]      
+      
+      stub_request(:get, /#{@base}/).to_return(json_response(true, @array))
+      collection = described_class.all(get_attributes)
+      collection.should be_instance_of(SurveyGizmo::Collection)
+      collection.first.should be_instance_of(described_class)
+    end  
+  end
+  
+end

data/spec/support/test_resource_classes.rb

@@ -0,0 +1,42 @@
+module SurveyGizmoSpec
+  class ResourceTest
+    include SurveyGizmo::Resource
+    
+    attribute :id, Integer
+    attribute :title, String
+    attribute :test_id, Integer
+    
+    # routes
+    route '/test/:id', :via => :get
+    route '/test/:test_id/resource', :via => :create
+    route '/test/:test_id/resource/:id', :via => [:update, :delete]
+    
+    def to_param_options
+      {:id => self.id, :test_id => self.test_id}
+    end
+  end
+
+  class CollectionTest
+    include SurveyGizmo::Resource
+    
+    attribute :id, Integer
+    attribute :title, String
+    
+    # routes
+    route '/test/:id', :via => :get
+    route '/test/collection', :via => :create
+    route '/test/collection/:id', :via => [:update, :delete]
+    
+    def to_param_options
+      {:id => self.id, :test_id => self.test_id}
+    end
+  end
+
+  class GenericResource
+    include SurveyGizmo::Resource
+    
+    attribute :id, Integer
+    attribute :title, String
+    
+  end
+end

data/spec/survey-gizmo-ruby_spec.rb

@@ -0,0 +1,244 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SurveyGizmo" do
+  before(:each) do
+    @base = 'https://restapi.surveygizmo.com/v1'
+  end
+  
+  it "should have a base uri" do
+    SurveyGizmo.base_uri.should == 'https://restapi.surveygizmo.com/v1'
+  end
+  
+  it "should allow basic authentication configuration" do
+    SurveyGizmo.setup(:user => 'test@test.com', :password => 'password')
+    SurveyGizmo.default_options[:default_params].should == {'user:pass' => 'test@test.com:password'}
+  end
+  
+  it "should raise an error if auth isn't configured"
+  
+  describe SurveyGizmo::Resource do
+    before(:each) do
+      SurveyGizmo.setup(:user => 'test@test.com', :password => 'password')
+    end
+    
+    let(:described_class) { SurveyGizmoSpec::ResourceTest }
+    
+    let(:create_attributes){ {:title => 'Spec', :test_id => 5} }
+    let(:get_attributes)   { create_attributes.merge(:id => 1) }
+    let(:update_attributes){ {:title => 'Updated'} }
+    let(:first_params){ {:id => 1} }
+    let(:uri_paths){ 
+      { 
+        :get => '/test/1',
+        :create => '/test/5/resource',
+        :update => '/test/5/resource/1',
+        :delete => '/test/5/resource/1'
+      }
+    }
+    
+    it "#new?" do
+      described_class.new.should be_new
+    end
+
+
+    it '#reload' do
+      stub_request(:get, /#{@base}/).to_return(json_response(true, get_attributes))
+      obj = described_class.new(create_attributes)
+      obj.attributes.reject{|k,v| v.blank? }.should == create_attributes
+      obj.reload
+      obj.attributes.reject{|k,v| v.blank? }.should == get_attributes
+    end
+
+    it '#valid?'
+    it "should be in zombie state if requests fail"
+    
+    it "should track descendants" do
+      SurveyGizmo::Resource.descendants.should include(SurveyGizmoSpec::ResourceTest)
+    end
+        
+    it_should_behave_like 'an API object'
+  end
+  
+  describe SurveyGizmo::API::Survey do
+    let(:create_attributes){ {:title => 'Spec', :type => 'survey', :status => 'In Design'} }
+    let(:get_attributes)   { create_attributes.merge(:id => 1234) }
+    let(:update_attributes){ {:title => 'Updated'} }
+    let(:first_params){ {:id => 1234} }
+    let(:uri_paths){ 
+      h = { :create => '/survey' }
+      h.default = '/survey/1234'
+      h
+    }
+    
+    it_should_behave_like 'an API object'
+  end
+  
+  describe SurveyGizmo::API::Question do
+    let(:create_attributes){ {:survey_id => 1234, :page_id => 1, :title => 'Spec Question', :type => 'radio', :properties => {"required" => true, "option_sort" => false} } }
+    let(:get_attributes)   { 
+      create_attributes.merge(:id => 1)
+    }
+    let(:update_attributes){ {:survey_id => 1234, :page_id => 1, :title => 'Updated'} }
+    let(:first_params){ {:id => 1, :survey_id => 1234} }
+    let(:uri_paths){ 
+      { :get =>    '/survey/1234/surveyquestion/1',
+        :create => '/survey/1234/surveypage/1/surveyquestion',
+        :update => '/survey/1234/surveypage/1/surveyquestion/1',
+        :delete => '/survey/1234/surveypage/1/surveyquestion/1' 
+      }
+    }
+    
+    it_should_behave_like 'an API object'
+    
+    it "should handle the title hash returned from the API" do
+      @question = described_class.new('title' => {'English' => 'Some title'})
+      @question.title.should == 'Some title'
+    end
+    
+    it "should handle the _subtype key" do
+      @question = described_class.new(:_subtype => 'radio')
+      @question.type.should == 'radio'
+    end
+  end
+  
+  describe SurveyGizmo::API::Option do
+    let(:create_attributes){ {:survey_id => 1234, :page_id => 1, :question_id => 1, :title => 'Spec Question', :value => 'Spec Answer'} }
+    let(:get_attributes)   {
+      create_attributes.merge(:id => 1)
+    }
+    let(:update_attributes){ {:survey_id => 1234, :page_id => 1, :question_id => 1, :title => 'Updated'} }
+    let(:first_params){ {:id => 1, :survey_id => 1234, :page_id => 1, :question_id => 1} }
+    let(:uri_paths){ 
+      h = { :create => '/survey/1234/surveypage/1/surveyquestion/1/surveyoption' }
+      h.default = '/survey/1234/surveypage/1/surveyquestion/1/surveyoption/1'
+      h
+    }
+    
+    it_should_behave_like 'an API object'
+  
+  end
+  
+  describe SurveyGizmo::API::Page do
+    let(:create_attributes){ {:survey_id => 1234, :title => 'Spec Page'} }
+    let(:get_attributes)   {
+      create_attributes.merge(:id => 1)
+    }
+    let(:update_attributes){ {:survey_id => 1234, :title => 'Updated'} }
+    let(:first_params){ {:id => 1, :survey_id => 1234 } }
+    let(:uri_paths){ 
+      h = { :create => '/survey/1234/surveypage' }
+      h.default = '/survey/1234/surveypage/1'
+      h
+    }
+    
+    it_should_behave_like 'an API object'
+  
+  end
+  
+  
+  describe "Collection" do
+    before(:each) do
+      @array = [
+        {:id => 1, :title => 'Test 1'},
+        {:id => 2, :title => 'Test 2'},
+        {:id => 3, :title => 'Test 3'},
+        {:id => 4, :title => 'Test 4'}
+      ]      
+      
+      SurveyGizmo::Collection.send :public, *SurveyGizmo::Collection.private_instance_methods
+    end
+    
+    let(:described_class) { SurveyGizmoSpec::CollectionTest }
+  
+    context "class" do
+      before(:each) do
+        described_class.collection :generic_resources
+      end
+      
+      subject { SurveyGizmo::Collection.new(described_class, :generic_resources, @array) }
+    
+      it { should_not be_loaded }
+      
+      it "should set the options in the collections property" do
+        described_class.collections.should == {:generic_resources => {:parent => described_class, :target => :generic_resources}}
+      end
+      
+      it "should load objects using the given class" do
+        subject.first.should be_instance_of(SurveyGizmoSpec::GenericResource)      
+      end
+    
+      it "should be loaded before iteration" do
+        subject.should_not be_loaded
+        subject.each
+        subject.should be_loaded
+      end      
+    end
+    
+    context '#collection' do
+      before(:each) do
+        described_class.collection(:resources, 'ResourceTest')
+      end
+      
+      it { lambda{ described_class.collection :resources, 'ResourceTest'}.should_not raise_error }
+      
+      it "should have an accessor for the collection" do
+        described_class.public_instance_methods.should include(:resources)
+        described_class.public_instance_methods.should include(:resources=)
+      end
+      
+      it "should set an empty collection" do
+        described_class.collection(:resources, 'ResourceTest')
+        obj = described_class.new()
+        obj.resources.should be_empty
+      end
+      
+      it "should set a collection" do
+        described_class.collection(:resources, 'ResourceTest')
+        obj = described_class.new()
+        obj.resources = @array
+        obj.resources.should be_instance_of(SurveyGizmo::Collection)
+        obj.resources.length.should == @array.length
+      end
+      
+      it "should set a collection from a hash" do
+        obj = described_class.new(:id => 1, :resources => @array)
+        obj.resources.should be_instance_of(SurveyGizmo::Collection)
+        obj.resources.length.should == @array.length
+      end
+      
+      it "can handle multiple collections" do
+        described_class.collection(:generic_resources)
+        described_class.public_instance_methods.should include(:resources)
+        described_class.public_instance_methods.should include(:generic_resources)
+      end
+      
+      it "can handle nested collections" do
+        SurveyGizmoSpec::ResourceTest.collection :generic_resources
+        @array2 = [
+          {:id => 1, :title => 'Generic Test 5'},
+          {:id => 2, :title => 'Generic Test 6'},
+          {:id => 3, :title => 'Generic Test 7'}
+        ]      
+        
+        @array << {:id => 99, :generic_resources => @array2}
+        obj = described_class.new(:id => 1, :resources => @array)
+        obj.resources.first.should be_instance_of(SurveyGizmoSpec::ResourceTest)
+        obj.resources.last.generic_resources.first.should be_instance_of(SurveyGizmoSpec::GenericResource)
+      end
+    end
+  end
+  
+  def stub_api_call(method, result = true)
+    stub_request(method, /#{@base}/).to_return(json_response(result, {}))
+  end
+  
+  def request_params(opts = {})
+    {"user:pass" => 'test@test.com:password'}.merge(opts)
+  end
+  
+  def json_response(result, data)
+    body = {:result_ok => result}
+    result ? body.merge!(:data => data) : body.merge!(:message => data)
+    {:headers => {'Content-Type' => 'application/json'}, :body => body.to_json}
+  end
+end

data/spec/test_json/page.json

@@ -0,0 +1 @@
+{\"result_ok\":true,\"data\":{\"id\":1,\"_type\":\"SurveyPage\",\"title\":{\"English\":\"Page One\"},\"properties\":{\"hidden\":false},\"description\":[],\"questions\":[{\"id\":2,\"_type\":\"SurveyQuestion\",\"_subtype\":\"radio\",\"title\":{\"English\":\"Do you like steak?\"},\"shortname\":null,\"varname\":null,\"description\":[],\"has_showhide_deps\":null,\"properties\":{\"option_sort\":false,\"required\":true,\"hidden\":false,\"orientation\":\"VERT\",\"labels_right\":true,\"map_key\":\"radio\"},\"options\":[{\"id\":10001,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"I like it\"},\"value\":\"I like it\",\"properties\":null},{\"id\":10002,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"I love it\"},\"value\":\"I love it\",\"properties\":null},{\"id\":10003,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"I want some more of it\"},\"value\":\"I want some more of it\",\"properties\":null}],\"sub_question_skus\":null},{\"id\":3,\"_type\":\"SurveyQuestion\",\"_subtype\":\"checkbox\",\"title\":{\"English\":\"What does Dr Pepper taste like?\"},\"shortname\":null,\"varname\":null,\"description\":[],\"has_showhide_deps\":null,\"properties\":{\"option_sort\":false,\"required\":false,\"hidden\":false,\"element_style\":\"OS\",\"orientation\":\"VERT\",\"minimum_response\":0,\"labels_right\":true,\"map_key\":\"checkbox\"},\"options\":[{\"id\":10004,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"Dr. Pepper\"},\"value\":\"Dr. Pepper\",\"properties\":null},{\"id\":10005,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"Chicken\"},\"value\":\"Chicken\",\"properties\":null},{\"id\":10006,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"Ramen Noodles\"},\"value\":\"Ramen Noodles\",\"properties\":null}],\"sub_question_skus\":null}]}}

data/spec/test_json/question.json

@@ -0,0 +1 @@
+{\"result_ok\":true,\"data\":{\"id\":2,\"_type\":\"SurveyQuestion\",\"_subtype\":\"radio\",\"title\":{\"English\":\"Do you like steak?\"},\"shortname\":null,\"varname\":null,\"description\":[],\"has_showhide_deps\":null,\"properties\":{\"option_sort\":false,\"required\":true,\"hidden\":false,\"orientation\":\"VERT\",\"labels_right\":true,\"map_key\":\"radio\"},\"options\":[{\"id\":10001,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"I like it\"},\"value\":\"I like it\",\"properties\":null},{\"id\":10002,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"I love it\"},\"value\":\"I love it\",\"properties\":null},{\"id\":10003,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"I want some more of it\"},\"value\":\"I want some more of it\",\"properties\":null}],\"sub_question_skus\":null}}

data/spec/test_json/survey.json

@@ -0,0 +1 @@
+{\"result_ok\":true,\"data\":{\"id\":\"1234\",\"team\":\"0\",\"_type\":\"Survey\",\"_subtype\":\"Standard Survey\",\"status\":\"In Design\",\"created_on\":\"2011-08-23 17:43:39\",\"modified_on\":\"2011-09-15 18:18:39\",\"languages\":[\"English\"],\"title\":\"Test Survey\",\"internal_title\":\"Test Survey\",\"title_ml\":{\"English\":\"Test Survey\"},\"theme\":\"11147\",\"statistics\":null,\"links\":{\"edit\":\"https:\\/\\/appv3.sgizmo.com\\/login\\/v1?authenticate=2593d488a24e1bb4a1267a44ad2cc3f607a23460&account_user_id=123456&r=%2Fprojects%2Feditor%3Fid%3D620263&signature=ba540c\",\"publish\":\"https:\\/\\/appv3.sgizmo.com\\/login\\/v1?authenticate=2593d488a24e1bb4a1267a44ad2cc3f607a23460&account_user_id=123456&r=%2Fprojects%2Fpromote%3Fid%3D620263&signature=5954e7\"},\"pages\":[{\"id\":1,\"_type\":\"SurveyPage\",\"title\":{\"English\":\"Page One\"},\"properties\":{\"hidden\":false},\"description\":[],\"questions\":[{\"id\":2,\"_type\":\"SurveyQuestion\",\"_subtype\":\"radio\",\"title\":{\"English\":\"Do you like steak?\"},\"shortname\":null,\"varname\":null,\"description\":[],\"has_showhide_deps\":null,\"properties\":{\"option_sort\":false,\"required\":true,\"hidden\":false,\"orientation\":\"VERT\",\"labels_right\":true,\"map_key\":\"radio\"},\"options\":[{\"id\":10001,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"I like it\"},\"value\":\"I like it\",\"properties\":null},{\"id\":10002,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"I love it\"},\"value\":\"I love it\",\"properties\":null},{\"id\":10003,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"I want some more of it\"},\"value\":\"I want some more of it\",\"properties\":null}],\"sub_question_skus\":null},{\"id\":3,\"_type\":\"SurveyQuestion\",\"_subtype\":\"checkbox\",\"title\":{\"English\":\"What does Dr Pepper taste like?\"},\"shortname\":null,\"varname\":null,\"description\":[],\"has_showhide_deps\":null,\"properties\":{\"option_sort\":false,\"required\":false,\"hidden\":false,\"element_style\":\"OS\",\"orientation\":\"VERT\",\"minimum_response\":0,\"labels_right\":true,\"map_key\":\"checkbox\"},\"options\":[{\"id\":10004,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"Dr. Pepper\"},\"value\":\"Dr. Pepper\",\"properties\":null},{\"id\":10005,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"Chicken\"},\"value\":\"Chicken\",\"properties\":null},{\"id\":10006,\"_type\":\"SurveyOption\",\"title\":{\"English\":\"Ramen Noodles\"},\"value\":\"Ramen Noodles\",\"properties\":null}],\"sub_question_skus\":null}]},{\"id\":2,\"_type\":\"SurveyPage\",\"title\":{\"English\":\"Thank You!\"},\"properties\":{\"hidden\":false},\"description\":[],\"questions\":[{\"id\":1,\"_type\":\"SurveyDecorative\",\"_subtype\":\"instructions\",\"title\":{\"English\":\"Thank you for taking our survey. Your response is very important to us.\"},\"shortname\":null,\"varname\":null,\"description\":[],\"has_showhide_deps\":null,\"properties\":{\"hidden\":false},\"options\":[],\"sub_question_skus\":null}]}]}}

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: survey-gizmo-ruby
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Kabari Hendrick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70260063096500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70260063096500
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70260063389380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70260063389380
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: &70260063597440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70260063597440
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70260063748800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70260063748800
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70260064153320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70260064153320
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70260065755920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70260065755920
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70260067262120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70260067262120
+description: ''
+email: self@ripthejacker.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/survey-gizmo-ruby.rb
+- lib/survey_gizmo/api/option.rb
+- lib/survey_gizmo/api/page.rb
+- lib/survey_gizmo/api/question.rb
+- lib/survey_gizmo/api/survey.rb
+- lib/survey_gizmo/collection.rb
+- lib/survey_gizmo/resource.rb
+- lib/survey_gizmo/survey_gizmo.rb
+- spec/spec_helper.rb
+- spec/support/model_cleanup.rb
+- spec/support/spec_shared_api_object.rb
+- spec/support/test_resource_classes.rb
+- spec/survey-gizmo-ruby_spec.rb
+- spec/test_json/page.json
+- spec/test_json/question.json
+- spec/test_json/survey.json
+homepage: http://github.com/RipTheJacker/survey-gizmo-ruby
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2566715168940454907
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: gem to consume the Survey Gizmo API
+test_files: []