v1.1.0

- prepare v1.1.0
- update doc for CSV, YAML, JSOn output
- add tests for CSV, YAML, JSOn output

Author: noraj

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pass-station (1.0.0)
+    pass-station (1.1.0)
       docopt (~> 0.6)
       paint (~> 2.2)
 

docs/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [1.1.0]
+
+- **Feature**: add CSV, JSON, YAML formatting
+- Project quality: add unit tests & CI
+- Minor code and doc enhancements
+- Gemfile: fix version compatibility (was wrongly advertised as compatible with Ruby 2.4 and 2.5 but is only with Ruby 2.6+ due to some options of the CSV parser)
+
 ## [1.0.0]
 
 - First version

docs/pages/examples.md

@@ -93,3 +93,109 @@ Xerox WorkCentre 5020/DN (printer)                   11111
 IBM                                                  11111111                   11111111
 ...
 ```
+
+Search default credentials for Dell products outputting in YAML:
+
+```plaintext
+$ pass-station search dell --output yaml
+---
+- :productvendor: Dell
+  :username: admin
+  :password: admin
+- :productvendor: Dell
+  :username: Admin
+  :password: "<blank>"
+- :productvendor: Dell
+  :username: Administrator
+  :password: storageserver
+- :productvendor: Dell
+  :username: admin
+  :password: password
+- :productvendor: Dell
+  :username: "<blank>"
+  :password: 1RRWTTOOI
+- :productvendor: Dell
+  :username: "<blank>"
+  :password: admin
+- :productvendor: Dell
+  :username: "<blank>"
+  :password: Dell
+- :productvendor: Dell
+  :username: "<blank>"
+  :password: Fireport
+- :productvendor: Dell
+  :username: "<blank>"
+  :password: nz0u4bbe
+- :productvendor: Dell
+  :username: rapport
+  :password: r@p8p0r+
+- :productvendor: Dell
+  :username: root
+  :password: calvin
+- :productvendor: Dell
+  :username: root
+  :password: wyse
+- :productvendor: Dell
+  :username: VNC
+  :password: winterm
+- :productvendor: DELL IDARC (web)
+  :username: root
+  :password: calvin
+- :productvendor: Dell iDRAC (web)
+  :username: root
+  :password: calvin
+```
+
+Search default credentials for Draytek products outputting in JSON (with and without [jq][jq] formatting):
+
+```plaintext
+$ pass-station search Draytek --output json
+[{"productvendor":"Draytek","username":"admin","password":"admin"},{"productvendor":"Draytek","username":"admin","password":"<blank>"},{"productvendor":"Draytek","username":"draytek","password":"1234"},{"productvendor":"Draytek","username":"Draytek","password":"1234"},{"productvendor":"Draytek Corp","username":"admin","password":"<blank>"}]
+
+$ pass-station search Draytek --output json --no-color | jq
+[
+  {
+    "productvendor": "Draytek",
+    "username": "admin",
+    "password": "admin"
+  },
+  {
+    "productvendor": "Draytek",
+    "username": "admin",
+    "password": "<blank>"
+  },
+  {
+    "productvendor": "Draytek",
+    "username": "draytek",
+    "password": "1234"
+  },
+  {
+    "productvendor": "Draytek",
+    "username": "Draytek",
+    "password": "1234"
+  },
+  {
+    "productvendor": "Draytek Corp",
+    "username": "admin",
+    "password": "<blank>"
+  }
+]
+```
+
+[jq]:https://stedolan.github.io/jq/
+
+Search default credentials for Edimax products outputting in CSV:
+
+```plaintext
+$ pass-station search Edimax --output csv
+productvendor,username,password
+Edimax,admin,123
+Edimax,admin,1234
+Edimax,admin,<blank>
+Edimax,admin,epicrouter
+Edimax,admin,password
+Edimax,admin,su@psir
+Edimax,edimax,software01
+Edimax,guest,1234
+Edimax,guest,<blank>
+```

docs/yard/PassStation.html

@@ -137,7 +137,7 @@ <h3 class="inherited">Constants included
 </div>
 
       <div id="footer">
-  Generated on Tue Mar  9 09:14:06 2021 by
+  Generated on Mon Mar 15 11:11:44 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-2.7.2).
 </div>

docs/yard/PassStation/DB.html

@@ -141,7 +141,7 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collaps
       <li class="public ">
   <span class="summary_signature">
 
-      <a href="#data-instance_method" title="#data (instance method)">#<strong>data</strong>  &#x21d2; CSV::Table </a>
+      <a href="#data-instance_method" title="#data (instance method)">#<strong>data</strong>  &#x21d2; Array&lt;CSV::Row&gt; </a>
 
 
 
@@ -161,7 +161,7 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collaps
 
 
     <span class="summary_desc"><div class='inline'>
-<p>Get the password database in <code>CSV::Table</code> format.</p>
+<p>Get the password database in <tt>Array&lt;CSV::Row&gt;</tt> format.</p>
 </div></span>
 
 </li>
@@ -656,7 +656,7 @@ <h2>
         <li class="public ">
   <span class="summary_signature">
 
-      <a href="#parse-instance_method" title="#parse (instance method)">#<strong>parse</strong>(sort = :productvendor)  &#x21d2; CSV::Table </a>
+      <a href="#parse-instance_method" title="#parse (instance method)">#<strong>parse</strong>(sort = :productvendor)  &#x21d2; Array&lt;CSV::Row&gt; </a>
 
 
 
@@ -704,7 +704,7 @@ <h2>
         <li class="public ">
   <span class="summary_signature">
 
-      <a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(term, col, opts = {})  &#x21d2; CSV::Table </a>
+      <a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(term, col, opts = {})  &#x21d2; Array&lt;CSV::Row&gt; </a>
 
 
 
@@ -757,19 +757,19 @@ <h3 class="signature first" id="initialize-instance_method">
       <pre class="lines">
 
 
+30
+31
 32
 33
 34
 35
 36
 37
 38
-39
-40
-41</pre>
+39</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/pass_station.rb', line 32</span>
+      <pre class="code"><span class="info file"># File 'lib/pass_station.rb', line 30</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
   <span class='ivar'>@storage_location</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>data/</span><span class='tstring_end'>&#39;</span></span>
@@ -796,7 +796,7 @@ <h2>Instance Attribute Details</h2>
       <div class="method_details first">
   <h3 class="signature first" id="data-instance_method">
 
-    #<strong>data</strong>  &#x21d2; <tt>CSV::Table</tt>  <span class="extras">(readonly)</span>
+    #<strong>data</strong>  &#x21d2; <tt>Array&lt;CSV::Row&gt;</tt>  <span class="extras">(readonly)</span>
 
 
 
@@ -805,7 +805,7 @@ <h3 class="signature first" id="data-instance_method">
 </h3><div class="docstring">
   <div class="discussion">
 
-<p>Get the password database in <code>CSV::Table</code> format</p>
+<p>Get the password database in <tt>Array&lt;CSV::Row&gt;</tt> format</p>
 
 
   </div>
@@ -818,7 +818,7 @@ <h3 class="signature first" id="data-instance_method">
     <li>
 
 
-        <span class='type'>(<tt>CSV::Table</tt>)</span>
+        <span class='type'>(<tt>Array&lt;CSV::Row&gt;</tt>)</span>
 
 
 
@@ -837,12 +837,12 @@ <h3 class="signature first" id="data-instance_method">
       <pre class="lines">
 
 
-29
-30
-31</pre>
+27
+28
+29</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/pass_station.rb', line 29</span>
+      <pre class="code"><span class="info file"># File 'lib/pass_station.rb', line 27</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_data'>data</span>
   <span class='ivar'>@data</span>
@@ -898,12 +898,12 @@ <h3 class="signature " id="database_name-instance_method">
       <pre class="lines">
 
 
-25
-26
-27</pre>
+23
+24
+25</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/pass_station.rb', line 25</span>
+      <pre class="code"><span class="info file"># File 'lib/pass_station.rb', line 23</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_database_name'>database_name</span>
   <span class='ivar'>@database_name</span>
@@ -934,14 +934,6 @@ <h3 class="signature " id="storage_location-instance_method">
 </div>
 <div class="tags">
 
-  <div class="examples">
-    <p class="tag_title">Examples:</p>
-    
-      
-      <pre class="example code"><code><span class='const'><span class='object_link'><a href="../PassStation.html" title="PassStation (module)">PassStation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_storage_location'>storage_location</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/srv/downloads/</span><span class='tstring_end'>&#39;</span></span></code></pre>
-    
-  </div>
-
 <p class="tag_title">Returns:</p>
 <ul class="return">
 
@@ -967,12 +959,12 @@ <h3 class="signature " id="storage_location-instance_method">
       <pre class="lines">
 
 
-20
-21
-22</pre>
+18
+19
+20</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/pass_station.rb', line 20</span>
+      <pre class="code"><span class="info file"># File 'lib/pass_station.rb', line 18</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_storage_location'>storage_location</span>
   <span class='ivar'>@storage_location</span>
@@ -2022,15 +2014,15 @@ <h3 class="signature " id="database_exists?-instance_method">
       <pre class="lines">
 
 
+43
+44
 45
 46
 47
-48
-49
-50</pre>
+48</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/pass_station.rb', line 45</span>
+      <pre class="code"><span class="info file"># File 'lib/pass_station.rb', line 43</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_database_exists?'>database_exists?</span>
   <span class='id identifier rubyid_exists'>exists</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_file?'>file?</span><span class='lparen'>(</span><span class='ivar'>@database_path</span><span class='rparen'>)</span>
@@ -2281,7 +2273,7 @@ <h3 class="signature " id="output-instance_method">
         <span class='name'>data</span>
 
 
-        <span class='type'>(<tt>CSV::Table</tt>)</span>
+        <span class='type'>(<tt>Array&lt;CSV::Row&gt;</tt>)</span>
 
 
 
@@ -2498,7 +2490,7 @@ <h3 class="signature " id="output_search-instance_method">
       <div class="method_details ">
   <h3 class="signature " id="parse-instance_method">
 
-    #<strong>parse</strong>(sort = :productvendor)  &#x21d2; <tt>CSV::Table</tt> 
+    #<strong>parse</strong>(sort = :productvendor)  &#x21d2; <tt>Array&lt;CSV::Row&gt;</tt> 
 
 
 
@@ -2542,7 +2534,7 @@ <h3 class="signature " id="parse-instance_method">
     <li>
 
 
-        <span class='type'>(<tt>CSV::Table</tt>)</span>
+        <span class='type'>(<tt>Array&lt;CSV::Row&gt;</tt>)</span>
 
 
 
@@ -2571,7 +2563,7 @@ <h3 class="signature " id="parse-instance_method">
       <pre class="code"><span class="info file"># File 'lib/pass_station/parse.rb', line 28</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_sort'>sort</span> <span class='op'>=</span> <span class='symbol'>:productvendor</span><span class='rparen'>)</span>
-  <span class='ivar'>@data</span> <span class='op'>=</span> <span class='const'>CSV</span><span class='period'>.</span><span class='id identifier rubyid_table'>table</span><span class='lparen'>(</span><span class='ivar'>@database_path</span><span class='comma'>,</span> <span class='ivar'>@config</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_sort_by'>sort_by</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span>
+  <span class='ivar'>@data</span> <span class='op'>=</span> <span class='const'>CSV</span><span class='period'>.</span><span class='id identifier rubyid_table'>table</span><span class='lparen'>(</span><span class='ivar'>@database_path</span><span class='comma'>,</span> <span class='op'>**</span><span class='ivar'>@config</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_sort_by'>sort_by</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_s'>s</span><span class='op'>|</span>
     <span class='id identifier rubyid_s'>s</span><span class='lbracket'>[</span><span class='id identifier rubyid_sort'>sort</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span>
   <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
@@ -2637,7 +2629,7 @@ <h3 class="signature " id="prepare_search-instance_method">
       <div class="method_details ">
   <h3 class="signature " id="search-instance_method">
 
-    #<strong>search</strong>(term, col, opts = {})  &#x21d2; <tt>CSV::Table</tt> 
+    #<strong>search</strong>(term, col, opts = {})  &#x21d2; <tt>Array&lt;CSV::Row&gt;</tt> 
 
 
 
@@ -2695,7 +2687,7 @@ <h3 class="signature " id="search-instance_method">
     <li>
 
 
-        <span class='type'>(<tt>CSV::Table</tt>)</span>
+        <span class='type'>(<tt>Array&lt;CSV::Row&gt;</tt>)</span>
 
 
 
@@ -2751,7 +2743,7 @@ <h3 class="signature " id="search-instance_method">
 </div>
 
       <div id="footer">
-  Generated on Tue Mar  9 09:14:06 2021 by
+  Generated on Mon Mar 15 11:11:44 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-2.7.2).
 </div>

docs/yard/PassStation/Output.html

@@ -100,7 +100,7 @@ <h2>Overview</h2><div class="docstring">
 
 
 
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Output/PrettyTable.html" title="PassStation::Output::PrettyTable (class)">PrettyTable</a></span>, <span class='object_link'><a href="Output/Table.html" title="PassStation::Output::Table (class)">Table</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Output/Csv.html" title="PassStation::Output::Csv (class)">Csv</a></span>, <span class='object_link'><a href="Output/Json.html" title="PassStation::Output::Json (class)">Json</a></span>, <span class='object_link'><a href="Output/PrettyTable.html" title="PassStation::Output::PrettyTable (class)">PrettyTable</a></span>, <span class='object_link'><a href="Output/Table.html" title="PassStation::Output::Table (class)">Table</a></span>, <span class='object_link'><a href="Output/Yaml.html" title="PassStation::Output::Yaml (class)">Yaml</a></span>
 
 
 </p>
@@ -116,7 +116,7 @@ <h2>Overview</h2><div class="docstring">
 </div>
 
       <div id="footer">
-  Generated on Tue Mar  9 09:14:06 2021 by
+  Generated on Mon Mar 15 11:11:44 2021 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.26 (ruby-2.7.2).
 </div>