safely_block 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ff610f8bed6b2446fd70d85987ec4e622e5f5021
-  data.tar.gz: 56a9d89bee3fd0aa4804623e29639b3aeb39e8a2
+SHA256:
+  metadata.gz: ffb5e297c082239df9675faa3fb796e46e59c4409754738d3209c791961487a5
+  data.tar.gz: 56cb3d1229faf04817dbf6d8cfdb210cd91171bbfb65379362a98647b6283441
 SHA512:
-  metadata.gz: 06cf78fcab0ee8e6a743f27b5ca9b95f45049a47c78700013da0298f7c7967616df9c6f6f082e1a013f5e06fa12e6636d2e7fc811747fa0aa7a362328754ecba
-  data.tar.gz: 1dcf67c2f094f854f358986240c14fe5e5afcfe6514d58a1f1cc95e8f670e5caa96462180a538f3e93427b9ef419bf1be66902c913d811adc0f889cd92dcc577
+  metadata.gz: 67c689e80de505ba63395e611868074213860b740f470098e6ceb6fdf2bf1768740397905dbf0e31f5000514400562901cfe842b3326556c612ca24edba8215a
+  data.tar.gz: 5db94cbe2670b3b362646ee84a78872206753adf65e0afd7f85dc9dbe44277defac662afa11bca3318de06ceb5dd4cb03409f8c7d49f85c79b4df8dac7c5b819

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.3.0
+
+- Made `safely` method private to behave like `Kernel` methods
+
+## 0.2.2
+
+- Added `context` option
+
+## 0.2.1
+
+- Tag exceptions reported with `report_exception`
+
 ## 0.2.0
 
 - Added `tag` option to `safely` method

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Andrew Kane
+Copyright (c) 2014-2019 Andrew Kane
 
 MIT License
 

data/README.md

@@ -10,6 +10,18 @@ Exceptions are rescued and automatically reported to your favorite reporting ser
 
 In development and test environments, exceptions are raised so you can fix them.
 
+[Read more](https://ankane.org/safely-pattern)
+
+[![Build Status](https://travis-ci.org/ankane/safely.svg?branch=master)](https://travis-ci.org/ankane/safely)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'safely_block'
+```
+
 ## Use It Everywhere
 
 “Oh no, analytics brought down search”
@@ -30,6 +42,14 @@ Also aliased as `yolo`.
 
 ## Features
 
+Pass extra context to be reported with exceptions
+
+```ruby
+safely context: {user_id: 123} do
+  # code
+end
+```
+
 Specify a default value to return on exceptions
 
 ```ruby
@@ -79,7 +99,8 @@ Reports exceptions to a variety of services out of the box thanks to [Errbase](h
 - [Airbrake](https://airbrake.io/)
 - [Appsignal](https://appsignal.com/)
 - [Bugsnag](https://bugsnag.com/)
-- [Exceptional](http://www.exceptional.io/)
+- [Exception Notification](https://github.com/smartinez87/exception_notification)
+- [Google Stackdriver](https://cloud.google.com/stackdriver/)
 - [Honeybadger](https://www.honeybadger.io/)
 - [Opbeat](https://opbeat.com/)
 - [Raygun](https://raygun.io/)
@@ -89,7 +110,7 @@ Reports exceptions to a variety of services out of the box thanks to [Errbase](h
 Customize reporting with:
 
 ```ruby
-Safely.report_exception_method = -> (e) { Rollbar.error(e) }
+Safely.report_exception_method = ->(e) { Rollbar.error(e) }
 ```
 
 By default, exception messages are prefixed with `[safely]`. This makes it easier to spot rescued exceptions. Turn this off with:
@@ -104,14 +125,22 @@ To report exceptions manually:
 Safely.report_exception(e)
 ```
 
-## Installation
+## Data Protection
 
-Add this line to your application’s Gemfile:
+To protect the privacy of your users, do not send [personal data](https://en.wikipedia.org/wiki/Personally_identifiable_information) to exception services. Filter sensitive form fields, use ids (not email addresses) to identify users, and mask IP addresses.
+
+With Rollbar, you can do:
 
 ```ruby
-gem 'safely_block'
+Rollbar.configure do |config|
+  config.person_id_method = "id" # default
+  config.scrub_fields |= [:birthday]
+  config.anonymize_user_ip = true
+end
 ```
 
+While working on exceptions, be on the lookout for personal data and correct as needed.
+
 ## History
 
 View the [changelog](https://github.com/ankane/safely/blob/master/CHANGELOG.md)
@@ -124,3 +153,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/safely/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/safely.git
+cd safely
+bundle install
+rake test
+```

data/lib/safely/core.rb

@@ -7,8 +7,20 @@ module Safely
     attr_accessor :raise_envs, :tag, :report_exception_method, :throttle_counter
     attr_writer :env
 
-    def report_exception(e)
-      report_exception_method.call(e)
+    def report_exception(e, tag: nil, context: {})
+      tag = Safely.tag if tag.nil?
+      if tag && e.message
+        e = e.dup # leave original exception unmodified
+        message = e.message
+        e.define_singleton_method(:message) do
+          "[#{tag == true ? "safely" : tag}] #{message}"
+        end
+      end
+      if report_exception_method.arity == 1
+        report_exception_method.call(e)
+      else
+        report_exception_method.call(e, context)
+      end
     end
 
     def env
@@ -23,8 +35,8 @@ module Safely
     end
   end
 
-  DEFAULT_EXCEPTION_METHOD = proc do |e|
-    Errbase.report(e)
+  DEFAULT_EXCEPTION_METHOD = proc do |e, context|
+    Errbase.report(e, context)
   end
 
   self.tag = true
@@ -34,7 +46,7 @@ module Safely
   self.throttle_counter = Hash.new(0)
 
   module Methods
-    def safely(tag: nil, sample: nil, except: nil, only: nil, silence: nil, throttle: false, default: nil)
+    def safely(tag: nil, sample: nil, except: nil, only: nil, silence: nil, throttle: false, default: nil, context: {})
       yield
     rescue *Array(only || StandardError) => e
       raise e if Array(except).any? { |c| e.is_a?(c) }
@@ -42,15 +54,7 @@ module Safely
       if sample ? rand < 1.0 / sample : true
         begin
           unless Array(silence).any? { |c| e.is_a?(c) } || Safely.throttled?(e, throttle)
-            tag = Safely.tag if tag.nil?
-            if tag && e.message
-              e = e.dup # leave original exception unmodified
-              message = e.message
-              e.define_singleton_method(:message) do
-                "[#{tag == true ? "safely" : tag}] #{message}"
-              end
-            end
-            Safely.report_exception(e)
+            Safely.report_exception(e, tag: tag, context: context)
           end
         rescue => e2
           $stderr.puts "FAIL-SAFE #{e2.class.name}: #{e2.message}"

data/lib/safely/version.rb

@@ -1,3 +1,3 @@
 module Safely
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/safely_block.rb

@@ -1,3 +1,4 @@
 require "safely/core"
 
-Object.send :include, Safely::Methods
+Object.include Safely::Methods
+Object.send :private, :safely, :yolo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safely_block
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2019-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: errbase
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,33 +58,26 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
-description: Awesome exception handling
-email:
-- andrew@chartkick.com
+        version: '0'
+description: 
+email: andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
 - 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
 licenses:
 - MIT
@@ -97,18 +90,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Awesome exception handling
-test_files:
-- test/safely_test.rb
-- test/test_helper.rb
+summary: Rescue and report exceptions in non-critical code
+test_files: []

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/Gemfile

@@ -1,4 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in safely_block.gemspec
-gemspec

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-task default: :test
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-end

data/safely_block.gemspec

@@ -1,26 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-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       = "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")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "errbase"
-
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest", ">= 5"
-end

data/test/safely_test.rb

@@ -1,136 +0,0 @@
-require_relative "test_helper"
-
-class TestSafely < Minitest::Test
-  def setup
-    Safely.env = "production"
-    Safely.tag = true
-    Safely.report_exception_method = Safely::DEFAULT_EXCEPTION_METHOD
-  end
-
-  def test_development_environment
-    Safely.env = "development"
-    assert_raises(Safely::TestError) do
-      safely do
-        raise Safely::TestError
-      end
-    end
-  end
-
-  def test_test_environment
-    Safely.env = "test"
-    assert_raises(Safely::TestError) do
-      safely do
-        raise Safely::TestError
-      end
-    end
-  end
-
-  def test_production_environment
-    exception = Safely::TestError.new
-    mock = MiniTest::Mock.new
-    mock.expect :report_exception, nil, [exception]
-    Safely.report_exception_method = -> (e) { mock.report_exception(e) }
-    safely do
-      raise exception
-    end
-    assert mock.verify
-  end
-
-  def test_yolo
-    exception = Safely::TestError.new
-    mock = MiniTest::Mock.new
-    mock.expect :report_exception, nil, [exception]
-    Safely.report_exception_method = -> (e) { mock.report_exception(e) }
-    yolo do
-      raise exception
-    end
-    assert mock.verify
-  end
-
-  def test_tagged
-    ex = nil
-    Safely.report_exception_method = -> (e) { ex = e }
-    safely { raise Safely::TestError, "Boom" }
-    assert_equal "[safely] Boom", ex.message
-  end
-
-  def test_not_tagged
-    Safely.tag = false
-    ex = nil
-    Safely.report_exception_method = -> (e) { ex = e }
-    safely { raise Safely::TestError, "Boom" }
-    assert_equal "Boom", ex.message
-  end
-
-  def test_local_tag
-    ex = nil
-    Safely.report_exception_method = -> (e) { ex = e }
-    safely(tag: "hi") { raise Safely::TestError, "Boom" }
-    assert_equal "[hi] Boom", ex.message
-  end
-
-  def test_return_value
-    assert_equal 1, safely { 1 }
-    assert_nil safely { raise Safely::TestError, "Boom" }
-  end
-
-  def test_default
-    assert_equal 1, safely(default: 2) { 1 }
-    assert_equal 2, safely(default: 2) { raise Safely::TestError, "Boom" }
-  end
-
-  def test_only
-    assert_nil safely(only: Safely::TestError) { raise Safely::TestError }
-    assert_raises(RuntimeError, "Boom") { safely(only: Safely::TestError) { raise "Boom" } }
-  end
-
-  def test_only_array
-    assert_nil safely(only: [Safely::TestError]) { raise Safely::TestError }
-    assert_raises(RuntimeError, "Boom") { safely(only: [Safely::TestError]) { raise "Boom" } }
-  end
-
-  def test_except
-    assert_raises(Safely::TestError, "Boom") { safely(except: StandardError) { raise Safely::TestError, "Boom" } }
-  end
-
-  def test_silence
-    safely(silence: StandardError) { raise Safely::TestError, "Boom" }
-    assert true
-  end
-
-  def test_failsafe
-    Safely.report_exception_method = -> (_) { raise "oops" }
-    _, err = capture_io do
-      safely { raise "boom" }
-    end
-    assert_equal "FAIL-SAFE RuntimeError: oops\n", err
-  end
-
-  def test_throttle
-    count = 0
-    Safely.report_exception_method = -> (_) { 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 = -> (_) { 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
-
-  def test_bad_argument
-    assert_raises(ArgumentError) do
-      safely(unknown: true) { }
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,8 +0,0 @@
-require "bundler/setup"
-Bundler.require(:default)
-require "minitest/autorun"
-require "minitest/pride"
-
-module Safely
-  class TestError < StandardError; end
-end