influxer 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b4166514c7bebd4c2af58c8362902eac3ee2113
-  data.tar.gz: 4d635a59d2969f7be5134018504d1fd93679d73c
+  metadata.gz: a70e770a10a4ba180183d675081265ed34c96a18
+  data.tar.gz: ce6d3d39937bc7eeabc4b4076bb9095e6b9eac59
 SHA512:
-  metadata.gz: 46fdff670e7c1f5d82dd4c89724c3b2710946bed1e5b584fb0fdddd2b78f7279d5e2a551599592f3ae7d99b2a1fb0f494cfbc8df981b40fada5ce2512cad04e5
-  data.tar.gz: 7db66507e1616b9dd99dfe55310e73c080c655fd70f2f8506eb6d294e61bfd9fb94401a6caf0ef23de9e66235fafb7afe5e550cdcd68cd8aa1961175fb00d515
+  metadata.gz: 23a20e2f8130fa8ad58c1ad961afd71f8bfa3a55ed744dc999857c6dd505b69ddcfa659cc2a885175a6e21005f836e1ee1f6d01850e9fbf898234e8ff6108562
+  data.tar.gz: 0373880b57e571673420d63297b81d4ffd8af6dee289adb2c9ccc8332447e736b841c92a0b2f6b11ec04e72ddd066a7ede9742d545706d1607d0a6891e3037b4

data/.hound.yml

@@ -1,2 +1,12 @@
 ruby:
-  enabled: true
+  enabled: true
+  config_file: .rubocop.yml
+
+javascript:
+  enabled: false
+
+coffeescript:
+  enabled: false
+
+sass:
+  enabled: false

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  # Include gemspec and Rakefile
+  Include:
+    - 'lib/**/*.rb'
+    - 'lib/**/*.rake'
+    - 'spec/**/*.rb'
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/dummy/**/*'
+  RunRailsCops: true
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/StringLiterals: 
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 100
+  Exclude:
+    - 'spec/**/*.rb'
+
+Rails/Date:
+  Enabled: false
+
+Rails/TimeZone:
+  Enabled: false

data/Changelog.md

@@ -1,3 +1,7 @@
+## 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

data/influxer.gemspec

@@ -14,10 +14,10 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split($/)
   s.require_paths = ["lib"]
-  
+
   s.add_runtime_dependency "rails", '~> 4.0'
-  s.add_dependency "influxdb", "~> 0.1.0", ">= 0.1.8"
-  s.add_dependency "anyway_config", "~>0", ">= 0.3"
+  s.add_dependency "influxdb", "~> 0.1.8"
+  s.add_dependency "anyway_config", "~>0.3"
 
   s.add_development_dependency "timecop"
   s.add_development_dependency "simplecov", ">= 0.3.8"

data/lib/influxer/client.rb

@@ -1,6 +1,7 @@
 require 'influxdb'
 
 module Influxer
+  # InfluxDB API client
   class Client < ::InfluxDB::Client
     def initialize
       @instrumenter = ActiveSupport::Notifications.instrumenter
@@ -9,47 +10,46 @@ module Influxer
 
     def cached_query(sql)
       log(sql) do
-        unless Influxer.config.cache == false
-          Rails.cache.fetch(normalized_cache_key(sql), cache_options(sql)) { self.query(sql) }
+        if Influxer.config.cache == false
+          query(sql)
         else
-          self.query(sql)
+          Rails.cache.fetch(normalized_cache_key(sql), cache_options(sql)) { query(sql) }
         end
       end
     end
-    
+
     private
 
-      def log(sql)
-        return yield unless logger.debug?
+    def log(sql)
+      return yield unless logger.debug?
 
-        _start = Time.now
-        res = yield
-        _duration = (Time.now - _start)*1000
-        
-        name  = "InfluxDB SQL (#{_duration.round(1)}ms)"
+      start_ts = Time.now
+      res = yield
+      duration = (Time.now - start_ts) * 1000
 
-        # bold black name and blue query string
-        msg = "\e[1m\e[30m#{name}\e[0m  \e[34m#{sql}\e[0m"
-        logger.debug msg
-        res
-      end
+      name  = "InfluxDB SQL (#{duration.round(1)}ms)"
 
-      def cache_options(sql=nil)
-        options = Influxer.config.cache.dup
-        # if sql contains 'now()' set expires to 1 minute or :cache_now_for value of config.cache if defined
-        if sql =~ /\snow\(\)/
-          options[:expires_in] = options[:cache_now_for] || 60
-        end
-        options
-      end
+      # bold black name and blue query string
+      msg = "\e[1m\e[30m#{name}\e[0m  \e[34m#{sql}\e[0m"
+      logger.debug msg
+      res
+    end
 
-      # add prefix; remove whitespaces
-      def normalized_cache_key(sql)
-        "influxer:#{sql.gsub(/\s*/, '')}"
-      end
+    # if sql contains 'now()' set expires to 1 minute or :cache_now_for value
+    # 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
+    end
 
-      def logger
-        Rails.logger
-      end
+    # add prefix; remove whitespaces
+    def normalized_cache_key(sql)
+      "influxer:#{sql.gsub(/\s*/, '')}"
+    end
+
+    def logger
+      Rails.logger
+    end
   end
-end
+end

data/lib/influxer/config.rb

@@ -1,12 +1,13 @@
 require 'anyway'
 
 module Influxer
+  # Influxer configuration
   class Config < Anyway::Config
     config_name :influxdb
 
-    attr_config database: 'db', 
+    attr_config database: 'db',
                 host: 'localhost',
-                port: 8083,
+                port: 8086,
                 username: 'root',
                 password: 'root',
                 use_ssl: false,
@@ -22,9 +23,7 @@ module Influxer
     def load
       super
       # we want pass @cache value as options to cache store, so we want it to be a Hash
-      if @cache == true
-        @cache = {}.with_indifferent_access
-      end
+      @cache = {}.with_indifferent_access if @cache == true
     end
   end
-end
+end

data/lib/influxer/engine.rb

@@ -2,11 +2,11 @@ require 'influxer'
 require 'rails'
 
 module Influxer
-  class Engine < Rails::Engine
-    initializer "extend ActiveRecord with influxer" do |app|
+  class Engine < Rails::Engine # :nodoc:
+    initializer "extend ActiveRecord with influxer" do |_app|
       ActiveSupport.on_load(:active_record) do
         ActiveRecord::Base.send :include, Influxer::Model
       end
-    end    
+    end
   end
-end
+end

data/lib/influxer/metrics/fanout.rb

@@ -1,53 +1,65 @@
 module Influxer
-  module Fanout
+  module Fanout # :nodoc: all
     extend ActiveSupport::Concern
 
     included do
       class_attribute :fanouts, :fanouts_by_name, :fanout_options
       self.fanouts = []
       self.fanouts_by_name = {} # to use within `fanout?`
-      self.fanout_options = {delimeter: "_"} 
-    end 
-    
+      self.fanout_options = { delimeter: "_" }
+    end
+
     module ClassMethods
       # Define fanouts for metrics as array of keys.
       # Order of keys is important.
       # Fanout delimeter can be set with 'delimiter' option (defaults to '_').
-      # 
+      #
       #   class MyMetrics < Influxer::Metrics
       #     set_series "my_points"
       #     fanout :account_id, :user_id
       #   end
-      #   
+      #
       #   MyMetrics.where(user_id: 1).where(account_id: 10)
       #   # select * from my_points_account_id_10_user_id_1
-      #   
+      #
       #   class MyMetrics < Influxer::Metrics
       #     set_series "my_points"
       #     fanout :account_id, :user_id, delimiter: "."
       #   end
-      #   
+      #
       #   MyMetrics.where(user_id: 1).where(account_id: 10).where("req_time > 1000")
       #   # select * from my_points.account_id.10.user_id.1 where req_time > 1000
-         
+
       def fanout(*args, **hargs)
-        self.fanout_options = self.fanout_options.merge hargs
+        self.fanout_options = fanout_options.merge hargs
+
+        names = args.map(&:to_s)
 
-        names = args.map(&:to_s) # convert all to strings (because args can be both Symbols and Strings)
-        
-        self.fanouts = (self.fanouts+names).uniq
+        self.fanouts = (fanouts + names).uniq
 
         names_hash = {}
         names.each do |name|
           names_hash[name] = 1
         end
 
-        self.fanouts_by_name = self.fanouts_by_name.merge names_hash
-      end      
+        self.fanouts_by_name = fanouts_by_name.merge names_hash
+      end
 
       def fanout?(key)
-        self.fanouts_by_name.key?(key.to_s)
+        fanouts_by_name.key?(key.to_s)
+      end
+
+      def fanout_rxp
+        return @fanout_rxp unless @fanout_rxp.nil?
+        series_name = Regexp.escape(quoted_series[1..-2])
+        del = Regexp.escape(fanout_options[:delimeter])
+        rstr = "^#{series_name}"
+        fanouts.each do |f_name|
+          rstr += "(?:#{del}#{Regexp.escape(f_name)}#{del}(?<#{f_name}>[^#{del}]+))?"
+        end
+        rstr += "$"
+        @fanout_rxp = Regexp.new(rstr)
       end
     end
   end
-end
+end

data/lib/influxer/metrics/metrics.rb

@@ -7,6 +7,7 @@ module Influxer
   class MetricsError < StandardError; end
   class MetricsInvalid < MetricsError; end
 
+  # Base class for InfluxDB querying and writing
   class Metrics
     include ActiveModel::Model
     include ActiveModel::Validations
@@ -19,13 +20,18 @@ module Influxer
 
     class << self
       # delegate query functions to all
-      delegate *(
-        [
-          :write, :select, :where, :group,
-          :merge, :time, :past, :since, :limit,
-          :fill, :delete_all
-        ]+Influxer::Calculations::CALCULATION_METHODS),
-      to: :all
+      delegate(
+        *(
+          [
+            :write, :select, :where, :group,
+            :merge, :time, :past, :since, :limit,
+            :fill, :delete_all
+          ] + Influxer::Calculations::CALCULATION_METHODS
+        ),
+        to: :all
+      )
+
+      attr_reader :series
 
       def attributes(*attrs)
         attrs.each do |name|
@@ -45,9 +51,9 @@ module Influxer
 
       def set_series(*args)
         if args.empty?
-          matches = self.to_s.match(/^(.*)Metrics$/)
+          matches = to_s.match(/^(.*)Metrics$/)
           if matches.nil?
-            @series = self.superclass.respond_to?(:series) ? self.superclass.series : self.to_s.underscore
+            @series = superclass.respond_to?(:series) ? superclass.series : to_s.underscore
           else
             @series = matches[1].split("::").join("_").underscore
           end
@@ -58,10 +64,6 @@ module Influxer
         end
       end
 
-      def series
-        @series
-      end
-
       def all
         if current_scope
           current_scope.clone
@@ -69,6 +71,23 @@ module Influxer
           default_scoped
         end
       end
+
+      def quoted_series(val = @series, instance = nil)
+        case val
+        when Regexp
+          val.inspect
+        when Proc
+          quoted_series(val.call(instance))
+        when Array
+          if val.length > 1
+            "merge(#{ val.map { |s| quoted_series(s) }.join(',') })"
+          else
+            quoted_series(val.first)
+          end
+        else
+          '"' + val.to_s.gsub(/\"/) { %q(\") } + '"'
+        end
+      end
     end
 
     def initialize(attributes = {})
@@ -78,7 +97,7 @@ module Influxer
     end
 
     def write
-      raise MetricsError.new('Cannot write the same metrics twice') if self.persisted?
+      fail MetricsError if self.persisted?
 
       return false if self.invalid?
 
@@ -89,8 +108,8 @@ module Influxer
     end
 
     def write!
-      raise MetricsInvalid.new('Validation failed') if self.invalid?
-      self.write
+      fail MetricsInvalid if self.invalid?
+      write
     end
 
     def write_point
@@ -103,39 +122,19 @@ module Influxer
     end
 
     def series
-      quote_series(self.class.series)
+      self.class.quoted_series(self.class.series, self)
     end
 
     def client
       Influxer.client
     end
 
-
     attributes :time
 
-
-    def quote_series(val)
-      case val
-      when Regexp
-        val.inspect
-      when Proc
-        quote_series(self.class.series.call(self))
-      when Array
-        if val.length > 1
-          "merge(#{ val.map{ |s| quote_series(s) }.join(',') })"
-        else
-          quote_series(val.first)
-        end
-      else
-        '"'+val.to_s.gsub(/\"/){ %q{\"} }+'"'
-      end
-    end
-
     private
 
     def unquote(name)
-      name.gsub(/(\A['"]|['"]\z)/,'')
+      name.gsub(/(\A['"]|['"]\z)/, '')
     end
-
   end
-end
+end

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

@@ -1,9 +1,9 @@
 module Influxer
-  module Calculations
-    CALCULATION_METHODS = 
+  module Calculations #:nodoc:
+    CALCULATION_METHODS =
       [
-        :count, :min, :max, :mean, 
-        :mode, :median, :distinct, :derivative, 
+        :count, :min, :max, :mean,
+        :mode, :median, :distinct, :derivative,
         :stddev, :sum, :first, :last, :difference,
         :percentile, :histogram, :top, :bottom
       ]
@@ -11,11 +11,11 @@ module Influxer
     CALCULATION_METHODS.each do |name|
       class_eval <<-CODE, __FILE__, __LINE__ + 1
         def #{name}(val, option=nil)                                                   # def count(val)
-          @values[:has_calculations] = true                                            #   @values[:has_calculations] = true 
-          select_values << "#{name}(\#\{val\}\#\{option ? ','+option.to_s : ''\})"     #   select_values << "count(\#\{val\})" 
+          @values[:has_calculations] = true                                            #   @values[:has_calculations] = true
+          select_values << "#{name}(\#\{val\}\#\{option ? ','+option.to_s : ''\})"     #   select_values << "count(\#\{val\})"
           self                                                                         #   self
         end                                                                            # end
       CODE
     end
   end
-end
+end

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

@@ -1,11 +1,11 @@
 module Influxer
-  module FanoutQuery
-    # Instance methods are included to Relation    
+  module FanoutQuery #:nodoc:
+    # Instance methods are included to Relation
     def build_fanout(key, val)
       @values[:has_fanout] = true
       if val.is_a?(Regexp)
         @values[:fanout_rxp] = true
-        fanout_values[key.to_s] = val.inspect[1..-2]     
+        fanout_values[key.to_s] = val.inspect[1..-2]
       else
         fanout_values[key.to_s] = val.to_s
       end
@@ -19,15 +19,31 @@ module Influxer
             fan_parts << name
             fan_parts << fanout_values[name]
           end
-        end  
+        end
         if @values[:fanout_rxp] == true
-          "merge(/^#{ fan_parts.join( @klass.fanout_options[:delimeter] ) }$/)"
+          "/^#{ fan_parts.join(@klass.fanout_options[:delimeter]) }$/"
         else
-          @instance.quote_series(fan_parts.join(@klass.fanout_options[:delimeter]))
+          @klass.quoted_series(fan_parts.join(@klass.fanout_options[:delimeter]))
         end
       else
         @instance.series
       end
     end
+
+    def prepare_fanout_points(hash)
+      hash.each do |k, v|
+        data = extract_values(k)
+        v.each { |p| p.merge!(data) } unless data.empty?
+      end
+      hash
+    end
+
+    private
+
+    # Extract fanout values from series name
+    def extract_values(name)
+      data = @klass.fanout_rxp.match(name)
+      Hash[data.names.zip(data.captures)].delete_if { |_k, v| v.nil? }
+    end
   end
-end
+end

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

@@ -1,5 +1,5 @@
 module Influxer
-  module TimeQuery
+  module TimeQuery #:nodoc:
     TIME_ALIASES = {
       hour: '1h',
       minute: '1m',
@@ -7,29 +7,29 @@ module Influxer
       ms: '1u',
       week: '1w',
       day: '1d',
-      month: '30d'        
+      month: '30d'
     }
 
     # Add group value to relation. To be used instead of `group("time(...)").
     # Accepts symbols and strings.
-    # 
+    #
     # You can set fill value within options.
     #
     #    Metrics.time(:hour)
     #    # select * from metrics group by time(1h)
-    #    
+    #
     #    Metrics.time("4d", fill: 0)
     #    # select * from metrics group by time(4d) fill(0)
 
-    def time(val, options={})
+    def time(val, options = {})
       if val.is_a?(Symbol)
-        @values[:time] = TIME_ALIASES[val] || '1'+val.to_s
+        @values[:time] = TIME_ALIASES[val] || '1' + val.to_s
       else
         @values[:time] = val
       end
 
       unless options[:fill].nil?
-        fill( (options[:fill] == :null) ? 'null' : options[:fill].to_i)
+        fill((options[:fill] == :null) ? 'null' : options[:fill].to_i)
       end
       self
     end
@@ -39,10 +39,10 @@ module Influxer
     #
     #    Metrics.past(:hour)
     #    # select * from metrics where time > now() - 1h
-    #    
+    #
     #    Metrics.past(:d)
-    #    # select * from metrics where time > now() - 1d    
-    #        
+    #    # select * from metrics where time > now() - 1d
+    #
     #    Metrics.past(2.days)
     #    # select * from metrics where time > now() - 172800s
 
@@ -60,9 +60,9 @@ module Influxer
     # Shortcut to define start point of the time interval.
     # Accepts DateTime objects.
     #
-    #    Metrics.since(1.day.ago) # assume that now is 2014-12-31 12:00:00 UTC 
+    #    Metrics.since(1.day.ago) # assume that now is 2014-12-31 12:00:00 UTC
     #    # select * from metrics where time > 1420027200s
-    #    
+    #
     #    Metrics.since(Time.local(2014,12,31))
     #    # select * from metrics where time > 1419984000s
 
@@ -70,4 +70,4 @@ module Influxer
       where("time > #{val.to_i}s")
     end
   end
-end
+end