Add JSON API #271

srbaker · 2017-07-29T21:20:34Z

This is the first run at an API, as discussed in #83. It is also required for #30.

codecov · 2017-07-29T22:13:28Z

Codecov Report

Merging #271 into master will decrease coverage by 3.34%.
The diff coverage is 0%.

@@            Coverage Diff             @@
##           master     #271      +/-   ##
==========================================
- Coverage   77.21%   73.87%   -3.35%     
==========================================
  Files          38       35       -3     
  Lines        1163     1018     -145     
==========================================
- Hits          898      752     -146     
- Misses        265      266       +1

juliusknorr · 2017-09-16T13:56:50Z

@srbaker Sorry for the long time without a reply. As you may have recognized, it has been silent around deck in the last weeks. I'll make sure to review this during the weekend so we can go on with that.

juliusknorr

Looks good in general. 👍 I've added some comments to the the code.

In general please make sure to indent the files by tab not spaces.

juliusknorr · 2017-09-18T13:13:35Z

lib/Controller/StackApiController.php

+     * Create a stack with the specified title and order.
+     */
+    public function create($boardId, $title, $order) {
+        // this throws a StatusException that needs to be caught and handled


We catch StatusExceptions in the "SharingMiddleware" (although the Sharing is not part of that anymore, so it might need some rename).

deck/lib/Middleware/SharingMiddleware.php

Line 61 in 15e5a43

public function afterException($controller, $methodName, \Exception $exception) {

You can either add some logic to return proper error responses there, or exclude any exceptions from ApiControllers there and add the handling to the controller.

juliusknorr · 2017-09-18T13:15:45Z

lib/Controller/BoardApiController.php

+    public function get($id) {
+        $board = $this->service->find($id);
+
+        // FIXME: this should probably 404 if the board has been deleted


It should be a 200 if it got deleted and a 404 if the entity for $id is not found. Otherwise you cannot separate between a successful deletion and a failing one, because the entity does not exist.

juliusknorr · 2017-09-18T13:18:14Z

lib/Controller/BoardApiController.php

+        return new DataResponse($board);
+    }
+
+    // this is taken from BoardController, but it's not ideal


You can move the method to the BoardService class, then we can use it from both controllers.

See:

deck/lib/Controller/BoardController.php

Line 53 in 2c63bfb

* TODO: move to boardservice

juliusknorr · 2017-09-18T13:19:35Z

appinfo/routes.php

@@ -62,5 +62,18 @@
 		['name' => 'label#update', 'url' => '/labels/{labelId}', 'verb' => 'PUT'],
 		['name' => 'label#delete', 'url' => '/labels/{labelId}', 'verb' => 'DELETE'],

+        // api


indentation seems wrong here 😉

srbaker · 2017-09-23T09:35:01Z

Thanks! I've also been a bit distracted by other things; I'll plan to address these this week, and finish up the last bits. I'm hoping to use this to get a mobile app running before the end of the year. Deck is starting to become a rather important part of my personal workflows. :)

juliusknorr · 2017-09-23T09:39:32Z

@srbaker Sure no need to hurry. I plan to do a 0.3.0 release in like 1 or 2 months, so we have some time if we want to get this in there.

robertauer · 2017-12-10T08:08:01Z

Are you guys still working on this? Would be really great to sync Deck with external apps!

srbaker · 2017-12-11T10:51:33Z

Heya, I haven't had the time I was hoping to. But I've got some time schedule to get this through to completion soon!

Thanks for your interest!

artemanufrij · 2017-12-11T11:01:46Z

I'm also waiting for implementation of JSON API. I plan to develop a native application for elementary OS based on deck

juliusknorr · 2017-12-11T11:05:18Z

@srbaker That is awesome to hear. I think the JSON API will be a huge benefit for the deck app. Thank you already for digging into it 👍

srbaker · 2017-12-14T09:53:48Z

@juliushaertl It is encouraging that I can drag out a contribution this long, and still have it be valued. I really want to see this, but sometimes real life gets in the way, you know? I've got some holidays coming up and a good set of tasks to work through. Cheers!

srbaker · 2018-02-12T10:22:30Z

Okay! I am back on this, after some delay. :)

Do you know if there is a linter for PHP that can tell me when I've violated the nextcloud coding style? I'd really like to just set up my editor (emacs) to do the right thing for me, rather than thinking about it. Thanks!

…ceeds or not.

srbaker · 2018-02-12T11:13:23Z

I think this solves the open issues. Please, comment on the latest. I'm going to be giving this more attention this week and next, so please comment if you have time.

juliusknorr · 2018-02-12T14:48:05Z

lib/Controller/BoardApiController.php

+	public function __construct($appName, IRequest $request, IUserManager $userManager, IGroupManager $groupManager, BoardService $service, $userId) {
+		parent::__construct($appName, $request);
+		$this->service = $service;
+		$this->userId = $userId;


No need for the user/group manager anymore.

juliusknorr · 2018-02-12T14:48:36Z

lib/Controller/BoardApiController.php

+		$this->userId = $userId;
+		$this->userManager = $userManager;
+		$this->groupManager = $groupManager;
+		$this->userInfo = $this->service->getBoardPrerequisites();


We can actually move that service to the BoardService now. 😉

juliusknorr · 2018-02-12T14:49:07Z

lib/Controller/BoardApiController.php

+	 * Return all of the boards that the current user has access to.
+	 */
+	public function index() {
+		$boards = $this->service->findAll($this->userInfo);


As mentioned above, let's move the user info fetching to the board service and get rid of the parameter here.

…ervice.

juliusknorr · 2018-02-12T15:29:25Z

Do you know if there is a linter for PHP that can tell me when I've violated the nextcloud coding style? I'd really like to just set up my editor (emacs) to do the right thing for me, rather than thinking about it. Thanks!

I'm not aware of any linter with a config available for the Nextcloud coding style. https://docs.nextcloud.com/server/10/developer_manual/general/codingguidelines.html#php

Since many developers use PHPStorm, the code style settings are available here: https://github.com/nextcloud/server/blob/master/.idea/codeStyleSettings.xml I'm sorry, I cannot tell anything about emacs, but in general the coding style looks fine on this PR.

srbaker · 2018-02-12T15:29:28Z

Sorry, I missed that, it should have been obvious. Clearly I need to go back through and do a refactor.

srbaker · 2018-02-12T15:34:52Z

I haven't done the commit signing: do I have to go back and amend all of my commits with a signature? Or is there something else I can do?

juliusknorr · 2018-02-12T15:40:10Z

I haven't done the commit signing: do I have to go back and amend all of my commits with a signature? Or is there something else I can do?

We can also squash those commits when merging, if you are fine with that.

Btw. feel free to join #nextcloud-deck on freenode IRC if you have some quick questions. 😉

Braintelligence · 2018-03-02T11:37:25Z

Looks like we can expect an API for Deck soon, very excited!

juliusknorr · 2018-08-15T19:06:12Z

Closing in favour of #535

Thanks again @srbaker for getting this started.

srbaker added 8 commits July 29, 2017 01:41

List boards, and fetch a specific board.

c51070a

Delete boards via the API.

1b22c44

Undo deletion of boards via API.

fc02f58

Update the documentation.

43c7fb7

Change the API version to 1.0, and fix the preflighted_cors version.

6343412

These parens are not needed.

03d1d6c

Board creation via API.

b8676ee

Add Stack support to API.

f6f78fc

srbaker added 2. developing backend enhancement labels Jul 29, 2017

srbaker added 2 commits July 29, 2017 23:21

Merge branch 'master' into add-json-api

05f5323

Fix the routing and the stacks API endpoint.

f797b31

srbaker and others added 3 commits July 30, 2017 12:36

Merge branch 'master' into add-json-api

d095c27

Merge branch 'master' into add-json-api

2c7c768

Merge branch 'master' into add-json-api

42d88e9

juliusknorr self-assigned this Sep 16, 2017

juliusknorr self-requested a review September 16, 2017 13:57

juliusknorr requested changes Sep 18, 2017

View reviewed changes

juliusknorr removed the 2. developing label Sep 18, 2017

juliusknorr removed their assignment Sep 28, 2017

juliusknorr mentioned this pull request Feb 5, 2018

Android App #187

Closed

srbaker added 5 commits February 12, 2018 11:22

Merge branch 'master' into add-json-api

5de1b94

Re-format code according to the coding style.

20be99e

This should be 200 on deletion, so we can tell whether a deletion suc…

e218d55

…ceeds or not.

Extract getBoardPererequisites() so it can be re-used.

fb19856

Merge remote-tracking branch 'origin/add-json-api' into add-json-api

6e722ae

juliusknorr reviewed Feb 12, 2018

View reviewed changes

Don't need to pass around the userInfo with it encapsulated in BoardS…

8b4efbc

…ervice.

srbaker added 2 commits February 14, 2018 23:50

Merge branch 'master' into add-json-api

6691234

Merge branch 'master' into add-json-api

e68b292

juliusknorr mentioned this pull request Jun 18, 2018

API / Apps #491

Closed

juliusknorr closed this Aug 15, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add JSON API #271

Add JSON API #271

srbaker commented Jul 29, 2017

codecov bot commented Jul 29, 2017 •

edited

Loading

juliusknorr commented Sep 16, 2017

juliusknorr left a comment

juliusknorr Sep 18, 2017

juliusknorr Sep 18, 2017

juliusknorr Sep 18, 2017

juliusknorr Sep 18, 2017

srbaker commented Sep 23, 2017

juliusknorr commented Sep 23, 2017

robertauer commented Dec 10, 2017

srbaker commented Dec 11, 2017

artemanufrij commented Dec 11, 2017 •

edited

Loading

juliusknorr commented Dec 11, 2017

srbaker commented Dec 14, 2017

srbaker commented Feb 12, 2018

srbaker commented Feb 12, 2018

juliusknorr Feb 12, 2018

juliusknorr Feb 12, 2018

juliusknorr Feb 12, 2018

juliusknorr commented Feb 12, 2018

srbaker commented Feb 12, 2018

srbaker commented Feb 12, 2018

juliusknorr commented Feb 12, 2018

Braintelligence commented Mar 2, 2018

juliusknorr commented Aug 15, 2018

Add JSON API #271

Add JSON API #271

Conversation

srbaker commented Jul 29, 2017

codecov bot commented Jul 29, 2017 • edited Loading

Codecov Report

juliusknorr commented Sep 16, 2017

juliusknorr left a comment

Choose a reason for hiding this comment

juliusknorr Sep 18, 2017

Choose a reason for hiding this comment

juliusknorr Sep 18, 2017

Choose a reason for hiding this comment

juliusknorr Sep 18, 2017

Choose a reason for hiding this comment

juliusknorr Sep 18, 2017

Choose a reason for hiding this comment

srbaker commented Sep 23, 2017

juliusknorr commented Sep 23, 2017

robertauer commented Dec 10, 2017

srbaker commented Dec 11, 2017

artemanufrij commented Dec 11, 2017 • edited Loading

juliusknorr commented Dec 11, 2017

srbaker commented Dec 14, 2017

srbaker commented Feb 12, 2018

srbaker commented Feb 12, 2018

juliusknorr Feb 12, 2018

Choose a reason for hiding this comment

juliusknorr Feb 12, 2018

Choose a reason for hiding this comment

juliusknorr Feb 12, 2018

Choose a reason for hiding this comment

juliusknorr commented Feb 12, 2018

srbaker commented Feb 12, 2018

srbaker commented Feb 12, 2018

juliusknorr commented Feb 12, 2018

Braintelligence commented Mar 2, 2018

juliusknorr commented Aug 15, 2018

codecov bot commented Jul 29, 2017 •

edited

Loading

artemanufrij commented Dec 11, 2017 •

edited

Loading