automate_soup 0.1.3 → 0.2.0

data/docs/AutomateSoup/API.html

@@ -1164,7 +1164,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:49:18 2017 by
+  Generated on Tue Dec 19 09:58:14 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/AutomateSoup/Change.html

@@ -152,7 +152,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#approve-instance_method" title="#approve (instance method)">#<strong>approve</strong>  &#x21d2; Object </a>
+      <a href="#approve-instance_method" title="#approve (instance method)">#<strong>approve</strong>  &#x21d2; Boolean </a>
     
 
     
@@ -200,7 +200,7 @@
         <li class="public ">
   <span class="summary_signature">
     
-      <a href="#deliver-instance_method" title="#deliver (instance method)">#<strong>deliver</strong>  &#x21d2; Object </a>
+      <a href="#deliver-instance_method" title="#deliver (instance method)">#<strong>deliver</strong>  &#x21d2; Boolean </a>
     
 
     
@@ -520,7 +520,7 @@
       <div class="method_details ">
   <h3 class="signature " id="approve-instance_method">
   
-    #<strong>approve</strong>  &#x21d2; <tt>Object</tt> 
+    #<strong>approve</strong>  &#x21d2; <tt>Boolean</tt> 
   
 
   
@@ -529,13 +529,31 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Approve this change.</p>
+<p>Approve this change. Raise exceptions where applicable.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>true if the change was approved, false otherwise.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -543,8 +561,6 @@
       <pre class="lines">
 
 
-74
-75
 76
 77
 78
@@ -555,15 +571,17 @@
 83
 84
 85
-86</pre>
+86
+87
+88</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/automate_soup/change.rb', line 74</span>
+      <pre class="code"><span class="info file"># File 'lib/automate_soup/change.rb', line 76</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_approve'>approve</span>
-  <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_stage'>stage</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>verify</span><span class='tstring_end'>&#39;</span></span>
+  <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_stage'>stage</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>verify</span><span class='tstring_end'>&#39;</span></span>
   <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Must run AutomateSoup.setup first</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="../AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_url'><span class='object_link'><a href="../AutomateSoup.html#url-class_method" title="AutomateSoup.url (method)">url</a></span></span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='const'><span class='object_link'><a href="../AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_credentials'><span class='object_link'><a href="../AutomateSoup.html#credentials-class_method" title="AutomateSoup.credentials (method)">credentials</a></span></span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
-  <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Approve link not available</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_links'>links</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_links'>links</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>approve</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_links'>links</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>approve</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>href</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Approve link not available, </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_links'>links</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_links'>links</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_links'>links</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>approve</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_links'>links</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>approve</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>href</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
   <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_url'><span class='object_link'><a href="../AutomateSoup.html#url-class_method" title="AutomateSoup.url (method)">url</a></span></span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_links'>links</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>approve</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>href</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
   <span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rest.html" title="AutomateSoup::Rest (module)">Rest</a></span></span><span class='period'>.</span><span class='id identifier rubyid_post'><span class='object_link'><a href="Rest.html#post-class_method" title="AutomateSoup::Rest.post (method)">post</a></span></span><span class='lparen'>(</span>
     <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
@@ -640,7 +658,7 @@
       <div class="method_details ">
   <h3 class="signature " id="deliver-instance_method">
   
-    #<strong>deliver</strong>  &#x21d2; <tt>Object</tt> 
+    #<strong>deliver</strong>  &#x21d2; <tt>Boolean</tt> 
   
 
   
@@ -649,13 +667,31 @@
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Deliver this change.</p>
+<p>Deliver this change. Raise exceptions where applicable.</p>
 
 
   </div>
 </div>
 <div class="tags">
   
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>Boolean</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>true if the change was delivered, false otherwise.</p>
+</div>
+      
+    </li>
+  
+</ul>
 
 </div><table class="source_code">
   <tr>
@@ -663,10 +699,6 @@
       <pre class="lines">
 
 
-90
-91
-92
-93
 94
 95
 96
@@ -676,16 +708,20 @@
 100
 101
 102
-103</pre>
+103
+104
+105
+106
+107</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/automate_soup/change.rb', line 90</span>
+      <pre class="code"><span class="info file"># File 'lib/automate_soup/change.rb', line 94</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_deliver'>deliver</span>
   <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Must approve change first</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_stage'>stage</span><span class='period'>.</span><span class='id identifier rubyid_eql?'>eql?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>verify</span><span class='tstring_end'>&#39;</span></span>
-  <span class='kw'>return</span> <span class='kw'>nil</span> <span class='kw'>if</span> <span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_stage'>stage</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>acceptance</span><span class='tstring_end'>&#39;</span></span>
+  <span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_current_stage'>current_stage</span><span class='period'>.</span><span class='id identifier rubyid_stage'>stage</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>acceptance</span><span class='tstring_end'>&#39;</span></span>
   <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Must run AutomateSoup.setup first</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="../AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_url'><span class='object_link'><a href="../AutomateSoup.html#url-class_method" title="AutomateSoup.url (method)">url</a></span></span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='const'><span class='object_link'><a href="../AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_credentials'><span class='object_link'><a href="../AutomateSoup.html#credentials-class_method" title="AutomateSoup.credentials (method)">credentials</a></span></span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
-  <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Deliver link not available</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_links'>links</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_links'>links</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>deliver</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_links'>links</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>deliver</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>href</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Deliver link not available, </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_links'>links</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_links'>links</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_links'>links</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>deliver</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>||</span> <span class='id identifier rubyid_links'>links</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>deliver</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>href</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
   <span class='id identifier rubyid_url'>url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='period'>.</span><span class='id identifier rubyid_url'><span class='object_link'><a href="../AutomateSoup.html#url-class_method" title="AutomateSoup.url (method)">url</a></span></span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_links'>links</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>deliver</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>href</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
   <span class='id identifier rubyid_res'>res</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../AutomateSoup.html" title="AutomateSoup (module)">AutomateSoup</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Rest.html" title="AutomateSoup::Rest (module)">Rest</a></span></span><span class='period'>.</span><span class='id identifier rubyid_post'><span class='object_link'><a href="Rest.html#post-class_method" title="AutomateSoup::Rest.post (method)">post</a></span></span><span class='lparen'>(</span>
     <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
@@ -882,7 +918,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:49:18 2017 by
+  Generated on Tue Dec 19 09:58:14 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/AutomateSoup/Credentials.html

@@ -442,7 +442,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:49:18 2017 by
+  Generated on Tue Dec 19 09:58:14 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/AutomateSoup/Rest.html

@@ -311,7 +311,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:49:18 2017 by
+  Generated on Tue Dec 19 09:58:14 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/AutomateSoup/Stage.html

@@ -249,12 +249,12 @@
       <pre class="lines">
 
 
+8
 9
-10
-11</pre>
+10</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/automate_soup/stage.rb', line 9</span>
+      <pre class="code"><span class="info file"># File 'lib/automate_soup/stage.rb', line 8</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
   <span class='ivar'>@source</span> <span class='op'>=</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_hash'>hash</span>
@@ -287,12 +287,12 @@
       <pre class="lines">
 
 
+12
 13
-14
-15</pre>
+14</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/automate_soup/stage.rb', line 13</span>
+      <pre class="code"><span class="info file"># File 'lib/automate_soup/stage.rb', line 12</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_method_missing'>method_missing</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
   <span class='ivar'>@source</span><span class='period'>.</span><span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
@@ -346,12 +346,12 @@
       <pre class="lines">
 
 
+20
 21
-22
-23</pre>
+22</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/automate_soup/stage.rb', line 21</span>
+      <pre class="code"><span class="info file"># File 'lib/automate_soup/stage.rb', line 20</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_failed?'>failed?</span>
   <span class='ivar'>@source</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_eql?'>eql?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>failed</span><span class='tstring_end'>&#39;</span></span>
@@ -398,12 +398,12 @@
       <pre class="lines">
 
 
+16
 17
-18
-19</pre>
+18</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/automate_soup/stage.rb', line 17</span>
+      <pre class="code"><span class="info file"># File 'lib/automate_soup/stage.rb', line 16</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_passed?'>passed?</span>
   <span class='ivar'>@source</span><span class='period'>.</span><span class='id identifier rubyid_status'>status</span><span class='period'>.</span><span class='id identifier rubyid_eql?'>eql?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>passed</span><span class='tstring_end'>&#39;</span></span>
@@ -418,7 +418,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:49:18 2017 by
+  Generated on Tue Dec 19 09:58:14 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/_index.html

@@ -156,7 +156,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:49:18 2017 by
+  Generated on Tue Dec 19 09:58:13 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/coverage/.resultset.json

@@ -140,6 +140,6 @@
         null
       ]
     },
-    "timestamp": 1513626557
+    "timestamp": 1513695817
   }
 }

data/docs/coverage/index.html

@@ -14,7 +14,7 @@
       <img src="./assets/0.10.2/loading.gif" alt="loading"/>
     </div>
     <div id="wrapper" style="display:none;">
-      <div class="timestamp">Generated <abbr class="timeago" title="2017-12-18T14:49:17-05:00">2017-12-18T14:49:17-05:00</abbr></div>
+      <div class="timestamp">Generated <abbr class="timeago" title="2017-12-19T10:03:37-05:00">2017-12-19T10:03:37-05:00</abbr></div>
       <ul class="group_tabs"></ul>
 
       <div id="content">

data/docs/file.README.html

@@ -201,7 +201,7 @@ conduct[https://github.com/[USERNAME]/automate_soup/blob/master/CODE_OF_CONDUCT.
 </div></div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:49:18 2017 by
+  Generated on Tue Dec 19 09:58:13 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/index.html

@@ -201,7 +201,7 @@ conduct[https://github.com/[USERNAME]/automate_soup/blob/master/CODE_OF_CONDUCT.
 </div></div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:49:18 2017 by
+  Generated on Tue Dec 19 09:58:13 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/docs/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Mon Dec 18 14:49:18 2017 by
+  Generated on Tue Dec 19 09:58:13 2017 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.9 (ruby-2.4.1).
 </div>

data/lib/automate_soup.rb

@@ -61,21 +61,36 @@ module AutomateSoup
     end
 
     ##
-    # Fetch all projects under an enterprise, organization pair
+    # Get the projects under and organization given the enterprise.
+    #
+    # @option enterprise [String] the enterprise to fetch org from, defaults to
+    # default.
+    # @option organization [String] the organization to fetch projects from.
     #
     def projects(enterprise: 'default', organization: nil)
       @api.projects(enterprise: enterprise, organization: organization)
     end
 
     ##
-    # Fetch all pipelines of a project under an enterprise, organization pair
+    # Fetch all project pipelines under an enterprise, organization pair
+    #
+    # @option enterprise [String] the enterprise to fetch org from, defaults to
+    # default.
+    # @option organization [String] the organization to fetch pipelines from.
+    # @option project [String] the project to fetch pipelines from.
     #
     def pipelines(enterprise: 'default', organization: nil, project: nil)
       @api.pipelines(enterprise: enterprise, organization: organization, project: project)
     end
 
     ##
-    # Fetch a pipeline of a project under an enterprise, organization pair.
+    # Fetch a projects pipeline under an enterprise, organization pair
+    #
+    # @option enterprise [String] the enterprise to fetch org from, defaults to
+    # default.
+    # @option organization [String] the organization to fetch from.
+    # @option project [String] the project to fetch from.
+    # @option pipeline [String] the pipeline to fetch from.
     #
     def pipeline(enterprise: 'default', organization: nil, project: nil, pipeline: nil)
       arr = []
@@ -94,6 +109,7 @@ module AutomateSoup
     # @option project [String] the project to fetch from.
     # @option pipeline [String] the pipeline to fetch from.
     #
+    # @return [Array] an array of strings holding change topics.
     def pipeline_topics(enterprise: 'default', organization: nil, project: nil, pipeline: nil)
       self.pipeline(
         enterprise: enterprise,
@@ -113,6 +129,7 @@ module AutomateSoup
     # @option pipeline [String] the pipeline to fetch from.
     # @option topic [String] the topic to fetch a change from.
     #
+    # @return [AutomateSoup::Change] the change coresponding to the given topic.
     def change_by_topic(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil)
       o = self.pipeline(
         enterprise: enterprise,
@@ -137,6 +154,7 @@ module AutomateSoup
     # to 10
     # @option retries [Integer] the amount of retries to make, defaults to 5
     #
+    # @return [Boolean] true if the change was approved, false otherwise.
     def approve_change(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil, wait: false, timeout: 10, retries: 5)
       o = self.change_by_topic(
         enterprise: enterprise,
@@ -163,8 +181,13 @@ module AutomateSoup
         end
       end
 
-      o.approve
-      return true if !wait && o.deliverable?
+      app = o.approve
+      return true if !wait && !app.nil? && o.deliverable?
+      if app.nil? && !o.deliverable?
+        puts "Could not approve change #{o.current_stage.stage}: #{o.current_stage.status}"
+        return false
+      end
+
       times = 1
       while times <= retries
         o = self.change_by_topic(
@@ -198,6 +221,7 @@ module AutomateSoup
     # to 10
     # @option retries [Integer] the amount of retries to make, defaults to 5
     #
+    # @return [Boolean] true if the change was delivered, false otherwise.
     def deliver_change(enterprise: @enterprise, organization: @organization, project: @project, pipeline: @pipeline, topic: nil, wait: false, timeout: 10, retries: 5)
       o = self.change_by_topic(
         enterprise: enterprise,
@@ -225,8 +249,14 @@ module AutomateSoup
         end
       end
 
-      o.deliver
-      return true if !wait && o.delivered?
+      de = o.deliver
+      return true if !wait && !de.nil? && o.delivered?
+
+      if de.nil? && !o.deliverable?
+        puts "Could not deliver change #{o.current_stage.stage}: #{o.current_stage.status}"
+        return false
+      end
+
       times = 1
       while times <= retries
         o = self.change_by_topic(

data/lib/automate_soup/change.rb

@@ -70,11 +70,13 @@ module AutomateSoup
     end
 
     ##
-    # Approve this change.
+    # Approve this change. Raise exceptions where applicable.
+    #
+    # @return [Boolean] true if the change was approved, false otherwise.
     def approve
       return nil if current_stage.stage != 'verify'
       raise 'Must run AutomateSoup.setup first' if AutomateSoup.url.nil? || AutomateSoup.credentials.nil?
-      raise 'Approve link not available' if links.nil? || links['approve'].nil? || links['approve']['href'].nil?
+      raise "Approve link not available, #{links.inspect}" if links.nil? || links['approve'].nil? || links['approve']['href'].nil?
       url = "#{AutomateSoup.url}#{links['approve']['href']}"
       res = AutomateSoup::Rest.post(
         url: url,
@@ -86,12 +88,14 @@ module AutomateSoup
     end
 
     ##
-    # Deliver this change.
+    # Deliver this change. Raise exceptions where applicable.
+    #
+    # @return [Boolean] true if the change was delivered, false otherwise.
     def deliver
       raise 'Must approve change first' if current_stage.stage.eql? 'verify'
       return nil if current_stage.stage != 'acceptance'
       raise 'Must run AutomateSoup.setup first' if AutomateSoup.url.nil? || AutomateSoup.credentials.nil?
-      raise 'Deliver link not available' if links.nil? || links['deliver'].nil? || links['deliver']['href'].nil?
+      raise "Deliver link not available, #{links.inspect}" if links.nil? || links['deliver'].nil? || links['deliver']['href'].nil?
       url = "#{AutomateSoup.url}#{links['deliver']['href']}"
       res = AutomateSoup::Rest.post(
         url: url,