Merge branch 'RCB-412' of github.com:samhausmann/php

Author: Chris Park

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": {

docker/run_php.sh

@@ -120,7 +120,7 @@ fi
 
 
 #Run unit tests
-cd /php-dev && ./bin/phpspec run
+cd /php-dev && ./bin/phpspec run --config=phpspec.yml --bootstrap=./vendor/autoload.php --no-interaction --format=pretty
 
 #Run php-cs-fixer
 ./bin/php-cs-fixer fix . --dry-run --diff --level=psr2

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

@@ -18,6 +18,8 @@
 $params = new DocumentParameters();
 $content = $language_data;
 $params->set('content', $content);
+$customHeader = "X-RosetteAPI-App: php-app";
+$api->setCustomHeaders($customHeader);
 
 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",
@@ -301,6 +309,65 @@ public function clearOptions()
         $this->options = array();
     }
 
+        /**
+     * Setter for options
+     *
+     *
+     * @return array
+     */
+    public function getCustomHeaders()
+    {
+        return $this->customHeaders;
+    }
+
+    /**
+     * Setter for custom headers
+     *
+     * @param array $headers
+     *
+     */
+    public function setCustomHeaders($header)
+    {
+        $this->clearCustomHeaders();
+        if($header != null){
+            if(preg_match("/^X-RosetteAPI-/", $header)){
+                array_push($this->customHeaders, $header);
+            } 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,6 +398,8 @@ private function callEndpoint($parameters, $subUrl)
         $this->subUrl = $subUrl;
         $resultObject = '';
 
+        $this->headers = $this->addHeaders($this->headers);
+
         if (strlen($parameters->getMultiPartContent()) > 0) {
             $content = $parameters->getMultiPartContent();
             $filename = $parameters->fileName;
@@ -357,6 +426,7 @@ private function callEndpoint($parameters, $subUrl)
 
             $resultObject = $this->postHttp($url, $this->headers, $multi);
         } else {
+
             $url = $this->service_url . $this->subUrl;
             $resultObject = $this->postHttp($url, $this->headers, $parameters->serialize($this->options));
         }

spec/rosette/api/ApiSpec.php

@@ -272,4 +272,17 @@ public function it_fails_with_non_200_response($params, $request)
         $this->setMockRequest($request);
         $this->shouldThrow('rosette\api\RosetteException')->duringRelationships($params);
     }
+
+    public function it_fails_with_incorrectly_formatted_custom_header($params, $request)
+    {
+        $this->shouldThrow('rosette\api\RosetteException')->duringSetCustomHeaders("test");
+    }
+
+    public function it_sets_gets_clears_customHeaders()
+    {
+        $this->setCustomHeaders('X-RosetteAPI-test');
+        $this->getCustomHeaders()->shouldBe(array('X-RosetteAPI-test'));
+        $this->clearCustomHeaders();
+        $this->getCustomHeaders()->shouldBe(array());
+    }
 }