Nik Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation:

   composer require amorebietakoudala/nik-bundle
   

   Register the bundle in config/bundles.php:

   return [
       // ...
       Amorebietakoudala\NikBundle\NikBundle::class => ['all' => true],
   ];
   

2. Configuration: Publish the default config:

   php bin/console config:dump-reference nik
   

   Override values in config/packages/nik.yaml:

   nik:
       api_key: '%env(NIK_API_KEY)%'
       base_uri: 'https://api.nik.example'
       debug: '%kernel.debug%'
   

3. First Use Case: Fetch a NIK response via a controller:

   use Amorebietakoudala\NikBundle\Service\NikClient;
   
   class NikController extends AbstractController
   {
       public function __construct(private NikClient $nikClient) {}
   
       public function getData(): Response
       {
           $response = $this->nikClient->get('/endpoint');
           return $this->json($response->getData());
       }
   }
   

Implementation Patterns

Core Workflows

1. API Integration:

   • Use NikClient for direct API calls:

     $this->nikClient->post('/users', ['name' => 'John']);
     $this->nikClient->put('/users/1', ['status' => 'active']);
     

   • Handle responses with getData() or getStatusCode().

2. Event-Driven Logic: Subscribe to NIK events (if supported):

   // config/services.yaml
   services:
       App\EventListener\NikEventListener:
           tags:
               - { name: 'kernel.event_listener', event: 'nik.response', method: 'onNikResponse' }
   

3. Translation & Localization: Use Symfony’s translation system for NIK-specific messages:

   # config/packages/nik.yaml
   nik:
       locales: ['es', 'en']
   

   $this->translator->trans('nik.error.invalid_request', [], 'nik');
   

4. Logging: Leverage Monolog for debugging:

   $this->nikClient->setLogger($this->container->get('logger'));
   

Integration Tips

• Dependency Injection: Prefer constructor injection for NikClient over service locator.
• Symfony Forms: Validate NIK responses with custom constraints:

  use Amorebietakoudala\NikBundle\Validator\Constraints\NikResponse;
  
  #[NikResponse()]
  private $nikData;
  

• Command-Line Tools: Create custom commands for bulk operations:

  use Symfony\Component\Console\Command\Command;
  use Amorebietakoudala\NikBundle\Service\NikClient;
  
  class SyncNikDataCommand extends Command
  {
      protected function execute(InputInterface $input, OutputInterface $output, NikClient $nikClient): int
      {
          $nikClient->syncAll();
          $output->writeln('Sync completed!');
          return Command::SUCCESS;
      }
  }
  

Gotchas and Tips

Common Pitfalls

1. API Key Management:

   • Ensure NIK_API_KEY is in .env never in code or Git.
   • Use Symfony’s %env(NIK_API_KEY)% in nik.yaml.

2. Debugging:

   • Enable debug mode in nik.yaml to log raw API responses:

     nik:
         debug: true
     

   • Check Monolog for errors (default channel: nik).

3. Rate Limiting:

   • The bundle may not handle retries. Implement a decorator:

     use Symfony\Component\HttpClient\RetryableHttpClient;
     
     $client = new RetryableHttpClient(
         $this->nikClient->getHttpClient(),
         [
             'max_retries' => 3,
             'delay' => 100,
             'statuses' => [429, 500, 503],
         ]
     );
     

4. Proprietary License:

   • Review the license terms before production use (e.g., audit logs, data export restrictions).

Extension Points

1. Custom Responses: Extend NikResponse class to add domain-specific logic:

   class CustomNikResponse extends \Amorebietakoudala\NikBundle\Response\NikResponse
   {
       public function isValid(): bool
       {
           return $this->getStatusCode() === 200 && $this->getData()['valid'] === true;
       }
   }
   

2. Middleware: Add preprocessing/POST-processing:

   # config/packages/nik.yaml
   nik:
       middleware:
           - App\Middleware\NikAuthMiddleware
           - App\Middleware\NikRateLimitMiddleware
   

3. Testing: Mock NikClient in PHPUnit:

   $this->createMock(NikClient::class)
       ->method('get')
       ->willReturn(new NikResponse(200, ['data' => 'mocked']));
   

4. Configuration Overrides: Dynamically override settings per environment:

   # config/packages/dev/nik.yaml
   nik:
       debug: true
       timeout: 60