httpcode/0000755000176200001440000000000013012417557012071 5ustar liggesusershttpcode/NAMESPACE0000644000176200001440000000023413012170744013301 0ustar liggesusers# Generated by roxygen2: do not edit by hand S3method(print,http_code) export(cat_for_status) export(dog_for_status) export(http_code) export(http_search) httpcode/NEWS.md0000644000176200001440000000056613012253064013165 0ustar liggesusershttpcode 0.2.0 ============== ### NEW FEATURES * Many http codes now with verbose explanation of the status code, but returning the verbose explanation is optional (with default false) (#3) * Added more status codes (#2) ### MINOR IMPROVEMENTS * Fix cat and dog status code base URLs to https (#4) httpcode 0.1.0 ============== ### NEW FEATURES * Released to CRAN. httpcode/R/0000755000176200001440000000000012436533623012274 5ustar liggesusershttpcode/R/httpcode-package.R0000644000176200001440000000031213012170722015602 0ustar liggesusers#' Explain the meaning of HTTP status codes #' #' @name httpcode-package #' @aliases httpcode #' @docType package #' @author Scott Chamberlain \email{myrmecocystus@@gmail.com} #' @keywords package NULL httpcode/R/cat_for_status.R0000644000176200001440000000245713012233121015424 0ustar liggesusers#' Use cat or dog pictures for various HTTP status codes #' #' @export #' @name cat_for_status #' #' @param code An http status code #' @param browse (logical) If \code{TRUE}, opens image in default browser. If #' \code{FALSE}, returns the URL of the image. #' @details uses a service for cats (https://http.cat) and #' dogs (https://httpstatusdogs.com) #' @return Opens image in your default browser, or returns URL #' @examples \dontrun{ #' # give back url #' cat_for_status(100) #' dog_for_status(100) #' cat_for_status(301) #' dog_for_status(301) #' cat_for_status(400) #' dog_for_status(400) #' #' # open image in default browser #' cat_for_status(400, browse=TRUE) #' #' # not found #' # cat_for_status(555) #' } cat_for_status <- function(code, browse = FALSE){ code <- as.character(code) if (code %in% names(status_codes)) { url <- sprintf('https://http.cat/%s', code) if (browse) utils::browseURL(url) else url } else { stopcode("No cat code found", "") } } #' @export #' @rdname cat_for_status dog_for_status <- function(code, browse = FALSE) { code <- as.character(code) if (code %in% names(status_codes)) { url <- sprintf('https://httpstatusdogs.com/wp-content/uploads/%s.jpg', code) if (browse) utils::browseURL(url) else url } else { stopcode("No dog code found", "") } } httpcode/R/code.R0000644000176200001440000000652713012236461013332 0ustar liggesusers#' Find out about http status codes #' #' @name http #' @param code (character) An http status code, or a regex search for HTTP #' status codes. #' @param text (character) A text string to search the messages or descriptions #' of HTTP status codes. #' @param verbose (logical) include verbose status code explanation. #' Default: \code{FALSE} #' #' @return on S3 object of class \code{http_code}, that is inside a list #' of the form: #' \itemize{ #' \item status_code - the status code #' \item message - very brief message explaining the code #' \item explanation - more verbose explanation, but still short #' \item explanation_verbose - the complete explanation #' } #' #' @examples #' # search by code #' http_code(100) #' http_code(400) #' http_code(503) #' ## verbose explanation #' http_code(100, verbose = TRUE) #' http_code(400, verbose = TRUE) #' http_code(503, verbose = TRUE) #' #' # fuzzy code search #' http_code('1xx') #' http_code('3xx') #' http_code('30[12]') #' http_code('30[34]') #' http_code('30[34]') #' ## verbose explanation #' http_code('1xx', verbose = TRUE) #' http_code('3xx', verbose = TRUE) #' #' # search by text message #' http_search("request") #' http_search("forbidden") #' http_search("too") #' ## verbose explanation #' http_search("request", verbose = TRUE) #' #' @examples \dontrun{ #' http_search("birds") #' http_code(999) #' } #' @export #' @rdname http http_code <- function(code = NULL, verbose = FALSE) { code <- as.character(code) if (is.null(code)) { print_codes() } else { if (is_three_digit_code(code)) { print_code(code, verbose) } else { print_filtered_codes(code, verbose) } } } #' @export #' @rdname http http_search <- function(text = NULL, verbose = FALSE) print_search(text, verbose) # helpers ------------------------------- print_filtered_codes <- function(code, verbose){ code2 <- paste0(gsub("x", "\\\\d", code), "$") found_codes <- nozero(sapply(names(status_codes), function(x) grep(code2, x, value = TRUE))) if (length(found_codes) == 0) stopcode('No code found corresponding to', code) print_codes(found_codes, verbose) } print_codes <- function(codes = names(status_codes), verbose) { lapply(sort(codes), print_code, verbose = verbose) } print_code <- function(code, verbose) { twocodes <- status_codes[code] if (length(twocodes[[1]]) != 3) stopcode('No description found for code', code) structure( msg_list( code, twocodes[[1]][[1]], twocodes[[1]][[2]], if (verbose) twocodes[[1]][[3]] else NULL ), class = "http_code" ) } #' @export print.http_code <- function(x, ...){ cat(sprintf("", x$status_code), sep = "\n") cat(sprintf(" Message: %s", x$message), sep = "\n") cat(sprintf(" Explanation: %s", x$explanation), sep = "\n") if (!is.null(x$verbose_explanation)) { cat( strwrap( sprintf(" Verbose Explanation: %s", x$verbose_explanation), getOption("width"), indent = 2, exdent = 4 ), sep = "\n" ) } } print_search <- function(text, verbose) { found_codes <- vapply(status_codes, function(x){ any(vapply(x, function(y) grepl(text, y %||% "", ignore.case = TRUE), logical(1))) }, logical(1)) if (any(found_codes)) { print_codes(names(status_codes[found_codes]), verbose) } else { stopcode('No status code found for search', text) } } httpcode/R/status_codes.R0000644000176200001440000007206213012235223015110 0ustar liggesusersstatus_codes <- list( `100` = list('Continue', 'Request received, please continue', "The client SHOULD continue with its request. This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server. The client SHOULD continue by sending the remainder of the request or, if the request has already been completed, ignore this response. The server MUST send a final response after the request has been completed. See section 8.2.3 for detailed discussion of the use and handling of this status code."), `101` = list('Switching Protocols', 'Switching to new protocol; obey Upgrade header', "The server understands and is willing to comply with the client's request, via the Upgrade message header field (section 14.42), for a change in the application protocol being used on this connection. The server will switch protocols to those defined by the response's Upgrade header field immediately after the empty line which terminates the 101 response.\nThe protocol SHOULD be switched only when it is advantageous to do so. For example, switching to a newer version of HTTP is advantageous over older versions, and switching to a real-time, synchronous protocol might be advantageous when delivering resources that use such features."), `102` = list('Processing', 'WebDAV; RFC 2518', NULL), `200` = list('OK', 'Request fulfilled, document follows', "The request has succeeded. The information returned with the response is dependent on the method used in the request, for example:\nGET an entity corresponding to the requested resource is sent in the response;\nHEAD the entity-header fields corresponding to the requested resource are sent in the response without any message-body;\nPOST an entity describing or containing the result of the action;\n TRACE an entity containing the request message as received by the end server."), `201` = list('Created', 'Document created, URL follows', "The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URI(s) returned in the entity of the response, with the most specific URI for the resource given by a Location header field. The response SHOULD include an entity containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. The origin server MUST create the resource before returning the 201 status code. If the action cannot be carried out immediately, the server SHOULD respond with 202 (Accepted) response instead.\nA 201 response MAY contain an ETag response header field indicating the current value of the entity tag for the requested variant just created, see section 14.19."), `202` = list('Accepted', 'Request accepted, processing continues off-line', "The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place. There is no facility for re-sending a status code from an asynchronous operation such as this.\nThe 202 response is intentionally non-committal. Its purpose is to allow a server to accept a request for some other process (perhaps a batch-oriented process that is only run once per day) without requiring that the user agent's connection to the server persist until the process is completed. The entity returned with this response SHOULD include an indication of the request's current status and either a pointer to a status monitor or some estimate of when the user can expect the request to be fulfilled."), `203` = list('Non-Authoritative Information', 'Request fulfilled from cache', "The returned metainformation in the entity-header is not the definitive set as available from the origin server, but is gathered from a local or a third-party copy. The set presented MAY be a subset or superset of the original version. For example, including local annotation information about the resource might result in a superset of the metainformation known by the origin server. Use of this response code is not required and is only appropriate when the response would otherwise be 200 (OK)."), `204` = list('No Content', 'Request fulfilled, nothing follows', "The server has fulfilled the request but does not need to return an entity-body, and might want to return updated metainformation. The response MAY include new or updated metainformation in the form of entity-headers, which if present SHOULD be associated with the requested variant.\nIf the client is a user agent, it SHOULD NOT change its document view from that which caused the request to be sent. This response is primarily intended to allow input for actions to take place without causing a change to the user agent's active document view, although any new or updated metainformation SHOULD be applied to the document currently in the user agent's active view.\nThe 204 response MUST NOT include a message-body, and thus is always terminated by the first empty line after the header fields."), `205` = list('Reset Content', 'Clear input form for further input.', "The server has fulfilled the request and the user agent SHOULD reset the document view which caused the request to be sent. This response is primarily intended to allow input for actions to take place via user input, followed by a clearing of the form in which the input is given so that the user can easily initiate another input action. The response MUST NOT include an entity."), `206` = list('Partial Content', 'Partial content follows.', "The server has fulfilled the partial GET request for the resource. The request MUST have included a Range header field (section 14.35) indicating the desired range, and MAY have included an If-Range header field (section 14.27) to make the request conditional.\nThe response MUST include the following header fields:\n- Either a Content-Range header field (section 14.16) indicating the range included with this response, or a multipart/byteranges Content-Type including Content-Range fields for each part. If a Content-Length header field is present in the response, its value MUST match the actual number of OCTETs transmitted in the message-body.\n - Date\n - ETag and/or Content-Location, if the header would have been sent in a 200 response to the same request\n - Expires, Cache-Control, and/or Vary, if the field-value might differ from that sent in any previous response for the same variant\nIf the 206 response is the result of an If-Range request that used a strong cache validator (see section 13.3.3), the response SHOULD NOT include other entity-headers. If the response is the result of an If-Range request that used a weak validator, the response MUST NOT include other entity-headers; this prevents inconsistencies between cached entity-bodies and updated headers. Otherwise, the response MUST include all of the entity-headers that would have been returned with a 200 (OK) response to the same request.\nA cache MUST NOT combine a 206 response with other previously cached content if the ETag or Last-Modified headers do not match exactly, see 13.5.4.\nA cache that does not support the Range and Content-Range headers MUST NOT cache 206 (Partial) responses."), `207` = list('Multi-Status', 'WebDAV; RFC 4918', NULL), `208` = list('Already Reported', 'WebDAV; RFC 5842', NULL), `226` = list('IM Used', 'RFC 3229', NULL), `300` = list('Multiple Choices', 'Object has several resources -- see URI list', "The requested resource corresponds to any one of a set of representations, each with its own specific location, and agent- driven negotiation information (section 12) is being provided so that the user (or user agent) can select a preferred representation and redirect its request to that location.\nUnless it was a HEAD request, the response SHOULD include an entity containing a list of resource characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. Depending upon the format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection.\nIf the server has a preferred choice of representation, it SHOULD include the specific URI for that representation in the Location field; user agents MAY use the Location field value for automatic redirection. This response is cacheable unless indicated otherwise."), `301` = list('Moved Permanently', 'Object moved permanently -- see URI list', "The requested resource has been assigned a new permanent URI and any future references to this resource SHOULD use one of the returned URIs. Clients with link editing capabilities ought to automatically re-link references to the Request-URI to one or more of the new references returned by the server, where possible. This response is cacheable unless indicated otherwise.\nThe new permanent URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).\nIf the 301 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued.\nNote: When automatically redirecting a POST request after receiving a 301 status code, some existing HTTP/1.0 user agents will erroneously change it into a GET request."), `302` = list('Found', 'Object moved temporarily -- see URI list', "The requested resource resides temporarily under a different URI. Since the redirection might be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field.\nThe temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).\nIf the 302 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued.\nNote: RFC 1945 and RFC 2068 specify that the client is not allowed to change the method on the redirected request. However, most existing user agent implementations treat 302 as if it were a 303 response, performing a GET on the Location field-value regardless of the original request method. The status codes 303 and 307 have been added for servers that wish to make unambiguously clear which kind of reaction is expected of the client."), `303` = list('See Other', 'Object moved -- see Method and URL list', "The response to the request can be found under a different URI and SHOULD be retrieved using a GET method on that resource. This method exists primarily to allow the output of a POST-activated script to redirect the user agent to a selected resource. The new URI is not a substitute reference for the originally requested resource. The 303 response MUST NOT be cached, but the response to the second (redirected) request might be cacheable.\nThe different URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s).\n Note: Many pre-HTTP/1.1 user agents do not understand the 303 status. When interoperability with such clients is a concern, the 302 status code may be used instead, since most user agents react to a 302 response as described here for 303."), `304` = list('Not Modified', 'Document has not changed since given time', "If the client has performed a conditional GET request and access is allowed, but the document has not been modified, the server SHOULD respond with this status code. The 304 response MUST NOT contain a message-body, and thus is always terminated by the first empty line after the header fields.\nThe response MUST include the following header fields:\n- Date, unless its omission is required by section 14.18.1\nIf a clockless origin server obeys these rules, and proxies and clients add their own Date to any response received without one (as already specified by [RFC 2068], section 14.19), caches will operate correctly.\n- ETag and/or Content-Location, if the header would have been sent in a 200 response to the same request\n- Expires, Cache-Control, and/or Vary, if the field-value might differ from that sent in any previous response for the same variant\nIf the conditional GET used a strong cache validator (see section 13.3.3), the response SHOULD NOT include other entity-headers. Otherwise (i.e., the conditional GET used a weak validator), the response MUST NOT include other entity-headers; this prevents inconsistencies between cached entity-bodies and updated headers.\nIf a 304 response indicates an entity not currently cached, then the cache MUST disregard the response and repeat the request without the conditional.\nIf a cache uses a received 304 response to update a cache entry, the cache MUST update the entry to reflect any new field values given in the response."), `305` = list('Use Proxy', 'You must use proxy specified in Location to access this resource.', "The requested resource MUST be accessed through the proxy given by the Location field. The Location field gives the URI of the proxy. The recipient is expected to repeat this single request via the proxy. 305 responses MUST only be generated by origin servers.\nNote: RFC 2068 was not clear that 305 was intended to redirect a single request, and to be generated by origin servers only. Not observing these limitations has significant security consequences."), `306` = list('Switch Proxy', 'Subsequent requests should use the specified proxy', "The 306 status code was used in a previous version of the secification, is no longer used, and the code is reserved."), `307` = list('Temporary Redirect', 'Object moved temporarily -- see URI list',"The requested resource resides temporarily under a different URI. Since the redirection MAY be altered on occasion, the client SHOULD continue to use the Request-URI for future requests. This response is only cacheable if indicated by a Cache-Control or Expires header field\nThe temporary URI SHOULD be given by the Location field in the response. Unless the request method was HEAD, the entity of the response SHOULD contain a short hypertext note with a hyperlink to the new URI(s) , since many pre-HTTP/1.1 user agents do not understand the 307 status. Therefore, the note SHOULD contain the information necessary for a user to repeat the original request on the new URI.\nIf the 307 status code is received in response to a request other than GET or HEAD, the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user, since this might change the conditions under which the request was issued."), `308` = list('Permanent Redirect', 'Object moved permanently', NULL), `400` = list('Bad Request', 'Bad request syntax or unsupported method', "The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications."), `401` = list('Unauthorized', 'No permission -- see authorization schemes', "The request requires user authentication. The response MUST include a WWW-Authenticate header field (section 14.47) containing a challenge applicable to the requested resource. The client MAY repeat the request with a suitable Authorization header field (section 14.8). If the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. If the 401 response contains the same challenge as the prior response, and the user agent has already attempted authentication at least once, then the user SHOULD be presented the entity that was given in the response, since that entity might include relevant diagnostic information. HTTP access authentication is explained in HTTP Authentication: Basic and Digest Access Authentication [43]."), `402` = list('Payment Required', 'No payment -- see charging schemes', "This code is reserved for future use."), `403` = list('Forbidden', 'Request forbidden -- authorization will not help', "The server understood the request, but is refusing to fulfill it. Authorization will not help and the request SHOULD NOT be repeated. If the request method was not HEAD and the server wishes to make public why the request has not been fulfilled, it SHOULD describe the reason for the refusal in the entity. If the server does not wish to make this information available to the client, the status code 404 (Not Found) can be used instead."), `404` = list('Not Found', 'Nothing matches the given URI', "The server has not found anything matching the Request-URI. No indication is given of whether the condition is temporary or permanent. The 410 (Gone) status code SHOULD be used if the server knows, through some internally configurable mechanism, that an old resource is permanently unavailable and has no forwarding address. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable."), `405` = list('Method Not Allowed', 'Specified method is invalid for this resource.', "The method specified in the Request-Line is not allowed for the resource identified by the Request-URI. The response MUST include an Allow header containing a list of valid methods for the requested resource."), `406` = list('Not Acceptable', 'URI not available in preferred format.', "The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request.\nUnless it was a HEAD request, the response SHOULD include an entity containing a list of available entity characteristics and location(s) from which the user or user agent can choose the one most appropriate. The entity format is specified by the media type given in the Content-Type header field. Depending upon the format and the capabilities of the user agent, selection of the most appropriate choice MAY be performed automatically. However, this specification does not define any standard for such automatic selection.\nNote: HTTP/1.1 servers are allowed to return responses which are not acceptable according to the accept headers sent in the request. In some cases, this may even be preferable to sending a 406 response. User agents are encouraged to inspect the headers of an incoming response to determine if it is acceptable.\nIf the response could be unacceptable, a user agent SHOULD temporarily stop receipt of more data and query the user for a decision on further actions."), `407` = list('Proxy Authentication Required', 'You must authenticate with this proxy before proceeding.', "This code is similar to 401 (Unauthorized), but indicates that the client must first authenticate itself with the proxy. The proxy MUST return a Proxy-Authenticate header field (section 14.33) containing a challenge applicable to the proxy for the requested resource. The client MAY repeat the request with a suitable Proxy-Authorization header field (section 14.34). HTTP access authentication is explained in HTTP Authentication: Basic and Digest Access Authentication [43]."), `408` = list('Request Timeout', 'Request timed out; try again later.', "The client did not produce a request within the time that the server was prepared to wait. The client MAY repeat the request without modifications at any later time."), `409` = list('Conflict', 'Request conflict.', "The request could not be completed due to a conflict with the current state of the resource. This code is only allowed in situations where it is expected that the user might be able to resolve the conflict and resubmit the request. The response body SHOULD include enough information for the user to recognize the source of the conflict. Ideally, the response entity would include enough information for the user or user agent to fix the problem; however, that might not be possible and is not required.\nConflicts are most likely to occur in response to a PUT request. For example, if versioning were being used and the entity being PUT included changes to a resource which conflict with those made by an earlier (third-party) request, the server might use the 409 response to indicate that it can't complete the request. In this case, the response entity would likely contain a list of the differences between the two versions in a format defined by the response Content-Type."), `410` = list('Gone', 'URI no longer exists and has been permanently removed.', "The requested resource is no longer available at the server and no forwarding address is known. This condition is expected to be considered permanent. Clients with link editing capabilities SHOULD delete references to the Request-URI after user approval. If the server does not know, or has no facility to determine, whether or not the condition is permanent, the status code 404 (Not Found) SHOULD be used instead. This response is cacheable unless indicated otherwise.\nThe 410 response is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable and that the server owners desire that remote links to that resource be removed. Such an event is common for limited-time, promotional services and for resources belonging to individuals no longer working at the server's site. It is not necessary to mark all permanently unavailable resources as 'gone' or to keep the mark for any length of time -- that is left to the discretion of the server owner."), `411` = list('Length Required', 'Client must specify Content-Length.', "The server refuses to accept the request without a defined Content-Length. The client MAY repeat the request if it adds a valid Content-Length header field containing the length of the message-body in the request message."), `412` = list('Precondition Failed', 'Precondition in headers is false.', "The precondition given in one or more of the request-header fields evaluated to false when it was tested on the server. This response code allows the client to place preconditions on the current resource metainformation (header field data) and thus prevent the requested method from being applied to a resource other than the one intended."), `413` = list('Request Entity Too Large', 'Entity is too large.', "The server is refusing to process a request because the request entity is larger than the server is willing or able to process. The server MAY close the connection to prevent the client from continuing the request.\nIf the condition is temporary, the server SHOULD include a Retry-After header field to indicate that it is temporary and after what time the client MAY try again."), `414` = list('Request-URI Too Long', 'URI is too long.', "The server is refusing to service the request because the Request-URI is longer than the server is willing to interpret. This rare condition is only likely to occur when a client has improperly converted a POST request to a GET request with long query information, when the client has descended into a URI 'black hole' of redirection (e.g., a redirected URI prefix that points to a suffix of itself), or when the server is under attack by a client attempting to exploit security holes present in some servers using fixed-length buffers for reading or manipulating the Request-URI."), `415` = list('Unsupported Media Type', 'Entity body in unsupported format.', "The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method."), `416` = list('Requested Range Not Satisfiable', 'Cannot satisfy request range.', "A server SHOULD return a response with this status code if a request included a Range request-header field (section 14.35), and none of the range-specifier values in this field overlap the current extent of the selected resource, and the request did not include an If-Range request-header field. (For byte-ranges, this means that the first- byte-pos of all of the byte-range-spec values were greater than the current length of the selected resource.)\nWhen this status code is returned for a byte-range request, the response SHOULD include a Content-Range entity-header field specifying the current length of the selected resource (see section 14.16). This response MUST NOT use the multipart/byteranges content-type."), `417` = list('Expectation Failed', 'Expect condition could not be satisfied.', "The expectation given in an Expect request-header field (see section 14.20) could not be met by this server, or, if the server is a proxy, the server has unambiguous evidence that the request could not be met by the next-hop server."), `418` = list("I'm a teapot", 'The HTCPCP server is a teapot', NULL), `419` = list('Authentication Timeout', 'previously valid authentication has expired', NULL), `420` = list('Method Failure / Enhance Your Calm', 'Spring Framework / Twitter', NULL), `422` = list('Unprocessable Entity', 'WebDAV; RFC 4918', NULL), `423` = list('Locked', 'WebDAV; RFC 4918', NULL), `424` = list('Failed Dependency / Method Failure', 'WebDAV; RFC 4918', NULL), `425` = list('Unordered Collection', 'Internet draft', NULL), `426` = list('Upgrade Required', 'client should switch to a different protocol', NULL), `428` = list('Precondition Required', 'RFC 6585', NULL), `429` = list('Too Many Requests', 'RFC 6585', NULL), `431` = list('Request Header Fields Too Large', 'RFC 6585', NULL), `440` = list('Login Timeout', 'Microsoft', NULL), `444` = list('No Response', 'Nginx', NULL), `449` = list('Retry With', 'Microsoft', NULL), `450` = list('Blocked by Windows Parental Controls', 'Microsoft', NULL), `451` = list('Unavailable For Legal Reasons', 'RFC 7725', NULL), `494` = list('Request Header Too Large', 'Nginx', NULL), `495` = list('Cert Error', 'Nginx', NULL), `496` = list('No Cert', 'Nginx', NULL), `497` = list('HTTP to HTTPS', 'Nginx', NULL), `498` = list('Token expired/invalid', 'Esri', NULL), `499` = list('Client Closed Request', 'Nginx', NULL), `500` = list('Internal Server Error', 'Server got itself in trouble', "The server encountered an unexpected condition which prevented it from fulfilling the request."), `501` = list('Not Implemented', 'Server does not support this operation', "The server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource."), `502` = list('Bad Gateway', 'Invalid responses from another server/proxy.', "The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request."), `503` = list('Service Unavailable', 'The server cannot process the request due to a high load', "The server is currently unable to handle the request due to a temporary overloading or maintenance of the server. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay MAY be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response.\nNote: The existence of the 503 status code does not imply that a server must use it when becoming overloaded. Some servers may wish to simply refuse the connection."), `504` = list('Gateway Timeout', 'The gateway server did not receive a timely response', "The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g. HTTP, FTP, LDAP) or some other auxiliary server (e.g. DNS) it needed to access in attempting to complete the request.\nNote: Note to implementors: some deployed proxies are known to return 400 or 500 when DNS lookups time out."), `505` = list('HTTP Version Not Supported', 'Cannot fulfill request.', "The server does not support, or refuses to support, the HTTP protocol version that was used in the request message. The server is indicating that it is unable or unwilling to complete the request using the same major version as the client, as described in section 3.1, other than with this error message. The response SHOULD contain an entity describing why that version is not supported and what other protocols are supported by that server."), `506` = list('Variant Also Negotiates', 'RFC 2295', NULL), `507` = list('Insufficient Storage', 'WebDAV; RFC 4918', NULL), `508` = list('Loop Detected', 'WebDAV; RFC 5842', NULL), `509` = list('Bandwidth Limit Exceeded', 'Apache bw/limited extension', NULL), `510` = list('Not Extended', 'RFC 2774', NULL), `511` = list('Network Authentication Required', 'RFC 6585', NULL), `598` = list('Network read timeout error', 'Unknown', NULL), `599` = list('Network connect timeout error', 'Unknown', NULL) ) httpcode/R/zzz.R0000644000176200001440000000101113012161000013216 0ustar liggesusersmsg_format <- " Message: %s Explanation: %s, Verbose Explanation: %s" msg_list <- function(a, b, c, d){ comp(list( status_code = a, message = b, explanation = c, verbose_explanation = d )) } is_three_digit_code <- function(x) grepl("\\d{3}", x) nozero <- function(x) names(x[sapply(x, length) > 0]) stopcode <- function(x, y) stop(sprintf('%s: %s\n', x, y), call. = FALSE) `%||%` <- function(x, y) if (is.null(x)) y else x comp <- function(l) Filter(Negate(is.null), l) httpcode/README.md0000644000176200001440000001221313012170653013340 0ustar liggesusershttpcode ======== [![Build Status](https://travis-ci.org/sckott/httpcode.svg)](https://travis-ci.org/sckott/httpcode) [![rstudio mirror downloads](http://cranlogs.r-pkg.org/badges/httpcode)](https://github.com/metacran/cranlogs.app) [![cran version](http://www.r-pkg.org/badges/version/httpcode)](https://cran.r-project.org/package=httpcode) `httpcode` is a tiny R package to search for and show http code messages and description. It's a port of the Python [httpcode](https://github.com/rspivak/httpcode) library. `httpcode` has no dependencies. Follows [RFC 2616](https://www.ietf.org/rfc/rfc2616.txt), and for additional codes following [RFC 6585](https://tools.ietf.org/html/rfc6585). Structure of information for each status code: * `status_code` - the status code * `message` - very brief message explaining the code * `explanation` - more verbose explanation, but still short * `explanation_verbose` - the complete explanation ## Installation Stable version ```r install.packages("httpcode") ``` Development version ```r devtools::install_github("sckott/httpcode") ``` ```r library("httpcode") ``` ## Search by http code ```r http_code(100) #> #> Message: Continue #> Explanation: Request received, please continue ``` ```r http_code(400) #> #> Message: Bad Request #> Explanation: Bad request syntax or unsupported method ``` ```r http_code(503) #> #> Message: Service Unavailable #> Explanation: The server cannot process the request due to a high load ``` ```r http_code(999) #> Error: No description found for code: 999 ``` ## Get verbose status code description ```r http_code(100, verbose = TRUE) #> #> Message: Continue #> Explanation: Request received, please continue #> Verbose Explanation: The client SHOULD continue with its request. This interim response is used to inform the client that the initial part of the request has been received and has not yet been rejected by the server. The client SHOULD continue by sending the remainder of the request or, if the request has already been completed, ignore this response. The server MUST send a final response after the request has been completed. See section 8.2.3 for detailed discussion of the use and handling of this status code. ``` ```r http_code(400, verbose = TRUE) #> #> Message: Bad Request #> Explanation: Bad request syntax or unsupported method #> Verbose Explanation: The request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. ``` # Fuzzy code search ```r http_code('1xx') #> [[1]] #> #> Message: Continue #> Explanation: Request received, please continue #> #> [[2]] #> #> Message: Switching Protocols #> Explanation: Switching to new protocol; obey Upgrade header #> #> [[3]] #> #> Message: Processing #> Explanation: WebDAV; RFC 2518 ``` ```r http_code('3xx') #> [[1]] #> #> Message: Multiple Choices #> Explanation: Object has several resources -- see URI list #> #> [[2]] #> #> Message: Moved Permanently #> Explanation: Object moved permanently -- see URI list #> ... ``` ```r http_code('30[12]') #> [[1]] #> #> Message: Moved Permanently #> Explanation: Object moved permanently -- see URI list #> #> [[2]] #> #> Message: Found #> Explanation: Object moved temporarily -- see URI list ``` ```r http_code('30[34]') #> [[1]] #> #> Message: See Other #> Explanation: Object moved -- see Method and URL list #> #> [[2]] #> #> Message: Not Modified #> Explanation: Document has not changed since given time ``` ## Search by message ```r http_search("request") #> [[1]] #> #> Message: Continue #> Explanation: Request received, please continue #> #> [[2]] #> #> Message: Switching Protocols #> Explanation: Switching to new protocol; obey Upgrade header #> ... ``` ```r http_search("forbidden") #> [[1]] #> #> Message: Forbidden #> Explanation: Request forbidden -- authorization will not help ``` ```r http_search("too") #> [[1]] #> #> Message: Bad Request #> Explanation: Bad request syntax or unsupported method #> #> [[2]] #> #> Message: Forbidden #> Explanation: Request forbidden -- authorization will not help #> #> [[3]] #> #> Message: Request Entity Too Large #> Explanation: Entity is too large. #> #> [[4]] #> #> Message: Request-URI Too Long #> Explanation: URI is too long. #> #> [[5]] #> #> Message: Too Many Requests #> Explanation: RFC 6585 #> #> [[6]] #> #> Message: Request Header Fields Too Large #> Explanation: RFC 6585 #> #> [[7]] #> #> Message: Request Header Too Large #> Explanation: Nginx ``` ```r http_search("birds") #> Error: No status code found for search: birds ``` ## Bugs/features? See [issues](https://github.com/sckott/httpcode/issues) httpcode/MD50000644000176200001440000000115613012417557012404 0ustar liggesusersde730ffe25a3881773db28d168ea9f16 *DESCRIPTION 769bdbb0572f2eefda48945aefb690fc *LICENSE e5098ac0d7fbb9c953a4fb8c3beae14f *NAMESPACE aef2b1392edc00bb9ca0582e5e59ba7b *NEWS.md 398db9e7a289bb70e7fb6884a82d38fc *R/cat_for_status.R 723af87a46f8f0a28e34c2a00d241303 *R/code.R 314b60b7939b0f77deb24a640e344028 *R/httpcode-package.R 612652f6e64693cfa081a697d6997397 *R/status_codes.R af4275ad523188c5e226e330ab940ef1 *R/zzz.R adcb2381bec4af14e68deb2cde2d7ba7 *README.md a79f1700be49a6632173ae211098f8f7 *man/cat_for_status.Rd e5f9114e6335acdf5cc8f2c068cad9be *man/http.Rd d0f3e21b7f12811c94b7f1e47976b20d *man/httpcode-package.Rd httpcode/DESCRIPTION0000644000176200001440000000135313012417557013601 0ustar liggesusersPackage: httpcode Title: 'HTTP' Status Code Helper Description: Find and explain the meaning of 'HTTP' status codes. Functions included for searching for codes by full or partial number, by message, and get appropriate dog and cat images for many status codes. Version: 0.2.0 Authors@R: person("Scott", "Chamberlain", role = c("aut","cre"), email = "myrmecocystus@gmail.com") License: MIT + file LICENSE URL: https://github.com/sckott/httpcode BugReports: http://www.github.com/sckott/httpcode/issues RoxygenNote: 5.0.1 NeedsCompilation: no Packaged: 2016-11-14 15:22:03 UTC; sacmac Author: Scott Chamberlain [aut, cre] Maintainer: Scott Chamberlain Repository: CRAN Date/Publication: 2016-11-14 21:32:47 httpcode/man/0000755000176200001440000000000012436535661012652 5ustar liggesusershttpcode/man/httpcode-package.Rd0000644000176200001440000000055713011666347016347 0ustar liggesusers% Generated by roxygen2: do not edit by hand % Please edit documentation in R/httpcode-package.R \docType{package} \name{httpcode-package} \alias{httpcode} \alias{httpcode-package} \title{Explain the meaning of HTTP status codes} \description{ Explain the meaning of HTTP status codes } \author{ Scott Chamberlain \email{myrmecocystus@gmail.com} } \keyword{package} httpcode/man/cat_for_status.Rd0000644000176200001440000000170613012233126016143 0ustar liggesusers% Generated by roxygen2: do not edit by hand % Please edit documentation in R/cat_for_status.R \name{cat_for_status} \alias{cat_for_status} \alias{dog_for_status} \title{Use cat or dog pictures for various HTTP status codes} \usage{ cat_for_status(code, browse = FALSE) dog_for_status(code, browse = FALSE) } \arguments{ \item{code}{An http status code} \item{browse}{(logical) If \code{TRUE}, opens image in default browser. If \code{FALSE}, returns the URL of the image.} } \value{ Opens image in your default browser, or returns URL } \description{ Use cat or dog pictures for various HTTP status codes } \details{ uses a service for cats (https://http.cat) and dogs (https://httpstatusdogs.com) } \examples{ \dontrun{ # give back url cat_for_status(100) dog_for_status(100) cat_for_status(301) dog_for_status(301) cat_for_status(400) dog_for_status(400) # open image in default browser cat_for_status(400, browse=TRUE) # not found # cat_for_status(555) } } httpcode/man/http.Rd0000644000176200001440000000271213012236471014106 0ustar liggesusers% Generated by roxygen2: do not edit by hand % Please edit documentation in R/code.R \name{http} \alias{http} \alias{http_code} \alias{http_search} \title{Find out about http status codes} \usage{ http_code(code = NULL, verbose = FALSE) http_search(text = NULL, verbose = FALSE) } \arguments{ \item{code}{(character) An http status code, or a regex search for HTTP status codes.} \item{verbose}{(logical) include verbose status code explanation. Default: \code{FALSE}} \item{text}{(character) A text string to search the messages or descriptions of HTTP status codes.} } \value{ on S3 object of class \code{http_code}, that is inside a list of the form: \itemize{ \item status_code - the status code \item message - very brief message explaining the code \item explanation - more verbose explanation, but still short \item explanation_verbose - the complete explanation } } \description{ Find out about http status codes } \examples{ # search by code http_code(100) http_code(400) http_code(503) ## verbose explanation http_code(100, verbose = TRUE) http_code(400, verbose = TRUE) http_code(503, verbose = TRUE) # fuzzy code search http_code('1xx') http_code('3xx') http_code('30[12]') http_code('30[34]') http_code('30[34]') ## verbose explanation http_code('1xx', verbose = TRUE) http_code('3xx', verbose = TRUE) # search by text message http_search("request") http_search("forbidden") http_search("too") ## verbose explanation http_search("request", verbose = TRUE) } httpcode/LICENSE0000644000176200001440000000005712645466223013105 0ustar liggesusersYEAR: 2016 COPYRIGHT HOLDER: Scott Chamberlain