[med-svn] [r-cran-httpcode] 02/04: New upstream version 0.2.0
Andreas Tille
tille at debian.org
Thu Sep 28 20:41:27 UTC 2017
This is an automated email from the git hooks/post-receive script.
tille pushed a commit to branch master
in repository r-cran-httpcode.
commit 815718b76a922f4e101b044649d7573b530c3161
Author: Andreas Tille <tille at debian.org>
Date: Thu Sep 28 22:39:33 2017 +0200
New upstream version 0.2.0
---
DESCRIPTION | 19 ++++
LICENSE | 2 +
MD5 | 13 +++
NAMESPACE | 7 ++
NEWS.md | 20 ++++
R/cat_for_status.R | 47 ++++++++++
R/code.R | 125 +++++++++++++++++++++++++
R/httpcode-package.R | 8 ++
R/status_codes.R | 82 +++++++++++++++++
R/zzz.R | 24 +++++
README.md | 237 ++++++++++++++++++++++++++++++++++++++++++++++++
debian/changelog | 5 -
debian/compat | 1 -
debian/control | 25 -----
debian/copyright | 32 -------
debian/rules | 5 -
debian/source/format | 1 -
debian/watch | 2 -
man/cat_for_status.Rd | 45 +++++++++
man/http.Rd | 64 +++++++++++++
man/httpcode-package.Rd | 15 +++
21 files changed, 708 insertions(+), 71 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
new file mode 100644
index 0000000..27c8ea6
--- /dev/null
+++ b/DESCRIPTION
@@ -0,0 +1,19 @@
+Package: 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 at R: person("Scott", "Chamberlain", role = c("aut","cre"),
+ email = "myrmecocystus at 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 <myrmecocystus at gmail.com>
+Repository: CRAN
+Date/Publication: 2016-11-14 21:32:47
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d044f7e
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,2 @@
+YEAR: 2016
+COPYRIGHT HOLDER: Scott Chamberlain
diff --git a/MD5 b/MD5
new file mode 100644
index 0000000..92af268
--- /dev/null
+++ b/MD5
@@ -0,0 +1,13 @@
+de730ffe25a3881773db28d168ea9f16 *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
diff --git a/NAMESPACE b/NAMESPACE
new file mode 100644
index 0000000..bba1dd1
--- /dev/null
+++ b/NAMESPACE
@@ -0,0 +1,7 @@
+# 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)
diff --git a/NEWS.md b/NEWS.md
new file mode 100644
index 0000000..5c679f2
--- /dev/null
+++ b/NEWS.md
@@ -0,0 +1,20 @@
+httpcode 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.
diff --git a/R/cat_for_status.R b/R/cat_for_status.R
new file mode 100644
index 0000000..3fe317c
--- /dev/null
+++ b/R/cat_for_status.R
@@ -0,0 +1,47 @@
+#' 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", "")
+ }
+}
diff --git a/R/code.R b/R/code.R
new file mode 100644
index 0000000..ef62f78
--- /dev/null
+++ b/R/code.R
@@ -0,0 +1,125 @@
+#' 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("<Status code: %s>", 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)
+ }
+}
diff --git a/R/httpcode-package.R b/R/httpcode-package.R
new file mode 100644
index 0000000..44a6ef9
--- /dev/null
+++ b/R/httpcode-package.R
@@ -0,0 +1,8 @@
+#' Explain the meaning of HTTP status codes
+#'
+#' @name httpcode-package
+#' @aliases httpcode
+#' @docType package
+#' @author Scott Chamberlain \email{myrmecocystus@@gmail.com}
+#' @keywords package
+NULL
diff --git a/R/status_codes.R b/R/status_codes.R
new file mode 100644
index 0000000..a3b1c2d
--- /dev/null
+++ b/R/status_codes.R
@@ -0,0 +1,82 @@
+status_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 f [...]
+ `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 [...]
+ `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 conta [...]
+ `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 ent [...]
+ `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 [...]
+ `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 [...]
+ `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 prima [...]
+ `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 mu [...]
+ `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 characteri [...]
+ `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 give [...]
+ `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 [...]
+ `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 [...]
+ `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 [...]
+ `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 ob [...]
+ `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 respons [...]
+ `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 credent [...]
+ `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 [...]
+ `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 bee [...]
+ `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 forma [...]
+ `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 aut [...]
+ `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 probl [...]
+ `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 ins [...]
+ `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 att [...]
+ `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 [...]
+ `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: T [...]
+ `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 su [...]
+ `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)
+)
diff --git a/R/zzz.R b/R/zzz.R
new file mode 100644
index 0000000..fde086b
--- /dev/null
+++ b/R/zzz.R
@@ -0,0 +1,24 @@
+msg_format <-
+ "<Status code: %s>
+ 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)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3f0ba46
--- /dev/null
+++ b/README.md
@@ -0,0 +1,237 @@
+httpcode
+========
+
+
+
+[](https://travis-ci.org/sckott/httpcode)
+[](https://github.com/metacran/cranlogs.app)
+[](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)
+#> <Status code: 100>
+#> Message: Continue
+#> Explanation: Request received, please continue
+```
+
+
+```r
+http_code(400)
+#> <Status code: 400>
+#> Message: Bad Request
+#> Explanation: Bad request syntax or unsupported method
+```
+
+
+```r
+http_code(503)
+#> <Status 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)
+#> <Status code: 100>
+#> 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 h [...]
+```
+
+
+```r
+http_code(400, verbose = TRUE)
+#> <Status code: 400>
+#> 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]]
+#> <Status code: 100>
+#> Message: Continue
+#> Explanation: Request received, please continue
+#>
+#> [[2]]
+#> <Status code: 101>
+#> Message: Switching Protocols
+#> Explanation: Switching to new protocol; obey Upgrade header
+#>
+#> [[3]]
+#> <Status code: 102>
+#> Message: Processing
+#> Explanation: WebDAV; RFC 2518
+```
+
+
+```r
+http_code('3xx')
+#> [[1]]
+#> <Status code: 300>
+#> Message: Multiple Choices
+#> Explanation: Object has several resources -- see URI list
+#>
+#> [[2]]
+#> <Status code: 301>
+#> Message: Moved Permanently
+#> Explanation: Object moved permanently -- see URI list
+#>
+...
+```
+
+
+```r
+http_code('30[12]')
+#> [[1]]
+#> <Status code: 301>
+#> Message: Moved Permanently
+#> Explanation: Object moved permanently -- see URI list
+#>
+#> [[2]]
+#> <Status code: 302>
+#> Message: Found
+#> Explanation: Object moved temporarily -- see URI list
+```
+
+
+```r
+http_code('30[34]')
+#> [[1]]
+#> <Status code: 303>
+#> Message: See Other
+#> Explanation: Object moved -- see Method and URL list
+#>
+#> [[2]]
+#> <Status code: 304>
+#> Message: Not Modified
+#> Explanation: Document has not changed since given time
+```
+
+## Search by message
+
+
+```r
+http_search("request")
+#> [[1]]
+#> <Status code: 100>
+#> Message: Continue
+#> Explanation: Request received, please continue
+#>
+#> [[2]]
+#> <Status code: 101>
+#> Message: Switching Protocols
+#> Explanation: Switching to new protocol; obey Upgrade header
+#>
+...
+```
+
+
+```r
+http_search("forbidden")
+#> [[1]]
+#> <Status code: 403>
+#> Message: Forbidden
+#> Explanation: Request forbidden -- authorization will not help
+```
+
+
+```r
+http_search("too")
+#> [[1]]
+#> <Status code: 400>
+#> Message: Bad Request
+#> Explanation: Bad request syntax or unsupported method
+#>
+#> [[2]]
+#> <Status code: 403>
+#> Message: Forbidden
+#> Explanation: Request forbidden -- authorization will not help
+#>
+#> [[3]]
+#> <Status code: 413>
+#> Message: Request Entity Too Large
+#> Explanation: Entity is too large.
+#>
+#> [[4]]
+#> <Status code: 414>
+#> Message: Request-URI Too Long
+#> Explanation: URI is too long.
+#>
+#> [[5]]
+#> <Status code: 429>
+#> Message: Too Many Requests
+#> Explanation: RFC 6585
+#>
+#> [[6]]
+#> <Status code: 431>
+#> Message: Request Header Fields Too Large
+#> Explanation: RFC 6585
+#>
+#> [[7]]
+#> <Status code: 494>
+#> 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)
diff --git a/debian/changelog b/debian/changelog
deleted file mode 100644
index 314d5de..0000000
--- a/debian/changelog
+++ /dev/null
@@ -1,5 +0,0 @@
-r-cran-httpcode (0.2.0-1) unstable; urgency=medium
-
- * Initial release (closes: #851563)
-
- -- Andreas Tille <tille at debian.org> Mon, 16 Jan 2017 17:05:24 +0100
diff --git a/debian/compat b/debian/compat
deleted file mode 100644
index f599e28..0000000
--- a/debian/compat
+++ /dev/null
@@ -1 +0,0 @@
-10
diff --git a/debian/control b/debian/control
deleted file mode 100644
index 67f0933..0000000
--- a/debian/control
+++ /dev/null
@@ -1,25 +0,0 @@
-Source: r-cran-httpcode
-Maintainer: Debian Med Packaging Team <debian-med-packaging at lists.alioth.debian.org>
-Uploaders: Andreas Tille <tille at debian.org>
-Section: gnu-r
-Priority: optional
-Build-Depends: debhelper (>= 10),
- dh-r,
- r-base-dev
-Standards-Version: 3.9.8
-Vcs-Browser: https://anonscm.debian.org/viewvc/debian-med/trunk/packages/R/r-cran-httpcode/
-Vcs-Svn: svn://anonscm.debian.org/debian-med/trunk/packages/R/r-cran-httpcode/
-Homepage: https://cran.r-project.org/package=httpcode
-
-Package: r-cran-httpcode
-Architecture: all
-Depends: ${R:Depends},
- ${shlibs:Depends},
- ${misc:Depends}
-Recommends: ${R:Recommends}
-Suggests: ${R:Suggests}
-Description: GNU R HTTP Status Code Helper
- 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.
diff --git a/debian/copyright b/debian/copyright
deleted file mode 100644
index 66394f2..0000000
--- a/debian/copyright
+++ /dev/null
@@ -1,32 +0,0 @@
-Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
-Upstream-Name: httpcode
-Upstream-Contact: Scott Chamberlain <myrmecocystus at gmail.com>
-Source: https://cran.r-project.org/package=httpcode
-
-Files: *
-Copyright: 2015-2017 Scott Chamberlain
-License: MIT
-
-Files: debian/*
-Copyright: 2017 Andreas Tille <tille at debian.org>
-License: MIT
-
-License: MIT
- Permission is hereby granted, free of charge, to any person obtaining
- a copy of this software and associated documentation files (the
- "Software"), to deal in the Software without restriction, including
- without limitation the rights to use, copy, modify, merge, publish,
- distribute, sublicense, and/or sell copies of the Software, and to
- permit persons to whom the Software is furnished to do so, subject to
- the following conditions:
- .
- The above copyright notice and this permission notice shall be
- included in all copies or substantial portions of the Software.
- .
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
- LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
- OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/debian/rules b/debian/rules
deleted file mode 100755
index 529c38a..0000000
--- a/debian/rules
+++ /dev/null
@@ -1,5 +0,0 @@
-#!/usr/bin/make -f
-
-%:
- dh $@ --buildsystem R
-
diff --git a/debian/source/format b/debian/source/format
deleted file mode 100644
index 163aaf8..0000000
--- a/debian/source/format
+++ /dev/null
@@ -1 +0,0 @@
-3.0 (quilt)
diff --git a/debian/watch b/debian/watch
deleted file mode 100644
index 013cc04..0000000
--- a/debian/watch
+++ /dev/null
@@ -1,2 +0,0 @@
-version=4
-https://cran.r-project.org/src/contrib/httpcode_([-\d.]*)\.tar\.gz
diff --git a/man/cat_for_status.Rd b/man/cat_for_status.Rd
new file mode 100644
index 0000000..20ec45a
--- /dev/null
+++ b/man/cat_for_status.Rd
@@ -0,0 +1,45 @@
+% 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)
+}
+}
+
diff --git a/man/http.Rd b/man/http.Rd
new file mode 100644
index 0000000..0de8196
--- /dev/null
+++ b/man/http.Rd
@@ -0,0 +1,64 @@
+% 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)
+
+}
+
diff --git a/man/httpcode-package.Rd b/man/httpcode-package.Rd
new file mode 100644
index 0000000..6aab691
--- /dev/null
+++ b/man/httpcode-package.Rd
@@ -0,0 +1,15 @@
+% 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 at gmail.com}
+}
+\keyword{package}
+
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/r-cran-httpcode.git
More information about the debian-med-commit
mailing list