sveneisenschmidt / yay Goto Github PK

To remove the need for a separate path for creating a player we need to add trailing slashes so symfony router can be match two http methods for the same path on the correct action.

Idea ist that rather than extending AchievementValidators we generate a ValidationContext that eases custom validators including the ExpressenValidator.

I imagine the following methods:

• hasAchievement
• getFilteredPersonalActions
• getPersonalActions

Plus extend the AchievementValidator next to supports with a boolean flag multiple that indicates an achievement can be granted multiple times.

• What activity / how many times?

Introduce a new webhook system that is able to process various payloads via processors. (Webhook Endpoint -> Processor(s) -> Engine)

• Separate webhook endpoint, the used processor is specified as a route parameter
• Processors are defined via a custom configuration but get transformed to services and registered via tags
• Processors are chainable
• Github Incomin Webhook Example
• Update documentation
• Document commands in a separate section
• add support for dummy as webhook type

To improve application performance and make the application production ready we need to move from the built-in php webserver to Nginx.

Due to security concerns the umask call in bin/console and public/index.php needs to be replaced.

• Do not create/purge database schema on every install
• Remove obsolete files from image
• Squash image
• Compress image
• Do not build unnecessary tags
• Build latest tag on stable
• Build branch tag on dev

• Migrate to new folder Struture
• Update bin/console
• Update public/index.php

Introduce a cover image that illustrates the simple gamification workflow.

• If an achievement can be granted multiple times it is not possible to achieve them in one request
• Personal achievement, even if multiple are only display as a single resource not array
• Personal statistics endpoint should show what achievement has been granted how many times -> #124

To ease development for project newcomers we need to add even more developer documentation. The documentation should cover the following points:

• Documentation on how to create custom integrations
• Documentation of tech stack

Yay entities are serialized and deserialzed in the ApiBundle. Different views/serialization groups are supported. Therefore all serializable entities need to be tested with their respective views.

• Remove docblocks
• Add return types
• Move annotations to configuration files
• replace @test annocations with test_prefix

• Upgrade to version 3
• Migrate docblocks to version 3 https://github.com/nelmio/NelmioApiDocBundle/blob/master/UPGRADE-3.0.md

See https://codecov.io/gh/sveneisenschmidt/yay/list/master/src/Yay, order by uncovered lines could descending.

• Create IntegrationBundle
• Move Install, Uninstall Commands to new Bundle
• Define new integration configuration format and transform it
• Use symfony configuration builder to validate integration confoguration file
• Test integration
• Update documentation
• Validate integration command
• Add tags to validators

All commands must have a documentation.

• Add mail catcher for local development
• Send mail when a new action is recorded
• Send mail when a new achievement is granted
• Send welcome mail when a new player is created

Goal is to provide container images that can be used instead if building your own.

• API endpoints should support filters
• API endpoints should support sorting
• API endpoints should support pagination

Use Criteria on collection level.

• Create github integration
• Add example script in dist/example/github

Empty results can not be returned:
http://yay-demo.sloppy.zone/api/players/jane.doe/personal-activities/

{
    exception: "Symfony\Component\Debug\Exception\FatalThrowableError",
    message: "Type error: Return value of Component\Entity\Player::getActivities() must implement interface Doctrine\Common\Collections\Collection, null returned"
}

• Upgrade to Symfony 3.4@beta including dependencies.
• Check deprecations and fix them.
• Check if third party bundles still working, update if necessary.

http://php.net/manual/de/migration71.new-features.php

• Nullable return types in Yay\Component\Entity

After every push the project needs to run against the tests via make test.

• StyleCI: Connect repository to StyleCI
• StyleCI: Fix reported issues
• Travis CI: Connect repository to Travis CI
• Travis CI: Make tests run against PHP 7.1, PHP 7.2 RC

• Unit test Yay\Component\Engine\Engine

Write unit test for src/Yay/Component/HttpFoundation/Request/ParamConverter/HeaderFieldConverter.php

Write unit test for src/Yay/Component/HttpFoundation/Request/ParamConverter/DeserializeFieldConverter.php is missing.

Extend ProgressController to support GET as a method to pass an action.

curl -X "GET" http://localhost:50080/api/progress/?player=jane.doe&action=demo-action

Add guide for hosting sveneisenshcmidt/yay-demo on sloppy.io, including all need services, test domain and APP_MODE.

• Case for chain processors scalar arguments to service names
• Validate arguments for static map so they always match the expected structure

Write unit test for src/Yay/Component/HttpFoundation/Request/ParamConverter/JsonFieldConverter is missing.

Write unit test for
src/Yay/Component/HttpFoundation/Request/ParamConverter/QueryStringConverter

Fix spelling issues in docs/installation.md

With #20 the engine now supports simple webhooks. The idea is to extend the documentation with a new chapter about (incoming & outgoing - not ready) webhooks. Examples for usage with systems like TravisCI or Github should be shown.

Check repository for obsolete files.

Move Apach2 document root to /data.

• Yay\Bundle\IntegrationBundle\Command\EnableCommand
• Yay\Bundle\IntegrationBundle\Command\DisableCommand
• Yay\Bundle\IntegrationBundle\Command\ValidateCommand
• Yay\Bundle\ApiBundle\Command\RecalculateCommand

• docs/configuration.md
• docs/integration.md
• README.md 

Based on the solution in #21 it will be possible to listen to internal events. Which these events a outgoing webhook could be executed and send payloads to third party systems.

• Update to new logo

• Exclude tests from code coverage
• Fix wrong Tests namespace

The build target calls the .application-build-docs target. The .application-build-docs target has a dependency on packages that are installed via install.

Solution:

• remove the .application-build-docs target from build
• add the .application-build-docs target to a new target build-docs

• Add events to engine
• log to database
• apply KISS
• Add Controller in API bundle to display events.

After a successful run on Travis CI on master branch a new container version shall be built with a dev tag.

When necessary environment variables are missing the blackfire container is not able to start and therefore all other images fail to run properly too.

The goal is to resolve this dependency somehow.

• Test src/Yay/Component/Engine/Storage/DoctrineStorage.php
• Test src/Yay/Component/Engine/StorageTrait.php

• Restructure documentation
• Add developer documentation #26
• Add command documentation #104
• Add custom documentation for API endpoints, filters, pagination and ordering

• Frontpage (Single page)

  • Quote
  • Usage (yml + curl)
  • Get support
  • License

• Getting Started

  • Requirements
  • Installation
  • Configuration
  • Usage / API
  • Examples

• Customisation

  • Integration with Third-Party-Services
  • Hosting
  • Templates

• Under the hood

  • Commands
  • Events
  • Webhook
  • Development

• Contributing