Added docs and code for BeeAuth

Author: luisdalmolin

README.md

@@ -73,6 +73,24 @@ file_put_contents('/path/to/storage/image.jpg', $image);
 Storage::put('/path/to/storage/image.jpg', $image);
 ```
 
+## Generating access token
+
+To initialize Bee Editor you may need an access token. You can use `BeeAuth` to easily generate that. You can grab the Client ID and Secret by logging in into the [Developer portal](https://developers.beefree.io) and going to the "details" of your application.
+
+```php
+use KirschbaumDevelopment\Bee\BeeAuth;
+
+$beeAuth = new BeeAuth(new \GuzzleHttp\Client);
+$beeAuth->setClientId('your-client-id-here');
+$beeAuth->setClientSecret('your-client-secret-here');
+$token = $beeAuth->generateToken();
+
+// then you can use the following methods:
+$token->getAccessToken();
+$token->getRefreshToken();
+$token->getExpires();
+```
+
 ### Testing
 
 ``` bash

src/BeeAuth.php

@@ -3,6 +3,7 @@
 namespace KirschbaumDevelopment\Bee;
 
 use GuzzleHttp\Client as GuzzleClient;
+use KirschbaumDevelopment\Bee\Resources\AuthorizationToken;
 
 class BeeAuth
 {
@@ -53,25 +54,12 @@ public function setClientSecret($clientSecret)
         return $this;
     }
 
-    /**
-     * Return the default headers.
-     *
-     * @param array $headers
-     * @return array
-     */
-    protected function formatHeaders($headers = [])
-    {
-        return array_merge([
-            'Authorization' => sprintf('Bearer %s', $this->getAuthorizationHeader()),
-        ], $headers);
-    }
-
     /**
      * Return the 'Authorization' header value.
      *
      * @return string
      */
-    protected function getAuthorizationHeader()
+    public function generateToken()
     {
         $response = $this->httpClient->post(static::API_AUTH_URL, [
             'form_params' => [
@@ -81,23 +69,6 @@ protected function getAuthorizationHeader()
             ]
         ]);
 
-        $contents = json_decode($response->getBody()->getContents(), true);
-
-        return $contents['access_token'];
-    }
-
-    /**
-     * Make sure JSON is encoded.
-     *
-     * @param mixed $json
-     * @return string
-     */
-    protected function encodeJson($json)
-    {
-        if (is_array($json) || is_object($json)) {
-            return json_encode($json);
-        }
-
-        return $json;
+        return new AuthorizationToken(json_decode($response->getBody()->getContents(), true));
     }
 }

src/Resources/AuthorizationToken.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace KirschbaumDevelopment\Bee\Resources;
+
+class AuthorizationToken
+{
+    /**
+     * @var string
+     */
+    protected $accessToken;
+
+    /**
+     * @var string
+     */
+    protected $tokenType;
+
+    /**
+     * @var string
+     */
+    protected $expiresIn;
+
+    /**
+     * @var string
+     */
+    protected $pageOrientation;
+
+    /**
+     * @var string
+     */
+    protected $refreshToken;
+
+    public function __construct($tokenData)
+    {
+        $this->accessToken = $tokenData['access_token'] ?? null;
+        $this->tokenType = $tokenData['token_type'] ?? null;
+        $this->expiresIn = $tokenData['expires_in'] ?? null;
+        $this->refreshToken = $tokenData['refresh_token'] ?? null;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAccessToken()
+    {
+        return $this->accessToken;
+    }
+
+    /**
+     * @return string
+     */
+    public function getTokenType()
+    {
+        return $this->tokenType;
+    }
+
+    /**
+     * @return string
+     */
+    public function getExpiresIn()
+    {
+        return $this->expiresIn;
+    }
+
+    /**
+     * @return string
+     */
+    public function getRefreshToken()
+    {
+        return $this->refreshToken;
+    }
+}

tests/BeeAuthTest.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace KirschbaumDevelopment\Bee\Tests;
+
+use GuzzleHttp\Client;
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\Psr7\Response;
+use PHPUnit\Framework\TestCase;
+use GuzzleHttp\Handler\MockHandler;
+use KirschbaumDevelopment\Bee\BeeAuth;
+use KirschbaumDevelopment\Bee\Resources\AuthorizationToken;
+
+/**
+ * @coversDefaultClass \KirschbaumDevelopment\Bee\BeeAuth
+ */
+class BeeAuthTest extends TestCase
+{
+    /**
+     * @covers ::generateToken
+     */
+    public function testGenerateToken()
+    {
+        $response = [
+            'access_token' => 'isufgisufdhguisdfhuisdf.oasihuifghsdif79s87f9sd8f7sd98f7sd98f7dsu89f.owTLmGhqv6ZJSikUhGeLBv-JANoXEAVvMZomivT2o-g',
+            'token_type' => 'bearer',
+            'expires_in' => 300,
+            'refresh_token' => '09a7sd98as7f98ds6f79sd8f.09a8s7da98sd7as98d7as9d8a7s9d8as6d9as86das98d67as.owTLmGhqv6ZJSikUhGeLBv-JANoXEAVvMZomivT2o-g',
+            'as:client_id' => 'da91fe57-1ca6-4dba-b557-61edb96f4149',
+            'userName' => 'Tn3KV7JYavWn',
+            'as:region' => 'eu-west-1',
+            '.issued' => 'Sat, 17 Aug 2019 00:08:50 GMT',
+            '.expires' => 'Sat, 17 Aug 2019 00:13:50 GMT'
+        ];
+
+        $mock = new MockHandler([new Response(200, [], json_encode($response))]);
+        $guzzleClient = new Client(['handler' => HandlerStack::create($mock)]);
+
+        $beeClient = new BeeAuth($guzzleClient);
+        $beeClient->setClientId('fake-client-id');
+        $beeClient->setClientSecret('fake-client-secret');
+        $token = $beeClient->generateToken();
+
+        $this->assertInstanceOf(AuthorizationToken::class, $token);
+        $this->assertEquals($response['access_token'], $token->getAccessToken());
+        $this->assertEquals($response['token_type'], $token->getTokenType());
+        $this->assertEquals($response['expires_in'], $token->getExpiresIn());
+        $this->assertEquals($response['refresh_token'], $token->getRefreshToken());
+    }
+}