whoopsie 0.0.2

data/app/controllers/whoopsie/application_controller.rb

@@ -0,0 +1,4 @@
+module Whoopsie
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/whoopsie/errors_controller.rb

@@ -0,0 +1,50 @@
+require_dependency 'whoopsie/application_controller'
+
+module Whoopsie
+  class ErrorsController < ApplicationController
+    skip_before_action :verify_authenticity_token
+
+    class JavaScriptError < StandardError
+    end
+
+    newrelic_ignore if defined?(NewRelic) && respond_to?(:newrelic_ignore)
+
+    # Create a JavaScript exception and notify as configured
+    # Params:
+    #   error_report: A hash containing :message as a string
+    #   extra: Contextual data
+    def create
+      if Rails.application.config.whoopsie.enable
+        exception = JavaScriptError.new(report_params[:message])
+        report_params.merge!(extra: params[:extra]) if params[:extra]
+        ExceptionNotifier.notify_exception(
+          exception,
+          env: request.env,
+          data: report_params
+        )
+        render plain: 'error acknowledged', status: :ok
+      else
+        render plain: 'error ignored', status: :accepted
+      end
+    end
+
+    # Call this method to test Whoopsie in your live production app.
+    def bang
+      fail('boom!')
+    end
+
+    # Make sure Whoopsie is available
+    def ping
+      app_name  = Rails.application.engine_name
+      db_status = !ActiveRecord::Base.connection.tables.empty? ? :ok : :empty
+      render plain: "#{app_name} #{db_status}"
+    end
+
+    private
+
+    # The :extra parameter may or may not be included as part of the :error_report
+    def report_params
+      params.require(:error_report).permit(:message, :extra)
+    end
+  end
+end

data/app/helpers/whoopsie/whoopsie_helper.rb

@@ -0,0 +1,18 @@
+module Whoopsie
+  module WhoopsieHelper
+    def whoopsie_config(extra = {})
+      (<<-EOS).strip_heredoc.html_safe
+        <script>
+          window.Whoopsie = window.Whoopsie || {};
+          window.Whoopsie.enabled                 = #{Rails.application.config.whoopsie.enable.to_json};
+          window.Whoopsie.client_notification_url = "#{errors_path}";
+          window.Whoopsie.extra = function(){
+            var extra = #{extra.to_json};
+            extra.location = window.location.toString();
+            return extra;
+          }
+        </script>
+      EOS
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+Whoopsie::Engine.routes.draw do
+  post '/errors', to: 'errors#create'
+  get  '/bang',   to: 'errors#bang'
+  get  '/ping',   to: 'errors#ping'
+end

data/lib/whoopsie.rb

@@ -0,0 +1,20 @@
+require 'rails'
+
+require 'exception_notification'
+require 'whoopsie/engine'
+require 'whoopsie/railtie'
+
+module Whoopsie
+  class << self
+    def report_and_swallow
+      yield
+    rescue StandardError => e
+      handle_exception(e)
+    end
+
+    def handle_exception(exception, data = {})
+      return ExceptionNotifier.notify_exception(exception, data) if Rails.application.config.whoopsie.enable
+      fail(exception)
+    end
+  end
+end

data/lib/whoopsie/engine.rb

@@ -0,0 +1,9 @@
+module Whoopsie
+  class Engine < ::Rails::Engine
+    isolate_namespace Whoopsie
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/whoopsie/railtie.rb

@@ -0,0 +1,39 @@
+module Whoopsie
+  class Railtie < Rails::Railtie
+    Config = Struct.new(:enable, :recipients, :sender, :email_prefix)
+    config.whoopsie = Config.new
+
+    initializer 'whoopsie.configure_middleware' do
+      Rails.application.middleware.insert_before(
+        ActiveRecord::ConnectionAdapters::ConnectionManagement,
+        ExceptionNotification::Rack
+      )
+
+      # Include the helper
+      ActionView::Base.send(:include, WhoopsieHelper)
+
+      ExceptionNotification.configure do |config|
+        # Ignore additional exception types.
+
+        # ActiveRecord::RecordNotFound, AbstractController::ActionNotFound and
+        # ActionController::RoutingError are already added.
+        # config.ignored_exceptions += %w{ActionView::TemplateError CustomError}
+
+        # Adds a condition to decide when an exception must be ignored or not.
+        # The ignore_if method can be invoked multiple times to add extra conditions.
+        # config.ignore_if do |exception, options|
+        #   ! Rails.application.config.whoopsie.enable
+        # end
+
+        if Rails.application.config.whoopsie.enable
+          config.add_notifier(
+            :email,
+            email_prefix:         Rails.application.config.whoopsie.email_prefix || '[ERROR] ',
+            sender_address:       Rails.application.config.whoopsie.sender,
+            exception_recipients: Rails.application.config.whoopsie.recipients
+          )
+        end
+      end
+    end
+  end
+end

data/lib/whoopsie/version.rb

@@ -0,0 +1,3 @@
+module Whoopsie
+  VERSION = '0.0.2'.freeze
+end

data/spec/controllers/whoopsie/errors_controller_spec.rb

@@ -0,0 +1,71 @@
+require 'rails_helper'
+
+module Whoopsie
+  RSpec.describe ErrorsController, type: :controller do
+    routes { Whoopsie::Engine.routes }
+
+    context '.ping' do
+      it 'returns a 200 status' do
+        get :ping
+        expect(response).to be_success
+      end
+    end
+
+    # This method allows you to test Whoopsie from within your live application.
+    context '.bang' do
+      it 'raises an error' do
+        expect do
+          get :bang
+        end.to raise_error(RuntimeError)
+      end
+    end
+
+    context '.create' do
+      let(:valid_params) do
+        {
+          error_report: {
+            message: 'I made a terrible mistake!',
+          },
+          extra: 'And it is what it is.'
+        }
+      end
+
+      context 'when Whoopsie is enabled' do
+        before do
+          Rails.application.config.whoopsie.enable = true
+        end
+
+        context 'with valid params' do
+          it 'returns a 200 status' do
+            post :create, valid_params
+            expect(response).to be_ok
+          end
+
+          it 'calls .notify_exception' do
+            expect(ExceptionNotifier).to receive(:notify_exception)
+            post :create, valid_params
+          end
+        end
+
+        context 'with missing params' do
+          it 'raises an exception' do
+            expect do
+              post :create
+            end.to raise_error(ActionController::ParameterMissing)
+          end
+        end
+      end
+
+      context 'when Whoopsie is disabled' do
+        before do
+          Rails.application.config.whoopsie.enable = false
+        end
+
+        it 'returns a 202 status' do
+          post :create, valid_params
+          expect(response).to be_accepted
+        end
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,3 @@
+//= require_tree .
+//= require jquery
+//= require whoopsie

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/welcome_controller.rb

@@ -0,0 +1,4 @@
+class WelcomeController < ApplicationController
+  def show
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= whoopsie_config({user_id: 123}) %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <%= yield %>
+
+  <script>
+    window.loggingInformation = {time: (new Date()).toString(), location: window.location.toString()};
+  </script>
+</body>
+</html>

data/spec/dummy/app/views/welcome/show.html.erb

@@ -0,0 +1,3 @@
+Hello!
+
+<button onclick="throw 'bang!'">bang!</button>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,38 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "whoopsie"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    config.action_mailer.delivery_method = :letter_opener
+    config.action_mailer.perform_deliveries = true
+    config.action_mailer.raise_delivery_errors = true
+
+    config.whoopsie.enable = true
+    config.whoopsie.email_prefix = '[ERROR TEST] '
+    config.whoopsie.recipients = ["whoopsie@example.com"]
+    config.whoopsie.sender = "whoopsie@example.com"
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000