Merge pull request #19 from duronrulez/feature/oauth2

Add basic oAuth2 support

Author: LogansUA

.gitignore

@@ -1 +1,2 @@
 /vendor/
+.idea/

src/BlizzardClient.php

@@ -2,6 +2,7 @@
 
 namespace BlizzardApi;
 
+use GuzzleHttp\Client;
 use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
@@ -13,21 +14,27 @@
 class BlizzardClient
 {
     const API_URL_PATTERN = 'https://region.api.battle.net';
+    const API_ACCESS_TOKEN_URL_PATTERN = 'https://region.battle.net/oauth/token';
 
     /**
      * @var string $apiUrl Blizzard API url
      */
     private $apiUrl;
 
+    /**
+     * @var string $apiAccessTokenUrl Blizzard API Access Token url
+     */
+    private $apiAccessTokenUrl;
+
     /**
      * @var string $apiKey API key
      */
     private $apiKey;
 
     /**
-     * @var string $accessToken Access token
+     * @var \BlizzardApi\Tokens\Access[] $accessTokens Access tokens
      */
-    private $accessToken;
+    private $accessTokens;
 
     /**
      * @var string $locale Locale
@@ -43,17 +50,17 @@ class BlizzardClient
      * BlizzardClient constructor
      *
      * @param string      $apiKey      API key
+     * @param string      $apiSecret   API Secret key
      * @param string      $region      Region
      * @param string      $locale      Locale
-     * @param null|string $accessToken OAuth access token
      */
-    public function __construct($apiKey, $region = 'us', $locale = 'en_us', $accessToken = null)
+    public function __construct($apiKey, $apiSecret, $region = 'us', $locale = 'en_us')
     {
         $options = [
             'apiKey'      => $apiKey,
+            'apiSecret'   => $apiSecret,
             'region'      => strtolower($region),
-            'locale'      => strtolower($locale),
-            'accessToken' => $accessToken,
+            'locale'      => strtolower($locale)
         ];
 
         $resolver = (new OptionsResolver());
@@ -62,11 +69,12 @@ public function __construct($apiKey, $region = 'us', $locale = 'en_us', $accessT
         $options = $resolver->resolve($options);
 
         $this->apiKey      = $options['apiKey'];
+        $this->apiSecret   = $options['apiSecret'];
         $this->region      = $options['region'];
         $this->locale      = $options['locale'];
-        $this->accessToken = $options['accessToken'];
 
         $this->updateApiUrl($options['region']);
+        $this->updateApiAccessTokenUrl($options['region']);
     }
 
     /**
@@ -79,6 +87,16 @@ public function getApiUrl()
         return $this->apiUrl;
     }
 
+    /**
+     * Get api Access Token url
+     *
+     * @return string Api Access Token url
+     */
+    public function getApiAccessTokenUrl()
+    {
+        return $this->apiAccessTokenUrl;
+    }
+
     /**
      * Get api key
      *
@@ -103,6 +121,30 @@ public function setApiKey($apiKey)
         return $this;
     }
 
+    /**
+     * Get api secret
+     *
+     * @return string Api secret
+     */
+    public function getApiSecret()
+    {
+        return $this->apiSecret;
+    }
+
+    /**
+     * Set api secret
+     *
+     * @param string $apiSecret Api secret
+     *
+     * @return $this
+     */
+    public function setApiSecret($apiSecret)
+    {
+        $this->apiSecret = $apiSecret;
+
+        return $this;
+    }
+
     /**
      * Get region
      *
@@ -125,6 +167,7 @@ public function setRegion($region)
         $this->region = strtolower($region);
 
         $this->updateApiUrl($region);
+        $this->updateApiAccessTokenUrl($region);
 
         return $this;
     }
@@ -160,19 +203,27 @@ public function setLocale($locale)
      */
     public function getAccessToken()
     {
-        return $this->accessToken;
+        if ($this->accessTokens == null) {
+            $this->accessTokens = [];
+        }
+
+        if (!array_key_exists($this->getRegion(), $this->accessTokens)) {
+            $this->accessTokens[$this->getRegion()] = $this->requestAccessToken();
+        }
+
+        return $this->accessTokens[$this->getRegion()]->getToken();
     }
 
     /**
      * Set access token
      *
-     * @param null|string $accessToken Access token
+     * @param null|Tokens\Access $accessToken Access token
      *
      * @return $this
      */
-    public function setAccessToken($accessToken)
+    public function setAccessToken(Tokens\Access $accessToken)
     {
-        $this->accessToken = $accessToken;
+        $this->accessTokens[$this->getRegion()] = $accessToken;
 
         return $this;
     }
@@ -191,6 +242,20 @@ private function updateApiUrl($region)
         $this->apiUrl = str_replace('region', strtolower($region), self::API_URL_PATTERN);
     }
 
+    /**
+     * Update API Access Token url
+     *
+     * Update API Access Token url by replacing region in API url pattern
+     *
+     * @param string $region Region
+     *
+     * @return $this
+     */
+    private function updateApiAccessTokenUrl($region)
+    {
+        $this->apiAccessTokenUrl = str_replace('region', strtolower($region), self::API_ACCESS_TOKEN_URL_PATTERN);
+    }
+
     /**
      * Configure options
      *
@@ -213,12 +278,39 @@ private function configureOptions(OptionsResolver $resolver, $region)
             );
         }
 
-        $resolver->setRequired(['apiKey', 'region', 'locale', 'accessToken'])
+        $resolver->setRequired(['apiKey', 'apiSecret', 'region', 'locale'])
                  ->setAllowedTypes('apiKey', 'string')
+                 ->setAllowedTypes('apiSecret', 'string')
                  ->setAllowedTypes('region', 'string')
                  ->setAllowedValues('region', array_keys(GeoData::$list))
                  ->setAllowedTypes('locale', 'string')
-                 ->setAllowedValues('locale', $locales)
-                 ->setAllowedTypes('accessToken', ['null', 'string']);
+                 ->setAllowedValues('locale', $locales);
     }
+
+    /**
+     * Request an Access Token from Blizzard
+     * @return Tokens\Access
+     * @throws \HttpResponseException
+     */
+    protected function requestAccessToken()
+    {
+        $client = new Client();
+
+        $options = [
+            'form_params' => [
+                'grant_type' => 'client_credentials',
+                'client_id' => $this->getApiKey(),
+                'client_secret' => $this->getApiSecret(),
+            ]
+        ];
+
+        $result = $client->post($this->getApiAccessTokenUrl(), $options);
+
+        if ($result->getStatusCode() == 200) {
+            return Tokens\Access::fromJson(json_decode($result->getBody()->getContents()));
+        } else {
+            throw new \HttpResponseException("Invalid Response");
+        }
+    }
+
 }

src/Service/Service.php

@@ -52,7 +52,7 @@ protected function request($urlSuffix, array $options)
         $options = $this->generateQueryOptions($options);
 
         $result = $client->get($this->serviceParam.$urlSuffix, $options);
-
+        
         return $result;
     }
 

src/Tokens/Access.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace BlizzardApi\Tokens;
+
+use BlizzardApi\BlizzardClient;
+use BlizzardApi\Tokens\Exceptions\Expired;
+use GuzzleHttp\Client;
+use GuzzleHttp\Psr7\Response;
+
+/**
+ * Class Access Token
+ *
+ * @author Hristo Mitev <duronrulez@gmail.com>
+ */
+class Access
+{
+    /**
+     * @var string $token The access token itself
+     */
+    protected $token;
+
+    /**
+     * @var string $tokenType The type of the token
+     */
+    protected $tokenType;
+
+    /**
+     * @var int $expiresIn The time for the token to expire in seconds
+     */
+    protected $expiresIn;
+
+    /**
+     * @var \DateTime $createdAt when was the token created
+     */
+    protected $createdAt;
+
+    /**
+     * @var \DateTime $expiresAt when is the token expiring
+     */
+    protected $expiresAt;
+
+    /**
+     * Access constructor.
+     * @param string $accessToken
+     * @param string $tokenType
+     * @param int $expiresIn
+     */
+    public function __construct($accessToken, $tokenType, $expiresIn)
+    {
+        $this->token = $accessToken;
+        $this->tokenType = $tokenType;
+        $this->expiresIn = $expiresIn;
+        $this->createdAt = new \DateTime();
+        $this->expiresAt = new \DateTime();;
+        $this->expiresAt->add(new \DateInterval('PT'.$this->expiresIn.'S'));
+    }
+
+    /**
+     * Create token from json object
+     * @param \stdClass $jsonObject
+     * @return \BlizzardApi\Tokens\Access
+     */
+    public static function fromJson($jsonObject)
+    {
+        return new self($jsonObject->access_token, $jsonObject->token_type, $jsonObject->expires_in);
+    }
+
+    /**
+     * Check if the token is expired
+     *
+     * @return bool
+     */
+    public function isExpired()
+    {
+        if ($this->expiresAt > new \DateTime()){
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Get the token string
+     *
+     * @return string
+     * @throws Expired
+     */
+    public function getToken()
+    {
+        if ($this->isExpired()) {
+            throw new Expired("Token has expired");
+        }
+
+        return $this->token;
+    }
+}

src/Tokens/Exceptions/Expired.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace BlizzardApi\Tokens\Exceptions;
+
+
+class Expired extends \Exception {
+
+}