symfony-bundle client-server-communication

kglogowski/client-server-communication

Library to communication between client and server

Installation

1. Run command: composer require kglogowski/client-server-communication "@dev", _(*1)

2. Add to Kernel: ```php $bundles = [ ... new CSC\CSCBundle(), new JMS\SerializerBundle\JMSSerializerBundle(), new FOS\RestBundle\FOSRestBundle(), ];, _(*2)

3. Configure your config.yml, _(*3)

       fos_rest:
          routing_loader:
              default_format: json
              include_format: true
          param_fetcher_listener: force
          body_listener: true
          allowed_methods_listener: true
          view:
              view_response_listener: 'force'
              formats:
                  json: true
          exception:
              enabled: true
              exception_controller: 'csc.rest.controller.exception:showAction'
          format_listener:
              rules:
                  - { path: '^/', priorities: ['json'], fallback_format: json, prefer_extension: false }
          service:
              view_handler: fos_rest.view_handler.default
   

4. Configure route, _(*4)

   #Example pager
   admin.invoice.pager:
       path:     /invoices
       methods:  [GET]
       defaults:
           _controller: "InspectorBundle:Invoice:pager"
           entityName: 'InspectorBundle\Entity\Invoice\Invoice'
           methodName: 'listInvoice'
           availableFilter: ['partner','created_at','payment_deadline_at','sold_at','delivery_at']
           sortAvailable: ['partner','created_at','payment_deadline_at','sold_at','delivery_at']
   
   #Example post
   admin.invoice.post:
       path:     /invoices
       methods:  [POST]
       defaults:
           _controller: "InspectorBundle:Invoice:post"
           entityName: 'InspectorBundle\Entity\Invoice\Invoice'
           validation: ['Post']
           insertable: ['partner_id','campaigns','delivered_at','sold_at','description','name','vat','days_to_pay']
   
   #Example put
   admin.invoice.put:
       path:     /invoices/{id}
       methods:  [PUT]
       requirements:
           id: '\d+'
       defaults:
           _controller: "InspectorBundle:Invoice:put"
           entityName: 'InspectorBundle\Entity\Invoice\Invoice'
           validation: ['Put']
           updatable: ['delivered_at','sold_at','description','name','vat','days_to_pay']
   
   #Example custom processor
   admin.invoice.bulk-pay:
       path:     /invoices/bulk-pay
       methods:  [PUT]
       defaults:
           _controller: "InspectorBundle:Invoice:bulkPay"
           entityName: 'InspectorBundle\Entity\Invoice\Invoice'
           requestProcessor: 'InspectorBundle\Server\Processor\Request\InvoicePayProcessor' #Service
   

5. Configure security.yml:, _(*5)

   #Example
   security:
       encoders:
           AppBundle\Entity\User:
               id: csc.rest.security.encoder.password
   
       providers:
           user_token:
               entity:
                   class: AppBundle:User\User
                   property: login
           user:
               id: app.rest.security.provider.token_user
       firewalls:
           dev:
               pattern: ^/(_(profiler|wdt)|css|images|js)/
               security: false
   
           user_token:
               pattern: ^/v1/auth/token$
               provider: user_token
               guard:
                   authenticators:
                       - app.rest.security.authenticator.credential
           user:
               pattern: ^/v1(/|/auth/token/clear$)
               provider: user
               guard:
                   authenticators:
                       - app.rest.security.authenticator.token
                       - app.rest.security.authenticator.sso
                   entry_point: app.rest.security.authenticator.token
           main:
               pattern: ^/
               anonymous: ~
   

6. Authenticators, _(*6)

   //Example authenticators:
   class RestCredentialAuthenticator extends BaseAuthenticator
   {
       public function getAccessTokenClass(): string
       {
           return UserAccessToken::class;
       }
   }
   
   class TokenAuthenticator extends BaseAuthenticator
   {
       /**
        * @return string
        */
       public function getAccessTokenClass(): string
       {
           return UserAccessToken::class;
       }
   }
   

7. Provider, _(*7)

   class TokenUserProvider extends BaseProvider
   {
       public function loadUserByUsername($username)
       {
          //Implement own method from repository
       }
   
       public function supportsClass($class)
       {
           return User::class === $class;
       }
   }
   

8. Add monolog: yaml # Monolog monolog: channels: ['raw_request', 'raw_response', 'auth'] use_microseconds: true