Compare commits
74 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2bedcf05ac | ||
|
|
b6328f270f | ||
|
|
1e86cc751f | ||
|
|
825cee7dc7 | ||
|
|
eb470e929c | ||
|
|
d23cdc5593 | ||
|
|
0f3a22d63e | ||
|
|
f7f13bd940 | ||
|
|
d950a88257 | ||
|
|
73c2d90323 | ||
|
|
d0fc831a00 | ||
|
|
4a480b156b | ||
|
|
ca6a3b1daf | ||
|
|
da71f063cf | ||
|
|
be5ee63ad1 | ||
|
|
32334a6bfa | ||
|
|
e11c54d29c | ||
|
|
a3312a0ecd | ||
|
|
fde6f41733 | ||
|
|
75258a2024 | ||
|
|
b330685820 | ||
|
|
2f7aea9f63 | ||
|
|
f04b42e75e | ||
|
|
32c1a9fef0 | ||
|
|
2b5b349036 | ||
|
|
1017f14ef5 | ||
|
|
99c6975f23 | ||
|
|
f257217434 | ||
|
|
c9c0a85250 | ||
|
|
3e375515fe | ||
|
|
b6fb76ce12 | ||
|
|
5926846300 | ||
|
|
feae18f980 | ||
|
|
b0df287d64 | ||
|
|
4221ee5138 | ||
|
|
ec5828c8aa | ||
|
|
0293eb258c | ||
|
|
a1ed45be55 | ||
|
|
8da79e7898 | ||
|
|
217b436124 | ||
|
|
d508bd9628 | ||
|
|
7116894dad | ||
|
|
f31ce371a0 | ||
|
|
530905c7c9 | ||
|
|
139b58019c | ||
|
|
8b47e051ba | ||
|
|
491064f40b | ||
|
|
fb241f6898 | ||
|
|
f6fc64103f | ||
|
|
11cf1eaa9f | ||
|
|
d5a7ad40bd | ||
|
|
8af870ff69 | ||
|
|
ae01978eb3 | ||
|
|
2074abf904 | ||
|
|
96cdf61101 | ||
|
|
002c175cd1 | ||
|
|
c5be546d1b | ||
|
|
5fa02336f9 | ||
|
|
23c3cb5b00 | ||
|
|
8ce5204c37 | ||
|
|
90be29ced4 | ||
|
|
8dcb11e0a6 | ||
|
|
3591292c3e | ||
|
|
3ec25a5d17 | ||
|
|
fbe66400fc | ||
|
|
f68939375b | ||
|
|
ba25e0304a | ||
|
|
3bb82974cc | ||
|
|
3eb8536d3d | ||
|
|
4762858017 | ||
|
|
7404fca828 | ||
|
|
1dfcade505 | ||
|
|
976247358b | ||
|
|
a58c5592d5 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,5 +1,6 @@
|
||||
.DS_Store
|
||||
build
|
||||
vendor
|
||||
composer.lock
|
||||
composer.phar
|
||||
coverage
|
||||
vendor
|
||||
|
||||
29
.travis.yml
29
.travis.yml
@@ -1,13 +1,21 @@
|
||||
sudo: false
|
||||
|
||||
language: php
|
||||
|
||||
php:
|
||||
- 5.4
|
||||
- 5.5
|
||||
- 5.6
|
||||
- '5.4'
|
||||
- '5.5'
|
||||
- '5.6'
|
||||
- '7.0'
|
||||
- hhvm
|
||||
|
||||
before_script:
|
||||
- composer selfupdate
|
||||
- composer install
|
||||
|
||||
after_script:
|
||||
- vendor/bin/test-reporter
|
||||
- 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:
|
||||
@@ -16,3 +24,16 @@ notifications:
|
||||
on_success: always
|
||||
on_failure: always
|
||||
on_start: false
|
||||
|
||||
matrix:
|
||||
fast_finish: true
|
||||
allow_failures:
|
||||
- php: hhvm
|
||||
|
||||
notifications:
|
||||
webhooks:
|
||||
urls:
|
||||
- https://webhooks.gitter.im/e/d4319553d0aecfd5b9ac
|
||||
on_success: always
|
||||
on_failure: always
|
||||
on_start: false
|
||||
|
||||
346
README.md
346
README.md
@@ -1,23 +1,33 @@
|
||||
# Unirest for PHP [![version][composer-image]][composer-url]
|
||||
# Unirest for PHP [![Build Status][travis-image]][travis-url] [![version][packagist-version]][packagist-url]
|
||||
|
||||
[![Build Status][travis-image]][travis-url]
|
||||
[![Code Climate][codeclimate-image]][codeclimate-url]
|
||||
[![Coverage Status][codecoverage-image]][codecoverage-url]
|
||||
[![Dependency Status][dependency-image]][dependency-url]
|
||||
[![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-logo]
|
||||
|
||||
|
||||
[Unirest](http://unirest.io) is a set of lightweight HTTP libraries available in multiple languages, built and maintained by [Mashape](https://github.com/Mashape), who also maintain the open-source API Gateway [Kong](https://github.com/Mashape/kong).
|
||||
|
||||
Unirest is a set of lightweight HTTP libraries available in multiple languages, ideal for most applications:
|
||||
|
||||
## Features
|
||||
|
||||
* 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 Basic Authentication natively
|
||||
* Supports Basic, Digest, Negotiate, NTLM Authentication natively
|
||||
* Customizable timeout
|
||||
* Customizable default headers for every request (DRY)
|
||||
* Automatic JSON parsing into a native object for JSON responses
|
||||
|
||||
## Requirements
|
||||
|
||||
- [cURL](http://php.net/manual/en/book.curl.php)
|
||||
- PHP 5.4+
|
||||
|
||||
## Installation
|
||||
|
||||
### Using [Composer](https://getcomposer.org)
|
||||
@@ -25,7 +35,6 @@ Unirest is a set of lightweight HTTP libraries available in multiple languages,
|
||||
To install unirest-php with Composer, just add the following to your `composer.json` file:
|
||||
|
||||
```json
|
||||
// composer.json
|
||||
{
|
||||
"require-dev": {
|
||||
"mashape/unirest-php": "2.*"
|
||||
@@ -42,7 +51,7 @@ composer require mashape/unirest-php
|
||||
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:
|
||||
|
||||
```shell
|
||||
composer require mashape/php-test-reporter:@dev-master
|
||||
composer require mashape/php-test-reporter dev-master
|
||||
```
|
||||
|
||||
Composer installs autoloader at `./vendor/autoloader.php`. to include the library in your script, add:
|
||||
@@ -57,7 +66,7 @@ If you use Symfony2, autoloader has to be detected automatically.
|
||||
|
||||
### Install from source
|
||||
|
||||
Unirest-PHP requires PHP `v5.4+`. Download the PHP library from Github, then include `Unirest.php` in your script:
|
||||
Download the PHP library from Github, then include `Unirest.php` in your script:
|
||||
|
||||
```shell
|
||||
git clone git@github.com:Mashape/unirest-php.git
|
||||
@@ -74,10 +83,10 @@ require_once '/path/to/unirest-php/src/Unirest.php';
|
||||
So you're probably wondering how using Unirest makes creating requests in PHP easier, let's look at a working example:
|
||||
|
||||
```php
|
||||
$headers = array("Accept" => "application/json");
|
||||
$body = array("foo" => "hellow", "bar" => "world");
|
||||
$headers = array('Accept' => 'application/json');
|
||||
$query = array('foo' => 'hello', 'bar' => 'world');
|
||||
|
||||
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body);
|
||||
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $query);
|
||||
|
||||
$response->code; // HTTP Status code
|
||||
$response->headers; // Headers
|
||||
@@ -85,50 +94,183 @@ $response->body; // Parsed body
|
||||
$response->raw_body; // Unparsed body
|
||||
```
|
||||
|
||||
### File Uploads
|
||||
### JSON Requests *(`application/json`)*
|
||||
|
||||
To upload files in a multipart form representation use the return value of `Unirest\File::add($path)` as the value of a parameter:
|
||||
A JSON Request can be constructed using the `Unirest\Request\Body::Json` helper:
|
||||
|
||||
```php
|
||||
$headers = array("Accept" => "application/json");
|
||||
$body = array("file" => Unirest\File::add("/tmp/file.txt"));
|
||||
$headers = array('Accept' => 'application/json');
|
||||
$data = array('name' => 'ahmad', 'company' => 'mashape');
|
||||
|
||||
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body);
|
||||
$body = Unirest\Request\Body::json($data);
|
||||
|
||||
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
|
||||
```
|
||||
|
||||
### Custom Entity Body
|
||||
**Notes:**
|
||||
- `Content-Type` headers will be automatically set to `application/json`
|
||||
- the data variable will be processed through [`json_encode`](http://php.net/manual/en/function.json-encode.php) with default values for arguments.
|
||||
- an error will be thrown if the [JSON Extension](http://php.net/manual/en/book.json.php) is not available.
|
||||
|
||||
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
|
||||
$headers = array("Accept" => "application/json");
|
||||
$body = json_encode(array("foo" => "hellow", "bar" => "world"));
|
||||
### Form Requests *(`application/x-www-form-urlencoded`)*
|
||||
|
||||
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body);
|
||||
```
|
||||
|
||||
### Basic Authentication
|
||||
|
||||
Authenticating the request with basic authentication can be done by providing the `username` and `password` arguments:
|
||||
A typical Form Request can be constructed using the `Unirest\Request\Body::Form` helper:
|
||||
|
||||
```php
|
||||
$response = Unirest\Request::get("http://httpbin.org/get", null, null, "username", "password");
|
||||
$headers = array('Accept' => 'application/json');
|
||||
$data = array('name' => 'ahmad', 'company' => 'mashape');
|
||||
|
||||
$body = Unirest\Request\Body::form($data);
|
||||
|
||||
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
|
||||
```
|
||||
|
||||
**Notes:**
|
||||
- `Content-Type` headers will be automatically set to `application/x-www-form-urlencoded`
|
||||
- the final data array will be processed through [`http_build_query`](http://php.net/manual/en/function.http-build-query.php) with default values for arguments.
|
||||
|
||||
### Multipart Requests *(`multipart/form-data`)*
|
||||
|
||||
A Multipart Request can be constructed using the `Unirest\Request\Body::Multipart` helper:
|
||||
|
||||
```php
|
||||
$headers = array('Accept' => 'application/json');
|
||||
$data = array('name' => 'ahmad', 'company' => 'mashape');
|
||||
|
||||
$body = Unirest\Request\Body::multipart($data);
|
||||
|
||||
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
|
||||
```
|
||||
|
||||
**Notes:**
|
||||
|
||||
- `Content-Type` headers will be automatically set to `multipart/form-data`.
|
||||
- an auto-generated `--boundary` will be set.
|
||||
|
||||
### Multipart File Upload
|
||||
|
||||
simply add an array of files as the second argument to to the `Multipart` helper:
|
||||
|
||||
```php
|
||||
$headers = array('Accept' => 'application/json');
|
||||
$data = array('name' => 'ahmad', 'company' => 'mashape');
|
||||
$files = array('bio' => '/path/to/bio.txt', 'avatar' => '/path/to/avatar.jpg');
|
||||
|
||||
$body = Unirest\Request\Body::multipart($data, $files);
|
||||
|
||||
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
|
||||
```
|
||||
|
||||
If you wish to further customize the properties of files uploaded you can do so with the `Unirest\Request\Body::File` helper:
|
||||
|
||||
```php
|
||||
$headers = array('Accept' => 'application/json');
|
||||
$body = array(
|
||||
'name' => 'ahmad',
|
||||
'company' => 'mashape'
|
||||
'bio' => Unirest\Request\Body::file('/path/to/bio.txt', 'text/plain'),
|
||||
'avatar' => Unirest\Request\Body::file('/path/to/my_avatar.jpg', 'text/plain', 'avatar.jpg')
|
||||
);
|
||||
|
||||
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
|
||||
```
|
||||
|
||||
**Note**: we did not use the `Unirest\Request\Body::multipart` helper in this example, it is not needed when manually adding files.
|
||||
|
||||
### Custom Body
|
||||
|
||||
Sending a custom body such rather than using the `Unirest\Request\Body` helpers is also possible, for example, using a [`serialize`](http://php.net/manual/en/function.serialize.php) body string with a custom `Content-Type`:
|
||||
|
||||
```php
|
||||
$headers = array('Accept' => 'application/json', 'Content-Type' => 'application/x-php-serialized');
|
||||
$body = serialize((array('foo' => 'hello', 'bar' => 'world'));
|
||||
|
||||
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
|
||||
```
|
||||
|
||||
### Authentication
|
||||
|
||||
First, if you are using [Mashape][mashape-url]:
|
||||
```php
|
||||
// Mashape auth
|
||||
Unirest\Request::setMashapeKey('<mashape_key>');
|
||||
```
|
||||
|
||||
Otherwise, passing a username, password *(optional)*, defaults to Basic Authentication:
|
||||
|
||||
```php
|
||||
// basic auth
|
||||
Unirest\Request::auth('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.*
|
||||
|
||||
**Supported Methods**
|
||||
|
||||
| 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
|
||||
// custom auth method
|
||||
Unirest\Request::proxyAuth('username', 'password', CURLAUTH_DIGEST);
|
||||
```
|
||||
|
||||
Previous versions of **Unirest** support *Basic Authentication* by providing the `username` and `password` arguments:
|
||||
|
||||
```php
|
||||
$response = Unirest\Request::get('http://mockbin.com/request', 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**
|
||||
|
||||
### Cookies
|
||||
|
||||
Set a cookie string to specify the contents of a cookie header. Multiple cookies are separated with a semicolon followed by a space (e.g., "fruit=apple; colour=red")
|
||||
|
||||
```php
|
||||
Unirest\Request::cookie($cookie)
|
||||
```
|
||||
|
||||
Set a cookie file path for enabling cookie reading and storing cookies across multiple sequence of requests.
|
||||
|
||||
```php
|
||||
Unirest\Request::cookieFile($cookieFile)
|
||||
```
|
||||
|
||||
`$cookieFile` must be a correct path with write permission.
|
||||
|
||||
### Request Object
|
||||
|
||||
```php
|
||||
Unirest\Request::get($url, $headers = array(), $parameters = NULL, $username = NULL, $password = NULL)
|
||||
Unirest\Request::post($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
||||
Unirest\Request::put($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
||||
Unirest\Request::patch($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
||||
Unirest\Request::delete($url, $headers = array(), $body = NULL, $username = NULL, $password = NULL)
|
||||
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.
|
||||
- `headers` - Request Headers as associative array or object
|
||||
- `body` - Request Body as associative array or object
|
||||
- `username` - Basic Authentication username
|
||||
- `password` - Basic Authentication password
|
||||
|
||||
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
|
||||
|
||||
@@ -143,6 +285,17 @@ Upon recieving a response Unirest returns the result in the form of an Object, t
|
||||
|
||||
You can set some advanced configuration to tune Unirest-PHP:
|
||||
|
||||
#### 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).
|
||||
|
||||
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**):
|
||||
@@ -151,13 +304,61 @@ You can set a custom timeout value (in **seconds**):
|
||||
Unirest\Request::timeout(5); // 5s timeout
|
||||
```
|
||||
|
||||
#### 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:
|
||||
|
||||
```php
|
||||
Unirest\Request::defaultHeader("Header1", "Value1");
|
||||
Unirest\Request::defaultHeader("Header2", "Value2");
|
||||
Unirest\Request::defaultHeader('Header1', 'Value1');
|
||||
Unirest\Request::defaultHeader('Header2', 'Value2');
|
||||
```
|
||||
|
||||
You can set default headers in bulk by passing an array:
|
||||
|
||||
```php
|
||||
Unirest\Request::defaultHeaders(array(
|
||||
'Header1' => 'Value1',
|
||||
'Header2' => 'Value2'
|
||||
));
|
||||
```
|
||||
|
||||
You can clear the default headers anytime with:
|
||||
@@ -166,6 +367,28 @@ You can clear the default headers anytime with:
|
||||
Unirest\Request::clearDefaultHeaders();
|
||||
```
|
||||
|
||||
#### Default cURL Options
|
||||
|
||||
You can set default [cURL options](http://php.net/manual/en/function.curl-setopt.php) that will be sent on every request:
|
||||
|
||||
```php
|
||||
Unirest\Request::curlOpt(CURLOPT_COOKIE, 'foo=bar');
|
||||
```
|
||||
|
||||
You can set options bulk by passing an array:
|
||||
|
||||
```php
|
||||
Unirest\Request::curlOpts(array(
|
||||
CURLOPT_COOKIE => 'foo=bar'
|
||||
));
|
||||
```
|
||||
|
||||
You can clear the default options anytime with:
|
||||
|
||||
```php
|
||||
Unirest\Request::clearCurlOpts();
|
||||
```
|
||||
|
||||
#### SSL validation
|
||||
|
||||
You can explicitly enable or disable SSL certificate validation when consuming an SSL protected endpoint:
|
||||
@@ -176,28 +399,41 @@ Unirest\Request::verifyPeer(false); // Disables SSL cert validation
|
||||
|
||||
By default is `true`.
|
||||
|
||||
## License
|
||||
#### Utility Methods
|
||||
|
||||
Licensed under [the MIT license](LICENSE).
|
||||
```php
|
||||
// alias for `curl_getinfo`
|
||||
Unirest\Request::getInfo()
|
||||
|
||||
Created with love by [![Mashape Logo][mashape-logo]](https://www.mashape.com/)
|
||||
// returns internal cURL handle
|
||||
Unirest\Request::getCurlHandle()
|
||||
```
|
||||
|
||||
[gitter-url]: https://gitter.im/Mashape
|
||||
[gitter-image]: https://badges.gitter.im/Mashape.png
|
||||
----
|
||||
|
||||
[composer-url]: http://badge.fury.io/ph/mashape%2Funirest-php
|
||||
[composer-image]: https://badge.fury.io/ph/mashape%2Funirest-php.svg
|
||||
Made with ♥ from the [Mashape][mashape-url] team
|
||||
|
||||
[unirest-logo]: http://cl.ly/image/2P373Y090s2O/Image%202015-10-12%20at%209.48.06%20PM.png
|
||||
|
||||
|
||||
[mashape-url]: https://www.mashape.com/
|
||||
|
||||
[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://travis-ci.org/Mashape/unirest-php.png?branch=master
|
||||
[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-image]: https://codeclimate.com/github/Mashape/unirest-php/badges/gpa.svg
|
||||
[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
|
||||
|
||||
[codecoverage-url]: https://codeclimate.com/github/Mashape/unirest-php
|
||||
[codecoverage-image]: https://codeclimate.com/github/Mashape/unirest-php/badges/coverage.svg
|
||||
|
||||
[dependency-url]: https://www.versioneye.com/user/projects/54b702db050646ca5c00019d
|
||||
[dependency-image]: https://www.versioneye.com/user/projects/54b702db050646ca5c00019d/badge.svg?style=flat
|
||||
|
||||
[mashape-logo]: https://cloud.githubusercontent.com/assets/183195/5750736/c94e178c-9c26-11e4-91b2-84bcd5d33e28.png
|
||||
[versioneye-url]: https://www.versioneye.com/user/projects/54b82450050646ca5c0001f3
|
||||
[versioneye-image]: https://img.shields.io/versioneye/d/php/mashape:unirest-php.svg?style=flat
|
||||
|
||||
@@ -8,11 +8,12 @@
|
||||
"author": "Mashape <opensource@mashape.com> (https://www.mashape.com)",
|
||||
"require": {
|
||||
"php": ">=5.4.0",
|
||||
"ext-curl": "0.0.0.*",
|
||||
"ext-json": "~1.3"
|
||||
"ext-curl": "*"
|
||||
},
|
||||
"suggest": {
|
||||
"ext-json": "Allows using JSON Bodies for sending and parsing requests"
|
||||
},
|
||||
"require-dev": {
|
||||
"ext-xdebug": "~2.2",
|
||||
"phpunit/phpunit": "~4.4",
|
||||
"codeclimate/php-test-reporter": "0.1.*"
|
||||
},
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
<?php
|
||||
|
||||
require_once dirname(__FILE__) . '/Unirest/File.php';
|
||||
require_once dirname(__FILE__) . '/Unirest/Exception.php';
|
||||
require_once dirname(__FILE__) . '/Unirest/Method.php';
|
||||
require_once dirname(__FILE__) . '/Unirest/Response.php';
|
||||
require_once dirname(__FILE__) . '/Unirest/Request.php';
|
||||
require_once dirname(__FILE__) . '/Unirest/Request/Body.php';
|
||||
|
||||
5
src/Unirest/Exception.php
Normal file
5
src/Unirest/Exception.php
Normal file
@@ -0,0 +1,5 @@
|
||||
<?php
|
||||
|
||||
namespace Unirest;
|
||||
|
||||
class Exception extends \Exception {}
|
||||
@@ -1,19 +0,0 @@
|
||||
<?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);
|
||||
}
|
||||
}
|
||||
}
|
||||
417
src/Unirest/Request.php
Normal file → Executable file
417
src/Unirest/Request.php
Normal file → Executable file
@@ -2,41 +2,106 @@
|
||||
|
||||
namespace Unirest;
|
||||
|
||||
use Unirest\Method;
|
||||
use Unirest\Response;
|
||||
use Unirest\Method as Method;
|
||||
use Unirest\Response as Response;
|
||||
use Unirest\Exception as Exception;
|
||||
|
||||
class Request
|
||||
{
|
||||
private static $verifyPeer = true;
|
||||
private static $socketTimeout = null;
|
||||
private static $cookie = null;
|
||||
private static $cookieFile = null;
|
||||
private static $curlOpts = array();
|
||||
private static $defaultHeaders = array();
|
||||
private static $handle = null;
|
||||
private static $jsonOpts = array();
|
||||
private static $socketTimeout = null;
|
||||
private static $verifyPeer = true;
|
||||
private static $verifyHost = true;
|
||||
|
||||
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 integer $depth User specified recursion depth.
|
||||
* @param integer $options Bitmask of JSON decode options. Currently only JSON_BIGINT_AS_STRING is supported (default is to cast large integers as floats)
|
||||
* @return array
|
||||
*/
|
||||
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
|
||||
* @return bool
|
||||
*/
|
||||
public static function verifyPeer($enabled)
|
||||
{
|
||||
self::$verifyPeer = $enabled;
|
||||
return self::$verifyPeer = $enabled;
|
||||
}
|
||||
|
||||
/**
|
||||
* Verify SSL host
|
||||
*
|
||||
* @param bool $enabled enable SSL host verification, by default is true
|
||||
* @return bool
|
||||
*/
|
||||
public static function verifyHost($enabled)
|
||||
{
|
||||
return self::$verifyHost = $enabled;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a timeout
|
||||
*
|
||||
* @param integer $seconds timeout value in seconds
|
||||
* @return integer
|
||||
*/
|
||||
public static function timeout($seconds)
|
||||
{
|
||||
self::$socketTimeout = $seconds;
|
||||
return self::$socketTimeout = $seconds;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set default headers to send on every request
|
||||
*
|
||||
* @param array $headers headers array
|
||||
*/
|
||||
public static function defaultHeaders($headers)
|
||||
{
|
||||
return self::$defaultHeaders = array_merge(self::$defaultHeaders, $headers);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a new default header to send on every request
|
||||
*
|
||||
* @param string $name header name
|
||||
* @param string $value header value
|
||||
* @return string
|
||||
*/
|
||||
public static function defaultHeader($name, $value)
|
||||
{
|
||||
self::$defaultHeaders[$name] = $value;
|
||||
return self::$defaultHeaders[$name] = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -44,17 +109,130 @@ class Request
|
||||
*/
|
||||
public static function clearDefaultHeaders()
|
||||
{
|
||||
self::$defaultHeaders = array();
|
||||
return self::$defaultHeaders = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set curl options to send on every request
|
||||
*
|
||||
* @param array $options options array
|
||||
* @return array
|
||||
*/
|
||||
public static function curlOpts($options)
|
||||
{
|
||||
return self::mergeCurlOptions(self::$curlOpts, $options);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a new default header to send on every request
|
||||
*
|
||||
* @param string $name header name
|
||||
* @param string $value header value
|
||||
* @return string
|
||||
*/
|
||||
public static function curlOpt($name, $value)
|
||||
{
|
||||
return self::$curlOpts[$name] = $value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear all the default headers
|
||||
*/
|
||||
public static function clearCurlOpts()
|
||||
{
|
||||
return self::$curlOpts = array();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a Mashape key to send on every request as a header
|
||||
* Obtain your Mashape key by browsing one of your Mashape applications on https://www.mashape.com
|
||||
*
|
||||
* Note: Mashape provides 2 keys for each application: a 'Testing' and a 'Production' one.
|
||||
* Be aware of which key you are using and do not share your Production key.
|
||||
*
|
||||
* @param string $key Mashape key
|
||||
* @return string
|
||||
*/
|
||||
public static function setMashapeKey($key)
|
||||
{
|
||||
return self::defaultHeader('X-Mashape-Key', $key);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a coockie string for enabling coockie handling
|
||||
*
|
||||
* @param string $cookie
|
||||
*/
|
||||
public static function cookie($cookie)
|
||||
{
|
||||
self::$cookie = $cookie;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set a coockie file path for enabling coockie handling
|
||||
*
|
||||
* $cookieFile must be a correct path with write permission
|
||||
*
|
||||
* @param string $cookieFile - path to file for saving cookie
|
||||
*/
|
||||
public static function cookieFile($cookieFile)
|
||||
{
|
||||
self::$cookieFile = $cookieFile;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set authentication method to use
|
||||
*
|
||||
* @param string $username authentication username
|
||||
* @param string $password authentication password
|
||||
* @param integer $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 integer $port proxy port
|
||||
* @param integer $type (Available options for this are CURLPROXY_HTTP, CURLPROXY_HTTP_1_0 CURLPROXY_SOCKS4, CURLPROXY_SOCKS5, CURLPROXY_SOCKS4A and CURLPROXY_SOCKS5_HOSTNAME)
|
||||
* @param bool $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 integer $method authentication method
|
||||
*/
|
||||
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 Basic Authentication username
|
||||
* @param string $password Basic Authentication password
|
||||
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||
* @param string $username Authentication username (deprecated)
|
||||
* @param string $password Authentication password (deprecated)
|
||||
* @return Unirest\Response
|
||||
*/
|
||||
public static function get($url, $headers = array(), $parameters = null, $username = null, $password = null)
|
||||
{
|
||||
@@ -66,9 +244,9 @@ class Request
|
||||
* @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
|
||||
* @param string $password Basic Authentication password
|
||||
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||
* @param string $username Basic Authentication username (deprecated)
|
||||
* @param string $password Basic Authentication password (deprecated)
|
||||
* @return Unirest\Response
|
||||
*/
|
||||
public static function head($url, $headers = array(), $parameters = null, $username = null, $password = null)
|
||||
{
|
||||
@@ -82,7 +260,7 @@ class Request
|
||||
* @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
|
||||
* @return Unirest\Response
|
||||
*/
|
||||
public static function options($url, $headers = array(), $parameters = null, $username = null, $password = null)
|
||||
{
|
||||
@@ -94,9 +272,9 @@ class Request
|
||||
* @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
|
||||
* @param string $password Basic Authentication password
|
||||
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||
* @param string $username Basic Authentication username (deprecated)
|
||||
* @param string $password Basic Authentication password (deprecated)
|
||||
* @return Unirest\Response
|
||||
*/
|
||||
public static function connect($url, $headers = array(), $parameters = null, $username = null, $password = null)
|
||||
{
|
||||
@@ -108,9 +286,9 @@ class Request
|
||||
* @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
|
||||
* @param string $username Basic Authentication username (deprecated)
|
||||
* @param string $password Basic Authentication password (deprecated)
|
||||
* @return Unirest\Response response
|
||||
*/
|
||||
public static function post($url, $headers = array(), $body = null, $username = null, $password = null)
|
||||
{
|
||||
@@ -122,9 +300,9 @@ class Request
|
||||
* @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
|
||||
* @param string $username Basic Authentication username (deprecated)
|
||||
* @param string $password Basic Authentication password (deprecated)
|
||||
* @return Unirest\Response
|
||||
*/
|
||||
public static function delete($url, $headers = array(), $body = null, $username = null, $password = null)
|
||||
{
|
||||
@@ -136,9 +314,9 @@ class Request
|
||||
* @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
|
||||
* @param string $username Basic Authentication username (deprecated)
|
||||
* @param string $password Basic Authentication password (deprecated)
|
||||
* @return Unirest\Response
|
||||
*/
|
||||
public static function put($url, $headers = array(), $body = null, $username = null, $password = null)
|
||||
{
|
||||
@@ -150,9 +328,9 @@ class Request
|
||||
* @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
|
||||
* @param string $username Basic Authentication username (deprecated)
|
||||
* @param string $password Basic Authentication password (deprecated)
|
||||
* @return Unirest\Response
|
||||
*/
|
||||
public static function patch($url, $headers = array(), $body = null, $username = null, $password = null)
|
||||
{
|
||||
@@ -164,9 +342,9 @@ class Request
|
||||
* @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
|
||||
* @param string $password Basic Authentication password
|
||||
* @return string|stdObj response string or stdObj if response is json-decodable
|
||||
* @param string $username Basic Authentication username (deprecated)
|
||||
* @param string $password Basic Authentication password (deprecated)
|
||||
* @return Unirest\Response
|
||||
*/
|
||||
public static function trace($url, $headers = array(), $body = null, $username = null, $password = null)
|
||||
{
|
||||
@@ -176,6 +354,9 @@ class Request
|
||||
/**
|
||||
* This function is useful for serializing multidimensional arrays, and avoid getting
|
||||
* the 'Array to string conversion' notice
|
||||
* @param array|object $data array to flatten.
|
||||
* @param bool|string $parent parent key or false if no parent
|
||||
* @return array
|
||||
*/
|
||||
public static function buildHTTPCurlQuery($data, $parent = false)
|
||||
{
|
||||
@@ -204,47 +385,23 @@ class Request
|
||||
|
||||
/**
|
||||
* Send a cURL request
|
||||
* @param Unirest\Method $method HTTP method to use
|
||||
* @param Unirest\Method|string $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 Basic Authentication username
|
||||
* @param string $password Basic Authentication password
|
||||
* @throws Exception if a cURL error occurs
|
||||
* @param string $username Authentication username (deprecated)
|
||||
* @param string $password Authentication password (deprecated)
|
||||
* @throws Unirest\Exception if a cURL error occurs
|
||||
* @return Unirest\Response
|
||||
*/
|
||||
private static function send($method, $url, $body = null, $headers = array(), $username = null, $password = null)
|
||||
public static function send($method, $url, $body = null, $headers = array(), $username = null, $password = null)
|
||||
{
|
||||
if ($headers == null) {
|
||||
$headers = array();
|
||||
}
|
||||
self::$handle = curl_init();
|
||||
|
||||
$lowercaseHeaders = array();
|
||||
$finalHeaders = array_merge($headers, self::$defaultHeaders);
|
||||
foreach ($finalHeaders as $key => $val) {
|
||||
$lowercaseHeaders[] = self::getHeader($key, $val);
|
||||
}
|
||||
if ($method !== Method::GET) {
|
||||
curl_setopt(self::$handle, CURLOPT_CUSTOMREQUEST, $method);
|
||||
|
||||
$lowerCaseFinalHeaders = array_change_key_case($finalHeaders);
|
||||
|
||||
if (!array_key_exists('user-agent', $lowerCaseFinalHeaders)) {
|
||||
$lowercaseHeaders[] = 'user-agent: unirest-php/2.0';
|
||||
}
|
||||
|
||||
if (!array_key_exists('expect', $lowerCaseFinalHeaders)) {
|
||||
$lowercaseHeaders[] = 'expect:';
|
||||
}
|
||||
|
||||
$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);
|
||||
}
|
||||
curl_setopt(self::$handle, CURLOPT_POSTFIELDS, $body);
|
||||
} elseif (is_array($body)) {
|
||||
if (strpos($url, '?') !== false) {
|
||||
$url .= '&';
|
||||
@@ -255,38 +412,113 @@ class Request
|
||||
$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, $lowercaseHeaders);
|
||||
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.
|
||||
$curl_base_options = [
|
||||
CURLOPT_URL => self::encodeUrl($url),
|
||||
CURLOPT_RETURNTRANSFER => true,
|
||||
CURLOPT_FOLLOWLOCATION => true,
|
||||
CURLOPT_MAXREDIRS => 10,
|
||||
CURLOPT_HTTPHEADER => self::getFormattedHeaders($headers),
|
||||
CURLOPT_HEADER => true,
|
||||
CURLOPT_SSL_VERIFYPEER => self::$verifyPeer,
|
||||
//CURLOPT_SSL_VERIFYHOST accepts only 0 (false) or 2 (true). Future versions of libcurl will treat values 1 and 2 as equals
|
||||
CURLOPT_SSL_VERIFYHOST => self::$verifyHost === false ? 0 : 2,
|
||||
// If an empty string, '', is set, a header containing all supported encoding types is sent
|
||||
CURLOPT_ENCODING => ''
|
||||
];
|
||||
|
||||
if (self::$socketTimeout != null) {
|
||||
curl_setopt($ch, CURLOPT_TIMEOUT, self::$socketTimeout);
|
||||
curl_setopt_array(self::$handle, self::mergeCurlOptions($curl_base_options, self::$curlOpts));
|
||||
|
||||
if (self::$socketTimeout !== null) {
|
||||
curl_setopt(self::$handle, CURLOPT_TIMEOUT, self::$socketTimeout);
|
||||
}
|
||||
|
||||
if (self::$cookie) {
|
||||
curl_setopt(self::$handle, CURLOPT_COOKIE, self::$cookie);
|
||||
}
|
||||
|
||||
if (self::$cookieFile) {
|
||||
curl_setopt(self::$handle, CURLOPT_COOKIEFILE, self::$cookieFile);
|
||||
curl_setopt(self::$handle, CURLOPT_COOKIEJAR, self::$cookieFile);
|
||||
}
|
||||
|
||||
// supporting deprecated http auth method
|
||||
if (!empty($username)) {
|
||||
curl_setopt($ch, CURLOPT_USERPWD, $username . ':' . ((empty($password)) ? '' : $password));
|
||||
curl_setopt_array(self::$handle, array(
|
||||
CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
|
||||
CURLOPT_USERPWD => $username . ':' . $password
|
||||
));
|
||||
}
|
||||
|
||||
$response = curl_exec($ch);
|
||||
$error = curl_error($ch);
|
||||
if (!empty(self::$auth['user'])) {
|
||||
curl_setopt_array(self::$handle, array(
|
||||
CURLOPT_HTTPAUTH => self::$auth['method'],
|
||||
CURLOPT_USERPWD => self::$auth['user'] . ':' . self::$auth['pass']
|
||||
));
|
||||
}
|
||||
|
||||
if (self::$proxy['address'] !== false) {
|
||||
curl_setopt_array(self::$handle, array(
|
||||
CURLOPT_PROXYTYPE => self::$proxy['type'],
|
||||
CURLOPT_PROXY => self::$proxy['address'],
|
||||
CURLOPT_PROXYPORT => self::$proxy['port'],
|
||||
CURLOPT_HTTPPROXYTUNNEL => self::$proxy['tunnel'],
|
||||
CURLOPT_PROXYAUTH => self::$proxy['auth']['method'],
|
||||
CURLOPT_PROXYUSERPWD => self::$proxy['auth']['user'] . ':' . self::$proxy['auth']['pass']
|
||||
));
|
||||
}
|
||||
|
||||
$response = curl_exec(self::$handle);
|
||||
$error = curl_error(self::$handle);
|
||||
$info = self::getInfo();
|
||||
|
||||
if ($error) {
|
||||
throw new \Exception($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_size = $info['header_size'];
|
||||
$header = substr($response, 0, $header_size);
|
||||
$body = substr($response, $header_size);
|
||||
$httpCode = $curl_info['http_code'];
|
||||
$httpCode = $info['http_code'];
|
||||
|
||||
return new Response($httpCode, $body, $header);
|
||||
return new Response($httpCode, $body, $header, self::$jsonOpts);
|
||||
}
|
||||
|
||||
public static function getInfo($opt = false)
|
||||
{
|
||||
if ($opt) {
|
||||
$info = curl_getinfo(self::$handle, $opt);
|
||||
} else {
|
||||
$info = curl_getinfo(self::$handle);
|
||||
}
|
||||
|
||||
return $info;
|
||||
}
|
||||
|
||||
public static function getCurlHandle()
|
||||
{
|
||||
return self::$handle;
|
||||
}
|
||||
|
||||
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)
|
||||
@@ -315,11 +547,11 @@ class Request
|
||||
$path = (isset($url_parsed['path']) ? $url_parsed['path'] : null);
|
||||
$query = (isset($url_parsed['query']) ? $url_parsed['query'] : null);
|
||||
|
||||
if ($query != null) {
|
||||
if ($query !== null) {
|
||||
$query = '?' . http_build_query(self::getArrayFromQuerystring($query));
|
||||
}
|
||||
|
||||
if ($port && $port[0] != ':') {
|
||||
if ($port && $port[0] !== ':') {
|
||||
$port = ':' . $port;
|
||||
}
|
||||
|
||||
@@ -327,9 +559,20 @@ class Request
|
||||
return $result;
|
||||
}
|
||||
|
||||
private static function getHeader($key, $val)
|
||||
private static function getHeaderString($key, $val)
|
||||
{
|
||||
$key = trim(strtolower($key));
|
||||
return $key . ': ' . $val;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $existing_options
|
||||
* @param array $new_options
|
||||
* @return array
|
||||
*/
|
||||
private static function mergeCurlOptions(&$existing_options, $new_options)
|
||||
{
|
||||
$existing_options = $new_options + $existing_options;
|
||||
return $existing_options;
|
||||
}
|
||||
}
|
||||
|
||||
66
src/Unirest/Request/Body.php
Normal file
66
src/Unirest/Request/Body.php
Normal file
@@ -0,0 +1,66 @@
|
||||
<?php
|
||||
|
||||
namespace Unirest\Request;
|
||||
|
||||
use Unirest\Request as Request;
|
||||
use Unirest\Exception as Exception;
|
||||
|
||||
class Body
|
||||
{
|
||||
/**
|
||||
* Prepares a file for upload. To be used inside the parameters declaration for a request.
|
||||
* @param string $filename The file path
|
||||
* @param string $mimetype MIME type
|
||||
* @param string $postname the file name
|
||||
* @return string|\CURLFile
|
||||
*/
|
||||
public static function File($filename, $mimetype = '', $postname = '')
|
||||
{
|
||||
if (class_exists('CURLFile')) {
|
||||
return new \CURLFile($filename, $mimetype, $postname);
|
||||
}
|
||||
|
||||
if (function_exists('curl_file_create')) {
|
||||
return curl_file_create($filename, $mimetype, $postname);
|
||||
}
|
||||
|
||||
return sprintf('@%s;filename=%s;type=%s', $filename, $postname ?: basename($filename), $mimetype);
|
||||
}
|
||||
|
||||
public static function Json($data)
|
||||
{
|
||||
if (!function_exists('json_encode')) {
|
||||
throw new Exception('JSON Extension not available');
|
||||
}
|
||||
|
||||
return json_encode($data);
|
||||
}
|
||||
|
||||
public static function Form($data)
|
||||
{
|
||||
if (is_array($data) || is_object($data) || $data instanceof \Traversable) {
|
||||
return http_build_query(Request::buildHTTPCurlQuery($data));
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
public static function Multipart($data, $files = false)
|
||||
{
|
||||
if (is_object($data)) {
|
||||
return get_object_vars($data);
|
||||
}
|
||||
|
||||
if (!is_array($data)) {
|
||||
return array($data);
|
||||
}
|
||||
|
||||
if ($files !== false) {
|
||||
foreach ($files as $name => $file) {
|
||||
$data[$name] = call_user_func(array(__CLASS__, 'File'), $file);
|
||||
}
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
@@ -13,25 +13,34 @@ class Response
|
||||
* @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)
|
||||
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;
|
||||
$json = json_decode($raw_body);
|
||||
|
||||
// make sure raw_body is the first argument
|
||||
array_unshift($json_args, $raw_body);
|
||||
|
||||
if (function_exists('json_decode')) {
|
||||
$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
|
||||
* @param string $raw_headers raw headers
|
||||
* @return array
|
||||
*/
|
||||
private function parseHeaders($raw_headers)
|
||||
{
|
||||
|
||||
89
tests/Unirest/BodyTest.php
Normal file
89
tests/Unirest/BodyTest.php
Normal file
@@ -0,0 +1,89 @@
|
||||
<?php
|
||||
|
||||
namespace Unirest\Request\Body\Test;
|
||||
|
||||
use Unirest\Request as Request;
|
||||
use Unirest\Request\Body as Body;
|
||||
|
||||
require_once __DIR__ . '/../../src/Unirest.php';
|
||||
|
||||
class BodyTest extends \PHPUnit_Framework_TestCase
|
||||
{
|
||||
public function testCURLFile()
|
||||
{
|
||||
$fixture = __DIR__ . '/fixtures/upload.txt';
|
||||
|
||||
$file = Body::File($fixture);
|
||||
|
||||
if (PHP_MAJOR_VERSION === 5 && PHP_MINOR_VERSION === 4) {
|
||||
$this->assertEquals($file, sprintf('@%s;filename=%s;type=', $fixture, basename($fixture)));
|
||||
} else {
|
||||
$this->assertTrue($file instanceof \CURLFile);
|
||||
}
|
||||
}
|
||||
|
||||
public function testHttpBuildQueryWithCurlFile()
|
||||
{
|
||||
$fixture = __DIR__ . '/fixtures/upload.txt';
|
||||
|
||||
$file = Body::File($fixture);
|
||||
$body = array(
|
||||
'to' => 'mail@mailinator.com',
|
||||
'from' => 'mail@mailinator.com',
|
||||
'file' => $file
|
||||
);
|
||||
|
||||
$result = Request::buildHTTPCurlQuery($body);
|
||||
$this->assertEquals($result['file'], $file);
|
||||
}
|
||||
|
||||
public function testJson()
|
||||
{
|
||||
$body = Body::Json(array('foo', 'bar'));
|
||||
|
||||
$this->assertEquals($body, '["foo","bar"]');
|
||||
}
|
||||
|
||||
public function testForm()
|
||||
{
|
||||
$body = Body::Form(array('foo' => 'bar', 'bar' => 'baz'));
|
||||
|
||||
$this->assertEquals($body, 'foo=bar&bar=baz');
|
||||
|
||||
// try again with a string
|
||||
$body = Body::Form($body);
|
||||
|
||||
$this->assertEquals($body, 'foo=bar&bar=baz');
|
||||
}
|
||||
|
||||
public function testMultipart()
|
||||
{
|
||||
$arr = array('foo' => 'bar', 'bar' => 'baz');
|
||||
|
||||
$body = Body::Multipart((object) $arr);
|
||||
|
||||
$this->assertEquals($body, $arr);
|
||||
|
||||
$body = Body::Multipart('flat');
|
||||
|
||||
$this->assertEquals($body, array('flat'));
|
||||
}
|
||||
|
||||
public function testMultipartFiles()
|
||||
{
|
||||
$fixture = __DIR__ . '/fixtures/upload.txt';
|
||||
|
||||
$data = array('foo' => 'bar', 'bar' => 'baz');
|
||||
$files = array('test' => $fixture);
|
||||
|
||||
$body = Body::Multipart($data, $files);
|
||||
|
||||
// echo $body;
|
||||
|
||||
$this->assertEquals($body, array(
|
||||
'foo' => 'bar',
|
||||
'bar' => 'baz',
|
||||
'test' => Body::File($fixture)
|
||||
));
|
||||
}
|
||||
}
|
||||
@@ -1,17 +0,0 @@
|
||||
<?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);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,114 +1,156 @@
|
||||
<?php
|
||||
|
||||
namespace Unirest\Request\Test;
|
||||
|
||||
use Unirest\Request as Request;
|
||||
|
||||
require __DIR__ . '/../../src/Unirest.php';
|
||||
|
||||
class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
{
|
||||
// Generic
|
||||
public function testHttpBuildQueryWhenCurlFile()
|
||||
public function testCurlOpts()
|
||||
{
|
||||
$file = Unirest\File::add(UPLOAD_FIXTURE);
|
||||
$body = array(
|
||||
'to' => 'mail@mailinator.com',
|
||||
'from' => 'mail@mailinator.com',
|
||||
'file' => $file
|
||||
);
|
||||
Request::curlOpt(CURLOPT_COOKIE, 'foo=bar');
|
||||
|
||||
$result = Unirest\Request::buildHTTPCurlQuery($body);
|
||||
$this->assertEquals($result['file'], $file);
|
||||
$response = Request::get('http://mockbin.com/request');
|
||||
|
||||
$this->assertTrue(property_exists($response->body->cookies, 'foo'));
|
||||
|
||||
Request::clearCurlOpts();
|
||||
}
|
||||
|
||||
/**
|
||||
* @expectedException Exception
|
||||
* @expectedException \Unirest\Exception
|
||||
*/
|
||||
public function testTimeoutFail()
|
||||
{
|
||||
Unirest\Request::timeout(1);
|
||||
Request::timeout(1);
|
||||
|
||||
Unirest\Request::get('http://httpbin.org/delay/3');
|
||||
Request::get('http://mockbin.com/delay/1000');
|
||||
|
||||
Unirest\Request::timeout(null); // Cleaning timeout for the other tests
|
||||
Request::timeout(null); // Cleaning timeout for the other tests
|
||||
}
|
||||
|
||||
public function testTimeoutSuccess()
|
||||
public function testDefaultHeaders()
|
||||
{
|
||||
Unirest\Request::timeout(3);
|
||||
$defaultHeaders = array(
|
||||
'header1' => 'Hello',
|
||||
'header2' => 'world'
|
||||
);
|
||||
Request::defaultHeaders($defaultHeaders);
|
||||
|
||||
$response = Request::get('http://mockbin.com/request');
|
||||
|
||||
$response = Unirest\Request::get('http://httpbin.org/delay/1');
|
||||
$this->assertEquals(200, $response->code);
|
||||
$this->assertObjectHasAttribute('header1', $response->body->headers);
|
||||
$this->assertEquals('Hello', $response->body->headers->header1);
|
||||
$this->assertObjectHasAttribute('header2', $response->body->headers);
|
||||
$this->assertEquals('world', $response->body->headers->header2);
|
||||
|
||||
Unirest\Request::timeout(null); // Cleaning timeout for the other tests
|
||||
Request::clearDefaultHeaders();
|
||||
|
||||
$response = Request::get('http://mockbin.com/request');
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$this->assertObjectNotHasAttribute('header1', $response->body->headers);
|
||||
$this->assertObjectNotHasAttribute('header2', $response->body->headers);
|
||||
}
|
||||
|
||||
public function testDefaultHeader()
|
||||
{
|
||||
Unirest\Request::defaultHeader('Hello', 'custom');
|
||||
$response = Unirest\Request::get('http://httpbin.org/get');
|
||||
Request::defaultHeader('Hello', 'custom');
|
||||
|
||||
$response = Request::get('http://mockbin.com/request');
|
||||
|
||||
$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->assertTrue(property_exists($response->body->headers, 'hello'));
|
||||
$this->assertEquals('custom', $response->body->headers->hello);
|
||||
|
||||
Request::clearDefaultHeaders();
|
||||
|
||||
$response = Request::get('http://mockbin.com/request');
|
||||
|
||||
$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->assertFalse(property_exists($response->body->headers, 'hello'));
|
||||
}
|
||||
|
||||
public function testSetMashapeKey()
|
||||
{
|
||||
Request::setMashapeKey('abcd');
|
||||
|
||||
$response = Request::get('http://mockbin.com/request');
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$headers = $response->body->headers;
|
||||
$properties = get_object_vars($headers);
|
||||
$this->assertFalse(array_key_exists('Hello', $properties));
|
||||
$this->assertTrue(property_exists($response->body->headers, 'x-mashape-key'));
|
||||
$this->assertEquals('abcd', $response->body->headers->{'x-mashape-key'});
|
||||
|
||||
// send another request
|
||||
$response = Request::get('http://mockbin.com/request');
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$this->assertTrue(property_exists($response->body->headers, 'x-mashape-key'));
|
||||
$this->assertEquals('abcd', $response->body->headers->{'x-mashape-key'});
|
||||
|
||||
Request::clearDefaultHeaders();
|
||||
|
||||
$response = Request::get('http://mockbin.com/request');
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$this->assertFalse(property_exists($response->body->headers, 'x-mashape-key'));
|
||||
}
|
||||
|
||||
public function testGzip()
|
||||
{
|
||||
$response = Unirest\Request::get('http://httpbin.org/gzip');
|
||||
$args = $response->body;
|
||||
$this->assertEquals(true, $args->gzipped);
|
||||
$response = Request::get('http://mockbin.com/gzip/request');
|
||||
|
||||
$this->assertEquals('gzip', $response->headers['Content-Encoding']);
|
||||
}
|
||||
|
||||
public function testBasicAuthenticationDeprecated()
|
||||
{
|
||||
$response = Request::get('http://mockbin.com/request', array(), array(), 'user', 'password');
|
||||
|
||||
$this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $response->body->headers->authorization);
|
||||
}
|
||||
|
||||
public function testBasicAuthentication()
|
||||
{
|
||||
$response = Unirest\Request::get('http://httpbin.org/get', array(), array(), 'user', 'password');
|
||||
$headers = $response->body->headers;
|
||||
$this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $headers->Authorization);
|
||||
Request::auth('user', 'password');
|
||||
|
||||
$response = Request::get('http://mockbin.com/request');
|
||||
|
||||
$this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $response->body->headers->authorization);
|
||||
}
|
||||
|
||||
public function testCustomHeaders()
|
||||
{
|
||||
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||
'user-agent' => 'ciao',
|
||||
$response = Request::get('http://mockbin.com/request', array(
|
||||
'user-agent' => 'unirest-php',
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
|
||||
$headers = $response->body->headers;
|
||||
$this->assertEquals('ciao', $headers->{'User-Agent'});
|
||||
$this->assertEquals('unirest-php', $response->body->headers->{'user-agent'});
|
||||
}
|
||||
|
||||
// GET
|
||||
public function testGet()
|
||||
{
|
||||
$response = Unirest\Request::get('http://httpbin.org/get?name=Mark', array(
|
||||
$response = Request::get('http://mockbin.com/request?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);
|
||||
$this->assertEquals('GET', $response->body->method);
|
||||
$this->assertEquals('Mark', $response->body->queryString->name);
|
||||
$this->assertEquals('thefosk', $response->body->queryString->nick);
|
||||
}
|
||||
|
||||
public function testGetMultidimensionalArray()
|
||||
{
|
||||
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||
$response = Request::get('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'key' => 'value',
|
||||
@@ -119,17 +161,15 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
));
|
||||
|
||||
$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]'});
|
||||
$this->assertEquals('GET', $response->body->method);
|
||||
$this->assertEquals('value', $response->body->queryString->key);
|
||||
$this->assertEquals('item1', $response->body->queryString->items[0]);
|
||||
$this->assertEquals('item2', $response->body->queryString->items[1]);
|
||||
}
|
||||
|
||||
public function testGetWithDots()
|
||||
{
|
||||
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||
$response = Request::get('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'user.name' => 'Mark',
|
||||
@@ -137,15 +177,14 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
|
||||
$args = $response->body->args;
|
||||
$this->assertEquals('Mark', $args->{'user.name'});
|
||||
$this->assertEquals('thefosk', $args->nick);
|
||||
$this->assertEquals('GET', $response->body->method);
|
||||
$this->assertEquals('Mark', $response->body->queryString->{'user.name'});
|
||||
$this->assertEquals('thefosk', $response->body->queryString->nick);
|
||||
}
|
||||
|
||||
public function testGetWithDotsAlt()
|
||||
{
|
||||
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||
$response = Request::get('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'user.name' => 'Mark Bond',
|
||||
@@ -153,55 +192,63 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
|
||||
$args = $response->body->args;
|
||||
$this->assertEquals('Mark Bond', $args->{'user.name'});
|
||||
$this->assertEquals('thefosk', $args->nick);
|
||||
$this->assertEquals('GET', $response->body->method);
|
||||
$this->assertEquals('Mark Bond', $response->body->queryString->{'user.name'});
|
||||
$this->assertEquals('thefosk', $response->body->queryString->nick);
|
||||
}
|
||||
|
||||
public function testGetWithEqualSign()
|
||||
{
|
||||
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||
$response = Request::get('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'name' => 'Mark=Hello'
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$this->assertEquals('GET', $response->body->method);
|
||||
$this->assertEquals('Mark=Hello', $response->body->queryString->name);
|
||||
}
|
||||
|
||||
$args = $response->body->args;
|
||||
$this->assertEquals('Mark=Hello', $args->name);
|
||||
|
||||
$response = Unirest\Request::get('http://httpbin.org/get', array(
|
||||
public function testGetWithEqualSignAlt()
|
||||
{
|
||||
$response = Request::get('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'name' => 'Mark=Hello=John'
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$this->assertEquals('GET', $response->body->method);
|
||||
$this->assertEquals('Mark=Hello=John', $response->body->queryString->name);
|
||||
}
|
||||
|
||||
$args = $response->body->args;
|
||||
$this->assertEquals('Mark=Hello=John', $args->name);
|
||||
public function testGetWithComplexQuery()
|
||||
{
|
||||
$response = Request::get('http://mockbin.com/request?query=[{"type":"/music/album","name":null,"artist":{"id":"/en/bob_dylan"},"limit":3}]&cursor');
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$this->assertEquals('GET', $response->body->method);
|
||||
$this->assertEquals('', $response->body->queryString->cursor);
|
||||
$this->assertEquals('[{"type":"/music/album","name":null,"artist":{"id":"/en/bob_dylan"},"limit":3}]', $response->body->queryString->query);
|
||||
}
|
||||
|
||||
public function testGetArray()
|
||||
{
|
||||
$response = Unirest\Request::get('http://httpbin.org/get', array(), array(
|
||||
$response = Request::get('http://mockbin.com/request', 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]'});
|
||||
$this->assertEquals('GET', $response->body->method);
|
||||
$this->assertEquals('Mark', $response->body->queryString->name[0]);
|
||||
$this->assertEquals('John', $response->body->queryString->name[1]);
|
||||
}
|
||||
|
||||
// POST
|
||||
public function testPost()
|
||||
{
|
||||
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||
$response = Request::post('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'name' => 'Mark',
|
||||
@@ -209,29 +256,65 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$this->assertEquals('POST', $response->body->method);
|
||||
$this->assertEquals('Mark', $response->body->postData->params->name);
|
||||
$this->assertEquals('thefosk', $response->body->postData->params->nick);
|
||||
}
|
||||
|
||||
$form = $response->body->form;
|
||||
$this->assertEquals('Mark', $form->name);
|
||||
$this->assertEquals('thefosk', $form->nick);
|
||||
public function testPostForm()
|
||||
{
|
||||
$body = Request\Body::Form(array(
|
||||
'name' => 'Mark',
|
||||
'nick' => 'thefosk'
|
||||
));
|
||||
|
||||
$response = Request::post('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), $body);
|
||||
|
||||
$this->assertEquals('POST', $response->body->method);
|
||||
$this->assertEquals('application/x-www-form-urlencoded', $response->body->headers->{'content-type'});
|
||||
$this->assertEquals('application/x-www-form-urlencoded', $response->body->postData->mimeType);
|
||||
$this->assertEquals('Mark', $response->body->postData->params->name);
|
||||
$this->assertEquals('thefosk', $response->body->postData->params->nick);
|
||||
}
|
||||
|
||||
public function testPostMultipart()
|
||||
{
|
||||
$body = Request\Body::Multipart(array(
|
||||
'name' => 'Mark',
|
||||
'nick' => 'thefosk'
|
||||
));
|
||||
|
||||
$response = Request::post('http://mockbin.com/request', (object) array(
|
||||
'Accept' => 'application/json',
|
||||
), $body);
|
||||
|
||||
$this->assertEquals('POST', $response->body->method);
|
||||
$this->assertEquals('multipart/form-data', explode(';', $response->body->headers->{'content-type'})[0]);
|
||||
$this->assertEquals('multipart/form-data', $response->body->postData->mimeType);
|
||||
$this->assertEquals('Mark', $response->body->postData->params->name);
|
||||
$this->assertEquals('thefosk', $response->body->postData->params->nick);
|
||||
}
|
||||
|
||||
public function testPostWithEqualSign()
|
||||
{
|
||||
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
$body = Request\Body::Form(array(
|
||||
'name' => 'Mark=Hello'
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$response = Request::post('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), $body);
|
||||
|
||||
$form = $response->body->form;
|
||||
$this->assertEquals('Mark=Hello', $form->name);
|
||||
$this->assertEquals(200, $response->code);
|
||||
$this->assertEquals('POST', $response->body->method);
|
||||
$this->assertEquals('Mark=Hello', $response->body->postData->params->name);
|
||||
}
|
||||
|
||||
public function testPostArray()
|
||||
{
|
||||
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||
$response = Request::post('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'name[0]' => 'Mark',
|
||||
@@ -239,16 +322,14 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
|
||||
$form = $response->body->form;
|
||||
|
||||
$this->assertEquals('Mark', $form->{'name[0]'});
|
||||
$this->assertEquals('John', $form->{'name[1]'});
|
||||
$this->assertEquals('POST', $response->body->method);
|
||||
$this->assertEquals('Mark', $response->body->postData->params->{'name[0]'});
|
||||
$this->assertEquals('John', $response->body->postData->params->{'name[1]'});
|
||||
}
|
||||
|
||||
public function testPostWithDots()
|
||||
{
|
||||
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||
$response = Request::post('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'user.name' => 'Mark',
|
||||
@@ -256,15 +337,14 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
|
||||
$form = $response->body->form;
|
||||
$this->assertEquals('Mark', $form->{'user.name'});
|
||||
$this->assertEquals('thefosk', $form->nick);
|
||||
$this->assertEquals('POST', $response->body->method);
|
||||
$this->assertEquals('Mark', $response->body->postData->params->{'user.name'});
|
||||
$this->assertEquals('thefosk', $response->body->postData->params->nick);
|
||||
}
|
||||
|
||||
public function testRawPost()
|
||||
{
|
||||
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||
$response = Request::post('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json',
|
||||
'Content-Type' => 'application/json'
|
||||
), json_encode(array(
|
||||
@@ -272,17 +352,13 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
)));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
|
||||
$json = $response->body->json;
|
||||
|
||||
$this->assertEquals('Sam Sullivan', $json->author);
|
||||
$this->assertEquals('POST', $response->body->method);
|
||||
$this->assertEquals('Sam Sullivan', json_decode($response->body->postData->text)->author);
|
||||
}
|
||||
|
||||
public function testPostMultidimensionalArray()
|
||||
{
|
||||
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
$body = Request\Body::Form(array(
|
||||
'key' => 'value',
|
||||
'items' => array(
|
||||
'item1',
|
||||
@@ -290,18 +366,21 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
)
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$response = Request::post('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), $body);
|
||||
|
||||
$form = $response->body->form;
|
||||
$this->assertEquals('value', $form->key);
|
||||
$this->assertEquals('item1', $form->{'items[0]'});
|
||||
$this->assertEquals('item2', $form->{'items[1]'});
|
||||
$this->assertEquals(200, $response->code);
|
||||
$this->assertEquals('POST', $response->body->method);
|
||||
$this->assertEquals('value', $response->body->postData->params->key);
|
||||
$this->assertEquals('item1', $response->body->postData->params->{'items[0]'});
|
||||
$this->assertEquals('item2', $response->body->postData->params->{'items[1]'});
|
||||
}
|
||||
|
||||
// PUT
|
||||
public function testPut()
|
||||
{
|
||||
$response = Unirest\Request::put('http://httpbin.org/put', array(
|
||||
$response = Request::put('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'name' => 'Mark',
|
||||
@@ -309,16 +388,15 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
|
||||
$form = $response->body->form;
|
||||
$this->assertEquals('Mark', $form->name);
|
||||
$this->assertEquals('thefosk', $form->nick);
|
||||
$this->assertEquals('PUT', $response->body->method);
|
||||
$this->assertEquals('Mark', $response->body->postData->params->name);
|
||||
$this->assertEquals('thefosk', $response->body->postData->params->nick);
|
||||
}
|
||||
|
||||
// PATCH
|
||||
public function testPatch()
|
||||
{
|
||||
$response = Unirest\Request::patch('http://httpbin.org/patch', array(
|
||||
$response = Request::patch('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'name' => 'Mark',
|
||||
@@ -326,16 +404,15 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
|
||||
$form = $response->body->form;
|
||||
$this->assertEquals('Mark', $form->name);
|
||||
$this->assertEquals('thefosk', $form->nick);
|
||||
$this->assertEquals('PATCH', $response->body->method);
|
||||
$this->assertEquals('Mark', $response->body->postData->params->name);
|
||||
$this->assertEquals('thefosk', $response->body->postData->params->nick);
|
||||
}
|
||||
|
||||
// DELETE
|
||||
public function testDelete()
|
||||
{
|
||||
$response = Unirest\Request::delete('http://httpbin.org/delete', array(
|
||||
$response = Request::delete('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json',
|
||||
'Content-Type' => 'application/x-www-form-urlencoded'
|
||||
), array(
|
||||
@@ -344,42 +421,59 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
|
||||
));
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$data = $response->body->data;
|
||||
$this->assertTrue(empty($data));
|
||||
$this->assertEquals('DELETE', $response->body->method);
|
||||
}
|
||||
|
||||
// Upload
|
||||
public function testUpload()
|
||||
{
|
||||
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||
$fixture = __DIR__ . '/../fixtures/upload.txt';
|
||||
|
||||
$headers = array('Accept' => 'application/json');
|
||||
$files = array('file' => $fixture);
|
||||
$data = array('name' => 'ahmad');
|
||||
|
||||
$body = Request\Body::Multipart($data, $files);
|
||||
|
||||
$response = Request::post('http://mockbin.com/request', $headers, $body);
|
||||
|
||||
$this->assertEquals(200, $response->code);
|
||||
$this->assertEquals('POST', $response->body->method);
|
||||
$this->assertEquals('ahmad', $response->body->postData->params->name);
|
||||
$this->assertEquals('This is a test', $response->body->postData->params->file);
|
||||
}
|
||||
|
||||
public function testUploadWithoutHelper()
|
||||
{
|
||||
$fixture = __DIR__ . '/../fixtures/upload.txt';
|
||||
|
||||
$response = Request::post('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'name' => 'Mark',
|
||||
'file' => Unirest\File::add(UPLOAD_FIXTURE)
|
||||
'file' => Request\Body::File($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);
|
||||
$this->assertEquals('POST', $response->body->method);
|
||||
$this->assertEquals('Mark', $response->body->postData->params->name);
|
||||
$this->assertEquals('This is a test', $response->body->postData->params->file);
|
||||
}
|
||||
|
||||
public function testUploadIfFilePartOfData()
|
||||
{
|
||||
$response = Unirest\Request::post('http://httpbin.org/post', array(
|
||||
$fixture = __DIR__ . '/../fixtures/upload.txt';
|
||||
|
||||
$response = Request::post('http://mockbin.com/request', array(
|
||||
'Accept' => 'application/json'
|
||||
), array(
|
||||
'name' => 'Mark',
|
||||
'files[owl.gif]' => Unirest\File::add(UPLOAD_FIXTURE)
|
||||
'files[owl.gif]' => Request\Body::File($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);
|
||||
$this->assertEquals('POST', $response->body->method);
|
||||
$this->assertEquals('Mark', $response->body->postData->params->name);
|
||||
$this->assertEquals('This is a test', $response->body->postData->params->{'files[owl.gif]'});
|
||||
}
|
||||
}
|
||||
|
||||
35
tests/Unirest/ResponseTest.php
Normal file
35
tests/Unirest/ResponseTest.php
Normal file
@@ -0,0 +1,35 @@
|
||||
<?php
|
||||
|
||||
namespace Unirest\Response\Test;
|
||||
|
||||
use Unirest\Request as Request;
|
||||
use Unirest\Response as Response;
|
||||
|
||||
require __DIR__ . '/../../src/Unirest.php';
|
||||
|
||||
class UnirestResponseTest extends \PHPUnit_Framework_TestCase
|
||||
{
|
||||
public function testJSONAssociativeArrays()
|
||||
{
|
||||
$opts = Request::jsonOpts(true);
|
||||
$response = new Response(200, '{"a":1,"b":2,"c":3,"d":4,"e":5}', '', $opts);
|
||||
|
||||
$this->assertEquals($response->body['a'], 1);
|
||||
}
|
||||
|
||||
public function testJSONAObjects()
|
||||
{
|
||||
$opts = Request::jsonOpts(false);
|
||||
$response = new Response(200, '{"a":1,"b":2,"c":3,"d":4,"e":5}', '', $opts);
|
||||
|
||||
$this->assertEquals($response->body->a, 1);
|
||||
}
|
||||
|
||||
public function testJSONOpts()
|
||||
{
|
||||
$opts = Request::jsonOpts(false, 512, JSON_NUMERIC_CHECK);
|
||||
$response = new Response(200, '{"number": 1234567890}', '', $opts);
|
||||
|
||||
$this->assertSame($response->body->number, 1234567890);
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1 @@
|
||||
<?php
|
||||
|
||||
require_once __DIR__ . '/../src/Unirest.php';
|
||||
|
||||
define('UPLOAD_FIXTURE', __DIR__ . '/fixtures/upload.txt');
|
||||
<?php ?>
|
||||
|
||||
Reference in New Issue
Block a user