jylis-rb 0.1.0 → 0.2.0

data/doc/file.license.html

@@ -60,7 +60,7 @@
       <div id="content"><div id='filecontents'>The MIT License (MIT)<br/><br/>Copyright (c) 2018 Alex McLain<br/><br/>Permission is hereby granted, free of charge, to any person obtaining a copy<br/>of this software and associated documentation files (the &quot;Software&quot;), to deal<br/>in the Software without restriction, including without limitation the rights<br/>to use, copy, modify, merge, publish, distribute, sublicense, and/or sell<br/>copies of the Software, and to permit persons to whom the Software is<br/>furnished to do so, subject to the following conditions:<br/><br/>The above copyright notice and this permission notice shall be included in<br/>all copies or substantial portions of the Software.<br/><br/>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR<br/>IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,<br/>FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE<br/>AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER<br/>LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,<br/>OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN<br/>THE SOFTWARE.</div></div>
 
       <div id="footer">
-  Generated on Sun Jun  3 21:46:59 2018 by
+  Generated on Tue Jun  5 17:01:51 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.14 (ruby-2.5.1).
 </div>

data/doc/index.html

@@ -118,7 +118,7 @@ $ cd jylis-rb
 
 <p>Ensure the tests pass:</p>
 
-<pre class="code ruby"><code class="ruby">$ rake
+<pre class="code ruby"><code class="ruby">$ bundle exec rake
 </code></pre>
 
 <p>Install the gem from the working source code:</p>
@@ -258,9 +258,9 @@ for the exact format of your particular query.</p>
 <p>Unordered JSON
 &lt;sup>[link[https://jemc.github.io/jylis/docs/types/ujson/]]</sup&gt;</p>
 
-<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/UJSON.html#set-instance_method" title="Jylis::DataType::UJSON#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>alice</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>admin</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='kw'>false</span>
-<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/UJSON.html#set-instance_method" title="Jylis::DataType::UJSON#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>brett</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>admin</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='kw'>false</span>
-<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/UJSON.html#set-instance_method" title="Jylis::DataType::UJSON#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>carol</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>admin</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='kw'>true</span>
+<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/UJSON.html#set-instance_method" title="Jylis::DataType::UJSON#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>alice</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>admin</span><span class='label_end'>&quot;:</span> <span class='kw'>false</span><span class='rbrace'>}</span>
+<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/UJSON.html#set-instance_method" title="Jylis::DataType::UJSON#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>brett</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>admin</span><span class='label_end'>&quot;:</span> <span class='kw'>false</span><span class='rbrace'>}</span>
+<span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/UJSON.html#set-instance_method" title="Jylis::DataType::UJSON#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>carol</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>admin</span><span class='label_end'>&quot;:</span> <span class='kw'>true</span><span class='rbrace'>}</span>
 
 <span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_ujson'><span class='object_link'><a href="Jylis.html#ujson-class_method" title="Jylis.ujson (method)">ujson</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Jylis/DataType/UJSON.html#get-instance_method" title="Jylis::DataType::UJSON#get (method)">get</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>users</span><span class='tstring_end'>&quot;</span></span>
 <span class='comment'># =&gt; {&quot;brett&quot;=&gt;{&quot;admin&quot;=&gt;false}, &quot;carol&quot;=&gt;{&quot;admin&quot;=&gt;true}, &quot;alice&quot;=&gt;{&quot;admin&quot;=&gt;false}}
@@ -287,10 +287,31 @@ data.</p>
 <span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_query'><span class='object_link'><a href="Jylis.html#query-class_method" title="Jylis.query (method)">query</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>TLOG</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>GET</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>temperature</span><span class='tstring_end'>&quot;</span></span>
 <span class='comment'># =&gt; [[&quot;72.6&quot;, 5]]
 </span></code></pre>
+
+<h3 id="label-Timestamps">Timestamps</h3>
+
+<p>In addition to supporting integer timestamps as defined by the Jylis spec,
+this library also has helpers to convert the Jylis <code>Timestamped</code>
+data types to/from ISO 8601. Functions that have a <code>timestamp</code>
+parameter will automatically convert an ISO 8601 string to a Unix
+timestamp.</p>
+
+<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_treg'><span class='object_link'><a href="Jylis.html#treg-class_method" title="Jylis.treg (method)">treg</a></span></span><span class='period'>.</span><span class='id identifier rubyid_set'><span class='object_link'><a href="Jylis/DataType/TREG.html#set-instance_method" title="Jylis::DataType::TREG#set (method)">set</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>volume</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='int'>64</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>2018-06-06T01:42:57Z</span><span class='tstring_end'>&quot;</span></span>
+
+<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Jylis.html" title="Jylis (class)">Jylis</a></span></span><span class='period'>.</span><span class='id identifier rubyid_treg'><span class='object_link'><a href="Jylis.html#treg-class_method" title="Jylis.treg (method)">treg</a></span></span><span class='period'>.</span><span class='id identifier rubyid_get'><span class='object_link'><a href="Jylis/DataType/TREG.html#get-instance_method" title="Jylis::DataType::TREG#get (method)">get</a></span></span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>volume</span><span class='tstring_end'>&quot;</span></span>
+<span class='comment'># =&gt; #&lt;Jylis::DataType::TREG::Result:0x00005609aa767f00 @timestamp=1528249377, @value=&quot;64&quot;&gt;
+</span>
+<span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_timestamp'>timestamp</span>
+<span class='comment'># =&gt; 1528249377
+</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_time'>time</span>
+<span class='comment'># =&gt; 2018-06-05 18:42:57 -0700
+</span><span class='id identifier rubyid_result'>result</span><span class='period'>.</span><span class='id identifier rubyid_timestamp_iso8601'>timestamp_iso8601</span>
+<span class='comment'># =&gt; &quot;2018-06-06T01:42:57Z&quot;
+</span></code></pre>
 </div></div>
 
       <div id="footer">
-  Generated on Sun Jun  3 21:46:59 2018 by
+  Generated on Tue Jun  5 17:01:51 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.14 (ruby-2.5.1).
 </div>

data/doc/method_list.html

@@ -436,6 +436,22 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Jylis/DataType/TLOG/Row.html#time-instance_method" title="Jylis::DataType::TLOG::Row#time (method)">#time</a></span>
+      <small>Jylis::DataType::TLOG::Row</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Jylis/DataType/TREG/Result.html#time-instance_method" title="Jylis::DataType::TREG::Result#time (method)">#time</a></span>
+      <small>Jylis::DataType::TREG::Result</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Jylis/DataType/TLOG/Row.html#timestamp-instance_method" title="Jylis::DataType::TLOG::Row#timestamp (method)">#timestamp</a></span>
@@ -452,6 +468,22 @@
   </li>
   
 
+  <li class="even ">
+    <div class="item">
+      <span class='object_link'><a href="Jylis/DataType/TLOG/Row.html#timestamp_iso8601-instance_method" title="Jylis::DataType::TLOG::Row#timestamp_iso8601 (method)">#timestamp_iso8601</a></span>
+      <small>Jylis::DataType::TLOG::Row</small>
+    </div>
+  </li>
+  
+
+  <li class="odd ">
+    <div class="item">
+      <span class='object_link'><a href="Jylis/DataType/TREG/Result.html#timestamp_iso8601-instance_method" title="Jylis::DataType::TREG::Result#timestamp_iso8601 (method)">#timestamp_iso8601</a></span>
+      <small>Jylis::DataType::TREG::Result</small>
+    </div>
+  </li>
+  
+
   <li class="even ">
     <div class="item">
       <span class='object_link'><a href="Jylis.html#tlog-class_method" title="Jylis.tlog (method)">tlog</a></span>

data/doc/top-level-namespace.html

@@ -100,7 +100,7 @@
 </div>
 
       <div id="footer">
-  Generated on Sun Jun  3 21:46:59 2018 by
+  Generated on Tue Jun  5 17:01:51 2018 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.14 (ruby-2.5.1).
 </div>

data/lib/jylis-rb/data_types/tlog.rb

@@ -76,6 +76,16 @@ class Jylis
         def to_a
           [value, timestamp]
         end
+
+        # @return [Time] the timestamp as a {Time} object
+        def time
+          Time.at(timestamp)
+        end
+
+        # @return [String] the timestamp as an ISO8601 formatted string
+        def timestamp_iso8601
+          time.utc.iso8601
+        end
       end
 
       # Get the latest `value` and `timestamp` for the register at `key`.
@@ -101,8 +111,11 @@ class Jylis
       # end
 
       # Insert a `value`/`timestamp` entry into the log at `key`.
+      #
+      # @param timestamp [Integer, String] a unix or iso8601 formatted timestamp
       def ins(key, value, timestamp)
-        result = connection.query("TLOG", "INS", key, value, timestamp)
+        timestamp = Time.parse(timestamp).utc.to_i if timestamp.is_a?(String)
+        result    = connection.query("TLOG", "INS", key, value, timestamp)
 
         unless result == "OK"
           raise "Failed: TLOG INS #{key} #{value} #{timestamp}"
@@ -121,8 +134,11 @@ class Jylis
 
       # Raise the cutoff timestamp of the log, causing any entries to be
       # discarded whose timestamp is earlier than the newly given `timestamp`.
+      #
+      # @param timestamp [Integer, String] a unix or iso8601 formatted timestamp
       def trimat(key, timestamp)
-        result = connection.query("TLOG", "TRIMAT", key, timestamp)
+        timestamp = Time.parse(timestamp).utc.to_i if timestamp.is_a?(String)
+        result    = connection.query("TLOG", "TRIMAT", key, timestamp)
 
         unless result == "OK"
           raise "Failed: TLOG TRIMAT #{key} #{timestamp}"

data/lib/jylis-rb/data_types/treg.rb

@@ -33,6 +33,16 @@ class Jylis
         def to_a
           [value, timestamp]
         end
+
+        # @return [Time] the timestamp as a {Time} object
+        def time
+          Time.at(timestamp)
+        end
+
+        # @return [String] the timestamp as an ISO8601 formatted string
+        def timestamp_iso8601
+          time.utc.iso8601
+        end
       end
 
       # Get the latest `value` and `timestamp` for the register at `key`.
@@ -45,8 +55,11 @@ class Jylis
       end
 
       # Set a `value` and `timestamp` for the register at `key`.
+      #
+      # @param timestamp [Integer, String] a unix or iso8601 formatted timestamp
       def set(key, value, timestamp)
-        result = connection.query("TREG", "SET", key, value, timestamp)
+        timestamp = Time.parse(timestamp).utc.to_i if timestamp.is_a?(String)
+        result    = connection.query("TREG", "SET", key, value, timestamp)
 
         unless result == "OK"
           raise "Failed: TREG SET #{key} #{value} #{timestamp}"

data/lib/jylis-rb/jylis.rb

@@ -23,6 +23,8 @@ class Jylis
     # @return [Boolean] true if a connection to the current server is established
     # @see Jylis::Connection#connected?
     def connected?
+      return false unless current
+
       current.connected?
     end
 

data/lib/jylis-rb/version.rb

@@ -1,4 +1,4 @@
 class Jylis
   # Gem version.
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jylis-rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex McLain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-03 00:00:00.000000000 Z
+date: 2018-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiredis
@@ -152,6 +152,8 @@ files:
 - doc/Jylis/DataType/TREG.html
 - doc/Jylis/DataType/TREG/Result.html
 - doc/Jylis/DataType/UJSON.html
+- doc/Jylis/Helpers.html
+- doc/Jylis/Helpers/Timestamp.html
 - doc/_index.html
 - doc/class_list.html
 - doc/css/common.css