mirrors/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2024-12-16 20:56:28 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3187 from wallabag/api-client-credentials

Browse source 
Create (and return) a client after creating a new user using the API
This commit is contained in:
Jérémy Benoist 2017-06-08 17:24:49 +02:00 committed by GitHub
commit 3f474025d8
7 changed files with 88 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
src/Wallabag/ApiBundle/Controller/UserRestController.php
View file

@ -9,6 +9,7 @@ use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\JsonResponse;
use Wallabag\UserBundle\Entity\User;
use Wallabag\ApiBundle\Entity\Client;
class UserRestController extends WallabagRestController
{
@ -27,13 +28,14 @@ class UserRestController extends WallabagRestController
}
/**
* Register an user.
* Register an user and create a client.
*
* @ApiDoc(
* requirements={
* {"name"="username", "dataType"="string", "required"=true, "description"="The user's username"},
* {"name"="password", "dataType"="string", "required"=true, "description"="The user's password"},
* {"name"="email", "dataType"="string", "required"=true, "description"="The user's email"}
* {"name"="email", "dataType"="string", "required"=true, "description"="The user's email"},
* {"name"="client_name", "dataType"="string", "required"=true, "description"="The client name (to be used by your app)"}
* }
* )
*
@ -97,29 +99,38 @@ class UserRestController extends WallabagRestController
->setStatusCode(JsonResponse::HTTP_BAD_REQUEST);
}
// create a default client
$client = new Client($user);
$client->setName($request->request->get('client_name', 'Default client'));
$this->getDoctrine()->getManager()->persist($client);
$user->addClient($client);
$userManager->updateUser($user);
// dispatch a created event so the associated config will be created
$event = new UserEvent($user, $request);
$this->get('event_dispatcher')->dispatch(FOSUserEvents::USER_CREATED, $event);
return $this->sendUser($user, JsonResponse::HTTP_CREATED);
return $this->sendUser($user, 'user_api_with_client', JsonResponse::HTTP_CREATED);
}
/**
* Send user response.
*
* @param User $user
* @param int $status HTTP Status code to send
* @param User $user
* @param string $group Used to define with serialized group might be used
* @param int $status HTTP Status code to send
*
* @return JsonResponse
*/
private function sendUser(User $user, $status = JsonResponse::HTTP_OK)
private function sendUser(User $user, $group = 'user_api', $status = JsonResponse::HTTP_OK)
{
$json = $this->get('serializer')->serialize(
$user,
'json',
SerializationContext::create()->setGroups(['user_api'])
SerializationContext::create()->setGroups([$group])
);
return (new JsonResponse())

23
src/Wallabag/ApiBundle/Entity/Client.php
View file

@ -5,6 +5,9 @@ namespace Wallabag\ApiBundle\Entity;
use Doctrine\ORM\Mapping as ORM;
use FOS\OAuthServerBundle\Entity\Client as BaseClient;
use Wallabag\UserBundle\Entity\User;
use JMS\Serializer\Annotation\Groups;
use JMS\Serializer\Annotation\SerializedName;
use JMS\Serializer\Annotation\VirtualProperty;
/**
* @ORM\Table("oauth2_clients")
@ -23,6 +26,8 @@ class Client extends BaseClient
* @var string
*
* @ORM\Column(name="name", type="text", nullable=false)
*
* @Groups({"user_api_with_client"})
*/
protected $name;
@ -36,6 +41,14 @@ class Client extends BaseClient
*/
protected $accessTokens;
/**
* @var string
*
* @SerializedName("client_secret")
* @Groups({"user_api_with_client"})
*/
protected $secret;
/**
* @ORM\ManyToOne(targetEntity="Wallabag\UserBundle\Entity\User", inversedBy="clients")
*/
@ -78,4 +91,14 @@ class Client extends BaseClient
{
return $this->user;
}
/**
* @VirtualProperty
* @SerializedName("client_id")
* @Groups({"user_api_with_client"})
*/
public function getClientId()
{
return $this->getId().'_'.$this->getRandomId();
}
}

2
src/Wallabag/CoreBundle/Resources/views/themes/common/Developer/index.html.twig
View file

@ -33,7 +33,7 @@
<table class="striped">
<tr>
<td>{{ 'developer.existing_clients.field_id'|trans }}</td>
<td><strong><code>{{ client.id }}_{{ client.randomId }}</code></strong></td>
<td><strong><code>{{ client.clientId }}</code></strong></td>
</tr>
<tr>
<td>{{ 'developer.existing_clients.field_secret'|trans }}</td>

38
src/Wallabag/UserBundle/Entity/User.php
View file

@ -6,6 +6,7 @@ use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use JMS\Serializer\Annotation\Groups;
use JMS\Serializer\Annotation\XmlRoot;
use JMS\Serializer\Annotation\Accessor;
use Scheb\TwoFactorBundle\Model\Email\TwoFactorInterface;
use Scheb\TwoFactorBundle\Model\TrustedComputerInterface;
use FOS\UserBundle\Model\User as BaseUser;
@ -36,7 +37,7 @@ class User extends BaseUser implements TwoFactorInterface, TrustedComputerInterf
* @ORM\Id
* @ORM\GeneratedValue(strategy="AUTO")
*
* @Groups({"user_api"})
* @Groups({"user_api", "user_api_with_client"})
*/
protected $id;
@ -45,21 +46,21 @@ class User extends BaseUser implements TwoFactorInterface, TrustedComputerInterf
*
* @ORM\Column(name="name", type="text", nullable=true)
*
* @Groups({"user_api"})
* @Groups({"user_api", "user_api_with_client"})
*/
protected $name;
/**
* @var string
*
* @Groups({"user_api"})
* @Groups({"user_api", "user_api_with_client"})
*/
protected $username;
/**
* @var string
*
* @Groups({"user_api"})
* @Groups({"user_api", "user_api_with_client"})
*/
protected $email;
@ -68,7 +69,7 @@ class User extends BaseUser implements TwoFactorInterface, TrustedComputerInterf
*
* @ORM\Column(name="created_at", type="datetime")
*
* @Groups({"user_api"})
* @Groups({"user_api", "user_api_with_client"})
*/
protected $createdAt;
@ -77,7 +78,7 @@ class User extends BaseUser implements TwoFactorInterface, TrustedComputerInterf
*
* @ORM\Column(name="updated_at", type="datetime")
*
* @Groups({"user_api"})
* @Groups({"user_api", "user_api_with_client"})
*/
protected $updatedAt;
@ -97,7 +98,8 @@ class User extends BaseUser implements TwoFactorInterface, TrustedComputerInterf
private $authCode;
/**
* @var bool Enabled yes/no
* @var bool
*
* @ORM\Column(type="boolean")
*/
private $twoFactorAuthentication = false;
@ -108,10 +110,20 @@ class User extends BaseUser implements TwoFactorInterface, TrustedComputerInterf
private $trusted;
/**
* @var ArrayCollection
*
* @ORM\OneToMany(targetEntity="Wallabag\ApiBundle\Entity\Client", mappedBy="user", cascade={"remove"})
*/
protected $clients;
/**
* @see getFirstClient() below
*
* @Groups({"user_api_with_client"})
* @Accessor(getter="getFirstClient")
*/
protected $default_client;
public function __construct()
{
parent::__construct();
@ -288,4 +300,16 @@ class User extends BaseUser implements TwoFactorInterface, TrustedComputerInterf
{
return $this->clients;
}
/**
* Only used by the API when creating a new user it'll also return the first client (which was also created at the same time).
*
* @return Client
*/
public function getFirstClient()
{
if (!empty($this->clients)) {
return $this->clients->first();
}
}
}

4
tests/Wallabag/AnnotationBundle/Controller/AnnotationControllerTest.php
View file

@ -85,7 +85,7 @@ class AnnotationControllerTest extends WallabagAnnotationTestCase
'text' => 'my annotation',
'quote' => 'my quote',
'ranges' => [
['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31]
['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31],
],
]);
$this->client->request('POST', $prefixUrl.'/'.$entry->getId().'.json', [], [], $headers, $content);
@ -130,7 +130,7 @@ class AnnotationControllerTest extends WallabagAnnotationTestCase
'text' => 'my annotation',
'quote' => $longQuote,
'ranges' => [
['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31]
['start' => '', 'startOffset' => 24, 'end' => '', 'endOffset' => 31],
],
]);
$this->client->request('POST', $prefixUrl.'/'.$entry->getId().'.json', [], [], $headers, $content);

13
tests/Wallabag/ApiBundle/Controller/UserRestControllerTest.php
View file

@ -61,10 +61,16 @@ class UserRestControllerTest extends WallabagApiTestCase
$this->assertArrayHasKey('username', $content);
$this->assertArrayHasKey('created_at', $content);
$this->assertArrayHasKey('updated_at', $content);
$this->assertArrayHasKey('default_client', $content);
$this->assertEquals('wallabag@google.com', $content['email']);
$this->assertEquals('google', $content['username']);
$this->assertArrayHasKey('client_secret', $content['default_client']);
$this->assertArrayHasKey('client_id', $content['default_client']);
$this->assertEquals('Default client', $content['default_client']['name']);
$this->assertEquals('application/json', $this->client->getResponse()->headers->get('Content-Type'));
$this->client->getContainer()->get('craue_config')->set('api_user_registration', 0);
@ -79,6 +85,7 @@ class UserRestControllerTest extends WallabagApiTestCase
'username' => 'google',
'password' => 'googlegoogle',
'email' => 'wallabag@google.com',
'client_name' => 'My client name !!',
]);
$this->assertEquals(201, $client->getResponse()->getStatusCode());
@ -90,10 +97,16 @@ class UserRestControllerTest extends WallabagApiTestCase
$this->assertArrayHasKey('username', $content);
$this->assertArrayHasKey('created_at', $content);
$this->assertArrayHasKey('updated_at', $content);
$this->assertArrayHasKey('default_client', $content);
$this->assertEquals('wallabag@google.com', $content['email']);
$this->assertEquals('google', $content['username']);
$this->assertArrayHasKey('client_secret', $content['default_client']);
$this->assertArrayHasKey('client_id', $content['default_client']);
$this->assertEquals('My client name !!', $content['default_client']['name']);
$this->assertEquals('application/json', $client->getResponse()->headers->get('Content-Type'));
$client->getContainer()->get('craue_config')->set('api_user_registration', 0);

2
tests/Wallabag/CoreBundle/Command/ShowUserCommandTest.php
View file

@ -4,10 +4,8 @@ namespace Tests\Wallabag\CoreBundle\Command;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Console\Tester\CommandTester;
use Wallabag\CoreBundle\Command\CleanDuplicatesCommand;
use Tests\Wallabag\CoreBundle\WallabagCoreTestCase;
use Wallabag\CoreBundle\Command\ShowUserCommand;
use Wallabag\CoreBundle\Entity\Entry;
use Wallabag\UserBundle\Entity\User;
class ShowUserCommandTest extends WallabagCoreTestCase