influxdb-rails 0.4.999 → 1.0.0.beta1

data/lib/influxdb/rails/logger.rb

@@ -1,12 +1,15 @@
 module InfluxDB
   module Rails
-    module Logger
-      PREFIX = "[InfluxDB::Rails] "
+    module Logger # rubocop:disable Style/Documentation
+      PREFIX = "[InfluxDB::Rails] ".freeze
 
       private
+
       def log(level, message)
-        return if level != :error && ! InfluxDB::Rails.configuration.debug?
-        InfluxDB::Rails.configuration.logger.send(level, PREFIX + message) if InfluxDB::Rails.configuration.logger
+        c = InfluxDB::Rails.configuration
+        return if level != :error && !c.debug?
+
+        c.logger&.send(level, PREFIX + message)
       end
     end
   end

data/lib/influxdb/rails/middleware/hijack_render_exception.rb

@@ -1,31 +1,16 @@
 module InfluxDB
   module Rails
     module Middleware
-      module HijackRenderException
-        def render_exception(env, e)
-          controller = env["action_controller.instance"]
+      module HijackRenderException # rubocop:disable Style/Documentation
+        def render_exception(env, ex)
+          controller = env["action_controller.instance"] || env.controller_instance
           request_data = controller.try(:influxdb_request_data) || {}
           unless InfluxDB::Rails.configuration.ignore_user_agent?(request_data[:user_agent])
-            InfluxDB::Rails.report_exception_unless_ignorable(e, request_data)
+            InfluxDB::Rails.report_exception_unless_ignorable(ex, request_data)
           end
           super
         end
       end
-
-      module OldHijackRenderException
-        def self.included(base)
-          base.send(:alias_method_chain, :render_exception, :influxdb)
-        end
-
-        def render_exception_with_influxdb(env, e)
-          controller = env["action_controller.instance"]
-          request_data = controller.try(:influxdb_request_data) || {}
-          unless InfluxDB::Rails.configuration.ignore_user_agent?(request_data[:user_agent])
-            InfluxDB::Rails.report_exception_unless_ignorable(e, request_data)
-          end
-          render_exception_without_influxdb(env, e)
-        end
-      end
     end
   end
 end

data/lib/influxdb/rails/middleware/hijack_rescue_action_everywhere.rb

@@ -1,32 +1,31 @@
 module InfluxDB
   module Rails
     module Middleware
-      module HijackRescueActionEverywhere
+      module HijackRescueActionEverywhere # rubocop:disable Style/Documentation
         def self.included(base)
           base.send(:alias_method_chain, :rescue_action_in_public, :influxdb)
           base.send(:alias_method_chain, :rescue_action_locally, :influxdb)
         end
 
         private
-        def rescue_action_in_public_with_influxdb(e)
-          handle_exception(e)
-          rescue_action_in_public_without_influxdb(e)
+
+        def rescue_action_in_public_with_influxdb(ex)
+          handle_exception(ex)
+          rescue_action_in_public_without_influxdb(ex)
         end
 
-        def rescue_action_locally_with_influxdb(e)
-          handle_exception(e)
-          rescue_action_locally_without_influxdb(e)
+        def rescue_action_locally_with_influxdb(ex)
+          handle_exception(ex)
+          rescue_action_locally_without_influxdb(ex)
         end
 
-        def handle_exception(e)
+        def handle_exception(ex)
           request_data = influxdb_request_data || {}
+          return if InfluxDB::Rails.configuration.ignore_user_agent?(request_data[:user_agent])
 
-          unless InfluxDB::Rails.configuration.ignore_user_agent?(request_data[:user_agent])
-            InfluxDB::Rails.report_exception_unless_ignorable(e, request_data)
-          end
+          InfluxDB::Rails.report_exception_unless_ignorable(ex, request_data)
         end
       end
     end
   end
 end
-

data/lib/influxdb/rails/rack.rb

@@ -1,6 +1,6 @@
 module InfluxDB
   module Rails
-    class Rack
+    class Rack # rubocop:disable Style/Documentation
       def initialize(app)
         @app = app
       end
@@ -12,7 +12,7 @@ module InfluxDB
       def _call(env)
         begin
           response = @app.call(env)
-        rescue => e
+        rescue StandardError => e
           InfluxDB::Rails.transmit_unless_ignorable(e, env)
           raise(e)
         end

data/lib/influxdb/rails/railtie.rb

@@ -1,54 +1,40 @@
-require 'influxdb'
-require 'rails'
+require "influxdb"
+require "rails"
 
 module InfluxDB
   module Rails
-    class Railtie < ::Rails::Railtie
+    class Railtie < ::Rails::Railtie # :nodoc:
       initializer "influxdb.insert_rack_middleware" do |app|
         app.config.middleware.insert 0, InfluxDB::Rails::Rack
       end
 
       config.after_initialize do
-        InfluxDB::Rails.configure(true) do |config|
-          config.logger                ||= ::Rails.logger
-          config.environment           ||= ::Rails.env
-          config.application_root      ||= ::Rails.root
-          config.application_name      ||= ::Rails.application.class.parent_name
-          config.framework              = "Rails"
-          config.framework_version       = ::Rails.version
-        end
+        InfluxDB::Rails.configure(true, &:load_rails_defaults)
 
         ActiveSupport.on_load(:action_controller) do
-          require 'influxdb/rails/air_traffic_controller'
+          require "influxdb/rails/air_traffic_controller"
           include InfluxDB::Rails::AirTrafficController
-          require 'influxdb/rails/instrumentation'
+          require "influxdb/rails/instrumentation"
           include InfluxDB::Rails::Instrumentation
         end
 
-        if defined?(::ActionDispatch::DebugExceptions)
-          require 'influxdb/rails/middleware/hijack_render_exception'
-          exceptions_class = ::ActionDispatch::DebugExceptions
-        elsif defined?(::ActionDispatch::ShowExceptions)
-          require 'influxdb/rails/middleware/hijack_render_exception'
-          exceptions_class = ::ActionDispatch::ShowExceptions
-        end
-
-        InfluxDB::Rails.safely_prepend(
-          "HijackRenderException",
-          :from => InfluxDB::Rails::Middleware,
-          :to => exceptions_class
-        )
+        require "influxdb/rails/middleware/hijack_render_exception"
+        ::ActionDispatch::DebugExceptions.prepend InfluxDB::Rails::Middleware::HijackRenderException
 
         if defined?(ActiveSupport::Notifications)
-          ActiveSupport::Notifications.subscribe "process_action.action_controller" do |name, start, finish, id, payload|
-            if InfluxDB::Rails.configuration.instrumentation_enabled? && ! InfluxDB::Rails.configuration.ignore_current_environment?
+          listen = lambda do |name, start, finish, id, payload|
+            c = InfluxDB::Rails.configuration
+
+            if c.instrumentation_enabled? && !c.ignore_current_environment?
               begin
                 InfluxDB::Rails.handle_action_controller_metrics(name, start, finish, id, payload)
-              rescue => e
-                InfluxDB::Rails.configuration.logger.error "[InfluxDB::Rails] Failed writing points to InfluxDB: #{e.message}"
+              rescue StandardError => e
+                c.logger.error "[InfluxDB::Rails] Failed writing points to InfluxDB: #{e.message}"
               end
             end
           end
+
+          ActiveSupport::Notifications.subscribe "process_action.action_controller", &listen
         end
       end
     end

data/lib/influxdb/rails/version.rb

@@ -1,5 +1,5 @@
 module InfluxDB
   module Rails
-    VERSION = "0.4.999"
+    VERSION = "1.0.0.beta1".freeze
   end
 end

data/lib/rails/generators/influxdb/influxdb_generator.rb

@@ -1,14 +1,15 @@
-require 'rails/generators'
+require "rails/generators"
 
-class InfluxdbGenerator < Rails::Generators::Base
+class InfluxdbGenerator < Rails::Generators::Base # rubocop:disable Style/Documentation
   desc "Description:\n  This creates a Rails initializer for InfluxDB::Rails."
 
-  source_root File.expand_path('../templates', __FILE__)
+  source_root File.expand_path("templates", __dir__)
 
   def copy_initializer_file
-    template "initializer.rb", "config/initializers/influxdb-rails.rb"
+    template "initializer.rb", "config/initializers/influxdb_rails.rb"
   end
 
   def install
+    # nothing to do here
   end
 end

data/spec/controllers/widgets_controller_spec.rb

@@ -1,6 +1,6 @@
-require 'spec_helper'
+require "spec_helper"
 
-RSpec.describe WidgetsController, :type => :controller do
+RSpec.describe WidgetsController, type: :controller do
   describe "#new" do
     it "should raise an exception" do
       expect { get :new }.to raise_error(ZeroDivisionError)

data/spec/integration/exceptions_spec.rb

@@ -1,9 +1,9 @@
 require File.expand_path(File.dirname(__FILE__) + "/integration_helper")
 
-RSpec.describe "exception handling", :type => :request do
+RSpec.describe "exception handling", type: :request do
   before do
     InfluxDB::Rails.configure do |config|
-      config.ignored_environments = %w{development}
+      config.ignored_environments = %w[development]
       config.instrumentation_enabled = false
     end
   end
@@ -26,16 +26,12 @@ RSpec.describe "exception handling", :type => :request do
     it "should not make an HTTP call to the API" do
       expect(InfluxDB::Rails.client).not_to receive(:write_point)
 
-      InfluxDB::Rails.configure do |config|
-        config.ignored_user_agents = %w{Googlebot}
-      end
-
+      # note: GoogleBot is ignored by default
       if Rails::VERSION::MAJOR >= 5
-        get "/widgets/new", headers: { "HTTP_USER_AGENT" => "Googlebot/2.1" }
+        get "/widgets/new", headers: { "HTTP_USER_AGENT" => "GoogleBot/2.1" }
       else
-        get "/widgets/new", {}, { "HTTP_USER_AGENT" => "Googlebot/2.1" }
+        get "/widgets/new", {}, "HTTP_USER_AGENT" => "GoogleBot/2.1"
       end
     end
   end
 end
-

data/spec/integration/metrics_spec.rb

@@ -1,10 +1,9 @@
 require File.expand_path(File.dirname(__FILE__) + "/integration_helper")
 
-RSpec.describe "collecting metrics through ActiveSupport::Notifications", :type => :request do
+RSpec.describe "collecting metrics through ActiveSupport::Notifications", type: :request do
   before do
     InfluxDB::Rails.configure do |config|
-      config.ignored_environments = %w{development}
-      config.instrumentation_enabled = true
+      config.ignored_environments = %w[development]
     end
   end
 
@@ -20,4 +19,3 @@ RSpec.describe "collecting metrics through ActiveSupport::Notifications", :type
     end
   end
 end
-

data/spec/spec_helper.rb

@@ -1,14 +1,14 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 ENV["RAILS_ENV"] ||= "test"
 
 require "rails"
 
-if Rails::VERSION::MAJOR < 4
-  raise "Sorry, influxdb-rails only supports Rails 4.x and higher."
+if Rails::VERSION::MAJOR < 4 || Rails::VERSION::MAJOR == 4 && Rails::VERSION::MINOR < 2
+  raise "Sorry, influxdb-rails only supports Rails 4.2 and higher."
 end
 
-require 'bundler/setup'
+require "bundler/setup"
 Bundler.require
 
 require "fakeweb"
@@ -16,13 +16,16 @@ FakeWeb.allow_net_connect = false
 
 puts "Loading Rails v#{Rails.version}..."
 
-if Rails.version.to_f < 5.0
-  require "support/rails4/app"
-  require "rspec/rails"
-else
-  require "support/rails5/app"
-  require "rspec/rails"
-end
+require "support/rails#{Rails::VERSION::MAJOR}/app"
+require "rspec/rails"
+
+RSpec.configure do |config|
+  # use expect syntax
+  config.disable_monkey_patching!
 
-# use expect syntax
-RSpec.configure { |c| c.disable_monkey_patching! }
+  # reset configuration for each spec
+  config.before :each do
+    InfluxDB::Rails.instance_variable_set :@configuration, nil
+    InfluxDB::Rails.configure(&:load_rails_defaults)
+  end
+end

data/spec/support/rails4/app.rb

@@ -1,8 +1,8 @@
-require 'action_controller/railtie'
+require "action_controller/railtie"
 
 app = Class.new(Rails::Application)
-app.config.secret_token = '1234567890abcdef1234567890abcdef'
-app.config.session_store :cookie_store, :key => '_myapp_session'
+app.config.secret_token = "1234567890abcdef1234567890abcdef"
+app.config.session_store :cookie_store, key: "_myapp_session"
 app.config.active_support.deprecation = :log
 app.config.eager_load = false
 app.config.root = File.dirname(__FILE__)
@@ -18,8 +18,13 @@ end
 
 class ApplicationController < ActionController::Base; end
 class WidgetsController < ApplicationController
-  def index; render :nothing => true; end
-  def new; return 1/0; end
+  def index
+    render nothing: true
+  end
+
+  def new
+    1 / 0
+  end
 end
 
 Object.const_set(:ApplicationHelper, Module.new)

data/spec/support/rails5/app.rb

@@ -1,8 +1,9 @@
-require 'action_controller/railtie'
+require "action_controller/railtie"
 
 app = Class.new(Rails::Application)
-app.config.secret_token = '1234567890abcdef1234567890abcdef'
-app.config.session_store :cookie_store, :key => '_myapp_session'
+app.config.secret_key_base = "1234567890abcdef1234567890abcdef"
+app.config.secret_token = "1234567890abcdef1234567890abcdef"
+app.config.session_store :cookie_store, key: "_myapp_session"
 app.config.active_support.deprecation = :log
 app.config.eager_load = false
 app.config.root = File.dirname(__FILE__)
@@ -18,8 +19,13 @@ end
 
 class ApplicationController < ActionController::Base; end
 class WidgetsController < ApplicationController
-  def index; head 200; end
-  def new; return 1/0; end
+  def index
+    head 200
+  end
+
+  def new
+    1 / 0
+  end
 end
 
 Object.const_set(:ApplicationHelper, Module.new)

data/spec/unit/backtrace_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe InfluxDB::Rails::Backtrace do
   before do
@@ -33,7 +33,6 @@ RSpec.describe InfluxDB::Rails::Backtrace do
   context "nil backtrace" do
     before do
       @raw_backtrace = nil
-
       @backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
     end
 
@@ -47,7 +46,6 @@ RSpec.describe InfluxDB::Rails::Backtrace do
         expect(@backtrace.to_a.is_a?(Array)).to be_truthy
       end
     end
-
   end
 
   describe "backtrace filters" do
@@ -75,7 +73,7 @@ RSpec.describe InfluxDB::Rails::Backtrace do
 
     it "should allow the addition of custom backtrace filters" do
       InfluxDB::Rails.configure do |config|
-        config.backtrace_filters << lambda { |line| line.gsub(/foo/, "F00") }
+        config.backtrace_filters << ->(line) { line.gsub(/foo/, "F00") }
       end
 
       filtered_backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
@@ -85,4 +83,3 @@ RSpec.describe InfluxDB::Rails::Backtrace do
     end
   end
 end
-

data/spec/unit/configuration_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe InfluxDB::Rails::Configuration do
   before do
@@ -7,12 +7,12 @@ RSpec.describe InfluxDB::Rails::Configuration do
 
   describe "#ignore_user_agent?" do
     it "should be true for user agents that have been set as ignorable" do
-      @configuration.ignored_user_agents = %w{Googlebot}
+      @configuration.ignored_user_agents = %w[Googlebot]
       expect(@configuration.ignore_user_agent?("Googlebot/2.1")).to be_truthy
     end
 
     it "should be false for user agents that have not been set as ignorable" do
-      @configuration.ignored_user_agents = %w{Googlebot}
+      @configuration.ignored_user_agents = %w[Googlebot]
       expect(@configuration.ignore_user_agent?("Mozilla/5.0")).to be_falsey
     end
 
@@ -29,8 +29,6 @@ RSpec.describe InfluxDB::Rails::Configuration do
 
   describe "#retry" do
     it "defaults to nil" do
-      InfluxDB::Rails.configure do |config|
-      end
       expect(InfluxDB::Rails.configuration.retry).to be_nil
     end
 
@@ -44,8 +42,6 @@ RSpec.describe InfluxDB::Rails::Configuration do
 
   describe "#open_timeout" do
     it "defaults to 5" do
-      InfluxDB::Rails.configure do |config|
-      end
       expect(InfluxDB::Rails.configuration.open_timeout).to eql(5)
     end
 
@@ -59,8 +55,6 @@ RSpec.describe InfluxDB::Rails::Configuration do
 
   describe "#read_timeout" do
     it "defaults to 300" do
-      InfluxDB::Rails.configure do |config|
-      end
       expect(InfluxDB::Rails.configuration.read_timeout).to eql(300)
     end
 
@@ -74,8 +68,6 @@ RSpec.describe InfluxDB::Rails::Configuration do
 
   describe "#max_delay" do
     it "defaults to 30" do
-      InfluxDB::Rails.configure do |config|
-      end
       expect(InfluxDB::Rails.configuration.max_delay).to eql(30)
     end
 
@@ -89,16 +81,28 @@ RSpec.describe InfluxDB::Rails::Configuration do
 
   describe "#time_precision" do
     it "defaults to seconds" do
+      expect(InfluxDB::Rails.configuration.time_precision).to eql("s")
+    end
+
+    it "can be updated" do
       InfluxDB::Rails.configure do |config|
+        config.time_precision = "ms"
       end
-      expect(InfluxDB::Rails.configuration.time_precision).to eql('s')
+      expect(InfluxDB::Rails.configuration.time_precision).to eql("ms")
     end
+  end
 
-    it "can be updated" do
+  describe "#rails_app_name" do
+    it "defaults to nil" do
+      expect(InfluxDB::Rails.configuration.rails_app_name).to be(nil)
+    end
+
+    it "can be set to own name" do
       InfluxDB::Rails.configure do |config|
-        config.time_precision = 'ms'
+        config.rails_app_name = "my-app"
       end
-      expect(InfluxDB::Rails.configuration.time_precision).to eql('ms')
+
+      expect(InfluxDB::Rails.configuration.rails_app_name).to eq("my-app")
     end
   end
 end