timber-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f4f0a765269e2b04700d9f0b5e8be9c8c5a1e2b7335ee31decc53379e0c29c6
+  data.tar.gz: 113255c96a2bcd218ce6d444c665a811f8e4ab47cf09cba3c2cebdc82e998084
+SHA512:
+  metadata.gz: b053eb354944ecac2cdae780546d70b00f10ff9ce00c73d1ef9a210fbe6977fe270e6136270e80124d58ad146423ee57e5c23ddd11be177cca9a4143cbc2f725
+  data.tar.gz: de16848d218e687879c3af22f1ceffe1b84647da03044a7356ae26d009b118b8a308d1d5151f3efdcfb29395fc6c4a25aa82f00a51a9fee1fc102beaec80af89

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Ignore gemset
+/.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,56 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- 1.9.3
+- 2.2.10
+- 2.3.8
+- 2.4.5
+- 2.5.3
+- jruby-9.2.5.0
+before_install: gem install bundler -v 1.17.3
+gemfile:
+- gemfiles/rails-3.2.gemfile
+- gemfiles/rails-4.0.gemfile
+- gemfiles/rails-4.1.gemfile
+- gemfiles/rails-4.2.gemfile
+- gemfiles/rails-5.0.gemfile
+- gemfiles/rails-5.1.gemfile
+- gemfiles/rails-5.2.gemfile
+- gemfiles/rails-edge.gemfile
+env:
+  global: RAILS_ENV=test
+before_script:
+- echo $BUNDLE_GEMFILE
+- bundle install
+script:
+  - bundle exec rspec --format documentation
+matrix:
+  fast_finish: true
+  exclude:
+    - rvm: 1.9.3
+    - gemfile: gemfiles/rails-edge.gemfile
+    - rvm: 2.4.5
+      gemfile: gemfiles/rails-4.0.gemfile
+    - rvm: 2.4.5
+      gemfile: gemfiles/rails-4.1.gemfile
+    - rvm: 2.5.3
+      gemfile: gemfiles/rails-3.2.gemfile
+    - rvm: 2.5.3
+      gemfile: gemfiles/rails-4.0.gemfile
+    - rvm: 2.5.3
+      gemfile: gemfiles/rails-4.1.gemfile
+  include:
+    - rvm: 2.5.3
+      gemfile: gemfiles/rails-edge.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails-3.2.gemfile
+  allow_failures:
+  - rvm: 1.9.3 # bundler wont install the gems
+  - gemfile: gemfiles/rails-edge.gemfile
+  - rvm: jruby-9.2.5.0
+notifications:
+  email: false
+  slack:
+    rooms:
+      secure: F4BGVLUnaDqJ3YXfuIwx+m6047E8YstCUXs33Tfcs7SUlSuOSChuXqvCfVtnfNy2muF7xgB6VRL3xpFIRm7qNStqGUWCQJXmKq2OEgq1DYGkhAVle4d/LBtVcfBgeLelsoi+1TI9MrUtpZDHPl0li3PLoC+dq7rzSuhrxQ9EOhZlZGVn6LTeVcgNw6cLNzHSWJJ8zpYWLjBWUXgJ75MQvo5qaNbQxyfzm7GzEgRNfSzabFBwpKwB1Tog9X9TKTtPrn30O9Ur9+wmTu6EnwaDWZjaTK6I+AbxE8huIfUGvSrq1aV2JaDIra6zHEQ+d4j0oRYutgFM4YfyN9124MbPE2yH/5lXNQHMpUOsP0bl2U+KGDzq/V5APyrZ6irsvwGYpo3fSXrW8nDIAK4Mh8KB+Ta0zN5H8PmIRK76wJ+wG2zAtrfl+ailxMrdpK6J04fl3pCBuO6eW+AKEJ7Wfi5GiE7a9lk/YewAeDHyyLSnUNFIP0/iFAbTtRh5denCk0ZUS1XyfZNQuFoku7jk5lpe41SNItqOO0jv/jXPF+wensNa2UgMBIP0XkRw55LKn9eY0MKm9P+zp9ePaXs0T0Ttv4e0T4Jxrgf5QBynefgHwAsOI1nHr7GhlPaFQ6u8iNmjNYLB9v1JZMlO08LkytzZFpUuJoHbYYoBaRtUtEosBHg=

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# TODO: REMOVE ME
+gem 'timber', git: 'https://github.com/mitchellhenke/timber-ruby.git', branch: '3.0'
+gem 'timber-rack', git: 'https://github.com/timberio/timber-ruby-rack.git', branch: 'master'
+
+# Specify your gem's dependencies in timber-ruby-rails.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,15 @@
+# License
+
+Copyright (c) 2019, Timber Technologies, Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

data/README.md

@@ -0,0 +1,12 @@
+# 🌲 Timber Integration For Rails
+
+[![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/timberio/timber-ruby-rails)
+[![Build Status](https://travis-ci.org/timberio/timber-ruby-rails.svg?branch=master)](https://travis-ci.org/timberio/timber-ruby-rails)
+[![Code Climate](https://codeclimate.com/github/timberio/timber-ruby-rails/badges/gpa.svg)](https://codeclimate.com/github/timberio/timber-ruby-rails)
+
+This library integrates the [`timber` Ruby library][timber_ruby] with the [Rails][rails] framework,
+turning your Rails logs into rich structured events.
+
+* **Sign-up: [https://app.timber.io](https://app.timber.io)**
+* **Documentation: [https://docs.timber.io/setup/languages/ruby/integrations/rails](https://docs.timber.io/setup/languages/ruby/integrations/rails)**

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "timber-rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/rails-3.0.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.0.0'
+# TODO: REMOVE ME
+gem 'timber', git: 'https://github.com/timberio/timber-ruby.git', branch: '3.0'
+gem 'timber-rack', git: 'https://github.com/timberio/timber-ruby-rack.git', branch: 'master'
+
+gemspec :path => '../'

data/gemfiles/rails-3.1.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.1.0'
+# TODO: REMOVE ME
+gem 'timber', git: 'https://github.com/timberio/timber-ruby.git', branch: '3.0'
+gem 'timber-rack', git: 'https://github.com/timberio/timber-ruby-rack.git', branch: 'master'
+
+gemspec :path => '../'

data/gemfiles/rails-3.2.gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 3.2.0'
+# TODO: REMOVE ME
+gem 'timber', git: 'https://github.com/timberio/timber-ruby.git', branch: '3.0'
+gem 'timber-rack', git: 'https://github.com/timberio/timber-ruby-rack.git', branch: 'master'
+
+gemspec :path => '../'

data/gemfiles/rails-4.0.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.0.0'
+# TODO: REMOVE ME
+gem 'timber', git: 'https://github.com/timberio/timber-ruby.git', branch: '3.0'
+gem 'timber-rack', git: 'https://github.com/timberio/timber-ruby-rack.git', branch: 'master'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-4.1.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.1.0'
+# TODO: REMOVE ME
+gem 'timber', git: 'https://github.com/timberio/timber-ruby.git', branch: '3.0'
+gem 'timber-rack', git: 'https://github.com/timberio/timber-ruby-rack.git', branch: 'master'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-4.2.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.2.0'
+# TODO: REMOVE ME
+gem 'timber', git: 'https://github.com/timberio/timber-ruby.git', branch: '3.0'
+gem 'timber-rack', git: 'https://github.com/timberio/timber-ruby-rack.git', branch: 'master'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-5.0.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.0.0'
+# TODO: REMOVE ME
+gem 'timber', git: 'https://github.com/timberio/timber-ruby.git', branch: '3.0'
+gem 'timber-rack', git: 'https://github.com/timberio/timber-ruby-rack.git', branch: 'master'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-5.1.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.1.0'
+# TODO: REMOVE ME
+gem 'timber', git: 'https://github.com/timberio/timber-ruby.git', branch: '3.0'
+gem 'timber-rack', git: 'https://github.com/timberio/timber-ruby-rack.git', branch: 'master'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-5.2.gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 5.2.0'
+# TODO: REMOVE ME
+gem 'timber', git: 'https://github.com/timberio/timber-ruby.git', branch: '3.0'
+gem 'timber-rack', git: 'https://github.com/timberio/timber-ruby-rack.git', branch: 'master'
+
+if RUBY_PLATFORM == "java"
+  gem 'mime-types', '2.6.2'
+end
+
+gemspec :path => '../'

data/gemfiles/rails-edge.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rack', git: 'https://github.com/rack/rack', branch: 'master'
+gem 'arel', git: 'https://github.com/rails/arel', branch: 'master'
+gem 'rails', git: 'https://github.com/rails/rails', branch: 'master'
+
+# TODO: REMOVE ME
+gem 'timber', git: 'https://github.com/timberio/timber-ruby.git', branch: '3.0'
+gem 'timber-rack', git: 'https://github.com/timberio/timber-ruby-rack.git', branch: 'master'
+
+gemspec :path => '../'

data/lib/timber-rails/action_controller/log_subscriber/timber_log_subscriber.rb

@@ -0,0 +1,46 @@
+module Timber
+  module Integrations
+    module ActionController
+      class LogSubscriber < Integrator
+        # The log subscriber that replaces the default `ActionController::LogSubscriber`.
+        # The intent of this subscriber is to, as transparently as possible, properly
+        # track events that are being logged here. This LogSubscriber will never change
+        # default behavior / log messages.
+        #
+        # @private
+        class TimberLogSubscriber < ::ActionController::LogSubscriber
+          def start_processing(event)
+            return true if silence?
+
+            info do
+              payload = event.payload
+              params  = payload[:params].except(*INTERNAL_PARAMS)
+              format  = extract_format(payload)
+              format  = format.to_s.upcase if format.is_a?(Symbol)
+
+              Events::ControllerCall.new(
+                controller: payload[:controller],
+                action: payload[:action],
+                format: format,
+                params: params
+              )
+            end
+          end
+
+          private
+            def extract_format(payload)
+              if payload.key?(:format)
+                payload[:format] # rails > 4.X
+              elsif payload.key?(:formats)
+                payload[:formats].first # rails 3.X
+              end
+            end
+
+            def silence?
+              ActionController.silence?
+            end
+        end
+      end
+    end
+  end
+end

data/lib/timber-rails/action_controller/log_subscriber.rb

@@ -0,0 +1,25 @@
+module Timber
+  module Integrations
+    module ActionController
+      # Responsible for removing the default ActionController::LogSubscriber and installing
+      # the TimberLogSubscriber
+      #
+      # @private
+      class LogSubscriber < Integrator
+        def initialize
+          require "action_controller/log_subscriber"
+          require "timber-rails/action_controller/log_subscriber/timber_log_subscriber"
+        rescue LoadError => e
+          raise RequirementNotMetError.new(e.message)
+        end
+
+        def integrate!
+          return true if Util::ActiveSupportLogSubscriber.subscribed?(:action_controller, TimberLogSubscriber)
+
+          Util::ActiveSupportLogSubscriber.unsubscribe!(:action_controller, ::ActionController::LogSubscriber)
+          TimberLogSubscriber.attach_to(:action_controller)
+        end
+      end
+    end
+  end
+end

data/lib/timber-rails/action_controller.rb

@@ -0,0 +1,17 @@
+require "timber-rails/action_controller/log_subscriber"
+
+module Timber
+  module Integrations
+    # Module for holding *all* ActionController integrations. See {Integration} for
+    # configuration details for all integrations.
+    module ActionController
+      extend Integration
+
+      def self.integrate!
+        return false if !enabled?
+
+        LogSubscriber.integrate!
+      end
+    end
+  end
+end

data/lib/timber-rails/action_dispatch/debug_exceptions.rb

@@ -0,0 +1,51 @@
+module Timber
+  module Integrations
+    module ActionDispatch
+      # Reponsible for disabled logging in the ActionDispatch::DebugExceptions
+      # Rack middleware. We cannot simply remove the middleware because it is
+      # coupled with displaying an exception debug screen if debug exceptions is enabled.
+      #
+      # @private
+      class DebugExceptions < Integrator
+
+        # Patch for disabling logging
+        #
+        # @private
+        module InstanceMethods
+          def self.included(klass)
+            klass.class_eval do
+              private
+                def logger(*args)
+                  nil
+                end
+            end
+          end
+        end
+
+        def initialize
+          begin
+            # Rails >= 3.1
+            require "action_dispatch/middleware/debug_exceptions"
+          rescue LoadError
+            # Rails < 3.1
+            require "action_dispatch/middleware/show_exceptions"
+          end
+        rescue LoadError => e
+          raise RequirementNotMetError.new(e.message)
+        end
+
+        def integrate!
+          if defined?(::ActionDispatch::DebugExceptions) && !::ActionDispatch::DebugExceptions.include?(InstanceMethods)
+            ::ActionDispatch::DebugExceptions.send(:include, InstanceMethods)
+          end
+
+          if defined?(::ActionDispatch::ShowExceptions) && !::ActionDispatch::ShowExceptions.include?(InstanceMethods)
+            ::ActionDispatch::ShowExceptions.send(:include, InstanceMethods)
+          end
+
+          true
+        end
+      end
+    end
+  end
+end

data/lib/timber-rails/action_dispatch.rb

@@ -0,0 +1,20 @@
+require "timber-rails/action_dispatch/debug_exceptions"
+
+module Timber
+  module Integrations
+    # Module for holding *all* ActionDispatch integrations. This
+    # module simply disables the exception tracking middleware so that our middleware
+    # works as expected.
+    module ActionDispatch
+      def self.enabled?
+        Rails::ErrorEvent.enabled?
+      end
+
+      def self.integrate!
+        return false if !enabled?
+
+        DebugExceptions.integrate!
+      end
+    end
+  end
+end

data/lib/timber-rails/action_view/log_subscriber/timber_log_subscriber.rb

@@ -0,0 +1,83 @@
+module Timber
+  module Integrations
+    module ActionView
+      class LogSubscriber < Integrator
+
+        # The log subscriber that replaces the default `ActionView::LogSubscriber`.
+        # The intent of this subscriber is to, as transparently as possible, properly
+        # track events that are being logged here.
+        #
+        # @private
+        class TimberLogSubscriber < ::ActionView::LogSubscriber
+          def render_template(event)
+            return true if silence?
+
+            info do
+              full_name = from_rails_root(event.payload[:identifier])
+              message = "  Rendered #{full_name}"
+              message << " within #{from_rails_root(event.payload[:layout])}" if event.payload[:layout]
+              message << " (#{event.duration.round(1)}ms)"
+
+              Events::TemplateRender.new(
+                name: full_name,
+                duration_ms: event.duration,
+                message: message
+              )
+            end
+          end
+
+          def render_partial(event)
+            return true if silence?
+
+            info do
+              full_name = from_rails_root(event.payload[:identifier])
+              message = "  Rendered #{full_name}"
+              message << " within #{from_rails_root(event.payload[:layout])}" if event.payload[:layout]
+              message << " (#{event.duration.round(1)}ms)"
+              message << " #{cache_message(event.payload)}" if event.payload.key?(:cache_hit)
+
+              Events::TemplateRender.new(
+                name: full_name,
+                duration_ms: event.duration,
+                message: message
+              )
+            end
+          end
+
+          def render_collection(event)
+            return true if silence?
+
+            if respond_to?(:render_count, true)
+              info do
+                identifier = event.payload[:identifier] || "templates"
+                full_name = from_rails_root(identifier)
+                message = "  Rendered collection of #{full_name}" \
+                  " #{render_count(event.payload)} (#{event.duration.round(1)}ms)"
+
+                Events::TemplateRender.new(
+                  name: full_name,
+                  duration_ms: event.duration,
+                  message: message
+                )
+              end
+            else
+              # Older versions of rails delegate this method to #render_template
+              render_template(event)
+            end
+          end
+
+          private
+            def log_rendering_start(payload)
+              # Consolidates 2 template rendering events into 1. We don't need 2 events for
+              # rendering a template. If you disagree, please feel free to open a PR and we
+              # can make this an option.
+            end
+
+            def silence?
+              ActionView.silence?
+            end
+        end
+      end
+    end
+  end
+end

data/lib/timber-rails/action_view/log_subscriber.rb

@@ -0,0 +1,25 @@
+module Timber
+  module Integrations
+    module ActionView
+      # Reponsible for uninstalling the default `ActionView::LogSubscriber` and installing
+      # the TimberLogSubscriber.
+      #
+      # @private
+      class LogSubscriber < Integrator
+        def initialize
+          require "action_view/log_subscriber"
+          require "timber-rails/action_view/log_subscriber/timber_log_subscriber"
+        rescue LoadError => e
+          raise RequirementNotMetError.new(e.message)
+        end
+
+        def integrate!
+          return true if Util::ActiveSupportLogSubscriber.subscribed?(:action_view, TimberLogSubscriber)
+
+          Util::ActiveSupportLogSubscriber.unsubscribe!(:action_view, ::ActionView::LogSubscriber)
+          TimberLogSubscriber.attach_to(:action_view)
+        end
+      end
+    end
+  end
+end

data/lib/timber-rails/action_view.rb

@@ -0,0 +1,17 @@
+require "timber-rails/action_view/log_subscriber"
+
+module Timber
+  module Integrations
+    # Module for holding *all* ActionView integrations. See {Integration} for
+    # configuration details for all integrations.
+    module ActionView
+      extend Integration
+
+      def self.integrate!
+        return false if !enabled?
+
+        LogSubscriber.integrate!
+      end
+    end
+  end
+end

data/lib/timber-rails/active_record/log_subscriber/timber_log_subscriber.rb

@@ -0,0 +1,52 @@
+# We require all of ActiveRecord because the #logger method in ::ActiveRecord::LogSubscriber
+# uses ActiveRecord::Base. We can't require active_record/base directly because ActiveRecord
+# does not require files properly and we receive unintialized constant errors.
+require "active_record"
+require "active_record/log_subscriber"
+
+module Timber
+  module Integrations
+    module ActiveRecord
+      class LogSubscriber < Integrator
+        # The log subscriber that replaces the default `ActiveRecord::LogSubscriber`.
+        # The intent of this subscriber is to, as transparently as possible, properly
+        # track events that are being logged here. This LogSubscriber will never change
+        # default behavior / log messages.
+        #
+        # @private
+        class TimberLogSubscriber < ::ActiveRecord::LogSubscriber
+          def sql(event)
+            return true if silence?
+
+            r = super(event)
+
+            if @message
+              payload = event.payload
+
+              sql_event = Events::SQLQuery.new(
+                sql: payload[:sql],
+                duration_ms: event.duration,
+                message: @message,
+              )
+
+              logger.debug sql_event
+
+              @message = nil
+            end
+
+            r
+          end
+
+          private
+            def debug(message)
+              @message = message
+            end
+
+            def silence?
+              ActiveRecord.silence?
+            end
+        end
+      end
+    end
+  end
+end

data/lib/timber-rails/active_record/log_subscriber.rb

@@ -0,0 +1,20 @@
+require "timber-rails/active_record/log_subscriber/timber_log_subscriber"
+
+module Timber
+  module Integrations
+    module ActiveRecord
+      # Reponsible for uninstalling the default `ActiveRecord::LogSubscriber` and replacing it
+      # with the `TimberLogSubscriber`.
+      #
+      # @private
+      class LogSubscriber < Integrator
+        def integrate!
+          return true if Util::ActiveSupportLogSubscriber.subscribed?(:active_record, TimberLogSubscriber)
+
+          Util::ActiveSupportLogSubscriber.unsubscribe!(:active_record, ::ActiveRecord::LogSubscriber)
+          TimberLogSubscriber.attach_to(:active_record)
+        end
+      end
+    end
+  end
+end

data/lib/timber-rails/active_record.rb

@@ -0,0 +1,17 @@
+require "timber-rails/active_record/log_subscriber"
+
+module Timber
+  module Integrations
+    # Module for holding *all* ActiveRecord integrations. See {Integration} for
+    # configuration details for all integrations.
+    module ActiveRecord
+      extend Integration
+
+      def self.integrate!
+        return false if !enabled?
+
+        LogSubscriber.integrate!
+      end
+    end
+  end
+end