files.com 1.0.487 → 1.0.488

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b26950c315d418ad5a98128863c5e09a92513a6b61c69c0f124355c50979fa
-  data.tar.gz: 35d0001958e3d7cd9c683ab85c13c7068284a281701f9848b3ab3a10f03c21ce
+  metadata.gz: 1be0c3961f1c2d64351b352e054d27ca5e0224457c7328d3082bca7c233707d7
+  data.tar.gz: ddda72daeb4660814c6b663b0f716425fd3168173b92178e60cad9aef78ffbd7
 SHA512:
-  metadata.gz: 17f5f0610765f124fa5b9612169094e5523da4b5acadb80a4274bacf5ef4c65a35506dac1474a71c21366581453c1e56d8ac7ab5fb576ef20fd2ac20a3f7bdf9
-  data.tar.gz: 70990797609a9c7017fa96d260d358418bf30d0a11a4b503a26534df0cb66c64d11f801f0e7796c1dd8e7916a2b2e83e339bf2adce44d1c492704a9ccf392dc3
+  metadata.gz: 4f8542508603e1b873829c75d3fbefca19d4d226d0fdcba9aac3d73e3348e8bbd8f1e91edd17d6c4421be6715b798a95f30154a63d19bbc91849faa1dc9dafc2
+  data.tar.gz: 150a8b8acfeaf6233b253abf97026da469a2a9f5ce245608c48daa2dfae582bd60844fd3ed3d4d09515f240af742e869d313c48b7c68ceb100bd1e3fd767e59d

data/_VERSION

@@ -1 +1 @@
-1.0.487
+1.0.488

data/lib/files.com/api_client.rb

@@ -236,12 +236,11 @@ module Files
 
         case e
         when Faraday::ClientError, Faraday::ServerError
-          if e.response
+          if e.response and has_error_type?(e)
             handle_error_response(e.response, error_context)
           else
             handle_network_error(e, error_context, num_retries, base_url)
           end
-
         else
           raise
         end
@@ -302,13 +301,15 @@ module Files
       end
     end
 
-    private def handle_network_error(error, context, num_retries, base_url = nil)
+    private def handle_network_error(error, _context, num_retries, base_url = nil)
       base_url ||= Files.base_url
 
-      Util.log_error("Network error", error_message: error.message, request_id: context.request_id)
+      error_message = error.message.empty? ? error.response[:body] : error.message
+
+      Util.log_error("Network error", error_message: error_message)
       message = "Could not connect to Files.com at URL #{base_url}. Please check your internet connection and try again. If this problem persists, you should check Files.com's service status at https://status.files.com, or contact your primary account representative."
       message += " Request was retried #{num_retries} times." if num_retries > 0
-      message += "\n\n(Network error: #{error.message})"
+      message += "\n\n(Network error: #{error_message})"
 
       raise APIConnectionError, message
     end
@@ -337,6 +338,12 @@ module Files
       headers
     end
 
+    private def has_error_type?(e)
+      Response.from_faraday_hash(e.response).data&.dig(:type) ? true : false
+    rescue JSON::ParserError, Error
+      false
+    end
+
     private def log_request(context, num_retries, no_body: false)
       Util.log_info("Request", method: context.method, num_retries: num_retries, path: context.path)
       Util.log_debug("Request details", body: context.body, query_params: context.query_params) unless no_body

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.0.487"
+  VERSION = "1.0.488"
 end

data/spec/lib/api_client_spec.rb

@@ -11,20 +11,20 @@ RSpec.describe Files::ApiClient do
         allow(subject).to receive(:log_request).and_raise(Faraday::ServerError.new('', mock_response))
       end
 
-      it 'retries with sleeps and raises general api error' do
+      it 'retries with sleeps and raises general api connection error' do
         expect(subject).to receive(:sleep).with(0.5).ordered
         expect(subject).to receive(:sleep).with(be_between(0.5, 1)).ordered
         expect(subject).to receive(:sleep).with(be_between(1, 2)).ordered
         expect {
           subject.execute_request_with_rescues(1, context) { 'empty block' }
-        }.to raise_error(Files::APIError, error_message)
+        }.to raise_error(Files::APIConnectionError, error_message)
       end
     end
 
     context 'when response is a valid json' do
       it_behaves_like 'a server error handler' do
-        let(:error_message) { "Server Error" }
-        let(:mock_response) { { status: 502, headers: {}, body: { error: error_message }.to_json } }
+        let(:error_message) { "Could not connect to Files.com at URL 1. Please check your internet connection and try again. If this problem persists, you should check Files.com's service status at https://status.files.com, or contact your primary account representative. Request was retried 3 times.\n\n(Network error: {\"error\":\"Server Error\"})" }
+        let(:mock_response) { { status: 502, headers: {}, body: { error: "Server Error" }.to_json } }
       end
     end
 
@@ -37,8 +37,50 @@ RSpec.describe Files::ApiClient do
             body: "<html><head><title>502 Bad Gateway</title></head><body><center><h1>502 Bad Gateway</h1></center><hr><center>files.com</center></body></html>"
           }
         }
-        let(:error_message) { "Unexpected response object from API: \"#{mock_response[:body]}\" (HTTP response code was 502)" }
+        let(:error_message) { "Could not connect to Files.com at URL 1. Please check your internet connection and try again. If this problem persists, you should check Files.com's service status at https://status.files.com, or contact your primary account representative. Request was retried 3 times.\n\n(Network error: <html><head><title>502 Bad Gateway</title></head><body><center><h1>502 Bad Gateway</h1></center><hr><center>files.com</center></body></html>)" }
       end
     end
   end
+
+  describe "#specific_api_error" do
+    let(:context) { double('context', method: 'some method', path: 'some path') }
+    let(:bad_request_with_data) {
+      {
+        error: "The request parameter path cannot have trailing whitespace: .   /+testing previews.",
+        'http-code': 400,
+        instance: "23825f04-7add-4911-b9d7-f4342a75a471",
+        title: "Request Param Path Cannot Have Trailing Whitespace",
+        type: "bad-request/request-param-path-cannot-have-trailing-whitespace"
+      }
+    }
+    let(:bad_request_without_data) {
+      {
+        error: 'Bad Request'
+      }
+    }
+    let(:mock_good_response) { { status: 400, headers: {}, body: bad_request_with_data.to_json } }
+    let(:mock_response_without_type) { { status: 400, headers: {}, body: bad_request_without_data.to_json } }
+    let(:mock_empty_response) { { status: 400, headers: {}, body: '' } }
+
+    it "handles correctly when bad request with data and proper error type" do
+      allow(subject).to receive(:log_request).and_raise(Faraday::BadRequestError.new('', mock_good_response))
+      expect {
+        subject.execute_request_with_rescues(1, context) { 'empty block' }
+      }.to raise_error(Files::RequestParamPathCannotHaveTrailingWhitespaceError, bad_request_with_data[:error])
+    end
+
+    it "throws generic bad request error when no type" do
+      allow(subject).to receive(:log_request).and_raise(Faraday::BadRequestError.new('', mock_response_without_type))
+      expect {
+        subject.execute_request_with_rescues(1, context) { 'empty block' }
+      }.to raise_error(Files::APIConnectionError)
+    end
+
+    it "throws generic bad request error when no body at all" do
+      allow(subject).to receive(:log_request).and_raise(Faraday::BadRequestError.new('', mock_empty_response))
+      expect {
+        subject.execute_request_with_rescues(1, context) { 'empty block' }
+      }.to raise_error(Files::APIConnectionError)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.487
+  version: 1.0.488
 platform: ruby
 authors:
 - files.com