survey-gizmo-ruby 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea584803e0be7b02dc62f295924bc21bac08f0ba
-  data.tar.gz: 183b970af5cdee838e5a64e331e232faf1075541
+  metadata.gz: 00dc389fa6c3415227ed3ea344c8ec1b7152eaa8
+  data.tar.gz: 342bda557eb8df193f19958de0337a23504c5a49
 SHA512:
-  metadata.gz: 74f7f2967b1dedb1f95d88e47ff03d5c038d7b9ed7e57170c4463d02af57b983c64b50b5f97c46b61c87843e2add15ce97aacf99dbe21422daae3ed0cca15a4b
-  data.tar.gz: 2e000e5f1e3c657959ffd82455355cdf5b9dddf319a850700cf2b3e707377bbad5182eb01cb938a790c1cff8602ed6b27091fffab2ccda89f99aaa401a136cae
+  metadata.gz: 35695df30398092c26e8fdb48eead2e669753df6cddd4a615eb70688ede385a80e6731adfd29d33bc83ae93b25a15d875c5cf3d2efa7519cb3124e02b018f6a5
+  data.tar.gz: 434990416b53a6cdd22c00f102f888125ec5a501c800c2c8df41fe1a8a126d510228595f8d9b4fd7a6482fb6644235d029564ca476c9166ccb14a7ccea3940c5

data/README.md

@@ -40,12 +40,17 @@ SurveyGizmo.configure do |config|
   config.user = 'still_tippin@woodgraingrip.com'
   config.password = 'it_takes_grindin_to_be_a_king'
 
-  # api_version defaults to v4, but you can probably set to v3 safely if you suspect a bug in v4
+  # Optional - Defaults to v4, but you can probably set to v3 safely if you suspect a bug in v4
   config.api_version = 'v4'
+
+  # Optional - Defaults to 50, maximum 500. Setting too high may cause SurveyGizmo to start throwing timeouts.
+  config.results_per_page = 100
 end
 
-# Retrieve all your surveys
+# Retrieve the first page of your surveys
 surveys = SurveyGizmo::API::Survey.all
+# Retrieve ALL your surveys (handle pagination for you)
+surveys = SurveyGizmo::API::Survey.all(all_pages: true)
 
 # Retrieve the survey with id: 12345
 survey = SurveyGizmo::API::Survey.first(id: 12345)
@@ -54,6 +59,7 @@ survey.pages # => [page1, page2,...]
 survey.number_of_completed_responses # => 355
 survey.server_has_new_results_since?(Time.now.utc - 2.days) # => true
 survey.team_names # => ['Development', 'Test']
+survey.belongs_to?('Development') # => true
 
 # Retrieving Questions for a given survey.  Note that page_id is a required parameter.
 questions = SurveyGizmo::API::Question.all(survey_id: survey.id, page_id: 1)
@@ -68,14 +74,28 @@ question.save
 # Destroy a question
 question.destroy
 
-# Retrieving SurveyResponses for a given survey.
-# Note that because both options are hashes, you need to enclose them both in
-# braces to page successfully!
-responses = SurveyGizmo::API::Response.all({ survey_id: survey.id }, { page: 1 })
-
-# Retrieving page 2 of non test data SurveyResponses
-filters  = { page: 2, filters: [{ field: 'istestdata', operator: '<>', value: 1 }] }
-responses = SurveyGizmo::API::Response.all({ survey_id: survey_id }, filters)
+# Retrieve 2nd page of SurveyResponses for a given survey.
+responses = SurveyGizmo::API::Response.all(survey_id: 12345, page: 2)
+# Retrieve all responses for a given survey.
+responses = SurveyGizmo::API::Response.all(all_pages: true, survey_id: 12345)
+# Retrieving page 3 of completed, non test data SurveyResponses submitted within the past 3 days
+# for contact id 999. This example shows you how to use some of the gem's built in filters and
+# filter generators as well as how to construct your own raw filter.
+# See: http://apihelp.surveygizmo.com/help/article/link/filters for more info on filters
+responses = SurveyGizmo::API::Response.all(
+  survey_id: 12345,
+  page: 3,
+  filters: [
+    SurveyGizmo::API::Response::NO_TEST_DATA,
+    SurveyGizmo::API::Response::ONLY_COMPLETED,
+    SurveyGizmo::API::Response.submitted_since_filter(Time.now - 72.hours),
+    {
+      field: 'contact_id',
+      operator: '=',
+      value: 999
+    }
+  ]
+)
 ```
 
 ## On API Timeouts

data/lib/survey-gizmo-ruby.rb

@@ -3,15 +3,15 @@ require 'active_support/core_ext/module'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/object/blank'
 require 'active_support/concern'
+require 'active_support/time_with_zone'
 require 'awesome_print'
-require 'virtus'
-require 'httparty'
 require 'digest/md5'
+require 'httparty'
+require 'virtus'
 
 require 'survey_gizmo/version'
 require 'survey_gizmo/survey_gizmo'
 require 'survey_gizmo/configuration'
-
 require 'survey_gizmo/multilingual_title'
 require 'survey_gizmo/resource'
 require 'survey_gizmo/rest_response'

data/lib/survey_gizmo/api/option.rb

@@ -2,17 +2,15 @@ module SurveyGizmo; module API
   # @see SurveyGizmo::Resource::ClassMethods
   class Option
     include SurveyGizmo::Resource
+    include SurveyGizmo::MultilingualTitle
 
     attribute :id,            Integer
     attribute :survey_id,     Integer
     attribute :page_id,       Integer
     attribute :question_id,   Integer
-    attribute :title,         String
     attribute :value,         String
     attribute :properties,    Hash
 
-    include SurveyGizmo::MultilingualTitle
-
     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]
 

data/lib/survey_gizmo/api/page.rb

@@ -2,16 +2,14 @@ module SurveyGizmo; module API
   # @see SurveyGizmo::Resource::ClassMethods
   class Page
     include SurveyGizmo::Resource
+    include SurveyGizmo::MultilingualTitle
 
     attribute :id,            Integer
-    attribute :title,         Hash
     attribute :description,   String
     attribute :properties,    Hash
     attribute :after,         Integer
     attribute :survey_id,     Integer
 
-    include SurveyGizmo::MultilingualTitle
-
     # routing
     route '/survey/:survey_id/surveypage', via: :create
     route '/survey/:survey_id/surveypage/:id', via: [:get, :update, :delete]
@@ -21,7 +19,7 @@ module SurveyGizmo; module API
     end
 
     def questions
-      @questions ||= SurveyGizmo::API::Question.all(survey_id: survey_id, page_id: id)
+      @questions ||= SurveyGizmo::API::Question.all(survey_id: survey_id, page_id: id, all_pages: true)
     end
 
     def to_param_options

data/lib/survey_gizmo/api/question.rb

@@ -2,9 +2,9 @@ module SurveyGizmo; module API
   # @see SurveyGizmo::Resource::ClassMethods
   class Question
     include SurveyGizmo::Resource
+    include SurveyGizmo::MultilingualTitle
 
     attribute :id,                 Integer
-    attribute :title,              Hash
     attribute :type,               String
     attribute :description,        String
     attribute :shortname,          String
@@ -17,26 +17,24 @@ module SurveyGizmo; module API
 
     alias_attribute :_subtype, :type
 
-    include SurveyGizmo::MultilingualTitle
-
     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]
 
     def survey
-      @survey ||= SurveyGizmo::API::Survey.first(id: survey_id)
+      @survey ||= Survey.first(id: survey_id)
     end
 
     def options
-      @options ||= SurveyGizmo::API::Option.all(survey_id: survey_id, page_id: page_id, question_id: id)
+      @options ||= Option.all(survey_id: survey_id, page_id: page_id, question_id: id, all_pages: true)
     end
 
     def parent_question
-      @parent_question ||= parent_question_id ? SurveyGizmo::API::Question.first(survey_id: survey_id, id: parent_question_id) : nil
+      @parent_question ||= parent_question_id ? Question.first(survey_id: survey_id, id: parent_question_id) : nil
     end
 
     def sub_questions
-      @sub_questions ||= sub_question_skus.map { |subquestion_id| SurveyGizmo::API::Question.first(survey_id: survey_id, id: subquestion_id) }
+      @sub_questions ||= sub_question_skus.map { |subquestion_id| Question.first(survey_id: survey_id, id: subquestion_id) }
                                           .each { |subquestion| subquestion.parent_question_id = id  }
     end
 

data/lib/survey_gizmo/api/response.rb

@@ -3,6 +3,18 @@ module SurveyGizmo; module API
   class Response
     include SurveyGizmo::Resource
 
+    # Filters
+    NO_TEST_DATA =   { field: 'istestdata', operator: '<>', value: 1 }
+    ONLY_COMPLETED = { field: 'status',     operator: '=',  value: 'Complete' }
+
+    def self.submitted_since_filter(time)
+      {
+        field: 'datesubmitted',
+        operator: '>=',
+        value: time.in_time_zone('Eastern Time (US & Canada)').strftime('%Y-%m-%d %H:%M:%S')
+      }
+    end
+
     attribute :id,                   Integer
     attribute :survey_id,            Integer
     attribute :contact_id,           Integer
@@ -21,7 +33,7 @@ module SurveyGizmo; module API
     route '/survey/:survey_id/surveyresponse/:id', via: [:get, :update, :delete]
 
     def survey
-      @survey ||= SurveyGizmo::API::Survey.first(id: survey_id)
+      @survey ||= Survey.first(id: survey_id)
     end
 
     def to_param_options

data/lib/survey_gizmo/api/survey.rb

@@ -25,18 +25,18 @@ module SurveyGizmo; module API
     route '/survey',     via: :create
 
     def to_param_options
-      { id: self.id }
+      { id: id }
     end
 
     def pages
-      @pages ||= SurveyGizmo::API::Page.all(survey_id: id)
+      @pages ||= Page.all(survey_id: id, all_pages: true)
     end
 
     # Sub question handling is in resource.rb.  It should probably be here instead but if it gets moved here
     # and people try to request all the questions for a specific page directly from a ::API::Question request,
     # sub questions will not be included!  So I left it there for least astonishment.
     def questions
-      @questions ||= pages.map { |p| SurveyGizmo::API::Question.all(survey_id: id, page_id: p.id) }.flatten
+      @questions ||= pages.map { |p| Question.all(survey_id: id, page_id: p.id, all_pages: true) }.flatten
     end
 
     # Statistics array of arrays looks like:
@@ -50,19 +50,13 @@ module SurveyGizmo; module API
     end
 
     def server_has_new_results_since?(time)
-      filters = [{
-        field: 'datesubmitted',
-        operator: '>=',
-        value: time.in_time_zone('Eastern Time (US & Canada)').strftime('%Y-%m-%d %H:%M:%S')
-      }]
-      responses = SurveyGizmo::API::Response.all({ survey_id: self.id }, { page: 1, filters: filters })
-      responses.size > 0
+      Response.all(survey_id: id, filters: [Response.submitted_since_filter(time)]).size > 0
     end
 
-    # As of 2015-08-07, when you request data on multiple surveys from /survey, the team
-    # variable comes back as "0".  If you request one survey at a time from /survey/{id}, it works correctly.
+    # As of 2015-12-18, when you request data on multiple surveys from /survey, the team variable comes
+    # back as "0".  If you request one survey at a time from /survey/{id}, it is populated correctly.
     def teams
-      @individual_survey ||= SurveyGizmo::API::Survey.first(id: self.id)
+      @individual_survey ||= Survey.first(id: id)
       @individual_survey.team
     end
 

data/lib/survey_gizmo/api/survey_campaign.rb

@@ -23,8 +23,8 @@ module SurveyGizmo; module API
     attribute :surveycampaign,  Integer
     attribute :copy,            Boolean
 
-    route '/survey/:survey_id/surveycampaign/:id', :via => [:get, :update, :delete]
-    route '/survey/:survey_id/surveycampaign', :via => :create
+    route '/survey/:survey_id/surveycampaign/:id', via: [:get, :update, :delete]
+    route '/survey/:survey_id/surveycampaign', via: :create
 
     def to_param_options
       { id: self.id, survey_id: self.survey_id }

data/lib/survey_gizmo/configuration.rb

@@ -14,13 +14,16 @@ module SurveyGizmo
   end
 
   class Configuration
+    DEFAULT_RESULTS_PER_PAGE = 50
     DEFAULT_API_VERSION = 'v4'
 
     attr_accessor :api_version
     attr_accessor :user
     attr_accessor :password
+    attr_accessor :results_per_page
 
     def initialize
+      @results_per_page = DEFAULT_RESULTS_PER_PAGE
       @api_version = DEFAULT_API_VERSION
     end
   end

data/lib/survey_gizmo/multilingual_title.rb

@@ -1,11 +1,12 @@
-# Inclusion of this module must come AFTER the virtus call:
-#    attribute :title
+# SurveyGizmo has a bad habit of returning titles in different formats when one is
+# requesting all surveys vs. an individual survey.
 
 module SurveyGizmo
   module MultilingualTitle
     extend ActiveSupport::Concern
 
     included do
+      attribute :title, Hash
       alias_method_chain :title=, :multilingual
     end
 

data/lib/survey_gizmo/resource.rb

@@ -18,16 +18,41 @@ module SurveyGizmo
 
     # These are methods that every API resource can use to access resources in SurveyGizmo
     module ClassMethods
-      # Get an array of resources
-      def all(conditions = {}, filters = nil)
-        response = RestResponse.new(SurveyGizmo.get(handle_route(:create, conditions) + convert_filters_into_query_string(filters)))
-        _collection = response.data.map { |datum| datum.is_a?(Hash) ? self.new(datum) : datum }
+      # Get an array of resources.
+      # @param [Hash] options - simple URL params at the top level, and SurveyGizmo "filters" at the :filters key
+      #
+      # example: { page: 2, filters: [{ field: "istestdata", operator: "<>", value: 1 }] }
+      #
+      # The top level keys (e.g. page, resultsperpage) get encoded in the url, while the
+      # contents of the array of hashes passed at the :filters key get turned into the format
+      # SurveyGizmo expects for its internal filtering, for example:
+      #
+      # filter[field][0]=istestdata&filter[operator][0]=<>&filter[value][0]=1
+      #
+      # Set all_pages: true if you want the gem to page through all the available responses
+      def all(conditions = {}, _deprecated_filters = {})
+        conditions = merge_params(conditions, _deprecated_filters)
+        fail ':all_pages and :page are mutually exclusive' if conditions[:page] && conditions[:all_pages]
+
+        all_pages = conditions.delete(:all_pages)
+        properties = conditions.dup
+        conditions[:resultsperpage] = SurveyGizmo.configuration.results_per_page unless conditions[:resultsperpage]
+
+        request_route = handle_route!(:create, conditions)
+        response = RestResponse.new(SurveyGizmo.get(request_route + filters_to_query_string(conditions)))
+        collection = response.data.map { |datum| datum.is_a?(Hash) ? new(datum) : datum }
+
+        while all_pages && response.current_page < response.total_pages
+          paged_filter = filters_to_query_string(conditions.merge(page: response.current_page + 1))
+          response = RestResponse.new(SurveyGizmo.get(request_route + paged_filter))
+          collection += response.data.map { |datum| datum.is_a?(Hash) ? new(datum) : datum }
+        end
 
         # Add in the properties from the conditions hash because many of the important ones (like survey_id) are
         # not often part of the SurveyGizmo returned data
-        conditions.keys.each do |k|
-          if conditions[k] && instance_methods.include?(k)
-            _collection.each { |c| c[k] ||= conditions[k] }
+        properties.each do |k,v|
+          if v && instance_methods.include?(k)
+            collection.each { |c| c[k] ||= v }
           end
         end
 
@@ -35,18 +60,21 @@ module SurveyGizmo
         # SurveyGizmo claims they will fix this bug and eventually all questions will be
         # returned in one request.
         if self == SurveyGizmo::API::Question
-          _collection += _collection.map { |question| question.sub_questions }.flatten
+          collection += collection.map { |question| question.sub_questions }.flatten
         end
 
-        _collection
+        collection
       end
 
-      # Retrieve a single resource.
-      def first(conditions = {}, filters = nil)
-        response = RestResponse.new(SurveyGizmo.get(handle_route(:get, conditions) + convert_filters_into_query_string(filters)))
+      # Retrieve a single resource.  See usage comment on .all
+      def first(conditions, _deprecated_filters = {})
+        conditions = merge_params(conditions, _deprecated_filters)
+        properties = conditions.dup
+
+        response = RestResponse.new(SurveyGizmo.get(handle_route!(:get, conditions) + filters_to_query_string(conditions)))
         # Add in the properties from the conditions hash because many of the important ones (like survey_id) are
         # not often part of the SurveyGizmo's returned data
-        new(conditions.merge(response.data))
+        new(properties.merge(response.data))
       end
 
       # Create a new resource.  Returns the newly created Resource instance.
@@ -58,7 +86,7 @@ module SurveyGizmo
 
       # Delete resources
       def destroy(conditions)
-        RestResponse.new(SurveyGizmo.delete(handle_route(:delete, conditions)))
+        RestResponse.new(SurveyGizmo.delete(handle_route!(:delete, conditions)))
       end
 
       # Define the path where a resource is located
@@ -68,56 +96,52 @@ module SurveyGizmo
         methods.is_a?(Array) ? methods.each { |m| @paths[m] = path } : (@paths[methods] = path)
       end
 
-      # This method replaces the :page_id, :survey_id, etc strings defined in each model's URI routes with the
+      # Replaces the :page_id, :survey_id, etc strings defined in each model's URI routes with the
       # values being passed in interpolation hash with the same keys.
-      def handle_route(key, interpolation_hash)
+      #
+      # This method has the SIDE EFFECT of deleting REST path related keys from interpolation_hash!
+      def handle_route!(key, interpolation_hash)
         path = @paths[key]
-        fail "No routes defined for `#{key}` in #{self.name}" unless path
+        fail "No routes defined for `#{key}` in #{name}" unless path
         fail "User/password hash not setup!" if SurveyGizmo.default_params.empty?
 
         path.gsub(/:(\w+)/) do |m|
           raise(SurveyGizmo::URLError, "Missing RESTful parameters in request: `#{m}`") unless interpolation_hash[$1.to_sym]
-          interpolation_hash[$1.to_sym]
+          interpolation_hash.delete($1.to_sym)
         end
       end
 
-      # Convert a [Hash] of filters into a query string
-      # @param [Hash] filters - simple pagination or other options at the top level, and surveygizmo "filters" at the :filters key
-      # @return [String]
-      #
-      # example input: { page: 2, filters: [{:field=>"istestdata", :operator=>"<>", :value=>1}] }
-      #
-      # The top level keys (e.g. page, resultsperpage) get simply encoded in the url, while the
-      # contents of the array of hashes passed in the filters hash get turned into the format
-      # SurveyGizmo expects for its internal filtering, for example:
-      #
-      # filter[field][0]=istestdata&filter[operator][0]=<>&filter[value][0]=1
-      def convert_filters_into_query_string(filters = nil)
+      private
+
+      # Convert a [Hash] of params and internal surveygizmo style filters into a query string
+      def filters_to_query_string(filters = {})
         return '' unless filters && filters.size > 0
 
-        output_filters = filters[:filters] || []
-        filter_hash = {}
-        output_filters.each_with_index do |filter,i|
-          filter_hash.merge!(
-            "filter[field][#{i}]".to_sym    => "#{filter[:field]}",
-            "filter[operator][#{i}]".to_sym => "#{filter[:operator]}",
-            "filter[value][#{i}]".to_sym    => "#{filter[:value]}",
-          )
+        params = {}
+        (filters.delete(:filters) || []).each_with_index do |filter, i|
+          fail "Bad filter params: #{filter}" unless filter.is_a?(Hash) && [:field, :operator, :value].all? { |k| filter[k] }
+
+          params["filter[field][#{i}]".to_sym]    = "#{filter[:field]}"
+          params["filter[operator][#{i}]".to_sym] = "#{filter[:operator]}"
+          params["filter[value][#{i}]".to_sym]    = "#{filter[:value]}"
         end
-        simple_filters = filters.reject { |k,v| k == :filters }
-        filter_hash.merge!(simple_filters)
 
         uri = Addressable::URI.new
-        uri.query_values = filter_hash
+        uri.query_values = params.merge(filters)
         "?#{uri.query}"
       end
+
+      def merge_params(conditions, _deprecated_filters)
+        $stderr.puts('Use of the 2nd hash parameter is deprecated.') unless _deprecated_filters.empty?
+        conditions.merge(_deprecated_filters || {})
+      end
     end
 
     # Save the resource to SurveyGizmo
     def save
       if id
         # Then it's an update, because we already know the surveygizmo assigned id
-        RestResponse.new(SurveyGizmo.post(handle_route(:update), query: self.attributes_without_blanks))
+        RestResponse.new(SurveyGizmo.post(handle_route(:update), query: attributes_without_blanks))
       else
         create_record_in_surveygizmo
       end
@@ -143,46 +167,32 @@ module SurveyGizmo
 
     # Returns itself if successfully saved, but with attributes added by SurveyGizmo
     def create_record_in_surveygizmo(attributes = {})
-      rest_response = RestResponse.new(SurveyGizmo.put(handle_route(:create), query: self.attributes_without_blanks))
+      rest_response = RestResponse.new(SurveyGizmo.put(handle_route(:create), query: attributes_without_blanks))
       self.attributes = rest_response.data
       self
     end
 
     def inspect
-      if ENV['GIZMO_DEBUG']
-        ap "CLASS: #{self.class}"
-      end
-
       attribute_strings = self.class.attribute_set.map do |attrib|
-        if ENV['GIZMO_DEBUG']
-          ap attrib
-          ap attrib.name
-          ap self.send(attrib.name)
-          ap self.send(attrib.name).class
-        end
-
-        if self.send(attrib.name).class == Hash
-          value = self.send(attrib.name).inspect
-        else
-          value = self.send(attrib.name).to_s
-        end
+        value = self.send(attrib.name)
+        value = value.is_a?(Hash) ? value.inspect : value.to_s
 
         "  \"#{attrib.name}\" => \"#{value}\"\n" unless value.strip.blank?
       end.compact
 
-      "#<#{self.class.name}:#{self.object_id}>\n#{attribute_strings.join()}"
+      "#<#{self.class.name}:#{self.object_id}>\n#{attribute_strings.join}"
     end
 
     protected
 
     def attributes_without_blanks
-      self.attributes.reject { |k,v| v.blank? }
+      attributes.reject { |k,v| v.blank? }
     end
 
     private
 
     def handle_route(key)
-      self.class.handle_route(key, to_param_options)
+      self.class.handle_route!(key, to_param_options)
     end
   end
 end

data/lib/survey_gizmo/rest_response.rb

@@ -1,22 +1,23 @@
 # This class normalizes the response returned by Survey Gizmo, including validation.
+
 class RestResponse
   attr_accessor :raw_response
   attr_accessor :parsed_response
 
-  def initialize(rest_response)
-    @raw_response = rest_response
-    @parsed_response = rest_response.parsed_response
+  def initialize(http_response)
+    @raw_response = http_response
+    @parsed_response = http_response.parsed_response
 
     if ENV['GIZMO_DEBUG']
-      ap 'SG Response: '
+      ap 'Parsed SurveyGizmo Response:'
       ap @parsed_response
     end
 
-    fail "Bad response: #{rest_response.inspect}" unless @parsed_response['result_ok'] && @parsed_response['result_ok'].to_s.downcase == 'true'
+    fail "Bad response: #{http_response.inspect}" unless @parsed_response['result_ok'] && @parsed_response['result_ok'].to_s.downcase == 'true'
     return unless data
 
     # Handle really crappy [] notation in SG API, so far just in SurveyResponse
-    (data.is_a?(Array) ? data : [data]).each do |datum|
+    (data.is_a?(Array) ? data : [data]).compact.each do |datum|
       unless datum['datesubmitted'].blank?
         # SurveyGizmo returns date information in EST but does not provide time zone information.
         # See https://surveygizmov4.helpgizmo.com/help/article/link/date-and-time-submitted
@@ -47,12 +48,20 @@ class RestResponse
 
   # The parsed JSON data of the response
   def data
-    @_data ||= @parsed_response['data']
+    @parsed_response['data']
   end
 
   # The error message if there is one
   def message
-    @_message ||= @parsed_response['message']
+    @parsed_response['message']
+  end
+
+  def current_page
+    @parsed_response['page']
+  end
+
+  def total_pages
+    @parsed_response['total_pages']
   end
 
   private

data/lib/survey_gizmo/version.rb

@@ -1,3 +1,4 @@
 module SurveyGizmo
-  VERSION = '4.0.0'
+  # TODO: When bumping to 5.0, remove the deprecated parameters for Resource.all and Resource.first
+  VERSION = '4.1.0'
 end

data/spec/resource_spec.rb

@@ -36,16 +36,16 @@ describe 'Survey Gizmo Resource' do
     it_should_behave_like 'an API object'
     it_should_behave_like 'an object with errors'
 
-    context '#convert_filters_into_query_string' do
+    context '#filters_to_query_string' do
       let(:page)    { 2 }
       let(:filters) { { page: page, filters: [{ field: 'istestdata', operator: '<>', value: 1 }] } }
 
       it 'should generate the correct page request' do
-        expect(SurveyGizmoSpec::ResourceTest.convert_filters_into_query_string(page: page)).to eq("?page=#{page}")
+        expect(SurveyGizmoSpec::ResourceTest.send(:filters_to_query_string, { page: page })).to eq("?page=#{page}")
       end
 
       it 'should generate the correct filter fragment' do
-        expect(SurveyGizmoSpec::ResourceTest.convert_filters_into_query_string(filters)).to eq("?filter%5Bfield%5D%5B0%5D=istestdata&filter%5Boperator%5D%5B0%5D=%3C%3E&filter%5Bvalue%5D%5B0%5D=1&page=#{page}")
+        expect(SurveyGizmoSpec::ResourceTest.send(:filters_to_query_string, filters)).to eq("?filter%5Bfield%5D%5B0%5D=istestdata&filter%5Boperator%5D%5B0%5D=%3C%3E&filter%5Bvalue%5D%5B0%5D=1&page=#{page}")
       end
     end
   end
@@ -72,10 +72,10 @@ describe 'Survey Gizmo Resource' do
 
   describe SurveyGizmo::API::Question do
     let(:base_params)       { {survey_id: 1234, page_id: 1} }
-    let(:create_attributes) { base_params.merge(title: 'Spec Question', type: 'radio', properties: {'required' => true, 'option_sort' => false}) }
+    let(:create_attributes) { base_params.merge(title: 'Spec Question', type: 'radio', properties: { 'required' => true, 'option_sort' => false }) }
     let(:update_attributes) { base_params.merge(title: 'Updated') }
     let(:first_params)      { base_params.merge(id: 1) }
-    let(:get_attributes)    { create_attributes.merge(id: 1) }
+    let(:get_attributes)    { create_attributes.merge(id: 1).reject { |k, v| k == :properties } }
     let(:uri_paths) {
       { :get =>    '/survey/1234/surveyquestion/1',
         :create => '/survey/1234/surveypage/1/surveyquestion',
@@ -96,7 +96,7 @@ describe 'Survey Gizmo Resource' do
     end
 
     it 'should have no subquestions' do
-      expect(described_class.new().sub_questions).to eq([])
+      expect(described_class.new.sub_questions).to eq([])
     end
 
     it 'should find the survey' do
@@ -107,7 +107,8 @@ describe 'Survey Gizmo Resource' do
 
     context 'with subquestions' do
       let(:parent_id) { 33 }
-      let(:question_with_subquestions) { described_class.new(id: parent_id, survey_id: 1234, sub_question_skus: [1, 2])}
+      let(:question_with_subquestions) { described_class.new(id: parent_id, survey_id: 1234, sub_question_skus: [1, 2]) }
+
       it 'should have 2 subquestions and they should have the right parent question' do
         stub_request(:get, /#{@base}/).to_return(json_response(true, get_attributes))
         expect(question_with_subquestions.sub_questions.size).to eq(2)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: survey-gizmo-ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Kabari Hendrick
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport