youyesyet/docs/youyesyet.routes.oauth.html

<!DOCTYPE html PUBLIC ""
    "">
<html><head><meta charset="UTF-8" /><title>youyesyet.routes.oauth documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Youyesyet</span> <span class="project-version">0.2.2-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="authorisation.html"><div class="inner"><span>Security and authorisation</span></div></a></li><li class="depth-1 "><a href="competitors.html"><div class="inner"><span>Competitor Analysis</span></div></a></li><li class="depth-1 "><a href="database.html"><div class="inner"><span>Database Specification</span></div></a></li><li class="depth-1 "><a href="scaling.html"><div class="inner"><span>YouYesYet: Scaling</span></div></a></li><li class="depth-1 "><a href="userspec.html"><div class="inner"><span>YouYesYet: User-oriented specification</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>youyesyet</span></div></div></li><li class="depth-2 branch"><a href="youyesyet.cache.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cache</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>canvasser-app</span></div></div></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.ajax.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ajax</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.gis.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gis</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.handlers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>handlers</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.state.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>state</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.subscriptions.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>subscriptions</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.ui-utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ui-utils</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>views</span></div></div></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.about.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>about</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.building.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>building</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.dwelling.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>dwelling</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.elector.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>elector</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.followup.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>followup</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.gdpr.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gdpr</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.issue.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>issue</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.issues.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>issues</span></div></a></li><li class="depth-4"><a href="youyesyet.canvasser-app.views.map.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>map</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.config.html"><div class="inner"><span class="tree" style="top: -548px;"><span class="top" style="height: 557px;"></span><span class="bottom"></span></span><span>config</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>db</span></div></div></li><li class="depth-3"><a href="youyesyet.db.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.handler.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>handler</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.layout.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>layout</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.locality.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>locality</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.middleware.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>middleware</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.oauth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>oauth</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.outqueue.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>outqueue</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>routes</span></div></div></li><li class="depth-3 branch"><a href="youyesyet.routes.auto.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auto</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.auto-json.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auto-json</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.home.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>home</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.issue-experts.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>issue-experts</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.logged-in.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>logged-in</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.manual.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>manual</span></div></a></li><li class="depth-3 branch current"><a href="youyesyet.routes.oauth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>oauth</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.rest.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rest</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.roles.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>roles</span></div></a></li><li class="depth-3"><a href="youyesyet.routes.services.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>services</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.utils.html"><div class="inner"><span class="tree" style="top: -331px;"><span class="top" style="height: 340px;"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-2"><a href="youyesyet.validation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>validation</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="youyesyet.routes.oauth.html#var-oauth-callback"><div class="inner"><span>oauth-callback</span></div></a></li><li class="depth-1"><a href="youyesyet.routes.oauth.html#var-oauth-init"><div class="inner"><span>oauth-init</span></div></a></li><li class="depth-1"><a href="youyesyet.routes.oauth.html#var-oauth-routes"><div class="inner"><span>oauth-routes</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">youyesyet.routes.oauth</h1><div class="doc"><div class="markdown"><p>OAuth authentication routes - not finished, does not work yet.</p></div></div><div class="public anchor" id="var-oauth-callback"><h3>oauth-callback</h3><div class="usage"><code>(oauth-callback request_token {:keys [session]})</code></div><div class="doc"><div class="markdown"><p>Handles the callback from the authority.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/youyesyet/blob/master/src/clj/youyesyet/routes/oauth.clj#L21">view source</a></div></div><div class="public anchor" id="var-oauth-init"><h3>oauth-init</h3><div class="usage"><code>(oauth-init request)</code></div><div class="doc"><div class="markdown"><p>Initiates the OAuth with the authority implied by this <code>request</code></p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/youyesyet/blob/master/src/clj/youyesyet/routes/oauth.clj#L9">view source</a></div></div><div class="public anchor" id="var-oauth-routes"><h3>oauth-routes</h3><div class="usage"></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/youyesyet/blob/master/src/clj/youyesyet/routes/oauth.clj#L36">view source</a></div></div></div></body></html>
	`<!DOCTYPE html PUBLIC ""`
	`"">`
	<html><head><meta charset="UTF-8" /><title>youyesyet.routes.oauth documentation</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Youyesyet</span> <span class="project-version">0.2.2-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="authorisation.html"><div class="inner"><span>Security and authorisation</span></div></a></li><li class="depth-1 "><a href="competitors.html"><div class="inner"><span>Competitor Analysis</span></div></a></li><li class="depth-1 "><a href="database.html"><div class="inner"><span>Database Specification</span></div></a></li><li class="depth-1 "><a href="scaling.html"><div class="inner"><span>YouYesYet: Scaling</span></div></a></li><li class="depth-1 "><a href="userspec.html"><div class="inner"><span>YouYesYet: User-oriented specification</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>youyesyet</span></div></div></li><li class="depth-2 branch"><a href="youyesyet.cache.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>cache</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>canvasser-app</span></div></div></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.ajax.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ajax</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.gis.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gis</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.handlers.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>handlers</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.state.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>state</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.subscriptions.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>subscriptions</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.canvasser-app.ui-utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>ui-utils</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>views</span></div></div></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.about.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>about</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.building.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>building</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.dwelling.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>dwelling</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.elector.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>elector</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.followup.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>followup</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.gdpr.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gdpr</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.issue.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>issue</span></div></a></li><li class="depth-4 branch"><a href="youyesyet.canvasser-app.views.issues.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>issues</span></div></a></li><li class="depth-4"><a href="youyesyet.canvasser-app.views.map.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>map</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.config.html"><div class="inner"><span class="tree" style="top: -548px;"><span class="top" style="height: 557px;"></span><span class="bottom"></span></span><span>config</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>db</span></div></div></li><li class="depth-3"><a href="youyesyet.db.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.handler.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>handler</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.layout.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>layout</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.locality.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>locality</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.middleware.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>middleware</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.oauth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>oauth</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.outqueue.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>outqueue</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>routes</span></div></div></li><li class="depth-3 branch"><a href="youyesyet.routes.auto.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auto</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.auto-json.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>auto-json</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.home.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>home</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.issue-experts.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>issue-experts</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.logged-in.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>logged-in</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.manual.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>manual</span></div></a></li><li class="depth-3 branch current"><a href="youyesyet.routes.oauth.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>oauth</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.rest.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rest</span></div></a></li><li class="depth-3 branch"><a href="youyesyet.routes.roles.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>roles</span></div></a></li><li class="depth-3"><a href="youyesyet.routes.services.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>services</span></div></a></li><li class="depth-2 branch"><a href="youyesyet.utils.html"><div class="inner"><span class="tree" style="top: -331px;"><span class="top" style="height: 340px;"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-2"><a href="youyesyet.validation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>validation</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="youyesyet.routes.oauth.html#var-oauth-callback"><div class="inner"><span>oauth-callback</span></div></a></li><li class="depth-1"><a href="youyesyet.routes.oauth.html#var-oauth-init"><div class="inner"><span>oauth-init</span></div></a></li><li class="depth-1"><a href="youyesyet.routes.oauth.html#var-oauth-routes"><div class="inner"><span>oauth-routes</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">youyesyet.routes.oauth</h1><div class="doc"><div class="markdown"><p>OAuth authentication routes - not finished, does not work yet.</p></div></div><div class="public anchor" id="var-oauth-callback"><h3>oauth-callback</h3><div class="usage"><code>(oauth-callback request_token {:keys [session]})</code></div><div class="doc"><div class="markdown"><p>Handles the callback from the authority.</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/youyesyet/blob/master/src/clj/youyesyet/routes/oauth.clj#L21">view source</a></div></div><div class="public anchor" id="var-oauth-init"><h3>oauth-init</h3><div class="usage"><code>(oauth-init request)</code></div><div class="doc"><div class="markdown"><p>Initiates the OAuth with the authority implied by this <code>request</code></p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/youyesyet/blob/master/src/clj/youyesyet/routes/oauth.clj#L9">view source</a></div></div><div class="public anchor" id="var-oauth-routes"><h3>oauth-routes</h3><div class="usage"></div><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="src-link"><a href="https://github.com/simon-brooke/youyesyet/blob/master/src/clj/youyesyet/routes/oauth.clj#L36">view source</a></div></div></div></body></html>