First pass at stream tidy ups

Adding options for request timeout
Adding a null cache class
Tests still required

Author: Ian Barber

src/Google/Cache/Null.php

@@ -0,0 +1,51 @@
+<?php
+/*
+ * Copyright 2014 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+ 
+require_once "Google/Cache/Abstract.php";
+require_once "Google/Cache/Exception.php";
+
+/**
+ * A blank storage class, for cases where caching is not
+ * required.
+ */
+class Google_Cache_Null extends Google_Cache_Abstract
+{
+   /**
+   * @inheritDoc
+   */
+  public function get($key, $expiration = false)
+  {
+    return false;
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public function set($key, $value)
+  {
+    // Nop.
+  }
+
+  /**
+   * @inheritDoc
+   * @param String $key
+   */
+  public function delete($key)
+  {
+    // Nop.
+  }
+}

src/Google/Config.php

@@ -51,8 +51,9 @@ public function __construct($ini_file_location = null)
 
       // Definition of class specific values, like file paths and so on.
       'classes' => array(
-        // If you want to pass in OAuth 2.0 settings, they will need to be
-        // structured like this.
+        'Google_IO_Abstract' => array(
+          'request_timeout_seconds' => 100,
+        ),
         'Google_Http_Request' => array(
           // Disable the use of gzip on calls if set to true. Defaults to false.
           'disable_gzip' => self::GZIP_ENABLED,
@@ -63,6 +64,8 @@ public function __construct($ini_file_location = null)
           // a production environment.
           'enable_gzip_for_uploads' => self::GZIP_UPLOADS_DISABLED,
         ),
+        // If you want to pass in OAuth 2.0 settings, they will need to be
+        // structured like this.
         'Google_Auth_OAuth2' => array(
           // Keys for OAuth 2.0 access, see the API console at
           // https://developers.google.com/console

src/Google/IO/Abstract.php

@@ -37,6 +37,10 @@ abstract class Google_IO_Abstract
   public function __construct(Google_Client $client)
   {
     $this->client = $client;
+    $timeout = $client->getClassConfig('Google_IO_Abstract', 'request_timeout_seconds');
+    if ($timeout > 0) {
+      $this->setTimeout($timeout);
+    }
   }
 
   /**
@@ -51,6 +55,12 @@ abstract public function executeRequest(Google_Http_Request $request);
    * @param $options
    */
   abstract public function setOptions($options);
+  
+  /**
+   * Set the maximum request time in seconds.
+   * @param $timeout in seconds
+   */
+  abstract public function setTimeout($timeout);
 
   /**
    * @visible for testing.

src/Google/IO/Curl.php

@@ -37,11 +37,11 @@ class Google_IO_Curl extends Google_IO_Abstract
   public function executeRequest(Google_Http_Request $request)
   {
     $curl = curl_init();
-    
+
     if ($request->getPostBody()) {
       curl_setopt($curl, CURLOPT_POSTFIELDS, $request->getPostBody());
     }
-    
+
     $requestHeaders = $request->getRequestHeaders();
     if ($requestHeaders && is_array($requestHeaders)) {
       $curlHeaders = array();
@@ -60,11 +60,11 @@ public function executeRequest(Google_Http_Request $request)
     curl_setopt($curl, CURLOPT_HEADER, true);
 
     curl_setopt($curl, CURLOPT_URL, $request->getUrl());
-    
+
     if ($request->canGzip()) {
       curl_setopt($curl, CURLOPT_ENCODING, 'gzip,deflate');
     }
-    
+
     foreach ($this->options as $key => $var) {
       curl_setopt($curl, $key, $var);
     }
@@ -90,6 +90,15 @@ public function executeRequest(Google_Http_Request $request)
    */
   public function setOptions($options)
   {
-    $this->options = $options;
+    $this->options = array_merge($this->options, $options);
+  }
+
+  /**
+   * Set the maximum request time in seconds.
+   * @param $timeout in seconds
+   */
+  public function setTimeout($timeout)
+  {
+    $this->options[CURLOPT_TIMEOUT] = $timeout;
   }
 }

src/Google/IO/Stream.php

@@ -25,7 +25,9 @@
 
 class Google_IO_Stream extends Google_IO_Abstract
 {
+  const TIMEOUT = "timeout";
   const ZLIB = "compress.zlib://";
+  private $options = array();
 
   private static $DEFAULT_HTTP_CONTEXT = array(
     "follow_location" => 0,
@@ -119,7 +121,7 @@ public function executeRequest(Google_Http_Request $request)
     }
 
     $responseHeaders = $this->getHttpResponseHeaders($http_response_header);
-    
+
     return array($response_data, $responseHeaders, $respHttpCode);
   }
 
@@ -129,9 +131,18 @@ public function executeRequest(Google_Http_Request $request)
    */
   public function setOptions($options)
   {
-    // NO-OP
+    $this->options = array_merge($this->options, $options);
   }
-  
+
+  /**
+   * Set the maximum request time in seconds.
+   * @param $timeout in seconds
+   */
+  public function setTimeout($timeout)
+  {
+    $this->options[self::TIMEOUT] = $timeout;
+  }
+
   protected function getHttpResponseCode($response_headers)
   {
     $header_count = count($response_headers);