public void ZipApiException_WithErrorResponse_UsesErrorMessage()
{
var errorResponse = new ZipErrorResponse()
{
ErrorCode = "TestErrorCode",
IsValid = false,
Message = "Operator is required",
ValidationErrors = new ZipValidationError[]
{
new ZipValidationError()
{
PropertyName = "Operator",
ErrorMessages = new string[]
{
"Operator is required"
}
}
}
};
var ex = new ZipApiException(errorResponse);
Assert.AreEqual("Operator is required", ex.Message);
Assert.IsNotNull(ex.Errors);
}
public void ZipApiException_WithErrorResponse_ConstructsWithErrorResponseAndInnerException()
{
var inner = new InvalidOperationException("Test error");
var errorResponse = new ZipErrorResponse()
{
ErrorCode = "TestErrorCode",
IsValid = false,
Message = "Operator is required",
ValidationErrors = new ZipValidationError[]
{
new ZipValidationError()
{
PropertyName = "Operator",
ErrorMessages = new string[]
{
"Operator is required"
}
}
}
};
var ex = new ZipApiException(errorResponse, inner);
Assert.AreEqual("Operator is required", ex.Message);
Assert.IsNotNull(ex.Errors);
Assert.AreEqual(inner, ex.InnerException);
}
public void ZipApiException_UsesExplicitErrorMessageAndInnerException()
{
var inner = new HttpRequestException();
var ex = new ZipApiException("Test message", inner);
Assert.AreEqual("Test message", ex.Message);
Assert.AreEqual(inner, ex.InnerException);
}
public void ZipApiException_WithErrorResponse_ProvidesErrorCodeWithMessageFor400Response()
{
var inner = new InvalidOperationException("Test error");
var errorResponse = new ZipErrorResponse()
{
ErrorCode = "AboveMaximumPreApprovalAmount",
IsValid = false,
Message = "The request is invalid",
Type = "https://partpay.net/errors/property-validation",
ResponseCode = 400
};
var ex = new ZipApiException(errorResponse, inner);
Assert.IsNotNull(ex.Errors);
Assert.AreEqual("(AboveMaximumPreApprovalAmount) The request is invalid", ex.Message);
}
public void ZipApiException_SerialisesAndDeserialisesCorrectly()
{
var inner = new InvalidOperationException("Test");
var ex = new ZipApiException("Test message", inner);
var formatter = new System.Runtime.Serialization.Formatters.Binary.BinaryFormatter();
using (var stream = new System.IO.MemoryStream())
{
formatter.Serialize(stream, ex);
stream.Seek(0, System.IO.SeekOrigin.Begin);
var deserialisedEx = formatter.Deserialize(stream) as ZipApiException;
Assert.AreEqual("Test message", deserialisedEx.Message);
Assert.IsTrue(deserialisedEx.InnerException is InvalidOperationException);
}
}
public void ZipApiException_Errors_ReturnsNullWhenNotConstructedWithErrorResponse()
{
var ex = new ZipApiException("Test message");
Assert.IsNull(ex.Errors);
}
public void ZipApiException_UsesExplicitErrorMessage()
{
var ex = new ZipApiException("Test message");
Assert.AreEqual("Test message", ex.Message);
}
public void ZipApiException_DefaultConstructor_UsesUnknownErrorResponseMessage()
{
var ex = new ZipApiException();
Assert.AreEqual("The API returned an error response but did not specify an error message.", ex.Message);
}
public void ZipError_CanDeserialiseFromJsonResponse()
{
var json = @"{""message"":""'Operator' must not be empty."",""isValid"":false,""errors"":[{""propertyName"":""operator"",""errorMessages"":[""'Operator' must not be empty.""]}],""type"":""https://partpay.net/errors/property-validation""}";
var error = System.Text.Json.JsonSerializer.Deserialize <ZipErrorResponse>(json, new System.Text.Json.JsonSerializerOptions()
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase
});
Assert.IsNotNull(error);
Assert.AreEqual("'Operator' must not be empty.", error.Message);
Assert.AreEqual(false, error.IsValid);
Assert.AreEqual(1, error.ValidationErrors.Count());
Assert.AreEqual("operator", error.ValidationErrors.FirstOrDefault().PropertyName);
Assert.AreEqual(1, error.ValidationErrors.FirstOrDefault().ErrorMessages.Count());
Assert.AreEqual("'Operator' must not be empty.", error.ValidationErrors.FirstOrDefault().ErrorMessages.FirstOrDefault());
json = @"{""message"":""'Amount' must not be empty."",""isValid"":false,""errors"":[{""propertyName"":""amount"",""errorMessages"":[""'Amount' must not be empty."",""'Amount' must be greater than '0'.""]},{""propertyName"":""operator"",""errorMessages"":[""'Operator' must not be empty.""]},{""propertyName"":""merchantReference"",""errorMessages"":[""'Merchant Reference' must not be empty.""]},{""propertyName"":""customerApprovalCode"",""errorMessages"":[""'Customer Approval Code' must not be empty.""]}],""type"":""https://partpay.net/errors/property-validation"",""traceId"":""0E391377-984E-49AE-BB3B-290F381DF4B8""}";
error = System.Text.Json.JsonSerializer.Deserialize <ZipErrorResponse>(json, new System.Text.Json.JsonSerializerOptions()
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase
});
Assert.IsNotNull(error);
Assert.AreEqual("'Amount' must not be empty.", error.Message);
Assert.AreEqual(false, error.IsValid);
Assert.AreEqual("https://partpay.net/errors/property-validation", error.Type);
Assert.AreEqual("0E391377-984E-49AE-BB3B-290F381DF4B8", error.TraceId);
var validationErrors = error.ValidationErrors.ToArray();
Assert.AreEqual(4, validationErrors.Count());
Assert.AreEqual("amount", validationErrors[0].PropertyName);
var errorMessages = validationErrors[0].ErrorMessages.ToArray();
Assert.AreEqual(2, errorMessages.Count());
Assert.AreEqual("'Amount' must not be empty.", errorMessages[0]);
Assert.AreEqual("'Amount' must be greater than '0'.", errorMessages[1]);
Assert.AreEqual("operator", validationErrors[1].PropertyName);
errorMessages = validationErrors[1].ErrorMessages.ToArray();
Assert.AreEqual(1, errorMessages.Count());
Assert.AreEqual("'Operator' must not be empty.", errorMessages[0]);
Assert.AreEqual("merchantReference", validationErrors[2].PropertyName);
errorMessages = validationErrors[2].ErrorMessages.ToArray();
Assert.AreEqual(1, errorMessages.Count());
Assert.AreEqual("'Merchant Reference' must not be empty.", errorMessages[0]);
Assert.AreEqual("customerApprovalCode", validationErrors[3].PropertyName);
errorMessages = validationErrors[3].ErrorMessages.ToArray();
Assert.AreEqual(1, errorMessages.Count());
Assert.AreEqual("'Customer Approval Code' must not be empty.", errorMessages[0]);
//Another style of error response Zip sends, includes 'detail'
json = @"{ ""type"": ""https://partpay.net/errors/invalid-refund-merchant-reference"", ""title"": ""Invalid Merchant Reference"", ""detail"": ""Refund reference '195e0a1e-ddfe-4466-ba04-216ecd1ab907' has already been applied to this order for amount 50.00."" }";
error = System.Text.Json.JsonSerializer.Deserialize <ZipErrorResponse>(json, new System.Text.Json.JsonSerializerOptions()
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase
});
Assert.IsNotNull(error);
var ex = new ZipApiException(error);
Assert.AreEqual("Refund reference '195e0a1e-ddfe-4466-ba04-216ecd1ab907' has already been applied to this order for amount 50.00.", ex.Message);
Assert.AreEqual("Invalid Merchant Reference", ex.Errors.Title);
Assert.AreEqual(false, ex.Errors.IsValid);
Assert.AreEqual("https://partpay.net/errors/invalid-refund-merchant-reference", ex.Errors.Type);
}
