aboutsummaryrefslogtreecommitdiff
path: root/includes/vendor/rmccue/requests/README.md
diff options
context:
space:
mode:
authors1n <[email protected]>2020-03-28 10:36:41 -0700
committers1n <[email protected]>2020-03-28 10:36:41 -0700
commit25b7d2aab61ae6421398d3abae5da6ffe590333d (patch)
tree611985ec78bb2d94099c9fd5dd687f5c9cee6f3e /includes/vendor/rmccue/requests/README.md
parentInitial commit (diff)
downloadcrack.cf-backup-master.tar.xz
crack.cf-backup-master.zip
3/28/2020, 10:36HEADmaster
Diffstat (limited to 'includes/vendor/rmccue/requests/README.md')
-rw-r--r--includes/vendor/rmccue/requests/README.md152
1 files changed, 152 insertions, 0 deletions
diff --git a/includes/vendor/rmccue/requests/README.md b/includes/vendor/rmccue/requests/README.md
new file mode 100644
index 0000000..8e99a20
--- /dev/null
+++ b/includes/vendor/rmccue/requests/README.md
@@ -0,0 +1,152 @@
+Requests for PHP
+================
+
+[![Build Status](https://travis-ci.org/rmccue/Requests.svg?branch=master)](https://travis-ci.org/rmccue/Requests)
+[![codecov.io](http://codecov.io/github/rmccue/Requests/coverage.svg?branch=master)](http://codecov.io/github/rmccue/Requests?branch=master)
+
+Requests is a HTTP library written in PHP, for human beings. It is roughly
+based on the API from the excellent [Requests Python
+library](http://python-requests.org/). Requests is [ISC
+Licensed](https://github.com/rmccue/Requests/blob/master/LICENSE) (similar to
+the new BSD license) and has no dependencies, except for PHP 5.2+.
+
+Despite PHP's use as a language for the web, its tools for sending HTTP requests
+are severely lacking. cURL has an
+[interesting API](http://php.net/manual/en/function.curl-setopt.php), to say the
+least, and you can't always rely on it being available. Sockets provide only low
+level access, and require you to build most of the HTTP response parsing
+yourself.
+
+We all have better things to do. That's why Requests was born.
+
+```php
+$headers = array('Accept' => 'application/json');
+$options = array('auth' => array('user', 'pass'));
+$request = Requests::get('https://api.github.com/gists', $headers, $options);
+
+var_dump($request->status_code);
+// int(200)
+
+var_dump($request->headers['content-type']);
+// string(31) "application/json; charset=utf-8"
+
+var_dump($request->body);
+// string(26891) "[...]"
+```
+
+Requests allows you to send **HEAD**, **GET**, **POST**, **PUT**, **DELETE**,
+and **PATCH** HTTP requests. You can add headers, form data, multipart files,
+and parameters with simple arrays, and access the response data in the same way.
+Requests uses cURL and fsockopen, depending on what your system has available,
+but abstracts all the nasty stuff out of your way, providing a consistent API.
+
+
+Features
+--------
+
+- International Domains and URLs
+- Browser-style SSL Verification
+- Basic/Digest Authentication
+- Automatic Decompression
+- Connection Timeouts
+
+
+Installation
+------------
+
+### Install with Composer
+If you're using [Composer](https://github.com/composer/composer) to manage
+dependencies, you can add Requests with it.
+
+```sh
+composer require rmccue/requests
+```
+
+or
+
+ {
+ "require": {
+ "rmccue/requests": ">=1.0"
+ }
+ }
+
+### Install source from GitHub
+To install the source code:
+
+ $ git clone git://github.com/rmccue/Requests.git
+
+And include it in your scripts:
+
+ require_once '/path/to/Requests/library/Requests.php';
+
+You'll probably also want to register an autoloader:
+
+ Requests::register_autoloader();
+
+
+### Install source from zip/tarball
+Alternatively, you can fetch a [tarball][] or [zipball][]:
+
+ $ curl -L https://github.com/rmccue/Requests/tarball/master | tar xzv
+ (or)
+ $ wget https://github.com/rmccue/Requests/tarball/master -O - | tar xzv
+
+[tarball]: https://github.com/rmccue/Requests/tarball/master
+[zipball]: https://github.com/rmccue/Requests/zipball/master
+
+
+### Using a Class Loader
+If you're using a class loader (e.g., [Symfony Class Loader][]) for
+[PSR-0][]-style class loading:
+
+ $loader->registerPrefix('Requests', 'path/to/vendor/Requests/library');
+
+[Symfony Class Loader]: https://github.com/symfony/ClassLoader
+[PSR-0]: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md
+
+
+Documentation
+-------------
+The best place to start is our [prose-based documentation][], which will guide
+you through using Requests.
+
+After that, take a look at [the documentation for
+`Requests::request()`][request_method], where all the parameters are fully
+documented.
+
+Requests is [100% documented with PHPDoc](http://requests.ryanmccue.info/api/).
+If you find any problems with it, [create a new
+issue](https://github.com/rmccue/Requests/issues/new)!
+
+[prose-based documentation]: https://github.com/rmccue/Requests/blob/master/docs/README.md
+[request_method]: http://requests.ryanmccue.info/api/class-Requests.html#_request
+
+Testing
+-------
+
+Requests strives to have 100% code-coverage of the library with an extensive
+set of tests. We're not quite there yet, but [we're getting close][codecov].
+
+[codecov]: http://codecov.io/github/rmccue/Requests
+
+To run the test suite, first check that you have the [PHP
+JSON extension ](http://php.net/manual/en/book.json.php) enabled. Then
+simply:
+
+ $ cd tests
+ $ phpunit
+
+If you'd like to run a single set of tests, specify just the name:
+
+ $ phpunit Transport/cURL
+
+Contribute
+----------
+
+1. Check for open issues or open a new issue for a feature request or a bug
+2. Fork [the repository][] on Github to start making your changes to the
+ `master` branch (or branch off of it)
+3. Write a test which shows that the bug was fixed or that the feature works as expected
+4. Send a pull request and bug me until I merge it
+
+[the repository]: https://github.com/rmccue/Requests