feat: Allow SaaS users to manage subscription within the dashboard (#5059)

spec/enterprise/controllers/enterprise/api/v1/accounts_controller_spec.rb

@@ -0,0 +1,102 @@
+require 'rails_helper'
+
+RSpec.describe 'Enterprise Billing APIs', type: :request do
+  let(:account) { create(:account) }
+  let(:admin) { create(:user, account: account, role: :administrator) }
+  let(:agent) { create(:user, account: account, role: :agent) }
+
+  describe 'POST /enterprise/api/v1/accounts/{account.id}/subscription' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        post "/enterprise/api/v1/accounts/#{account.id}/subscription", as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user' do
+      context 'when it is an agent' do
+        it 'returns unauthorized' do
+          post "/enterprise/api/v1/accounts/#{account.id}/subscription",
+               headers: agent.create_new_auth_token,
+               as: :json
+
+          expect(response).to have_http_status(:unauthorized)
+        end
+      end
+
+      context 'when it is an admin' do
+        it 'enqueues a job' do
+          expect do
+            post "/enterprise/api/v1/accounts/#{account.id}/subscription",
+                 headers: admin.create_new_auth_token,
+                 as: :json
+          end.to have_enqueued_job(Enterprise::CreateStripeCustomerJob).with(account)
+        end
+
+        it 'does not enqueues a job if customer id is present' do
+          account.update!(custom_attributes: { 'stripe_customer_id': 'cus_random_string' })
+
+          expect do
+            post "/enterprise/api/v1/accounts/#{account.id}/subscription",
+                 headers: admin.create_new_auth_token,
+                 as: :json
+          end.not_to have_enqueued_job(Enterprise::CreateStripeCustomerJob).with(account)
+        end
+      end
+    end
+  end
+
+  describe 'POST /enterprise/api/v1/accounts/{account.id}/checkout' do
+    context 'when it is an unauthenticated user' do
+      it 'returns unauthorized' do
+        post "/enterprise/api/v1/accounts/#{account.id}/checkout", as: :json
+
+        expect(response).to have_http_status(:unauthorized)
+      end
+    end
+
+    context 'when it is an authenticated user' do
+      context 'when it is an agent' do
+        it 'returns unauthorized' do
+          post "/enterprise/api/v1/accounts/#{account.id}/checkout",
+               headers: agent.create_new_auth_token,
+               as: :json
+
+          expect(response).to have_http_status(:unauthorized)
+        end
+      end
+
+      context 'when it is an admin and the stripe customer id is not present' do
+        it 'returns error' do
+          post "/enterprise/api/v1/accounts/#{account.id}/checkout",
+               headers: admin.create_new_auth_token,
+               as: :json
+
+          expect(response).to have_http_status(:unprocessable_entity)
+          json_response = JSON.parse(response.body)
+          expect(json_response['error']).to eq('Please subscribe to a plan before viewing the billing details')
+        end
+      end
+
+      context 'when it is an admin and the stripe customer is present' do
+        it 'calls create session' do
+          account.update!(custom_attributes: { 'stripe_customer_id': 'cus_random_string' })
+
+          create_session_service = double
+          allow(Enterprise::Billing::CreateSessionService).to receive(:new).and_return(create_session_service)
+          allow(create_session_service).to receive(:create_session).and_return(create_session_service)
+          allow(create_session_service).to receive(:url).and_return('https://billing.stripe.com/random_string')
+
+          post "/enterprise/api/v1/accounts/#{account.id}/checkout",
+               headers: admin.create_new_auth_token,
+               as: :json
+
+          expect(response).to have_http_status(:success)
+          json_response = JSON.parse(response.body)
+          expect(json_response['redirect_url']).to eq('https://billing.stripe.com/random_string')
+        end
+      end
+    end
+  end
+end

spec/enterprise/jobs/enterprise/create_stripe_customer_job_spec.rb

@@ -0,0 +1,27 @@
+require 'rails_helper'
+
+RSpec.describe Enterprise::CreateStripeCustomerJob, type: :job do
+  include ActiveJob::TestHelper
+  subject(:job) { described_class.perform_later(account) }
+
+  let(:account) { create(:account) }
+
+  it 'queues the job' do
+    expect { job }.to have_enqueued_job(described_class)
+      .with(account)
+      .on_queue('default')
+  end
+
+  it 'executes perform' do
+    create_stripe_customer_service = double
+    allow(Enterprise::Billing::CreateStripeCustomerService)
+      .to receive(:new)
+      .with(account: account)
+      .and_return(create_stripe_customer_service)
+    allow(create_stripe_customer_service).to receive(:perform)
+
+    perform_enqueued_jobs { job }
+
+    expect(Enterprise::Billing::CreateStripeCustomerService).to have_received(:new).with(account: account)
+  end
+end

spec/enterprise/models/account_spec.rb

@@ -28,5 +28,15 @@ RSpec.describe Account do
         }
       )
     end
+
+    it 'returns limits based on subscription' do
+      account.update(limits: { agents: 10 }, custom_attributes: { subscribed_quantity: 5 })
+      expect(account.usage_limits).to eq(
+        {
+          agents: 5,
+          inboxes: ChatwootApp.max_limit
+        }
+      )
+    end
   end
 end

spec/enterprise/services/enterprise/billing/create_session_service_spec.rb

@@ -0,0 +1,22 @@
+require 'rails_helper'
+
+describe Enterprise::Billing::CreateSessionService do
+  subject(:create_session_service) { described_class }
+
+  describe '#perform' do
+    it 'calls stripe billing portal session' do
+      customer_id = 'cus_random_number'
+      return_url = 'https://www.chatwoot.com'
+      allow(Stripe::BillingPortal::Session).to receive(:create).with({ customer: customer_id, return_url: return_url })
+
+      create_session_service.new.create_session(customer_id, return_url)
+
+      expect(Stripe::BillingPortal::Session).to have_received(:create).with(
+        {
+          customer: customer_id,
+          return_url: return_url
+        }
+      )
+    end
+  end
+end

spec/enterprise/services/enterprise/billing/create_stripe_customer_service_spec.rb

@@ -0,0 +1,81 @@
+require 'rails_helper'
+
+describe Enterprise::Billing::CreateStripeCustomerService do
+  subject(:create_stripe_customer_service) { described_class }
+
+  let(:account) { create(:account) }
+  let!(:admin1) { create(:user, account: account, role: :administrator) }
+  let(:admin2) { create(:user, account: account, role: :administrator) }
+
+  describe '#perform' do
+    before do
+      create(
+        :installation_config,
+        { name: 'CHATWOOT_CLOUD_PLANS', value: [
+          { 'name' => 'A Plan Name', 'product_id' => ['prod_hacker_random'], 'price_ids' => ['price_hacker_random'] }
+        ] }
+      )
+    end
+
+    it 'does not call stripe methods if customer id is present' do
+      account.update!(custom_attributes: { stripe_customer_id: 'cus_random_number' })
+
+      allow(Stripe::Customer).to receive(:create)
+      allow(Stripe::Subscription).to receive(:create)
+        .and_return(
+          {
+            plan: { id: 'price_random_number', product: 'prod_random_number' },
+            quantity: 2
+          }.with_indifferent_access
+        )
+
+      create_stripe_customer_service.new(account: account).perform
+
+      expect(Stripe::Customer).not_to have_received(:create)
+      expect(Stripe::Subscription)
+        .to have_received(:create)
+        .with({ customer: 'cus_random_number', items: [{ price: 'price_hacker_random', quantity: 2 }] })
+
+      expect(account.reload.custom_attributes).to eq(
+        {
+          stripe_customer_id: 'cus_random_number',
+          stripe_price_id: 'price_random_number',
+          stripe_product_id: 'prod_random_number',
+          subscribed_quantity: 2,
+          plan_name: 'A Plan Name'
+        }.with_indifferent_access
+      )
+    end
+
+    it 'calls stripe methods to create a customer and updates the account' do
+      customer = double
+      allow(Stripe::Customer).to receive(:create).and_return(customer)
+      allow(customer).to receive(:id).and_return('cus_random_number')
+      allow(Stripe::Subscription)
+        .to receive(:create)
+        .and_return(
+          {
+            plan: { id: 'price_random_number', product: 'prod_random_number' },
+            quantity: 2
+          }.with_indifferent_access
+        )
+
+      create_stripe_customer_service.new(account: account).perform
+
+      expect(Stripe::Customer).to have_received(:create).with({ name: account.name, email: admin1.email })
+      expect(Stripe::Subscription)
+        .to have_received(:create)
+        .with({ customer: customer.id, items: [{ price: 'price_hacker_random', quantity: 2 }] })
+
+      expect(account.reload.custom_attributes).to eq(
+        {
+          stripe_customer_id: customer.id,
+          stripe_price_id: 'price_random_number',
+          stripe_product_id: 'prod_random_number',
+          subscribed_quantity: 2,
+          plan_name: 'A Plan Name'
+        }.with_indifferent_access
+      )
+    end
+  end
+end