Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,19 @@ client.create_private_message( #=> Creates a private messages b

```

You can handle some basic errors by rescuing from certain error classes and inspecting the response object passed to those errors:

```ruby
begin
client.create_group({ name: 'NO' })
rescue DiscourseApi::UnprocessableEntity => error
# `body` is something like `{ errors: ["Name must be at least 3 characters"] }`
# This outputs "Name must be at least 3 characters"
puts error.response.body['errors'].first
end
```

Check out [lib/discourse_api/error.rb](lib/discourse_api/error.rb) and [lib/discourse_api/client.rb](lib/discourse_api/client.rb)'s `handle_error` method for the types of errors raised by the API.

## Contributing

Expand Down
8 changes: 4 additions & 4 deletions lib/discourse_api/client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -138,13 +138,13 @@ def request(method, path, params={})
def handle_error(response)
case response.status
when 403
raise DiscourseApi::UnauthenticatedError.new(response.env[:body])
raise DiscourseApi::UnauthenticatedError.new(response.env[:body], response.env)
when 404, 410
raise DiscourseApi::NotFoundError.new(response.env[:body])
raise DiscourseApi::NotFoundError.new(response.env[:body], response.env)
when 422
raise DiscourseApi::UnprocessableEntity.new(response.env[:body])
raise DiscourseApi::UnprocessableEntity.new(response.env[:body], response.env)
when 429
raise DiscourseApi::TooManyRequests.new(response.env[:body])
raise DiscourseApi::TooManyRequests.new(response.env[:body], response.env)
when 500...600
raise DiscourseApi::Error.new(response.env[:body])
end
Expand Down
6 changes: 6 additions & 0 deletions lib/discourse_api/error.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
module DiscourseApi
class DiscourseError < StandardError
attr_reader :response

def initialize(message, response = nil)
super(message)
@response = response
end
end

class Error < DiscourseError
Expand Down