feat: account onboarding with clearbit (#8857)

* feat: add clearbit lookup * chore: fix typo in .env.example * refactor: split lookup to reduce cognitive complexity * feat: add more fields to lookup * feat: extend accounts controller * feat: save extra data to custom_attributes * feat: allow v2 update with custom_attributes * feat: add update route * refactor: reduce complexity * feat: move update to v1 controller * test: add locale test * feat: remove update from routes * test: update API for custom attributes * test: all custom attributes * fix: v2 tests * test: enterprise accounts controller * fix: clearbit payload * fix: with modified env * feat: allow custom attributes updates to profile * refactor: reduce complexity * feat: allow clearbit api key in installation config * refactor: move clearbit to internal * feat: allow clearbit * chore: add display_title for June * feat: allow more internal options * refactor: use globalconfig to fetch clearbit token * test: move response body to a factory * refactor: update ops * chore: remove clearbit from .env.example * chore: apply suggestions from code review Co-authored-by: sojan-official <sojan@chatwoot.com> --------- Co-authored-by: sojan-official <sojan@chatwoot.com>
2024-02-12 23:21:42 +05:30
parent fc6a22b072
commit 657843960c
14 changed files with 367 additions and 33 deletions
--- a/spec/enterprise/controllers/enterprise/api/v2/accounts_controller_spec.rb
+++ b/spec/enterprise/controllers/enterprise/api/v2/accounts_controller_spec.rb
@@ -0,0 +1,72 @@
+require 'rails_helper'
+
+RSpec.describe Enterprise::Api::V2::AccountsController, type: :request do
+  let(:email) { Faker::Internet.email }
+  let(:user) { create(:user) }
+  let(:account) { create(:account) }
+  let(:clearbit_data) do
+    {
+      name: 'John Doe',
+      company_name: 'Acme Inc',
+      industry: 'Software',
+      company_size: '51-200',
+      timezone: 'America/Los_Angeles',
+      logo: 'https://logo.clearbit.com/acme.com'
+    }
+  end
+
+  before do
+    allow(Enterprise::ClearbitLookupService).to receive(:lookup).and_return(clearbit_data)
+  end
+
+  describe 'POST /api/v1/accounts' do
+    let(:account_builder) { double }
+    let(:account) { create(:account) }
+    let(:user) { create(:user, email: email, account: account) }
+
+    before do
+      allow(AccountBuilder).to receive(:new).and_return(account_builder)
+    end
+
+    it 'fetches data from clearbit and updates user and account info' do
+      with_modified_env ENABLE_ACCOUNT_SIGNUP: 'true' do
+        allow(account_builder).to receive(:perform).and_return([user, account])
+
+        params = { email: email, user: nil, locale: nil, password: 'Password1!' }
+
+        post api_v2_accounts_url,
+             params: params,
+             as: :json
+
+        expect(AccountBuilder).to have_received(:new).with(params.except(:password).merge(user_password: params[:password]))
+        expect(account_builder).to have_received(:perform)
+        expect(Enterprise::ClearbitLookupService).to have_received(:lookup).with(email)
+
+        custom_attributes = account.custom_attributes
+
+        expect(account.name).to eq('Acme Inc')
+        expect(custom_attributes['industry']).to eq('Software')
+        expect(custom_attributes['company_size']).to eq('51-200')
+        expect(custom_attributes['timezone']).to eq('America/Los_Angeles')
+      end
+    end
+
+    it 'handles errors when fetching data from clearbit' do
+      with_modified_env ENABLE_ACCOUNT_SIGNUP: 'true' do
+        allow(account_builder).to receive(:perform).and_return([user, account])
+        allow(Enterprise::ClearbitLookupService).to receive(:lookup).and_raise(StandardError)
+        params = { email: email, user: nil, locale: nil, password: 'Password1!' }
+
+        post api_v2_accounts_url,
+             params: params,
+             as: :json
+
+        expect(AccountBuilder).to have_received(:new).with(params.except(:password).merge(user_password: params[:password]))
+        expect(account_builder).to have_received(:perform)
+        expect(Enterprise::ClearbitLookupService).to have_received(:lookup).with(email)
+
+        expect(response).to have_http_status(:success)
+      end
+    end
+  end
+end