influxer 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 020023da263e0ad14394211eaab3b6388359a2ebd8de084182eeddca8b4f7569
-  data.tar.gz: 4648019961ea24ff2132d73b7975a801f0be0270380ba003223166191c4d924d
+  metadata.gz: 5fa8f3e80a1c44d03d2217577611586d49e346fef552cc7545a73b39d6824a95
+  data.tar.gz: 990ebe156e20a28189949ad6d428188bc498cd70dd53614e777c28317609ed7e
 SHA512:
-  metadata.gz: 3215b0bc249ad3e927f9f77dafb417c29c915c6b32f8f2342c6507b4d165f2a46b9aae82fe815ac374a2785f46c19020b6dd2688e8a208a79cc2a7e7060eb42c
-  data.tar.gz: 70b27b50e9e98dcebde9b9ef4f16e1899c3f056770f31ece57af1c4c092a08ffa2484a4343e9c87795ffeca6b79553f9ab78a8dd431d40a75f0a2a808cf605b4
+  metadata.gz: fa4793fba2f7a21533ef25a18d44ea2e525878a0d5d23cdb94b87287c001b4b776e01c2aa2bd5a8ecc35fb18ec2e1841172f94bb3071f61ea00b1a5e820612d4
+  data.tar.gz: '09d22a2c32a82775c39503545197becfd5eda67bdd18251274770dd9e6681d06e6efd13aa84a62e08a406c8fa51b95398efdf74fb5cd2720f40751a404730258'

data/{Changelog.md → CHANGELOG.md}

@@ -2,6 +2,12 @@
 
 ## 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+**
@@ -24,11 +30,11 @@
 
 ## 1.1.4
 
-- [Fixes [#35](https://github.com/palkan/influxer/issues/35)] Support time duration suffix and handle `'s'` and `'ms'` precisions. ([@palkan][])
+- [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 typecasted for `time` key.
+  **BREAKING:** `Time`-like value are only type-casted for `time` key.
 
 ## 1.1.2
 
@@ -78,54 +84,7 @@ end
 
 - Fix missing `#delegate` in ActiveRecord 3.2
 
-## 0.5.4
-- Add `set_retention_policy` method
-
-## 0.5.3
-- Fix `where.not` with ranges typo
-
-## 0.5.2
-- Fix bug with query logging
-
-## 0.5.1
-- Fix whitespace around operators
-- Add `Relation#from` method to redefine series
-- Handle nil values for tags in #where clause
-
-## 0.5.0
-- Update `timestamp` support
-- Add `epoch` method
-
-## 0.4.0
-- Rename default `time` attribute to `timestamp`
-
-## 0.2.3
-- Parse fanout queries points to handle _fanouted_ values
-- Add Rubocop config and cleanup code style
-
-## 0.1.1
-- Add [anyway_config](https://github.com/palkan/anyway_config)
-- Add `empty?` method
-
-## 0.1.0
-- Add logs
-- Add `foreign_key` param to `has_metrics` options
-
-## 0.1.0-rc
-- Fix `Relation#to_a` (now returns array of points correctrly)
-- Fix fanout queries with array args (now use `merge(Regexp)`)
-
-## 0.1.0-alpha
-- Add `time` method to Relation to group by time with constants (`:hour`, `:day`, etc) and fill support
-- Series names now properly quoted with double-quotes
-- Using regexps, ranges and arrays within `where` clause
-- `where.not(...)` support
-- Add `past` and `since` methods
-- Add `merge` method and support for regexp series
-- Add `delete_all` support
-- Add cache support (using `Rails.cache`)
-- Scopes (default and named)
-- Support for fanout series
+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

data/{MIT-LICENSE → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright 2014-2019 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,37 +1,88 @@
-[![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 4+ compatible! (Rails 3.2 support is still included but no longer required to pass all the tests).
+# 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
+
+## 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
-  default_scope -> { time(:hour).limit(1000) }
   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
+# => 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
+# => select * from "metrics" group by time(1w) where account_id=1
+```
+
+### Active Record integration
 
-  ```
-- Integrate with your model:
-  ```ruby
+You can association metrics with Active Record models:
+
+```ruby
 class UserVisits < Influxer::Metrics
 end
 
@@ -41,10 +92,18 @@ end
 
 user = User.find(1)
 user.visits.write(page_id: "home")
-  #=> < creates point {user_id: 1, page_id: 'home'} in 'user_visits' series >
+#=> < 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'
-  ```
+#=> 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
 
-Find more on [Wiki](https://github.com/palkan/influxer/wiki).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/influxer/metrics/metrics.rb

@@ -33,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

data/lib/influxer/metrics/relation.rb

@@ -22,11 +22,11 @@ module Influxer
 
     MULTI_KEY_METHODS = %i[fanout].freeze
 
-    SINGLE_VALUE_METHODS = %i[fill time limit offset slimit soffset from normalized].freeze
+    SINGLE_VALUE_METHODS = %i[fill time limit offset slimit soffset from normalized timezone].freeze
 
     MULTI_VALUE_SIMPLE_METHODS = %i[select group].freeze
 
-    SINGLE_VALUE_SIMPLE_METHODS = %i[fill limit offset slimit soffset from].freeze
+    SINGLE_VALUE_SIMPLE_METHODS = %i[fill limit offset slimit soffset from timezone].freeze
 
     MULTI_VALUE_METHODS.each do |name|
       class_eval <<-CODE, __FILE__, __LINE__ + 1
@@ -121,6 +121,13 @@ module Influxer
       self
     end
 
+    def timezone(val)
+      return self if val.blank?
+
+      @values[:timezone] = val
+      self
+    end
+
     def order(val)
       case val
       when Hash
@@ -159,6 +166,7 @@ module Influxer
       sql << "offset #{offset_value}" unless offset_value.nil?
       sql << "slimit #{slimit_value}" unless slimit_value.nil?
       sql << "soffset #{soffset_value}" unless soffset_value.nil?
+      sql << "TZ('#{timezone_value}')" unless timezone_value.blank?
       sql.join " "
     end
     # rubocop:enable Metrics/AbcSize
@@ -205,7 +213,11 @@ module Influxer
     end
 
     def delete_all
-      sql = ["drop series"]
+      sql = if where_contains_time?
+        ["delete"]
+      else
+        ["drop series"]
+      end
 
       sql << "from #{@instance.series}"
 

data/lib/influxer/metrics/relation/where_clause.rb

@@ -104,5 +104,11 @@ module Influxer
       @null_relation = !negate
       negate ? "time >= 0" : "time < 0"
     end
+
+    def where_contains_time?
+      where_values.any? do |where_clause|
+        /time( )/ === where_clause
+      end
+    end
   end
 end

data/lib/influxer/rails/client.rb

@@ -33,7 +33,7 @@ module Influxer
     # of config.cache if defined
     def cache_options(sql = nil)
       options = Influxer.config.cache.dup
-      options[:expires_in] = (options[:cache_now_for] || 60) if sql =~ /\snow\(\)/
+      options[:expires_in] = (options[:cache_now_for] || 60) if /\snow\(\)/.match?(sql)
       options
     end
 

data/lib/influxer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Influxer # :nodoc:
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: influxer
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Vlad Dem
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -143,21 +143,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- Changelog.md
-- Gemfile
-- MIT-LICENSE
+- CHANGELOG.md
+- LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- gemfiles/rails32.gemfile
-- gemfiles/rails42.gemfile
-- gemfiles/rails5.gemfile
-- gemfiles/rails6.gemfile
-- influxer.gemspec
 - lib/influxer.rb
 - lib/influxer/client.rb
 - lib/influxer/config.rb
@@ -177,24 +165,6 @@ files:
 - lib/influxer/model.rb
 - lib/influxer/rails/client.rb
 - lib/influxer/version.rb
-- spec/cases/points_spec.rb
-- spec/cases/write_points_spec.rb
-- spec/client_spec.rb
-- spec/fixtures/empty_result.json
-- spec/fixtures/single_series.json
-- spec/metrics/metrics_spec.rb
-- spec/metrics/relation_spec.rb
-- spec/metrics/scoping_spec.rb
-- spec/model/user_spec.rb
-- spec/spec_helper.rb
-- spec/support/metrics/action_metrics.rb
-- spec/support/metrics/custom_metrics.rb
-- spec/support/metrics/dummy_metrics.rb
-- spec/support/metrics/user_metrics.rb
-- spec/support/metrics/visits_metrics.rb
-- spec/support/shared_contexts/shared_precision.rb
-- spec/support/shared_contexts/shared_query.rb
-- spec/support/user.rb
 homepage: http://github.com/palkan/influxer
 licenses:
 - MIT
@@ -204,7 +174,7 @@ metadata:
   documentation_uri: http://github.com/palkan/influxer
   homepage_uri: http://github.com/palkan/influxer
   source_code_uri: http://github.com/palkan/influxer
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -219,8 +189,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.1.2
+signing_key:
 specification_version: 4
 summary: InfluxDB for Rails
 test_files: []

data/.gitignore

@@ -1,37 +0,0 @@
-# Numerous always-ignore extensions
-*.diff
-*.err
-*.orig
-*.log
-*.rej
-*.swo
-*.swp
-*.vi
-*~
-*.sass-cache
-*.iml
-.idea/
-
-# Sublime
-*.sublime-project
-*.sublime-workspace
-
-# OS or Editor folders
-.DS_Store
-.cache
-.project
-.settings
-.tmproj
-Thumbs.db
-
-.bundle/
-log/*.log
-pkg/
-spec/dummy/db/*.sqlite3
-spec/dummy/db/*.sqlite3-journal
-spec/dummy/tmp/
-tmp/
-
-Gemfile.lock
-Gemfile.local
-*.gem

data/.rspec

@@ -1,2 +0,0 @@
---color
--f d