RubyGems - czech_post_b2b_client - Versions diffs - 1.0.0 - Mend

czech_post_b2b_client 1.0.0

Files changed (397) hide show

data/doc/CzechPostB2bClient/ResponseParsers/GetResultParcelsParser.html ADDED

@@ -0,0 +1,625 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: CzechPostB2bClient::ResponseParsers::GetResultParcelsParser
+    &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 = "CzechPostB2bClient::ResponseParsers::GetResultParcelsParser";
+  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 (G)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../CzechPostB2bClient.html" title="CzechPostB2bClient (module)">CzechPostB2bClient</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../ResponseParsers.html" title="CzechPostB2bClient::ResponseParsers (module)">ResponseParsers</a></span></span>
+     &raquo;
+    <span class="title">GetResultParcelsParser</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: CzechPostB2bClient::ResponseParsers::GetResultParcelsParser
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="BaseParser.html" title="CzechPostB2bClient::ResponseParsers::BaseParser (class)">BaseParser</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="../../SteppedService/Base.html" title="SteppedService::Base (class)">SteppedService::Base</a></span></li>
+            <li class="next"><span class='object_link'><a href="BaseParser.html" title="CzechPostB2bClient::ResponseParsers::BaseParser (class)">BaseParser</a></span></li>
+            <li class="next">CzechPostB2bClient::ResponseParsers::GetResultParcelsParser</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb</dd>
+  </dl>
+</div>
+  <h2>Instance Attribute Summary</h2>
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../../SteppedService/Base.html" title="SteppedService::Base (class)">SteppedService::Base</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../../SteppedService/Base.html#result-instance_method" title="SteppedService::Base#result (method)">#result</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="#build_result-instance_method" title="#build_result (instance method)">#<strong>build_result</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#parcel_data_from-instance_method" title="#parcel_data_from (instance method)">#<strong>parcel_data_from</strong>(rp_hash)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#parcel_parcel_id_from-instance_method" title="#parcel_parcel_id_from (instance method)">#<strong>parcel_parcel_id_from</strong>(rp_hash)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#parcels_data_hash-instance_method" title="#parcels_data_hash (instance method)">#<strong>parcels_data_hash</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#response_parcel_hashes-instance_method" title="#response_parcel_hashes (instance method)">#<strong>response_parcel_hashes</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#response_root_node_name-instance_method" title="#response_root_node_name (instance method)">#<strong>response_root_node_name</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#response_state_response-instance_method" title="#response_state_response (instance method)">#<strong>response_state_response</strong>  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#updated_result_value_for-instance_method" title="#updated_result_value_for (instance method)">#<strong>updated_result_value_for</strong>(value, parcel_params_result_hash)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'></div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseParser.html" title="CzechPostB2bClient::ResponseParsers::BaseParser (class)">BaseParser</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseParser.html#initialize-instance_method" title="CzechPostB2bClient::ResponseParsers::BaseParser#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="BaseParser.html#steps-instance_method" title="CzechPostB2bClient::ResponseParsers::BaseParser#steps (method)">#steps</a></span></p>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../../SteppedService/Base.html" title="SteppedService::Base (class)">SteppedService::Base</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="../../SteppedService/Base.html#call-class_method" title="SteppedService::Base.call (method)">call</a></span>, <span class='object_link'><a href="../../SteppedService/Base.html#call-instance_method" title="SteppedService::Base#call (method)">#call</a></span>, <span class='object_link'><a href="../../SteppedService/Base.html#errors-instance_method" title="SteppedService::Base#errors (method)">#errors</a></span>, <span class='object_link'><a href="../../SteppedService/Base.html#failure%3F-instance_method" title="SteppedService::Base#failure? (method)">#failure?</a></span>, <span class='object_link'><a href="../../SteppedService/Base.html#finished%3F-instance_method" title="SteppedService::Base#finished? (method)">#finished?</a></span>, <span class='object_link'><a href="../../SteppedService/Base.html#steps-instance_method" title="SteppedService::Base#steps (method)">#steps</a></span>, <span class='object_link'><a href="../../SteppedService/Base.html#success%3F-instance_method" title="SteppedService::Base#success? (method)">#success?</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BaseParser.html#initialize-instance_method" title="CzechPostB2bClient::ResponseParsers::BaseParser#initialize (method)">CzechPostB2bClient::ResponseParsers::BaseParser</a></span></p>
+</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="build_result-instance_method">
+    #<strong>build_result</strong>  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+6
+7
+8
+9
+10</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb', line 6</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_build_result'>build_result</span>
+  <span class='kw'>super</span>
+  <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='symbol'>:response</span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='symbol'>:state</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_state_hash_from'>state_hash_from</span><span class='lparen'>(</span><span class='id identifier rubyid_response_state_response'>response_state_response</span><span class='rparen'>)</span>
+  <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='symbol'>:parcels</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parcels_data_hash'>parcels_data_hash</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="parcel_data_from-instance_method">
+    #<strong>parcel_data_from</strong>(rp_hash)  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+35
+36
+37
+38</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb', line 35</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_parcel_data_from'>parcel_data_from</span><span class='lparen'>(</span><span class='id identifier rubyid_rp_hash'>rp_hash</span><span class='rparen'>)</span>
+  <span class='lbrace'>{</span> <span class='label'>parcel_code:</span> <span class='id identifier rubyid_rp_hash'>rp_hash</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>parcelCode</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
+    <span class='label'>states:</span> <span class='lbracket'>[</span><span class='id identifier rubyid_state_hash_from'>state_hash_from</span><span class='lparen'>(</span><span class='id identifier rubyid_rp_hash'>rp_hash</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>doParcelStateResponse</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rparen'>)</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="parcel_parcel_id_from-instance_method">
+    #<strong>parcel_parcel_id_from</strong>(rp_hash)  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+31
+32
+33</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb', line 31</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_parcel_parcel_id_from'>parcel_parcel_id_from</span><span class='lparen'>(</span><span class='id identifier rubyid_rp_hash'>rp_hash</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_rp_hash'>rp_hash</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>recordNumber</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="parcels_data_hash-instance_method">
+    #<strong>parcels_data_hash</strong>  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+12
+13
+14
+15
+16
+17</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb', line 12</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_parcels_data_hash'>parcels_data_hash</span>
+  <span class='id identifier rubyid_response_parcel_hashes'>response_parcel_hashes</span><span class='period'>.</span><span class='id identifier rubyid_each_with_object'>each_with_object</span><span class='lparen'>(</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_rp_hash'>rp_hash</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='op'>|</span>
+    <span class='id identifier rubyid_parcel_id'>parcel_id</span> <span class='op'>=</span> <span class='id identifier rubyid_parcel_parcel_id_from'>parcel_parcel_id_from</span><span class='lparen'>(</span><span class='id identifier rubyid_rp_hash'>rp_hash</span><span class='rparen'>)</span>
+    <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='id identifier rubyid_parcel_id'>parcel_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_updated_result_value_for'>updated_result_value_for</span><span class='lparen'>(</span><span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='id identifier rubyid_parcel_id'>parcel_id</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_rp_hash'>rp_hash</span><span class='rparen'>)</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="response_parcel_hashes-instance_method">
+    #<strong>response_parcel_hashes</strong>  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+27
+28
+29</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb', line 27</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_response_parcel_hashes'>response_parcel_hashes</span>
+  <span class='lbracket'>[</span><span class='id identifier rubyid_response_root_node'>response_root_node</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>doParcelParamResult</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span> <span class='comment'># to always get array of hash(es)
+</span><span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="response_root_node_name-instance_method">
+    #<strong>response_root_node_name</strong>  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb', line 19</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_response_root_node_name'>response_root_node_name</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>getResultParcelsResponse</span><span class='tstring_end'>&#39;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="response_state_response-instance_method">
+    #<strong>response_state_response</strong>  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb', line 23</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_response_state_response'>response_state_response</span>
+  <span class='id identifier rubyid_response_root_node'>response_root_node</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>doParcelHeaderResult</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>doParcelStateResponse</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="updated_result_value_for-instance_method">
+    #<strong>updated_result_value_for</strong>(value, parcel_params_result_hash)  &#x21d2; <tt>Object</tt>
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+40
+41
+42
+43
+44
+45
+46
+47
+48
+49
+50
+51
+52
+53</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/czech_post_b2b_client/response_parsers/get_result_parcels_parser.rb', line 40</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_updated_result_value_for'>updated_result_value_for</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='comma'>,</span> <span class='id identifier rubyid_parcel_params_result_hash'>parcel_params_result_hash</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_pd_hash'>pd_hash</span><span class='op'>=</span><span class='id identifier rubyid_parcel_data_from'>parcel_data_from</span><span class='lparen'>(</span><span class='id identifier rubyid_parcel_params_result_hash'>parcel_params_result_hash</span><span class='rparen'>)</span>
+  <span class='kw'>return</span> <span class='id identifier rubyid_pd_hash'>pd_hash</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
+  <span class='comment'># more doParcelParamsResult nodes for one parcel_id =&gt; probably errors
+</span>  <span class='id identifier rubyid_old_p_code'>old_p_code</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span><span class='lbracket'>[</span><span class='symbol'>:parcel_code</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_new_p_code'>new_p_code</span> <span class='op'>=</span> <span class='id identifier rubyid_pd_hash'>pd_hash</span><span class='lbracket'>[</span><span class='symbol'>:parcel_code</span><span class='rbracket'>]</span>
+  <span class='id identifier rubyid_value'>value</span><span class='lbracket'>[</span><span class='symbol'>:states</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='lbracket'>[</span><span class='symbol'>:states</span><span class='rbracket'>]</span> <span class='op'>+</span> <span class='id identifier rubyid_pd_hash'>pd_hash</span><span class='lbracket'>[</span><span class='symbol'>:states</span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_sort'>sort</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='id identifier rubyid_b'>b</span><span class='op'>|</span> <span class='id identifier rubyid_a'>a</span><span class='lbracket'>[</span><span class='symbol'>:code</span><span class='rbracket'>]</span> <span class='op'>&lt;=&gt;</span> <span class='id identifier rubyid_b'>b</span><span class='lbracket'>[</span><span class='symbol'>:code</span><span class='rbracket'>]</span> <span class='rbrace'>}</span>
+  <span class='id identifier rubyid_raise'>raise</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Two different parcel_codes [</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_old_p_code'>old_p_code</span><span class='embexpr_end'>}</span><span class='tstring_content'>, </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_new_p_code'>new_p_code</span><span class='embexpr_end'>}</span><span class='tstring_content'>] for parcel_id:&#39;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_parcel_id'>parcel_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>&#39;</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_old_p_code'>old_p_code</span> <span class='op'>!=</span> <span class='id identifier rubyid_new_p_code'>new_p_code</span>
+  <span class='id identifier rubyid_value'>value</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Fri Mar 20 17:49:10 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>