getters/setters for custom headers and regex check

Author: SamHausmann

composer.json

@@ -16,8 +16,7 @@
     }
   ],
   "require-dev": {
-    "fabpot/php-cs-fixer": ">=1.9",
-    "phpdocumentor/phpdocumentor": "~2.8",
+    "friendsofphp/php-cs-fixer": ">=1.9",
     "phpspec/phpspec": "~2.5"
   },
   "config": {

examples/docker/Dockerfile

@@ -15,6 +15,6 @@ WORKDIR /php/examples
 RUN curl -sS https://getcomposer.org/installer | php && mv composer.phar /usr/local/bin/composer && composer require "rosette/api: ~1.0.0"
 
 # allow interactive bash inside docker container
-CMD ./run_php.sh $API_KEY $ALT_URL; /bin/bash
+CMD ./run_php.sh $API_KEY $ALT_URL
 
 VOLUME ["/source"]

examples/language.php

@@ -17,12 +17,12 @@
 $api = isset($options['url']) ? new Api($options['key'], $options['url']) : new Api($options['key']);
 $params = new DocumentParameters();
 $content = $language_data;
+$params->set('content', $content);
 $appHeader = [];
 $appHeader = "X-RosetteAPI-App: php-app";
 $customHeaders = [];
 $customHeaders[0] = $appHeader;
-$params->set('content', $content);
-$params->loadCustomHeaders($customHeaders);
+$api->setCustomHeaders($customHeaders);
 
 try {
     $result = $api->language($params);

source/rosette/api/Api.php

@@ -109,6 +109,12 @@ class Api
      */
     private $options;
 
+    /**
+     * internal customHeaders array
+     * @var array
+     */
+    private $customHeaders;
+
 
     /**
      * Create an L{API} object.
@@ -121,6 +127,8 @@ public function __construct($user_key, $service_url  = 'https://api.rosette.com/
     {
         $this->user_key = $user_key;
 
+
+
         $this->headers = array("X-RosetteAPI-Key: $user_key",
                           "Content-Type: application/json",
                           "Accept: application/json",
@@ -129,6 +137,14 @@ public function __construct($user_key, $service_url  = 'https://api.rosette.com/
                           "X-RosetteAPI-Binding: php",
                           "X-RosetteAPI-Binding-Version: " . self::$binding_version );
 
+        /*$this->headers = $this->addHeaders(array("X-RosetteAPI-Key: $user_key",
+                          "Content-Type: application/json",
+                          "Accept: application/json",
+                          "Accept-Encoding: gzip",
+                          "User-Agent: RosetteAPIPHP/" . self::$binding_version,
+                          "X-RosetteAPI-Binding: php",
+                          "X-RosetteAPI-Binding-Version: " . self::$binding_version ));*/
+
         $this->setServiceUrl($service_url);
         $this->setDebug(false);
         $this->setTimeout(300);
@@ -301,6 +317,72 @@ public function clearOptions()
         $this->options = array();
     }
 
+        /**
+     * Setter for options
+     *
+     *
+     * @return array
+     */
+    public function getCustomHeaders()
+    {
+        /*if (sizeof($this->customHeaders) > 0) {
+            return $this->customHeaders;
+        } else {
+            return null;
+        }*/
+        return $this->customHeaders;
+    }
+
+    /**
+     * Setter for custom headers
+     *
+     * @param array $headers
+     *
+     */
+    public function setCustomHeaders($headers)
+    {
+        $this->clearCustomHeaders();
+        if($headers != null){
+            foreach ($headers as $key => $value) {
+                if(preg_match("/^X-RosetteAPI-/", $value)){
+                    array_push($this->customHeaders, $value);
+                } else {
+                    throw new RosetteException("Custom headers must start with \"X-\"");
+                }
+            }
+        }
+    }
+
+    /**
+    * Adds custom headers to headers array if there are any
+    *
+    * @param array $headers
+    *
+    * @return array $headers
+    **/
+    private function addHeaders($headers)
+    {
+       $customHeaders = $this->getCustomHeaders();
+
+       if(sizeof($customHeaders) > 0){
+            foreach($customHeaders as $value)
+            {
+                array_push($headers, $value);
+            }
+            return $headers;
+       } else {
+        return $headers;
+       }
+    }
+
+    /**
+     * Clears all custom headers
+     */
+    public function clearCustomHeaders()
+    {
+        $this->customHeaders = array();
+    }
+
 
     /**
      * Replaces a header item with a new one
@@ -331,16 +413,7 @@ private function callEndpoint($parameters, $subUrl)
         $this->subUrl = $subUrl;
         $resultObject = '';
 
-        // if custom headers exist, add them
-        if($parameters->customHeaders != null){
-            foreach ($parameters->customHeaders as $key => $value) {
-                if(strpos($value, "X") === 0 && strpos($value, "-") === 1){
-                    array_push($this->headers, $value);
-                } else {
-                    throw new RosetteException("Custom headers must start with \"X-\"");
-                }
-            }
-        }
+        $this->headers = $this->addHeaders($this->headers);
 
         if (strlen($parameters->getMultiPartContent()) > 0) {
             $content = $parameters->getMultiPartContent();

source/rosette/api/DocumentParameters.php

@@ -53,11 +53,6 @@ class DocumentParameters extends RosetteParamsSetBase
      */
     public $genre;
 
-    /**
-     * @var array customHeaders to allow user to provide custom headers for an API request
-     */
-    public $customHeaders;
-
     /**
      * Constructor.
      *
@@ -160,19 +155,4 @@ public function loadDocumentString($stringData, $multiPart = false)
             $this->multiPartContent = '';
         }
     }
-
-    /**
-     * Loads a custom header into the object.
-     *
-     *
-     * @param $customHeaders : Array of custom headers to be passed during the request
-     * 
-     *
-     * @throws RosetteException
-     */
-
-    public function loadCustomHeaders($headers)
-    {
-        $this->customHeaders = $headers;
-    }
 }

source/rosette/api/NameSimilarityParameters.php

@@ -34,10 +34,6 @@ class NameSimilarityParameters extends RosetteParamsSetBase
      * @var string genre to categorize the input data
      */
     public $genre;
-    /**
-     * @var array customHeaders to allow user to provide custom headers for an API request
-     */
-    public $customHeaders;
     /**
      * constructor.
      *
@@ -71,19 +67,4 @@ public function validate()
             );
         }
     }
-
-    /**
-     * Loads a custom header into the object.
-     *
-     *
-     * @param $customHeaders : Array of custom headers to be passed during the request
-     * 
-     *
-     * @throws RosetteException
-     */
-
-    public function loadCustomHeaders($headers)
-    {
-        $this->customHeaders = $headers;
-    }
 }

source/rosette/api/NameTranslationParameters.php

@@ -58,10 +58,6 @@ class NameTranslationParameters extends RosetteParamsSetBase
      * @var string genre to categorize the input data
      */
     public $genre;
-    /**
-     * @var array customHeaders to allow user to provide custom headers for an API request
-     */
-    public $customHeaders;
     /**
      * constructor.
      */
@@ -89,19 +85,4 @@ public function validate()
             );
         }
     }
-
-    /**
-     * Loads a custom header into the object.
-     *
-     *
-     * @param $customHeaders : Array of custom headers to be passed during the request
-     * 
-     *
-     * @throws RosetteException
-     */
-
-    public function loadCustomHeaders($headers)
-    {
-        $this->customHeaders = $headers;
-    }
 }

spec/rosette/api/ApiSpec.php

@@ -275,15 +275,14 @@ public function it_fails_with_non_200_response($params, $request)
 
     public function it_fails_with_incorrectly_formatted_custom_header($params, $request)
     {
-        $params->beADoubleOf('\rosette\api\DocumentParameters');
-        $params->contentUri = 'http://some.dummysite.com';
-        $appHeader = [];
-        $appHeader = "RosetteAPI-App: php-app";
-        $customHeaders = [];
-        $customHeaders[0] = $appHeader;
-        $params->set('content', "some content");
-        $params->loadCustomHeaders($customHeaders);
-        $this->shouldThrow('rosette\api\RosetteException')->duringLanguage($params);
+        $this->shouldThrow('rosette\api\RosetteException')->duringSetCustomHeaders(array("test"));
+    }
 
+    public function it_sets_gets_clears_customHeaders()
+    {
+        $this->setCustomHeaders(array('X-RosetteAPI-test'));
+        $this->getCustomHeaders()->shouldBe(array('X-RosetteAPI-test'));
+        $this->clearCustomHeaders();
+        $this->getCustomHeaders()->shouldBe(array());
     }
 }