mirror/mCaptcha
1
0
Fork 1
mirror of https://github.com/mCaptcha/mCaptcha.git synced 2026-02-11 18:15:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ 8d2d81ed76 🚀

Browse Source
This commit is contained in:
realaravinth
2021-03-24 08:33:56 +00:00
parent 05d83fe847
commit 3daf12c5ae
40 changed files with 929 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

182
src/guard/api/v1/meta.rs.html Normal file
View File

@@ -0,0 +1,182 @@
<!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/api/v1/meta.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>meta.rs - source</title><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="../../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../../storage.js"></script><noscript><link rel="stylesheet" href="../../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../../../guard/index.html'><div class='logo-container rust-logo'><img src='../../../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../../../settings.html"><img src="../../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span>
<span id="2"> 2</span>
<span id="3"> 3</span>
<span id="4"> 4</span>
<span id="5"> 5</span>
<span id="6"> 6</span>
<span id="7"> 7</span>
<span id="8"> 8</span>
<span id="9"> 9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="comment">/*
* Copyright (C) 2021 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* 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="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">get</span>, <span class="ident">web</span>, <span class="ident">HttpResponse</span>, <span class="ident">Responder</span>};
<span class="kw">use</span> <span class="ident">derive_builder</span>::<span class="ident">Builder</span>;
<span class="kw">use</span> <span class="ident">serde</span>::{<span class="ident">Deserialize</span>, <span class="ident">Serialize</span>};
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">Data</span>;
<span class="kw">use</span> <span class="kw">crate</span>::{<span class="ident">GIT_COMMIT_HASH</span>, <span class="ident">VERSION</span>};
<span class="attribute">#[<span class="ident">get</span>(<span class="string">&quot;/api/v1/meta/build&quot;</span>)]</span>
<span class="doccomment">/// emmits build details of the bninary</span>
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">build_details</span>() <span class="op">-</span><span class="op">&gt;</span> <span class="kw">impl</span> <span class="ident">Responder</span> {
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">content_type</span>(<span class="string">&quot;text/html&quot;</span>).<span class="ident">body</span>(<span class="macro">format</span><span class="macro">!</span>(
<span class="string">&quot;version: {}\ncommit: {}&quot;</span>,
<span class="ident">VERSION</span>, <span class="kw-2">*</span><span class="ident">GIT_COMMIT_HASH</span>
))
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">Deserialize</span>, <span class="ident">Builder</span>, <span class="ident">Serialize</span>)]</span>
<span class="doccomment">/// Health check return datatype</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Health</span> {
<span class="ident">db</span>: <span class="ident">bool</span>,
}
<span class="attribute">#[<span class="ident">get</span>(<span class="string">&quot;/api/v1/meta/health&quot;</span>)]</span>
<span class="doccomment">/// checks all components of the system</span>
<span class="kw">pub</span> <span class="kw">async</span> <span class="kw">fn</span> <span class="ident">health</span>(<span class="ident">data</span>: <span class="ident">web</span>::<span class="ident">Data</span><span class="op">&lt;</span><span class="ident">Data</span><span class="op">&gt;</span>) <span class="op">-</span><span class="op">&gt;</span> <span class="kw">impl</span> <span class="ident">Responder</span> {
<span class="kw">use</span> <span class="ident">sqlx</span>::<span class="ident">Connection</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">resp_builder</span> <span class="op">=</span> <span class="ident">HealthBuilder</span>::<span class="ident">default</span>();
<span class="ident">resp_builder</span>.<span class="ident">db</span>(<span class="bool-val">false</span>);
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Ok</span>(<span class="kw-2">mut</span> <span class="ident">con</span>) <span class="op">=</span> <span class="ident">data</span>.<span class="ident">db</span>.<span class="ident">acquire</span>().<span class="kw">await</span> {
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Ok</span>(<span class="kw">_</span>) <span class="op">=</span> <span class="ident">con</span>.<span class="ident">ping</span>().<span class="kw">await</span> {
<span class="ident">resp_builder</span>.<span class="ident">db</span>(<span class="bool-val">true</span>);
}
};
<span class="ident">HttpResponse</span>::<span class="prelude-val">Ok</span>().<span class="ident">json</span>(<span class="ident">resp_builder</span>.<span class="ident">build</span>().<span class="ident">unwrap</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="ident">actix_web</span>::{<span class="ident">http</span>::<span class="ident">StatusCode</span>, <span class="ident">test</span>, <span class="ident">App</span>};
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="ident">api</span>::<span class="ident">v1</span>::<span class="ident">services</span> <span class="kw">as</span> <span class="ident">v1_services</span>;
<span class="kw">use</span> <span class="kw">crate</span>::<span class="kw-2">*</span>;
<span class="attribute">#[<span class="ident">actix_rt</span>::<span class="ident">test</span>]</span>
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">build_details_works</span>() {
<span class="kw">const</span> <span class="ident">GET_URI</span>: <span class="kw-2">&amp;</span><span class="ident">str</span> <span class="op">=</span> <span class="string">&quot;/api/v1/meta/build&quot;</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">app</span> <span class="op">=</span> <span class="ident">test</span>::<span class="ident">init_service</span>(<span class="ident">App</span>::<span class="ident">new</span>().<span class="ident">configure</span>(<span class="ident">v1_services</span>)).<span class="kw">await</span>;
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span>
<span class="ident">test</span>::<span class="ident">call_service</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">app</span>, <span class="ident">test</span>::<span class="ident">TestRequest</span>::<span class="ident">get</span>().<span class="ident">uri</span>(<span class="ident">GET_URI</span>).<span class="ident">to_request</span>()).<span class="kw">await</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode</span>::<span class="ident">OK</span>);
}
<span class="attribute">#[<span class="ident">actix_rt</span>::<span class="ident">test</span>]</span>
<span class="kw">async</span> <span class="kw">fn</span> <span class="ident">health_works</span>() {
<span class="kw">const</span> <span class="ident">GET_URI</span>: <span class="kw-2">&amp;</span><span class="ident">str</span> <span class="op">=</span> <span class="string">&quot;/api/v1/meta/health&quot;</span>;
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="ident">Data</span>::<span class="ident">new</span>().<span class="kw">await</span>;
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">app</span> <span class="op">=</span> <span class="macro">get_app</span><span class="macro">!</span>(<span class="ident">data</span>).<span class="kw">await</span>;
<span class="kw">let</span> <span class="ident">resp</span> <span class="op">=</span>
<span class="ident">test</span>::<span class="ident">call_service</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">app</span>, <span class="ident">test</span>::<span class="ident">TestRequest</span>::<span class="ident">get</span>().<span class="ident">uri</span>(<span class="ident">GET_URI</span>).<span class="ident">to_request</span>()).<span class="kw">await</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">resp</span>.<span class="ident">status</span>(), <span class="ident">StatusCode</span>::<span class="ident">OK</span>);
<span class="kw">let</span> <span class="ident">health_resp</span>: <span class="ident">Health</span> <span class="op">=</span> <span class="ident">test</span>::<span class="ident">read_body_json</span>(<span class="ident">resp</span>).<span class="kw">await</span>;
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">health_resp</span>.<span class="ident">db</span>, <span class="bool-val">true</span>);
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../../../";window.currentCrate = "guard";</script><script src="../../../../main.js"></script><script src="../../../../source-script.js"></script><script src="../../../../source-files.js"></script><script defer src="../../../../search-index.js"></script></body></html>

46
src/guard/api/v1/mod.rs.html
View File

@@ -48,6 +48,11 @@
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="comment">/*
* Copyright (C) 2021 Aravinth Manivannan &lt;realaravinth@batsense.net&gt;
@@ -70,28 +75,33 @@
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">auth</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">mcaptcha</span>;
<span class="kw">pub</span> <span class="kw">mod</span> <span class="ident">meta</span>;
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">services</span>(<span class="ident">cfg</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">ServiceConfig</span>) {
<span class="kw">use</span> <span class="ident">auth</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">mcaptcha</span>::<span class="kw-2">*</span>;
<span class="comment">// auth</span>
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">auth</span>::<span class="ident">signout</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">auth</span>::<span class="ident">signin</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">auth</span>::<span class="ident">signup</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">auth</span>::<span class="ident">delete_account</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">signout</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">signin</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">signup</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">delete_account</span>);
<span class="comment">// mcaptcha</span>
<span class="comment">// 1. domain and mcaptcha</span>
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">mcaptcha</span>::<span class="ident">add_domain</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">mcaptcha</span>::<span class="ident">delete_domain</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">mcaptcha</span>::<span class="ident">add_mcaptcha</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">mcaptcha</span>::<span class="ident">delete_mcaptcha</span>);
<span class="comment">// levels</span>
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">mcaptcha</span>::<span class="ident">add_levels</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">mcaptcha</span>::<span class="ident">update_levels</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">mcaptcha</span>::<span class="ident">delete_levels</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">mcaptcha</span>::<span class="ident">get_levels</span>);
<span class="comment">// duration</span>
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">mcaptcha</span>::<span class="ident">update_duration</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">mcaptcha</span>::<span class="ident">get_duration</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">add_domain</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">delete_domain</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">add_mcaptcha</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">delete_mcaptcha</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">add_levels</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">update_levels</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">delete_levels</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">get_levels</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">update_duration</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">get_duration</span>);
<span class="comment">// meta</span>
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">meta</span>::<span class="ident">build_details</span>);
<span class="ident">cfg</span>.<span class="ident">service</span>(<span class="ident">meta</span>::<span class="ident">health</span>);
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>