Added webhook handler for gift subscription purchases

ghost/core/core/boot.js

@@ -334,6 +334,7 @@ async function initServices() {
     const slackNotifications = require('./server/services/slack-notifications');
     const mediaInliner = require('./server/services/media-inliner');
     const donationService = require('./server/services/donations');
+    const giftService = require('./server/services/gifts');
     const recommendationsService = require('./server/services/recommendations');
     const emailAddressService = require('./server/services/email-address');
     const statsService = require('./server/services/stats');
@@ -374,6 +375,7 @@ async function initServices() {
         slackNotifications.init(),
         mediaInliner.init(),
         donationService.init(),
+        giftService.init(),
         recommendationsService.init(),
         statsService.init(),
         explorePingService.init()

ghost/core/core/server/models/gift.js

@@ -0,0 +1,26 @@
+const errors = require('@tryghost/errors');
+const ghostBookshelf = require('./base');
+
+const Gift = ghostBookshelf.Model.extend({
+    tableName: 'gifts',
+
+    buyer() {
+        return this.belongsTo('Member', 'buyer_member_id', 'id');
+    },
+
+    redeemer() {
+        return this.belongsTo('Member', 'redeemer_member_id', 'id');
+    },
+
+    tier() {
+        return this.belongsTo('Product', 'tier_id', 'id');
+    }
+}, {
+    async destroy() {
+        throw new errors.IncorrectUsageError({message: 'Cannot destroy Gift'});
+    }
+});
+
+module.exports = {
+    Gift: ghostBookshelf.model('Gift', Gift)
+};

ghost/core/core/server/services/gifts/constants.ts

@@ -0,0 +1 @@
+export const GIFT_EXPIRY_DAYS = 365;

ghost/core/core/server/services/gifts/gift-bookshelf-repository.ts

@@ -0,0 +1,48 @@
+import {Gift} from './gift';
+
+type BookshelfModel<T> = {
+    add(data: Partial<T>, unfilteredOptions?: unknown): Promise<T>;
+    findOne(data: Record<string, unknown>, unfilteredOptions?: unknown): Promise<T | null>;
+};
+
+type GiftBookshelfModel = BookshelfModel<Record<string, unknown>>;
+
+export class GiftBookshelfRepository {
+    readonly #Model: GiftBookshelfModel;
+
+    constructor({GiftModel}: {GiftModel: GiftBookshelfModel}) {
+        this.#Model = GiftModel;
+    }
+
+    async existsByCheckoutSessionId(checkoutSessionId: string): Promise<boolean> {
+        const existing = await this.#Model.findOne({
+            stripe_checkout_session_id: checkoutSessionId
+        }, {require: false});
+
+        return !!existing;
+    }
+
+    async create(gift: Gift) {
+        await this.#Model.add({
+            token: gift.token,
+            buyer_email: gift.buyerEmail,
+            buyer_member_id: gift.buyerMemberId,
+            redeemer_member_id: gift.redeemerMemberId,
+            tier_id: gift.tierId,
+            cadence: gift.cadence,
+            duration: gift.duration,
+            currency: gift.currency,
+            amount: gift.amount,
+            stripe_checkout_session_id: gift.stripeCheckoutSessionId,
+            stripe_payment_intent_id: gift.stripePaymentIntentId,
+            consumes_at: gift.consumesAt,
+            expires_at: gift.expiresAt,
+            status: gift.status,
+            purchased_at: gift.purchasedAt,
+            redeemed_at: gift.redeemedAt,
+            consumed_at: gift.consumedAt,
+            expired_at: gift.expiredAt,
+            refunded_at: gift.refundedAt
+        });
+    }
+}

ghost/core/core/server/services/gifts/gift-service-wrapper.js

@@ -0,0 +1,27 @@
+class GiftServiceWrapper {
+    service;
+
+    async init() {
+        if (this.service) {
+            return;
+        }
+
+        const {Gift: GiftModel} = require('../../models');
+        const {GiftBookshelfRepository} = require('./gift-bookshelf-repository');
+        const {GiftService} = require('./gift-service');
+        const membersService = require('../members');
+
+        const repository = new GiftBookshelfRepository({
+            GiftModel
+        });
+
+        this.service = new GiftService({
+            giftRepository: repository,
+            get memberRepository() {
+                return membersService.api.members;
+            }
+        });
+    }
+}
+
+module.exports = GiftServiceWrapper;

ghost/core/core/server/services/gifts/gift-service.ts

@@ -0,0 +1,63 @@
+import errors from '@tryghost/errors';
+import {Gift} from './gift';
+import type {GiftBookshelfRepository} from './gift-bookshelf-repository';
+
+interface MemberRepository {
+    get(filter: Record<string, unknown>): Promise<{id: string} | null>;
+}
+
+interface GiftPurchaseData {
+    token: string;
+    buyerEmail: string;
+    stripeCustomerId: string | null;
+    tierId: string;
+    cadence: 'month' | 'year';
+    duration: string;
+    currency: string;
+    amount: number;
+    stripeCheckoutSessionId: string;
+    stripePaymentIntentId: string;
+}
+
+export class GiftService {
+    readonly #giftRepository: GiftBookshelfRepository;
+    readonly #memberRepository: MemberRepository;
+
+    constructor({giftRepository, memberRepository}: {giftRepository: GiftBookshelfRepository; memberRepository: MemberRepository}) {
+        this.#giftRepository = giftRepository;
+        this.#memberRepository = memberRepository;
+    }
+
+    async recordPurchase(data: GiftPurchaseData): Promise<boolean> {
+        const duration = Number.parseInt(data.duration);
+
+        if (Number.isNaN(duration)) {
+            throw new errors.ValidationError({message: `Invalid gift duration: ${data.duration}`});
+        }
+
+        if (await this.#giftRepository.existsByCheckoutSessionId(data.stripeCheckoutSessionId)) {
+            return false;
+        }
+
+        const member = data.stripeCustomerId
+            ? await this.#memberRepository.get({customer_id: data.stripeCustomerId})
+            : null;
+
+        const gift = Gift.fromPurchase({
+            token: data.token,
+            buyerEmail: data.buyerEmail,
+            buyerMemberId: member?.id ?? null,
+            tierId: data.tierId,
+            cadence: data.cadence,
+            duration,
+            currency: data.currency,
+            amount: data.amount,
+            stripeCheckoutSessionId: data.stripeCheckoutSessionId,
+            stripePaymentIntentId: data.stripePaymentIntentId
+        });
+
+        await this.#giftRepository.create(gift);
+
+        return true;
+    }
+}

ghost/core/core/server/services/gifts/gift.ts

@@ -0,0 +1,103 @@
+import {GIFT_EXPIRY_DAYS} from './constants';
+
+type GiftStatus = 'purchased' | 'redeemed' | 'consumed' | 'expired' | 'refunded';
+type GiftCadence = 'month' | 'year';
+
+interface GiftData {
+    token: string;
+    buyerEmail: string;
+    buyerMemberId: string | null;
+    redeemerMemberId: string | null;
+    tierId: string;
+    cadence: GiftCadence;
+    duration: number;
+    currency: string;
+    amount: number;
+    stripeCheckoutSessionId: string;
+    stripePaymentIntentId: string;
+    consumesAt: Date | null;
+    expiresAt: Date | null;
+    status: GiftStatus;
+    purchasedAt: Date;
+    redeemedAt: Date | null;
+    consumedAt: Date | null;
+    expiredAt: Date | null;
+    refundedAt: Date | null;
+}
+
+interface GiftPurchaseData {
+    token: string;
+    buyerEmail: string;
+    buyerMemberId: string | null;
+    tierId: string;
+    cadence: GiftCadence;
+    duration: number;
+    currency: string;
+    amount: number;
+    stripeCheckoutSessionId: string;
+    stripePaymentIntentId: string;
+}
+
+export class Gift {
+    token: string;
+    buyerEmail: string;
+    buyerMemberId: string | null;
+    redeemerMemberId: string | null;
+    tierId: string;
+    cadence: GiftCadence;
+    duration: number;
+    currency: string;
+    amount: number;
+    stripeCheckoutSessionId: string;
+    stripePaymentIntentId: string;
+    consumesAt: Date | null;
+    expiresAt: Date | null;
+    status: GiftStatus;
+    purchasedAt: Date;
+    redeemedAt: Date | null;
+    consumedAt: Date | null;
+    expiredAt: Date | null;
+    refundedAt: Date | null;
+
+    constructor(data: GiftData) {
+        this.token = data.token;
+        this.buyerEmail = data.buyerEmail;
+        this.buyerMemberId = data.buyerMemberId;
+        this.redeemerMemberId = data.redeemerMemberId;
+        this.tierId = data.tierId;
+        this.cadence = data.cadence;
+        this.duration = data.duration;
+        this.currency = data.currency;
+        this.amount = data.amount;
+        this.stripeCheckoutSessionId = data.stripeCheckoutSessionId;
+        this.stripePaymentIntentId = data.stripePaymentIntentId;
+        this.consumesAt = data.consumesAt;
+        this.expiresAt = data.expiresAt;
+        this.status = data.status;
+        this.purchasedAt = data.purchasedAt;
+        this.redeemedAt = data.redeemedAt;
+        this.consumedAt = data.consumedAt;
+        this.expiredAt = data.expiredAt;
+        this.refundedAt = data.refundedAt;
+    }
+
+    static fromPurchase(data: GiftPurchaseData) {
+        const now = new Date();
+        const expiresAt = new Date(now);
+
+        expiresAt.setDate(expiresAt.getDate() + GIFT_EXPIRY_DAYS);
+
+        return new Gift({
+            ...data,
+            redeemerMemberId: null,
+            consumesAt: null,
+            expiresAt,
+            status: 'purchased',
+            purchasedAt: now,
+            redeemedAt: null,
+            consumedAt: null,
+            expiredAt: null,
+            refundedAt: null
+        });
+    }
+}

ghost/core/core/server/services/gifts/index.js

@@ -0,0 +1,3 @@
+const GiftServiceWrapper = require('./gift-service-wrapper');
+
+module.exports = new GiftServiceWrapper();

ghost/core/core/server/services/stripe/service.js

@@ -10,6 +10,7 @@ const models = require('../../models');
 const {getConfig} = require('./config');
 const settingsHelpers = require('../settings-helpers');
 const donationService = require('../donations');
+const giftService = require('../gifts');
 const staffService = require('../staff');
 const labs = require('../../../shared/labs');
 const settingsCache = require('../../../shared/settings-cache');
@@ -60,6 +61,7 @@ module.exports = new StripeService({
         }
     },
     donationService,
+    giftService,
     staffService,
     settingsCache
 });

ghost/core/core/server/services/stripe/services/webhook/checkout-session-event-service.js

@@ -14,6 +14,7 @@ const {
  * It is triggered for the following scenarios:
  * - Subscription
  * - Donation
+ * - Gift purchase
  * - Setup intent
  *
  * This service delegates the event to the appropriate handler based on the session mode and metadata.
@@ -26,6 +27,7 @@ module.exports = class CheckoutSessionEventService {
      * @param {import('../../stripe-api')} deps.api
      * @param {object} deps.memberRepository
      * @param {object} deps.donationRepository
+     * @param {object} deps.giftService
      * @param {object} deps.staffServiceEmails
      * @param {function} deps.sendSignupEmail
      * @param {function} deps.isPaidWelcomeEmailActive
@@ -51,9 +53,31 @@ module.exports = class CheckoutSessionEventService {
 
         if (session.mode === 'payment' && session.metadata?.ghost_donation) {
             await this.handleDonationEvent(session);
+        } else if (session.mode === 'payment' && session.metadata?.ghost_gift) {
+            await this.handleGiftEvent(session);
         }
     }
 
+    /**
+     * Handles a `checkout.session.completed` event for a gift subscription purchase
+     *
+     * @param {import('stripe').Stripe.Checkout.Session} session
+     */
+    async handleGiftEvent(session) {
+        await this.deps.giftService.recordPurchase({
+            token: session.metadata?.gift_token,
+            buyerEmail: session.metadata?.purchaser_email,
+            stripeCustomerId: session.customer ?? null,
+            tierId: session.metadata?.tier_id,
+            cadence: session.metadata?.cadence,
+            duration: session.metadata?.duration,
+            currency: session.currency,
+            amount: session.amount_total,
+            stripeCheckoutSessionId: session.id,
+            stripePaymentIntentId: session.payment_intent
+        });
+    }
+
     /**
      * Handles a `checkout.session.completed` event for a donation
      * @param {import('stripe').Stripe.Checkout.Session} session

ghost/core/core/server/services/stripe/stripe-service.js

@@ -37,6 +37,7 @@ module.exports = class StripeService {
      * @param {*} deps.labs
      * @param {*} deps.membersService
      * @param {*} deps.donationService
+     * @param {*} deps.giftService
      * @param {*} deps.staffService
      * @param {import('./webhook-manager').StripeWebhook} deps.StripeWebhook
      * @param {object} deps.settingsCache
@@ -53,6 +54,7 @@ module.exports = class StripeService {
         labs,
         membersService,
         donationService,
+        giftService,
         staffService,
         StripeWebhook,
         settingsCache,
@@ -110,6 +112,9 @@ module.exports = class StripeService {
             get donationRepository(){
                 return donationService.repository;
             },
+            get giftService(){
+                return giftService.service;
+            },
             get staffServiceEmails(){
                 return staffService.api.emails;
             },