Support for customer portals (#46)

* Support for customer portals

* wip

Author: driesvints

README.md

@@ -357,9 +357,25 @@ Attempting to use any of these will result in an exception being thrown.
 
 ## Customers
 
-### Updating Customers
+### Customer Portal
 
-Right now, it's not possible to update customer objects. Meaning, when they fill out their name, email address, city, region and country initially, there's no possibility of updating it later. To change these fields for a customer in Lemon Squeezy, you'll need to let your customer [contact Lemon Squeezy support](https://www.lemonsqueezy.com/help) so they can do it for you.
+Customers may easily manage their personal data like their name, email address, etc by visiting their [customer portal](https://docs.lemonsqueezy.com/guides/developer-guide/customer-portal). Lemon Squeezy for Laravel makes it easy to redirect customers to this by calling `redirectToCustomerPortal` on the billable:
+
+```php
+use Illuminate\Http\Request;
+ 
+Route::get('/customer-portal', function (Request $request) {
+    return $request->user()->redirectToCustomerPortal();
+});
+```
+
+In order to call this method your billable already needs to have a subscription or made a purchase through Lemon Squeezy. Also, this method will perform an underlying API call so make sure to place this redirect behind a route which you can link to in your app.
+
+Optionally, you also get the signed customer portal url directly:
+
+```php
+$url = $user->customerPortalUrl();
+```
 
 ## Subscriptions
 

src/Concerns/ManagesCustomer.php

@@ -3,7 +3,10 @@
 namespace LemonSqueezy\Laravel\Concerns;
 
 use Illuminate\Database\Eloquent\Relations\MorphOne;
+use Illuminate\Http\RedirectResponse;
 use LemonSqueezy\Laravel\Customer;
+use LemonSqueezy\Laravel\Exceptions\InvalidCustomer;
+use LemonSqueezy\Laravel\LemonSqueezy;
 
 trait ManagesCustomer
 {
@@ -64,4 +67,44 @@ public function lemonSqueezyTaxNumber(): ?string
     {
         return $this->tax_number ?? null; // 'GB123456789'
     }
+
+    /**
+     * Get the customer portal url for this billable.
+     */
+    public function customerPortalUrl(): string
+    {
+        $this->assertCustomerExists();
+
+        $response = LemonSqueezy::api('GET', "customers/{$this->lemon_squeezy_id}");
+
+        return $response['data']['attributes']['urls']['customer_portal'];
+    }
+
+    /**
+     * Generate a redirect response to the billable's customer portal.
+     */
+    public function redirectToCustomerPortal(): RedirectResponse
+    {
+        return new RedirectResponse($this->customerPortalUrl());
+    }
+
+    /**
+     * Determine if the billable has a Lemon Squeezy customer ID.
+     */
+    public function hasLemonSqueezyId(): bool
+    {
+        return ! is_null($this->lemon_squeezy_id);
+    }
+
+    /**
+     * Determine if the billable has a Lemon Squeezy customer ID and throw an exception if not.
+     *
+     * @throws InvalidCustomer
+     */
+    protected function assertCustomerExists(): void
+    {
+        if (! $this->hasLemonSqueezyId()) {
+            throw InvalidCustomer::notYetCreated($this);
+        }
+    }
 }

src/Exceptions/InvalidCustomer.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace LemonSqueezy\Laravel\Exceptions;
+
+use Exception;
+use Illuminate\Database\Eloquent\Model;
+
+class InvalidCustomer extends Exception
+{
+    public static function notYetCreated(Model $owner): static
+    {
+        return new static(class_basename($owner).' is not a Stripe customer yet. See the createAsStripeCustomer method.');
+    }
+}

tests/Feature/BillableTest.php

@@ -54,3 +54,23 @@
 
     (new User)->checkout('variant_123');
 });
+
+it('can generate a customer portal link for a billable', function () {
+    config()->set('lemon-squeezy.store', 'store_23432');
+
+    Http::fake([
+        'api.lemonsqueezy.com/v1/customers/1' => Http::response([
+            'data' => ['attributes' => ['urls' => [
+                'customer_portal' => 'https://my-store.lemonsqueezy.com/billing?expires=1666869343&signature=xxxxx',
+            ]]],
+        ]),
+    ]);
+
+    $user = new User;
+    $user->lemon_squeezy_id = 1;
+
+    $url = $user->customerPortalUrl();
+
+    expect($url)
+        ->toBe('https://my-store.lemonsqueezy.com/billing?expires=1666869343&signature=xxxxx');
+});