survey-gizmo-ruby 2.0.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc7ec77f5e304d1dec270f479b3caadc795e75e1
-  data.tar.gz: 1c65b8c0bf95015e3c65be784b78bdd916793100
+  metadata.gz: ff4381315b3f5ce301adca67c272f4966b4c5e8e
+  data.tar.gz: 21531bfec2ce56c5946b14ffd7a7f011d177ceeb
 SHA512:
-  metadata.gz: 77bf4d152eeb999f2a6a62f4a233b4d8b42e8c47038e54864ccd42947024383e790785f41fa618ec06f8f50d7add669e0f0c96666092e6a3c45155a3073151c7
-  data.tar.gz: e87d4acc9fe981fd5653ceb2f7197e144c7d5d3c5aedbe8f2d71afc7d0c21b1d5036fa66d5bb062c04cc331cfd48a3054549a74ee5bedb3df7c726ef30a29521
+  metadata.gz: 453a7400ff86b0f8ac68d525b3e5dad504c46bd20fb002e9dfb4bb8f5964f9c907c781a4afb7f3c4a4b0ab423a5dd3716f2b8d2c4d71620d4bcf25786e2eb2ee
+  data.tar.gz: 7b4d3ccc7cdde1a2fdeba1883d91669ae87c98f982ad78149830820c52b24201bcd287442c3e487db7caaef5c268ac1b19b5ab88562213d88a08ee59f98a8765

data/README.md

@@ -1,27 +1,23 @@
-#### WARNING:
+# Survey Gizmo (ruby)
 
-This is version `2.0.0` of the gem, which introduces breaking changes. People who need backwards compatibility can use `1.0.4`.
+Integrate with the [Survey Gizmo API](http://apisurveygizmo.helpgizmo.com/help) using an ActiveModel style interface.
 
-What's fixed/better:
-* Filtering of requests is implemented
-* Requests for the questions in a survey now retrieve ALL of the questions, even the sneaky sub_questions that weren't directly returned to a basic API request.
+Currently supports SurveyGizmo API **v4** (default) and **v3**.
 
-What broke:
-* SurveyGizmo objects (Survey, SurveyQuestion, etc) no longer track their own state (:new, :zombie, :saved, etc etc) - state tracking was useless anyways because exceptions always were raised on errors.
-* There is no more SurveyGizmo::Collection class...  now there are just Arrays.
-* There is no more lazy loading/instantiation.
+## Versions
 
-What's different:
-* Variables are not autoloaded.  That is to say when you load a Survey, the API request that loads the associated questions is not executed until you ask for them with the #questions method
+### Major Changes in 3.0
 
-Also a past warning from another author:
-> SurveyGizmo doesn't test their REST API when they roll out changes.  They don't publish a list of active defects, and when you call/email for support it is unlikely you will geto a person that knows anything about programming or the REST API.  You can't talk to level 2 support, although they might offer you a discount on their paid consulting rates if the problem persists for more than a few weeks.
+* BREAKING CHANGE: Configuration is completely different
+* Important Change: Defaults to using the v4 SurveyGizmo API endpoint to take advantage of various API bug fixes (notably team ownership is broken in v3)
 
-— chorn@chorn.com 2013-03-15
+### Old versions
 
-# Survey Gizmo (ruby)
+[Version 2.0.1 for the v3 API is here](https://github.com/RipTheJacker/survey-gizmo-ruby/releases/tag/v2.0.1)
+
+[Version 1.0.5 for the v2 API is here](https://github.com/RipTheJacker/survey-gizmo-ruby/releases/tag/v1.0.5)
 
-Integrate with the [Survey Gizmo API](http://apisurveygizmo.helpgizmo.com/help) 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
+[Version 0.7.0 for the v1 API is here](https://github.com/RipTheJacker/survey-gizmo-ruby/releases/tag/v0.7.0)
 
 ## Installation
 
@@ -34,13 +30,27 @@ gem 'survey-gizmo-ruby'
 ```ruby
 require 'survey-gizmo-ruby'
 
-# somewhere in your app define your survey gizmo login credentials.
-SurveyGizmo.setup(user: 'you@somewhere.com', password: 'mypassword')
+# Configure your credentials
+SurveyGizmo.configure do |config|
+  config.user = 'still_tippin@test.com'
+  config.password = 'ittakesgrindintobeaking'
+
+  # api_version defaults to v4, but you can probably set to v3 safely if you suspect a bug in v4
+  config.api_version = 'v4'
+end
 
 # Retrieve the survey with id: 12345
 survey = SurveyGizmo::API::Survey.first(id: 12345)
 survey.title # => My Title
 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']
+
+# 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)
+# Or just retrieve all questions for all pages of this survey
+questions = survey.questions
 
 # Create a question for your survey
 question = SurveyGizmo::API::Question.create(survey_id: survey.id, title: 'Do you like ruby?', type: 'checkbox')
@@ -51,23 +61,23 @@ question.save # => question # (but now with the id assigned by SurveyGizmo as th
   question.save # => false
   question.errors # => ['There was an error']
 
-# 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)
-# Or just retrieve all questions for all pages of this survey
-questions = survey.questions
-
 # Retrieving SurveyResponses for a given survey.
-# Note that because of both options being hashes, you need to enclose them both in braces to page successfully!
-responses = SurveyGizmo::API::Response.all({survey_id: survey.id}, {page: 1})
+# Note that because of both options being 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)
+filters  = {page: 2, filters: [{ field: 'istestdata', operator: '<>', value: 1 }] }
+responses = SurveyGizmo::API::Response.all({ survey_id: survey_id }, filters)
 ```
 
+## On API Timeouts
+
+API timeouts are a regular occurrence with the SurveyGizmo API.  At Lumos Labs we use our own [Pester gem](https://github.com/lumoslabs/pester) to manage retry strategies.  It might work for you.
+
 ## Debugging
 
-The GIZMO_DEBUG environment variable will trigger full printouts of SurveyGizmo's HTTP responses and variable introspection for almost everything
+The GIZMO_DEBUG environment variable will trigger full printouts of SurveyGizmo's HTTP responses and variable introspection for almost everything.
 
 ```bash
 cd /my/app
@@ -77,14 +87,14 @@ bundle exec rails whatever
 
 ## Adding API Objects
 
-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:
+Currently, the following API objects are included in the gem: `Survey`, `Question`, `Option`, `Page`, `Response`, `EmailMessage`, `SurveyCampaign`, `Contact`, `AccountTeams`. 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:
 
 ```ruby
 class SomeObject
   # the base where most of the methods for handling the API are stored
   include SurveyGizmo::Resource
 
-  # the attribtues the object should respond to
+  # the attributes the object should respond to
   attribute :id,          Integer
   attribute :title,       String
   attribute :status,      String
@@ -92,12 +102,13 @@ class SomeObject
   attribute :created_on,  DateTime
 
   # defing the paths used to retrieve/set info
-  route '/something/:id', :via => [:get, :update, :delete]
-  route '/something',     :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
+  # this must be defined with the params that would be included in any route related
+  # to an instance of SomeObject
   def to_param_options
-    {:id => self.id}
+    { id: self.id }
   end
 end
 ```
@@ -110,16 +121,15 @@ The [Virtus](https://github.com/solnic/virtus) gem is included to handle the att
 * Take a gander at the github issues beforehand
 * Fork the project
 * Start a feature/bugfix branch and hack away
-* Make sure to add tests for it!!!!
+* Make sure to add specs for it!!!!
 * Submit a pull request
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-## Missing Features
-
-* It would be nice to implement enumerable on the Question and (especially) Response objects so people don't have to implement their own paging
-* There are several API objects that are available and not included in this gem.
-* It is also missing OAuth authentication ability.
+## Desirable/Missing Features
 
+* There are several API objects that are available and not included in this gem.  AccountTeams, for instance, has some skeleton code but is untested.
+* OAuth authentication ability.
+* Better specs with VCR/Webmock would be nice.
 
 # Copyright
 

data/lib/survey-gizmo-ruby.rb

@@ -1 +1,26 @@
-require 'survey_gizmo/survey_gizmo'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/object/blank'
+require 'active_support/concern'
+require 'awesome_print'
+require 'virtus'
+require 'httparty'
+require 'digest/md5'
+
+require 'survey_gizmo/version'
+require 'survey_gizmo/survey_gizmo'
+require 'survey_gizmo/configuration'
+
+require 'survey_gizmo/resource'
+require 'survey_gizmo/rest_response'
+
+require 'survey_gizmo/api/account_teams'
+require 'survey_gizmo/api/contact'
+require 'survey_gizmo/api/email_message'
+require 'survey_gizmo/api/option'
+require 'survey_gizmo/api/page'
+require 'survey_gizmo/api/question'
+require 'survey_gizmo/api/response'
+require 'survey_gizmo/api/survey'
+require 'survey_gizmo/api/survey_campaign'

data/lib/survey_gizmo/api/account_teams.rb

@@ -0,0 +1,24 @@
+# This REST endpoint is only available to accounts with admin privileges
+# This code is untested.
+
+module SurveyGizmo
+  module API
+    class AccountTeams
+      include SurveyGizmo::Resource
+
+      attribute :id,            Integer
+      attribute :teamid,        Integer
+      attribute :teamname,      String
+      attribute :color,         String
+      attribute :default_role,  String
+      attribute :status,        String
+
+      route '/accountteams/:id', via: [:get, :update, :delete]
+      route '/accountteams',     via: :create
+
+      def to_param_options
+        { id: self.id }
+      end
+    end
+  end
+end

data/lib/survey_gizmo/api/contact.rb

@@ -3,8 +3,6 @@ module SurveyGizmo; module API
   class Contact
     include SurveyGizmo::Resource
 
-    # @macro [attach] virtus_attribute
-    #   @return [$2]
     attribute :id,                      Integer
     attribute :survey_id,               Integer
     attribute :campaign_id,             Integer
@@ -41,9 +39,8 @@ module SurveyGizmo; module API
     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}
+      { 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

@@ -3,8 +3,6 @@ module SurveyGizmo; module API
   class EmailMessage
     include SurveyGizmo::Resource
 
-    # @macro [attach] virtus_attribute
-    #   @return [$2]
     attribute :id,                Integer
     attribute :survey_id,         Integer
     attribute :campaign_id,       Integer
@@ -25,9 +23,8 @@ module SurveyGizmo; module API
     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}
+      { id: self.id, survey_id: self.survey_id, campaign_id: self.campaign_id }
     end
   end
 end; end

data/lib/survey_gizmo/api/option.rb

@@ -3,8 +3,6 @@ module SurveyGizmo; module API
   class Option
     include SurveyGizmo::Resource
 
-    # @macro [attach] virtus_attribute
-    #   @return [$2]
     attribute :id,            Integer
     attribute :survey_id,     Integer
     attribute :page_id,       Integer
@@ -25,9 +23,8 @@ 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}
+      { 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

@@ -3,8 +3,6 @@ module SurveyGizmo; module API
   class Page
     include SurveyGizmo::Resource
 
-    # @macro [attach] virtus_attribute
-    #   @return [$2]
     attribute :id,            Integer
     attribute :title,         Hash
     attribute :description,   String
@@ -25,16 +23,14 @@ module SurveyGizmo; module API
     end
 
     # survey gizmo sends a hash back for :title
-    # @private
     def title_with_multilingual=(val)
       self.title_without_multilingual = val.is_a?(Hash) ? val : { 'English' => val }
     end
 
     alias_method_chain :title=, :multilingual
 
-    # @see SurveyGizmo::Resource#to_param_options
     def to_param_options
-      {id: self.id, survey_id: self.survey_id}
+      { id: self.id, survey_id: self.survey_id }
     end
   end
 end; end

data/lib/survey_gizmo/api/question.rb

@@ -3,8 +3,6 @@ module SurveyGizmo; module API
   class Question
     include SurveyGizmo::Resource
 
-    # @macro [attach] virtus_attribute
-    #   @return [$2]
     attribute :id,                 Integer
     attribute :title,              String
     attribute :type,               String
@@ -13,7 +11,7 @@ module SurveyGizmo; module API
     attribute :properties,         Hash
     attribute :after,              Integer
     attribute :survey_id,          Integer
-    attribute :page_id,            Integer, :default => 1
+    attribute :page_id,            Integer, default: 1
     attribute :sub_question_skus,  Array
     attribute :parent_question_id, Integer
 
@@ -36,9 +34,10 @@ module SurveyGizmo; module API
     end
 
     def sub_questions
-      @sub_questions ||= sub_question_skus.map {|subquestion_id| SurveyGizmo::API::Question.first(survey_id: survey_id, id: subquestion_id)}
-                                          .each {|subquestion| subquestion.parent_question_id = id}
+      @sub_questions ||= sub_question_skus.map { |subquestion_id| SurveyGizmo::API::Question.first(survey_id: survey_id, id: subquestion_id) }
+                                          .each { |subquestion| subquestion.parent_question_id = id  }
     end
+
     # survey gizmo sends a hash back for :title
     # @private
     def title_with_multilingual=(val)
@@ -49,7 +48,7 @@ module SurveyGizmo; module API
 
     # @see SurveyGizmo::Resource#to_param_options
     def to_param_options
-      {id: self.id, survey_id: self.survey_id, page_id: self.page_id}
+      { id: self.id, survey_id: self.survey_id, page_id: self.page_id }
     end
   end
 end; end

data/lib/survey_gizmo/api/response.rb

@@ -3,8 +3,6 @@ module SurveyGizmo; module API
   class Response
     include SurveyGizmo::Resource
 
-    # @macro [attach] virtus_attribute
-    #   @return [$2] the attribute +$1+ as a $2
     attribute :id,                   Integer
     attribute :survey_id,            Integer
     attribute :contact_id,           Integer
@@ -27,9 +25,8 @@ module SurveyGizmo; module API
       @survey ||= SurveyGizmo::API::Survey.first(id: survey_id)
     end
 
-    # @see SurveyGizmo::Resource#to_param_options
     def to_param_options
-      {id: self.id, survey_id: self.survey_id}
+      { id: self.id, survey_id: self.survey_id }
     end
   end
 end; end

data/lib/survey_gizmo/api/survey.rb

@@ -3,10 +3,8 @@ module SurveyGizmo; module API
   class Survey
     include SurveyGizmo::Resource
 
-    # @macro [attach] virtus_attribute
-    #   @return [$2]
     attribute :id,             Integer
-    attribute :team,           Integer
+    attribute :team,           Array
     attribute :type,           String
     attribute :_subtype,       String
     attribute :status,         String
@@ -26,27 +24,54 @@ module SurveyGizmo; module API
     route '/survey/:id', via: [:get, :update, :delete]
     route '/survey',     via: :create
 
+    def to_param_options
+      { id: self.id }
+    end
+
     def pages
       @pages ||= SurveyGizmo::API::Page.all(survey_id: id)
     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| SurveyGizmo::API::Question.all(survey_id: id, page_id: p.id) }.flatten
     end
 
     # Statistics array of arrays looks like:
     # [["Partial", 2], ["Disqualified", 28], ["Complete", 15]]
     def number_of_completed_responses
-      if statistics && !statistics.empty? && (completed_data = statistics.find {|a| a[0] == 'Complete'})
+      if statistics && !statistics.empty? && (completed_data = statistics.find { |a| a[0] == 'Complete' })
         completed_data[1]
       else
         0
       end
     end
 
-    # @see SurveyGizmo::Resource#to_param_options
-    def to_param_options
-      {id: self.id}
+    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
+    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.
+    def teams
+      @individual_survey ||= SurveyGizmo::API::Survey.first(id: self.id)
+      @individual_survey.team
+    end
+
+    def team_names
+      teams.map { |t| t['name'] }
+    end
+
+    def belongs_to?(team)
+      team_names.any? { |t| t == team }
     end
   end
-end; end
+end; end

data/lib/survey_gizmo/api/survey_campaign.rb

@@ -3,8 +3,6 @@ module SurveyGizmo; module API
   class SurveyCampaign
     include SurveyGizmo::Resource
 
-    # @macro [attach] virtus_attribute
-    #   @return [$2]
     attribute :id,              Integer
     attribute :name,            String
     attribute :type,            String
@@ -28,9 +26,8 @@ module SurveyGizmo; module API
     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}
+      { id: self.id, survey_id: self.survey_id }
     end
   end
-end; end
+end; end

data/lib/survey_gizmo/configuration.rb

@@ -0,0 +1,27 @@
+module SurveyGizmo
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+    SurveyGizmo.setup
+  end
+
+  def self.reset!
+    self.configuration = Configuration.new
+  end
+
+  class Configuration
+    DEFAULT_API_VERSION = 'v4'
+
+    attr_accessor :api_version
+    attr_accessor :user
+    attr_accessor :password
+
+    def initialize
+      @api_version = DEFAULT_API_VERSION
+    end
+  end
+end

data/lib/survey_gizmo/resource.rb

@@ -24,31 +24,31 @@ module SurveyGizmo
       # @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 at filters[:filters] gets turned into the format surveygizmo expects for its internal filtering, for example:
+      # 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 at filters[:filters] gets 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)
-        if 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]}",
-            })
-          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}"
-        else
-          ''
+        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]}",
+          )
         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}"
       end
 
       # Get a list of resources
@@ -58,7 +58,7 @@ module SurveyGizmo
       def all(conditions = {}, filters = nil)
         response = RestResponse.new(SurveyGizmo.get(handle_route(:create, conditions) + convert_filters_into_query_string(filters)))
         if response.ok?
-          _collection = response.data.map {|datum| datum.is_a?(Hash) ? self.new(datum) : datum}
+          _collection = response.data.map { |datum| datum.is_a?(Hash) ? self.new(datum) : datum }
 
           # 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
@@ -70,7 +70,7 @@ module SurveyGizmo
 
           # Sub questions are not pulled by default so we have to retrieve them
           if self == SurveyGizmo::API::Question
-            _collection += _collection.map {|question| question.sub_questions}.flatten
+            _collection += _collection.map { |question| question.sub_questions }.flatten
           end
 
           _collection
@@ -130,7 +130,6 @@ module SurveyGizmo
         methods = options[:via]
         methods = [:get, :create, :update, :delete] if methods == :any
         methods.is_a?(Array) ? methods.each { |m| @paths[m] = path } : (@paths[methods] = path)
-        nil
       end
 
       # This method replaces the :page_id, :survey_id, etc strings defined in each model's URI routes with the
@@ -150,7 +149,8 @@ module SurveyGizmo
 
     # Save the instance to Survey Gizmo
     def save
-      if id #Then it's an update
+      if id
+        # Then it's an update, because we already know the surveygizmo assigned id
         handle_response(SurveyGizmo.post(handle_route(:update), query: self.attributes_without_blanks))
         @latest_response.ok?
       else
@@ -232,7 +232,6 @@ module SurveyGizmo
       end
     end
 
-
     protected
 
     def attributes_without_blanks
@@ -240,6 +239,7 @@ module SurveyGizmo
     end
 
     private
+
     def handle_route(key)
       self.class.handle_route(key, to_param_options)
     end

data/lib/survey_gizmo/rest_response.rb

@@ -15,8 +15,8 @@ class RestResponse
       # provide time zone information in their API responses.
       #
       # See https://surveygizmov4.helpgizmo.com/help/article/link/date-and-time-submitted
-      unless datum["datesubmitted"].blank?
-        datum["datesubmitted"] = datum["datesubmitted"] + " EST"
+      unless datum['datesubmitted'].blank?
+        datum['datesubmitted'] = datum['datesubmitted'] + ' EST'
       end
 
       datum.keys.grep(/^\[/).each do |key|
@@ -55,7 +55,7 @@ class RestResponse
 
   # The parsed JSON data of the response
   def data
-    @_data ||= @parsed_response['data'] #|| {'id' => @parsed_response['id']}
+    @_data ||= @parsed_response['data']
   end
 
   # The error message if there is one
@@ -63,7 +63,6 @@ class RestResponse
     @_message ||= @parsed_response['message']
   end
 
-
   private
 
   def cleanup_attribute_name(attr)

data/lib/survey_gizmo/survey_gizmo.rb

@@ -1,53 +1,15 @@
-require 'active_support/core_ext/string'
-require 'active_support/core_ext/module'
-require 'active_support/core_ext/hash'
-require 'active_support/core_ext/object/blank'
-require 'active_support/concern'
-require 'awesome_print'
-require 'virtus'
-require 'httparty'
-require 'digest/md5'
-
-require 'survey_gizmo/resource'
-require 'survey_gizmo/rest_response'
-
-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']
+
+  debug_output $stderr if ENV['GIZMO_DEBUG'] =~ /^(true|t|yes|y|1)$/i
   default_timeout 600  # 10 minutes, SurveyGizmo has serious problems.
 
   format :json
 
   URLError = Class.new(RuntimeError)
 
-  # The base uri for this version of the API is $1
-  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
-  #   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:md5' => "#{opts[:user]}:#{Digest::MD5.hexdigest(opts[:password])}" })
-  end
-
-  def self.reset
-    @@options = {}
-    default_params({})
+  def self.setup
+    base_uri "https://restapi.surveygizmo.com/#{SurveyGizmo.configuration.api_version}"
+    default_params({ 'user:md5' => "#{SurveyGizmo.configuration.user}:#{Digest::MD5.hexdigest(SurveyGizmo.configuration.password)}" })
   end
 end

data/lib/survey_gizmo/version.rb

@@ -0,0 +1,3 @@
+module SurveyGizmo
+  VERSION = '3.0.3'
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'survey_gizmo/configuration'
+
+describe SurveyGizmo::Configuration do
+
+  before(:each) do
+    SurveyGizmo.configure do |config|
+      config.user = 'test@test.com'
+      config.password = 'password'
+    end
+  end
+
+  after(:each) do
+    SurveyGizmo.reset!
+  end
+
+  it 'should allow basic authentication configuration' do
+    expect(SurveyGizmo.default_params).to eq({ 'user:md5' => 'test@test.com:5f4dcc3b5aa765d61d8327deb882cf99' })
+  end
+
+  it 'should allow changing user and pass' do
+    SurveyGizmo.configure do |config|
+      config.user = 'slimthug'
+      config.password = 'fourfourz'
+      config.api_version = 'v3'
+    end
+
+    expect(SurveyGizmo.default_params).to eq({ 'user:md5'=>'slimthug:836fd7e2961a094c01cb7ba78bac6a06' })
+    expect(SurveyGizmo.base_uri).to eq('https://restapi.surveygizmo.com/v3')
+  end
+end

data/spec/resource_spec.rb

@@ -1,18 +1,14 @@
 require 'spec_helper'
-describe 'Survey Gizmo Resource' do
 
+describe 'Survey Gizmo Resource' do
   let(:create_attributes_to_compare) { }
   let(:get_attributes_to_compare) { }
 
   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(:update_attributes) { {title: 'Updated'} }
-    let(:first_params)      { {id: 1, test_id: 5} }
+    let(:create_attributes) { { title: 'Spec', test_id: 5 } }
+    let(:update_attributes) { { title: 'Updated' } }
+    let(:first_params)      { { id: 1, test_id: 5 } }
     let(:get_attributes)    { create_attributes.merge(id: 1) }
     let(:uri_paths){
       {
@@ -42,7 +38,7 @@ describe 'Survey Gizmo Resource' do
 
     context '#convert_filters_into_query_string' do
       let(:page)    { 2 }
-      let(:filters) { {page: page, filters: [{field: 'istestdata', operator: '<>', value: 1}] }}
+      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}")
@@ -170,4 +166,19 @@ describe 'Survey Gizmo Resource' do
     it_should_behave_like 'an object with errors'
   end
 
+  describe SurveyGizmo::API::AccountTeams do
+    pending('Need an account with admin privileges to test this')
+    let(:create_attributes) { { teamid: 1234, teamname: 'team' } }
+    let(:get_attributes)    { create_attributes.merge(id: 1234) }
+    let(:update_attributes) { create_attributes }
+    let(:first_params)      { { teamname: 'team' } }
+    let(:uri_paths) do
+      h = { :create => '/account_teams/1234' }
+      h.default = '/account_teams/1234'
+      h
+    end
+
+    #it_should_behave_like 'an API object'
+    #it_should_behave_like 'an object with errors'
+  end
 end

data/spec/spec_helper.rb

@@ -5,12 +5,16 @@ require 'webmock/rspec'
 
 # 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.include SurveyGizmoSpec::Methods
 
   config.before(:each) do
-    @base = 'https://restapi.surveygizmo.com/v3'
+    @base = 'https://restapi.surveygizmo.com/v4'
+    SurveyGizmo.configure do |config|
+      config.user = 'test@test.com'
+      config.password = 'password'
+    end
   end
 end

data/spec/support/methods.rb

@@ -4,17 +4,13 @@ module SurveyGizmoSpec
       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}
+      body = { result_ok: result }
       result ? body.merge!(data: data) : body.merge!(message: data)
       {
-        headers: {'Content-Type' => 'application/json'},
+        headers: { 'Content-Type' => 'application/json' },
         body: body.to_json
       }
     end
   end
-end
+end

data/spec/support/spec_shared_api_object.rb

@@ -1,8 +1,4 @@
 shared_examples_for 'an API object' do
-  before(:all) do
-    SurveyGizmo.setup(user: 'test@test.com', password: 'password')
-  end
-
   it "should be descendant of SurveyGizmo::Resource" do
     SurveyGizmo::Resource.descendants.should include(described_class)
   end
@@ -24,7 +20,7 @@ shared_examples_for 'an API object' do
       stub_request(:put, /#{@base}/).to_return(json_response(true, create_attributes))
       obj = described_class.create(create_attributes)
 
-      obj.attributes.reject{|k,v| v.blank? }.should == (create_attributes_to_compare || create_attributes)
+      obj.attributes.reject { |k,v| v.blank? }.should == (create_attributes_to_compare || create_attributes)
     end
   end
 

data/spec/support/spec_shared_object_with_errors.rb

@@ -1,6 +1,5 @@
 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
 
@@ -31,4 +30,4 @@ shared_examples_for 'an object with errors' do
       @obj.errors.should be_empty
     end
   end
-end
+end

data/spec/support/test_resource_classes.rb

@@ -22,4 +22,4 @@ module SurveyGizmoSpec
     attribute :id, Integer
     attribute :title, String
   end
-end
+end

data/spec/survey-gizmo-ruby_spec.rb

@@ -2,16 +2,6 @@ require 'spec_helper'
 
 describe SurveyGizmo do
   it 'should have a base uri' do
-    SurveyGizmo.base_uri.should == 'https://restapi.surveygizmo.com/v3'
-  end
-
-  it 'should raise an error if auth isn\'t configured' do
-    #SurveyGizmo.reset
-    #expect(SurveyGizmo::API::Survey.all).to raise_exception
-  end
-
-  it 'should allow basic authentication configuration' do
-    SurveyGizmo.setup(user: 'test@test.com', password: 'password')
-    SurveyGizmo.default_options[:default_params].should == {'user:md5' => 'test@test.com:5f4dcc3b5aa765d61d8327deb882cf99'}
+    SurveyGizmo.base_uri.should == 'https://restapi.surveygizmo.com/v4'
   end
 end

data/survey-gizmo-ruby.gemspec

@@ -2,9 +2,11 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
+require 'survey_gizmo/version'
+
 Gem::Specification.new do |gem|
   gem.name = 'survey-gizmo-ruby'
-  gem.version = '2.0.1'
+  gem.version = SurveyGizmo::VERSION
   gem.authors = ['Kabari Hendrick', 'Chris Horn', 'Adrien Jarthon', 'Lumos Labs, Inc.']
   gem.email = ['adrien.jarthon@dimelo.com']
   gem.description = 'Gem to use the SurveyGizmo.com REST API, v3+'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: survey-gizmo-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.3
 platform: ruby
 authors:
 - Kabari Hendrick
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -196,6 +196,7 @@ files:
 - README.md
 - Rakefile
 - lib/survey-gizmo-ruby.rb
+- lib/survey_gizmo/api/account_teams.rb
 - lib/survey_gizmo/api/contact.rb
 - lib/survey_gizmo/api/email_message.rb
 - lib/survey_gizmo/api/option.rb
@@ -204,9 +205,12 @@ files:
 - lib/survey_gizmo/api/response.rb
 - lib/survey_gizmo/api/survey.rb
 - lib/survey_gizmo/api/survey_campaign.rb
+- lib/survey_gizmo/configuration.rb
 - lib/survey_gizmo/resource.rb
 - lib/survey_gizmo/rest_response.rb
 - lib/survey_gizmo/survey_gizmo.rb
+- lib/survey_gizmo/version.rb
+- spec/configuration_spec.rb
 - spec/resource_spec.rb
 - spec/spec_helper.rb
 - spec/support/methods.rb
@@ -243,6 +247,7 @@ signing_key:
 specification_version: 4
 summary: Gem to use the SurveyGizmo.com REST API, v3+
 test_files:
+- spec/configuration_spec.rb
 - spec/resource_spec.rb
 - spec/spec_helper.rb
 - spec/support/methods.rb