1
0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2024-11-11 05:32:39 +01:00
invoiceninja/app/Services/Subscription/SubscriptionService.php

268 lines
8.5 KiB
PHP
Raw Normal View History

2021-03-14 22:42:05 +01:00
<?php
/**
* Invoice Ninja (https://invoiceninja.com).
*
* @link https://github.com/invoiceninja/invoiceninja source repository
*
* @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
*
* @license https://opensource.org/licenses/AAL
*/
namespace App\Services\Subscription;
2021-03-14 22:42:05 +01:00
2021-03-17 03:21:06 +01:00
use App\DataMapper\InvoiceItem;
use App\Factory\InvoiceFactory;
2021-03-23 13:17:28 +01:00
use App\Factory\InvoiceToRecurringInvoiceFactory;
2021-03-21 06:35:09 +01:00
use App\Jobs\Util\SystemLogger;
use App\Models\Subscription;
use App\Models\ClientContact;
2021-03-15 21:35:19 +01:00
use App\Models\ClientSubscription;
2021-03-23 13:17:28 +01:00
use App\Models\Invoice;
2021-03-17 16:12:25 +01:00
use App\Models\PaymentHash;
2021-03-17 03:21:06 +01:00
use App\Models\Product;
2021-03-21 06:35:09 +01:00
use App\Models\SystemLog;
2021-03-17 03:21:06 +01:00
use App\Repositories\InvoiceRepository;
2021-03-22 21:09:42 +01:00
use App\Utils\Traits\CleanLineItems;
2021-03-21 06:35:09 +01:00
use App\Utils\Traits\MakesHash;
use GuzzleHttp\RequestOptions;
2021-03-15 21:35:19 +01:00
class SubscriptionService
2021-03-14 22:42:05 +01:00
{
2021-03-21 06:35:09 +01:00
use MakesHash;
2021-03-22 21:09:42 +01:00
use CleanLineItems;
2021-03-21 06:35:09 +01:00
/** @var subscription */
private $subscription;
2021-03-14 22:42:05 +01:00
/** @var client_subscription */
2021-03-21 06:35:09 +01:00
private $client_subscription;
public function __construct(Subscription $subscription)
2021-03-14 22:42:05 +01:00
{
$this->subscription = $subscription;
2021-03-14 22:42:05 +01:00
}
2021-03-18 01:53:08 +01:00
public function completePurchase(PaymentHash $payment_hash)
{
if (!property_exists($payment_hash->data, 'billing_context')) {
throw new \Exception("Illegal entrypoint into method, payload must contain billing context");
2021-03-18 10:57:55 +01:00
}
// At this point we have some state carried from the billing page
// to this, available as $payment_hash->data->billing_context. Make something awesome ⭐
2021-03-22 21:09:42 +01:00
// create client subscription record
2021-03-18 01:53:08 +01:00
//
// create recurring invoice if is_recurring
2021-03-22 21:09:42 +01:00
//
2021-03-18 01:53:08 +01:00
}
/**
'email' => $this->email ?? $this->contact->email,
'quantity' => $this->quantity,
'contact_id' => $this->contact->id,
*/
2021-03-18 01:53:08 +01:00
public function startTrial(array $data)
{
2021-03-22 21:09:42 +01:00
// Redirects from here work just fine. Livewire will respect it.
if(!$this->subscription->trial_enabled)
return new \Exception("Trials are disabled for this product");
$contact = ClientContact::with('client')->find($data['contact_id']);
$cs = new ClientSubscription();
$cs->subscription_id = $this->subscription->id;
$cs->company_id = $this->subscription->company_id;
$cs->trial_started = time();
$cs->trial_ends = time() + $this->subscription->trial_duration;
$cs->quantity = $data['quantity'];
$cs->client_id = $contact->client->id;
$cs->save();
$this->client_subscription = $cs;
//execute any webhooks
2021-03-23 13:17:28 +01:00
$this->triggerWebhook();
if(strlen($this->subscription->webhook_configuration->post_purchase_url) >=1)
return redirect($this->subscription->webhook_configuration->post_purchase_url);
2021-03-18 01:53:08 +01:00
return redirect('/client/subscription/'.$cs->hashed_id);
2021-03-18 01:53:08 +01:00
}
public function createInvoice($data): ?\App\Models\Invoice
2021-03-14 22:42:05 +01:00
{
2021-03-17 03:21:06 +01:00
$invoice_repo = new InvoiceRepository();
2021-03-22 21:09:42 +01:00
$data['line_items'] = $this->cleanItems($this->createLineItems($data));
2021-03-17 03:21:06 +01:00
return $invoice_repo->save($data, InvoiceFactory::create($this->subscription->company_id, $this->subscription->user_id));
2021-03-17 03:21:06 +01:00
}
2021-03-21 10:26:30 +01:00
/**
* Creates the required line items for the invoice
* for the billing subscription.
*/
2021-03-20 03:49:45 +01:00
private function createLineItems($data): array
2021-03-17 03:21:06 +01:00
{
2021-03-17 03:21:06 +01:00
$line_items = [];
$product = $this->subscription->product;
2021-03-17 03:21:06 +01:00
$item = new InvoiceItem;
2021-03-20 03:49:45 +01:00
$item->quantity = $data['quantity'];
2021-03-17 03:21:06 +01:00
$item->product_key = $product->product_key;
$item->notes = $product->notes;
$item->cost = $product->price;
2021-03-20 03:49:45 +01:00
$item->tax_rate1 = $product->tax_rate1 ?: 0;
$item->tax_name1 = $product->tax_name1 ?: '';
$item->tax_rate2 = $product->tax_rate2 ?: 0;
$item->tax_name2 = $product->tax_name2 ?: '';
$item->tax_rate3 = $product->tax_rate3 ?: 0;
$item->tax_name3 = $product->tax_name3 ?: '';
$item->custom_value1 = $product->custom_value1 ?: '';
$item->custom_value2 = $product->custom_value2 ?: '';
$item->custom_value3 = $product->custom_value3 ?: '';
$item->custom_value4 = $product->custom_value4 ?: '';
2021-03-17 03:21:06 +01:00
//$item->type_id need to switch whether the subscription is a service or product
$line_items[] = $item;
//do we have a promocode? enter this as a line item.
if(strlen($data['coupon']) >=1 && ($data['coupon'] == $this->subscription->promo_code) && $this->subscription->promo_discount > 0)
2021-03-20 03:57:03 +01:00
$line_items[] = $this->createPromoLine($data);
2021-03-17 03:21:06 +01:00
return $line_items;
2021-03-14 22:42:05 +01:00
}
2021-03-21 10:26:30 +01:00
/**
* If a coupon is entered (and is valid)
* then we apply the coupon discount with a line item.
*/
2021-03-20 03:49:45 +01:00
private function createPromoLine($data)
{
2021-03-20 03:57:03 +01:00
$product = $this->subscription->product;
2021-03-20 04:39:30 +01:00
$discounted_amount = 0;
$discount = 0;
$amount = $data['quantity'] * $product->cost;
2021-03-20 03:57:03 +01:00
if ($this->subscription->is_amount_discount == true) {
$discount = $this->subscription->promo_discount;
2021-03-20 04:39:30 +01:00
}
else {
$discount = round($amount * ($this->subscription->promo_discount / 100), 2);
2021-03-20 04:39:30 +01:00
}
$discounted_amount = $amount - $discount;
2021-03-20 03:49:45 +01:00
$item = new InvoiceItem;
2021-03-20 03:57:03 +01:00
$item->quantity = 1;
$item->product_key = ctrans('texts.promo_code');
$item->notes = ctrans('texts.promo_code');
2021-03-20 04:39:30 +01:00
$item->cost = $discounted_amount;
2021-03-20 03:57:03 +01:00
$item->tax_rate1 = $product->tax_rate1 ?: 0;
$item->tax_name1 = $product->tax_name1 ?: '';
$item->tax_rate2 = $product->tax_rate2 ?: 0;
$item->tax_name2 = $product->tax_name2 ?: '';
$item->tax_rate3 = $product->tax_rate3 ?: 0;
$item->tax_name3 = $product->tax_name3 ?: '';
return $item;
2021-03-20 03:49:45 +01:00
}
2021-03-21 10:26:30 +01:00
private function convertInvoiceToRecurring($payment_hash)
2021-03-15 21:35:19 +01:00
{
//The first invoice is a plain invoice - the second is fired on the recurring schedule.
2021-03-23 13:17:28 +01:00
$invoice = Invoice::find($payment_hash->billing_context->invoice_id);
if(!$invoice)
throw new \Exception("Could not match an invoice for payment of billing subscription");
2021-03-23 13:35:48 +01:00
//todo - need to remove the promo code - if it exists
2021-03-23 13:17:28 +01:00
return InvoiceToRecurringInvoiceFactory::create($invoice);
2021-03-15 21:35:19 +01:00
}
2021-03-21 10:26:30 +01:00
public function createClientSubscription($payment_hash)
2021-03-14 22:42:05 +01:00
{
2021-03-21 10:26:30 +01:00
//is this a recurring or one off subscription.
2021-03-15 21:35:19 +01:00
$cs = new ClientSubscription();
$cs->subscription_id = $this->subscription->id;
$cs->company_id = $this->subscription->company_id;
2021-03-15 21:35:19 +01:00
2021-03-23 13:17:28 +01:00
$cs->invoice_id = $payment_hash->billing_context->invoice_id;
$cs->client_id = $payment_hash->billing_context->client_id;
$cs->quantity = $payment_hash->billing_context->quantity;
2021-03-21 10:26:30 +01:00
//if is_recurring
//create recurring invoice from invoice
if($this->subscription->is_recurring)
2021-03-23 13:17:28 +01:00
{
2021-03-21 10:26:30 +01:00
$recurring_invoice = $this->convertInvoiceToRecurring($payment_hash);
$recurring_invoice->frequency_id = $this->subscription->frequency_id;
2021-03-21 10:26:30 +01:00
$recurring_invoice->next_send_date = $recurring_invoice->nextDateByFrequency(now()->format('Y-m-d'));
2021-03-23 13:17:28 +01:00
$recurring_invoice->save();
$cs->recurring_invoice_id = $recurring_invoice->id;
2021-03-21 10:26:30 +01:00
//?set the recurring invoice as active - set the date here also based on the frequency?
2021-03-23 13:17:28 +01:00
$recurring_invoice->service()->start();
}
2021-03-21 10:26:30 +01:00
2021-03-15 21:35:19 +01:00
$cs->save();
2021-03-21 06:35:09 +01:00
$this->client_subscription = $cs;
2021-03-14 22:42:05 +01:00
}
2021-03-23 13:17:28 +01:00
public function triggerWebhook()
2021-03-14 22:42:05 +01:00
{
//hit the webhook to after a successful onboarding
2021-03-23 13:17:28 +01:00
2021-03-21 06:35:09 +01:00
$body = [
'subscription' => $this->subscription,
2021-03-21 06:35:09 +01:00
'client_subscription' => $this->client_subscription,
2021-03-23 13:17:28 +01:00
'client' => $this->client_subscription->client->toArray(),
2021-03-21 06:35:09 +01:00
];
$client = new \GuzzleHttp\Client(['headers' => $this->subscription->webhook_configuration->post_purchase_headers]);
2021-03-21 06:35:09 +01:00
$response = $client->{$this->subscription->webhook_configuration->post_purchase_rest_method}($this->subscription->post_purchase_url,[
2021-03-21 06:35:09 +01:00
RequestOptions::JSON => ['body' => $body]
]);
SystemLogger::dispatch(
$body,
SystemLog::CATEGORY_WEBHOOK,
SystemLog::EVENT_WEBHOOK_RESPONSE,
SystemLog::TYPE_WEBHOOK_RESPONSE,
2021-03-23 13:17:28 +01:00
$this->client_subscription->client,
2021-03-21 06:35:09 +01:00
);
2021-03-14 22:42:05 +01:00
}
public function fireNotifications()
{
//scan for any notification we are required to send
}
2021-03-17 16:12:25 +01:00
2021-03-14 22:42:05 +01:00
}