updating README and fixing typo

Add PHP version to readme.md's requirements

README.md

@@ -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
 
@@ -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,7 +108,7 @@ 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
@@ -151,11 +152,21 @@ 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 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
@@ -194,7 +205,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:
 

src/Unirest/Request.php

@@ -7,11 +7,12 @@ use Unirest\Response;
 
 class Request
 {
+    private static $cookieFile = null;
+    private static $defaultHeaders = array();
     private static $handle = null;
     private static $jsonOpts = array();
-    private static $verifyPeer = true;
     private static $socketTimeout = null;
-    private static $defaultHeaders = array();
+    private static $verifyPeer = true;
 
     private static $auth = array (
         'user' => '',
@@ -102,6 +103,18 @@ class Request
         return self::defaultHeader('X-Mashape-Key', $key);
     }
 
+    /**
+     * 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;
+    }
+
     /**
      * Clear all the default headers
      */
@@ -360,6 +373,11 @@ class Request
             curl_setopt(self::$handle, CURLOPT_TIMEOUT, self::$socketTimeout);
         }
 
+        if (self::$cookieFile) {
+            curl_setopt($ch, CURLOPT_COOKIEFILE, self::$cookieFile);
+            curl_setopt($ch, CURLOPT_COOKIEJAR, self::$cookieFile);
+        }
+
         // supporting deprecated http auth method
         if (!empty($username)) {
             curl_setopt_array(self::$handle, array(

tests/Unirest/RequestTest.php

@@ -23,126 +23,117 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
     {
         Unirest\Request::timeout(1);
 
-        Unirest\Request::get('http://httpbin.org/delay/3');
+        Unirest\Request::get('http://mockbin.com/delay/3000');
 
         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');
+        $response = Unirest\Request::get('http://mockbin.com/delay/2000');
         $this->assertEquals(200, $response->code);
 
         Unirest\Request::timeout(null); // Cleaning timeout for the other tests
     }
+*/
 
     public function testDefaultHeader()
     {
         Unirest\Request::defaultHeader('Hello', 'custom');
-        $response = Unirest\Request::get('http://httpbin.org/get');
+
+        $response = Unirest\Request::get('http://mockbin.com/request');
 
         $this->assertEquals(200, $response->code);
-        $headers    = $response->body->headers;
+        $this->assertTrue(property_exists($response->body->headers, 'hello'));
-        $properties = get_object_vars($headers);
+        $this->assertEquals('custom', $response->body->headers->hello);
-        $this->assertTrue(array_key_exists('Hello', $properties));
-        $this->assertEquals('custom', $headers->Hello);
-        $response = Unirest\Request::get('http://httpbin.org/get');
 
-        $this->assertEquals(200, $response->code);
-        $headers    = $response->body->headers;
-        $properties = get_object_vars($headers);
-        $this->assertTrue(array_key_exists('Hello', $properties));
-        $this->assertEquals('custom', $headers->Hello);
         Unirest\Request::clearDefaultHeaders();
-        $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;
+        $this->assertFalse(property_exists($response->body->headers, 'hello'));
-        $properties = get_object_vars($headers);
-        $this->assertFalse(array_key_exists('Hello', $properties));
     }
 
     public function testSetMashapeKey()
     {
         Unirest\Request::setMashapeKey('abcd');
-        $response = Unirest\Request::get('http://httpbin.org/get');
+
+        $response = Unirest\Request::get('http://mockbin.com/request');
 
         $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->assertTrue(array_key_exists('X-Mashape-Key', $properties));
+
-        $this->assertEquals('abcd', $headers->{'X-Mashape-Key'});
+        // send another request
-        $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;
+        $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->assertTrue(array_key_exists('X-Mashape-Key', $properties));
+
-        $this->assertEquals('abcd', $headers->{'X-Mashape-Key'});
         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;
+        $this->assertFalse(property_exists($response->body->headers, 'x-mashape-key'));
-        $properties = get_object_vars($headers);
-        $this->assertFalse(array_key_exists('X-Mashape-Key', $properties));
     }
 
     public function testGzip()
     {
-        $response = Unirest\Request::get('http://httpbin.org/gzip');
+        $response = Unirest\Request::get('http://mockbin.com/gzip/request');
-        $args     = $response->body;
+
-        $this->assertEquals(true, $args->gzipped);
+        $this->assertEquals('gzip', $response->headers['Content-Encoding']);
     }
 
     public function testBasicAuthenticationDeprecated()
     {
-        $response = Unirest\Request::get('http://httpbin.org/get', array(), array(), 'user', 'password');
+        $response = Unirest\Request::get('http://mockbin.com/request', array(), array(), 'user', 'password');
-        $headers  = $response->body->headers;
+
-        $this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $headers->Authorization);
+        $this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $response->body->headers->authorization);
     }
 
     public function testBasicAuthentication()
     {
         Unirest\Request::auth('user', 'password');
-        $response = Unirest\Request::get('http://httpbin.org/get');
 
-        $this->assertEquals('Basic dXNlcjpwYXNzd29yZA==', $response->body->headers->Authorization);
+        $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(
+        $response = Unirest\Request::get('http://mockbin.com/request', array(
-            'user-agent' => 'ciao',
+            'user-agent' => 'unirest-php',
         ));
 
         $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
     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);
-
+        $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()
     {
-        $response = Unirest\Request::get('http://httpbin.org/get', array(
+        $response = Unirest\Request::get('http://mockbin.com/request', array(
             'Accept' => 'application/json'
         ), array(
             'key' => 'value',
@@ -153,17 +144,15 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
         ));
 
         $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()
     {
-        $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',
@@ -171,15 +160,14 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
         ));
 
         $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()
     {
-        $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',
@@ -187,69 +175,63 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
         ));
 
         $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()
     {
-        $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);
-
+        $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()
     {
-        $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);
-
+        $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()
     {
-        $response = Unirest\Request::get('http://httpbin.org/get?query=[{"type":"/music/album","name":null,"artist":{"id":"/en/bob_dylan"},"limit":3}]&cursor');
+        $response = Unirest\Request::get('http://mockbin.com/request?query=[{"type":"/music/album","name":null,"artist":{"id":"/en/bob_dylan"},"limit":3}]&cursor');
 
         $this->assertEquals(200, $response->code);
-
+        $this->assertEquals('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()
     {
-        $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);
-
+        $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
     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',
@@ -257,29 +239,27 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
         ));
 
         $this->assertEquals(200, $response->code);
-
+        $this->assertEquals('POST', $response->body->method);
-        $form = $response->body->form;
+        $this->assertEquals('Mark', $response->body->postData->params->name);
-        $this->assertEquals('Mark', $form->name);
+        $this->assertEquals('thefosk', $response->body->postData->params->nick);
-        $this->assertEquals('thefosk', $form->nick);
     }
 
     public function testPostWithEqualSign()
     {
-        $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);
-
+        $this->assertEquals('POST', $response->body->method);
-        $form = $response->body->form;
+        $this->assertEquals('Mark=Hello', $response->body->postData->params->name);
-        $this->assertEquals('Mark=Hello', $form->name);
     }
 
     public function testPostArray()
     {
-        $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',
@@ -287,16 +267,14 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
         ));
 
         $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()
     {
-        $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',
@@ -304,15 +282,14 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
         ));
 
         $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()
     {
-        $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(
@@ -320,15 +297,13 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
         )));
 
         $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()
     {
-        $response = Unirest\Request::post('http://httpbin.org/post', array(
+        $response = Unirest\Request::post('http://mockbin.com/request', array(
             'Accept' => 'application/json'
         ), array(
             'key' => 'value',
@@ -339,17 +314,16 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
         ));
 
         $this->assertEquals(200, $response->code);
-
+        $this->assertEquals('POST', $response->body->method);
-        $form = $response->body->form;
+        $this->assertEquals('value', $response->body->postData->params->key);
-        $this->assertEquals('value', $form->key);
+        $this->assertEquals('item1', $response->body->postData->params->{'items[0]'});
-        $this->assertEquals('item1', $form->{'items[0]'});
+        $this->assertEquals('item2', $response->body->postData->params->{'items[1]'});
-        $this->assertEquals('item2', $form->{'items[1]'});
     }
 
     // PUT
     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',
@@ -357,16 +331,15 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
         ));
 
         $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
     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',
@@ -374,16 +347,15 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
         ));
 
         $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
     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(
@@ -392,42 +364,37 @@ class UnirestRequestTest extends \PHPUnit_Framework_TestCase
         ));
 
         $this->assertEquals(200, $response->code);
-        $data = $response->body->data;
+        $this->assertEquals('DELETE', $response->body->method);
-        $this->assertTrue(empty($data));
     }
 
     // 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);
-
+        $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()
     {
-        $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);
-
+        $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);
     }
 }