redis-time-series 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51234a8f3542da255912f95982ebab2bf66dd657da9e38e55afdedd97029685d
-  data.tar.gz: 42a49fdafb136d8ebe4b094f935b0427430672ab810691a35ca2f78328d92135
+  metadata.gz: 0d699daec01bb891952501de6a51cc4b966be74a0f8585030bafb4f6a908b36e
+  data.tar.gz: dfa027d344c4d5485b0a22a33edd67973c2a60cb60dbbaa1a57101ccce8833fc
 SHA512:
-  metadata.gz: acc08d1745cf24bfc87c22d3809570daa0b2feae4e5d5b97d4a43a0626217b44ea3ffdb12c3f6799c068bb6e62f0cc7a1b65274e5d8eac5cb13017bfea73dff4
-  data.tar.gz: 1ff7aa6fb44dd2729612ac24e2be45496d45bd5a0fc86ed692bd18c38bcb160971c0efed05e598ffabb6471cf4d6903d303a1d0b74e55672c479829b98b26012
+  metadata.gz: acadcad9c6919e810f0e100bfe20b60055507e2efa98d0853fca6c15a252f99b65c722c71acc99d37d8d9f72964d91f862c9604fb96458ca3faaddce9f841752
+  data.tar.gz: 489415e8247d8cffefcf13e4e70c82cde752170c4416bc0973495c5d38b1d27d2b554cdd62db8729c9c71b125cb4848aa5a1efd81b998aa5f6e5683c13be8ccc

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+## 0.3.0
+* Added `TS.QUERYINDEX` command
+
 ## 0.2.0
 * Converted `#info` to a struct instead of a hash.
 * Added methods on time series for getting info attributes.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-time-series (0.1.1)
+    redis-time-series (0.3.0)
       redis (~> 4.0)
 
 GEM

data/README.md

@@ -1,4 +1,5 @@
-![](https://github.com/dzunk/redis-time-series/workflows/RSpec/badge.svg)
+[![RSpec](https://github.com/dzunk/redis-time-series/workflows/RSpec/badge.svg)](https://github.com/dzunk/redis-time-series/actions?query=workflow%3ARSpec+branch%3Amaster)
+[![Gem Version](https://badge.fury.io/rb/redis-time-series.svg)](https://badge.fury.io/rb/redis-time-series)
 
 # RedisTimeSeries
 
@@ -159,36 +160,50 @@ ts.length
 ts.size
 => 3
 ```
+Find series matching specific label(s)
+```ruby
+Redis::TimeSeries.queryindex('foo=bar')
+=> [#<Redis::TimeSeries:0x00007fc115ba1610
+  @key="ts3",
+  @redis=#<Redis client v4.2.1 for redis://127.0.0.1:6379/0>,
+  @retention=nil,
+  @uncompressed=false>]
+# Note that you need at least one "label equals value" filter
+Redis::TimeSeries.queryindex('foo!=bar')
+=> RuntimeError: Filtering requires at least one equality comparison
+```
+
 
 ### TODO
 * `TS.REVRANGE`
 * `TS.MRANGE`/`TS.MREVRANGE`
-* `TS.QUERYINDEX`
 * Compaction rules
 * Filters
 * Probably a bunch more stuff
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-In order to run the specs or use the console, you'll need a Redis server running on the default port 6379 with the RedisTimeSeries module enabled. The easiest way to do so is by running the Docker image:
-```
-docker run -p 6379:6379 -it --rm redislabs/redistimeseries
-```
+After checking out the repo, run `bin/setup`. You need the `docker` daemon installed and running. This script will:
+* Install gem dependencies
+* Pull the latest `redislabs/redistimeseries` image
+* Start a Redis server on port 6379
+* Seed three time series with some sample data
+* Attach to the running server and print logs to `STDOUT`
 
-The `bin/console` script will set up three time series, `@ts1`, `@ts2`, and `@ts3`, with three values in each. **It will also flush the local Redis server each time you run it**, so don't try it if you have data you don't want to lose!
+With the above script running, or after starting a server manually, you can run `bin/console` to interact with it. The three series are named `ts1`, `ts2`, and `ts3`, and are available as instance variables in the console.
 
 If you want to see the commands being executed, run the console with `DEBUG=true bin/console` and it will output the raw command strings as they're executed.
 ```ruby
 [1] pry(main)> @ts1.increment
-DEBUG: TS.INCRBY foo 1
+DEBUG: TS.INCRBY ts1 1
 => 1593159795467
 [2] pry(main)> @ts1.get
-DEBUG: TS.GET foo
+DEBUG: TS.GET ts1
 => #<Redis::TimeSeries::Sample:0x00007f8e1a190cf8 @time=2020-06-26 01:23:15 -0700, @value=0.4e1>
 ```
 
+Use `rake spec` to run the test suite.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/dzunk/redis-time-series.

data/bin/console

@@ -6,15 +6,9 @@ require 'pry'
 require 'redis'
 require 'redis-time-series'
 
-Redis.current.flushall
-
-@ts1 = Redis::TimeSeries.create('foo')
-@ts2 = Redis::TimeSeries.create('bar')
-@ts3 = Redis::TimeSeries.create('baz')
-
+@ts1 = Redis::TimeSeries.new('ts1')
+@ts2 = Redis::TimeSeries.new('ts2')
+@ts3 = Redis::TimeSeries.new('ts3')
 @series = [@ts1, @ts2, @ts3]
-@series.each do |ts|
-  3.times { ts.increment; sleep 0.01 }
-end
 
 Pry.start

data/bin/setup

@@ -1,8 +1,30 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
+#!/usr/bin/env ruby
 
-bundle install
+system 'bundle install'
+system 'docker pull redislabs/redistimeseries:latest'
+container_id = `docker run -p 6379:6379 -dit --rm redislabs/redistimeseries`
 
-# Do any other automated setup that you need to do here
+require 'bundler/setup'
+require 'active_support/core_ext/numeric/time'
+require 'redis'
+
+Redis.current.flushall
+ts1 = Redis::TimeSeries.create('ts1')
+ts2 = Redis::TimeSeries.create('ts2')
+ts3 = Redis::TimeSeries.create('ts3')
+
+ts1.add 12, 6.minutes.ago
+ts1.add 34, 4.minutes.ago
+ts1.add 56, 2.minutes.ago
+
+10.times { ts2.increment; sleep 0.01 }
+
+ts3.labels = { foo: 'bar' }
+ts3.add 1
+sleep 0.01
+ts3.incrby 2
+sleep 0.01
+ts3.decrement
+
+at_exit { system "docker stop #{container_id}" }
+system "docker logs -f #{container_id}"

data/lib/redis-time-series.rb

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

data/lib/redis/time_series.rb

@@ -33,6 +33,12 @@ class Redis
         end
       end
 
+      def queryindex(filter_value)
+        filters = Filter.new(filter_value)
+        filters.validate!
+        redis.call('TS.QUERYINDEX', *filters.to_a).map { |key| new(key) }
+      end
+
       def redis
         @redis ||= Redis.current
       end

data/lib/redis/time_series/filter.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+class Redis
+  class TimeSeries
+    class Filter
+      Equal = Struct.new(:label, :value) do
+        self::REGEX = /^[^!]+=[^(]+/
+
+        def self.parse(str)
+          new(*str.split('='))
+        end
+
+        def to_s
+          "#{label}=#{value}"
+        end
+      end
+
+      NotEqual = Struct.new(:label, :value) do
+        self::REGEX = /^.+!=[^(]+/
+
+        def self.parse(str)
+          new(*str.split('!='))
+        end
+
+        def to_s
+          "#{label}!=#{value}"
+        end
+      end
+
+      Absent = Struct.new(:label) do
+        self::REGEX = /^[^!]+=$/
+
+        def self.parse(str)
+          new(str.delete('='))
+        end
+
+        def to_s
+          "#{label}="
+        end
+      end
+
+      Present = Struct.new(:label) do
+        self::REGEX = /^.+!=$/
+
+        def self.parse(str)
+          new(str.delete('!='))
+        end
+
+        def to_s
+          "#{label}!="
+        end
+      end
+
+      AnyValue = Struct.new(:label, :values) do
+        self::REGEX = /^[^!]+=\(.+\)/
+
+        def self.parse(str)
+          label, values = str.split('=')
+          values = values.tr('()', '').split(',')
+          new(label, values)
+        end
+
+        def to_s
+          "#{label}=(#{values.join(',')})"
+        end
+      end
+
+      NoValues = Struct.new(:label, :values) do
+        self::REGEX = /^.+!=\(.+\)/
+
+        def self.parse(str)
+          label, values = str.split('!=')
+          values = values.tr('()', '').split(',')
+          new(label, values)
+        end
+
+        def to_s
+          "#{label}!=(#{values.join(',')})"
+        end
+      end
+
+      TYPES = [Equal, NotEqual, Absent, Present, AnyValue, NoValues]
+      TYPES.each do |type|
+        define_method "#{type.to_s.split('::').last.gsub(/(.)([A-Z])/,'\1_\2').downcase}_filters" do
+          filters.select { |f| f.is_a? type }
+        end
+      end
+
+      attr_reader :filters
+
+      def initialize(filters = nil)
+        filters = parse_string(filters) if filters.is_a?(String)
+        @filters = filters.presence || {}
+      end
+
+      def validate!
+        valid? || raise('Filtering requires at least one equality comparison')
+      end
+
+      def valid?
+        !!filters.find { |f| f.is_a? Equal }
+      end
+
+      def to_a
+        filters.map(&:to_s)
+      end
+
+      private
+
+      def parse_string(filter_string)
+        filter_string.split(' ').map do |str|
+          match = TYPES.find { |f| f::REGEX.match? str }
+          raise "Unable to parse '#{str}'" unless match
+          match.parse(str)
+        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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Duszynski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-06 00:00:00.000000000 Z
+date: 2020-07-17 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/filter.rb
 - lib/redis/time_series/info.rb
 - lib/redis/time_series/sample.rb
 - lib/time/msec.rb