Skip to content

Commit

Permalink
Include reason & message in API error when available
Browse files Browse the repository at this point in the history
  • Loading branch information
sqrrrl committed Jan 7, 2016
1 parent 2336c1a commit 451a0b6
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 2 deletions.
4 changes: 2 additions & 2 deletions lib/google/apis/core/api_command.rb
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,11 @@ def check_status(status, header = nil, body = nil, message = nil)
when 400, 402...500
error = parse_error(body)
if error
message = error['reason'] if error.has_key?('reason')
message = sprintf('%s: %s', error['reason'], error['message'])
raise Google::Apis::RateLimitError.new(message,
status_code: status,
header: header,
body: body) if RATE_LIMIT_ERRORS.include?(message)
body: body) if RATE_LIMIT_ERRORS.include?(error['reason'])
end
super(status, header, body, message)
else
Expand Down
39 changes: 39 additions & 0 deletions spec/google/apis/core/api_command_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,41 @@
end
end

context('with a client error response') do
let(:command) do
Google::Apis::Core::ApiCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
end

before(:example) do
json = <<EOF
{
"error": {
"errors": [
{
"domain": "global",
"reason": "timeRangeEmpty",
"message": "The specified time range is empty."
}
],
"code": 400,
"message": "The specified time range is empty."
}
}
EOF
stub_request(:get, 'https://www.googleapis.com/zoo/animals')
.to_return(status: [400, 'Bad Request'], headers: { 'Content-Type' => 'application/json' }, body: json)
end

it 'should raise client error' do
expect { command.execute(client) }.to raise_error(Google::Apis::ClientError)
end

it 'should raise an error with the reason and message' do
expect { command.execute(client) }.to raise_error(
/timeRangeEmpty: The specified time range is empty/)
end
end

context('with an empty error body') do
let(:command) do
Google::Apis::Core::ApiCommand.new(:get, 'https://www.googleapis.com/zoo/animals')
Expand All @@ -166,5 +201,9 @@
it 'should raise client error' do
expect { command.execute(client) }.to raise_error(Google::Apis::ClientError)
end

it 'should use the default error message' do
expect { command.execute(client) }.to raise_error(/Invalid request/)
end
end
end
14 changes: 14 additions & 0 deletions spec/integration_tests/url_shortener_spec.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

require 'spec_helper'
require 'google/apis/urlshortener_v1'
require 'googleauth'
Expand Down

0 comments on commit 451a0b6

Please sign in to comment.