redis-time-series 0.1.0 → 0.5.0

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.5.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.}
@@ -38,4 +38,5 @@ Gem::Specification.new do |spec|
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-time-series
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Duszynski
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -94,13 +94,28 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !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: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
@@ -111,10 +126,17 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- lib/ext/time_msec.rb
 - lib/redis-time-series.rb
 - lib/redis/time_series.rb
+- lib/redis/time_series/aggregation.rb
+- lib/redis/time_series/client.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:

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