47 Commits

Author SHA1 Message Date
Ahmad Nassri
da71f063cf Merge pull request #88 from frankdee/master
improved solution to override cURL options …
2015-12-15 17:22:11 -05:00
frankdee
be5ee63ad1 shortened cURL options array merging 2015-12-14 19:17:31 +01:00
frankdee
32334a6bfa improved solution to override cURL options, that preserves the right indices in cURL option arrays
(Note: PHP seems to not override all options when calling 'curl_setopt_array(..)' several times after another)
2015-12-14 13:55:49 +01:00
Ahmad Nassri
e11c54d29c Merge pull request #86 from Mashape/curlopts-override-fix
allow to override curlopts
2015-12-11 18:41:55 -05:00
Ahmad Nassri
a3312a0ecd allow to override curlopts 2015-12-11 18:38:09 -05:00
Augusto Marietti
fde6f41733 Update README.md 2015-10-16 19:40:03 -07:00
Ahmad Nassri
75258a2024 Merge pull request #83 from mircobabini/patch-1
fix composer command
2015-09-03 11:12:21 -04:00
Mirco Babini
b330685820 fix composer command 2015-09-03 15:39:52 +02:00
Augusto Marietti
2f7aea9f63 Update README.md 2015-07-28 00:27:17 -07:00
Ahmad Nassri
f04b42e75e Merge pull request #81 from gabrielzerbib/master
phpdoc return type for ::post
2015-07-27 12:17:35 -07:00
Gabriel Zerbib
32c1a9fef0 Merge branch 'master' of https://github.com/gabrielzerbib/unirest-php 2015-07-27 22:07:56 +03:00
Gabriel
2b5b349036 phpdoc return type for ::post 2015-07-27 22:07:05 +03:00
Gabriel
1017f14ef5 phpdoc return type for ::post 2015-07-27 14:57:24 +03:00
Ahmad Nassri
99c6975f23 Merge pull request #79 from voodoodrul/patch-1
Allow disabling of CURLOPT_SSL_VERIFYHOST
2015-06-08 13:29:31 -04:00
Jesse Skrivseth
f257217434 Fix CURLOPT_SSL_VERIFYHOST issue
libcurl's CURLOPT_SSL_VERIFYHOST option accepts only values 0 and 2. This fix is fail-secure in that SSL host verification will be enabled regardless of what a caller passes to Request::verifyHost($bool) unless $bool === false.
2015-06-08 08:50:58 -06:00
Jesse Skrivseth
c9c0a85250 Allow disabling of CURLOPT_SSL_VERIFYHOST
Useful when the SSL cert has an invalid or non-resolvable hostname
2015-06-05 19:50:11 -06:00
Ahmad Nassri
3e375515fe Update README.md 2015-04-22 11:40:44 -04:00
Ahmad Nassri
b6fb76ce12 oops, forgot notifications 2015-04-09 12:29:10 -04:00
Ahmad Nassri
5926846300 events are required for gitter hook? 2015-04-09 12:02:12 -04:00
Ahmad Nassri
feae18f980 add gitter webhook 2015-04-09 11:22:15 -04:00
Ahmad Nassri
b0df287d64 README fix 2015-04-08 17:36:02 -04:00
Ahmad Nassri
4221ee5138 setting custom curl options
- `Unirest\Request::curlOpt()`
- `Unirest\Request::curlOpts()`
- `Unirest\Request::clearCurlOpts()`

fixes #78
2015-04-08 17:35:14 -04:00
Ahmad Nassri
ec5828c8aa Merge pull request #77 from cristianp6/master
Fixed "Undefined variable: ch" and add cookie string support
2015-04-03 13:08:41 -04:00
cristianp6
0293eb258c Add cookie string support, aka CURLOPT_COOKIE 2015-04-03 12:04:49 +02:00
cristianp6
a1ed45be55 Fixed "Notice: Undefined variable: ch" on curl_setopt cookieFile 2015-04-03 11:16:17 +02:00
Ahmad Nassri
8da79e7898 updating README and fixing typo 2015-04-02 14:22:32 -04:00
Ahmad Nassri
217b436124 manually applying PR by @daydiff due to complex merge issues, closes #67 2015-04-02 14:11:23 -04:00
Ahmad Nassri
d508bd9628 Merge pull request #76 from vlakarados/master
Add PHP version to readme.md's requirements
2015-03-30 03:40:31 -04:00
Sergey Telshevsky
7116894dad Add PHP version to readme.md's requirements 2015-03-30 10:33:46 +03:00
Ahmad Nassri
f31ce371a0 updating all tests and docs to mockbins.com 2015-03-07 06:00:42 -05:00
Ahmad Nassri
530905c7c9 switch to using curl_setopt_array for better readability, added utility methods Fixes #66 2015-03-01 02:48:16 -05:00
Ahmad Nassri
139b58019c Merge pull request #68 from thibaultCha/feature/set-mashape-key
Native 'setMashapeKey' method for X-Mashape-Key header
2015-02-10 20:16:30 -08:00
thibaultCha
8b47e051ba Set Mashape Key by calling setDefaultHeader 2015-02-05 23:02:12 -08:00
thibaultCha
491064f40b Add test for setMashapeKey 2015-02-05 21:09:01 -08:00
thibaultCha
fb241f6898 Native 'setMashapeKey' method for X-Mashape-Key header 2015-02-05 20:49:06 -08:00
Ahmad Nassri
f6fc64103f Update README.md 2015-02-05 14:31:38 -05:00
Ahmad Nassri
11cf1eaa9f Update README.md 2015-02-05 14:04:02 -05:00
Ahmad Nassri
d5a7ad40bd fix to deprecated method + more tests 2015-02-05 13:00:49 -05:00
Ahmad Nassri
8af870ff69 fix depreicated method as well! 2015-02-05 12:53:30 -05:00
Ahmad Nassri
ae01978eb3 php 5.4 cURL does not support setting username and password separately 2015-02-05 12:48:56 -05:00
Ahmad Nassri
2074abf904 keeping deprecated auth method functional 2015-02-05 12:22:46 -05:00
Ahmad Nassri
96cdf61101 allowing all native libcurl authentication methods 2015-02-05 12:19:47 -05:00
Ahmad Nassri
002c175cd1 typo fix 2015-02-05 11:41:42 -05:00
Ahmad Nassri
c5be546d1b Proxies!
closes #47
2015-02-05 11:33:59 -05:00
Ahmad Nassri
5fa02336f9 rounded corners for badges 2015-01-15 17:31:04 -05:00
Ahmad Nassri
23c3cb5b00 fix badge + unified description 2015-01-15 17:15:37 -05:00
Ahmad Nassri
8ce5204c37 updates to badges and text 2015-01-15 15:25:45 -05:00
4 changed files with 575 additions and 228 deletions

View File

@@ -26,3 +26,11 @@ matrix:
fast_finish: true fast_finish: true
allow_failures: allow_failures:
- php: hhvm - php: hhvm
notifications:
webhooks:
urls:
- https://webhooks.gitter.im/e/d4319553d0aecfd5b9ac
on_success: always
on_failure: always
on_start: false

210
README.md
View File

@@ -1,19 +1,24 @@
# 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] [![Downloads][packagist-downloads]][packagist-url]
[![Code Climate][codeclimate-image]][codeclimate-url] [![Code Climate][codeclimate-quality]][codeclimate-url]
[![Coverage Status][codecoverage-image]][codecoverage-url] [![Coverage Status][codeclimate-coverage]][codeclimate-url]
[![Dependency Status][dependency-image]][dependency-url] [![Dependencies][versioneye-image]][versioneye-url]
[![Gitter][gitter-image]][gitter-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 ## Features
* Utility methods to call `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` requests * Utility methods to call `GET`, `HEAD`, `POST`, `PUT`, `DELETE`, `CONNECT`, `OPTIONS`, `TRACE`, `PATCH` requests
* Supports form parameters, file uploads and custom body entities * 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
@@ -21,6 +26,7 @@ Unirest is a set of lightweight HTTP libraries available in multiple languages,
## Requirements ## Requirements
- [cURL](http://php.net/manual/en/book.curl.php) - [cURL](http://php.net/manual/en/book.curl.php)
- PHP 5.4+
## Installation ## Installation
@@ -45,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: 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 ```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: Composer installs autoloader at `./vendor/autoloader.php`. to include the library in your script, add:
@@ -60,7 +66,7 @@ If you use Symfony2, autoloader has to be detected automatically.
### Install from source ### 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 ```shell
git clone git@github.com:Mashape/unirest-php.git git clone git@github.com:Mashape/unirest-php.git
@@ -80,7 +86,7 @@ So you're probably wondering how using Unirest makes creating requests in PHP ea
$headers = array("Accept" => "application/json"); $headers = array("Accept" => "application/json");
$body = array("foo" => "hellow", "bar" => "world"); $body = array("foo" => "hellow", "bar" => "world");
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body); $response = Unirest\Request::post("http://mockbin.com/request", $headers, $body);
$response->code; // HTTP Status code $response->code; // HTTP Status code
$response->headers; // Headers $response->headers; // Headers
@@ -96,7 +102,7 @@ To upload files in a multipart form representation use the return value of `Unir
$headers = array("Accept" => "application/json"); $headers = array("Accept" => "application/json");
$body = array("file" => Unirest\File::add("/tmp/file.txt")); $body = array("file" => Unirest\File::add("/tmp/file.txt"));
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body); $response = Unirest\Request::post("http://mockbin.com/request", $headers, $body);
``` ```
### Custom Entity Body ### Custom Entity Body
@@ -106,32 +112,84 @@ Sending a custom body such as a JSON Object rather than a string or form style p
$headers = array("Accept" => "application/json"); $headers = array("Accept" => "application/json");
$body = json_encode(array("foo" => "hellow", "bar" => "world")); $body = json_encode(array("foo" => "hellow", "bar" => "world"));
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body); $response = Unirest\Request::post("http://mockbin.com/request", $headers, $body);
``` ```
### Basic Authentication ### Authentication
Authenticating the request with basic authentication can be done by providing the `username` and `password` arguments: 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 ```php
$response = Unirest\Request::get("http://httpbin.org/get", null, null, "username", "password"); // 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 ### Request Object
```php ```php
Unirest\Request::get($url, $headers = array(), $parameters = null, $username = null, $password = null) Unirest\Request::get($url, $headers = array(), $parameters = null)
Unirest\Request::post($url, $headers = array(), $body = null, $username = null, $password = null) Unirest\Request::post($url, $headers = array(), $body = null)
Unirest\Request::put($url, $headers = array(), $body = null, $username = null, $password = null) Unirest\Request::put($url, $headers = array(), $body = null)
Unirest\Request::patch($url, $headers = array(), $body = null, $username = null, $password = null) Unirest\Request::patch($url, $headers = array(), $body = null)
Unirest\Request::delete($url, $headers = array(), $body = null, $username = null, $password = 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
You can send a request with any [standard](http://www.iana.org/assignments/http-methods/http-methods.xhtml) or custom HTTP Method: You can send a request with any [standard](http://www.iana.org/assignments/http-methods/http-methods.xhtml) or custom HTTP Method:
@@ -157,7 +215,7 @@ You can set some advanced configuration to tune Unirest-PHP:
#### Custom JSON Decode Flags #### Custom JSON Decode Flags
Unirest uses PHP's [JSON Extension](http://php.net/manual/en/book.json.php) for automatically decoding JSON responses. 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). 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: To do so, simply set the desired options using the `jsonOpts` request method:
@@ -173,6 +231,45 @@ You can set a custom timeout value (in **seconds**):
Unirest\Request::timeout(5); // 5s timeout 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 #### 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:
@@ -182,7 +279,7 @@ Unirest\Request::defaultHeader("Header1", "Value1");
Unirest\Request::defaultHeader("Header2", "Value2"); Unirest\Request::defaultHeader("Header2", "Value2");
``` ```
You can do set default headers in bulk: You can set default headers in bulk by passing an array:
```php ```php
Unirest\Request::defaultHeaders(array( Unirest\Request::defaultHeaders(array(
@@ -197,6 +294,28 @@ You can clear the default headers anytime with:
Unirest\Request::clearDefaultHeaders(); 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 #### 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:
@@ -207,26 +326,41 @@ Unirest\Request::verifyPeer(false); // Disables SSL cert validation
By default is `true`. By default is `true`.
## License #### Utility Methods
Licensed under [the MIT license](https://github.com/Mashape/unirest-php/blob/master/LICENSE). ```php
// alias for `curl_getinfo`
Unirest\Request::getInfo()
Created with love by [Mashape](https://www.mashape.com/). // returns internal cURL handle
Unirest\Request::getCurlHandle()
```
----
Made with &#9829; 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-url]: https://gitter.im/Mashape/unirest-php
[gitter-image]: https://badges.gitter.im/Join%20Chat.svg [gitter-image]: https://img.shields.io/badge/Gitter-Join%20Chat-blue.svg?style=flat
[composer-url]: http://badge.fury.io/ph/mashape%2Funirest-php
[composer-image]: https://badge.fury.io/ph/mashape%2Funirest-php.svg
[travis-url]: https://travis-ci.org/Mashape/unirest-php [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-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 [versioneye-url]: https://www.versioneye.com/user/projects/54b82450050646ca5c0001f3
[codecoverage-image]: https://codeclimate.com/github/Mashape/unirest-php/badges/coverage.svg [versioneye-image]: https://img.shields.io/versioneye/d/php/mashape:unirest-php.svg?style=flat
[dependency-url]: https://www.versioneye.com/user/projects/54b702db050646ca5c00019d
[dependency-image]: https://www.versioneye.com/user/projects/54b702db050646ca5c00019d/badge.svg?style=flat

313
src/Unirest/Request.php Normal file → Executable file
View File

@@ -7,10 +7,33 @@ use Unirest\Response;
class Request class Request
{ {
private static $jsonOpts = array(); private static $cookie = null;
private static $verifyPeer = true; private static $cookieFile = null;
private static $socketTimeout = null; private static $curlOpts = array();
private static $defaultHeaders = 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 * Set JSON decode mode
@@ -34,6 +57,16 @@ class Request
return self::$verifyPeer = $enabled; return self::$verifyPeer = $enabled;
} }
/**
* Verify SSL host
*
* @param bool $enabled enable SSL host verification, by default is true
*/
public static function verifyHost($enabled)
{
return self::$verifyHost = $enabled;
}
/** /**
* Set a timeout * Set a timeout
* *
@@ -51,11 +84,7 @@ class Request
*/ */
public static function defaultHeaders($headers) public static function defaultHeaders($headers)
{ {
foreach ($headers as $name => $value) { return array_merge(self::$defaultHeaders, $headers);
self::$defaultHeaders[$name] = $value;
}
return $headers;
} }
/** /**
@@ -77,15 +106,126 @@ class Request
return 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
*/
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
*/
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 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 * Send a GET request to a URL
* *
* @param string $url URL to send the GET request to * @param string $url URL to send the GET request to
* @param array $headers additional headers to send * @param array $headers additional headers to send
* @param mixed $parameters parameters to send in the querystring * @param mixed $parameters parameters to send in the querystring
* @param string $username Basic Authentication username * @param string $username Authentication username (deprecated)
* @param string $password Basic Authentication password * @param string $password Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable * @return Unirest\Response
*/ */
public static function get($url, $headers = array(), $parameters = null, $username = null, $password = null) public static function get($url, $headers = array(), $parameters = null, $username = null, $password = null)
{ {
@@ -97,9 +237,9 @@ class Request
* @param string $url URL to send the HEAD request to * @param string $url URL to send the HEAD request to
* @param array $headers additional headers to send * @param array $headers additional headers to send
* @param mixed $parameters parameters to send in the querystring * @param mixed $parameters parameters to send in the querystring
* @param string $username Basic Authentication username * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password * @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable * @return Unirest\Response
*/ */
public static function head($url, $headers = array(), $parameters = null, $username = null, $password = null) public static function head($url, $headers = array(), $parameters = null, $username = null, $password = null)
{ {
@@ -113,7 +253,7 @@ class Request
* @param mixed $parameters parameters to send in the querystring * @param mixed $parameters parameters to send in the querystring
* @param string $username Basic Authentication username * @param string $username Basic Authentication username
* @param string $password Basic Authentication password * @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) public static function options($url, $headers = array(), $parameters = null, $username = null, $password = null)
{ {
@@ -125,9 +265,9 @@ class Request
* @param string $url URL to send the CONNECT request to * @param string $url URL to send the CONNECT request to
* @param array $headers additional headers to send * @param array $headers additional headers to send
* @param mixed $parameters parameters to send in the querystring * @param mixed $parameters parameters to send in the querystring
* @param string $username Basic Authentication username * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password * @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable * @return Unirest\Response
*/ */
public static function connect($url, $headers = array(), $parameters = null, $username = null, $password = null) public static function connect($url, $headers = array(), $parameters = null, $username = null, $password = null)
{ {
@@ -139,9 +279,9 @@ class Request
* @param string $url URL to send the POST request to * @param string $url URL to send the POST request to
* @param array $headers additional headers to send * @param array $headers additional headers to send
* @param mixed $body POST body data * @param mixed $body POST body data
* @param string $username Basic Authentication username * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password * @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable * @return Unirest\Response response
*/ */
public static function post($url, $headers = array(), $body = null, $username = null, $password = null) public static function post($url, $headers = array(), $body = null, $username = null, $password = null)
{ {
@@ -153,9 +293,9 @@ class Request
* @param string $url URL to send the DELETE request to * @param string $url URL to send the DELETE request to
* @param array $headers additional headers to send * @param array $headers additional headers to send
* @param mixed $body DELETE body data * @param mixed $body DELETE body data
* @param string $username Basic Authentication username * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password * @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable * @return Unirest\Response
*/ */
public static function delete($url, $headers = array(), $body = null, $username = null, $password = null) public static function delete($url, $headers = array(), $body = null, $username = null, $password = null)
{ {
@@ -167,9 +307,9 @@ class Request
* @param string $url URL to send the PUT request to * @param string $url URL to send the PUT request to
* @param array $headers additional headers to send * @param array $headers additional headers to send
* @param mixed $body PUT body data * @param mixed $body PUT body data
* @param string $username Basic Authentication username * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password * @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable * @return Unirest\Response
*/ */
public static function put($url, $headers = array(), $body = null, $username = null, $password = null) public static function put($url, $headers = array(), $body = null, $username = null, $password = null)
{ {
@@ -181,9 +321,9 @@ class Request
* @param string $url URL to send the PATCH request to * @param string $url URL to send the PATCH request to
* @param array $headers additional headers to send * @param array $headers additional headers to send
* @param mixed $body PATCH body data * @param mixed $body PATCH body data
* @param string $username Basic Authentication username * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password * @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable * @return Unirest\Response
*/ */
public static function patch($url, $headers = array(), $body = null, $username = null, $password = null) public static function patch($url, $headers = array(), $body = null, $username = null, $password = null)
{ {
@@ -195,9 +335,9 @@ class Request
* @param string $url URL to send the TRACE request to * @param string $url URL to send the TRACE request to
* @param array $headers additional headers to send * @param array $headers additional headers to send
* @param mixed $body TRACE body data * @param mixed $body TRACE body data
* @param string $username Basic Authentication username * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password * @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable * @return Unirest\Response
*/ */
public static function trace($url, $headers = array(), $body = null, $username = null, $password = null) public static function trace($url, $headers = array(), $body = null, $username = null, $password = null)
{ {
@@ -239,22 +379,22 @@ class Request
* @param string $url URL to send the request to * @param string $url URL to send the request to
* @param mixed $body request body * @param mixed $body request body
* @param array $headers additional headers to send * @param array $headers additional headers to send
* @param string $username Basic Authentication username * @param string $username Authentication username (deprecated)
* @param string $password Basic Authentication password * @param string $password Authentication password (deprecated)
* @throws Exception if a cURL error occurs * @throws Exception if a cURL error occurs
* @return Unirest\Response * @return Unirest\Response
*/ */
public 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)
{ {
$ch = curl_init(); self::$handle = curl_init();
if ($method !== Method::GET) { if ($method !== Method::GET) {
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method); curl_setopt(self::$handle, CURLOPT_CUSTOMREQUEST, $method);
if (is_array($body) || $body instanceof \Traversable) { if (is_array($body) || $body instanceof \Traversable) {
curl_setopt($ch, CURLOPT_POSTFIELDS, self::buildHTTPCurlQuery($body)); curl_setopt(self::$handle, CURLOPT_POSTFIELDS, self::buildHTTPCurlQuery($body));
} else { } else {
curl_setopt($ch, CURLOPT_POSTFIELDS, $body); curl_setopt(self::$handle, CURLOPT_POSTFIELDS, $body);
} }
} elseif (is_array($body)) { } elseif (is_array($body)) {
if (strpos($url, '?') !== false) { if (strpos($url, '?') !== false) {
@@ -266,40 +406,94 @@ class Request
$url .= urldecode(http_build_query(self::buildHTTPCurlQuery($body))); $url .= urldecode(http_build_query(self::buildHTTPCurlQuery($body)));
} }
curl_setopt($ch, CURLOPT_URL, self::encodeUrl($url)); $curl_base_options = [
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); CURLOPT_URL => self::encodeUrl($url),
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true); CURLOPT_RETURNTRANSFER => true,
curl_setopt($ch, CURLOPT_MAXREDIRS, 10); CURLOPT_FOLLOWLOCATION => true,
curl_setopt($ch, CURLOPT_HTTPHEADER, self::getFormattedHeaders($headers)); CURLOPT_MAXREDIRS => 10,
curl_setopt($ch, CURLOPT_HEADER, true); CURLOPT_HTTPHEADER => self::getFormattedHeaders($headers),
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, self::$verifyPeer); CURLOPT_HEADER => true,
curl_setopt($ch, CURLOPT_ENCODING, ''); // If an empty string, '', is set, a header containing all supported encoding types is sent. 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 => ''
];
curl_setopt_array(self::$handle, self::mergeCurlOptions($curl_base_options, self::$curlOpts));
if (self::$socketTimeout !== null) { if (self::$socketTimeout !== null) {
curl_setopt($ch, CURLOPT_TIMEOUT, self::$socketTimeout); 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)) { 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); if (!empty(self::$auth['user'])) {
$error = curl_error($ch); 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) { if ($error) {
throw new \Exception($error); throw new \Exception($error);
} }
// Split the full response in its headers and body // Split the full response in its headers and body
$curl_info = curl_getinfo($ch); $header_size = $info['header_size'];
$header_size = $curl_info['header_size'];
$header = substr($response, 0, $header_size); $header = substr($response, 0, $header_size);
$body = substr($response, $header_size); $body = substr($response, $header_size);
$httpCode = $curl_info['http_code']; $httpCode = $info['http_code'];
return new Response($httpCode, $body, $header, self::$jsonOpts); 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) public static function getFormattedHeaders($headers)
{ {
$formattedHeaders = array(); $formattedHeaders = array();
@@ -364,4 +558,15 @@ class Request
$key = trim(strtolower($key)); $key = trim(strtolower($key));
return $key . ': ' . $val; 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;
}
} }

View File

@@ -16,6 +16,17 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
$this->assertEquals($result['file'], $file); $this->assertEquals($result['file'], $file);
} }
public function testCurlOpts()
{
Unirest\Request::curlOpt(CURLOPT_COOKIE, 'foo=bar');
$response = Unirest\Request::get('http://mockbin.com/request');
$this->assertTrue(property_exists($response->body->cookies, 'foo'));
Unirest\Request::clearCurlOpts();
}
/** /**
* @expectedException Exception * @expectedException Exception
*/ */
@@ -23,17 +34,7 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
{ {
Unirest\Request::timeout(1); Unirest\Request::timeout(1);
Unirest\Request::get('http://httpbin.org/delay/3'); Unirest\Request::get('http://mockbin.com/delay/1000');
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 Unirest\Request::timeout(null); // Cleaning timeout for the other tests
} }
@@ -41,74 +42,97 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
public function testDefaultHeader() public function testDefaultHeader()
{ {
Unirest\Request::defaultHeader('Hello', 'custom'); Unirest\Request::defaultHeader('Hello', 'custom');
$response = Unirest\Request::get('http://httpbin.org/get');
$response = Unirest\Request::get('http://mockbin.com/request');
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$headers = $response->body->headers; $this->assertTrue(property_exists($response->body->headers, 'hello'));
$properties = get_object_vars($headers); $this->assertEquals('custom', $response->body->headers->hello);
$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(); Unirest\Request::clearDefaultHeaders();
$response = Unirest\Request::get('http://httpbin.org/get');
$response = Unirest\Request::get('http://mockbin.com/request');
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$headers = $response->body->headers; $this->assertFalse(property_exists($response->body->headers, 'hello'));
$properties = get_object_vars($headers); }
$this->assertFalse(array_key_exists('Hello', $properties));
public function testSetMashapeKey()
{
Unirest\Request::setMashapeKey('abcd');
$response = Unirest\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'});
// send another request
$response = Unirest\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'});
Unirest\Request::clearDefaultHeaders();
$response = Unirest\Request::get('http://mockbin.com/request');
$this->assertEquals(200, $response->code);
$this->assertFalse(property_exists($response->body->headers, 'x-mashape-key'));
} }
public function testGzip() public function testGzip()
{ {
$response = Unirest\Request::get('http://httpbin.org/gzip'); $response = Unirest\Request::get('http://mockbin.com/gzip/request');
$args = $response->body;
$this->assertEquals(true, $args->gzipped); $this->assertEquals('gzip', $response->headers['Content-Encoding']);
}
public function testBasicAuthenticationDeprecated()
{
$response = Unirest\Request::get('http://mockbin.com/request', array(), array(), 'user', 'password');
$this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $response->body->headers->authorization);
} }
public function testBasicAuthentication() public function testBasicAuthentication()
{ {
$response = Unirest\Request::get('http://httpbin.org/get', array(), array(), 'user', 'password'); Unirest\Request::auth('user', 'password');
$headers = $response->body->headers;
$this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $headers->Authorization); $response = Unirest\Request::get('http://mockbin.com/request');
$this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $response->body->headers->authorization);
} }
public function testCustomHeaders() public function testCustomHeaders()
{ {
$response = Unirest\Request::get('http://httpbin.org/get', array( $response = Unirest\Request::get('http://mockbin.com/request', array(
'user-agent' => 'ciao', 'user-agent' => 'unirest-php',
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('unirest-php', $response->body->headers->{'user-agent'});
$headers = $response->body->headers;
$this->assertEquals('ciao', $headers->{'User-Agent'});
} }
// GET // GET
public function testGet() public function testGet()
{ {
$response = Unirest\Request::get('http://httpbin.org/get?name=Mark', array( $response = Unirest\Request::get('http://mockbin.com/request?name=Mark', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'nick' => 'thefosk' 'nick' => 'thefosk'
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('GET', $response->body->method);
$args = $response->body->args; $this->assertEquals('Mark', $response->body->queryString->name);
$this->assertEquals('Mark', $args->name); $this->assertEquals('thefosk', $response->body->queryString->nick);
$this->assertEquals('thefosk', $args->nick);
} }
public function testGetMultidimensionalArray() public function testGetMultidimensionalArray()
{ {
$response = Unirest\Request::get('http://httpbin.org/get', array( $response = Unirest\Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'key' => 'value', 'key' => 'value',
@@ -119,17 +143,15 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('GET', $response->body->method);
$args = $response->body->args; $this->assertEquals('value', $response->body->queryString->key);
$this->assertEquals('item1', $response->body->queryString->items[0]);
$this->assertEquals('value', $args->key); $this->assertEquals('item2', $response->body->queryString->items[1]);
$this->assertEquals('item1', $args->{'items[0]'});
$this->assertEquals('item2', $args->{'items[1]'});
} }
public function testGetWithDots() public function testGetWithDots()
{ {
$response = Unirest\Request::get('http://httpbin.org/get', array( $response = Unirest\Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'user.name' => 'Mark', 'user.name' => 'Mark',
@@ -137,15 +159,14 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('GET', $response->body->method);
$args = $response->body->args; $this->assertEquals('Mark', $response->body->queryString->{'user.name'});
$this->assertEquals('Mark', $args->{'user.name'}); $this->assertEquals('thefosk', $response->body->queryString->nick);
$this->assertEquals('thefosk', $args->nick);
} }
public function testGetWithDotsAlt() public function testGetWithDotsAlt()
{ {
$response = Unirest\Request::get('http://httpbin.org/get', array( $response = Unirest\Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'user.name' => 'Mark Bond', 'user.name' => 'Mark Bond',
@@ -153,69 +174,63 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('GET', $response->body->method);
$args = $response->body->args; $this->assertEquals('Mark Bond', $response->body->queryString->{'user.name'});
$this->assertEquals('Mark Bond', $args->{'user.name'}); $this->assertEquals('thefosk', $response->body->queryString->nick);
$this->assertEquals('thefosk', $args->nick);
} }
public function testGetWithEqualSign() public function testGetWithEqualSign()
{ {
$response = Unirest\Request::get('http://httpbin.org/get', array( $response = Unirest\Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark=Hello' 'name' => 'Mark=Hello'
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('GET', $response->body->method);
$args = $response->body->args; $this->assertEquals('Mark=Hello', $response->body->queryString->name);
$this->assertEquals('Mark=Hello', $args->name);
} }
public function testGetWithEqualSignAlt() public function testGetWithEqualSignAlt()
{ {
$response = Unirest\Request::get('http://httpbin.org/get', array( $response = Unirest\Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark=Hello=John' 'name' => 'Mark=Hello=John'
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('GET', $response->body->method);
$args = $response->body->args; $this->assertEquals('Mark=Hello=John', $response->body->queryString->name);
$this->assertEquals('Mark=Hello=John', $args->name);
} }
public function testGetWithComplexQuery() 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'); $response = Unirest\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(200, $response->code);
$this->assertEquals('GET', $response->body->method);
$args = $response->body->args; $this->assertEquals('', $response->body->queryString->cursor);
$this->assertEquals('', $args->cursor); $this->assertEquals('[{"type":"/music/album","name":null,"artist":{"id":"/en/bob_dylan"},"limit":3}]', $response->body->queryString->query);
$this->assertEquals('[{"type":"/music/album","name":null,"artist":{"id":"/en/bob_dylan"},"limit":3}]', $args->query);
} }
public function testGetArray() public function testGetArray()
{ {
$response = Unirest\Request::get('http://httpbin.org/get', array(), array( $response = Unirest\Request::get('http://mockbin.com/request', array(), array(
'name[0]' => 'Mark', 'name[0]' => 'Mark',
'name[1]' => 'John' 'name[1]' => 'John'
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('GET', $response->body->method);
$args = $response->body->args; $this->assertEquals('Mark', $response->body->queryString->name[0]);
$this->assertEquals('Mark', $args->{'name[0]'}); $this->assertEquals('John', $response->body->queryString->name[1]);
$this->assertEquals('John', $args->{'name[1]'});
} }
// POST // POST
public function testPost() public function testPost()
{ {
$response = Unirest\Request::post('http://httpbin.org/post', array( $response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark', 'name' => 'Mark',
@@ -223,29 +238,27 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('POST', $response->body->method);
$form = $response->body->form; $this->assertEquals('Mark', $response->body->postData->params->name);
$this->assertEquals('Mark', $form->name); $this->assertEquals('thefosk', $response->body->postData->params->nick);
$this->assertEquals('thefosk', $form->nick);
} }
public function testPostWithEqualSign() public function testPostWithEqualSign()
{ {
$response = Unirest\Request::post('http://httpbin.org/post', array( $response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark=Hello' 'name' => 'Mark=Hello'
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('POST', $response->body->method);
$form = $response->body->form; $this->assertEquals('Mark=Hello', $response->body->postData->params->name);
$this->assertEquals('Mark=Hello', $form->name);
} }
public function testPostArray() public function testPostArray()
{ {
$response = Unirest\Request::post('http://httpbin.org/post', array( $response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name[0]' => 'Mark', 'name[0]' => 'Mark',
@@ -253,16 +266,14 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('POST', $response->body->method);
$form = $response->body->form; $this->assertEquals('Mark', $response->body->postData->params->{'name[0]'});
$this->assertEquals('John', $response->body->postData->params->{'name[1]'});
$this->assertEquals('Mark', $form->{'name[0]'});
$this->assertEquals('John', $form->{'name[1]'});
} }
public function testPostWithDots() public function testPostWithDots()
{ {
$response = Unirest\Request::post('http://httpbin.org/post', array( $response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'user.name' => 'Mark', 'user.name' => 'Mark',
@@ -270,15 +281,14 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('POST', $response->body->method);
$form = $response->body->form; $this->assertEquals('Mark', $response->body->postData->params->{'user.name'});
$this->assertEquals('Mark', $form->{'user.name'}); $this->assertEquals('thefosk', $response->body->postData->params->nick);
$this->assertEquals('thefosk', $form->nick);
} }
public function testRawPost() public function testRawPost()
{ {
$response = Unirest\Request::post('http://httpbin.org/post', array( $response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json', 'Accept' => 'application/json',
'Content-Type' => 'application/json' 'Content-Type' => 'application/json'
), json_encode(array( ), json_encode(array(
@@ -286,15 +296,13 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
))); )));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('POST', $response->body->method);
$json = $response->body->json; $this->assertEquals('Sam Sullivan', json_decode($response->body->postData->text)->author);
$this->assertEquals('Sam Sullivan', $json->author);
} }
public function testPostMultidimensionalArray() public function testPostMultidimensionalArray()
{ {
$response = Unirest\Request::post('http://httpbin.org/post', array( $response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'key' => 'value', 'key' => 'value',
@@ -305,17 +313,16 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('POST', $response->body->method);
$form = $response->body->form; $this->assertEquals('value', $response->body->postData->params->key);
$this->assertEquals('value', $form->key); $this->assertEquals('item1', $response->body->postData->params->{'items[0]'});
$this->assertEquals('item1', $form->{'items[0]'}); $this->assertEquals('item2', $response->body->postData->params->{'items[1]'});
$this->assertEquals('item2', $form->{'items[1]'});
} }
// PUT // PUT
public function testPut() public function testPut()
{ {
$response = Unirest\Request::put('http://httpbin.org/put', array( $response = Unirest\Request::put('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark', 'name' => 'Mark',
@@ -323,16 +330,15 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('PUT', $response->body->method);
$form = $response->body->form; $this->assertEquals('Mark', $response->body->postData->params->name);
$this->assertEquals('Mark', $form->name); $this->assertEquals('thefosk', $response->body->postData->params->nick);
$this->assertEquals('thefosk', $form->nick);
} }
// PATCH // PATCH
public function testPatch() public function testPatch()
{ {
$response = Unirest\Request::patch('http://httpbin.org/patch', array( $response = Unirest\Request::patch('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark', 'name' => 'Mark',
@@ -340,16 +346,15 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('PATCH', $response->body->method);
$form = $response->body->form; $this->assertEquals('Mark', $response->body->postData->params->name);
$this->assertEquals('Mark', $form->name); $this->assertEquals('thefosk', $response->body->postData->params->nick);
$this->assertEquals('thefosk', $form->nick);
} }
// DELETE // DELETE
public function testDelete() public function testDelete()
{ {
$response = Unirest\Request::delete('http://httpbin.org/delete', array( $response = Unirest\Request::delete('http://mockbin.com/request', array(
'Accept' => 'application/json', 'Accept' => 'application/json',
'Content-Type' => 'application/x-www-form-urlencoded' 'Content-Type' => 'application/x-www-form-urlencoded'
), array( ), array(
@@ -358,42 +363,37 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$data = $response->body->data; $this->assertEquals('DELETE', $response->body->method);
$this->assertTrue(empty($data));
} }
// Upload // Upload
public function testUpload() public function testUpload()
{ {
$response = Unirest\Request::post('http://httpbin.org/post', array( $response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark', 'name' => 'Mark',
'file' => Unirest\File::add(UPLOAD_FIXTURE) 'file' => Unirest\File::add(UPLOAD_FIXTURE)
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('POST', $response->body->method);
$files = $response->body->files; $this->assertEquals('Mark', $response->body->postData->params->name);
$this->assertEquals('This is a test', $files->file); $this->assertEquals('This is a test', $response->body->postData->params->file);
$form = $response->body->form;
$this->assertEquals('Mark', $form->name);
} }
public function testUploadIfFilePartOfData() public function testUploadIfFilePartOfData()
{ {
$response = Unirest\Request::post('http://httpbin.org/post', array( $response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark', 'name' => 'Mark',
'files[owl.gif]' => Unirest\File::add(UPLOAD_FIXTURE) 'files[owl.gif]' => Unirest\File::add(UPLOAD_FIXTURE)
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('POST', $response->body->method);
//$files = $response->body->files; $this->assertEquals('Mark', $response->body->postData->params->name);
//$this->assertEquals('This is a test', $files->file); $this->assertEquals('This is a test', $response->body->postData->params->{'files[owl.gif]'});
$form = $response->body->form;
$this->assertEquals('Mark', $form->name);
} }
} }