adminbruno
/
docuseal
mirror of https://github.com/docusealco/docuseal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

rubocop fixes and minor test refactors

Browse Source
pull/544/head
Ryan Arakawa 4 months ago
parent 07f92058f0
commit 371fdbd6a8
5 changed files with 49 additions and 122 deletions
Show Stats Download Patch File Download Diff File

6
app/services/export_service.rb
Unescape View File

@ -9,7 +9,7 @@ class ExportService
@error_message = nil
end
def set_error(message)
def record_error(message)
@error_message = message
end
@ -40,8 +40,4 @@ class ExportService
def export_location
@export_location ||= ExportLocation.default_location
end
def set_error(message)
@error_message = message
end
end

8
app/services/export_submission_service.rb
Unescape View File

@ -12,7 +12,7 @@ class ExportSubmissionService < ExportService
export_location = ExportLocation.default_location
if export_location&.submissions_endpoint.blank?
set_error('Export failed: Submission export endpoint is not configured.')
record_error('Export failed: Submission export endpoint is not configured.')
return false
end
@ -22,18 +22,18 @@ class ExportSubmissionService < ExportService
if response&.success?
true
else
set_error("Failed to export submission ##{submission.id} events.")
record_error("Failed to export submission ##{submission.id} events.")
false
end
rescue Faraday::Error => e
Rails.logger.error("Failed to export submission Faraday: #{e.message}")
Rollbar.error("Failed to export submission: #{e.message}") if defined?(Rollbar)
set_error("Network error occurred during export: #{e.message}")
record_error("Network error occurred during export: #{e.message}")
false
rescue StandardError => e
Rails.logger.error("Failed to export submission: #{e.message}")
Rollbar.error(e) if defined?(Rollbar)
set_error("An unexpected error occurred during export: #{e.message}")
record_error("An unexpected error occurred during export: #{e.message}")
false
end

6
app/services/export_template_service.rb
Unescape View File

@ -15,18 +15,18 @@ class ExportTemplateService < ExportService
else
Rails.logger.error("Failed to export template to third party: #{response&.status}")
Rollbar.error("#{export_location.name} template export API error: #{response&.status}") if defined?(Rollbar)
set_error('Failed to export template to third party')
record_error('Failed to export template to third party')
false
end
rescue Faraday::Error => e
Rails.logger.error("Failed to export template Faraday: #{e.message}")
Rollbar.error("Failed to export template: #{e.message}") if defined?(Rollbar)
set_error("Network error occurred during template export: #{e.message}")
record_error("Network error occurred during template export: #{e.message}")
false
rescue StandardError => e
Rails.logger.error("Failed to export template: #{e.message}")
Rollbar.error(e) if defined?(Rollbar)
set_error("An unexpected error occurred during template export: #{e.message}")
record_error("An unexpected error occurred during template export: #{e.message}")
false
end
end

8
spec/models/submitter_spec.rb
Unescape View File

@ -6,7 +6,9 @@ RSpec.describe Submitter do
let(:account) { create(:account) }
let(:user) { create(:user, account: account) }
let(:template) { create(:template, account: account, author: user) }
let(:submission) { create(:submission, :with_submitters, template: template, account: account, created_by_user: user) }
let(:submission) do
create(:submission, :with_submitters, template: template, account: account, created_by_user: user)
end
let(:submitter) { submission.submitters.first }
describe '#status' do
@ -128,7 +130,9 @@ RSpec.describe Submitter do
it 'logs the error and does not re-raise' do
expect { submitter.update!(completed_at: Time.current) }.not_to raise_error
expect(Rails.logger).to have_received(:error).with('Failed to export submission on status change: Export failed')
expect(Rails.logger).to have_received(:error).with(
'Failed to export submission on status change: Export failed'
)
end
end

143
spec/services/export_submission_service_spec.rb
Unescape View File

@ -6,7 +6,9 @@ RSpec.describe ExportSubmissionService do
let(:account) { create(:account) }
let(:user) { create(:user, account: account) }
let(:template) { create(:template, account: account, author: user) }
let(:submission) { create(:submission, template: template, account: account) }
let(:submission) do
create(:submission, :with_submitters, template: template, account: account, created_by_user: user)
end
let(:export_location) { create(:export_location, :with_submissions_endpoint) }
let(:service) { described_class.new(submission) }
let(:faraday_connection) { instance_double(Faraday::Connection) }
@ -140,76 +142,51 @@ RSpec.describe ExportSubmissionService do
describe 'payload building' do
let(:request_double) { instance_double(Faraday::Request, body: nil) }
let(:submitter1) { create(:submitter, submission: submission, account: account, name: 'John Doe', email: 'john@example.com', completed_at: Time.current, uuid: SecureRandom.uuid) }
let(:submitter2) { create(:submitter, submission: submission, account: account, name: 'Jane Smith', email: 'jane@example.com', opened_at: Time.current, uuid: SecureRandom.uuid) }
before do
submission.submitters << [submitter1, submitter2]
allow(request_double).to receive(:body=)
allow(faraday_connection).to receive(:post).and_yield(request_double).and_return(faraday_response)
allow(faraday_connection).to receive(:post)
.with(export_location.submissions_endpoint)
.and_yield(request_double)
.and_return(faraday_response)
allow(faraday_response).to receive(:success?).and_return(true)
end
it 'includes external_submission_id in payload' do
allow(request_double).to receive(:body=) do |body|
expect(JSON.parse(body)).to include('external_submission_id' => submission.id)
end
service.call
allow(Submitter).to receive(:after_update)
submission.submitters.first.update!(name: 'John Doe', email: 'john@example.com', completed_at: Time.current)
submission.submitters << create(
:submitter,
submission: submission,
account: account,
name: 'Jane Smith',
email: 'jane@example.com',
opened_at: Time.current,
uuid: SecureRandom.uuid
)
end
it 'includes template_name in payload' do
it 'builds correct payload structure with all required fields' do
allow(request_double).to receive(:body=) do |body|
expect(JSON.parse(body)).to include('template_name' => submission.template.name)
end
service.call
end
parsed_body = JSON.parse(body)
it 'includes submission status in payload' do
allow(request_double).to receive(:body=) do |body|
expect(JSON.parse(body)).to include('status' => 'in_progress')
end
service.call
end
expect(parsed_body).to include(
'external_submission_id' => submission.id,
'template_name' => submission.template.name,
'status' => 'in_progress'
)
expect(parsed_body).to have_key('created_at')
expect(parsed_body).to have_key('updated_at')
it 'includes submitter_data array in payload' do
allow(request_double).to receive(:body=) do |body|
parsed_body = JSON.parse(body)
expect(parsed_body).to have_key('submitter_data')
expect(parsed_body['submitter_data']).to be_an(Array)
expect(parsed_body['submitter_data'].length).to eq(2)
end
service.call
end
it 'includes correct submitter data in payload' do
allow(request_double).to receive(:body=) do |body|
parsed_body = JSON.parse(body)
submitter_data = parsed_body['submitter_data']
first_submitter = submitter_data.find { |s| s['email'] == 'john@example.com' }
expect(first_submitter).to include(
'external_submitter_id' => submitter1.slug,
completed_submitter = parsed_body['submitter_data'].find { |s| s['status'] == 'completed' }
expect(completed_submitter).to include(
'name' => 'John Doe',
'email' => 'john@example.com',
'status' => 'completed'
)
second_submitter = submitter_data.find { |s| s['email'] == 'jane@example.com' }
expect(second_submitter).to include(
'external_submitter_id' => submitter2.slug,
'name' => 'Jane Smith',
'email' => 'jane@example.com',
'status' => 'opened'
)
end
service.call
end
it 'includes created_at and updated_at in payload' do
allow(request_double).to receive(:body=) do |body|
parsed_body = JSON.parse(body)
expect(parsed_body).to have_key('created_at')
expect(parsed_body).to have_key('updated_at')
expect(completed_submitter).to have_key('external_submitter_id')
end
service.call
end
@ -228,66 +205,16 @@ RSpec.describe ExportSubmissionService do
end
end
describe '#submission_status' do
let(:service) { described_class.new(submission) }
context 'with multiple submitters' do
let(:submitter1) { create(:submitter, submission: submission, account: account, uuid: SecureRandom.uuid) }
let(:submitter2) { create(:submitter, submission: submission, account: account, uuid: SecureRandom.uuid) }
before do
submission.submitters << [submitter1, submitter2]
end
it 'returns declined when any submitter is declined' do
submitter1.declined_at = Time.current
submitter2.completed_at = Time.current
expect(service.send(:submission_status)).to eq('declined')
end
it 'returns completed when all submitters are completed' do
submitter1.completed_at = Time.current
submitter2.completed_at = Time.current
expect(service.send(:submission_status)).to eq('completed')
end
it 'returns in_progress when any submitter is opened but not all completed' do
submitter1.opened_at = Time.current
submitter2.sent_at = Time.current
expect(service.send(:submission_status)).to eq('in_progress')
end
it 'returns sent when any submitter is sent but none opened' do
submitter1.sent_at = Time.current
expect(service.send(:submission_status)).to eq('sent')
end
it 'returns pending when no submitters have been sent' do
expect(service.send(:submission_status)).to eq('pending')
end
end
context 'with single submitter' do
let(:submitter) { create(:submitter, submission: submission, account: account, uuid: SecureRandom.uuid) }
before do
submission.submitters << submitter
end
it 'returns the submitter status when single submitter' do
submitter.opened_at = Time.current
expect(service.send(:submission_status)).to eq('in_progress')
end
end
end
describe 'extra_params handling' do
let(:request_double) { instance_double(Faraday::Request, body: nil) }
before do
allow(export_location).to receive(:extra_params).and_return({ 'api_key' => 'test_key', 'version' => '1.0' })
allow(request_double).to receive(:body=)
allow(faraday_connection).to receive(:post).and_yield(request_double).and_return(faraday_response)
allow(faraday_connection).to receive(:post)
.with(export_location.submissions_endpoint)
.and_yield(request_double)
.and_return(faraday_response)
allow(faraday_response).to receive(:success?).and_return(true)
end

Write Preview
Loading…
Cancel
Save