{ "content": [ { "type": "text", "text": "# HTTP::Tiny (perldoc)\n\n## NAME\n\nHTTP::Tiny - A small, simple, correct HTTP/1.1 client\n\n## SYNOPSIS\n\nuse HTTP::Tiny;\nmy $response = HTTP::Tiny->new->get('http://example.com/');\ndie \"Failed!\\n\" unless $response->{success};\nprint \"$response->{status} $response->{reason}\\n\";\nwhile (my ($k, $v) = each %{$response->{headers}}) {\nfor (ref $v eq 'ARRAY' ? @$v : $v) {\nprint \"$k: $\\n\";\n}\n}\nprint $response->{content} if length $response->{content};\n\n## DESCRIPTION\n\nThis is a very simple HTTP/1.1 client, designed for doing simple requests without the overhead\nof a large framework like LWP::UserAgent.\n\n## Sections\n\n- **NAME**\n- **VERSION**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **METHODS**\n- **SSL SUPPORT**\n- **PROXY SUPPORT**\n- **LIMITATIONS**\n- **SEE ALSO**\n- **SUPPORT** (1 subsections)\n- **AUTHORS**\n- **CONTRIBUTORS**\n- **COPYRIGHT AND LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "HTTP::Tiny", "section": "", "mode": "perldoc", "summary": "HTTP::Tiny - A small, simple, correct HTTP/1.1 client", "synopsis": "use HTTP::Tiny;\nmy $response = HTTP::Tiny->new->get('http://example.com/');\ndie \"Failed!\\n\" unless $response->{success};\nprint \"$response->{status} $response->{reason}\\n\";\nwhile (my ($k, $v) = each %{$response->{headers}}) {\nfor (ref $v eq 'ARRAY' ? @$v : $v) {\nprint \"$k: $\\n\";\n}\n}\nprint $response->{content} if length $response->{content};", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [], "examples": [], "see_also": [], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "VERSION", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 16, "subsections": [] }, { "name": "DESCRIPTION", "lines": 11, "subsections": [] }, { "name": "METHODS", "lines": 225, "subsections": [] }, { "name": "SSL SUPPORT", "lines": 64, "subsections": [] }, { "name": "PROXY SUPPORT", "lines": 27, "subsections": [] }, { "name": "LIMITATIONS", "lines": 47, "subsections": [] }, { "name": "SEE ALSO", "lines": 16, "subsections": [] }, { "name": "SUPPORT", "lines": 5, "subsections": [ { "name": "Source Code", "lines": 7 } ] }, { "name": "AUTHORS", "lines": 4, "subsections": [] }, { "name": "CONTRIBUTORS", "lines": 74, "subsections": [] }, { "name": "COPYRIGHT AND LICENSE", "lines": 5, "subsections": [] } ], "sections": { "NAME": { "content": "HTTP::Tiny - A small, simple, correct HTTP/1.1 client\n", "subsections": [] }, "VERSION": { "content": "version 0.076\n", "subsections": [] }, "SYNOPSIS": { "content": "use HTTP::Tiny;\n\nmy $response = HTTP::Tiny->new->get('http://example.com/');\n\ndie \"Failed!\\n\" unless $response->{success};\n\nprint \"$response->{status} $response->{reason}\\n\";\n\nwhile (my ($k, $v) = each %{$response->{headers}}) {\nfor (ref $v eq 'ARRAY' ? @$v : $v) {\nprint \"$k: $\\n\";\n}\n}\n\nprint $response->{content} if length $response->{content};\n", "subsections": [] }, "DESCRIPTION": { "content": "This is a very simple HTTP/1.1 client, designed for doing simple requests without the overhead\nof a large framework like LWP::UserAgent.\n\nIt is more correct and more complete than HTTP::Lite. It supports proxies and redirection. It\nalso correctly resumes after EINTR.\n\nIf IO::Socket::IP 0.25 or later is installed, HTTP::Tiny will use it instead of IO::Socket::INET\nfor transparent support for both IPv4 and IPv6.\n\nCookie support requires HTTP::CookieJar or an equivalent class.\n", "subsections": [] }, "METHODS": { "content": "new\n$http = HTTP::Tiny->new( %attributes );\n\nThis constructor returns a new HTTP::Tiny object. Valid attributes include:\n\n* \"agent\" — A user-agent string (defaults to 'HTTP-Tiny/$VERSION'). If \"agent\" — ends in a\nspace character, the default user-agent string is appended.\n\n* \"cookiejar\" — An instance of HTTP::CookieJar — or equivalent class that supports the \"add\"\nand \"cookieheader\" methods\n\n* \"defaultheaders\" — A hashref of default headers to apply to requests\n\n* \"localaddress\" — The local IP address to bind to\n\n* \"keepalive\" — Whether to reuse the last connection (if for the same scheme, host and port)\n(defaults to 1)\n\n* \"maxredirect\" — Maximum number of redirects allowed (defaults to 5)\n\n* \"maxsize\" — Maximum response size in bytes (only when not using a data callback). If\ndefined, responses larger than this will return an exception.\n\n* \"httpproxy\" — URL of a proxy server to use for HTTP connections (default is\n$ENV{httpproxy} — if set)\n\n* \"httpsproxy\" — URL of a proxy server to use for HTTPS connections (default is\n$ENV{httpsproxy} — if set)\n\n* \"proxy\" — URL of a generic proxy server for both HTTP and HTTPS connections (default is\n$ENV{allproxy} — if set)\n\n* \"noproxy\" — List of domain suffixes that should not be proxied. Must be a comma-separated\nstring or an array reference. (default is $ENV{noproxy} —)\n\n* \"timeout\" — Request timeout in seconds (default is 60) If a socket open, read or write takes\nlonger than the timeout, an exception is thrown.\n\n* \"verifySSL\" — A boolean that indicates whether to validate the SSL certificate of an\n\"https\" — connection (default is false)\n\n* \"SSLoptions\" — A hashref of \"SSL*\" — options to pass through to IO::Socket::SSL\n\nPassing an explicit \"undef\" for \"proxy\", \"httpproxy\" or \"httpsproxy\" will prevent getting the\ncorresponding proxies from the environment.\n\nExceptions from \"maxsize\", \"timeout\" or other errors will result in a pseudo-HTTP status code\nof 599 and a reason of \"Internal Exception\". The content field in the response will contain the\ntext of the exception.\n\nThe \"keepalive\" parameter enables a persistent connection, but only to a single destination\nscheme, host and port. Also, if any connection-relevant attributes are modified, or if the\nprocess ID or thread ID change, the persistent connection will be dropped. If you want\npersistent connections across multiple destinations, use multiple HTTP::Tiny objects.\n\nSee \"SSL SUPPORT\" for more on the \"verifySSL\" and \"SSLoptions\" attributes.\n\nget|head|put|post|delete\n$response = $http->get($url);\n$response = $http->get($url, \\%options);\n$response = $http->head($url);\n\nThese methods are shorthand for calling \"request()\" for the given method. The URL must have\nunsafe characters escaped and international domain names encoded. See \"request()\" for valid\noptions and a description of the response.\n\nThe \"success\" field of the response will be true if the status code is 2XX.\n\npostform\n$response = $http->postform($url, $formdata);\n$response = $http->postform($url, $formdata, \\%options);\n\nThis method executes a \"POST\" request and sends the key/value pairs from a form data hash or\narray reference to the given URL with a \"content-type\" of \"application/x-www-form-urlencoded\".\nIf data is provided as an array reference, the order is preserved; if provided as a hash\nreference, the terms are sorted on key and value for consistency. See documentation for the\n\"wwwformurlencode\" method for details on the encoding.\n\nThe URL must have unsafe characters escaped and international domain names encoded. See\n\"request()\" for valid options and a description of the response. Any \"content-type\" header or\ncontent in the options hashref will be ignored.\n\nThe \"success\" field of the response will be true if the status code is 2XX.\n\nmirror\n$response = $http->mirror($url, $file, \\%options)\nif ( $response->{success} ) {\nprint \"$file is up to date\\n\";\n}\n\nExecutes a \"GET\" request for the URL and saves the response body to the file name provided. The\nURL must have unsafe characters escaped and international domain names encoded. If the file\nalready exists, the request will include an \"If-Modified-Since\" header with the modification\ntimestamp of the file. You may specify a different \"If-Modified-Since\" header yourself in the\n\"$options->{headers}\" hash.\n\nThe \"success\" field of the response will be true if the status code is 2XX or if the status code\nis 304 (unmodified).\n\nIf the file was modified and the server response includes a properly formatted \"Last-Modified\"\nheader, the file modification time will be updated accordingly.\n\nrequest\n$response = $http->request($method, $url);\n$response = $http->request($method, $url, \\%options);\n\nExecutes an HTTP request of the given method type ('GET', 'HEAD', 'POST', 'PUT', etc.) on the\ngiven URL. The URL must have unsafe characters escaped and international domain names encoded.\n\nNOTE: Method names are case-sensitive per the HTTP/1.1 specification. Don't use \"get\" when you\nreally want \"GET\". See LIMITATIONS for how this applies to redirection.\n\nIf the URL includes a \"user:password\" stanza, they will be used for Basic-style authorization\nheaders. (Authorization headers will not be included in a redirected request.) For example:\n\n$http->request('GET', 'http://Aladdin:open sesame@example.com/');\n\nIf the \"user:password\" stanza contains reserved characters, they must be percent-escaped:\n\n$http->request('GET', 'http://john%40example.com:password@example.com/');\n\nA hashref of options may be appended to modify the request.\n\nValid options are:\n\n* \"headers\" — A hashref containing headers to include with the request. If the value for a\nheader is an array reference, the header will be output multiple times with each value in\nthe array. These headers over-write any default headers.\n\n* \"content\" — A scalar to include as the body of the request OR a code reference that will be\ncalled iteratively to produce the body of the request\n\n* \"trailercallback\" — A code reference that will be called if it exists to provide a hashref\nof trailing headers (only used with chunked transfer-encoding)\n\n* \"datacallback\" — A code reference that will be called for each chunks of the response body\nreceived.\n\n* \"peer\" — Override host resolution and force all connections to go only to a specific peer\naddress, regardless of the URL of the request. This will include any redirections! This\noptions should be used with extreme caution (e.g. debugging or very special circumstances).\nIt can be given as either a scalar or a code reference that will receive the hostname and\nwhose response will be taken as the address.\n\nThe \"Host\" header is generated from the URL in accordance with RFC 2616. It is a fatal error to\nspecify \"Host\" in the \"headers\" option. Other headers may be ignored or overwritten if necessary\nfor transport compliance.\n\nIf the \"content\" option is a code reference, it will be called iteratively to provide the\ncontent body of the request. It should return the empty string or undef when the iterator is\nexhausted.\n\nIf the \"content\" option is the empty string, no \"content-type\" or \"content-length\" headers will\nbe generated.\n\nIf the \"datacallback\" option is provided, it will be called iteratively until the entire\nresponse body is received. The first argument will be a string containing a chunk of the\nresponse body, the second argument will be the in-progress response hash reference, as described\nbelow. (This allows customizing the action of the callback based on the \"status\" or \"headers\"\nreceived prior to the content body.)\n\nThe \"request\" method returns a hashref containing the response. The hashref will have the\nfollowing keys:\n\n* \"success\" — Boolean indicating whether the operation returned a 2XX status code\n\n* \"url\" — URL that provided the response. This is the URL of the request unless there were\nredirections, in which case it is the last URL queried in a redirection chain\n\n* \"status\" — The HTTP status code of the response\n\n* \"reason\" — The response phrase returned by the server\n\n* \"content\" — The body of the response. If the response does not have any content or if a data\ncallback is provided to consume the response body, this will be the empty string\n\n* \"headers\" — A hashref of header fields. All header field names will be normalized to be\nlower case. If a header is repeated, the value will be an arrayref; it will otherwise be a\nscalar string containing the value\n\n* \"protocol\" - If this field exists, it is the protocol of the response such as HTTP/1.0 or\nHTTP/1.1\n\n* \"redirects\" If this field exists, it is an arrayref of response hash references from\nredirects in the same order that redirections occurred. If it does not exist, then no\nredirections occurred.\n\nOn an exception during the execution of the request, the \"status\" field will contain 599, and\nthe \"content\" field will contain the text of the exception.\n\nwwwformurlencode\n$params = $http->wwwformurlencode( $data );\n$response = $http->get(\"http://example.com/query?$params\");\n\nThis method converts the key/value pairs from a data hash or array reference into a\n\"x-www-form-urlencoded\" string. The keys and values from the data reference will be UTF-8\nencoded and escaped per RFC 3986. If a value is an array reference, the key will be repeated\nwith each of the values of the array reference. If data is provided as a hash reference, the\nkey/value pairs in the resulting string will be sorted by key and value for consistent ordering.\n\ncanssl\n$ok = HTTP::Tiny->canssl;\n($ok, $why) = HTTP::Tiny->canssl;\n($ok, $why) = $http->canssl;\n\nIndicates if SSL support is available. When called as a class object, it checks for the correct\nversion of Net::SSLeay and IO::Socket::SSL. When called as an object methods, if \"SSLverify\" is\ntrue or if \"SSLverifymode\" is set in \"SSLoptions\", it checks that a CA file is available.\n\nIn scalar context, returns a boolean indicating if SSL is available. In list context, returns\nthe boolean and a (possibly multi-line) string of errors indicating why SSL isn't available.\n\nconnected\n$host = $http->connected;\n($host, $port) = $http->connected;\n\nIndicates if a connection to a peer is being kept alive, per the \"keepalive\" option.\n\nIn scalar context, returns the peer host and port, joined with a colon, or \"undef\" (if no peer\nis connected). In list context, returns the peer host and port or an empty list (if no peer is\nconnected).\n\nNote: This method cannot reliably be used to discover whether the remote host has closed its end\nof the socket.\n", "subsections": [] }, "SSL SUPPORT": { "content": "Direct \"https\" connections are supported only if IO::Socket::SSL 1.56 or greater and Net::SSLeay\n1.49 or greater are installed. An exception will be thrown if new enough versions of these\nmodules are not installed or if the SSL encryption fails. You can also use\n\"HTTP::Tiny::canssl()\" utility function that returns boolean to see if the required modules are\ninstalled.\n\nAn \"https\" connection may be made via an \"http\" proxy that supports the CONNECT command (i.e.\nRFC 2817). You may not proxy \"https\" via a proxy that itself requires \"https\" to communicate.\n\nSSL provides two distinct capabilities:\n\n* Encrypted communication channel\n\n* Verification of server identity\n\nBy default, HTTP::Tiny does not verify server identity.\n\nServer identity verification is controversial and potentially tricky because it depends on a\n(usually paid) third-party Certificate Authority (CA) trust model to validate a certificate as\nlegitimate. This discriminates against servers with self-signed certificates or certificates\nsigned by free, community-driven CA's such as CAcert.org .\n\nBy default, HTTP::Tiny does not make any assumptions about your trust model, threat level or\nrisk tolerance. It just aims to give you an encrypted channel when you need one.\n\nSetting the \"verifySSL\" attribute to a true value will make HTTP::Tiny verify that an SSL\nconnection has a valid SSL certificate corresponding to the host name of the connection and that\nthe SSL certificate has been verified by a CA. Assuming you trust the CA, this will protect\nagainst a man-in-the-middle attack . If\nyou are concerned about security, you should enable this option.\n\nCertificate verification requires a file containing trusted CA certificates.\n\nIf the environment variable \"SSLCERTFILE\" is present, HTTP::Tiny will try to find a CA\ncertificate file in that location.\n\nIf the Mozilla::CA module is installed, HTTP::Tiny will use the CA file included with it as a\nsource of trusted CA's. (This means you trust Mozilla, the author of Mozilla::CA, the CPAN\nmirror where you got Mozilla::CA, the toolchain used to install it, and your operating system\nsecurity, right?)\n\nIf that module is not available, then HTTP::Tiny will search several system-specific default\nlocations for a CA certificate file:\n\n* /etc/ssl/certs/ca-certificates.crt\n\n* /etc/pki/tls/certs/ca-bundle.crt\n\n* /etc/ssl/ca-bundle.pem\n\nAn exception will be raised if \"verifySSL\" is true and no CA certificate file is available.\n\nIf you desire complete control over SSL connections, the \"SSLoptions\" attribute lets you\nprovide a hash reference that will be passed through to \"IO::Socket::SSL::startSSL()\",\noverriding any options set by HTTP::Tiny. For example, to provide your own trusted CA file:\n\nSSLoptions => {\nSSLcafile => $filepath,\n}\n\nThe \"SSLoptions\" attribute could also be used for such things as providing a client certificate\nfor authentication to a server or controlling the choice of cipher used for the SSL connection.\nSee IO::Socket::SSL documentation for details.\n", "subsections": [] }, "PROXY SUPPORT": { "content": "HTTP::Tiny can proxy both \"http\" and \"https\" requests. Only Basic proxy authorization is\nsupported and it must be provided as part of the proxy URL:\n\"http://user:pass@proxy.example.com/\".\n\nHTTP::Tiny supports the following proxy environment variables:\n\n* httpproxy or HTTPPROXY\n\n* httpsproxy or HTTPSPROXY\n\n* allproxy or ALLPROXY\n\nIf the \"REQUESTMETHOD\" environment variable is set, then this might be a CGI process and\n\"HTTPPROXY\" would be set from the \"Proxy:\" header, which is a security risk. If\n\"REQUESTMETHOD\" is set, \"HTTPPROXY\" (the upper case variant only) is ignored.\n\nTunnelling \"https\" over an \"http\" proxy using the CONNECT method is supported. If your proxy\nuses \"https\" itself, you can not tunnel \"https\" over it.\n\nBe warned that proxying an \"https\" connection opens you to the risk of a man-in-the-middle\nattack by the proxy server.\n\nThe \"noproxy\" environment variable is supported in the format of a comma-separated list of\ndomain extensions proxy should not be used for.\n\nProxy arguments passed to \"new\" will override their corresponding environment variables.\n", "subsections": [] }, "LIMITATIONS": { "content": "HTTP::Tiny is *conditionally compliant* with the HTTP/1.1 specifications\n:\n\n* \"Message Syntax and Routing\" [RFC7230]\n\n* \"Semantics and Content\" [RFC7231]\n\n* \"Conditional Requests\" [RFC7232]\n\n* \"Range Requests\" [RFC7233]\n\n* \"Caching\" [RFC7234]\n\n* \"Authentication\" [RFC7235]\n\nIt attempts to meet all \"MUST\" requirements of the specification, but does not implement all\n\"SHOULD\" requirements. (Note: it was developed against the earlier RFC 2616 specification and\nmay not yet meet the revised RFC 7230-7235 spec.)\n\nSome particular limitations of note include:\n\n* HTTP::Tiny focuses on correct transport. Users are responsible for ensuring that\nuser-defined headers and content are compliant with the HTTP/1.1 specification.\n\n* Users must ensure that URLs are properly escaped for unsafe characters and that\ninternational domain names are properly encoded to ASCII. See URI::Escape, URI::punycode\nand Net::IDN::Encode.\n\n* Redirection is very strict against the specification. Redirection is only automatic for\nresponse codes 301, 302, 307 and 308 if the request method is 'GET' or 'HEAD'. Response code\n303 is always converted into a 'GET' redirection, as mandated by the specification. There is\nno automatic support for status 305 (\"Use proxy\") redirections.\n\n* There is no provision for delaying a request body using an \"Expect\" header. Unexpected \"1XX\"\nresponses are silently ignored as per the specification.\n\n* Only 'chunked' \"Transfer-Encoding\" is supported.\n\n* There is no support for a Request-URI of '*' for the 'OPTIONS' request.\n\n* Headers mentioned in the RFCs and some other, well-known headers are generated with their\ncanonical case. Other headers are sent in the case provided by the user. Except for control\nheaders (which are sent first), headers are sent in arbitrary order.\n\nDespite the limitations listed above, HTTP::Tiny is considered feature-complete. New feature\nrequests should be directed to HTTP::Tiny::UA.\n", "subsections": [] }, "SEE ALSO": { "content": "* HTTP::Tiny::UA - Higher level UA features for HTTP::Tiny\n\n* HTTP::Thin - HTTP::Tiny wrapper with HTTP::Request/HTTP::Response compatibility\n\n* HTTP::Tiny::Mech - Wrap WWW::Mechanize instance in HTTP::Tiny compatible interface\n\n* IO::Socket::IP - Required for IPv6 support\n\n* IO::Socket::SSL - Required for SSL support\n\n* LWP::UserAgent - If HTTP::Tiny isn't enough for you, this is the \"standard\" way to do things\n\n* Mozilla::CA - Required if you want to validate SSL certificates\n\n* Net::SSLeay - Required for SSL support\n", "subsections": [] }, "SUPPORT": { "content": "Bugs / Feature Requests\nPlease report any bugs or feature requests through the issue tracker at\n. You will be notified automatically of any\nprogress on your issue.\n", "subsections": [ { "name": "Source Code", "content": "This is open source software. The code repository is available for public review and\ncontribution under the terms of the license.\n\n\n\ngit clone https://github.com/chansen/p5-http-tiny.git\n" } ] }, "AUTHORS": { "content": "* Christian Hansen \n\n* David Golden \n", "subsections": [] }, "CONTRIBUTORS": { "content": "* Alan Gardner \n\n* Alessandro Ghedini \n\n* A. Sinan Unur \n\n* Brad Gilbert \n\n* brian m. carlson \n\n* Chris Nehren \n\n* Chris Weyl \n\n* Claes Jakobsson \n\n* Clinton Gormley \n\n* Craig A. Berry \n\n* Craig Berry \n\n* David Golden \n\n* David Mitchell \n\n* Dean Pearce \n\n* Edward Zborowski \n\n* Felipe Gasper \n\n* James Raspass \n\n* Jeremy Mates \n\n* Jess Robinson \n\n* Karen Etheridge \n\n* Lukas Eklund \n\n* Martin J. Evans \n\n* Martin-Louis Bright \n\n* Mike Doherty \n\n* Nicolas Rochelemagne \n\n* Olaf Alders \n\n* Olivier Mengué \n\n* Petr Písař \n\n* Serguei Trouchelle \n\n* Shoichi Kaji \n\n* SkyMarshal \n\n* Sören Kornetzki \n\n* Steve Grazzini \n\n* Syohei YOSHIDA \n\n* Tatsuhiko Miyagawa \n\n* Tom Hukins \n\n* Tony Cook \n", "subsections": [] }, "COPYRIGHT AND LICENSE": { "content": "This software is copyright (c) 2018 by Christian Hansen.\n\nThis is free software; you can redistribute it and/or modify it under the same terms as the Perl\n5 programming language system itself.\n", "subsections": [] } } } }