53 Commits

Author SHA1 Message Date
Ahmad Nassri
2bedcf05ac docs(readme): fix content-types in labels [ci skip] 2016-02-24 23:27:05 -05:00
Ahmad Nassri
b6328f270f chore(travis): fix namespacing issues 2016-02-24 23:23:54 -05:00
Ahmad Nassri
1e86cc751f chore(travis): move to container mode in travis 2016-02-24 23:13:33 -05:00
Ahmad Nassri
825cee7dc7 chore(travis): fix namespacing issues 2016-02-24 23:12:45 -05:00
Ahmad Nassri
eb470e929c chore(travis): test on all current PHP versions 2016-02-24 23:02:39 -05:00
Ahmad Nassri
d23cdc5593 refactor(request): request body management is now externalized to helper methods 2016-02-24 23:01:21 -05:00
Ahmad Nassri
0f3a22d63e feat(json): json pecl extension may be available all the time 2016-02-24 22:07:25 -05:00
Ahmad Nassri
f7f13bd940 Merge pull request #91 from Furgas/fix-curlfile
Fix creating CURLFile
2016-02-16 14:25:22 -05:00
Tomasz Sawicki
d950a88257 Fix creating CURLFile 2016-02-16 19:54:45 +01:00
Ahmad Nassri
73c2d90323 Merge pull request #90 from Furgas/fix-phpdoc
Fix PHPDoc
2016-02-16 11:45:52 -05:00
Tomasz Sawicki
d0fc831a00 Fix PHPDoc 2016-02-16 10:49:00 +01:00
Ahmad Nassri
4a480b156b Merge pull request #89 from RusinovIG/master
Fixed setting of default headers array
2016-01-20 14:41:35 -05:00
Igor Rusinov
ca6a3b1daf Fixed setting of default headers array 2016-01-18 23:24:14 +03:00
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
15 changed files with 789 additions and 298 deletions

3
.gitignore vendored
View File

@@ -1,5 +1,6 @@
.DS_Store .DS_Store
build build
vendor
composer.lock composer.lock
composer.phar composer.phar
coverage
vendor

View File

@@ -1,9 +1,12 @@
sudo: false
language: php language: php
php: php:
- 5.4 - '5.4'
- 5.5 - '5.5'
- 5.6 - '5.6'
- '7.0'
- hhvm - hhvm
before_script: before_script:
@@ -26,3 +29,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

193
README.md
View File

@@ -7,7 +7,11 @@
[![Gitter][gitter-image]][gitter-url] [![Gitter][gitter-image]][gitter-url]
[![License][packagist-license]][license-url] [![License][packagist-license]][license-url]
Unirest is a set of lightweight HTTP libraries available in [multiple languages](http://unirest.io). ![][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).
## Features ## Features
@@ -22,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
@@ -46,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:
@@ -61,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
@@ -78,10 +83,10 @@ require_once '/path/to/unirest-php/src/Unirest.php';
So you're probably wondering how using Unirest makes creating requests in PHP easier, let's look at a working example: So you're probably wondering how using Unirest makes creating requests in PHP easier, let's look at a working example:
```php ```php
$headers = array("Accept" => "application/json"); $headers = array('Accept' => 'application/json');
$body = array("foo" => "hellow", "bar" => "world"); $query = array('foo' => 'hello', 'bar' => 'world');
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body); $response = Unirest\Request::post('http://mockbin.com/request', $headers, $query);
$response->code; // HTTP Status code $response->code; // HTTP Status code
$response->headers; // Headers $response->headers; // Headers
@@ -89,30 +94,109 @@ $response->body; // Parsed body
$response->raw_body; // Unparsed body $response->raw_body; // Unparsed body
``` ```
### File Uploads ### JSON Requests *(`application/json`)*
To upload files in a multipart form representation use the return value of `Unirest\File::add($path)` as the value of a parameter: A JSON Request can be constructed using the `Unirest\Request\Body::Json` helper:
```php ```php
$headers = array("Accept" => "application/json"); $headers = array('Accept' => 'application/json');
$body = array("file" => Unirest\File::add("/tmp/file.txt")); $data = array('name' => 'ahmad', 'company' => 'mashape');
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body); $body = Unirest\Request\Body::json($data);
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
```
**Notes:**
- `Content-Type` headers will be automatically set to `application/json`
- the data variable will be processed through [`json_encode`](http://php.net/manual/en/function.json-encode.php) with default values for arguments.
- an error will be thrown if the [JSON Extension](http://php.net/manual/en/book.json.php) is not available.
### Form Requests *(`application/x-www-form-urlencoded`)*
A typical Form Request can be constructed using the `Unirest\Request\Body::Form` helper:
```php
$headers = array('Accept' => 'application/json');
$data = array('name' => 'ahmad', 'company' => 'mashape');
$body = Unirest\Request\Body::form($data);
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
```
**Notes:**
- `Content-Type` headers will be automatically set to `application/x-www-form-urlencoded`
- the final data array will be processed through [`http_build_query`](http://php.net/manual/en/function.http-build-query.php) with default values for arguments.
### Multipart Requests *(`multipart/form-data`)*
A Multipart Request can be constructed using the `Unirest\Request\Body::Multipart` helper:
```php
$headers = array('Accept' => 'application/json');
$data = array('name' => 'ahmad', 'company' => 'mashape');
$body = Unirest\Request\Body::multipart($data);
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
```
**Notes:**
- `Content-Type` headers will be automatically set to `multipart/form-data`.
- an auto-generated `--boundary` will be set.
### Multipart File Upload
simply add an array of files as the second argument to to the `Multipart` helper:
```php
$headers = array('Accept' => 'application/json');
$data = array('name' => 'ahmad', 'company' => 'mashape');
$files = array('bio' => '/path/to/bio.txt', 'avatar' => '/path/to/avatar.jpg');
$body = Unirest\Request\Body::multipart($data, $files);
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
``` ```
### Custom Entity Body
Sending a custom body such as a JSON Object rather than a string or form style parameters we utilize json_encode for the body: If you wish to further customize the properties of files uploaded you can do so with the `Unirest\Request\Body::File` helper:
```php ```php
$headers = array("Accept" => "application/json"); $headers = array('Accept' => 'application/json');
$body = json_encode(array("foo" => "hellow", "bar" => "world")); $body = array(
'name' => 'ahmad',
'company' => 'mashape'
'bio' => Unirest\Request\Body::file('/path/to/bio.txt', 'text/plain'),
'avatar' => Unirest\Request\Body::file('/path/to/my_avatar.jpg', 'text/plain', 'avatar.jpg')
);
$response = Unirest\Request::post("http://httpbin.org/post", $headers, $body); $response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
```
**Note**: we did not use the `Unirest\Request\Body::multipart` helper in this example, it is not needed when manually adding files.
### Custom Body
Sending a custom body such rather than using the `Unirest\Request\Body` helpers is also possible, for example, using a [`serialize`](http://php.net/manual/en/function.serialize.php) body string with a custom `Content-Type`:
```php
$headers = array('Accept' => 'application/json', 'Content-Type' => 'application/x-php-serialized');
$body = serialize((array('foo' => 'hello', 'bar' => 'world'));
$response = Unirest\Request::post('http://mockbin.com/request', $headers, $body);
``` ```
### Authentication ### 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 ```php
// basic auth // basic auth
@@ -123,7 +207,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.* 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 | | Method | Description |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -145,11 +229,27 @@ Unirest\Request::proxyAuth('username', 'password', CURLAUTH_DIGEST);
Previous versions of **Unirest** support *Basic Authentication* by providing the `username` and `password` arguments: Previous versions of **Unirest** support *Basic Authentication* by providing the `username` and `password` arguments:
```php ```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** **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
@@ -188,7 +288,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:
@@ -248,16 +348,16 @@ Unirest\Request::proxyAuth('username', 'password', CURLAUTH_DIGEST);
You can set default headers that will be sent on every request: You can set default headers that will be sent on every request:
```php ```php
Unirest\Request::defaultHeader("Header1", "Value1"); 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(
"Header1" => "Value1", 'Header1' => 'Value1',
"Header2" => "Value2" 'Header2' => 'Value2'
)); ));
``` ```
@@ -267,6 +367,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:
@@ -277,9 +399,24 @@ Unirest\Request::verifyPeer(false); // Disables SSL cert validation
By default is `true`. 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
[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 [license-url]: https://github.com/Mashape/unirest-php/blob/master/LICENSE
@@ -299,4 +436,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 [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-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

View File

@@ -8,8 +8,10 @@
"author": "Mashape <opensource@mashape.com> (https://www.mashape.com)", "author": "Mashape <opensource@mashape.com> (https://www.mashape.com)",
"require": { "require": {
"php": ">=5.4.0", "php": ">=5.4.0",
"ext-curl": "*", "ext-curl": "*"
"ext-json": "*" },
"suggest": {
"ext-json": "Allows using JSON Bodies for sending and parsing requests"
}, },
"require-dev": { "require-dev": {
"phpunit/phpunit": "~4.4", "phpunit/phpunit": "~4.4",

View File

@@ -1,6 +1,7 @@
<?php <?php
require_once dirname(__FILE__) . '/Unirest/File.php'; require_once dirname(__FILE__) . '/Unirest/Exception.php';
require_once dirname(__FILE__) . '/Unirest/Method.php'; require_once dirname(__FILE__) . '/Unirest/Method.php';
require_once dirname(__FILE__) . '/Unirest/Response.php'; require_once dirname(__FILE__) . '/Unirest/Response.php';
require_once dirname(__FILE__) . '/Unirest/Request.php'; require_once dirname(__FILE__) . '/Unirest/Request.php';
require_once dirname(__FILE__) . '/Unirest/Request/Body.php';

View File

@@ -0,0 +1,5 @@
<?php
namespace Unirest;
class Exception extends \Exception {}

View File

@@ -1,19 +0,0 @@
<?php
namespace Unirest;
class File
{
/**
* Prepares a file for upload. To be used inside the parameters declaration for a request.
* @param string $path The file path
*/
public static function add($filename, $mimetype = '', $postname = '')
{
if (function_exists('curl_file_create')) {
return curl_file_create($filename, $mimetype = '', $postname = '');
} else {
return sprintf('@%s;filename=%s;type=%s', $filename, $postname ?: basename($filename), $mimetype);
}
}
}

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

@@ -2,15 +2,21 @@
namespace Unirest; namespace Unirest;
use Unirest\Method; use Unirest\Method as Method;
use Unirest\Response; use Unirest\Response as Response;
use Unirest\Exception as Exception;
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 ( private static $auth = array (
'user' => '', 'user' => '',
@@ -34,8 +40,9 @@ class Request
* Set JSON decode mode * Set JSON decode mode
* *
* @param bool $assoc When TRUE, returned objects will be converted into associative arrays. * @param bool $assoc When TRUE, returned objects will be converted into associative arrays.
* @param bool $depth User specified recursion depth. * @param integer $depth User specified recursion depth.
* @param bool $options Bitmask of JSON decode options. Currently only JSON_BIGINT_AS_STRING is supported (default is to cast large integers as floats) * @param integer $options Bitmask of JSON decode options. Currently only JSON_BIGINT_AS_STRING is supported (default is to cast large integers as floats)
* @return array
*/ */
public static function jsonOpts($assoc = false, $depth = 512, $options = 0) public static function jsonOpts($assoc = false, $depth = 512, $options = 0)
{ {
@@ -46,16 +53,29 @@ class Request
* Verify SSL peer * Verify SSL peer
* *
* @param bool $enabled enable SSL verification, by default is true * @param bool $enabled enable SSL verification, by default is true
* @return bool
*/ */
public static function verifyPeer($enabled) public static function verifyPeer($enabled)
{ {
return self::$verifyPeer = $enabled; return self::$verifyPeer = $enabled;
} }
/**
* Verify SSL host
*
* @param bool $enabled enable SSL host verification, by default is true
* @return bool
*/
public static function verifyHost($enabled)
{
return self::$verifyHost = $enabled;
}
/** /**
* Set a timeout * Set a timeout
* *
* @param integer $seconds timeout value in seconds * @param integer $seconds timeout value in seconds
* @return integer
*/ */
public static function timeout($seconds) public static function timeout($seconds)
{ {
@@ -69,11 +89,7 @@ class Request
*/ */
public static function defaultHeaders($headers) public static function defaultHeaders($headers)
{ {
foreach ($headers as $name => $value) { return self::$defaultHeaders = array_merge(self::$defaultHeaders, $headers);
self::$defaultHeaders[$name] = $value;
}
return $headers;
} }
/** /**
@@ -81,6 +97,7 @@ class Request
* *
* @param string $name header name * @param string $name header name
* @param string $value header value * @param string $value header value
* @return string
*/ */
public static function defaultHeader($name, $value) public static function defaultHeader($name, $value)
{ {
@@ -95,12 +112,80 @@ 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
* @return string
*/
public static function curlOpt($name, $value)
{
return self::$curlOpts[$name] = $value;
}
/**
* Clear all the default headers
*/
public static function clearCurlOpts()
{
return self::$curlOpts = array();
}
/**
* Set a Mashape key to send on every request as a header
* Obtain your Mashape key by browsing one of your Mashape applications on https://www.mashape.com
*
* Note: Mashape provides 2 keys for each application: a 'Testing' and a 'Production' one.
* Be aware of which key you are using and do not share your Production key.
*
* @param string $key Mashape key
* @return string
*/
public static function setMashapeKey($key)
{
return self::defaultHeader('X-Mashape-Key', $key);
}
/**
* Set a coockie string for enabling coockie handling
*
* @param string $cookie
*/
public static function cookie($cookie)
{
self::$cookie = $cookie;
}
/**
* Set a coockie file path for enabling coockie handling
*
* $cookieFile must be a correct path with write permission
*
* @param string $cookieFile - path to file for saving cookie
*/
public static function cookieFile($cookieFile)
{
self::$cookieFile = $cookieFile;
}
/** /**
* Set authentication method to use * Set authentication method to use
* *
* @param string $username authentication username * @param string $username authentication username
* @param string $password authentication password * @param string $password authentication password
* @param string $method authentication method * @param integer $method authentication method
*/ */
public static function auth($username = '', $password = '', $method = CURLAUTH_BASIC) public static function auth($username = '', $password = '', $method = CURLAUTH_BASIC)
{ {
@@ -113,9 +198,9 @@ class Request
* Set proxy to use * Set proxy to use
* *
* @param string $address proxy address * @param string $address proxy address
* @param string $port proxy port * @param integer $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 integer $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 * @param bool $tunnel enable/disable tunneling
*/ */
public static function proxy($address, $port = 1080, $type = CURLPROXY_HTTP, $tunnel = false) public static function proxy($address, $port = 1080, $type = CURLPROXY_HTTP, $tunnel = false)
{ {
@@ -130,8 +215,7 @@ class Request
* *
* @param string $username authentication username * @param string $username authentication username
* @param string $password authentication password * @param string $password authentication password
* @param string $method authentication method * @param integer $method authentication method
* @param string $tunnel enable/disable tunneling
*/ */
public static function proxyAuth($username = '', $password = '', $method = CURLAUTH_BASIC) public static function proxyAuth($username = '', $password = '', $method = CURLAUTH_BASIC)
{ {
@@ -148,7 +232,7 @@ class Request
* @param mixed $parameters parameters to send in the querystring * @param mixed $parameters parameters to send in the querystring
* @param string $username Authentication username (deprecated) * @param string $username Authentication username (deprecated)
* @param string $password Authentication password (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) public static function get($url, $headers = array(), $parameters = null, $username = null, $password = null)
{ {
@@ -162,7 +246,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 (deprecated) * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (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) public static function head($url, $headers = array(), $parameters = null, $username = null, $password = null)
{ {
@@ -176,7 +260,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)
{ {
@@ -190,7 +274,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 (deprecated) * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (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) public static function connect($url, $headers = array(), $parameters = null, $username = null, $password = null)
{ {
@@ -204,7 +288,7 @@ class Request
* @param mixed $body POST body data * @param mixed $body POST body data
* @param string $username Basic Authentication username (deprecated) * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (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) public static function post($url, $headers = array(), $body = null, $username = null, $password = null)
{ {
@@ -218,7 +302,7 @@ class Request
* @param mixed $body DELETE body data * @param mixed $body DELETE body data
* @param string $username Basic Authentication username (deprecated) * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (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) public static function delete($url, $headers = array(), $body = null, $username = null, $password = null)
{ {
@@ -232,7 +316,7 @@ class Request
* @param mixed $body PUT body data * @param mixed $body PUT body data
* @param string $username Basic Authentication username (deprecated) * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (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) public static function put($url, $headers = array(), $body = null, $username = null, $password = null)
{ {
@@ -246,7 +330,7 @@ class Request
* @param mixed $body PATCH body data * @param mixed $body PATCH body data
* @param string $username Basic Authentication username (deprecated) * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (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) public static function patch($url, $headers = array(), $body = null, $username = null, $password = null)
{ {
@@ -260,7 +344,7 @@ class Request
* @param mixed $body TRACE body data * @param mixed $body TRACE body data
* @param string $username Basic Authentication username (deprecated) * @param string $username Basic Authentication username (deprecated)
* @param string $password Basic Authentication password (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) public static function trace($url, $headers = array(), $body = null, $username = null, $password = null)
{ {
@@ -270,6 +354,9 @@ class Request
/** /**
* This function is useful for serializing multidimensional arrays, and avoid getting * This function is useful for serializing multidimensional arrays, and avoid getting
* the 'Array to string conversion' notice * the 'Array to string conversion' notice
* @param array|object $data array to flatten.
* @param bool|string $parent parent key or false if no parent
* @return array
*/ */
public static function buildHTTPCurlQuery($data, $parent = false) public static function buildHTTPCurlQuery($data, $parent = false)
{ {
@@ -298,27 +385,23 @@ class Request
/** /**
* Send a cURL request * Send a cURL request
* @param Unirest\Method $method HTTP method to use * @param Unirest\Method|string $method HTTP method to use
* @param string $url URL to send the request to * @param 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 Authentication username (deprecated) * @param string $username Authentication username (deprecated)
* @param string $password Authentication password (deprecated) * @param string $password Authentication password (deprecated)
* @throws Exception if a cURL error occurs * @throws Unirest\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) { curl_setopt(self::$handle, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_POSTFIELDS, self::buildHTTPCurlQuery($body));
} else {
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
}
} elseif (is_array($body)) { } elseif (is_array($body)) {
if (strpos($url, '?') !== false) { if (strpos($url, '?') !== false) {
$url .= '&'; $url .= '&';
@@ -329,60 +412,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 // supporting deprecated http auth method
if (!empty($username)) { if (!empty($username)) {
curl_setopt($ch, CURLOPT_USERNAME, $username); curl_setopt_array(self::$handle, array(
curl_setopt($ch, CURLOPT_PASSWORD, $password); CURLOPT_HTTPAUTH => CURLAUTH_BASIC,
curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_BASIC); CURLOPT_USERPWD => $username . ':' . $password
));
} }
if (!empty(self::$auth['user'])) { if (!empty(self::$auth['user'])) {
curl_setopt($ch, CURLOPT_USERNAME, self::$auth['user']); curl_setopt_array(self::$handle, array(
curl_setopt($ch, CURLOPT_PASSWORD, self::$auth['pass']); CURLOPT_HTTPAUTH => self::$auth['method'],
curl_setopt($ch, CURLOPT_HTTPAUTH, self::$auth['method']); CURLOPT_USERPWD => self::$auth['user'] . ':' . self::$auth['pass']
));
} }
if (self::$proxy['address'] !== false) { if (self::$proxy['address'] !== false) {
curl_setopt($ch, CURLOPT_PROXYTYPE, self::$proxy['type']); curl_setopt_array(self::$handle, array(
curl_setopt($ch, CURLOPT_PROXY, self::$proxy['address']); CURLOPT_PROXYTYPE => self::$proxy['type'],
curl_setopt($ch, CURLOPT_PROXYPORT, self::$proxy['port']); CURLOPT_PROXY => self::$proxy['address'],
curl_setopt($ch, CURLOPT_HTTPPROXYTUNNEL, self::$proxy['tunnel']); CURLOPT_PROXYPORT => self::$proxy['port'],
CURLOPT_HTTPPROXYTUNNEL => self::$proxy['tunnel'],
curl_setopt($ch, CURLOPT_PROXYAUTH, self::$proxy['auth']['method']); CURLOPT_PROXYAUTH => self::$proxy['auth']['method'],
curl_setopt($ch, CURLOPT_PROXYUSERNAME, self::$proxy['auth']['user']); CURLOPT_PROXYUSERPWD => self::$proxy['auth']['user'] . ':' . self::$proxy['auth']['pass']
curl_setopt($ch, CURLOPT_PROXYPASSWORD, self::$proxy['auth']['pass']); ));
} }
$response = curl_exec($ch); $response = curl_exec(self::$handle);
$error = curl_error($ch); $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();
@@ -447,4 +564,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

@@ -0,0 +1,66 @@
<?php
namespace Unirest\Request;
use Unirest\Request as Request;
use Unirest\Exception as Exception;
class Body
{
/**
* Prepares a file for upload. To be used inside the parameters declaration for a request.
* @param string $filename The file path
* @param string $mimetype MIME type
* @param string $postname the file name
* @return string|\CURLFile
*/
public static function File($filename, $mimetype = '', $postname = '')
{
if (class_exists('CURLFile')) {
return new \CURLFile($filename, $mimetype, $postname);
}
if (function_exists('curl_file_create')) {
return curl_file_create($filename, $mimetype, $postname);
}
return sprintf('@%s;filename=%s;type=%s', $filename, $postname ?: basename($filename), $mimetype);
}
public static function Json($data)
{
if (!function_exists('json_encode')) {
throw new Exception('JSON Extension not available');
}
return json_encode($data);
}
public static function Form($data)
{
if (is_array($data) || is_object($data) || $data instanceof \Traversable) {
return http_build_query(Request::buildHTTPCurlQuery($data));
}
return $data;
}
public static function Multipart($data, $files = false)
{
if (is_object($data)) {
return get_object_vars($data);
}
if (!is_array($data)) {
return array($data);
}
if ($files !== false) {
foreach ($files as $name => $file) {
$data[$name] = call_user_func(array(__CLASS__, 'File'), $file);
}
}
return $data;
}
}

View File

@@ -25,10 +25,12 @@ class Response
// make sure raw_body is the first argument // make sure raw_body is the first argument
array_unshift($json_args, $raw_body); array_unshift($json_args, $raw_body);
$json = call_user_func_array('json_decode', $json_args); if (function_exists('json_decode')) {
$json = call_user_func_array('json_decode', $json_args);
if (json_last_error() === JSON_ERROR_NONE) { if (json_last_error() === JSON_ERROR_NONE) {
$this->body = $json; $this->body = $json;
}
} }
} }
@@ -37,6 +39,8 @@ class Response
* *
* thanks to ricardovermeltfoort@gmail.com * thanks to ricardovermeltfoort@gmail.com
* http://php.net/manual/en/function.http-parse-headers.php#112986 * http://php.net/manual/en/function.http-parse-headers.php#112986
* @param string $raw_headers raw headers
* @return array
*/ */
private function parseHeaders($raw_headers) private function parseHeaders($raw_headers)
{ {

View File

@@ -0,0 +1,89 @@
<?php
namespace Unirest\Request\Body\Test;
use Unirest\Request as Request;
use Unirest\Request\Body as Body;
require_once __DIR__ . '/../../src/Unirest.php';
class BodyTest extends \PHPUnit_Framework_TestCase
{
public function testCURLFile()
{
$fixture = __DIR__ . '/fixtures/upload.txt';
$file = Body::File($fixture);
if (PHP_MAJOR_VERSION === 5 && PHP_MINOR_VERSION === 4) {
$this->assertEquals($file, sprintf('@%s;filename=%s;type=', $fixture, basename($fixture)));
} else {
$this->assertTrue($file instanceof \CURLFile);
}
}
public function testHttpBuildQueryWithCurlFile()
{
$fixture = __DIR__ . '/fixtures/upload.txt';
$file = Body::File($fixture);
$body = array(
'to' => 'mail@mailinator.com',
'from' => 'mail@mailinator.com',
'file' => $file
);
$result = Request::buildHTTPCurlQuery($body);
$this->assertEquals($result['file'], $file);
}
public function testJson()
{
$body = Body::Json(array('foo', 'bar'));
$this->assertEquals($body, '["foo","bar"]');
}
public function testForm()
{
$body = Body::Form(array('foo' => 'bar', 'bar' => 'baz'));
$this->assertEquals($body, 'foo=bar&bar=baz');
// try again with a string
$body = Body::Form($body);
$this->assertEquals($body, 'foo=bar&bar=baz');
}
public function testMultipart()
{
$arr = array('foo' => 'bar', 'bar' => 'baz');
$body = Body::Multipart((object) $arr);
$this->assertEquals($body, $arr);
$body = Body::Multipart('flat');
$this->assertEquals($body, array('flat'));
}
public function testMultipartFiles()
{
$fixture = __DIR__ . '/fixtures/upload.txt';
$data = array('foo' => 'bar', 'bar' => 'baz');
$files = array('test' => $fixture);
$body = Body::Multipart($data, $files);
// echo $body;
$this->assertEquals($body, array(
'foo' => 'bar',
'bar' => 'baz',
'test' => Body::File($fixture)
));
}
}

View File

@@ -1,17 +0,0 @@
<?php
use Unirest\File as File;
class UnirestFileTest extends \PHPUnit_Framework_TestCase
{
public function testCURLFile()
{
$file = File::add(UPLOAD_FIXTURE);
if (PHP_MAJOR_VERSION === 5 && PHP_MINOR_VERSION === 4) {
$this->assertEquals($file, sprintf('@%s;filename=%s;type=', UPLOAD_FIXTURE, basename(UPLOAD_FIXTURE)));
} else {
$this->assertTrue($file instanceof \CURLFile);
}
}
}

View File

@@ -1,114 +1,156 @@
<?php <?php
namespace Unirest\Request\Test;
use Unirest\Request as Request;
require __DIR__ . '/../../src/Unirest.php';
class UnirestRequestTest extends \PHPUnit_Framework_TestCase class UnirestRequestTest extends \PHPUnit_Framework_TestCase
{ {
// Generic // Generic
public function testHttpBuildQueryWhenCurlFile() public function testCurlOpts()
{ {
$file = Unirest\File::add(UPLOAD_FIXTURE); Request::curlOpt(CURLOPT_COOKIE, 'foo=bar');
$body = array(
'to' => 'mail@mailinator.com',
'from' => 'mail@mailinator.com',
'file' => $file
);
$result = Unirest\Request::buildHTTPCurlQuery($body); $response = Request::get('http://mockbin.com/request');
$this->assertEquals($result['file'], $file);
$this->assertTrue(property_exists($response->body->cookies, 'foo'));
Request::clearCurlOpts();
} }
/** /**
* @expectedException Exception * @expectedException \Unirest\Exception
*/ */
public function testTimeoutFail() public function testTimeoutFail()
{ {
Unirest\Request::timeout(1); Request::timeout(1);
Unirest\Request::get('http://httpbin.org/delay/3'); Request::get('http://mockbin.com/delay/1000');
Unirest\Request::timeout(null); // Cleaning timeout for the other tests Request::timeout(null); // Cleaning timeout for the other tests
} }
public function testTimeoutSuccess() public function testDefaultHeaders()
{ {
Unirest\Request::timeout(3); $defaultHeaders = array(
'header1' => 'Hello',
'header2' => 'world'
);
Request::defaultHeaders($defaultHeaders);
$response = Request::get('http://mockbin.com/request');
$response = Unirest\Request::get('http://httpbin.org/delay/1');
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertObjectHasAttribute('header1', $response->body->headers);
$this->assertEquals('Hello', $response->body->headers->header1);
$this->assertObjectHasAttribute('header2', $response->body->headers);
$this->assertEquals('world', $response->body->headers->header2);
Unirest\Request::timeout(null); // Cleaning timeout for the other tests Request::clearDefaultHeaders();
$response = Request::get('http://mockbin.com/request');
$this->assertEquals(200, $response->code);
$this->assertObjectNotHasAttribute('header1', $response->body->headers);
$this->assertObjectNotHasAttribute('header2', $response->body->headers);
} }
public function testDefaultHeader() public function testDefaultHeader()
{ {
Unirest\Request::defaultHeader('Hello', 'custom'); Request::defaultHeader('Hello', 'custom');
$response = Unirest\Request::get('http://httpbin.org/get');
$response = 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); Request::clearDefaultHeaders();
$response = Unirest\Request::get('http://httpbin.org/get');
$response = 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->assertTrue(array_key_exists('Hello', $properties));
$this->assertEquals('custom', $headers->Hello); public function testSetMashapeKey()
Unirest\Request::clearDefaultHeaders(); {
$response = Unirest\Request::get('http://httpbin.org/get'); Request::setMashapeKey('abcd');
$response = 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, 'x-mashape-key'));
$properties = get_object_vars($headers); $this->assertEquals('abcd', $response->body->headers->{'x-mashape-key'});
$this->assertFalse(array_key_exists('Hello', $properties));
// send another request
$response = Request::get('http://mockbin.com/request');
$this->assertEquals(200, $response->code);
$this->assertTrue(property_exists($response->body->headers, 'x-mashape-key'));
$this->assertEquals('abcd', $response->body->headers->{'x-mashape-key'});
Request::clearDefaultHeaders();
$response = Request::get('http://mockbin.com/request');
$this->assertEquals(200, $response->code);
$this->assertFalse(property_exists($response->body->headers, 'x-mashape-key'));
} }
public function testGzip() public function testGzip()
{ {
$response = Unirest\Request::get('http://httpbin.org/gzip'); $response = 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 = 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'); Request::auth('user', 'password');
$headers = $response->body->headers;
$this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $headers->Authorization); $response = 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 = 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 = 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 = Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'key' => 'value', 'key' => 'value',
@@ -119,17 +161,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 = Request::get('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'user.name' => 'Mark', 'user.name' => 'Mark',
@@ -137,15 +177,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 = 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 +192,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 = 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 = 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 = 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 = 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 = Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark', 'name' => 'Mark',
@@ -223,29 +256,65 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
)); ));
$this->assertEquals(200, $response->code); $this->assertEquals(200, $response->code);
$this->assertEquals('POST', $response->body->method);
$this->assertEquals('Mark', $response->body->postData->params->name);
$this->assertEquals('thefosk', $response->body->postData->params->nick);
}
$form = $response->body->form; public function testPostForm()
$this->assertEquals('Mark', $form->name); {
$this->assertEquals('thefosk', $form->nick); $body = Request\Body::Form(array(
'name' => 'Mark',
'nick' => 'thefosk'
));
$response = Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json'
), $body);
$this->assertEquals('POST', $response->body->method);
$this->assertEquals('application/x-www-form-urlencoded', $response->body->headers->{'content-type'});
$this->assertEquals('application/x-www-form-urlencoded', $response->body->postData->mimeType);
$this->assertEquals('Mark', $response->body->postData->params->name);
$this->assertEquals('thefosk', $response->body->postData->params->nick);
}
public function testPostMultipart()
{
$body = Request\Body::Multipart(array(
'name' => 'Mark',
'nick' => 'thefosk'
));
$response = Request::post('http://mockbin.com/request', (object) array(
'Accept' => 'application/json',
), $body);
$this->assertEquals('POST', $response->body->method);
$this->assertEquals('multipart/form-data', explode(';', $response->body->headers->{'content-type'})[0]);
$this->assertEquals('multipart/form-data', $response->body->postData->mimeType);
$this->assertEquals('Mark', $response->body->postData->params->name);
$this->assertEquals('thefosk', $response->body->postData->params->nick);
} }
public function testPostWithEqualSign() public function testPostWithEqualSign()
{ {
$response = Unirest\Request::post('http://httpbin.org/post', array( $body = Request\Body::Form(array(
'Accept' => 'application/json'
), array(
'name' => 'Mark=Hello' 'name' => 'Mark=Hello'
)); ));
$this->assertEquals(200, $response->code); $response = Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json'
), $body);
$form = $response->body->form; $this->assertEquals(200, $response->code);
$this->assertEquals('Mark=Hello', $form->name); $this->assertEquals('POST', $response->body->method);
$this->assertEquals('Mark=Hello', $response->body->postData->params->name);
} }
public function testPostArray() public function testPostArray()
{ {
$response = Unirest\Request::post('http://httpbin.org/post', array( $response = Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name[0]' => 'Mark', 'name[0]' => 'Mark',
@@ -253,16 +322,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 = Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'user.name' => 'Mark', 'user.name' => 'Mark',
@@ -270,15 +337,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 = 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,17 +352,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( $body = Request\Body::Form(array(
'Accept' => 'application/json'
), array(
'key' => 'value', 'key' => 'value',
'items' => array( 'items' => array(
'item1', 'item1',
@@ -304,18 +366,21 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
) )
)); ));
$this->assertEquals(200, $response->code); $response = Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json'
), $body);
$form = $response->body->form; $this->assertEquals(200, $response->code);
$this->assertEquals('value', $form->key); $this->assertEquals('POST', $response->body->method);
$this->assertEquals('item1', $form->{'items[0]'}); $this->assertEquals('value', $response->body->postData->params->key);
$this->assertEquals('item2', $form->{'items[1]'}); $this->assertEquals('item1', $response->body->postData->params->{'items[0]'});
$this->assertEquals('item2', $response->body->postData->params->{'items[1]'});
} }
// PUT // PUT
public function testPut() public function testPut()
{ {
$response = Unirest\Request::put('http://httpbin.org/put', array( $response = Request::put('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark', 'name' => 'Mark',
@@ -323,16 +388,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 = Request::patch('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark', 'name' => 'Mark',
@@ -340,16 +404,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 = 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 +421,59 @@ 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( $fixture = __DIR__ . '/../fixtures/upload.txt';
$headers = array('Accept' => 'application/json');
$files = array('file' => $fixture);
$data = array('name' => 'ahmad');
$body = Request\Body::Multipart($data, $files);
$response = Request::post('http://mockbin.com/request', $headers, $body);
$this->assertEquals(200, $response->code);
$this->assertEquals('POST', $response->body->method);
$this->assertEquals('ahmad', $response->body->postData->params->name);
$this->assertEquals('This is a test', $response->body->postData->params->file);
}
public function testUploadWithoutHelper()
{
$fixture = __DIR__ . '/../fixtures/upload.txt';
$response = Request::post('http://mockbin.com/request', array(
'Accept' => 'application/json' 'Accept' => 'application/json'
), array( ), array(
'name' => 'Mark', 'name' => 'Mark',
'file' => Unirest\File::add(UPLOAD_FIXTURE) 'file' => Request\Body::File($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( $fixture = __DIR__ . '/../fixtures/upload.txt';
$response = 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]' => Request\Body::File($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);
} }
} }

View File

@@ -1,27 +1,34 @@
<?php <?php
namespace Unirest\Response\Test;
use Unirest\Request as Request;
use Unirest\Response as Response;
require __DIR__ . '/../../src/Unirest.php';
class UnirestResponseTest extends \PHPUnit_Framework_TestCase class UnirestResponseTest extends \PHPUnit_Framework_TestCase
{ {
public function testJSONAssociativeArrays() public function testJSONAssociativeArrays()
{ {
$opts = Unirest\Request::jsonOpts(true); $opts = Request::jsonOpts(true);
$response = new Unirest\Response(200, '{"a":1,"b":2,"c":3,"d":4,"e":5}', '', $opts); $response = new Response(200, '{"a":1,"b":2,"c":3,"d":4,"e":5}', '', $opts);
$this->assertEquals($response->body['a'], 1); $this->assertEquals($response->body['a'], 1);
} }
public function testJSONAObjects() public function testJSONAObjects()
{ {
$opts = Unirest\Request::jsonOpts(false); $opts = Request::jsonOpts(false);
$response = new Unirest\Response(200, '{"a":1,"b":2,"c":3,"d":4,"e":5}', '', $opts); $response = new Response(200, '{"a":1,"b":2,"c":3,"d":4,"e":5}', '', $opts);
$this->assertEquals($response->body->a, 1); $this->assertEquals($response->body->a, 1);
} }
public function testJSONOpts() public function testJSONOpts()
{ {
$opts = Unirest\Request::jsonOpts(false, 512, JSON_NUMERIC_CHECK); $opts = Request::jsonOpts(false, 512, JSON_NUMERIC_CHECK);
$response = new Unirest\Response(200, '{"number": 1234567890}', '', $opts); $response = new Response(200, '{"number": 1234567890}', '', $opts);
$this->assertSame($response->body->number, 1234567890); $this->assertSame($response->body->number, 1234567890);
} }

View File

@@ -1,5 +1 @@
<?php <?php ?>
require_once __DIR__ . '/../src/Unirest.php';
define('UPLOAD_FIXTURE', __DIR__ . '/fixtures/upload.txt');