lukasoppermann / formandsystem-api

The Form&System api.

Hi there 👋

I'm Lukas,

I work at GitHub 🐱🐙 on the primer team. (Which is great because I love cats and octopi)

🔭 I constantly refresh my portfolio try out new react stuff and work on my Figma plugins: design tokens & elevation scale

🌱 I am learning

• how to use screen readers
• productivly using an ANSI keyboard (I switched from a german layout)

🤔 I’m looking for help with my open source projects

• Figma design tokens export plugin
• Figma elevation system plugin
• HTML5 Sortable (drag & drop) package

💬 Ask me about

• design systems
• design tokens
• espresso based drinks

📫 Reach me on twitter: https://twitter.com/lukasoppermann

📚 Read my thoughts on medium.com/@lukasoppermann

🧪 Check out my work: https://lukasoppermann.com

😄 Pronouns: he/him

formandsystem-api's Issues

Refactor

Refactor code (all).

Error codes

Add more descriptive error codes. E.g. 201 created

Fix cached but wrong token

"Published" field should be considered when retrieving data.

Stati should be considered when retrieving data.

• retrieve only published == true content
• add option withdrafts to retrieve unpublished content as well

Set headers in response.

Set headers in api response. This could also fix the bug where unit-tests do not run because of a header already set. #25

http://laravel.com/docs/4.2/responses

$response = Response::make($contents, $statusCode);
$response->header('Content-Type', $value);
return $response;

Add test for query parameters

• fields
• sort
• include
• page
• filters

Return consitency.

• consistent error format
• consistent success format

Adhere to jsonapi page[] query parameter for pagination

Adhere to jsonapi page[] query parameter for pagination

update url to v1.0

Needs to be 1.0 and also changed in cms & copra.

Error messages for update & post to relationships

Add correct responses & errors to update & post methods for relationships.

Refactor Repositories

To Dos:

• remove chaining
  • use chaining on method only.
• simplify methods

Cleanup / Refactor of requests

Toooo many requests.

Add ssl possibility.

User needs the following options:

• port (with a default)
• use certificate

Users need a way to upload the certificate

[Commands] for nesting nav from db files.

We need to create a nested structure from streams.

Error message for when scope does not suffice?

Refactor Fragments

Fragments should be separate from pages.

Rename Content Repo to Pages

I should stick to pages everywhere.

Errors for wrong id, etc. when no db entry is found.

Add erros like 404, etc. for when api call is made correctly but with data so that no db entry is found.

Remove csrf from api calls

https://laracasts.com/discuss/channels/general-discussion/l5-avoiding-csrf-middleware-on-api-post-routes

Validate Data on relationship update

PATCH /metadetails/{{metadetails_id}}/relationships/pages

E.g. second item is missing type.

{

    "data": [
        { "type": "pages", "id": "{{page_id}}" },
        { "id": "{{page_id_3}}" }
    ]
}

CORS

Add CORS

CHECK all error messages & errors

Transformer for stream PostData

Add transformer form stream

Implement nesting service

• nested structure from streams (navi)

Automatic DB Backup

CMS should create and store some client DB backups to restore old states.

Fix tags

Make tags work for l5 version with new tag model

HATEOS

Make it really HATEOS

Missing stream.

What happens if stream does not exists? (And if not exist but article_id is set)?

Is this correct behaviour?

Answer:

• Stream and Stream_record_id will be set to null by the transformer
• position will be set to 0 by the transformer

Relationships post data transformer

Needs some kind of method that checks if relationship objects from request are valid.

Client Cache

API sends object to client with all api calls that need to be refreshed

[
   '/pages/89234987234-234234-34234',
   '/pages/89234987234-234234-34234',
]

DO request via laravel or wget to creare cache.

Write docs

Start writing docs in wiki:

• Authentication
• Get Request
  • streams/index
  • streams/show/$name
  • pages/index
  • pages/show/$name
• Post Request
  • streams/store
  • pages/store
• Delete Request
  • streams/destroy
  • pages/destroy
• Update Request
  • streams/edit
  • pages/edit

check for ajax

If $request->ajax return other error message to if user browses the page

Decouple more from CMS structure?

Should all api endpoints be decoupled.

• remove restore of stream in update of page
• remove stream item creation in page creation

Improved error messages when parameter are wrong

e.g. if tags are not provided as array, but as string

Wrong sort parameters

Make api check if columns exist before sorting.

EloquentStreamRepository.php

        if( isset($parameters['sort']) && $parameters['sort'] != "false" )
        {
          $sortParams = [$parameters['sort']];
          if( $pos = strpos($sortParams[0],'],') )
          {
            $sortParams = [
              substr($sortParams[0], 0, $pos+1),
              substr($sortParams[0], $pos+2)
            ];
          }

PhpUnit test fails: Cannot modify header information

This is because headers are set in BaseApiController. This might be solved by #24

Try sql injections.

Add special tags (internal) which are normally not retrieved

• Split into 2 fields
  • published (boolean)
  • tags (internal = true) for custom stati

Transformer for pages

Extract db-data transformation from repository to transformers.

Fix Specs

Fix phpspecs for l5 version

Setup oAuth for API

Api should use oAuth for authentication.

http://alexbilbie.com/2013/02/securing-your-api-with-oauth-2/
https://github.com/thephpleague/oauth2-server

• client authentication with read only

Add phpunit tests

Laracast Incremental API videos 10 & 11.

• start basics and first test

DB Setup

• needs to create oAuth table or use different routes
• needs to create new tables an fetch from thoses

Testing

• pages/index
• pages/show
• pages/store
• pages/update
• pages/delete
• streams/index
• streams/show
• streams/store
• streams/update
• streams/delete

Refactor API Controller

API controller is pretty messy, refactor it

Refactor and update to Laravel 5

Refactor repositories, Controllers and all.

Naming

• rename repo methods to reflect if result is array or model

Pages

• pages/index
• pages/show
• pages/store
• pages/update
• pages/delete

Stream

• streams/index
• streams/show
• streams/store
• streams/update
• streams/delete

Reintroduce stuff like limit, etc.

• limit
• offset
• from
• until
• withTrashed

Allow for senden images

http://ryansechrest.com/2012/07/send-and-receive-binary-files-using-php-and-curl/

send HTTP request using PHP:

This is more like real web browser behavior as seen by another server:
You can use socket_connect(); and socket_write();, I will add more information about those later.

Extract responds to own method.

Extract the responds from BaseApiController to own method, so it can be used in requests as well.

multiple tests with imcomplete data

E.g. images can patch slug only, but if a link is provided everything needs to be updated

        "type" => "images",
        "attributes" => [
            "link" => "http://lorempixel.com/1511/1254/cats/?12207",
            'slug' => 'image-slug',
            'bytesize' => 122345,
            'width' => 300,
            'height' => 500,
        ]

Refactor merging of Stream & Page

Content is always returned in the following structure. Pages are nested inside the content object with the language as key.

stream_record_id: 1,
stream: 'news',
position: 3,
content:{
    de: {page-data...},
    en: {page-data...}
}

Tags

Tags should be added as a many to many relationship.

• read on pivot table
• add tags table
• connect tags to entries