surveymonkey 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f76a9537a7930fbe4e0cb07df9a37ae6f0af006b
-  data.tar.gz: 40359b7c3c9f074de14439a927ab2487e12ea158
+  metadata.gz: 01090e5bb2cc9905f723fc8cd3ba440b0d7557bf
+  data.tar.gz: 800fa9a973a283ba9dd36053a88c6bdc66eb2285
 SHA512:
-  metadata.gz: daa7736f969950a13f79936f0047d712110e113bea725503da70629b4b3f651b5a732d042d31107dcb6cf4109c3f784eb254903814be6af60731b370e3fe4578
-  data.tar.gz: 50840782d00d245888fd066e80f9f5c6fab6a9cd00ad949281d3a68b2da71dbbf698176a8c88da38e24f41386bfc3f0a0a56c0e82182c273bd144a7548481dac
+  metadata.gz: f75ee597a09ad0fab36c1a15063abef4dda45d0c6e0ccf0a8442076c6e7778ebb8666809643cdfb381f2f67060f8618bf0d809f8ba3d486cfbd730f14e4b4bc5
+  data.tar.gz: bdc3c2d2e98e212bc4671edf973c274d58e4eacbf30c341fe468a689ae59f4c97dabb1e0182430ca78cc33c807a340fff2d02e72285ab443c044dbaa1b3cc0e7

data/lib/surveymonkey.rb

@@ -38,16 +38,16 @@ module Surveymonkey
 
     def method_missing(method_name, *args)
       begin
-        $log.debug sprintf("%s: %s\n", __method__, 'enter')
+        $log.debug sprintf("%s: %s", __method__, 'enter')
 
         the_args = Hash(Array(args).shift) || {}
 
         # 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)
+        $log.debug sprintf("%s: page_size: %i", __method__, page_size)
 
         method_params = the_args
-        $log.debug sprintf("%s: method_params: %s\n", __method__, method_params.inspect)
+        $log.debug sprintf("%s: method_params: %s", __method__, method_params.inspect)
 
         # is this a paginated method?
         pagination_field = PaginatedMethods.fetch(method_name, nil)
@@ -60,15 +60,15 @@ module Surveymonkey
         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", __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", __method__, method_name.to_s)
         exit 1
 
       rescue StandardError => e
-        $log.error sprintf("%s: %s\n", __method__, e.message)
+        $log.error sprintf("%s: %s", __method__, e.message)
         raise e
 
       end
@@ -124,7 +124,7 @@ module Surveymonkey
         raise e
 
       rescue StandardError => e
-        $log.error(sprintf("%s: %s\n", __method__, e.message))
+        $log.error(sprintf("%s: %s", __method__, e.message))
         raise e
 
       end
@@ -139,7 +139,7 @@ module Surveymonkey
         Surveymonkey::Request.new(method_name.to_s, {'method_params' => method_params}).execute
 
       rescue StandardError => e
-        $log.error sprintf("%s: %s\n", __method__, e.message)
+        $log.error sprintf("%s: %s", __method__, e.message)
         raise e
 
       end

data/lib/surveymonkey/api.rb

@@ -61,24 +61,24 @@ class Surveymonkey::API
 
   def api_method(key, api_methods = self.api_methods)
     begin
-      $log.debug(sprintf("%s: api methods: %s\n", __method__, api_methods.inspect))
-      $log.debug(sprintf("%s: fetching '%s' from API methods\n", __method__, key))
+      $log.debug(sprintf("%s: api methods: %s", __method__, api_methods.inspect))
+      $log.debug(sprintf("%s: fetching '%s' from API methods", __method__, key))
       value = api_methods.fetch(key)
-      $log.debug(sprintf("%s: retrieved '%s'\n", __method__, value.inspect))
+      $log.debug(sprintf("%s: retrieved '%s'", __method__, value.inspect))
 
       path = value['path']
-      $log.debug(sprintf("%s: path '%s'\n", __method__, path))
+      $log.debug(sprintf("%s: path '%s'", __method__, path))
       method = (value['method'] || 'post')
-      $log.debug(sprintf("%s: method '%s'\n", __method__, method))
+      $log.debug(sprintf("%s: method '%s'", __method__, method))
 
       # return
       Surveymonkey::API::Method.new(path, method, method_name = key)
 
     rescue KeyError => e
-      $log.error(sprintf("%s: '%s' not found in api methods\n", __method__, key))
+      $log.error(sprintf("%s: '%s' not found in api methods", __method__, key))
       raise e
     rescue StandardError => e
-      $log.error(sprintf("%s: %s\n", __method__, e.message))
+      $log.error(sprintf("%s: %s", __method__, e.message))
       raise
     end
   end
@@ -91,15 +91,15 @@ class Surveymonkey::API
   def api_method_params(method_params)
     begin
       # TODO validate params against API spec
-      $log.debug(sprintf("%s: parsing api method params from '%s'\n", __method__, method_params))
+      $log.debug(sprintf("%s: parsing api method params from '%s'", __method__, method_params))
       the_params = (method_params.kind_of?(String) ? method_params : JSON.generate(method_params || {}))
-      $log.debug(sprintf("%s: parsed method params '%s'\n", __method__, the_params))
+      $log.debug(sprintf("%s: parsed method params '%s'", __method__, the_params))
 
       # return
       the_params
 
     rescue StandardError => e
-      $log.error(sprintf("%s: %s\n", __method__, e.message))
+      $log.error(sprintf("%s: %s", __method__, e.message))
       raise
     end
   end
@@ -114,7 +114,7 @@ class Surveymonkey::API
       @api_methods = Api_methods
       @api_version = Api_version
     rescue StandardError => e
-      $log.error(sprintf("%s: %s\n", __method__, e.message))
+      $log.error(sprintf("%s: %s", __method__, e.message))
       raise
     end
   end

data/lib/surveymonkey/api/method.rb

@@ -21,9 +21,8 @@ class Surveymonkey::API::Method
       @method_name = method_name.to_s
 
       # validate the method
-      $log.debug(sprintf("%s:http_method: '%s'\n", __method__, http_method))
       the_method = http_method.to_s.downcase
-      $log.debug(sprintf("%s:the_method: '%s'\n", __method__, the_method))
+      $log.debug(sprintf("%s: the_method: '%s' (was '%s')", __method__, the_method, http_method))
 
       if the_method =~ /^(get|post|patch|put|delete|move|copy|head|options)$/
         @http_method = the_method
@@ -33,7 +32,7 @@ class Surveymonkey::API::Method
       end
 
     rescue StandardError => e
-      $log.error(sprintf("%s: unable to initialize API method: %s\n", __method__, e.message))
+      $log.error(sprintf("%s: unable to initialize API method: %s", __method__, e.message))
       raise
     end
   end

data/lib/surveymonkey/client.rb

@@ -30,16 +30,15 @@ class Surveymonkey::Client
 
       self.class.logger $log, :debug
 
-      $log.debug(sprintf("%s: setting base_uri to '%s'\n", __method__, @baseuri))
+      $log.debug(sprintf("%s: setting base_uri to '%s'", __method__, @baseuri))
       self.class.base_uri @baseuri
 
-      $log.debug(sprintf("%s: setting headers'\n", __method__))
       http_headers = _http_headers(@access_token)
       self.class.headers http_headers
 
     rescue StandardError => e
-      $log.error(sprintf("%s: %s\n", __method__, e.message))
-      raise
+      $log.error(sprintf("%s: %s", __method__, e.message))
+      raise e
     end
   end
 
@@ -55,17 +54,17 @@ class Surveymonkey::Client
 
   def _http_headers(token) #:nodoc:
     begin
-      $log.debug(sprintf("%s: constructing http headers with token '%s'\n", __method__, token))
+      $log.debug(sprintf("%s: constructing http headers with token '%s'", __method__, token))
       http_headers = {
         "Content-Type" => "application/json",
         "Authorization" => sprintf("bearer %s", token),
       }
-      $log.debug(sprintf("%s: http headers: '%s'\n", __method__, http_headers))
+      $log.debug(sprintf("%s: http headers: '%s'", __method__, http_headers))
       http_headers
 
     rescue StandardError => e
-      $log.error(sprintf("%s: %s\n", __method__, e.message))
-      raise
+      $log.error(sprintf("%s: %s", __method__, e.message))
+      raise e
     end
   end
 

data/lib/surveymonkey/error.rb

@@ -29,8 +29,8 @@ class Surveymonkey::Error < StandardError
       @status_name  = _status_name(@status)
 
     rescue StandardError => e
-      $log.error(sprintf("%s: unable to parse '%s' as error\n", __method__, error.inspect))
-      raise
+      $log.error(sprintf("%s: unable to parse '%s' as error", __method__, error.inspect))
+      raise e
     end
   end
 
@@ -47,7 +47,7 @@ class Surveymonkey::Error < StandardError
     begin
       self.status_codes.fetch(error)
     rescue StandardError => e
-      $log.error(sprintf("%s: %i is not a valid error code\n", __method__, error))
+      $log.error(sprintf("%s: %i is not a valid error code", __method__, error))
       raise
     end
   end

data/lib/surveymonkey/request.rb

@@ -26,40 +26,58 @@ class Surveymonkey::Request
 
     def execute(method_params = self.method_params, api_method = self.api_method, api_key = self.api_key, access_token = self.access_token)
       begin
-        $log.debug(sprintf("%s: enter\n", __method__))
+        $log.debug(sprintf("%s: enter", __method__))
+
+        method_logname = sprintf("%s[%s]", __method__, api_method)
 
         self.method_params=(self.api.api_method_params(method_params))
         method_params = self.method_params
-        $log.debug(sprintf("%s: method_params: %s\n", __method__, method_params))
+        $log.debug(sprintf("%s: method_params: %s", method_logname, method_params))
 
         path = api_method.path
-        $log.debug(sprintf("%s: path: %s\n", __method__, path))
+        $log.debug(sprintf("%s: path: %s", method_logname, path))
 
         http_method = api_method.http_method
-        $log.debug(sprintf("%s: http_method: %s\n", __method__, http_method))
+        $log.debug(sprintf("%s: http_method: %s", method_logname, http_method))
 
         request_uri = _request_uri(path, api_key)
-        $log.debug(sprintf("%s: ready to make request for '%s'\n", __method__, api_method))
+        $log.debug(sprintf("%s: ready to make request for '%s'", method_logname, api_method))
 
         response = self.client.class.send(http_method.to_sym, request_uri, body: self.method_params)
 
-        $log.debug(sprintf("%s: response class %s\n", __method__, response.class))
-        $log.debug(sprintf("%s: response code %i\n", __method__, response.code))
-        $log.debug(sprintf("%s: response headers '%s'\n", __method__, response.headers.inspect))
+        $log.debug(sprintf("%s: response class %s code %i", method_logname, response.class, response.code))
+        $log.debug(sprintf("%s: response headers '%s'", method_logname, response.headers.inspect))
+
+        if _valid_response?(response)
+          parsed = response.parsed_response
+          status = parsed.fetch('status')
+          $log.debug(sprintf("%s: API returned status %i", method_logname, status))
 
-        parsed = response.parsed_response
-        status = parsed.fetch('status')
+          if status == 0
+            $log.debug(sprintf("%s: raw data: %s", method_logname, response.body.to_s))
+            $log.debug(sprintf("%s: parsed data: %s", method_logname, parsed.fetch('data', []).inspect))
+            parsed
+          else
+            raise Surveymonkey::Error.new(parsed)
+          end
 
-        if status == 0
-          parsed
         else
-          $log.debug(sprintf("%s: API returned status %i\n", __method__, status))
-          raise Surveymonkey::Error.new(parsed)
+          $log.error sprintf("%s: API returned invalid HTTP response code from '%s'", method_logname, self)
+
+          mashery_error_code  = $response.headers.fetch('x-mashery-error-code', 'UNKNOWN')
+          error_detail_header = $response.headers.fetch('x-error-detail-header', 'Unknown')
+
+          the_error = {
+            'status' => 3,
+            'errmsg' => sprintf("%s (%s)", mashery_error_code, error_detail_header)
+          }
+          raise Surveymonkey::Error.new(the_error)
         end
 
       rescue StandardError => e
-        $log.error(sprintf("%s: unable to execute API request: %s\n", __method__, e.message))
-        raise
+        $log.error sprintf("%s: unable to execute API request: %s", method_logname, self)
+        $log.debug sprintf("%s: response: %s", method_logname, parsed.inspect)
+        raise e
       end
     end
 
@@ -73,9 +91,9 @@ class Surveymonkey::Request
 
     def initialize(api_method, *args)
       begin
-        $log.debug(sprintf("%s: enter\n", __method__))
-        $log.debug(sprintf("%s: api_method: %s\n", __method__, api_method))
-        $log.debug(sprintf("%s: args: %s\n", __method__, args))
+        $log.debug(sprintf("%s: enter", __method__))
+        $log.debug(sprintf("%s: api_method: %s", __method__, api_method))
+        $log.debug(sprintf("%s: args: %s", __method__, args))
 
         # store the API method name for stringification
         @method_name = api_method
@@ -97,7 +115,7 @@ class Surveymonkey::Request
         @api = Surveymonkey::API.new
 
       rescue StandardError => e
-        $log.error(sprintf("%s: unable to initialize API request: %s\n", __method__, e.message))
+        $log.error(sprintf("%s: unable to initialize API request: %s", __method__, e.message))
         raise
       end
     end
@@ -107,7 +125,7 @@ class Surveymonkey::Request
     #
 
     def to_s
-      self.method_name
+      sprintf("%s %s", self.api_method, self.method_params.inspect)
     end
 
 
@@ -118,8 +136,8 @@ class Surveymonkey::Request
       begin
         @client = Surveymonkey::Client.new()
       rescue StandardError => e
-        $log.fatal(sprintf("%s: %s\n", "Unable to initialize REST client", e.message))
-        $log.debug(sprintf("%s: %s\n", __method__, e.message))
+        $log.fatal(sprintf("%s: %s", "Unable to initialize REST client", e.message))
+        $log.debug(sprintf("%s: %s", __method__, e))
         raise
       end
     end
@@ -128,53 +146,72 @@ class Surveymonkey::Request
       begin
         @api = Surveymonkey::API.new()
       rescue StandardError => e
-        $log.fatal(sprintf("%s: %s\n", "Unable to initialize SurveyMonkey API", e.message))
-        $log.debug(sprintf("%s: %s\n", __method__, e.message))
+        $log.fatal(sprintf("%s: %s", "Unable to initialize SurveyMonkey API", e.message))
+        $log.debug(sprintf("%s: %s", __method__, e))
         raise
       end
     end
 
     def _http_headers(token) #:nodoc:
       begin
-        $log.debug(sprintf("%s: constructing http headers with token '%s'\n", __method__, token))
+        $log.debug(sprintf("%s: constructing http headers with token '%s'", __method__, token))
         http_headers = {
           "Content-Type" => "application/json",
           "Authorization" => sprintf("bearer %s", token),
         }
-        $log.debug(sprintf("%s: http headers: '%s'\n", __method__, http_headers))
+        $log.debug(sprintf("%s: http headers: '%s'", __method__, http_headers))
         http_headers
 
-      rescue Exception => e
-        $log.error(sprintf("%s: %s\n", __method__, e.message))
-        raise
+      rescue StandardError => e
+        $log.error(sprintf("%s: %s", __method__, e.message))
+        raise e
       end
     end
 
     def _from_env(key) #:nodoc:
       begin
-        $log.debug(sprintf("%s: fetching '%s' from environment\n", __method__, key))
+        $log.debug(sprintf("%s: fetching '%s' from environment", __method__, key))
         value = ENV.fetch(key)
-        $log.debug(sprintf("%s: retrieved '%s'\n", __method__, value))
+        $log.debug(sprintf("%s: retrieved '%s'", __method__, value))
         value
 
       rescue KeyError => e
-        $log.info(sprintf("%s: '%s' not found in environment\n", __method__, key))
-      rescue Exception => e
-        $log.error(sprintf("%s: %s\n", __method__, e.message))
-        raise
+        $log.info(sprintf("%s: '%s' not found in environment", __method__, key))
+      rescue StandardError => e
+        $log.error(sprintf("%s: %s", __method__, e.message))
+        raise e
       end
     end
 
     def _request_uri(path, api_key) #:nodoc:
       begin
-        $log.debug(sprintf("%s: generating request uri fragment from '%s' and '%s'\n", __method__, path, api_key))
+        $log.debug(sprintf("%s: generating request uri fragment from '%s' and '%s'", __method__, path, api_key))
         request_uri = sprintf("%s?api_key=%s", path, api_key)
-        $log.debug(sprintf("%s: generated '%s'\n", __method__, request_uri))
+        $log.debug(sprintf("%s: generated '%s'", __method__, request_uri))
         request_uri
 
       rescue StandardError => e
-        $log.error(sprintf("%s: %s\n", __method__, e.message))
-        raise
+        $log.error(sprintf("%s: %s", __method__, e.message))
+        raise e
+      end
+    end
+
+    def _valid_response?(response) #:nodoc:
+      begin
+        code = response.code
+        $log.debug sprintf("%s: HTTP response code is %i", __method__, code)
+        # this claims to raise an exception if the response is not a 2XX
+        response.value
+
+        code
+
+      rescue Net::HTTPError => e
+        $log.error sprintf("%s: HTTP error: %s", __method__, e.message)
+        return nil
+
+      rescue StandardError => e
+        $log.error(sprintf("%s: %s", __method__, e.message))
+        raise e
       end
     end
   end

data/lib/surveymonkey/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surveymonkey
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Steve Huff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler