timberio 1.0.0.beta1

data/spec/timber/patterns/to_json_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe Timber::Patterns::ToJSON do
+  class TestJSON
+    include Timber::Patterns::ToJSON
+
+    attr_reader :json_payload
+
+    def initialize(json_payload)
+      @json_payload = json_payload
+    end
+  end
+
+  describe ".as_json" do
+    let(:hash) { {} }
+    let(:target) { TestJSON.new(hash) }
+    subject { target.as_json }
+    it { should eq({}) }
+
+    context "with a value" do
+      let(:hash) { {:test => 1} }
+      it { should eq({:test => 1}) }
+    end
+
+    context "with a nil value" do
+      let(:hash) { {:test => nil} }
+      it { should eq({}) }
+    end
+
+    context "with an empty array" do
+      let(:hash) { {:test => []} }
+      it { should eq({}) }
+    end
+
+    context "with an empty hash" do
+      let(:hash) { {:test => {}} }
+      it { should eq({}) }
+    end
+  end
+end

data/spec/timber/probes/action_controller_base_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe Timber::Probes::ActionControllerBase do
+  describe described_class::InstanceMethods do
+    before(:each) do
+      class PagesPlainController < ActionController::Base
+        layout nil
+
+        def index
+          render json: {}
+        end
+
+        def method_for_action(action_name)
+          action_name
+        end
+      end
+
+      ::RailsApp.routes.draw do
+        get 'pages_plain' => 'pages_plain#index'
+      end
+    end
+
+    after(:each) do
+      Object.send(:remove_const, :PagesPlainController)
+    end
+
+    let(:logger_context_class) { Timber::Contexts::Logger }
+    let(:rack_request_context_class) { Timber::Contexts::HTTPRequests::Rack }
+    let(:request_context_class) { Timber::Contexts::HTTPRequests::ActionControllerSpecific }
+    let(:organization_context_class) { Timber::Contexts::Organizations::ActionController }
+    let(:user_context_class) { Timber::Contexts::Users::ActionController }
+    let(:response_context_class) { Timber::Contexts::HTTPResponses::ActionController }
+
+    describe "#process" do
+      it "should set the context" do
+        allow(Timber::CurrentContext).to receive(:add).with(kind_of(logger_context_class))
+        expect(Timber::CurrentContext).to receive(:add).with(kind_of(rack_request_context_class)).and_yield.once
+        expect(Timber::CurrentContext).to receive(:add).with(kind_of(request_context_class), kind_of(organization_context_class), kind_of(user_context_class), kind_of(response_context_class)).and_yield.once
+        dispatch_rails_request("/pages_plain")
+      end
+    end
+  end
+end

data/spec/timber/probes/action_controller_log_subscriber/action_controller_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Timber::Probes::ActiveSupportLogSubscriber::ActionController do
+  before(:each) do
+    class PagesController < ActionController::Base
+      layout nil
+
+      def index
+        response.headers['Content-Length'] = "500"
+        render json: {}
+      end
+
+      def method_for_action(action_name)
+        action_name
+      end
+    end
+
+    ::RailsApp.routes.draw do
+      get 'pages' => 'pages#index'
+    end
+  end
+
+  after(:each) do
+    Object.send(:remove_const, :PagesController)
+  end
+
+  let(:response_context_class) { Timber::Contexts::HTTPResponses::ActionController }
+
+  describe "#process_action" do
+    it "should set the context" do
+      expect_any_instance_of(response_context_class).to receive(:event=).with(kind_of(ActiveSupport::Notifications::Event)).once
+      dispatch_rails_request("/pages")
+    end
+  end
+end

data/spec/timber/probes/action_controller_log_subscriber/action_view_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe Timber::Probes::ActiveSupportLogSubscriber::ActionView do
+  before(:each) do
+    class UsersController < ActionController::Base
+      layout nil
+
+      def index
+        render template: "template"
+      end
+
+      def method_for_action(action_name)
+        action_name
+      end
+    end
+
+    ::RailsApp.routes.draw do
+      get 'users' => 'users#index'
+    end
+  end
+
+  after(:each) do
+    Object.send(:remove_const, :UsersController)
+  end
+
+  let(:logger_context_class) { Timber::Contexts::Logger }
+  let(:rack_request_context_class) { Timber::Contexts::HTTPRequests::Rack }
+  let(:request_context_class) { Timber::Contexts::HTTPRequests::ActionControllerSpecific }
+  let(:organization_context_class) { Timber::Contexts::Organizations::ActionController }
+  let(:user_context_class) { Timber::Contexts::Users::ActionController }
+  let(:response_context_class) { Timber::Contexts::HTTPResponses::ActionController }
+  let(:action_view_context_class) { Timber::Contexts::TemplateRenders::ActionView }
+  let(:action_view_specific_context_class) { Timber::Contexts::TemplateRenders::ActionViewSpecific }
+
+  describe "#process_action" do
+    it "should set the context" do
+      allow(Timber::CurrentContext).to receive(:add).with(kind_of(logger_context_class))
+      expect(Timber::CurrentContext).to receive(:add).with(kind_of(rack_request_context_class)).and_yield.once
+      expect(Timber::CurrentContext).to receive(:add).with(kind_of(request_context_class), kind_of(organization_context_class), kind_of(user_context_class), kind_of(response_context_class)).and_yield.once
+      expect(Timber::CurrentContext).to receive(:add).with(kind_of(action_view_context_class), kind_of(action_view_specific_context_class)).and_yield.once
+      dispatch_rails_request("/users")
+    end
+  end
+end

data/spec/timber/probes/action_controller_log_subscriber/active_record_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe Timber::Probes::ActiveSupportLogSubscriber::ActiveRecord do
+  before(:each) { Timber::Probes::ActiveSupportLogSubscriber.insert! }
+
+  let(:logger_context_class) { Timber::Contexts::Logger }
+  let(:active_record_context_class) { Timber::Contexts::SQLQueries::ActiveRecord }
+  let(:active_record_specific_context_class) { Timber::Contexts::SQLQueries::ActiveRecordSpecific }
+
+  describe "#sql" do
+    context "log level debug" do
+      before(:each) do
+        @old_level = ::ActiveRecord::Base.logger.level
+        ::ActiveRecord::Base.logger.level = Logger::DEBUG
+      end
+
+      after(:each) { ::ActiveRecord::Base.logger.level = @old_level }
+
+      it "should set the context" do
+        expect(Timber::CurrentContext).to receive(:add).with(kind_of(logger_context_class)).and_yield.once
+        expect(Timber::CurrentContext).to receive(:add).with(kind_of(active_record_context_class), kind_of(active_record_specific_context_class)).and_yield.once
+        ActiveRecord::Base.connection.execute("select * from users")
+      end
+    end
+  end
+end

data/spec/timber/probes/action_dispatch_debug_exceptions_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe Timber::Probes::ActionDispatchDebugExceptions do
+  describe described_class::InstanceMethods do
+    describe ".log_error" do
+      before(:each) do
+        class ExceptionController < ActionController::Base
+          layout nil
+
+          def index
+            raise "boom"
+          end
+
+          def method_for_action(action_name)
+            action_name
+          end
+        end
+
+        ::RailsApp.routes.draw do
+          get 'exception' => 'exception#index'
+        end
+      end
+
+      after(:each) do
+        Object.send(:remove_const, :ExceptionController)
+      end
+
+      let(:logger_context_class) { Timber::Contexts::Logger }
+      let(:rack_request_context_class) { Timber::Contexts::HTTPRequests::Rack }
+      let(:request_context_class) { Timber::Contexts::HTTPRequests::ActionControllerSpecific }
+      let(:organization_context_class) { Timber::Contexts::Organizations::ActionController }
+      let(:user_context_class) { Timber::Contexts::Users::ActionController }
+      let(:response_context_class) { Timber::Contexts::HTTPResponses::ActionController }
+      let(:exception_context_class) { Timber::Contexts::Exception }
+
+      it "should set the context" do
+        expect(Timber::CurrentContext).to receive(:add).with(kind_of(logger_context_class)).and_yield.at_least(:once)
+        expect(Timber::CurrentContext).to receive(:add).with(kind_of(rack_request_context_class)).and_yield.once
+        expect(Timber::CurrentContext).to receive(:add).with(kind_of(request_context_class), kind_of(organization_context_class), kind_of(user_context_class), kind_of(response_context_class)).and_yield.once
+        expect(Timber::CurrentContext).to receive(:add).with(kind_of(exception_context_class)).and_yield
+        dispatch_rails_request("/exception")
+      end
+    end
+  end
+end

data/spec/timber/probes/logger_spec.rb

@@ -0,0 +1,20 @@
+require "spec_helper"
+
+describe Timber::Probes::Logger do
+  describe described_class::InstanceMethods do
+    describe ".add" do
+      let(:logger) { ::Logger.new(nil) }
+      let(:context_class) { Timber::Contexts::Logger }
+
+      it "should set the context" do
+        expect(Timber::CurrentContext).to receive(:add).with(kind_of(context_class)).and_yield.once
+        logger.info("test")
+      end
+
+      it "should ignore Config.logger" do
+        expect(Timber::CurrentContext).to_not receive(:add).with(kind_of(context_class))
+        Timber::Config.logger.info("text")
+      end
+    end
+  end
+end

data/spec/timber/probes/rack_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe Timber::Probes::Rack do
+  describe described_class::Middleware do
+    describe ".call" do
+      let(:app) do
+        Rack::Builder.new do
+          use Timber::Probes::Rack::Middleware
+          run lambda { |env|
+            [200, {'Content-Type' => 'text/plain'}, ['hello world']]
+          }
+        end
+      end
+      let(:context_class) { Timber::Contexts::HTTPRequests::Rack }
+
+      def request
+        Rack::MockRequest.new(app).get('/')
+      end
+
+      it "should set the context" do
+        expect(Timber::CurrentContext).to receive(:add).with(kind_of(context_class)).and_yield.once
+        request
+      end
+    end
+  end
+end

data/timberio.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "timber/version"
+
+Gem::Specification.new do |s|
+  s.name        = "timberio"
+  s.version     = Timber::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Timber Technologies, Inc."]
+  s.email       = ["hi@timber.io"]
+  s.homepage    = "http://timber.io"
+  s.summary     = 'Make logging useful again.'
+
+  s.required_ruby_version     = '>= 1.9.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: timberio
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta1
+platform: ruby
+authors:
+- Timber Technologies, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-14 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- hi@timber.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- Appraisals
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO
+- benchmark/README.md
+- benchmark/rails_request.rb
+- benchmark/support/rails.rb
+- circle.yml
+- docs/installation/rails_on_heroku.md
+- docs/installation/rails_over_http.md
+- gemfiles/rails_3.0.X.gemfile
+- gemfiles/rails_3.1.X.gemfile
+- gemfiles/rails_3.2.X.gemfile
+- gemfiles/rails_4.0.X.gemfile
+- gemfiles/rails_4.1.X.gemfile
+- gemfiles/rails_4.2.X.gemfile
+- gemfiles/rails_5.0.X.gemfile
+- gemfiles/rails_edge.gemfile
+- lib/timber.rb
+- lib/timber/api_settings.rb
+- lib/timber/bootstrap.rb
+- lib/timber/config.rb
+- lib/timber/context.rb
+- lib/timber/context_snapshot.rb
+- lib/timber/contexts.rb
+- lib/timber/contexts/dynamic_values.rb
+- lib/timber/contexts/exception.rb
+- lib/timber/contexts/http_request.rb
+- lib/timber/contexts/http_requests/action_controller_specific.rb
+- lib/timber/contexts/http_requests/rack.rb
+- lib/timber/contexts/http_requests/rack/params.rb
+- lib/timber/contexts/http_response.rb
+- lib/timber/contexts/http_responses/action_controller.rb
+- lib/timber/contexts/logger.rb
+- lib/timber/contexts/organization.rb
+- lib/timber/contexts/organizations/action_controller.rb
+- lib/timber/contexts/server.rb
+- lib/timber/contexts/servers/heroku_specific.rb
+- lib/timber/contexts/sql_queries/active_record.rb
+- lib/timber/contexts/sql_queries/active_record_specific.rb
+- lib/timber/contexts/sql_queries/active_record_specific/binds.rb
+- lib/timber/contexts/sql_query.rb
+- lib/timber/contexts/template_render.rb
+- lib/timber/contexts/template_renders/action_view.rb
+- lib/timber/contexts/template_renders/action_view_specific.rb
+- lib/timber/contexts/user.rb
+- lib/timber/contexts/users/action_controller.rb
+- lib/timber/current_context.rb
+- lib/timber/current_line_indexes.rb
+- lib/timber/frameworks.rb
+- lib/timber/frameworks/rails.rb
+- lib/timber/internal_logger.rb
+- lib/timber/log_device.rb
+- lib/timber/log_devices.rb
+- lib/timber/log_devices/heroku_logplex.rb
+- lib/timber/log_devices/heroku_logplex/hybrid_formatter.rb
+- lib/timber/log_devices/http.rb
+- lib/timber/log_devices/http/log_pile.rb
+- lib/timber/log_devices/http/log_truck.rb
+- lib/timber/log_devices/http/log_truck/delivery.rb
+- lib/timber/log_devices/io.rb
+- lib/timber/log_devices/io/formatter.rb
+- lib/timber/log_devices/io/hybrid_formatter.rb
+- lib/timber/log_devices/io/hybrid_hidden_formatter.rb
+- lib/timber/log_devices/io/json_formatter.rb
+- lib/timber/log_devices/io/logfmt_formatter.rb
+- lib/timber/log_line.rb
+- lib/timber/logger.rb
+- lib/timber/macros.rb
+- lib/timber/macros/compactor.rb
+- lib/timber/macros/date_formatter.rb
+- lib/timber/macros/deep_merger.rb
+- lib/timber/macros/logfmt_encoder.rb
+- lib/timber/patterns.rb
+- lib/timber/patterns/delegated_singleton.rb
+- lib/timber/patterns/to_json.rb
+- lib/timber/patterns/to_logfmt.rb
+- lib/timber/probe.rb
+- lib/timber/probes.rb
+- lib/timber/probes/action_controller_base.rb
+- lib/timber/probes/action_dispatch_debug_exceptions.rb
+- lib/timber/probes/active_support_log_subscriber.rb
+- lib/timber/probes/active_support_log_subscriber/action_controller.rb
+- lib/timber/probes/active_support_log_subscriber/action_view.rb
+- lib/timber/probes/active_support_log_subscriber/active_record.rb
+- lib/timber/probes/heroku.rb
+- lib/timber/probes/logger.rb
+- lib/timber/probes/rack.rb
+- lib/timber/probes/server.rb
+- lib/timber/version.rb
+- spec/spec_helper.rb
+- spec/support/action_controller.rb
+- spec/support/action_view.rb
+- spec/support/active_record.rb
+- spec/support/coveralls.rb
+- spec/support/rails.rb
+- spec/support/rails/templates/_partial.html
+- spec/support/rails/templates/template.html
+- spec/support/simplecov.rb
+- spec/support/socket_hostname.rb
+- spec/support/timber.rb
+- spec/support/timecop.rb
+- spec/support/webmock.rb
+- spec/timber/bootstrap_spec.rb
+- spec/timber/context_snapshot_spec.rb
+- spec/timber/context_spec.rb
+- spec/timber/contexts/exception_spec.rb
+- spec/timber/contexts/organizations/action_controller_spec.rb
+- spec/timber/contexts/users/action_controller_spec.rb
+- spec/timber/current_line_indexes_spec.rb
+- spec/timber/frameworks/rails_spec.rb
+- spec/timber/log_devices/heroku_logplex_spec.rb
+- spec/timber/log_devices/http/log_truck/delivery_spec.rb
+- spec/timber/log_devices/http/log_truck_spec.rb
+- spec/timber/log_devices/io/hybrid_hidden_formatter_spec.rb
+- spec/timber/log_line_spec.rb
+- spec/timber/macros/compactor_spec.rb
+- spec/timber/macros/logfmt_encoder_spec.rb
+- spec/timber/patterns/to_json_spec.rb
+- spec/timber/probes/action_controller_base_spec.rb
+- spec/timber/probes/action_controller_log_subscriber/action_controller_spec.rb
+- spec/timber/probes/action_controller_log_subscriber/action_view_spec.rb
+- spec/timber/probes/action_controller_log_subscriber/active_record_spec.rb
+- spec/timber/probes/action_dispatch_debug_exceptions_spec.rb
+- spec/timber/probes/logger_spec.rb
+- spec/timber/probes/rack_spec.rb
+- timberio.gemspec
+homepage: http://timber.io
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Make logging useful again.
+test_files:
+- spec/spec_helper.rb
+- spec/support/action_controller.rb
+- spec/support/action_view.rb
+- spec/support/active_record.rb
+- spec/support/coveralls.rb
+- spec/support/rails.rb
+- spec/support/rails/templates/_partial.html
+- spec/support/rails/templates/template.html
+- spec/support/simplecov.rb
+- spec/support/socket_hostname.rb
+- spec/support/timber.rb
+- spec/support/timecop.rb
+- spec/support/webmock.rb
+- spec/timber/bootstrap_spec.rb
+- spec/timber/context_snapshot_spec.rb
+- spec/timber/context_spec.rb
+- spec/timber/contexts/exception_spec.rb
+- spec/timber/contexts/organizations/action_controller_spec.rb
+- spec/timber/contexts/users/action_controller_spec.rb
+- spec/timber/current_line_indexes_spec.rb
+- spec/timber/frameworks/rails_spec.rb
+- spec/timber/log_devices/heroku_logplex_spec.rb
+- spec/timber/log_devices/http/log_truck/delivery_spec.rb
+- spec/timber/log_devices/http/log_truck_spec.rb
+- spec/timber/log_devices/io/hybrid_hidden_formatter_spec.rb
+- spec/timber/log_line_spec.rb
+- spec/timber/macros/compactor_spec.rb
+- spec/timber/macros/logfmt_encoder_spec.rb
+- spec/timber/patterns/to_json_spec.rb
+- spec/timber/probes/action_controller_base_spec.rb
+- spec/timber/probes/action_controller_log_subscriber/action_controller_spec.rb
+- spec/timber/probes/action_controller_log_subscriber/action_view_spec.rb
+- spec/timber/probes/action_controller_log_subscriber/active_record_spec.rb
+- spec/timber/probes/action_dispatch_debug_exceptions_spec.rb
+- spec/timber/probes/logger_spec.rb
+- spec/timber/probes/rack_spec.rb