tastes_bitter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6101cd9fc67f9102961b94aaf6ba8717b1f9e6a8
+  data.tar.gz: 6f3482627ed3f5d0a505bed211ea8dce51291208
+SHA512:
+  metadata.gz: 3f22572e0377f33cb56cb41878390cc4c7bf9d1eeed05ae76f2002f0081733d7a57d973f134396afa3fe30ea2191e544263c58d6c496b2382c8ccb79e47e072b
+  data.tar.gz: 6ce972cf818bf8c65de1c05ac408929ebb7b159baa5dbc5c28e6613aac928cd4ea79887b7438b9d42ef07d0632ec78e111645c68b477d4bb5028347c988bc655

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Mat Harvard
+
+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,51 @@
+# Tastes Bitter
+
+Get an email notification when a JavaScript error occurs in your Rails application.
+
+## How it works
+
+The JavaScript hooks into the `window.onerror` event by sending an XHR with the error data which is then emailed.
+
+## Install
+
+Add the gem to your `Gemfile`.
+
+```ruby
+gem 'tastes_bitter', github: 'matharvard/tastes_bitter'
+```
+
+Use Bundler to install it.
+
+```console
+$ bundle install
+```
+
+Run the install generator.
+
+```console
+$ bundle exec rails generate tastes_bitter:install
+```
+
+## Configure
+
+Open `config/initializers/tastes_bitter.rb` and update the configuration.
+
+```ruby
+TastesBitter.configure do |config|
+
+  config.mailer_receiver = "notifications@example.com"
+  config.mailer_sender = "notifications@example.com"
+  config.mailer_subject_prefix = "[JavaScript Error] "
+
+end
+```
+
+Make sure you have [ActionMailer configured](http://api.rubyonrails.org/classes/ActionMailer/Base.html) in order for emails to be sent.
+
+Add the JavaScript file to `application.js`.
+
+```coffeescript
+//= require tastes_bitter/javascript_errors
+```
+
+It **does** matter where you include the JavaScript. It will only catch errors that occur *after* it has been loaded into the page. In general, you'll want to include it around the top of `application.js`. This will ensure it catches all errors from any other JavaScript code in your application.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TastesBitter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/tastes_bitter/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/tastes_bitter/javascript_errors.coffee

@@ -0,0 +1,19 @@
+window.onerror = (message, file_or_page, line_number) ->
+  xhr = null
+  error_info = null
+  form = null
+
+  form = new FormData
+  form.append 'message', message
+  form.append 'file_or_page', file_or_page
+  form.append 'line_number', line_number
+  form.append 'user_agent', navigator.userAgent
+  form.append 'current_page', window.location.href
+
+  xhr?.abort()
+  xhr = new XMLHttpRequest
+  xhr.open 'POST', '/__javascript_errors', true
+  xhr.send form
+
+  # Return `false` to call the default handler.
+  false

data/app/assets/stylesheets/tastes_bitter/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/app/assets/stylesheets/tastes_bitter/javascript_errors.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/tastes_bitter/application_controller.rb

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

data/app/controllers/tastes_bitter/javascript_errors_controller.rb

@@ -0,0 +1,33 @@
+require 'browser'
+require_dependency "tastes_bitter/application_controller"
+
+module TastesBitter
+
+  class JavascriptErrorsController < ApplicationController
+
+    # Responsible for handling errors sent from the browser, parsing the data,
+    # and sending the email with the information about the error.
+    def create
+      browser = Browser.new(ua: params["user_agent"])
+
+      error_info = {
+        message: params["message"],
+        file_or_page: params["file_or_page"],
+        line_number: params["line_number"],
+        user_agent: params["user_agent"],
+        current_page: params["current_page"],
+        platform: browser.platform.to_s.humanize,
+        browser_name: browser.name,
+        browser_version: browser.full_version
+      }
+
+      ::TastesBitter::JavascriptErrorsMailer.javascript_error(error_info).deliver_later
+
+      respond_to do |format|
+        format.js { render nothing: true, status: :ok }
+      end
+    end
+
+  end
+
+end

data/app/helpers/tastes_bitter/application_helper.rb

@@ -0,0 +1,4 @@
+module TastesBitter
+  module ApplicationHelper
+  end
+end

data/app/helpers/tastes_bitter/javascript_errors_helper.rb

@@ -0,0 +1,4 @@
+module TastesBitter
+  module JavascriptErrorsHelper
+  end
+end

data/app/mailers/application_mailer.rb

@@ -0,0 +1,5 @@
+class ApplicationMailer < ActionMailer::Base
+
+  layout 'mailer'
+
+end

data/app/mailers/tastes_bitter/javascript_errors_mailer.rb

@@ -0,0 +1,15 @@
+module TastesBitter
+  class JavascriptErrorsMailer < ApplicationMailer
+
+    def javascript_error(error_info)
+      @error_info = error_info
+
+      mail(
+        to: ::TastesBitter.configuration.mailer_receiver,
+        from: ::TastesBitter.configuration.mailer_sender,
+        subject: "#{ ::TastesBitter.configuration.mailer_subject_prefix } #{ @error_info[:message] }"
+      )
+    end
+
+  end
+end

data/app/views/layouts/mailer.html.erb

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/app/views/layouts/tastes_bitter/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>TastesBitter</title>
+  <%= stylesheet_link_tag    "tastes_bitter/application", media: "all" %>
+  <%= javascript_include_tag "tastes_bitter/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/tastes_bitter/javascript_errors_mailer/javascript_error.html.erb

@@ -0,0 +1,9 @@
+<p>
+  Error Message: <%= @error_info[:message] %><br>
+  File: <%= @error_info[:file_or_page] %><br>
+  Line Number: <%= @error_info[:line_number] %><br>
+  User Agent: <%= @error_info[:user_agent] %><br>
+  Current Page: <%= @error_info[:current_page] %><br>
+  Platform: <%= @error_info[:platform] %><br>
+  Browser: <%= @error_info[:browser_name] %> <%= @error_info[:browser_version] %>
+</p>

data/app/views/tastes_bitter/javascript_errors_mailer/javascript_error.text.erb

@@ -0,0 +1,7 @@
+Error Message: <%= @error_info[:message] %>
+File: <%= @error_info[:file_or_page] %>
+Line Number: <%= @error_info[:line_number] %>
+User Agent: <%= @error_info[:user_agent] %>
+Current Page: <%= @error_info[:current_page] %>
+Platform: <%= @error_info[:platform] %>
+Browser: <%= @error_info[:browser_name] %> <%= @error_info[:browser_version] %>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+
+  resources :__javascript_errors, controller: "tastes_bitter/javascript_errors", only: :create
+
+end

data/lib/generators/tastes_bitter/install_generator.rb

@@ -0,0 +1,17 @@
+module TastesBitter
+
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_tastes_bitter_initializer
+        copy_file "tastes_bitter.rb", "config/initializers/tastes_bitter.rb"
+      end
+
+    end
+
+  end
+
+end

data/lib/generators/tastes_bitter/templates/tastes_bitter.rb

@@ -0,0 +1,7 @@
+TastesBitter.configure do |config|
+
+  config.mailer_receiver = "notifications@example.com"
+  config.mailer_sender = "notifications@example.com"
+  config.mailer_subject_prefix = "[JavaScript Error] "
+
+end

data/lib/tasks/tastes_bitter_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tastes_bitter do
+#   # Task goes here
+# end

data/lib/tastes_bitter.rb

@@ -0,0 +1,5 @@
+require 'tastes_bitter/engine'
+require 'tastes_bitter/configuration'
+
+module TastesBitter
+end

data/lib/tastes_bitter/configuration.rb

@@ -0,0 +1,29 @@
+module TastesBitter
+
+  class Configuration
+
+    attr_accessor :mailer_receiver
+    attr_accessor :mailer_sender
+    attr_accessor :mailer_subject_prefix
+
+    def initialize
+      @mailer_receiver = "notifications@example.com"
+      @mailer_sender = "notifications@example.com"
+      @mailer_subject_prefix = "[JavaScript Error] "
+    end
+
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+end

data/lib/tastes_bitter/engine.rb

@@ -0,0 +1,9 @@
+module TastesBitter
+
+  class Engine < ::Rails::Engine
+
+    isolate_namespace TastesBitter
+
+  end
+
+end

data/lib/tastes_bitter/version.rb

@@ -0,0 +1,5 @@
+module TastesBitter
+
+  VERSION = "0.0.1"
+
+end

data/test/controllers/tastes_bitter/javascript_errors_controller_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+module TastesBitter
+
+  class JavascriptErrorsControllerTest < ActionController::TestCase
+
+    # setup do
+    #   @routes = Engine.routes
+    # end
+
+    test "should respond with ok status without params" do
+      xhr :post, :create
+      assert_response :ok
+    end
+
+    test "should respond with ok status with params" do
+      params = {
+        "message": "A message",
+        "file_or_page": "A file or page",
+        "line_number": "A line number",
+        "user_agent": "A user agent",
+        "current_page": "A current page"
+      }
+      xhr :post, :create, params
+      assert_response :ok
+    end
+
+  end
+
+end

data/test/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>.