RubyGems - czech_post_b2b_client - Versions diffs - 1.0.0 - Mend

czech_post_b2b_client 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (397) hide show

data/doc/SteppedService.html ADDED

@@ -0,0 +1,224 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: SteppedService
+    &mdash; Documentation by YARD 0.9.19
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "SteppedService";
+  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>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index (S)</a> &raquo;
+    <span class="title">SteppedService</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Module: SteppedService
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/stepped_service/base.rb<span class="defines">,<br />
+  lib/stepped_service/errors.rb</span>
+</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Service class based on steps chain (see #steps), which can be successfull
+even with errors. If execution of step is successful, next step will be
+executed. Step can be marked as failed by calling #fail!. That will stop
+executing steps chain and return as #failed?. During processing, #errors
+can be added, but they will not stop the execution.</p>
+<p>Example usage</p>
+<pre class="code ruby"><code class="ruby">class TeaMaker &lt; SteppedService::Base
+  attr_reader :tea_type, :bags_into_kettle
+  def initialize(tea_type:, bags_into_kettle:)
+    @tea_type = tea_type
+    @bags_into_kettle = bags_into_kettle
+  end
+  def steps
+    %i[get_water_into_kettle
+      make_it_boil
+      put_tea_bags_into_kettle
+      wait_3mins
+      pour_tea_into_cups
+      add_sugar_to_caps]
+  end
+  private
+  attr_accessor :teabags, :kettle, :cups
+  def get_water_into_kettle
+    self.kettle = find_kettle
+    unless kettle
+      errors.add(:kettle, &quot;There is no kettle in kitchen!&quot;)
+      fail!
+    end
+    fill_water_into(kettle)
+  end
+  def make_it_boil
+    ...
+  end
+  def put_tea_bags_into_kettle
+    self.teabags = get_teabags(tea_type, bags_into_kettle)
+    if teabags.empty?
+      errors.add(:teabags, &quot;There is no #{bags_into_kettle} #{tea_type} tea teabags in storage,  using fruit tea teabags.&quot;)
+      self.teabags = get_teabags(:fruit, bags_into_kettle)
+      if teabags.empty?
+        errors.add(:teabags, &quot;There is no #{bags_into_kettle} fruit tea teabags in storage either!&quot;)
+        fail!
+      end
+    end
+    insert(teabags, to: kettle)
+  end
+  ...
+  def add_sugar_to_caps # last step should fill @result
+     cups.each{ |c| c.insert(sugar_cube) }
+     @result = cups
+  end
+end</code></pre>
+<p>calling</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_teamaker'>teamaker</span> <span class='op'>=</span> <span class='const'>TeaMaker</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='symbol'>:black</span><span class='comma'>,</span> <span class='int'>2</span><span class='rparen'>)</span>
+</code></pre>
+<p>will return instance of with:</p>
+<ul><li>
+<p>if there is no kettle :</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_teamaker'>teamaker</span><span class='period'>.</span><span class='id identifier rubyid_failure?'>failure?</span> <span class='comment'># =&gt; true
+</span><span class='id identifier rubyid_teamaker'>teamaker</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> <span class='comment'># =&gt; nil
+</span><span class='id identifier rubyid_teamaker'>teamaker</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='lbracket'>[</span><span class='symbol'>:kettle</span><span class='rbracket'>]</span> <span class='comment'># =&gt; [&quot;There is no kettle in kitchen!&quot;]
+</span></code></pre>
+</li><li>
+<p>if there is no black tea but fruit was found:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_teamaker'>teamaker</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span> <span class='comment'># =&gt; true
+</span><span class='id identifier rubyid_teamaker'>teamaker</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> <span class='comment'># =&gt; _cups with fruit tea_
+</span><span class='id identifier rubyid_teamaker'>teamaker</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span><span class='lbracket'>[</span><span class='symbol'>:teabags</span><span class='rbracket'>]</span> <span class='comment'># =&gt; [&quot;There is no 2 :black tea teabags in storage, using fruit tea teabags.&quot;]
+</span></code></pre>
+</li><li>
+<p>if there is no black or fruit tea:</p>
+<pre class="code ruby"><code class="ruby">teamaker.success? # =&gt; false
+teamaker.result # =&gt; nil
+teamaker.errors[:teabags] # =&gt; [&quot;There is no 2 :black tea teabags in storage, using fruit tea teabags.&quot;,
+                                &quot;There is no 2 fruit tea teabags in storage either!&quot;]</code></pre>
+</li><li>
+<p>if all goes well:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_teamaker'>teamaker</span><span class='period'>.</span><span class='id identifier rubyid_success?'>success?</span> <span class='comment'># =&gt; true
+</span><span class='id identifier rubyid_teamaker'>teamaker</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span> <span class='comment'># =&gt; _cups with black tea_
+</span><span class='id identifier rubyid_teamaker'>teamaker</span><span class='period'>.</span><span class='id identifier rubyid_errors'>errors</span> <span class='comment'># =&gt; {}
+</span></code></pre>
+</li></ul>
+  </div>
+</div>
+<div class="tags">
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="SteppedService/Base.html" title="SteppedService::Base (class)">Base</a></span>, <span class='object_link'><a href="SteppedService/Errors.html" title="SteppedService::Errors (class)">Errors</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Fri Mar 20 17:49:05 2020 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.19 (ruby-2.4.1).
+</div>
+    </div>
+  </body>
+</html>

data/doc/SteppedService/Base.html ADDED

@@ -0,0 +1,706 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: SteppedService::Base
+    &mdash; Documentation by YARD 0.9.19
+</title>
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "SteppedService::Base";
+  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>
+    <div class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../_index.html">Index (B)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../SteppedService.html" title="SteppedService (module)">SteppedService</a></span></span>
+     &raquo;
+    <span class="title">Base</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Class: SteppedService::Base
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName">Object</span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next">SteppedService::Base</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/stepped_service/base.rb</dd>
+  </dl>
+</div>
+<div id="subclasses">
+  <h2>Direct Known Subclasses</h2>
+  <p class="children"><span class='object_link'><a href="../CzechPostB2bClient/RequestBuilders/BaseBuilder.html" title="CzechPostB2bClient::RequestBuilders::BaseBuilder (class)">CzechPostB2bClient::RequestBuilders::BaseBuilder</a></span>, <span class='object_link'><a href="../CzechPostB2bClient/ResponseParsers/BaseParser.html" title="CzechPostB2bClient::ResponseParsers::BaseParser (class)">CzechPostB2bClient::ResponseParsers::BaseParser</a></span>, <span class='object_link'><a href="../CzechPostB2bClient/Services/ApiCaller.html" title="CzechPostB2bClient::Services::ApiCaller (class)">CzechPostB2bClient::Services::ApiCaller</a></span>, <span class='object_link'><a href="../CzechPostB2bClient/Services/Orchestrator.html" title="CzechPostB2bClient::Services::Orchestrator (class)">CzechPostB2bClient::Services::Orchestrator</a></span></p>
+</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="#result-instance_method" title="#result (instance method)">#<strong>result</strong>  &#x21d2; Object </a>
+  </span>
+      <span class="note title readonly">readonly</span>
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the value of attribute result.</p>
+</div></span>
+</li>
+  </ul>
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+    <ul class="summary">
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#call-class_method" title="call (class method)">.<strong>call</strong>(*args, **keyword_args)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></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="#call-instance_method" title="#call (instance method)">#<strong>call</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>You can override it, to not use steps.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#errors-instance_method" title="#errors (instance method)">#<strong>errors</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#failure%3F-instance_method" title="#failure? (instance method)">#<strong>failure?</strong>  &#x21d2; Boolean </a>
+      (also: #failed?)
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#finished%3F-instance_method" title="#finished? (instance method)">#<strong>finished?</strong>  &#x21d2; Boolean </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#steps-instance_method" title="#steps (instance method)">#<strong>steps</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#success%3F-instance_method" title="#success? (instance method)">#<strong>success?</strong>  &#x21d2; Boolean </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+    </ul>
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+      <span id=""></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="result-instance_method">
+    #<strong>result</strong>  &#x21d2; <tt>Object</tt>  <span class="extras">(readonly)</span>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Returns the value of attribute result</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+86
+87
+88</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/stepped_service/base.rb', line 86</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span>
+  <span class='ivar'>@result</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="call-class_method">
+    .<strong>call</strong>(*args, **keyword_args)  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+88
+89
+90</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/stepped_service/base.rb', line 88</span>
+<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_keyword_args'>keyword_args</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_keyword_args'>keyword_args</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span>
+<span class='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">
+  <h3 class="signature first" id="call-instance_method">
+    #<strong>call</strong>  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>You can override it, to not use steps</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+93
+94
+95
+96
+97
+98
+99
+100
+101
+102
+103</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/stepped_service/base.rb', line 93</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
+  <span class='ivar'>@finished</span> <span class='op'>=</span> <span class='kw'>false</span>
+  <span class='ivar'>@failed</span> <span class='op'>=</span> <span class='kw'>false</span>
+  <span class='id identifier rubyid_steps'>steps</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_step'>step</span><span class='op'>|</span>
+    <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='id identifier rubyid_step'>step</span><span class='rparen'>)</span>
+    <span class='kw'>return</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id identifier rubyid_finished?'>finished?</span> <span class='op'>||</span> <span class='id identifier rubyid_failed?'>failed?</span>
+  <span class='kw'>end</span>
+  <span class='id identifier rubyid_finish!'>finish!</span>
+  <span class='kw'>self</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="errors-instance_method">
+    #<strong>errors</strong>  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+122
+123
+124
+125</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/stepped_service/base.rb', line 122</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_errors'>errors</span>
+  <span class='comment'># use with errors.add(:network, e.message)
+</span>  <span class='ivar'>@errors</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="Errors.html" title="SteppedService::Errors (class)">Errors</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="failure?-instance_method">
+    #<strong>failure?</strong>  &#x21d2; <tt>Boolean</tt>
+    <span class="aliases">Also known as:
+    <span class="names"><span id='failed?-instance_method'>failed?</span></span>
+    </span>
+</h3><div class="docstring">
+  <div class="discussion">
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+117
+118
+119</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/stepped_service/base.rb', line 117</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_failure?'>failure?</span>
+  <span class='id identifier rubyid_failed'>failed</span> <span class='op'>==</span> <span class='kw'>true</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="finished?-instance_method">
+    #<strong>finished?</strong>  &#x21d2; <tt>Boolean</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+109
+110
+111</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/stepped_service/base.rb', line 109</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_finished?'>finished?</span>
+  <span class='id identifier rubyid_finished'>finished</span> <span class='op'>==</span> <span class='kw'>true</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="steps-instance_method">
+    #<strong>steps</strong>  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+105
+106
+107</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/stepped_service/base.rb', line 105</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_steps'>steps</span>
+  <span class='qsymbols_beg'>%i[</span><span class='tstring_content'>need</span><span class='words_sep'> </span><span class='tstring_content'>to</span><span class='words_sep'> </span><span class='tstring_content'>be</span><span class='words_sep'> </span><span class='tstring_content'>implemented</span><span class='words_sep'>]</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="success?-instance_method">
+    #<strong>success?</strong>  &#x21d2; <tt>Boolean</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+  </div>
+</div>
+<div class="tags">
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+113
+114
+115</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/stepped_service/base.rb', line 113</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
+  <span class='op'>!</span><span class='id identifier rubyid_failure?'>failure?</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Fri Mar 20 17:49:05 2020 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.19 (ruby-2.4.1).
+</div>
+    </div>
+  </body>
+</html>