Added basic API endpoints (#258)

config/bundles.php

@@ -19,4 +19,7 @@ return [
     DAMA\DoctrineTestBundle\DAMADoctrineTestBundle::class => ['test' => true],
     KevinPapst\AdminLTEBundle\AdminLTEBundle::class => ['all' => true],
     FOS\UserBundle\FOSUserBundle::class => ['all' => true],
+    FOS\RestBundle\FOSRestBundle::class => ['all' => true],
+    Nelmio\ApiDocBundle\NelmioApiDocBundle::class => ['all' => true],
+    JMS\SerializerBundle\JMSSerializerBundle::class => ['all' => true],
 ];

config/packages/dev/jms_serializer.yaml

@@ -0,0 +1,7 @@
+jms_serializer:
+    visitors:
+        json:
+            options:
+                - JSON_PRETTY_PRINT
+                - JSON_UNESCAPED_SLASHES
+                - JSON_PRESERVE_ZERO_FRACTION

config/packages/fos_rest.yaml

@@ -0,0 +1,107 @@
+fos_rest:
+#    disable_csrf_role: ROLE_API
+#    access_denied_listener:
+#        enabled:              false
+#        service:              null
+#        formats:
+#            name:                 ~
+#    unauthorized_challenge:  null
+#    param_fetcher_listener:
+#        enabled:              false
+#        force:                false
+#        service:              null
+#    cache_dir:            '%kernel.cache_dir%/fos_rest'
+#    allowed_methods_listener:
+#        enabled:              false
+#        service:              null
+    routing_loader:
+        default_format: json
+        include_format: true
+#        prefix_methods:       true
+#    body_converter:
+#        enabled:              false
+#        validate:             false
+#        validation_errors_argument:  validationErrors
+#    service:
+#        router:               router
+#        templating:           templating
+#        serializer:           null
+#        view_handler:         fos_rest.view_handler.default
+#        inflector:            fos_rest.inflector.doctrine
+#        validator:            validator
+#    serializer:
+#        version:              null
+#        groups:               []
+#        serialize_null:       false
+    view:
+        default_engine:       twig
+#        force_redirects:
+#            name:                 ~
+#        mime_types:
+#            enabled:              false
+#            service:              null
+#            formats:
+#                name:                 ~
+#        formats:
+#            name:                 ~
+#        templating_formats:
+#            name:                 ~
+#        view_response_listener:
+#            enabled:              true
+#            force:                true
+#            service:              null
+        failed_validation:    400
+#        empty_content:        204
+#        serialize_null:       false
+#        jsonp_handler:
+#            callback_param:       callback
+#            mime_type:            application/javascript+jsonp
+    exception:
+        enabled:              true
+        exception_controller: 'fos_rest.exception.controller:showAction'
+#        service:              null
+        codes:
+#            'Symfony\Component\Routing\Exception\ResourceNotFoundException': 404
+#            'Doctrine\ORM\OptimisticLockException': HTTP_CONFLICT
+#            'Symfony\Component\HttpKernel\Exception\NotFoundHttpException': 400
+        messages:
+            'Symfony\Component\Routing\Exception\ResourceNotFoundException': true
+            'Symfony\Component\HttpKernel\Exception\NotFoundHttpException': true
+#    body_listener:
+#        enabled:              true
+#        service:              null
+#        default_format:       null
+#        throw_exception_on_unsupported_content_type:  false
+#        decoders:
+#            name:                 ~
+#        array_normalizer:
+#            service:              null
+#            forms:                false
+    format_listener:
+        enabled: true
+#        service:              null
+        rules:
+            - { path: ^/api, prefer_extension: true, fallback_format: json, priorities: [ json, xml ] }
+#            host:                 null     # URL host name
+#            methods:              null     # Method for URL
+#            stop:                 false
+#            attributes:           []
+#    versioning:
+#        enabled: false
+#        default_version: ~
+#        resolvers:
+#            query:
+#                enabled: true
+#                parameter_name: version
+#            custom_header:
+#                enabled: true
+#                header_name: X-Accept-Version
+#            media_type:
+#                enabled: true
+#                regex: /(v|version)=(?P<version>[0-9\.]+)/
+#        guessing_order:
+#            - query
+#            - custom_header
+#            - media_type
+    zone:
+        - { path: ^/api/* }

config/packages/jms_serializer.yaml

@@ -0,0 +1,12 @@
+jms_serializer:
+    visitors:
+        xml:
+            format_output: '%kernel.debug%'
+    metadata:
+        directories:
+            FOSUB:
+                namespace_prefix: "FOS\\UserBundle"
+                path: "%kernel.root_dir%/../config/serializer/FOS/UserBundle"
+            App:
+                namespace_prefix: "App"
+                path: "%kernel.root_dir%/../config/serializer/App"

config/packages/nelmio_api_doc.yaml

@@ -0,0 +1,27 @@
+nelmio_api_doc:
+    models:
+        use_jms: true
+    areas:
+        path_patterns:
+            - ^/api(?!/doc)
+    documentation:
+        #host: '{{hostname}}'
+        schemes: [http, https]
+        info:
+            title: Kimai 2 - API Docs
+            description: REST API description for the Kimai 2 time-tracking software
+            version: 0.1
+        securityDefinitions:
+            X-AUTH-USER:
+                type: apiKey
+                description: 'Value: {Username}'
+                name: X-AUTH-USER
+                in: header
+            X-AUTH-TOKEN:
+                type: apiKey
+                description: 'Value: {API Token}'
+                name: X-AUTH-TOKEN
+                in: header
+        security:
+            - X-AUTH-USER: []
+            - X-AUTH-TOKEN: []

config/packages/prod/jms_serializer.yaml

@@ -0,0 +1,6 @@
+jms_serializer:
+    visitors:
+        json:
+            options:
+                - JSON_UNESCAPED_SLASHES
+                - JSON_PRESERVE_ZERO_FRACTION

config/packages/security.yaml

@@ -2,7 +2,6 @@ security:
     encoders:
         App\Entity\User: bcrypt
 
-    # https://symfony.com/doc/current/book/security.html#where-do-users-come-from-user-providers
     providers:
         fos_userbundle:
             id: fos_user.user_provider.username_email
@@ -13,39 +12,28 @@ security:
             security: false
 
         secured_area:
-            # this firewall applies to all URLs
             pattern: ^/
-
-            # make sure only allowed users have access to their time-tracking
             user_checker: App\Security\UserChecker
+            anonymous: true
+            stateless: false
 
-            # but the firewall does not require login on every page
-            # denying access is done in access_control or in your controllers
-            anonymous: ~
+            guard:
+                authenticators:
+                    - App\Security\TokenAuthenticator
 
             remember_me:
                 secret:   '%kernel.secret%'
                 lifetime: 604800
                 path:     /
 
-            # This allows the user to login by submitting a username and password
-            # Reference: http://symfony.com/doc/current/cookbook/security/form_login_setup.html
             form_login:
-                # fos user bundle handles the form login
                 provider: fos_userbundle
-                # The route name that the login form submits to
                 check_path: fos_user_security_check
-                # The name of the route where the login form lives
-                # When the user tries to access a protected page, they are redirected here
                 login_path: fos_user_security_login
-                # Secure the login form against CSRF
-                # Reference: http://symfony.com/doc/current/cookbook/security/csrf_in_login_form.html
                 csrf_token_generator: security.csrf.token_manager
 
             logout:
-                # The route name the user can go to in order to logout
                 path: fos_user_security_logout
-                # The name of the route to redirect to after logging out
                 target: homepage
 
     role_hierarchy:
@@ -60,4 +48,4 @@ security:
         - { path: '^/(%app_locales%)/register', role: IS_AUTHENTICATED_ANONYMOUSLY }
         - { path: '^/(%app_locales%)/resetting', role: IS_AUTHENTICATED_ANONYMOUSLY }
         - { path: '^/(%app_locales%)/admin', roles: ROLE_ADMIN }
-
+        - { path: '^/api', roles: IS_AUTHENTICATED_REMEMBERED }

config/routes.yaml

@@ -11,15 +11,3 @@ homepage:
         _controller: Symfony\Bundle\FrameworkBundle\Controller\RedirectController::redirectAction
         route: timesheet
         permanent: true
-
-fos_user_security:
-    prefix: /{_locale}
-    resource: "@FOSUserBundle/Resources/config/routing/security.xml"
-
-fos_user_registration:
-    prefix: /{_locale}/register
-    resource: "@FOSUserBundle/Resources/config/routing/registration.xml"
-
-fos_user_resetting:
-    prefix: /{_locale}/resetting
-    resource: "@FOSUserBundle/Resources/config/routing/resetting.xml"

config/routes/annotations.yaml

@@ -5,4 +5,9 @@ controllers:
     requirements:
         _locale: '%app_locales%'
     defaults:
-        _locale: '%locale%'
+        _locale: '%locale%'
+
+app.api:
+    resource: '../src/API/'
+    type: rest
+    prefix: /api

config/routes/fos_user.yaml

@@ -0,0 +1,14 @@
+# Expose security related features like login and logout
+fos_user_security:
+    prefix: /{_locale}
+    resource: "@FOSUserBundle/Resources/config/routing/security.xml"
+
+# Expose the user registration feature
+fos_user_registration:
+    prefix: /{_locale}/register
+    resource: "@FOSUserBundle/Resources/config/routing/registration.xml"
+
+# Expose the users password-reset feature
+fos_user_resetting:
+    prefix: /{_locale}/resetting
+    resource: "@FOSUserBundle/Resources/config/routing/resetting.xml"

config/routes/nelmio_api_doc.yaml

@@ -0,0 +1,11 @@
+# Expose the Kimai API documentation as HTML
+app.swagger_ui:
+    path: /api/doc
+    methods: GET
+    defaults: { _controller: nelmio_api_doc.controller.swagger_ui }
+
+# Expose the Kimai API documentation as swagger compliant JSON
+app.swagger:
+    path: /api/doc.json
+    methods: GET
+    defaults: { _controller: nelmio_api_doc.controller.swagger }

config/serializer/App/Entity.Activity.yml

@@ -0,0 +1,18 @@
+App\Entity\Activity:
+    exclusion_policy: All
+    custom_accessor_order: [id, name, comment, visible, project_id]
+    properties:
+        id:
+            include: true
+        name:
+            include: true
+        comment:
+            include: true
+        visible:
+            include: true
+    virtual_properties:
+        getProjectId:
+            name: project_id
+            serialized_name: project_id
+            exp: "object.getProject() === null ? null : object.getProject().getId()"
+            type: integer

config/serializer/App/Entity.Customer.yml

@@ -0,0 +1,35 @@
+App\Entity\Customer:
+    exclusion_policy: All
+    properties:
+        id:
+            include: true
+        name:
+            include: true
+        number:
+            include: true
+        comment:
+            include: true
+        visible:
+            include: true
+        company:
+            include: true
+        contact:
+            include: true
+        address:
+            include: true
+        country:
+            include: true
+        currency:
+            include: true
+        phone:
+            include: true
+        fax:
+            include: true
+        mobile:
+            include: true
+        mail:
+            include: true
+        homepage:
+            include: true
+        timezone:
+            include: true

config/serializer/App/Entity.Project.yml

@@ -0,0 +1,22 @@
+App\Entity\Project:
+    exclusion_policy: All
+    custom_accessor_order: [id, name, comment, visible, budget, orderNumber, customer_id]
+    properties:
+        id:
+            include: true
+        name:
+            include: true
+        comment:
+            include: true
+        visible:
+            include: true
+        budget:
+            include: true
+        orderNumber:
+            include: true
+    virtual_properties:
+        getCustomerId:
+            name: customer_id
+            serialized_name: customer_id
+            exp: "object.getCustomer() === null ? null : object.getCustomer().getId()"
+            type: integer

config/serializer/App/Entity.User.yml

@@ -0,0 +1,11 @@
+App\Entity\User:
+    exclusion_policy: All
+    properties:
+        id:
+            include: true
+        alias:
+            include: true
+        title:
+            include: true
+        avatar:
+            include: true

config/serializer/FOS/UserBundle/Model.User.yml

@@ -0,0 +1,23 @@
+FOS\UserBundle\Model\User:
+    exclusion_policy: NONE
+    properties:
+        email:
+            exclude: true
+        emailCanonical:
+            exclude: true
+        usernameCanonical:
+            exclude: true
+        password:
+            exclude: true
+        plainPassword:
+            exclude: true
+        registeredAt:
+            exclude: true
+        lastLogin:
+            exclude: true
+        confirmationToken:
+            exclude: true
+        passwordRequestedAt:
+            exclude: true
+        salt:
+            exclude: true

config/services.yaml

@@ -104,3 +104,27 @@ services:
 
     App\Timesheet\Calculator\RateCalculator:
         arguments: ["%kimai.timesheet.rates%"]
+
+    # ================================================================================
+    # REPOSITORIES
+    # ================================================================================
+
+    App\Repository\UserRepository:
+        class:     Doctrine\ORM\EntityRepository
+        factory:   ['@doctrine.orm.entity_manager', getRepository]
+        arguments: ['App\Entity\User']
+
+    App\Repository\ActivityRepository:
+        class:     Doctrine\ORM\EntityRepository
+        factory:   ['@doctrine.orm.entity_manager', getRepository]
+        arguments: ['App\Entity\Activity']
+
+    App\Repository\ProjectRepository:
+        class:     Doctrine\ORM\EntityRepository
+        factory:   ['@doctrine.orm.entity_manager', getRepository]
+        arguments: ['App\Entity\Project']
+
+    App\Repository\CustomerRepository:
+        class:     Doctrine\ORM\EntityRepository
+        factory:   ['@doctrine.orm.entity_manager', getRepository]
+        arguments: ['App\Entity\Customer']

config/services_test.yaml

@@ -2,8 +2,4 @@ services:
     _defaults:
         public: true
 
-    # If you need to access services in a test, create an alias
-    # and then fetch that alias from the container. As a convention,
-    # aliases are prefixed with test. For example:
-    #
-    # test.App\Service\MyService: '@App\Service\MyService'
+    test.PasswordEncoder: "@security.encoder_factory"