influxer 0.2.2 → 0.2.4

data/lib/influxer/metrics/relation.rb

@@ -3,13 +3,14 @@ require 'influxer/metrics/relation/fanout_query'
 require 'influxer/metrics/relation/calculations'
 
 module Influxer
+  # Relation is used to build queries
   class Relation
-    attr_reader :values
-
     include Influxer::TimeQuery
     include Influxer::FanoutQuery
     include Influxer::Calculations
-    
+
+    attr_reader :values
+
     MULTI_VALUE_METHODS = [:select, :where, :group]
 
     MULTI_KEY_METHODS = [:fanout]
@@ -62,40 +63,38 @@ module Influxer
       CODE
     end
 
-
-    class << self
-      # delegate array methods to to_a
-      delegate :to_xml, :to_yaml, :length, :collect, :map, :each, :all?, :include?, :to_ary, :join, to: :to_a
-    end
+    # delegate array methods to to_a
+    delegate :to_xml, :to_yaml, :length, :collect, :map, :each, :all?, :include?, :to_ary, :join,
+             to: :to_a
 
     # Initialize new Relation for 'klass' (Class) metrics.
-    # 
+    #
     # Available params:
-    #  :attributes - hash of attributes to be included to new Metrics object and where clause of Relation
-    # 
+    #  :attributes - hash of attributes to be included to new Metrics object
+    #  and where clause of Relation
+    #
     def initialize(klass, params = {})
       @klass = klass
       @instance = klass.new params[:attributes]
-      self.reset
-      self.where(params[:attributes]) if params[:attributes].present?
+      reset
+      where(params[:attributes]) if params[:attributes].present?
       self
     end
 
-
     def write(params = {})
       build params
       @instance.write
     end
 
     def build(params = {})
-      params.each do |key,val|
+      params.each do |key, val|
         @instance.send("#{key}=", val) if @instance.respond_to?(key)
       end
       @instance
     end
 
     # accepts hash or strings conditions
-    def where(*args,**hargs)
+    def where(*args, **hargs)
       build_where(args, hargs, false)
       self
     end
@@ -107,34 +106,24 @@ module Influxer
 
     def to_sql
       sql = ["select"]
+      select_values << "*" if select_values.empty?
 
-      if select_values.empty?
-        sql << "*"
-      else
-        sql << select_values.uniq.join(",")
-      end 
+      sql << select_values.uniq.join(",")
 
       sql << "from #{ build_series_name }"
+      sql << "merge #{ @klass.quoted_series(merge_value) }" unless merge_value.nil?
 
-      unless merge_value.nil?
-        sql << "merge #{ @instance.quote_series(merge_value) }"
-      end
-
-      unless group_values.empty? and time_value.nil?
-        sql << "group by #{ (time_value.nil? ? [] : ['time('+@values[:time]+')']).concat(group_values).uniq.join(",") }"
+      unless group_values.empty? && time_value.nil?
+        group_fields = (time_value.nil? ? [] : ['time(' + @values[:time] + ')']) + group_values
+        group_fields.uniq!
+        sql << "group by #{ group_fields.join(',') }"
       end
 
-      unless fill_value.nil?
-        sql << "fill(#{ fill_value })"
-      end
+      sql << "fill(#{ fill_value })" unless fill_value.nil?
 
-      unless where_values.empty?
-        sql << "where #{ where_values.join(" and ") }"
-      end
+      sql << "where #{ where_values.join(' and ') }" unless where_values.empty?
 
-      unless limit_value.nil?
-        sql << "limit #{ limit_value }"
-      end
+      sql << "limit #{ limit_value }" unless limit_value.nil?
       sql.join " "
     end
 
@@ -156,10 +145,10 @@ module Influxer
         select_values.clear
         limit(1).load
       end
-      return @records.empty? 
+      @records.empty?
     end
 
-    def as_json(options=nil)
+    def as_json(options = nil)
       to_a.as_json(options)
     end
 
@@ -174,9 +163,7 @@ module Influxer
 
       sql << "from #{@instance.series}"
 
-      unless where_values.empty?
-        sql << "where #{where_values.join(" and ")}"
-      end
+      sql << "where #{where_values.join(' and ')}" unless where_values.empty?
 
       sql = sql.join " "
 
@@ -193,11 +180,11 @@ module Influxer
     def merge!(rel)
       return self if rel.nil?
       MULTI_VALUE_METHODS.each do |method|
-        (@values[method]||=[]).concat(rel.values[method]).uniq! unless rel.values[method].nil?
+        (@values[method] ||= []).concat(rel.values[method]).uniq! unless rel.values[method].nil?
       end
 
       MULTI_KEY_METHODS.each do |method|
-        (@values[method]||={}).merge!(rel.values[method]) unless rel.values[method].nil?
+        (@values[method] ||= {}).merge!(rel.values[method]) unless rel.values[method].nil?
       end
 
       SINGLE_VALUE_METHODS.each do |method|
@@ -207,93 +194,93 @@ module Influxer
       self
     end
 
-
     protected
-      def build_where(args, hargs, negate)
-        case
-        when (args.present? and args[0].is_a?(String))
-          where_values.concat args.map{|str| "(#{str})"}
-        when hargs.present?
-          build_hash_where(hargs, negate)
-        else
-          false
-        end
-      end
 
-      def build_hash_where(hargs, negate = false)
-        hargs.each do |key, val|
-          if @klass.fanout?(key)
-            build_fanout(key,val)
-          else
-            where_values << "(#{ build_eql(key,val,negate) })"
-          end
-        end
+    def build_where(args, hargs, negate)
+      case
+      when (args.present? && args[0].is_a?(String))
+        where_values.concat args.map { |str| "(#{str})" }
+      when hargs.present?
+        build_hash_where(hargs, negate)
+      else
+        false
       end
+    end
 
-      def build_eql(key,val,negate)
-        case val
-        when Regexp
-          "#{key}#{ negate ? '!~' : '=~'}#{val.inspect}"
-        when Array
-          build_in(key,val,negate)
-        when Range
-          build_range(key,val,negate)
+    def build_hash_where(hargs, negate = false)
+      hargs.each do |key, val|
+        if @klass.fanout?(key)
+          build_fanout(key, val)
         else
-          "#{key}#{ negate ? '<>' : '='}#{quoted(val)}"
-        end  
-      end
-
-      def build_in(key, arr, negate)
-        buf = []
-        arr.each do |val|
-          buf << build_eql(key,val,negate)
+          where_values << "(#{ build_eql(key, val, negate) })"
         end
-        "#{ buf.join( negate ? ' and ' : ' or ') }"
       end
+    end
 
-      def build_range(key,val,negate)
-        unless negate
-          "#{key}>#{quoted(val.begin)} and #{key}<#{quoted(val.end)}"
-        else
-          "#{key}<#{quoted(val.begin)} and #{key}>#{quoted(val.end)}"
-        end  
+    def build_eql(key, val, negate)
+      case val
+      when Regexp
+        "#{key}#{ negate ? '!~' : '=~'}#{val.inspect}"
+      when Array
+        build_in(key, val, negate)
+      when Range
+        build_range(key, val, negate)
+      else
+        "#{key}#{ negate ? '<>' : '='}#{quoted(val)}"
       end
+    end
 
-      def loaded?
-        @loaded
+    def build_in(key, arr, negate)
+      buf = []
+      arr.each do |val|
+        buf << build_eql(key, val, negate)
       end
+      "#{ buf.join(negate ? ' and ' : ' or ') }"
+    end
 
-      def reset
-        @values = {}
-        @records = nil
-        @loaded = false
-        self
+    def build_range(key, val, negate)
+      if negate
+        "#{key}<#{quoted(val.begin)} and #{key}>#{quoted(val.end)}"
+      else
+        "#{key}>#{quoted(val.begin)} and #{key}<#{quoted(val.end)}"
       end
+    end
 
-      def reload
-        self.reset
-        self.load
-        self
-      end
+    def loaded?
+      @loaded
+    end
 
-      def quoted(val)
-        if val.is_a?(String) or val.is_a?(Symbol)
-          "'#{val}'"
-        elsif val.kind_of?(Time) or val.kind_of?(DateTime)
-          "#{val.to_i}s"
-        else
-          val.to_s
-        end
-      end
+    def reset
+      @values = {}
+      @records = nil
+      @loaded = false
+      self
+    end
 
-      def method_missing(method, *args, &block)
-        if @klass.respond_to?(method)    
-          merge!(scoping { @klass.public_send(method, *args, &block) })
-        end
-      end
+    def reload
+      reset
+      load
+      self
+    end
 
-      def get_points(hash)
-        hash.values.reduce([],:+)
+    def quoted(val)
+      if val.is_a?(String) || val.is_a?(Symbol)
+        "'#{val}'"
+      elsif val.is_a?(Time) || val.is_a?(DateTime)
+        "#{val.to_i}s"
+      else
+        val.to_s
       end
+    end
+
+    def get_points(hash)
+      prepare_fanout_points(hash) if @values[:has_fanout] == true
+      hash.values.reduce([], :+)
+    end
+
+    def method_missing(method, *args, &block)
+      return super unless @klass.respond_to?(method)
+      merge!(scoping { @klass.public_send(method, *args, &block) })
+    end
   end
-end 
+end

data/lib/influxer/metrics/scoping/default.rb

@@ -1,6 +1,8 @@
+require 'active_support/concern'
+
 module Influxer
   module Scoping
-    module Default
+    module Default # :nodoc: all
       extend ActiveSupport::Concern
 
       included do
@@ -18,11 +20,11 @@ module Influxer
         end
 
         def default_scoped
-          self.default_scopes.inject(Relation.new(self)) do |rel, scope| 
-            rel.merge!(rel.scoping{ scope.call })
+          self.default_scopes.inject(Relation.new(self)) do |rel, scope|
+            rel.merge!(rel.scoping { scope.call })
           end
         end
       end
     end
   end
-end
+end

data/lib/influxer/metrics/scoping/named.rb

@@ -1,11 +1,13 @@
+require 'active_support/concern'
+
 module Influxer
   module Scoping
-    module Named
+    module Named # :nodoc: all
       extend ActiveSupport::Concern
 
       module ClassMethods
         def scope(name, scope)
-          raise Error.new("Scope not defined: #{name}") if scope.nil? or !scope.respond_to?(:call)
+          fail "Scope not defined: #{name}" if scope.nil? || !scope.respond_to?(:call)
           singleton_class.send(:define_method, name) do |*args|
             rel = all
             rel.merge!(rel.scoping { scope.call(*args) })
@@ -15,4 +17,4 @@ module Influxer
       end
     end
   end
-end
+end

data/lib/influxer/metrics/scoping.rb

@@ -3,22 +3,22 @@ require 'influxer/metrics/scoping/default'
 require 'influxer/metrics/scoping/named'
 
 module Influxer
-  module Scoping
+  module Scoping # :nodoc:
     extend ActiveSupport::Concern
 
-    class Error < StandardError; end;
+    class Error < StandardError; end
 
     included do
       include Default
       include Named
     end
 
-    module ClassMethods
-      def current_scope #:nodoc:
+    module ClassMethods # :nodoc:
+      def current_scope
         ScopeRegistry.value_for(:current_scope, name)
       end
 
-      def current_scope=(scope) #:nodoc:
+      def current_scope=(scope)
         ScopeRegistry.set_value_for(:current_scope, name, scope)
       end
     end
@@ -48,9 +48,10 @@ module Influxer
 
       def raise_invalid_scope_type!(scope_type)
         if !VALID_SCOPE_TYPES.include?(scope_type)
-          raise ArgumentError, "Invalid scope type '#{scope_type}' sent to the registry. Scope types must be included in VALID_SCOPE_TYPES"
+          raise ArgumentError, "Invalid scope type '#{scope_type}' sent to the registry. \
+          Scope types  must be included in VALID_SCOPE_TYPES"
         end
       end
     end
   end
-end
+end

data/lib/influxer/model.rb

@@ -1,35 +1,34 @@
 require 'active_support'
 
 module Influxer
+  # Add `has_metrics` method to AR::Base
   module Model
     extend ActiveSupport::Concern
-  
-    module ClassMethods
+
+    module ClassMethods # :nodoc:
       def has_metrics(*args, **params)
         metrics_name = args.empty? ? "metrics" : args.first.to_s
 
-        klass = params[:class_name].present? ? params[:class_name] : "#{self}Metrics" 
+        klass = params[:class_name].present? ? params[:class_name] : "#{self}Metrics"
         klass = klass.constantize
 
         attrs = nil
 
-        if params[:inherits].present? 
-          attrs = params[:inherits]
-        end
+        attrs = params[:inherits] if params[:inherits].present?
 
-        _foreign_key = params.key?(:foreign_key) ? params[:foreign_key] : self.to_s.foreign_key
+        foreign_key = params.key?(:foreign_key) ? params[:foreign_key] : to_s.foreign_key
 
         define_method(metrics_name) do
-          rel_attrs = _foreign_key ? {_foreign_key => self.id} : {}
-          
+          rel_attrs = foreign_key ? { foreign_key => id } : {}
+
           unless attrs.nil?
             attrs.each do |key|
-              rel_attrs[key] = self.send(key)
-            end 
+              rel_attrs[key] = send(key)
+            end
           end
           Relation.new klass, attributes: rel_attrs
         end
       end
     end
   end
-end
+end

data/lib/influxer/version.rb

@@ -1,3 +1,3 @@
-module Influxer
-  VERSION = "0.2.2"
+module Influxer # :nodoc:
+  VERSION = "0.2.4"
 end

data/lib/influxer.rb

@@ -1,11 +1,12 @@
 require 'influxer/version'
 
+# Rails client for InfluxDB
 module Influxer
   require 'influxer/config'
   require 'influxer/client'
   require 'influxer/metrics/metrics'
 
-  module Model
+  module Model # :nodoc:
     require 'influxer/model'
   end
 

data/spec/client_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Influxer::Client do
-
   after(:each) do
     Rails.cache.clear
   end
@@ -17,7 +16,7 @@ describe Influxer::Client do
 
   describe "cache" do
     before do
-      allow_any_instance_of(Influxer::Client).to receive(:query) do |_, sql|   
+      allow_any_instance_of(Influxer::Client).to receive(:query) do |_, sql|
         sql
       end
     end
@@ -36,13 +35,13 @@ describe Influxer::Client do
     end
 
     it "should write data to cache with expiration" do
-      conf.cache = {expires_in: 1}
+      conf.cache = { expires_in: 1 }
 
       client.cached_query(q)
       expect(Rails.cache.exist?("influxer:listseries")).to be_truthy
-      
+
       sleep 2
       expect(Rails.cache.exist?("influxer:listseries")).to be_falsey
     end
   end
-end
+end

data/spec/config_spec.rb

@@ -1,18 +1,17 @@
 require 'spec_helper'
 
 describe Influxer::Config do
-
   let(:conf) { Influxer.config }
 
   it "should load config from file" do
     expect(conf.retry).to eq 5
-    expect(conf.host).to eq "test.host"   
+    expect(conf.host).to eq "test.host"
   end
 
   unless Rails.application.try(:secrets).nil?
     it "should load config from secrets" do
       expect(conf.username).to eq "test"
-      expect(conf.password).to eq "test"   
+      expect(conf.password).to eq "test"
     end
   end
 end

data/spec/dummy/app/metrics/testo_metrics.rb

@@ -1,3 +1,3 @@
 class TestoMetrics < Influxer::Metrics
   attributes :testo_id, :receipt_id, :testo
-end
+end

data/spec/dummy/app/models/testo.rb

@@ -3,4 +3,4 @@ class Testo < ActiveRecord::Base
   has_metrics :testo_metrics, class_name: "TestoMetrics", inherits: [:receipt_id]
   has_metrics :testo2_metrics, class_name: "TestoMetrics", foreign_key: :testo
   has_metrics :custom_metrics, class_name: "TestoMetrics", foreign_key: nil
-end
+end

data/spec/dummy/config/application.rb

@@ -21,4 +21,3 @@ module Dummy
     # config.i18n.default_locale = :de
   end
 end
-

data/spec/dummy/config/initializers/cookies_serializer.rb

@@ -1,3 +1,3 @@
 # Be sure to restart your server when you modify this file.
 
-Dummy::Application.config.action_dispatch.cookies_serializer = :json
+Dummy::Application.config.action_dispatch.cookies_serializer = :json

data/spec/fixtures/fanout_series.json

@@ -0,0 +1,23 @@
+{
+  "dummy_by_day_user_6":
+    [
+      {
+        "time": 1430092800,
+        "sequence_number": 1, 
+        "time_spent": 100
+      }
+    ],
+  "dummy_by_day_user_2":
+    [
+      {
+        "time": 1430092800, 
+        "sequence_number": 1, 
+        "time_spent": 50
+      },
+      {
+        "time": 1430094800, 
+        "sequence_number": 2, 
+        "time_spent": 150
+      }
+    ]
+}

data/spec/metrics/fanout_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Influxer::Metrics do
   before do
-    allow_any_instance_of(Influxer::Client).to receive(:query) do |_, sql|    
+    allow_any_instance_of(Influxer::Client).to receive(:query) do |_, sql|
       sql
     end
   end
@@ -40,7 +40,22 @@ describe Influxer::Metrics do
     end
 
     it "should work with regexp fanouts" do
-      expect(dappy.where(dummy_id: 100).by_user(/[1-3]/).daily.to_sql).to eq "select * from merge(/^dummy_by_day_user_[1-3]$/) where (dummy_id=100)"
+      expect(dappy.where(dummy_id: 100).by_user(/[1-3]/).daily.to_sql)
+        .to eq "select * from /^dummy_by_day_user_[1-3]$/ where (dummy_id=100)"
     end
   end
-end
+
+  describe "#prepare_fanout_points" do
+    before do
+      allow_any_instance_of(Influxer::Client).to receive(:query) do |_, _sql|
+        JSON.parse(File.read('./spec/fixtures/fanout_series.json'))
+      end
+    end
+
+    it "sets fanout fields values" do
+      res = dappy.by_user(/\d+/).daily.to_a
+      expect(res.detect { |v| v["user"] == '6' }).to include('time_spent' => 100, 'by' => 'day')
+      expect(res.select { |v| v["user"] == '2' }.size).to eq 2
+    end
+  end
+end