Deploying to gh-pages from @ ac502b7c08 🚀

This commit is contained in:
realaravinth
2022-11-04 10:05:00 +00:00
parent 49538a56a4
commit 55a5f29113
941 changed files with 22322 additions and 30474 deletions

View File

@@ -1,4 +1,4 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/email/verification.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>verification.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../mcaptcha/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../mcaptcha/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../mcaptcha/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/email/verification.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>verification.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../../mcaptcha/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../../mcaptcha/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../../mcaptcha/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav></div><section id="main-content" class="content"><div class="example-wrap"><pre class="line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
@@ -153,42 +153,42 @@
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.
*/</span>
<span class="doccomment">//! Email operations: verification, notification, etc</span>
<span class="kw">use</span> <span class="ident">lettre</span>::{
<span class="ident">message</span>::{<span class="ident">header</span>, <span class="ident">MultiPart</span>, <span class="ident">SinglePart</span>},
<span class="ident">AsyncTransport</span>, <span class="ident">Message</span>,
*/
</span><span class="doccomment">//! Email operations: verification, notification, etc
</span><span class="kw">use </span>lettre::{
message::{header, MultiPart, SinglePart},
AsyncTransport, Message,
};
<span class="kw">use</span> <span class="ident">sailfish::TemplateOnce</span>;
<span class="kw">use </span>sailfish::TemplateOnce;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::errors</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::Data</span>;
<span class="kw">use </span><span class="kw">crate</span>::errors::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::Data;
<span class="kw">const</span> <span class="ident">PAGE</span>: <span class="kw-2">&amp;</span><span class="ident">str</span> <span class="op">=</span> <span class="string">&quot;Login&quot;</span>;
<span class="kw">const </span>PAGE: <span class="kw-2">&amp;</span>str = <span class="string">&quot;Login&quot;</span>;
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">TemplateOnce</span>)]</span>
<span class="attribute">#[<span class="ident">template</span>(<span class="ident">path</span> <span class="op">=</span> <span class="string">&quot;email/verification/index.html&quot;</span>)]</span>
<span class="kw">struct</span> <span class="ident">IndexPage</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="ident">verification_link</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="ident">str</span>,
<span class="attribute">#[derive(Clone, TemplateOnce)]
#[template(path = <span class="string">&quot;email/verification/index.html&quot;</span>)]
</span><span class="kw">struct </span>IndexPage&lt;<span class="lifetime">&#39;a</span>&gt; {
verification_link: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
}
<span class="kw">impl</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> <span class="ident">IndexPage</span><span class="op">&lt;</span><span class="lifetime">&#39;a</span><span class="op">&gt;</span> {
<span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">verification_link</span>: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a</span> <span class="ident">str</span>) -&gt; <span class="self">Self</span> {
<span class="self">Self</span> { <span class="ident">verification_link</span> }
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>&gt; IndexPage&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">fn </span>new(verification_link: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{ verification_link }
}
}
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">verification</span>(
<span class="ident">data</span>: <span class="kw-2">&amp;</span><span class="ident">Data</span>,
<span class="ident">to</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>,
<span class="ident">verification_link</span>: <span class="kw-2">&amp;</span><span class="ident">str</span>,
) -&gt; <span class="ident">ServiceResult</span><span class="op">&lt;</span>()<span class="op">&gt;</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">smtp</span>) <span class="op">=</span> <span class="ident">data</span>.<span class="ident">settings</span>.<span class="ident">smtp</span>.<span class="ident">as_ref</span>() {
<span class="kw">let</span> <span class="ident">from</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">&quot;mCaptcha Admin &lt;{}&gt;&quot;</span>, <span class="ident">smtp</span>.<span class="ident">from</span>);
<span class="kw">let</span> <span class="ident">reply_to</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">&quot;mCaptcha Admin &lt;{}&gt;&quot;</span>, <span class="ident">smtp</span>.<span class="ident">reply</span>);
<span class="kw">const</span> <span class="ident">SUBJECT</span>: <span class="kw-2">&amp;</span><span class="ident">str</span> <span class="op">=</span> <span class="string">&quot;[mCaptcha] Please verify your email&quot;</span>;
<span class="kw">async fn </span>verification(
data: <span class="kw-2">&amp;</span>Data,
to: <span class="kw-2">&amp;</span>str,
verification_link: <span class="kw-2">&amp;</span>str,
) -&gt; ServiceResult&lt;()&gt; {
<span class="kw">if let </span><span class="prelude-val">Some</span>(smtp) = data.settings.smtp.as_ref() {
<span class="kw">let </span>from = <span class="macro">format!</span>(<span class="string">&quot;mCaptcha Admin &lt;{}&gt;&quot;</span>, smtp.from);
<span class="kw">let </span>reply_to = <span class="macro">format!</span>(<span class="string">&quot;mCaptcha Admin &lt;{}&gt;&quot;</span>, smtp.reply);
<span class="kw">const </span>SUBJECT: <span class="kw-2">&amp;</span>str = <span class="string">&quot;[mCaptcha] Please verify your email&quot;</span>;
<span class="kw">let</span> <span class="ident">plain_text</span> <span class="op">=</span> <span class="macro">format!</span>(
<span class="kw">let </span>plain_text = <span class="macro">format!</span>(
<span class="string">&quot;
Welcome to mCaptcha!
@@ -202,81 +202,81 @@ With best regards,
Admin
instance: {}
project website: {}&quot;</span>,
<span class="ident">verification_link</span>,
<span class="kw-2">&amp;</span><span class="ident">data</span>.<span class="ident">settings</span>.<span class="ident">server</span>.<span class="ident">domain</span>,
<span class="ident"><span class="kw">crate</span>::PKG_HOMEPAGE</span>
verification_link,
<span class="kw-2">&amp;</span>data.settings.server.domain,
<span class="kw">crate</span>::PKG_HOMEPAGE
);
<span class="kw">let</span> <span class="ident">html</span> <span class="op">=</span> <span class="ident">IndexPage::new</span>(<span class="ident">verification_link</span>).<span class="ident">render_once</span>().<span class="ident">unwrap</span>();
<span class="kw">let </span>html = IndexPage::new(verification_link).render_once().unwrap();
<span class="kw">let</span> <span class="ident">email</span> <span class="op">=</span> <span class="ident">Message::builder</span>()
.<span class="ident">from</span>(<span class="ident">from</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>())
.<span class="ident">reply_to</span>(<span class="ident">reply_to</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>())
.<span class="ident">to</span>(<span class="ident">to</span>.<span class="ident">parse</span>().<span class="ident">unwrap</span>())
.<span class="ident">subject</span>(<span class="ident">SUBJECT</span>)
.<span class="ident">multipart</span>(
<span class="ident">MultiPart::alternative</span>() <span class="comment">// This is composed of two parts.</span>
.<span class="ident">singlepart</span>(
<span class="ident">SinglePart::builder</span>()
.<span class="ident">header</span>(<span class="ident">header::ContentType::TEXT_PLAIN</span>)
.<span class="ident">body</span>(<span class="ident">plain_text</span>), <span class="comment">// Every message should have a plain text fallback.</span>
)
.<span class="ident">singlepart</span>(
<span class="ident">SinglePart::builder</span>()
.<span class="ident">header</span>(<span class="ident">header::ContentType::TEXT_HTML</span>)
.<span class="ident">body</span>(<span class="ident">html</span>),
<span class="kw">let </span>email = Message::builder()
.from(from.parse().unwrap())
.reply_to(reply_to.parse().unwrap())
.to(to.parse().unwrap())
.subject(SUBJECT)
.multipart(
MultiPart::alternative() <span class="comment">// This is composed of two parts.
</span>.singlepart(
SinglePart::builder()
.header(header::ContentType::TEXT_PLAIN)
.body(plain_text), <span class="comment">// Every message should have a plain text fallback.
</span>)
.singlepart(
SinglePart::builder()
.header(header::ContentType::TEXT_HTML)
.body(html),
),
)
.<span class="ident">unwrap</span>();
.unwrap();
<span class="ident">data</span>.<span class="ident">mailer</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>().<span class="ident">send</span>(<span class="ident">email</span>).<span class="kw">await</span><span class="question-mark">?</span>;
data.mailer.as_ref().unwrap().send(email).<span class="kw">await</span><span class="question-mark">?</span>;
}
<span class="prelude-val">Ok</span>(())
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">tests</span> {
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">awc::Client</span>;
<span class="kw">use </span>awc::Client;
<span class="attribute">#[<span class="ident">actix_rt::test</span>]</span>
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">email_verification_works_pg</span>() {
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="ident"><span class="kw">crate</span>::tests::pg::get_data</span>().<span class="kw">await</span>;
<span class="ident">email_verification_works</span>(<span class="ident">data</span>).<span class="kw">await</span>;
<span class="attribute">#[actix_rt::test]
</span><span class="kw">async fn </span>email_verification_works_pg() {
<span class="kw">let </span>data = <span class="kw">crate</span>::tests::pg::get_data().<span class="kw">await</span>;
email_verification_works(data).<span class="kw">await</span>;
}
<span class="attribute">#[<span class="ident">actix_rt::test</span>]</span>
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">email_verification_works_maria</span>() {
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="ident"><span class="kw">crate</span>::tests::maria::get_data</span>().<span class="kw">await</span>;
<span class="ident">email_verification_works</span>(<span class="ident">data</span>).<span class="kw">await</span>;
<span class="attribute">#[actix_rt::test]
</span><span class="kw">async fn </span>email_verification_works_maria() {
<span class="kw">let </span>data = <span class="kw">crate</span>::tests::maria::get_data().<span class="kw">await</span>;
email_verification_works(data).<span class="kw">await</span>;
}
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">email_verification_works</span>(<span class="ident">data</span>: <span class="ident"><span class="kw">crate</span>::ArcData</span>) {
<span class="kw">const</span> <span class="ident">TO_ADDR</span>: <span class="kw-2">&amp;</span><span class="ident">str</span> <span class="op">=</span> <span class="string">&quot;Hello &lt;realaravinth@localhost&gt;&quot;</span>;
<span class="kw">const</span> <span class="ident">VERIFICATION_LINK</span>: <span class="kw-2">&amp;</span><span class="ident">str</span> <span class="op">=</span> <span class="string">&quot;https://localhost&quot;</span>;
<span class="kw">let</span> <span class="ident">settings</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="ident">data</span>.<span class="ident">settings</span>;
<span class="ident">verification</span>(<span class="kw-2">&amp;</span><span class="ident">data</span>, <span class="ident">TO_ADDR</span>, <span class="ident">VERIFICATION_LINK</span>)
.<span class="kw">await</span>
.<span class="ident">unwrap</span>();
<span class="kw">async fn </span>email_verification_works(data: <span class="kw">crate</span>::ArcData) {
<span class="kw">const </span>TO_ADDR: <span class="kw-2">&amp;</span>str = <span class="string">&quot;Hello &lt;realaravinth@localhost&gt;&quot;</span>;
<span class="kw">const </span>VERIFICATION_LINK: <span class="kw-2">&amp;</span>str = <span class="string">&quot;https://localhost&quot;</span>;
<span class="kw">let </span>settings = <span class="kw-2">&amp;</span>data.settings;
verification(<span class="kw-2">&amp;</span>data, TO_ADDR, VERIFICATION_LINK)
.<span class="kw">await
</span>.unwrap();
<span class="kw">let</span> <span class="ident">client</span> <span class="op">=</span> <span class="ident">Client::default</span>();
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">resp</span> <span class="op">=</span> <span class="ident">client</span>
.<span class="ident">get</span>(<span class="string">&quot;http://localhost:1080/email&quot;</span>)
.<span class="ident">send</span>()
.<span class="kw">await</span>
.<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">data</span>: <span class="ident">serde_json::Value</span> <span class="op">=</span> <span class="ident">resp</span>.<span class="ident">json</span>().<span class="kw">await</span>.<span class="ident">unwrap</span>();
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="ident">data</span>[<span class="number">0</span>];
<span class="kw">let</span> <span class="ident">smtp</span> <span class="op">=</span> <span class="ident">settings</span>.<span class="ident">smtp</span>.<span class="ident">as_ref</span>().<span class="ident">unwrap</span>();
<span class="kw">let </span>client = Client::default();
<span class="kw">let </span><span class="kw-2">mut </span>resp = client
.get(<span class="string">&quot;http://localhost:1080/email&quot;</span>)
.send()
.<span class="kw">await
</span>.unwrap();
<span class="kw">let </span>data: serde_json::Value = resp.json().<span class="kw">await</span>.unwrap();
<span class="kw">let </span>data = <span class="kw-2">&amp;</span>data[<span class="number">0</span>];
<span class="kw">let </span>smtp = settings.smtp.as_ref().unwrap();
<span class="kw">let</span> <span class="ident">from_addr</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="ident">data</span>[<span class="string">&quot;headers&quot;</span>][<span class="string">&quot;from&quot;</span>];
<span class="kw">let </span>from_addr = <span class="kw-2">&amp;</span>data[<span class="string">&quot;headers&quot;</span>][<span class="string">&quot;from&quot;</span>];
<span class="macro">assert!</span>(<span class="ident">from_addr</span>.<span class="ident">to_string</span>().<span class="ident">contains</span>(<span class="kw-2">&amp;</span><span class="ident">smtp</span>.<span class="ident">from</span>));
<span class="macro">assert!</span>(from_addr.to_string().contains(<span class="kw-2">&amp;</span>smtp.from));
<span class="kw">let</span> <span class="ident">body</span> <span class="op">=</span> <span class="kw-2">&amp;</span><span class="ident">data</span>[<span class="string">&quot;html&quot;</span>];
<span class="macro">assert!</span>(<span class="ident">body</span>.<span class="ident">to_string</span>().<span class="ident">contains</span>(<span class="ident">VERIFICATION_LINK</span>));
<span class="kw">let </span>body = <span class="kw-2">&amp;</span>data[<span class="string">&quot;html&quot;</span>];
<span class="macro">assert!</span>(body.to_string().contains(VERIFICATION_LINK));
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="mcaptcha" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="mcaptcha" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.65.0 (897e37553 2022-11-02)" ></div></body></html>