doc/Ballast/Service.html in ballast-2.1.3 vs doc/Ballast/Service.html in ballast-2.2.0

- old
+ new

@@ -214,10 +214,33 @@ <li class="public "> <span class="summary_signature"> + <a href="#fail_validation%21-class_method" title="fail_validation! (class method)">+ (Object) <strong>fail_validation!</strong>(details) </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'><p>Marks the failure of the validation of the operation.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#handle_failure-class_method" title="handle_failure (class method)">+ (Response) <strong>handle_failure</strong>(failure, raise_errors) </a> </span> @@ -269,11 +292,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#fail%21-instance_method" title="#fail! (instance method)">- (Object) <strong>fail!</strong>(details, on_validation: false) </a> + <a href="#fail%21-instance_method" title="#fail! (instance method)">- (Object) <strong>fail!</strong>(details) </a> </span> @@ -292,10 +315,33 @@ <li class="public "> <span class="summary_signature"> + <a href="#fail_validation%21-instance_method" title="#fail_validation! (instance method)">- (Object) <strong>fail_validation!</strong>(details) </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'><p>Marks the failure of the validation of the operation.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Service) <strong>initialize</strong>(owner = nil) </a> </span> @@ -366,16 +412,16 @@ <tr> <td> <pre class="lines"> -109 -110 -111</pre> +115 +116 +117</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 109</span> + <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 115</span> <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_owner identifier id'>owner</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span> <span class='rubyid_@owner ivar id'>@owner</span> <span class='assign token'>=</span> <span class='rubyid_owner identifier id'>owner</span> <span class='rubyid_end end kw'>end</span> </pre> @@ -567,11 +613,23 @@ 142 143 144 145 146 -147</pre> +147 +148 +149 +150 +151 +152 +153 +154 +155 +156 +157 +158 +159</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 11</span> <span class='rubyid_class class kw'>class</span> <span class='rubyid_Service constant id'>Service</span> @@ -662,15 +720,21 @@ <span class='rubyid_end end kw'>end</span> <span class='comment val'># Marks the failure of the operation.</span> <span class='comment val'>#</span> <span class='comment val'># @param details [Object] The error(s) occurred.</span> - <span class='comment val'># @param on_validation [Boolean] Whether the error(s) was/were validation error(s).</span> <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_fail! fid id'>fail!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='comma token'>,</span> <span class='label val'>on_validation:</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span> - <span class='rubyid_raise identifier id'>raise</span><span class='lparen token'>(</span><span class='rubyid_on_validation identifier id'>on_validation</span> <span class='integer val'>? </span><span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_ValidationFailure constant id'>ValidationFailure</span> <span class='colon op'>:</span> <span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_Failure constant id'>Failure</span><span class='comma token'>,</span> <span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> + <span class='rubyid_raise identifier id'>raise</span><span class='lparen token'>(</span><span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_Failure constant id'>Failure</span><span class='comma token'>,</span> <span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> <span class='rubyid_end end kw'>end</span> + <span class='comment val'># Marks the failure of the validation of the operation.</span> + <span class='comment val'>#</span> + <span class='comment val'># @param details [Object] The error(s) occurred.</span> + <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_fail_validation! fid id'>fail_validation!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> + <span class='rubyid_raise identifier id'>raise</span><span class='lparen token'>(</span><span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_ValidationFailure constant id'>ValidationFailure</span><span class='comma token'>,</span> <span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> + <span class='rubyid_end end kw'>end</span> + <span class='comment val'># Creates a service object.</span> <span class='comment val'>#</span> <span class='comment val'># @param owner [Object|NilClass] The owner of the service.</span> <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_owner identifier id'>owner</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span> <span class='rubyid_@owner ivar id'>@owner</span> <span class='assign token'>=</span> <span class='rubyid_owner identifier id'>owner</span> @@ -695,15 +759,21 @@ <span class='rubyid_end end kw'>end</span> <span class='comment val'># Marks the failure of the operation.</span> <span class='comment val'>#</span> <span class='comment val'># @param details [Object] The error(s) occurred.</span> - <span class='comment val'># @param on_validation [Boolean] Whether the error(s) was/were validation error(s).</span> - <span class='rubyid_def def kw'>def</span> <span class='rubyid_fail! fid id'>fail!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='comma token'>,</span> <span class='label val'>on_validation:</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span> - <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_class identifier id'>class</span><span class='dot token'>.</span><span class='rubyid_fail! fid id'>fail!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='comma token'>,</span> <span class='label val'>on_validation:</span> <span class='rubyid_on_validation identifier id'>on_validation</span><span class='rparen token'>)</span> + <span class='rubyid_def def kw'>def</span> <span class='rubyid_fail! fid id'>fail!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> + <span class='rubyid_raise identifier id'>raise</span><span class='lparen token'>(</span><span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_Failure constant id'>Failure</span><span class='comma token'>,</span> <span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> <span class='rubyid_end end kw'>end</span> + <span class='comment val'># Marks the failure of the validation of the operation.</span> + <span class='comment val'>#</span> + <span class='comment val'># @param details [Object] The error(s) occurred.</span> + <span class='rubyid_def def kw'>def</span> <span class='rubyid_fail_validation! fid id'>fail_validation!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> + <span class='rubyid_raise identifier id'>raise</span><span class='lparen token'>(</span><span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_ValidationFailure constant id'>ValidationFailure</span><span class='comma token'>,</span> <span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> + <span class='rubyid_end end kw'>end</span> + <span class='comment val'># Handles a failure.</span> <span class='comment val'>#</span> <span class='comment val'># @param failure [Failure] The failure to handle.</span> <span class='comment val'># @param raise_errors [Boolean] If `true` it will simply raise the error, otherwise it will return a failure as as Service::Response.</span> <span class='comment val'># @return [Response] A failure response.</span> @@ -917,43 +987,114 @@ <div class='inline'><p>The error(s) occurred.</p> </div> </li> +</ul> + +<p class="tag_title">Raises:</p> +<ul class="raise"> + <li> - <span class='name'>on_validation</span> + <span class='type'>(<tt><span class='object_link'><a href="Errors/Failure.html" title="Ballast::Errors::Failure (class)">Errors::Failure</a></span></tt>)</span> - <span class='type'>(<tt>Boolean</tt>)</span> + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +101 +102 +103</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 101</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_fail! fid id'>fail!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='comma token'>,</span> <span class='label val'>on_validation:</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span> + <span class='rubyid_raise identifier id'>raise</span><span class='lparen token'>(</span><span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_Failure constant id'>Failure</span><span class='comma token'>,</span> <span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="fail_validation!-class_method"> + + + (<tt>Object</tt>) <strong>fail_validation!</strong>(details) + + + + + +</h3><div class="docstring"> + <div class="discussion"> + <p>Marks the failure of the validation of the operation.</p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + <span class='name'>details</span> + + + <span class='type'>(<tt>Object</tt>)</span> + + + &mdash; - <div class='inline'><p>Whether the error(s) was/were validation error(s).</p> + <div class='inline'><p>The error(s) occurred.</p> </div> </li> </ul> +<p class="tag_title">Raises:</p> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Errors/ValidationFailure.html" title="Ballast::Errors::ValidationFailure (class)">Errors::ValidationFailure</a></span></tt>)</span> + + + + </li> + +</ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> -102 -103 -104</pre> +108 +109 +110</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 102</span> + <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 108</span> -<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_fail! fid id'>fail!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='comma token'>,</span> <span class='label val'>on_validation:</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span> - <span class='rubyid_raise identifier id'>raise</span><span class='lparen token'>(</span><span class='rubyid_on_validation identifier id'>on_validation</span> <span class='integer val'>? </span><span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_ValidationFailure constant id'>ValidationFailure</span> <span class='colon op'>:</span> <span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_Failure constant id'>Failure</span><span class='comma token'>,</span> <span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> +<span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_fail_validation! fid id'>fail_validation!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> + <span class='rubyid_raise identifier id'>raise</span><span class='lparen token'>(</span><span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_ValidationFailure constant id'>ValidationFailure</span><span class='comma token'>,</span> <span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> <span class='rubyid_end end kw'>end</span> </pre> </td> </tr> </table> @@ -1033,16 +1174,16 @@ <tr> <td> <pre class="lines"> -144 -145 -146</pre> +156 +157 +158</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 144</span> + <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 156</span> <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_handle_failure identifier id'>handle_failure</span><span class='lparen token'>(</span><span class='rubyid_failure identifier id'>failure</span><span class='comma token'>,</span> <span class='rubyid_raise_errors identifier id'>raise_errors</span><span class='rparen token'>)</span> <span class='rubyid_raise_errors identifier id'>raise_errors</span> <span class='integer val'>? </span><span class='rubyid_raise identifier id'>raise</span><span class='lparen token'>(</span><span class='rubyid_failure identifier id'>failure</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_Response constant id'>Response</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_false false kw'>false</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='rubyid_failure identifier id'>failure</span><span class='dot token'>.</span><span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> <span class='rubyid_end end kw'>end</span> </pre> @@ -1193,21 +1334,21 @@ <tr> <td> <pre class="lines"> -122 -123 -124 -125 -126 -127 128 -129</pre> +129 +130 +131 +132 +133 +134 +135</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 122</span> + <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 128</span> <span class='rubyid_def def kw'>def</span> <span class='rubyid_call identifier id'>call</span><span class='lparen token'>(</span><span class='rubyid_operation identifier id'>operation</span> <span class='assign token'>=</span> <span class='symbol val'>:perform</span><span class='comma token'>,</span> <span class='label val'>owner:</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='label val'>raise_errors:</span> <span class='rubyid_false false kw'>false</span><span class='comma token'>,</span> <span class='label val'>params:</span> <span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='comma token'>,</span> <span class='pow op'>**</span><span class='rubyid_kwargs identifier id'>kwargs</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span> <span class='comment val'># PI: Ignore Roodi on this method</span> <span class='rubyid_@owner ivar id'>@owner</span> <span class='assign token'>=</span> <span class='rubyid_owner identifier id'>owner</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_owner identifier id'>owner</span> <span class='rubyid_fail! fid id'>fail!</span><span class='lparen token'>(</span><span class='label val'>status:</span> <span class='integer val'>501</span><span class='comma token'>,</span> <span class='label val'>error:</span> <span class='dstring node'>&quot;Unsupported operation #{self.class}##{operation}.&quot;</span><span class='rparen token'>)</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='rubyid_operation identifier id'>operation</span><span class='rparen token'>)</span> @@ -1222,11 +1363,11 @@ </div> <div class="method_details "> <h3 class="signature " id="fail!-instance_method"> - - (<tt>Object</tt>) <strong>fail!</strong>(details, on_validation: false) + - (<tt>Object</tt>) <strong>fail!</strong>(details) @@ -1254,43 +1395,114 @@ <div class='inline'><p>The error(s) occurred.</p> </div> </li> +</ul> + +<p class="tag_title">Raises:</p> +<ul class="raise"> + <li> - <span class='name'>on_validation</span> + <span class='type'>(<tt><span class='object_link'><a href="Errors/Failure.html" title="Ballast::Errors::Failure (class)">Errors::Failure</a></span></tt>)</span> - <span class='type'>(<tt>Boolean</tt>)</span> + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +140 +141 +142</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 140</span> + +<span class='rubyid_def def kw'>def</span> <span class='rubyid_fail! fid id'>fail!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> + <span class='rubyid_raise identifier id'>raise</span><span class='lparen token'>(</span><span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_Failure constant id'>Failure</span><span class='comma token'>,</span> <span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> +<span class='rubyid_end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> + <h3 class="signature " id="fail_validation!-instance_method"> + + - (<tt>Object</tt>) <strong>fail_validation!</strong>(details) + + + + + +</h3><div class="docstring"> + <div class="discussion"> + <p>Marks the failure of the validation of the operation.</p> + + + </div> +</div> +<div class="tags"> + <p class="tag_title">Parameters:</p> +<ul class="param"> + + <li> + <span class='name'>details</span> + + + <span class='type'>(<tt>Object</tt>)</span> + + + &mdash; - <div class='inline'><p>Whether the error(s) was/were validation error(s).</p> + <div class='inline'><p>The error(s) occurred.</p> </div> </li> </ul> +<p class="tag_title">Raises:</p> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="Errors/ValidationFailure.html" title="Ballast::Errors::ValidationFailure (class)">Errors::ValidationFailure</a></span></tt>)</span> + + + + </li> + +</ul> </div><table class="source_code"> <tr> <td> <pre class="lines"> -135 -136 -137</pre> +147 +148 +149</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 135</span> + <pre class="code"><span class="info file"># File 'lib/ballast/service.rb', line 147</span> -<span class='rubyid_def def kw'>def</span> <span class='rubyid_fail! fid id'>fail!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='comma token'>,</span> <span class='label val'>on_validation:</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span> - <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_class identifier id'>class</span><span class='dot token'>.</span><span class='rubyid_fail! fid id'>fail!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='comma token'>,</span> <span class='label val'>on_validation:</span> <span class='rubyid_on_validation identifier id'>on_validation</span><span class='rparen token'>)</span> +<span class='rubyid_def def kw'>def</span> <span class='rubyid_fail_validation! fid id'>fail_validation!</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> + <span class='rubyid_raise identifier id'>raise</span><span class='lparen token'>(</span><span class='rubyid_Errors constant id'>Errors</span><span class='colon2 op'>::</span><span class='rubyid_ValidationFailure constant id'>ValidationFailure</span><span class='comma token'>,</span> <span class='rubyid_details identifier id'>details</span><span class='rparen token'>)</span> <span class='rubyid_end end kw'>end</span> </pre> </td> </tr> </table> @@ -1299,10 +1511,10 @@ </div> </div> <div id="footer"> - Generated on Fri Feb 6 13:24:21 2015 by + Generated on Fri Feb 6 16:18:34 2015 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.8.7.6 (ruby-2.2.0). </div> </body> \ No newline at end of file