timber 2.6.1 → 2.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 695d1eb93a0e891ecc1a3eb47ee4888d0d30fdbc
-  data.tar.gz: d1075432948895089dec419679a8fb12194a7631
+  metadata.gz: fb990174a93469450d73ae20ffd997d61ca0f01e
+  data.tar.gz: 0f7ada34254928c3b196b5e33ab5e7b11dbc3982
 SHA512:
-  metadata.gz: 6318864253dec537d4e604161e5877873407744d57d738519fc24091a72126dbe3429cf4be85d106f09f28ab41d4513218407094d27aa296575429e22b30f8b9
-  data.tar.gz: 90cb2e402a913de26c656bb9b5bef4f49ebeff58e3b06c56b9c335888dd07f434d63f6da473cb993da1f9e537ccead50fabf36877bd7cd6652d98d105fa6a38d
+  metadata.gz: 859c860cb28a5e11d6901ca8648e8e3467b43ac21131e4c33f5601883c8543427a21709f4f19827728ed0d0cddfe5ddfb176851109d69e5c4d8b3eb5ee11d701
+  data.tar.gz: 10750c2cdd80151a56dee093f0c63e8180d4875235092e795a69ea1d459108e7f02f246251492267d1bacaf32ad1e3b36dc98e0db9dd4b696c2680b7518b7270

data/.travis.yml

@@ -28,22 +28,26 @@ script:
 matrix:
   fast_finish: true
   exclude:
-    - rvm: "1.9.3"
+    - rvm: 1.9.3
+    - rvm: 2.2.6
+      gemfile: gemfiles/rails-edge.gemfile
+    - rvm: 2.3.3
+      gemfile: gemfiles/rails-edge.gemfile
   include:
-    - rvm: "1.9.3"
-      gemfile: "gemfiles/rails-3.0.gemfile"
-    - rvm: "1.9.3"
-      gemfile: "gemfiles/rails-3.1.gemfile"
-    - rvm: "1.9.3"
-      gemfile: "gemfiles/rails-3.2.gemfile"
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails-3.0.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails-3.1.gemfile
+    - rvm: 1.9.3
+      gemfile: gemfiles/rails-3.2.gemfile
   allow_failures:
   - rvm: 1.9.3 # bundler wont install the gems
   - rvm: 2.4.2
     gemfile: gemfiles/rails-4.0.gemfile
   - rvm: 2.4.2
     gemfile: gemfiles/rails-4.1.gemfile
-  - rvm: "jruby-1.7.26"
-  - rvm: "jruby-9.1.9.0"
+  - rvm: jruby-1.7.26
+  - rvm: jruby-9.1.9.0
 notifications:
   email: false
   slack:

data/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [2.6.2] - 2018-10-17
+
+### Fixed
+
+  - Fixes an issue where logging without specifying data would raise an error
+  - Fix nested hash in parameters not showing up in logs
+
 ## [2.6.1] - 2017-11-28
 
 ### Fixed

data/lib/timber/current_context.rb

@@ -57,6 +57,13 @@ module Timber
     #     # ... anything logged here will include the context ...
     #   end
     #
+    # @note Any custom context needs to have a single root key to be valid. i.e. instead of:
+    #   Timber::CurrentContext.with(job_id: "123", job_name: "Refresh User Account")
+    #
+    # do
+    #
+    #   Timber::CurrentContext.with(job: {job_id: "123", job_name: "Refresh User Account"})
+    #
     # @example Adding multiple contexts
     #   Timber::CurrentContext.with(context1, context2) { ... }
     def with(*objects)

data/lib/timber/events/custom.rb

@@ -27,7 +27,7 @@ module Timber
         @type = normalizer.fetch!(:type, :symbol)
         @message = normalizer.fetch!(:message, :string)
 
-        data = normalizer.fetch!(:data, :hash)
+        data = normalizer.fetch(:data, :hash, default: {})
 
         if !data.nil? && data[:time_ms].is_a?(Time)
           data[:time_ms] = Timer.duration_ms(data[:time_ms])
@@ -50,4 +50,4 @@ module Timber
       end
     end
   end
-end
+end

data/lib/timber/util/attribute_normalizer.rb

@@ -23,7 +23,7 @@ module Timber
         v = @attributes[key]
 
         if blank?(v)
-          nil
+          options[:default] || nil
         else
           case type
           when :array

data/lib/timber/util/hash.rb

@@ -83,8 +83,8 @@ module Timber
         # We use is_a? because it accounts for inheritance.
         def is_a_primitive_type?(v)
           v.is_a?(Array) || v.is_a?(Integer) || v.is_a?(Float) || v.is_a?(TrueClass) ||
-            v.is_a?(FalseClass) || v.is_a?(String) || v.is_a?(Time)
+            v.is_a?(FalseClass) || v.is_a?(String) || v.is_a?(Time) || v.is_a?(::Hash)
         end
     end
   end
-end
+end

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.6.1"
+  VERSION = "2.6.2"
 end

data/spec/timber/events/custom_spec.rb

@@ -19,4 +19,18 @@ describe Timber::Events::Custom, :rails_23 => true do
       expect(data[:time_ms]).to be > 0.0
     end
   end
-end
+
+  describe "#new" do
+    it "does not require data key" do
+      custom_event = described_class.new(:type => "my type", :message => "hello")
+    end
+  end
+
+  describe "#as_json" do
+    it "should render an empty data hash" do
+      custom_event = described_class.new(:type => "my type", :message => "hello")
+      hash = custom_event.as_json()
+      expect(hash).to eq({:custom => {:"my type" => {}}})
+    end
+  end
+end

data/spec/timber/util/hash_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Timber::Util::Hash, :rails_23 => true do
+  describe "jsonify" do
+    it "should return the original for simple 1 level hash" do
+      original = { a: "a", b: 1, c: 123.11 }
+      v = jsonify(original)
+      expect(v).to eq(original)
+    end
+
+    it "should return the original when it's a multilevel hash but with supported values" do
+      original = { a: "a", nested: { b: 1 } }
+      v = jsonify(original)
+      expect(v).to eq(original)
+    end
+
+    it "cuts out ASCII strings longer than 1000 characters from the hash" do
+      file1 = ("a" * 1005).encode("ASCII-8BIT")
+      file2 = ("x" * 1010).encode("ASCII-8BIT")
+      original = { path: "abc", file: file1, nested: { path: "def", file: file2 } }
+      v = jsonify(original)
+      expect(v).to eq({ path: "abc", nested: { path: "def" } })
+    end
+
+    def jsonify(h)
+      Timber::Util::Hash.jsonify(h)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.6.2
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-28 00:00:00.000000000 Z
+date: 2018-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -293,6 +293,7 @@ files:
 - spec/timber/log_entry_spec.rb
 - spec/timber/logger_spec.rb
 - spec/timber/util/attribute_normalizer_spec.rb
+- spec/timber/util/hash_spec.rb
 - spec/timber/util/request_spec.rb
 - timber.gemspec
 homepage: https://github.com/timberio/timber-ruby
@@ -364,4 +365,5 @@ test_files:
 - spec/timber/log_entry_spec.rb
 - spec/timber/logger_spec.rb
 - spec/timber/util/attribute_normalizer_spec.rb
+- spec/timber/util/hash_spec.rb
 - spec/timber/util/request_spec.rb