fab-manager/app/services/invoices_service.rb

# frozen_string_literal: true

# Provides methods for accessing Invoices resources and properties
class InvoicesService
  # return a paginated list of invoices, ordered by the given criterion and optionally filtered
  # @param order_key {string} any column from invoices or joined a table
  # @param direction {string} 'ASC' or 'DESC', linked to order_key
  # @param page {number} page number, used to paginate results
  # @param size {number} number of items per page
  # @param filters {Hash} allowed filters: number, customer, date.
  def self.list(order_key, direction, page, size, filters = {})
    invoices = Invoice.includes(:avoir, :operator_profile, :payment_gateway_object, invoicing_profile: [:user])
                      .joins(:invoicing_profile)
                      .order("#{order_key} #{direction}")
                      .page(page)
                      .per(size)

    if filters[:number].size.positive?
      invoices = invoices.where(
        'invoices.reference LIKE :search',
        search: "#{filters[:number]}%"
      )
    end
    if filters[:customer].size.positive?
      # ILIKE => PostgreSQL case-insensitive LIKE
      invoices = invoices.where(
        'invoicing_profiles.first_name ILIKE :search OR invoicing_profiles.last_name ILIKE :search',
        search: "%#{filters[:customer]}%"
      )
    end
    unless filters[:date].nil?
      start_at = Date.parse(filters[:date]).in_time_zone
      end_at = start_at.end_of_day
      invoices = invoices.where(created_at: (start_at..end_at))
    end

    invoices
  end

  # Parse the order_by clause provided by JS client from '-column' form to SQL compatible form
  # @param order_by {string} expected form: 'column' or '-column'
  def self.parse_order(order_by)
    direction = (order_by[0] == '-' ? 'DESC' : 'ASC')
    key = (order_by[0] == '-' ? order_by[1, order_by.size] : order_by)

    order_key = case key
                when 'reference'
                  'invoices.reference'
                when 'date'
                  'invoices.created_at'
                when 'total'
                  'invoices.total'
                when 'name'
                  'profiles.first_name'
                else
                  'invoices.id'
                end
    { direction: direction, order_key: order_key }
  end

  ##
  # Create an Invoice with an associated array of InvoiceItem matching the given parameters
  # @param payment_details {Hash} as generated by ShoppingCart.total
  # @param operator_profile_id {Number} ID of the user that operates the invoice generation (an admin, a manager or the customer himself)
  # @param objects {Array<Reservation|Subscription|StatisticProfilePrepaidPack>} the booked reservation and/or subscription or pack
  # @param user {User} the customer
  # @param payment_id {String} ID of the payment, a returned by the gateway, if the current invoice is paid by card
  # @param payment_method {String} the payment method used
  ##
  def self.create(payment_details, operator_profile_id, objects, user, payment_id: nil, payment_type: nil, payment_method: nil)
    operator = InvoicingProfile.find(operator_profile_id)&.user
    method = if payment_method
               payment_method
             else
               (operator&.admin? || operator&.manager?) && operator != user ? nil : 'card'
             end

    invoice = Invoice.new(
      invoicing_profile: user.invoicing_profile,
      statistic_profile: user.statistic_profile,
      operator_profile_id: operator_profile_id,
      payment_method: method
    )
    unless payment_id.nil?
      invoice.payment_gateway_object = PaymentGatewayObject.new(gateway_object_id: payment_id, gateway_object_type: payment_type)
    end

    InvoicesService.generate_invoice_items(invoice, payment_details, objects)
    InvoicesService.set_total_and_coupon(invoice, user, payment_details[:coupon])
    invoice
  end

  ##
  # Generate an array of {InvoiceItem} with the provided elements, price included.
  # @param invoice {Invoice} the parent invoice
  # @param payment_details {Hash} as generated by ShoppingCart.total
  # @param objects {Array<Reservation|Subscription|StatisticProfilePrepaidPack|OrderItem>}
  ##
  def self.generate_invoice_items(invoice, payment_details, objects)
    objects.each_with_index do |object, index|
      if object.is_a?(Reservation) && object.reservable.is_a?(Event)
        InvoicesService.generate_event_item(invoice, object, payment_details, main: index.zero?)
      elsif object.is_a?(Subscription)
        InvoicesService.generate_subscription_item(invoice, object, payment_details, main: index.zero?)
      elsif object.is_a?(Reservation)
        InvoicesService.generate_reservation_item(invoice, object, payment_details, main: index.zero?)
      elsif object.is_a?(StatisticProfilePrepaidPack)
        InvoicesService.generate_prepaid_pack_item(invoice, object, payment_details, main: index.zero?)
      elsif object.is_a?(OrderItem)
        InvoicesService.generate_order_item(invoice, object, payment_details, main: index.zero?)
      else
        InvoicesService.generate_generic_item(invoice, object, payment_details, main: index.zero?)
      end
    end
  end

  ##
  # Generate an InvoiceItem for each slot in the given reservation and save them in invoice.invoice_items.
  # This method must be called if reservation.reservable is an Event
  ##
  def self.generate_event_item(invoice, reservation, payment_details, main: false)
    raise TypeError unless reservation.reservable.is_a? Event

    reservation.slots_reservations.map(&:slot).each do |slot|
      description = "#{reservation.reservable.name}\n"
      description += if slot.start_at.to_date == slot.end_at.to_date
                       "#{I18n.l slot.start_at.to_date, format: :long} #{I18n.l slot.start_at, format: :hour_minute} " \
                         "- #{I18n.l slot.end_at, format: :hour_minute}"
                     else
                       "#{I18n.t('events.from_STARTDATE_to_ENDDATE',
                                 **{ STARTDATE: I18n.l(slot.start_at.to_date, format: :long),
                                     ENDDATE: I18n.l(slot.end_at.to_date, format: :long) })} " \
                         "#{I18n.t('events.from_STARTTIME_to_ENDTIME',
                                   **{ STARTTIME: I18n.l(slot.start_at, format: :hour_minute),
                                       ENDTIME: I18n.l(slot.end_at, format: :hour_minute) })}"
                     end

      price_slot = payment_details[:elements][:slots].detect { |p_slot| p_slot[:start_at].to_time.in_time_zone == slot[:start_at] }
      invoice.invoice_items.push InvoiceItem.new(
        amount: price_slot[:price],
        description: description,
        object: reservation,
        main: main
      )
    end
  end

  ##
  # Generate an InvoiceItem for each slot in the given reservation and save them in invoice.invoice_items.
  # This method must be called if reservation.reservable is a Space, a Machine or a Training
  ##
  def self.generate_reservation_item(invoice, reservation, payment_details, main: false)
    raise TypeError unless [Space, Machine, Training].include? reservation.reservable.class

    reservation.slots_reservations.map(&:slot).each do |slot|
      description = reservation.reservable.name +
                    " #{I18n.l slot.start_at, format: :long} - #{I18n.l slot.end_at, format: :hour_minute}"

      price_slot = payment_details[:elements][:slots].detect { |p_slot| p_slot[:start_at].to_time.in_time_zone == slot[:start_at] }
      invoice.invoice_items.push InvoiceItem.new(
        amount: price_slot[:price],
        description: description,
        object: reservation,
        main: main
      )
    end
  end

  ##
  # Generate an InvoiceItem for the given subscription and save it in invoice.invoice_items.
  # This method must be called only with a valid subscription
  ##
  def self.generate_subscription_item(invoice, subscription, payment_details, main: false)
    raise TypeError unless subscription

    invoice.invoice_items.push InvoiceItem.new(
      amount: payment_details[:elements][:plan],
      description: subscription.plan.base_name,
      object: subscription,
      main: main
    )
  end

  ##
  # Generate an InvoiceItem for the given StatisticProfilePrepaidPack and save it in invoice.invoice_items.
  # This method must be called only with a valid pack-statistic_profile relation
  ##
  def self.generate_prepaid_pack_item(invoice, pack, payment_details, main: false)
    raise TypeError unless pack

    invoice.invoice_items.push InvoiceItem.new(
      amount: payment_details[:elements][:pack],
      description: I18n.t('invoices.pack_item', **{ COUNT: pack.prepaid_pack.minutes / 60, ITEM: pack.prepaid_pack.priceable.name }),
      object: pack,
      main: main
    )
  end

  ##
  # Generate an InvoiceItem for given OrderItem and sva it in invoice.invoice_items
  # This method must be called whith an order
  ##
  def self.generate_order_item(invoice, item, _payment_details, main: false)
    raise TypeError unless item

    invoice.invoice_items.push InvoiceItem.new(
      amount: item.is_offered ? 0 : item.amount * item.quantity,
      description: "#{item.orderable.name} x #{item.quantity}",
      object: item,
      main: main
    )
  end

  def self.generate_generic_item(invoice, item, payment_details, main: false)
    invoice.invoice_items.push InvoiceItem.new(
      amount: payment_details[:elements][item.class.name.to_sym],
      description: item.class.name,
      object: item,
      main: main
    )
  end

  ##
  # Set the total price to the reservation's invoice, summing its whole items.
  # Additionally a coupon may be applied to this invoice to make a discount on the total price
  # @param invoice {Invoice} the invoice to fill
  # @param user {User} the customer
  # @param [coupon] {Coupon} optional coupon to apply to the invoice
  ##
  def self.set_total_and_coupon(invoice, user, coupon = nil)
    return unless invoice

    total = invoice.invoice_items.map(&:amount).map(&:to_i).reduce(:+)

    unless coupon.nil?
      total = CouponService.new.apply(total, coupon, user.id)
      invoice.coupon_id = coupon.id
    end

    invoice.total = total
  end
end