31 Commits

Author SHA1 Message Date
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
4 changed files with 372 additions and 196 deletions

View File

@@ -26,3 +26,11 @@ 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

View File

@@ -22,6 +22,7 @@ Unirest is a set of lightweight HTTP libraries available in [multiple languages]
## Requirements
- [cURL](http://php.net/manual/en/book.curl.php)
- PHP 5.4+
## Installation
@@ -61,7 +62,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
@@ -81,7 +82,7 @@ So you're probably wondering how using Unirest makes creating requests in PHP ea
$headers = array("Accept" => "application/json");
$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->headers; // Headers
@@ -97,7 +98,7 @@ To upload files in a multipart form representation use the return value of `Unir
$headers = array("Accept" => "application/json");
$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
@@ -107,12 +108,18 @@ Sending a custom body such as a JSON Object rather than a string or form style p
$headers = array("Accept" => "application/json");
$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);
```
### Authentication
Passing a username, password *(optional)*, defaults to Basic 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
@@ -123,7 +130,7 @@ The third parameter, which is a bitmask, will Unirest which HTTP authentication
If more than one bit is set, Unirest *(at PHP's libcurl level)* will first query the site to see what authentication methods it supports and then pick the best one you allow it to use. *For some methods, this will induce an extra network round-trip.*
**Supported Method**
**Supported Methods**
| Method | Description |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -145,11 +152,27 @@ 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://httpbin.org/get", null, null, "username", "password");
$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
@@ -188,7 +211,7 @@ 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#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:
@@ -252,7 +275,7 @@ Unirest\Request::defaultHeader("Header1", "Value1");
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
Unirest\Request::defaultHeaders(array(
@@ -267,6 +290,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:
@@ -277,9 +322,21 @@ Unirest\Request::verifyPeer(false); // Disables SSL cert validation
By default is `true`.
#### Utility Methods
```php
// alias for `curl_getinfo`
Unirest\Request::getInfo()
// returns internal cURL handle
Unirest\Request::getCurlHandle()
```
----
Made with &#9829; from the [Mashape](https://www.mashape.com/) team
Made with &#9829; from the [Mashape][mashape-url] team
[mashape-url]: https://www.mashape.com/
[license-url]: https://github.com/Mashape/unirest-php/blob/master/LICENSE
@@ -299,4 +356,4 @@ Made with &#9829; from the [Mashape](https://www.mashape.com/) team
[codeclimate-coverage]: https://img.shields.io/codeclimate/coverage/github/Mashape/unirest-php.svg?style=flat
[versioneye-url]: https://www.versioneye.com/user/projects/54b82450050646ca5c0001f3
[versioneye-image]: https://img.shields.io/versioneye/d/user/projects/54b82450050646ca5c0001f3.svg?style=flat
[versioneye-image]: https://img.shields.io/versioneye/d/php/mashape:unirest-php.svg?style=flat

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

@@ -7,10 +7,15 @@ use Unirest\Response;
class Request
{
private static $jsonOpts = array();
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' => '',
@@ -51,6 +56,16 @@ class Request
{
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
@@ -69,11 +84,7 @@ class Request
*/
public static function defaultHeaders($headers)
{
foreach ($headers as $name => $value) {
self::$defaultHeaders[$name] = $value;
}
return $headers;
return array_merge(self::$defaultHeaders, $headers);
}
/**
@@ -95,6 +106,71 @@ class Request
return self::$defaultHeaders = array();
}
/**
* Set curl options to send on every request
*
* @param array $options options array
*/
public static function curlOpts($opts)
{
return array_merge(self::$curlOpts, $opts);
}
/**
* 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
*
@@ -148,7 +224,7 @@ class Request
* @param mixed $parameters parameters to send in the querystring
* @param string $username Authentication username (deprecated)
* @param string $password Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable
* @return Unirest\Response
*/
public static function get($url, $headers = array(), $parameters = null, $username = null, $password = null)
{
@@ -162,7 +238,7 @@ class Request
* @param mixed $parameters parameters to send in the querystring
* @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable
* @return Unirest\Response
*/
public static function head($url, $headers = array(), $parameters = null, $username = null, $password = null)
{
@@ -176,7 +252,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)
{
@@ -190,7 +266,7 @@ class Request
* @param mixed $parameters parameters to send in the querystring
* @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable
* @return Unirest\Response
*/
public static function connect($url, $headers = array(), $parameters = null, $username = null, $password = null)
{
@@ -204,7 +280,7 @@ class Request
* @param mixed $body POST body data
* @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable
* @return Unirest\Response response
*/
public static function post($url, $headers = array(), $body = null, $username = null, $password = null)
{
@@ -218,7 +294,7 @@ class Request
* @param mixed $body DELETE body data
* @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable
* @return Unirest\Response
*/
public static function delete($url, $headers = array(), $body = null, $username = null, $password = null)
{
@@ -232,7 +308,7 @@ class Request
* @param mixed $body PUT body data
* @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable
* @return Unirest\Response
*/
public static function put($url, $headers = array(), $body = null, $username = null, $password = null)
{
@@ -246,7 +322,7 @@ class Request
* @param mixed $body PATCH body data
* @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable
* @return Unirest\Response
*/
public static function patch($url, $headers = array(), $body = null, $username = null, $password = null)
{
@@ -260,7 +336,7 @@ class Request
* @param mixed $body TRACE body data
* @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (deprecated)
* @return string|stdObj response string or stdObj if response is json-decodable
* @return Unirest\Response
*/
public static function trace($url, $headers = array(), $body = null, $username = null, $password = null)
{
@@ -309,15 +385,18 @@ class Request
*/
public static function send($method, $url, $body = null, $headers = array(), $username = null, $password = null)
{
$ch = curl_init();
self::$handle = curl_init();
// start with default options
curl_setopt_array(self::$handle, self::$curlOpts);
if ($method !== Method::GET) {
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt(self::$handle, CURLOPT_CUSTOMREQUEST, $method);
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 {
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt(self::$handle, CURLOPT_POSTFIELDS, $body);
}
} elseif (is_array($body)) {
if (strpos($url, '?') !== false) {
@@ -329,60 +408,92 @@ 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, self::getFormattedHeaders($headers));
curl_setopt($ch, CURLOPT_HEADER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, self::$verifyPeer);
curl_setopt($ch, CURLOPT_ENCODING, ''); // If an empty string, '', is set, a header containing all supported encoding types is sent.
curl_setopt_array(self::$handle, array(
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(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_USERNAME, $username);
curl_setopt($ch, CURLOPT_PASSWORD, $password);
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
curl_setopt_array(self::$handle, array(
CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
CURLOPT_USERPWD => $username . ':' . $password
));
}
if (!empty(self::$auth['user'])) {
curl_setopt($ch, CURLOPT_USERNAME, self::$auth['user']);
curl_setopt($ch, CURLOPT_PASSWORD, self::$auth['pass']);
curl_setopt($ch, CURLOPT_HTTPAUTH, self::$auth['method']);
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($ch, CURLOPT_PROXYTYPE, self::$proxy['type']);
curl_setopt($ch, CURLOPT_PROXY, self::$proxy['address']);
curl_setopt($ch, CURLOPT_PROXYPORT, self::$proxy['port']);
curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, self::$proxy['tunnel']);
curl_setopt($ch, CURLOPT_PROXYAUTH, self::$proxy['auth']['method']);
curl_setopt($ch, CURLOPT_PROXYUSERNAME, self::$proxy['auth']['user']);
curl_setopt($ch, CURLOPT_PROXYPASSWORD, self::$proxy['auth']['pass']);
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($ch);
$error = curl_error($ch);
$response = curl_exec(self::$handle);
$error = curl_error(self::$handle);
$info = self::getInfo();
if ($error) {
throw new \Exception($error);
}
// Split the full response in its headers and body
$curl_info = curl_getinfo($ch);
$header_size = $curl_info['header_size'];
$header_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, 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();

View File

@@ -16,6 +16,17 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
$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
*/
@@ -23,17 +34,7 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
{
Unirest\Request::timeout(1);
Unirest\Request::get('http://httpbin.org/delay/3');
Unirest\Request::timeout(null); // Cleaning timeout for the other tests
}
public function testTimeoutSuccess()
{
Unirest\Request::timeout(3);
$response = Unirest\Request::get('http://httpbin.org/delay/1');
$this->assertEquals(200, $response->code);
Unirest\Request::get('http://mockbin.com/delay/1000');
Unirest\Request::timeout(null); // Cleaning timeout for the other tests
}
@@ -41,74 +42,97 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
public function testDefaultHeader()
{
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);
$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);
$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');
$response = Unirest\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->assertFalse(property_exists($response->body->headers, 'hello'));
}
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()
{
$response = Unirest\Request::get('http://httpbin.org/gzip');
$args = $response->body;
$this->assertEquals(true, $args->gzipped);
$response = Unirest\Request::get('http://mockbin.com/gzip/request');
$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()
{
$response = Unirest\Request::get('http://httpbin.org/get', array(), array(), 'user', 'password');
$headers = $response->body->headers;
$this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $headers->Authorization);
Unirest\Request::auth('user', 'password');
$response = Unirest\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 = Unirest\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 = Unirest\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 = Unirest\Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'key' => 'value',
@@ -119,17 +143,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 = Unirest\Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'user.name' => 'Mark',
@@ -137,15 +159,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 = Unirest\Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'user.name' => 'Mark Bond',
@@ -153,69 +174,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 = Unirest\Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'name' => 'Mark=Hello'
));
$this->assertEquals(200, $response->code);
$args = $response->body->args;
$this->assertEquals('Mark=Hello', $args->name);
$this->assertEquals('GET', $response->body->method);
$this->assertEquals('Mark=Hello', $response->body->queryString->name);
}
public function testGetWithEqualSignAlt()
{
$response = Unirest\Request::get('http://httpbin.org/get', array(
$response = Unirest\Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'name' => 'Mark=Hello=John'
));
$this->assertEquals(200, $response->code);
$args = $response->body->args;
$this->assertEquals('Mark=Hello=John', $args->name);
$this->assertEquals('GET', $response->body->method);
$this->assertEquals('Mark=Hello=John', $response->body->queryString->name);
}
public function testGetWithComplexQuery()
{
$response = Unirest\Request::get('http://httpbin.org/get?query=[{"type":"/music/album","name":null,"artist":{"id":"/en/bob_dylan"},"limit":3}]&cursor');
$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);
$args = $response->body->args;
$this->assertEquals('', $args->cursor);
$this->assertEquals('[{"type":"/music/album","name":null,"artist":{"id":"/en/bob_dylan"},"limit":3}]', $args->query);
$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 = Unirest\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 = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'name' => 'Mark',
@@ -223,29 +238,27 @@ 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('POST', $response->body->method);
$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(
$response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'name' => 'Mark=Hello'
));
$this->assertEquals(200, $response->code);
$form = $response->body->form;
$this->assertEquals('Mark=Hello', $form->name);
$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 = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'name[0]' => 'Mark',
@@ -253,16 +266,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 = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'user.name' => 'Mark',
@@ -270,15 +281,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 = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json',
'Content-Type' => 'application/json'
), json_encode(array(
@@ -286,15 +296,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(
$response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'key' => 'value',
@@ -305,17 +313,16 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
));
$this->assertEquals(200, $response->code);
$form = $response->body->form;
$this->assertEquals('value', $form->key);
$this->assertEquals('item1', $form->{'items[0]'});
$this->assertEquals('item2', $form->{'items[1]'});
$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 = Unirest\Request::put('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'name' => 'Mark',
@@ -323,16 +330,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 = Unirest\Request::patch('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'name' => 'Mark',
@@ -340,16 +346,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 = Unirest\Request::delete('http://mockbin.com/request', array(
'Accept' => 'application/json',
'Content-Type' => 'application/x-www-form-urlencoded'
), array(
@@ -358,42 +363,37 @@ 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(
$response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'name' => 'Mark',
'file' => Unirest\File::add(UPLOAD_FIXTURE)
));
$this->assertEquals(200, $response->code);
$files = $response->body->files;
$this->assertEquals('This is a test', $files->file);
$form = $response->body->form;
$this->assertEquals('Mark', $form->name);
$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(
$response = Unirest\Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json'
), array(
'name' => 'Mark',
'files[owl.gif]' => Unirest\File::add(UPLOAD_FIXTURE)
));
$this->assertEquals(200, $response->code);
//$files = $response->body->files;
//$this->assertEquals('This is a test', $files->file);
$form = $response->body->form;
$this->assertEquals('Mark', $form->name);
$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]'});
}
}