redis-time-series 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2bb0c44197c39258529e093bb34aa0a04576743c4f3d07016f607f9d84cd15e
-  data.tar.gz: 95ce400fcbbdeff4adcd326dd3927f535410be3180526c34068926c1908ac447
+  metadata.gz: 23852f9c6baca09369bbcce49642070c13d1212ba2ca9e7eec93dd691702eb72
+  data.tar.gz: 9edac086b6fc8119382bac0777160d96279df597cdf7cb4f84d27a36532118d2
 SHA512:
-  metadata.gz: ea5a10679174714e5f7ad63fe00f093c0d65c2c5954d11c19ea5a6b52a1660d897cb63e8ba6f6c037ca7f31e5281857f90a9fe2485dc0b401d37f281bd82ec70
-  data.tar.gz: c3cfb8e9632e9876b7cb39888fe89aab86e8becda9b64f3c6c2f4f78e4c58f59595255111820e89914c46a1a29d0a25c8c50f80c6b4311bb60e5b5141137c400
+  metadata.gz: c8efbc6e6426d316715fc134f71d5d2d7bc334ac2d088340eba39d050185fdbd5cbf2a8d7c6cd80274e9bb3b53766905c30124d551b0d5b863180cb12c89eec0
+  data.tar.gz: 5a1d988f13fbace8a269b7156fea1858072a15d030439fbad38e2dfcf720503c71182267d424c5557f8bacf61305975c75c35ad2050c8e307c3b46fb8dc8b5f8

data/.github/workflows/rspec.yml

@@ -0,0 +1,26 @@
+name: RSpec
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  spec:
+    runs-on: ubuntu-latest
+    services:
+      redis:
+        image: redislabs/redistimeseries:latest
+        ports:
+          - 6379:6379/tcp
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run specs
+      run: bundle exec rake spec

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## 0.1.1
+Fix setting labels on `TS.CREATE` and `TS.ALTER`
+
+## 0.1.0
+
+Basic functionality. Includes commands:
+* `TS.CREATE`
+* `TS.ALTER`
+* `TS.ADD`
+* `TS.MADD`
+* `TS.INCRBY`
+* `TS.DECRBY`
+* `TS.RANGE`
+* `TS.GET`
+* `TS.INFO`

data/README.md

@@ -1,3 +1,5 @@
+![](https://github.com/dzunk/redis-time-series/workflows/RSpec/badge.svg)
+
 # RedisTimeSeries
 
 A Ruby adapter for the [RedisTimeSeries module](https://oss.redislabs.com/redistimeseries).
@@ -10,6 +12,7 @@ docker run -p 6379:6379 -it --rm redislabs/redistimeseries
 
 **TL;DR**
 ```ruby
+require 'redis-time-series'
 ts = Redis::TimeSeries.new('foo')
 ts.add 1234
 => #<Redis::TimeSeries::Sample:0x00007f8c0d2561d8 @time=2020-06-25 23:23:04 -0700, @value=0.1234e4>
@@ -48,7 +51,7 @@ Create a series (issues `TS.CREATE` command) and return a Redis::TimeSeries obje
 ```ruby
 ts = Redis::TimeSeries.create(
   'your_ts_key',
-  labels: ['foo', 'bar'],
+  labels: { foo: 'bar' },
   retention: 600,
   uncompressed: false,
   redis: Redis.new(url: ENV['REDIS_URL']) # defaults to Redis.current
@@ -127,6 +130,20 @@ ts.range from: 10.minutes.ago, to: Time.current # Time range as keyword args
  #<Redis::TimeSeries::Sample:0x00007fa25dc01b68 @time=2020-06-25 23:50:57 -0700, @value=0.57e2>,
  #<Redis::TimeSeries::Sample:0x00007fa25dc019b0 @time=2020-06-25 23:51:30 -0700, @value=0.58e2>]
 ```
+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"=>[]}
+```
 
 ### TODO
 * `TS.REVRANGE`
@@ -140,7 +157,22 @@ ts.range from: 10.minutes.ago, to: Time.current # Time range as keyword args
 
 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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
+```
+
+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!
+
+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
+=> 1593159795467
+[2] pry(main)> @ts1.get
+DEBUG: TS.GET foo
+=> #<Redis::TimeSeries::Sample:0x00007f8e1a190cf8 @time=2020-06-26 01:23:15 -0700, @value=0.4e1>
+```
 
 ## Contributing
 

data/bin/console

@@ -3,6 +3,7 @@
 require 'bundler/setup'
 require 'active_support/core_ext/numeric/time'
 require 'pry'
+require 'redis'
 require 'redis-time-series'
 
 Redis.current.flushall

data/lib/redis-time-series.rb

@@ -1,9 +1,8 @@
 require 'bigdecimal'
 require 'time/msec'
-require 'redis'
 require 'redis/time_series'
 require 'redis/time_series/sample'
 
 class RedisTimeSeries
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/redis/time_series.rb

@@ -59,10 +59,10 @@ class Redis
 
     def create
       args = [key]
-      args << "RETENTION #{retention}" if retention
-      args << "UNCOMPRESSED" if uncompressed
-      args << "LABELS #{label_string}" if labels.any?
-      cmd 'TS.CREATE', args
+      args << ['RETENTION', retention] if retention
+      args << 'UNCOMPRESSED' if uncompressed
+      args << ['LABELS', labels.to_a] if labels.any?
+      cmd 'TS.CREATE', args.flatten
       self
     end
 
@@ -101,7 +101,7 @@ class Redis
 
     def labels=(val)
       @labels = val
-      cmd 'TS.ALTER', key, 'LABELS', label_string
+      cmd 'TS.ALTER', key, 'LABELS', labels.to_a.flatten
     end
 
     def madd(*values)
@@ -153,9 +153,5 @@ class Redis
       puts "DEBUG: #{name} #{args.join(' ')}" if ENV['DEBUG']
       redis.call name, *args
     end
-
-    def label_string
-      labels.map { |label, value| "#{label} #{value}" }.join(' ')
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-time-series
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Matt Duszynski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -101,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md