Fix string validation errors (#1740)

* Fix string validation errors

Just came across this in the wild

openSUSE/open-build-service#17535

Apparently sometimes the validation json is formated like that.

* Add additional test cases

* Fix lint: add empty line after guard clause

* Use regex for nested structure test assertion

---------

Co-authored-by: Keegan Campbell <[email protected]>

Author: hennevogel

lib/octokit/error.rb

@@ -191,6 +191,8 @@ def response_error_summary
       return nil unless data.is_a?(Hash) && !Array(data[:errors]).empty?
 
       summary = +"\nError summary:\n"
+      return summary << data[:errors] if data[:errors].is_a?(String)
+
       summary << data[:errors].map do |error|
         if error.is_a? Hash
           error.map { |k, v| "  #{k}: #{v}" }

spec/octokit/client_spec.rb

@@ -839,6 +839,147 @@
       end
     end
 
+    it 'exposes errors string' do
+      stub_get('/boom')
+        .to_return \
+          status: 422,
+          headers: {
+            content_type: 'application/json'
+          },
+          body: {
+            message: 'Validation Failed',
+            errors: 'Issue'
+          }.to_json
+      begin
+        Octokit.get('/boom')
+      rescue Octokit::UnprocessableEntity => e
+        expect(e.message).to include('GET https://api.github.com/boom: 422 - Validation Failed')
+        expect(e.message).to include('Issue')
+      end
+    end
+
+    it 'handles errors as a hash' do
+      stub_get('/boom')
+        .to_return \
+          status: 422,
+          headers: { content_type: 'application/json' },
+          body: {
+            message: 'Validation Failed',
+            errors: { field: 'some field', issue: 'some issue' }
+          }.to_json
+      begin
+        Octokit.get('/boom')
+      rescue Octokit::UnprocessableEntity => e
+        expect(e.message).to include('GET https://api.github.com/boom: 422 - Validation Failed')
+        expect(e.message).to include('Error summary:')
+        expect(e.message).to include('[:field, "some field"]')
+        expect(e.message).to include('[:issue, "some issue"]')
+      end
+    end
+
+    it 'handles nil errors gracefully' do
+      stub_get('/boom')
+        .to_return \
+          status: 422,
+          headers: { content_type: 'application/json' },
+          body: {
+            message: 'Validation Failed',
+            errors: nil
+          }.to_json
+      begin
+        Octokit.get('/boom')
+      rescue Octokit::UnprocessableEntity => e
+        expect(e.message).to include('GET https://api.github.com/boom: 422 - Validation Failed')
+        expect(e.message).not_to include('Error summary:')
+      end
+    end
+
+    it 'handles errors array of strings' do
+      stub_get('/boom')
+        .to_return \
+          status: 422,
+          headers: { content_type: 'application/json' },
+          body: {
+            message: 'Validation Failed',
+            errors: ['Issue 1', 'Issue 2']
+          }.to_json
+      begin
+        Octokit.get('/boom')
+      rescue Octokit::UnprocessableEntity => e
+        expect(e.message).to include('GET https://api.github.com/boom: 422 - Validation Failed')
+        expect(e.message).to include('Error summary:')
+        expect(e.message).to include('Issue 1')
+        expect(e.message).to include('Issue 2')
+      end
+    end
+
+    it 'handles errors with special characters' do
+      stub_get('/boom')
+        .to_return \
+          status: 422,
+          headers: { content_type: 'application/json' },
+          body: {
+            message: 'Validation Failed',
+            errors: 'Error with <special> characters & symbols'
+          }.to_json
+      begin
+        Octokit.get('/boom')
+      rescue Octokit::UnprocessableEntity => e
+        expect(e.message).to include('GET https://api.github.com/boom: 422 - Validation Failed')
+        expect(e.message).to include('Error summary:')
+        expect(e.message).to include('Error with <special> characters & symbols')
+      end
+    end
+
+    it 'handles nested structures in errors' do
+      stub_get('/boom')
+        .to_return \
+          status: 422,
+          headers: { content_type: 'application/json' },
+          body: {
+            message: 'Validation Failed',
+            errors: [
+              { field: 'some field', issue: 'some issue' },
+              { details: { subfield: 'value' } }
+            ]
+          }.to_json
+      begin
+        Octokit.get('/boom')
+      rescue Octokit::UnprocessableEntity => e
+        expect(e.message).to include('GET https://api.github.com/boom: 422 - Validation Failed')
+        expect(e.message).to include('Error summary:')
+        expect(e.message).to include('field: some field')
+        expect(e.message).to include('issue: some issue')
+        # Ruby, depending on the version, may format the hash differently
+        # either with a ligature (=>) or a colon (:)
+        # '{:subfield => "value"}' or '{subfield: "value"}'
+        # so we use a regex to match either for the test assertion
+        expect(e.message).to match(
+          /details: \{(?::subfield\s*=>\s*"value"|subfield:\s*"value")\}/
+        )
+      end
+    end
+
+    it 'handles mixed-type errors array' do
+      stub_get('/boom')
+        .to_return \
+          status: 422,
+          headers: { content_type: 'application/json' },
+          body: {
+            message: 'Validation Failed',
+            errors: ['Issue', { field: 'some field', issue: 'some issue' }]
+          }.to_json
+      begin
+        Octokit.get('/boom')
+      rescue Octokit::UnprocessableEntity => e
+        expect(e.message).to include('GET https://api.github.com/boom: 422 - Validation Failed')
+        expect(e.message).to include('Error summary:')
+        expect(e.message).to include('Issue')
+        expect(e.message).to include('field: some field')
+        expect(e.message).to include('issue: some issue')
+      end
+    end
+
     it 'knows the difference between different kinds of forbidden' do
       stub_get('/some/admin/stuffs').to_return(status: 403)
       expect { Octokit.get('/some/admin/stuffs') }.to raise_error Octokit::Forbidden