agreement_engine 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +17 -0
- data/.ruby-version +1 -1
- data/CHANGELOG.md +36 -0
- data/README.md +278 -17
- data/app/controllers/agreement_engine/admin/documents_controller.rb +6 -32
- data/app/controllers/agreement_engine/admin/issues_controller.rb +50 -0
- data/app/controllers/agreement_engine/agreements_controller.rb +5 -5
- data/app/controllers/agreement_engine/consents_controller.rb +47 -0
- data/app/controllers/agreement_engine/documents_controller.rb +4 -7
- data/app/controllers/agreement_engine/receipts_controller.rb +31 -0
- data/app/controllers/agreement_engine/record_documents_controller.rb +47 -0
- data/app/controllers/agreement_engine/signatures_controller.rb +89 -0
- data/app/controllers/agreement_engine/verifications_controller.rb +18 -0
- data/app/mailers/agreement_engine/receipt_mailer.rb +18 -0
- data/app/models/agreement_engine/acceptance.rb +84 -0
- data/app/models/agreement_engine/consent_withdrawal.rb +13 -0
- data/app/models/agreement_engine/document.rb +81 -3
- data/app/views/agreement_engine/admin/documents/index.html.erb +1 -2
- data/app/views/agreement_engine/admin/documents/show.html.erb +52 -2
- data/app/views/agreement_engine/admin/issues/new.html.erb +51 -0
- data/app/views/agreement_engine/agreements/show.html.erb +4 -1
- data/app/views/agreement_engine/consents/show.html.erb +19 -0
- data/app/views/agreement_engine/documents/_issued_version.html.erb +5 -0
- data/app/views/agreement_engine/documents/{terms.html.erb → show.html.erb} +4 -4
- data/app/views/agreement_engine/receipt_mailer/copy.text.erb +5 -0
- data/app/views/agreement_engine/signatures/show.html.erb +37 -0
- data/app/views/agreement_engine/verifications/show.html.erb +22 -0
- data/config/locales/en.yml +44 -0
- data/config/routes.rb +12 -3
- data/db/migrate/20261120011146_add_issued_versions_to_agreement_engine_documents.rb +8 -0
- data/db/migrate/20261120022247_create_agreement_engine_acceptances.rb +22 -0
- data/db/migrate/20261120023407_create_agreement_engine_consent_withdrawals.rb +12 -0
- data/db/migrate/20261120024007_add_signature_fields_to_agreement_engine_acceptances.rb +7 -0
- data/db/migrate/20261120030101_add_subject_to_agreement_engine_documents.rb +9 -0
- data/db/migrate/20261120041730_add_carry_over_to_agreement_engine_acceptances.rb +8 -0
- data/db/migrate/20261120141925_add_period_to_agreement_engine_acceptances.rb +6 -0
- data/db/migrate/20261120143946_add_database_guards_to_agreement_engine.rb +9 -0
- data/db/migrate/20261120145611_add_one_signature_index_to_agreement_engine_acceptances.rb +5 -0
- data/docs/byte-form/examples/blank-standing/bytes.json +1 -0
- data/docs/byte-form/examples/blank-standing/input.json +15 -0
- data/docs/byte-form/examples/blank-standing/sha256 +1 -0
- data/docs/byte-form/examples/with-values/bytes.json +1 -0
- data/docs/byte-form/examples/with-values/input.json +15 -0
- data/docs/byte-form/examples/with-values/sha256 +1 -0
- data/docs/byte-form.md +44 -0
- data/exe/agreement_engine-verify +14 -0
- data/lib/agreement_engine/acceptance_event.rb +22 -0
- data/lib/agreement_engine/byte_form.rb +28 -0
- data/lib/agreement_engine/configuration.rb +35 -2
- data/lib/agreement_engine/consent.rb +26 -0
- data/lib/agreement_engine/database_guards.rb +46 -0
- data/lib/agreement_engine/document_type.rb +23 -0
- data/lib/agreement_engine/enforceable.rb +6 -7
- data/lib/agreement_engine/engine.rb +7 -0
- data/lib/agreement_engine/html_to_page.rb +63 -0
- data/lib/agreement_engine/integrity.rb +23 -0
- data/lib/agreement_engine/pages_elements.rb +29 -0
- data/lib/agreement_engine/period.rb +23 -0
- data/lib/agreement_engine/receipt.rb +43 -0
- data/lib/agreement_engine/seed.rb +37 -0
- data/lib/agreement_engine/signable.rb +25 -9
- data/lib/agreement_engine/upgrade.rb +75 -0
- data/lib/agreement_engine/verification.rb +13 -0
- data/lib/agreement_engine/version.rb +1 -1
- data/lib/agreement_engine.rb +43 -1
- data/lib/generators/agreement_engine/templates/initializer.rb +5 -4
- data/lib/tasks/agreement_engine.rake +18 -15
- metadata +64 -9
- data/app/views/agreement_engine/admin/documents/_form.html.erb +0 -44
- data/app/views/agreement_engine/admin/documents/edit.html.erb +0 -5
- data/app/views/agreement_engine/admin/documents/new.html.erb +0 -5
- data/app/views/agreement_engine/documents/privacy.html.erb +0 -16
- data/lib/agreement_engine/agreement.rb +0 -23
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module AgreementEngine
|
|
4
|
+
module Period
|
|
5
|
+
module_function
|
|
6
|
+
|
|
7
|
+
def describe(period)
|
|
8
|
+
return if period.blank?
|
|
9
|
+
return "#{ActiveSupport::Duration.parse(period["duration"]).inspect} from acceptance" if period["duration"]
|
|
10
|
+
|
|
11
|
+
starts = period["starts_on"]&.to_date
|
|
12
|
+
ends = period["ends_on"]&.to_date
|
|
13
|
+
return "#{day(starts)} to #{day(ends)}" if starts && ends
|
|
14
|
+
return "from #{day(starts)}" if starts
|
|
15
|
+
|
|
16
|
+
"until #{day(ends)}"
|
|
17
|
+
end
|
|
18
|
+
|
|
19
|
+
def day(date)
|
|
20
|
+
date.strftime("%-d %B %Y")
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "keystone_ui/pages/pdf_drawing"
|
|
4
|
+
|
|
5
|
+
module AgreementEngine
|
|
6
|
+
module Receipt
|
|
7
|
+
module_function
|
|
8
|
+
|
|
9
|
+
def pdf(acceptance)
|
|
10
|
+
copy = acceptance.document.frozen_copy
|
|
11
|
+
surface = KeystoneUi::Pages::PdfSurface.new(KeystoneUi::Pages::PdfLook.host)
|
|
12
|
+
KeystoneUi::Pages::PdfDrawing.draw(copy["document"], surface, values: copy["values"] || {})
|
|
13
|
+
surface.space(KeystoneUi::Pages::PdfDrawing::SPACING, 8)
|
|
14
|
+
summary_lines(acceptance).each do |line|
|
|
15
|
+
surface.text(line, size: KeystoneUi::Pages::PdfElements::NOTE_SIZE, font: "--ks-font-body", color: "--ks-color-text-muted", leading: "--leading-relaxed")
|
|
16
|
+
end
|
|
17
|
+
surface.render
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
def summary_lines(acceptance)
|
|
21
|
+
[
|
|
22
|
+
"SHA-256: #{acceptance.content_hash}",
|
|
23
|
+
"Accepted: #{acceptance.accepted_at.utc.strftime("%Y-%m-%d %H:%M:%S UTC")}",
|
|
24
|
+
("Typed name: #{acceptance.typed_name}" if acceptance.typed_name.present?),
|
|
25
|
+
period_line(acceptance),
|
|
26
|
+
"agreement_engine #{acceptance.engine_version}, keystone_ui-pages #{acceptance.pages_version}"
|
|
27
|
+
].compact
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
def period_line(acceptance)
|
|
31
|
+
described = Period.describe(acceptance.document.frozen_copy.to_h["period"])
|
|
32
|
+
return unless described
|
|
33
|
+
|
|
34
|
+
dates = [acceptance.period_starts_on, acceptance.period_ends_on].compact
|
|
35
|
+
dates.size == 2 && acceptance.document.frozen_copy["period"]["duration"] ? "Period: #{described}, #{Period.day(dates[0])} to #{Period.day(dates[1])}" : "Period: #{described}"
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
def byte_form(acceptance)
|
|
39
|
+
copy = acceptance.document.frozen_copy
|
|
40
|
+
ByteForm.encode(slug: copy["slug"], number: copy["number"], document: copy["document"], values: copy["values"] || {}, period: copy["period"])
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require "securerandom"
|
|
4
|
+
|
|
5
|
+
module AgreementEngine
|
|
6
|
+
module Seed
|
|
7
|
+
module_function
|
|
8
|
+
|
|
9
|
+
def run
|
|
10
|
+
AgreementEngine.config.registered_document_types.select(&:standing?).filter_map do |type|
|
|
11
|
+
next Consent.seed! if type.key == Consent::TYPE.key
|
|
12
|
+
|
|
13
|
+
issue_starting_version(type, placeholder_text(type))
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
def issue_starting_version(type, text)
|
|
18
|
+
return if Document.where(document_type: type.key.to_s, subject_id: nil).exists?
|
|
19
|
+
|
|
20
|
+
page = KeystoneUi::Pages::Page.create!(name: type.title, slug: "agreement-#{type.key.to_s.dasherize}", document: document_of(text))
|
|
21
|
+
page.publish
|
|
22
|
+
Document.issue!(type: type.key, page_version: page.live_version, version: "1.0", effective_at: Time.current)
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
def placeholder_text(type)
|
|
26
|
+
[[:heading, type.title], [:paragraph, "This is a placeholder. Replace it with your #{type.title.downcase} in the page builder, then issue a new version."]]
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
def document_of(text)
|
|
30
|
+
document = KeystoneUi::Pages::Document.blank
|
|
31
|
+
document["sections"][0]["rows"][0]["columns"][0]["elements"] = text.map do |key, value|
|
|
32
|
+
{"id" => SecureRandom.uuid, "key" => key.to_s, "fields" => {"text" => value}}
|
|
33
|
+
end
|
|
34
|
+
document
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
@@ -5,19 +5,35 @@ module AgreementEngine
|
|
|
5
5
|
extend ActiveSupport::Concern
|
|
6
6
|
|
|
7
7
|
included do
|
|
8
|
-
|
|
9
|
-
belongs_to :"accepted_#{agreement.document_type}_version",
|
|
10
|
-
class_name: "AgreementEngine::Document",
|
|
11
|
-
optional: true
|
|
12
|
-
end
|
|
8
|
+
has_many :agreement_engine_acceptances, -> { order(:accepted_at, :id) }, as: :signer, class_name: "AgreementEngine::Acceptance"
|
|
13
9
|
end
|
|
14
10
|
|
|
15
|
-
def
|
|
16
|
-
|
|
11
|
+
def accepted_versions(document_type)
|
|
12
|
+
agreement_engine_acceptances.includes(:document).map(&:document).select { |document| document.document_type == document_type.to_s }
|
|
17
13
|
end
|
|
18
14
|
|
|
19
|
-
def
|
|
20
|
-
|
|
15
|
+
def accepted_current?(document_type)
|
|
16
|
+
current = AgreementEngine::Document.current(document_type)
|
|
17
|
+
current.nil? || agreement_engine_acceptances.exists?(document: current)
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
def holds_consent?
|
|
21
|
+
held_consent.present?
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
def held_consent
|
|
25
|
+
current = AgreementEngine::Document.current(AgreementEngine::Consent::TYPE.key)
|
|
26
|
+
return unless current
|
|
27
|
+
|
|
28
|
+
agreement_engine_acceptances.where(document: current).where.missing(:consent_withdrawal).last
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
def needs_acceptance?(document_type)
|
|
32
|
+
!accepted_current?(document_type)
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def accept_version!(version)
|
|
36
|
+
AgreementEngine::Acceptance.create!(signer: self, person: AgreementEngine::Acceptance.person_snapshot(self), document: version, content_hash: version.content_hash, byte_form_version: version.byte_form_version, accepted_at: Time.current)
|
|
21
37
|
end
|
|
22
38
|
end
|
|
23
39
|
end
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module AgreementEngine
|
|
4
|
+
module Upgrade
|
|
5
|
+
Report = Data.define(:left_out)
|
|
6
|
+
|
|
7
|
+
module_function
|
|
8
|
+
|
|
9
|
+
def run(signer_class: nil, time_column: nil)
|
|
10
|
+
left_out = []
|
|
11
|
+
legacy_versions.group_by(&:document_type).each do |document_type, versions|
|
|
12
|
+
page = page_for(document_type)
|
|
13
|
+
versions.each do |version|
|
|
14
|
+
missed = carry_over_version(page, version)
|
|
15
|
+
left_out << [version.document_type, version.version, missed] if missed.any?
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
carry_over_acceptances(signer_class, time_column) if signer_class
|
|
19
|
+
Report.new(left_out: left_out)
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
def carry_over_acceptances(signer_class, time_column)
|
|
23
|
+
AgreementEngine.config.registered_document_types.select(&:standing?).each do |type|
|
|
24
|
+
column = "accepted_#{type.key}_version_id"
|
|
25
|
+
next unless signer_class.column_names.include?(column)
|
|
26
|
+
|
|
27
|
+
signer_class.where.not(column => nil).find_each do |signer|
|
|
28
|
+
document = Document.find_by(id: signer.public_send(column))
|
|
29
|
+
next unless document
|
|
30
|
+
next if Acceptance.exists?(signer: signer, document: document, carried_over: true)
|
|
31
|
+
|
|
32
|
+
reported_time = time_column && signer.public_send(time_column)
|
|
33
|
+
evidence = evidence_at_upgrade(signer)
|
|
34
|
+
Acceptance.create!(
|
|
35
|
+
signer: signer,
|
|
36
|
+
document: document,
|
|
37
|
+
content_hash: document.content_hash,
|
|
38
|
+
byte_form_version: document.byte_form_version,
|
|
39
|
+
carried_over: true,
|
|
40
|
+
accepted_at: reported_time,
|
|
41
|
+
time_reported_by_host: reported_time.present?,
|
|
42
|
+
person: Acceptance.person_snapshot(signer).merge(evidence[:person].to_h.stringify_keys),
|
|
43
|
+
account: evidence[:account],
|
|
44
|
+
snapshot_taken_at: Time.current
|
|
45
|
+
)
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
def legacy_versions
|
|
51
|
+
Document.where(content_hash: nil, subject_id: nil).where.not(effective_at: nil).order(:effective_at, :id).to_a
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
def evidence_at_upgrade(signer)
|
|
55
|
+
AgreementEngine.config.evidence(nil, signer)
|
|
56
|
+
rescue => error
|
|
57
|
+
Rails.error.report(error, handled: true, source: "agreement_engine")
|
|
58
|
+
{}
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
def page_for(document_type)
|
|
62
|
+
KeystoneUi::Pages::Page.find_or_create_by!(slug: "agreement-#{document_type.to_s.dasherize}") do |page|
|
|
63
|
+
page.name = document_type.to_s.titleize
|
|
64
|
+
end
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
def carry_over_version(page, version)
|
|
68
|
+
converted = HtmlToPage.convert(version.content.body.to_html)
|
|
69
|
+
page.edit(converted.document)
|
|
70
|
+
page.publish
|
|
71
|
+
version.issue_in_place!(page.live_version)
|
|
72
|
+
converted.left_out
|
|
73
|
+
end
|
|
74
|
+
end
|
|
75
|
+
end
|
data/lib/agreement_engine.rb
CHANGED
|
@@ -1,8 +1,21 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
require_relative "agreement_engine/version"
|
|
4
|
+
require "keystone_ui/pages"
|
|
5
|
+
require "keystone_ui/pages/document"
|
|
4
6
|
require_relative "agreement_engine/configuration"
|
|
5
|
-
require_relative "agreement_engine/
|
|
7
|
+
require_relative "agreement_engine/document_type"
|
|
8
|
+
require_relative "agreement_engine/byte_form"
|
|
9
|
+
require_relative "agreement_engine/verification"
|
|
10
|
+
require_relative "agreement_engine/consent"
|
|
11
|
+
require_relative "agreement_engine/seed"
|
|
12
|
+
require_relative "agreement_engine/acceptance_event"
|
|
13
|
+
require_relative "agreement_engine/period"
|
|
14
|
+
require_relative "agreement_engine/receipt"
|
|
15
|
+
require_relative "agreement_engine/html_to_page"
|
|
16
|
+
require_relative "agreement_engine/upgrade"
|
|
17
|
+
require_relative "agreement_engine/integrity"
|
|
18
|
+
require_relative "agreement_engine/database_guards"
|
|
6
19
|
|
|
7
20
|
module AgreementEngine
|
|
8
21
|
class << self
|
|
@@ -13,6 +26,35 @@ module AgreementEngine
|
|
|
13
26
|
def configure
|
|
14
27
|
yield config
|
|
15
28
|
end
|
|
29
|
+
|
|
30
|
+
def issue_for!(type_key, record, period: nil)
|
|
31
|
+
type = document_type(type_key)
|
|
32
|
+
page_version = KeystoneUi::Pages::Page.find_by!(slug: type.template).live_version
|
|
33
|
+
values = config.values_method.call(record, type).to_h.stringify_keys
|
|
34
|
+
label = (Document.where(document_type: type.key.to_s, subject: record).count + 1).to_s
|
|
35
|
+
Document.issue!(type: type.key, page_version: page_version, version: label, effective_at: Time.current, subject: record, values: values, period: period)
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
def current_for(type_key, record)
|
|
39
|
+
Document.where(document_type: type_key.to_s, subject: record).order(:created_at, :id).last
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
def signers_for(type_key, record)
|
|
43
|
+
current_for(type_key, record)&.acceptances.to_a.map(&:signer).uniq
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
def in_force(on:, person: nil, account_id: nil, record: nil)
|
|
47
|
+
acceptances = Acceptance.includes(:document).order(:accepted_at, :id)
|
|
48
|
+
acceptances = acceptances.where(signer: person) if person
|
|
49
|
+
acceptances = acceptances.where(document: Document.where(subject: record)) if record
|
|
50
|
+
acceptances.select do |acceptance|
|
|
51
|
+
(account_id.nil? || acceptance.account.to_h["id"].to_s == account_id.to_s) && acceptance.in_force_on?(on)
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
def document_type(key)
|
|
56
|
+
config.registered_document_types.find { |type| type.key == key.to_sym }
|
|
57
|
+
end
|
|
16
58
|
end
|
|
17
59
|
end
|
|
18
60
|
|
|
@@ -10,9 +10,10 @@ AgreementEngine.configure do |config|
|
|
|
10
10
|
# controller.redirect_to("/", alert: "Not authorized") unless config.signed_in?(controller)
|
|
11
11
|
# }
|
|
12
12
|
|
|
13
|
-
#
|
|
14
|
-
#
|
|
15
|
-
#
|
|
16
|
-
# AgreementEngine::
|
|
13
|
+
# Register your documents. A standing type that prompts sends signed-in people
|
|
14
|
+
# to accept its current version:
|
|
15
|
+
# config.document_types = [
|
|
16
|
+
# AgreementEngine::DocumentType.new(key: :terms_of_service, title: "Terms of Service", kind: :standing, strength: :click_accept, prompts: true),
|
|
17
|
+
# AgreementEngine::DocumentType.new(key: :privacy_policy, title: "Privacy Policy", kind: :standing, strength: :click_accept, prompts: true)
|
|
17
18
|
# ]
|
|
18
19
|
end
|
|
@@ -1,23 +1,26 @@
|
|
|
1
1
|
namespace :agreement_engine do
|
|
2
|
-
desc "
|
|
2
|
+
desc "Issue a starting version for every registered standing document type that has none"
|
|
3
3
|
task seed: :environment do
|
|
4
4
|
puts "Seeding legal documents..."
|
|
5
|
+
AgreementEngine::Seed.run.compact.each { |document| puts " Issued #{document.document_type.titleize} v#{document.version}" }
|
|
6
|
+
puts "Done!"
|
|
7
|
+
end
|
|
5
8
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
document_type: agreement.document_type,
|
|
12
|
-
version: "1.0",
|
|
13
|
-
summary: "Initial #{agreement.title.downcase}",
|
|
14
|
-
content: "<h2>#{agreement.title}</h2><p>This is a placeholder. Please update with your actual #{agreement.title.downcase}.</p>",
|
|
15
|
-
effective_at: Time.current
|
|
16
|
-
)
|
|
17
|
-
puts " Created #{agreement.title} v1.0"
|
|
18
|
-
end
|
|
9
|
+
desc "Move legacy documents into pages and carry over each user's stored acceptances, as agreement_engine:upgrade[User,terms_accepted_at]"
|
|
10
|
+
task :upgrade, [:signer_class, :time_column] => :environment do |_task, args|
|
|
11
|
+
report = AgreementEngine::Upgrade.run(signer_class: (args[:signer_class] || "User").constantize, time_column: args[:time_column].presence&.to_sym)
|
|
12
|
+
report.left_out.each do |document_type, version, tags|
|
|
13
|
+
puts " #{document_type} #{version} could not carry over: #{tags.join(", ")}"
|
|
19
14
|
end
|
|
15
|
+
puts "Upgrade done."
|
|
16
|
+
end
|
|
20
17
|
|
|
21
|
-
|
|
18
|
+
desc "List every issued version and acceptance whose hashes disagree, and fail when one is found"
|
|
19
|
+
task check_hashes: :environment do
|
|
20
|
+
problems = AgreementEngine::Integrity.problems
|
|
21
|
+
problems.each { |problem| puts problem }
|
|
22
|
+
abort "#{problems.size} hash problem(s) found." if problems.any?
|
|
23
|
+
|
|
24
|
+
puts "Every hash agrees."
|
|
22
25
|
end
|
|
23
26
|
end
|
metadata
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: agreement_engine
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- tylercschneider
|
|
8
|
-
bindir:
|
|
8
|
+
bindir: exe
|
|
9
9
|
cert_chain: []
|
|
10
10
|
date: 1980-01-02 00:00:00.000000000 Z
|
|
11
11
|
dependencies:
|
|
@@ -23,6 +23,20 @@ dependencies:
|
|
|
23
23
|
- - "<"
|
|
24
24
|
- !ruby/object:Gem::Version
|
|
25
25
|
version: '3'
|
|
26
|
+
- !ruby/object:Gem::Dependency
|
|
27
|
+
name: keystone_ui-pages
|
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
|
29
|
+
requirements:
|
|
30
|
+
- - ">="
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: '0.15'
|
|
33
|
+
type: :runtime
|
|
34
|
+
prerelease: false
|
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
36
|
+
requirements:
|
|
37
|
+
- - ">="
|
|
38
|
+
- !ruby/object:Gem::Version
|
|
39
|
+
version: '0.15'
|
|
26
40
|
- !ruby/object:Gem::Dependency
|
|
27
41
|
name: rails
|
|
28
42
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -41,7 +55,8 @@ description: Track and enforce user acceptance of Terms of Service, Privacy Poli
|
|
|
41
55
|
and other legal agreements with versioned documents and audit trails.
|
|
42
56
|
email:
|
|
43
57
|
- tylercschneider@gmail.com
|
|
44
|
-
executables:
|
|
58
|
+
executables:
|
|
59
|
+
- agreement_engine-verify
|
|
45
60
|
extensions: []
|
|
46
61
|
extra_rdoc_files: []
|
|
47
62
|
files:
|
|
@@ -53,29 +68,69 @@ files:
|
|
|
53
68
|
- README.md
|
|
54
69
|
- Rakefile
|
|
55
70
|
- app/controllers/agreement_engine/admin/documents_controller.rb
|
|
71
|
+
- app/controllers/agreement_engine/admin/issues_controller.rb
|
|
56
72
|
- app/controllers/agreement_engine/agreements_controller.rb
|
|
73
|
+
- app/controllers/agreement_engine/consents_controller.rb
|
|
57
74
|
- app/controllers/agreement_engine/documents_controller.rb
|
|
75
|
+
- app/controllers/agreement_engine/receipts_controller.rb
|
|
76
|
+
- app/controllers/agreement_engine/record_documents_controller.rb
|
|
77
|
+
- app/controllers/agreement_engine/signatures_controller.rb
|
|
78
|
+
- app/controllers/agreement_engine/verifications_controller.rb
|
|
79
|
+
- app/mailers/agreement_engine/receipt_mailer.rb
|
|
80
|
+
- app/models/agreement_engine/acceptance.rb
|
|
81
|
+
- app/models/agreement_engine/consent_withdrawal.rb
|
|
58
82
|
- app/models/agreement_engine/document.rb
|
|
59
|
-
- app/views/agreement_engine/admin/documents/_form.html.erb
|
|
60
|
-
- app/views/agreement_engine/admin/documents/edit.html.erb
|
|
61
83
|
- app/views/agreement_engine/admin/documents/index.html.erb
|
|
62
|
-
- app/views/agreement_engine/admin/documents/new.html.erb
|
|
63
84
|
- app/views/agreement_engine/admin/documents/show.html.erb
|
|
85
|
+
- app/views/agreement_engine/admin/issues/new.html.erb
|
|
64
86
|
- app/views/agreement_engine/agreements/show.html.erb
|
|
65
|
-
- app/views/agreement_engine/
|
|
66
|
-
- app/views/agreement_engine/documents/
|
|
87
|
+
- app/views/agreement_engine/consents/show.html.erb
|
|
88
|
+
- app/views/agreement_engine/documents/_issued_version.html.erb
|
|
89
|
+
- app/views/agreement_engine/documents/show.html.erb
|
|
90
|
+
- app/views/agreement_engine/receipt_mailer/copy.text.erb
|
|
91
|
+
- app/views/agreement_engine/signatures/show.html.erb
|
|
92
|
+
- app/views/agreement_engine/verifications/show.html.erb
|
|
67
93
|
- app/views/layouts/agreement_engine/minimal.html.erb
|
|
68
94
|
- config/locales/en.yml
|
|
69
95
|
- config/routes.rb
|
|
70
96
|
- db/migrate/20260208000001_create_fine_print_documents.rb
|
|
71
97
|
- db/migrate/20260208000002_add_fine_print_to_users.rb
|
|
72
98
|
- db/migrate/20260921200000_rename_fine_print_tables_to_agreement_engine.rb
|
|
99
|
+
- db/migrate/20261120011146_add_issued_versions_to_agreement_engine_documents.rb
|
|
100
|
+
- db/migrate/20261120022247_create_agreement_engine_acceptances.rb
|
|
101
|
+
- db/migrate/20261120023407_create_agreement_engine_consent_withdrawals.rb
|
|
102
|
+
- db/migrate/20261120024007_add_signature_fields_to_agreement_engine_acceptances.rb
|
|
103
|
+
- db/migrate/20261120030101_add_subject_to_agreement_engine_documents.rb
|
|
104
|
+
- db/migrate/20261120041730_add_carry_over_to_agreement_engine_acceptances.rb
|
|
105
|
+
- db/migrate/20261120141925_add_period_to_agreement_engine_acceptances.rb
|
|
106
|
+
- db/migrate/20261120143946_add_database_guards_to_agreement_engine.rb
|
|
107
|
+
- db/migrate/20261120145611_add_one_signature_index_to_agreement_engine_acceptances.rb
|
|
108
|
+
- docs/byte-form.md
|
|
109
|
+
- docs/byte-form/examples/blank-standing/bytes.json
|
|
110
|
+
- docs/byte-form/examples/blank-standing/input.json
|
|
111
|
+
- docs/byte-form/examples/blank-standing/sha256
|
|
112
|
+
- docs/byte-form/examples/with-values/bytes.json
|
|
113
|
+
- docs/byte-form/examples/with-values/input.json
|
|
114
|
+
- docs/byte-form/examples/with-values/sha256
|
|
115
|
+
- exe/agreement_engine-verify
|
|
73
116
|
- lib/agreement_engine.rb
|
|
74
|
-
- lib/agreement_engine/
|
|
117
|
+
- lib/agreement_engine/acceptance_event.rb
|
|
118
|
+
- lib/agreement_engine/byte_form.rb
|
|
75
119
|
- lib/agreement_engine/configuration.rb
|
|
120
|
+
- lib/agreement_engine/consent.rb
|
|
121
|
+
- lib/agreement_engine/database_guards.rb
|
|
122
|
+
- lib/agreement_engine/document_type.rb
|
|
76
123
|
- lib/agreement_engine/enforceable.rb
|
|
77
124
|
- lib/agreement_engine/engine.rb
|
|
125
|
+
- lib/agreement_engine/html_to_page.rb
|
|
126
|
+
- lib/agreement_engine/integrity.rb
|
|
127
|
+
- lib/agreement_engine/pages_elements.rb
|
|
128
|
+
- lib/agreement_engine/period.rb
|
|
129
|
+
- lib/agreement_engine/receipt.rb
|
|
130
|
+
- lib/agreement_engine/seed.rb
|
|
78
131
|
- lib/agreement_engine/signable.rb
|
|
132
|
+
- lib/agreement_engine/upgrade.rb
|
|
133
|
+
- lib/agreement_engine/verification.rb
|
|
79
134
|
- lib/agreement_engine/version.rb
|
|
80
135
|
- lib/generators/agreement_engine/install_generator.rb
|
|
81
136
|
- lib/generators/agreement_engine/templates/initializer.rb
|
|
@@ -1,44 +0,0 @@
|
|
|
1
|
-
<%= form_with(model: document, url: url, class: "space-y-4") do |form| %>
|
|
2
|
-
<% if document.errors.any? %>
|
|
3
|
-
<div class="bg-red-50 border border-red-200 rounded p-4">
|
|
4
|
-
<h2 class="text-red-800 font-medium"><%= pluralize(document.errors.count, "error") %> prohibited this document from being saved:</h2>
|
|
5
|
-
<ul class="mt-2 list-disc list-inside text-red-700">
|
|
6
|
-
<% document.errors.full_messages.each do |message| %>
|
|
7
|
-
<li><%= message %></li>
|
|
8
|
-
<% end %>
|
|
9
|
-
</ul>
|
|
10
|
-
</div>
|
|
11
|
-
<% end %>
|
|
12
|
-
|
|
13
|
-
<div>
|
|
14
|
-
<%= form.label :document_type, class: "block text-sm font-medium text-gray-700" %>
|
|
15
|
-
<%= form.select :document_type,
|
|
16
|
-
AgreementEngine.config.agreements.map { |a| [a.title, a.document_type] },
|
|
17
|
-
{}, class: "mt-1 block w-full rounded-md border-gray-300 shadow-sm" %>
|
|
18
|
-
</div>
|
|
19
|
-
|
|
20
|
-
<div>
|
|
21
|
-
<%= form.label :version, class: "block text-sm font-medium text-gray-700" %>
|
|
22
|
-
<%= form.text_field :version, class: "mt-1 block w-full rounded-md border-gray-300 shadow-sm" %>
|
|
23
|
-
</div>
|
|
24
|
-
|
|
25
|
-
<div>
|
|
26
|
-
<%= form.label :summary, class: "block text-sm font-medium text-gray-700" %>
|
|
27
|
-
<%= form.text_area :summary, rows: 2, class: "mt-1 block w-full rounded-md border-gray-300 shadow-sm" %>
|
|
28
|
-
</div>
|
|
29
|
-
|
|
30
|
-
<div>
|
|
31
|
-
<%= form.label :effective_at, class: "block text-sm font-medium text-gray-700" %>
|
|
32
|
-
<%= form.datetime_local_field :effective_at, class: "mt-1 block w-full rounded-md border-gray-300 shadow-sm" %>
|
|
33
|
-
<p class="mt-1 text-sm text-gray-500">Leave blank to save as draft.</p>
|
|
34
|
-
</div>
|
|
35
|
-
|
|
36
|
-
<div>
|
|
37
|
-
<%= form.label :content, class: "block text-sm font-medium text-gray-700" %>
|
|
38
|
-
<%= form.rich_text_area :content, class: "mt-1 block w-full" %>
|
|
39
|
-
</div>
|
|
40
|
-
|
|
41
|
-
<div>
|
|
42
|
-
<%= form.submit class: "btn btn-primary" %>
|
|
43
|
-
</div>
|
|
44
|
-
<% end %>
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
<% content_for :title, "Privacy Policy" %>
|
|
2
|
-
|
|
3
|
-
<div class="mx-auto max-w-4xl px-4 py-12 sm:px-6 lg:px-8">
|
|
4
|
-
<article class="prose prose-gray dark:prose-invert max-w-none">
|
|
5
|
-
<h1>Privacy Policy</h1>
|
|
6
|
-
|
|
7
|
-
<% if @version %>
|
|
8
|
-
<p class="text-sm text-gray-500 dark:text-gray-400">
|
|
9
|
-
Version <%= @version.version %> - Effective <%= @version.effective_at.strftime("%B %d, %Y") %>
|
|
10
|
-
</p>
|
|
11
|
-
<%= @version.content %>
|
|
12
|
-
<% else %>
|
|
13
|
-
<p class="text-gray-500">No privacy policy has been published yet.</p>
|
|
14
|
-
<% end %>
|
|
15
|
-
</article>
|
|
16
|
-
</div>
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module AgreementEngine
|
|
4
|
-
Agreement = Data.define(:id, :title, :version_column, :document_type, :prompt_when_updated) do
|
|
5
|
-
def current_version
|
|
6
|
-
AgreementEngine::Document.current(document_type)
|
|
7
|
-
end
|
|
8
|
-
|
|
9
|
-
def accepted_by?(user)
|
|
10
|
-
current = current_version
|
|
11
|
-
return true unless current
|
|
12
|
-
user.public_send(version_column) == current.id
|
|
13
|
-
end
|
|
14
|
-
|
|
15
|
-
def not_accepted_by?(user)
|
|
16
|
-
!accepted_by?(user)
|
|
17
|
-
end
|
|
18
|
-
|
|
19
|
-
def to_param = id
|
|
20
|
-
|
|
21
|
-
def to_partial_path = "agreement_engine/agreements/#{id}"
|
|
22
|
-
end
|
|
23
|
-
end
|