Merge pull request #143 from baron-hines/RUBYAPI-38

RUBYAPI-38: new response attributes and request option

Author: baron-hines

CHANGELOG

@@ -1,3 +1,8 @@
+v1.4.19
+ - create SparkQLErrors attribute for SparkApi::Response and populate when present
+ - create Errors attribute for SparkApi::Response and populate when present
+ - create SparkApi::Request option `full_response` that allows methods to return object instead of body only.
+
 v1.4.18
  - include the errors from the response in the instance of ClientErrors
 

VERSION

@@ -1 +1 @@
-1.4.18
+1.4.19

lib/spark_api/request.rb

@@ -92,7 +92,12 @@ def request(method, path, body, options)
         SparkApi.logger.error { "Authentication failed or server is sending us expired tokens, nothing we can do here." }
         raise
       end
-      response.body
+
+      if options[:full_response]
+        return response
+      else
+        return response.body
+      end
     rescue Faraday::Error::ConnectionFailed => e
       if self.ssl_verify && e.message =~ /certificate verify failed/
         SparkApi.logger.error { SparkApi::Errors.ssl_verification_error }

lib/spark_api/response.rb

@@ -1,7 +1,7 @@
 module SparkApi
   # API Response interface
   module Response
-    ATTRIBUTES = [:code, :message, :results, :success, :pagination, :details, :d]
+    ATTRIBUTES = [:code, :message, :results, :success, :pagination, :details, :d, :errors, :sparkql_errors]
     attr_accessor *ATTRIBUTES
     def success?
       @success
@@ -23,6 +23,8 @@ def initialize(d)
         self.success    = self.d["Success"]
         self.pagination = self.d["Pagination"]
         self.details    = self.d["Details"] || []
+        self.errors     = self.d["Errors"]
+        self.sparkql_errors = self.d['SparkQLErrors']
         super(results)
       rescue Exception => e
         SparkApi.logger.error "Unable to understand the response! #{d}"

spec/unit/spark_api/request_spec.rb

@@ -57,6 +57,20 @@
       r.success?.should be(false)
       r.message.should be == "I am a failure."
     end
+    it "should have SparkQLErrors when present" do
+      err = {"Token" => "ExpirationDate", "Status" => "Dropped"}
+      r = SparkApi::ApiResponse.new({"D"=>{"Success" => false, "Message" => "I am a failure from .",
+        "SparkQLErrors" => [err]
+      }})
+      r.sparkql_errors.first.should eq(err)
+    end
+    it "should have Errors when present" do
+      err = {"Type" => "InvalidAttribute", "Attribute" => "DisplayName", "Message" => "DisplayName is wrong."}
+      r = SparkApi::ApiResponse.new({"D"=>{"Success" => false, "Message" => "I am a failure from .",
+        "Errors" => [err]
+      }})
+      r.errors.first.should eq(err)
+    end
   end
 
   describe SparkApi::Request do
@@ -197,6 +211,13 @@ def version()
         subject.post('/stringdata', 'I am a lonely String!').success?.should == true
       end
 
+      it "should allow response object to be returned instead of body" do
+        r = subject.get('/system', { full_response: true })
+
+        r.is_a?(Faraday::Response).should be(true)
+        r.status.should eq(200)
+      end
+
       it "should give me BigDecimal results for large floating point numbers" do
         MultiJson.default_adapter.should eq(:yajl) unless jruby?
         result = subject.get('/listings/1000')[0]