added docs files

im-blx · Dec 18, 2017 · 3c029fa · 3c029fa
1 parent d047cb6
commit 3c029fa
Show file tree

Hide file tree

Showing 20 changed files with 390 additions and 36 deletions.
diff --git a/doc/.build b/doc/.build
@@ -4,7 +4,7 @@ fonts/icomoon.eot
 fonts/icomoon.svg
 fonts/icomoon.ttf
 fonts/icomoon.woff
-dist/sidebar_items-59b49ae195.js
+dist/sidebar_items-a31106edb0.js
 api-reference.html
 search.html
 404.html

diff --git a/doc/404.html b/doc/404.html
@@ -8,7 +8,7 @@
     <title>404 – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 

diff --git a/doc/Kuber.Hex.Adapter.html b/doc/Kuber.Hex.Adapter.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Adapter – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 
@@ -71,6 +71,15 @@ <h1>
       </h1>
 
 
+        <section id="moduledoc">
+          <p>Adapter module is currently holding the validation part.</p>
+<p>This modules is being <code class="inline">used</code> by all the payment gateways and raises a run-time 
+error for the missing configurations which are passed by the gateways to 
+<code class="inline">validate_config</code> method.</p>
+<p>Raises an exception <a href="https://hexdocs.pm/elixir/ArgumentError.html"><code class="inline">ArgumentError</code></a> if the config is not as per the <code class="inline">@required_config</code></p>
+
+        </section>
+
 
 
 

diff --git a/doc/Kuber.Hex.Address.html b/doc/Kuber.Hex.Address.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Address – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 

diff --git a/doc/Kuber.Hex.Application.html b/doc/Kuber.Hex.Application.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Application – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 

diff --git a/doc/Kuber.Hex.CreditCard.html b/doc/Kuber.Hex.CreditCard.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.CreditCard – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 
@@ -71,6 +71,28 @@ <h1>
       </h1>
 
 
+        <section id="moduledoc">
+          <p>CreditCard module defines the struct for the credit cards. </p>
+<p>It mostly has fields such as:-</p>
+<ul>
+<li><code class="inline">number</code>: Credit card number
+</li>
+<li><code class="inline">month</code>: Expiry month
+</li>
+<li><code class="inline">year</code>: Expiration year
+</li>
+<li><code class="inline">first_name</code>: First name of the card holder
+</li>
+<li><code class="inline">last_name</code>: Last of the card holder
+</li>
+<li><code class="inline">verification_code</code>: 3/4 digit code at the back of the card
+</li>
+<li><code class="inline">brand</code>: VISA/MASTERCARD/MAESTRO/RUPAY etc.
+</li>
+</ul>
+
+        </section>
+
 
 
 

diff --git a/doc/Kuber.Hex.Gateways.AuthorizeNet.html b/doc/Kuber.Hex.Gateways.AuthorizeNet.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Gateways.AuthorizeNet – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 
@@ -167,6 +167,9 @@ <h2>
     <a href="#validate_config/1">validate_config(config)</a>
   </div>
 
+    <div class="summary-synopsis"><p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+</div>
+
 </div>
 <div class="summary-row">
   <div class="summary-signature">
@@ -376,7 +379,8 @@ <h1 class="section-heading">
 
   </div>
   <section class="docstring">
-
+    <p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+
   </section>
 </div>
 <div class="detail" id="void/2">

diff --git a/doc/Kuber.Hex.Gateways.Base.html b/doc/Kuber.Hex.Gateways.Base.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Gateways.Base – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 

diff --git a/doc/Kuber.Hex.Gateways.Bogus.html b/doc/Kuber.Hex.Gateways.Bogus.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Gateways.Bogus – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 

diff --git a/doc/Kuber.Hex.Gateways.Cams.html b/doc/Kuber.Hex.Gateways.Cams.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Gateways.Cams – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 
@@ -176,6 +176,9 @@ <h2>
     <a href="#validate_config/1">validate_config(config)</a>
   </div>
 
+    <div class="summary-synopsis"><p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+</div>
+
 </div>
 <div class="summary-row">
   <div class="summary-signature">
@@ -381,7 +384,8 @@ <h1 class="section-heading">
 
   </div>
   <section class="docstring">
-
+    <p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+
   </section>
 </div>
 <div class="detail" id="verify/2">

diff --git a/doc/Kuber.Hex.Gateways.Monei.html b/doc/Kuber.Hex.Gateways.Monei.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Gateways.Monei – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 
@@ -272,6 +272,9 @@ <h2>
     <a href="#validate_config/1">validate_config(config)</a>
   </div>
 
+    <div class="summary-synopsis"><p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+</div>
+
 </div>
 <div class="summary-row">
   <div class="summary-signature">
@@ -563,7 +566,8 @@ <h3 id="store/2-note" class="section-heading">
 
   </div>
   <section class="docstring">
-
+    <p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+
   </section>
 </div>
 <div class="detail" id="void/2">

diff --git a/doc/Kuber.Hex.Gateways.Paymill.html b/doc/Kuber.Hex.Gateways.Paymill.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Gateways.Paymill – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 
@@ -165,6 +165,9 @@ <h2>
     <a href="#validate_config/1">validate_config(config)</a>
   </div>
 
+    <div class="summary-synopsis"><p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+</div>
+
 </div>
 <div class="summary-row">
   <div class="summary-signature">
@@ -410,7 +413,8 @@ <h1 class="section-heading">
 
   </div>
   <section class="docstring">
-
+    <p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+
   </section>
 </div>
 <div class="detail" id="void/2">

diff --git a/doc/Kuber.Hex.Gateways.Stripe.html b/doc/Kuber.Hex.Gateways.Stripe.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Gateways.Stripe – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 
@@ -181,6 +181,9 @@ <h2>
     <a href="#validate_config/1">validate_config(config)</a>
   </div>
 
+    <div class="summary-synopsis"><p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+</div>
+
 </div>
 <div class="summary-row">
   <div class="summary-signature">
@@ -484,7 +487,8 @@ <h2 id="unstore/2-examples" class="section-heading">
 
   </div>
   <section class="docstring">
-
+    <p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+
   </section>
 </div>
 <div class="detail" id="void/2">

diff --git a/doc/Kuber.Hex.Gateways.WireCard.html b/doc/Kuber.Hex.Gateways.WireCard.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Gateways.WireCard – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 
@@ -221,6 +221,9 @@ <h2>
     <a href="#validate_config/1">validate_config(config)</a>
   </div>
 
+    <div class="summary-synopsis"><p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+</div>
+
 </div>
 <div class="summary-row">
   <div class="summary-signature">
@@ -542,7 +545,8 @@ <h1 class="section-heading">
 
   </div>
   <section class="docstring">
-
+    <p>Validates the config dynamically depending on what is the value of <code class="inline">required_config</code></p>
+
   </section>
 </div>
 <div class="detail" id="void/2">

diff --git a/doc/Kuber.Hex.Response.html b/doc/Kuber.Hex.Response.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Response – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 
@@ -71,6 +71,13 @@ <h1>
       </h1>
 
 
+        <section id="moduledoc">
+          <p>Module which defines the struct for response struct.</p>
+<p>Response struct is a standard response from public API to the application.</p>
+<p>TODO: Add the response struct detail about the attributes in the struct</p>
+
+        </section>
+
 
 
         <section id="summary" class="details-list">

diff --git a/doc/Kuber.Hex.Worker.html b/doc/Kuber.Hex.Worker.html
@@ -8,7 +8,7 @@
     <title>Kuber.Hex.Worker – kuber_hex v0.0.2</title>
     <link rel="stylesheet" href="dist/app-c922dbe7ef.css" />
 
-    <script src="dist/sidebar_items-59b49ae195.js"></script>
+    <script src="dist/sidebar_items-a31106edb0.js"></script>
 
 
 
@@ -71,6 +71,19 @@ <h1>
       </h1>
 
 
+        <section id="moduledoc">
+          <p>A central supervised worker handling all the calls for different gateways</p>
+<p>It’s main task is to re-route the requests to the respective gateway methods.</p>
+<p>State for this worker currently is:-</p>
+<ul>
+<li><code class="inline">gateways</code>:- a list of all the gateways configured in the application.
+</li>
+<li><code class="inline">all_configs</code>:- All the configurations for all the gateways that are configured.
+</li>
+</ul>
+
+        </section>
+
 
 
         <section id="summary" class="details-list">
@@ -89,6 +102,15 @@ <h2>
       <a href="#functions">Functions</a>
     </h2>
     <div class="summary-row">
+  <div class="summary-signature">
+    <a href="#handle_call/3">handle_call(msg, from, state)</a>
+  </div>
+
+    <div class="summary-synopsis"><p>Handles call for ‘unstore’ method</p>
+</div>
+
+</div>
+<div class="summary-row">
   <div class="summary-signature">
     <a href="#start_link/3">start_link(gateways, all_config, opts \\ [])</a>
   </div>
@@ -114,7 +136,25 @@ <h1 class="section-heading">
             </a>
             Functions
           </h1>
-          <div class="detail" id="start_link/3">
+          <div class="detail" id="handle_call/3">
+
+
+  <div class="detail-header">
+    <a href="#handle_call/3" class="detail-link" title="Link to this function">
+      <span class="icon-link" aria-hidden="true"></span>
+      <span class="sr-only">Link to this function</span>
+    </a>
+    <span class="signature">handle_call(msg, from, state)</span>
+
+
+
+  </div>
+  <section class="docstring">
+    <p>Handles call for ‘unstore’ method</p>
+
+  </section>
+</div>
+<div class="detail" id="start_link/3">
 
 
     <span id="start_link/2"></span>