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

221 lines
6.5 KiB
Ruby
Raw Normal View History

2019-03-13 16:49:03 +01:00
# frozen_string_literal: true
require 'checksum'
2019-01-09 16:28:23 +01:00
# Invoice correspond to a single purchase made by an user. This purchase may
# include reservation(s) and/or a subscription
2020-03-25 10:16:47 +01:00
class Invoice < ApplicationRecord
2016-03-23 18:39:41 +01:00
include NotifyWith::NotificationAttachedObject
require 'fileutils'
scope :only_invoice, -> { where(type: nil) }
belongs_to :invoiced, polymorphic: true
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
belongs_to :subscription, foreign_type: 'Subscription', foreign_key: 'invoiced_id'
belongs_to :reservation, foreign_type: 'Reservation', foreign_key: 'invoiced_id'
belongs_to :offer_day, foreign_type: 'OfferDay', foreign_key: 'invoiced_id'
2016-03-23 18:39:41 +01:00
has_one :avoir, class_name: 'Invoice', foreign_key: :invoice_id, dependent: :destroy
belongs_to :operator_profile, foreign_key: :operator_profile_id, class_name: 'InvoicingProfile'
2016-03-23 18:39:41 +01:00
before_create :add_environment
2019-02-11 13:57:07 +01:00
after_create :update_reference, :chain_record
2019-01-09 16:28:23 +01:00
after_commit :generate_and_send_invoice, on: [:create], if: :persisted?
after_update :log_changes
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}"
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
2020-06-15 10:58:15 +02:00
prefix = Setting.find_by(name: 'invoice_prefix').history_values.order(created_at: :desc).where('created_at <= ?', created_at).limit(1).first
prefix ||= if created_at < Setting.find_by(name: 'invoice_prefix').history_values.order(created_at: :asc).limit(1).first.created_at
Setting.find_by(name: 'invoice_prefix').history_values.order(created_at: :asc).limit(1).first
else
Setting.find_by(name: 'invoice_prefix')..history_values.order(created_at: :desc).limit(1).first
end
"#{prefix.value}-#{id}_#{created_at.strftime('%d%m%Y')}.pdf"
2016-03-23 18:39:41 +01:00
end
def user
invoicing_profile.user
end
2016-03-23 18:39:41 +01:00
def generate_reference
self.reference = InvoiceReferenceService.generate_reference(self)
2016-03-23 18:39:41 +01:00
end
def update_reference
generate_reference
save
end
def order_number
InvoiceReferenceService.generate_order_number(self)
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
2019-06-11 16:56:11 +02:00
pdf = ::PDF::Invoice.new(self, subscription&.expiration_date).render
2016-03-23 18:39:41 +01:00
File.binwrite(file, pdf)
end
def build_avoir(attrs = {})
raise Exception 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
# override created_at to compute CA in stats
avoir.created_at = avoir.avoir_date
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 Exception if ii.invoice_item # cannot refund an item that was already refunded
refund_items += 1 unless ii.amount.zero?
avoir_ii = avoir.invoice_items.build(ii.dup.attributes)
avoir_ii.created_at = avoir.avoir_date
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
unless avoir.coupon_id.nil?
discount = avoir.total
if avoir.coupon.type == 'percent_off'
discount = avoir.total * avoir.coupon.percent_off / 100.0
elsif avoir.coupon.type == 'amount_off'
discount = (avoir.coupon.amount_off / paid_items) * refund_items
else
raise InvalidCouponError
end
2016-08-11 13:44:42 +02:00
avoir.total -= discount
end
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|
return true if ii.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?
2019-01-09 16:28:23 +01:00
if invoiced_type == 'Reservation' && invoiced.reservable_type == 'Training'
2016-03-23 18:39:41 +01:00
user.trainings.include?(invoiced.reservable_id)
else
false
end
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 = []
res.push(means: :wallet, amount: wallet_amount) if wallet_transaction && wallet_amount.positive?
if paid_with_stripe?
res.push(means: :card, amount: amount_paid)
else
res.push(means: :other, amount: amount_paid)
end
res
end
def add_environment
self.environment = Rails.env
end
2019-02-11 13:57:07 +01:00
def chain_record
2019-02-12 16:00:36 +01:00
self.footprint = compute_footprint
2019-03-11 13:49:16 +01:00
save!
2019-02-12 16:00:36 +01:00
end
2019-02-11 13:57:07 +01:00
2019-02-12 16:00:36 +01:00
def check_footprint
invoice_items.map(&:check_footprint).all? && footprint == compute_footprint
2019-02-11 13:57:07 +01:00
end
def set_wallet_transaction(amount, transaction_id)
raise InvalidFootprintError unless check_footprint
update_columns(wallet_amount: amount, wallet_transaction_id: transaction_id)
chain_record
end
def paid_with_stripe?
stp_payment_intent_id? || stp_invoice_id? || payment_method == 'stripe'
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?
2019-01-09 16:28:23 +01:00
puts "Creating an InvoiceWorker job to generate the following invoice: id(#{id}), invoiced_id(#{invoiced_id}), " \
"invoiced_type(#{invoiced_type}), user_id(#{invoicing_profile.user_id})"
2017-02-13 14:38:28 +01:00
end
InvoiceWorker.perform_async(id, user&.subscription&.expired_at)
2016-03-23 18:39:41 +01:00
end
2019-02-12 16:00:36 +01:00
def compute_footprint
2019-09-18 15:09:14 +02:00
FootprintService.compute_footprint(Invoice, self)
2019-02-12 16:00:36 +01:00
end
def log_changes
return if Rails.env.test?
return unless changed?
puts "WARNING: Invoice update triggered [ id: #{id}, reference: #{reference} ]"
puts '---------- changes ----------'
puts changes
puts '---------------------------------'
end
2016-03-23 18:39:41 +01:00
end