contextio 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5e2dbe2586d58809974fbc1700cc773d43d6e78
-  data.tar.gz: 216fa008cae2c54e0c195020f9405684ebabc777
+  metadata.gz: ee262c3eb5ba95fb430a2a2e0fc0e7398ea8d844
+  data.tar.gz: c9b4024b14a87f608fb61412b6a5d7dbd8e15ddf
 SHA512:
-  metadata.gz: b4a5f33b09fd9d40bd3702df6333a422d84b259558a574265c73212950ba9eaf53f9bcbf63b432613c04c136dbdab394c219ea97766a58eed66363347c68981b
-  data.tar.gz: 03b711445a19b70b57f57502c549e8d33acb55fd42337f29353dcd31fbdbcbfde074b848ceaf40d58e9d051d5aef18dece9bfeb83f94046f0352bbb5ed22d0b0
+  metadata.gz: df4b5035d406a74a45a2e4dd6a4485df9c8a5cb005c068529f148d554b08fd862dfc4e76d0897e0ca6f8c623479515a380cfae7fbd7414c6ffab60fdf35b3d34
+  data.tar.gz: ffd3c8568ca1d75d25492c2cd9435956add7538514c53c2f10d1a9abfe6332ee24a658b17a47703d07747d564390d1379275c9fc7dbdde2a7efd250d1372b1b5

data/CHANGES.md

@@ -1,5 +1,9 @@
 # Changes
 
+## 1.7.2
+
+* Improve error handling for better trouble shooting. - Ben Hamill
+
 ## 1.7.1
 
 * Fix bug in `ContextIO::Message#set_flags` that was failing, and also fixes the

data/lib/contextio/api.rb

@@ -95,30 +95,18 @@ class ContextIO
     # @raise [API::Error] if the response code isn't in the 200 or 300 range.
     def request(method, resource_path, params = {})
       response = oauth_request(method, resource_path, params, { 'Accept' => 'application/json' })
-      body = response.body
-      results = JSON.parse(body.to_s) unless response.body.to_s.empty?
 
-      unless response.success?
-        if results.is_a?(Hash) && results['type'] == 'error'
-          message = results['value']
-        else
-          message = "HTTP #{response.status} Error"
-        end
-
-        raise API::Error, message
+      with_error_handling(response) do |response|
+        parse_json(response.body)
       end
-
-      results
     end
 
     def raw_request(method, resource_path, params={})
       response = oauth_request(method, resource_path, params)
 
-      unless response.success?
-        raise API::Error, "HTTP #{response.status} Error"
+      with_error_handling(response) do |response|
+        response.body
       end
-
-      response.body
     end
 
     private
@@ -186,5 +174,52 @@ class ContextIO
         faraday.adapter Faraday.default_adapter
       end
     end
+
+    # Errors can come in a few shapes and we want to detect them and extract the
+    # useful information. If no errors are found, it calls the provided block
+    # and passes the response through.
+    #
+    # @param [Faraday::Response] response A response object from making a request to the
+    #   API with Faraday.
+    #
+    # @raise [API::Error] if the response code isn't in the 200 or 300 range.
+    def with_error_handling(response, &block)
+      return block.call(response) if response.success?
+
+      parsed_body = parse_json(response.body)
+      message = determine_best_error_message(parsed_body) || "HTTP #{response.status} Error"
+
+      raise API::Error, message
+    end
+
+    # Parses JSON if there's valid JSON passed in.
+    #
+    # @param [String] document A string you suspect may be a JSON document.
+    #
+    # @return [Hash, Array, Nil] Either a parsed version of the JSON document or
+    #   nil, if the document wasn't valid JSON.
+    def parse_json(document)
+      return JSON.parse(document.to_s)
+    rescue JSON::ParserError => e
+      return nil
+    end
+
+    # Given a parsed JSON body from an error response, figures out if it can
+    # pull useful information therefrom.
+    #
+    # @param [Hash] parsed_body A Hash parsed from a JSON document that may
+    #   describe an error condition.
+    #
+    # @return [String, Nil] If it can, it will return a human-readable
+    #   error-describing String. Otherwise, nil.
+    def determine_best_error_message(parsed_body)
+      return unless parsed_body.respond_to?(:[])
+
+      if parsed_body['type'] == 'error'
+        return parsed_body['value']
+      elsif parsed_body.has_key?('success') && !parsed_body['success']
+        return [parsed_body['feedback_code'], parsed_body['connectionLog']].compact.join("\n")
+      end
+    end
   end
 end

data/lib/contextio/version.rb

@@ -1,6 +1,6 @@
 class ContextIO
   # @private
-  VERSION = "1.7.1"
+  VERSION = "1.7.2"
 
   # The gem version.
   #

data/spec/unit/contextio/api_spec.rb

@@ -152,6 +152,22 @@ describe ContextIO::API do
       end
     end
 
+    context "with a bad response that has a different body" do
+      before do
+        WebMock.stub_request(
+          :get,
+          'https://api.context.io/2.0/test'
+        ).to_return(
+          status: 400,
+          body: JSON.dump('success' => false, 'feedback_code' => 'nope')
+        )
+      end
+
+      it "raises an API error with the body message" do
+        expect { subject }.to raise_error(ContextIO::API::Error, 'nope')
+      end
+    end
+
     context "with a bad response that has no body" do
       before do
         WebMock.stub_request(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contextio
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Ben Hamill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2014-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday