safely_block 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65bad436ec7ddcd49ef1836e3ec0f077b8754290
-  data.tar.gz: fcafabce7a11b00143410a3083f78cbdee24bab3
+  metadata.gz: 9ba20f765b3e7d5a3a42de0c5376d06f2fa1a123
+  data.tar.gz: 100cf5b7ab1a8fba676b64e7914908d7d23f8276
 SHA512:
-  metadata.gz: 180b1e137dcf01415624ea95333f2e571cd96edcaedb628ed99d83cb32d787ba470f8afc8f4084352cce7f5b162719bee5435e8742a431391dd0b5c95a0a4ff3
-  data.tar.gz: 381c7aa036d20fd55577d67425e2f4a264af515231bb65c25d124b8bf68c0eb3f789cfe4338f4c859d8ce69d8ccaaf931e7317c20287982c4068655992bb72bd
+  metadata.gz: c781fdff6e44069440281ba046b853e97a187c0ef59110231c4571113abd6451f15ecbb94484b7c53afcd0c2d07e24f8ddd28a3cd1ed843611dfcb2d97b73ee2
+  data.tar.gz: 1d261002fdf45d8fe088a75203ce55e61467aefb41547abbbad2ae617384f3f9bb3579b3ea961e24369daa21666dcd91803fde2eb8c9accd9a41521f1625d765

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.1
+
+- Added `Safely.safely` to not pollute when included in gems
+- Added `throttle` option
+
 ## 0.1.0
 
 - Added `tag` option and tag exception message by default

data/README.md

@@ -1,30 +1,28 @@
 # Safely
 
-Unexpected data can cause errors in production - don’t let it bring down the system
-
 ```ruby
 safely do
   # keep going if this code fails
 end
 ```
 
-Exceptions are rescued and reported to your favorite reporting service.
+Exceptions are rescued and automatically reported to your favorite reporting service.
 
-In development and test environments, exceptions are raised so you can fix them. :smirk:
+In development and test environments, exceptions are raised so you can fix them.
 
-## Examples
+## Use It Everywhere
 
-Great for analytics
+“Oh no, analytics brought down search”
 
 ```ruby
-safely { track_event("Search") }
+safely { track_search(params) }
 ```
 
-and background jobs
+“Recommendations stopped updating because of one bad user”
 
 ```ruby
-User.find_each do |user|
-  safely { cache_recommendations(user) }
+users.each do |user|
+  safely { update_recommendations(user) }
 end
 ```
 
@@ -32,18 +30,10 @@ Also aliased as `yolo`.
 
 ## Features
 
-Throttle reporting with:
-
-```ruby
-safely sample: 1000 do
-  # reports ~ 1/1000 errors
-end
-```
-
 Specify a default value to return on exceptions
 
 ```ruby
-score = safely(default: 30) { calculate_score }
+show_banner = safely(default: true) { show_banner_logic }
 ```
 
 Raise specific exceptions
@@ -70,6 +60,16 @@ Silence exceptions
 safely(silence: ActiveRecord::RecordNotUnique) { code }
 ```
 
+Throttle reporting with:
+
+```ruby
+safely throttle: {limit: 10, period: 1.minute} do
+  # reports only first 10 exceptions each minute
+end
+```
+
+**Note:** The throttle limit is approximate and per process.
+
 ## Reporting
 
 Reports exceptions to a variety of services out of the box thanks to [Errbase](https://github.com/ankane/errbase).
@@ -96,6 +96,12 @@ By default, exception messages are prefixed with `[safely]`. This makes it easie
 Safely.tag = false
 ```
 
+To report exceptions manually:
+
+```ruby
+Safely.report_exception(e)
+```
+
 ## Installation
 
 Add this line to your application’s Gemfile:

data/lib/safely/core.rb

@@ -0,0 +1,57 @@
+require "safely/version"
+require "errbase"
+require "digest"
+
+module Safely
+  class << self
+    attr_accessor :raise_envs, :tag, :report_exception_method, :throttle_counter
+    attr_writer :env
+
+    def report_exception(e)
+      report_exception_method.call(e)
+    end
+
+    def env
+      @env ||= ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
+    end
+
+    def throttled?(e, options)
+      return false unless options
+      key = "#{options[:key] || Digest::MD5.hexdigest([e.class.name, e.message, e.backtrace.join("\n")].join("/"))}/#{(Time.now.to_i / options[:period]) * options[:period]}"
+      throttle_counter.clear if throttle_counter.size > 1000 # prevent from growing indefinitely
+      (throttle_counter[key] += 1) > options[:limit]
+    end
+  end
+
+  DEFAULT_EXCEPTION_METHOD = proc do |e|
+    e = e.dup # leave original exception unmodified
+    e.message.prepend("[safely] ") if e.message && Safely.tag
+    Errbase.report(e)
+  end
+
+  self.tag = true
+  self.report_exception_method = DEFAULT_EXCEPTION_METHOD
+  self.raise_envs = %w(development test)
+  # not thread-safe, but we don't need to be exact
+  self.throttle_counter = Hash.new(0)
+
+  module Methods
+    def safely(options = {})
+      yield
+    rescue *Array(options[:only] || StandardError) => e
+      raise e if Array(options[:except]).any? { |c| e.is_a?(c) }
+      raise e if Safely.raise_envs.include?(Safely.env)
+      sample = options[:sample]
+      if sample ? rand < 1.0 / sample : true
+        begin
+          Safely.report_exception(e) unless Array(options[:silence]).any? { |c| e.is_a?(c) } || Safely.throttled?(e, options[:throttle])
+        rescue => e2
+          $stderr.puts "FAIL-SAFE #{e2.class.name}: #{e2.message}"
+        end
+      end
+      options[:default]
+    end
+    alias_method :yolo, :safely
+  end
+  extend Methods
+end

data/lib/safely/version.rb

@@ -0,0 +1,3 @@
+module Safely
+  VERSION = "0.1.1"
+end

data/lib/safely_block.rb

@@ -1,45 +1,3 @@
-require "errbase"
-
-module Safely
-  VERSION = "0.1.0"
-
-  class << self
-    attr_accessor :env, :raise_envs, :tag, :report_exception_method
-
-    def report_exception(e)
-      report_exception_method.call(e)
-    end
-  end
-
-  DEFAULT_EXCEPTION_METHOD = proc do |e|
-    e = e.dup # leave original exception unmodified
-    e.message.prepend("[safely] ") if e.message && Safely.tag
-    Errbase.report(e)
-  end
-
-  self.env = ENV["RACK_ENV"] || ENV["RAILS_ENV"] || "development"
-  self.tag = true
-  self.report_exception_method = DEFAULT_EXCEPTION_METHOD
-  self.raise_envs = %w(development test)
-
-  module Methods
-    def safely(options = {})
-      yield
-    rescue *Array(options[:only] || StandardError) => e
-      raise e if Array(options[:except]).any? { |c| e.is_a?(c) }
-      raise e if Safely.raise_envs.include?(Safely.env)
-      sample = options[:sample]
-      if sample ? rand < 1.0 / sample : true
-        begin
-          Safely.report_exception(e) unless Array(options[:silence]).any? { |c| e.is_a?(c) }
-        rescue => e2
-          $stderr.puts "FAIL-SAFE #{e2.class.name}: #{e2.message}"
-        end
-      end
-      options[:default]
-    end
-    alias_method :yolo, :safely
-  end
-end
+require "safely/core"
 
 Object.send :include, Safely::Methods

data/safely_block.gemspec

@@ -1,16 +1,16 @@
 # coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "safely_block"
+require "safely/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "safely_block"
   spec.version       = Safely::VERSION
   spec.authors       = ["Andrew Kane"]
   spec.email         = ["andrew@chartkick.com"]
-  spec.summary       = "Don’t let small errors bring down the system"
-  spec.description   = "Don’t let small errors bring down the system"
-  spec.homepage      = "https://github.com/ankane/safely_block"
+  spec.summary       = "Awesome exception handling"
+  spec.description   = "Awesome exception handling"
+  spec.homepage      = "https://github.com/ankane/safely"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/test/safely_test.rb

@@ -82,4 +82,26 @@ class TestSafely < Minitest::Test
     end
     assert_equal "FAIL-SAFE RuntimeError: oops\n", err
   end
+
+  def test_throttle
+    count = 0
+    Safely.report_exception_method = proc { |e| count += 1 }
+    5.times do |n|
+      safely throttle: {limit: 2, period: 3600} do
+        raise Safely::TestError
+      end
+    end
+    assert_equal 2, count
+  end
+
+  def test_throttle_key
+    count = 0
+    Safely.report_exception_method = proc { |e| count += 1 }
+    5.times do |n|
+      safely throttle: {limit: 2, period: 3600, key: "boom#{n % 2}"} do
+        raise Safely::TestError
+      end
+    end
+    assert_equal 4, count
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safely_block
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2016-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: errbase
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
-description: Don’t let small errors bring down the system
+description: Awesome exception handling
 email:
 - andrew@chartkick.com
 executables: []
@@ -79,11 +79,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/safely/core.rb
+- lib/safely/version.rb
 - lib/safely_block.rb
 - safely_block.gemspec
 - test/safely_test.rb
 - test/test_helper.rb
-homepage: https://github.com/ankane/safely_block
+homepage: https://github.com/ankane/safely
 licenses:
 - MIT
 metadata: {}
@@ -103,10 +105,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.1
 signing_key: 
 specification_version: 4
-summary: Don’t let small errors bring down the system
+summary: Awesome exception handling
 test_files:
 - test/safely_test.rb
 - test/test_helper.rb