survey-gizmo-ruby 0.7.1 → 0.9.6

data/Gemfile

@@ -1,15 +1,17 @@
-source "http://rubygems.org"
+source :rubygems
 
-gem "activesupport", '>= 3.0.1'
+gem "activesupport", '~> 3.0'
 gem 'i18n'
-gem 'virtus',      '~> 0.0.5'
+gem 'virtus'
 gem 'httparty'
+gem 'addressable', :require => "addressable/uri"
 
 group :development do
   gem 'bluecloth',    :require => nil
   gem "yard", "~> 0.7.0"
   gem "bundler", "~> 1.0"
   gem "jeweler", "~> 1.6.4"
+  gem 'awesome_print', :require => 'ap'
 end
 
 group :test do

data/Gemfile.lock

@@ -1,24 +1,26 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.1.3)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
       multi_json (~> 1.0)
-    addressable (2.2.6)
-    awesome_print (1.0.1)
+    addressable (2.3.2)
+    awesome_print (1.1.0)
+    backports (2.6.4)
     bluecloth (2.2.0)
     crack (0.3.1)
     diff-lcs (1.1.3)
     git (1.2.5)
-    httparty (0.8.1)
-      multi_json
+    httparty (0.9.0)
+      multi_json (~> 1.0)
       multi_xml
-    i18n (0.6.0)
+    i18n (0.6.1)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    multi_json (1.0.4)
-    multi_xml (0.4.1)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
     net-http-spy (0.2.1)
     rake (0.9.2.2)
     rspec (2.11.0)
@@ -26,20 +28,22 @@ GEM
       rspec-expectations (~> 2.11.0)
       rspec-mocks (~> 2.11.0)
     rspec-core (2.11.1)
-    rspec-expectations (2.11.2)
+    rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.2)
-    virtus (0.0.10)
-    webmock (1.7.8)
-      addressable (~> 2.2, > 2.2.5)
+    rspec-mocks (2.11.3)
+    virtus (0.5.2)
+      backports (~> 2.6.1)
+    webmock (1.8.11)
+      addressable (>= 2.2.7)
       crack (>= 0.1.7)
-    yard (0.7.4)
+    yard (0.7.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (>= 3.0.1)
+  activesupport (~> 3.0)
+  addressable
   awesome_print
   bluecloth
   bundler (~> 1.0)
@@ -48,6 +52,6 @@ DEPENDENCIES
   jeweler (~> 1.6.4)
   net-http-spy
   rspec (~> 2.11.0)
-  virtus (~> 0.0.5)
+  virtus
   webmock
   yard (~> 0.7.0)

data/README.md

@@ -1,6 +1,6 @@
 # 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**.
+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 **v3**. If you want to use version 1 of the API, please use gem version ~0.7.0
 
 ## Installation
 
@@ -28,9 +28,9 @@ Integrate with the [Survey Gizmo API](http://developer.surveygizmo.com/resources
 	
 ## 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:
+Currently, the following API objects are included in the gem: `Survey`, `Question`, `Option`, `Page`, `Response`, `EmailMessage`, `SurveyCampaign`, `Contact`. 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 how to do so:
 
-	class Survey
+	class SomeObject
 	  # the base where most of the methods for handling the API are stored
 	  include SurveyGizmo::Resource
       
@@ -38,12 +38,12 @@ Currently, the following API objects are included in the gem: `Survey`, `Questio
 	  attribute :id,          Integer
 	  attribute :title,       String
 	  attribute :status,      String
-	  attribute :type,        String,   :default => 'survey'
+	  attribute :type,        String
 	  attribute :created_on,  DateTime
   
       # defing the paths used to retrieve/set info
-	  route '/survey/:id', :via => [:get, :update, :delete]
-	  route '/survey',     :via => :create
+	  route '/something/:id', :via => [:get, :update, :delete]
+	  route '/something',     :via => :create
   		
       # this must be defined with the params that would be included in any route
 	  def to_param_options
@@ -70,6 +70,6 @@ There are several API objects that are available and not included in this gem. I
 
 # Copyright
 
-Copyright (c) 2011 RipTheJacker. See LICENSE.txt for
+Copyright (c) 2012 RipTheJacker. See LICENSE.txt for
 further details.
 

data/Rakefile

@@ -17,10 +17,10 @@ Jeweler::Tasks.new do |gem|
   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.summary     = %Q{gem to use the Survey Gizmo REST API}
+  gem.description = %Q{gem to use the SurveyGizmo.com REST API, v3+}
   gem.email       = "self@ripthejacker.com"
-  gem.authors     = ["Kabari Hendrick"]
+  gem.authors     = ["Kabari Hendrick", "Chris Horn"]
   gem.files       = FileList['lib/**/*.rb', 'Gemfile*', '[A-Z]*', 'Rakefile', 'spec/**/*'].to_a
   # dependencies defined in Gemfile
 end

data/VERSION

@@ -1 +1 @@
-0.7.1
+0.9.6

data/lib/survey_gizmo/api/contact.rb

@@ -0,0 +1,49 @@
+module SurveyGizmo; module API
+  # @see SurveyGizmo::Resource::ClassMethods
+  class Contact
+    include SurveyGizmo::Resource
+
+    # @macro [attach] virtus_attribute
+    #   @return [$2]
+    attribute :id,                      Integer
+    attribute :survey_id,               Integer
+    attribute :campaign_id,             Integer
+    attribute :estatus,                 String
+    attribute :esubscriberstatus,       String
+    attribute :semailaddress,           String
+    attribute :sfirstname,              String
+    attribute :slastname,               String
+    attribute :sorganization,           String
+    attribute :sdepartment,             String
+    attribute :sbusinessphone,          String
+    attribute :shomephone,              String
+    attribute :sfaxphone,               String
+    attribute :sworkphone,              String
+    attribute :smailingaddress,         String
+    attribute :smailingaddress2,        String
+    attribute :smailingaddresscity,     String
+    attribute :smailingaddressstate,    String
+    attribute :smailingaddresscountry,  String
+    attribute :smailingaddresspostal,   String
+    attribute :stitle,                  String
+    attribute :surl,                    String
+    attribute :scustomfield1,           String
+    attribute :scustomfield2,           String
+    attribute :scustomfield3,           String
+    attribute :scustomfield4,           String
+    attribute :scustomfield5,           String
+    attribute :scustomfield6,           String
+    attribute :scustomfield7,           String
+    attribute :scustomfield8,           String
+    attribute :scustomfield9,           String
+    attribute :scustomfield10,          String
+
+    route '/survey/:survey_id/surveycampaign/:campaign_id/contact/:id', :via => [:get, :update, :delete]
+    route '/survey/:survey_id/surveycampaign/:campaign_id/contact', :via => :create
+
+    # @see SurveyGizmo::Resource#to_param_options
+    def to_param_options
+      {:id => self.id, :survey_id => self.survey_id, :campaign_id => self.campaign_id}
+    end
+  end
+end; end

data/lib/survey_gizmo/api/email_message.rb

@@ -0,0 +1,33 @@
+module SurveyGizmo; module API
+  # @see SurveyGizmo::Resource::ClassMethods
+  class EmailMessage
+    include SurveyGizmo::Resource
+
+    # @macro [attach] virtus_attribute
+    #   @return [$2]
+    attribute :id,                Integer
+    attribute :survey_id,         Integer
+    attribute :campaign_id,       Integer
+    attribute :invite_identity,   Integer
+    attribute :_type,             String
+    attribute :_subtype,          String
+    attribute :subject,           String
+    attribute :replies,           String
+    attribute :messagetype,       String
+    attribute :medium,            String
+    attribute :status,            String
+    attribute :from,              Hash
+    attribute :body,              Hash
+    attribute :send,              Boolean
+    attribute :datecreated,       DateTime
+    attribute :datemodified,      DateTime
+
+    route '/survey/:survey_id/surveycampaign/:campaign_id/emailmessage/:id', :via => [:get, :update, :delete]
+    route '/survey/:survey_id/surveycampaign/:campaign_id/emailmessage', :via => :create
+
+    # @see SurveyGizmo::Resource#to_param_options
+    def to_param_options
+      {:id => self.id, :survey_id => self.survey_id, :campaign_id => self.campaign_id}
+    end
+  end
+end; end

data/lib/survey_gizmo/api/option.rb

@@ -2,20 +2,21 @@ module SurveyGizmo; module API
   # @see SurveyGizmo::Resource::ClassMethods
   class Option
     include SurveyGizmo::Resource
-    
+
     # @macro [attach] virtus_attribute
     #   @return [$2]
     attribute :id,            Integer
-    attribute :title,         String
-    attribute :value,         String
     attribute :survey_id,     Integer
     attribute :page_id,       Integer
     attribute :question_id,   Integer
-        
+    attribute :title,         String
+    attribute :value,         String
+    attribute :properties,    Hash
+
     # 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)
@@ -23,11 +24,11 @@ module SurveyGizmo; module API
     end
 
     alias_method_chain :title=, :multilingual
-    
+
     # @see SurveyGizmo::Resource#to_param_options
     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

@@ -2,7 +2,7 @@ module SurveyGizmo; module API
   # @see SurveyGizmo::Resource::ClassMethods
   class Page
     include SurveyGizmo::Resource
-    
+
     # @macro [attach] virtus_attribute
     #   @return [$2]
     attribute :id,            Integer
@@ -11,15 +11,15 @@ module SurveyGizmo; module API
     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]
-    
+
     # @macro collection
     collection :questions
-    
+
     # survey gizmo sends a hash back for :title
     # @private
     def title_with_multilingual=(val)
@@ -27,8 +27,8 @@ module SurveyGizmo; module API
     end
 
     alias_method_chain :title=, :multilingual
-    
-    # @see SurveyGizmo::Resource#to_param_options 
+
+    # @see SurveyGizmo::Resource#to_param_options
     def to_param_options
       {:id => self.id, :survey_id => self.survey_id}
     end

data/lib/survey_gizmo/api/question.rb

@@ -2,27 +2,28 @@ module SurveyGizmo; module API
   # @see SurveyGizmo::Resource::ClassMethods
   class Question
     include SurveyGizmo::Resource
-    
+
     # @macro [attach] virtus_attribute
     #   @return [$2]
     attribute :id,            Integer
     attribute :title,         String
     attribute :type,          String
     attribute :description,   String
+    attribute :shortname,     String
     attribute :properties,    Hash
     attribute :after,         Integer
     attribute :survey_id,     Integer
     attribute :page_id,       Integer, :default => 1
-    
+
     alias_attribute :_subtype, :type
-    
+
     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]
-    
+
     # @macro collection
     collection :options
-    
+
     # survey gizmo sends a hash back for :title
     # @private
     def title_with_multilingual=(val)
@@ -30,8 +31,8 @@ module SurveyGizmo; module API
     end
 
     alias_method_chain :title=, :multilingual
-    
-    # @see SurveyGizmo::Resource#to_param_options 
+
+    # @see SurveyGizmo::Resource#to_param_options
     def to_param_options
       {:id => self.id, :survey_id => self.survey_id, :page_id => self.page_id}
     end

data/lib/survey_gizmo/api/response.rb

@@ -2,22 +2,31 @@ module SurveyGizmo; module API
   # @see SurveyGizmo::Resource::ClassMethods
   class Response
     include SurveyGizmo::Resource
-    
+
     # @macro [attach] virtus_attribute
     #   @return [$2] the attribute +$1+ as a $2
-    attribute :id,            Integer
-    attribute :data,          String
-    attribute :status,        String
-    attribute :survey_id,     Integer
-        
+    attribute :id,                   Integer
+    attribute :survey_id,            Integer
+    attribute :contact_id,           Integer
+    attribute :data,                 String
+    attribute :status,               String
+    attribute :date_submitted,       DateTime
+    attribute :is_test_data,         Boolean
+    attribute :sResponseComment,     String
+    attribute :variable,             Hash       # READ-ONLY
+    attribute :meta,                 Hash       # READ-ONLY
+    attribute :shown,                Hash       # READ-ONLY
+    attribute :url,                  Hash       # READ-ONLY
+    attribute :answers,              Hash       # READ-ONLY
+
     # routing
     route '/survey/:survey_id/surveyresponse',     :via => :create
     route '/survey/:survey_id/surveyresponse/:id', :via => [:get, :update, :delete]
-    
-    # @see SurveyGizmo::Resource#to_param_options 
+
+    # @see SurveyGizmo::Resource#to_param_options
     def to_param_options
       {:id => self.id, :survey_id => self.survey_id}
     end
-  
+
   end
 end; end

data/lib/survey_gizmo/api/survey.rb

@@ -2,23 +2,33 @@ module SurveyGizmo; module API
   # @see SurveyGizmo::Resource::ClassMethods
   class Survey
     include SurveyGizmo::Resource
-    
+
     # @macro [attach] virtus_attribute
     #   @return [$2]
-    attribute :id,          Integer
-    attribute :title,       String    
-    attribute :status,      String
-    attribute :type,        String,   :default => 'survey'
-    attribute :links,       Hash
-    attribute :created_on,  DateTime
-    
+    attribute :id,             Integer
+    attribute :team,           Integer
+    attribute :_type,          String
+    attribute :_subtype,       String
+    attribute :status,         String
+    attribute :forward_only,   Boolean
+    attribute :title,          String
+    attribute :internal_title, String
+    attribute :title_ml,       Hash
+    attribute :links,          Hash
+    attribute :theme,          Integer
+    attribute :blockby,        String
+    attribute :languages,      Array
+    attribute :statistics,     Array
+    attribute :created_on,     DateTime
+    attribute :modified_on,    DateTime
+
     route '/survey/:id', :via => [:get, :update, :delete]
     route '/survey',     :via => :create
-    
+
     # @macro collection
     collection :pages
-        
-    # @see SurveyGizmo::Resource#to_param_options    
+
+    # @see SurveyGizmo::Resource#to_param_options
     def to_param_options
       {:id => self.id}
     end

data/lib/survey_gizmo/api/survey_campaign.rb

@@ -0,0 +1,33 @@
+module SurveyGizmo; module API
+  # @see SurveyGizmo::Resource::ClassMethods
+  class SurveyCampaign
+    include SurveyGizmo::Resource
+
+    # @macro [attach] virtus_attribute
+    #   @return [$2]
+    attribute :id,              Integer
+    attribute :name,            String
+    attribute :_type,           String
+    attribute :_subtype,        String
+    attribute :__subtype,       String
+    attribute :status,          String
+    attribute :uri,             String
+    attribute :SSL,             Boolean
+    attribute :slug,            String
+    attribute :language,        String
+    attribute :close_message,   String
+    attribute :limit_responses, String
+    attribute :tokenvariables,  Array
+    attribute :survey_id,       Integer
+    attribute :datecreated,     DateTime
+    attribute :datemodified,    DateTime
+
+    route '/survey/:survey_id/surveycampaign/:id', :via => [:get, :update, :delete]
+    route '/survey/:survey_id/surveycampaign', :via => :create
+
+    # @see SurveyGizmo::Resource#to_param_options
+    def to_param_options
+      {:id => self.id, :survey_id => self.survey_id}
+    end
+  end
+end; end

data/lib/survey_gizmo/collection.rb

@@ -1,9 +1,9 @@
 module SurveyGizmo
   class Collection
     include Enumerable
-    
+
     private
-    # @param [Class] resource 
+    # @param [Class] resource
     # @param [Symbol] name
     # @param [Array] values in hashes
     def initialize(resource, name, values)
@@ -12,14 +12,14 @@ module SurveyGizmo
       @loaded         = false
       @options        = resource.collections[name]
     end
-    
+
     public
-    
+
     # @private
     def length
       @array.length
     end
-    
+
     # @private
     def each
       lazy_load
@@ -29,13 +29,13 @@ module SurveyGizmo
         @collection.each
       end
     end
-    
+
     # @private
     def method_missing(meth, *args, &blk)
       lazy_load
       @collection.send(meth, *args, &blk)
     end
-    
+
     # @private
     def model
       return @model if defined?(@model)
@@ -43,31 +43,31 @@ module SurveyGizmo
       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    
+      @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

@@ -1,30 +1,42 @@
 require "set"
+require "addressable/uri"
 
 module SurveyGizmo
   module Resource
     extend ActiveSupport::Concern
-    
+
     included do
       include Virtus
       instance_variable_set('@paths', {})
       instance_variable_set('@collections', {})
       SurveyGizmo::Resource.descendants << self
     end
-    
+
     # @return [Set] Every class that includes SurveyGizmo::Resource
     def self.descendants
       @descendants ||= Set.new
     end
-    
+
     # These are methods that every API resource has to access resources
     # in Survey Gizmo
     module ClassMethods
-      
+
+      # Convert a [Hash] of filters into a query string
+      # @param [Hash] filters
+      # @return [String]
+      def convert_filters_into_query_string(filters = nil)
+        "" unless filters && filters.size > 0
+        uri = Addressable::URI.new
+        uri.query_values = filters
+        "?#{uri.query}"
+      end
+
       # Get a list of resources
       # @param [Hash] conditions
+      # @param [Hash] filters
       # @return [SurveyGizmo::Collection, Array]
-      def all(conditions = {})
-        response = Response.new SurveyGizmo.get(handle_route(:create, conditions))
+      def all(conditions = {}, filters = nil)
+        response = Response.new SurveyGizmo.get(handle_route(:create, conditions) + convert_filters_into_query_string(filters))
         if response.ok?
           _collection = SurveyGizmo::Collection.new(self, nil, response.data)
           _collection.send(:options=, {:target => self, :parent => self})
@@ -33,15 +45,16 @@ module SurveyGizmo
           []
         end
       end
-      
+
       # Get the first resource
       # @param [Hash] conditions
+      # @param [Hash] filters
       # @return [Object, nil]
-      def first(conditions)
-        response = Response.new SurveyGizmo.get(handle_route(:get, conditions))
+      def first(conditions = {}, filters = nil)
+        response = Response.new SurveyGizmo.get(handle_route(:get, conditions) +  convert_filters_into_query_string(filters))
         response.ok? ? load(conditions.merge(response.data)) : nil
       end
-      
+
       # Create a new resource
       # @param [Hash] attributes
       # @return [Resource]
@@ -51,7 +64,7 @@ module SurveyGizmo
         resource.__send__(:_create)
         resource
       end
-      
+
       # Deleted the Resource from Survey Gizmo
       # @param [Hash] conditions
       # @return [Boolean]
@@ -59,11 +72,11 @@ module SurveyGizmo
         response = Response.new SurveyGizmo.delete(handle_route(:delete, conditions))
         response.ok?
       end
-      
+
       # Define the path where a resource is located
-      # @param [String] path 
+      # @param [String] path
       #   the path in Survey Gizmo for the resource
-      # @param [Hash] options 
+      # @param [Hash] options
       # @option options [Array] :via
       #     which is `:get`, `:create`, `:update`, `:delete`, or `:any`
       # @scope class
@@ -73,19 +86,19 @@ module SurveyGizmo
         methods.is_a?(Array) ? methods.each{|m| @paths[m] = path } : (@paths[methods] = path)
         nil
       end
-      
+
       # @api private
       def load(attributes = {})
         resource = new(attributes)
         resource.__send__(:clean!)
         resource
       end
-      
+
       # Defines a new collection. These are child objects of the resource.
       # @macro [new] collection
       #   @param [Symbol] resource_name the name of the collection, pluralized
       #   @param [Class] model and optional class name if the class name does not match the resource_name
-      #   @return [Collection] 
+      #   @return [Collection]
       #     the $1 collection
       #   @scope instance
       def collection(resource_name, model = nil)
@@ -94,29 +107,29 @@ module SurveyGizmo
           def #{resource_name}
             @#{resource_name} ||= []
           end
-          
+
           def #{resource_name}=(array)
             @#{resource_name} = SurveyGizmo::Collection.new(#{self}, :#{resource_name}, array)
           end
         EOS
       end
-      
+
       # @api private
       def collections
         @collections.dup.freeze
       end
-      
+
       # @api private
       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+)/) do |m| 
+        path.gsub(/:(\w+)/) do |m|
           options[$1.to_sym].tap{ |result| raise(SurveyGizmo::URLError, "Missing parameters in request: `#{m}`") unless result }
         end
       end
     end
-    
+
     # Updates attributes and saves this Resource instance
     #
     # @param [Hash] attributes
@@ -128,7 +141,7 @@ module SurveyGizmo
       self.attributes = attributes
       self.save
     end
-    
+
     # Save the instance to Survey Gizmo
     #
     # @return [Boolean]
@@ -142,21 +155,21 @@ module SurveyGizmo
         end
       end
     end
-    
+
     # fetch resource from SurveyGizmo and reload the attributes
     # @return [self, false]
     #   Returns the object, if saved. Otherwise returns false.
     def reload
       handle_response SurveyGizmo.get(handle_route(:get)) do
-        if _response.ok? 
+        if _response.ok?
           self.attributes = _response.data
           clean!
         else
           false
         end
-      end  
+      end
     end
-    
+
     # Deleted the Resource from Survey Gizmo
     # @return [Boolean]
     def destroy
@@ -165,13 +178,13 @@ module SurveyGizmo
         _response.ok? ? destroyed! : false
       end
     end
-    
+
     # The state of the current Resource
     # @api private
     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
@@ -184,84 +197,135 @@ module SurveyGizmo
         @_state = state
         true
       end
-      
+
       # Inquire about the method state if $1
       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
     def to_param_options
       raise "Define #to_param_options in #{self.class.name}"
     end
-    
+
     # Any errors returned by Survey Gizmo
     # @return [Array]
     def errors
       @errors ||= []
     end
     
+    # @return [Hash] The raw JSON returned by Survey Gizmo
+    def raw_response
+      _response.response if _response
+    end
+    
     # @visibility private
     def inspect
       attrs = self.class.attributes.map do |attrib|
         value = attrib.get!(self).inspect
 
-        "#{attrib.instance_variable_name}=#{value}"
+        "#{attrib.instance_variable_name}=#{value}" if attrib.respond_to?(:instance_variable_name)
       end
 
       "#<#{self.class.name}:#{self.object_id} #{attrs.join(' ')}>"
     end
-    
+
     # This class normalizes the response returned by Survey Gizmo
     class Response
       def ok?
         @response['result_ok']
       end
-      
+
       # The parsed JSON data of the response
       def data
         @_data ||= (@response['data'] || {})
       end
-      
+
       # The error message if there is one
       def message
         @_message ||= @response['message']
       end
       
+      attr_reader :response
+      
       private
+      def cleanup_attribute_name(attr)
+        attr.downcase.gsub(/[^[:alnum:]]+/,'_').gsub(/(url|variable|standard|shown)/,'').gsub(/_+/,'_').gsub(/^_/,'').gsub(/_$/,'')
+      end
+
+      def find_attribute_parent(attr)
+        case attr.downcase
+        when /url/
+          "url"
+        when /variable.*standard/
+          "meta"
+        when /variable.*shown/
+          "shown"
+        when /variable/
+          "variable"
+        when /question/
+          "answers"
+        end
+      end
+
       def initialize(response)
         @response = response.parsed_response
+        return unless @response['data'].class == Hash
+        @_data = @response['data']
+
+        # Handle really crappy [] notation in SG API, so far just in SurveyResponse
+        @_data.keys.grep(/^\[/).each do |key|
+          next unless @_data[key].length > 0
+
+          parent = find_attribute_parent(key)
+          @_data[parent] = {} unless @_data[parent]
+
+          case key.downcase
+          when /(url|variable.*standard)/
+            @_data[parent][cleanup_attribute_name(key).to_sym] = @_data[key]
+          when /variable.*shown/
+            @_data[parent][cleanup_attribute_name(key).to_i] = @_data[key].include?("1")
+          when /variable/
+            @_data[parent][cleanup_attribute_name(key).to_i] = @_data[key].to_i
+          when /question/
+            @_data[parent][key] = @_data[key]
+          end
+
+          @_data.delete(key)
+        end
       end
     end
     
-    protected
     
+    protected
+
     def attributes_without_blanks
       self.attributes.reject{|k,v| v.blank? }
     end
-    
+
     private
+    # The response object from SurveyGizmo. Useful for viewing the raw data returned
     attr_reader :_response
-    
+
     def set_response(http)
       @_response = Response.new(http)
     end
-    
+
     def handle_route(key)
       self.class.handle_route(key, to_param_options)
     end
-    
+
     def handle_response(resp, &block)
       set_response(resp)
       (self.errors << _response.message) unless _response.ok?
       self.errors.clear if !self.errors.empty? && _response.ok?
       instance_eval(&block)
     end
-    
+
     def _create(attributes = {})
       http = SurveyGizmo.put(handle_route(:create), :query => self.attributes_without_blanks)
       handle_response http do
@@ -270,9 +334,9 @@ module SurveyGizmo
           saved!
         else
           false
-        end      
+        end
       end
     end
-    
+
   end
 end

data/lib/survey_gizmo/survey_gizmo.rb

@@ -10,24 +10,28 @@ require "survey_gizmo/resource"
 require "survey_gizmo/collection"
 
 require "survey_gizmo/api/survey"
+require "survey_gizmo/api/survey_campaign"
 require "survey_gizmo/api/question"
 require "survey_gizmo/api/option"
 require "survey_gizmo/api/page"
+require "survey_gizmo/api/contact"
 require "survey_gizmo/api/response"
+require "survey_gizmo/api/email_message"
 
 module SurveyGizmo
   include HTTParty
-  
+  debug_output $stderr if ENV['GIZMO_DEBUG']
+
   format :json
-  
+
   URLError = Class.new(RuntimeError)
-  
+
   # The base uri for this version of the API is $1
-  base_uri 'https://restapi.surveygizmo.com/v1'
-  
+  base_uri 'https://restapi.surveygizmo.com/v3'
+
   @@options = {}
   mattr_accessor :options
-  
+
   # Setup the account credentials to access the API
   # @param [Hash] opts
   # @option opts [#to_s] :user
@@ -38,5 +42,5 @@ module SurveyGizmo
     self.options = opts
     default_params({"user:pass" => opts.values_at(:user, :password).join(':')})
   end
-  
+
 end

data/spec/resource_spec.rb

@@ -47,7 +47,7 @@ describe "Survey Gizmo Resource" do
   end
 
   describe SurveyGizmo::API::Survey do
-    let(:create_attributes){ {:title => 'Spec', :type => 'survey', :status => 'In Design'} }
+    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} }

data/spec/spec_helper.rb

@@ -14,7 +14,7 @@ RSpec.configure do |config|
   config.include SurveyGizmoSpec::Methods
   
   config.before(:each) do
-    @base = 'https://restapi.surveygizmo.com/v1'
+    @base = 'https://restapi.surveygizmo.com/v3'
   end
   
   config.after(:suite) do

data/spec/survey-gizmo-ruby_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe "SurveyGizmo" do  
   it "should have a base uri" do
-    SurveyGizmo.base_uri.should == 'https://restapi.surveygizmo.com/v1'
+    SurveyGizmo.base_uri.should == 'https://restapi.surveygizmo.com/v3'
   end
   
   it "should allow basic authentication configuration" do
@@ -89,17 +89,18 @@ describe "SurveyGizmo" do
       end
       
       it "can handle nested collections" do
+        pending("Needs to be changed to work with suite. Right now it only passes in isolation.")
         SurveyGizmoSpec::ResourceTest.collection :generic_resources
-        @array2 = [
+        @generic_resource_list = [
           {:id => 1, :title => 'Generic Test 5'},
           {:id => 2, :title => 'Generic Test 6'},
           {:id => 3, :title => 'Generic Test 7'}
         ]      
         
-        @array << {:id => 99, :generic_resources => @array2}
+        @array << {:id => 99, :generic_resources => @generic_resource_list}
         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)
+        obj.resources.detect{|r| r.id == 99 }.generic_resources.first.should be_instance_of(SurveyGizmoSpec::GenericResource)
       end
     end
   end  

metadata

@@ -1,30 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: survey-gizmo-ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.9.6
   prerelease: 
 platform: ruby
 authors:
 - Kabari Hendrick
+- Chris Horn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-22 00:00:00.000000000 Z
+date: 2012-10-09 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70264289751960 !ruby/object:Gem::Requirement
+  requirement: &70327435758280 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70264289751960
+  version_requirements: *70327435758280
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70264289751200 !ruby/object:Gem::Requirement
+  requirement: &70327435756840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,21 +33,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70264289751200
+  version_requirements: *70327435756840
 - !ruby/object:Gem::Dependency
   name: virtus
-  requirement: &70264289750360 !ruby/object:Gem::Requirement
+  requirement: &70327435748540 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70264289750360
+  version_requirements: *70327435748540
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70264289749540 !ruby/object:Gem::Requirement
+  requirement: &70327435746040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +55,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70264289749540
+  version_requirements: *70327435746040
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: &70327435744300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70327435744300
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &70264289725700 !ruby/object:Gem::Requirement
+  requirement: &70327435742600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70264289725700
+  version_requirements: *70327435742600
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70264289724740 !ruby/object:Gem::Requirement
+  requirement: &70327435741380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +88,10 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *70264289724740
+  version_requirements: *70327435741380
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70264289724080 !ruby/object:Gem::Requirement
+  requirement: &70327435729640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +99,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70264289724080
+  version_requirements: *70327435729640
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70264289723040 !ruby/object:Gem::Requirement
+  requirement: &70327435724260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,8 +110,19 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70264289723040
-description: ''
+  version_requirements: *70327435724260
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: &70327435712160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70327435712160
+description: gem to use the SurveyGizmo.com REST API, v3+
 email: self@ripthejacker.com
 executables: []
 extensions: []
@@ -114,11 +137,14 @@ files:
 - Rakefile
 - VERSION
 - lib/survey-gizmo-ruby.rb
+- lib/survey_gizmo/api/contact.rb
+- lib/survey_gizmo/api/email_message.rb
 - lib/survey_gizmo/api/option.rb
 - lib/survey_gizmo/api/page.rb
 - lib/survey_gizmo/api/question.rb
 - lib/survey_gizmo/api/response.rb
 - lib/survey_gizmo/api/survey.rb
+- lib/survey_gizmo/api/survey_campaign.rb
 - lib/survey_gizmo/collection.rb
 - lib/survey_gizmo/resource.rb
 - lib/survey_gizmo/survey_gizmo.rb
@@ -148,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1188549938639229754
+      hash: 1680038984146331974
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -157,8 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
-summary: gem to consume the Survey Gizmo API
+summary: gem to use the Survey Gizmo REST API
 test_files: []