survey-gizmo-ruby 5.0.3 → 5.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e8d3c3ad7b01fbcd010738d2a5cf49376162df8
-  data.tar.gz: b7718a4435ea2b88abe17d460698b1104b2d6b02
+  metadata.gz: c2d8dfa46ed2f287166d32c156466b1ff39d84b7
+  data.tar.gz: c22d6cb33d3e3a57fe6d848e33011dd9c5f860ad
 SHA512:
-  metadata.gz: 3f9484c0436ffe3d78b5a0b68e0fe208ed3144480f7e0e7aefc3a4bb346e9f783b553d99dd542c5c9d6040ff263c9469472598137c40670f6c10925bf99aed05
-  data.tar.gz: 165082ee6af357726b193f86c6ef5c803a66fb7b77c21c43292254bcbc096403050c6b6ca7ec48611639664c7ee9fcbda570a2a3514f8ca634547c7520d64a35
+  metadata.gz: 89cda081f559f84fb5c19493ddb11e2f48bd0d8c4ff26d76ab6f4d8320428dc5dbfc7561cbbf929a67fb4217cae391414b269eeb6a330c2a7fb3f9549d1986eb
+  data.tar.gz: 06cac087f8f21a42fe5a6e2c535d0e407fac2d86fa39967778942e68ce469419dadb7e56308a47a95e48c1e87d5241788d9465792b7356d48805bf2372995f2d

data/README.md

@@ -58,6 +58,9 @@ SurveyGizmo.configure do |config|
 
   # Optional - Defaults to 50, maximum 500. Setting too high may cause SurveyGizmo to start throwing timeouts.
   config.results_per_page = 100
+
+  # Optional - Defaults to 300 seconds
+  config.timeout_seconds = 600
 end
 ```
 
@@ -78,7 +81,8 @@ Pester.configure do |config|
   config.environments[:survey_gizmo_ruby][:retry_error_classes] = [MyExceptionClass, MyOtherExceptionClass]
 end
 
-# To set Pester to retry on ALL exception classes, do this (use with caution! Can include exceptions Rails likes to throw on SIGHUP)
+# To set Pester to retry on ALL exception classes, do this:
+# (use with caution! Can include exceptions Rails likes to throw on SIGHUP)
 Pester.configure do |config|
   config.environments[:survey_gizmo_ruby][:retry_error_classes] = nil
 end
@@ -121,9 +125,9 @@ questions = survey.questions
 questions = survey.actual_questions
 
 # Create a question for your survey.  The returned object will be given an :id parameter by SG.
-question = SurveyGizmo::API::Question.create(survey_id: survey.id, title: 'Do you like ruby?', type: 'checkbox')
+question = SurveyGizmo::API::Question.create(survey_id: survey.id, title: 'Do u ruby?', type: 'checkbox')
 # Update a question
-question.title = "Do you LOVE Ruby?"
+question.title = "Do u <3 Ruby?"
 question.save
 # Destroy a question
 question.destroy
@@ -131,8 +135,8 @@ question.destroy
 # Iterate over all your Responses
 survey.responses.each { |response| do_something_with(response) }
 # Use filters to limit results - this example will iterate over page 3 of completed, non test data
-# SurveyResponses submitted within the past 3 days for contact 999. It demonstrates how to use some of the gem's
-# built in filters/generators as well as how to construct a filter.
+# SurveyResponses submitted within the past 3 days for contact 999. It demonstrates how to use some of
+# the gem's built in filters/generators as well as how to construct a filter.
 # See: http://apihelp.surveygizmo.com/help/article/link/filters for more info on filters
 filters = [
   SurveyGizmo::API::Response::NO_TEST_DATA,
@@ -197,7 +201,7 @@ class SomeObject
     get: '/something/:id',
     update: '/something/weird/:id',
     create: '/something',
-    delete: /something/delete/:id'
+    delete: '/something/delete/:id'
   }
 end
 ```

data/lib/survey_gizmo/api/account_teams.rb

@@ -1,19 +1,17 @@
 # This REST endpoint is only available to accounts with admin privileges
 # This code is untested.
 
-module SurveyGizmo
-  module API
-    class AccountTeams
-      include SurveyGizmo::Resource
+module SurveyGizmo::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
+    attribute :id,            Integer
+    attribute :teamid,        Integer
+    attribute :teamname,      String
+    attribute :color,         String
+    attribute :default_role,  String
+    attribute :status,        String
 
-      @route = '/accountteams'
-    end
+    @route = '/accountteams'
   end
 end

data/lib/survey_gizmo/api/answer.rb

@@ -1,59 +1,56 @@
-module SurveyGizmo
-  module API
-    class Answer
-      include Virtus.model
+module SurveyGizmo::API
+  class Answer
+    include Virtus.model
 
-      attribute :key,           String
-      attribute :value,         String
-      attribute :survey_id,     Integer
-      attribute :response_id,   Integer
-      attribute :question_id,   Integer
-      attribute :option_id,     Integer
-      attribute :submitted_at,  DateTime
-      attribute :answer_text,   String
-      attribute :other_text,    String
-      attribute :question_pipe, String
+    attribute :key,           String
+    attribute :value,         String
+    attribute :survey_id,     Integer
+    attribute :response_id,   Integer
+    attribute :question_id,   Integer
+    attribute :option_id,     Integer
+    attribute :submitted_at,  DateTime
+    attribute :answer_text,   String
+    attribute :other_text,    String
+    attribute :question_pipe, String
 
-      def initialize(attrs = {})
-        self.attributes = attrs
+    def initialize(attrs = {})
+      self.attributes = attrs
 
-        case key
-        when /\[question\((\d+)\),\s*option\((\d+|"\d+-other")\)\]/
-          @question_id, @option_id = $1, $2
+      case key
+      when /\[question\((\d+)\),\s*option\((\d+|"\d+-other")\)\]/
+        self.question_id, self.option_id = $1, $2
 
-          if @option_id =~ /other/
-            @option_id.delete!('-other"')
-            self.other_text = value
-          end
-        when /\[question\((\d+)\),\s*question_pipe\("(.*)"\)\]/
-          @question_id = $1
-          @question_pipe = $2
-        when /\[question\((\d+)\)\]/
-          @question_id = $1
-        else
-          fail "Can't recognize pattern for #{attrs[:key]} => #{attrs[:value]} - you may have to parse your answers manually."
-        end
-
-        self.question_id = @question_id.to_i
-        if @option_id
-          fail "Bad option_id #{option_id}!" if option_id.to_i == 0 && option_id != '0'
-          self.option_id = @option_id.to_i
+        if option_id =~ /-other/
+          option_id.delete!('-other"')
+          self.other_text = value
         end
+      when /\[question\((\d+)\),\s*question_pipe\("(.*)"\)\]/
+        self.question_id, self.question_pipe = $1, $2
+      when /\[question\((\d+)\)\]/
+        self.question_id = $1
+      else
+        fail "Can't recognize pattern for #{attrs[:key]} => #{attrs[:value]} - you may have to parse your answers manually."
       end
 
-      # Strips out the answer_text when there is a valid option_id
-      def to_hash
-        {
-          response_id: response_id,
-          question_id: question_id,
-          option_id: option_id,
-          question_pipe: question_pipe,
-          submitted_at: submitted_at,
-          survey_id: survey_id,
-          other_text: other_text,
-          answer_text: option_id || other_text ? nil : answer_text
-        }.reject { |k,v| v.nil? }
+      self.question_id = question_id.to_i
+      if option_id
+        fail "Bad option_id #{option_id} (class: #{option_id.class}) for #{attrs}!" if option_id.to_i == 0 && option_id != '0' && option_id != 0
+        self.option_id = option_id.to_i
       end
     end
+
+    # Strips out the answer_text when there is a valid option_id
+    def to_hash
+      {
+        response_id: response_id,
+        question_id: question_id,
+        option_id: option_id,
+        question_pipe: question_pipe,
+        submitted_at: submitted_at,
+        survey_id: survey_id,
+        other_text: other_text,
+        answer_text: option_id || other_text ? nil : answer_text
+      }.reject { |k, v| v.nil? }
+    end
   end
 end

data/lib/survey_gizmo/api/campaign.rb

@@ -1,5 +1,4 @@
-module SurveyGizmo; module API
-  # @see SurveyGizmo::Resource::ClassMethods
+module SurveyGizmo::API
   class Campaign
     include SurveyGizmo::Resource
 
@@ -29,4 +28,4 @@ module SurveyGizmo; module API
       Contact.all(conditions.merge(children_params).merge(all_pages: !conditions[:page]))
     end
   end
-end; end
+end

data/lib/survey_gizmo/api/contact.rb

@@ -1,5 +1,4 @@
-module SurveyGizmo; module API
-  # @see SurveyGizmo::Resource::ClassMethods
+module SurveyGizmo::API
   class Contact
     include SurveyGizmo::Resource
 
@@ -38,4 +37,4 @@ module SurveyGizmo; module API
 
     @route = '/survey/:survey_id/surveycampaign/:campaign_id/contact'
   end
-end; end
+end

data/lib/survey_gizmo/api/email_message.rb

@@ -1,5 +1,4 @@
-module SurveyGizmo; module API
-  # @see SurveyGizmo::Resource::ClassMethods
+module SurveyGizmo::API
   class EmailMessage
     include SurveyGizmo::Resource
 
@@ -22,4 +21,4 @@ module SurveyGizmo; module API
 
     @route = '/survey/:survey_id/surveycampaign/:campaign_id/emailmessage'
   end
-end; end
+end

data/lib/survey_gizmo/api/option.rb

@@ -1,5 +1,4 @@
-module SurveyGizmo; module API
-  # @see SurveyGizmo::Resource::ClassMethods
+module SurveyGizmo::API
   class Option
     include SurveyGizmo::Resource
     include SurveyGizmo::MultilingualTitle
@@ -13,4 +12,4 @@ module SurveyGizmo; module API
 
     @route = '/survey/:survey_id/surveypage/:page_id/surveyquestion/:question_id/surveyoption'
   end
-end; end
+end

data/lib/survey_gizmo/api/page.rb

@@ -1,7 +1,6 @@
 require 'survey_gizmo/api/question'
 
-module SurveyGizmo; module API
-  # @see SurveyGizmo::Resource::ClassMethods
+module SurveyGizmo::API
   class Page
     include SurveyGizmo::Resource
     include SurveyGizmo::MultilingualTitle
@@ -33,4 +32,4 @@ module SurveyGizmo; module API
       @questions = with_subquestions.each { |q| q.attributes = children_params }
     end
   end
-end; end
+end

data/lib/survey_gizmo/api/question.rb

@@ -1,7 +1,6 @@
 require 'survey_gizmo/api/option'
 
-module SurveyGizmo; module API
-  # @see SurveyGizmo::Resource::ClassMethods
+module SurveyGizmo::API
   class Question
     include SurveyGizmo::Resource
     include SurveyGizmo::MultilingualTitle
@@ -59,4 +58,4 @@ module SurveyGizmo; module API
       end
     end
   end
-end; end
+end

data/lib/survey_gizmo/api/response.rb

@@ -1,5 +1,4 @@
-module SurveyGizmo; module API
-  # @see SurveyGizmo::Resource::ClassMethods
+module SurveyGizmo::API
   class Response
     include SurveyGizmo::Resource
 
@@ -40,7 +39,8 @@ module SurveyGizmo; module API
       answers.select do |k,v|
         next false unless v.is_a?(FalseClass) || v.present?
 
-        # Strip out "Other" answers that don't actually have the "other" text.
+        # Strip out "Other" answers that don't actually have the "other" text (they come back as two responses - one
+        # for the "Other" option_id, and then a whole separate response for the text given as an "Other" response.
         if k =~ /\[question\((\d+)\),\s*option\((\d+)\)\]/
           !answers.keys.any? { |key| key =~ /\[question\((#{$1})\),\s*option\("(#{$2})-other"\)\]/ }
         else
@@ -49,4 +49,4 @@ module SurveyGizmo; module API
       end.map { |k,v| Answer.new(children_params.merge(key: k, value: v, answer_text: v, submitted_at: submitted_at)) }
     end
   end
-end; end
+end

data/lib/survey_gizmo/api/survey.rb

@@ -1,7 +1,6 @@
 require 'survey_gizmo/api/page'
 
-module SurveyGizmo; module API
-  # @see SurveyGizmo::Resource::ClassMethods
+module SurveyGizmo::API
   class Survey
     include SurveyGizmo::Resource
 
@@ -22,16 +21,15 @@ module SurveyGizmo; module API
     attribute :created_on,     DateTime
     attribute :modified_on,    DateTime
     attribute :copy,           Boolean
-    # Unfortunately if pages is an attribute, then save and update requests will collide with the differing response
-    # types to Survey.all and Survey.first and cause an incorrect reload
+    # See comment in the #pages method for why this :pages can't be an attribute
     # attribute :pages,          Array[Page]
 
     @route = '/survey'
 
     def pages
-      # SurveyGizmo sends down the page info to .first requests but NOT to .all requests, so we must load pages manually
-      # We should be able to just .reload this Survey BUT we can't make :pages a Virtus attribute without requiring a
-      # call to this method during Survey.save
+      # SurveyGizmo sends down the page info to .first requests but NOT to .all requests, so we must load pages
+      # manually.  We should be able to just .reload this Survey BUT we can't make :pages a Virtus attribute without
+      # requiring a call to this method during Survey.save
       @pages ||= Page.all(children_params.merge(all_pages: true)).to_a
       @pages.each { |p| p.attributes = children_params }
     end
@@ -84,4 +82,4 @@ module SurveyGizmo; module API
       @campaigns ||= Campaign.all(children_params.merge(all_pages: true)).to_a
     end
   end
-end; end
+end

data/lib/survey_gizmo/configuration.rb

@@ -58,6 +58,7 @@ module SurveyGizmo
     DEFAULT_REST_API_URL = 'https://restapi.surveygizmo.com'
     DEFAULT_API_VERSION = 'v4'
     DEFAULT_RESULTS_PER_PAGE = 50
+    DEFAULT_TIMEOUT_SECONDS = 300
 
     attr_accessor :user
     attr_accessor :password
@@ -67,11 +68,13 @@ module SurveyGizmo
     attr_accessor :api_version
     attr_accessor :logger
     attr_accessor :results_per_page
+    attr_accessor :timeout_seconds
 
     def initialize
       @api_url = DEFAULT_REST_API_URL
       @api_version = DEFAULT_API_VERSION
       @results_per_page = DEFAULT_RESULTS_PER_PAGE
+      @timeout_seconds = DEFAULT_TIMEOUT_SECONDS
       @logger = SurveyGizmo::Logger.new(STDOUT)
       @api_debug = ENV['GIZMO_DEBUG'].to_s =~ /^(true|t|yes|y|1)$/i
     end

data/lib/survey_gizmo/connection.rb

@@ -2,8 +2,6 @@ require 'active_support/core_ext/module/delegation'
 
 module SurveyGizmo
   class Connection
-    TIMEOUT_SECONDS = 300
-
     class << self
       delegate :put, :get, :delete, :post, to: :connection
 
@@ -18,8 +16,8 @@ module SurveyGizmo
           url: SurveyGizmo.configuration.api_url,
           params: { 'user:md5' => "#{SurveyGizmo.configuration.user}:#{Digest::MD5.hexdigest(SurveyGizmo.configuration.password)}" },
           request: {
-            timeout: TIMEOUT_SECONDS,
-            open_timeout: TIMEOUT_SECONDS
+            timeout: SurveyGizmo.configuration.timeout_seconds,
+            open_timeout: SurveyGizmo.configuration.timeout_seconds
           }
         }
 

data/lib/survey_gizmo/version.rb

@@ -1,3 +1,3 @@
 module SurveyGizmo
-  VERSION = '5.0.3'
+  VERSION = '5.0.4'
 end

data/survey-gizmo-ruby.gemspec

@@ -11,15 +11,15 @@ Gem::Specification.new do |gem|
   gem.email = ['adrien.jarthon@dimelo.com']
   gem.description = 'Gem to use the SurveyGizmo.com REST API, v3+'
   gem.summary = 'Gem to use the SurveyGizmo.com REST API, v3+'
-  gem.homepage = 'http://github.com/RipTheJacker/survey-gizmo-ruby'
+  gem.homepage = 'http://github.com/jarthod/survey-gizmo-ruby'
   gem.licenses = ['MIT']
   gem.required_ruby_version = '>= 1.9'
 
   gem.add_dependency 'activesupport', '>= 3.0'
   gem.add_dependency 'addressable', '~> 2'
   gem.add_dependency 'awesome_print', '~> 1'
-  gem.add_dependency 'faraday', '~> 0.9'
-  gem.add_dependency 'faraday_middleware'
+  gem.add_dependency 'faraday', '>= 0.9.1', '~> 0.9'
+  gem.add_dependency 'faraday_middleware', '~> 0.10'
   gem.add_dependency 'i18n'
   gem.add_dependency 'pester', '>= 1.0.0'
   gem.add_dependency 'virtus', '>= 1.0.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: survey-gizmo-ruby
 version: !ruby/object:Gem::Version
-  version: 5.0.3
+  version: 5.0.4
 platform: ruby
 authors:
 - Kabari Hendrick
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-24 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -59,6 +59,9 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -66,6 +69,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.1
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
@@ -73,16 +79,16 @@ dependencies:
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -226,7 +232,7 @@ files:
 - spec/test_json/question.json
 - spec/test_json/survey.json
 - survey-gizmo-ruby.gemspec
-homepage: http://github.com/RipTheJacker/survey-gizmo-ruby
+homepage: http://github.com/jarthod/survey-gizmo-ruby
 licenses:
 - MIT
 metadata: {}