surveymonkey 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b64132d5d1febf1ea23a672a432bda1c3f87db7
-  data.tar.gz: f956f7dfba34dd84c1d2ebd858ffd1c336301063
+  metadata.gz: 6e1ba04b72f387956b57379112fcc3d0b2af52bc
+  data.tar.gz: 646d1fbe102a8c982f8bf6d360e602dd790577bb
 SHA512:
-  metadata.gz: a708772e0e48a25ac487c2fdae8904d91a97b3e77893459a9b69b8a8066f96f33123d0001351942c4b7e2f222dc59c71c58a6ad2e74d5329888d237a7cace4f4
-  data.tar.gz: 0ba7c59b97a3595a275965bc9c320e5766ee2a1aacd7d38faa9bf8673a81179d3bb12d0ba97fe5858335710b30d3b0fedba7a353c61022ab5d346c61a71cae8b
+  metadata.gz: 84eb3f064ff7f5538fb07c0d542616a88e60230360d6f56bdfcd6f7716adbae616bc035e1472fb693dcc9959372047e617f58b17a21e7f7807fcc5aaf915b29c
+  data.tar.gz: 93123b3ba30cf464513bd35f603fe1b93bcf3d19f5add1e7db5f8475cdf0637d51757ece7bdf774f91197aae3237590aa3a6c0a70618b6e7b1c68f7b12b9cc08

data/README.md

@@ -67,6 +67,8 @@ To pass parameters to an API method, pass a hash as the `method_params` paramete
 
 API method responses are parsed into Ruby data structures; do with them as you think best.
 
+SurveyMonkey API responses include a `status` attribute.  The possible values of this attribute are documented upstream; `Surveymonkey::Client` inspects each API response and raises a `Surveymonkey::Error` if the status code is other than 0.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/surveymonkey/error.rb

@@ -0,0 +1,54 @@
+require 'surveymonkey/logging'
+
+class Surveymonkey::Error < StandardError
+  # constants
+
+  ##
+  # API status codes, documented upstream.
+
+  Status_codes = {
+    0 => 'Success',
+    1 => 'Not Authenticated',
+    2 => 'Invalid User Credentials',
+    3 => 'Invalid Request',
+    4 => 'Unknown User',
+    5 => 'System Error'
+  }
+
+  attr_reader :status, :status_name, :status_codes, :errmsg
+
+  ##
+  # Create a new Surveymonkey::Error object.  Pass in the hash parsed from the
+  # JSON object returned by the API.
+
+  def initialize(error = {}, status_codes = Status_codes)
+    begin
+      @status_codes = status_codes
+      @status       = error.fetch('status', 0)
+      @errmsg       = error.fetch('errmsg', '')
+      @status_name  = _status_name(@status)
+
+    rescue StandardError => e
+      $log.error(sprintf("%s: unable to parse '%s' as error\n", __method__, error.inspect))
+      raise
+    end
+  end
+
+  ##
+  # Stringify a Surveymonkey::Error object.
+
+  def to_s
+    sprintf("Error %i (%s): %s", self.status, self.status_name, self.errmsg)
+  end
+
+  private
+
+  def _status_name(error) # :nodoc:
+    begin
+      self.status_codes.fetch(error)
+    rescue StandardError => e
+      $log.error(sprintf("%s: %i is not a valid error code\n", __method__, error))
+      raise
+    end
+  end
+end

data/lib/surveymonkey/request.rb

@@ -1,6 +1,7 @@
 require 'surveymonkey/logging'
 require 'surveymonkey/api'
 require 'surveymonkey/client'
+require 'surveymonkey/error'
 
 ##
 # Object representing a request to the SurveyMonkey API.  Parameters should all be populated automatically.
@@ -46,7 +47,15 @@ class Surveymonkey::Request
         $log.debug(sprintf("%s: response code %i\n", __method__, response.code))
         $log.debug(sprintf("%s: response headers '%s'\n", __method__, response.headers.inspect))
 
-        response.parsed_response
+        parsed = response.parsed_response
+        status = parsed.fetch('status')
+
+        if status == 0
+          parsed
+        else
+          $log.debug(sprintf("%s: API returned status %i\n", __method__, status))
+          raise Surveymonkey::Error.new(parsed)
+        end
 
       rescue StandardError => e
         $log.error(sprintf("%s: unable to execute API request: %s\n", __method__, e.message))

data/lib/surveymonkey/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: surveymonkey
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Steve Huff
@@ -158,6 +158,7 @@ files:
 - lib/surveymonkey/api.rb
 - lib/surveymonkey/api/method.rb
 - lib/surveymonkey/client.rb
+- lib/surveymonkey/error.rb
 - lib/surveymonkey/logging.rb
 - lib/surveymonkey/request.rb
 - lib/surveymonkey/version.rb