Merge pull request #13 from Nekland/feature/follow-google-auth

Follow google auth

Author: Nek-

Diff for: .travis.yml

@@ -1,11 +1,10 @@
 language: php
 
 php:
-  - 5.4
-  - 5.5
   - 5.6
   - 7.0
   - 7.1
+  - 7.2
 
 
 branches:

Diff for: CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- New auth method because google given now different information than before
 
 ## [0.1.0] - 2017-06-20
 ### Added

Diff for: Readme.md

@@ -27,8 +27,8 @@ $youtube = new Youtube();
 
 // You have to authenticate to access the youtube api
 $youtube->authenticate(
-    'ServiceAuth',
-    ['cert_file' => 'my_google_certificate', 'email' => 'myemail_for_google_service@googleapi_etc.com']
+    'JsonFileServiceAuth',
+    ['json_file' => 'my_google_certificate.json']
 );
 
 // The info variable will contains an array of data returned by google

Diff for: composer.json

@@ -12,7 +12,7 @@
         }
     ],
     "require": {
-        "php":              ">=5.4",
+        "php":              ">=5.6",
         "guzzle/guzzle":    ">=3.7",
         "nekland/base-api": "~0.0.1",
         "namshi/jose":      "~1.2"

Diff for: docs/authentication.md

@@ -37,18 +37,49 @@ $youtube->authenticate(
 Service Account (via OAuth)
 ----------------------------
 
+To make this authentication work, you need to generate a JSON file from the google developer console.
+You can do it like that:
+
+1. Go to [https://console.developers.google.com/apis/dashboard](https://console.developers.google.com/apis/dashboard)
+2. Create your project if it's not already in the project list (we do not care about the project id)
+3. Click on the name of your project in the list present on the top of the dashboard
+4. Enable Youtube API for this project
+5. Go to credentials page
+6. In the section `OAuth`, create a new Client ID of type `Service Account`
+7. Follow the link `Manage services accounts`
+
+> This procedure can change since we do not decide of the google website UX :) .
+
+Now you have your key file you can use `YoutubeApi` like that:
+
+```php
+<?php
+
+$youtube = new Youtube();
+$youtube->authenticate(
+    'JsonFileServiceAuth',
+    ['json_file' => 'my_google_certificate.json']
+);
+```
+
+
+Service Account (via OAuth)
+----------------------------
+
+_Note: if this method is still supported by the library as well as Google, this method is deprecated._
+
 To make this authentication work, you need to generate a P12 key certificate and an API email from the google developer console.
 You can do it like that:
 
-1. Go to [https://console.developers.google.com/project](https://console.developers.google.com/project);
-2. Create your project if it's not already in the project list (we do not care about the project id);
-3. Click on the name of your project in the list;
-4. Click on APIS & AUTH > API and on "YouTube Data API v3" in the API list and click on "OFF" button to make it becoming "ON";
-5. Click on APIs & AUTH > Credentials;
+1. Go to [https://console.developers.google.com/apis/dashboard](https://console.developers.google.com/apis/dashboard)
+2. Create your project if it's not already in the project list (we do not care about the project id)
+3. Click on the name of your project in the list present on the top of the dashboard
+4. Enable Youtube API for this project
+5. Go to credentials page
 6. In the section `OAuth`, create a new Client ID of type `Service Account`
-7. Click on "Generate new P12 key" to download your certificate key
+7. Follow the link `Manage services accounts`
 
-> This procedure can change since we do not decide of the google website usability :) .
+> This procedure can change since we do not decide of the google website UX :) .
 
 Now you have your key file you can use `YoutubeApi` like that:
 

Diff for: lib/Nekland/YoutubeApi/Http/Auth/JsonFileServiceAuth.php

@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * This file is a part of nekland youtube api package
+ *
+ * (c) Nekland <[email protected]>
+ *
+ * For the full license, take a look to the LICENSE file
+ * on the root directory of this project
+ */
+
+namespace Nekland\YoutubeApi\Http\Auth;
+
+/**
+ * Class JsonfileServiceAuth
+ *
+ * Options:
+ *      json_file: the path to the json file given by Google
+ */
+final class JsonFileServiceAuth extends ServiceAuth
+{
+    /**
+     * @var array
+     */
+    private $json;
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getIss()
+    {
+        $this->loadFile();
+
+        return $this->json['client_email'];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function getPrivateKey()
+    {
+        $this->loadFile();
+
+        return $this->json['private_key'];
+
+    }
+
+    /**
+     * @return array
+     * @throws \Nekland\YoutubeApi\Exception\MissingOptionException if the required option is not set.
+     */
+    private function loadFile()
+    {
+        if ($this->json) {
+            return $this->json;
+        }
+
+        $json = file_get_contents($this->getOption('json_file'));
+
+        return $this->json = json_decode($json, true);
+    }
+}

Diff for: lib/Nekland/YoutubeApi/Http/Auth/ServiceAuth.php

@@ -18,22 +18,30 @@
 use Nekland\YoutubeApi\Exception\AuthException;
 use Nekland\YoutubeApi\Exception\MissingOptionException;
 
+/**
+ * Class ServiceAuth
+ *
+ * Options:
+ *      email: google api service account
+ *      cert_file: path to the file that contain the certificate
+ *      cert_password: password to decrypt the (p12) certificate
+ */
 class ServiceAuth implements AuthInterface
 {
     /**
      * @var array
      */
-    private $options;
+    protected $options;
 
     /**
      * @var \Guzzle\Http\ClientInterface
      */
-    private $client;
+    protected $client;
 
     /**
      * @param \Guzzle\Http\ClientInterface $client
      */
-    public function __construct(\Guzzle\Http\ClientInterface $client=null)
+    public function __construct(\Guzzle\Http\ClientInterface $client = null)
     {
         if (null === $client) {
             $this->client = new Client();
@@ -60,9 +68,9 @@ private function getToken()
     {
         $jws = new JWS('RS256');
         $jws->setPayload(array(
-            'iss'   => $this->getOption('email'),
+            'iss'   => $this->getIss(),
             'scope' => 'https://www.googleapis.com/auth/youtube',
-            'aud'   =>'https://accounts.google.com/o/oauth2/token',
+            'aud'   =>'https://www.googleapis.com/oauth2/v4/token',
             'exp'   => time() + 60,
             'iat'   => time()
         ));
@@ -84,11 +92,19 @@ private function getToken()
         return $finalArray['access_token'];
     }
 
+    /**
+     * @return string
+     */
+    protected function getIss()
+    {
+        return $this->getOption('email');
+    }
+
     /**
      * @return string
      * @throws \Nekland\YoutubeApi\Exception\AuthException
      */
-    private function getPrivateKey()
+    protected function getPrivateKey()
     {
         $file            = $this->getOption('cert_file');
         $res             = array();
@@ -100,7 +116,7 @@ private function getPrivateKey()
             return $res['pkey'];
         }
 
-        throw new AuthException(sprintf('The certificate "%" looks wrong PHP cannot open it.', $file));
+        throw new AuthException(sprintf('The key to open the p12 "%" file looks wrong, or the file is malformed.', $file));
     }
 
     /**
@@ -109,7 +125,7 @@ private function getPrivateKey()
      * @return mixed
      * @throws \Nekland\YoutubeApi\Exception\MissingOptionException
      */
-    private function getOption($option, $default=null)
+    protected function getOption($option, $default=null)
     {
         if (isset($this->options[$option])) {
             return $this->options[$option];

Diff for: test/Nekland/Tests/Api/TestCase.php

@@ -13,6 +13,7 @@
 
 
 use Nekland\YoutubeApi\Youtube;
+use Prophecy\Argument;
 
 class TestCase extends \PHPUnit_Framework_TestCase
 {
@@ -22,15 +23,12 @@ class TestCase extends \PHPUnit_Framework_TestCase
      */
     protected function getYoutubeMock(array $data)
     {
-        $httpClient = $this->getMock('Nekland\BaseApi\Http\ClientInterface');
+        $httpClient = $this->prophesize('Nekland\BaseApi\Http\ClientInterface');
 
         foreach($data as $method => $return) {
-            $httpClient->expects($this->any())
-                ->method($method)
-                ->willReturn($return)
-            ;
+            $httpClient->$method(Argument::cetera())->willReturn($return);
         }
 
-        return new Youtube($httpClient);
+        return new Youtube($httpClient->reveal());
     }
 }

Diff for: test/Nekland/Tests/Http/Auth/AuthServiceTrait.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * This file is a part of YoutubeApi package.
+ *
+ * (c) Nekland <[email protected]>
+ *
+ * For the full license, take a look to the LICENSE file
+ * on the root directory of this project
+ */
+
+namespace Nekland\Tests\Http\Auth;
+
+
+use Guzzle\Http\ClientInterface;
+use Guzzle\Http\Message\EntityEnclosingRequestInterface;
+use Guzzle\Http\Message\Response;
+use Prophecy\Argument;
+
+trait AuthServiceTrait
+{
+    protected function getClientMock()
+    {
+        $client = $this->prophesize(ClientInterface::class);
+        $request = $this->prophesize(EntityEnclosingRequestInterface::class);
+        $response = $this->prophesize(Response::class);
+
+        $response->getBody(Argument::cetera())->willReturn($this->getGoogleResponse());
+        $request->send(Argument::any())->shouldBeCalled()->willReturn($response->reveal());
+        $client->post(Argument::cetera())->willReturn($request->reveal());
+
+        return $client->reveal();
+    }
+
+    protected function getGoogleResponse()
+    {
+        return '{
+    "access_token" : "ya29.1.AADHN_WnGjqYiAcnONRLFDOfXia5XZLFO4RSyEhWtQPAvYpgPYiQj89c7UsrAs5_",
+    "token_type" : "Bearer",
+    "expires_in" : 3600
+}';
+    }
+}

Diff for: test/Nekland/Tests/Http/Auth/JsonFileServiceAuthTest.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * This file is a part of YoutubeApi package.
+ *
+ * (c) Nekland <[email protected]>
+ *
+ * For the full license, take a look to the LICENSE file
+ * on the root directory of this project
+ */
+
+namespace Nekland\Tests\Http\Auth;
+
+
+use Guzzle\Http\ClientInterface;
+use Guzzle\Http\Message\Request;
+use Nekland\YoutubeApi\Http\Auth\JsonFileServiceAuth;
+
+class JsonFileServiceAuthTest extends \PHPUnit_Framework_TestCase
+{
+    use AuthServiceTrait;
+
+    public function testItConstructWithOrWithoutClient()
+    {
+        $auth = new JsonFileServiceAuth();
+        $this->assertInstanceOf(JsonFileServiceAuth::class, $auth);
+
+        $auth = new JsonFileServiceAuth($this->prophesize(ClientInterface::class)->reveal());
+        $this->assertInstanceOf(JsonFileServiceAuth::class, $auth);
+    }
+
+    public function testItAddsATokenToTheRequest()
+    {
+        $auth = new JsonFileServiceAuth($this->getClientMock());
+
+        // This file is a fake, of course.
+        $file = __DIR__ . '/../../../../test_data/given_by_google.json';
+
+        $auth->setOptions(['json_file' => $file]);
+        $request = new Request('POST', 'http://fake.com');
+        $auth->auth($request);
+
+        $this->assertContains('ya29.1.AADHN_WnGjqYiAcnONRLFDOfXia5XZLFO4RSyEhWtQPAvYpgPYiQj89c7UsrAs5_',(string)$request->getHeader('Authorization'));
+    }
+
+    /**
+     * @expectedException \Nekland\YoutubeApi\Exception\MissingOptionException
+     */
+    public function testItThrowsExceptionIfOptionMissing()
+    {
+        $auth = new JsonFileServiceAuth($this->prophesize(ClientInterface::class)->reveal());
+        $request = new Request('POST', 'http://fake.com');
+        $auth->auth($request);
+    }
+}