ws-3314: update headers and user agent

Author: Adam Soos

source/rosette/api/Api.php

@@ -144,6 +144,9 @@ public function __construct($user_key, $service_url = 'https://analytics.babelst
             'Content-Type' => 'application/json',
             'Accept-Encoding' => 'gzip',
             'User-Agent' => $this->getUserAgent(),
+            'X-BabelStreetAPI-Binding' => 'php',
+            'X-BabelStreetAPI-Binding-Version' => $this->getBindingVersion(),
+            // TODO remove this in future release
             'X-RosetteApi-Binding' => 'php',
             'X-RosetteAPI-Binding-Version' => $this->getBindingVersion());
 
@@ -170,7 +173,7 @@ public function getBindingVersion()
      */
     public function getUserAgent()
     {
-        return 'RosetteAPIPHP/' . $this->getBindingVersion() . '/' . phpversion();
+        return 'Babel-Street-Analytics-API-PHP/' . $this->getBindingVersion() . '/' . phpversion();
     }
 
     /**
@@ -379,10 +382,12 @@ public function getCustomHeaders()
      */
     public function setCustomHeader($header, $value = null)
     {
-        $headerPrefix = 'x-rosetteapi-';
-        if (strlen($header) < strlen($headerPrefix) ||
-            strcasecmp(substr($header, 0, strlen($headerPrefix)), $headerPrefix) != 0) {
-            throw new RosetteException("Custom headers must start with \"$headerPrefix\"");
+        $legacyHeaderPrefix = 'x-rosetteapi-';
+        $headerPrefix = 'x-babelstreetapi-';
+        if (strlen($header) < strlen($legacyHeaderPrefix) ||
+            (strcasecmp(substr($header, 0, strlen($headerPrefix)), $headerPrefix) != 0 &&
+            strcasecmp(substr($header, 0, strlen($legacyHeaderPrefix)), $legacyHeaderPrefix) != 0)) {
+            throw new RosetteException("Custom headers must start with \"$headerPrefix\" or \"$legacyHeaderPrefix\"");
         }
         if (is_null($value) && array_key_exists($header, $this->customHeaders)) {
             unsset($this->customHeaders, $header);

spec/rosette/api/ApiSpec.php

@@ -34,7 +34,7 @@ public function it_sets_gets_response_code()
     public function it_constructs_user_agent()
     {
         $version = $this->getWrappedObject()->getBindingVersion();
-        $uaString = 'RosetteAPIPHP/' . $version . '/' . phpversion();
+        $uaString = 'Babel-Street-Analytics-API-PHP/' . $version . '/' . phpversion();
         $this->getUserAgent()->shouldBe($uaString);
     }
     public function it_sets_gets_clears_url_params()
@@ -333,13 +333,20 @@ public function it_fails_with_incorrectly_formatted_custom_header($params, $requ
     {
         $this->shouldThrow(RosetteConstants::$RosetteExceptionFullClassName)->duringSetCustomHeader("test");
     }
-    public function it_sets_gets_clears_customHeaders()
+    public function it_sets_gets_clears_customHeaders_rosette()
     {
         $this->setCustomHeader('X-RosetteAPI-test', 'true');
         $this->getCustomHeaders()->shouldBe(array('X-RosetteAPI-test' => 'true'));
         $this->clearCustomHeaders();
         $this->getCustomHeaders()->shouldBe(array());
     }
+    public function it_sets_gets_clears_customHeaders_babelstreet()
+    {
+        $this->setCustomHeader('X-BabelStreetAPI-test', 'true');
+        $this->getCustomHeaders()->shouldBe(array('X-BabelStreetAPI-test' => 'true'));
+        $this->clearCustomHeaders();
+        $this->getCustomHeaders()->shouldBe(array());
+    }
     public function it_fails_with_409_response($params, $request)
     {
         $params->beADoubleOf(ApiSpec::$DocumentParametersFullClassName);