PageRenderTime 50ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 0ms

/site/api-docs/Sinatra/LazyAuth.html

https://github.com/bbrowning/deltacloud
HTML | 227 lines | 133 code | 94 blank | 0 comment | 0 complexity | fa6d26cb0bf8ea2baf31c3ef0ed38878 MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    4. 

  4.   <head>
    5. 

  5.     <meta name="Content-Type" content="text/html; charset=utf8" />
    6. 

  6. <title>Module: Sinatra::LazyAuth</title>
    7. 

  7. <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
    8. 

  8. <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
    9. 

  9. 

  10. <script type="text/javascript" charset="utf-8">
    11. 

  11.   relpath = '..';
    12. 

  12.   if (relpath != '') relpath += '/';
    13. 

  13. </script>
    14. 

  14. <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
    15. 

  15. <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
    16. 

  16. 

  17.   </head>
    18. 

  18.   <body>
    19. 

  19.     <script type="text/javascript" charset="utf-8">
    20. 

  20.       if (window.top.frames.main) document.body.className = 'frames';
    21. 

  21.     </script>
    22. 

  22.     
    23. 

  23.     <div id="header">
    24. 

  24.       <div id="menu">
    25. 

  25.   
    26. 

  26.     <a href="../_index.html">Index (L)</a> &raquo; 
    27. 

  27.     <span class='title'><span class='object_link'><a href="../Sinatra.html" title="Sinatra (module)">Sinatra</a></span></span>
    28. 

  28.      &raquo; 
    29. 

  29.     <span class="title">LazyAuth</span>
    30. 

  30.   
    31. 

  31.   
    32. 

  32.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
    33. 

  33. </div>
    34. 

  34. 

  35.       <div id="search">
    36. 

  36.   <a id="class_list_link" href="#">Class List</a>
    37. 

  37.   <a id="method_list_link" href="#">Method List</a>
    38. 

  38.   <a id ="file_list_link" href="#">File List</a>
    39. 

  39. </div>
    40. 

  40. 

  41.       <div class="clear"></div>
    42. 

  42.     </div>
    43. 

  43.     
    44. 

  44.     <iframe id="search_frame"></iframe>
    45. 

  45.     
    46. 

  46.     <div id="content"><h1>Module: Sinatra::LazyAuth
    47. 

  47.   
    48. 

  48.   
    49. 

  49.   
    50. 

  50. </h1>
    51. 

  51. 

  52. <dl class="box">
    53. 

  53.   
    54. 

  54.   
    55. 

  55.     
    56. 

  56.   
    57. 

  57.     
    58. 

  58.   
    59. 

  59.   
    60. 

  60.   
    61. 

  61.     <dt class="r1 last">Defined in:</dt>
    62. 

  62.     <dd class="r1 last">lib/sinatra/lazy_auth.rb</dd>
    63. 

  63.   
    64. 

  64. </dl>
    65. 

  65. <div class="clear"></div>
    66. 

  66. 

  67. <h2>Defined Under Namespace</h2>
    68. 

  68. <p class="children">
    69. 

  69.    
    70. 

  70.     
    71. 

  71.    
    72. 

  72.     
    73. 

  73.       <strong class="classes">Classes:</strong> <span class='object_link'><a href="LazyAuth/LazyCredentials.html" title="Sinatra::LazyAuth::LazyCredentials (class)">LazyCredentials</a></span>
    74. 

  74.     
    75. 

  75.   
    76. 

  76. </p>
    77. 

  77. 

  78. 

  79. 

  80.   
    81. 

  81.     <h2>
    82. 

  82.       Instance Method Summary
    83. 

  83.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
    84. 

  84.     </h2>
    85. 

  85. 

  86.     <ul class="summary">
    87. 

  87.       
    88. 

  88.         <li class="public ">
    89. 

  89.   <span class="summary_signature">
    90. 

  90.     
    91. 

  91.       <a href="#authorize%21-instance_method" title="#authorize! (instance method)">- (Object) <strong>authorize!</strong> </a>
    92. 

  92.     
    93. 

  93. 

  94.     
    95. 

  95.   </span>
    96. 

  96.   
    97. 

  97.   
    98. 

  98.   
    99. 

  99.   
    100. 

  100.   
    101. 

  101.   
    102. 

  102. 

  103.   
    104. 

  104.     <span class="summary_desc"><div class='inline'></div></span>
    105. 

  105.   
    106. 

  106. </li>
    107. 

  107. 

  108.       
    109. 

  109.         <li class="public ">
    110. 

  110.   <span class="summary_signature">
    111. 

  111.     
    112. 

  112.       <a href="#credentials-instance_method" title="#credentials (instance method)">- (Object) <strong>credentials</strong> </a>
    113. 

  113.     
    114. 

  114. 

  115.     
    116. 

  116.   </span>
    117. 

  117.   
    118. 

  118.   
    119. 

  119.   
    120. 

  120.   
    121. 

  121.   
    122. 

  122.   
    123. 

  123. 

  124.   
    125. 

  125.     <span class="summary_desc"><div class='inline'><p>
    126. 

  126. Request the current user&#8217;s credentials.
    127. 

  127. </p>
    128. 

  128. </div></span>
    129. 

  129.   
    130. 

  130. </li>
    131. 

  131. 

  132.       
    133. 

  133.     </ul>
    134. 

  134.   
    135. 

  135. 

  136. 

  137. 

  138.   <div id="instance_method_details" class="method_details_list">
    139. 

  139.     <h2>Instance Method Details</h2>
    140. 

  140.     
    141. 

  141.     
    142. 

  142.       <div class="method_details first">
    143. 

  143.   <p class="signature first" id="authorize!-instance_method">
    144. 

  144.   
    145. 

  145.     - (<tt>Object</tt>) <strong>authorize!</strong> 
    146. 

  146.   
    147. 

  147. 

  148.   
    149. 

  149. </p><table class="source_code">
    150. 

  150.   <tr>
    151. 

  151.     <td>
    152. 

  152.       <pre class="lines">
    153. 

  153. 

  154. 

  155. 42
    156. 

  156. 43
    157. 

  157. 44
    158. 

  158. 45
    159. 

  159. 46</pre>
    160. 

  160.     </td>
    161. 

  161.     <td>
    162. 

  162.       <pre class="code"><span class="info file"># File 'lib/sinatra/lazy_auth.rb', line 42</span>
    163. 

  163. 

  164. <span class='def def kw'>def</span> <span class='authorize! fid id'>authorize!</span>
    165. 

  165.   <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='dstring node'>&quot;#{DRIVER}-deltacloud@#{HOSTNAME}&quot;</span>
    166. 

  166.   <span class='response identifier id'>response</span><span class='lbrack token'>[</span><span class='string val'>'WWW-Authenticate'</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='dstring node'>%(Basic realm=&quot;#{r}&quot;)</span>
    167. 

  167.   <span class='throw identifier id'>throw</span><span class='lparen token'>(</span><span class='symbol val'>:halt</span><span class='comma token'>,</span> <span class='lbrack token'>[</span><span class='integer val'>401</span><span class='comma token'>,</span> <span class='string val'>&quot;Not authorized\n&quot;</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
    168. 

  168. <span class='end end kw'>end</span>
    169. 

  169. </pre>
    170. 

  170.     </td>
    171. 

  171.   </tr>
    172. 

  172. </table>
    173. 

  173. </div>
    174. 

  174.     
    175. 

  175.       <div class="method_details ">
    176. 

  176.   <p class="signature " id="credentials-instance_method">
    177. 

  177.   
    178. 

  178.     - (<tt>Object</tt>) <strong>credentials</strong> 
    179. 

  179.   
    180. 

  180. 

  181.   
    182. 

  182. </p><div class="docstring">
    183. 

  183.   <div class="discussion">
    184. 

  184.     <p>
    185. 

  185. Request the current user&#8217;s credentials. Actual credentials are only
    186. 

  186. requested when an attempt is made to get the user name or password
    187. 

  187. </p>
    188. 

  188. 

  189. 

  190.   </div>
    191. 

  191. </div>
    192. 

  192. <div class="tags">
    193. 

  193.   
    194. 

  194. </div><table class="source_code">
    195. 

  195.   <tr>
    196. 

  196.     <td>
    197. 

  197.       <pre class="lines">
    198. 

  198. 

  199. 

  200. 50
    201. 

  201. 51
    202. 

  202. 52</pre>
    203. 

  203.     </td>
    204. 

  204.     <td>
    205. 

  205.       <pre class="code"><span class="info file"># File 'lib/sinatra/lazy_auth.rb', line 50</span>
    206. 

  206. 

  207. <span class='def def kw'>def</span> <span class='credentials identifier id'>credentials</span>
    208. 

  208.   <span class='LazyCredentials constant id'>LazyCredentials</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span>
    209. 

  209. <span class='end end kw'>end</span>
    210. 

  210. </pre>
    211. 

  211.     </td>
    212. 

  212.   </tr>
    213. 

  213. </table>
    214. 

  214. </div>
    215. 

  215.     
    216. 

  216.   </div>
    217. 

  217. 

  218. </div>
    219. 

  219.     
    220. 

  220.     <div id="footer">
    221. 

  221.   Generated on Thu Sep 30 14:44:01 2010 by 
    222. 

  222.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
    223. 

  223.   0.6.1 (ruby-1.8.6).
    224. 

  224. </div>
    225. 

  225. 

  226.   </body>
    227. 

  227. </html>
    228.