jira_exception_collector 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+config.ru

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - ruby-head
+  - ree

data/Gemfile

@@ -0,0 +1,18 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in jira_notifier.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'test-unit'
+  gem 'fakeweb'
+  gem 'bundler', '>= 1.0.0'
+  gem 'rack'
+  if RUBY_VERSION =~ /^1\.9/
+    gem 'ruby-debug19'
+  else
+    gem 'ruby-debug'
+  end
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2011 Rich Manalang
+
+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,66 @@
+# JIRA Exception Collector
+
+A gem that logs your exceptions as a JIRA issue. Once it's in JIRA, you can route it to
+the appropriate developer to fix the issue using JIRA's workflow engine.
+
+![Moneyshot](https://img.skitch.com/20111130-b3f5rj9q95wh9txjrygyeaexn4.png)
+
+## Installation
+
+JIRA Exception Collector is a gem. To install:
+
+    gem install jira-exception-collector
+
+... or, add this to your Gemfile:
+
+    gem jira-exception-collector
+
+... then:
+
+    bundle install
+
+
+## Usage
+
+This gem utilizes the [JIRA Issue Collector plugin](https://plugins.atlassian.com/583856).
+Make sure your JIRA instance has this plugin installed before using this gem.
+
+## Setup an Issue Collector in JIRA
+
+In JIRA, go to Administration > Issue Collectors. You'll need to be a JIRA administrator
+to do this. Add a new Issue Collector pointing to the project you want the exceptions to
+go to. Also, if you don't already have an Issue Type for exceptions, you might want to
+create one so that you have a better way of organizing the issues in your project.
+
+Once you create the Issue Collector, copy the Collector URL (found on the Issue Collector's
+page).
+
+## Configure your Rack app with the Collector URL
+
+This gem works with any Rack based app. To configure it, first crack open your config.ru
+and add this before the `run` statement:
+
+````ruby
+use Rack::JiraExceptionCollector, "[collector url]"
+````
+
+By default, JIRA Exception Collector is enabled under production and staging environments.
+To modify this, just supply an array of the environments you want exceptions to be logged:
+
+````ruby
+use Rack::JiraExceptionCollector, "[collector url]", %w(prod1 prod2 stage deploy)
+````
+
+## Compatibility with JIRA
+
+Because this gem relies on the [JIRA Issue Collector plugin](https://plugins.atlassian.com/583856),
+this gem is only compatible with the JIRA versions that the JIRA Issue Collector supports.
+
+## Contributing
+
+This is a pushmepullyou type of project. Fork it hard, push in your awesome sauce, then 
+send in your pull request. Oh, don't forget to add tests.
+
+## Copyright
+
+Copyright (c) Rich Manalang and Atlassian, Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/jira_exception_collector.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rack/jira_exception_collector_version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "jira_exception_collector"
+  gem.authors       = ["Rich Manalang"]
+  gem.email         = ["rmanalang@atlassian.com"]
+  gem.description   = %q{A basic exception logger that logs to a JIRA instance}
+  gem.summary       = %q{jira_notifier will log your exceptions to a JIRA instance}
+  gem.homepage      = "https://github.com/manalang/jira_exception_collector"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.require_paths = ["lib"]
+  gem.version       = Rack::JiraExceptionCollector::VERSION
+  gem.add_dependency 'rack'
+  gem.extra_rdoc_files = ['README.md','LICENSE']
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'test-unit'
+  gem.add_development_dependency 'fakeweb'
+end

data/lib/rack/exception.erb

@@ -0,0 +1,53 @@
+{code}
+Server Environment:
+===================
+
+Project root: <%=project_root %>
+Environment name: <%=framework_env %>
+
+
+Error:
+======
+
+Class: <%=error.class.name %>
+<%- if error.respond_to?(:message) -%>
+Message: <%=error.message %>
+<%- end -%>
+
+<%- if backtrace.respond_to?(:each) -%>
+<%- backtrace.each do |line| -%>
+<%=line.file %> [<%=line.method %>] (<%=line.number %>)
+<%- end -%>  
+<%- end -%>
+
+Request:
+========
+
+URL: <%=url %>
+
+<%- if params && params.any? -%>
+Request Parameters:
+-------------------
+
+<%- params.each do |key, value| -%>
+<%=key %>: <%=value %>
+<%- end -%>
+
+<%- end -%>
+<%- if session && session.any? -%>
+Session:
+========
+
+<%- session.each do |key, value| -%>
+<%=key %>: <%=value %>
+<%- end -%>
+
+<%- end -%>
+<%- if environment && environment.any? -%>
+Environment:
+============
+<%- environment.each do |key,value| -%>
+<%=key %>: <%=value %>
+<%- end -%>
+<%- end -%>
+{code}

data/lib/rack/jira_exception_collector.rb

@@ -0,0 +1,195 @@
+require 'rack/jira_exception_collector_version'
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'erb'
+require 'ostruct'
+
+module Rack
+  class JiraExceptionCollector
+
+    FILTER_REPLACEMENT = "[FILTERED]"
+
+    class Error < StandardError; end
+
+    def initialize(app, collector_url = nil, report_under = %w(staging production), 
+                   rack_environment = 'RACK_ENV')
+      @app                 = app
+      @collector_url       = collector_url
+      @report_under        = report_under
+      @rack_environment    = rack_environment
+      @filters             = %w(AWS_ACCESS_KEY AWS_SECRET_ACCESS_KEY AWS_ACCOUNT SSH_AUTH_SOCK)
+      @failsafe            = $stderr
+      yield self if block_given?
+    end
+
+    def call(env)
+      status, headers, body =
+        begin
+          @app.call(env)
+        rescue StandardError, LoadError, SyntaxError => boom
+          notified = send_exception boom, env
+          raise
+        end
+      send_exception env['rack.exception'], env if env['rack.exception']
+      [status, headers, body]
+    end
+
+    def environment_filter_keys
+      @filters.flatten
+    end
+
+    def environment_filter_regexps
+      environment_filter_keys.map do |key|
+        "^#{Regexp.escape(wrapped_key_for(key))}$"
+      end
+    end
+    private
+    def report?
+      @report_under.include?(rack_env) || rack_env == "test"
+    end
+
+    def send_exception(exception, env)
+      return true unless report?
+      request = Rack::Request.new(env)
+      env['rack.session'] = {:a => 1}
+
+      options = {
+        :url               => env['REQUEST_URI'],
+        :params            => request.params,
+        :framework_env     => rack_env,
+        :notifier_name     => 'Rack::JiraExceptionCollector',
+        :notifier_version  => VERSION,
+        :environment       => environment_data_for(env),
+        :session           => env['rack.session']
+      }
+
+      if result = post_to_jira(exception, options)
+        if result.code == "200"
+          env['jira.notified'] = true
+        else
+          raise Error, "Status: #{result.code} #{result.body.inspect}"
+        end
+      else
+        raise Error, "No response from JIRA"
+      end
+    rescue Exception => e
+      return unless @failsafe
+      @failsafe.puts "Fail safe error caught: #{e.class}: #{e.message}"
+      @failsafe.puts e.backtrace
+      @failsafe.puts "Exception is #{exception.class}: #{exception.message}"
+      @failsafe.puts exception.backtrace
+      false
+    end
+
+    def rack_env
+      ENV[@rack_environment] || 'development'
+    end
+
+    def document_defaults(error)
+      {
+        :error            => error,
+        :environment      => ENV.to_hash,
+        :backtrace        => backtrace_for(error),
+        :url              => nil,
+        :request          => nil,
+        :params           => nil,
+        :notifier_version => VERSION,
+        :session          => {},
+        :framework_env    => ENV['RACK_ENV'] || 'development',
+        :project_root     => Dir.pwd
+      }
+    end
+
+    def document_data(error, options)
+      data = document_defaults(error).merge(options)
+      [:params, :session, :environment].each{|n| data[n] = clean(data[n]) if data[n] }
+      data
+    end
+
+    def document_for(exception, options={})
+      data = document_data(exception, options)
+      scope = OpenStruct.new(data).extend(ERB::Util)
+      scope.instance_eval ERB.new(notice_template, nil, '-').src
+    end    
+
+    def notice_template
+      ::File.read(::File.join(::File.dirname(__FILE__), 'exception.erb'))
+    end
+
+    BacktraceLine = Struct.new(:file, :number, :method)
+
+    def backtrace_for(error)
+      return "" unless error.respond_to? :backtrace
+      lines = Array(error.backtrace).map {|l| backtrace_line(l)}
+      if lines.empty?
+        lines << BacktraceLine.new("no-backtrace", "1", nil)
+      end
+      lines
+    end
+
+    def backtrace_line(line)
+      if match = line.match(%r{^(.+):(\d+)(?::in `([^']+)')?$})
+        BacktraceLine.new(*match.captures)
+      else
+        BacktraceLine.new(line, "1", nil)
+      end
+    end
+
+    def post_to_jira(exception,options={})
+      uri = URI.parse(@collector_url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if uri.scheme == "https"
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request['X-JIRA-Client-Name'] = "Rack::JiraExceptionCollector"
+      error = document_for(exception, options)
+      request.set_form_data({ 
+        "description" => "#{exception.class.name}: #{exception.message}",
+        "webInfo" => error
+      })
+      response = http.request(request)
+    end
+
+    def environment_data_for(env)
+      data = {}
+      ENV.each do |key,value|
+        data[wrapped_key_for(key)] = value.inspect
+      end
+      env.each do |key,value|
+        data["rack[#{key.inspect}]"] = value.inspect
+      end
+      data
+    end
+
+    def clean(hash)
+      hash.inject({}) do |acc, (k, v)|
+        acc[k] = (v.is_a?(Hash) ? clean(v) : filtered_value(k,v))
+      acc
+      end
+    end
+
+    def filters
+      environment_filter_keys.flatten.compact
+    end
+
+    def filtered_value(key, value)
+      if filters.any? {|f| key.to_s =~ Regexp.new(f)}
+        FILTER_REPLACEMENT
+      else
+        value.to_s
+      end
+    end
+
+    def wrapped_key_for(key)
+      "ENV[#{key.inspect}]"
+    end
+
+    def extract_body(env)
+      if io = env['rack.input']
+        io.rewind if io.respond_to?(:rewind)
+        io.read
+      end
+    end
+
+  end
+end

data/lib/rack/jira_exception_collector_version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class JiraExceptionCollector
+    VERSION = "0.0.1"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:test)
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'test/unit'
+require 'rack/mock'
+require 'rack/lobster'
+require 'rack/jira_exception_collector'

data/test/test_log_exception.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class Rack::JiraExceptionCollector::TestLogException < Test::Unit::TestCase
+  def setup
+    @collector_url = "http://example.com/rest/collectors/1.0/template/form/ac29dace"
+    FakeWeb.register_uri(:post, @collector_url,
+                         :body => "Thanks for providing your feedback", :status => ["200", "OK"])
+
+    @app = Rack::Lobster.new
+    @collector = Rack::JiraExceptionCollector.new @app, @collector_url
+    @request = Rack::MockRequest.new @collector
+  end
+
+  def test_exception_was_sent
+    ENV['RACK_ENV'] = 'test'
+    env = Rack::MockRequest.env_for('/?flip=crash', :method => 'GET')
+    assert_raise(RuntimeError) { @collector.call(env) }
+    assert_true env['jira.notified'], "JIRA exception created"
+  end
+
+  def test_exception_can_be_sent_from_a_custom_env
+    ENV['RACK_ENV'] = "my_custom_env"
+    env = Rack::MockRequest.env_for('/?flip=crash', :method => 'GET')
+    collector = Rack::JiraExceptionCollector.new @app, @collector_url, "my_custom_env"
+    assert_raise(RuntimeError) { collector.call(env) }
+    assert_true env['jira.notified'], "JIRA exception created"
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: jira_exception_collector
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rich Manalang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: A basic exception logger that logs to a JIRA instance
+email: 
+- rmanalang@atlassian.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jira_exception_collector.gemspec
+- lib/rack/exception.erb
+- lib/rack/jira_exception_collector.rb
+- lib/rack/jira_exception_collector_version.rb
+- test/helper.rb
+- test/test_log_exception.rb
+homepage: https://github.com/manalang/jira_exception_collector
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: jira_notifier will log your exceptions to a JIRA instance
+test_files: 
+- test/helper.rb
+- test/test_log_exception.rb