error.go

// Copyright (c) 2016 Pulcy.
//
// 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.

package api

import (
	"github.com/juju/errgo"
	"github.com/pulcy/rest-kit"
)

const (
	codeDuplicateID = 1
	codeValidation  = 2
)

var (
	IDNotFoundError  = restkit.NotFoundError("not found", 0)
	DuplicateIDError = restkit.BadRequestError("duplicate ID", codeDuplicateID)
	ValidationError  = restkit.BadRequestError("validation", codeValidation)

	maskAny = errgo.MaskFunc(errgo.Any)
)

// IsIDNotFound returns true if the cause of the given error is IDNotFoundError.
func IsIDNotFound(err error) bool {
	return restkit.IsStatusNotFound(err)
}

// IsDuplicateID returns true if the cause of the given error is DuplicateIDError.
func IsDuplicateID(err error) bool {
	return restkit.IsStatusBadRequest(err) && restkit.IsErrorResponseWithCode(err, codeDuplicateID)
}

// IsValidation returns true if the cause of the given error is ValidationError.
func IsValidation(err error) bool {
	return restkit.IsStatusBadRequest(err) && restkit.IsErrorResponseWithCode(err, codeValidation)
}