redis-time-series 0.3.0 → 0.6.0

data/lib/redis/time_series/rule.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+class Redis
+  class TimeSeries
+    # A compaction rule applies an aggregation from a source series to a destination series.
+    # As data is added to the source, it will be aggregated based on any configured rule(s) and
+    # distributed to the correct destination(s).
+    #
+    # Compaction rules are useful to retain data over long time periods without requiring exorbitant
+    # amounts of memory and storage. For example, if you're collecting data on a minute-by-minute basis,
+    # you may want to retain a week's worth of data at full fidelity, and a year's worth of data downsampled
+    # to hourly, which would require 60x less memory.
+    class Rule
+      # @return [Aggregation] the configured aggregation for this rule
+      attr_reader :aggregation
+
+      # @return [String] the Redis key of the destination series
+      attr_reader :destination_key
+
+      # @return [TimeSeries] the data source of this compaction rule
+      attr_reader :source
+
+      # Manually instantiating a rule does nothing, don't bother.
+      # @api private
+      # @see Info#rules
+      def initialize(source:, data:)
+        @source = source
+        @destination_key, duration, aggregation_type = data
+        @aggregation = Aggregation.new(aggregation_type, duration)
+      end
+
+      # Delete this compaction rule.
+      # @return [String] the string "OK"
+      def delete
+        source.delete_rule(dest: destination_key)
+      end
+
+      # @return [TimeSeries] the destination time series this rule refers to
+      def destination
+        @dest ||= TimeSeries.new(destination_key, redis: source.redis)
+      end
+      alias dest destination
+
+      # @return [String] the Redis key of the source series
+      def source_key
+        source.key
+      end
+    end
+  end
+end

data/lib/redis/time_series/sample.rb

@@ -1,23 +1,39 @@
 # frozen_string_literal: true
 class Redis
   class TimeSeries
+    # A sample is an immutable value object that represents a single data point within a time series.
     class Sample
-      TS_FACTOR = 1000.0
+      using TimeMsec
 
-      attr_reader :time, :value
+      # @return [Time] the sample's timestamp
+      attr_reader :time
+      # @return [BigDecimal] the decimal value of the sample
+      attr_reader :value
 
+      # Samples are returned by time series query methods, there's no need to create one yourself.
+      # @api private
+      # @see TimeSeries#get
+      # @see TimeSeries#range
       def initialize(timestamp, value)
-        @time = Time.at(timestamp / TS_FACTOR)
+        @time = Time.from_msec(timestamp)
         @value = BigDecimal(value)
       end
 
-      def ts_msec
-        (time.to_f * TS_FACTOR).to_i
+      # @return [Integer] the millisecond value of the sample's timestamp
+      # @note
+      #   We're wrapping the method provided by the {TimeMsec} refinement for convenience,
+      #   otherwise it wouldn't be callable on {time} and devs would have to litter
+      #   +using TimeMsec+ or +* 1000.0+ wherever they wanted the value.
+      def to_msec
+        time.ts_msec
       end
 
+      # @return [Hash] a hash representation of the sample
+      # @example
+      #   {:timestamp=>1595199272401, :value=>0.2e1}
       def to_h
         {
-          timestamp: ts_msec,
+          timestamp: to_msec,
           value: value
         }
       end

data/lib/redis/time_series/version.rb

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

data/redis-time-series.gemspec

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'redis-time-series'
+require 'redis/time_series/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'redis-time-series'
-  spec.version       = RedisTimeSeries::VERSION
+  spec.version       = Redis::TimeSeries::VERSION
   spec.authors       = ['Matt Duszynski']
-  spec.email         = ['mattduszynski@gmail.com']
+  spec.email         = ['dzunk@hey.com']
 
   spec.summary       = %q{A Ruby adapter for the RedisTimeSeries module.}
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
@@ -31,11 +31,13 @@ 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'
+  spec.add_development_dependency 'simplecov', '< 0.18' # https://github.com/codeclimate/test-reporter/issues/413
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: redis-time-series
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Matt Duszynski
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-17 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
@@ -94,9 +114,23 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+description:
 email:
-- mattduszynski@gmail.com
+- dzunk@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -104,20 +138,26 @@ files:
 - ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- lib/ext/time_msec.rb
 - lib/redis-time-series.rb
 - lib/redis/time_series.rb
-- lib/redis/time_series/filter.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
+- lib/redis/time_series/rule.rb
 - lib/redis/time_series/sample.rb
-- lib/time/msec.rb
+- lib/redis/time_series/version.rb
 - redis-time-series.gemspec
 homepage: https://github.com/dzunk/redis-time-series
 licenses:
@@ -126,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
@@ -141,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,58 +0,0 @@
-PATH
-  remote: .
-  specs:
-    redis-time-series (0.3.0)
-      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)
-    i18n (1.8.3)
-      concurrent-ruby (~> 1.0)
-    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.1)
-    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)
-    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)
-
-BUNDLED WITH
-   1.17.2

data/lib/time/msec.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-class Time
-  # TODO: use refinemenets instead of monkey-patching Time
-  def ts_msec
-    (to_f * 1000.0).to_i
-  end
-end