crash-reporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee7a00bfb5d5914b68b510b747f3b97cda8b8c63
+  data.tar.gz: 2784937b9bb5b9deb03da1e03adb589a903b67cb
+SHA512:
+  metadata.gz: 7677b289b5263e59342df71b97b7224bef69b81bf8413c352e8141450c59ea3a0b97f46647171dc3aaeaa9df49ae34aea460b4de520f0384ebfc61a82f276794
+  data.tar.gz: af69939f76c48ad55fcde4c8111b2da9f771b2e13c902da21bca2d4dcd86382a15bb5c7b53a9c9f2a5cedce623a6a603e821771dab11750aae663d876c76cd5c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in crash-reporter.gemspec
+gemspec
+
+group :test do
+  gem 'pry'
+  gem 'minitest-reporters'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Articulate Global, 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,119 @@
+# CrashReporter
+
+A meta-tool to enable crash info collection from our toolset without manual effort required from users.
+
+CrashReporter will allow you to build out crash report collection and reporting procedures in response to a failure of some kind within a given project. This is made more for cli tools. Included behaviors allow GitHub issues to be created on errors raised. Additional reporters can be built and included in the workflow as required.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crash-reporter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crash-reporter
+
+## Usage
+
+```ruby
+# explicitly require desired reporters
+require 'crash_reporter/reporters/github_issues'
+
+CrashReporter.setup do |c|
+  c.engine = CrashReporter::GithubIssues.new('username/repo', 'auth_token')
+  c.tags = "crashy"   # defaults to 'crash report'
+end
+```
+
+Note that the repo name can actually be auto-discovered from the local git repo as long as you have a proper `origin` remote setup.
+
+```ruby
+class MyCoolClass
+  include CrashReporter::DSL
+
+  def method_that_could_crash
+    raise StandardError
+  end
+
+  # this has to be _after_ all the methods you wish to capture as we redefine the methods to include error capturing
+  capture_errors :method_that_could_crash
+end
+
+MyCoolClass.new.method_that_could_crash
+
+# Will submit a GitHub issue to your repo and re-raise error!
+```
+
+Alternatively, you can handle the error submission yourself without the class-level error handling capture (possibly a more explicit method):
+
+```ruby
+class MyCoolClass
+  include CrashReporter::DSL
+
+  ARealBadThing = Class.new(StandardError)
+
+  def method_that_could_crash
+    capture_errors do
+      raise ARealBadThing
+    end
+  end
+
+  # or
+
+  def will_crash
+    begin
+      raise StandardError, "Nope!"
+    rescue StandardError => e
+      report_crash e   # or any raw string message you want
+    end
+  end
+end
+```
+
+You can additionally define your own reporters. All these reporters require is a `run` method that takes a string or an object derived from Ruby's `StandardError`. `StandardError` is the recommended method as it allows us to collect backtrace information from the crash in a uniform manner.
+
+```ruby
+class SlackReporter
+  def initialize(hook_url)
+    @hook_url = hook_url
+   end
+
+  def run(error)
+    HTTP.post(@hook_url,
+      json: {
+        text: "WE GOT PROBLEMS: #{error.message}"
+      })
+  end
+end
+```
+
+Then register your new reporter:
+
+```ruby
+# Register a new webhook and use the URL here
+
+CrashReporter.configuration.engines << SlackReporter.new('https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX')
+```
+
+Then crashes will push notifications to Slack as well! Note you can stack notifications by `<<` them to the `engines` array. You can clear these by setting `CrashReporter.configuration.engine = SlackReporter.new(...)` which will add the single reporter.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/[USERNAME]/crash-reporter.
+
+## License
+
+This software is provided under the the [MIT license](LICENSE).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "crash-reporter"
+
+# 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

data/bin/setup

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

data/crash_reporter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crash_reporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crash-reporter"
+  spec.version       = CrashReporter::VERSION
+  spec.authors       = ["Luke van der Hoeven"]
+  spec.email         = ["hungerandthirst@gmail.com"]
+
+  spec.summary       = %q{Small gem for reporting code crashes or errors to arbitrary sources}
+  spec.description   = %q{Nope}
+  spec.homepage      = "https://github.com/articulate/crash-reporter"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "http", "~> 0.9"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency 'webmock'
+end

data/lib/crash-reporter.rb

@@ -0,0 +1 @@
+require "crash_reporter"

data/lib/crash_reporter/configure.rb

@@ -0,0 +1,47 @@
+module CrashReporter
+  class Configure
+    attr_accessor :engines, :tags, :project_name, :repo_url, :version
+
+    def self.setup(&block)
+      config = new
+      yield config
+
+      config
+    end
+
+    def initialize
+      @engines = []
+      @tags = ['crash report']
+    end
+
+    # clears out all prior added engines
+    def engine=(engine)
+      @engines = [engine]
+    end
+
+    def tags=(*tags)
+      @tags = tags
+    end
+
+    def project_name
+      @project_name || repo_name
+    end
+
+    def repo_url
+      @repo_url ||= `git config --get remote.origin.url`.chomp
+    end
+
+    def repo_path
+      repo_url.split('/').last(2).join('/')
+    end
+
+    def repo_name
+      repo_url.split('/').last
+    end
+
+    def version=(version)
+      @version = version
+      @tags << version
+    end
+  end
+end

data/lib/crash_reporter/dsl.rb

@@ -0,0 +1,43 @@
+module CrashReporter
+  module DSL
+
+    module ClassMethods
+      def capture_errors(*methods)
+        methods.each do |method_name|
+          unbound = self.instance_method(method_name)
+          remove_method method_name
+
+          # wrap given method in begin/rescue clause
+          define_method method_name do
+            begin
+              unbound.bind(self).call
+            rescue StandardError => e
+              CrashReporter.report(e)
+
+              # continue to raise original error
+              raise e
+            end
+          end
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def capture_errors(&block)
+      begin
+        yield
+      rescue StandardError => e
+        report_crash(e)
+
+        raise e
+      end
+    end
+
+    def report_crash(data)
+      CrashReporter.report(data)
+    end
+  end
+end

data/lib/crash_reporter/reporters/github_issues.rb

@@ -0,0 +1,41 @@
+require 'http'
+
+module CrashReporter
+  class GithubIssues
+    GH_URI = 'https://api.github.com'
+
+    def initialize(repo_name = CrashReporter.configuration.repo_path, token)
+      @repo_name = repo_name
+      @token = token
+    end
+
+    def run(data)
+      # Run custom formatting on Ruby StandardError objects, otherwise, just pass through
+      data = format(data) if data.is_a?(StandardError)
+
+      HTTP.headers(
+          accept: 'application/vnd.github.v3+json',
+          authorization: "token #{@token}"
+      ).post("#{GH_URI}/repos/#{@repo_name}/issues", json: {
+          labels: CrashReporter.configuration.tags,
+          title: "Crash report from #{CrashReporter.configuration.project_name}",
+          body: data
+      })
+
+      data
+    end
+
+    private
+
+    def format(error)
+      <<-ERROR
+**Error:** #{error.message}
+
+**Backtrace:**
+```
+#{error.backtrace.join("\n")}
+```
+ERROR
+    end
+  end
+end

data/lib/crash_reporter/version.rb

@@ -0,0 +1,3 @@
+module CrashReporter
+  VERSION = "0.1.0"
+end

data/lib/crash_reporter.rb

@@ -0,0 +1,26 @@
+require 'crash_reporter/version'
+require 'crash_reporter/configure'
+
+module CrashReporter
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configure.new
+    end
+
+    def reset
+      @configuration = Configure.new
+    end
+
+    def report(data)
+      configuration.engines.each do |engine|
+        engine.run(data)
+      end
+    end
+
+    def configure(&block)
+      yield configuration
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: crash-reporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luke van der Hoeven
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Nope
+email:
+- hungerandthirst@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- crash_reporter.gemspec
+- lib/crash-reporter.rb
+- lib/crash_reporter.rb
+- lib/crash_reporter/configure.rb
+- lib/crash_reporter/dsl.rb
+- lib/crash_reporter/reporters/github_issues.rb
+- lib/crash_reporter/version.rb
+homepage: https://github.com/articulate/crash-reporter
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Small gem for reporting code crashes or errors to arbitrary sources
+test_files: []