Fixes #1: Added a more extensible connectivity layer to the Blizzard API that uses cURL to analyse requests - thus removing the file_get_contents_dependency - and integrated support for Authorization tokens.

Author: petrepatrasc

Service/ApiService.php

@@ -28,6 +28,11 @@ class ApiService
      */
     protected $callService = null;
 
+    /**
+     * @var string
+     */
+    protected $authorizationToken = null;
+
     /**
      * @param CallService $callService The service that makes the actual API calls. As long as the API stays read-only, it will strictly be used as an extra dependency in order to mock the call to the WS.
      */
@@ -219,4 +224,23 @@ protected function getNormalisedPlayerProfileArray($apiData = array())
         $apiData['career'] = array_merge($normalisedArray['career'], $apiData['career']);
         return $apiData;
     }
+
+    /**
+     * @param string $authorizationToken
+     * @return $this
+     */
+    public function setAuthorizationToken($authorizationToken)
+    {
+        $this->authorizationToken = $authorizationToken;
+        $this->callService->getConnectivityLayer()->getBlizzardApi()->setAuthorizationToken($authorizationToken);
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAuthorizationToken()
+    {
+        return $this->authorizationToken;
+    }
 }

Service/CallService.php

@@ -2,13 +2,25 @@
 
 namespace petrepatrasc\BlizzardApiBundle\Service;
 use petrepatrasc\BlizzardApiBundle\Entity\Exception\BlizzardApiException;
+use petrepatrasc\StarcraftConnectionLayerBundle\Service\ConnectionService;
 
 /**
  * Handles calling the Battle.NET service. Added for extensibility at the moment.
  * @package petrepatrasc\BlizzardApiBundle\Service
  */
 class CallService
 {
+    /**
+     * @var ConnectionService
+     */
+    protected $connectivityLayer;
+
+    /**
+     * Class constructor.
+     */
+    public function __construct() {
+        $this->connectivityLayer = new ConnectionService();
+    }
 
     /**
      * Make a call to the Battle.NET Api Service.
@@ -29,12 +41,30 @@ public function makeCallToApiService($region, $apiMethod, $params = array(), $tr
             $battleNetUrl .= '/';
         }
 
-        $result = @file_get_contents($battleNetUrl);
+        $result = $this->getConnectivityLayer()->getBlizzardApi()->retrieveData($battleNetUrl);
 
-        if ($result === FALSE) {
-            throw new BlizzardApiException("Failed to open stream: HTTP request failed! HTTP/1.1 404 Not Found", 404);
+        if ($result === null) {
+            throw new BlizzardApiException("No data was returned from the server", 500);
         } else {
             return $result;
         }
     }
+
+    /**
+     * @param \petrepatrasc\StarcraftConnectionLayerBundle\Service\ConnectionService $connectivityLayer
+     * @return $this
+     */
+    public function setConnectivityLayer($connectivityLayer)
+    {
+        $this->connectivityLayer = $connectivityLayer;
+        return $this;
+    }
+
+    /**
+     * @return \petrepatrasc\StarcraftConnectionLayerBundle\Service\ConnectionService
+     */
+    public function getConnectivityLayer()
+    {
+        return $this->connectivityLayer;
+    }
 }

Tests/Integration/ApiServiceTest.php

@@ -29,6 +29,15 @@ public function testGetProfileSanityCheckThatApiIsActuallyResponding()
         $this->assertEquals("/profile/2048419/1/LionHeart/", $profile->getBasicInformation()->getProfilePath());
     }
 
+    /**
+     * @expectedException \petrepatrasc\BlizzardApiBundle\Entity\Exception\BlizzardApiException
+     * @expectedExceptionMessage Invalid Application
+     */
+    public function testThatAnInvalidApplicationKeyWillNotWork() {
+        $this->apiService->setAuthorizationToken("BNET c1fbf21b79c03191d:+3fE0RaKc+PqxN0gi8va5GQC35A=");
+        $this->apiService->getPlayerProfile(\petrepatrasc\BlizzardApiBundle\Entity\Region::Europe, 2048419, 'LionHeart');
+    }
+
     public function testGetPlayerLatestMatches()
     {
         $matches = $this->apiService->getPlayerLatestMatches(Entity\Region::Europe, 2048419, 'LionHeart');
@@ -40,6 +49,7 @@ public function testGetPlayerLatestMatches()
          * @var $match Entity\Match
          * @var $latestMatch Entity\Match
          */
+        $this->assertInternalType('array', $matches);
         foreach ($matches as $match) {
             $this->assertInstanceOf('\petrepatrasc\BlizzardApiBundle\Entity\Match', $match);
             $this->assertInternalType('string', $match->getMap());

Tests/Unit/Service/ApiServiceTest.php

@@ -23,7 +23,7 @@ public function setUp()
     {
         parent::setUp();
 
-        $this->callServiceMock = $this->getMock('CallService', array('makeCallToApiService'));
+        $this->callServiceMock = $this->getMock('CallService', array('makeCallToApiService', 'getConnectivityLayer'));
 
         $this->apiService = new ApiService($this->callServiceMock);
     }
@@ -298,6 +298,7 @@ public function testGetPlayerLatestMatches()
          * @var $match Entity\Match
          * @var $latestMatch Entity\Match
          */
+        $this->assertInternalType('array', $matches);
         foreach ($matches as $match) {
             $this->assertInstanceOf('\petrepatrasc\BlizzardApiBundle\Entity\Match', $match);
             $this->assertInternalType('string', $match->getMap());
@@ -653,4 +654,18 @@ public function testMakeCallWhenExceptionIsHit() {
         $this->callServiceMock->expects($this->atLeastOnce())->method('makeCallToApiService')->withAnyParameters()->will($this->returnValue(file_get_contents(self::MOCK_PATH . 'resource-not-found.json')));
         $callResponse = $this->apiService->makeCall(Entity\Region::Europe, ApiService::API_REWARDS_METHOD, array(), false);
     }
+
+    public function testThatSettingAnAuthorizationKeyIsPropagatedToAllLayers() {
+        $blizzardServiceMock = $this->getMock('\petrepatrasc\StarcraftConnectionLayer\Service\BlizzardApi', array('setAuthorizationToken'));
+        $blizzardServiceMock->expects($this->atLeastOnce())->method('setAuthorizationToken')->withAnyParameters()->will($this->returnValue($blizzardServiceMock));
+
+        $connectivityLayerMock = $this->getMock('\petrepatrasc\StarcraftConnectionLayer\Service\ConnectionService', array('getBlizzardApi'));
+        $connectivityLayerMock->expects($this->atLeastOnce())->method('getBlizzardApi')->withAnyParameters()->will($this->returnValue($blizzardServiceMock));
+
+        $this->callServiceMock->expects($this->atLeastOnce())->method('getConnectivityLayer')->withAnyParameters()->will($this->returnValue($connectivityLayerMock));
+        $sampleAuthorizationToken = "TEST";
+
+        $this->apiService->setAuthorizationToken($sampleAuthorizationToken);
+        $this->assertEquals($sampleAuthorizationToken, $this->apiService->getAuthorizationToken());
+    }
 }

Tests/Unit/Service/CallServiceTest.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace petrepatrasc\BlizzardApiBundle\Tests\Unit\Service;
+
+
+use petrepatrasc\BlizzardApiBundle\Entity;
+use petrepatrasc\BlizzardApiBundle\Service\ApiService;
+use petrepatrasc\BlizzardApiBundle\Service\CallService;
+use petrepatrasc\StarcraftConnectionLayerBundle\Service\ConnectionService;
+
+class CallServiceTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var CallService
+     */
+    protected $callService;
+
+    public function setUp() {
+        parent::setUp();
+
+        $this->callService = new CallService();
+    }
+
+    public function testDependencyInjection() {
+        $connectivityLayer = new ConnectionService();
+
+        $this->callService = new CallService();
+        $this->callService->setConnectivityLayer($connectivityLayer);
+
+        $this->assertEquals($connectivityLayer, $this->callService->getConnectivityLayer());
+    }
+
+    /**
+     * @expectedException \petrepatrasc\BlizzardApiBundle\Entity\Exception\BlizzardApiException
+     * @expectedExceptionCode 500
+     * @expectedExceptionMessage No data was returned from the server
+     */
+    public function testNullResponseRaisesExceptions() {
+        $blizzardServiceMock = $this->getMock('\petrepatrasc\StarcraftConnectionLayer\Service\BlizzardApi', array('retrieveData'));
+        $blizzardServiceMock->expects($this->atLeastOnce())->method('retrieveData')->withAnyParameters()->will($this->returnValue(null));
+
+        $connectivityLayerMock = $this->getMock('\petrepatrasc\StarcraftConnectionLayer\Service\ConnectionService', array('getBlizzardApi'));
+        $connectivityLayerMock->expects($this->atLeastOnce())->method('getBlizzardApi')->withAnyParameters()->will($this->returnValue($blizzardServiceMock));
+
+        $this->callService->setConnectivityLayer($connectivityLayerMock);
+
+        $this->callService->makeCallToApiService(Entity\Region::Europe, ApiService::API_REWARDS_METHOD, array(), false);
+    }
+}

composer.json

@@ -16,7 +16,8 @@
         "php": ">=5.3.2",
         "ext-curl": "*",
         "symfony/framework-bundle": ">=2.1",
-        "symfony/security-bundle": ">=2.1"
+        "symfony/security-bundle": ">=2.1",
+        "petrepatrasc/starcraft-connection-layer": ">=1.0.0"
     },
     "require-dev": {
         "twig/twig": "*",