influxer 1.1.3 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 36dc815f87b5baba491093838e46cf60537af9eb
-  data.tar.gz: 3149c0e7950e1986bfefeb78cec5bf8e3b334596
+SHA256:
+  metadata.gz: 5fa8f3e80a1c44d03d2217577611586d49e346fef552cc7545a73b39d6824a95
+  data.tar.gz: 990ebe156e20a28189949ad6d428188bc498cd70dd53614e777c28317609ed7e
 SHA512:
-  metadata.gz: 9555072584dbcb205fafdf5f82615430d729a8e7b56962bda588c1b8319b3c5e2b6a07c238705bb1bec8737b39d85852e63d8dd3bdbd0a7483ba441bb512e806
-  data.tar.gz: b2b26a45612366170dba61278e5fb3fbeb0ae56b802bf652b8db90fcf4b63372eb3a33386d791fb605c3668a27b3e399001a608df4a156e4755fb15dbfb36f96
+  metadata.gz: fa4793fba2f7a21533ef25a18d44ea2e525878a0d5d23cdb94b87287c001b4b776e01c2aa2bd5a8ecc35fb18ec2e1841172f94bb3071f61ea00b1a5e820612d4
+  data.tar.gz: '09d22a2c32a82775c39503545197becfd5eda67bdd18251274770dd9e6681d06e6efd13aa84a62e08a406c8fa51b95398efdf74fb5cd2720f40751a404730258'

data/CHANGELOG.md

@@ -0,0 +1,92 @@
+# Change log
+
+## master (unreleased)
+
+## 1.2.1 (2020-07-09)
+
+- Support for setting timezone in queries to configure influx time calculations, e.g., time epoch aggregation ([@jklimke][])
+
+  [PR](https://github.com/palkan/influxer/pull/46)
+
+## 1.2.0 (2019-05-20)
+
+- **Require Ruby 2.4+**
+
+## 1.1.6
+
+- [Fixes [#41](https://github.com/palkan/influxer/issues/41)] Fix query building with empty arrays in `where` clause ([@dimiii][])
+
+  [PR](https://github.com/palkan/influxer/pull/44)
+
+  **BREAKING:** `where.not` now returns non-empty result for an empty array.
+
+- Support of year alias in queries ([@dimiii][])
+
+- [Fixes [#40](https://github.com/palkan/influxer/issues/40)] Avoid adding precision suffix to write queries. ([@palkan][])
+
+## 1.1.5
+
+- [Fixes [#37](https://github.com/palkan/influxer/issues/37)] Timestamp ranges are quoted again. ([@jklimke][])
+
+## 1.1.4
+
+- [Fixes [#35](https://github.com/palkan/influxer/issues/35)] Support time duration suffix and handle `'s'` and `'ms'` precision. ([@palkan][])
+
+  [PR](https://github.com/palkan/influxer/pull/36)
+
+  **BREAKING:** `Time`-like value are only type-casted for `time` key.
+
+## 1.1.2
+
+- Support exclusive ranges as `where` arguments. ([@MPursche][])
+
+```ruby
+# range including the end
+where(a: 1..4)
+#=> ... WHERE a >= 1 AND a <= 4
+
+#range excluding the end
+where(a: 1...4)
+#=> ... WHERE a >= 1 AND a < 4
+```
+
+## 1.1.1
+
+- [Fixes [#31](https://github.com/palkan/influxer/issues/31)] Fix bug with empty arrays in `where` clause
+
+- Introduce `Relation#none` method
+
+## 1.1.0
+
+### Features
+
+- Add ability to specify per-metrics retention-policy, precision and database
+
+Now you can override default configuration for a specific metrics class:
+
+```ruby
+class CustomMetrics < Influxer::Metrics
+  set_database "custom_db"
+  set_retention_policy :yearly
+  set_precision "ms"
+end
+```
+
+### Fixes
+
+- [Fixes [#30](https://github.com/palkan/influxer/issues/30)] Fix writing points with custom retention policy
+
+### Misc
+
+- Update Rubocop configuration and add Rubocop Rake task to defaults
+
+## 1.0.1
+
+- Fix missing `#delegate` in ActiveRecord 3.2
+
+See [changelog](https://github.com/palkan/influxer/blob/1.0.0/Changelog.md) for earlier versions.
+
+[@palkan]: https://github.com/palkan
+[@MPursche]: https://github.com/MPursche
+[@jklimke]: https://github.com/jklimke
+[@dimiii]: https://github.com/dimiii

data/{MIT-LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright 2014 palkan
+Copyright 2014-2020 Vladimir Dementyev
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,50 +1,109 @@
-[![Gem Version](https://badge.fury.io/rb/influxer.svg)](https://rubygems.org/gems/influxer) [![Build Status](https://travis-ci.org/palkan/influxer.svg?branch=master)](https://travis-ci.org/palkan/influxer) [![Dependency Status](https://dependencyci.com/github/palkan/influxer/badge)](https://dependencyci.com/github/palkan/influxer)
-## Influxer
+![Build](https://github.com/palkan/influxer/workflows/Build/badge.svg)
 
-**NOTE**: Version 0.3.x supports InfluxDB >= 0.9.0. For InfluxDB 0.8.x use [version 0.2.5](https://github.com/palkan/influxer/tree/0.2.5).
-
-**NOTE**: Influxer is Rails 3, 4, 5 compatible!
+# Influxer
 
 Influxer provides an ActiveRecord-style way to work with [InfluxDB](https://influxdb.com/) with many useful features, such as:
-- Familar query language (use `select`, `where`, `not`, `group` etc).
-- Support for Regex conditions: `where(page_id: /^home\/.*/) #=> select * ... where page_id=~/^home\/.*/`.
-- Special query methods for InfluxDB: 
-    - `time` - group by time (e.g. `Metrics.time(:hour) => # select * ... group by time(1h)`);
-    - `past` - get only points for last hour/minute/whatever (e.g. `Metrics.past(:day) => # select * ... where time > now() - 1d`);
-    - `since` - get only points since date (e.g. `Metrics.since(Time.utc(2014,12,31)) => # select * ... where time > 1419984000s`);
-    - `merge` - merge series.
-- Scopes support
-    ```ruby
-    class Metrics < Influxer::Metrics
-        default_scope -> { time(:hour).limit(1000) }
-        tags :account_id
-        attributes :value
-        scope :unlimited, -> { limit(nil) }
-        scope :by_account, -> (id) { where(account_id: id) if id.present? }
-    end
-
-    Metrics.by_account(1)
-    # => select * from "metrics" group by time(1h) where account_id=1 limit 1000
-
-    Metrics.unlimited.by_account(1).time(:week)
-    # => select * from "metrics" group by time(1w) where account_id=1
-
-    ```
-- Integrate with your model:
-    ```ruby
-    class UserVisits < Influxer::Metrics
-    end
-    
-    class User < ActiveRecord::Base
-        has_metrics :visits
-    end
-
-    user = User.find(1)
-    user.visits.write(page_id: 'home')
-    #=> < creates point {user_id: 1, page_id: 'home'} in 'user_visits' series >
-
-    user.visits.where(page_id: 'home')
-    #=> select * from user_visits where page_id='home'
-    ```
-    
-Find more on [Wiki](https://github.com/palkan/influxer/wiki).
+
+## Installation
+
+Adding to a gem:
+
+```ruby
+# my-cool-gem.gemspec
+Gem::Specification.new do |spec|
+  # ...
+  spec.add_dependency "influxer", ">= 1.2.0"
+  # ...
+end
+```
+
+Or adding to your project:
+
+```ruby
+# Gemfile
+gem "influxer", "~> 1.2"
+```
+
+## Usage
+
+### Metrics classes
+
+To query InfluxDB or write to it, you should define a metrics class first. Each metrics class represents a measurement/series (or multiple related measurements):
+
+```ruby
+class VisitsMetrics < Influxer::Metrics
+  # Define tags...
+  tags :account_id, :page_id
+  # ...and attributes
+  attributes :user_id, :browser
+end
+```
+
+### Querying
+
+Now you can use your metrics classes in a similar way to Active Record models to build queries. For example:
+
+```ruby
+VisitsMetrics.select(:account_id, :user_id).where(page_id: /^home\/.*/)
+```
+
+Influxer provides special query methods for dealing with time series:
+
+- Group by time: `Metrics.time(:hour) => # select * ... group by time(1h)`.
+- Select only points for the last hour/minute/whatever: `Metrics.past(:day) => # select * ... where time > now() - 1d`.
+- Select only points since the specified time: `Metrics.since(Time.utc(2014,12,31)) => # select * ... where time > 1419984000s`.
+- and more.
+
+See [our Wiki](https://github.com/palkan/influxer/wiki/Query-methods) for more.
+
+### Scopes support
+
+You can define scopes to re-use query conditions:
+
+```ruby
+class Metrics < Influxer::Metrics
+  tags :account_id
+  attributes :value
+
+  default_scope -> { time(:hour).limit(1000) }
+
+  scope :unlimited, -> { limit(nil) }
+  scope :by_account, ->(id) { where(account_id: id) if id.present? }
+end
+
+Metrics.by_account(1)
+# => select * from "metrics" group by time(1h) where account_id=1 limit 1000
+
+Metrics.unlimited.by_account(1).time(:week)
+# => select * from "metrics" group by time(1w) where account_id=1
+```
+
+### Active Record integration
+
+You can association metrics with Active Record models:
+
+```ruby
+class UserVisits < Influxer::Metrics
+end
+
+class User < ActiveRecord::Base
+  has_metrics :visits
+end
+
+user = User.find(1)
+user.visits.write(page_id: "home")
+#=> < creates point {user_id: 1, page_id: 'home'} in 'user_visits' series >
+
+user.visits.where(page_id: "home")
+#=> select * from user_visits where page_id='home'
+```
+
+Find more on [Wiki](https://github.com/palkan/influxer/wiki/ActiveRecord-integration).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/palkan/influxer](https://github.com/palkan/influxer).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/influxer.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require 'influxer/version'
-require 'active_model'
+require "influxer/version"
+require "active_model"
+require "active_support/core_ext"
 
 # Rails client for InfluxDB
 module Influxer
@@ -9,16 +10,16 @@ module Influxer
     ActiveModel::VERSION::MAJOR == 3
   end
 
-  require 'influxer/config'
-  require 'influxer/client'
-  require 'influxer/metrics/metrics'
+  require "influxer/config"
+  require "influxer/client"
+  require "influxer/metrics/metrics"
 
   module Model # :nodoc:
-    require 'influxer/model'
+    require "influxer/model"
   end
 
-  require 'influxer/rails/client' if defined?(Rails)
-  require 'influxer/engine' if defined?(Rails)
+  require "influxer/rails/client" if defined?(Rails)
+  require "influxer/engine" if defined?(Rails)
 
   def self.config
     @config ||= Config.new
@@ -33,7 +34,7 @@ module Influxer
   end
 
   def self.reset!
-    @client.stop! unless @client.nil?
+    @client&.stop!
     @config = nil
     @client = nil
   end

data/lib/influxer/client.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'influxdb'
+require "influxdb"
 
 module Influxer
   # InfluxDB API client

data/lib/influxer/config.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'anyway_config'
+require "anyway_config"
 
 module Influxer
   # Influxer configuration
@@ -28,9 +28,10 @@ module Influxer
                 :denormalize,
                 :udp,
                 :async,
-                database: 'db',
-                time_precision: 'ns',
-                cache: false
+                database: "db",
+                time_precision: "ns",
+                cache: false,
+                time_duration_suffix_enabled: false
 
     def load(*)
       super

data/lib/influxer/engine.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'influxer'
+require "influxer"
 
 module Influxer
   class Engine < Rails::Engine # :nodoc:

data/lib/influxer/metrics/active_model3/model.rb

@@ -5,10 +5,8 @@ module Influxer
     # Replacement of ActiveModel::Model for ActiveModel 3
     module Model
       def initialize(attributes = {})
-        if attributes
-          attributes.each do |attr, value|
-            public_send("#{attr}=", value)
-          end
+        attributes&.each do |attr, value|
+          public_send("#{attr}=", value)
         end
 
         super()

data/lib/influxer/metrics/metrics.rb

@@ -1,16 +1,15 @@
 # frozen_string_literal: true
 
-require 'influxer/metrics/relation'
-require 'influxer/metrics/scoping'
-require 'influxer/metrics/quoting/timestamp'
-require 'influxer/metrics/active_model3/model'
+require "influxer/metrics/relation"
+require "influxer/metrics/scoping"
+require "influxer/metrics/quoting/timestamp"
+require "influxer/metrics/active_model3/model"
 
 module Influxer
   class MetricsError < StandardError; end
   class MetricsInvalid < MetricsError; end
 
   # Base class for InfluxDB querying and writing
-  # rubocop:disable Metrics/ClassLength
   class Metrics
     TIME_FACTOR = 1_000_000_000
     if Influxer.active_model3?
@@ -18,7 +17,6 @@ module Influxer
     else
       include ActiveModel::Model
     end
-    # rubocop:enable Style/MixinUsage
 
     include ActiveModel::Validations
     extend ActiveModel::Callbacks
@@ -35,7 +33,7 @@ module Influxer
           [
             :write, :write!, :select, :where,
             :group, :time, :past, :since,
-            :limit, :offset, :fill, :delete_all, :epoch
+            :limit, :offset, :fill, :delete_all, :epoch, :timezone
           ] + Influxer::Calculations::CALCULATION_METHODS
         ),
         to: :all
@@ -125,7 +123,7 @@ module Influxer
           quoted_series(val.call(instance), write: write)
         when Array
           if val.length > 1
-            "merge(#{val.map { |s| quoted_series(s, write: write) }.join(',')})"
+            "merge(#{val.map { |s| quoted_series(s, write: write) }.join(",")})"
           else
             quoted_series(val.first, write: write)
           end
@@ -133,7 +131,7 @@ module Influxer
           # Only add retention policy when selecting points
           # and not writing
           if !write && retention_policy.present?
-            [quote(@retention_policy), quote(val)].join('.')
+            [quote(@retention_policy), quote(val)].join(".")
           else
             quote(val)
           end
@@ -169,6 +167,7 @@ module Influxer
 
     def write!
       raise MetricsInvalid if invalid?
+
       write
     end
 
@@ -225,13 +224,11 @@ module Influxer
     end
 
     def parsed_timestamp
-      quote_timestamp @timestamp, client
+      quote_timestamp_for_write @timestamp, client
     end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
 
     def unquote(name)
-      name.gsub(/(\A['"]|['"]\z)/, '')
+      name.gsub(/(\A['"]|['"]\z)/, "")
     end
   end
 end

data/lib/influxer/metrics/quoting/timestamp.rb

@@ -2,24 +2,67 @@
 
 module Influxer
   module TimestampQuoting #:nodoc:
-    TIME_FACTOR = 1_000_000_000
+    TIME_FACTORS = {
+      "ns" => 1_000_000_000,
+      "ms" => 1_000,
+      "s" => 1
+    }.freeze
 
-    # Quote timestamp as ns
-    # rubocop: disable Metrics/AbcSize, Metrics/MethodLength
+    DEFAULT_PRECISION = "ns"
+
+    # Quote timestamp
+    # rubocop: disable Metrics/MethodLength, Metrics/AbcSize
     def quote_timestamp(val, client)
-      return val unless client.time_precision == 'ns'
+      if Influxer.config.time_duration_suffix_enabled
+        precision = if TIME_FACTORS.key?(client.time_precision)
+          client.time_precision
+        else
+          DEFAULT_PRECISION
+        end
+        return quote_timestamp_with_suffix(val, precision)
+      end
+
+      if !TIME_FACTORS.key?(client.time_precision) &&
+          !val.is_a?(Numeric)
+        warn(
+          "Influxer doesn't automatically cast Time and String values " \
+          "to '#{client.time_precision}' precision. " \
+          "Please, convert to numeric value yourself"
+        )
+        return val
+      end
+
+      factorize_timestamp(val, TIME_FACTORS.fetch(client.time_precision))
+    end
+    # rubocop: enable Metrics/MethodLength, Metrics/AbcSize
+
+    def quote_timestamp_with_suffix(val, precision)
+      "#{factorize_timestamp(val, TIME_FACTORS.fetch(precision))}#{precision}"
+    end
+
+    def quote_timestamp_for_write(val, client)
+      if !TIME_FACTORS.key?(client.time_precision) &&
+          !val.is_a?(Numeric)
+        raise ArgumentError,
+              "Influxer doesn't support quoting #{val} " \
+              " with '#{client.time_precision}' precision. " \
+              "Please, convert to numeric value yourself"
+      end
+
+      factorize_timestamp(val, TIME_FACTORS.fetch(client.time_precision))
+    end
 
+    def factorize_timestamp(val, factor)
       case val
       when Numeric
-        val.to_i.to_s.ljust(19, '0').to_i
+        (val.to_f * factor).to_i
       when String
-        (Time.parse(val).to_r * TIME_FACTOR).to_i
+        (Time.parse(val).to_r * factor).to_i
       when Date, DateTime
-        (val.to_time.to_r * TIME_FACTOR).to_i
+        (val.to_time.to_r * factor).to_i
       when Time
-        (val.to_r * TIME_FACTOR).to_i
+        (val.to_r * factor).to_i
       end
     end
-    # rubocop: enable Metrics/AbcSize, Metrics/MethodLength
   end
 end