redis-time-series 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461a6f3842867d1ba51440e7576aad3e9b92ecd02700cd59e5508c0e8bbfcaa7
-  data.tar.gz: 0c03af91af0eaaa37917db2cad21417c38709a53b223ed2864bad0f9857fa1f7
+  metadata.gz: 4648678522434687a6e278490c7a308c64f6460394b8ebde16b2ce2daa9e92ad
+  data.tar.gz: e2f48fb1c8efebb3b4d6e4c47d1d86137a10ac8a54735c94b3bdb35ef6396651
 SHA512:
-  metadata.gz: 56dcd4439b2f4f06469237d2925d84b2ffabc40e2dccb608d5489b78f0e2a5b299881487b55e67fb48f1c9d0f7f56951ee98254ae84229b1827fb4cf3683ca44
-  data.tar.gz: 860e638f906b9dc19358e6156ad6a0488452be0be499853926742073cf6e85d00f4e95755f1659feae9763334eebbab044147fa3d94512dbb2a91360ec08728b
+  metadata.gz: 269a787d8d2a2a467a52e915ab717bc5b20eb28cacc55eb5dfc9ce3909a7d83cdd4e15b19afc92612d19fa551c6ba793df76ceef03d8bb8bdb16b6dc0253d2cc
+  data.tar.gz: c5d845052ca8f2a518fb3a20a82a8d8aa35128cb824f54d2531a949767e90f8c7979ede07ba1bd56ae30a825edb9f6be90e52ca404a14199bfd13484026d8d40

data/.github/workflows/rspec.yml

@@ -11,9 +11,13 @@ on:
 jobs:
   spec:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        image_version: ['latest', 'edge']
+        ruby_version: ['2.6', '2.7']
     services:
       redis:
-        image: redislabs/redistimeseries:latest
+        image: redislabs/redistimeseries:${{ matrix.image_version }}
         ports:
           - 6379:6379/tcp
     env:
@@ -25,16 +29,18 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6
+        ruby-version: ${{ matrix.ruby_version }}
     - name: Set up CodeClimate
       run: |
         curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
         chmod +x ./cc-test-reporter
         ./cc-test-reporter before-build
     - name: Install dependencies
-      run: bundle install
+      run: |
+        bundle install
+        bundle exec appraisal install
     - name: Run specs
-      run: bundle exec rake spec
+      run: bundle exec appraisal rake spec
     - name: Upload coverage report
       run: ./cc-test-reporter after-build -t simplecov coverage/.resultset.json
     - uses: actions/upload-artifact@v2

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/Appraisals

@@ -0,0 +1,7 @@
+appraise 'redis 3' do
+  gem 'redis', '~> 3.3'
+end
+
+appraise 'redis 4' do
+  gem 'redis', '~> 4.0'
+end

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## 0.6.0
+* Add CHUNK_SIZE param to CREATE, ADD, INCRBY, DECRBY commands (#53)
+* Add duplication policy to TS.CREATE and TS.ADD commands (#51)
+* Add support for endless ranges to TS.RANGE (#50)
+* Cast label values to integers in Info struct (#49)
+* Build against edge upstream in addition to latest stable (#48)
+
 ## 0.5.2
 * Add chunk_type to info struct (#47)
 

data/lib/redis-time-series.rb

@@ -1,9 +1,11 @@
 require 'bigdecimal'
 require 'forwardable'
 require 'ext/time_msec'
+
 require 'redis/time_series/client'
 require 'redis/time_series/errors'
 require 'redis/time_series/aggregation'
+require 'redis/time_series/duplicate_policy'
 require 'redis/time_series/filters'
 require 'redis/time_series/rule'
 require 'redis/time_series/info'

data/lib/redis/time_series.rb

@@ -37,6 +37,11 @@ class Redis
       #   With no value, the series will not be trimmed.
       # @option options [Boolean] :uncompressed
       #   When true, series data will be stored in an uncompressed format.
+      # @option options [String, Symbol] :duplicate_policy
+      #   A duplication policy to resolve conflicts when adding values to the series.
+      #   Valid values are in Redis::TimeSeries::DuplicatePolicy::VALID_POLICIES
+      # @option options [Integer] :chunk_size
+      #   Amount of memory, in bytes, to allocate for each chunk of data
       #
       # @return [Redis::TimeSeries] the created time series
       # @see https://oss.redislabs.com/redistimeseries/commands/#tscreate
@@ -154,21 +159,33 @@ class Redis
     # @param value [Numeric] the value to add
     # @param timestamp [Time, Numeric] the +Time+, or integer timestamp in milliseconds, to add the value
     # @param uncompressed [Boolean] if true, stores data in an uncompressed format
+    # @param on_duplicate [String, Symbol] a duplication policy for conflict resolution
+    # @param chunk_size [Integer] set default chunk size, in bytes, for the time series
     #
     # @return [Sample] the value that was added
     # @raise [Redis::CommandError] if the value being added is older than the latest timestamp in the series
-    def add(value, timestamp = '*', uncompressed: nil)
-      ts = cmd 'TS.ADD', key, timestamp, value, ('UNCOMPRESSED' if uncompressed)
+    #
+    # @see TimeSeries::DuplicatePolicy
+    def add(value, timestamp = '*', uncompressed: nil, on_duplicate: nil, chunk_size: nil)
+      ts = cmd 'TS.ADD',
+               key,
+               timestamp,
+               value,
+               ('UNCOMPRESSED' if uncompressed),
+               (['CHUNK_SIZE', chunk_size] if chunk_size),
+               (DuplicatePolicy.new(on_duplicate).to_a('ON_DUPLICATE') if on_duplicate)
       Sample.new(ts, value)
     end
 
     # Issues a TS.CREATE command for the current series.
     # You should use class method {Redis::TimeSeries.create} instead.
     # @api private
-    def create(retention: nil, uncompressed: nil, labels: nil)
+    def create(retention: nil, uncompressed: nil, labels: nil, duplicate_policy: nil, chunk_size: nil)
       cmd 'TS.CREATE', key,
           (['RETENTION', retention] if retention),
           ('UNCOMPRESSED' if uncompressed),
+          (['CHUNK_SIZE', chunk_size] if chunk_size),
+          (DuplicatePolicy.new(duplicate_policy).to_a if duplicate_policy),
           (['LABELS', labels.to_a] if labels&.any?)
       self
     end
@@ -206,11 +223,17 @@ class Redis
     # @param value [Integer] the amount to decrement by
     # @param timestamp [Time, Integer] the Time or integer millisecond timestamp to save the new value at
     # @param uncompressed [Boolean] if true, stores data in an uncompressed format
+    # @param chunk_size [Integer] set default chunk size, in bytes, for the time series
     #
     # @return [Integer] the timestamp the value was stored at
     # @see https://oss.redislabs.com/redistimeseries/commands/#tsincrbytsdecrby
-    def decrby(value = 1, timestamp = nil, uncompressed: nil)
-      cmd 'TS.DECRBY', key, value, (timestamp if timestamp), ('UNCOMPRESSED' if uncompressed)
+    def decrby(value = 1, timestamp = nil, uncompressed: nil, chunk_size: nil)
+      cmd 'TS.DECRBY',
+          key,
+          value,
+          (timestamp if timestamp),
+          ('UNCOMPRESSED' if uncompressed),
+          (['CHUNK_SIZE', chunk_size] if chunk_size)
     end
     alias decrement decrby
 
@@ -241,11 +264,17 @@ class Redis
     # @param value [Integer] the amount to increment by
     # @param timestamp [Time, Integer] the Time or integer millisecond timestamp to save the new value at
     # @param uncompressed [Boolean] if true, stores data in an uncompressed format
+    # @param chunk_size [Integer] set default chunk size, in bytes, for the time series
     #
     # @return [Integer] the timestamp the value was stored at
     # @see https://oss.redislabs.com/redistimeseries/commands/#tsincrbytsdecrby
-    def incrby(value = 1, timestamp = nil, uncompressed: nil)
-      cmd 'TS.INCRBY', key, value, (timestamp if timestamp), ('UNCOMPRESSED' if uncompressed)
+    def incrby(value = 1, timestamp = nil, uncompressed: nil, chunk_size: nil)
+      cmd 'TS.INCRBY',
+          key,
+          value,
+          (timestamp if timestamp),
+          ('UNCOMPRESSED' if uncompressed),
+          (['CHUNK_SIZE', chunk_size] if chunk_size)
     end
     alias increment incrby
 
@@ -312,12 +341,12 @@ class Redis
         # `range` will swallow all parameters if they're all hash syntax
         count = range.delete(:count)
         aggregation = range.delete(:aggregation)
-        range = range.fetch(:from)..range.fetch(:to)
+        range = range.fetch(:from)..range[:to]
       end
       cmd('TS.RANGE',
           key,
-          range.min,
-          range.max,
+          (range.begin || '-'),
+          (range.end || '+'),
           (['COUNT', count] if count),
           Aggregation.parse(aggregation)&.to_a
          ).map { |ts, val| Sample.new(ts, val) }

data/lib/redis/time_series/duplicate_policy.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+class Redis
+  class TimeSeries
+    # Duplication policies can be applied to a time series in order to resolve conflicts
+    # when adding data that already exists in the series.
+    #
+    # @see https://oss.redislabs.com/redistimeseries/master/configuration/#duplicate_policy
+    class DuplicatePolicy
+      VALID_POLICIES = %i[
+        block
+        first
+        last
+        min
+        max
+        sum
+      ].freeze
+
+      attr_reader :policy
+
+      def initialize(policy)
+        policy = policy.to_s.downcase.to_sym
+        if VALID_POLICIES.include?(policy)
+          @policy = policy
+        else
+          raise UnknownPolicyError, "#{policy} is not a valid duplicate policy"
+        end
+      end
+
+      def to_a(cmd = 'DUPLICATE_POLICY')
+        [cmd, policy]
+      end
+
+      def to_s(cmd = 'DUPLICATE_POLICY')
+        to_a(cmd).join(' ')
+      end
+
+      def ==(other)
+        return policy == other.policy if other.is_a?(self.class)
+        policy == self.class.new(other).policy
+      end
+
+      VALID_POLICIES.each do |policy|
+        define_method("#{policy}?") do
+          @policy == policy
+        end
+      end
+    end
+  end
+end

data/lib/redis/time_series/errors.rb

@@ -15,5 +15,10 @@ class Redis
     # an unknown type, or when calling a command with an invalid aggregation value.
     # @see Redis::TimeSeries::Aggregation
     class AggregationError < Error; end
+
+    # +UnknownPolicyError+ is raised when attempting to apply an unkown type of
+    # duplicate policy when creating or adding to a series.
+    # @see Redis::TimeSeries::DuplicatePolicy
+    class UnknownPolicyError < Error; end
   end
 end

data/lib/redis/time_series/info.rb

@@ -10,6 +10,10 @@ class Redis
     #
     # @!attribute [r] chunk_count
     #   @return [Integer] number of memory chunks used for the time-series
+    # @!attribute [r] chunk_size
+    #   @return [Integer] amount of allocated memory in bytes
+    # @!attribute [r] chunk_type
+    #   @return [String] whether the chunk is "compressed" or "uncompressed"
     # @!attribute [r] first_timestamp
     #   @return [Integer] first timestamp present in the time-series (milliseconds since epoch)
     # @!attribute [r] labels
@@ -52,20 +56,43 @@ class Redis
       :total_samples,
       keyword_init: true
     ) do
-      # @api private
-      # @return [Info]
-      def self.parse(series:, data:)
-        data.each_slice(2).reduce({}) do |h, (key, value)|
-          # Convert camelCase info keys to snake_case
-          key = key.gsub(/(.)([A-Z])/,'\1_\2').downcase.to_sym
-          next h unless members.include?(key)
-          h[key] = value
-          h
-        end.then do |parsed_hash|
-          parsed_hash[:series] = series
-          parsed_hash[:labels] = parsed_hash[:labels].to_h
-          parsed_hash[:rules] = parsed_hash[:rules].map { |d| Rule.new(source: series, data: d) }
-          new(parsed_hash)
+      class << self
+        # @api private
+        # @return [Info]
+        def parse(series:, data:)
+          build_hash(data)
+            .merge(series: series)
+            .then(&method(:parse_labels))
+            .then(&method(:parse_policies))
+            .then(&method(:parse_rules))
+            .then(&method(:new))
+        end
+
+        private
+
+        def build_hash(data)
+          data.each_slice(2).reduce({}) do |h, (key, value)|
+            # Convert camelCase info keys to snake_case
+            key = key.gsub(/(.)([A-Z])/,'\1_\2').downcase.to_sym
+            # Skip unknown properties
+            next h unless members.include?(key)
+            h.merge(key => value)
+          end
+        end
+
+        def parse_labels(hash)
+          hash[:labels] = hash[:labels].to_h.transform_values { |v| v.to_i.to_s == v ? v.to_i : v }
+          hash
+        end
+
+        def parse_policies(hash)
+          hash[:duplicate_policy] = DuplicatePolicy.new(hash[:duplicate_policy]) if hash[:duplicate_policy]
+          hash
+        end
+
+        def parse_rules(hash)
+          hash[:rules] = hash[:rules].map { |d| Rule.new(source: hash[:series], data: d) }
+          hash
         end
       end
 

data/lib/redis/time_series/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 class Redis
   class TimeSeries
-    VERSION = '0.5.2'
+    VERSION = '0.6.0'
   end
 end

data/redis-time-series.gemspec

@@ -31,10 +31,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'redis', '~> 4.0'
+  spec.add_dependency 'redis', '>= 3.3', '< 5'
 
   spec.add_development_dependency 'activesupport', '~> 6.0'
-  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'pry', '~> 0.13'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: redis-time-series
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Matt Duszynski
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-10 00:00:00.000000000 Z
+date: 2020-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +44,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +128,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '0.18'
-description: 
+description:
 email:
 - dzunk@hey.com
 executables: []
@@ -118,9 +138,9 @@ files:
 - ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -131,6 +151,7 @@ files:
 - lib/redis/time_series.rb
 - lib/redis/time_series/aggregation.rb
 - lib/redis/time_series/client.rb
+- lib/redis/time_series/duplicate_policy.rb
 - lib/redis/time_series/errors.rb
 - lib/redis/time_series/filters.rb
 - lib/redis/time_series/info.rb
@@ -145,7 +166,7 @@ metadata:
   homepage_uri: https://github.com/dzunk/redis-time-series
   source_code_uri: https://github.com/dzunk/redis-time-series
   changelog_uri: https://github.com/dzunk/redis-time-series/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +181,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.2
+signing_key:
 specification_version: 4
 summary: A Ruby adapter for the RedisTimeSeries module.
 test_files: []

data/Gemfile.lock

@@ -1,66 +0,0 @@
-PATH
-  remote: .
-  specs:
-    redis-time-series (0.5.2)
-      redis (~> 4.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.0.3.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    coderay (1.1.3)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    i18n (1.8.3)
-      concurrent-ruby (~> 1.0)
-    json (2.3.1)
-    method_source (1.0.0)
-    minitest (5.14.1)
-    pry (0.13.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rake (13.0.1)
-    redis (4.2.2)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    simplecov (0.17.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport (~> 6.0)
-  bundler (~> 1.17)
-  pry (~> 0.13)
-  rake (~> 13.0)
-  redis-time-series!
-  rspec (~> 3.0)
-  simplecov (< 0.18)
-
-BUNDLED WITH
-   1.17.2