openfoodnetwork/spec/models/spree/payment_method_spec.rb

# frozen_string_literal: true

class Spree::Gateway::Test < Spree::Gateway
end

RSpec.describe Spree::PaymentMethod do
  describe "validations" do
    subject { build(:payment_method) }

    it { is_expected.to have_many(:customer_account_transactions) }
    it { is_expected.to have_many(:payments) }
  end

  describe ".managed_by scope" do
    subject! { create(:payment_method) }
    let(:owner) { subject.distributors.first.owner }
    let(:other_user) { create(:user) }
    let(:admin) { create(:admin_user) }

    it "returns everything for admins" do
      expect(Spree::PaymentMethod.managed_by(admin)).to eq [subject]
    end

    it "returns payment methods of managed enterprises" do
      expect(Spree::PaymentMethod.managed_by(owner)).to eq [subject]
    end

    it "returns nothing for other users" do
      expect(Spree::PaymentMethod.managed_by(other_user)).to eq []
    end
  end

  describe "#available" do
    let(:enterprise) { create(:enterprise) }

    before do
      Spree::PaymentMethod.delete_all

      [nil, 'both', 'back_end'].each do |display_on|
        Spree::Gateway::Test.create(
          name: 'Display Both',
          display_on:,
          active: true,
          environment: 'test',
          description: 'foofah',
          distributors: [enterprise]
        )
      end
      expect(Spree::PaymentMethod.all.size).to eq 3
    end

    it "should return all methods available to front-end/back-end when no parameter is passed" do
      expect(Spree::PaymentMethod.available.size).to eq 2
    end

    it "should return all methods available to front-end/back-end when display_on = :both" do
      expect(Spree::PaymentMethod.available(:both).size).to eq 2
    end

    it "should return all methods available to back-end when display_on = :back_end" do
      expect(Spree::PaymentMethod.available(:back_end).size).to eq 2
    end
  end

  describe "#internal" do
    it "returns only internal payment method" do
      external = create(:payment_method)
      internal = create(:payment_method, internal: true)

      payment_methods = described_class.internal
      expect(payment_methods).to include(internal)
      expect(payment_methods).not_to include(external)
    end
  end

  describe "#customer_credit" do
    it "returns customer credit payment method" do
      # Creating an enterprise will create the needed internal payment method if needed
      enterprise = create(:enterprise)
      payment_method = Spree::PaymentMethod.unscoped.find_by(
        name: Rails.application.config.credit_payment_method[:name], internal: true
      )
      expect(enterprise.payment_methods.customer_credit).to eq(payment_method)
    end
  end

  describe "#configured?" do
    context "non-Stripe payment method" do
      let(:payment_method) { build(:payment_method) }

      it "returns true" do
        expect(payment_method).to be_configured
      end
    end

    context "Stripe payment method" do
      let(:payment_method) { create(:stripe_sca_payment_method) }

      before do
        allow(Spree::Config).to receive(:stripe_connect_enabled).and_return(true)
        allow(Stripe).to receive(:publishable_key) { "some_key" }
      end

      context "and Stripe Connect is enabled and a Stripe publishable key, account id, account
               owner are all present" do
        it "returns true" do
          expect(payment_method).to be_configured
        end
      end

      context "and Stripe Connect is disabled" do
        before { allow(Spree::Config).to receive(:stripe_connect_enabled).and_return(false) }

        it "returns false" do
          expect(payment_method).not_to be_configured
        end
      end

      context "and a Stripe publishable key is not present" do
        before { allow(Stripe).to receive(:publishable_key) { nil } }

        it "returns false" do
          expect(payment_method).not_to be_configured
        end
      end

      context "and a Stripe account owner is not present" do
        before { payment_method.preferred_enterprise_id = nil }

        it "returns false" do
          expect(payment_method).not_to be_configured
        end
      end

      context "and a Stripe account ID is not present" do
        before do
          StripeAccount.find_by(
            enterprise_id: payment_method.preferred_enterprise_id
          ).update_column(:stripe_user_id, nil)
        end

        it "returns false" do
          expect(payment_method).not_to be_configured
        end
      end
    end
  end

  it "orders payment methods by name" do
    pm1 = create(:payment_method, name: 'ZZ')
    pm2 = create(:payment_method, name: 'AA')
    pm3 = create(:payment_method, name: 'BB')

    expect(Spree::PaymentMethod.by_name).to eq([pm2, pm3, pm1])
  end

  it "raises errors when required fields are missing" do
    pm = Spree::PaymentMethod.new
    pm.save
    expect(pm.errors.to_a).to eq(["Name can't be blank", "At least one hub must be selected"])
  end

  it "computes the amount of fees" do
    order = create(:order)

    free_payment_method = create(:payment_method) # flat rate calculator with preferred_amount of 0
    expect(free_payment_method.compute_amount(order)).to eq 0

    flat_rate_payment_method = create(:payment_method,
                                      calculator: Calculator::FlatRate.new(preferred_amount: 10))
    expect(flat_rate_payment_method.compute_amount(order)).to eq 10

    flat_percent_payment_method = create(:payment_method,
                                         calculator: Calculator::FlatPercentItemTotal
                                           .new(preferred_flat_percent: 10))
    expect(flat_percent_payment_method.compute_amount(order)).to eq 0

    product = create(:product)
    order.contents.add(product.variants.first)
    expect(flat_percent_payment_method.compute_amount(order)).to eq 2.0
  end

  describe "scope" do
    describe "filtering to specified distributors" do
      let!(:distributor_a) { create(:distributor_enterprise) }
      let!(:distributor_b) { create(:distributor_enterprise) }
      let!(:distributor_c) { create(:distributor_enterprise) }

      let!(:payment_method_a) {
        create(:payment_method, distributors: [distributor_a, distributor_b])
      }
      let!(:payment_method_b) { create(:payment_method, distributors: [distributor_b]) }
      let!(:payment_method_c) { create(:payment_method, distributors: [distributor_c]) }

      it "includes only unique records under specified distributors" do
        result = described_class.for_distributors([distributor_a, distributor_b])
        expect(result.length).to eq(2)
        expect(result).to include(payment_method_a)
        expect(result).to include(payment_method_b)
      end
    end
  end

  describe "#display_name" do
    subject { build(:payment_method, name:) }

    let(:name) { "credit_payment_method.name" }

    it "translate the name" do
      expect(subject.display_name).to eq("Customer credit")
    end

    context "when not a tranlatable string" do
      let(:name) { "customer credit payment" }

      it "falls back to no translation" do
        expect(subject.display_name).to eq("customer credit payment")
      end
    end
  end

  describe "#display_description" do
    subject { build(:payment_method, description:) }

    let(:description) { "credit_payment_method.description" }

    it "translate the name" do
      expect(subject.display_description).to eq("Allow customer to pay with credit")
    end

    context "when not a tranlatable string" do
      let(:description) { "Payment method to allow customer to pay with credit" }

      it "falls back to no translation" do
        expect(subject.display_description).to eq(
          "Payment method to allow customer to pay with credit"
        )
      end
    end

    context "when description is empty" do
      let(:description) { "" }

      it "falls back to no translation" do
        expect(subject.display_description).to eq("")
      end
    end
  end
end