escalate 0.1.0.pre.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb743da8ea57e11a7bfa80d653548239e0b760ab
+  data.tar.gz: 36555a0ba6f8bca3f821c5b0044739e26762cc23
+SHA512:
+  metadata.gz: 7c735aa3214359068d14e0fd981c64c62e14896d73965d467d5b28ebaa3d2bf300ae9037164d3a4a7e5a6b4a77439a8a5137dd5d3b7b51eda27cef0ec7a57a60
+  data.tar.gz: a3899dc985f47f6e87d609b5fdf85443b9278ca100b40e5e41e4be641c8aa6116850dc80a4426f779c34e741b5b0893c9032e3c2b59974a9b802da0bcc8629bd

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.4.2
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.6
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog for `escalate`
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - Unreleased
+
+[0.1.0]: https://github.com/Invoca/escalate/releases/tag/v0.1.0

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to Escalate
+
+This document explains our guidelines and workflows to contributing to an Invoca open source project.  Please take care to follow the guidelines, as they exist to help us manage changes in a timely and efficient manner.
+
+## Code of Conduct
+All contributors to this project must adhere to the [Community Code of Conduct](https://github.com/Invoca/escalate/blob/master/code-of-conduct.md)
+
+## Environment Setup
+1. Install the ruby version specified in the [.ruby-version](https://github.com/Invoca/escalate/blob/master/.ruby-version) file (preferably you're using [rvm](https://rvm.io/) or [rbenv](https://github.com/rbenv/rbenv) to manage ruby versions)
+2. Make a fork of Escalate, then clone your fork to your machine
+3. Run `bundle install` in your Escalate directory to install dependencies
+
+## Branching
+
+* __Create an issue before starting a branch__
+* For bugs, prefix the branch name with `bug/`
+* For features, prefix the branch name with `feature/`
+* Include the issue number and a short description of the issue
+
+Examples
+* `bug/1234_fix_issue_with_formatter_not_formatting`
+* `feature/4321_merge_contexts_together`
+
+## Filing Issues
+
+* Use the appropriate template provided
+* Include as much information as possible to help:
+  * The person who will be fixing the bug understand the issue
+  * The person code reviewing the fix to understand what the original need was
+* Check for open issues before filing your own
+
+## Committing
+
+* Break your commits into logical atomic units. Well-segmented commits make it much easier for others to step through your changes.
+* Limit your subject (first) line to 50 characters (GitHub truncates more than 70).
+* Provide a body if you'd like to explain your commit in detail.
+* Capitalize the beginning of your subject line, and do not end the subject line with a period.
+* Your subject line should complete this sentence: `If applied, this commit will [your subject line]`.
+* Don't use [magic GitHub words](https://help.github.com/articles/closing-issues-using-keywords/) in your commits to close issues - do that in the pull request for your code instead.
+* Adapted from [How to Write a Git Commit Message](https://chris.beams.io/posts/git-commit/#seven-rules).
+
+## Making Pull Requests
+
+* Use fill out the template provided
+* Provide a link to the issue being resolved by the PR
+* Make sure to include tests
+* Resolve linting comments from Hound before requesting review

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in escalate.gemspec
+gemspec
+
+gem "pry"
+gem "pry-byebug"
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    escalate (0.1.0.pre.1)
+      activesupport
+      contextual_logger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    contextual_logger (0.11.0)
+      activesupport
+      json
+    diff-lcs (1.4.4)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
+    json (2.5.1)
+    method_source (1.0.0)
+    minitest (5.14.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  escalate!
+  pry
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.6

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Invoca Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Escalate
+
+A simple and lightweight gem to help with escalating errors
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'escalate'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install escalate
+
+## Usage
+
+### Adding Escalate to Your Gem
+
+All you need to do is extend `Escalate.mixin` within your gem and you're all set.
+
+```ruby
+module SomeGem
+  include Escalate.mixin
+end
+```
+
+This will expose the `Escalate#ex_escalate` method within your gem to be used instead
+of using `logger.error`.
+
+```ruby
+module SomeGem
+  include Escalate.mixin
+
+  class << self
+    attr_accessor :logger
+  end
+
+  class SomeClass
+    def something_dangerous
+      # ...
+    rescue => ex
+      SomeGem.escalate(ex, "I was doing something dangerous and an exception was raised")
+    end
+  end
+end
+```
+
+When `SomeGem.escalate` above is triggered, it will use the logger returned by `SomeGem.logger` or
+default to a `STDERR` logger and do the following:
+
+1. Log an error containing the exception and any additional information about the current environment that is specified
+2. Trigger any `escalation_callbacks` configured on the `Escalate` gem
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/invoca/escalate.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "escalate"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/code-of-conduct.md

@@ -0,0 +1,16 @@
+# Invoca Community Code of Conduct v1.0
+
+## Contributor Code of Conduct
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.

data/escalate.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/escalate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "escalate"
+  spec.version       = Escalate::VERSION
+  spec.authors       = ["Invoca Development", "Octothorp"]
+  spec.email         = ["development@invoca.com", "octothorp@invoca.com"]
+
+  spec.summary       = "Simple gem for abstracting log escalations"
+  spec.description   = "Simple gem for abstracting log escalations"
+  spec.homepage      = "https://github.com/invoca/escalate"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata = {
+    "allowed_push_host" => "https://rubygems.org",
+    "homepage_uri"      => spec.homepage,
+    "changelog_uri"     => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "contextual_logger"
+end

data/lib/escalate.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext"
+require "contextual_logger"
+
+require_relative "escalate/version"
+require_relative "escalate/mixin"
+
+module Escalate
+  class Error < StandardError; end
+
+  class << self
+    # Logs and escalated an exception
+    #
+    # @param [Exception] exception
+    #   The exception that was raised and needs to be escalated
+    #
+    # @param [String] message
+    #   An additional message about what was happening at the time of the exception
+    #
+    # @param [Logger] logger
+    #   The logger object to use when logging the exception
+    #
+    # @param [Hash] context
+    #   Any additional context to be tied to the escalation
+    def escalate(exception, message, logger, **context)
+      error_message = <<~EOS
+        [Escalate] #{message} (#{context.inspect})
+          #{exception.class.name}: #{exception.message}
+          #{exception.backtrace.join("\n")}
+      EOS
+
+      if logger.is_a?(ContextualLogger::LoggerMixin)
+        logger.error(error_message, **context)
+      else
+        logger.error(error_message)
+      end
+
+      on_escalate_blocks.each do |block|
+        block.call(exception, message, **context)
+      end
+    rescue Exception => ex
+      STDERR.puts("[ExEscalator] Exception rescued while escalating #{exception.inspect}:" \
+                "#{ex.class.name}: #{ex.message}")
+    end
+
+    # Returns a module to be mixed into a class or module exposing
+    # the ex_escalate method to be used for escalating and logging
+    # exceptions.
+    #
+    # @param [Proc] logger_block
+    #   A block to be used to get the logger object that Escalate
+    #   should be using
+    def mixin(&logger_block)
+      Thread.current[:escalate_logger_block] = logger_block
+
+      Module.new do
+        def self.included(base)
+          base.extend Escalate::Mixin
+          base.escalate_logger_block = Thread.current[:escalate_logger_block] || -> { base.try(:logger) }
+        end
+      end
+    end
+
+    # Registers an escalation callback to be executed when `ex_escalate`
+    # is invoked.
+    def on_escalate(&block)
+      on_escalate_blocks.add(block)
+    end
+
+    private
+
+    def on_escalate_blocks
+      @on_escalate_blocks ||= Set.new
+    end
+  end
+end

data/lib/escalate/mixin.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Escalate
+  module Mixin
+    class << self
+      def included(base)
+        raise 'instead of `include ExEscalator::Mixin`, you should `include ExEscalator.mixin`'
+      end
+    end
+
+    attr_accessor :escalate_logger_block
+
+    def ex_escalate(exception, message, **context)
+      Escalate.escalate(exception, message, escalate_logger, **context)
+    end
+
+    private
+
+    def escalate_logger
+      escalate_logger_block.try(:call) || default_escalate_logger
+    end
+
+    def default_escalate_logger
+      @default_escalate_logger ||= Logger.new(STDERR)
+    end
+  end
+end

data/lib/escalate/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Escalate
+  VERSION = "0.1.0.pre.1"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: escalate
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.1
+platform: ruby
+authors:
+- Invoca Development
+- Octothorp
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: contextual_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple gem for abstracting log escalations
+email:
+- development@invoca.com
+- octothorp@invoca.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- code-of-conduct.md
+- escalate.gemspec
+- lib/escalate.rb
+- lib/escalate/mixin.rb
+- lib/escalate/version.rb
+homepage: https://github.com/invoca/escalate
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/invoca/escalate
+  changelog_uri: https://github.com/invoca/escalate/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.13
+signing_key:
+specification_version: 4
+summary: Simple gem for abstracting log escalations
+test_files: []