wavefront-sdk 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2002dacfb813974ef1b2450b4843142bc399d472
-  data.tar.gz: 6b6f2ec545568e1ae155b98c9ecf0b6d8b7e6737
+  metadata.gz: 6ee9f41acd3fe0813ce536d55ec05f27faddc67d
+  data.tar.gz: 4c316c36eb1256aaa7821465bc33a6a16a0beb26
 SHA512:
-  metadata.gz: 7f36ed4ec001d74f134c5e9b893cc11e9f71872b885960ceb5da87d7d8915c5b63dbc362604d599f768efa826ea6efa63a17802a8f1bea4ce254fd41184620ae
-  data.tar.gz: 1641bf8dadb681d1401c332136fc7dd139379fb65c890e40f5deeee129de973c7f97a19587cdf31285d78c7a76e8d0ae89d4296de180fdf1b91dd70e1be713a3
+  metadata.gz: 3543d7d92e10e2b050c02619ebf72ad62a42eaabcd3e7981daf86a840f432c141bc67671dcf526d1333277783444a7c6dc47ae358cc6dd5b4e8d505f883ae3d8
+  data.tar.gz: 314e7259a6bd111678b3295966a78deb524f821630ea2725f178fdc19856c240fb6ce59d3fa717f16369e01ebfce50c77f51bf0add382f55080bd73ac134ff17

data/lib/wavefront-sdk/exception.rb

@@ -14,6 +14,8 @@ module Wavefront
     class InvalidGranularity < ::Exception; end
     class InvalidHostname < ::Exception; end
     class InvalidIntegrationId < ::Exception; end
+    class InvalidRelativeTime < ::Exception; end
+    class InvalidTimeUnit < ::Exception; end
     class InvalidMaintenanceWindowId < ::Exception; end
     class InvalidMessageId < ::Exception; end
     class InvalidMetricName < ::Exception; end

data/lib/wavefront-sdk/mixins.rb

@@ -1,3 +1,4 @@
+require 'date'
 require_relative './exception'
 
 module Wavefront
@@ -5,7 +6,9 @@ module Wavefront
     # Return a time as an integer, however it might come in.
     #
     # @param t [Integer, String, Time] timestamp
-    # @param ms [Boolean] whether to return epoch milliseconds
+    # @param ms [Boolean] whether to return epoch milliseconds.
+    #   Passing in an integer timestamp returns itself, regardless
+    #   of this value
     # @return [Integer] epoch time in seconds
     # @raise Wavefront::InvalidTimestamp
     #
@@ -15,10 +18,15 @@ module Wavefront
       # through. No validation, because maybe the user means one
       # second past the epoch, or the year 2525.
       #
-      return t if t.is_a?(Integer)
+      return t if t.is_a?(Numeric)
 
       if t.is_a?(String)
         return t.to_i if t.match(/^\d+$/)
+
+        if t.start_with?('-') || t.start_with?('+')
+          return relative_time(t, ms)
+        end
+
         begin
           t = DateTime.parse("#{t} #{Time.now.getlocal.zone}")
         rescue
@@ -28,10 +36,59 @@ module Wavefront
 
       ms ? t.to_datetime.strftime('%Q').to_i : t.strftime('%s').to_i
     end
+
+    # Return a timetamp described by the given string. That is,
+    # '+5m' is five minutes in the future, and '-.1h' is half an
+    # hour ago.
+    #
+    # @param t [String] relative time string. Must begin with + or
+    #   -, followed by a number, finished with a lower-case time
+    #   unit identifier. See #time_multiplier
+    # @param ref [Time, DateTime] calculate time relative to this
+    #   point. Primarily for easier testing. Defaults to "now".
+    # @return [Integer] integer timestamp
+    # @raise [InvalidRelativeTime] if t does not meet requirements
+    #
+    def relative_time(t, ms = false, ref = DateTime.now)
+      ref = ms ? ref.to_date.strftime('%Q') : ref.to_time
+      ref.to_i + parse_relative_time(t, ms)
+    end
+
+    def parse_relative_time(t, ms = false)
+      unless t.start_with?('+') || t.start_with?('-')
+        raise Wavefront::Exception::InvalidRelativeTime
+      end
+
+      m = ms ? 1000 : 1
+
+      t = t[1..-1] if t.start_with?('+')
+      match = t.match(/^(-?\d*\.?\d*)([smhdwy])$/)
+      (match[1].to_f * time_multiplier(match[2]) * m).to_i
+    rescue NoMethodError
+      raise Wavefront::Exception::InvalidRelativeTime
+    end
+
+    # naively return the number of seconds from the given
+    # multiplier. This makes absolutely no attempt to compensate for
+    # any kind of daylight savings or calendar adjustment. A day is
+    # always going to 60 seconds x 60 minutes x 24 hours, and a
+    # year will always have 365 days.
+    #
+    # @param suffix [Symbol, String]
+    # @return [Integer] the number of seconds in one unit of the
+    #   given suffix
+    # @raise InvalidTimeUnit if the suffix is unknown
+    #
+    def time_multiplier(suffix)
+      u = { s: 1, m: 60, h: 3600, d: 86400, w: 604800, y: 31536000 }
+
+      return u[suffix.to_sym] if u.key?(suffix.to_sym)
+      raise Wavefront::Exception::InvalidTimeUnit
+    end
   end
 end
 
-# Extensions to the Hash class
+# Extensions to stdlib Hash
 #
 class Hash
 

data/lib/wavefront-sdk/version.rb

@@ -1 +1 @@
-WF_SDK_VERSION = '1.1.0'.freeze
+WF_SDK_VERSION = '1.2.0'.freeze

data/spec/wavefront-sdk/mixins_spec.rb

@@ -2,6 +2,7 @@
 
 require_relative '../spec_helper'
 require_relative '../../lib/wavefront-sdk/mixins'
+require 'spy/integration'
 
 # Test SDK mixins
 #
@@ -23,5 +24,69 @@ class WavefrontMixinsTest < MiniTest::Test
     assert_raises(Wavefront::Exception::InvalidTimestamp) do
       parse_time('nonsense')
     end
+
+    trt_spy = Spy.on(self, :relative_time).and_call_through
+
+    parse_time('+5m')
+    parse_time('-0.5m')
+
+    assert_equal trt_spy.calls.length, 2
+  end
+
+  def test_relative_time
+    base = Time.now
+    bi = base.to_i
+    ms_base = base.to_date
+    mbi = ms_base.strftime('%Q').to_i
+
+    assert_equal relative_time('+60s', false, base), bi + 60
+    assert_equal relative_time('-60s', false, base), bi - 60
+    assert_equal relative_time('+.5m', false, base), bi + 30
+    assert_equal relative_time('-000.50m', false, base), bi - 30
+
+    assert_equal relative_time('+60s', true, ms_base), mbi + 60 * 1000
+    assert_equal relative_time('-60s', true, ms_base), mbi - 60 * 1000
+    assert_equal relative_time('+.5m', true, ms_base), mbi + 30 * 1000
+    assert_equal relative_time('-000.50m', true, ms_base), mbi - 30 * 1000
+
+    assert_raises(Wavefront::Exception::InvalidRelativeTime) do
+      relative_time('5m')
+    end
+  end
+
+  def test_parse_relative_time
+    assert_equal parse_relative_time('-5s'), -5
+    assert_equal parse_relative_time('-5s', true), -5000
+    assert_equal parse_relative_time('+10000s'), 10000
+    assert_equal parse_relative_time('-5m'), -300
+    assert_equal parse_relative_time('-.5m'), -30
+    assert_equal parse_relative_time('-0.5m'), -30
+    assert_equal parse_relative_time('+5m'), 300
+    assert_equal parse_relative_time('+.5m'), 30
+    assert_equal parse_relative_time('+.50m'), 30
+    assert_equal parse_relative_time('+.50m', true), 30 * 1000
+    assert_equal parse_relative_time('+.50m'), 30
+    assert_equal parse_relative_time('+1.5d'), 60 * 60 * 24 * 1.5
+    assert_equal parse_relative_time('-1.5d'), 60 * 60 * 24 * -1.5
+
+    ['-1.5p', '1.5m', '+1.3.5s'].each do
+      assert_raises Wavefront::Exception::InvalidRelativeTime do |t|
+        parse_relative_time(t)
+      end
+    end
+  end
+
+  def test_time_multiplier
+    assert_equal time_multiplier(:s), 1
+    assert_equal time_multiplier('s'), 1
+    assert_equal time_multiplier(:m), 60
+    assert_equal time_multiplier(:h), 60 * 60
+    assert_equal time_multiplier(:d), 60 * 60 * 24
+    assert_equal time_multiplier(:w), 60 * 60 * 24 * 7
+    assert_equal time_multiplier(:y), 60 * 60 * 24 * 365
+
+    assert_raises(Wavefront::Exception::InvalidTimeUnit) do
+      time_multiplier(:p)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wavefront-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Robert Fisher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-09 00:00:00.000000000 Z
+date: 2017-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -257,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: SDK for Wavefront API v2