1
0
mirror of https://github.com/LaCasemate/fab-manager.git synced 2024-12-15 00:24:09 +01:00
fab-manager/app/models/invoice.rb

226 lines
6.6 KiB
Ruby
Raw Normal View History

2019-03-13 16:49:03 +01:00
# frozen_string_literal: true
2021-05-27 15:58:55 +02:00
# Invoice correspond to a single purchase made by an user. This purchase is linked to one or many invoice_items
class Invoice < PaymentDocument
include NotificationAttachedObject
2016-03-23 18:39:41 +01:00
require 'fileutils'
scope :only_invoice, -> { where(type: nil) }
has_many :invoice_items, dependent: :destroy
accepts_nested_attributes_for :invoice_items
belongs_to :invoicing_profile
2019-06-11 10:02:48 +02:00
belongs_to :statistic_profile
belongs_to :wallet_transaction
2016-08-03 17:25:00 +02:00
belongs_to :coupon
2016-03-23 18:39:41 +01:00
2023-03-23 17:39:06 +01:00
has_one :chained_element, as: :element, dependent: :restrict_with_exception
2023-03-28 12:44:00 +02:00
has_one :avoir, class_name: 'Avoir', dependent: :destroy, inverse_of: :invoice
2023-03-16 17:17:00 +01:00
has_one :payment_schedule_item, dependent: :restrict_with_error
has_one :payment_gateway_object, as: :item, dependent: :destroy
2023-03-16 17:17:00 +01:00
has_one :order, dependent: :restrict_with_error
belongs_to :operator_profile, class_name: 'InvoicingProfile'
has_many :accounting_lines, dependent: :destroy
delegate :user, to: :invoicing_profile
2023-03-24 17:21:44 +01:00
delegate :footprint, to: :chained_element
2016-03-23 18:39:41 +01:00
before_create :add_environment
2023-03-24 17:21:44 +01:00
after_create :generate_order_number, :update_reference, :chain_record
after_update :log_changes
after_commit :generate_and_send_invoice, on: [:create], if: :persisted?
2016-03-23 18:39:41 +01:00
validates_with ClosedPeriodValidator
2016-03-23 18:39:41 +01:00
def file
2019-06-11 16:56:11 +02:00
dir = "invoices/#{invoicing_profile.id}"
dir = "test/fixtures/files/invoices/#{invoicing_profile.id}" if Rails.env.test?
2016-03-23 18:39:41 +01:00
2019-06-11 16:56:11 +02:00
# create directories if they doesn't exists (invoice & invoicing_profile_id)
2019-01-09 16:28:23 +01:00
FileUtils.mkdir_p dir
"#{dir}/#{filename}"
2016-03-29 18:02:40 +02:00
end
def filename
prefix = Setting.find_by(name: 'invoice_prefix').value_at(created_at)
prefix ||= if created_at < Setting.find_by(name: 'invoice_prefix').first_update
Setting.find_by(name: 'invoice_prefix').first_value
2020-06-15 10:58:15 +02:00
else
Setting.get('invoice_prefix')
2020-06-15 10:58:15 +02:00
end
"#{prefix}-#{id}_#{created_at.strftime('%d%m%Y')}.pdf"
2016-03-23 18:39:41 +01:00
end
2023-03-24 17:21:44 +01:00
def generate_order_number
self.order_number = order.reference and return unless order.nil? || order.reference.nil?
2023-03-16 17:17:00 +01:00
2023-03-24 17:21:44 +01:00
if !payment_schedule_item.nil? && !payment_schedule_item.first?
self.order_number = payment_schedule_item.payment_schedule.order_number
return
end
2023-03-16 17:17:00 +01:00
2023-03-24 17:21:44 +01:00
super
2016-03-23 18:39:41 +01:00
end
2019-02-13 12:59:28 +01:00
# for debug & used by rake task "fablab:maintenance:regenerate_invoices"
2016-03-23 18:39:41 +01:00
def regenerate_invoice_pdf
2023-02-24 17:26:55 +01:00
pdf = ::Pdf::Invoice.new(self).render
2016-03-23 18:39:41 +01:00
File.binwrite(file, pdf)
end
def build_avoir(attrs = {})
raise CannotRefundError if refunded? == true || prevent_refund?
2019-01-09 16:28:23 +01:00
avoir = Avoir.new(dup.attributes)
2016-03-23 18:39:41 +01:00
avoir.type = 'Avoir'
avoir.attributes = attrs
avoir.reference = nil
avoir.invoice_id = id
2023-03-16 17:17:00 +01:00
avoir.avoir_date = Time.current
2016-03-23 18:39:41 +01:00
avoir.total = 0
# refunds of invoices with cash coupons: we need to ventilate coupons on paid items
paid_items = 0
refund_items = 0
2016-03-23 18:39:41 +01:00
invoice_items.each do |ii|
2019-01-09 16:28:23 +01:00
paid_items += 1 unless ii.amount.zero?
next unless attrs[:invoice_items_ids].include? ii.id # list of items to refund (partial refunds)
raise StandardError if ii.invoice_item # cannot refund an item that was already refunded
2019-01-09 16:28:23 +01:00
refund_items += 1 unless ii.amount.zero?
avoir_ii = avoir.invoice_items.build(ii.dup.attributes)
avoir_ii.invoice_item_id = ii.id
avoir.total += avoir_ii.amount
2016-03-23 18:39:41 +01:00
end
2016-08-11 13:44:42 +02:00
# handle coupon
avoir.total = CouponService.apply_on_refund(avoir.total, avoir.coupon, paid_items, refund_items)
2016-03-23 18:39:41 +01:00
avoir
end
2019-01-09 16:28:23 +01:00
def subscription_invoice?
2016-03-23 18:39:41 +01:00
invoice_items.each do |ii|
2021-05-27 15:58:55 +02:00
return true if ii.object_type == 'Subscription'
2016-03-23 18:39:41 +01:00
end
false
end
##
# Test if the current invoice has been refund, totally or partially.
# @return {Boolean|'partial'}, true means fully refund, false means not refunded
##
2019-01-09 16:28:23 +01:00
def refunded?
2016-03-23 18:39:41 +01:00
if avoir
invoice_items.each do |item|
return 'partial' unless item.invoice_item
end
true
else
false
end
end
##
# Check if the current invoice is about a training that was previously validated for the concerned user.
# In that case refunding the invoice shouldn't be allowed.
2019-06-11 16:56:11 +02:00
# Moreover, an invoice cannot be refunded if the users' account was deleted
2016-03-23 18:39:41 +01:00
# @return {Boolean}
##
def prevent_refund?
2019-06-11 16:56:11 +02:00
return true if user.nil?
if main_item.nil?
Rails.logger.error "Invoice (id: #{id}) does not have a main_item and is probably in error"
return true
end
2021-05-27 15:58:55 +02:00
if main_item.object_type == 'Reservation' && main_item.object&.reservable_type == 'Training'
user.trainings.include?(main_item.object.reservable_id)
2016-03-23 18:39:41 +01:00
else
false
end
end
2021-05-27 15:58:55 +02:00
def main_item
2023-01-06 10:31:20 +01:00
main = invoice_items.where(main: true).first
if main.nil?
main = invoice_items.order(id: :asc).first
main&.update(main: true)
end
main
2021-05-27 15:58:55 +02:00
end
def other_items
invoice_items.where(main: [nil, false])
end
# get amount total paid
def amount_paid
2019-01-09 16:28:23 +01:00
total - (wallet_amount || 0)
end
# return a summary of the payment means used
def payment_means
res = []
2022-12-09 12:28:13 +01:00
res.push(means: :wallet, amount: wallet_amount) if paid_by_wallet?
if paid_by_card?
res.push(means: :card, amount: amount_paid)
else
res.push(means: :other, amount: amount_paid)
end
res
end
2022-12-09 12:28:13 +01:00
def payment_details(mean)
case mean
when :card
if paid_by_card?
{
payment_mean: mean,
gateway_object_id: payment_gateway_object&.gateway_object_id,
gateway_object_type: payment_gateway_object&.gateway_object_type
2022-12-09 12:28:13 +01:00
}
end
when :wallet
{ payment_mean: mean, wallet_transaction_id: wallet_transaction_id } if paid_by_wallet?
2022-12-09 12:28:13 +01:00
else
{ payment_mean: mean }
2022-12-09 12:28:13 +01:00
end
end
2021-04-16 16:03:10 +02:00
def footprint_children
invoice_items
2019-02-11 13:57:07 +01:00
end
def paid_by_card?
payment_method == 'card'
end
2022-12-09 12:28:13 +01:00
def paid_by_wallet?
wallet_transaction && wallet_amount.positive?
end
def render_resource
{ partial: 'api/invoices/invoice', locals: { invoice: self } }
end
private
2019-01-09 16:28:23 +01:00
2016-03-23 18:39:41 +01:00
def generate_and_send_invoice
return unless Setting.get('invoicing_module')
2017-02-13 14:38:28 +01:00
unless Rails.env.test?
Rails.logger.info "Creating an InvoiceWorker job to generate the following invoice: id(#{id}), " \
"main_item.object_id(#{main_item.object_id}), " \
"main_item.object_type(#{main_item.object_type}), user_id(#{invoicing_profile.user_id})"
2017-02-13 14:38:28 +01:00
end
InvoiceWorker.perform_async(id)
2016-03-23 18:39:41 +01:00
end
def log_changes
return if Rails.env.test?
return unless changed?
Rails.logger.warn "Invoice update triggered [ id: #{id}, reference: #{reference} ]\n" \
"---------- changes ----------#{changes}\n---------------------------------"
end
2016-03-23 18:39:41 +01:00
end