added async option

Author: pulkitjalan

README.md

@@ -101,3 +101,19 @@ $requester->url('example.com/upload')->addFile('/tmp/image.jpg')->post([
     ]
 ]);
 ```
+
+Guzzle 5 uses RingPHP and has the added functionality of performing request asynchronously.
+
+Performing asynchronous requests
+```php
+// Create a post request
+$response = $requester->url('example.com')->async(true)->get();
+
+// Use the response asynchronously
+$this->response = $response->then(function ($response) {
+    return $response->getBody();
+});
+
+// Use the response synchronously
+$this->response = $response->getBody();
+```

src/Requester.php

@@ -39,6 +39,20 @@ class Requester
      */
     protected $secure = true;
 
+    /**
+     * Verify ssl connection
+     *
+     * @var boolean|string
+     */
+    protected $verify = true;
+
+    /**
+     * Make request asynchronously
+     *
+     * @var boolean
+     */
+    protected $async = false;
+
     /**
      * Retry request on which types of errors
      *
@@ -123,7 +137,20 @@ public function secure($secure)
      */
     public function verify($verify)
     {
-        $this->options = array_merge($this->options, ['verify' => $verify]);
+        $this->verify = $verify;
+
+        return $this;
+    }
+
+    /**
+     * Make request asynchronously
+     *
+     * @param  boolean                          $async
+     * @return \PulkitJalan\Requester\Requester
+     */
+    public function async($async)
+    {
+        $this->async = $async;
 
         return $this;
     }
@@ -277,6 +304,7 @@ public function options(array $options = [])
 
     /**
      * Getter for the url will append protocol if one does not exist
+     *
      * @return string
      */
     public function getUrl()
@@ -294,6 +322,24 @@ public function getUrl()
         return $url;
     }
 
+    /**
+     * Getter for options
+     *
+     * @return array
+     */
+    public function getOptions($options)
+    {
+        // Add verify to options
+        $options = array_merge(['verify' => $this->verify], $options);
+
+        if ($this->async) {
+            $options = array_merge(['future' => true], $options);
+        }
+
+        // merge and return
+        return array_merge_recursive($this->options, $options);
+    }
+
     /**
      * Send the request using guzzle
      *
@@ -308,7 +354,7 @@ protected function send($function, array $options = [])
         $url = $this->getUrl();
 
         // merge options
-        $options = array_merge_recursive($this->options, $options);
+        $options = $this->getOptions($options);
 
         // need to reset after every request
         $this->initialize();
@@ -363,6 +409,7 @@ protected function initialize()
         $this->retryOn = array_get($this->config, 'retry.on', [500, 502, 503, 504]);
         $this->retryDelay = array_get($this->config, 'retry.delay', 10);
         $this->retry = array_get($this->config, 'retry.times', 5);
-        $this->verify(array_get($this->config, 'verify', true));
+        $this->verify = array_get($this->config, 'verify', true);
+        $this->async = array_get($this->config, 'async', false);
     }
 }

src/config/config.php

@@ -23,6 +23,16 @@
     */
     'verify' => true,
 
+    /*
+    |--------------------------------------------------------------------------
+    | Make request asynchronously (see README for more info)
+    |--------------------------------------------------------------------------
+    |
+    | Advisable to leave it false and use the async method per request
+    |
+    */
+    'async' => false,
+
     /*
     |--------------------------------------------------------------------------
     | Retry options

tests/RequesterTest.php

@@ -4,22 +4,21 @@
 
 use PHPUnit_Framework_TestCase;
 use Mockery;
-use PulkitJalan\Requester\Requester;
 
 class RequesterTest extends PHPUnit_Framework_TestCase
 {
     public function setUp()
     {
         $this->guzzle = Mockery::mock('GuzzleHttp\Client')->makePartial();
-        $this->requester = new Requester($this->guzzle, []);
+        $this->requester = Mockery::mock('PulkitJalan\Requester\Requester', [$this->guzzle, []])->makePartial();
     }
 
     public function tearDown()
     {
         Mockery::close();
     }
 
-    public function test_url_getter()
+    public function testUrlGetter()
     {
         $this->requester->url('example.com');
 
@@ -34,37 +33,42 @@ public function test_url_getter()
         $this->assertEquals('git://example.com', $this->requester->getUrl());
     }
 
-    public function test_invalid_url_exception()
+    public function testInvalidUrlException()
     {
         $this->setExpectedException('PulkitJalan\Requester\Exceptions\InvalidUrlException');
 
         $this->requester->getUrl();
     }
 
-    public function test_guzzle_getter()
+    public function testGuzzleGetter()
     {
         $this->assertInstanceOf('GuzzleHttp\Client', $this->requester->getGuzzleClient());
     }
 
-    public function test_disabling_ssl_verification()
+    public function testDisablingSslVerification()
     {
-        $this->requester->verify(false);
+        $this->guzzle->shouldReceive('get')->once()->with('https://example.com', [
+            'verify' => false,
+        ]);
 
-        $this->assertEquals(['verify' => false], $this->readAttribute($this->requester, 'options'));
+        $this->requester->url('example.com')->verify(false)->get();
+    }
 
-        $this->guzzle->shouldReceive('get')->once()->with('http://example.com', [
-            'verify' => false,
+    public function testSettingAsync()
+    {
+        $this->guzzle->shouldReceive('get')->once()->with('https://example.com', [
+            'verify' => true,
+            'future' => true
         ]);
 
-        $this->requester->url('example.com')->secure(false)->verify(false)->get();
+        $this->requester->url('example.com')->async(true)->get();
     }
 
-    public function test_setting_and_adding_headers()
+    public function testSettingAndAddingHeaders()
     {
         $this->requester->headers(['Authorization' => 'Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==']);
 
         $this->assertEquals([
-            'verify' => true,
             'headers' => [
                 'Authorization' => 'Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==',
             ],
@@ -73,15 +77,14 @@ public function test_setting_and_adding_headers()
         $this->requester->headers(['Cache-Control' => 'no-cache']);
 
         $this->assertEquals([
-            'verify' => true,
             'headers' => [
                 'Authorization' => 'Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==',
                 'Cache-Control' => 'no-cache',
             ],
         ], $this->readAttribute($this->requester, 'options'));
     }
 
-    public function test_adding_file_to_request()
+    public function testAddingFileToRequest()
     {
         $this->requester->addFile(__FILE__);
 
@@ -94,7 +97,7 @@ public function test_adding_file_to_request()
         $this->assertInternalType('resource', $this->readAttribute($this->requester, 'options')['body']['image']);
     }
 
-    public function test_changing_retry_options()
+    public function testChangingRetryOptions()
     {
         $this->requester->retry(10);
 
@@ -113,7 +116,7 @@ public function test_changing_retry_options()
         $this->assertEquals(false, $this->readAttribute($this->requester, 'retry'));
     }
 
-    public function test_sending_get_request()
+    public function testSendingGetRequest()
     {
         $this->guzzle->shouldReceive('get')->once()->with('https://example.com', [
             'verify' => true,
@@ -122,7 +125,7 @@ public function test_sending_get_request()
         $this->requester->url('example.com')->get();
     }
 
-    public function test_sending_head_request()
+    public function testSendingHeadRequest()
     {
         $this->guzzle->shouldReceive('head')->once()->with('https://example.com', [
             'verify' => true,
@@ -131,7 +134,7 @@ public function test_sending_head_request()
         $this->requester->url('example.com')->head();
     }
 
-    public function test_sending_options_request()
+    public function testSendingOptionsRequest()
     {
         $this->guzzle->shouldReceive('options')->once()->with('https://example.com', [
             'verify' => true,
@@ -140,7 +143,7 @@ public function test_sending_options_request()
         $this->requester->url('example.com')->options();
     }
 
-    public function test_sending_post_request()
+    public function testSendingPostRequest()
     {
         $this->guzzle->shouldReceive('post')->once()->with('https://example.com', [
             'verify' => true,
@@ -156,7 +159,7 @@ public function test_sending_post_request()
         ]);
     }
 
-    public function test_sending_put_request()
+    public function testSendingPutRequest()
     {
         $this->guzzle->shouldReceive('put')->once()->with('https://example.com', [
             'verify' => true,
@@ -172,7 +175,7 @@ public function test_sending_put_request()
         ]);
     }
 
-    public function test_sending_patch_request()
+    public function testSendingPatchRequest()
     {
         $this->guzzle->shouldReceive('patch')->once()->with('https://example.com', [
             'verify' => true,
@@ -188,7 +191,7 @@ public function test_sending_patch_request()
         ]);
     }
 
-    public function test_sending_delete_request()
+    public function testSendingDeleteRequest()
     {
         $this->guzzle->shouldReceive('delete')->once()->with('https://example.com', [
             'verify' => true,