Compare commits

...
20 Commits
Author SHA1 Message Date
Alex Turchyn 9100d48cc3 fix audit trail generation 2023-09-12 22:36:04 +03:00
Alex Turchyn 21b207cb1a fix submissions api 2023-09-11 09:49:59 +03:00
Alex Turchyn 3aa703032f adjust audit trail 2023-09-11 01:24:43 +03:00
Alex Turchyn fcfd2e13bd track form open after link click 2023-09-10 20:46:45 +03:00
Alex Turchyn cf6cacdc92 add audit trail 2023-09-10 20:46:44 +03:00
Alex Turchyn 8cabe31827 add submission tracking events 2023-09-10 17:49:10 +03:00
Alex Turchyn 62cea05084 add preserve submitters order option 2023-09-10 11:24:28 +03:00
Alex Turchyn 07e49f9f07 adjust default email 2023-09-09 23:17:41 +03:00
Alex Turchyn baad784818 send docs copy only if email present 2023-09-09 14:00:14 +03:00
Alex Turchyn 6eecd3afa4 fix email template submitters list 2023-09-09 11:44:04 +03:00
Alex Turchyn 8e90100871 fix submission download 2023-09-09 02:00:11 +03:00
Alex Turchyn 12c5138364 adjust add recipients view 2023-09-09 01:25:44 +03:00
Alex Turchyn 80ad166fd9 automatically send emails when all parties completed the form 2023-09-09 00:43:32 +03:00
Alex Turchyn 2fab6984ea fix form button loading indicator 2023-09-06 22:21:15 +03:00
Alex Turchyn 422639114b add bcc emails config 2023-09-06 21:41:23 +03:00
Alex Turchyn fca441878a send completed notification emails to a single user 2023-09-06 20:10:55 +03:00
Alex Turchyn 76578077e8 fix pdf rendering with rotate prop 2023-09-06 17:27:54 +03:00
Alex Turchyn bbd3618f0e add js alert translation 2023-09-05 22:28:50 +03:00
Alex Turchyn 47ed8db955 fix typo 2023-09-05 21:53:17 +03:00
Alex Turchyn fec6e2e35d add portuguese form translations 2023-09-05 21:49:12 +03:00
43 changed files with 771 additions and 117 deletions

No files matched your search

+3
View File
@@ -26,6 +26,9 @@ Style/Documentation:
Lint/MissingSuper: Lint/MissingSuper:
Enabled: false Enabled: false
Metrics/ParameterLists:
Max: 10
Metrics/MethodLength: Metrics/MethodLength:
Max: 25 Max: 25
Exclude: Exclude:
+1 -1
View File
@@ -31,7 +31,7 @@ ENV BUNDLE_WITHOUT="development:test"
WORKDIR /app WORKDIR /app
RUN apk add --no-cache build-base sqlite-dev libpq-dev mariadb-dev vips-dev vips-poppler vips-heif libc6-compat ttf-freefont ttf-liberation && cp /usr/share/fonts/liberation/LiberationSans-Regular.ttf /LiberationSans-Regular.ttf && apk del ttf-liberation RUN apk add --no-cache build-base sqlite-dev libpq-dev mariadb-dev vips-dev vips-poppler vips-heif libc6-compat ttf-freefont ttf-liberation && cp /usr/share/fonts/liberation/LiberationSans-Regular.ttf /usr/share/fonts/liberation/LiberationSans-Bold.ttf / && apk del ttf-liberation
COPY ./Gemfile ./Gemfile.lock ./ COPY ./Gemfile ./Gemfile.lock ./
+12 -11
View File
@@ -9,27 +9,28 @@ module Api
template = current_account.templates.find(params[:template_id]) template = current_account.templates.find(params[:template_id])
submissions = submissions =
if (params[:emails] || params[:email]).present? if (emails = (params[:emails] || params[:email]).presence)
Submissions.create_from_emails(template:, Submissions.create_from_emails(template:,
user: current_user, user: current_user,
source: :api, source: :api,
mark_as_sent: params[:send_email] != 'false', mark_as_sent: params[:send_email] != 'false',
emails: params[:emails] || params[:email]) emails:)
else else
submissions_attrs = normalize_submissions_params!(submissions_params[:submission], template) submissions_attrs = normalize_submissions_params!(submissions_params[:submission], template)
Submissions.create_from_submitters(template:, Submissions.create_from_submitters(
user: current_user, template:,
source: :api, user: current_user,
mark_as_sent: params[:send_email] != 'false', source: :api,
submissions_attrs:) mark_as_sent: params[:send_email] != 'false',
submitters_order: params[:submitters_order] || 'preserved',
submissions_attrs:
)
end end
submitters = submissions.flat_map(&:submitters) Submissions.send_signature_requests(submissions, send_email: params[:send_email] != 'false')
Submitters.send_signature_requests(submitters, send_email: params[:send_email] != 'false') render json: submissions.flat_map(&:submitters)
render json: submitters
rescue UnknownFieldName, UnknownSubmitterName => e rescue UnknownFieldName, UnknownSubmitterName => e
render json: { error: e.message }, status: :unprocessable_entity render json: { error: e.message }, status: :unprocessable_entity
end end
@@ -0,0 +1,17 @@
# frozen_string_literal: true
module Api
class SubmitterEmailClicksController < ApiBaseController
skip_before_action :authenticate_user!
def create
submitter = Submitter.find_by!(slug: params[:submitter_slug])
if params[:t] == SubmissionEvents.build_tracking_param(submitter, 'click_email')
SubmissionEvents.create_with_tracking_data(submitter, 'click_email', request)
end
render json: {}
end
end
end
@@ -0,0 +1,15 @@
# frozen_string_literal: true
module Api
class SubmitterFormViewsController < ApiBaseController
skip_before_action :authenticate_user!
def create
submitter = Submitter.find_by!(slug: params[:submitter_slug])
SubmissionEvents.create_with_tracking_data(submitter, 'view_form', request)
render json: {}
end
end
end
+3 -5
View File
@@ -26,16 +26,14 @@ class SubmissionsController < ApplicationController
Submissions.create_from_submitters(template: @template, Submissions.create_from_submitters(template: @template,
user: current_user, user: current_user,
source: :invite, source: :invite,
submitters_order: params[:preserve_order] == '1' ? 'preserved' : 'random',
mark_as_sent: params[:send_email] == '1', mark_as_sent: params[:send_email] == '1',
submissions_attrs: submissions_params[:submission].to_h.values) submissions_attrs: submissions_params[:submission].to_h.values)
end end
submitters = submissions.flat_map(&:submitters) Submissions.send_signature_requests(submissions, params)
Submitters.send_signature_requests(submitters, params) redirect_to template_path(@template), notice: 'New recipients have been added'
redirect_to template_path(@template),
notice: "#{submitters.size} #{'recipient'.pluralize(submitters.size)} added"
end end
def destroy def destroy
@@ -15,9 +15,13 @@ class SubmissionsDebugController < ApplicationController
render 'submit_form/show' render 'submit_form/show'
end end
f.pdf do f.pdf do
Submissions::GenerateResultAttachments.call(@submitter) if params[:audit]
Submissions::GenerateAuditTrail.call(@submitter.submission)
else
Submissions::GenerateResultAttachments.call(@submitter)
end
send_data ActiveStorage::Attachment.where(name: :documents).last.download, send_data ActiveStorage::Attachment.where(name: params[:audit] ? :audit_trail : :documents).last.download,
filename: 'debug.pdf', filename: 'debug.pdf',
disposition: 'inline', disposition: 'inline',
type: 'application/pdf' type: 'application/pdf'
@@ -8,8 +8,12 @@ class SubmissionsDownloadController < ApplicationController
Submissions::EnsureResultGenerated.call(submitter) Submissions::EnsureResultGenerated.call(submitter)
last_submitter = submitter.submission.submitters.where.not(completed_at: nil).order(:completed_at).last
Submissions::EnsureResultGenerated.call(last_submitter)
urls = urls =
Submitters.select_attachments_for_download(submitter).map do |attachment| Submitters.select_attachments_for_download(last_submitter).map do |attachment|
helpers.rails_blob_url(attachment) helpers.rails_blob_url(attachment)
end end
@@ -8,6 +8,8 @@ class SubmittersSendEmailController < ApplicationController
SubmitterMailer.invitation_email(submitter).deliver_later! SubmitterMailer.invitation_email(submitter).deliver_later!
SubmissionEvent.create!(submitter:, event_type: 'send_email')
submitter.sent_at ||= Time.current submitter.sent_at ||= Time.current
submitter.save! submitter.save!
+1 -1
View File
@@ -140,7 +140,7 @@ export default {
fetch(this.baseUrl + `/send_submission_email.json?submitter_slug=${this.submitterSlug}`, { fetch(this.baseUrl + `/send_submission_email.json?submitter_slug=${this.submitterSlug}`, {
method: 'POST' method: 'POST'
}).then(() => { }).then(() => {
alert('Email has been sent') alert(this.t('email_has_been_sent'))
}).finally(() => { }).finally(() => {
this.isSendingCopy = false this.isSendingCopy = false
}) })
+41 -2
View File
@@ -493,10 +493,49 @@ export default {
this.$nextTick(() => { this.$nextTick(() => {
this.recalculateButtonDisabledKey = Math.random() this.recalculateButtonDisabledKey = Math.random()
this.maybeTrackEmailClick().finally(() => {
this.trackViewForm()
})
}) })
}, },
methods: { methods: {
t, t,
maybeTrackEmailClick () {
const queryParams = new URLSearchParams(window.location.search)
if (queryParams.has('t')) {
const t = queryParams.get('t')
queryParams.delete('t')
const newUrl = [window.location.pathname, queryParams.toString()].filter(Boolean).join('?')
window.history.replaceState({}, document.title, newUrl)
return fetch(this.baseUrl + '/api/submitter_email_clicks', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
t,
submitter_slug: this.submitterSlug
})
})
} else {
return Promise.resolve({})
}
},
trackViewForm () {
fetch(this.baseUrl + '/api/submitter_form_views', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify({
submitter_slug: this.submitterSlug
})
})
},
goToStep (step, scrollToArea = false, clickUpload = false) { goToStep (step, scrollToArea = false, clickUpload = false) {
this.currentStep = this.stepFields.indexOf(step) this.currentStep = this.stepFields.indexOf(step)
@@ -531,14 +570,14 @@ export default {
? this.$refs.currentStep.submit ? this.$refs.currentStep.submit
: () => Promise.resolve({}) : () => Promise.resolve({})
stepPromise().then(() => { stepPromise().then(async () => {
const formData = new FormData(this.$refs.form) const formData = new FormData(this.$refs.form)
if (this.currentStep === this.stepFields.length - 1) { if (this.currentStep === this.stepFields.length - 1) {
formData.append('completed', 'true') formData.append('completed', 'true')
} }
this.saveStep(formData).then(async (response) => { await this.saveStep(formData).then(async (response) => {
if (response.status === 422) { if (response.status === 422) {
const data = await response.json() const data = await response.json()
+43 -9
View File
@@ -20,7 +20,8 @@ const en = {
change_phone_number: 'Change phone number', change_phone_number: 'Change phone number',
sending: 'Sending...', sending: 'Sending...',
resend_code: 'Re-send code', resend_code: 'Re-send code',
verification_code_has_been_resent: 'Verification code has been re-sent via SMS' verification_code_has_been_resent: 'Verification code has been re-sent via SMS',
email_has_been_sent: 'Email has been sent'
} }
const es = { const es = {
@@ -45,7 +46,8 @@ const es = {
change_phone_number: 'Cambiar número de teléfono', change_phone_number: 'Cambiar número de teléfono',
sending: 'Enviando...', sending: 'Enviando...',
resend_code: 'Reenviar código', resend_code: 'Reenviar código',
verification_code_has_been_resent: 'El código de verificación ha sido reenviado por SMS' verification_code_has_been_resent: 'El código de verificación ha sido reenviado por SMS',
email_has_been_sent: 'El correo electrónico ha sido enviado'
} }
const it = { const it = {
@@ -70,7 +72,8 @@ const it = {
change_phone_number: 'Cambia numero di telefono', change_phone_number: 'Cambia numero di telefono',
sending: 'Invio in corso...', sending: 'Invio in corso...',
resend_code: 'Rinvia codice', resend_code: 'Rinvia codice',
verification_code_has_been_resent: 'Il codice di verifica è stato rinviato tramite SMS' verification_code_has_been_resent: 'Il codice di verifica è stato rinviato tramite SMS',
email_has_been_sent: "L'email è stata inviata"
} }
const de = { const de = {
@@ -95,7 +98,8 @@ const de = {
change_phone_number: 'Telefonnummer ändern', change_phone_number: 'Telefonnummer ändern',
sending: 'Senden...', sending: 'Senden...',
resend_code: 'Code erneut senden', resend_code: 'Code erneut senden',
verification_code_has_been_resent: 'Die Verifizierungscode wurde erneut per SMS gesendet' verification_code_has_been_resent: 'Die Verifizierungscode wurde erneut per SMS gesendet',
email_has_been_sent: 'Die E-Mail wurde gesendet'
} }
const fr = { const fr = {
@@ -120,7 +124,8 @@ const fr = {
change_phone_number: 'Changer le numéro de téléphone', change_phone_number: 'Changer le numéro de téléphone',
sending: 'Envoi en cours...', sending: 'Envoi en cours...',
resend_code: 'Renvoyer le code', resend_code: 'Renvoyer le code',
verification_code_has_been_resent: 'Le code de vérification a été renvoyé par SMS' verification_code_has_been_resent: 'Le code de vérification a été renvoyé par SMS',
email_has_been_sent: "L'email a été envoyé"
} }
const pl = { const pl = {
@@ -145,7 +150,8 @@ const pl = {
change_phone_number: 'Zmień numer telefonu', change_phone_number: 'Zmień numer telefonu',
sending: 'Wysyłanie...', sending: 'Wysyłanie...',
resend_code: 'Ponownie wyślij kod', resend_code: 'Ponownie wyślij kod',
verification_code_has_been_resent: 'Kod weryfikacyjny został ponownie wysłany' verification_code_has_been_resent: 'Kod weryfikacyjny został ponownie wysłany',
email_has_been_sent: 'E-mail został wysłany'
} }
const uk = { const uk = {
@@ -170,7 +176,8 @@ const uk = {
change_phone_number: 'Змінити номер телефону', change_phone_number: 'Змінити номер телефону',
sending: 'Надсилаю...', sending: 'Надсилаю...',
resend_code: 'Повторно відправити код', resend_code: 'Повторно відправити код',
verification_code_has_been_resent: 'Код підтвердження був повторно надісланий' verification_code_has_been_resent: 'Код підтвердження був повторно надісланий',
email_has_been_sent: 'Електронний лист був відправлений'
} }
const cs = { const cs = {
@@ -195,10 +202,37 @@ const cs = {
change_phone_number: 'Změnit telefonní číslo', change_phone_number: 'Změnit telefonní číslo',
sending: 'Odesílání...', sending: 'Odesílání...',
resend_code: 'Znovu odeslat kód', resend_code: 'Znovu odeslat kód',
verification_code_has_been_resent: 'Ověřovací kód byl znovu odeslán' verification_code_has_been_resent: 'Ověřovací kód byl znovu odeslán',
email_has_been_sent: 'E-mail byl odeslán'
} }
const i18n = { en, es, it, de, fr, pl, uk, cs } const pt = {
submit_form: 'Enviar Formulário',
type_here: 'Digite aqui',
optional: 'opcional',
select_your_option: 'Selecione sua opção',
complete_hightlighted_checkboxes_and_click: 'Complete as caixas de seleção destacadas e clique',
submit: 'enviar',
next: 'próximo',
click_to_upload: 'Clique para fazer o upload',
or_drag_and_drop_files: 'ou arraste e solte arquivos',
send_copy_via_email: 'Enviar cópia por e-mail',
download: 'Baixar',
form_has_been_completed: 'O formulário foi concluído!',
create_a_free_account: 'Criar uma Conta Gratuita',
signed_with: 'Assinado com',
open_source_documents_software: 'software de documentos de código aberto',
verified_phone_number: 'Verificar Número de Telefone',
use_international_format: 'Use formato internacional: +1xxx',
six_digits_code: 'Código de 6 dígitos',
change_phone_number: 'Alterar número de telefone',
sending: 'Enviando...',
resend_code: 'Reenviar código',
verification_code_has_been_resent: 'O código de verificação foi reenviado via SMS',
email_has_been_sent: 'Email enviado'
}
const i18n = { en, es, it, de, fr, pl, uk, cs, pt }
const browserLanguage = (navigator.language || navigator.userLanguage || 'en').split('-')[0] const browserLanguage = (navigator.language || navigator.userLanguage || 'en').split('-')[0]
@@ -1,7 +0,0 @@
# frozen_string_literal: true
class GenerateSubmitterResultAttachmentsJob < ApplicationJob
def perform(submitter)
Submissions::EnsureResultGenerated.call(submitter)
end
end
@@ -0,0 +1,53 @@
# frozen_string_literal: true
class ProcessSubmitterCompletionJob < ApplicationJob
def perform(submitter)
is_all_completed = !submitter.submission.submitters.exists?(completed_at: nil)
if !is_all_completed && submitter.submission.submitters_order_preserved?
enqueue_next_submitter_request_notification(submitter)
end
Submissions::EnsureResultGenerated.call(submitter)
if submitter.account.encrypted_configs.exists?(key: EncryptedConfig::WEBHOOK_URL_KEY)
SendWebhookRequestJob.perform_later(submitter)
end
return unless is_all_completed
return if submitter.completed_at != submitter.submission.submitters.maximum(:completed_at)
Submissions::GenerateAuditTrail.call(submitter.submission)
enqueue_emails(submitter)
end
def enqueue_emails(submitter)
user = submitter.submission.created_by_user || submitter.template.author
if submitter.template.account.users.exists?(id: user.id)
bcc = submitter.submission.template.account.account_configs.find_by(key: 'bcc_emails')&.value
SubmitterMailer.completed_email(submitter, user, bcc:).deliver_later!
end
to = submitter.submission.submitters.sort_by(&:completed_at).select(&:email?).map(&:friendly_name).join(', ')
SubmitterMailer.documents_copy_email(submitter, to:).deliver_later! if to.present?
end
def enqueue_next_submitter_request_notification(submitter)
next_submitter_item =
submitter.submission.template_submitters.find do |e|
sub = submitter.submission.submitters.find { |s| s.uuid == e['uuid'] }
sub.completed_at.blank? && sub.sent_at.blank?
end
return unless next_submitter_item
next_submitter = submitter.submission.submitters.find { |s| s.uuid == next_submitter_item['uuid'] }
Submitters.send_signature_requests([next_submitter], send_email: true)
end
end
@@ -0,0 +1,12 @@
# frozen_string_literal: true
class SendSubmitterInvitationEmailJob < ApplicationJob
def perform(submitter)
SubmitterMailer.invitation_email(submitter).deliver_now!
SubmissionEvent.create!(submitter:, event_type: 'send_email')
submitter.sent_at ||= Time.current
submitter.save
end
end
+30 -12
View File
@@ -17,42 +17,46 @@ class SubmitterMailer < ApplicationMailer
'You have been invited to submit a form' 'You have been invited to submit a form'
end end
mail(to: @submitter.email, mail(to: @submitter.friendly_name,
from: from_address_for_submitter(submitter), from: from_address_for_submitter(submitter),
subject:, subject:,
reply_to: submitter.submission.created_by_user&.friendly_name) reply_to: (submitter.submission.created_by_user || submitter.template.author)&.friendly_name)
end end
def completed_email(submitter, user) def completed_email(submitter, user, bcc: nil)
@current_account = submitter.submission.template.account @current_account = submitter.submission.template.account
@submitter = submitter @submitter = submitter
@submission = submitter.submission
@user = user @user = user
Submissions::EnsureResultGenerated.call(submitter)
@email_config = @current_account.account_configs.find_by(key: AccountConfig::SUBMITTER_COMPLETED_EMAIL_KEY) @email_config = @current_account.account_configs.find_by(key: AccountConfig::SUBMITTER_COMPLETED_EMAIL_KEY)
add_completed_email_attachments!(submitter)
subject = subject =
if @email_config if @email_config
ReplaceEmailVariables.call(@email_config.value['subject'], submitter:) ReplaceEmailVariables.call(@email_config.value['subject'], submitter:)
else else
%(#{submitter.email} has completed the "#{submitter.submission.template.name}" form) submitters = submitter.submission.submitters.order(:completed_at)
.map { |e| e.name || e.email || e.phone }.join(', ')
%(#{submitter.submission.template.name} has been completed by #{submitters})
end end
mail(from: from_address_for_submitter(submitter), mail(from: from_address_for_submitter(submitter),
to: user.email, to: user.friendly_name,
bcc:,
subject:) subject:)
end end
def documents_copy_email(submitter) def documents_copy_email(submitter, to: nil)
@current_account = submitter.submission.template.account @current_account = submitter.submission.template.account
@submitter = submitter @submitter = submitter
Submissions::EnsureResultGenerated.call(@submitter) Submissions::EnsureResultGenerated.call(@submitter)
@documents = Submitters.select_attachments_for_download(submitter) @documents = add_completed_email_attachments!(submitter)
@documents.each do |attachment|
attachments[attachment.filename.to_s] = attachment.download
end
@email_config = @current_account.account_configs.find_by(key: AccountConfig::SUBMITTER_DOCUMENTS_COPY_EMAIL_KEY) @email_config = @current_account.account_configs.find_by(key: AccountConfig::SUBMITTER_DOCUMENTS_COPY_EMAIL_KEY)
@@ -64,12 +68,26 @@ class SubmitterMailer < ApplicationMailer
end end
mail(from: from_address_for_submitter(submitter), mail(from: from_address_for_submitter(submitter),
to: submitter.email, to: to || @submitter.friendly_name,
subject:) subject:)
end end
private private
def add_completed_email_attachments!(submitter)
documents = Submitters.select_attachments_for_download(submitter)
documents.each do |attachment|
attachments[attachment.filename.to_s] = attachment.download
end
if submitter.submission.audit_trail.present?
attachments[submitter.submission.audit_trail.filename.to_s] = submitter.submission.audit_trail.download
end
documents
end
def from_address_for_submitter(submitter) def from_address_for_submitter(submitter)
submitter.submission.created_by_user&.friendly_name || submitter.submission.template.author.friendly_name submitter.submission.created_by_user&.friendly_name || submitter.submission.template.author.friendly_name
end end
+3 -5
View File
@@ -36,12 +36,10 @@ class AccountConfig < ApplicationRecord
'{{account.name}}' '{{account.name}}'
}, },
SUBMITTER_COMPLETED_EMAIL_KEY => { SUBMITTER_COMPLETED_EMAIL_KEY => {
'subject' => '{{submitter.name}} has completed the "{{template.name}}" form', 'subject' => '{{template.name}} has been completed by {{submission.submitters}}',
'body' => "Hi,\n\n" \ 'body' => "Hi,\n\n" \
"{{submitter.name}} has completed the \"{{template.name}}\" form:\n\n" \ "\"{{template.name}}\" form has been completed by {{submission.submitters}}\n\n" \
"{{submission.link}}\n\n" \ '{{submission.link}}'
"Thanks,\n" \
'{{account.name}}'
}, },
SUBMITTER_DOCUMENTS_COPY_EMAIL_KEY => { SUBMITTER_DOCUMENTS_COPY_EMAIL_KEY => {
'subject' => 'Your copy of documents', 'subject' => 'Your copy of documents',
+10
View File
@@ -7,6 +7,7 @@
# id :bigint not null, primary key # id :bigint not null, primary key
# deleted_at :datetime # deleted_at :datetime
# source :text not null # source :text not null
# submitters_order :string not null
# template_fields :text # template_fields :text
# template_schema :text # template_schema :text
# template_submitters :text # template_submitters :text
@@ -31,12 +32,16 @@ class Submission < ApplicationRecord
belongs_to :created_by_user, class_name: 'User', optional: true belongs_to :created_by_user, class_name: 'User', optional: true
has_many :submitters, dependent: :destroy has_many :submitters, dependent: :destroy
has_many :submission_events, dependent: :destroy
serialize :template_fields, JSON serialize :template_fields, JSON
serialize :template_schema, JSON serialize :template_schema, JSON
serialize :template_submitters, JSON serialize :template_submitters, JSON
attribute :source, :string, default: 'link' attribute :source, :string, default: 'link'
attribute :submitters_order, :string, default: 'random'
has_one_attached :audit_trail
has_many :template_schema_documents, has_many :template_schema_documents,
->(e) { where(uuid: (e.template_schema.presence || e.template.schema).pluck('attachment_uuid')) }, ->(e) { where(uuid: (e.template_schema.presence || e.template.schema).pluck('attachment_uuid')) },
@@ -50,4 +55,9 @@ class Submission < ApplicationRecord
embed: 'embed', embed: 'embed',
link: 'link' link: 'link'
}, scope: false, prefix: true }, scope: false, prefix: true
enum :submitters_order, {
random: 'random',
preserved: 'preserved'
}, scope: false, prefix: true
end end
+53
View File
@@ -0,0 +1,53 @@
# frozen_string_literal: true
# == Schema Information
#
# Table name: submission_events
#
# id :bigint not null, primary key
# data :text not null
# event_timestamp :datetime not null
# event_type :string not null
# created_at :datetime not null
# updated_at :datetime not null
# submission_id :bigint not null
# submitter_id :bigint
#
# Indexes
#
# index_submission_events_on_submission_id (submission_id)
# index_submission_events_on_submitter_id (submitter_id)
#
# Foreign Keys
#
# fk_rails_... (submission_id => submissions.id)
# fk_rails_... (submitter_id => submitters.id)
#
class SubmissionEvent < ApplicationRecord
belongs_to :submission
belongs_to :submitter, optional: true
attribute :data, :string, default: -> { {} }
attribute :event_timestamp, :datetime, default: -> { Time.current }
serialize :data, JSON
before_validation :set_submission_id, on: :create
enum :event_type, {
send_email: 'send_email',
send_sms: 'send_sms',
open_email: 'open_email',
click_email: 'click_email',
click_sms: 'click_sms',
start_form: 'start_form',
view_form: 'view_form',
complete_form: 'complete_form'
}, scope: false
private
def set_submission_id
self.submission_id = submitter&.submission_id
end
end
+9
View File
@@ -44,6 +44,7 @@ class Submitter < ApplicationRecord
has_many_attached :attachments has_many_attached :attachments
has_many :document_generation_events, dependent: :destroy has_many :document_generation_events, dependent: :destroy
has_many :submission_events, dependent: :destroy
def status def status
if completed_at? if completed_at?
@@ -57,6 +58,14 @@ class Submitter < ApplicationRecord
end end
end end
def friendly_name
if name.present?
"#{name} <#{email}>"
else
email
end
end
def status_event_at def status_event_at
completed_at || opened_at || sent_at || created_at completed_at || opened_at || sent_at || created_at
end end
+1 -1
View File
@@ -17,7 +17,7 @@
</div> </div>
</div> </div>
<div class="text-center text-2xl font-semibold"> <div class="text-center text-2xl font-semibold">
Form has been submitter already Form has been submitted already
</div> </div>
<% if Accounts.can_send_emails?(@submitter.submission.template.account) %> <% if Accounts.can_send_emails?(@submitter.submission.template.account) %>
<div> <div>
@@ -30,10 +30,11 @@
</div> </div>
<a href="#" class="btn btn-primary btn-sm w-full flex items-center justify-center" data-action="click:dynamic-list#addItem"> <a href="#" class="btn btn-primary btn-sm w-full flex items-center justify-center" data-action="click:dynamic-list#addItem">
<%= svg_icon('user_plus', class: 'w-4 h-4 stroke-2') %> <%= svg_icon('user_plus', class: 'w-4 h-4 stroke-2') %>
<span>Add Recipient</span> <span>Add New</span>
</a> </a>
</dynamic-list> </dynamic-list>
<div> <div>
<%= render('submitters_order', f:, template:) if Accounts.can_send_emails?(current_account) %>
<%= render 'send_email', f:, template: %> <%= render 'send_email', f:, template: %>
<%= render 'send_sms', f: %> <%= render 'send_sms', f: %>
</div> </div>
+5 -2
View File
@@ -31,11 +31,14 @@
</div> </div>
<a href="#" class="btn btn-primary btn-sm w-full flex items-center justify-center" data-action="click:dynamic-list#addItem"> <a href="#" class="btn btn-primary btn-sm w-full flex items-center justify-center" data-action="click:dynamic-list#addItem">
<%= svg_icon('user_plus', class: 'w-4 h-4 stroke-2') %> <%= svg_icon('user_plus', class: 'w-4 h-4 stroke-2') %>
<span>Add Recipient</span> <span>Add New</span>
</a> </a>
</dynamic-list> </dynamic-list>
<% end %> <% end %>
<%= render 'send_email', f:, template: %> <div>
<%= render 'send_email', f:, template: %>
<%= render('submitters_order', f:, template:) if Accounts.can_send_emails?(current_account) %>
</div>
<div class="form-control"> <div class="form-control">
<%= f.button button_title(title: 'Add Recipients'), class: 'base-button' %> <%= f.button button_title(title: 'Add Recipients'), class: 'base-button' %>
</div> </div>
+2 -1
View File
@@ -34,10 +34,11 @@
</div> </div>
<a href="#" class="btn btn-primary btn-sm w-full flex items-center justify-center" data-action="click:dynamic-list#addItem"> <a href="#" class="btn btn-primary btn-sm w-full flex items-center justify-center" data-action="click:dynamic-list#addItem">
<%= svg_icon('user_plus', class: 'w-4 h-4 stroke-2') %> <%= svg_icon('user_plus', class: 'w-4 h-4 stroke-2') %>
<span>Add Recipient</span> <span>Add New</span>
</a> </a>
</dynamic-list> </dynamic-list>
<%= render 'send_sms', f: %> <%= render 'send_sms', f: %>
<%= render('submitters_order', f:, template:) if Accounts.can_send_emails?(current_account) %>
<div class="form-control"> <div class="form-control">
<%= f.button button_title(title: 'Add Recipients'), class: 'base-button' %> <%= f.button button_title(title: 'Add Recipients'), class: 'base-button' %>
</div> </div>
+2 -19
View File
@@ -1,8 +1,8 @@
<div class="form-control"> <div class="form-control">
<% is_smtp_configured = Accounts.can_send_emails?(current_account) %> <% is_smtp_configured = Accounts.can_send_emails?(current_account) %>
<%= f.label :send_email, for: uuid = SecureRandom.uuid, class: 'flex items-center cursor-pointer' do %> <%= f.label :send_email, for: uuid = SecureRandom.uuid, class: 'flex items-center cursor-pointer' do %>
<%= f.check_box :send_email, id: uuid, class: 'base-checkbox', disabled: !is_smtp_configured, onchange: "window.message_field && message_field.classList.toggle('hidden', !event.currentTarget.checked)" %> <%= f.check_box :send_email, id: uuid, class: 'base-checkbox', disabled: !is_smtp_configured, checked: is_smtp_configured %>
<span class="label">Send Email</span> <span class="label">Send emails</span>
<% end %> <% end %>
<% unless is_smtp_configured %> <% unless is_smtp_configured %>
<div class="alert my-4"> <div class="alert my-4">
@@ -18,20 +18,3 @@
</div> </div>
<% end %> <% end %>
</div> </div>
<% unless AccountConfig.exists?(key: AccountConfig::SUBMITTER_INVITATION_EMAIL_KEY) %>
<div id="message_field" class="card card-compact bg-base-200 hidden">
<div class="card-body">
<div class="form-control space-y-2">
<span class="label-text">Hi there,</span>
<autoresize-textarea>
<%= f.text_area :message, value: format(SubmitterMailer::DEFAULT_MESSAGE, name: template.name), required: true, class: 'base-textarea !rounded-lg w-full' %>
</autoresize-textarea>
<span class="label-text">
Thanks,
<br>
<%= current_account.name %>
</span>
</div>
</div>
</div>
<% end %>
@@ -0,0 +1,11 @@
<% if template.submitters.size > 1 %>
<div class="form-control">
<%= f.label :preserve_order, for: uuid = SecureRandom.uuid, class: 'flex items-center cursor-pointer' do %>
<%= f.check_box :preserve_order, id: uuid, class: 'base-checkbox', checked: template.submissions.last&.submitters_order.in?(['preserved', nil]) %>
<span class="label">Preserve submitters order</span>
<span class="tooltip" data-tip="When checked, notifications will be sent to the second submitter once the form is completed by the previous submitter. Uncheck this option to send notifications to all submitters simultaneously right away.">
<%= svg_icon('info_circle', class: 'w-4 h-4') %>
</span>
<% end %>
</div>
<% end %>
@@ -1,7 +1,7 @@
<% if @email_config %> <% if @email_config %>
<%= auto_link(simple_format(h(ReplaceEmailVariables.call(@email_config.value['body'], submitter: @submitter)))) %> <%= auto_link(simple_format(h(ReplaceEmailVariables.call(@email_config.value['body'], submitter: @submitter)))) %>
<% else %> <% else %>
<p>Hi <%= @user.first_name %>,</p> <p>Hi there,</p>
<p><%= @submitter.email %> has completed the "<%= @submitter.submission.template.name %>" form.</p> <p>"<%= @submitter.submission.template.name %>" form has been completed by <%= @submitter.submission.submitters.order(:completed_at).map { |e| e.name || e.email || e.phone }.join(', ') %>.</p>
<p><%= link_to 'View Submission', submission_url(@submitter.submission) %></p> <p><%= link_to 'View Submission', submission_url(@submitter.submission) %></p>
<% end %> <% end %>
@@ -3,7 +3,7 @@
<% else %> <% else %>
<p>Hi there,</p> <p>Hi there,</p>
<%= simple_format(@message) %> <%= simple_format(@message) %>
<p><%= link_to 'Submit Form', submit_form_url(slug: @submitter.slug) %></p> <p><%= link_to 'Submit Form', submit_form_url(slug: @submitter.slug, t: SubmissionEvents.build_tracking_param(@submitter, 'click_email')) %></p>
<p>Please contact us by replying to this email if you didn't request this.</p> <p>Please contact us by replying to this email if you didn't request this.</p>
<p> <p>
Thanks,<br><%= @current_account.name %> Thanks,<br><%= @current_account.name %>
+2
View File
@@ -31,6 +31,8 @@ Rails.application.routes.draw do
namespace :api, defaults: { format: :json } do namespace :api, defaults: { format: :json } do
resources :attachments, only: %i[create] resources :attachments, only: %i[create]
resources :submitter_email_clicks, only: %i[create]
resources :submitter_form_views, only: %i[create]
resources :submissions, only: %i[create] resources :submissions, only: %i[create]
resources :templates, only: %i[update show index] do resources :templates, only: %i[update show index] do
resources :submissions, only: %i[create] resources :submissions, only: %i[create]
@@ -0,0 +1,15 @@
# frozen_string_literal: true
class AddSubmittersOrderToSubmissions < ActiveRecord::Migration[7.0]
class MigrationSubmission < ApplicationRecord
self.table_name = 'submissions'
end
def change
add_column :submissions, :submitters_order, :string
MigrationSubmission.where(submitters_order: nil).update_all(submitters_order: 'random')
change_column_null :submissions, :submitters_order, false
end
end
@@ -0,0 +1,15 @@
# frozen_string_literal: true
class CreateSubmissionEvents < ActiveRecord::Migration[7.0]
def change
create_table :submission_events do |t|
t.references :submission, null: false, foreign_key: true, index: true
t.references :submitter, null: true, foreign_key: true, index: true
t.text :data, null: false
t.string :event_type, null: false
t.datetime :event_timestamp, null: false
t.timestamps
end
end
end
+16 -1
View File
@@ -10,7 +10,7 @@
# #
# It's strongly recommended that you check this file into your version control system. # It's strongly recommended that you check this file into your version control system.
ActiveRecord::Schema[7.0].define(version: 2023_09_02_171216) do ActiveRecord::Schema[7.0].define(version: 2023_09_10_084410) do
# These are extensions that must be enabled in order to support this database # These are extensions that must be enabled in order to support this database
enable_extension "plpgsql" enable_extension "plpgsql"
@@ -91,6 +91,18 @@ ActiveRecord::Schema[7.0].define(version: 2023_09_02_171216) do
t.index ["account_id"], name: "index_encrypted_configs_on_account_id" t.index ["account_id"], name: "index_encrypted_configs_on_account_id"
end end
create_table "submission_events", force: :cascade do |t|
t.bigint "submission_id", null: false
t.bigint "submitter_id"
t.text "data", null: false
t.string "event_type", null: false
t.datetime "event_timestamp", null: false
t.datetime "created_at", null: false
t.datetime "updated_at", null: false
t.index ["submission_id"], name: "index_submission_events_on_submission_id"
t.index ["submitter_id"], name: "index_submission_events_on_submitter_id"
end
create_table "submissions", force: :cascade do |t| create_table "submissions", force: :cascade do |t|
t.bigint "template_id", null: false t.bigint "template_id", null: false
t.bigint "created_by_user_id" t.bigint "created_by_user_id"
@@ -101,6 +113,7 @@ ActiveRecord::Schema[7.0].define(version: 2023_09_02_171216) do
t.text "template_schema" t.text "template_schema"
t.text "template_submitters" t.text "template_submitters"
t.text "source", null: false t.text "source", null: false
t.string "submitters_order", null: false
t.index ["created_by_user_id"], name: "index_submissions_on_created_by_user_id" t.index ["created_by_user_id"], name: "index_submissions_on_created_by_user_id"
t.index ["template_id"], name: "index_submissions_on_template_id" t.index ["template_id"], name: "index_submissions_on_template_id"
end end
@@ -177,6 +190,8 @@ ActiveRecord::Schema[7.0].define(version: 2023_09_02_171216) do
add_foreign_key "active_storage_variant_records", "active_storage_blobs", column: "blob_id" add_foreign_key "active_storage_variant_records", "active_storage_blobs", column: "blob_id"
add_foreign_key "document_generation_events", "submitters" add_foreign_key "document_generation_events", "submitters"
add_foreign_key "encrypted_configs", "accounts" add_foreign_key "encrypted_configs", "accounts"
add_foreign_key "submission_events", "submissions"
add_foreign_key "submission_events", "submitters"
add_foreign_key "submissions", "templates" add_foreign_key "submissions", "templates"
add_foreign_key "submissions", "users", column: "created_by_user_id" add_foreign_key "submissions", "users", column: "created_by_user_id"
add_foreign_key "submitters", "submissions" add_foreign_key "submitters", "submissions"
+4
View File
@@ -15,4 +15,8 @@ module PdfIcons
def paperclip_io def paperclip_io
@paperclip_io ||= StringIO.new(PATH.join('paperclip.png').read) @paperclip_io ||= StringIO.new(PATH.join('paperclip.png').read)
end end
def logo_io
@logo_io ||= StringIO.new(PATH.join('logo.png').read)
end
end end
Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

+22 -10
View File
@@ -7,28 +7,24 @@ module ReplaceEmailVariables
SUBMITTER_EMAIL = '{{submitter.email}}' SUBMITTER_EMAIL = '{{submitter.email}}'
SUBMITTER_NAME = '{{submitter.name}}' SUBMITTER_NAME = '{{submitter.name}}'
SUBMISSION_LINK = '{{submission.link}}' SUBMISSION_LINK = '{{submission.link}}'
SUBMISSION_SUBMITTERS = '{{submission.submitters}}'
DOCUMENTS_LINKS = '{{documents.links}}' DOCUMENTS_LINKS = '{{documents.links}}'
module_function module_function
def call(text, submitter:) def call(text, submitter:)
submitter_link = submitter_link = build_submitter_link(submitter)
Rails.application.routes.url_helpers.submit_form_url(
slug: submitter.slug, **Docuseal.default_url_options
)
if submitter.submission submission_link = build_submission_link(submitter.submission) if submitter.submission
submission_link =
Rails.application.routes.url_helpers.submission_url(
submitter.submission, **Docuseal.default_url_options
)
end
text = text.gsub(TEMAPLTE_NAME, submitter.template.name) if submitter.template text = text.gsub(TEMAPLTE_NAME, submitter.template.name) if submitter.template
text = text.gsub(SUBMITTER_EMAIL, submitter.email) if submitter.email text = text.gsub(SUBMITTER_EMAIL, submitter.email) if submitter.email
text = text.gsub(SUBMITTER_NAME, submitter.name || submitter.email || submitter.phone) text = text.gsub(SUBMITTER_NAME, submitter.name || submitter.email || submitter.phone)
text = text.gsub(SUBMITTER_LINK, submitter_link) text = text.gsub(SUBMITTER_LINK, submitter_link)
text = text.gsub(SUBMISSION_LINK, submission_link) if submission_link text = text.gsub(SUBMISSION_LINK, submission_link) if submission_link
if text.include?(SUBMISSION_SUBMITTERS)
text = text.gsub(SUBMISSION_SUBMITTERS, build_submission_submitters(submitter.submission))
end
text = text.gsub(DOCUMENTS_LINKS, build_documents_links_text(submitter)) text = text.gsub(DOCUMENTS_LINKS, build_documents_links_text(submitter))
text = text.gsub(ACCOUNT_NAME, submitter.template.account.name) if submitter.template text = text.gsub(ACCOUNT_NAME, submitter.template.account.name) if submitter.template
@@ -46,4 +42,20 @@ module ReplaceEmailVariables
"#{link}\n" "#{link}\n"
end.join end.join
end end
def build_submitter_link(submitter)
Rails.application.routes.url_helpers.submit_form_url(
slug: submitter.slug,
t: SubmissionEvents.build_tracking_param(submitter, 'click_email'),
**Docuseal.default_url_options
)
end
def build_submission_link(submission)
Rails.application.routes.url_helpers.submission_url(submission, **Docuseal.default_url_options)
end
def build_submission_submitters(submission)
submission.submitters.order(:completed_at).map { |e| e.name || e.email || e.phone }.join(', ')
end
end end
+33
View File
@@ -0,0 +1,33 @@
# frozen_string_literal: true
module SubmissionEvents
TRACKING_PARAM_LENGTH = 6
EVENT_NAMES = {
send_email: 'Email sent',
send_sms: 'SMS sent',
open_email: 'Email opened',
click_email: 'Email link clicked',
click_sms: 'SMS link clicked',
start_form: 'Submission started',
view_form: 'Form viewed',
complete_form: 'Submission completed'
}.freeze
module_function
def build_tracking_param(submitter, event_type = 'click_email')
Base64.urlsafe_encode64(
[submitter.slug, event_type, Rails.application.secrets.secret_key_base].join(':')
).first(TRACKING_PARAM_LENGTH)
end
def create_with_tracking_data(submitter, event_type, request)
SubmissionEvent.create!(submitter:, event_type:, data: {
ip: request.remote_ip,
ua: request.user_agent,
sid: request.session.id.to_s,
uid: request.env['warden'].user(:user)&.id
}.compact_blank)
end
end
+28 -8
View File
@@ -1,6 +1,8 @@
# frozen_string_literal: true # frozen_string_literal: true
module Submissions module Submissions
DEFAULT_SUBMITTERS_ORDER = 'random'
module_function module_function
def update_template_fields!(submission) def update_template_fields!(submission)
@@ -24,9 +26,11 @@ module Submissions
end end
end end
def create_from_submitters(template:, user:, submissions_attrs:, source:, mark_as_sent: false) def create_from_submitters(template:, user:, submissions_attrs:, source:, mark_as_sent: false,
submitters_order: DEFAULT_SUBMITTERS_ORDER)
submissions_attrs.map do |attrs| submissions_attrs.map do |attrs|
submission = template.submissions.new(created_by_user: user, source:, template_submitters: template.submitters) submission = template.submissions.new(created_by_user: user, source:,
template_submitters: template.submitters, submitters_order:)
attrs[:submitters].each_with_index do |submitter_attrs, index| attrs[:submitters].each_with_index do |submitter_attrs, index|
uuid = uuid =
@@ -36,15 +40,31 @@ module Submissions
next if uuid.blank? next if uuid.blank?
submission.submitters.new(email: submitter_attrs[:email], is_order_sent = submitters_order == 'random' || index.zero?
phone: submitter_attrs[:phone].to_s.gsub(/[^0-9+]/, ''),
name: submitter_attrs[:name], submission.submitters.new(
sent_at: mark_as_sent && submitter_attrs[:email].present? ? Time.current : nil, email: submitter_attrs[:email],
values: submitter_attrs[:values] || {}, phone: submitter_attrs[:phone].to_s.gsub(/[^0-9+]/, ''),
uuid:) name: submitter_attrs[:name],
sent_at: mark_as_sent && submitter_attrs[:email].present? && is_order_sent ? Time.current : nil,
values: submitter_attrs[:values] || {},
uuid:
)
end end
submission.tap(&:save!) submission.tap(&:save!)
end end
end end
def send_signature_requests(submissions, params)
submissions.each do |submission|
if submission.submitters_order_preserved?
first_submitter = submission.submitters.find { |e| e.uuid == submission.template_submitters.first['uuid'] }
Submitters.send_signature_requests([first_submitter], params)
else
Submitters.send_signature_requests(submission.submitters, params)
end
end
end
end end
+273
View File
@@ -0,0 +1,273 @@
# frozen_string_literal: true
module Submissions
module GenerateAuditTrail
FONT_SIZE = 9
TEXT_COLOR = '525252'
FONT_PATH = '/LiberationSans-Regular.ttf'
FONT_BOLD_PATH = '/LiberationSans-Bold.ttf'
FONT_NAME = if File.exist?(FONT_PATH)
FONT_PATH
else
'Helvetica'
end
FONT_BOLD_NAME = if File.exist?(FONT_BOLD_PATH)
FONT_BOLD_PATH
else
'Helvetica'
end
INFO_CREATOR = "#{Docuseal::PRODUCT_NAME} (#{Docuseal::PRODUCT_URL})".freeze
SIGN_REASON = 'Signed with DocuSeal.co'
VERIFIED_TEXT = if Docuseal.multitenant?
'Verified by DocuSeal'
else
'Verified'
end
module_function
# rubocop:disable Metrics
def call(submission)
account = submission.template.account
pkcs = Accounts.load_signing_pkcs(account)
verify_url = Rails.application.routes.url_helpers.settings_esign_url(**Docuseal.default_url_options)
composer = HexaPDF::Composer.new(skip_page_creation: true)
composer.document.fonts.add(FONT_BOLD_NAME, variant: :bold)
divider = HexaPDF::Layout::Box.create(
margin: [0, 0, 15, 0],
border: {
width: [1, 0, 0, 0],
color: %w[hp-gray-light]
},
height: 1
)
composer.page_style(:default, page_size: :A4) do |canvas, style|
box = canvas.context.box(:media)
canvas.save_graphics_state do
canvas.fill_color('FAF7F5')
.rectangle(0, 0, box.width, 20)
.rectangle(0, box.height - 20, box.width, 20)
.fill
end
style.frame = style.create_frame(canvas.context, 50)
end
composer.style(:base, font: FONT_NAME, font_size: FONT_SIZE, fill_color: TEXT_COLOR, line_spacing: 1.2)
composer.style(:link, fill_color: 'hp-blue-light', underline: true)
composer.new_page
composer.column(columns: 1) do |column|
column.image(PdfIcons.logo_io, width: 40, height: 40, position: :float)
column.formatted_text([{ text: 'DocuSeal',
link: Docuseal::PRODUCT_URL }],
font_size: 20,
font: [FONT_BOLD_NAME, { variant: :bold }],
width: 100,
padding: [12, 0, 0, 8],
position: :float, position_hint: :left)
column.text('Audit Log',
font_size: 16,
padding: [15, 0, 0, 0],
position: :float, position_hint: :right)
end
composer.column(columns: 1) do |column|
column.text("Envelope ID: #{submission.id}", font_size: 12, padding: [20, 0, 10, 0], position: :float)
column.formatted_text([
{ link: verify_url, text: 'Verify', style: :link }
], font_size: 9, padding: [22, 0, 10, 0], position: :float, align: :right)
end
composer.draw_box(divider)
last_submitter = submission.submitters.where.not(completed_at: nil).order(:completed_at).last
documents_data = Submitters.select_attachments_for_download(last_submitter).map do |document|
original_documents = submission.template.documents.select { |e| e.uuid == document.uuid }.presence
original_documents ||= submission.template.documents.select do |e|
e.image? && submission.schema.any? do |item|
item['attachment_uuid'] == e.uuid
end
end
link =
Rails.application.routes.url_helpers.rails_blob_url(document, **Docuseal.default_url_options)
[
composer.document.layout.formatted_text_box(
[{ text: document.filename.to_s, link: }]
),
composer.document.layout.formatted_text_box(
[
{ text: "Original SHA256:\n", font: [FONT_BOLD_NAME, { variant: :bold }] },
original_documents.map { |d| d.metadata['sha256'] || d.checksum }.join("\n"),
"\n",
{ text: "Result SHA256:\n", font: [FONT_BOLD_NAME, { variant: :bold }] },
document.metadata['sha256'] || document.checksum,
"\n",
{ text: 'Generated at: ', font: [FONT_BOLD_NAME, { variant: :bold }] },
I18n.l(document.created_at, format: :long, locale: account.locale)
], line_spacing: 1.8
)
]
end
composer.table(documents_data, cell_style: { padding: [0, 0, 25, 0], border: { width: 0 } })
composer.draw_box(divider)
submission.template_submitters.filter_map do |item|
submitter = submission.submitters.find { |e| e.uuid == item['uuid'] }
next if submitter.blank?
completed_event =
submission.submission_events.find { |e| e.submitter_id == submitter.id && e.complete_form? } ||
SubmissionEvent.new
click_email_event =
submission.submission_events.find { |e| e.submitter_id == submitter.id && e.click_email? }
is_phone_verified =
submission.template_fields.any? do |e|
e['type'] == 'phone' && e['submitter_uuid'] == submitter.uuid && submitter.values[e['uuid']].present?
end
submitter_field_counters = Hash.new { 0 }
info_rows = [
[
composer.document.layout.formatted_text_box(
[
submission.template_submitters.size > 1 && { text: "#{item['name']}\n" },
submitter.email && { text: "#{submitter.email}\n", font: [FONT_BOLD_NAME, { variant: :bold }] },
submitter.name && { text: "#{submitter.name}\n" },
submitter.phone && { text: "#{submitter.phone}\n" }
].compact_blank, line_spacing: 1.8, padding: [0, 20, 0, 0]
)
],
[
composer.document.layout.formatted_text_box(
[
submitter.email && {
text: "Email verification: #{click_email_event ? VERIFIED_TEXT : 'Unverififed'}\n"
},
submitter.phone && {
text: "Phone verification: #{is_phone_verified ? VERIFIED_TEXT : 'Unverififed'}\n"
},
completed_event.data['ip'] && { text: "IP: #{completed_event.data['ip']}\n" },
completed_event.data['sid'] && { text: "Session ID: #{completed_event.data['sid']}\n" },
completed_event.data['ua'] && { text: "User agent: #{completed_event.data['ua']}\n" },
"\n"
].compact_blank, line_spacing: 1.8, padding: [10, 20, 20, 0]
)
]
]
composer.table(info_rows, cell_style: { padding: [0, 0, 0, 0], border: { width: 0 } })
composer.column(columns: 1, gaps: 0, style: { padding: [0, 200, 0, 0] }) do |column|
submission.template_fields.filter_map do |field|
next if field['submitter_uuid'] != submitter.uuid
submitter_field_counters[field['type']] += 1
value = submitter.values[field['uuid']]
next if Array.wrap(value).compact_blank.blank?
[
column.formatted_text_box(
[
{
text: field['name'].to_s.upcase.presence ||
"#{field['type']} Field #{submitter_field_counters[field['type']]}\n".upcase,
font_size: 6
}
].compact_blank, line_spacing: 1.8, padding: [0, 0, 5, 0]
),
if field['type'].in?(%w[image signature])
attachment = submitter.attachments.find { |a| a.uuid == value }
image = Vips::Image.new_from_buffer(attachment.download, '').autorot
scale = [300.0 / image.width, 300.0 / image.height].min
io = StringIO.new(image.resize([scale, 1].min).write_to_buffer('.png'))
column.image(io, padding: [0, 100, 10, 0])
column.formatted_text_box([{ text: '' }])
elsif field['type'] == 'file'
column.formatted_text_box(
Array.wrap(value).map do |uuid|
attachment = submitter.attachments.find { |a| a.uuid == uuid }
link =
Rails.application.routes.url_helpers.rails_blob_url(attachment, **Docuseal.default_url_options)
{ link:, text: "#{attachment.filename}\n", style: :link }
end,
padding: [0, 0, 10, 0]
)
elsif field['type'] == 'checkbox'
column.formatted_text_box([{ text: value.to_s.titleize }], padding: [0, 0, 10, 0])
else
value = I18n.l(Date.parse(value), format: :long, locale: account.locale) if field['type'] == 'date'
value = value.join(', ') if value.is_a?(Array)
column.formatted_text_box([{ text: value.to_s.presence || 'n/a' }], padding: [0, 0, 10, 0])
end
]
end
end
composer.draw_box(divider)
end
composer.text('Event Log', font_size: 12, padding: [10, 0, 20, 0])
events_data = submission.submission_events.sort_by(&:event_timestamp).map do |event|
submitter = submission.submitters.find { |e| e.id == event.submitter_id }
[
I18n.l(event.event_timestamp, format: :long, locale: account.locale),
composer.document.layout.formatted_text_box(
[
{ text: SubmissionEvents::EVENT_NAMES[event.event_type.to_sym],
font: [FONT_BOLD_NAME, { variant: :bold }] },
event.event_type.include?('send_') ? ' to ' : ' by ',
if event.event_type.include?('sms')
submitter.phone
else
(submitter.email || submitter.name || submitter.phone)
end
]
)
]
end
composer.table(events_data, cell_style: { padding: [0, 0, 20, 0], border: { width: 0 } }) if events_data.present?
io = StringIO.new
composer.document.trailer.info[:Creator] = INFO_CREATOR
composer.document.sign(io, reason: SIGN_REASON,
certificate: pkcs.certificate,
key: pkcs.key,
certificate_chain: pkcs.ca_certs || [])
ActiveStorage::Attachment.create!(
blob: ActiveStorage::Blob.create_and_upload!(
io: StringIO.new(io.string), filename: "Audit Log - #{submission.template.name}.pdf"
),
name: 'audit_trail',
record: submission
)
end
# rubocop:enable Metrics
end
end
@@ -28,7 +28,8 @@ module Submissions
template = submitter.submission.template template = submitter.submission.template
pkcs = Accounts.load_signing_pkcs(submitter.submission.template.account) account = submitter.submission.template.account
pkcs = Accounts.load_signing_pkcs(account)
pdfs_index = build_pdfs_index(submitter) pdfs_index = build_pdfs_index(submitter)
@@ -40,6 +41,7 @@ module Submissions
pdf.fonts.add(FONT_NAME) pdf.fonts.add(FONT_NAME)
page = pdf.pages[area['page']] page = pdf.pages[area['page']]
page.rotate(0, flatten: true) if page[:Rotate] != 0
page[:Annots] ||= [] page[:Annots] ||= []
page[:Annots] = page[:Annots].reject { |e| e[:A] && e[:A][:URI].to_s.starts_with?('file:///docuseal_field') } page[:Annots] = page[:Annots].reject { |e| e[:A] && e[:A][:URI].to_s.starts_with?('file:///docuseal_field') }
@@ -148,7 +150,7 @@ module Submissions
height - (area['y'] * height)) height - (area['y'] * height))
end end
else else
value = I18n.l(Date.parse(value), format: :long) if field['type'] == 'date' value = I18n.l(Date.parse(value), format: :long, locale: account.locale) if field['type'] == 'date'
text = HexaPDF::Layout::TextFragment.create(Array.wrap(value).join(', '), font: pdf.fonts.add(FONT_NAME), text = HexaPDF::Layout::TextFragment.create(Array.wrap(value).join(', '), font: pdf.fonts.add(FONT_NAME),
font_size:) font_size:)
@@ -213,6 +215,7 @@ module Submissions
blob: ActiveStorage::Blob.create_and_upload!( blob: ActiveStorage::Blob.create_and_upload!(
io: StringIO.new(io.string), filename: "#{name}.pdf" io: StringIO.new(io.string), filename: "#{name}.pdf"
), ),
metadata: { sha256: Base64.urlsafe_encode64(Digest::SHA256.digest(io.string)) },
name: 'documents', name: 'documents',
record: submitter record: submitter
) )
+1 -1
View File
@@ -35,7 +35,7 @@ module Submitters
submitters.each do |submitter| submitters.each do |submitter|
next if submitter.email.blank? next if submitter.email.blank?
SubmitterMailer.invitation_email(submitter, message: params[:message]).deliver_later! SendSubmitterInvitationEmailJob.perform_later(submitter)
end end
end end
end end
+9 -11
View File
@@ -7,23 +7,19 @@ module Submitters
module_function module_function
def call(submitter, params, request) def call(submitter, params, request)
Submissions.update_template_fields!(submitter.submission) if submitter.submission.template_fields.blank? if submitter.submission.template_fields.blank?
Submissions.update_template_fields!(submitter.submission)
SubmissionEvents.create_with_tracking_data(submitter, 'start_form', request)
end
update_submitter!(submitter, params, request) update_submitter!(submitter, params, request)
submitter.submission.save! submitter.submission.save!
return unless submitter.completed_at? return submitter unless submitter.completed_at?
GenerateSubmitterResultAttachmentsJob.perform_later(submitter) ProcessSubmitterCompletionJob.perform_later(submitter)
if submitter.account.encrypted_configs.exists?(key: EncryptedConfig::WEBHOOK_URL_KEY)
SendWebhookRequestJob.perform_later(submitter)
end
submitter.submission.template.account.users.active.admins.each do |user|
SubmitterMailer.completed_email(submitter, user).deliver_later!
end
submitter submitter
end end
@@ -40,6 +36,8 @@ module Submitters
submitter.completed_at = Time.current submitter.completed_at = Time.current
submitter.ip = request.remote_ip submitter.ip = request.remote_ip
submitter.ua = request.user_agent submitter.ua = request.user_agent
SubmissionEvents.create_with_tracking_data(submitter, 'complete_form', request)
end end
submitter.save! submitter.save!
+2
View File
@@ -19,6 +19,7 @@ module Templates
if blob.content_type == PDF_CONTENT_TYPE && blob.metadata['pdf'].nil? if blob.content_type == PDF_CONTENT_TYPE && blob.metadata['pdf'].nil?
blob.metadata['pdf'] = { 'annotations' => Templates::BuildAnnotations.call(document_data) } blob.metadata['pdf'] = { 'annotations' => Templates::BuildAnnotations.call(document_data) }
blob.metadata['sha256'] = Base64.urlsafe_encode64(Digest::SHA256.digest(document_data))
end end
blob.save! blob.save!
@@ -37,6 +38,7 @@ module Templates
if file.content_type == PDF_CONTENT_TYPE if file.content_type == PDF_CONTENT_TYPE
metadata = { 'identified' => true, 'analyzed' => true, metadata = { 'identified' => true, 'analyzed' => true,
'sha256' => Base64.urlsafe_encode64(Digest::SHA256.digest(data)),
'pdf' => { 'annotations' => Templates::BuildAnnotations.call(data) } } 'pdf' => { 'annotations' => Templates::BuildAnnotations.call(data) } }
end end
+1 -1
View File
@@ -81,7 +81,7 @@ RSpec.describe 'Submit Form' do
expect do expect do
click_on 'submit' click_on 'submit'
end.to change(enqueued_jobs, :size).by(3) end.to change(enqueued_jobs, :size).by(2)
end end
end end
end end