message_templatehttperror503

Package'fauxpas'April13,2020TitleHTTPErrorHelpersDescriptionHTTPerrorhelpers.
MethodsincludedforgeneralpurposeHTTPerrorhandling,aswellasindividualmethodsforeveryHTTPstatuscode,bothviastatuscodenumbersaswellastheirdescriptivenames.
Supportsabilitytoadjustbehaviortostop,messageorwarning.
Includesabilitytousecustomwhiskertemplatetohaveanycongurationofstatuscode,shortdescription,andverbosemessage.
Currentlysupportsintegrationwith'crul','curl',and'httr'.
Version0.
5.
0LicenseMIT+leLICENSEURLhttps://docs.
ropensci.
org/fauxpas,https://github.
com/ropensci/fauxpasBugReportshttps://github.
com/ropensci/fauxpas/issuesVignetteBuilderknitrEncodingUTF-8Languageen-USImportsR6(>=2.
1.
2),httpcode(>=0.
3.
0),whiskerSuggestscrul(>=0.
5.
0),curl(>=2.
2),httr(>=1.
2.
0),testthat,knitr,rmarkdownRoxygenNote7.
1.
0X-schema.
org-applicationCategoryWebX-schema.
org-keywordshttp,https,API,web-services,curl,errors,errorX-schema.
org-isPartOfhttps://ropensci.
orgNeedsCompilationnoAuthorScottChamberlain[aut,cre]()MaintainerScottChamberlainRepositoryCRANDate/Publication2020-04-1316:10:02UTC12ErrorRtopicsdocumented:fauxpas-package2Error2Error-Classes5nd_error_class6http1007Index13fauxpas-packagefauxpasDescriptionHTTPErrorHelpersAuthor(s)ScottChamberlainErrorErrorclassDescriptionErrorclassArgumentsbehaviorBehavioroftheerror.
default:auto.
SeeDetailsmessage_templateAmessagetemplate.
optional.
usewhiskertemplating.
namestouseare:rea-sonandstatus.
useintemplatelike{{reason}}and{{status}}.
Notethat{{message}}thatisusedinmessage_template_verbosewillbeignoredhere.
call.
(logical)indicatingifthecallshouldbecomepartoftheerrormessage.
Default:FALSEmessage_template_verboseAverbosemessagetemplate.
optional.
usewhiskertemplating.
namestouseare:reason,status,message.
useintemplatelike{{reason}},{{status}},and{{message}}.
Notethatthisisignoredhere,butisusedintheHTTP*methods(e.
g.
HTTPBadRequest)muffle(logical)whethertonotrespondwhenstatuscodesin1xx-3xxseries.
Default:FALSEError3DetailsMethodsdo(response,mssg)Executecondition,whetheritbemessage,warning,orerror.
–response:isanyresponsefromcrul,curl,orhttrExecutecondition,whetheritbemes-sage,warning,error,oryourowncustomfunction.
Thismethodusesmessage_template_verbose,andusesit'sdefaultvalue.
–mssg:characterstringmessagetoincludeincall.
ignorediftemplatedoesnothaveamessageentryset_behavior(behavior)Setbehavior,sameassettingbehavioroninitializingwith$new()behaviorparameteroptionsstop-usestopwarning-usewarningmessage-usemessageauto-togglebetweenstopandmessagedependingontheHTTPstatuscodeseries.
Defaultswillbe:–1xx:message–2xx:message–3xx:message–4xx:stop–5xx:stopOfcourse,youcanalwaysoverridethedefaults.
SeeAlsohttp,Error-ClassesExamplesError$new()#resetbehavior(z{{reason}}")x$do(res)x$do_verbose(res)##End(Notrun)#serviceunavailablex{{reason}}")yy$message_template##Notrun:yy$do(res)##End(Notrun)##withverbosemessagelibrary(crul)res300CANNOTbemuffled-i.
e.
,returnthehttpresponseobject##Notrun:http(res404,muffle=TRUE)##End(Notrun)}IndexTopicpackagefauxpas-package,2Error,2,5,7,11Error-Classes,5fauxpas(fauxpas-package),2fauxpas-package,2find_error_class,6http,3,5http(http100),7http100,7http101(http100),7http102(http100),7http200(http100),7http201(http100),7http202(http100),7http203(http100),7http204(http100),7http205(http100),7http206(http100),7http207(http100),7http208(http100),7http226(http100),7http300(http100),7http301(http100),7http302(http100),7http303(http100),7http304(http100),7http305(http100),7http306(http100),7http307(http100),7http308(http100),7http400(http100),7http401(http100),7http402(http100),7http403(http100),7http404(http100),7http405(http100),7http406(http100),7http407(http100),7http408(http100),7http409(http100),7http410(http100),7http411(http100),7http412(http100),7http413(http100),7http414(http100),7http415(http100),7http416(http100),7http417(http100),7http418(http100),7http419(http100),7http420(http100),7http422(http100),7http423(http100),7http424(http100),7http425(http100),7http426(http100),7http428(http100),7http429(http100),7http431(http100),7http440(http100),7http444(http100),7http449(http100),7http450(http100),7http451(http100),7http494(http100),7http495(http100),7http496(http100),7http497(http100),7http498(http100),7http499(http100),7http500(http100),7http501(http100),7http502(http100),7http503(http100),7http504(http100),71314INDEXhttp505(http100),7http506(http100),7http507(http100),7http508(http100),7http509(http100),7http510(http100),7http511(http100),7http598(http100),7http599(http100),7HTTPAccepted(Error-Classes),5HTTPAlreadyReported(Error-Classes),5HTTPATimeoutOccurred(Error-Classes),5HTTPAuthenticationTimeout(Error-Classes),5HTTPBadGateway(Error-Classes),5HTTPBadRequest(Error-Classes),5HTTPBandwidthLimitExceeded(Error-Classes),5HTTPBlockedByWindowsParentalControls(Error-Classes),5HTTPCertError(Error-Classes),5HTTPClientClosedRequest(Error-Classes),5HTTPConflict(Error-Classes),5HTTPConnectionTimedOut(Error-Classes),5HTTPContinue(Error-Classes),5HTTPCreated(Error-Classes),5HTTPExpectationFailed(Error-Classes),5HTTPFailedDependency(Error-Classes),5HTTPForbidden(Error-Classes),5HTTPFound(Error-Classes),5HTTPGatewayTimeout(Error-Classes),5HTTPGone(Error-Classes),5HTTPHTTPToHTTPS(Error-Classes),5HTTPHTTPVersionNotSupported(Error-Classes),5HTTPImUsed(Error-Classes),5HTTPInsufficientStorage(Error-Classes),5HTTPInternalServerError(Error-Classes),5HTTPInvalidSSLCertificate(Error-Classes),5HTTPLengthRequired(Error-Classes),5HTTPLocked(Error-Classes),5HTTPLoginTimeout(Error-Classes),5HTTPLoopDetected(Error-Classes),5HTTPMethodFailure(Error-Classes),5HTTPMethodNotAllowed(Error-Classes),5HTTPMisdirectedRequest(Error-Classes),5HTTPMovedPermanently(Error-Classes),5HTTPMultipleChoices(Error-Classes),5HTTPMultiStatus(Error-Classes),5HTTPNetworkAuthenticationRequired(Error-Classes),5HTTPNetworkConnectTimeoutError(Error-Classes),5HTTPNetworkReadTimeoutError(Error-Classes),5HTTPNoCert(Error-Classes),5HTTPNoContent(Error-Classes),5HTTPNonAuthoritativeInformation(Error-Classes),5HTTPNoResponse(Error-Classes),5HTTPNotAcceptable(Error-Classes),5HTTPNotExtended(Error-Classes),5HTTPNotFound(Error-Classes),5HTTPNotImplemented(Error-Classes),5HTTPNotModified(Error-Classes),5HTTPOK(Error-Classes),5HTTPOriginIsUnreachable(Error-Classes),5HTTPPartialContent(Error-Classes),5HTTPPaymentRequired(Error-Classes),5HTTPPermanentRedirect(Error-Classes),5HTTPPreconditionFailed(Error-Classes),5HTTPPreconditionRequired(Error-Classes),5HTTPProcessing(Error-Classes),5HTTPProxyAuthenticationRequired(Error-Classes),5HTTPRailgunError(Error-Classes),5HTTPRequestEntityTooLarge(Error-Classes),5HTTPRequestHeaderFieldsTooLarge(Error-Classes),5HTTPRequestHeaderTooLarge(Error-Classes),5HTTPRequestRangeNotSatisfiable(Error-Classes),5HTTPRequestTimeout(Error-Classes),5HTTPRequestURITooLong(Error-Classes),5HTTPResetContent(Error-Classes),5INDEX15HTTPRetryWith(Error-Classes),5HTTPSeeOther(Error-Classes),5HTTPServiceUnavailable(Error-Classes),5HTTPSSLHandshakeFailed(Error-Classes),5HTTPSwitchProtocol(Error-Classes),5HTTPSwitchProxy(Error-Classes),5HTTPTeaPot(Error-Classes),5HTTPTemporaryRedirect(Error-Classes),5HTTPTokenExpiredInvalid(Error-Classes),5HTTPTooManyRequests(Error-Classes),5HTTPUnauthorized(Error-Classes),5HTTPUnavailableForLegalReasons(Error-Classes),5HTTPUnorderedCollection(Error-Classes),5HTTPUnprocessableEntity(Error-Classes),5HTTPUnsupportedMediaType(Error-Classes),5HTTPUpgradeRequired(Error-Classes),5HTTPUseProxy(Error-Classes),5HTTPVariantAlsoNegotiates(Error-Classes),5HTTPWebServerIsDown(Error-Classes),5HTTPWebServerReturnedUnknownError(Error-Classes),5