trek 2.4.0 → 2.6.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.
Files changed (217) hide show
  1. checksums.yaml +4 -4
  2. data/.node-version +1 -1
  3. data/AGENTS.md +12 -8
  4. data/CHANGELOG.md +62 -0
  5. data/Gemfile +5 -0
  6. data/Gemfile.lock +205 -171
  7. data/Makefile +28 -1
  8. data/README.md +2 -2
  9. data/app/components/trek/dashboard/tile_component/tile_component.css +9 -0
  10. data/app/components/trek/dashboard/tile_component/tile_component.html.slim +4 -2
  11. data/app/components/trek/dashboard/tile_component.rb +12 -2
  12. data/app/components/trek/form/content_editor_component/content_editor_component.css +5 -0
  13. data/app/components/trek/form/content_editor_component/content_editor_component.html.slim +19 -93
  14. data/app/components/trek/form/content_editor_component/content_editor_component.js +94 -251
  15. data/app/components/trek/form/content_editor_component/extensions/block_view.js +40 -0
  16. data/app/components/trek/form/content_editor_component/extensions/image_block.js +28 -26
  17. data/app/components/trek/form/content_editor_component/extensions/prompts_block.js +15 -26
  18. data/app/components/trek/form/content_editor_component/extensions/table_of_contents.js +1 -3
  19. data/app/components/trek/form/content_editor_component.rb +15 -0
  20. data/app/components/trek/form/image_field_component/image_field_component.css +40 -1
  21. data/app/components/trek/form/image_field_component/image_field_component.html.slim +0 -9
  22. data/app/components/trek/form/image_field_component.rb +37 -14
  23. data/app/components/trek/list/item_component.rb +1 -1
  24. data/app/components/trek/list/tree/item_component.rb +2 -2
  25. data/app/components/trek/search_component/search_component.html.slim +2 -1
  26. data/app/components/trek/search_component.rb +9 -1
  27. data/app/content/trek/content/bullet_list.rb +10 -0
  28. data/app/content/trek/content/cleaner.rb +53 -0
  29. data/app/content/trek/content/document.rb +33 -0
  30. data/app/content/trek/content/image_block.rb +52 -0
  31. data/app/content/trek/content/link_resolver.rb +33 -0
  32. data/app/content/trek/content/list_item.rb +19 -0
  33. data/app/content/trek/content/ordered_list.rb +10 -0
  34. data/app/content/trek/content/paragraph.rb +10 -0
  35. data/app/content/trek/content/prompts_block.rb +21 -0
  36. data/app/content/trek/content.rb +38 -0
  37. data/app/controllers/concerns/trek/reorderable.rb +32 -3
  38. data/app/controllers/trek/csp_reports_controller.rb +17 -7
  39. data/app/controllers/trek/panels/base_controller.rb +3 -0
  40. data/app/controllers/trek/panels/links_controller.rb +1 -1
  41. data/app/controllers/trek/panels/prompts_controller.rb +2 -2
  42. data/app/controllers/trek/resource_controller.rb +5 -5
  43. data/app/helpers/trek/thumbnail_helper.rb +11 -0
  44. data/app/jobs/trek/purge_expired_sessions_job.rb +4 -3
  45. data/app/models/concerns/trek/contentable.rb +19 -10
  46. data/app/models/concerns/trek/pageable.rb +10 -1
  47. data/app/models/concerns/trek/users/sign_in_code.rb +70 -0
  48. data/app/models/concerns/trek/users/sign_in_lockout.rb +4 -2
  49. data/app/views/trek/panels/images/_form.html.slim +1 -1
  50. data/app/views/trek/panels/images/create.turbo_stream.slim +1 -1
  51. data/app/views/trek/panels/links/_form.html.slim +3 -5
  52. data/app/views/trek/panels/prompts/_form.html.slim +1 -1
  53. data/app/views/trek/panels/prompts/create.turbo_stream.slim +0 -1
  54. data/config/locales/trek.en.yml +40 -2
  55. data/config/locales/trek.fr.yml +40 -2
  56. data/docs/.vitepress/config.mjs +4 -1
  57. data/docs/background-jobs.md +69 -0
  58. data/docs/content-editor.md +219 -0
  59. data/docs/customize.md +2 -0
  60. data/docs/deploy.md +2 -2
  61. data/docs/getting-started.md +4 -4
  62. data/docs/index.md +1 -1
  63. data/docs/reference/components.md +2 -2
  64. data/docs/reference/concerns/contentable.md +11 -4
  65. data/docs/reference/concerns/formattable.md +1 -1
  66. data/docs/reference/controllers.md +1 -1
  67. data/docs/reference/environment-variables.md +1 -0
  68. data/docs/reference/formatters.md +4 -9
  69. data/docs/reference/forms.md +1 -1
  70. data/docs/reference/generators/audit-log.md +2 -2
  71. data/docs/reference/generators/install.md +3 -2
  72. data/docs/reference/generators/public-accounts.md +141 -0
  73. data/docs/reference/generators/security-headers.md +1 -1
  74. data/docs/reference/index.md +2 -1
  75. data/docs/reference/models/fragment.md +1 -0
  76. data/docs/reference/models/user.md +3 -1
  77. data/docs/what-is-trek.md +5 -5
  78. data/lib/generators/trek/audit_log_generator.rb +54 -0
  79. data/lib/generators/trek/helpers.rb +13 -5
  80. data/lib/generators/trek/install/admin/users_generator.rb +6 -1
  81. data/lib/generators/trek/install/admin_generator.rb +8 -0
  82. data/lib/generators/trek/install/appsignal_generator.rb +1 -1
  83. data/lib/generators/trek/install/audit_log_generator.rb +9 -45
  84. data/lib/generators/trek/install/authentication_generator.rb +1 -1
  85. data/lib/generators/trek/install/authorization_generator.rb +1 -1
  86. data/lib/generators/trek/install/good_job_generator.rb +161 -0
  87. data/lib/generators/trek/install/model_specs_generator.rb +3 -3
  88. data/lib/generators/trek/install/postmark_generator.rb +2 -2
  89. data/lib/generators/trek/install/ruby_generator.rb +1 -1
  90. data/lib/generators/trek/install/scalingo_generator.rb +7 -45
  91. data/lib/generators/trek/install/specs_generator.rb +11 -0
  92. data/lib/generators/trek/install/user_generator.rb +1 -1
  93. data/lib/generators/trek/install_generator.rb +15 -0
  94. data/lib/generators/trek/public_accounts_generator.rb +267 -0
  95. data/lib/generators/trek/scaffold_generator.rb +13 -5
  96. data/lib/generators/trek/scalingo_generator.rb +55 -0
  97. data/lib/generators/trek/templates/.gitlab-ci.yml +1 -1
  98. data/lib/generators/trek/templates/Makefile +1 -1
  99. data/lib/generators/trek/templates/controllers/admin/fragments_controller.rb +7 -0
  100. data/lib/generators/trek/templates/controllers/admin/panels/images_controller.rb +8 -0
  101. data/lib/generators/trek/templates/controllers/admin/panels/links_controller.rb +8 -0
  102. data/lib/generators/trek/templates/controllers/admin/panels/prompts_controller.rb +8 -0
  103. data/lib/generators/trek/templates/controllers/admin/password_renewals_controller.rb +11 -0
  104. data/lib/generators/trek/templates/controllers/admin/user_sessions_controller.rb +1 -1
  105. data/lib/generators/trek/templates/controllers/admin/users_controller.rb +0 -8
  106. data/lib/generators/trek/templates/initializers/content_security_policy.rb +3 -2
  107. data/lib/generators/trek/templates/initializers/good_job.rb.tt +38 -0
  108. data/lib/generators/trek/templates/jobs/mail_delivery_job.rb +6 -0
  109. data/lib/generators/trek/templates/layouts/admin.html.slim +5 -0
  110. data/lib/generators/trek/templates/mailers/admin_mailer.rb +4 -2
  111. data/lib/generators/trek/templates/models/fragment.rb +14 -0
  112. data/lib/generators/trek/templates/package.json.tt +1 -1
  113. data/lib/generators/trek/templates/public_accounts/api/authentication.rb.tt +76 -0
  114. data/lib/generators/trek/templates/public_accounts/api/controllers/accounts_controller.rb.tt +22 -0
  115. data/lib/generators/trek/templates/public_accounts/api/controllers/active_sessions_controller.rb.tt +21 -0
  116. data/lib/generators/trek/templates/public_accounts/api/controllers/base_controller.rb.tt +71 -0
  117. data/lib/generators/trek/templates/public_accounts/api/controllers/email_changes_controller.rb.tt +55 -0
  118. data/lib/generators/trek/templates/public_accounts/api/controllers/email_confirmations_controller.rb.tt +19 -0
  119. data/lib/generators/trek/templates/public_accounts/api/controllers/password_resets_controller.rb.tt +28 -0
  120. data/lib/generators/trek/templates/public_accounts/api/controllers/passwords_controller.rb.tt +17 -0
  121. data/lib/generators/trek/templates/public_accounts/api/controllers/registrations_controller.rb.tt +17 -0
  122. data/lib/generators/trek/templates/public_accounts/api/controllers/sessions_controller.rb.tt +45 -0
  123. data/lib/generators/trek/templates/public_accounts/api/controllers/sign_in_codes_controller.rb.tt +15 -0
  124. data/lib/generators/trek/templates/public_accounts/jobs/sign_in_code_job.rb.tt +13 -0
  125. data/lib/generators/trek/templates/public_accounts/locales/accounts.en.yml.tt +205 -0
  126. data/lib/generators/trek/templates/public_accounts/locales/accounts.fr.yml.tt +205 -0
  127. data/lib/generators/trek/templates/public_accounts/mailers/account_mailer.rb.tt +85 -0
  128. data/lib/generators/trek/templates/public_accounts/migrations/create_accounts.rb.tt +46 -0
  129. data/lib/generators/trek/templates/public_accounts/models/account/session.rb.tt +47 -0
  130. data/lib/generators/trek/templates/public_accounts/models/account/sign_in_code.rb.tt +8 -0
  131. data/lib/generators/trek/templates/public_accounts/models/account.rb.tt +73 -0
  132. data/lib/generators/trek/templates/public_accounts/spec/api/accounts_spec.rb.tt +90 -0
  133. data/lib/generators/trek/templates/public_accounts/spec/api/sign_ins_spec.rb.tt +158 -0
  134. data/lib/generators/trek/templates/public_accounts/spec/models/account/sign_in_code_spec.rb.tt +56 -0
  135. data/lib/generators/trek/templates/public_accounts/spec/models/account_spec.rb.tt +109 -0
  136. data/lib/generators/trek/templates/public_accounts/spec/web/accounts_spec.rb.tt +126 -0
  137. data/lib/generators/trek/templates/public_accounts/spec/web/authentication_spec.rb.tt +43 -0
  138. data/lib/generators/trek/templates/public_accounts/spec/web/sign_ins_spec.rb.tt +215 -0
  139. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.en.html.slim.tt +10 -0
  140. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.en.text.erb.tt +8 -0
  141. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.fr.html.slim.tt +13 -0
  142. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change.fr.text.erb.tt +8 -0
  143. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.en.html.slim.tt +9 -0
  144. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.en.text.erb.tt +11 -0
  145. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.fr.html.slim.tt +11 -0
  146. data/lib/generators/trek/templates/public_accounts/views/mailer/email_change_code.fr.text.erb.tt +11 -0
  147. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.en.html.slim.tt +10 -0
  148. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.en.text.erb.tt +8 -0
  149. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.fr.html.slim.tt +10 -0
  150. data/lib/generators/trek/templates/public_accounts/views/mailer/email_confirmation.fr.text.erb.tt +8 -0
  151. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.en.html.slim.tt +10 -0
  152. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.en.text.erb.tt +8 -0
  153. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.fr.html.slim.tt +13 -0
  154. data/lib/generators/trek/templates/public_accounts/views/mailer/password_reset.fr.text.erb.tt +8 -0
  155. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.en.html.slim.tt +9 -0
  156. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.en.text.erb.tt +11 -0
  157. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.fr.html.slim.tt +9 -0
  158. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_code.fr.text.erb.tt +11 -0
  159. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.en.html.slim.tt +23 -0
  160. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.en.text.erb.tt +14 -0
  161. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.fr.html.slim.tt +24 -0
  162. data/lib/generators/trek/templates/public_accounts/views/mailer/sign_in_locked.fr.text.erb.tt +14 -0
  163. data/lib/generators/trek/templates/public_accounts/web/authentication.rb.tt +97 -0
  164. data/lib/generators/trek/templates/public_accounts/web/controllers/accounts_controller.rb.tt +33 -0
  165. data/lib/generators/trek/templates/public_accounts/web/controllers/active_sessions_controller.rb.tt +15 -0
  166. data/lib/generators/trek/templates/public_accounts/web/controllers/base_controller.rb.tt +52 -0
  167. data/lib/generators/trek/templates/public_accounts/web/controllers/email_changes_controller.rb.tt +85 -0
  168. data/lib/generators/trek/templates/public_accounts/web/controllers/email_confirmations_controller.rb.tt +19 -0
  169. data/lib/generators/trek/templates/public_accounts/web/controllers/password_resets_controller.rb.tt +41 -0
  170. data/lib/generators/trek/templates/public_accounts/web/controllers/passwords_controller.rb.tt +23 -0
  171. data/lib/generators/trek/templates/public_accounts/web/controllers/registrations_controller.rb.tt +24 -0
  172. data/lib/generators/trek/templates/public_accounts/web/controllers/sessions_controller.rb.tt +78 -0
  173. data/lib/generators/trek/templates/public_accounts/web/controllers/sign_in_codes_controller.rb.tt +27 -0
  174. data/lib/generators/trek/templates/public_accounts/web/views/_flash.html.slim.tt +5 -0
  175. data/lib/generators/trek/templates/public_accounts/web/views/accounts/show.html.slim.tt +52 -0
  176. data/lib/generators/trek/templates/public_accounts/web/views/email_changes/edit.html.slim.tt +17 -0
  177. data/lib/generators/trek/templates/public_accounts/web/views/email_changes/new.html.slim.tt +15 -0
  178. data/lib/generators/trek/templates/public_accounts/web/views/password_resets/edit.html.slim.tt +26 -0
  179. data/lib/generators/trek/templates/public_accounts/web/views/password_resets/new.html.slim.tt +15 -0
  180. data/lib/generators/trek/templates/public_accounts/web/views/passwords/edit.html.slim.tt +25 -0
  181. data/lib/generators/trek/templates/public_accounts/web/views/registrations/new.html.slim.tt +28 -0
  182. data/lib/generators/trek/templates/public_accounts/web/views/sessions/new.html.slim.tt +38 -0
  183. data/lib/generators/trek/templates/public_accounts/web/views/sign_in_codes/new.html.slim.tt +17 -0
  184. data/lib/generators/trek/templates/spec/jobs/mail_delivery_job_spec.rb +11 -0
  185. data/lib/generators/trek/templates/spec/mailers/admin_mailer_spec.rb +12 -1
  186. data/lib/generators/trek/templates/spec/requests/admin/active_sessions_spec.rb +1 -0
  187. data/lib/generators/trek/templates/spec/requests/admin/fragments_spec.rb +27 -3
  188. data/lib/generators/trek/templates/spec/requests/admin/good_job_spec.rb +34 -0
  189. data/lib/generators/trek/templates/spec/requests/admin/pages_spec.rb +9 -1
  190. data/lib/generators/trek/templates/spec/requests/admin/panels_spec.rb +70 -0
  191. data/lib/generators/trek/templates/spec/requests/admin/password_renewal_spec.rb +2 -2
  192. data/lib/generators/trek/templates/spec/requests/admin/sign_in_lockout_spec.rb +1 -1
  193. data/lib/generators/trek/templates/spec/requests/admin/sign_in_notices_spec.rb +5 -3
  194. data/lib/generators/trek/templates/spec/requests/admin/user_sessions_spec.rb +2 -2
  195. data/lib/generators/trek/templates/views/admin/fragments/index.html.slim +14 -3
  196. data/lib/generators/trek/templates/views/admin/users/index.html.slim +1 -1
  197. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.en.html.slim +1 -1
  198. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.en.text.erb +1 -1
  199. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.fr.html.slim +1 -1
  200. data/lib/generators/trek/templates/views/admin_mailer/new_sign_in.fr.text.erb +1 -1
  201. data/lib/trek/csp_reports.rb +22 -4
  202. data/lib/trek/engine.rb +8 -3
  203. data/lib/trek/saved_attachments_reload.rb +2 -1
  204. data/lib/trek/typography_formatter.rb +35 -4
  205. data/lib/trek/version.rb +1 -1
  206. data/lib/trek.rb +1 -1
  207. data/package.json +12 -8
  208. data/renovate.json +1 -0
  209. data/trek.gemspec +3 -3
  210. data/vitest.config.mjs +24 -0
  211. data/yarn.lock +1706 -1028
  212. metadata +116 -14
  213. data/app/formatters/prosemirror_to_html/global_id_to_links_formatter.rb +0 -19
  214. data/app/formatters/prosemirror_to_html/nodes/image_block.rb +0 -44
  215. data/app/formatters/prosemirror_to_html/nodes/prompts_block.rb +0 -28
  216. data/app/formatters/prosemirror_to_html/remove_empty_paragraphs_formatter.rb +0 -11
  217. data/app/models/prosemirror.rb +0 -23
@@ -0,0 +1,158 @@
1
+ require "rails_helper"
2
+
3
+ RSpec.describe "<%= human_name.pluralize %>' sign-ins through the API", type: :request do
4
+ include ActiveSupport::Testing::TimeHelpers
5
+
6
+ <% if code? -%>
7
+ def emailed_code
8
+ ActionMailer::Base.deliveries.last.text_part.body.to_s[/\b\d{6}\b/]
9
+ end
10
+
11
+ # The response's status
12
+ def ask_for_code(email)
13
+ perform_enqueued_jobs { post <%= route_prefix %>_sign_in_path, params: { email: }, as: :json }
14
+ response.status
15
+ end
16
+
17
+ def sign_in(email)
18
+ ask_for_code(email)
19
+ post <%= route_prefix %>_sign_in_code_path, params: { email:, otp: emailed_code }, as: :json
20
+ response.parsed_body["token"]
21
+ end
22
+
23
+ it "emails a code to an email without an account, with the same answer as for an account", :aggregate_failures do
24
+ <%= class_name %>.create!(email: "ada@example.com")
25
+
26
+ expect(ask_for_code("grace@example.com")).to eq(ask_for_code("ada@example.com")).and eq(202)
27
+ expect(ActionMailer::Base.deliveries.flat_map(&:to)).to eq(%w[grace@example.com ada@example.com])
28
+ end
29
+
30
+ it "refuses an invalid email", :aggregate_failures do
31
+ post <%= route_prefix %>_sign_in_path, params: { email: "not an email" }, as: :json
32
+
33
+ expect(response).to have_http_status(:unprocessable_content)
34
+ expect(response.parsed_body["error"]).to eq("invalid_email")
35
+ end
36
+
37
+ it "creates the account and answers with a token", :aggregate_failures do
38
+ token = nil
39
+
40
+ expect { token = sign_in("grace@example.com") }.to change(<%= class_name %>, :count).by(1)
41
+ expect(response).to have_http_status(:created)
42
+ expect(token).to be_present
43
+ end
44
+
45
+ it "refuses a wrong code", :aggregate_failures do
46
+ ask_for_code("ada@example.com")
47
+ post <%= route_prefix %>_sign_in_code_path, params: { email: "ada@example.com", otp: "000000" }, as: :json
48
+
49
+ expect(response).to have_http_status(:unauthorized)
50
+ expect(response.parsed_body["error"]).to eq("invalid_code")
51
+ end
52
+ <% else -%>
53
+ let(:password) { "correct horse battery staple" }
54
+ let!(:<%= file_name %>) { <%= class_name %>.create!(email: "ada@example.com", password:) }
55
+
56
+ def emailed_token
57
+ CGI.unescape(ActionMailer::Base.deliveries.last.text_part.body.to_s[/token=([^\s&]+)/, 1].to_s)
58
+ end
59
+
60
+ def sign_in(email, password: self.password)
61
+ post <%= route_prefix %>_sign_in_path, params: { email:, password: }, as: :json
62
+ response.parsed_body["token"]
63
+ end
64
+
65
+ it "signs up and in, answering with a token, and emails a link to confirm the email", :aggregate_failures do
66
+ perform_enqueued_jobs { post <%= route_prefix %>_sign_up_path, params: { email: "grace@example.com", password: }, as: :json }
67
+
68
+ expect(response).to have_http_status(:created)
69
+ expect(response.parsed_body["token"]).to be_present
70
+ expect(ActionMailer::Base.deliveries.last.to).to eq(["grace@example.com"])
71
+ end
72
+
73
+ it "confirms the email with the token of the emailed link" do
74
+ perform_enqueued_jobs { post <%= route_prefix %>_sign_up_path, params: { email: "grace@example.com", password: }, as: :json }
75
+
76
+ patch <%= route_prefix %>_email_confirmation_path, params: { token: emailed_token }, as: :json
77
+
78
+ expect(<%= class_name %>.find_by(email: "grace@example.com")).to be_confirmed
79
+ end
80
+
81
+ it "answers with a token" do
82
+ expect(sign_in(<%= file_name %>.email)).to be_present
83
+ end
84
+
85
+ it "refuses a wrong password", :aggregate_failures do
86
+ sign_in(<%= file_name %>.email, password: "wrong horse battery staple")
87
+
88
+ expect(response).to have_http_status(:unauthorized)
89
+ expect(response.parsed_body["error"]).to eq("invalid_password")
90
+ end
91
+
92
+ it "resets the password with the token of the emailed link", :aggregate_failures do
93
+ perform_enqueued_jobs { post <%= route_prefix %>_password_reset_path, params: { email: <%= file_name %>.email }, as: :json }
94
+ expect(response).to have_http_status(:accepted)
95
+
96
+ patch <%= route_prefix %>_password_reset_path, params: { token: emailed_token, password: "a brand new password 1!" }, as: :json
97
+ expect(<%= file_name %>.reload.authenticate("a brand new password 1!")).to be_truthy
98
+ end
99
+
100
+ it "answers a password reset the same for an unknown email, and sends nothing", :aggregate_failures do
101
+ perform_enqueued_jobs { post <%= route_prefix %>_password_reset_path, params: { email: "nobody@example.com" }, as: :json }
102
+
103
+ expect(response).to have_http_status(:accepted)
104
+ expect(ActionMailer::Base.deliveries).to be_empty
105
+ end
106
+ <% end -%>
107
+
108
+ <% if audit_log? -%>
109
+ it "records the sign-in in the audit log" do
110
+ sign_in("ada@example.com")
111
+
112
+ expect(AuditLog.where(action: "<%= controllers_path %>/sessions#create", actor: <%= class_name %>.last)).to exist
113
+ end
114
+
115
+ <% end -%>
116
+ it "uses the token for the next requests" do
117
+ token = sign_in("ada@example.com")
118
+
119
+ get <%= route_prefix %>_account_path, headers: { "Authorization" => "Bearer #{token}" }
120
+
121
+ expect(response.parsed_body["email"]).to eq("ada@example.com")
122
+ end
123
+
124
+ it "refuses a request without a token, or with a forged one", :aggregate_failures do
125
+ get <%= route_prefix %>_account_path
126
+ expect(response).to have_http_status(:unauthorized)
127
+
128
+ token = sign_in("ada@example.com")
129
+ get <%= route_prefix %>_account_path, headers: { "Authorization" => "Bearer #{token.chop}x" }
130
+ expect(response).to have_http_status(:unauthorized)
131
+ end
132
+
133
+ it "ends the token's session when signing out" do
134
+ token = sign_in("ada@example.com")
135
+
136
+ delete <%= route_prefix %>_session_path, headers: { "Authorization" => "Bearer #{token}" }
137
+ get <%= route_prefix %>_account_path, headers: { "Authorization" => "Bearer #{token}" }
138
+
139
+ expect(response).to have_http_status(:unauthorized)
140
+ end
141
+
142
+ it "refuses the token after the session's idle timeout" do
143
+ token = sign_in("ada@example.com")
144
+
145
+ travel <%= class_name %>::Session.idle_timeout + 1.minute
146
+ get <%= route_prefix %>_account_path, headers: { "Authorization" => "Bearer #{token}" }
147
+
148
+ expect(response).to have_http_status(:unauthorized)
149
+ end
150
+
151
+ it "refuses a token signed with another key" do
152
+ forged = JWT.encode({ sub: <%= class_name %>::Session.maximum(:id).to_i + 1 }, "wrong key", "HS256")
153
+
154
+ get <%= route_prefix %>_account_path, headers: { "Authorization" => "Bearer #{forged}" }
155
+
156
+ expect(response).to have_http_status(:unauthorized)
157
+ end
158
+ end
@@ -0,0 +1,56 @@
1
+ require "rails_helper"
2
+
3
+ RSpec.describe <%= class_name %>::SignInCode, type: :model do
4
+ include ActiveSupport::Testing::TimeHelpers
5
+
6
+ it "keeps a digest of the code, not the code", :aggregate_failures do
7
+ sign_in_code = described_class.issue("ada@example.com")
8
+
9
+ expect(sign_in_code.code).to match(/\A\d{6}\z/)
10
+ expect(described_class.find(sign_in_code.id).code_digest).not_to include(sign_in_code.code)
11
+ end
12
+
13
+ it "signs in once with the right code", :aggregate_failures do
14
+ code = described_class.issue("ada@example.com").code
15
+
16
+ expect(described_class.redeem("Ada@example.com", code)).to be_present
17
+ expect(described_class.redeem("ada@example.com", code)).to be_nil
18
+ end
19
+
20
+ it "accepts the code with spaces" do
21
+ code = described_class.issue("ada@example.com").code
22
+
23
+ expect(described_class.redeem("ada@example.com", "#{code[0, 3]} #{code[3..]}")).to be_present
24
+ end
25
+
26
+ it "replaces the email's earlier code" do
27
+ first = described_class.issue("ada@example.com").code
28
+ described_class.issue("ada@example.com")
29
+
30
+ expect(described_class.redeem("ada@example.com", first)).to be_nil
31
+ end
32
+
33
+ it "stops working after its validity" do
34
+ code = described_class.issue("ada@example.com").code
35
+
36
+ travel described_class.validity + 1.second do
37
+ expect(described_class.redeem("ada@example.com", code)).to be_nil
38
+ end
39
+ end
40
+
41
+ it "stops working after too many wrong tries, even with the right code" do
42
+ code = described_class.issue("ada@example.com").code
43
+ wrong = code.succ.rjust(6, "0")[-6..]
44
+ described_class.max_attempts.times { described_class.redeem("ada@example.com", wrong) }
45
+
46
+ expect(described_class.redeem("ada@example.com", code)).to be_nil
47
+ end
48
+
49
+ it "doesn't sign in with a code confirming a new email", :aggregate_failures do
50
+ <%= file_name %> = <%= class_name %>.create!(email: "ada@example.com")
51
+ code = described_class.issue("new@example.com", purpose: "email_change", <%= file_name %>:).code
52
+
53
+ expect(described_class.redeem("new@example.com", code)).to be_nil
54
+ expect(described_class.redeem("new@example.com", code, purpose: "email_change", <%= file_name %>:)).to be_present
55
+ end
56
+ end
@@ -0,0 +1,109 @@
1
+ require "rails_helper"
2
+
3
+ RSpec.describe <%= class_name %>, type: :model do
4
+ include ActiveSupport::Testing::TimeHelpers
5
+
6
+ <% if password? -%>
7
+ let(:password) { "correct horse battery staple" }
8
+
9
+ <% end -%>
10
+ def create_<%= file_name %>(email, **attributes)
11
+ described_class.create!(email:<% if password? %>, password:<% end %>, **attributes)
12
+ end
13
+
14
+ it "keeps emails in lower case, without spaces" do
15
+ expect(create_<%= file_name %>(" Ada@Example.com ").email).to eq("ada@example.com")
16
+ end
17
+
18
+ it "refuses an email another account has, whatever its case" do
19
+ create_<%= file_name %>("ada@example.com")
20
+
21
+ expect(described_class.new(email: "ADA@example.com")).not_to be_valid
22
+ end
23
+ <% if code? -%>
24
+
25
+ it "creates the account of a verified email once" do
26
+ first = described_class.for_verified_email!("ada@example.com")
27
+
28
+ expect(described_class.for_verified_email!("Ada@example.com")).to eq(first)
29
+ end
30
+ <% end -%>
31
+
32
+ it "finds the accounts nobody used since a date", :aggregate_failures do
33
+ used = create_<%= file_name %>("used@example.com", last_activity_at: 1.day.ago)
34
+ idle = create_<%= file_name %>("idle@example.com", last_activity_at: 2.years.ago)
35
+ never = travel_to(2.years.ago) { create_<%= file_name %>("never@example.com") }
36
+
37
+ expect(described_class.inactive_since(1.year.ago)).to contain_exactly(idle, never)
38
+ expect(described_class.inactive_since(1.year.ago)).not_to include(used)
39
+ end
40
+
41
+ it "deletes its sessions with it" do
42
+ <%= file_name %> = create_<%= file_name %>("ada@example.com")
43
+ <%= file_name %>.sessions.create!
44
+
45
+ expect { <%= file_name %>.destroy }.to change(<%= class_name %>::Session, :count).by(-1)
46
+ end
47
+
48
+ it "loses its expired sessions to the daily purge" do
49
+ <%= file_name %> = create_<%= file_name %>("ada@example.com")
50
+ <%= file_name %>.sessions.create!(created_at: 2.years.ago, last_activity_at: 2.years.ago)
51
+ current = <%= file_name %>.sessions.create!
52
+
53
+ Trek::PurgeExpiredSessionsJob.perform_now("<%= class_name %>::Session")
54
+
55
+ expect(<%= file_name %>.sessions.reload).to contain_exactly(current)
56
+ end
57
+ <% if password? -%>
58
+
59
+ describe "password" do
60
+ it "is required" do
61
+ expect(described_class.new(email: "ada@example.com")).not_to be_valid
62
+ end
63
+
64
+ it "follows the password rules" do
65
+ expect(described_class.new(email: "ada@example.com", password: "short")).not_to be_valid
66
+ end
67
+ end
68
+
69
+ describe "email confirmation" do
70
+ let(:<%= file_name %>) { create_<%= file_name %>("ada@example.com") }
71
+
72
+ it "is pending after signing up" do
73
+ expect(<%= file_name %>).not_to be_confirmed
74
+ end
75
+
76
+ it "finds the account by its link, once", :aggregate_failures do
77
+ token = <%= file_name %>.generate_token_for(:email_confirmation)
78
+
79
+ expect(described_class.find_by_token_for(:email_confirmation, token)).to eq(<%= file_name %>)
80
+ <%= file_name %>.confirm_email!
81
+ expect(described_class.find_by_token_for(:email_confirmation, token)).to be_nil
82
+ end
83
+ end
84
+
85
+ describe "email change" do
86
+ let(:<%= file_name %>) { create_<%= file_name %>("ada@example.com", unconfirmed_email: "ada@lovelace.org") }
87
+
88
+ it "takes the new email, confirmed", :aggregate_failures do
89
+ <%= file_name %>.change_email!
90
+
91
+ expect(<%= file_name %>.reload.email).to eq("ada@lovelace.org")
92
+ expect(<%= file_name %>).to be_confirmed
93
+ end
94
+
95
+ it "keeps the email when another account has the new one" do
96
+ create_<%= file_name %>("ada@lovelace.org")
97
+
98
+ expect(<%= file_name %>.change_email!).to be(false)
99
+ end
100
+
101
+ it "uses its link up once the email changed" do
102
+ token = <%= file_name %>.generate_token_for(:email_change)
103
+ <%= file_name %>.change_email!
104
+
105
+ expect(described_class.find_by_token_for(:email_change, token)).to be_nil
106
+ end
107
+ end
108
+ <% end -%>
109
+ end
@@ -0,0 +1,126 @@
1
+ require "rails_helper"
2
+
3
+ RSpec.describe "<%= human_name.pluralize %>' accounts", type: :request do
4
+ include ActiveSupport::Testing::TimeHelpers
5
+
6
+ <% if code? -%>
7
+ let(:<%= file_name %>) { <%= class_name %>.create!(email: "ada@example.com") }
8
+
9
+ def emailed_code
10
+ ActionMailer::Base.deliveries.last.text_part.body.to_s[/\b\d{6}\b/]
11
+ end
12
+
13
+ def change_email_to(email)
14
+ perform_enqueued_jobs { post <%= route_prefix %>_email_change_path, params: { email: } }
15
+ patch <%= route_prefix %>_email_change_path, params: { otp: emailed_code }
16
+ end
17
+
18
+ def sign_in_as(<%= file_name %>)
19
+ perform_enqueued_jobs { post <%= route_prefix %>_sign_in_path, params: { email: <%= file_name %>.email } }
20
+ post <%= route_prefix %>_sign_in_code_path, params: { otp: emailed_code }
21
+ end
22
+ <% else -%>
23
+ let(:<%= file_name %>) { <%= class_name %>.create!(email: "ada@example.com", password: "correct horse battery staple") }
24
+
25
+ def emailed_link
26
+ ActionMailer::Base.deliveries.last.text_part.body.to_s[%r{https?://\S+}]
27
+ end
28
+
29
+ def change_email_to(email)
30
+ perform_enqueued_jobs { post <%= route_prefix %>_email_change_path, params: { email: } }
31
+ get emailed_link
32
+ end
33
+
34
+ def sign_in_as(<%= file_name %>)
35
+ post <%= route_prefix %>_sign_in_path, params: { email: <%= file_name %>.email, password: "correct horse battery staple" }
36
+ end
37
+ <% end -%>
38
+
39
+ it "asks to sign in" do
40
+ get <%= route_prefix %>_account_path
41
+
42
+ expect(response).to redirect_to(<%= route_prefix %>_sign_in_path)
43
+ end
44
+
45
+ it "shows the account" do
46
+ sign_in_as(<%= file_name %>)
47
+ get <%= route_prefix %>_account_path
48
+
49
+ expect(response.body).to include(<%= file_name %>.email)
50
+ end
51
+
52
+ it "changes the name" do
53
+ sign_in_as(<%= file_name %>)
54
+ patch <%= route_prefix %>_account_path, params: { <%= file_name %>: { name: "Ada Lovelace" } }
55
+
56
+ expect(<%= file_name %>.reload.name).to eq("Ada Lovelace")
57
+ end
58
+
59
+ it "changes the email once the <%= code? ? "code" : "link" %> sent to the new one is <%= code? ? "typed" : "followed" %>", :aggregate_failures do
60
+ sign_in_as(<%= file_name %>)
61
+ change_email_to("ada@lovelace.org")
62
+
63
+ expect(ActionMailer::Base.deliveries.last.to).to eq(["ada@lovelace.org"])
64
+ expect(<%= file_name %>.reload.email).to eq("ada@lovelace.org")
65
+ end
66
+
67
+ it "keeps the email when another account has the new one", :aggregate_failures do
68
+ <%= class_name %>.create!(email: "taken@example.com"<% if password? %>, password: "correct horse battery staple"<% end %>)
69
+ sign_in_as(<%= file_name %>)
70
+ change_email_to("taken@example.com")
71
+
72
+ expect(<%= file_name %>.reload.email).to eq("ada@example.com")
73
+ expect(flash[:alert]).to be_present
74
+ end
75
+
76
+ it "signs the other browsers out", :aggregate_failures do
77
+ other = <%= file_name %>.sessions.create!
78
+ sign_in_as(<%= file_name %>)
79
+
80
+ delete others_<%= route_prefix %>_active_sessions_path
81
+
82
+ expect(<%= class_name %>::Session.exists?(other.id)).to be(false)
83
+ expect(<%= file_name %>.sessions.count).to eq(1)
84
+ end
85
+
86
+ it "deletes the account after a recent sign-in" do
87
+ sign_in_as(<%= file_name %>)
88
+
89
+ expect { delete <%= route_prefix %>_account_path }.to change(<%= class_name %>, :count).by(-1)
90
+ end
91
+
92
+ it "asks to sign in again before deleting the account", :aggregate_failures do
93
+ sign_in_as(<%= file_name %>)
94
+ travel <%= class_name %>::Session::RECENT + 1.minute
95
+
96
+ expect { delete <%= route_prefix %>_account_path }.not_to change(<%= class_name %>, :count)
97
+ expect(response).to redirect_to(<%= route_prefix %>_sign_in_path)
98
+ end
99
+ <% if password? -%>
100
+
101
+ it "sends the confirmation link again" do
102
+ sign_in_as(<%= file_name %>)
103
+
104
+ perform_enqueued_jobs { post <%= route_prefix %>_email_confirmation_path }
105
+
106
+ expect(ActionMailer::Base.deliveries.last.to).to eq([<%= file_name %>.email])
107
+ end
108
+
109
+ it "changes the password after a recent sign-in, and signs the other browsers out", :aggregate_failures do
110
+ other = <%= file_name %>.sessions.create!
111
+ sign_in_as(<%= file_name %>)
112
+
113
+ patch <%= route_prefix %>_password_path, params: { <%= file_name %>: { password: "a brand new password 1!" } }
114
+
115
+ expect(<%= file_name %>.reload.authenticate("a brand new password 1!")).to be_truthy
116
+ expect(<%= class_name %>::Session.exists?(other.id)).to be(false)
117
+ end
118
+
119
+ it "refuses a password breaking the rules" do
120
+ sign_in_as(<%= file_name %>)
121
+ patch <%= route_prefix %>_password_path, params: { <%= file_name %>: { password: "short" } }
122
+
123
+ expect(response).to have_http_status(:unprocessable_content)
124
+ end
125
+ <% end -%>
126
+ end
@@ -0,0 +1,43 @@
1
+ require "rails_helper"
2
+
3
+ # What any page of the site knows about who is signed in (<%= accounts_module %>::Authentication).
4
+ RSpec.describe ApplicationController, type: :controller do
5
+ controller do
6
+ def index
7
+ render plain: [current_<%= file_name %>&.email, staff_user&.email].inspect
8
+ end
9
+ end
10
+
11
+ it "knows nobody by default" do
12
+ get :index
13
+
14
+ expect(response.body).to eq("[nil, nil]")
15
+ end
16
+
17
+ it "knows the signed-in <%= human_name.downcase %>" do
18
+ <%= file_name %>_session = <%= class_name %>.create!(email: "ada@example.com"<% if password? %>, password: "correct horse battery staple"<% end %>).sessions.create!
19
+ cookies.signed[<%= accounts_module %>::Authentication::COOKIE] = <%= file_name %>_session.id
20
+
21
+ get :index
22
+
23
+ expect(response.body).to eq('["ada@example.com", nil]')
24
+ end
25
+
26
+ it "knows a staff member signed in to the admin, without signing in a <%= human_name.downcase %>" do
27
+ editor = users.create(role: :editor)
28
+ cookies.signed[:session_id] = editor.sessions.create!.id
29
+
30
+ get :index
31
+
32
+ expect(response.body).to eq("[nil, #{editor.email.inspect}]")
33
+ end
34
+
35
+ it "ignores an admin session of a user who isn't staff anymore" do
36
+ reader = users.create(role: :reader)
37
+ cookies.signed[:session_id] = reader.sessions.create!.id
38
+
39
+ get :index
40
+
41
+ expect(response.body).to eq("[nil, nil]")
42
+ end
43
+ end