<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Clavem::Authorizer
— Documentation by YARD 0.8.3
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (A)</a> »
<span class='title'><span class='object_link'><a href="../Clavem.html" title="Clavem (module)">Clavem</a></span></span>
»
<span class="title">Authorizer</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Clavem::Authorizer
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Clavem::Authorizer</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2">Includes:</dt>
<dd class="r2">R18n::Helpers</dd>
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/clavem/authorizer.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A class to handle oAuth authorizations.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#command-instance_method" title="#command (instance method)">- (String) <strong>command</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The command to open the URL.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#i18n-instance_method" title="#i18n (instance method)">- (Object) <strong>i18n</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute i18n.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ip-instance_method" title="#ip (instance method)">- (String) <strong>ip</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The IP address on which listening for replies.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#localizer-instance_method" title="#localizer (instance method)">- (R18N::Translation) <strong>localizer</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>A localizer object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#port-instance_method" title="#port (instance method)">- (Fixnum) <strong>port</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The port on which listening for replies.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#response_handler-instance_method" title="#response_handler (instance method)">- (Proc) <strong>response_handler</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>A Ruby block to handle response and check for success.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#status-instance_method" title="#status (instance method)">- (Object) <strong>status</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute status.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#template-instance_method" title="#template (instance method)">- (String) <strong>template</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Alternative template to show progress in user's browser.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#timeout-instance_method" title="#timeout (instance method)">- (Fixnum) <strong>timeout</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The amount of milliseconds to wait for response from the remote endpoint before returning a failure.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#title-instance_method" title="#title (instance method)">- (String) <strong>title</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The title for response template.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#token-instance_method" title="#token (instance method)">- (String) <strong>token</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The token obtained by the remote endpoint.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#url-instance_method" title="#url (instance method)">- (String) <strong>url</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The URL where to send the user to start authorization..</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#instance-class_method" title="instance (class method)">+ (Authorizer) <strong>instance</strong>(ip = "127.0.0.1", port = 2501, command = nil, title = nil, template = nil, timeout = 0, force = false, &response_handler) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns a unique (singleton) instance of the authorizer.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#authorize-instance_method" title="#authorize (instance method)">- (Authorizer) <strong>authorize</strong>(url) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Starts the authorization flow.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#callback_url-instance_method" title="#callback_url (instance method)">- (String) <strong>callback_url</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the callback_url for this authorizer.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default_response_handler-instance_method" title="#default_response_handler (instance method)">- (String|nil) <strong>default_response_handler</strong>(authorizer, request, response) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Handles a response from the remote endpoint.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (Authorizer) <strong>initialize</strong>(ip = "127.0.0.1", port = 2501, command = nil, title = nil, template = nil, timeout = 0, &response_handler) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Creates a new authorizer.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Clavem::Authorizer (class)">Authorizer</a></span></tt>) <strong>initialize</strong>(ip = "127.0.0.1", port = 2501, command = nil, title = nil, template = nil, timeout = 0, &response_handler)
</h3><div class="docstring">
<div class="discussion">
<p>Creates a new authorizer.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>ip</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>"127.0.0.1"</tt>)</em>
—
<div class='inline'><p>The IP address on which listening for replies. Default is <code>127.0.0.1</code>.</p>
</div>
</li>
<li>
<span class='name'>port</span>
<span class='type'>(<tt>Fixnum</tt>)</span>
<em class="default">(defaults to: <tt>2501</tt>)</em>
—
<div class='inline'><p>The port on which listening for replies. Default is <code>2501</code>.</p>
</div>
</li>
<li>
<span class='name'>command</span>
<span class='type'>(<tt>String|nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The command to open the URL. <code>{{URL}}</code> is replaced with the specified URL. Default is <code>open "{{URL}}"</code>.</p>
</div>
</li>
<li>
<span class='name'>title</span>
<span class='type'>(<tt>String|nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The title for response template. Default is <code>Clavem Authorization</code></p>
</div>
</li>
<li>
<span class='name'>template</span>
<span class='type'>(<tt>String|nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Alternative template to show progress in user's browser.</p>
</div>
</li>
<li>
<span class='name'>timeout</span>
<span class='type'>(<tt>Fixnum</tt>)</span>
<em class="default">(defaults to: <tt>0</tt>)</em>
—
<div class='inline'><p>The amount of milliseconds to wait for response from the remote endpoint before returning a failure. Default is <code>0</code>, which means <em>disabled</em>.</p>
</div>
</li>
<li>
<span class='name'>response_handler</span>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'><p>A Ruby block to handle response and check for success. See <span class='object_link'><a href="#default_response_handler-instance_method" title="Clavem::Authorizer#default_response_handler (method)">#default_response_handler</a></span>.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_ip'>ip</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='int'>2501</span><span class='comma'>,</span> <span class='id identifier rubyid_command'>command</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_title'>title</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_template'>template</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_timeout'>timeout</span> <span class='op'>=</span> <span class='int'>0</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_response_handler'>response_handler</span><span class='rparen'>)</span>
<span class='ivar'>@ip</span> <span class='op'>=</span> <span class='id identifier rubyid_ip'>ip</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='op'>?</span> <span class='id identifier rubyid_ip'>ip</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>"</span></span>
<span class='ivar'>@port</span> <span class='op'>=</span> <span class='id identifier rubyid_port'>port</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span> <span class='op'><</span> <span class='int'>1</span> <span class='op'>?</span> <span class='int'>2501</span> <span class='op'>:</span> <span class='id identifier rubyid_port'>port</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span>
<span class='ivar'>@command</span> <span class='op'>=</span> <span class='id identifier rubyid_command'>command</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='op'>?</span> <span class='id identifier rubyid_command'>command</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>open \"{{URL}}\"</span><span class='tstring_end'>"</span></span>
<span class='ivar'>@title</span> <span class='op'>=</span> <span class='id identifier rubyid_title'>title</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='op'>?</span> <span class='id identifier rubyid_title'>title</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Clavem Authorization</span><span class='tstring_end'>"</span></span>
<span class='ivar'>@template</span> <span class='op'>=</span> <span class='id identifier rubyid_template'>template</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='op'>?</span> <span class='id identifier rubyid_template'>template</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span> <span class='op'>:</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_dirname'>dirname</span><span class='lparen'>(</span><span class='kw'>__FILE__</span><span class='rparen'>)</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/template.html.erb</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='ivar'>@timeout</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_timeout'>timeout</span><span class='period'>.</span><span class='id identifier rubyid_to_integer'>to_integer</span><span class='comma'>,</span> <span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_max'>max</span>
<span class='ivar'>@response_handler</span> <span class='op'>=</span> <span class='id identifier rubyid_response_handler'>response_handler</span>
<span class='ivar'>@token</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@status</span> <span class='op'>=</span> <span class='symbol'>:waiting</span>
<span class='ivar'>@compiled_template</span> <span class='op'>||=</span> <span class='op'>::</span><span class='const'>ERB</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@template</span><span class='rparen'>)</span>
<span class='ivar'>@i18n</span> <span class='op'>=</span> <span class='id identifier rubyid_t'>t</span>
<span class='ivar'>@timeout_expired</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='ivar'>@timeout_thread</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='kw'>self</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="command=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="command-instance_method">
- (<tt>String</tt>) <strong>command</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The command to open the URL. <code>{{URL}}</code> is replaced with the specified URL. Default is <code>open "{{URL}}"</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the current value of command</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_command'>command</span>
<span class='ivar'>@command</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="i18n=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="i18n-instance_method">
- (<tt>Object</tt>) <strong>i18n</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute i18n</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 51</span>
<span class='kw'>def</span> <span class='id identifier rubyid_i18n'>i18n</span>
<span class='ivar'>@i18n</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="ip=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="ip-instance_method">
- (<tt>String</tt>) <strong>ip</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The IP address on which listening for replies. Default is <code>127.0.0.1</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the current value of ip</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ip'>ip</span>
<span class='ivar'>@ip</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="localizer=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="localizer-instance_method">
- (<tt>R18N::Translation</tt>) <strong>localizer</strong>
</h3><div class="docstring">
<div class="discussion">
<p>A localizer object.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>R18N::Translation</tt>)</span>
—
<div class='inline'><p>the current value of localizer</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_localizer'>localizer</span>
<span class='ivar'>@localizer</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="port=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="port-instance_method">
- (<tt>Fixnum</tt>) <strong>port</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The port on which listening for replies. Default is <code>2501</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Fixnum</tt>)</span>
—
<div class='inline'><p>the current value of port</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_port'>port</span>
<span class='ivar'>@port</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="response_handler=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="response_handler-instance_method">
- (<tt>Proc</tt>) <strong>response_handler</strong>
</h3><div class="docstring">
<div class="discussion">
<p>A Ruby block to handle response and check for success. @see <span class='object_link'><a href="#default_response_handler-instance_method" title="Clavem::Authorizer#default_response_handler (method)">#default_response_handler</a></span>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'><p>the current value of response_handler</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_response_handler'>response_handler</span>
<span class='ivar'>@response_handler</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="status=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="status-instance_method">
- (<tt>Object</tt>) <strong>status</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute status</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span>
<span class='ivar'>@status</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="template=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="template-instance_method">
- (<tt>String</tt>) <strong>template</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Alternative template to show progress in user's browser.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the current value of template</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_template'>template</span>
<span class='ivar'>@template</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="timeout=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="timeout-instance_method">
- (<tt>Fixnum</tt>) <strong>timeout</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The amount of milliseconds to wait for response from the remote endpoint before returning a failure. Default is <code>0</code>, which means <em>disabled</em>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Fixnum</tt>)</span>
—
<div class='inline'><p>the current value of timeout</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_timeout'>timeout</span>
<span class='ivar'>@timeout</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="title=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="title-instance_method">
- (<tt>String</tt>) <strong>title</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The title for response template. Default is <code>Clavem Authorization</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the current value of title</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
<span class='ivar'>@title</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="token=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="token-instance_method">
- (<tt>String</tt>) <strong>token</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The token obtained by the remote endpoint.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the current value of token</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_token'>token</span>
<span class='ivar'>@token</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="url=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="url-instance_method">
- (<tt>String</tt>) <strong>url</strong>
</h3><div class="docstring">
<div class="discussion">
<p>The URL where to send the user to start authorization..</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the current value of url</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_url'>url</span>
<span class='ivar'>@url</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="instance-class_method">
+ (<tt><span class='object_link'><a href="" title="Clavem::Authorizer (class)">Authorizer</a></span></tt>) <strong>instance</strong>(ip = "127.0.0.1", port = 2501, command = nil, title = nil, template = nil, timeout = 0, force = false, &response_handler)
</h3><div class="docstring">
<div class="discussion">
<p>Returns a unique (singleton) instance of the authorizer.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>ip</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>"127.0.0.1"</tt>)</em>
—
<div class='inline'><p>The IP address on which listening for replies. Default is <code>127.0.0.1</code>.</p>
</div>
</li>
<li>
<span class='name'>port</span>
<span class='type'>(<tt>Fixnum</tt>)</span>
<em class="default">(defaults to: <tt>2501</tt>)</em>
—
<div class='inline'><p>The port on which listening for replies. Default is <code>2501</code>.</p>
</div>
</li>
<li>
<span class='name'>command</span>
<span class='type'>(<tt>String|nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The command to open the URL. <code>{{URL}}</code> is replaced with the specified URL. Default is <code>open "{{URL}}"</code>.</p>
</div>
</li>
<li>
<span class='name'>title</span>
<span class='type'>(<tt>String|nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The title for response template. Default is <code>Clavem Authorization</code></p>
</div>
</li>
<li>
<span class='name'>template</span>
<span class='type'>(<tt>String|nil</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Alternative template to show progress in user's browser.</p>
</div>
</li>
<li>
<span class='name'>timeout</span>
<span class='type'>(<tt>Fixnum</tt>)</span>
<em class="default">(defaults to: <tt>0</tt>)</em>
—
<div class='inline'><p>The amount of milliseconds to wait for response from the remote endpoint before returning a failure. Default is <code>0</code>, which means <em>disabled</em>.</p>
</div>
</li>
<li>
<span class='name'>response_handler</span>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'><p>A Ruby block to handle response and check for success. See <span class='object_link'><a href="#default_response_handler-instance_method" title="Clavem::Authorizer#default_response_handler (method)">#default_response_handler</a></span>.</p>
</div>
</li>
<li>
<span class='name'>force</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>If to force recreation of the instance.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Clavem::Authorizer (class)">Authorizer</a></span></tt>)</span>
—
<div class='inline'><p>The unique (singleton) instance of the authorizer.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
64
65
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 64</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span><span class='lparen'>(</span><span class='id identifier rubyid_ip'>ip</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span> <span class='op'>=</span> <span class='int'>2501</span><span class='comma'>,</span> <span class='id identifier rubyid_command'>command</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_title'>title</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_template'>template</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_timeout'>timeout</span> <span class='op'>=</span> <span class='int'>0</span><span class='comma'>,</span> <span class='id identifier rubyid_force'>force</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_response_handler'>response_handler</span><span class='rparen'>)</span>
<span class='ivar'>@instance</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_force'>force</span>
<span class='ivar'>@instance</span> <span class='op'>||=</span> <span class='const'>Clavem</span><span class='op'>::</span><span class='const'>Authorizer</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_ip'>ip</span><span class='comma'>,</span> <span class='id identifier rubyid_port'>port</span><span class='comma'>,</span> <span class='id identifier rubyid_command'>command</span><span class='comma'>,</span> <span class='id identifier rubyid_title'>title</span><span class='comma'>,</span> <span class='id identifier rubyid_template'>template</span><span class='comma'>,</span> <span class='id identifier rubyid_timeout'>timeout</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_response_handler'>response_handler</span><span class='rparen'>)</span>
<span class='ivar'>@instance</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="authorize-instance_method">
- (<tt><span class='object_link'><a href="" title="Clavem::Authorizer (class)">Authorizer</a></span></tt>) <strong>authorize</strong>(url)
</h3><div class="docstring">
<div class="discussion">
<p>Starts the authorization flow.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>url</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The URL where to send the user to start authorization.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Clavem::Authorizer (class)">Authorizer</a></span></tt>)</span>
—
<div class='inline'><p>The authorizer.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Exceptions/AuthorizationDenied.html" title="Clavem::Exceptions::AuthorizationDenied (class)">Clavem::Exceptions::AuthorizationDenied</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 103</span>
<span class='kw'>def</span> <span class='id identifier rubyid_authorize'>authorize</span><span class='lparen'>(</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
<span class='ivar'>@url</span> <span class='op'>=</span> <span class='id identifier rubyid_url'>url</span>
<span class='ivar'>@status</span> <span class='op'>=</span> <span class='symbol'>:waiting</span>
<span class='kw'>begin</span>
<span class='comment'># Setup stuff
</span> <span class='id identifier rubyid_setup_webserver'>setup_webserver</span>
<span class='id identifier rubyid_setup_interruptions_handling'>setup_interruptions_handling</span>
<span class='id identifier rubyid_setup_timeout_handling'>setup_timeout_handling</span>
<span class='comment'># Open the endpoint then start the server
</span> <span class='id identifier rubyid_open_endpoint'>open_endpoint</span>
<span class='ivar'>@server</span><span class='period'>.</span><span class='id identifier rubyid_start'>start</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Clavem</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>Timeout</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>if</span> <span class='ivar'>@timeout_expired</span>
<span class='kw'>rescue</span> <span class='const'>Clavem</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>Timeout</span> <span class='op'>=></span> <span class='id identifier rubyid_t'>t</span>
<span class='ivar'>@status</span> <span class='op'>=</span> <span class='symbol'>:failure</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='id identifier rubyid_t'>t</span>
<span class='kw'>rescue</span> <span class='op'>=></span> <span class='id identifier rubyid_e'>e</span>
<span class='ivar'>@status</span> <span class='op'>=</span> <span class='symbol'>:failure</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Clavem</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>Failure</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Cannot handle response: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>ensure</span>
<span class='id identifier rubyid_cleanup'>cleanup</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>Clavem</span><span class='op'>::</span><span class='const'>Exceptions</span><span class='op'>::</span><span class='const'>AuthorizationDenied</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>if</span> <span class='ivar'>@status</span> <span class='op'>==</span> <span class='symbol'>:denied</span>
<span class='kw'>self</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="callback_url-instance_method">
- (<tt>String</tt>) <strong>callback_url</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the callback_url for this authorizer.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The callback_url for this authorizer.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
135
136
137</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 135</span>
<span class='kw'>def</span> <span class='id identifier rubyid_callback_url'>callback_url</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>http://</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_ip'>ip</span><span class='rbrace'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_port'>port</span><span class='rbrace'>}</span><span class='tstring_content'>/</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="default_response_handler-instance_method">
- (<tt>String|nil</tt>) <strong>default_response_handler</strong>(authorizer, request, response)
</h3><div class="docstring">
<div class="discussion">
<p>Handles a response from the remote endpoint.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>authorizer</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Clavem::Authorizer (class)">Authorizer</a></span></tt>)</span>
—
<div class='inline'><p>The current authorizer.</p>
</div>
</li>
<li>
<span class='name'>request</span>
<span class='type'>(<tt>WEBrick::HTTPRequest</tt>)</span>
—
<div class='inline'><p>The request that the remote endpoint made to notify authorization status.</p>
</div>
</li>
<li>
<span class='name'>response</span>
<span class='type'>(<tt>WEBrick::HTTPResponse</tt>)</span>
—
<div class='inline'><p>The request to send to the browser.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String|nil</tt>)</span>
—
<div class='inline'><p>The oAuth access token. Returning <code>nil</code> means <em>authorization denied</em>.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
145
146
147</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/clavem/authorizer.rb', line 145</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default_response_handler'>default_response_handler</span><span class='lparen'>(</span><span class='id identifier rubyid_authorizer'>authorizer</span><span class='comma'>,</span> <span class='id identifier rubyid_request'>request</span><span class='comma'>,</span> <span class='id identifier rubyid_response'>response</span><span class='rparen'>)</span>
<span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_query'>query</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>oauth_token</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Jan 27 14:14:59 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.3 (ruby-1.9.3).
</div>
</body>
</html>