stacha-dev/tardis

PHP based backend for web applications.

API Service Stacha.dev

Instalation

1. Clone repository: git clone https://github.com/Stacha-dev/tardis.git && cd tardis
2. Run install script ./bin/install.sh <db_user> <db_password> <db_name>
3. Generate password for root user composer app:password <password>

Development

1. Update git pull develop to get recent commits
2. Install composer dependencies composer install
3. Load DB schema composer migrations:migrate and generate proxies composer orm:proxies
4. Create new branch by git checkout -b <branch-name> follow this convention:
   • Feature feat/<feature-name>
   • Bugfix fix/<bugfix-name>
   • Chore chore/<chore-name>
5. Commit changes to the remote branch
6. In case of feature add PHP Unit test suite
7. Create pull request into develop branch follow this convention
   • <type>(Scope): Description example: feat(User): Added user model

API

Endpoints: POSTMAN

Usefull Commands

App

composer app:password <password>    // Generates password

ORM

composer orm:create                 // Creates DB schema
composer orm:update                 // Updates DB schema
compsoer orm:drop                   // Drops DB schema

Migrations

composer migrations:diff            // Generates differences in DB schema
composer migrations:status          // Show migration status
composer migrations:migrate         // Migrate to latest migration
composert migrations:migrate:prev   // Migrate to previous migration

PHPStan

composer phpstan                    // Runs static analysis

Coding Standards

composer cs                         // Checks coding standarts
composer cs:fix                     // Fixes coding standarts

PHP Unit

composer test                       // Runs all unit tests
compsoer test:coverage              // Generates test coverage

tardis's Issues

Implement gallery tag

I would like to add tag to gallery. Tags should be simple strings like: carousel, press, ....

Add coveralls

Describe your feature request

Add coveralls to project https://coveralls.io/

Hash passwords in DB

Description

In this time, passwords are stored in DB without hashing. Which is hudge security issue. We need to save passwords as hashes. To do that, I suggest to has password in user model src/Model/Entity/User.php method setPassword. This method is called when new user is creating. Then there is login method in src/Controller/User.php where you need to compare hashes. I don't know much about hashing algorithms, so use whatever you want.
I think about sending passwords as hashes from client, but we are using https only, sou I think this is not necessary.

Login method

Username from request body
$username = $body->getBodyData('username') ?? $username;
Pass from request body
$password = $body->getBodyData('password') ?? $password;
Query with find one by username and password, now the password should be hashed
$user = $this->entityManager->getRepository('App\Model\Entity\User')->findOneBy(array("username" => $username, "password" => $password));

Investigate and implement realtime capability

Describe your feature request

It would be nice to subscribe server side events on client side. This could be used for realtime experince in client app. Technology used for this, can be websockets od server siede events (sse), in coop with doctrine events.

Register routes refactoring

Refactor register route. Remove regex string and search for improvements.
Current state:

tardis/src/Controller/Gallery.php

Lines 24 to 30 in f6d6cbc

	$router->register(RouteFactory::fromConstants(1, "GET", "@^(?<version>[0-9])/gallery$@", "getAll"))
	->register(RouteFactory::fromConstants(1, "GET", "@^(?<version>[0-9]+)/gallery/(?<id>[0-9]+)$@", "getOneById", array("id")))
	->register(RouteFactory::fromConstants(1, "GET", "@^(?<version>[0-9]+)/gallery/(?<alias>[a-z1-9-]+)$@", "getOneByAlias", array("alias")))
	->register(RouteFactory::fromConstants(1, "GET", "@^(?<version>[0-9]+)/gallery/find/(?<key>[a-z1-9-]+)/(?<value>[a-z1-9-]+)$@", "find", array("key", "value")))
	->register(RouteFactory::fromConstants(1, "POST", "@^(?<version>[0-9]+)/gallery$@", "create", array(), true))
	->register(RouteFactory::fromConstants(1, "PUT", "@^(?<version>[0-9]+)/gallery/(?<id>[0-9]+)$@", "edit", array("id"), true))
	->register(RouteFactory::fromConstants(1, "DELETE", "@^(?<version>[0-9]+)/gallery/(?<id>[0-9]+)$@", "delete", array("id"), true));

Add performance measurement

• Measure performance of API
• Visualize it

PHP8 refactoring

Implement PHP8 features. Enable JIT by default.

Implement article category

Fix image delete

• Delete original file
• Delete all assets

Add description to images db (in galleries)

Add description to images db (in galleries)

Implement image manipulation tool

• Resize
• WebP format
• Thumbnails

Implement gallery tag

I would like to add tag to gallery. Tags should be simple strings like: carousel, press, ....

Solve www redirect issue

When request is redirected with 301, the request become GET.

Custom exceptions

Check: https://github.com/nette/utils/blob/master/src/Utils/exceptions.php

Try implmement custom repostitories

Describe your feature request

We should use Doctrine custom repositories for often used queries, read more https://www.doctrine-project.org/projects/doctrine-orm/en/2.8/reference/working-with-objects.html#custom-repositories

Update gallery and image response

• Save webp and jpeg
• Add image type information
• Use getOneById method from Image in gallery
• See https://medium.com/@tirthbodawala/use-webp-images-along-with-other-fallback-sources-to-and-placeholder-to-get-max-image-optimization-4cf7bda8348c

Add possiblity to send e-mail

Expected Behavior

It is possible to send e-mail to one recipient without attachment. Sender will be provided by configuration.

Revision of code documentation

Describe your feature request

I find that some generated docs not right. We should get this right and maybe add some tags from https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html

Implement DB migrations

Describe your feature request
We should be able to generate db migrations to get compatybily between multiple versions of this project.

Describe the solution you'd like
We should implement Doctrine Migrations.

Update Postman endpoints

Description of the bug

Postman endpoints are obsolete, also there is some routes missing and naming is not clear.

Expected behavior

Up-to-date API endpoints.

Rename config file

Instead of tmpl use local.

Add general endpoints

Describe your feature request

See: https://betterprogramming.pub/22-best-practices-to-take-your-api-design-skills-to-the-next-level-65569b200b9

• /health
• /version
• /metrics
• ?/debug
• /status

Add gallery and image entity

• Gallery entity

• Image entity

Opravit problém s CORS při PUT a DELETE requestu.

Souvisí s předvojovým requestem OPTIONS, který nemá route a končí na 400.
Ideálně vytvořit třídu pro odesílání zpráv např Response::message("foo", 200), a přidat globální routu pro OPTIONS reqeusty.

Extend standard Exception class by response code.

Description

Generated exceptions are catche by src/Controller/App.php line 16. There I would like to get HTTP response code from exception object. It should be named like getHttpStatusCode without parametter. Response code should be provided in constructor, or by setter. Code should be in src/Lib/Exception/Exception.php and namespace App\Exception. Also create unit tests! Check your code by PHPStan and CS.

Links

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
• https://www.php.net/manual/en/language.exceptions.extending.php

List

• Extended class

• Pass PHPStan and CS

• Cover code by unit test and it should pass

Custom page

There should be one universal option for creating custom text pages. As I imagine it, it should contain:

• title (varchar => json)
• content (text => json)
• visibility (bool)
  This can be used various ways, when needed: special covid notices, post about relocation, etc. There should be also option to [add to menu] and link the page with a coresponding menu option.

Implement author to entities

Add author to created entities.

Oprava htaccessu, v URL se zobrazuje public.

Upravit .htaccess v rootu projektu aby se v url nezobrazoval public/

Solve move file issue

In this time, it is not possible to upload image bigger than 1MB.

Add PHP Unit section to README

Implement contact entity

Describe the solution you'd like
I would like to be able to create contact (person) with personal information. Also be able to edit and delete.

Add simple response method to view

Describe your feature request

After some actions where We don't need to response with data, there could be handy method witch basically render only some sort of standardized format like {"status": "ok"} or something like that. Sou the general workflow should looks like that:

action
$this->view->responseOk();
return

Method name is not definitely given, it can be differ. There could be another method with same purpose with inverse meaning.

PHPUnit failing to generate codecov

Add menu entity

Expected Behavior

User should create own menu.

Actual Behavior

There is no menu entity.

Implement product entity

Add posting time control

Any text content user posts should have time control - from when it starts to be public.

Example:
Create news and state it starts to be public immediately or in an hour or tomorrow etc.

Implement gallery tag

I would like to add tag to gallery. Tags should be simple strings like: carousel, press, ....

Implement JWT authorization

Add root user

• Install DB fixtures
• Add root user with random pass
• Secure create user endpoint

Add contributing guidelines

Describe your feature request
Add contributing guidelines according to https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors

Describe the solution you'd like
In project root should be CONTRIBUTING.md with brief contributing guidelines.

File upload and storage

Let's make simple api end points to upload, list, delete files. Focus on images aditionaly on pdfs.

• Upload

• Delete

• Helper class

• Unit tests

Solve routing with www

Imlement configuration helper

Add utit test to mail lib

Describe your feature request

Mail library should have own unit tests. You can avoid send method. Add test to Assert\Text too.