You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltacloud.apache.org by mf...@apache.org on 2010/09/30 14:48:04 UTC
svn commit: r1003045 [17/24] - in /incubator/deltacloud/trunk: server/
site/api-docs/ site/api-docs/CloudClient/ site/api-docs/Deltacloud/
site/api-docs/Deltacloud/BaseDriver/ site/api-docs/Deltacloud/Drivers/
site/api-docs/Deltacloud/Drivers/Azure/ si...
Added: incubator/deltacloud/trunk/site/api-docs/RightAws/MockEc2.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/api-docs/RightAws/MockEc2.html?rev=1003045&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/api-docs/RightAws/MockEc2.html (added)
+++ incubator/deltacloud/trunk/site/api-docs/RightAws/MockEc2.html Thu Sep 30 12:48:00 2010
@@ -0,0 +1,740 @@
+<!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 name="Content-Type" content="text/html; charset=utf8" />
+<title>Class: RightAws::MockEc2</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">
+ relpath = '..';
+ if (relpath != '') relpath += '/';
+</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>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="../_index.html">Index (M)</a> »
+ <span class='title'><span class='object_link'><a href="../RightAws.html" title="RightAws (module)">RightAws</a></span></span>
+ »
+ <span class="title">MockEc2</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 id="class_list_link" href="#">Class List</a>
+ <a id="method_list_link" href="#">Method List</a>
+ <a id ="file_list_link" href="#">File List</a>
+</div>
+
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><h1>Class: RightAws::MockEc2
+
+
+
+</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">RightAws::MockEc2</li>
+
+ </ul>
+ <a href="#" class="inheritanceTree">show all</a>
+
+ </dd>
+
+
+
+
+
+
+
+
+
+ <dt class="r2 last">Defined in:</dt>
+ <dd class="r2 last">lib/deltacloud/drivers/ec2/ec2_mock_driver.rb</dd>
+
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+ <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="#describe_availability_zones-instance_method" title="#describe_availability_zones (instance method)">- (Object) <strong>describe_availability_zones</strong>(opts = {}) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#describe_images-instance_method" title="#describe_images (instance method)">- (Object) <strong>describe_images</strong>(opts = {}) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#describe_images_by_owner-instance_method" title="#describe_images_by_owner (instance method)">- (Object) <strong>describe_images_by_owner</strong>(id) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#describe_instances-instance_method" title="#describe_instances (instance method)">- (Object) <strong>describe_instances</strong>(opts = {}) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#describe_snapshots-instance_method" title="#describe_snapshots (instance method)">- (Object) <strong>describe_snapshots</strong>(opts = {}) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#describe_volumes-instance_method" title="#describe_volumes (instance method)">- (Object) <strong>describe_volumes</strong>(opts = {}) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (MockEc2) <strong>initialize</strong>(opts = {}) </a>
+
+
+
+ </span>
+
+ <span class="note title constructor">constructor</span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+A new instance of MockEc2.
+</p>
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#reboot_instances-instance_method" title="#reboot_instances (instance method)">- (Object) <strong>reboot_instances</strong>(id) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#run_instances-instance_method" title="#run_instances (instance method)">- (Object) <strong>run_instances</strong>(image_id, min_count, max_count, group_ids, key_name, user_data = '', addressing_type = nil, instance_type = nil, kernel_id = nil, ramdisk_id = nil, availability_zone = nil, block_device_mappings = nil) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#terminate_instances-instance_method" title="#terminate_instances (instance method)">- (Object) <strong>terminate_instances</strong>(id) </a>
+
+
+
+ (also: #destroy_instance)
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ </ul>
+
+
+<div id="constructor_details" class="method_details_list">
+ <h2>Constructor Details</h2>
+
+ <div class="method_details first">
+ <p class="signature first" id="initialize-instance_method">
+
+ - (<tt><span class='object_link'><a href="" title="RightAws::MockEc2 (class)">MockEc2</a></span></tt>) <strong>initialize</strong>(opts = {})
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+A new instance of MockEc2
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+4
+5</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud/drivers/ec2/ec2_mock_driver.rb', line 4</span>
+
+<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='opts identifier id'>opts</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
+<span class='end end 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">
+ <p class="signature first" id="describe_availability_zones-instance_method">
+
+ - (<tt>Object</tt>) <strong>describe_availability_zones</strong>(opts = {})
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+19
+20
+21</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud/drivers/ec2/ec2_mock_driver.rb', line 19</span>
+
+<span class='def def kw'>def</span> <span class='describe_availability_zones identifier id'>describe_availability_zones</span><span class='lparen token'>(</span><span class='opts identifier id'>opts</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
+ <span class='load_fixtures_for identifier id'>load_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:realms</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="describe_images-instance_method">
+
+ - (<tt>Object</tt>) <strong>describe_images</strong>(opts = {})
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+7
+8
+9</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud/drivers/ec2/ec2_mock_driver.rb', line 7</span>
+
+<span class='def def kw'>def</span> <span class='describe_images identifier id'>describe_images</span><span class='lparen token'>(</span><span class='opts identifier id'>opts</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
+ <span class='load_fixtures_for identifier id'>load_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:images</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="describe_images_by_owner-instance_method">
+
+ - (<tt>Object</tt>) <strong>describe_images_by_owner</strong>(id)
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+11
+12
+13</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud/drivers/ec2/ec2_mock_driver.rb', line 11</span>
+
+<span class='def def kw'>def</span> <span class='describe_images_by_owner identifier id'>describe_images_by_owner</span><span class='lparen token'>(</span><span class='id identifier id'>id</span><span class='rparen token'>)</span>
+ <span class='load_fixtures_for identifier id'>load_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:images</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='i identifier id'>i</span><span class='bitor op'>|</span> <span class='i identifier id'>i</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_owner</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='eql? fid id'>eql?</span><span class='lparen token'>(</span><span class='id identifier id'>id</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="describe_instances-instance_method">
+
+ - (<tt>Object</tt>) <strong>describe_instances</strong>(opts = {})
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+23
+24
+25
+26
+27
+28
+29
+30
+31</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud/drivers/ec2/ec2_mock_driver.rb', line 23</span>
+
+<span class='def def kw'>def</span> <span class='describe_instances identifier id'>describe_instances</span><span class='lparen token'>(</span><span class='opts identifier id'>opts</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
+ <span class='instances identifier id'>instances</span> <span class='assign token'>=</span> <span class='load_fixtures_for identifier id'>load_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:instances</span><span class='rparen token'>)</span>
+ <span class='instances identifier id'>instances</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='instance identifier id'>instance</span><span class='comma token'>,</span> <span class='i identifier id'>i</span><span class='bitor op'>|</span>
+ <span class='instances identifier id'>instances</span><span class='lbrack token'>[</span><span class='i identifier id'>i</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='update_delayed_state identifier id'>update_delayed_state</span><span class='lparen token'>(</span><span class='instance identifier id'>instance</span><span class='rparen token'>)</span>
+ <span class='return return kw'>return</span> <span class='lbrack token'>[</span><span class='instance identifier id'>instance</span><span class='rbrack token'>]</span> <span class='if if_mod kw'>if</span> <span class='opts identifier id'>opts</span> <span class='and and kw'>and</span> <span class='opts identifier id'>opts</span><span class='lbrack token'>[</span><span class='symbol val'>:id</span><span class='rbrack token'>]</span> <span class='and and kw'>and</span> <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_instance_id</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='eql? fid id'>eql?</span><span class='lparen token'>(</span><span class='opts identifier id'>opts</span><span class='lbrack token'>[</span><span class='symbol val'>:id</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
+ <span class='end end kw'>end</span>
+ <span class='update_fixtures_for identifier id'>update_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:instances</span><span class='comma token'>,</span> <span class='instances identifier id'>instances</span><span class='rparen token'>)</span>
+ <span class='instances identifier id'>instances</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="describe_snapshots-instance_method">
+
+ - (<tt>Object</tt>) <strong>describe_snapshots</strong>(opts = {})
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+83
+84
+85</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud/drivers/ec2/ec2_mock_driver.rb', line 83</span>
+
+<span class='def def kw'>def</span> <span class='describe_snapshots identifier id'>describe_snapshots</span><span class='lparen token'>(</span><span class='opts identifier id'>opts</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
+ <span class='load_fixtures_for identifier id'>load_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:storage_snapshot</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="describe_volumes-instance_method">
+
+ - (<tt>Object</tt>) <strong>describe_volumes</strong>(opts = {})
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+87
+88
+89</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud/drivers/ec2/ec2_mock_driver.rb', line 87</span>
+
+<span class='def def kw'>def</span> <span class='describe_volumes identifier id'>describe_volumes</span><span class='lparen token'>(</span><span class='opts identifier id'>opts</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
+ <span class='load_fixtures_for identifier id'>load_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:storage_volume</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="reboot_instances-instance_method">
+
+ - (<tt>Object</tt>) <strong>reboot_instances</strong>(id)
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+77
+78
+79</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud/drivers/ec2/ec2_mock_driver.rb', line 77</span>
+
+<span class='def def kw'>def</span> <span class='reboot_instances identifier id'>reboot_instances</span><span class='lparen token'>(</span><span class='id identifier id'>id</span><span class='rparen token'>)</span>
+ <span class='update_instance_state identifier id'>update_instance_state</span><span class='lparen token'>(</span><span class='id identifier id'>id</span><span class='comma token'>,</span> <span class='string val'>'pending'</span><span class='comma token'>,</span> <span class='string val'>'0'</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="run_instances-instance_method">
+
+ - (<tt>Object</tt>) <strong>run_instances</strong>(image_id, min_count, max_count, group_ids, key_name, user_data = '', addressing_type = nil, instance_type = nil, kernel_id = nil, ramdisk_id = nil, availability_zone = nil, block_device_mappings = nil)
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+
+
+ </div>
+</div>
+<div class="tags">
+ <h3>Raises:</h3>
+<ul class="raise">
+
+ <li>
+
+ <span class='type'>(<tt>Exception</tt>)</span>
+
+
+
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+33
+34
+35
+36
+37
+38
+39
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53
+54
+55
+56
+57
+58
+59
+60
+61
+62
+63
+64
+65
+66
+67
+68
+69
+70</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud/drivers/ec2/ec2_mock_driver.rb', line 33</span>
+
+<span class='def def kw'>def</span> <span class='run_instances identifier id'>run_instances</span><span class='lparen token'>(</span><span class='image_id identifier id'>image_id</span><span class='comma token'>,</span> <span class='min_count identifier id'>min_count</span><span class='comma token'>,</span> <span class='max_count identifier id'>max_count</span><span class='comma token'>,</span> <span class='group_ids identifier id'>group_ids</span><span class='comma token'>,</span> <span class='key_name identifier id'>key_name</span><span class='comma token'>,</span> <span class='user_data identifier id'>user_data</span><span class='assign token'>=</span><span class='string val'>''</span><span class='comma token'>,</span> <span class='addressing_type identifier id'>addressing_type</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='instance_type identifier id'>instance_type</span> <span class='assign t
oken'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='kernel_id identifier id'>kernel_id</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='ramdisk_id identifier id'>ramdisk_id</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='availability_zone identifier id'>availability_zone</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='block_device_mappings identifier id'>block_device_mappings</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='rparen token'>)</span>
+
+ <span class='instances identifier id'>instances</span> <span class='assign token'>=</span> <span class='load_fixtures_for identifier id'>load_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:instances</span><span class='rparen token'>)</span>
+ <span class='image identifier id'>image</span> <span class='assign token'>=</span> <span class='load_fixtures_for identifier id'>load_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:images</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='img identifier id'>img</span><span class='bitor op'>|</span> <span class='img identifier id'>img</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_id</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='eql? fid id'>eql?</span><span class='lparen token'>(</span><span class='image_id identifier id'>image_id</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='first identifier id'>first</span>
+
+ <span class='if if kw'>if</span> <span class='availability_zone identifier id'>availability_zone</span>
+ <span class='realm identifier id'>realm</span> <span class='assign token'>=</span> <span class='load_fixtures_for identifier id'>load_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:realms</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='realm identifier id'>realm</span><span class='bitor op'>|</span> <span class='realm identifier id'>realm</span><span class='lbrack token'>[</span><span class='symbol val'>:zone_name</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='eql? fid id'>eql?</span><span class='lparen token'>(</span><span class='availability_zone identifier id'>availability_zone</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='first identifier id'>first</span>
+ <span class='else else kw'>else</span>
+ <span class='realm identifier id'>realm</span> <span class='assign token'>=</span> <span class='load_fixtures_for identifier id'>load_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:realms</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='first identifier id'>first</span>
+ <span class='end end kw'>end</span>
+
+ <span class='raise identifier id'>raise</span> <span class='Exception constant id'>Exception</span> <span class='unless unless_mod kw'>unless</span> <span class='image identifier id'>image</span>
+ <span class='raise identifier id'>raise</span> <span class='Exception constant id'>Exception</span> <span class='unless unless_mod kw'>unless</span> <span class='realm identifier id'>realm</span>
+
+ <span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span> <span class='rbrace token'>}</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_image_id</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='image identifier id'>image</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_id</span><span class='rbrack token'>]</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_availability_zone</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='realm identifier id'>realm</span><span class='lbrack token'>[</span><span class='symbol val'>:zone_name</span><span class='rbrack token'>]</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_instance_type</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='instance_type identifier id'>instance_type</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_owner</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='user_data identifier id'>user_data</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_state</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='string val'>'pending'</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_reason</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='string val'>''</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:dns_name</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='dstring node'>"#{random_dns}-01-C9.usma2.compute.amazonaws.com"</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:private_dns_name</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='dstring node'>"#{random_dns}-02-P9.usma2.compute.amazonaws.com"</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_state_code</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='string val'>"0"</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_key_name</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='string val'>"staging"</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_kernel_id</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='string val'>"aki-be3adfd7"</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_ramdisk_id</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='string val'>"ari-ce34gad7"</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_groups</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='string val'>"default"</span><span class='rbrack token'>]</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_instance_id</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='random_instance_id identifier id'>random_instance_id</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_reservation_id</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='string val'>"r-aabbccdd"</span>
+ <span class='instance identifier id'>instance</span><span class='lbrack token'>[</span><span class='symbol val'>:aws_launch_time</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='instance_time_format identifier id'>instance_time_format</span>
+
+ <span class='instances identifier id'>instances</span> <span class='lshft op'><<</span> <span class='instance identifier id'>instance</span>
+
+ <span class='update_fixtures_for identifier id'>update_fixtures_for</span><span class='lparen token'>(</span><span class='symbol val'>:instances</span><span class='comma token'>,</span> <span class='instances identifier id'>instances</span><span class='rparen token'>)</span>
+
+ <span class='return return kw'>return</span> <span class='lbrack token'>[</span><span class='instance identifier id'>instance</span><span class='rbrack token'>]</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="terminate_instances-instance_method">
+
+ - (<tt>Object</tt>) <strong>terminate_instances</strong>(id)
+
+
+
+ <span class="aliases">Also known as:
+ <span class="names"><span id='destroy_instance-instance_method'>destroy_instance</span></span>
+ </span>
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+73
+74
+75</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/deltacloud/drivers/ec2/ec2_mock_driver.rb', line 73</span>
+
+<span class='def def kw'>def</span> <span class='terminate_instances identifier id'>terminate_instances</span><span class='lparen token'>(</span><span class='id identifier id'>id</span><span class='rparen token'>)</span>
+ <span class='update_instance_state identifier id'>update_instance_state</span><span class='lparen token'>(</span><span class='id identifier id'>id</span><span class='comma token'>,</span> <span class='string val'>'stopping'</span><span class='comma token'>,</span> <span class='string val'>'80'</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Thu Sep 30 14:43:57 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.6.1 (ruby-1.8.6).
+</div>
+
+ </body>
+</html>
\ No newline at end of file
Added: incubator/deltacloud/trunk/site/api-docs/Sinatra.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/api-docs/Sinatra.html?rev=1003045&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/api-docs/Sinatra.html (added)
+++ incubator/deltacloud/trunk/site/api-docs/Sinatra.html Thu Sep 30 12:48:00 2010
@@ -0,0 +1,110 @@
+<!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 name="Content-Type" content="text/html; charset=utf8" />
+<title>Module: Sinatra</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">
+ relpath = '';
+ if (relpath != '') relpath += '/';
+</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>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="_index.html">Index (S)</a> »
+
+
+ <span class="title">Sinatra</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 id="class_list_link" href="#">Class List</a>
+ <a id="method_list_link" href="#">Method List</a>
+ <a id ="file_list_link" href="#">File List</a>
+</div>
+
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><h1>Module: Sinatra
+
+
+
+</h1>
+
+<dl class="box">
+
+
+
+
+
+
+
+
+ <dt class="r1 last">Defined in:</dt>
+ <dd class="r1 last">lib/sinatra/lazy_auth.rb<span class="defines">,<br />
+ lib/sinatra/rabbit.rb,<br /> lib/sinatra/url_for.rb,<br /> lib/sinatra/respond_to.rb,<br /> lib/sinatra/static_assets.rb,<br /> lib/sinatra/respond_to_old.rb</span>
+</dd>
+
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+ <div class="discussion">
+ <p>
+Accept header parsing was looked at but deemed too much of an irregularity
+to deal with. Problems with the header differences from IE, Firefox,
+Safari, and every other UA causes problems with the expected output. The
+general expected behavior would be serve html when no extension provided,
+but most UAs say they will accept application/xml with out a quality
+indicator, meaning you’d get the xml block served insead. Just plain
+retarded, use the extension and you’ll never be suprised.
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Sinatra/LazyAuth.html" title="Sinatra::LazyAuth (module)">LazyAuth</a></span>, <span class='object_link'><a href="Sinatra/Rabbit.html" title="Sinatra::Rabbit (module)">Rabbit</a></span>, <span class='object_link'><a href="Sinatra/RabbitHelper.html" title="Sinatra::RabbitHelper (module)">RabbitHelper</a></span>, <span class='object_link'><a href="Sinatra/RespondTo.html" title="Sinatra::RespondTo (module)">RespondTo</a></span>, <span class='object_link'><a href="Sinatra/StaticAssets.html" title="Sinatra::StaticAssets (module)">StaticAssets</a></span>, <span class='object_link'><a href="Sinatra/UrlForHelper.html" title="Sinatra::UrlForHelper (module)">UrlForHelper</a></span>
+
+
+
+
+</p>
+
+
+
+
+
+</div>
+
+ <div id="footer">
+ Generated on Thu Sep 30 14:43:58 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.6.1 (ruby-1.8.6).
+</div>
+
+ </body>
+</html>
\ No newline at end of file
Added: incubator/deltacloud/trunk/site/api-docs/Sinatra/LazyAuth.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/api-docs/Sinatra/LazyAuth.html?rev=1003045&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/api-docs/Sinatra/LazyAuth.html (added)
+++ incubator/deltacloud/trunk/site/api-docs/Sinatra/LazyAuth.html Thu Sep 30 12:48:00 2010
@@ -0,0 +1,227 @@
+<!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 name="Content-Type" content="text/html; charset=utf8" />
+<title>Module: Sinatra::LazyAuth</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">
+ relpath = '..';
+ if (relpath != '') relpath += '/';
+</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>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="../_index.html">Index (L)</a> »
+ <span class='title'><span class='object_link'><a href="../Sinatra.html" title="Sinatra (module)">Sinatra</a></span></span>
+ »
+ <span class="title">LazyAuth</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 id="class_list_link" href="#">Class List</a>
+ <a id="method_list_link" href="#">Method List</a>
+ <a id ="file_list_link" href="#">File List</a>
+</div>
+
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><h1>Module: Sinatra::LazyAuth
+
+
+
+</h1>
+
+<dl class="box">
+
+
+
+
+
+
+
+
+ <dt class="r1 last">Defined in:</dt>
+ <dd class="r1 last">lib/sinatra/lazy_auth.rb</dd>
+
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+
+
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="LazyAuth/LazyCredentials.html" title="Sinatra::LazyAuth::LazyCredentials (class)">LazyCredentials</a></span>
+
+
+</p>
+
+
+
+
+ <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%21-instance_method" title="#authorize! (instance method)">- (Object) <strong>authorize!</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#credentials-instance_method" title="#credentials (instance method)">- (Object) <strong>credentials</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Request the current user’s credentials.
+</p>
+</div></span>
+
+</li>
+
+
+ </ul>
+
+
+
+
+ <div id="instance_method_details" class="method_details_list">
+ <h2>Instance Method Details</h2>
+
+
+ <div class="method_details first">
+ <p class="signature first" id="authorize!-instance_method">
+
+ - (<tt>Object</tt>) <strong>authorize!</strong>
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+42
+43
+44
+45
+46</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/lazy_auth.rb', line 42</span>
+
+<span class='def def kw'>def</span> <span class='authorize! fid id'>authorize!</span>
+ <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='dstring node'>"#{DRIVER}-deltacloud@#{HOSTNAME}"</span>
+ <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="#{r}")</span>
+ <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'>"Not authorized\n"</span><span class='rbrack token'>]</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="credentials-instance_method">
+
+ - (<tt>Object</tt>) <strong>credentials</strong>
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Request the current user’s credentials. Actual credentials are only
+requested when an attempt is made to get the user name or password
+</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/sinatra/lazy_auth.rb', line 50</span>
+
+<span class='def def kw'>def</span> <span class='credentials identifier id'>credentials</span>
+ <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>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Thu Sep 30 14:44:01 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.6.1 (ruby-1.8.6).
+</div>
+
+ </body>
+</html>
\ No newline at end of file
Added: incubator/deltacloud/trunk/site/api-docs/Sinatra/LazyAuth/LazyCredentials.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/api-docs/Sinatra/LazyAuth/LazyCredentials.html?rev=1003045&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/api-docs/Sinatra/LazyAuth/LazyCredentials.html (added)
+++ incubator/deltacloud/trunk/site/api-docs/Sinatra/LazyAuth/LazyCredentials.html Thu Sep 30 12:48:00 2010
@@ -0,0 +1,360 @@
+<!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 name="Content-Type" content="text/html; charset=utf8" />
+<title>Class: Sinatra::LazyAuth::LazyCredentials</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">
+ relpath = '../..';
+ if (relpath != '') relpath += '/';
+</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>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="../../_index.html">Index (L)</a> »
+ <span class='title'><span class='object_link'><a href="../../Sinatra.html" title="Sinatra (module)">Sinatra</a></span></span> » <span class='title'><span class='object_link'><a href="../LazyAuth.html" title="Sinatra::LazyAuth (module)">LazyAuth</a></span></span>
+ »
+ <span class="title">LazyCredentials</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 id="class_list_link" href="#">Class List</a>
+ <a id="method_list_link" href="#">Method List</a>
+ <a id ="file_list_link" href="#">File List</a>
+</div>
+
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><h1>Class: Sinatra::LazyAuth::LazyCredentials
+
+
+
+</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">Sinatra::LazyAuth::LazyCredentials</li>
+
+ </ul>
+ <a href="#" class="inheritanceTree">show all</a>
+
+ </dd>
+
+
+
+
+
+
+
+
+
+ <dt class="r2 last">Defined in:</dt>
+ <dd class="r2 last">lib/sinatra/lazy_auth.rb</dd>
+
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+ <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="#initialize-instance_method" title="#initialize (instance method)">- (LazyCredentials) <strong>initialize</strong>(app) </a>
+
+
+
+ </span>
+
+ <span class="note title constructor">constructor</span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+A new instance of LazyCredentials.
+</p>
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#password-instance_method" title="#password (instance method)">- (Object) <strong>password</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#provided%3F-instance_method" title="#provided? (instance method)">- (Boolean) <strong>provided?</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#user-instance_method" title="#user (instance method)">- (Object) <strong>user</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ </ul>
+
+
+<div id="constructor_details" class="method_details_list">
+ <h2>Constructor Details</h2>
+
+ <div class="method_details first">
+ <p class="signature first" id="initialize-instance_method">
+
+ - (<tt><span class='object_link'><a href="" title="Sinatra::LazyAuth::LazyCredentials (class)">LazyCredentials</a></span></tt>) <strong>initialize</strong>(app)
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+A new instance of LazyCredentials
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+8
+9
+10
+11</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/lazy_auth.rb', line 8</span>
+
+<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='app identifier id'>app</span><span class='rparen token'>)</span>
+ <span class='@app ivar id'>@app</span> <span class='assign token'>=</span> <span class='app identifier id'>app</span>
+ <span class='@provided ivar id'>@provided</span> <span class='assign token'>=</span> <span class='false false kw'>false</span>
+<span class='end end 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">
+ <p class="signature first" id="password-instance_method">
+
+ - (<tt>Object</tt>) <strong>password</strong>
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+18
+19
+20
+21</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/lazy_auth.rb', line 18</span>
+
+<span class='def def kw'>def</span> <span class='password identifier id'>password</span>
+ <span class='credentials! fid id'>credentials!</span>
+ <span class='@password ivar id'>@password</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="provided?-instance_method">
+
+ - (<tt>Boolean</tt>) <strong>provided?</strong>
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+
+
+ </div>
+</div>
+<div class="tags">
+ <h3>Returns:</h3>
+<ul class="return">
+
+ <li>
+
+ <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+23
+24
+25</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/lazy_auth.rb', line 23</span>
+
+<span class='def def kw'>def</span> <span class='provided? fid id'>provided?</span>
+ <span class='@provided ivar id'>@provided</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="user-instance_method">
+
+ - (<tt>Object</tt>) <strong>user</strong>
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+13
+14
+15
+16</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/lazy_auth.rb', line 13</span>
+
+<span class='def def kw'>def</span> <span class='user identifier id'>user</span>
+ <span class='credentials! fid id'>credentials!</span>
+ <span class='@user ivar id'>@user</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Thu Sep 30 14:43:52 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.6.1 (ruby-1.8.6).
+</div>
+
+ </body>
+</html>
\ No newline at end of file
Added: incubator/deltacloud/trunk/site/api-docs/Sinatra/Rabbit.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/api-docs/Sinatra/Rabbit.html?rev=1003045&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/api-docs/Sinatra/Rabbit.html (added)
+++ incubator/deltacloud/trunk/site/api-docs/Sinatra/Rabbit.html Thu Sep 30 12:48:00 2010
@@ -0,0 +1,248 @@
+<!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 name="Content-Type" content="text/html; charset=utf8" />
+<title>Module: Sinatra::Rabbit</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">
+ relpath = '..';
+ if (relpath != '') relpath += '/';
+</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>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="../_index.html">Index (R)</a> »
+ <span class='title'><span class='object_link'><a href="../Sinatra.html" title="Sinatra (module)">Sinatra</a></span></span>
+ »
+ <span class="title">Rabbit</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 id="class_list_link" href="#">Class List</a>
+ <a id="method_list_link" href="#">Method List</a>
+ <a id ="file_list_link" href="#">File List</a>
+</div>
+
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><h1>Module: Sinatra::Rabbit
+
+
+
+</h1>
+
+<dl class="box">
+
+
+
+
+
+
+
+
+ <dt class="r1 last">Defined in:</dt>
+ <dd class="r1 last">lib/sinatra/rabbit.rb</dd>
+
+</dl>
+<div class="clear"></div>
+
+<h2>Defined Under Namespace</h2>
+<p class="children">
+
+
+
+
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Rabbit/Collection.html" title="Sinatra::Rabbit::Collection (class)">Collection</a></span>, <span class='object_link'><a href="Rabbit/DuplicateCollectionException.html" title="Sinatra::Rabbit::DuplicateCollectionException (class)">DuplicateCollectionException</a></span>, <span class='object_link'><a href="Rabbit/DuplicateOperationException.html" title="Sinatra::Rabbit::DuplicateOperationException (class)">DuplicateOperationException</a></span>, <span class='object_link'><a href="Rabbit/DuplicateParamException.html" title="Sinatra::Rabbit::DuplicateParamException (class)">DuplicateParamException</a></span>, <span class='object_link'><a href="Rabbit/Operation.html" title="Sinatra::Rabbit::Operation (class)">Operation</a></span>
+
+
+</p>
+
+
+
+
+ <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="#collection-instance_method" title="#collection (instance method)">- (Object) <strong>collection</strong>(name, &block) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Create a new collection.
+</p>
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#collections-instance_method" title="#collections (instance method)">- (Object) <strong>collections</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ </ul>
+
+
+
+
+ <div id="instance_method_details" class="method_details_list">
+ <h2>Instance Method Details</h2>
+
+
+ <div class="method_details first">
+ <p class="signature first" id="collection-instance_method">
+
+ - (<tt>Object</tt>) <strong>collection</strong>(name, &block)
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Create a new collection. NAME should be the pluralized name of the
+collection.
+</p>
+<p>
+Adds a helper method #{name}_url which returns the URL to the :index
+operation on this collection.
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+ <h3>Raises:</h3>
+<ul class="raise">
+
+ <li>
+
+ <span class='type'>(<tt><span class='object_link'><a href="Rabbit/DuplicateCollectionException.html" title="Sinatra::Rabbit::DuplicateCollectionException (class)">DuplicateCollectionException</a></span></tt>)</span>
+
+
+
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+204
+205
+206
+207
+208
+209
+210</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/rabbit.rb', line 204</span>
+
+<span class='def def kw'>def</span> <span class='collection identifier id'>collection</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
+ <span class='raise identifier id'>raise</span> <span class='DuplicateCollectionException constant id'>DuplicateCollectionException</span> <span class='if if_mod kw'>if</span> <span class='collections identifier id'>collections</span><span class='lbrack token'>[</span><span class='name identifier id'>name</span><span class='rbrack token'>]</span>
+ <span class='return return kw'>return</span> <span class='unless unless_mod kw'>unless</span> <span class='driver identifier id'>driver</span><span class='dot token'>.</span><span class='has_collection? fid id'>has_collection?</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span><span class='rparen token'>)</span>
+ <span class='collections identifier id'>collections</span><span class='lbrack token'>[</span><span class='name identifier id'>name</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='Collection constant id'>Collection</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
+ <span class='collections identifier id'>collections</span><span class='lbrack token'>[</span><span class='name identifier id'>name</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='add_feature_params identifier id'>add_feature_params</span><span class='lparen token'>(</span><span class='driver identifier id'>driver</span><span class='dot token'>.</span><span class='features identifier id'>features</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
+ <span class='collections identifier id'>collections</span><span class='lbrack token'>[</span><span class='name identifier id'>name</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='generate identifier id'>generate</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="collections-instance_method">
+
+ - (<tt>Object</tt>) <strong>collections</strong>
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+195
+196
+197</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/rabbit.rb', line 195</span>
+
+<span class='def def kw'>def</span> <span class='collections identifier id'>collections</span>
+ <span class='@collections ivar id'>@collections</span> <span class='opasgn op'>||=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Thu Sep 30 14:43:59 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.6.1 (ruby-1.8.6).
+</div>
+
+ </body>
+</html>
\ No newline at end of file
Added: incubator/deltacloud/trunk/site/api-docs/Sinatra/Rabbit/Collection.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/site/api-docs/Sinatra/Rabbit/Collection.html?rev=1003045&view=auto
==============================================================================
--- incubator/deltacloud/trunk/site/api-docs/Sinatra/Rabbit/Collection.html (added)
+++ incubator/deltacloud/trunk/site/api-docs/Sinatra/Rabbit/Collection.html Thu Sep 30 12:48:00 2010
@@ -0,0 +1,716 @@
+<!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 name="Content-Type" content="text/html; charset=utf8" />
+<title>Class: Sinatra::Rabbit::Collection</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">
+ relpath = '../..';
+ if (relpath != '') relpath += '/';
+</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>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="../../_index.html">Index (C)</a> »
+ <span class='title'><span class='object_link'><a href="../../Sinatra.html" title="Sinatra (module)">Sinatra</a></span></span> » <span class='title'><span class='object_link'><a href="../Rabbit.html" title="Sinatra::Rabbit (module)">Rabbit</a></span></span>
+ »
+ <span class="title">Collection</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 id="class_list_link" href="#">Class List</a>
+ <a id="method_list_link" href="#">Method List</a>
+ <a id ="file_list_link" href="#">File List</a>
+</div>
+
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><h1>Class: Sinatra::Rabbit::Collection
+
+
+
+</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">Sinatra::Rabbit::Collection</li>
+
+ </ul>
+ <a href="#" class="inheritanceTree">show all</a>
+
+ </dd>
+
+
+
+
+
+
+
+
+
+ <dt class="r2 last">Defined in:</dt>
+ <dd class="r2 last">lib/sinatra/rabbit.rb</dd>
+
+</dl>
+<div class="clear"></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="#name-instance_method" title="#name (instance method)">- (Object) <strong>name</strong> </a>
+
+
+
+ </span>
+
+
+ <span class="note title readonly">readonly</span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Returns the value of attribute name.
+</p>
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#operations-instance_method" title="#operations (instance method)">- (Object) <strong>operations</strong> </a>
+
+
+
+ </span>
+
+
+ <span class="note title readonly">readonly</span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Returns the value of attribute operations.
+</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="#add_feature_params-instance_method" title="#add_feature_params (instance method)">- (Object) <strong>add_feature_params</strong>(features) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#description-instance_method" title="#description (instance method)">- (Object) <strong>description</strong>(text = '') </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Set/Return description for collection If first parameter is not present,
+full description will be returned.
+</p>
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#generate-instance_method" title="#generate (instance method)">- (Object) <strong>generate</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#generate_documentation-instance_method" title="#generate_documentation (instance method)">- (Object) <strong>generate_documentation</strong> </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'></div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Collection) <strong>initialize</strong>(name, &block) </a>
+
+
+
+ </span>
+
+ <span class="note title constructor">constructor</span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+A new instance of Collection.
+</p>
+</div></span>
+
+</li>
+
+
+ <li class="public ">
+ <span class="summary_signature">
+
+ <a href="#operation-instance_method" title="#operation (instance method)">- (Object) <strong>operation</strong>(name, opts = {}, &block) </a>
+
+
+
+ </span>
+
+
+
+
+
+
+
+
+ <span class="summary_desc"><div class='inline'><p>
+Add a new operation for this collection.
+</p>
+</div></span>
+
+</li>
+
+
+ </ul>
+
+
+<div id="constructor_details" class="method_details_list">
+ <h2>Constructor Details</h2>
+
+ <div class="method_details first">
+ <p class="signature first" id="initialize-instance_method">
+
+ - (<tt><span class='object_link'><a href="" title="Sinatra::Rabbit::Collection (class)">Collection</a></span></tt>) <strong>initialize</strong>(name, &block)
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+A new instance of Collection
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+116
+117
+118
+119
+120
+121
+122</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/rabbit.rb', line 116</span>
+
+<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
+ <span class='@name ivar id'>@name</span> <span class='assign token'>=</span> <span class='name identifier id'>name</span>
+ <span class='@description ivar id'>@description</span> <span class='assign token'>=</span> <span class='string val'>""</span>
+ <span class='@operations ivar id'>@operations</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span>
+ <span class='instance_eval identifier id'>instance_eval</span><span class='lparen token'>(</span><span class='bitand op'>&</span><span class='block identifier id'>block</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
+ <span class='generate_documentation identifier id'>generate_documentation</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+</div>
+
+ <div id="instance_attr_details" class="attr_details">
+ <h2>Instance Attribute Details</h2>
+
+
+ <span id=""></span>
+ <span id="name-instance_method"></span>
+ <div class="method_details first">
+ <p class="signature first" id="name-instance_method">
+
+ - (<tt>Object</tt>) <strong>name</strong> <span class="extras">(readonly)</span>
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Returns the value of attribute name
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+114
+115
+116</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/rabbit.rb', line 114</span>
+
+<span class='def def kw'>def</span> <span class='name identifier id'>name</span>
+ <span class='@name ivar id'>@name</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+
+ <span id=""></span>
+ <span id="operations-instance_method"></span>
+ <div class="method_details ">
+ <p class="signature " id="operations-instance_method">
+
+ - (<tt>Object</tt>) <strong>operations</strong> <span class="extras">(readonly)</span>
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Returns the value of attribute operations
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+114
+115
+116</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/rabbit.rb', line 114</span>
+
+<span class='def def kw'>def</span> <span class='operations identifier id'>operations</span>
+ <span class='@operations ivar id'>@operations</span>
+<span class='end end 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">
+ <p class="signature first" id="add_feature_params-instance_method">
+
+ - (<tt>Object</tt>) <strong>add_feature_params</strong>(features)
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+178
+179
+180
+181
+182
+183
+184
+185
+186
+187
+188
+189
+190
+191
+192</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/rabbit.rb', line 178</span>
+
+<span class='def def kw'>def</span> <span class='add_feature_params identifier id'>add_feature_params</span><span class='lparen token'>(</span><span class='features identifier id'>features</span><span class='rparen token'>)</span>
+ <span class='features identifier id'>features</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='f identifier id'>f</span><span class='bitor op'>|</span>
+ <span class='f identifier id'>f</span><span class='dot token'>.</span><span class='operations identifier id'>operations</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='fop identifier id'>fop</span><span class='bitor op'>|</span>
+ <span class='if if kw'>if</span> <span class='cop identifier id'>cop</span> <span class='assign token'>=</span> <span class='operations identifier id'>operations</span><span class='lbrack token'>[</span><span class='fop identifier id'>fop</span><span class='dot token'>.</span><span class='name identifier id'>name</span><span class='rbrack token'>]</span>
+ <span class='fop identifier id'>fop</span><span class='dot token'>.</span><span class='params identifier id'>params</span><span class='dot token'>.</span><span class='each_key identifier id'>each_key</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='bitor op'>|</span>
+ <span class='if if kw'>if</span> <span class='cop identifier id'>cop</span><span class='dot token'>.</span><span class='params identifier id'>params</span><span class='dot token'>.</span><span class='has_key? fid id'>has_key?</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='rparen token'>)</span>
+ <span class='raise identifier id'>raise</span> <span class='DuplicateParamException constant id'>DuplicateParamException</span><span class='comma token'>,</span> <span class='dstring node'>"Parameter '#{k}' for operation #{fop.name} defined by collection #{@name} and by feature #{f.name}"</span>
+ <span class='else else kw'>else</span>
+ <span class='cop identifier id'>cop</span><span class='dot token'>.</span><span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='k identifier id'>k</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='fop identifier id'>fop</span><span class='dot token'>.</span><span class='params identifier id'>params</span><span class='lbrack token'>[</span><span class='k identifier id'>k</span><span class='rbrack token'>]</span>
+ <span class='end end kw'>end</span>
+ <span class='end end kw'>end</span>
+ <span class='end end kw'>end</span>
+ <span class='end end kw'>end</span>
+ <span class='end end kw'>end</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="description-instance_method">
+
+ - (<tt>Object</tt>) <strong>description</strong>(text = '')
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Set/Return description for collection If first parameter is not present,
+full description will be returned.
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+127
+128
+129
+130</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/rabbit.rb', line 127</span>
+
+<span class='def def kw'>def</span> <span class='description identifier id'>description</span><span class='lparen token'>(</span><span class='text identifier id'>text</span><span class='assign token'>=</span><span class='string val'>''</span><span class='rparen token'>)</span>
+ <span class='return return kw'>return</span> <span class='@description ivar id'>@description</span> <span class='if if_mod kw'>if</span> <span class='text identifier id'>text</span><span class='dot token'>.</span><span class='blank? fid id'>blank?</span>
+ <span class='@description ivar id'>@description</span> <span class='assign token'>=</span> <span class='text identifier id'>text</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="generate-instance_method">
+
+ - (<tt>Object</tt>) <strong>generate</strong>
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+173
+174
+175
+176</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/rabbit.rb', line 163</span>
+
+<span class='def def kw'>def</span> <span class='generate identifier id'>generate</span>
+ <span class='operations identifier id'>operations</span><span class='dot token'>.</span><span class='values identifier id'>values</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='op identifier id'>op</span><span class='bitor op'>|</span> <span class='op identifier id'>op</span><span class='dot token'>.</span><span class='generate identifier id'>generate</span> <span class='rbrace token'>}</span>
+ <span class='app identifier id'>app</span> <span class='assign token'>=</span> <span class='colon3 op'>::</span><span class='Sinatra constant id'>Sinatra</span><span class='colon2 op'>::</span><span class='Application constant id'>Application</span>
+ <span class='collname identifier id'>collname</span> <span class='assign token'>=</span> <span class='name identifier id'>name</span> <span class='comment val'># Work around Ruby's weird scoping/capture</span>
+ <span class='app identifier id'>app</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='symbol val'>:define_method</span><span class='comma token'>,</span> <span class='dstring node'>"#{name.to_s.singularize}_url"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='id identifier id'>id</span><span class='bitor op'>|</span>
+ <span class='url_for identifier id'>url_for</span> <span class='dstring node'>"/api/#{collname}/#{id}"</span><span class='comma token'>,</span> <span class='symbol val'>:full</span>
+ <span class='end end kw'>end</span>
+
+ <span class='if if kw'>if</span> <span class='index_op identifier id'>index_op</span> <span class='assign token'>=</span> <span class='operations identifier id'>operations</span><span class='lbrack token'>[</span><span class='symbol val'>:index</span><span class='rbrack token'>]</span>
+ <span class='app identifier id'>app</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='symbol val'>:define_method</span><span class='comma token'>,</span> <span class='dstring node'>"#{name}_url"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span>
+ <span class='url_for identifier id'>url_for</span> <span class='index_op identifier id'>index_op</span><span class='dot token'>.</span><span class='path identifier id'>path</span><span class='dot token'>.</span><span class='gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='regexp val'>/\/\?$/</span><span class='comma token'>,</span><span class='string val'>''</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='symbol val'>:full</span>
+ <span class='end end kw'>end</span>
+ <span class='end end kw'>end</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="generate_documentation-instance_method">
+
+ - (<tt>Object</tt>) <strong>generate_documentation</strong>
+
+
+
+</p><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+132
+133
+134
+135
+136
+137
+138
+139
+140
+141</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/rabbit.rb', line 132</span>
+
+<span class='def def kw'>def</span> <span class='generate_documentation identifier id'>generate_documentation</span>
+ <span class='coll identifier id'>coll</span><span class='comma token'>,</span> <span class='oper identifier id'>oper</span><span class='comma token'>,</span> <span class='features identifier id'>features</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='comma token'>,</span> <span class='@operations ivar id'>@operations</span><span class='comma token'>,</span> <span class='driver identifier id'>driver</span><span class='dot token'>.</span><span class='features identifier id'>features</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='rparen token'>)</span>
+ <span class='colon3 op'>::</span><span class='Sinatra constant id'>Sinatra</span><span class='colon2 op'>::</span><span class='Application constant id'>Application</span><span class='dot token'>.</span><span class='get identifier id'>get</span><span class='lparen token'>(</span><span class='dstring node'>"/api/docs/#{@name}"</span><span class='rparen token'>)</span> <span class='do do kw'>do</span>
+ <span class='@collection ivar id'>@collection</span><span class='comma token'>,</span> <span class='@operations ivar id'>@operations</span><span class='comma token'>,</span> <span class='@features ivar id'>@features</span> <span class='assign token'>=</span> <span class='coll identifier id'>coll</span><span class='comma token'>,</span> <span class='oper identifier id'>oper</span><span class='comma token'>,</span> <span class='features identifier id'>features</span>
+ <span class='respond_to identifier id'>respond_to</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='format identifier id'>format</span><span class='bitor op'>|</span>
+ <span class='format identifier id'>format</span><span class='dot token'>.</span><span class='html identifier id'>html</span> <span class='lbrace token'>{</span> <span class='haml identifier id'>haml</span> <span class='symbol val'>:'docs/collection'</span> <span class='rbrace token'>}</span>
+ <span class='format identifier id'>format</span><span class='dot token'>.</span><span class='xml identifier id'>xml</span> <span class='lbrace token'>{</span> <span class='haml identifier id'>haml</span> <span class='symbol val'>:'docs/collection'</span> <span class='rbrace token'>}</span>
+ <span class='end end kw'>end</span>
+ <span class='end end kw'>end</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ <div class="method_details ">
+ <p class="signature " id="operation-instance_method">
+
+ - (<tt>Object</tt>) <strong>operation</strong>(name, opts = {}, &block)
+
+
+
+</p><div class="docstring">
+ <div class="discussion">
+ <p>
+Add a new operation for this collection. For the standard REST operations
+:index, :show, :update, and :destroy, we already know what method to use
+and whether this is an operation on the URL for individual elements or for
+the whole collection.
+</p>
+<p>
+For non-standard operations, options must be passed:
+</p>
+<pre class="code">
+ <span class='symbol val'>:method</span> <span class='colon op'>:</span> <span class='one identifier id'>one</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='HTTP constant id'>HTTP</span> <span class='methods identifier id'>methods</span>
+ <span class='symbol val'>:member</span> <span class='colon op'>:</span> <span class='whether identifier id'>whether</span> <span class='this identifier id'>this</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='operation identifier id'>operation</span> <span class='on identifier id'>on</span> <span class='the identifier id'>the</span> <span class='collection identifier id'>collection</span> <span class='or or kw'>or</span> <span class='an identifier id'>an</span>
+ <span class='individual identifier id'>individual</span> <span class='element identifier id'>element</span> <span class='lparen token'>(</span><span class='FIXME constant id'>FIXME</span><span class='colon op'>:</span> <span class='custom identifier id'>custom</span> <span class='operations identifier id'>operations</span> <span class='on identifier id'>on</span> <span class='the identifier id'>the</span>
+ <span class='collection identifier id'>collection</span> <span class='will identifier id'>will</span> <span class='use identifier id'>use</span> <span class='a identifier id'>a</span> <span class='nonsensical identifier id'>nonsensical</span> <span class='URL constant id'>URL</span><span class='rparen token'>)</span> <span class='The constant id'>The</span> <span class='URL constant id'>URL</span> <span class='for for kw'>for</span> <span class='the identifier id'>the</span>
+ <span class='operation identifier id'>operation</span> <span class='is identifier id'>is</span> <span class='the identifier id'>the</span> <span class='element identifier id'>element</span> <span class='URL constant id'>URL</span> <span class='with identifier id'>with</span> <span class='the identifier id'>the</span> <span class='name identifier id'>name</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='operation identifier id'>operation</span>
+ <span class='appended identifier id'>appended</span>
+</pre>
+<p>
+This also defines a helper method like show_instance_url that returns the
+URL to this operation (in request context)
+</p>
+
+
+ </div>
+</div>
+<div class="tags">
+ <h3>Raises:</h3>
+<ul class="raise">
+
+ <li>
+
+ <span class='type'>(<tt><span class='object_link'><a href="DuplicateOperationException.html" title="Sinatra::Rabbit::DuplicateOperationException (class)">DuplicateOperationException</a></span></tt>)</span>
+
+
+
+
+ </li>
+
+</ul>
+
+</div><table class="source_code">
+ <tr>
+ <td>
+ <pre class="lines">
+
+
+158
+159
+160
+161</pre>
+ </td>
+ <td>
+ <pre class="code"><span class="info file"># File 'lib/sinatra/rabbit.rb', line 158</span>
+
+<span class='def def kw'>def</span> <span class='operation identifier id'>operation</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='opts identifier id'>opts</span> <span class='assign token'>=</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
+ <span class='raise identifier id'>raise</span> <span class='DuplicateOperationException constant id'>DuplicateOperationException</span> <span class='if if_mod kw'>if</span> <span class='@operations ivar id'>@operations</span><span class='lbrack token'>[</span><span class='name identifier id'>name</span><span class='rbrack token'>]</span>
+ <span class='@operations ivar id'>@operations</span><span class='lbrack token'>[</span><span class='name identifier id'>name</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='Operation constant id'>Operation</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='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='opts identifier id'>opts</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
+<span class='end end kw'>end</span>
+</pre>
+ </td>
+ </tr>
+</table>
+</div>
+
+ </div>
+
+</div>
+
+ <div id="footer">
+ Generated on Thu Sep 30 14:43:59 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+ 0.6.1 (ruby-1.8.6).
+</div>
+
+ </body>
+</html>
\ No newline at end of file