survey-gizmo-ruby 0.5.0 → 0.6.0

data/Gemfile

@@ -1,12 +1,13 @@
 source "http://rubygems.org"
 
-gem "activesupport", '~> 3.0.1'
+gem "activesupport", '>= 3.0.1'
 gem 'i18n'
 gem 'virtus',      '~> 0.0.5'
 gem 'httparty'
 
 group :development do
-  gem "yard", "~> 0.6.0"
+  gem 'bluecloth',    :require => nil
+  gem "yard", "~> 0.7.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
 end
@@ -15,4 +16,5 @@ group :test do
   gem "webmock", :require => 'webmock/rspec'
   gem "rspec", "~> 2.3.0"
   gem 'net-http-spy', :require => nil
+  gem 'awesome_print', :require => nil
 end

data/Gemfile.lock

@@ -1,23 +1,26 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.0.10)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
     addressable (2.2.6)
-    crack (0.1.8)
+    awesome_print (1.0.1)
+    bluecloth (2.2.0)
+    crack (0.3.1)
     diff-lcs (1.1.3)
     git (1.2.5)
-    httparty (0.8.0)
+    httparty (0.8.1)
       multi_json
       multi_xml
-    i18n (0.5.0)
+    i18n (0.6.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    multi_json (1.0.3)
-    multi_xml (0.4.0)
+    multi_json (1.0.4)
+    multi_xml (0.4.1)
     net-http-spy (0.2.1)
-    rake (0.9.2)
+    rake (0.9.2.2)
     rspec (2.3.0)
       rspec-core (~> 2.3.0)
       rspec-expectations (~> 2.3.0)
@@ -26,17 +29,19 @@ GEM
     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)
+    virtus (0.0.10)
+    webmock (1.7.8)
+      addressable (> 2.2.5, ~> 2.2)
       crack (>= 0.1.7)
-    yard (0.6.8)
+    yard (0.7.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 3.0.1)
+  activesupport (>= 3.0.1)
+  awesome_print
+  bluecloth
   bundler (~> 1.0.0)
   httparty
   i18n
@@ -45,4 +50,4 @@ DEPENDENCIES
   rspec (~> 2.3.0)
   virtus (~> 0.0.5)
   webmock
-  yard (~> 0.6.0)
+  yard (~> 0.7.0)

data/README.md

@@ -4,7 +4,7 @@ Integrate with the [Survey Gizmo API](http://developer.surveygizmo.com/resources
 
 ## Installation
 
-The gem hasn't been pushed to rubygems.org yet, so for now just install from the repo with rake.
+    gem install survey-gizmo-ruby
 
 ## Basic Usage
 
@@ -13,10 +13,19 @@ The gem hasn't been pushed to rubygems.org yet, so for now just install from the
 	# somewhere in your app define your survey gizmo login credentials.
 	SurveyGizmo.setup(:user => 'you@somewhere.com', :password => 'mypassword')
 	
-	SurveyGizmo::API::Survey.first(:id => 12345)
+	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']
 	
-	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:

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/lib/survey_gizmo/api/option.rb

@@ -1,16 +1,19 @@
 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 :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',     :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
@@ -21,8 +24,10 @@ module SurveyGizmo; module API
 
     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

@@ -1,7 +1,10 @@
 module SurveyGizmo; module API
+  # @see SurveyGizmo::Resource::ClassMethods
   class Page
     include SurveyGizmo::Resource
     
+    # @macro [attach] virtus_attribute
+    #   @return [$2]
     attribute :id,            Integer
     attribute :title,         String
     attribute :description,   String
@@ -14,6 +17,7 @@ module SurveyGizmo; module API
     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
@@ -24,6 +28,7 @@ module SurveyGizmo; module API
 
     alias_method_chain :title=, :multilingual
     
+    # @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

@@ -1,7 +1,10 @@
 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
@@ -9,15 +12,15 @@ module SurveyGizmo; module API
     attribute :properties,    Hash
     attribute :after,         Integer
     attribute :survey_id,     Integer
-    attribute :page_id,       Integer
+    attribute :page_id,       Integer, :default => 1
     
     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]
     
+    # @macro collection
     collection :options
     
     # survey gizmo sends a hash back for :title
@@ -28,6 +31,7 @@ module SurveyGizmo; module API
 
     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}
     end

data/lib/survey_gizmo/api/response.rb

@@ -0,0 +1,23 @@
+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
+        
+    # routing
+    route '/survey/:survey_id/surveyresponse',     :via => :create
+    route '/survey/:survey_id/surveyresponse/:id', :via => [:get, :update, :delete]
+    
+    # @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

@@ -1,18 +1,24 @@
 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 :title,       String    
     attribute :status,      String
     attribute :type,        String,   :default => 'survey'
+    attribute :links,       Hash
     attribute :created_on,  DateTime
     
     route '/survey/:id', :via => [:get, :update, :delete]
     route '/survey',     :via => :create
     
+    # @macro collection
     collection :pages
-    
+        
+    # @see SurveyGizmo::Resource#to_param_options    
     def to_param_options
       {:id => self.id}
     end

data/lib/survey_gizmo/collection.rb

@@ -5,7 +5,7 @@ module SurveyGizmo
     private
     # @param [Class] resource 
     # @param [Symbol] name
-    # @param [Array] values
+    # @param [Array] values in hashes
     def initialize(resource, name, values)
       @array          = Array(values)
       @collection     = []
@@ -15,23 +15,28 @@ module SurveyGizmo
     
     public
     
+    # @private
     def length
       @array.length
     end
     
+    # @private
     def each
       lazy_load
       if block_given?
-        @collection.each{ |o| yield(o)}
+        @collection.each{ |o| yield(o) }
       else
         @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)
       return (@model = options[:target]) if options[:target].is_a?(Class)

data/lib/survey_gizmo/resource.rb

@@ -11,47 +11,41 @@ module SurveyGizmo
       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
       
       # Get a list of resources
       # @param [Hash] conditions
-      # @return [SurveGizmo::Collection, false]
+      # @return [SurveyGizmo::Collection, Array]
       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
+        response = Response.new SurveyGizmo.get(handle_route(:create, conditions))
+        if response.ok?
+          _collection = SurveyGizmo::Collection.new(self, nil, 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]
+      # @return [Object, nil]
       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
+        response = Response.new SurveyGizmo.get(handle_route(:get, conditions))
+        response.ok? ? load(conditions.merge(response.data)) : nil
       end
       
       # Create a new resource
       # @param [Hash] attributes
-      # @return [Object]
+      # @return [Resource]
+      #   The newly created Resource instance
       def create(attributes = {})
         resource = new(attributes)
         resource.__send__(:_create)
@@ -59,8 +53,12 @@ module SurveyGizmo
       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`
+      # @param [String] path 
+      #   the path in Survey Gizmo for the resource
+      # @param [Hash] options 
+      # @option options [Array] :via
+      #     which is `:get`, `:create`, `:update`, `:delete`, or `:any`
+      # @scope class
       def route(path, options)
         methods = options[:via]
         methods = [:get, :create, :update, :delete] if methods == :any
@@ -68,13 +66,20 @@ module SurveyGizmo
         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] 
+      #     the $1 collection
+      #   @scope instance
       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)
@@ -88,10 +93,12 @@ module SurveyGizmo
         EOS
       end
       
+      # @api private
       def collections
-        @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
@@ -99,56 +106,76 @@ module SurveyGizmo
         path.gsub(/:(\w+)/){|m| options[$1.to_sym] }
       end
     end
-        
+    
+    # Updates attributes and saves this Resource instance
+    #
+    # @param [Hash] attributes
+    #   attributes to be updated
+    #
+    # @return [Boolean]
+    #   true if resource is saved
     def update(attributes = {})
       self.attributes = attributes
       self.save
     end
     
+    # Save the instance to Survey Gizmo
+    #
+    # @return [Boolean]
+    #   true if Resource instance is saved
     def save
-      response = SurveyGizmo.post(handle_route(:update), :query => self.attributes_without_blanks)
-      _result = response.parsed_response['result_ok']
-      saved! if _result
-      _result
+      if new?
+        _create
+      else
+        handle_response SurveyGizmo.post(handle_route(:update), :query => self.attributes_without_blanks), do 
+          _response.ok? ? saved! : false
+        end
+      end
     end
     
     # fetch resource from SurveyGizmo and reload the attributes
+    # @return [self, false]
+    #   Returns the object, if saved. Otherwise returns false.
     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
+      handle_response SurveyGizmo.get(handle_route(:get)), do
+        if _response.ok? 
+          self.attributes = _response.data
+          clean!
+        else
+          false
+        end
       end  
     end
     
+    # Deleted the Resource from Survey Gizmo
+    # @return [Boolean]
     def destroy
-      return false if new?
-      response = SurveyGizmo.delete(handle_route(:delete))
-      _result = response.parsed_response['result_ok']
-      destroyed! if _result
-      _result
+      return false if new? || destroyed?
+      handle_response SurveyGizmo.delete(handle_route(:delete)), do
+        _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.
+    #   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|
+      # Change the method state to $1
       define_method("#{state}!") do
         @_state = state
+        true
       end
       
+      # Inquire about the method state if $1
       define_method("#{state}?") do
         @_state == state
       end
@@ -157,11 +184,18 @@ module SurveyGizmo
     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}
+    # @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
+    
+    # @visibility private
     def inspect
       attrs = self.class.attributes.map do |attrib|
         value = attrib.get!(self).inspect
@@ -171,29 +205,63 @@ module SurveyGizmo
 
       "#<#{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
+      
+      private
+      def initialize(response)
+        @response = response.parsed_response
+      end
+    end
+    
     protected
     
+    def attributes_without_blanks
+      self.attributes.reject{|k,v| v.blank? }
+    end
+    
+    private
+    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
     
-    # @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
+    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
     
-    # @private
-    def attributes_without_blanks
-      self.attributes.reject{|k,v| v.blank? }
+    def _create(attributes = {})
+      http = SurveyGizmo.put(handle_route(:create), :query => self.attributes_without_blanks)
+      handle_response http, do
+        if _response.ok?
+          self.attributes = _response.data
+          saved!
+        else
+          false
+        end      
+      end
     end
     
   end

data/lib/survey_gizmo/survey_gizmo.rb

@@ -13,15 +13,25 @@ require "survey_gizmo/api/survey"
 require "survey_gizmo/api/question"
 require "survey_gizmo/api/option"
 require "survey_gizmo/api/page"
+require "survey_gizmo/api/response"
 
 module SurveyGizmo
   include HTTParty
   
   format :json
+  
+  # The base uri for this version of the API is $1
   base_uri 'https://restapi.surveygizmo.com/v1'
+  
   @@options = {}
   mattr_accessor :options
   
+  # Setup the account credentials to access the API
+  # @param [Hash] opts
+  # @option opts [#to_s] :user
+  #   The username for your account. Usually your email address
+  # @option opts [#to_s] :password
+  #   The account password
   def self.setup(opts = {})
     self.options = opts
     default_params({"user:pass" => opts.values_at(:user, :password).join(':')})

data/spec/resource_spec.rb

@@ -0,0 +1,124 @@
+require "spec_helper"
+describe "Survey Gizmo Resource" do
+  
+  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 track descendants" do
+      SurveyGizmo::Resource.descendants.should include(SurveyGizmoSpec::ResourceTest)
+    end
+      
+    it_should_behave_like 'an API object'
+    it_should_behave_like 'an object with errors'
+  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'
+    it_should_behave_like 'an object with errors'
+  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_behave_like 'an object with errors'
+  
+    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'
+    it_should_behave_like 'an object with errors'
+  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'
+    it_should_behave_like 'an object with errors'
+  end
+end

data/spec/spec_helper.rb

@@ -8,10 +8,16 @@ 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}
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f }
 
 RSpec.configure do |config|
-  config.after(:all) do
+  config.include SurveyGizmoSpec::Methods
+  
+  config.before(:each) do
+    @base = 'https://restapi.surveygizmo.com/v1'
+  end
+  
+  config.after(:suite) do
     SurveyGizmoSpec.cleanup_models
   end
 end

data/spec/support/methods.rb

@@ -0,0 +1,17 @@
+module SurveyGizmoSpec
+  module Methods
+    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
+end

data/spec/support/spec_shared_api_object.rb

@@ -38,7 +38,7 @@ shared_examples_for 'an API object' do
   
     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
+      described_class.first(first_params).should == nil
     end
   end
   
@@ -103,7 +103,32 @@ shared_examples_for 'an API object' do
     end
   end
   
+  context '#save' do
+    it "should call create on a new resource" do
+      stub_api_call(:put)
+      obj = described_class.new(create_attributes)
+      obj.save
+      a_request(:put, /#{@base}#{uri_paths[:create]}/).should have_been_made
+    end
+    
+    it "should call update on a created resource" do
+      obj = described_class.new(get_attributes)
+      obj.__send__(:clean!)
+      stub_api_call(:post)
+      obj.save
+      a_request(:post, /#{@base}#{uri_paths[:update]}/).should have_been_made
+    end
+  end
+  
   context '#all' do
+    before(:all) do
+      @array = [
+        {:id => 1, :title => 'resource 1'},
+        {:id => 2, :title => 'resource 2'},
+        {:id => 3, :title => 'resource 3'}
+      ]
+    end
+    
     it "should make a get request" do
       stub_request(:get, /#{@base}/).to_return(json_response(true, []))
       described_class.all(get_attributes)
@@ -111,17 +136,22 @@ shared_examples_for 'an API object' do
     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  
+    
+    it "should return instances of the class" do
+      stub_request(:get, /#{@base}/).to_return(json_response(true, @array))
+      collection = described_class.all(get_attributes)
+      collection.first.should be_instance_of(described_class)
+    end
+    
+    it "should include all elements" do
+      stub_request(:get, /#{@base}/).to_return(json_response(true, @array))
+      collection = described_class.all(get_attributes)
+      collection.length.should == 3
+    end
   end
   
 end

data/spec/support/spec_shared_object_with_errors.rb

@@ -0,0 +1,36 @@
+shared_examples_for 'an object with errors' do
+  before(:each) do
+    SurveyGizmo.setup(:user => 'test@test.com', :password => 'password')
+    stub_request(:any, /#{@base}/).to_return(json_response(false, 'There was an error!'))
+  end
+  
+  it "should be in zombie state if requests fail"
+
+  context "class methods" do
+    it { described_class.first(get_attributes).should be_nil }
+    it { described_class.all(get_attributes).should be_empty }
+  end
+
+  context "instance methods" do
+    before(:each) do
+      @obj = described_class.new(create_attributes)
+    end
+  
+    it "should have an errors array" do
+      @obj.errors.should == []
+    end
+  
+    it "should add errors on failed requests" do
+      @obj.save.should == false
+      @obj.errors.should include('There was an error!')
+    end
+  
+    it "should empty the errors array if object gets saved" do
+      stub_request(:any, /#{@base}/).to_return(json_response(false, 'There was an error!'), json_response(true, get_attributes))
+      @obj.save.should == false
+      @obj.errors.should_not be_empty
+      @obj.save.should == true
+      @obj.errors.should be_empty
+    end
+  end
+end

data/spec/survey-gizmo-ruby_spec.rb

@@ -1,10 +1,6 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-describe "SurveyGizmo" do
-  before(:each) do
-    @base = 'https://restapi.surveygizmo.com/v1'
-  end
-  
+describe "SurveyGizmo" do  
   it "should have a base uri" do
     SurveyGizmo.base_uri.should == 'https://restapi.surveygizmo.com/v1'
   end
@@ -14,127 +10,7 @@ describe "SurveyGizmo" do
     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
-  
+  it "should raise an error if auth isn't configured"  
   
   describe "Collection" do
     before(:each) do
@@ -226,19 +102,5 @@ describe "SurveyGizmo" do
         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  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: survey-gizmo-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-30 00:00:00.000000000Z
+date: 2011-12-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70260063096500 !ruby/object:Gem::Requirement
+  requirement: &70195630027920 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.1
   type: :runtime
   prerelease: false
-  version_requirements: *70260063096500
+  version_requirements: *70195630027920
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70260063389380 !ruby/object:Gem::Requirement
+  requirement: &70195630026500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70260063389380
+  version_requirements: *70195630026500
 - !ruby/object:Gem::Dependency
   name: virtus
-  requirement: &70260063597440 !ruby/object:Gem::Requirement
+  requirement: &70195630025000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *70260063597440
+  version_requirements: *70195630025000
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70260063748800 !ruby/object:Gem::Requirement
+  requirement: &70195630006520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,21 +54,32 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70260063748800
+  version_requirements: *70195630006520
+- !ruby/object:Gem::Dependency
+  name: bluecloth
+  requirement: &70195630005200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70195630005200
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70260064153320 !ruby/object:Gem::Requirement
+  requirement: &70195630002980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *70260064153320
+  version_requirements: *70195630002980
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70260065755920 !ruby/object:Gem::Requirement
+  requirement: &70195629996380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +87,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70260065755920
+  version_requirements: *70195629996380
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70260067262120 !ruby/object:Gem::Requirement
+  requirement: &70195629994020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +98,7 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70260067262120
+  version_requirements: *70195629994020
 description: ''
 email: self@ripthejacker.com
 executables: []
@@ -106,13 +117,17 @@ files:
 - 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/collection.rb
 - lib/survey_gizmo/resource.rb
 - lib/survey_gizmo/survey_gizmo.rb
+- spec/resource_spec.rb
 - spec/spec_helper.rb
+- spec/support/methods.rb
 - spec/support/model_cleanup.rb
 - spec/support/spec_shared_api_object.rb
+- spec/support/spec_shared_object_with_errors.rb
 - spec/support/test_resource_classes.rb
 - spec/survey-gizmo-ruby_spec.rb
 - spec/test_json/page.json
@@ -133,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2566715168940454907
+      hash: -3511147689201295286
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: