Pando Product Provider Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add the bundle via Composer:

   composer require blackboxcode/pando-product-provider-bundle
   

   Enable the bundle in config/bundles.php:

   BlackBoxCode\PandoProductProviderBundle\PandoProductProviderBundle::class => ['all' => true],
   

2. Configuration Publish the default config:

   php artisan vendor:publish --provider="BlackBoxCode\PandoProductProviderBundle\PandoProductProviderBundle" --tag="config"
   

   Update config/pando_product_provider.php with your Pando API credentials and endpoints.

3. First Use Case Fetch a product by ID in a controller:

   use BlackBoxCode\PandoProductProviderBundle\Service\PandoProductService;
   
   public function showProduct(PandoProductService $pandoService, $productId)
   {
       $product = $pandoService->getProduct($productId);
       return view('product.show', compact('product'));
   }
   

Implementation Patterns

Core Workflows

1. Product Data Fetching Use the PandoProductService to retrieve products, categories, or variants:

   // Get a single product
   $product = $pandoService->getProduct($id);
   
   // Get a list of products (with optional filters)
   $products = $pandoService->getProducts(['category' => 'electronics', 'limit' => 10]);
   

2. Integration with Laravel Models Extend a Laravel model (e.g., Product) to sync with Pando:

   class Product extends Model
   {
       public function syncWithPando()
       {
           $pandoData = app(PandoProductService::class)->getProduct($this->pando_id);
           $this->update($pandoData);
       }
   }
   

3. Event-Driven Updates Listen for Pando webhooks (if supported) to trigger model updates:

   // In EventServiceProvider
   protected $listen = [
       'BlackBoxCode\PandoProductProviderBundle\Events\PandoProductUpdated' => [
           ProductUpdatedListener::class,
       ],
   ];
   

4. Caching Strategies Cache responses to reduce API calls:

   $products = Cache::remember("pando_products_{$category}", now()->addHours(1), function () use ($pandoService, $category) {
       return $pandoService->getProducts(['category' => $category]);
   });
   

Advanced Patterns

1. Custom API Endpoints Extend the provider to support non-standard Pando endpoints:

   // Create a custom service
   class CustomPandoService extends PandoProductService
   {
       public function getCustomData($endpoint, $params = [])
       {
           return $this->client->get($endpoint, $params);
       }
   }
   

2. Bulk Operations Use chunking for large datasets:

   $pandoService->getProductsInBulk($category, 100, function ($products) {
       Product::insert($products);
   });
   

3. Localization Handling Map Pando’s localized fields to Laravel’s json columns:

   $product->localized_fields = $pandoService->getLocalizedFields($productId);
   $product->save();
   

Gotchas and Tips

Common Pitfalls

1. API Rate Limits

   • Pando may throttle requests. Implement exponential backoff in your service:

     try {
         return $this->client->get('/products');
     } catch (RateLimitException $e) {
         sleep($e->getRetryAfter());
         return $this->client->get('/products');
     }
     

2. Data Mismatches

   • Pando’s schema may differ from your Laravel models. Use a data mapper:

     $mappedProduct = (new PandoToLaravelMapper())->map($pandoData);
     

3. Webhook Verification

   • If using webhooks, validate signatures to prevent spoofing:

     if (!Hash::check($request->header('X-Signature'), $request->getContent())) {
         abort(403);
     }
     

4. Idempotency

   • Ensure bulk updates are idempotent to avoid duplicates:

     Product::upsert($pandoData, ['pando_id'], ['name', 'price']);
     

Debugging Tips

1. Enable API Logging Configure the HTTP client to log requests/responses:

   'pando' => [
       'logging' => true,
       'log_path' => storage_path('logs/pando.log'),
   ],
   

2. Mock the Service for Testing Use Laravel’s Mockery to isolate tests:

   $mock = Mockery::mock(PandoProductService::class);
   $mock->shouldReceive('getProduct')->andReturn($fakeProduct);
   

3. Handle Deprecated Endpoints

   • Check Pando’s API docs for deprecated routes and update your config accordingly.

Extension Points

1. Custom Providers Implement PandoProductProviderInterface for alternative data sources:

   class CustomPandoProvider implements PandoProductProviderInterface
   {
       public function getProduct($id)
       {
           // Custom logic
       }
   }
   

2. Event Dispatching Extend the bundle to dispatch events after sync operations:

   // In PandoProductService
   event(new ProductSynced($product));
   

3. Queue Background Jobs Offload heavy syncs to queues:

   SyncPandoProducts::dispatch($categoryId)->onQueue('pando');