timber 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a26e7b9b1e27e631deac9a62753d67fabfe532a37446c29ad532fc6948b5682
-  data.tar.gz: 66c38071146891f8d8e7a763a2486eda7d5aef7fdffbffb9a26dc8128a581e79
+  metadata.gz: 3d765ddddb68b5b6af092b021c1e0971bf4979ae93f8c85104c7bddefea7fa30
+  data.tar.gz: 156ec4acdf3aa23ffcc87d2b6efaeb260dd5dc191905dbceff76a05eef273adb
 SHA512:
-  metadata.gz: 5acf7ca9461dd5b24b20cda20f7f6828e5f78c8fcb8cc44a3ef8a01ec882ba5fbcdec33f522d5753b4ef81a750c27820b33dbfb8d4cdd5eab80a299ce43bdece
-  data.tar.gz: e47f9313d14194be733203491d82213f87e5d1c2d5f2f6796a29e489dec892b6b699016a657147263e2658fd835f7836b64ed423fa6c882c1dd9171b8e2c51ee
+  metadata.gz: a6f2df759bf0545435c7b52c7673871f212a31e00491e90c88ed672380ce344b69c700af3d2757272c6d01b4f722f0ee1c553b9012ac817173a3d5aef5b6dc52
+  data.tar.gz: 5bac442f91f99b0a7aaa9f27a6f75ea4a8d197abd68f1860a59f92a220ae817450c9f363ed2b52808602e90180bcf1e13a40ea02dca2b5d58d168b8820b2e6fa

data/CHANGELOG.md

@@ -7,11 +7,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [3.0.1] - 2019-04-10
+
+### Fixed
+
+  - Fixed a bug where `Timber.with_context` was calling a non-existent method. [#205](https://github.com/timberio/timber-ruby/pull/205)
+
+## [3.0.0] - 2019-03-28
+
 ### Changed
 
   - Timber's Rails integration has been moved to the optional `timber_rails` gem: https://github.com/timberio/timber-ruby-rails
   - Timber's Rack integration has been moved to the optional `timber_rack` gem: https://github.com/timberio/timber-ruby-rack
-  - Custom events are no longer nested under the `custom.event` key, events are now merged into the root docoment.
+  - Custom events are no longer nested under the `custom.event` key, events are now merged into the root document.
   - Custom contexts are no longer nested under the `context.custom` key, contexts are not part of the top-level `context` document.
   - The Timber JSON schema (`$shema` key) was dropped since the Timber.io service no longer requires a strict schema (structured data in any shape is accepted).
   - `Timber::LogDevices::HTTP#initialize` now takes a second `source_id` parameter. Timber's new API keys are no longer Timber source specific and therefore require a `source_id` to be specificed. Ex: `Timber::LogDevices::HTTP.new('api_key', 'source_id')`.
@@ -134,7 +142,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
     instead of applying back pressure.
 
 
-[Unreleased]: https://github.com/timberio/timber-ruby/compare/v2.6.1...HEAD
+[Unreleased]: https://github.com/timberio/timber-ruby/compare/v3.0.1...HEAD
+[3.0.1]: https://github.com/timberio/timber-ruby/compare/v3.0.0...v3.0.1
+[3.0.0]: https://github.com/timberio/timber-ruby/compare/v2.6.1...v3.0.0
 [2.6.1]: https://github.com/timberio/timber-ruby/compare/v2.6.0...v2.6.1
 [2.6.0]: https://github.com/timberio/timber-ruby/compare/v2.5.1...v2.6.0
 [2.5.1]: https://github.com/timberio/timber-ruby/compare/v2.5.0...v2.5.1

data/README.md

@@ -26,7 +26,19 @@ important stats easier than ever.
 
 ---
 
-* **[Features](https://docs.timber.io/setup/languages/ruby#features)**
+### Features
+
+* Simple integration. Exposes the same API as the Ruby Logger.
+* Performant, light-weight, and thoughtful design.
+* Support for structured logging.
+* Support for context.
+* Automatic context capturing.
+* Integrates with popular 3rd party libraries, such as Rails and Rack.
+
+---
+
+### Get Started
+
 * **[Installation](https://docs.timber.io/setup/languages/ruby#installation)**
 * **[Configuration](https://docs.timber.io/setup/languages/ruby#configuration)**
 * **[Usage](https://docs.timber.io/setup/languages/ruby#usage)**

data/UPGRADING.md

@@ -0,0 +1,48 @@
+# Upgrading
+
+## 2.x to 3.x
+
+### Overview
+
+We're excited to announce the 3.X line of Timber for Ruby! We've been making big
+strides with Timber as a whole and 3.X represents a lot of big improvements:
+
+- A lighter code base
+- Better performance
+- A simpler, better install process and strategy
+- New docs: https://docs.timber.io/setup/languages/ruby
+- New integration libraries focused on the specific library they're integrating with
+
+  - https://github.com/timberio/timber-ruby-rack
+  - https://github.com/timberio/timber-ruby-rails
+
+Outside of that, 3.0 does not introduce any API changes, and is forward compatbile
+in that regard. This means actions like setting context and logging structured data
+will continue to work as expected.
+
+### Rails
+
+If you're on Rails, the upgrade process is simple. Simply add the `timber-rails`
+gem to your `Gemfile`:
+
+```
+gem 'timber-rails', '~> 1.0'
+```
+
+That's it! Everything is taken care of you via a Rails initializer.
+
+More info: https://docs.timber.io/setup/languages/ruby/integrations/rack
+
+### Non-rails
+
+If you're not on rails, and you're using `Rack`, you'll want to install the
+`timber-rack` gem by adding it to your `Gemfile`:
+
+```
+gem 'timber-rack', '~> 1.0'
+```
+
+That's it! The middleware class names are still the same and should not
+require any altering.
+
+More info: https://docs.timber.io/setup/languages/ruby/integrations/rack

data/lib/timber/current_context.rb

@@ -38,6 +38,11 @@ module Timber
       def reset(*args)
         instance.reset(*args)
       end
+
+      # Convenience method for {CurrentContext#with}. See {CurrentContext#with} for more info.
+      def with(*args, &block)
+        instance.with(*args, &block)
+      end
     end
 
     # Adds contexts but does not remove them. See {#with} for automatic maintenance and {#remove}
@@ -68,6 +73,12 @@ module Timber
       self
     end
 
+    def replace(hash)
+      @hash = hash
+      expire_cache!
+      self
+    end
+
     # Resets the context to be blank. Use this carefully! This will remove *any* context,
     # include context that is automatically included with Timber.
     def reset
@@ -83,6 +94,35 @@ module Timber
       @snapshot ||= hash.clone
     end
 
+    # Adds a context and then removes it when the block is finished executing.
+    #
+    # @note Because context is included with every log line, it is recommended that you limit this
+    #   to only neccessary data.
+    #
+    # @example Adding a custom context
+    #   Timber::CurrentContext.with({build: {version: "1.0.0"}}) do
+    #     # ... 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)
+      old_hash = hash.clone
+      begin
+        add(*objects)
+        yield
+      ensure
+        replace(old_hash)
+      end
+    end
+
     private
       # The internal hash that is maintained. Use {#with} and {#add} for hash maintenance.
       def hash

data/lib/timber/version.rb

@@ -1,3 +1,3 @@
 module Timber
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/spec/timber/current_context_spec.rb

@@ -89,4 +89,25 @@ describe Timber::CurrentContext do
       expect(described_class.instance.send(:hash)[:build]).to be_nil
     end
   end
+
+  describe ".with" do
+    it "should merge the context and cleanup on block exit" do
+      expect(described_class.instance.send(:hash)[:build]).to be_nil
+
+      described_class.with({build: {version: "1.0.0"}}) do
+        expect(described_class.instance.send(:hash)[:build]).to eq({:version=>"1.0.0"})
+
+        described_class.with({testing: {key: "value"}}) do
+          expect(described_class.instance.send(:hash)[:build]).to eq({:version=>"1.0.0"})
+          expect(described_class.instance.send(:hash)[:testing]).to eq({:key=>"value"})
+        end
+
+        expect(described_class.instance.send(:hash)[:build]).to eq({:version=>"1.0.0"})
+        expect(described_class.instance.send(:hash)[:testing]).to be_nil
+      end
+
+      expect(described_class.instance.send(:hash)[:build]).to be_nil
+      expect(described_class.instance.send(:hash)[:testing]).to be_nil
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timber
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Timber Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-27 00:00:00.000000000 Z
+date: 2019-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -153,6 +153,7 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- UPGRADING.md
 - bin/timber
 - lib/timber.rb
 - lib/timber/config.rb