surveymonkey 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e1ba04b72f387956b57379112fcc3d0b2af52bc
-  data.tar.gz: 646d1fbe102a8c982f8bf6d360e602dd790577bb
+  metadata.gz: f76a9537a7930fbe4e0cb07df9a37ae6f0af006b
+  data.tar.gz: 40359b7c3c9f074de14439a927ab2487e12ea158
 SHA512:
-  metadata.gz: 84eb3f064ff7f5538fb07c0d542616a88e60230360d6f56bdfcd6f7716adbae616bc035e1472fb693dcc9959372047e617f58b17a21e7f7807fcc5aaf915b29c
-  data.tar.gz: 93123b3ba30cf464513bd35f603fe1b93bcf3d19f5add1e7db5f8475cdf0637d51757ece7bdf774f91197aae3237590aa3a6c0a70618b6e7b1c68f7b12b9cc08
+  metadata.gz: daa7736f969950a13f79936f0047d712110e113bea725503da70629b4b3f651b5a732d042d31107dcb6cf4109c3f784eb254903814be6af60731b370e3fe4578
+  data.tar.gz: 50840782d00d245888fd066e80f9f5c6fab6a9cd00ad949281d3a68b2da71dbbf698176a8c88da38e24f41386bfc3f0a0a56c0e82182c273bd144a7548481dac

data/lib/surveymonkey.rb

@@ -1,7 +1,9 @@
+require "deep_merge"
 require "logging"
 
 require "surveymonkey/version"
 require "surveymonkey/logging"
+require "surveymonkey/error"
 require "surveymonkey/request"
 
 ##
@@ -12,6 +14,21 @@ module Surveymonkey
   class << self
     # Constants
 
+    ##
+    # Default page size for paginated API requests
+
+    DefaultPageSize = 1000
+
+    ##
+    # API methods that support pagination
+
+    PaginatedMethods = {
+      :get_survey_list     => 'surveys',
+      :get_collector_list  => 'collectors',
+      :get_respondent_list => 'respondents',
+      :get_template_list   => 'templates',
+    }
+
     # Public methods
 
     ##
@@ -21,29 +38,112 @@ module Surveymonkey
 
     def method_missing(method_name, *args)
       begin
-        $log.debug(sprintf("%s: %s\n", __method__, 'enter'))
+        $log.debug sprintf("%s: %s\n", __method__, 'enter')
 
-        method_params = Hash(Array(args).shift) || {}
-        $log.debug(sprintf("%s: method_params: %s\n", __method__, method_params.inspect))
+        the_args = Hash(Array(args).shift) || {}
 
-        request = Surveymonkey::Request.new(method_name.to_s, method_params)
-        response = request.execute
-        response
+        # extract page_size if passed in args
+        page_size = the_args.delete('page_size') { |key| DefaultPageSize }.to_i
+        $log.debug sprintf("%s: page_size: %i\n", __method__, page_size)
+
+        method_params = the_args
+        $log.debug sprintf("%s: method_params: %s\n", __method__, method_params.inspect)
+
+        # is this a paginated method?
+        pagination_field = PaginatedMethods.fetch(method_name, nil)
+        if pagination_field
+          $log.info sprintf("calling method '%s' with pagination, page size %i", method_name, page_size)
+          paginate_request(method_name, pagination_field, page_size, method_params)
+        else
+          $log.info sprintf("calling method '%s' without pagination", method_name)
+          Surveymonkey::Request.new(method_name.to_s, method_params).execute
+        end
 
       rescue TypeError => e
-        $log.fatal(sprintf("%s: method parameters must be a hash\n", __method__))
+        $log.fatal sprintf("%s: method parameters must be a hash\n", __method__)
         exit 1
+
       rescue KeyError => e
-        $log.fatal(sprintf("%s: method '%s' not implemented\n", __method__, method_name.to_s))
+        $log.fatal sprintf("%s: method '%s' not implemented\n", __method__, method_name.to_s)
         exit 1
+
       rescue StandardError => e
-        $log.error(sprintf("%s: %s\n", __method__, e.message))
-        raise
+        $log.error sprintf("%s: %s\n", __method__, e.message)
+        raise e
+
       end
     end
 
     # Private methods
     private
 
+    ##
+    # Execute a series of requests, collating the results.
+
+    def paginate_request(api_method, field, page_size = 1000, method_params = {}) # :nodoc:
+      begin
+        $log.debug sprintf("%s: enter", __method__)
+
+        current_page = 1
+        num_results = page_size
+        final_response = {}
+        results = []
+
+        $log.info sprintf("%s: requesting pages of %i items", __method__, page_size)
+
+        while num_results >= page_size
+
+          method_params.merge!({'page' => current_page})
+          method_params.merge!({'page_size' => page_size})
+
+          $log.debug sprintf("requesting %s: %s", api_method, method_params.inspect)
+
+          response = execute_request(api_method.to_sym, method_params)
+
+          page_results = response.fetch('data', {}).fetch(field, [])
+
+          $log.info sprintf("%s returned batch of %i results", api_method, page_results.length)
+
+          results.concat(page_results)
+
+          $log.info sprintf("%i total results collected from %s", results.length, api_method)
+
+          num_results = page_results.length
+
+          current_page = current_page.next
+
+          final_response.deep_merge!(response)
+        end
+
+        final_response['data'].store(field, results.uniq)
+
+        final_response
+
+      rescue Surveymonkey::Error => e
+        $log.error sprintf("SurveyMonkey API error: %s", e.message)
+        raise e
+
+      rescue StandardError => e
+        $log.error(sprintf("%s: %s\n", __method__, e.message))
+        raise e
+
+      end
+    end
+
+    ##
+    # Execute a single API request.
+    def execute_request(method_name, method_params = {}) # :nodoc:
+      begin
+        $log.debug sprintf("%s: %s %s", __method__, method_name.to_s, method_params.inspect)
+
+        Surveymonkey::Request.new(method_name.to_s, {'method_params' => method_params}).execute
+
+      rescue StandardError => e
+        $log.error sprintf("%s: %s\n", __method__, e.message)
+        raise e
+
+      end
+    end
+
   end
 end

data/lib/surveymonkey/version.rb

@@ -2,5 +2,5 @@
 # Specify the version of the surveymonkey gem.
 
 module Surveymonkey
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/surveymonkey.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 2.4"
   spec.add_development_dependency "rubygems-tasks", "~> 0.2"
 
+  spec.add_runtime_dependency "deep_merge", "~> 1"
   spec.add_runtime_dependency "httparty", "~> 0.13"
   spec.add_runtime_dependency "json", "~> 1.8"
   spec.add_runtime_dependency "logging", "~> 2"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surveymonkey
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Steve Huff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement