Merge pull request php-vcr#147 from jamiecuthill/implement_curl_reset

Reset request on curl_reset

Author: adri

src/VCR/CodeTransform/CurlCodeTransform.php

@@ -15,7 +15,8 @@ class CurlCodeTransform extends AbstractCodeTransform
         '/(?<!::|->|\w_)\\\?curl_multi_add_handle\s*\(/i'    => '\VCR\LibraryHooks\CurlHook::curl_multi_add_handle(',
         '/(?<!::|->|\w_)\\\?curl_multi_remove_handle\s*\(/i' => '\VCR\LibraryHooks\CurlHook::curl_multi_remove_handle(',
         '/(?<!::|->|\w_)\\\?curl_multi_exec\s*\(/i'          => '\VCR\LibraryHooks\CurlHook::curl_multi_exec(',
-        '/(?<!::|->|\w_)\\\?curl_multi_info_read\s*\(/i'     => '\VCR\LibraryHooks\CurlHook::curl_multi_info_read('
+        '/(?<!::|->|\w_)\\\?curl_multi_info_read\s*\(/i'     => '\VCR\LibraryHooks\CurlHook::curl_multi_info_read(',
+        '/(?<!::|->|\w_)\\\?curl_reset\s*\(/i'               => '\VCR\LibraryHooks\CurlHook::curl_reset('
     );
 
     /**

src/VCR/LibraryHooks/CurlHook.php

@@ -171,6 +171,19 @@ public static function curlInit($url = null)
         return $curlHandle;
     }
 
+    /**
+     * Reset a cURL session.
+     *
+     * @link http://www.php.net/manual/en/function.curl-reset.php
+     * @param resource $curlHandle A cURL handle returned by curl_init().
+     */
+    public static function curlReset($curlHandle)
+    {
+        \curl_reset($curlHandle);
+        self::$requests[(int) $curlHandle] = new Request('GET', null);
+        self::$curlOptions[(int) $curlHandle] = array();
+    }
+
     /**
      * Perform a cURL session.
      *
@@ -185,7 +198,7 @@ public static function curlExec($curlHandle)
     {
         $request = self::$requests[(int) $curlHandle];
         CurlHelper::validateCurlPOSTBody($request, $curlHandle);
-        
+
         $requestCallback = self::$requestCallback;
         self::$responses[(int) $curlHandle] = $requestCallback($request);
 
@@ -202,8 +215,6 @@ public static function curlExec($curlHandle)
      * @link http://www.php.net/manual/en/function.curl-multi-add-handle.php
      * @param resource $multiHandle A cURL multi handle returned by curl_multi_init().
      * @param resource $curlHandle  A cURL handle returned by curl_init().
-     *
-     * @return integer Returns 0 on success, or one of the CURLM_XXX errors code.
      */
     public static function curlMultiAddHandle($multiHandle, $curlHandle)
     {
@@ -220,8 +231,6 @@ public static function curlMultiAddHandle($multiHandle, $curlHandle)
      * @link http://www.php.net/manual/en/function.curl-multi-remove-handle.php
      * @param resource $multiHandle A cURL multi handle returned by curl_multi_init().
      * @param resource $curlHandle A cURL handle returned by curl_init().
-     *
-     * @return integer  Returns 0 on success, or one of the CURLM_XXX error codes.
      */
     public static function curlMultiRemoveHandle($multiHandle, $curlHandle)
     {
@@ -318,8 +327,6 @@ public static function curlSetopt($curlHandle, $option, $value)
      * @link http://www.php.net/manual/en/function.curl-setopt-array.php
      * @param resource $curlHandle A cURL handle returned by curl_init().
      * @param array    $options    An array specifying which options to set and their values.
-     *
-     * @return boolean|null              Returns TRUE if all options were successfully set.
      */
     public static function curlSetoptArray($curlHandle, $options)
     {

tests/VCR/CodeTransform/CurlCodeTransformTest.php

@@ -30,6 +30,7 @@ public function codeSnippetProvider()
             array('\VCR\LibraryHooks\CurlHook::curl_multi_remove_handle(', 'curl_multi_remove_handle('),
             array('\VCR\LibraryHooks\CurlHook::curl_multi_exec(', 'curl_multi_exec('),
             array('\VCR\LibraryHooks\CurlHook::curl_multi_info_read(', 'curl_multi_info_read('),
+            array('\VCR\LibraryHooks\CurlHook::curl_reset(', 'curl_reset('),
 
             array('\VCR\LibraryHooks\CurlHook::curl_init(', '\\CURL_INIT ('),
             array('\VCR\LibraryHooks\CurlHook::curl_exec(', '\\curl_exec('),
@@ -39,6 +40,7 @@ public function codeSnippetProvider()
             array('\VCR\LibraryHooks\CurlHook::curl_multi_remove_handle(', '\\curl_multi_remove_handle('),
             array('\VCR\LibraryHooks\CurlHook::curl_multi_exec(', '\\curl_multi_exec('),
             array('\VCR\LibraryHooks\CurlHook::curl_multi_info_read(', '\\curl_multi_info_read('),
+            array('\VCR\LibraryHooks\CurlHook::curl_reset(', '\\curl_reset('),
 
             array('SomeClass::CURL_INIT (', 'SomeClass::CURL_INIT ('),
             array('SomeClass::curl_exec(', 'SomeClass::curl_exec('),
@@ -48,6 +50,7 @@ public function codeSnippetProvider()
             array('SomeClass::curl_multi_remove_handle(', 'SomeClass::curl_multi_remove_handle('),
             array('SomeClass::curl_multi_exec(', 'SomeClass::curl_multi_exec('),
             array('SomeClass::curl_multi_info_read(', 'SomeClass::curl_multi_info_read('),
+            array('SomeClass::curl_reset(', 'SomeClass::curl_reset('),
 
             array('$object->CURL_INIT (', '$object->CURL_INIT ('),
             array('$object->curl_exec(', '$object->curl_exec('),
@@ -57,6 +60,7 @@ public function codeSnippetProvider()
             array('$object->curl_multi_remove_handle(', '$object->curl_multi_remove_handle('),
             array('$object->curl_multi_exec(', '$object->curl_multi_exec('),
             array('$object->curl_multi_info_read(', '$object->curl_multi_info_read('),
+            array('$object->curl_reset(', '$object->curl_reset('),
 
             array('function send_http_asynchronous_curl_exec(', 'function send_http_asynchronous_curl_exec(')
         );

tests/VCR/LibraryHooks/CurlHookTest.php

@@ -303,6 +303,31 @@ function () use ($testClass) {
         curl_multi_close($curlMultiHandle);
     }
 
+    /**
+     * @requires PHP 5.5.0
+     */
+    public function testShouldResetRequest()
+    {
+        $testClass = $this;
+        $this->curlHook->enable(
+            function (Request $request) use ($testClass) {
+                $testClass->assertEquals(
+                    'GET',
+                    $request->getMethod(),
+                    ''
+                );
+                return new Response(200);
+            }
+        );
+
+        $curlHandle = curl_init("http://example.com");
+        curl_setopt($curlHandle, CURLOPT_CUSTOMREQUEST, "DELETE");
+        curl_reset($curlHandle);
+        curl_exec($curlHandle);
+
+        $this->curlHook->disable();
+    }
+
     /**
      * @return \callable
      */