+ if defined?(SystemTimer)
+ Timer = SystemTimer
+ else
+ require 'timeout'
+ Timer = Timeout
+ end
+
+ # The base class for API Errors.
+ class APIError < RuntimeError
+ def status
+ :internal_server_error
+ end
+
+ def to_s
+ "Generic API Error"
+ end
+ end
+
+ # Raised when access is denied.
+ class APIAccessDenied < RuntimeError
+ def status
+ :forbidden
+ end
+
+ def to_s
+ "Access denied"
+ end
+ end
+
+ # Raised when an API object is not found.
+ class APINotFoundError < APIError
+ def status
+ :not_found
+ end
+
+ def to_s
+ "Object not found"
+ end
+ end
+
+ # Raised when a precondition to an API action fails sanity check.
+ class APIPreconditionFailedError < APIError
+ def initialize(message = "")
+ @message = message
+ end
+
+ def status
+ :precondition_failed
+ end
+
+ def to_s
+ "Precondition failed: #{@message}"
+ end
+ end
+
+ # Raised when to delete an already-deleted object.
+ class APIAlreadyDeletedError < APIError
+ def initialize(object = "object", object_id = "")
+ @object, @object_id = object, object_id
+ end
+
+ attr_reader :object, :object_id
+
+ def status
+ :gone
+ end
+
+ def to_s
+ "The #{object} with the id #{object_id} has already been deleted"
+ end
+ end
+
+ # Raised when the user logged in isn't the same as the changeset
+ class APIUserChangesetMismatchError < APIError
+ def status
+ :conflict
+ end
+
+ def to_s
+ "The user doesn't own that changeset"
+ end
+ end
+
+ # Raised when the changeset provided is already closed
+ class APIChangesetAlreadyClosedError < APIError
+ def initialize(changeset)
+ @changeset = changeset
+ end
+
+ attr_reader :changeset
+
+ def status
+ :conflict
+ end
+
+ def to_s
+ "The changeset #{@changeset.id} was closed at #{@changeset.closed_at}"
+ end
+ end
+
+ # Raised when the changeset provided is not yet closed
+ class APIChangesetNotYetClosedError < APIError
+ def initialize(changeset)
+ @changeset = changeset
+ end
+
+ attr_reader :changeset
+
+ def status
+ :conflict
+ end
+
+ def to_s
+ "The changeset #{@changeset.id} is not yet closed."
+ end
+ end
+
+ # Raised when a user is already subscribed to the changeset
+ class APIChangesetAlreadySubscribedError < APIError
+ def initialize(changeset)
+ @changeset = changeset
+ end
+
+ attr_reader :changeset
+
+ def status
+ :conflict
+ end
+
+ def to_s
+ "You are already subscribed to changeset #{@changeset.id}."
+ end
+ end
+
+ # Raised when a user is not subscribed to the changeset
+ class APIChangesetNotSubscribedError < APIError
+ def initialize(changeset)
+ @changeset = changeset
+ end
+
+ attr_reader :changeset
+
+ def status
+ :not_found
+ end
+
+ def to_s
+ "You are not subscribed to changeset #{@changeset.id}."
+ end
+ end
+
+ # Raised when a change is expecting a changeset, but the changeset doesn't exist
+ class APIChangesetMissingError < APIError
+ def status
+ :conflict
+ end
+
+ def to_s
+ "You need to supply a changeset to be able to make a change"
+ end
+ end
+
+ # Raised when a diff is uploaded containing many changeset IDs which don't match
+ # the changeset ID that the diff was uploaded to.
+ class APIChangesetMismatchError < APIError
+ def initialize(provided, allowed)
+ @provided, @allowed = provided, allowed
+ end
+
+ def status
+ :conflict
+ end
+
+ def to_s
+ "Changeset mismatch: Provided #{@provided} but only #{@allowed} is allowed"
+ end
+ end
+
+ # Raised when a diff upload has an unknown action. You can only have create,
+ # modify, or delete
+ class APIChangesetActionInvalid < APIError
+ def initialize(provided)
+ @provided = provided
+ end
+
+ def status
+ :bad_request
+ end
+
+ def to_s
+ "Unknown action #{@provided}, choices are create, modify, delete"
+ end
+ end
+
+ # Raised when bad XML is encountered which stops things parsing as
+ # they should.
+ class APIBadXMLError < APIError
+ def initialize(model, xml, message="")
+ @model, @xml, @message = model, xml, message
+ end
+
+ def status
+ :bad_request
+ end
+
+ def to_s
+ "Cannot parse valid #{@model} from xml string #{@xml}. #{@message}"
+ end
+ end
+
+ # Raised when the provided version is not equal to the latest in the db.
+ class APIVersionMismatchError < APIError
+ def initialize(id, type, provided, latest)
+ @id, @type, @provided, @latest = id, type, provided, latest
+ end
+
+ attr_reader :provided, :latest, :id, :type
+
+ def status
+ :conflict
+ end
+
+ def to_s
+ "Version mismatch: Provided #{provided}, server had: #{latest} of #{type} #{id}"
+ end
+ end
+
+ # raised when a two tags have a duplicate key string in an element.
+ # this is now forbidden by the API.
+ class APIDuplicateTagsError < APIError
+ def initialize(type, id, tag_key)
+ @type, @id, @tag_key = type, id, tag_key
+ end
+
+ attr_reader :type, :id, :tag_key
+
+ def status
+ :bad_request
+ end
+
+ def to_s
+ "Element #{@type}/#{@id} has duplicate tags with key #{@tag_key}"
+ end
+ end
+
+ # Raised when a way has more than the configured number of way nodes.
+ # This prevents ways from being to long and difficult to work with
+ class APITooManyWayNodesError < APIError
+ def initialize(id, provided, max)
+ @id, @provided, @max = id, provided, max
+ end
+
+ attr_reader :id, :provided, :max
+
+ def status
+ :bad_request
+ end
+
+ def to_s
+ "You tried to add #{provided} nodes to way #{id}, however only #{max} are allowed"
+ end
+ end
+
+ ##
+ # raised when user input couldn't be parsed
+ class APIBadUserInput < APIError
+ def initialize(message)
+ @message = message
+ end
+
+ def status
+ :bad_request
+ end
+
+ def to_s
+ @message
+ end
+ end
+
+ ##
+ # raised when bounding box is invalid
+ class APIBadBoundingBox < APIError
+ def initialize(message)
+ @message = message
+ end
+
+ def status
+ :bad_request
+ end
+
+ def to_s
+ @message
+ end
+ end
+
+ ##
+ # raised when an API call is made using a method not supported on that URI
+ class APIBadMethodError < APIError
+ def initialize(supported_method)
+ @supported_method = supported_method
+ end
+
+ def status
+ :method_not_allowed
+ end
+
+ def to_s
+ "Only method #{@supported_method} is supported on this URI"
+ end
+ end
+
+ ##
+ # raised when an API call takes too long
+ class APITimeoutError < APIError
+ def status
+ :request_timeout
+ end
+
+ def to_s
+ "Request timed out"
+ end
+ end
+
+ ##
+ # raised when someone tries to redact a current version of
+ # an element - only historical versions can be redacted.
+ class APICannotRedactError < APIError
+ def status
+ :bad_request
+ end
+
+ def to_s
+ "Cannot redact current version of element, only historical versions may be redacted."
+ end
+ end
+
+ # Raised when the note provided is already closed
+ class APINoteAlreadyClosedError < APIError
+ def initialize(note)
+ @note = note
+ end
+
+ attr_reader :note
+
+ def status
+ :conflict
+ end
+
+ def to_s
+ "The note #{@note.id} was closed at #{@note.closed_at}"
+ end
+ end
+
+ # Raised when the note provided is already open
+ class APINoteAlreadyOpenError < APIError
+ def initialize(note)
+ @note = note
+ end
+
+ attr_reader :note
+
+ def status
+ :conflict
+ end
+
+ def to_s
+ "The note #{@note.id} is already open"
+ end
+ end
+
+ # raised when a two preferences have a duplicate key string.
+ class APIDuplicatePreferenceError < APIError
+ def initialize(key)
+ @key = key
+ end
+
+ attr_reader :key
+
+ def status
+ :bad_request
+ end
+
+ def to_s
+ "Duplicate preferences with key #{@key}"
+ end
+ end
+
+ # Helper methods for going to/from mercator and lat/lng.