timber 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfc7a63ba3d0400f2c4dd67bc0844126e5d155fe
-  data.tar.gz: 1ccf7ffb850c87ae7ccc51c04daaa94b1d685adf
+  metadata.gz: a530de0193b8608dad9cf57cd4695260fa861eda
+  data.tar.gz: 30d326dde43b0fa6ecaa68dc3361a2379bbc8a54
 SHA512:
-  metadata.gz: a207f1fccdd43e25fbb3e7c9b31809f00cd53884f09d1ca21201348330b3ac66999f422a6e9a9eb8831b807dc1cc53e2731e2c5f0f0e8e2c5bfe96e992e69f65
-  data.tar.gz: 29da7a68133255e47dbbb58498d120b308176d6d5a1f554a4661c3d9820b4e80043ac4a94da740ae10ccf0be2485404815e13860412376d54f8333b7c2c96af6
+  metadata.gz: fe81f00a478333a7a51b95b7136d14f843e462e71dda131196ed0fbdc53fe86c52b5ea5e163926cefe09b0ca1c3a493fc8fed7e1de96c7707fedb0d556d8028e
+  data.tar.gz: 8e0af30d2ecb86e448b4d3d90f679ec00adca9fbf204a496cb694ac9c476fea63760b925f3a06455e3633e4ad6175cec46858e02f0c7168294b4dfe02f2cbb31

data/README.md

@@ -300,7 +300,7 @@ gem 'timber'
 
 <details><summary><strong>Rails (all versions, including edge)</strong></summary><p>
 
-👉 **Prefer examples?** Checkout our the [Timber install example pull request](https://github.com/timberio/ruby-rails-example-app/pulls/1)
+👉 **Prefer examples?** Checkout our the [Timber install example pull request](https://github.com/timberio/ruby-rails-example-app/pull/1/files)
 
 ---
 

data/lib/timber/contexts/custom.rb

@@ -18,7 +18,7 @@ module Timber
       end
 
       def as_json(_options = {})
-        {Timber::Object.try(type, :to_sym) => data}
+        {Timber::Util::Object.try(type, :to_sym) => data}
       end
     end
   end

data/lib/timber/contexts/organization.rb

@@ -26,7 +26,7 @@ module Timber
       end
 
       def as_json(_options = {})
-        {id: Timber::Object.try(id, :to_s), name: name}
+        {id: Timber::Util::Object.try(id, :to_s), name: name}
       end
     end
   end

data/lib/timber/contexts/system.rb

@@ -12,7 +12,7 @@ module Timber
       end
 
       def as_json(_options = {})
-        {pid: Timber::Object.try(pid, :to_s)}
+        {pid: Timber::Util::Object.try(pid, :to_s)}
       end
     end
   end

data/lib/timber/contexts/user.rb

@@ -19,15 +19,16 @@ module Timber
     class User < Context
       @keyspace = :user
 
-      attr_reader :id, :name
+      attr_reader :id, :name, :email
 
       def initialize(attributes)
         @id = attributes[:id]
         @name = attributes[:name]
+        @email = attributes[:email]
       end
 
       def as_json(_options = {})
-        {id: Timber::Object.try(id, :to_s), name: name}
+        {id: Timber::Util::Object.try(id, :to_s), name: name, email: email}
       end
     end
   end

data/lib/timber/events/custom.rb

@@ -26,7 +26,7 @@ module Timber
       end
 
       def to_hash
-        {Timber::Object.try(type, :to_sym) => data}
+        {Timber::Util::Object.try(type, :to_sym) => data}
       end
       alias to_h to_hash
 

data/lib/timber/probes/action_controller_user_context.rb

@@ -0,0 +1,52 @@
+module Timber
+  module Probes
+    # Responsible for automatically tracking controller call and http response events
+    # for applications that use `ActionController`.
+    class ActionControllerUserContext < Probe
+      module AroundFilter
+        def self.included(klass)
+          klass.class_eval do
+            if klass.respond_to?(:around_action)
+              around_action :_timber_capture_user_context
+            else
+              around_filter :_timber_capture_user_context
+            end
+
+            private
+              def _timber_capture_user_context
+                if respond_to?(:current_user, true)
+                  id = Timber::Util::Object.try(current_user, :id)
+                  name = Timber::Util::Object.try(current_user, :name)
+                  if !name
+                    first_name = Timber::Util::Object.try(current_user, :first_name)
+                    last_name = Timber::Util::Object.try(current_user, :last_name)
+                    if first_name || last_name
+                      name = [first_name, last_name].compact.join(" ")
+                    end
+                  end
+                  email = Timber::Util::Object.try(current_user, :email)
+                  user_context = Timber::Contexts::User.new(:id => id, :name => name, :email => email)
+                  Timber::CurrentContext.with(user_context) do
+                    yield
+                  end
+                else
+                  yield
+                end
+              end
+          end
+        end
+      end
+
+      def initialize
+        require "action_controller"
+      rescue LoadError => e
+        raise RequirementNotMetError.new(e.message)
+      end
+
+      def insert!
+        return true if ActionController::Base.include?(AroundFilter)
+        ActionController::Base.send(:include, AroundFilter)
+      end
+    end
+  end
+end

data/lib/timber/probes/active_record_log_subscriber/log_subscriber.rb

@@ -9,14 +9,16 @@ module Timber
         def sql(event)
           super(event)
 
-          payload = event.payload
-          event = Events::SQLQuery.new(
-            sql: payload[:sql],
-            time_ms: event.duration,
-            message: @message
-          )
+          if @message
+            payload = event.payload
+            event = Events::SQLQuery.new(
+              sql: payload[:sql],
+              time_ms: event.duration,
+              message: @message
+            )
 
-          logger.debug event
+            logger.debug event
+          end
         end
 
         private

data/lib/timber/probes.rb

@@ -1,4 +1,5 @@
 require "timber/probes/action_controller_log_subscriber"
+require "timber/probes/action_controller_user_context"
 require "timber/probes/action_dispatch_debug_exceptions"
 require "timber/probes/action_view_log_subscriber"
 require "timber/probes/active_record_log_subscriber"
@@ -11,6 +12,7 @@ module Timber
   module Probes
     def self.insert!
       ActionControllerLogSubscriber.insert!
+      ActionControllerUserContext.insert!
       ActionDispatchDebugExceptions.insert!
       ActionViewLogSubscriber.insert!
       ActiveRecordLogSubscriber.insert!

data/lib/timber/util/object.rb

@@ -1,12 +1,14 @@
 module Timber
-  # @private
-  module Object
+  module Util
     # @private
-    def self.try(object, method)
-      if object == nil
-        nil
-      else
-        object.send(method) rescue object
+    module Object
+      # @private
+      def self.try(object, method)
+        if object == nil
+          nil
+        else
+          object.send(method) rescue object
+        end
       end
     end
   end

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "1.1.3"
+  VERSION = "1.1.4"
 end

data/spec/support/rails.rb

@@ -2,7 +2,7 @@ require "rails"
 
 # Defualt the rails logger to nothing, each test shoould be
 # responsible for setting up the logger
-logger = ::Logger.new(nil)
+logger = ::Logger.new(STDOUT)
 Rails.logger = logger
 
 class RailsApp < Rails::Application

data/spec/timber/probes/action_controller_user_context_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+describe Timber::Probes::ActionControllerUserContext do
+  describe described_class::AroundFilter do
+    let(:time) { Time.utc(2016, 9, 1, 12, 0, 0) }
+    let(:io) { StringIO.new }
+    let(:logger) do
+      logger = Timber::Logger.new(io)
+      logger.level = ::Logger::WARN
+      logger
+    end
+
+    around(:each) do |example|
+      class UserContextController < ActionController::Base
+        layout nil
+
+        def index
+          logger.error "test"
+          render json: {}
+        end
+
+        def method_for_action(action_name)
+          action_name
+        end
+
+        private
+          def current_user
+            @current_user ||= begin
+              user_struct = Struct.new(:id, :name, :email)
+              user_struct.new(1, "Ben Johnson", "hi@timber.io")
+            end
+          end
+      end
+
+      ::RailsApp.routes.draw do
+        get 'user_context' => 'user_context#index'
+      end
+
+      old_logger = ::ActionController::Base.logger
+      ::ActionController::Base.logger = logger
+
+      Timecop.freeze(time) { example.run }
+
+      Object.send(:remove_const, :UserContextController)
+      ::ActionController::Base.logger = old_logger
+    end
+
+    describe "#index" do
+      it "should capture the user context" do
+        dispatch_rails_request("/user_context")
+        expect(io.string).to include("\"user\":{\"id\":\"1\",\"name\":\"Ben Johnson\",\"email\":\"hi@timber.io\"}")
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Timber Technologies, Inc.
@@ -83,6 +83,7 @@ files:
 - lib/timber/probes.rb
 - lib/timber/probes/action_controller_log_subscriber.rb
 - lib/timber/probes/action_controller_log_subscriber/log_subscriber.rb
+- lib/timber/probes/action_controller_user_context.rb
 - lib/timber/probes/action_dispatch_debug_exceptions.rb
 - lib/timber/probes/action_view_log_subscriber.rb
 - lib/timber/probes/action_view_log_subscriber/log_subscriber.rb
@@ -123,6 +124,7 @@ files:
 - spec/timber/log_entry_spec.rb
 - spec/timber/logger_spec.rb
 - spec/timber/probes/action_controller_log_subscriber_spec.rb
+- spec/timber/probes/action_controller_user_context_spec.rb
 - spec/timber/probes/action_dispatch_debug_exceptions_spec.rb
 - spec/timber/probes/action_view_log_subscriber_spec.rb
 - spec/timber/probes/active_record_log_subscriber_spec.rb
@@ -178,6 +180,7 @@ test_files:
 - spec/timber/log_entry_spec.rb
 - spec/timber/logger_spec.rb
 - spec/timber/probes/action_controller_log_subscriber_spec.rb
+- spec/timber/probes/action_controller_user_context_spec.rb
 - spec/timber/probes/action_dispatch_debug_exceptions_spec.rb
 - spec/timber/probes/action_view_log_subscriber_spec.rb
 - spec/timber/probes/active_record_log_subscriber_spec.rb