sfrest 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 08936ab1f2d5f8780cba9b3c74884806896886bd6c26210e3d3f69de44f6f510
-  data.tar.gz: 299199ecf27db665e2dacd3300a0a033251baf26a0964852592fb22a24d5dbf9
+  metadata.gz: 728d8a47e5b6c93f0dd88576f75b24d2e8cdd7a6a5aed22d89517d6835d5501d
+  data.tar.gz: c738283f50fe09d31b714791b44a3ec9130578e61f93b21687382a988254c6a6
 SHA512:
-  metadata.gz: f76a2ec444911abdaa7c0eaac3d3c2797822f6e79c9b75096d7d7565ddd27151e3be0907779b78f1fc27fe3f0428dd48342f77aa690fbd2deb79cf064003494c
-  data.tar.gz: 5283104b05712b69a454d5a5b5c8e181b90f4168c53c8ce35a436283d61d9fd2b1e2dd35c9ad1e00f1493b90be5f414f57294d5d49573d08c7a89314e4348f3b
+  metadata.gz: a6663190218e40d64e6f0e6c327fe459a148d9eb8439e4d11590b44afa817d37f5ef1c91f7badfd346ac7451394bf3ea74caa3fe9fa7ab6dd4055c5b21b9ea7a
+  data.tar.gz: b1966f5b32571d9838106c4023dffaaec226683dccbba70375f8d921fe223643185bd028670ed616d2048fa23b4ecca5cf3605c5997eb1f88f30118a30d7e7dd

data/lib/sfrest/connection.rb

@@ -16,8 +16,8 @@ module SFRest
     # http request via get
     # @param [string] uri
     # @return [Object] ruby representation of the json response
-    #                  if the reponsebody  does not parse, returns
-    #                  the non-parsed body
+    #                  if the reponse body  does not parse, raises
+    #                  a SFRest::InvalidResponse
     def get(uri)
       headers = { 'Content-Type' => 'application/json' }
       res = Excon.get(@base_url + uri.to_s,
@@ -25,18 +25,14 @@ module SFRest
                       user: username,
                       password: password,
                       ssl_verify_peer: false)
-      begin
-        access_check JSON(res.body), res.status
-      rescue JSON::ParserError
-        res.body
-      end
+      api_response res
     end
 
     # http request via get
     # @param [string] uri
     # @return [Integer, Object] http status and the ruby representation
-    #                           of the json response if the reponse body
-    #                           does not parse, returns the non-parsed body
+    #                  if the reponse body  does not parse, raises
+    #                  a SFRest::InvalidResponse
     def get_with_status(uri)
       headers = { 'Content-Type' => 'application/json' }
       res = Excon.get(@base_url + uri.to_s,
@@ -44,19 +40,14 @@ module SFRest
                       user: username,
                       password: password,
                       ssl_verify_peer: false)
-      begin
-        data = access_check JSON(res.body), res.status
-        return res.status, data
-      rescue JSON::ParserError
-        return res.status, res.body
-      end
+      api_response res, true
     end
 
     # http request via post
     # @param [string] uri
     # @return [Object] ruby representation of the json response
-    #                  if the reponsebody  does not parse, returns
-    #                  the non-parsed body
+    #                  if the reponse body  does not parse, raises
+    #                  a SFRest::InvalidResponse
     def post(uri, payload)
       headers = { 'Content-Type' => 'application/json' }
       res = Excon.post(@base_url + uri.to_s,
@@ -65,18 +56,14 @@ module SFRest
                        password: password,
                        ssl_verify_peer: false,
                        body: payload)
-      begin
-        access_check JSON(res.body), res.status
-      rescue JSON::ParserError
-        res.body
-      end
+      api_response res
     end
 
     # http request via put
     # @param [string] uri
     # @return [Object] ruby representation of the json response
-    #                  if the reponsebody  does not parse, returns
-    #                  the non-parsed body
+    #                  if the reponse body  does not parse, raises
+    #                  a SFRest::InvalidResponse
     def put(uri, payload)
       headers = { 'Content-Type' => 'application/json' }
       res = Excon.put(@base_url + uri.to_s,
@@ -85,18 +72,14 @@ module SFRest
                       password: password,
                       ssl_verify_peer: false,
                       body: payload)
-      begin
-        access_check JSON(res.body), res.status
-      rescue JSON::ParserError
-        res.body
-      end
+      api_response res
     end
 
     # http request via delete
     # @param [string] uri
     # @return [Object] ruby representation of the json response
-    #                  if the reponsebody  does not parse, returns
-    #                  the non-parsed body
+    #                  if the reponse body  does not parse, raises
+    #                  a SFRest::InvalidResponse
     def delete(uri)
       headers = { 'Content-Type' => 'application/json' }
       res = Excon.delete(@base_url + uri.to_s,
@@ -104,11 +87,22 @@ module SFRest
                          user: username,
                          password: password,
                          ssl_verify_peer: false)
-      begin
-        access_check JSON(res.body), res.status
-      rescue JSON::ParserError
-        res.body
-      end
+      api_response res
+    end
+
+    # Confirm that the result looks adequate
+    # @param [Excon::Response] res
+    # @param [Boolean] return_status If true returns the integer status
+    #                  with the reponse
+    # @return [Array|Object] if return_status then [int, Object]
+    #                        else Object
+    def api_response(res, return_status = false)
+      data = access_check JSON(res.body), res.status
+      ret_data = return_status ? [res.status, data] : data
+      return ret_data
+    rescue JSON::ParserError
+      message = "Invalid data, status #{res.status}, body: #{res.body}"
+      raise SFRest::InvalidResponse, message
     end
 
     # Throws an SFRest exception for requests that have problems
@@ -123,7 +117,9 @@ module SFRest
     #
     # The cyclomatic complexity check is being ignored here because we are
     # collecting all the possible exception raising cases.
-    def access_check(data, http_status) # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop: disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def access_check(data, http_status)
+      raise SFRest::EmptyResult if data.size.zero?
       if data.is_a?(Hash) && !data['message'].nil?
         case data['message']
         when /Access denied|Access Denied/
@@ -142,6 +138,7 @@ module SFRest
       end
       data
     end
+    # rubocop: enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
     # pings the SF api as an authenticated user
     # responds with a pong

data/lib/sfrest/error.rb

@@ -22,4 +22,10 @@ module SFRest
 
   # if you get in valid data
   class InvalidDataError < SFRest::SFError; end
+
+  # If the return seems to contain no data
+  class EmptyResult < SFRest::SFError; end
+
+  # If the return cannot be parsed into something useful
+  class InvalidResponse < SFRest::SFError; end
 end

data/lib/sfrest/version.rb

@@ -1,4 +1,4 @@
 module SFRest
   # Just tracks the version of sfrest.
-  VERSION = '0.0.14'.freeze
+  VERSION = '0.0.15'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfrest
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-13 00:00:00.000000000 Z
+date: 2018-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon