influxdb-rails 0.0.1

data/spec/support/rails4/app.rb

@@ -0,0 +1,27 @@
+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.active_support.deprecation = :log
+app.config.eager_load = false
+app.config.root = File.dirname(__FILE__)
+Rails.backtrace_cleaner.remove_silencers!
+app.initialize!
+
+app.routes.draw do
+  resources :widgets
+end
+
+InfluxDB::Rails.configure do |config|
+  config.api_key = "f123-e456-d789c012"
+  config.application_id = "b12r8c72"
+end
+
+class ApplicationController < ActionController::Base; end
+class WidgetsController < ApplicationController
+  def index; render :nothing => true; end
+  def new; return 1/0; end
+end
+
+Object.const_set(:ApplicationHelper, Module.new)

data/spec/unit/backtrace_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe InfluxDB::Rails::Backtrace do
+  before do
+    @raw_backtrace = [
+      "/var/www/current/app/models/foo.rb:10:in `bar'",
+      "/var/www/current/app/models/foo.rb:19:in `baz'",
+      "/var/www/current/app/models/foo.rb:32:in `<main>'"
+    ]
+
+    @backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+  end
+
+  it "should accept an exception into the initializer" do
+    @backtrace.lines.should_not be_empty
+    @backtrace.lines.count.should == 3
+  end
+
+  it "should correctly parse lines into their elements" do
+    line = @backtrace.lines.first
+
+    line.file.should == "/var/www/current/app/models/foo.rb"
+    line.number.should == "10"
+    line.method.should == "bar"
+  end
+
+  describe "#to_a" do
+    it "should return an array of lines" do
+      @backtrace.to_a.is_a?(Array).should be_true
+    end
+  end
+
+  context "nil backtrace" do
+    before do
+      @raw_backtrace = nil
+
+      @backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+    end
+
+    it "should accept an exception into the initializer" do
+      @backtrace.lines.should be_empty
+      @backtrace.lines.count.should == 0
+    end
+
+    describe "#to_a" do
+      it "should return an array of lines" do
+        @backtrace.to_a.is_a?(Array).should be_true
+      end
+    end
+
+  end
+
+  describe "backtrace filters" do
+    before do
+      InfluxDB::Rails.configure do |config|
+        config.application_root = "/var/www/current"
+      end
+    end
+
+    it "should apply a single default backtrace filter correctly" do
+      filtered_backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+
+      line = filtered_backtrace.lines.first
+      line.file.should == "[APP_ROOT]/app/models/foo.rb"
+    end
+
+    it "should all default backtrace filters correctly" do
+      extended_backtrace = @raw_backtrace.dup
+      extended_backtrace << "#{Gem.path.first}/lib/foo_gem.rb:1:in `blah'"
+
+      filtered_backtrace = InfluxDB::Rails::Backtrace.new(extended_backtrace)
+      filtered_backtrace.lines.first.file.should == "[APP_ROOT]/app/models/foo.rb"
+      filtered_backtrace.lines.last.file.should == "[GEM_ROOT]/lib/foo_gem.rb"
+    end
+
+    it "should allow the addition of custom backtrace filters" do
+      InfluxDB::Rails.configure do |config|
+        config.backtrace_filters << lambda { |line| line.gsub(/foo/, "F00") }
+      end
+
+      filtered_backtrace = InfluxDB::Rails::Backtrace.new(@raw_backtrace)
+
+      line = filtered_backtrace.lines.first
+      line.file.should == "[APP_ROOT]/app/models/F00.rb"
+    end
+  end
+end
+

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe InfluxDB::Rails::Configuration do
+  before do
+    @configuration = InfluxDB::Rails::Configuration.new
+  end
+
+  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.ignore_user_agent?("Googlebot/2.1").should be_true
+    end
+
+    it "should be false for user agents that have not been set as ignorable" do
+      @configuration.ignored_user_agents = %w{Googlebot}
+      @configuration.ignore_user_agent?("Mozilla/5.0").should be_false
+    end
+
+    it "should be false if the ignored user agents list is empty" do
+      @configuration.ignored_user_agents = []
+      @configuration.ignore_user_agent?("Googlebot/2.1").should be_false
+    end
+
+    it "should be false if the ignored user agents list is inadvertently set to nil" do
+      @configuration.ignored_user_agents = nil
+      @configuration.ignore_user_agent?("Googlebot/2.1").should be_false
+    end
+  end
+end

data/spec/unit/exception_presenter_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe InfluxDB::Rails::ExceptionPresenter do
+  before do
+    begin
+      1/0
+    rescue Exception => e
+      @exception = e
+    end
+  end
+
+  describe ".new" do
+    it "should create a new ExceptionPresenter" do
+      exception_presenter = InfluxDB::Rails::ExceptionPresenter.new(@exception)
+      exception_presenter.should be_a(InfluxDB::Rails::ExceptionPresenter)
+    end
+
+    it "should accept an exception as a parameter" do
+      exception_presenter = InfluxDB::Rails::ExceptionPresenter.new(@exception)
+      exception_presenter.should_not be_nil
+    end
+  end
+
+  # describe "#to_json" do
+    # it "should return a JSON string" do
+      # exception_presenter = InfluxDB::ExceptionPresenter.new(@exception)
+      # json = JSON.parse(exception_presenter.to_json)
+
+      # json["message"].should == "divided by 0"
+      # json["time"].should_not be_nil
+      # json["backtrace"].should_not be_nil
+    # end
+
+    # it "should include a custom hash if defined in the influxdb config" do
+      # InfluxDB.configure do |config|
+        # config.define_custom_exception_data do |exception_presenter|
+          # if exception_presenter.exception.class ==  ZeroDivisionError
+            # exception_presenter.hash = "some_hash"
+            # exception_presenter.custom_data[:extra_info] = "blah"
+          # end
+        # end
+      # end
+
+      # exception_presenter = InfluxDB::ExceptionPresenter.new(@exception)
+      # json = JSON.parse(exception_presenter.to_json)
+      # json["hash"].should == "some_hash"
+      # json["custom_data"]["extra_info"].should == "blah"
+    # end
+
+    # describe "environment variables" do
+      # it "should be filtered based on the contents of environment_variable_filters" do
+        # InfluxDB.configure do |config|
+          # config.environment_variable_filters = [/password/i]
+        # end
+
+        # exception_presenter = InfluxDB::ExceptionPresenter.new(
+          # :exception => @exception,
+          # :environment_variables => {
+            # "IMPORTANT_PASSWORD" => "sesame",
+            # "EDITOR" => "vim"
+        # })
+
+        # json = JSON.parse(exception_presenter.to_json)
+        # json["environment_variables"].size.should == 1
+        # json["environment_variables"].should == {"EDITOR" => "vim"}
+      # end
+    # end
+  # end
+end

data/spec/unit/influxdb_rails_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe InfluxDB::Rails do
+  before do
+    InfluxDB::Rails.configure { |config| config.ignored_environments = [] }
+  end
+
+  describe ".ignorable_exception?" do
+    it "should be true for exception types specified in the configuration" do
+      class DummyException < Exception; end
+      exception = DummyException.new
+
+      InfluxDB::Rails.configure do |config|
+        config.ignored_exceptions << 'DummyException'
+      end
+
+      InfluxDB::Rails.ignorable_exception?(exception).should be_true
+    end
+
+    it "should be true for exception types specified in the configuration" do
+      exception = ActionController::RoutingError.new("foo")
+      InfluxDB::Rails.ignorable_exception?(exception).should be_true
+    end
+
+    it "should be false for valid exceptions" do
+      exception = ZeroDivisionError.new
+      InfluxDB::Rails.ignorable_exception?(exception).should be_false
+    end
+  end
+
+  describe 'rescue' do
+    it "should transmit an exception when passed" do
+      InfluxDB::Rails.configure do |config|
+        config.ignored_environments = []
+        config.instrumentation_enabled = false
+      end
+
+      InfluxDB::Rails.client.should_receive(:write_point)
+
+      InfluxDB::Rails.rescue do
+        raise ArgumentError.new('wrong')
+      end
+    end
+
+    it "should also raise the exception when in an ignored environment" do
+      InfluxDB::Rails.configure { |config| config.ignored_environments = %w{development test} }
+
+      expect {
+        InfluxDB::Rails.rescue do
+          raise ArgumentError.new('wrong')
+        end
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe "rescue_and_reraise" do
+    it "should transmit an exception when passed" do
+      InfluxDB::Rails.configure { |config| config.ignored_environments = [] }
+
+      InfluxDB::Rails.client.should_receive(:write_point)
+
+      expect {
+        InfluxDB::Rails.rescue_and_reraise { raise ArgumentError.new('wrong') }
+      }.to raise_error(ArgumentError)
+    end
+  end
+end

metadata

@@ -0,0 +1,226 @@
+--- !ruby/object:Gem::Specification
+name: influxdb-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Todd Persen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: influxdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem automatically instruments your Ruby on Rails 3.x/4.x applications
+  using InfluxDB for storage.
+email:
+- todd@influxdb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- config.ru
+- Gemfile
+- Gemfile.lock
+- gemfiles/Gemfile.rails-3.0.x
+- gemfiles/Gemfile.rails-3.0.x.lock
+- gemfiles/Gemfile.rails-3.1.x
+- gemfiles/Gemfile.rails-3.1.x.lock
+- gemfiles/Gemfile.rails-3.2.x
+- gemfiles/Gemfile.rails-3.2.x.lock
+- gemfiles/Gemfile.rails-4.0.x
+- gemfiles/Gemfile.rails-4.0.x.lock
+- generators/influxdb/influxdb_generator.rb
+- generators/influxdb/templates/initializer.rb
+- influxdb-rails.gemspec
+- lib/influxdb/rails/air_traffic_controller.rb
+- lib/influxdb/rails/backtrace.rb
+- lib/influxdb/rails/configuration.rb
+- lib/influxdb/rails/exception_presenter.rb
+- lib/influxdb/rails/instrumentation.rb
+- lib/influxdb/rails/logger.rb
+- lib/influxdb/rails/middleware/hijack_render_exception.rb
+- lib/influxdb/rails/middleware/hijack_rescue_action_everywhere.rb
+- lib/influxdb/rails/rack.rb
+- lib/influxdb/rails/rails.rb
+- lib/influxdb/rails/railtie.rb
+- lib/influxdb/rails/version.rb
+- lib/influxdb-rails.rb
+- lib/rails/generators/influxdb/influxdb_generator.rb
+- lib/rails/generators/influxdb/templates/initializer.rb
+- Rakefile
+- README.md
+- spec/controllers/widgets_controller_spec.rb
+- spec/integration/exceptions_spec.rb
+- spec/integration/integration_helper.rb
+- spec/spec_helper.rb
+- spec/suite.sh
+- spec/support/rails3/app.rb
+- spec/support/rails3/log/test.log
+- spec/support/rails4/app.rb
+- spec/unit/backtrace_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/exception_presenter_spec.rb
+- spec/unit/influxdb_rails_spec.rb
+homepage: http://influxdb.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: influxdb-rails
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: InfluxDB bindings for Ruby on Rails.
+test_files:
+- spec/controllers/widgets_controller_spec.rb
+- spec/integration/exceptions_spec.rb
+- spec/integration/integration_helper.rb
+- spec/spec_helper.rb
+- spec/suite.sh
+- spec/support/rails3/app.rb
+- spec/support/rails3/log/test.log
+- spec/support/rails4/app.rb
+- spec/unit/backtrace_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/exception_presenter_spec.rb
+- spec/unit/influxdb_rails_spec.rb