timber 2.1.0.rc5 → 2.1.0.rc6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bb5abd9ff785281715e45354703c1b9c3f2b25b
-  data.tar.gz: 347d46a12f3880a73e28d595554c5f838bb59eb1
+  metadata.gz: 7a643334c71fa0882be4dff042d82a30e2b46a6a
+  data.tar.gz: 5fa71626d12aa84e4235de2134c4dead24de3bd3
 SHA512:
-  metadata.gz: 553e015f5deecc539ec6437e7ae661f2e75d0d3bee6e92b095efb05f5ce180a7bc7ba7d710ca5749f022d61e3ed26e1f0b02cb1e778693f1f5553cf15570d9c8
-  data.tar.gz: 979086f4ac6d10bb38276696eed64b3ccf9cb79b2b057c8f83d3e1e045959735e4d9ab0cc47874cd21d2e4ba0bebd87382576436e94aff15204c0d9dcccc2944
+  metadata.gz: b51e148b80b8054a020ff4a3e6a0d0044755da44373360aedda5c3c495e53c4b920d4e697bfb25f778bccc7f1fe39c1e14738af3813a312dfc8ebb4b39579b57
+  data.tar.gz: 59b9e2d8caf5072fc05a17939c734e5f4fda0800f8b6b92a4f8acffd28ae0951e35561f2831a3bc782969690f52ba8a45307eceb7e27d056306e515ae3e90206

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+Please see [https://github.com/timberio/timber-ruby/releases](https://github.com/timberio/timber-ruby/releases) for library specific changes.
+
+For all Timber changes see [https://timber.io/changelog](https://timber.io/changelog).

data/README.md

@@ -2,7 +2,6 @@
 
 [![ISC License](https://img.shields.io/badge/license-ISC-ff69b4.svg)](LICENSE.md)
 [![Build Status](https://travis-ci.org/timberio/timber-ruby.svg?branch=master)](https://travis-ci.org/timberio/timber-ruby)
-[![Build Status](https://travis-ci.org/timberio/timber-ruby.svg?branch=master)](https://travis-ci.org/timberio/timber-ruby)
 [![Code Climate](https://codeclimate.com/github/timberio/timber-ruby/badges/gpa.svg)](https://codeclimate.com/github/timberio/timber-ruby)
 [![View docs](https://img.shields.io/badge/docs-viewdocs-blue.svg?style=flat-square "Viewdocs")](http://www.rubydoc.info/github/timberio/timber-ruby)
 
@@ -198,8 +197,8 @@ end
 
 Aggregates destroy details, and with Timber capturing metrics and timings is just logging events.
 Timber is built on modern big-data principles, it can calculate aggregates across terrabytes of
-data in seconds. Don't reduce the quality of your data because the system processing
-your data is limited.
+data in seconds. Don't reduce the quality of your log data to accomodate a restrive
+logging system.
 
 Here's a timing example. Notice how Timber automatically calculates the time and adds the timing
 to the message.
@@ -213,7 +212,7 @@ logger.info("Processed background job", background_job: {time_ms: timer})
 # => Processed background job in 54.2ms @metadata {"level": "info", "event": {"background_job": {"time_ms": 54.2}}}
 ```
 
-And of course, `time_ms` can also take a `Float`:
+And of course, `time_ms` can also take a `Float` or `Fixnum`:
 
 ```ruby
 logger.info("Processed background job", background_job: {time_ms: 45.6})
@@ -296,10 +295,10 @@ config.integrations.rack.http_events.collapse_into_single_event = true
 ```
 
 This does _not_ silence the controller call log event. This is because Timber captures the
-parameters passed to the controller, which is very valuable when debugging.
+parameters passed to the controller, which are generally valuable when debugging.
 
-For a full list of integrations and settings, see
-[Timber::Integrations](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Integrations)
+For a full list of integration settings, see
+[Timber::Config::Integrations](http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config/Integrations)
 
 ---
 

data/lib/timber/cli/config_file.rb

@@ -3,14 +3,15 @@ require "timber/cli/file_helper"
 module Timber
   class CLI
     class ConfigFile
-      attr_reader :path
+      attr_reader :path, :file_helper
 
-      def initialize(path)
+      def initialize(path, file_helper)
         @path = path
+        @file_helper = file_helper
       end
 
       def create!
-        FileHelper.write(path, content)
+        file_helper.write(path, content)
       end
 
       def exists?

data/lib/timber/cli/installers/config_file.rb

@@ -12,7 +12,7 @@ module Timber
     module Installers
       class ConfigFile < Installer
         def run(app, path)
-          config_file = Timber::CLI::ConfigFile.new(path)
+          config_file = Timber::CLI::ConfigFile.new(path, file_helper)
 
           if config_file.exists?
             io.puts ""

data/lib/timber/config/integrations.rb

@@ -29,7 +29,7 @@ module Timber
         Timber::Integrations::ActionController
       end
 
-      # Convenience method for accessing the {Timber::IIntegrations::ActionView} class
+      # Convenience method for accessing the {Timber::Integrations::ActionView} class
       # specific configuration.
       #
       # @example
@@ -39,7 +39,7 @@ module Timber
         Timber::Integrations::ActionView
       end
 
-      # Convenience method for accessing the {Timber::IIntegrations::ActiveRecord} class
+      # Convenience method for accessing the {Timber::Integrations::ActiveRecord} class
       # specific configuration.
       #
       # @example
@@ -49,7 +49,7 @@ module Timber
         Timber::Integrations::ActiveRecord
       end
 
-      # Convenience method for accessing the various `Timber::IIntegrations::Rack::*`
+      # Convenience method for accessing the various `Timber::Integrations::Rack::*`
       # classes. See {Rack} for a list of methods available.
       #
       # @example

data/lib/timber/contexts/custom.rb

@@ -28,7 +28,7 @@ module Timber
         @data = attributes[:data] || raise(ArgumentError.new(":data is required"))
       end
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(options = {})
         {Timber::Util::Object.try(type, :to_sym) => data}
       end

data/lib/timber/contexts/http.rb

@@ -3,15 +3,15 @@ require "timber/context"
 module Timber
   module Contexts
     # The HTTP context adds data about the current HTTP request being processed to your logs.
-    # This allows your to tail and filter by this data. A very useful piece of data this
+    # This allows you to tail and filter by this data. A very useful piece of data this
     # captures is the request ID. This gives you the ability to trace requests and view logs
     # for a specific request only. For example, say you've searched your logs and found the
     # specific line you are looking for, but it lacks context. With Timber you can simply
     # click the request ID and "zoom out" to view all logs for that request. This gives you
     # complete picture of how the log line in questio was generated.
     #
-    # @note This context should be installed automatically through integrations,
-    #   such as the {Intregrations::Rack::HTTPContext} rack middleware.
+    # @note This context should be installed automatically through the,
+    #   {Intregrations::Rack::HTTPContext} Rack middleware.
     class HTTP < Context
       @keyspace = :http
 
@@ -24,7 +24,7 @@ module Timber
         @request_id = attributes[:request_id]
       end
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {:method => method, :path => path, :remote_addr => remote_addr, :request_id => request_id}
       end

data/lib/timber/contexts/organization.rb

@@ -28,7 +28,7 @@ module Timber
         @name = attributes[:name]
       end
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {id: Timber::Util::Object.try(id, :to_s), name: name}
       end

data/lib/timber/contexts/release.rb

@@ -5,7 +5,8 @@ require "timber/util"
 module Timber
   module Contexts
     # The release context tracks application releases / versions / deploys.
-    # To automatically set this context, see {.from_env}.
+    #
+    # @note To automatically set this context, see {.from_env}.
     class Release < Context
       @keyspace = :release
 
@@ -40,7 +41,7 @@ module Timber
         @version = attributes[:version]
       end
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {commit_hash: commit_hash, created_at: created_at, version: version}
       end

data/lib/timber/contexts/runtime.rb

@@ -20,7 +20,7 @@ module Timber
         @module_name = attributes[:module_name]
       end
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {application: application, class_name: class_name, file: file, function: function,
           line: line, module_name: module_name}

data/lib/timber/contexts/session.rb

@@ -3,7 +3,7 @@ require "timber/util"
 
 module Timber
   module Contexts
-    # The session context adds the current session ID to your logs. This allows your
+    # The session context adds the current session ID to your logs. This allows you
     # to tail and filter logs by specific session IDs. Moreover, it gives you a unique
     # identifier to report on user activity by session. This way your logs can tell the
     # story of how many time a user has engaged your site.
@@ -19,7 +19,7 @@ module Timber
         @id = attributes[:id] || raise(ArgumentError.new(":id is required"))
       end
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {id: Timber::Util::Object.try(id, :to_s)}
       end

data/lib/timber/contexts/system.rb

@@ -4,6 +4,9 @@ require "timber/util"
 module Timber
   module Contexts
     # The system context tracks OS level process information, such as the process ID.
+    #
+    # @note This is tracked automatically in {CurrentContext}. When the current context
+    #   is initialized, the system context gets added automatically.
     class System < Context
       @keyspace = :system
 
@@ -15,7 +18,7 @@ module Timber
         @pid = @pid.to_s
       end
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {hostname: hostname, pid: Timber::Util::Object.try(pid, :to_s)}
       end

data/lib/timber/contexts/user.rb

@@ -21,7 +21,7 @@ module Timber
         @email = attributes[:email]
       end
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {id: Timber::Util::Object.try(id, :to_s), name: name, email: email}
       end

data/lib/timber/events/controller_call.rb

@@ -26,7 +26,7 @@ module Timber
       end
       alias to_h to_hash
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {:controller_call => to_hash}
       end

data/lib/timber/events/custom.rb

@@ -41,7 +41,7 @@ module Timber
       end
       alias to_h to_hash
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {:custom => to_hash}
       end

data/lib/timber/events/exception.rb

@@ -28,7 +28,7 @@ module Timber
       end
       alias to_h to_hash
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {:exception => to_hash}
       end

data/lib/timber/events/http_client_request.rb

@@ -33,7 +33,7 @@ module Timber
       end
       alias to_h to_hash
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {:http_client_request => to_hash}
       end

data/lib/timber/events/http_client_response.rb

@@ -28,7 +28,7 @@ module Timber
       end
       alias to_h to_hash
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {:http_client_response => to_hash}
       end

data/lib/timber/events/http_server_request.rb

@@ -30,7 +30,7 @@ module Timber
       end
       alias to_h to_hash
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {:http_server_request => to_hash}
       end

data/lib/timber/events/http_server_response.rb

@@ -26,7 +26,7 @@ module Timber
       end
       alias to_h to_hash
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {:http_server_response => to_hash}
       end

data/lib/timber/events/sql_query.rb

@@ -21,7 +21,7 @@ module Timber
       end
       alias to_h to_hash
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {:sql_query => to_hash}
       end

data/lib/timber/events/template_render.rb

@@ -21,7 +21,7 @@ module Timber
       end
       alias to_h to_hash
 
-      # Builds a hash representation of containing simply objects, suitable for serialization.
+      # Builds a hash representation containing simple objects, suitable for serialization (JSON).
       def as_json(_options = {})
         {:template_render => to_hash}
       end

data/lib/timber/log_devices/http.rb

@@ -12,7 +12,7 @@ module Timber
     # A highly efficient log device that buffers and delivers log messages over HTTPS to
     # the Timber API. It uses batches, keep-alive connections, and msgpack to deliver logs with
     # high-throughput and little overhead. All log preparation and delivery is done asynchronously
-    # in a thread as not to block application execution and efficient deliver logs for
+    # in a thread as not to block application execution and efficiently deliver logs for
     # multi-threaded environments.
     #
     # See {#initialize} for options and more details.

data/lib/timber/log_entry.rb

@@ -13,7 +13,7 @@ module Timber
     attr_reader :context_snapshot, :event, :level, :message, :progname, :tags, :time, :time_ms
 
     # Creates a log entry suitable to be sent to the Timber API.
-    # @param severity [Integer] the log level / severity
+    # @param level [Integer] the log level / severity
     # @param time [Time] the exact time the log message was written
     # @param progname [String] the progname scope for the log message
     # @param message [String] Human readable log message.
@@ -37,7 +37,7 @@ module Timber
       @event = event
     end
 
-    # Builds a hash representation of containing simply objects, suitable for serialization.
+    # Builds a hash representation containing simple objects, suitable for serialization (JSON).
     def as_json(options = {})
       options ||= {}
       hash = {

data/lib/timber/overrides/lograge.rb

@@ -1,5 +1,9 @@
 # Timber and lograge are not compatible installed together. Using lograge
 # with the Timber.io *service* is perfectly fine, but not with the Timber *gem*.
+#
+# Timber does ship with a {Timber::Config#logrageify!} option that configures
+# Timber to behave similarly to Lograge (silencing various logs). Check out
+# the aforementioned method or the README for info.
 begin
   require "lograge"
 

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "2.1.0.rc5"
+  VERSION = "2.1.0.rc6"
 end

data/spec/timber/cli/config_file_spec.rb

@@ -1,14 +1,16 @@
 require "spec_helper"
 
 describe Timber::CLI::ConfigFile, :rails_23 => true do
+  let(:api) { Timber::CLI::API.new("abcd1234") }
+  let(:file_helper) { @file_helper = Timber::CLI::FileHelper.new(api) }
   let(:path) { "config/initializers/timber.rb" }
-  let(:config_file) { described_class.new(path) }
+  let(:config_file) { described_class.new(path, file_helper) }
   let(:initial_contents) { "# Timber.io Ruby Configuration - Simple Structured Logging\n#\n#  ^  ^  ^   ^      ___I_      ^  ^   ^  ^  ^   ^  ^\n# /|\\/|\\/|\\ /|\\    /\\-_--\\    /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   /  \\_-__\\   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# /|\\/|\\/|\\ /|\\   |[]| [] |   /|\\/|\\ /|\\/|\\/|\\ /|\\/|\\\n# -------------------------------------------------------------------\n# Website:       https://timber.io\n# Documentation: https://timber.io/docs\n# Support:       support@timber.io\n# -------------------------------------------------------------------\n\nconfig = Timber::Config.instance\n\n# Add additional configuration here.\n# For a full list of configuration options and their explanations see:\n# http://www.rubydoc.info/github/timberio/timber-ruby/Timber/Config\n\n" }
   let(:contents_hook) { "# Add additional configuration here." }
 
   describe ".create!" do
     it "should create" do
-      expect(Timber::CLI::FileHelper).to receive(:write).with(path, initial_contents).exactly(1).times
+      expect(config_file.file_helper).to receive(:write).with(path, initial_contents).exactly(1).times
       config_file.create!
     end
   end

data/spec/timber/cli/installers/config_file_spec.rb

@@ -23,9 +23,9 @@ describe Timber::CLI::Installers::ConfigFile, :rails_23 => true do
   describe ".run" do
     it "should run properly" do
       path = "/path/to/file"
-      config_file = Timber::CLI::ConfigFile.new(path)
+      config_file = Timber::CLI::ConfigFile.new(path, installer.file_helper)
 
-      expect(Timber::CLI::ConfigFile).to receive(:new).with(path).and_return(config_file)
+      expect(Timber::CLI::ConfigFile).to receive(:new).with(path, installer.file_helper).and_return(config_file)
       expect(config_file).to receive(:exists?).exactly(1).times.and_return(false)
       expect(installer).to receive(:logrageify?).exactly(1).times.and_return(true)
       expect(config_file).to receive(:logrageify!).exactly(1).times

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 2.1.0.rc5
+  version: 2.1.0.rc6
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2017-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -134,7 +134,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md

data/CHANGELOG

@@ -1,3 +0,0 @@
-Please see https://github.com/timberio/timber-ruby/releases for library specific changes.
-
-For all Timber changes see https://timber.io/changelog.