add billable_entity model

app/models/billing_entity.rb

@@ -0,0 +1,167 @@
+class BillingEntity < ApplicationRecord
+  include PaperTrailTraceable
+  include OrganizationTimezone
+  include Currencies
+
+  EMAIL_SETTINGS = [
+    "invoice.finalized",
+    "credit_note.created"
+  ].freeze
+
+  belongs_to :organization
+
+  has_many :customers
+  has_many :subscriptions, through: :customers
+  has_many :invoices
+  has_many :credit_notes, through: :invoices
+  has_many :fees, through: :subscriptions
+  has_many :daily_usages
+  has_many :integrations, class_name: "Integrations::BaseIntegration"
+  has_many :payment_providers, class_name: "PaymentProviders::BaseProvider"
+  has_many :payment_requests
+  has_and_belongs_to_many :taxes # many taxes belong to many entities?
+  has_many :wallets, through: :customers
+  has_many :wallet_transactions, through: :wallets
+  has_many :cached_aggregations
+  has_many :data_exports
+
+  has_many :stripe_payment_providers, class_name: 'PaymentProviders::StripeProvider'
+  has_many :gocardless_payment_providers, class_name: 'PaymentProviders::GocardlessProvider'
+  has_many :cashfree_payment_providers, class_name: 'PaymentProviders::CashfreeProvider'
+  has_many :adyen_payment_providers, class_name: 'PaymentProviders::AdyenProvider'
+
+  has_many :hubspot_integrations, class_name: "Integrations::HubspotIntegration"
+  has_many :netsuite_integrations, class_name: "Integrations::NetsuiteIntegration"
+  has_many :xero_integrations, class_name: "Integrations::XeroIntegration"
+  has_one :salesforce_integration, class_name: "Integrations::SalesforceIntegration"
+
+  # this one needs to be done via applied_dunning_campaign_id
+  has_one :applied_dunning_campaign
+
+  has_many :invoice_custom_section_selections
+  has_many :selected_invoice_custom_sections, through: :invoice_custom_section_selections, source: :invoice_custom_section
+
+  DOCUMENT_NUMBERINGS = [
+    :per_customer,
+    :per_organization
+  ].freeze
+
+  enum :document_numbering, DOCUMENT_NUMBERINGS
+
+  validates :country, country_code: true, unless: -> { country.nil? }
+  validates :default_currency, inclusion: {in: currency_list}
+  validates :document_locale, language_code: true
+  validates :email, email: true, if: :email?
+  validates :invoice_footer, length: {maximum: 600}
+  validates :document_number_prefix, length: {minimum: 1, maximum: 10}, on: :update
+  validates :invoice_grace_period, numericality: {greater_than_or_equal_to: 0}
+  validates :net_payment_term, numericality: {greater_than_or_equal_to: 0}
+  validates :logo,
+            image: {authorized_content_type: %w[image/png image/jpg image/jpeg], max_size: 800.kilobytes},
+            if: :logo?
+  validates :name, presence: true
+  validates :timezone, timezone: true
+  validates :finalize_zero_amount_invoice, inclusion: {in: [true, false]}
+
+  validate :validate_email_settings
+
+
+  def logo_url
+    return if logo.blank?
+
+    Rails.application.routes.url_helpers.rails_blob_url(logo, host: ENV["LAGO_API_URL"])
+  end
+
+  def base64_logo
+    return if logo.blank?
+
+    logo.blob.open do |tempfile|
+      data = tempfile.read
+      Base64.encode64(data)
+    end
+  end
+
+  def eu_vat_eligible?
+    country && LagoEuVat::Rate.new.countries_code.include?(country)
+  end
+
+  def payment_provider(provider)
+    case provider
+    when "stripe"
+      stripe_payment_provider
+    when "gocardless"
+      gocardless_payment_provider
+    when 'cashfree'
+      cashfree_payment_provider
+    when 'adyen'
+      adyen_payment_provider
+    end
+  end
+
+  def document_number_prefix=(value)
+    super(value&.upcase)
+  end
+
+  def reset_customers_last_dunning_campaign_attempt
+    customers
+      .falling_back_to_default_dunning_campaign
+      .update_all( # rubocop:disable Rails/SkipsModelValidations
+        last_dunning_campaign_attempt: 0,
+        last_dunning_campaign_attempt_at: nil
+      )
+  end
+
+  private
+
+  # NOTE: After creating an organization, default document_number_prefix needs to be generated.
+  # Example of expected format is ORG-4321
+  def generate_document_number_prefix
+    update!(document_number_prefix: "#{name.first(3).upcase}-#{id.last(4).upcase}")
+  end
+
+  def validate_email_settings
+    return if email_settings.all? { |v| EMAIL_SETTINGS.include?(v) }
+
+    errors.add(:email_settings, :unsupported_value)
+  end
+end
+
+# == Schema Information
+#
+# Table name: billing_entities
+#
+#  id                           :uuid             not null, primary key
+#  address_line1                :string
+#  address_line2                :string
+#  city                         :string
+#  country                      :string
+#  default_currency             :string           default("USD"), not null
+#  document_locale              :string           default("en"), not null
+#  document_number_prefix       :string
+#  document_numbering           :integer          not null
+#  email                        :string
+#  email_settings               :string           default([]), not null, is an Array
+#  eu_tax_management            :boolean          default(FALSE)
+#  finalize_zero_amount_invoice :boolean          default(TRUE), not null
+#  invoice_footer               :text
+#  invoice_grace_period         :integer          default(0), not null
+#  legal_name                   :string
+#  legal_number                 :string
+#  logo                         :string
+#  name                         :string           not null
+#  net_payment_term             :integer          default(0), not null
+#  state                        :string
+#  tax_identification_number    :string
+#  timezone                     :string           default("UTC"), not null
+#  vat_rate                     :float            default(0.0), not null
+#  zipcode                      :string
+#  created_at                   :datetime         not null
+#  updated_at                   :datetime         not null
+#  applied_dunning_campaign_id  :uuid
+#  organization_id              :uuid             not null
+#
+# Indexes
+#
+#  index_billing_entities_on_applied_dunning_campaign_id  (applied_dunning_campaign_id)
+#  index_billing_entities_on_organization_id              (organization_id)
+#

spec/factories/billing_entities.rb

@@ -0,0 +1,5 @@
+FactoryBot.define do
+  factory :billing_entity do
+
+  end
+end

spec/models/billing_entity_spec.rb

@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe BillingEntity, type: :model do
+  pending "add some examples to (or delete) #{__FILE__}"
+end