aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJeremy Benoist <j0k3r@users.noreply.github.com>2016-10-12 14:06:33 +0200
committerGitHub <noreply@github.com>2016-10-12 14:06:33 +0200
commitb1b561da518ae3add4445c46ef8398a314c8de37 (patch)
tree3ff96d8cfe8021d6fbaa487dd0db2ef01f74ba42
parente4cf672ccf61689ba28c2e89fc55f83167800b18 (diff)
parent3f3a60879e168f4a8040c441e295fa63e024961d (diff)
downloadwallabag-b1b561da518ae3add4445c46ef8398a314c8de37.tar.gz
wallabag-b1b561da518ae3add4445c46ef8398a314c8de37.tar.zst
wallabag-b1b561da518ae3add4445c46ef8398a314c8de37.zip
Merge pull request #2372 from pmartin/api-get-entry-as-epub
API: ability to export entry in all available format (epub, pdf, etc...)
-rw-r--r--app/config/config.yml2
-rw-r--r--src/Wallabag/ApiBundle/Controller/WallabagRestController.php29
-rw-r--r--src/Wallabag/ApiBundle/Resources/config/routing_rest.yml8
-rw-r--r--tests/Wallabag/ApiBundle/Controller/WallabagRestControllerTest.php104
4 files changed, 89 insertions, 54 deletions
diff --git a/app/config/config.yml b/app/config/config.yml
index bcc4c8eb..2f102c45 100644
--- a/app/config/config.yml
+++ b/app/config/config.yml
@@ -130,6 +130,8 @@ fos_rest:
130nelmio_api_doc: 130nelmio_api_doc:
131 sandbox: 131 sandbox:
132 enabled: false 132 enabled: false
133 cache:
134 enabled: true
133 name: wallabag API documentation 135 name: wallabag API documentation
134 136
135nelmio_cors: 137nelmio_cors:
diff --git a/src/Wallabag/ApiBundle/Controller/WallabagRestController.php b/src/Wallabag/ApiBundle/Controller/WallabagRestController.php
index 9997913d..fa573988 100644
--- a/src/Wallabag/ApiBundle/Controller/WallabagRestController.php
+++ b/src/Wallabag/ApiBundle/Controller/WallabagRestController.php
@@ -3,7 +3,7 @@
3namespace Wallabag\ApiBundle\Controller; 3namespace Wallabag\ApiBundle\Controller;
4 4
5use FOS\RestBundle\Controller\FOSRestController; 5use FOS\RestBundle\Controller\FOSRestController;
6use Hateoas\Configuration\Route; 6use Hateoas\Configuration\Route as HateoasRoute;
7use Hateoas\Representation\Factory\PagerfantaFactory; 7use Hateoas\Representation\Factory\PagerfantaFactory;
8use Nelmio\ApiDocBundle\Annotation\ApiDoc; 8use Nelmio\ApiDocBundle\Annotation\ApiDoc;
9use Symfony\Component\HttpFoundation\Request; 9use Symfony\Component\HttpFoundation\Request;
@@ -12,6 +12,7 @@ use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
12use Symfony\Component\Security\Core\Exception\AccessDeniedException; 12use Symfony\Component\Security\Core\Exception\AccessDeniedException;
13use Wallabag\CoreBundle\Entity\Entry; 13use Wallabag\CoreBundle\Entity\Entry;
14use Wallabag\CoreBundle\Entity\Tag; 14use Wallabag\CoreBundle\Entity\Tag;
15use FOS\RestBundle\Controller\Annotations\Route;
15 16
16class WallabagRestController extends FOSRestController 17class WallabagRestController extends FOSRestController
17{ 18{
@@ -115,7 +116,7 @@ class WallabagRestController extends FOSRestController
115 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage'); 116 $pagerfantaFactory = new PagerfantaFactory('page', 'perPage');
116 $paginatedCollection = $pagerfantaFactory->createRepresentation( 117 $paginatedCollection = $pagerfantaFactory->createRepresentation(
117 $pager, 118 $pager,
118 new Route( 119 new HateoasRoute(
119 'api_get_entries', 120 'api_get_entries',
120 [ 121 [
121 'archive' => $isArchived, 122 'archive' => $isArchived,
@@ -158,6 +159,30 @@ class WallabagRestController extends FOSRestController
158 } 159 }
159 160
160 /** 161 /**
162 * Retrieve a single entry as a predefined format.
163 *
164 * @ApiDoc(
165 * requirements={
166 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
167 * }
168 * )
169 *
170 * @Route(requirements={"_format"="epub|mobi|pdf|txt|csv"})
171 *
172 * @return Response
173 */
174 public function getEntryExportAction(Entry $entry, Request $request)
175 {
176 $this->validateAuthentication();
177 $this->validateUserAccess($entry->getUser()->getId());
178
179 return $this->get('wallabag_core.helper.entries_export')
180 ->setEntries($entry)
181 ->updateTitle('entry')
182 ->exportAs($request->attributes->get('_format'));
183 }
184
185 /**
161 * Create an entry. 186 * Create an entry.
162 * 187 *
163 * @ApiDoc( 188 * @ApiDoc(
diff --git a/src/Wallabag/ApiBundle/Resources/config/routing_rest.yml b/src/Wallabag/ApiBundle/Resources/config/routing_rest.yml
index 5f43f971..35f8b2c1 100644
--- a/src/Wallabag/ApiBundle/Resources/config/routing_rest.yml
+++ b/src/Wallabag/ApiBundle/Resources/config/routing_rest.yml
@@ -1,4 +1,4 @@
1entries: 1api:
2 type: rest 2 type: rest
3 resource: "WallabagApiBundle:WallabagRest" 3 resource: "WallabagApiBundle:WallabagRest"
4 name_prefix: api_ 4 name_prefix: api_
diff --git a/tests/Wallabag/ApiBundle/Controller/WallabagRestControllerTest.php b/tests/Wallabag/ApiBundle/Controller/WallabagRestControllerTest.php
index 5dcb3e00..6bca3c8b 100644
--- a/tests/Wallabag/ApiBundle/Controller/WallabagRestControllerTest.php
+++ b/tests/Wallabag/ApiBundle/Controller/WallabagRestControllerTest.php
@@ -32,12 +32,55 @@ class WallabagRestControllerTest extends WallabagApiTestCase
32 $this->assertEquals($entry->getUserEmail(), $content['user_email']); 32 $this->assertEquals($entry->getUserEmail(), $content['user_email']);
33 $this->assertEquals($entry->getUserId(), $content['user_id']); 33 $this->assertEquals($entry->getUserId(), $content['user_id']);
34 34
35 $this->assertTrue( 35 $this->assertEquals('application/json', $this->client->getResponse()->headers->get('Content-Type'));
36 $this->client->getResponse()->headers->contains( 36 }
37 'Content-Type', 37
38 'application/json' 38 public function testExportEntry()
39 ) 39 {
40 ); 40 $entry = $this->client->getContainer()
41 ->get('doctrine.orm.entity_manager')
42 ->getRepository('WallabagCoreBundle:Entry')
43 ->findOneBy(['user' => 1, 'isArchived' => false]);
44
45 if (!$entry) {
46 $this->markTestSkipped('No content found in db.');
47 }
48
49 $this->client->request('GET', '/api/entries/'.$entry->getId().'/export.epub');
50 $this->assertEquals(200, $this->client->getResponse()->getStatusCode());
51
52 // epub format got the content type in the content
53 $this->assertContains('application/epub', $this->client->getResponse()->getContent());
54 $this->assertEquals('application/epub+zip', $this->client->getResponse()->headers->get('Content-Type'));
55
56 // re-auth client for mobi
57 $client = $this->createAuthorizedClient();
58 $client->request('GET', '/api/entries/'.$entry->getId().'/export.mobi');
59 $this->assertEquals(200, $client->getResponse()->getStatusCode());
60
61 $this->assertEquals('application/x-mobipocket-ebook', $client->getResponse()->headers->get('Content-Type'));
62
63 // re-auth client for pdf
64 $client = $this->createAuthorizedClient();
65 $client->request('GET', '/api/entries/'.$entry->getId().'/export.pdf');
66 $this->assertEquals(200, $client->getResponse()->getStatusCode());
67
68 $this->assertContains('PDF-', $client->getResponse()->getContent());
69 $this->assertEquals('application/pdf', $client->getResponse()->headers->get('Content-Type'));
70
71 // re-auth client for pdf
72 $client = $this->createAuthorizedClient();
73 $client->request('GET', '/api/entries/'.$entry->getId().'/export.txt');
74 $this->assertEquals(200, $client->getResponse()->getStatusCode());
75
76 $this->assertContains('text/plain', $client->getResponse()->headers->get('Content-Type'));
77
78 // re-auth client for pdf
79 $client = $this->createAuthorizedClient();
80 $client->request('GET', '/api/entries/'.$entry->getId().'/export.csv');
81 $this->assertEquals(200, $client->getResponse()->getStatusCode());
82
83 $this->assertContains('application/csv', $client->getResponse()->headers->get('Content-Type'));
41 } 84 }
42 85
43 public function testGetOneEntryWrongUser() 86 public function testGetOneEntryWrongUser()
@@ -70,12 +113,7 @@ class WallabagRestControllerTest extends WallabagApiTestCase
70 $this->assertEquals(1, $content['page']); 113 $this->assertEquals(1, $content['page']);
71 $this->assertGreaterThanOrEqual(1, $content['pages']); 114 $this->assertGreaterThanOrEqual(1, $content['pages']);
72 115
73 $this->assertTrue( 116 $this->assertEquals('application/json', $this->client->getResponse()->headers->get('Content-Type'));
74 $this->client->getResponse()->headers->contains(
75 'Content-Type',
76 'application/json'
77 )
78 );
79 } 117 }
80 118
81 public function testGetEntriesWithFullOptions() 119 public function testGetEntriesWithFullOptions()
@@ -117,12 +155,7 @@ class WallabagRestControllerTest extends WallabagApiTestCase
117 $this->assertContains('since=1443274283', $content['_links'][$link]['href']); 155 $this->assertContains('since=1443274283', $content['_links'][$link]['href']);
118 } 156 }
119 157
120 $this->assertTrue( 158 $this->assertEquals('application/json', $this->client->getResponse()->headers->get('Content-Type'));
121 $this->client->getResponse()->headers->contains(
122 'Content-Type',
123 'application/json'
124 )
125 );
126 } 159 }
127 160
128 public function testGetStarredEntries() 161 public function testGetStarredEntries()
@@ -150,12 +183,7 @@ class WallabagRestControllerTest extends WallabagApiTestCase
150 $this->assertContains('sort=updated', $content['_links'][$link]['href']); 183 $this->assertContains('sort=updated', $content['_links'][$link]['href']);
151 } 184 }
152 185
153 $this->assertTrue( 186 $this->assertEquals('application/json', $this->client->getResponse()->headers->get('Content-Type'));
154 $this->client->getResponse()->headers->contains(
155 'Content-Type',
156 'application/json'
157 )
158 );
159 } 187 }
160 188
161 public function testGetArchiveEntries() 189 public function testGetArchiveEntries()
@@ -182,12 +210,7 @@ class WallabagRestControllerTest extends WallabagApiTestCase
182 $this->assertContains('archive=1', $content['_links'][$link]['href']); 210 $this->assertContains('archive=1', $content['_links'][$link]['href']);
183 } 211 }
184 212
185 $this->assertTrue( 213 $this->assertEquals('application/json', $this->client->getResponse()->headers->get('Content-Type'));
186 $this->client->getResponse()->headers->contains(
187 'Content-Type',
188 'application/json'
189 )
190 );
191 } 214 }
192 215
193 public function testGetTaggedEntries() 216 public function testGetTaggedEntries()
@@ -214,12 +237,7 @@ class WallabagRestControllerTest extends WallabagApiTestCase
214 $this->assertContains('tags='.urlencode('foo,bar'), $content['_links'][$link]['href']); 237 $this->assertContains('tags='.urlencode('foo,bar'), $content['_links'][$link]['href']);
215 } 238 }
216 239
217 $this->assertTrue( 240 $this->assertEquals('application/json', $this->client->getResponse()->headers->get('Content-Type'));
218 $this->client->getResponse()->headers->contains(
219 'Content-Type',
220 'application/json'
221 )
222 );
223 } 241 }
224 242
225 public function testGetDatedEntries() 243 public function testGetDatedEntries()
@@ -246,12 +264,7 @@ class WallabagRestControllerTest extends WallabagApiTestCase
246 $this->assertContains('since=1443274283', $content['_links'][$link]['href']); 264 $this->assertContains('since=1443274283', $content['_links'][$link]['href']);
247 } 265 }
248 266
249 $this->assertTrue( 267 $this->assertEquals('application/json', $this->client->getResponse()->headers->get('Content-Type'));
250 $this->client->getResponse()->headers->contains(
251 'Content-Type',
252 'application/json'
253 )
254 );
255 } 268 }
256 269
257 public function testGetDatedSupEntries() 270 public function testGetDatedSupEntries()
@@ -279,12 +292,7 @@ class WallabagRestControllerTest extends WallabagApiTestCase
279 $this->assertContains('since='.($future->getTimestamp() + 1000), $content['_links'][$link]['href']); 292 $this->assertContains('since='.($future->getTimestamp() + 1000), $content['_links'][$link]['href']);
280 } 293 }
281 294
282 $this->assertTrue( 295 $this->assertEquals('application/json', $this->client->getResponse()->headers->get('Content-Type'));
283 $this->client->getResponse()->headers->contains(
284 'Content-Type',
285 'application/json'
286 )
287 );
288 } 296 }
289 297
290 public function testDeleteEntry() 298 public function testDeleteEntry()