redis-time-series 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23852f9c6baca09369bbcce49642070c13d1212ba2ca9e7eec93dd691702eb72
-  data.tar.gz: 9edac086b6fc8119382bac0777160d96279df597cdf7cb4f84d27a36532118d2
+  metadata.gz: 51234a8f3542da255912f95982ebab2bf66dd657da9e38e55afdedd97029685d
+  data.tar.gz: 42a49fdafb136d8ebe4b094f935b0427430672ab810691a35ca2f78328d92135
 SHA512:
-  metadata.gz: c8efbc6e6426d316715fc134f71d5d2d7bc334ac2d088340eba39d050185fdbd5cbf2a8d7c6cd80274e9bb3b53766905c30124d551b0d5b863180cb12c89eec0
-  data.tar.gz: 5a1d988f13fbace8a269b7156fea1858072a15d030439fbad38e2dfcf720503c71182267d424c5557f8bacf61305975c75c35ad2050c8e307c3b46fb8dc8b5f8
+  metadata.gz: acc08d1745cf24bfc87c22d3809570daa0b2feae4e5d5b97d4a43a0626217b44ea3ffdb12c3f6799c068bb6e62f0cc7a1b65274e5d8eac5cb13017bfea73dff4
+  data.tar.gz: 1ff7aa6fb44dd2729612ac24e2be45496d45bd5a0fc86ed692bd18c38bcb160971c0efed05e598ffabb6471cf4d6903d303a1d0b74e55672c479829b98b26012

data/.github/workflows/rspec.yml

@@ -5,6 +5,8 @@ on:
     branches: [ master ]
   pull_request:
     branches: [ master ]
+  schedule:
+    - cron:  '0 0 * * *'
 
 jobs:
   spec:

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+## 0.2.0
+* Converted `#info` to a struct instead of a hash.
+* Added methods on time series for getting info attributes.
+
 ## 0.1.1
 Fix setting labels on `TS.CREATE` and `TS.ALTER`
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-time-series (0.1.0)
+    redis-time-series (0.1.1)
       redis (~> 4.0)
 
 GEM
@@ -24,7 +24,7 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     rake (13.0.1)
-    redis (4.1.4)
+    redis (4.2.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)

data/README.md

@@ -133,16 +133,31 @@ ts.range from: 10.minutes.ago, to: Time.current # Time range as keyword args
 Get info about the series
 ```ruby
 ts.info
-=> {"total_samples"=>3,
- "memory_usage"=>4184,
- "first_timestamp"=>1593155422582,
- "last_timestamp"=>1593155709333,
- "retention_time"=>0,
- "chunk_count"=>1,
- "max_samples_per_chunk"=>256,
- "labels"=>[],
- "source_key"=>nil,
- "rules"=>[]}
+=> #<struct Redis::TimeSeries::Info
+ total_samples=3,
+ memory_usage=4184,
+ first_timestamp=1594060993011,
+ last_timestamp=1594060993060,
+ retention_time=0,
+ chunk_count=1,
+ max_samples_per_chunk=256,
+ labels={"foo"=>"bar"},
+ source_key=nil,
+ rules=[]>
+# Each info property is also a method on the time series object
+ts.memory_usage
+=> 4208
+ts.labels
+=> {"foo"=>"bar"}
+ts.total_samples
+=> 3
+# Total samples also available as #count, #length, and #size
+ts.count
+=> 3
+ts.length
+=> 3
+ts.size
+=> 3
 ```
 
 ### TODO

data/bin/console

@@ -14,7 +14,7 @@ Redis.current.flushall
 
 @series = [@ts1, @ts2, @ts3]
 @series.each do |ts|
-  3.times { ts.increment }
+  3.times { ts.increment; sleep 0.01 }
 end
 
 Pry.start

data/lib/redis-time-series.rb

@@ -1,8 +1,10 @@
 require 'bigdecimal'
+require 'forwardable'
 require 'time/msec'
+require 'redis/time_series/info'
 require 'redis/time_series'
 require 'redis/time_series/sample'
 
 class RedisTimeSeries
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/redis/time_series.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 class Redis
   class TimeSeries
+    extend Forwardable
+
     class << self
       def create(key, **options)
-        new(key, **options).create
+        new(key, **options).create(labels: options[:labels])
       end
 
       def madd(data)
@@ -40,12 +42,10 @@ class Redis
       end
     end
 
-    attr_reader :key, :labels, :redis, :retention, :uncompressed
+    attr_reader :key, :redis, :retention, :uncompressed
 
     def initialize(key, options = {})
       @key = key
-      # TODO: read labels from redis if not loaded in memory
-      @labels = options[:labels] || []
       @redis = options[:redis] || self.class.redis
       @retention = options[:retention]
       @uncompressed = options[:uncompressed] || false
@@ -57,11 +57,11 @@ class Redis
       Sample.new(ts, value)
     end
 
-    def create
+    def create(labels: nil)
       args = [key]
       args << ['RETENTION', retention] if retention
       args << 'UNCOMPRESSED' if uncompressed
-      args << ['LABELS', labels.to_a] if labels.any?
+      args << ['LABELS', labels.to_a] if labels&.any?
       cmd 'TS.CREATE', args.flatten
       self
     end
@@ -91,17 +91,14 @@ class Redis
     end
     alias increment incrby
 
-    # TODO: extract Info module, with methods for each property
     def info
-      cmd('TS.INFO', key).each_slice(2).reduce({}) do |h, (key, value)|
-        h[key.gsub(/(.)([A-Z])/,'\1_\2').downcase] = value
-        h
-      end
+      cmd('TS.INFO', key).then(&Info.method(:parse))
     end
+    def_delegators :info, *Info.members
+    %i[count length size].each { |m| def_delegator :info, :total_samples, m }
 
     def labels=(val)
-      @labels = val
-      cmd 'TS.ALTER', key, 'LABELS', labels.to_a.flatten
+      cmd 'TS.ALTER', key, 'LABELS', val.to_a.flatten
     end
 
     def madd(*values)

data/lib/redis/time_series/info.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+class Redis
+  class TimeSeries
+    Info = Struct.new(
+      :total_samples,
+      :memory_usage,
+      :first_timestamp,
+      :last_timestamp,
+      :retention_time,
+      :chunk_count,
+      :max_samples_per_chunk,
+      :labels,
+      :source_key,
+      :rules,
+      keyword_init: true
+    ) do
+      def self.parse(raw_array)
+        raw_array.each_slice(2).reduce({}) do |h, (key, value)|
+          # Convert camelCase info keys to snake_case
+          h[key.gsub(/(.)([A-Z])/,'\1_\2').downcase] = value
+          h
+        end.then do |parsed_hash|
+          parsed_hash['labels'] = parsed_hash['labels'].to_h
+          new(parsed_hash)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-time-series
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Duszynski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -114,6 +114,7 @@ files:
 - bin/setup
 - lib/redis-time-series.rb
 - lib/redis/time_series.rb
+- lib/redis/time_series/info.rb
 - lib/redis/time_series/sample.rb
 - lib/time/msec.rb
 - redis-time-series.gemspec