Compare commits
71 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d5a7ad40bd | ||
|
|
8af870ff69 | ||
|
|
ae01978eb3 | ||
|
|
2074abf904 | ||
|
|
96cdf61101 | ||
|
|
002c175cd1 | ||
|
|
c5be546d1b | ||
|
|
5fa02336f9 | ||
|
|
23c3cb5b00 | ||
|
|
8ce5204c37 | ||
|
|
90be29ced4 | ||
|
|
8dcb11e0a6 | ||
|
|
3591292c3e | ||
|
|
3ec25a5d17 | ||
|
|
fbe66400fc | ||
|
|
f68939375b | ||
|
|
ba25e0304a | ||
|
|
3bb82974cc | ||
|
|
3eb8536d3d | ||
|
|
4762858017 | ||
|
|
7404fca828 | ||
|
|
1dfcade505 | ||
|
|
976247358b | ||
|
|
a58c5592d5 | ||
|
|
3ffe191c1c | ||
|
|
d7d9c35696 | ||
|
|
9461d6664c | ||
|
|
d188bcbd15 | ||
|
|
1ad47092de | ||
|
|
bcc2a3bc19 | ||
|
|
aff17227d4 | ||
|
|
eaaca57797 | ||
|
|
e6f9dc1d01 | ||
|
|
9a67f24f34 | ||
|
|
2a07cffe54 | ||
|
|
0b29426d7f | ||
|
|
c1018cc344 | ||
|
|
4f156e59fd | ||
|
|
be9bca1d5a | ||
|
|
ed2a2df982 | ||
|
|
7a6df4cb82 | ||
|
|
34db4e958f | ||
|
|
2bbafd950d | ||
|
|
601c20c6ca | ||
|
|
b4b4b85a69 | ||
|
|
f0b84f49ca | ||
|
|
2279d98f6a | ||
|
|
fe8591361b | ||
|
|
87f5c54308 | ||
|
|
eccbc76469 | ||
|
|
d004129842 | ||
|
|
97f51e1269 | ||
|
|
ed76b17884 | ||
|
|
8ee4ba0753 | ||
|
|
dd9edca044 | ||
|
|
814cee98fc | ||
|
|
07aa7ab19f | ||
|
|
c7b73c8316 | ||
|
|
b6efa7e1cc | ||
|
|
6347fa33ee | ||
|
|
cda471ebdb | ||
|
|
61eb281692 | ||
|
|
ea3995225c | ||
|
|
4e68b0efab | ||
|
|
9465a4656a | ||
|
|
2d4f23af38 | ||
|
|
2bd214f2d9 | ||
|
|
6e615557cc | ||
|
|
e362fe01ec | ||
|
|
461060202c | ||
|
|
8020af6f71 |
16
.editorconfig
Normal file
16
.editorconfig
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
# http://editorconfig.org
|
||||||
|
root = true
|
||||||
|
|
||||||
|
[*]
|
||||||
|
indent_style = space
|
||||||
|
indent_size = 4
|
||||||
|
end_of_line = lf
|
||||||
|
charset = utf-8
|
||||||
|
trim_trailing_whitespace = true
|
||||||
|
insert_final_newline = true
|
||||||
|
|
||||||
|
[*.{json,xml,yml}]
|
||||||
|
indent_size = 2
|
||||||
|
|
||||||
|
[*.{md,yml}]
|
||||||
|
trim_trailing_whitespace = false
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,4 +1,5 @@
|
|||||||
.DS_Store
|
.DS_Store
|
||||||
/vendor
|
build
|
||||||
|
vendor
|
||||||
composer.lock
|
composer.lock
|
||||||
composer.phar
|
composer.phar
|
||||||
23
.travis.yml
23
.travis.yml
@@ -1,11 +1,28 @@
|
|||||||
language: php
|
language: php
|
||||||
|
|
||||||
php:
|
php:
|
||||||
- 5.3
|
|
||||||
- 5.4
|
- 5.4
|
||||||
- 5.5
|
- 5.5
|
||||||
|
- 5.6
|
||||||
|
- hhvm
|
||||||
|
|
||||||
before_script:
|
before_script:
|
||||||
- sh -c "if [ '$TRAVIS_PHP_VERSION' = '5.2' ]; then wget http://iweb.dl.sourceforge.net/project/simpletest/simpletest/simpletest_1.1/simpletest_1.1.0.tar.gz; tar xf simpletest_1.1.0.tar.gz -C test; else composer install --dev --prefer-source; fi"
|
- composer selfupdate
|
||||||
|
- composer install
|
||||||
|
|
||||||
script: php test/Unirest.php
|
after_script:
|
||||||
|
- vendor/bin/test-reporter --stdout > codeclimate.json
|
||||||
|
- "curl -X POST -d @codeclimate.json -H 'Content-Type: application/json' -H 'User-Agent: Code Climate (PHP Test Reporter v0.1.1)' https://codeclimate.com/test_reports"
|
||||||
|
|
||||||
|
notifications:
|
||||||
|
webhooks:
|
||||||
|
urls:
|
||||||
|
- https://webhooks.gitter.im/e/802f417bb6e3e1e8b20d
|
||||||
|
on_success: always
|
||||||
|
on_failure: always
|
||||||
|
on_start: false
|
||||||
|
|
||||||
|
matrix:
|
||||||
|
fast_finish: true
|
||||||
|
allow_failures:
|
||||||
|
- php: hhvm
|
||||||
|
|||||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
|||||||
The MIT License
|
The MIT License
|
||||||
|
|
||||||
Copyright (c) 2013 Mashape (http://mashape.com)
|
Copyright (c) 2013-2015 Mashape (https://www.mashape.com)
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
Permission is hereby granted, free of charge, to any person obtaining
|
||||||
a copy of this software and associated documentation files (the
|
a copy of this software and associated documentation files (the
|
||||||
|
|||||||
292
README.md
292
README.md
@@ -1,118 +1,179 @@
|
|||||||
<hr>
|
# Unirest for PHP [![Build Status][travis-image]][travis-url] [![version][packagist-version]][packagist-url]
|
||||||
**To the community**: At this time Unirest-PHP only support syncronous requests, and I would really love to implement asynchronous support. If you guys have any feedback or ideas please comment on issue <a href="https://github.com/Mashape/unirest-php/issues/23">#23</a>.
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
# Unirest for PHP [](https://travis-ci.org/Mashape/unirest-php)
|
[![Downloads][packagist-downloads]][packagist-url]
|
||||||
|
[![Code Climate][codeclimate-quality]][codeclimate-url]
|
||||||
|
[![Coverage Status][codeclimate-coverage]][codeclimate-url]
|
||||||
|
[![Dependencies][versioneye-image]][versioneye-url]
|
||||||
|
[![Gitter][gitter-image]][gitter-url]
|
||||||
|
[![License][packagist-license]][license-url]
|
||||||
|
|
||||||
Unirest is a set of lightweight HTTP libraries available in multiple languages, ideal for most applications:
|
Unirest is a set of lightweight HTTP libraries available in [multiple languages](http://unirest.io).
|
||||||
|
|
||||||
* Make `GET`, `POST`, `PUT`, `PATCH`, `DELETE` requests
|
## Features
|
||||||
* It supports form parameters, file uploads and custom body entities
|
|
||||||
|
* Utility methods to call `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` requests
|
||||||
|
* Supports form parameters, file uploads and custom body entities
|
||||||
* Supports gzip
|
* Supports gzip
|
||||||
* Supports Basic Authentication natively
|
* Supports Basic, Digest, Negotiate, NTLM Authentication natively
|
||||||
* Customizable timeout
|
* Customizable timeout
|
||||||
* Customizable default headers for every request (DRY)
|
* Customizable default headers for every request (DRY)
|
||||||
* Automatic JSON parsing into a native object for JSON responses
|
* Automatic JSON parsing into a native object for JSON responses
|
||||||
|
|
||||||
Created with love by [thefosk](https://github.com/thefosk) @ [mashape.com](https://mashape.com)
|
## Requirements
|
||||||
|
|
||||||
### Install with Composer
|
- [cURL](http://php.net/manual/en/book.curl.php)
|
||||||
If you're using [Composer](https://github.com/composer/composer) to manage
|
|
||||||
dependencies, you can add Unirest with it.
|
|
||||||
|
|
||||||
```javascript
|
## Installation
|
||||||
|
|
||||||
|
### Using [Composer](https://getcomposer.org)
|
||||||
|
|
||||||
|
To install unirest-php with Composer, just add the following to your `composer.json` file:
|
||||||
|
|
||||||
|
```json
|
||||||
{
|
{
|
||||||
"require" : {
|
"require-dev": {
|
||||||
"mashape/unirest-php" : "dev-master"
|
"mashape/unirest-php": "2.*"
|
||||||
},
|
}
|
||||||
"autoload": {
|
|
||||||
"psr-0": {"Unirest": "lib/"}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Install source from GitHub
|
or by running the following command:
|
||||||
Unirest-PHP requires PHP `v5.3+`. Download the PHP library from Github, and require in your script like so:
|
|
||||||
|
|
||||||
To install the source code:
|
```shell
|
||||||
|
composer require mashape/unirest-php
|
||||||
```bash
|
|
||||||
$ git clone git@github.com:Mashape/unirest-php.git
|
|
||||||
```
|
```
|
||||||
|
|
||||||
And include it in your scripts:
|
This will get you the latest version of the reporter and install it. If you do want the master, untagged, version you may use the command below:
|
||||||
|
|
||||||
```bash
|
```shell
|
||||||
require_once '/path/to/unirest-php/lib/Unirest.php';
|
composer require mashape/php-test-reporter:@dev-master
|
||||||
```
|
```
|
||||||
|
|
||||||
## Creating Request
|
Composer installs autoloader at `./vendor/autoloader.php`. to include the library in your script, add:
|
||||||
|
|
||||||
|
```php
|
||||||
|
require_once 'vendor/autoload.php';
|
||||||
|
```
|
||||||
|
|
||||||
|
If you use Symfony2, autoloader has to be detected automatically.
|
||||||
|
|
||||||
|
*You can see this library on [Packagist](https://packagist.org/packages/mashape/unirest-php).*
|
||||||
|
|
||||||
|
### Install from source
|
||||||
|
|
||||||
|
Unirest-PHP requires PHP `v5.4+`. Download the PHP library from Github, then include `Unirest.php` in your script:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
git clone git@github.com:Mashape/unirest-php.git
|
||||||
|
```
|
||||||
|
|
||||||
|
```php
|
||||||
|
require_once '/path/to/unirest-php/src/Unirest.php';
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Creating a Request
|
||||||
|
|
||||||
So you're probably wondering how using Unirest makes creating requests in PHP easier, let's look at a working example:
|
So you're probably wondering how using Unirest makes creating requests in PHP easier, let's look at a working example:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
$response = Unirest::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
|
$headers = array("Accept" => "application/json");
|
||||||
array(
|
$body = array("foo" => "hellow", "bar" => "world");
|
||||||
"parameter" => 23,
|
|
||||||
"foo" => "bar"
|
|
||||||
)
|
|
||||||
);
|
|
||||||
|
|
||||||
$response->code; // HTTP Status code
|
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body);
|
||||||
$response->headers; // Headers
|
|
||||||
$response->body; // Parsed body
|
$response->code; // HTTP Status code
|
||||||
$response->raw_body; // Unparsed body
|
$response->headers; // Headers
|
||||||
|
$response->body; // Parsed body
|
||||||
|
$response->raw_body; // Unparsed body
|
||||||
```
|
```
|
||||||
|
|
||||||
### File Uploads
|
### File Uploads
|
||||||
|
|
||||||
To upload files in a multipart form representation use the return value of `Unirest::file($path)` as the value of a parameter:
|
To upload files in a multipart form representation use the return value of `Unirest\File::add($path)` as the value of a parameter:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
$response = Unirest::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
|
$headers = array("Accept" => "application/json");
|
||||||
array(
|
$body = array("file" => Unirest\File::add("/tmp/file.txt"));
|
||||||
"file" => Unirest::file("/tmp/file.txt") // Tells Unirest where the file is located
|
|
||||||
)
|
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body);
|
||||||
);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Custom Entity Body
|
### Custom Entity Body
|
||||||
|
|
||||||
Sending a custom body such as a JSON Object rather than a string or form style parameters we utilize json_encode for the body:
|
Sending a custom body such as a JSON Object rather than a string or form style parameters we utilize json_encode for the body:
|
||||||
```php
|
```php
|
||||||
$response = Unirest::post("http://httpbin.org/post", array( "Accept" => "application/json" ),
|
$headers = array("Accept" => "application/json");
|
||||||
json_encode(
|
$body = json_encode(array("foo" => "hellow", "bar" => "world"));
|
||||||
array(
|
|
||||||
"parameter" => "value",
|
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body);
|
||||||
"foo" => "bar"
|
|
||||||
)
|
|
||||||
)
|
|
||||||
);
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Basic Authentication
|
### Authentication
|
||||||
|
|
||||||
Authenticating the request with basic authentication can be done by providing the `username` and `password` arguments:
|
Passing a username, password *(optional)*, defaults to Basic Authentication:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
$response = Unirest::get("http://httpbin.org/get", null, null, "username", "password");
|
// basic auth
|
||||||
|
Unirest\Request::auth('username', 'password');
|
||||||
```
|
```
|
||||||
|
|
||||||
# Request
|
The third parameter, which is a bitmask, will Unirest which HTTP authentication method(s) you want it to use for your proxy authentication.
|
||||||
|
|
||||||
|
If more than one bit is set, Unirest *(at PHP's libcurl level)* will first query the site to see what authentication methods it supports and then pick the best one you allow it to use. *For some methods, this will induce an extra network round-trip.*
|
||||||
|
|
||||||
|
**Supported Method**
|
||||||
|
|
||||||
|
| Method | Description |
|
||||||
|
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
|
| `CURLAUTH_BASIC` | HTTP Basic authentication. This is the default choice |
|
||||||
|
| `CURLAUTH_DIGEST` | HTTP Digest authentication. as defined in [RFC 2617](http://www.ietf.org/rfc/rfc2617.txt) |
|
||||||
|
| `CURLAUTH_DIGEST_IE` | HTTP Digest authentication with an IE flavor. *The IE flavor is simply that libcurl will use a special "quirk" that IE is known to have used before version 7 and that some servers require the client to use.* |
|
||||||
|
| `CURLAUTH_NEGOTIATE` | HTTP Negotiate (SPNEGO) authentication. as defined in [RFC 4559](http://www.ietf.org/rfc/rfc4559.txt) |
|
||||||
|
| `CURLAUTH_NTLM` | HTTP NTLM authentication. A proprietary protocol invented and used by Microsoft. |
|
||||||
|
| `CURLAUTH_NTLM_WB` | NTLM delegating to winbind helper. Authentication is performed by a separate binary application. *see [libcurl docs](http://curl.haxx.se/libcurl/c/CURLOPT_HTTPAUTH.html) for more info* |
|
||||||
|
| `CURLAUTH_ANY` | This is a convenience macro that sets all bits and thus makes libcurl pick any it finds suitable. libcurl will automatically select the one it finds most secure. |
|
||||||
|
| `CURLAUTH_ANYSAFE` | This is a convenience macro that sets all bits except Basic and thus makes libcurl pick any it finds suitable. libcurl will automatically select the one it finds most secure. |
|
||||||
|
| `CURLAUTH_ONLY` | This is a meta symbol. OR this value together with a single specific auth value to force libcurl to probe for un-restricted auth and if not, only that single auth algorithm is acceptable. |
|
||||||
|
|
||||||
```php
|
```php
|
||||||
Unirest::get($url, $headers = array(), $parameters = NULL, $username = NULL, $password = NULL)
|
// custom auth method
|
||||||
Unirest::post($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
Unirest\Request::proxyAuth('username', 'password', CURLAUTH_DIGEST);
|
||||||
Unirest::put($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
```
|
||||||
Unirest::patch($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
|
||||||
Unirest::delete($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
Previous versions of **Unirest** support *Basic Authentication* by providing the `username` and `password` arguments:
|
||||||
|
|
||||||
|
```php
|
||||||
|
$response = Unirest\Request::get("http://httpbin.org/get", null, null, "username", "password");
|
||||||
|
```
|
||||||
|
|
||||||
|
**This has been deprecated, and will be completely removed in `v.3.0.0` please use the `Unirest\Request::auth()` method instead**
|
||||||
|
|
||||||
|
### Request Object
|
||||||
|
|
||||||
|
```php
|
||||||
|
Unirest\Request::get($url, $headers = array(), $parameters = null)
|
||||||
|
Unirest\Request::post($url, $headers = array(), $body = null)
|
||||||
|
Unirest\Request::put($url, $headers = array(), $body = null)
|
||||||
|
Unirest\Request::patch($url, $headers = array(), $body = null)
|
||||||
|
Unirest\Request::delete($url, $headers = array(), $body = null)
|
||||||
```
|
```
|
||||||
|
|
||||||
- `url` - Endpoint, address, or uri to be acted upon and requested information from.
|
- `url` - Endpoint, address, or uri to be acted upon and requested information from.
|
||||||
- `headers` - Request Headers as associative array or object
|
- `headers` - Request Headers as associative array or object
|
||||||
- `body` - Request Body as associative array or object
|
- `body` - Request Body as associative array or object
|
||||||
- `username` - Basic Authentication username
|
|
||||||
- `password` - Basic Authentication password
|
|
||||||
|
|
||||||
# Response
|
You can send a request with any [standard](http://www.iana.org/assignments/http-methods/http-methods.xhtml) or custom HTTP Method:
|
||||||
|
|
||||||
|
```php
|
||||||
|
Unirest\Request::send(Unirest\Method::LINK, $url, $headers = array(), $body);
|
||||||
|
|
||||||
|
Unirest\Request::send('CHECKOUT', $url, $headers = array(), $body);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Response Object
|
||||||
|
|
||||||
Upon recieving a response Unirest returns the result in the form of an Object, this object should always have the same keys for each language regarding to the response details.
|
Upon recieving a response Unirest returns the result in the form of an Object, this object should always have the same keys for each language regarding to the response details.
|
||||||
|
|
||||||
- `code` - HTTP Response Status Code (Example `200`)
|
- `code` - HTTP Response Status Code (Example `200`)
|
||||||
@@ -120,39 +181,122 @@ Upon recieving a response Unirest returns the result in the form of an Object, t
|
|||||||
- `body` - Parsed response body where applicable, for example JSON responses are parsed to Objects / Associative Arrays.
|
- `body` - Parsed response body where applicable, for example JSON responses are parsed to Objects / Associative Arrays.
|
||||||
- `raw_body` - Un-parsed response body
|
- `raw_body` - Un-parsed response body
|
||||||
|
|
||||||
# Advanced Configuration
|
### Advanced Configuration
|
||||||
|
|
||||||
You can set some advanced configuration to tune Unirest-PHP:
|
You can set some advanced configuration to tune Unirest-PHP:
|
||||||
|
|
||||||
### Timeout
|
#### Custom JSON Decode Flags
|
||||||
|
|
||||||
|
Unirest uses PHP's [JSON Extension](http://php.net/manual/en/book.json.php) for automatically decoding JSON responses.
|
||||||
|
sometime you may want to return associative arrays, limit the depth of recursion, or use any of the [customization flags](http://php.net/manual/en/json.constants.php#constant.json-hex-tag).
|
||||||
|
|
||||||
|
To do so, simply set the desired options using the `jsonOpts` request method:
|
||||||
|
|
||||||
|
```php
|
||||||
|
Unirest\Request::jsonOpts(true, 512, JSON_NUMERIC_CHECK & JSON_FORCE_OBJECT & JSON_UNESCAPED_SLASHES);
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Timeout
|
||||||
|
|
||||||
You can set a custom timeout value (in **seconds**):
|
You can set a custom timeout value (in **seconds**):
|
||||||
|
|
||||||
```php
|
```php
|
||||||
Unirest::timeout(5); // 5s timeout
|
Unirest\Request::timeout(5); // 5s timeout
|
||||||
```
|
```
|
||||||
|
|
||||||
### Default Request Headers
|
#### Proxy
|
||||||
|
|
||||||
|
Set the proxy to use for the upcoming request.
|
||||||
|
|
||||||
|
you can also set the proxy type to be one of `CURLPROXY_HTTP`, `CURLPROXY_HTTP_1_0`, `CURLPROXY_SOCKS4`, `CURLPROXY_SOCKS5`, `CURLPROXY_SOCKS4A`, and `CURLPROXY_SOCKS5_HOSTNAME`.
|
||||||
|
|
||||||
|
*check the [cURL docs](http://curl.haxx.se/libcurl/c/CURLOPT_PROXYTYPE.html) for more info*.
|
||||||
|
|
||||||
|
```php
|
||||||
|
// quick setup with default port: 1080
|
||||||
|
Unirest\Request::proxy('10.10.10.1');
|
||||||
|
|
||||||
|
// custom port and proxy type
|
||||||
|
Unirest\Request::proxy('10.10.10.1', 8080, CURLPROXY_HTTP);
|
||||||
|
|
||||||
|
// enable tunneling
|
||||||
|
Unirest\Request::proxy('10.10.10.1', 8080, CURLPROXY_HTTP, true);
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Proxy Authenticaton
|
||||||
|
|
||||||
|
Passing a username, password *(optional)*, defaults to Basic Authentication:
|
||||||
|
|
||||||
|
```php
|
||||||
|
// basic auth
|
||||||
|
Unirest\Request::proxyAuth('username', 'password');
|
||||||
|
```
|
||||||
|
|
||||||
|
The third parameter, which is a bitmask, will Unirest which HTTP authentication method(s) you want it to use for your proxy authentication.
|
||||||
|
|
||||||
|
If more than one bit is set, Unirest *(at PHP's libcurl level)* will first query the site to see what authentication methods it supports and then pick the best one you allow it to use. *For some methods, this will induce an extra network round-trip.*
|
||||||
|
|
||||||
|
See [Authentication](#authentication) for more details on methods supported.
|
||||||
|
|
||||||
|
```php
|
||||||
|
// basic auth
|
||||||
|
Unirest\Request::proxyAuth('username', 'password', CURLAUTH_DIGEST);
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Default Request Headers
|
||||||
|
|
||||||
You can set default headers that will be sent on every request:
|
You can set default headers that will be sent on every request:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
Unirest::defaultHeader("Header1", "Value1");
|
Unirest\Request::defaultHeader("Header1", "Value1");
|
||||||
Unirest::defaultHeader("Header2", "Value2");
|
Unirest\Request::defaultHeader("Header2", "Value2");
|
||||||
|
```
|
||||||
|
|
||||||
|
You can do set default headers in bulk:
|
||||||
|
|
||||||
|
```php
|
||||||
|
Unirest\Request::defaultHeaders(array(
|
||||||
|
"Header1" => "Value1",
|
||||||
|
"Header2" => "Value2"
|
||||||
|
));
|
||||||
```
|
```
|
||||||
|
|
||||||
You can clear the default headers anytime with:
|
You can clear the default headers anytime with:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
Unirest::clearDefaultHeaders();
|
Unirest\Request::clearDefaultHeaders();
|
||||||
```
|
```
|
||||||
|
|
||||||
### SSL validation
|
#### SSL validation
|
||||||
|
|
||||||
You can explicitly enable or disable SSL certificate validation when consuming an SSL protected endpoint:
|
You can explicitly enable or disable SSL certificate validation when consuming an SSL protected endpoint:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
Unirest::verifyPeer(false); // Disables SSL cert validation
|
Unirest\Request::verifyPeer(false); // Disables SSL cert validation
|
||||||
```
|
```
|
||||||
|
|
||||||
By default is `true`.
|
By default is `true`.
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
Made with ♥ from the [Mashape](https://www.mashape.com/) team
|
||||||
|
|
||||||
|
[license-url]: https://github.com/Mashape/unirest-php/blob/master/LICENSE
|
||||||
|
|
||||||
|
[gitter-url]: https://gitter.im/Mashape/unirest-php
|
||||||
|
[gitter-image]: https://img.shields.io/badge/Gitter-Join%20Chat-blue.svg?style=flat
|
||||||
|
|
||||||
|
[travis-url]: https://travis-ci.org/Mashape/unirest-php
|
||||||
|
[travis-image]: https://img.shields.io/travis/Mashape/unirest-php.svg?style=flat
|
||||||
|
|
||||||
|
[packagist-url]: https://packagist.org/packages/Mashape/unirest-php
|
||||||
|
[packagist-license]: https://img.shields.io/packagist/l/Mashape/unirest-php.svg?style=flat
|
||||||
|
[packagist-version]: https://img.shields.io/packagist/v/Mashape/unirest-php.svg?style=flat
|
||||||
|
[packagist-downloads]: https://img.shields.io/packagist/dm/Mashape/unirest-php.svg?style=flat
|
||||||
|
|
||||||
|
[codeclimate-url]: https://codeclimate.com/github/Mashape/unirest-php
|
||||||
|
[codeclimate-quality]: https://img.shields.io/codeclimate/github/Mashape/unirest-php.svg?style=flat
|
||||||
|
[codeclimate-coverage]: https://img.shields.io/codeclimate/coverage/github/Mashape/unirest-php.svg?style=flat
|
||||||
|
|
||||||
|
[versioneye-url]: https://www.versioneye.com/user/projects/54b82450050646ca5c0001f3
|
||||||
|
[versioneye-image]: https://img.shields.io/versioneye/d/user/projects/54b82450050646ca5c0001f3.svg?style=flat
|
||||||
|
|||||||
@@ -1,31 +1,26 @@
|
|||||||
{
|
{
|
||||||
"name" : "mashape/unirest-php",
|
"name": "mashape/unirest-php",
|
||||||
"description" : "Unirest PHP",
|
"description": "Unirest PHP",
|
||||||
"keywords" : ["rest", "curl", "http", "client"],
|
"keywords": ["rest", "curl", "http", "https", "client"],
|
||||||
"type" : "library",
|
"type": "library",
|
||||||
"homepage" : "https://github.com/Mashape/unirest-php",
|
"homepage": "https://github.com/Mashape/unirest-php",
|
||||||
"license" : "MIT",
|
"license": "MIT",
|
||||||
"authors" : [
|
"author": "Mashape <opensource@mashape.com> (https://www.mashape.com)",
|
||||||
{
|
"require": {
|
||||||
"name" : "Mashape",
|
"php": ">=5.4.0",
|
||||||
"email" : "support@mashape.com",
|
"ext-curl": "*",
|
||||||
"homepage" : "http://mashape.com"
|
"ext-json": "*"
|
||||||
}
|
},
|
||||||
],
|
"require-dev": {
|
||||||
"require" : {
|
"phpunit/phpunit": "~4.4",
|
||||||
"php" : ">=5.3.0",
|
"codeclimate/php-test-reporter": "0.1.*"
|
||||||
"ext-curl" : "*",
|
},
|
||||||
"ext-json" : "*"
|
"autoload": {
|
||||||
},
|
"psr-0": {
|
||||||
"require-dev": {
|
"Unirest": "src"
|
||||||
"vierbergenlars/simpletest": "*"
|
|
||||||
},
|
|
||||||
"autoload" : {
|
|
||||||
"psr-0" : {
|
|
||||||
"Unirest" : "lib"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"support" : {
|
|
||||||
"email" : "support@mashape.com"
|
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
"support": {
|
||||||
|
"email": "opensource@mashape.com"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
require(dirname(__FILE__) . '/Unirest/HttpMethod.php');
|
|
||||||
require(dirname(__FILE__) . '/Unirest/HttpResponse.php');
|
|
||||||
require(dirname(__FILE__) . '/Unirest/Unirest.php');
|
|
||||||
|
|
||||||
?>
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Unirest;
|
|
||||||
|
|
||||||
interface HttpMethod
|
|
||||||
{
|
|
||||||
|
|
||||||
const DELETE = "DELETE";
|
|
||||||
const GET = "GET";
|
|
||||||
const POST = "POST";
|
|
||||||
const PUT = "PUT";
|
|
||||||
const PATCH = "PATCH";
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,77 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace Unirest;
|
|
||||||
|
|
||||||
class HttpResponse
|
|
||||||
{
|
|
||||||
|
|
||||||
private $code;
|
|
||||||
private $raw_body;
|
|
||||||
private $body;
|
|
||||||
private $headers;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param int $code response code of the cURL request
|
|
||||||
* @param string $raw_body the raw body of the cURL response
|
|
||||||
* @param string $headers raw header string from cURL response
|
|
||||||
*/
|
|
||||||
public function __construct($code, $raw_body, $headers)
|
|
||||||
{
|
|
||||||
$this->code = $code;
|
|
||||||
$this->headers = $this->get_headers_from_curl_response($headers);
|
|
||||||
$this->raw_body = $raw_body;
|
|
||||||
$this->body = $raw_body;
|
|
||||||
$json = json_decode($raw_body);
|
|
||||||
|
|
||||||
if (json_last_error() == JSON_ERROR_NONE) {
|
|
||||||
$this->body = $json;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Return a property of the response if it exists.
|
|
||||||
* Possibilities include: code, raw_body, headers, body (if the response is json-decodable)
|
|
||||||
* @return mixed
|
|
||||||
*/
|
|
||||||
public function __get($property)
|
|
||||||
{
|
|
||||||
if (property_exists($this, $property)) {
|
|
||||||
return $this->$property;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set the properties of this object
|
|
||||||
* @param string $property the property name
|
|
||||||
* @param mixed $value the property value
|
|
||||||
*/
|
|
||||||
public function __set($property, $value)
|
|
||||||
{
|
|
||||||
if (property_exists($this, $property)) {
|
|
||||||
$this->$property = $value;
|
|
||||||
}
|
|
||||||
return $this;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Retrieve the cURL response headers from the
|
|
||||||
* header string and convert it into an array
|
|
||||||
* @param string $headers header string from cURL response
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
private function get_headers_from_curl_response($headers)
|
|
||||||
{
|
|
||||||
$headers = explode("\r\n", $headers);
|
|
||||||
array_shift($headers);
|
|
||||||
|
|
||||||
foreach ($headers as $line) {
|
|
||||||
if (strstr($line, ': ')) {
|
|
||||||
list($key, $value) = explode(': ', $line);
|
|
||||||
$result[$key] = $value;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return $result;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
@@ -1,319 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
use Unirest\HttpMethod;
|
|
||||||
use Unirest\HttpResponse;
|
|
||||||
|
|
||||||
class Unirest
|
|
||||||
{
|
|
||||||
|
|
||||||
private static $verifyPeer = true;
|
|
||||||
private static $socketTimeout = null;
|
|
||||||
private static $defaultHeaders = array();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Verify SSL peer
|
|
||||||
* @param bool $enabled enable SSL verification, by default is true
|
|
||||||
*/
|
|
||||||
public static function verifyPeer($enabled)
|
|
||||||
{
|
|
||||||
Unirest::$verifyPeer = $enabled;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set a timeout
|
|
||||||
* @param integer $seconds timeout value in seconds
|
|
||||||
*/
|
|
||||||
public static function timeout($seconds)
|
|
||||||
{
|
|
||||||
Unirest::$socketTimeout = $seconds;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Set a new default header to send on every request
|
|
||||||
* @param string $name header name
|
|
||||||
* @param string $value header value
|
|
||||||
*/
|
|
||||||
public static function defaultHeader($name, $value)
|
|
||||||
{
|
|
||||||
Unirest::$defaultHeaders[$name] = $value;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Clear all the default headers
|
|
||||||
*/
|
|
||||||
public static function clearDefaultHeaders()
|
|
||||||
{
|
|
||||||
Unirest::$defaultHeaders = array();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send a GET request to a URL
|
|
||||||
* @param string $url URL to send the GET request to
|
|
||||||
* @param array $headers additional headers to send
|
|
||||||
* @param mixed $parameters parameters to send in the querystring
|
|
||||||
* @param string $username Basic Authentication username
|
|
||||||
* @param string $password Basic Authentication password
|
|
||||||
* @return string|stdObj response string or stdObj if response is json-decodable
|
|
||||||
*/
|
|
||||||
public static function get($url, $headers = array(), $parameters = NULL, $username = NULL, $password = NULL)
|
|
||||||
{
|
|
||||||
return Unirest::request(HttpMethod::GET, $url, $parameters, $headers, $username, $password);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send POST request to a URL
|
|
||||||
* @param string $url URL to send the POST request to
|
|
||||||
* @param array $headers additional headers to send
|
|
||||||
* @param mixed $body POST body data
|
|
||||||
* @param string $username Basic Authentication username
|
|
||||||
* @param string $password Basic Authentication password
|
|
||||||
* @return string|stdObj response string or stdObj if response is json-decodable
|
|
||||||
*/
|
|
||||||
public static function post($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
|
||||||
{
|
|
||||||
return Unirest::request(HttpMethod::POST, $url, $body, $headers, $username, $password);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send DELETE request to a URL
|
|
||||||
* @param string $url URL to send the DELETE request to
|
|
||||||
* @param array $headers additional headers to send
|
|
||||||
* @param mixed $body DELETE body data
|
|
||||||
* @param string $username Basic Authentication username
|
|
||||||
* @param string $password Basic Authentication password
|
|
||||||
* @return string|stdObj response string or stdObj if response is json-decodable
|
|
||||||
*/
|
|
||||||
public static function delete($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
|
||||||
{
|
|
||||||
return Unirest::request(HttpMethod::DELETE, $url, $body, $headers, $username, $password);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send PUT request to a URL
|
|
||||||
* @param string $url URL to send the PUT request to
|
|
||||||
* @param array $headers additional headers to send
|
|
||||||
* @param mixed $body PUT body data
|
|
||||||
* @param string $username Basic Authentication username
|
|
||||||
* @param string $password Basic Authentication password
|
|
||||||
* @return string|stdObj response string or stdObj if response is json-decodable
|
|
||||||
*/
|
|
||||||
public static function put($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
|
||||||
{
|
|
||||||
return Unirest::request(HttpMethod::PUT, $url, $body, $headers, $username, $password);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send PATCH request to a URL
|
|
||||||
* @param string $url URL to send the PATCH request to
|
|
||||||
* @param array $headers additional headers to send
|
|
||||||
* @param mixed $body PATCH body data
|
|
||||||
* @param string $username Basic Authentication username
|
|
||||||
* @param string $password Basic Authentication password
|
|
||||||
* @return string|stdObj response string or stdObj if response is json-decodable
|
|
||||||
*/
|
|
||||||
public static function patch($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
|
||||||
{
|
|
||||||
return Unirest::request(HttpMethod::PATCH, $url, $body, $headers, $username, $password);
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Prepares a file for upload. To be used inside the parameters declaration for a request.
|
|
||||||
* @param string $path The file path
|
|
||||||
*/
|
|
||||||
public static function file($path)
|
|
||||||
{
|
|
||||||
if (function_exists("curl_file_create")) {
|
|
||||||
return curl_file_create($path);
|
|
||||||
} else {
|
|
||||||
return "@" . $path;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This function is useful for serializing multidimensional arrays, and avoid getting
|
|
||||||
* the "Array to string conversion" notice
|
|
||||||
*/
|
|
||||||
public static function http_build_query_for_curl($arrays, &$new = array(), $prefix = null)
|
|
||||||
{
|
|
||||||
if (is_object($arrays)) {
|
|
||||||
$arrays = get_object_vars($arrays);
|
|
||||||
}
|
|
||||||
|
|
||||||
foreach ($arrays AS $key => $value) {
|
|
||||||
$k = isset($prefix) ? $prefix . '[' . $key . ']' : $key;
|
|
||||||
if (!$value instanceof \CURLFile AND (is_array($value) OR is_object($value))) {
|
|
||||||
Unirest::http_build_query_for_curl($value, $new, $k);
|
|
||||||
} else {
|
|
||||||
$new[$k] = $value;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Send a cURL request
|
|
||||||
* @param string $httpMethod HTTP method to use (based off \Unirest\HttpMethod constants)
|
|
||||||
* @param string $url URL to send the request to
|
|
||||||
* @param mixed $body request body
|
|
||||||
* @param array $headers additional headers to send
|
|
||||||
* @param string $username Basic Authentication username
|
|
||||||
* @param string $password Basic Authentication password
|
|
||||||
* @throws Exception if a cURL error occurs
|
|
||||||
* @return HttpResponse
|
|
||||||
*/
|
|
||||||
private static function request($httpMethod, $url, $body = NULL, $headers = array(), $username = NULL, $password = NULL)
|
|
||||||
{
|
|
||||||
if ($headers == NULL)
|
|
||||||
$headers = array();
|
|
||||||
|
|
||||||
$lowercaseHeaders = array();
|
|
||||||
$finalHeaders = array_merge($headers, Unirest::$defaultHeaders);
|
|
||||||
foreach ($finalHeaders as $key => $val) {
|
|
||||||
$lowercaseHeaders[] = Unirest::getHeader($key, $val);
|
|
||||||
}
|
|
||||||
|
|
||||||
$lowerCaseFinalHeaders = array_change_key_case($finalHeaders);
|
|
||||||
if (!array_key_exists("user-agent", $lowerCaseFinalHeaders)) {
|
|
||||||
$lowercaseHeaders[] = "user-agent: unirest-php/1.1";
|
|
||||||
}
|
|
||||||
if (!array_key_exists("expect", $lowerCaseFinalHeaders)) {
|
|
||||||
$lowercaseHeaders[] = "expect:";
|
|
||||||
}
|
|
||||||
|
|
||||||
$ch = curl_init();
|
|
||||||
if ($httpMethod != HttpMethod::GET) {
|
|
||||||
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $httpMethod);
|
|
||||||
if (is_array($body) || $body instanceof Traversable) {
|
|
||||||
Unirest::http_build_query_for_curl($body, $postBody);
|
|
||||||
curl_setopt($ch, CURLOPT_POSTFIELDS, $postBody);
|
|
||||||
} else {
|
|
||||||
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
|
|
||||||
}
|
|
||||||
} else if (is_array($body)) {
|
|
||||||
if (strpos($url, '?') !== false) {
|
|
||||||
$url .= "&";
|
|
||||||
} else {
|
|
||||||
$url .= "?";
|
|
||||||
}
|
|
||||||
Unirest::http_build_query_for_curl($body, $postBody);
|
|
||||||
$url .= urldecode(http_build_query($postBody));
|
|
||||||
}
|
|
||||||
|
|
||||||
curl_setopt($ch, CURLOPT_URL, Unirest::encodeUrl($url));
|
|
||||||
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
|
|
||||||
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
|
|
||||||
curl_setopt($ch, CURLOPT_MAXREDIRS, 10);
|
|
||||||
curl_setopt($ch, CURLOPT_HTTPHEADER, $lowercaseHeaders);
|
|
||||||
curl_setopt($ch, CURLOPT_HEADER, true);
|
|
||||||
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, Unirest::$verifyPeer);
|
|
||||||
curl_setopt($ch, CURLOPT_ENCODING, ""); // If an empty string, "", is set, a header containing all supported encoding types is sent.
|
|
||||||
if (Unirest::$socketTimeout != null) {
|
|
||||||
curl_setopt($ch, CURLOPT_TIMEOUT, Unirest::$socketTimeout);
|
|
||||||
}
|
|
||||||
if (!empty($username)) {
|
|
||||||
curl_setopt($ch, CURLOPT_USERPWD, $username . ":" . ((empty($password)) ? "" : $password));
|
|
||||||
}
|
|
||||||
|
|
||||||
$response = curl_exec($ch);
|
|
||||||
$error = curl_error($ch);
|
|
||||||
if ($error) {
|
|
||||||
throw new Exception($error);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Split the full response in its headers and body
|
|
||||||
$curl_info = curl_getinfo($ch);
|
|
||||||
$header_size = $curl_info["header_size"];
|
|
||||||
$header = substr($response, 0, $header_size);
|
|
||||||
$body = substr($response, $header_size);
|
|
||||||
$httpCode = $curl_info["http_code"];
|
|
||||||
|
|
||||||
return new HttpResponse($httpCode, $body, $header);
|
|
||||||
}
|
|
||||||
|
|
||||||
private static function getArrayFromQuerystring($querystring)
|
|
||||||
{
|
|
||||||
$pairs = explode("&", $querystring);
|
|
||||||
$vars = array();
|
|
||||||
foreach ($pairs as $pair) {
|
|
||||||
$nv = explode("=", $pair, 2);
|
|
||||||
$name = $nv[0];
|
|
||||||
$value = $nv[1];
|
|
||||||
$vars[$name] = $value;
|
|
||||||
}
|
|
||||||
return $vars;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Ensure that a URL is encoded and safe to use with cURL
|
|
||||||
* @param string $url URL to encode
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
private static function encodeUrl($url)
|
|
||||||
{
|
|
||||||
$url_parsed = parse_url($url);
|
|
||||||
|
|
||||||
$scheme = $url_parsed['scheme'] . '://';
|
|
||||||
$host = $url_parsed['host'];
|
|
||||||
$port = (isset($url_parsed['port']) ? $url_parsed['port'] : null);
|
|
||||||
$path = (isset($url_parsed['path']) ? $url_parsed['path'] : null);
|
|
||||||
$query = (isset($url_parsed['query']) ? $url_parsed['query'] : null);
|
|
||||||
|
|
||||||
if ($query != null) {
|
|
||||||
$query = '?' . http_build_query(Unirest::getArrayFromQuerystring($url_parsed['query']));
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($port && $port[0] != ":")
|
|
||||||
$port = ":" . $port;
|
|
||||||
|
|
||||||
$result = $scheme . $host . $port . $path . $query;
|
|
||||||
return $result;
|
|
||||||
}
|
|
||||||
|
|
||||||
private static function getHeader($key, $val)
|
|
||||||
{
|
|
||||||
$key = trim(strtolower($key));
|
|
||||||
return $key . ": " . $val;
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!function_exists('http_chunked_decode')) {
|
|
||||||
/**
|
|
||||||
* Dechunk an http 'transfer-encoding: chunked' message
|
|
||||||
* @param string $chunk the encoded message
|
|
||||||
* @return string the decoded message
|
|
||||||
*/
|
|
||||||
function http_chunked_decode($chunk)
|
|
||||||
{
|
|
||||||
$pos = 0;
|
|
||||||
$len = strlen($chunk);
|
|
||||||
$dechunk = null;
|
|
||||||
|
|
||||||
while (($pos < $len) && ($chunkLenHex = substr($chunk, $pos, ($newlineAt = strpos($chunk, "\n", $pos + 1)) - $pos))) {
|
|
||||||
|
|
||||||
if (!is_hex($chunkLenHex)) {
|
|
||||||
trigger_error('Value is not properly chunk encoded', E_USER_WARNING);
|
|
||||||
return $chunk;
|
|
||||||
}
|
|
||||||
|
|
||||||
$pos = $newlineAt + 1;
|
|
||||||
$chunkLen = hexdec(rtrim($chunkLenHex, "\r\n"));
|
|
||||||
$dechunk .= substr($chunk, $pos, $chunkLen);
|
|
||||||
$pos = strpos($chunk, "\n", $pos + $chunkLen) + 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
return $dechunk;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* determine if a string can represent a number in hexadecimal
|
|
||||||
* @link http://uk1.php.net/ctype_xdigit
|
|
||||||
* @param string $hex
|
|
||||||
* @return boolean true if the string is a hex, otherwise false
|
|
||||||
*/
|
|
||||||
function is_hex($hex)
|
|
||||||
{
|
|
||||||
return ctype_xdigit($hex);
|
|
||||||
}
|
|
||||||
|
|
||||||
?>
|
|
||||||
16
phpunit.xml
Normal file
16
phpunit.xml
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<phpunit bootstrap="tests/bootstrap.php" colors="true">
|
||||||
|
<logging>
|
||||||
|
<log type="coverage-clover" target="build/logs/clover.xml"/>
|
||||||
|
</logging>
|
||||||
|
|
||||||
|
<testsuites>
|
||||||
|
<testsuite name="Unirest Test Suite">
|
||||||
|
<directory>./tests</directory>
|
||||||
|
</testsuite>
|
||||||
|
</testsuites>
|
||||||
|
|
||||||
|
<php>
|
||||||
|
<ini name="date.timezone" value="UTC"/>
|
||||||
|
</php>
|
||||||
|
</phpunit>
|
||||||
6
src/Unirest.php
Normal file
6
src/Unirest.php
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
require_once dirname(__FILE__) . '/Unirest/File.php';
|
||||||
|
require_once dirname(__FILE__) . '/Unirest/Method.php';
|
||||||
|
require_once dirname(__FILE__) . '/Unirest/Response.php';
|
||||||
|
require_once dirname(__FILE__) . '/Unirest/Request.php';
|
||||||
19
src/Unirest/File.php
Normal file
19
src/Unirest/File.php
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Unirest;
|
||||||
|
|
||||||
|
class File
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* Prepares a file for upload. To be used inside the parameters declaration for a request.
|
||||||
|
* @param string $path The file path
|
||||||
|
*/
|
||||||
|
public static function add($filename, $mimetype = '', $postname = '')
|
||||||
|
{
|
||||||
|
if (function_exists('curl_file_create')) {
|
||||||
|
return curl_file_create($filename, $mimetype = '', $postname = '');
|
||||||
|
} else {
|
||||||
|
return sprintf('@%s;filename=%s;type=%s', $filename, $postname ?: basename($filename), $mimetype);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
75
src/Unirest/Method.php
Normal file
75
src/Unirest/Method.php
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Hypertext Transfer Protocol (HTTP) Method Registry
|
||||||
|
*
|
||||||
|
* http://www.iana.org/assignments/http-methods/http-methods.xhtml
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Unirest;
|
||||||
|
|
||||||
|
interface Method
|
||||||
|
{
|
||||||
|
// RFC7231
|
||||||
|
const GET = 'GET';
|
||||||
|
const HEAD = 'HEAD';
|
||||||
|
const POST = 'POST';
|
||||||
|
const PUT = 'PUT';
|
||||||
|
const DELETE = 'DELETE';
|
||||||
|
const CONNECT = 'CONNECT';
|
||||||
|
const OPTIONS = 'OPTIONS';
|
||||||
|
const TRACE = 'TRACE';
|
||||||
|
|
||||||
|
// RFC3253
|
||||||
|
const BASELINE = 'BASELINE';
|
||||||
|
|
||||||
|
// RFC2068
|
||||||
|
const LINK = 'LINK';
|
||||||
|
const UNLINK = 'UNLINK';
|
||||||
|
|
||||||
|
// RFC3253
|
||||||
|
const MERGE = 'MERGE';
|
||||||
|
const BASELINECONTROL = 'BASELINE-CONTROL';
|
||||||
|
const MKACTIVITY = 'MKACTIVITY';
|
||||||
|
const VERSIONCONTROL = 'VERSION-CONTROL';
|
||||||
|
const REPORT = 'REPORT';
|
||||||
|
const CHECKOUT = 'CHECKOUT';
|
||||||
|
const CHECKIN = 'CHECKIN';
|
||||||
|
const UNCHECKOUT = 'UNCHECKOUT';
|
||||||
|
const MKWORKSPACE = 'MKWORKSPACE';
|
||||||
|
const UPDATE = 'UPDATE';
|
||||||
|
const LABEL = 'LABEL';
|
||||||
|
|
||||||
|
// RFC3648
|
||||||
|
const ORDERPATCH = 'ORDERPATCH';
|
||||||
|
|
||||||
|
// RFC3744
|
||||||
|
const ACL = 'ACL';
|
||||||
|
|
||||||
|
// RFC4437
|
||||||
|
const MKREDIRECTREF = 'MKREDIRECTREF';
|
||||||
|
const UPDATEREDIRECTREF = 'UPDATEREDIRECTREF';
|
||||||
|
|
||||||
|
// RFC4791
|
||||||
|
const MKCALENDAR = 'MKCALENDAR';
|
||||||
|
|
||||||
|
// RFC4918
|
||||||
|
const PROPFIND = 'PROPFIND';
|
||||||
|
const LOCK = 'LOCK';
|
||||||
|
const UNLOCK = 'UNLOCK';
|
||||||
|
const PROPPATCH = 'PROPPATCH';
|
||||||
|
const MKCOL = 'MKCOL';
|
||||||
|
const COPY = 'COPY';
|
||||||
|
const MOVE = 'MOVE';
|
||||||
|
|
||||||
|
// RFC5323
|
||||||
|
const SEARCH = 'SEARCH';
|
||||||
|
|
||||||
|
// RFC5789
|
||||||
|
const PATCH = 'PATCH';
|
||||||
|
|
||||||
|
// RFC5842
|
||||||
|
const BIND = 'BIND';
|
||||||
|
const UNBIND = 'UNBIND';
|
||||||
|
const REBIND = 'REBIND';
|
||||||
|
}
|
||||||
447
src/Unirest/Request.php
Normal file
447
src/Unirest/Request.php
Normal file
@@ -0,0 +1,447 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Unirest;
|
||||||
|
|
||||||
|
use Unirest\Method;
|
||||||
|
use Unirest\Response;
|
||||||
|
|
||||||
|
class Request
|
||||||
|
{
|
||||||
|
private static $jsonOpts = array();
|
||||||
|
private static $verifyPeer = true;
|
||||||
|
private static $socketTimeout = null;
|
||||||
|
private static $defaultHeaders = array();
|
||||||
|
|
||||||
|
private static $auth = array (
|
||||||
|
'user' => '',
|
||||||
|
'pass' => '',
|
||||||
|
'method' => CURLAUTH_BASIC
|
||||||
|
);
|
||||||
|
|
||||||
|
private static $proxy = array(
|
||||||
|
'port' => false,
|
||||||
|
'tunnel' => false,
|
||||||
|
'address' => false,
|
||||||
|
'type' => CURLPROXY_HTTP,
|
||||||
|
'auth' => array (
|
||||||
|
'user' => '',
|
||||||
|
'pass' => '',
|
||||||
|
'method' => CURLAUTH_BASIC
|
||||||
|
)
|
||||||
|
);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set JSON decode mode
|
||||||
|
*
|
||||||
|
* @param bool $assoc When TRUE, returned objects will be converted into associative arrays.
|
||||||
|
* @param bool $depth User specified recursion depth.
|
||||||
|
* @param bool $options Bitmask of JSON decode options. Currently only JSON_BIGINT_AS_STRING is supported (default is to cast large integers as floats)
|
||||||
|
*/
|
||||||
|
public static function jsonOpts($assoc = false, $depth = 512, $options = 0)
|
||||||
|
{
|
||||||
|
return self::$jsonOpts = array($assoc, $depth, $options);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Verify SSL peer
|
||||||
|
*
|
||||||
|
* @param bool $enabled enable SSL verification, by default is true
|
||||||
|
*/
|
||||||
|
public static function verifyPeer($enabled)
|
||||||
|
{
|
||||||
|
return self::$verifyPeer = $enabled;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set a timeout
|
||||||
|
*
|
||||||
|
* @param integer $seconds timeout value in seconds
|
||||||
|
*/
|
||||||
|
public static function timeout($seconds)
|
||||||
|
{
|
||||||
|
return self::$socketTimeout = $seconds;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set default headers to send on every request
|
||||||
|
*
|
||||||
|
* @param array $headers headers array
|
||||||
|
*/
|
||||||
|
public static function defaultHeaders($headers)
|
||||||
|
{
|
||||||
|
foreach ($headers as $name => $value) {
|
||||||
|
self::$defaultHeaders[$name] = $value;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $headers;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set a new default header to send on every request
|
||||||
|
*
|
||||||
|
* @param string $name header name
|
||||||
|
* @param string $value header value
|
||||||
|
*/
|
||||||
|
public static function defaultHeader($name, $value)
|
||||||
|
{
|
||||||
|
return self::$defaultHeaders[$name] = $value;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clear all the default headers
|
||||||
|
*/
|
||||||
|
public static function clearDefaultHeaders()
|
||||||
|
{
|
||||||
|
return self::$defaultHeaders = array();
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set authentication method to use
|
||||||
|
*
|
||||||
|
* @param string $username authentication username
|
||||||
|
* @param string $password authentication password
|
||||||
|
* @param string $method authentication method
|
||||||
|
*/
|
||||||
|
public static function auth($username = '', $password = '', $method = CURLAUTH_BASIC)
|
||||||
|
{
|
||||||
|
self::$auth['user'] = $username;
|
||||||
|
self::$auth['pass'] = $password;
|
||||||
|
self::$auth['method'] = $method;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set proxy to use
|
||||||
|
*
|
||||||
|
* @param string $address proxy address
|
||||||
|
* @param string $port proxy port
|
||||||
|
* @param string $port proxy type (Available options for this are CURLPROXY_HTTP, CURLPROXY_HTTP_1_0 CURLPROXY_SOCKS4, CURLPROXY_SOCKS5, CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5_HOSTNAME)
|
||||||
|
* @param string $tunnel enable/disable tunneling
|
||||||
|
*/
|
||||||
|
public static function proxy($address, $port = 1080, $type = CURLPROXY_HTTP, $tunnel = false)
|
||||||
|
{
|
||||||
|
self::$proxy['type'] = $type;
|
||||||
|
self::$proxy['port'] = $port;
|
||||||
|
self::$proxy['tunnel'] = $tunnel;
|
||||||
|
self::$proxy['address'] = $address;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set proxy authentication method to use
|
||||||
|
*
|
||||||
|
* @param string $username authentication username
|
||||||
|
* @param string $password authentication password
|
||||||
|
* @param string $method authentication method
|
||||||
|
* @param string $tunnel enable/disable tunneling
|
||||||
|
*/
|
||||||
|
public static function proxyAuth($username = '', $password = '', $method = CURLAUTH_BASIC)
|
||||||
|
{
|
||||||
|
self::$proxy['auth']['user'] = $username;
|
||||||
|
self::$proxy['auth']['pass'] = $password;
|
||||||
|
self::$proxy['auth']['method'] = $method;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a GET request to a URL
|
||||||
|
*
|
||||||
|
* @param string $url URL to send the GET request to
|
||||||
|
* @param array $headers additional headers to send
|
||||||
|
* @param mixed $parameters parameters to send in the querystring
|
||||||
|
* @param string $username Authentication username (deprecated)
|
||||||
|
* @param string $password Authentication password (deprecated)
|
||||||
|
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||||
|
*/
|
||||||
|
public static function get($url, $headers = array(), $parameters = null, $username = null, $password = null)
|
||||||
|
{
|
||||||
|
return self::send(Method::GET, $url, $parameters, $headers, $username, $password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a HEAD request to a URL
|
||||||
|
* @param string $url URL to send the HEAD request to
|
||||||
|
* @param array $headers additional headers to send
|
||||||
|
* @param mixed $parameters parameters to send in the querystring
|
||||||
|
* @param string $username Basic Authentication username (deprecated)
|
||||||
|
* @param string $password Basic Authentication password (deprecated)
|
||||||
|
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||||
|
*/
|
||||||
|
public static function head($url, $headers = array(), $parameters = null, $username = null, $password = null)
|
||||||
|
{
|
||||||
|
return self::send(Method::HEAD, $url, $parameters, $headers, $username, $password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a OPTIONS request to a URL
|
||||||
|
* @param string $url URL to send the OPTIONS request to
|
||||||
|
* @param array $headers additional headers to send
|
||||||
|
* @param mixed $parameters parameters to send in the querystring
|
||||||
|
* @param string $username Basic Authentication username
|
||||||
|
* @param string $password Basic Authentication password
|
||||||
|
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||||
|
*/
|
||||||
|
public static function options($url, $headers = array(), $parameters = null, $username = null, $password = null)
|
||||||
|
{
|
||||||
|
return self::send(Method::OPTIONS, $url, $parameters, $headers, $username, $password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a CONNECT request to a URL
|
||||||
|
* @param string $url URL to send the CONNECT request to
|
||||||
|
* @param array $headers additional headers to send
|
||||||
|
* @param mixed $parameters parameters to send in the querystring
|
||||||
|
* @param string $username Basic Authentication username (deprecated)
|
||||||
|
* @param string $password Basic Authentication password (deprecated)
|
||||||
|
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||||
|
*/
|
||||||
|
public static function connect($url, $headers = array(), $parameters = null, $username = null, $password = null)
|
||||||
|
{
|
||||||
|
return self::send(Method::CONNECT, $url, $parameters, $headers, $username, $password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send POST request to a URL
|
||||||
|
* @param string $url URL to send the POST request to
|
||||||
|
* @param array $headers additional headers to send
|
||||||
|
* @param mixed $body POST body data
|
||||||
|
* @param string $username Basic Authentication username (deprecated)
|
||||||
|
* @param string $password Basic Authentication password (deprecated)
|
||||||
|
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||||
|
*/
|
||||||
|
public static function post($url, $headers = array(), $body = null, $username = null, $password = null)
|
||||||
|
{
|
||||||
|
return self::send(Method::POST, $url, $body, $headers, $username, $password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send DELETE request to a URL
|
||||||
|
* @param string $url URL to send the DELETE request to
|
||||||
|
* @param array $headers additional headers to send
|
||||||
|
* @param mixed $body DELETE body data
|
||||||
|
* @param string $username Basic Authentication username (deprecated)
|
||||||
|
* @param string $password Basic Authentication password (deprecated)
|
||||||
|
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||||
|
*/
|
||||||
|
public static function delete($url, $headers = array(), $body = null, $username = null, $password = null)
|
||||||
|
{
|
||||||
|
return self::send(Method::DELETE, $url, $body, $headers, $username, $password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send PUT request to a URL
|
||||||
|
* @param string $url URL to send the PUT request to
|
||||||
|
* @param array $headers additional headers to send
|
||||||
|
* @param mixed $body PUT body data
|
||||||
|
* @param string $username Basic Authentication username (deprecated)
|
||||||
|
* @param string $password Basic Authentication password (deprecated)
|
||||||
|
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||||
|
*/
|
||||||
|
public static function put($url, $headers = array(), $body = null, $username = null, $password = null)
|
||||||
|
{
|
||||||
|
return self::send(Method::PUT, $url, $body, $headers, $username, $password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send PATCH request to a URL
|
||||||
|
* @param string $url URL to send the PATCH request to
|
||||||
|
* @param array $headers additional headers to send
|
||||||
|
* @param mixed $body PATCH body data
|
||||||
|
* @param string $username Basic Authentication username (deprecated)
|
||||||
|
* @param string $password Basic Authentication password (deprecated)
|
||||||
|
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||||
|
*/
|
||||||
|
public static function patch($url, $headers = array(), $body = null, $username = null, $password = null)
|
||||||
|
{
|
||||||
|
return self::send(Method::PATCH, $url, $body, $headers, $username, $password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send TRACE request to a URL
|
||||||
|
* @param string $url URL to send the TRACE request to
|
||||||
|
* @param array $headers additional headers to send
|
||||||
|
* @param mixed $body TRACE body data
|
||||||
|
* @param string $username Basic Authentication username (deprecated)
|
||||||
|
* @param string $password Basic Authentication password (deprecated)
|
||||||
|
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||||
|
*/
|
||||||
|
public static function trace($url, $headers = array(), $body = null, $username = null, $password = null)
|
||||||
|
{
|
||||||
|
return self::send(Method::TRACE, $url, $body, $headers, $username, $password);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This function is useful for serializing multidimensional arrays, and avoid getting
|
||||||
|
* the 'Array to string conversion' notice
|
||||||
|
*/
|
||||||
|
public static function buildHTTPCurlQuery($data, $parent = false)
|
||||||
|
{
|
||||||
|
$result = array();
|
||||||
|
|
||||||
|
if (is_object($data)) {
|
||||||
|
$data = get_object_vars($data);
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($data as $key => $value) {
|
||||||
|
if ($parent) {
|
||||||
|
$new_key = sprintf('%s[%s]', $parent, $key);
|
||||||
|
} else {
|
||||||
|
$new_key = $key;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!$value instanceof \CURLFile and (is_array($value) or is_object($value))) {
|
||||||
|
$result = array_merge($result, self::buildHTTPCurlQuery($value, $new_key));
|
||||||
|
} else {
|
||||||
|
$result[$new_key] = $value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $result;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Send a cURL request
|
||||||
|
* @param Unirest\Method $method HTTP method to use
|
||||||
|
* @param string $url URL to send the request to
|
||||||
|
* @param mixed $body request body
|
||||||
|
* @param array $headers additional headers to send
|
||||||
|
* @param string $username Authentication username (deprecated)
|
||||||
|
* @param string $password Authentication password (deprecated)
|
||||||
|
* @throws Exception if a cURL error occurs
|
||||||
|
* @return Unirest\Response
|
||||||
|
*/
|
||||||
|
public static function send($method, $url, $body = null, $headers = array(), $username = null, $password = null)
|
||||||
|
{
|
||||||
|
$ch = curl_init();
|
||||||
|
|
||||||
|
if ($method !== Method::GET) {
|
||||||
|
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
|
||||||
|
|
||||||
|
if (is_array($body) || $body instanceof \Traversable) {
|
||||||
|
curl_setopt($ch, CURLOPT_POSTFIELDS, self::buildHTTPCurlQuery($body));
|
||||||
|
} else {
|
||||||
|
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
|
||||||
|
}
|
||||||
|
} elseif (is_array($body)) {
|
||||||
|
if (strpos($url, '?') !== false) {
|
||||||
|
$url .= '&';
|
||||||
|
} else {
|
||||||
|
$url .= '?';
|
||||||
|
}
|
||||||
|
|
||||||
|
$url .= urldecode(http_build_query(self::buildHTTPCurlQuery($body)));
|
||||||
|
}
|
||||||
|
|
||||||
|
curl_setopt($ch, CURLOPT_URL, self::encodeUrl($url));
|
||||||
|
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
|
||||||
|
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
|
||||||
|
curl_setopt($ch, CURLOPT_MAXREDIRS, 10);
|
||||||
|
curl_setopt($ch, CURLOPT_HTTPHEADER, self::getFormattedHeaders($headers));
|
||||||
|
curl_setopt($ch, CURLOPT_HEADER, true);
|
||||||
|
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, self::$verifyPeer);
|
||||||
|
curl_setopt($ch, CURLOPT_ENCODING, ''); // If an empty string, '', is set, a header containing all supported encoding types is sent.
|
||||||
|
|
||||||
|
if (self::$socketTimeout !== null) {
|
||||||
|
curl_setopt($ch, CURLOPT_TIMEOUT, self::$socketTimeout);
|
||||||
|
}
|
||||||
|
|
||||||
|
// supporting deprecated http auth method
|
||||||
|
if (!empty($username)) {
|
||||||
|
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
|
||||||
|
curl_setopt($ch, CURLOPT_USERPWD, $username . ':' . $password);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!empty(self::$auth['user'])) {
|
||||||
|
curl_setopt($ch, CURLOPT_HTTPAUTH, self::$auth['method']);
|
||||||
|
curl_setopt($ch, CURLOPT_USERPWD, self::$auth['user'] . ':' . self::$auth['pass']);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (self::$proxy['address'] !== false) {
|
||||||
|
curl_setopt($ch, CURLOPT_PROXYTYPE, self::$proxy['type']);
|
||||||
|
curl_setopt($ch, CURLOPT_PROXY, self::$proxy['address']);
|
||||||
|
curl_setopt($ch, CURLOPT_PROXYPORT, self::$proxy['port']);
|
||||||
|
curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, self::$proxy['tunnel']);
|
||||||
|
|
||||||
|
curl_setopt($ch, CURLOPT_PROXYAUTH, self::$proxy['auth']['method']);
|
||||||
|
curl_setopt($ch, CURLOPT_PROXYUSERPWD, self::$proxy['auth']['user'] . ':' . self::$proxy['auth']['pass']);
|
||||||
|
}
|
||||||
|
|
||||||
|
$response = curl_exec($ch);
|
||||||
|
$error = curl_error($ch);
|
||||||
|
|
||||||
|
if ($error) {
|
||||||
|
throw new \Exception($error);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Split the full response in its headers and body
|
||||||
|
$curl_info = curl_getinfo($ch);
|
||||||
|
$header_size = $curl_info['header_size'];
|
||||||
|
$header = substr($response, 0, $header_size);
|
||||||
|
$body = substr($response, $header_size);
|
||||||
|
$httpCode = $curl_info['http_code'];
|
||||||
|
|
||||||
|
return new Response($httpCode, $body, $header, self::$jsonOpts);
|
||||||
|
}
|
||||||
|
|
||||||
|
public static function getFormattedHeaders($headers)
|
||||||
|
{
|
||||||
|
$formattedHeaders = array();
|
||||||
|
|
||||||
|
$combinedHeaders = array_change_key_case(array_merge((array) $headers, self::$defaultHeaders));
|
||||||
|
|
||||||
|
foreach ($combinedHeaders as $key => $val) {
|
||||||
|
$formattedHeaders[] = self::getHeaderString($key, $val);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!array_key_exists('user-agent', $combinedHeaders)) {
|
||||||
|
$formattedHeaders[] = 'user-agent: unirest-php/2.0';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!array_key_exists('expect', $combinedHeaders)) {
|
||||||
|
$formattedHeaders[] = 'expect:';
|
||||||
|
}
|
||||||
|
|
||||||
|
return $formattedHeaders;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static function getArrayFromQuerystring($query)
|
||||||
|
{
|
||||||
|
$query = preg_replace_callback('/(?:^|(?<=&))[^=[]+/', function ($match) {
|
||||||
|
return bin2hex(urldecode($match[0]));
|
||||||
|
}, $query);
|
||||||
|
|
||||||
|
parse_str($query, $values);
|
||||||
|
|
||||||
|
return array_combine(array_map('hex2bin', array_keys($values)), $values);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Ensure that a URL is encoded and safe to use with cURL
|
||||||
|
* @param string $url URL to encode
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
private static function encodeUrl($url)
|
||||||
|
{
|
||||||
|
$url_parsed = parse_url($url);
|
||||||
|
|
||||||
|
$scheme = $url_parsed['scheme'] . '://';
|
||||||
|
$host = $url_parsed['host'];
|
||||||
|
$port = (isset($url_parsed['port']) ? $url_parsed['port'] : null);
|
||||||
|
$path = (isset($url_parsed['path']) ? $url_parsed['path'] : null);
|
||||||
|
$query = (isset($url_parsed['query']) ? $url_parsed['query'] : null);
|
||||||
|
|
||||||
|
if ($query !== null) {
|
||||||
|
$query = '?' . http_build_query(self::getArrayFromQuerystring($query));
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($port && $port[0] !== ':') {
|
||||||
|
$port = ':' . $port;
|
||||||
|
}
|
||||||
|
|
||||||
|
$result = $scheme . $host . $port . $path . $query;
|
||||||
|
return $result;
|
||||||
|
}
|
||||||
|
|
||||||
|
private static function getHeaderString($key, $val)
|
||||||
|
{
|
||||||
|
$key = trim(strtolower($key));
|
||||||
|
return $key . ': ' . $val;
|
||||||
|
}
|
||||||
|
}
|
||||||
74
src/Unirest/Response.php
Normal file
74
src/Unirest/Response.php
Normal file
@@ -0,0 +1,74 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Unirest;
|
||||||
|
|
||||||
|
class Response
|
||||||
|
{
|
||||||
|
public $code;
|
||||||
|
public $raw_body;
|
||||||
|
public $body;
|
||||||
|
public $headers;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param int $code response code of the cURL request
|
||||||
|
* @param string $raw_body the raw body of the cURL response
|
||||||
|
* @param string $headers raw header string from cURL response
|
||||||
|
* @param array $json_args arguments to pass to json_decode function
|
||||||
|
*/
|
||||||
|
public function __construct($code, $raw_body, $headers, $json_args = array())
|
||||||
|
{
|
||||||
|
$this->code = $code;
|
||||||
|
$this->headers = $this->parseHeaders($headers);
|
||||||
|
$this->raw_body = $raw_body;
|
||||||
|
$this->body = $raw_body;
|
||||||
|
|
||||||
|
// make sure raw_body is the first argument
|
||||||
|
array_unshift($json_args, $raw_body);
|
||||||
|
|
||||||
|
$json = call_user_func_array('json_decode', $json_args);
|
||||||
|
|
||||||
|
if (json_last_error() === JSON_ERROR_NONE) {
|
||||||
|
$this->body = $json;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* if PECL_HTTP is not available use a fall back function
|
||||||
|
*
|
||||||
|
* thanks to ricardovermeltfoort@gmail.com
|
||||||
|
* http://php.net/manual/en/function.http-parse-headers.php#112986
|
||||||
|
*/
|
||||||
|
private function parseHeaders($raw_headers)
|
||||||
|
{
|
||||||
|
if (function_exists('http_parse_headers')) {
|
||||||
|
return http_parse_headers($raw_headers);
|
||||||
|
} else {
|
||||||
|
$key = '';
|
||||||
|
$headers = array();
|
||||||
|
|
||||||
|
foreach (explode("\n", $raw_headers) as $i => $h) {
|
||||||
|
$h = explode(':', $h, 2);
|
||||||
|
|
||||||
|
if (isset($h[1])) {
|
||||||
|
if (!isset($headers[$h[0]])) {
|
||||||
|
$headers[$h[0]] = trim($h[1]);
|
||||||
|
} elseif (is_array($headers[$h[0]])) {
|
||||||
|
$headers[$h[0]] = array_merge($headers[$h[0]], array(trim($h[1])));
|
||||||
|
} else {
|
||||||
|
$headers[$h[0]] = array_merge(array($headers[$h[0]]), array(trim($h[1])));
|
||||||
|
}
|
||||||
|
|
||||||
|
$key = $h[0];
|
||||||
|
} else {
|
||||||
|
if (substr($h[0], 0, 1) == "\t") {
|
||||||
|
$headers[$key] .= "\r\n\t".trim($h[0]);
|
||||||
|
} elseif (!$key) {
|
||||||
|
$headers[0] = trim($h[0]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $headers;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
1
test/.gitignore
vendored
1
test/.gitignore
vendored
@@ -1 +0,0 @@
|
|||||||
simpletest
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
echo "Running the Unirest-PHP bindings test suite.\n" . "If you're trying to use the Unirest-PHP bindings you'll probably want " . "to require('lib/Unirest.php'); instead of this file\n";
|
|
||||||
|
|
||||||
$ok = @include_once(dirname(__FILE__) . '/simpletest/autorun.php');
|
|
||||||
if (!$ok) {
|
|
||||||
$ok = @include_once(dirname(__FILE__) . '/../vendor/vierbergenlars/simpletest/autorun.php');
|
|
||||||
}
|
|
||||||
if (!$ok) {
|
|
||||||
echo "MISSING DEPENDENCY: The Unirest-PHP test cases depend on SimpleTest. " . "Download it at <http://www.simpletest.org/>, and either install it " . "in your PHP include_path or put it in the test/ directory.\n";
|
|
||||||
exit(1);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Throw an exception on any error
|
|
||||||
function exception_error_handler($errno, $errstr, $errfile, $errline)
|
|
||||||
{
|
|
||||||
throw new ErrorException($errstr, $errno, 0, $errfile, $errline);
|
|
||||||
}
|
|
||||||
|
|
||||||
set_error_handler('exception_error_handler');
|
|
||||||
error_reporting(E_ALL | E_STRICT);
|
|
||||||
|
|
||||||
require_once(dirname(__FILE__) . '/../lib/Unirest.php');
|
|
||||||
|
|
||||||
require_once(dirname(__FILE__) . '/Unirest/UnirestTest.php');
|
|
||||||
|
|
||||||
?>
|
|
||||||
@@ -1,374 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
class UnirestTest extends UnitTestCase
|
|
||||||
{
|
|
||||||
|
|
||||||
public function testGet()
|
|
||||||
{
|
|
||||||
$response = Unirest::get("http://httpbin.org/get?name=Mark", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"nick" => "thefosk"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$args = $response->body->args;
|
|
||||||
$this->assertEqual("Mark", $args->name);
|
|
||||||
$this->assertEqual("thefosk", $args->nick);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testGetMultidimensionalArray()
|
|
||||||
{
|
|
||||||
$response = Unirest::get("http://httpbin.org/get", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
'key' => 'value',
|
|
||||||
'items' => array(
|
|
||||||
'item1',
|
|
||||||
'item2'
|
|
||||||
)
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$args = $response->body->args;
|
|
||||||
|
|
||||||
$this->assertEqual("value", $args->key);
|
|
||||||
$this->assertEqual("item1", $args->{"items[0]"});
|
|
||||||
$this->assertEqual("item2", $args->{"items[1]"});
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testGetWithDots()
|
|
||||||
{
|
|
||||||
$response = Unirest::get("http://httpbin.org/get", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"user.name" => "Mark",
|
|
||||||
"nick" => "thefosk"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$args = $response->body->args;
|
|
||||||
$this->assertEqual("Mark", $args->{"user.name"});
|
|
||||||
$this->assertEqual("thefosk", $args->nick);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testGetWithDots2()
|
|
||||||
{
|
|
||||||
$response = Unirest::get("http://httpbin.org/get", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"user.name" => "Mark Bond",
|
|
||||||
"nick" => "thefosk"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$args = $response->body->args;
|
|
||||||
$this->assertEqual("Mark Bond", $args->{"user.name"});
|
|
||||||
$this->assertEqual("thefosk", $args->nick);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testPost()
|
|
||||||
{
|
|
||||||
$response = Unirest::post("http://httpbin.org/post", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"name" => "Mark",
|
|
||||||
"nick" => "thefosk"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$form = $response->body->form;
|
|
||||||
$this->assertEqual("Mark", $form->name);
|
|
||||||
$this->assertEqual("thefosk", $form->nick);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testPostWithEqualSign()
|
|
||||||
{
|
|
||||||
$response = Unirest::post("http://httpbin.org/post", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"name" => "Mark=Hello"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$form = $response->body->form;
|
|
||||||
$this->assertEqual("Mark=Hello", $form->name);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testGetWithEqualSign()
|
|
||||||
{
|
|
||||||
$response = Unirest::get("http://httpbin.org/get", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"name" => "Mark=Hello"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$args = $response->body->args;
|
|
||||||
$this->assertEqual("Mark=Hello", $args->name);
|
|
||||||
|
|
||||||
$response = Unirest::get("http://httpbin.org/get", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"name" => "Mark=Hello=John"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$args = $response->body->args;
|
|
||||||
$this->assertEqual("Mark=Hello=John", $args->name);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testPostArray()
|
|
||||||
{
|
|
||||||
$response = Unirest::post("http://httpbin.org/post", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"name[0]" => "Mark",
|
|
||||||
"name[1]" => "John"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$form = $response->body->form;
|
|
||||||
|
|
||||||
$this->assertEqual("Mark", $form->{"name[0]"});
|
|
||||||
$this->assertEqual("John", $form->{"name[1]"});
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testGetArray()
|
|
||||||
{
|
|
||||||
$response = Unirest::get("http://httpbin.org/get", array(), array(
|
|
||||||
"name[0]" => "Mark",
|
|
||||||
"name[1]" => "John"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$args = $response->body->args;
|
|
||||||
$this->assertEqual("Mark", $args->{"name[0]"});
|
|
||||||
$this->assertEqual("John", $args->{"name[1]"});
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testPostWithDots()
|
|
||||||
{
|
|
||||||
$response = Unirest::post("http://httpbin.org/post", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"user.name" => "Mark",
|
|
||||||
"nick" => "thefosk"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$form = $response->body->form;
|
|
||||||
$this->assertEqual("Mark", $form->{"user.name"});
|
|
||||||
$this->assertEqual("thefosk", $form->nick);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testRawPost()
|
|
||||||
{
|
|
||||||
$response = Unirest::post("http://httpbin.org/post", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), json_encode(array(
|
|
||||||
"author" => "Sam Sullivan"
|
|
||||||
)));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$json = $response->body->json;
|
|
||||||
$this->assertEqual("Sam Sullivan", $json->author);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testUpload()
|
|
||||||
{
|
|
||||||
$response = Unirest::post("http://httpbin.org/post", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"name" => "Mark",
|
|
||||||
"file" => Unirest::file(dirname(__FILE__) . "/test_upload.txt")
|
|
||||||
));
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$files = $response->body->files;
|
|
||||||
$this->assertEqual("This is a test", $files->file);
|
|
||||||
|
|
||||||
$form = $response->body->form;
|
|
||||||
$this->assertEqual("Mark", $form->name);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testUploadIfFilePartOfData()
|
|
||||||
{
|
|
||||||
$response = Unirest::post("http://httpbin.org/post", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"name" => "Mark",
|
|
||||||
"files[owl.gif]" => Unirest::file(dirname(__FILE__) . "/test_upload.txt")
|
|
||||||
));
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
//$files = $response->body->files;
|
|
||||||
//$this->assertEqual("This is a test", $files->file);
|
|
||||||
|
|
||||||
$form = $response->body->form;
|
|
||||||
$this->assertEqual("Mark", $form->name);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testPostMultidimensionalArray()
|
|
||||||
{
|
|
||||||
$response = Unirest::post("http://httpbin.org/post", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
'key' => 'value',
|
|
||||||
'items' => array(
|
|
||||||
'item1',
|
|
||||||
'item2'
|
|
||||||
)
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$form = $response->body->form;
|
|
||||||
$this->assertEqual("value", $form->key);
|
|
||||||
$this->assertEqual("item1", $form->{"items[0]"});
|
|
||||||
$this->assertEqual("item2", $form->{"items[1]"});
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testPut()
|
|
||||||
{
|
|
||||||
$response = Unirest::put("http://httpbin.org/put", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"name" => "Mark",
|
|
||||||
"nick" => "thefosk"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$form = $response->body->form;
|
|
||||||
$this->assertEqual("Mark", $form->name);
|
|
||||||
$this->assertEqual("thefosk", $form->nick);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testPatch()
|
|
||||||
{
|
|
||||||
$response = Unirest::patch("http://httpbin.org/patch", array(
|
|
||||||
"Accept" => "application/json"
|
|
||||||
), array(
|
|
||||||
"name" => "Mark",
|
|
||||||
"nick" => "thefosk"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$form = $response->body->form;
|
|
||||||
$this->assertEqual("Mark", $form->name);
|
|
||||||
$this->assertEqual("thefosk", $form->nick);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testDelete()
|
|
||||||
{
|
|
||||||
$response = Unirest::delete("http://httpbin.org/delete", array(
|
|
||||||
"Accept" => "application/json",
|
|
||||||
"Content-Type" => "application/x-www-form-urlencoded"
|
|
||||||
), array(
|
|
||||||
"name" => "Mark",
|
|
||||||
"nick" => "thefosk"
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
$data = $response->body->data;
|
|
||||||
$this->assertFalse(empty($data));
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testTimeoutFail()
|
|
||||||
{
|
|
||||||
Unirest::timeout(1);
|
|
||||||
|
|
||||||
$this->expectException();
|
|
||||||
$response = Unirest::get("http://httpbin.org/delay/3");
|
|
||||||
|
|
||||||
Unirest::timeout(null); // Cleaning timeout for the other tests
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testTimeoutSuccess()
|
|
||||||
{
|
|
||||||
Unirest::timeout(3);
|
|
||||||
|
|
||||||
$response = Unirest::get("http://httpbin.org/delay/1");
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
Unirest::timeout(null); // Cleaning timeout for the other tests
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testDefaultHeader()
|
|
||||||
{
|
|
||||||
Unirest::defaultHeader("Hello", "custom");
|
|
||||||
$response = Unirest::get("http://httpbin.org/get");
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
$headers = $response->body->headers;
|
|
||||||
$properties = get_object_vars($headers);
|
|
||||||
$this->assertTrue(array_key_exists("Hello", $properties));
|
|
||||||
$this->assertEqual("custom", $headers->Hello);
|
|
||||||
$response = Unirest::get("http://httpbin.org/get");
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
$headers = $response->body->headers;
|
|
||||||
$properties = get_object_vars($headers);
|
|
||||||
$this->assertTrue(array_key_exists("Hello", $properties));
|
|
||||||
$this->assertEqual("custom", $headers->Hello);
|
|
||||||
Unirest::clearDefaultHeaders();
|
|
||||||
$response = Unirest::get("http://httpbin.org/get");
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
$headers = $response->body->headers;
|
|
||||||
$properties = get_object_vars($headers);
|
|
||||||
$this->assertFalse(array_key_exists("Hello", $properties));
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testGzip()
|
|
||||||
{
|
|
||||||
$response = Unirest::get("http://httpbin.org/gzip");
|
|
||||||
$args = $response->body;
|
|
||||||
$this->assertEqual(true, $args->gzipped);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testBasicAuthentication()
|
|
||||||
{
|
|
||||||
$response = Unirest::get("http://httpbin.org/get", null, null, "user", "password");
|
|
||||||
$headers = $response->body->headers;
|
|
||||||
$this->assertEqual("Basic dXNlcjpwYXNzd29yZA==", $headers->Authorization);
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testCustomHeaders()
|
|
||||||
{
|
|
||||||
$response = Unirest::get('http://httpbin.org/get', array(
|
|
||||||
'user-agent' => 'ciao',
|
|
||||||
));
|
|
||||||
|
|
||||||
$this->assertEqual(200, $response->code);
|
|
||||||
|
|
||||||
$headers = $response->body->headers;
|
|
||||||
$this->assertEqual("ciao", $headers->{'User-Agent'});
|
|
||||||
}
|
|
||||||
|
|
||||||
public function testHttpBuildQueryWhenCurlFile()
|
|
||||||
{
|
|
||||||
$file = Unirest::file(dirname(__FILE__) . "/test_upload.txt");
|
|
||||||
$body = array(
|
|
||||||
"to" => "mail@mailinator.com",
|
|
||||||
"from" => "mail@mailinator.com",
|
|
||||||
"file" => $file
|
|
||||||
);
|
|
||||||
Unirest::http_build_query_for_curl($body, $postBody);
|
|
||||||
$this->assertEqual($postBody['file'], $file);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
17
tests/Unirest/FileTest.php
Normal file
17
tests/Unirest/FileTest.php
Normal file
@@ -0,0 +1,17 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
use Unirest\File as File;
|
||||||
|
|
||||||
|
class UnirestFileTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
public function testCURLFile()
|
||||||
|
{
|
||||||
|
$file = File::add(UPLOAD_FIXTURE);
|
||||||
|
|
||||||
|
if (PHP_MAJOR_VERSION === 5 && PHP_MINOR_VERSION === 4) {
|
||||||
|
$this->assertEquals($file, sprintf('@%s;filename=%s;type=', UPLOAD_FIXTURE, basename(UPLOAD_FIXTURE)));
|
||||||
|
} else {
|
||||||
|
$this->assertTrue($file instanceof \CURLFile);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
407
tests/Unirest/RequestTest.php
Normal file
407
tests/Unirest/RequestTest.php
Normal file
@@ -0,0 +1,407 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
// Generic
|
||||||
|
public function testHttpBuildQueryWhenCurlFile()
|
||||||
|
{
|
||||||
|
$file = Unirest\File::add(UPLOAD_FIXTURE);
|
||||||
|
$body = array(
|
||||||
|
'to' => 'mail@mailinator.com',
|
||||||
|
'from' => 'mail@mailinator.com',
|
||||||
|
'file' => $file
|
||||||
|
);
|
||||||
|
|
||||||
|
$result = Unirest\Request::buildHTTPCurlQuery($body);
|
||||||
|
$this->assertEquals($result['file'], $file);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @expectedException Exception
|
||||||
|
*/
|
||||||
|
public function testTimeoutFail()
|
||||||
|
{
|
||||||
|
Unirest\Request::timeout(1);
|
||||||
|
|
||||||
|
Unirest\Request::get('http://httpbin.org/delay/3');
|
||||||
|
|
||||||
|
Unirest\Request::timeout(null); // Cleaning timeout for the other tests
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testTimeoutSuccess()
|
||||||
|
{
|
||||||
|
Unirest\Request::timeout(3);
|
||||||
|
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/delay/1');
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
Unirest\Request::timeout(null); // Cleaning timeout for the other tests
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testDefaultHeader()
|
||||||
|
{
|
||||||
|
Unirest\Request::defaultHeader('Hello', 'custom');
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get');
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
$headers = $response->body->headers;
|
||||||
|
$properties = get_object_vars($headers);
|
||||||
|
$this->assertTrue(array_key_exists('Hello', $properties));
|
||||||
|
$this->assertEquals('custom', $headers->Hello);
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get');
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
$headers = $response->body->headers;
|
||||||
|
$properties = get_object_vars($headers);
|
||||||
|
$this->assertTrue(array_key_exists('Hello', $properties));
|
||||||
|
$this->assertEquals('custom', $headers->Hello);
|
||||||
|
Unirest\Request::clearDefaultHeaders();
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get');
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
$headers = $response->body->headers;
|
||||||
|
$properties = get_object_vars($headers);
|
||||||
|
$this->assertFalse(array_key_exists('Hello', $properties));
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testGzip()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/gzip');
|
||||||
|
$args = $response->body;
|
||||||
|
$this->assertEquals(true, $args->gzipped);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testBasicAuthenticationDeprecated()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get', array(), array(), 'user', 'password');
|
||||||
|
$headers = $response->body->headers;
|
||||||
|
$this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $headers->Authorization);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testBasicAuthentication()
|
||||||
|
{
|
||||||
|
Unirest\Request::auth('user', 'password');
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get');
|
||||||
|
|
||||||
|
$this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $response->body->headers->Authorization);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testCustomHeaders()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||||
|
'user-agent' => 'ciao',
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$headers = $response->body->headers;
|
||||||
|
$this->assertEquals('ciao', $headers->{'User-Agent'});
|
||||||
|
}
|
||||||
|
|
||||||
|
// GET
|
||||||
|
public function testGet()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get?name=Mark', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'nick' => 'thefosk'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$args = $response->body->args;
|
||||||
|
$this->assertEquals('Mark', $args->name);
|
||||||
|
$this->assertEquals('thefosk', $args->nick);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testGetMultidimensionalArray()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'key' => 'value',
|
||||||
|
'items' => array(
|
||||||
|
'item1',
|
||||||
|
'item2'
|
||||||
|
)
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$args = $response->body->args;
|
||||||
|
|
||||||
|
$this->assertEquals('value', $args->key);
|
||||||
|
$this->assertEquals('item1', $args->{'items[0]'});
|
||||||
|
$this->assertEquals('item2', $args->{'items[1]'});
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testGetWithDots()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'user.name' => 'Mark',
|
||||||
|
'nick' => 'thefosk'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$args = $response->body->args;
|
||||||
|
$this->assertEquals('Mark', $args->{'user.name'});
|
||||||
|
$this->assertEquals('thefosk', $args->nick);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testGetWithDotsAlt()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'user.name' => 'Mark Bond',
|
||||||
|
'nick' => 'thefosk'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$args = $response->body->args;
|
||||||
|
$this->assertEquals('Mark Bond', $args->{'user.name'});
|
||||||
|
$this->assertEquals('thefosk', $args->nick);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testGetWithEqualSign()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'name' => 'Mark=Hello'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$args = $response->body->args;
|
||||||
|
$this->assertEquals('Mark=Hello', $args->name);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testGetWithEqualSignAlt()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'name' => 'Mark=Hello=John'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$args = $response->body->args;
|
||||||
|
$this->assertEquals('Mark=Hello=John', $args->name);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testGetWithComplexQuery()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get?query=[{"type":"/music/album","name":null,"artist":{"id":"/en/bob_dylan"},"limit":3}]&cursor');
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$args = $response->body->args;
|
||||||
|
$this->assertEquals('', $args->cursor);
|
||||||
|
$this->assertEquals('[{"type":"/music/album","name":null,"artist":{"id":"/en/bob_dylan"},"limit":3}]', $args->query);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testGetArray()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::get('http://httpbin.org/get', array(), array(
|
||||||
|
'name[0]' => 'Mark',
|
||||||
|
'name[1]' => 'John'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$args = $response->body->args;
|
||||||
|
$this->assertEquals('Mark', $args->{'name[0]'});
|
||||||
|
$this->assertEquals('John', $args->{'name[1]'});
|
||||||
|
}
|
||||||
|
|
||||||
|
// POST
|
||||||
|
public function testPost()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'name' => 'Mark',
|
||||||
|
'nick' => 'thefosk'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$form = $response->body->form;
|
||||||
|
$this->assertEquals('Mark', $form->name);
|
||||||
|
$this->assertEquals('thefosk', $form->nick);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testPostWithEqualSign()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'name' => 'Mark=Hello'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$form = $response->body->form;
|
||||||
|
$this->assertEquals('Mark=Hello', $form->name);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testPostArray()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'name[0]' => 'Mark',
|
||||||
|
'name[1]' => 'John'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$form = $response->body->form;
|
||||||
|
|
||||||
|
$this->assertEquals('Mark', $form->{'name[0]'});
|
||||||
|
$this->assertEquals('John', $form->{'name[1]'});
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testPostWithDots()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'user.name' => 'Mark',
|
||||||
|
'nick' => 'thefosk'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$form = $response->body->form;
|
||||||
|
$this->assertEquals('Mark', $form->{'user.name'});
|
||||||
|
$this->assertEquals('thefosk', $form->nick);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testRawPost()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||||
|
'Accept' => 'application/json',
|
||||||
|
'Content-Type' => 'application/json'
|
||||||
|
), json_encode(array(
|
||||||
|
'author' => 'Sam Sullivan'
|
||||||
|
)));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$json = $response->body->json;
|
||||||
|
|
||||||
|
$this->assertEquals('Sam Sullivan', $json->author);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testPostMultidimensionalArray()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'key' => 'value',
|
||||||
|
'items' => array(
|
||||||
|
'item1',
|
||||||
|
'item2'
|
||||||
|
)
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$form = $response->body->form;
|
||||||
|
$this->assertEquals('value', $form->key);
|
||||||
|
$this->assertEquals('item1', $form->{'items[0]'});
|
||||||
|
$this->assertEquals('item2', $form->{'items[1]'});
|
||||||
|
}
|
||||||
|
|
||||||
|
// PUT
|
||||||
|
public function testPut()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::put('http://httpbin.org/put', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'name' => 'Mark',
|
||||||
|
'nick' => 'thefosk'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$form = $response->body->form;
|
||||||
|
$this->assertEquals('Mark', $form->name);
|
||||||
|
$this->assertEquals('thefosk', $form->nick);
|
||||||
|
}
|
||||||
|
|
||||||
|
// PATCH
|
||||||
|
public function testPatch()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::patch('http://httpbin.org/patch', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'name' => 'Mark',
|
||||||
|
'nick' => 'thefosk'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$form = $response->body->form;
|
||||||
|
$this->assertEquals('Mark', $form->name);
|
||||||
|
$this->assertEquals('thefosk', $form->nick);
|
||||||
|
}
|
||||||
|
|
||||||
|
// DELETE
|
||||||
|
public function testDelete()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::delete('http://httpbin.org/delete', array(
|
||||||
|
'Accept' => 'application/json',
|
||||||
|
'Content-Type' => 'application/x-www-form-urlencoded'
|
||||||
|
), array(
|
||||||
|
'name' => 'Mark',
|
||||||
|
'nick' => 'thefosk'
|
||||||
|
));
|
||||||
|
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
$data = $response->body->data;
|
||||||
|
$this->assertTrue(empty($data));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Upload
|
||||||
|
public function testUpload()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'name' => 'Mark',
|
||||||
|
'file' => Unirest\File::add(UPLOAD_FIXTURE)
|
||||||
|
));
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
$files = $response->body->files;
|
||||||
|
$this->assertEquals('This is a test', $files->file);
|
||||||
|
|
||||||
|
$form = $response->body->form;
|
||||||
|
$this->assertEquals('Mark', $form->name);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testUploadIfFilePartOfData()
|
||||||
|
{
|
||||||
|
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||||
|
'Accept' => 'application/json'
|
||||||
|
), array(
|
||||||
|
'name' => 'Mark',
|
||||||
|
'files[owl.gif]' => Unirest\File::add(UPLOAD_FIXTURE)
|
||||||
|
));
|
||||||
|
$this->assertEquals(200, $response->code);
|
||||||
|
|
||||||
|
//$files = $response->body->files;
|
||||||
|
//$this->assertEquals('This is a test', $files->file);
|
||||||
|
|
||||||
|
$form = $response->body->form;
|
||||||
|
$this->assertEquals('Mark', $form->name);
|
||||||
|
}
|
||||||
|
}
|
||||||
28
tests/Unirest/ResponseTest.php
Normal file
28
tests/Unirest/ResponseTest.php
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
class UnirestResponseTest extends \PHPUnit_Framework_TestCase
|
||||||
|
{
|
||||||
|
public function testJSONAssociativeArrays()
|
||||||
|
{
|
||||||
|
$opts = Unirest\Request::jsonOpts(true);
|
||||||
|
$response = new Unirest\Response(200, '{"a":1,"b":2,"c":3,"d":4,"e":5}', '', $opts);
|
||||||
|
|
||||||
|
$this->assertEquals($response->body['a'], 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testJSONAObjects()
|
||||||
|
{
|
||||||
|
$opts = Unirest\Request::jsonOpts(false);
|
||||||
|
$response = new Unirest\Response(200, '{"a":1,"b":2,"c":3,"d":4,"e":5}', '', $opts);
|
||||||
|
|
||||||
|
$this->assertEquals($response->body->a, 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testJSONOpts()
|
||||||
|
{
|
||||||
|
$opts = Unirest\Request::jsonOpts(false, 512, JSON_NUMERIC_CHECK);
|
||||||
|
$response = new Unirest\Response(200, '{"number": 1234567890}', '', $opts);
|
||||||
|
|
||||||
|
$this->assertSame($response->body->number, 1234567890);
|
||||||
|
}
|
||||||
|
}
|
||||||
5
tests/bootstrap.php
Normal file
5
tests/bootstrap.php
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
require_once __DIR__ . '/../src/Unirest.php';
|
||||||
|
|
||||||
|
define('UPLOAD_FIXTURE', __DIR__ . '/fixtures/upload.txt');
|
||||||
Reference in New Issue
Block a user