matteolc/t2_airtime

View on GitHub
rdoc/T2Airtime/Country.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>

<html>
<head>
<meta charset="UTF-8">

<title>class T2Airtime::Country - T2Airtime</title>

<script type="text/javascript">
  var rdoc_rel_prefix = "../";
</script>

<script src="../js/jquery.js"></script>
<script src="../js/darkfish.js"></script>

<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">



<body id="top" role="document" class="class">
<nav role="navigation">
  <div id="project-navigation">
    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2>
    <a href="../index.html" rel="home">Home</a>
  </h2>

  <div id="table-of-contents-navigation">
    <a href="../table_of_contents.html#pages">Pages</a>
    <a href="../table_of_contents.html#classes">Classes</a>
    <a href="../table_of_contents.html#methods">Methods</a>
  </div>
</div>

    <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

  </div>

  

  <div id="class-metadata">
    
    <div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

  
  <p class="link">Object
  
</div>

    
    
    <!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    
    <li ><a href="#method-c-alpha3">::alpha3</a>
    
    <li ><a href="#method-c-normalize">::normalize</a>
    
    <li ><a href="#method-c-register_alpha3">::register_alpha3</a>
    
    <li ><a href="#method-c-serialize">::serialize</a>
    
    <li ><a href="#method-c-take">::take</a>
    
  </ul>
</div>

  </div>
</nav>

<main role="main" aria-labelledby="class-T2Airtime::Country">
  <h1 id="class-T2Airtime::Country" class="class">
    class T2Airtime::Country
  </h1>

  <section class="description">
    
  </section>

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    

    

    
     <section id="public-class-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Class Methods</h3>
       </header>

    
      <div id="method-c-alpha3" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">alpha3</span><span
            class="method-args">(name)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="alpha3-source">
            <pre><span class="ruby-comment"># File lib/t2_airtime/serializer.rb, line 60</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">alpha3</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-identifier">alpha3</span> = <span class="ruby-constant">ISO3166</span><span class="ruby-operator">::</span><span class="ruby-constant">Country</span>.<span class="ruby-identifier">find_country_by_name</span>(<span class="ruby-identifier">name</span>).<span class="ruby-identifier">try</span>(<span class="ruby-value">:alpha3</span>)
  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">alpha3</span>           
    <span class="ruby-identifier">alpha3</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">name</span>
    <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;Saint Vincent Grenadines&#39;</span>
      <span class="ruby-string">&#39;VCT&#39;</span>;
    <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;Kosovo&#39;</span>
      <span class="ruby-string">&#39;UNK&#39;</span>
    <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;Netherlands Antilles&#39;</span>
      <span class="ruby-string">&#39;ANT&#39;</span>
    <span class="ruby-keyword">when</span> <span class="ruby-string">&#39;Serbia and Montenegro&#39;</span>
      <span class="ruby-string">&#39;SCG&#39;</span>
    <span class="ruby-keyword">end</span>        
    <span class="ruby-identifier">register_alpha3</span>(<span class="ruby-identifier">alpha3</span>, <span class="ruby-identifier">name</span>) <span class="ruby-keyword">if</span> <span class="ruby-node">%w(VCT UNK ANT SCG)</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">alpha3</span>)
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">alpha3</span> <span class="ruby-operator">||</span> <span class="ruby-string">&quot;XXX&quot;</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-c-normalize" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">normalize</span><span
            class="method-args">(name)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="normalize-source">
            <pre><span class="ruby-comment"># File lib/t2_airtime/serializer.rb, line 56</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">normalize</span>(<span class="ruby-identifier">name</span>)
   <span class="ruby-identifier">name</span>.<span class="ruby-identifier">starts_with?</span>(<span class="ruby-string">&quot;St&quot;</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">name</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-string">&quot;St&quot;</span>, <span class="ruby-string">&quot;Saint&quot;</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">name</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-c-register_alpha3" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">register_alpha3</span><span
            class="method-args">(alpha3, name)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="register_alpha3-source">
            <pre><span class="ruby-comment"># File lib/t2_airtime/serializer.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">register_alpha3</span>(<span class="ruby-identifier">alpha3</span>, <span class="ruby-identifier">name</span>)
    <span class="ruby-constant">ISO3166</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">register</span>(
      <span class="ruby-identifier">alpha2</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;XX&#39;</span>,
      <span class="ruby-identifier">alpha3</span><span class="ruby-operator">:</span> <span class="ruby-identifier">alpha3</span>,
      <span class="ruby-identifier">name</span><span class="ruby-operator">:</span> <span class="ruby-identifier">name</span>
    ) 
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-c-serialize" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">serialize</span><span
            class="method-args">(data, ts="</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="serialize-source">
            <pre><span class="ruby-comment"># File lib/t2_airtime/serializer.rb, line 34</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">serialize</span>(<span class="ruby-identifier">data</span>, <span class="ruby-identifier">ts</span>=<span class="ruby-node">&quot;#{Time.zone.now}&quot;</span>, <span class="ruby-identifier">qty</span>=<span class="ruby-keyword">nil</span>)
    <span class="ruby-keyword">return</span> [] <span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>[<span class="ruby-value">:countryid</span>].<span class="ruby-identifier">nil?</span>
    <span class="ruby-identifier">names</span> = <span class="ruby-identifier">data</span>[<span class="ruby-value">:country</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">&quot;,&quot;</span>) 
    <span class="ruby-identifier">ids</span> = <span class="ruby-identifier">data</span>[<span class="ruby-value">:countryid</span>].<span class="ruby-identifier">split</span>(<span class="ruby-string">&quot;,&quot;</span>)
    <span class="ruby-identifier">ids</span>.<span class="ruby-identifier">take</span>(<span class="ruby-identifier">qty</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">ids</span>.<span class="ruby-identifier">count</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">qty</span>).<span class="ruby-identifier">each_with_index</span>.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">id</span>, <span class="ruby-identifier">n</span><span class="ruby-operator">|</span> {
      <span class="ruby-identifier">type</span><span class="ruby-operator">:</span> <span class="ruby-string">&quot;countries&quot;</span>,
      <span class="ruby-identifier">id</span><span class="ruby-operator">:</span> <span class="ruby-constant">Integer</span>(<span class="ruby-identifier">id</span>),
      <span class="ruby-identifier">attributes</span><span class="ruby-operator">:</span> {
        <span class="ruby-string">&quot;name&quot;</span><span class="ruby-operator">:</span> <span class="ruby-identifier">names</span>[<span class="ruby-identifier">n</span>], 
        <span class="ruby-string">&quot;alpha3&quot;</span><span class="ruby-operator">:</span> <span class="ruby-identifier">alpha3</span>(<span class="ruby-identifier">names</span>[<span class="ruby-identifier">n</span>]),
        <span class="ruby-string">&quot;fetched-at&quot;</span><span class="ruby-operator">:</span> <span class="ruby-constant">T2Airtime</span><span class="ruby-operator">::</span><span class="ruby-constant">Util</span>.<span class="ruby-identifier">format_time</span>(<span class="ruby-identifier">ts</span>)
      },
      <span class="ruby-identifier">relationships</span><span class="ruby-operator">:</span> {
        <span class="ruby-identifier">operators</span><span class="ruby-operator">:</span> {
          <span class="ruby-identifier">links</span><span class="ruby-operator">:</span> {
            <span class="ruby-identifier">related</span><span class="ruby-operator">:</span> <span class="ruby-node">&quot;/countries/#{id}/operators&quot;</span>
          }
        }
      }
    }}.<span class="ruby-identifier">as_json</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
      <div id="method-c-take" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">take</span><span
            class="method-args">(qty=5)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>
        

        <div class="method-description">
          
          
          
          

          
          <div class="method-source-code" id="take-source">
            <pre><span class="ruby-comment"># File lib/t2_airtime/serializer.rb, line 29</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">take</span>(<span class="ruby-identifier">qty</span>=<span class="ruby-value">5</span>)
    <span class="ruby-identifier">reply</span> = <span class="ruby-constant">T2Airtime</span><span class="ruby-operator">::</span><span class="ruby-constant">API</span>.<span class="ruby-identifier">api</span>.<span class="ruby-identifier">country_list</span>
    <span class="ruby-identifier">reply</span>.<span class="ruby-identifier">success?</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">serialize</span>(<span class="ruby-identifier">reply</span>.<span class="ruby-identifier">data</span>, <span class="ruby-identifier">reply</span>.<span class="ruby-identifier">headers</span>[<span class="ruby-value">:date</span>], <span class="ruby-identifier">qty</span>) <span class="ruby-operator">:</span> []
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

        

        
      </div>

    
    </section>
  
  </section>
</main>


<footer id="validator-badges" role="contentinfo">
  <p><a href="http://validator.w3.org/check/referer">Validate</a>
  <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.1.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>