Permalink
Browse files

update documentation

  • Loading branch information...
Xylakant committed Dec 14, 2011
1 parent a6a5db9 commit 79e692247a95bbbeb4493037824a15c1d693d881
View
@@ -87,7 +87,7 @@
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
View
@@ -97,7 +97,7 @@ <h2>Defined Under Namespace</h2>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:49 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
View
@@ -2500,7 +2500,7 @@ <h3>Returns:</h3>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
View
@@ -107,7 +107,7 @@
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
View
@@ -558,7 +558,7 @@ <h2>Instance Method Details</h2>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
View
@@ -253,7 +253,7 @@ <h2>Instance Method Details</h2>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
View
@@ -99,7 +99,7 @@ <h2>Defined Under Namespace</h2>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
@@ -99,7 +99,7 @@ <h2>Defined Under Namespace</h2>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
@@ -99,7 +99,7 @@ <h2>Defined Under Namespace</h2>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
@@ -783,7 +783,7 @@ <h3>Returns:</h3>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
@@ -738,7 +738,7 @@ <h3>See Also:</h3>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
@@ -603,7 +603,7 @@ <h3>See Also:</h3>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
View
@@ -214,7 +214,7 @@ <h2>Namespace Listing A-Z</h2>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:49 2011 by
+ Generated on Wed Dec 14 16:49:09 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
View
@@ -178,9 +178,11 @@ <h2>Auth Scheme Name</h2>
<h2>Authentication Header Format</h2>
<p>The format of the Authentication Header can be controlled using the <code>:auth_header_format</code> directive. The given format string will be interpolated
-with all given options and the signature. The default value is <code>%{auth_scheme} %{signature}</code> which will result in an auth header with a format such as <code>HMAC 539263f4f83878a4917d2f9c1521320c28b926a9</code>.</p>
+with all given options and the signature. The default value is <code>%{scheme} %{signature}</code> which will result in an auth header with a format such as <code>HMAC 539263f4f83878a4917d2f9c1521320c28b926a9</code>. The format string must contain at least the <code>scheme</code> and <code>signature</code> components.</p>
-<p>The <code>:auth_header_format</code> directive has a companion directive, <code>:auth_header_parse</code> which can be a proc or a regular expression. Any given regular expression will be evaluated against the string and any named capture pattern will be added to the parameters for the request. The regular expression must at least contain a pattern named <code>scheme</code> and pattern named <code>signature</code>. The default value is <code>/(?&lt;scheme&gt;\w+) (?&lt;signature&gt;\w+)/</code></p>
+<p>The <code>:auth_header_format</code> directive has a companion directive, <code>:auth_header_parse</code> which must be a regular expression. Any given regular expression will be evaluated against the authorization header. The results can be retrieved using the <code>parsed_auth_header</code> method. The regular expression must at least contain a pattern named <code>scheme</code> and pattern named <code>signature</code>. The default value for this directive is a regular expression that is auto-generated by translating the <code>:auth_header_format</code> setting to a regular expression that contains a named capture group for each named part of the format string. Each capture allows for word characters, plus, dash, underscore and dot. The default :auth_header_format <code>%{scheme} %{signature}</code> will be translated to <code>/(?&lt;autschemeh_scheme&gt;[-_+.\w]+) (?&lt;signature&gt;[-_+.\w]+)/</code>.</p>
+
+<p>See the section about multiple authentication secrets for a use-case and a comprehensive example.</p>
<h2>Optional nonce</h2>
@@ -370,9 +372,7 @@ <h3>Header-Based Authentication</h3>
<span class='id identifier rubyid_access_key_id'>access_key_id</span> <span class='op'>=</span> <span class='id identifier rubyid_strategy'>strategy</span><span class='period'>.</span><span class='id identifier rubyid_parsed_auth_header'>parsed_auth_header</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>access_key_id</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='id identifier rubyid_keys'>keys</span><span class='lbracket'>[</span><span class='id identifier rubyid_access_key_id'>access_key_id</span><span class='rbracket'>]</span>
<span class='rbrace'>}</span><span class='comma'>,</span>
- <span class='symbol'>:auth_header_format</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>%{scheme} %{access_key_id} %{signature}</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
- <span class='symbol'>:auth_header_parse</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(?&lt;scheme&gt;\w+) (?&lt;access_key_id&gt;\w+) (?&lt;signature&gt;\w+)</span><span class='regexp_end'>/</span></span>
- <span class='rbrace'>}</span>
+ <span class='symbol'>:auth_header_format</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>%{scheme} %{access_key_id} %{signature}</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
</pre>
@@ -421,7 +421,7 @@ <h2>Faraday Middleware</h2>
<h2>Licence</h2>
-<p>Copyright (c) 2011 Florian Gilcher <a href="&#x6d;&#x61;&#x69;&#x6c;&#116;&#x6f;&#58;&#102;&#108;&#111;&#114;&#x69;&#x61;&#x6e;&#x2e;&#x67;&#105;&#108;&#99;&#104;&#101;&#114;&#64;&#x61;&#x73;&#x71;&#117;&#x65;&#x72;&#x61;&#46;&#100;&#101;">&#x66;&#108;&#111;&#114;&#105;&#97;&#110;&#46;&#103;&#x69;&#x6c;&#x63;&#104;&#101;&#114;&#x40;&#97;&#115;&#x71;&#117;&#101;&#x72;&#97;&#46;&#x64;&#x65;</a>, Felix Gilcher <a href="&#x6d;&#97;&#x69;&#108;&#116;&#111;&#58;&#x66;&#x65;&#108;&#x69;&#x78;&#46;&#103;&#x69;&#x6c;&#x63;&#x68;&#x65;&#x72;&#64;&#x61;&#115;&#113;&#117;&#101;&#x72;&#97;&#46;&#100;&#x65;">&#102;&#101;&#108;&#105;&#120;&#46;&#103;&#x69;&#x6c;&#99;&#x68;&#x65;&#114;&#x40;&#97;&#x73;&#113;&#x75;&#101;&#114;&#97;&#x2e;&#100;&#101;</a></p>
+<p>Copyright (c) 2011 Florian Gilcher <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;&#102;&#108;&#x6f;&#114;&#x69;&#x61;&#x6e;&#46;&#103;&#105;&#108;&#x63;&#x68;&#x65;&#114;&#64;&#x61;&#115;&#x71;&#117;&#101;&#x72;&#97;&#46;&#x64;&#101;">&#x66;&#x6c;&#111;&#x72;&#x69;&#x61;&#110;&#46;&#x67;&#x69;&#x6c;&#99;&#x68;&#101;&#114;&#x40;&#x61;&#x73;&#113;&#117;&#x65;&#114;&#97;&#46;&#100;&#x65;</a>, Felix Gilcher <a href="&#x6d;&#97;&#x69;&#108;&#116;&#111;&#x3a;&#x66;&#101;&#108;&#105;&#120;&#x2e;&#x67;&#x69;&#108;&#x63;&#104;&#101;&#x72;&#x40;&#97;&#x73;&#x71;&#117;&#101;&#x72;&#97;&#x2e;&#100;&#x65;">&#102;&#101;&#x6c;&#x69;&#x78;&#x2e;&#103;&#105;&#x6c;&#x63;&#104;&#x65;&#114;&#x40;&#97;&#115;&#113;&#117;&#x65;&#x72;&#x61;&#x2e;&#100;&#x65;</a></p>
<p>Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -444,7 +444,7 @@ <h2>Licence</h2>
</div></div>
<div id="footer">
- Generated on Tue Dec 13 23:47:49 2011 by
+ Generated on Wed Dec 14 16:49:10 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
View
@@ -178,9 +178,11 @@ <h2>Auth Scheme Name</h2>
<h2>Authentication Header Format</h2>
<p>The format of the Authentication Header can be controlled using the <code>:auth_header_format</code> directive. The given format string will be interpolated
-with all given options and the signature. The default value is <code>%{auth_scheme} %{signature}</code> which will result in an auth header with a format such as <code>HMAC 539263f4f83878a4917d2f9c1521320c28b926a9</code>.</p>
+with all given options and the signature. The default value is <code>%{scheme} %{signature}</code> which will result in an auth header with a format such as <code>HMAC 539263f4f83878a4917d2f9c1521320c28b926a9</code>. The format string must contain at least the <code>scheme</code> and <code>signature</code> components.</p>
-<p>The <code>:auth_header_format</code> directive has a companion directive, <code>:auth_header_parse</code> which can be a proc or a regular expression. Any given regular expression will be evaluated against the string and any named capture pattern will be added to the parameters for the request. The regular expression must at least contain a pattern named <code>scheme</code> and pattern named <code>signature</code>. The default value is <code>/(?&lt;scheme&gt;\w+) (?&lt;signature&gt;\w+)/</code></p>
+<p>The <code>:auth_header_format</code> directive has a companion directive, <code>:auth_header_parse</code> which must be a regular expression. Any given regular expression will be evaluated against the authorization header. The results can be retrieved using the <code>parsed_auth_header</code> method. The regular expression must at least contain a pattern named <code>scheme</code> and pattern named <code>signature</code>. The default value for this directive is a regular expression that is auto-generated by translating the <code>:auth_header_format</code> setting to a regular expression that contains a named capture group for each named part of the format string. Each capture allows for word characters, plus, dash, underscore and dot. The default :auth_header_format <code>%{scheme} %{signature}</code> will be translated to <code>/(?&lt;autschemeh_scheme&gt;[-_+.\w]+) (?&lt;signature&gt;[-_+.\w]+)/</code>.</p>
+
+<p>See the section about multiple authentication secrets for a use-case and a comprehensive example.</p>
<h2>Optional nonce</h2>
@@ -370,9 +372,7 @@ <h3>Header-Based Authentication</h3>
<span class='id identifier rubyid_access_key_id'>access_key_id</span> <span class='op'>=</span> <span class='id identifier rubyid_strategy'>strategy</span><span class='period'>.</span><span class='id identifier rubyid_parsed_auth_header'>parsed_auth_header</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>access_key_id</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span>
<span class='id identifier rubyid_keys'>keys</span><span class='lbracket'>[</span><span class='id identifier rubyid_access_key_id'>access_key_id</span><span class='rbracket'>]</span>
<span class='rbrace'>}</span><span class='comma'>,</span>
- <span class='symbol'>:auth_header_format</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>%{scheme} %{access_key_id} %{signature}</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
- <span class='symbol'>:auth_header_parse</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(?&lt;scheme&gt;\w+) (?&lt;access_key_id&gt;\w+) (?&lt;signature&gt;\w+)</span><span class='regexp_end'>/</span></span>
- <span class='rbrace'>}</span>
+ <span class='symbol'>:auth_header_format</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>%{scheme} %{access_key_id} %{signature}</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
</pre>
@@ -421,7 +421,7 @@ <h2>Faraday Middleware</h2>
<h2>Licence</h2>
-<p>Copyright (c) 2011 Florian Gilcher <a href="&#x6d;&#97;&#105;&#108;&#116;&#111;&#58;&#x66;&#108;&#111;&#114;&#105;&#x61;&#x6e;&#x2e;&#x67;&#105;&#108;&#99;&#104;&#x65;&#114;&#x40;&#x61;&#x73;&#113;&#117;&#101;&#x72;&#97;&#x2e;&#100;&#101;">&#x66;&#x6c;&#x6f;&#114;&#x69;&#97;&#110;&#46;&#x67;&#105;&#x6c;&#99;&#104;&#101;&#114;&#64;&#97;&#x73;&#x71;&#117;&#101;&#x72;&#x61;&#46;&#x64;&#101;</a>, Felix Gilcher <a href="&#x6d;&#x61;&#x69;&#108;&#116;&#x6f;&#x3a;&#x66;&#x65;&#108;&#x69;&#x78;&#46;&#103;&#105;&#x6c;&#x63;&#104;&#101;&#x72;&#64;&#97;&#115;&#x71;&#x75;&#101;&#114;&#97;&#46;&#x64;&#101;">&#102;&#x65;&#108;&#105;&#x78;&#x2e;&#x67;&#105;&#108;&#x63;&#x68;&#x65;&#114;&#64;&#x61;&#x73;&#x71;&#x75;&#x65;&#114;&#x61;&#46;&#x64;&#x65;</a></p>
+<p>Copyright (c) 2011 Florian Gilcher <a href="&#109;&#97;&#x69;&#108;&#x74;&#x6f;&#x3a;&#102;&#x6c;&#x6f;&#114;&#x69;&#x61;&#110;&#46;&#103;&#x69;&#108;&#x63;&#x68;&#x65;&#114;&#64;&#97;&#x73;&#113;&#x75;&#101;&#x72;&#97;&#x2e;&#100;&#101;">&#102;&#108;&#111;&#114;&#x69;&#97;&#x6e;&#46;&#103;&#105;&#x6c;&#x63;&#x68;&#x65;&#114;&#x40;&#x61;&#x73;&#113;&#x75;&#101;&#114;&#97;&#46;&#x64;&#101;</a>, Felix Gilcher <a href="&#x6d;&#97;&#x69;&#x6c;&#116;&#111;&#x3a;&#102;&#101;&#108;&#x69;&#x78;&#x2e;&#x67;&#105;&#108;&#99;&#x68;&#101;&#x72;&#64;&#x61;&#115;&#113;&#117;&#101;&#114;&#97;&#46;&#100;&#101;">&#102;&#101;&#x6c;&#x69;&#120;&#x2e;&#x67;&#x69;&#x6c;&#x63;&#104;&#x65;&#114;&#x40;&#x61;&#x73;&#113;&#117;&#x65;&#x72;&#97;&#46;&#x64;&#101;</a></p>
<p>Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
@@ -444,7 +444,7 @@ <h2>Licence</h2>
</div></div>
<div id="footer">
- Generated on Tue Dec 13 23:47:49 2011 by
+ Generated on Wed Dec 14 16:49:09 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>
@@ -96,7 +96,7 @@ <h2>Defined Under Namespace</h2>
</div>
<div id="footer">
- Generated on Tue Dec 13 23:47:50 2011 by
+ Generated on Wed Dec 14 16:49:11 2011 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.7.4 (ruby-1.9.2).
</div>

0 comments on commit 79e6922

Please sign in to comment.