Add custom errors
This commit is contained in:
parent
3841c4f76c
commit
438fc7294d
4 changed files with 123 additions and 52 deletions
|
|
@ -1,68 +1,73 @@
|
||||||
class Api::V1::ApiController < ActionController::API
|
module Api::V1
|
||||||
##### Doorkeeper
|
class ApiController < ActionController::API
|
||||||
include Doorkeeper::Rails::Helpers
|
##### Doorkeeper
|
||||||
|
include Doorkeeper::Rails::Helpers
|
||||||
|
|
||||||
##### Errors
|
##### Errors
|
||||||
rescue_from ActiveRecord::RecordInvalid, with: :render_unprocessable_entity_response
|
rescue_from ActiveRecord::RecordInvalid, with: :render_unprocessable_entity_response
|
||||||
rescue_from ActiveRecord::RecordNotDestroyed, with: :render_unprocessable_entity_response
|
rescue_from ActiveRecord::RecordNotDestroyed, with: :render_unprocessable_entity_response
|
||||||
rescue_from ActiveRecord::RecordNotFound, with: :render_not_found_response
|
rescue_from ActiveRecord::RecordNotFound, with: :render_not_found_response
|
||||||
rescue_from ActiveRecord::RecordNotSaved, with: :render_unprocessable_entity_response
|
rescue_from ActiveRecord::RecordNotSaved, with: :render_unprocessable_entity_response
|
||||||
rescue_from ActiveRecord::RecordNotUnique, with: :render_unprocessable_entity_response
|
rescue_from ActiveRecord::RecordNotUnique, with: :render_unprocessable_entity_response
|
||||||
rescue_from ActionController::ParameterMissing, with: :render_unprocessable_entity_response
|
rescue_from Api::V1::SameFavoriteUserError, with: :render_unprocessable_entity_response
|
||||||
|
rescue_from Api::V1::FavoriteAlreadyExistsError, with: :render_unprocessable_entity_response
|
||||||
|
rescue_from Api::V1::UnauthorizedError, with: :render_unauthorized_response
|
||||||
|
rescue_from ActionController::ParameterMissing, with: :render_unprocessable_entity_response
|
||||||
|
|
||||||
##### Hooks
|
##### Hooks
|
||||||
before_action :current_user
|
before_action :current_user
|
||||||
before_action :set_default_content_type
|
before_action :set_default_content_type
|
||||||
|
|
||||||
##### Responders
|
##### Responders
|
||||||
respond_to :json
|
respond_to :json
|
||||||
|
|
||||||
##### Methods
|
##### Methods
|
||||||
# Assign the current user if the Doorkeeper token isn't nil, then
|
# Assign the current user if the Doorkeeper token isn't nil, then
|
||||||
# update the current user's last seen datetime and last IP address
|
# update the current user's last seen datetime and last IP address
|
||||||
# before returning
|
# before returning
|
||||||
def current_user
|
def current_user
|
||||||
@current_user ||= User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
|
@current_user ||= User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
|
||||||
@current_user.update_last_ip_and_last_seen!(request.remote_ip) if @current_user
|
@current_user.update_last_ip_and_last_seen!(request.remote_ip) if @current_user
|
||||||
|
|
||||||
return @current_user
|
return @current_user
|
||||||
end
|
end
|
||||||
|
|
||||||
# Set the response content-type
|
# Set the response content-type
|
||||||
def set_content_type(content_type)
|
def set_content_type(content_type)
|
||||||
response.headers["Content-Type"] = content_type
|
response.headers["Content-Type"] = content_type
|
||||||
end
|
end
|
||||||
|
|
||||||
# Set the default response content-type to application/javascript
|
# Set the default response content-type to application/javascript
|
||||||
# with a UTF-8 charset
|
# with a UTF-8 charset
|
||||||
def set_default_content_type
|
def set_default_content_type
|
||||||
set_content_type("application/javascript; charset=utf-8")
|
set_content_type("application/javascript; charset=utf-8")
|
||||||
end
|
end
|
||||||
|
|
||||||
def current_user
|
def current_user
|
||||||
@current_user ||= User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
|
@current_user ||= User.find(doorkeeper_token.resource_owner_id) if doorkeeper_token
|
||||||
|
|
||||||
return @current_user
|
return @current_user
|
||||||
end
|
end
|
||||||
|
|
||||||
### Error response methods
|
### Error response methods
|
||||||
def render_unprocessable_entity_response(exception)
|
def render_unprocessable_entity_response(exception)
|
||||||
@exception = exception
|
@exception = exception
|
||||||
render action: 'errors', status: :unprocessable_entity
|
render action: 'errors', status: :unprocessable_entity
|
||||||
end
|
end
|
||||||
|
|
||||||
def render_not_found_response
|
def render_not_found_response
|
||||||
response = { errors: [{ message: "Record could not be found.", code: "not_found" }]}
|
response = { errors: [{ message: "Record could not be found.", code: "not_found" }]}
|
||||||
render 'not_found', status: :not_found
|
render 'not_found', status: :not_found
|
||||||
end
|
end
|
||||||
|
|
||||||
def render_unauthorized_response
|
def render_unauthorized_response
|
||||||
render action: 'errors', status: :unauthorized
|
render action: 'errors', status: :unauthorized
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
def restrict_access
|
def restrict_access
|
||||||
raise UnauthorizedError unless current_user
|
raise UnauthorizedError unless current_user
|
||||||
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
22
app/errors/api/v1/FavoriteAlreadyExistsError.rb
Normal file
22
app/errors/api/v1/FavoriteAlreadyExistsError.rb
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
module Api::V1
|
||||||
|
class FavoriteAlreadyExistsError < StandardError
|
||||||
|
def http_status
|
||||||
|
422
|
||||||
|
end
|
||||||
|
|
||||||
|
def code
|
||||||
|
"favorite_already_exists"
|
||||||
|
end
|
||||||
|
|
||||||
|
def message
|
||||||
|
"This user has favorited this party already"
|
||||||
|
end
|
||||||
|
|
||||||
|
def to_hash
|
||||||
|
{
|
||||||
|
message: message,
|
||||||
|
code: code
|
||||||
|
}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
22
app/errors/api/v1/SameFavoriteUserError.rb
Normal file
22
app/errors/api/v1/SameFavoriteUserError.rb
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
module Api::V1
|
||||||
|
class SameFavoriteUserError < StandardError
|
||||||
|
def http_status
|
||||||
|
422
|
||||||
|
end
|
||||||
|
|
||||||
|
def code
|
||||||
|
"same_favorite_user"
|
||||||
|
end
|
||||||
|
|
||||||
|
def message
|
||||||
|
"Users cannot favorite their own parties"
|
||||||
|
end
|
||||||
|
|
||||||
|
def to_hash
|
||||||
|
{
|
||||||
|
message: message,
|
||||||
|
code: code
|
||||||
|
}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
22
app/errors/api/v1/UnauthorizedError.rb
Normal file
22
app/errors/api/v1/UnauthorizedError.rb
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
module Api::V1
|
||||||
|
class UnauthorizedError < StandardError
|
||||||
|
def http_status
|
||||||
|
401
|
||||||
|
end
|
||||||
|
|
||||||
|
def code
|
||||||
|
"unauthorized"
|
||||||
|
end
|
||||||
|
|
||||||
|
def message
|
||||||
|
"User is not allowed to modify that resource"
|
||||||
|
end
|
||||||
|
|
||||||
|
def to_hash
|
||||||
|
{
|
||||||
|
message: message,
|
||||||
|
code: code
|
||||||
|
}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
Loading…
Reference in a new issue