raygun4ruby 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61736f6afdee2839d8085205074cc3e36a0d1ab2
-  data.tar.gz: 91f356594710741eec38c69f2e1122eb7bfdf3e9
+  metadata.gz: acbc458153d576b6856920cb72985952f9f6ed22
+  data.tar.gz: bb9976f64347bce6b6a6a6f3920564b489b478bb
 SHA512:
-  metadata.gz: 1c5a29513ec9b6603e798381c89005802a87ac470bcfdb6e77f2287523d880f4db7dc0fe6122254e8f8722aa5e54fb5f418b72702fa1b4a2cb5defc69626556b
-  data.tar.gz: b44748b701d56a4359644c679abe517ef9540049c9a8acd960babbe2614d68d27457ec2563298d625ed4485f6f2d6705ffc512bba0e6e4f36b3ed193b2cf0919
+  metadata.gz: d603e52d886065cf9cc7b26f6639a8f6c237447d2af106bd5e55b96e5d25b721b1b2607a34f25b71ef9ea5514252492dd7f584463d36a7dd2d614db1a00b66c1
+  data.tar.gz: 9c1f5c46f012cc003a32ed8829755f3c8321d3049c6b1c7c349063461674f6bf0a6c7114fb9bf444f8ce926c101cd9125c96f92438a34c2a6f1dd8322e650734

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/dummy/log

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -5,8 +5,6 @@ script:
   - bundle exec rake
 
 rvm:
- - 2.0.0
- - 2.2.5
  - 2.3.3
  - 2.4.0
 

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 3.1.0 (15/01/2019):
+
+  Feature:
+    - Ability to automatically configure Raygun4JS on the client side by injecting it into outbound HTML pages. Thanks @MikeRogers0 for this ([#138](https://github.com/MindscapeHQ/raygun4ruby/pull/138)])
+
 ## 3.0.0 (18/12/2018):
   Breaking changes:
     Parameter filters are now applied if you are using the `filter_payload_with_whitelist` functionality. Previously if this was set to true the parameter filtering was bailed out of ([#136](https://github.com/MindscapeHQ/raygun4ruby/pull/136/files))

data/Rakefile

@@ -7,7 +7,7 @@ namespace :test do
 
   desc "Test the basics of the adapter"
   Rake::TestTask.new(:units) do |t|
-    t.test_files = FileList["test/unit/*_test.rb", "specs/**/*_spec.rb"]
+    t.test_files = FileList["test/unit/*_test.rb"]
   end
 
   desc "Run a test against the live API"
@@ -15,6 +15,13 @@ namespace :test do
     t.test_files = FileList["test/integration/*_test.rb"]
   end
 
+  begin
+    require 'rspec/core/rake_task'
+
+    RSpec::Core::RakeTask.new(:spec)
+
+  rescue LoadError
+  end
 end
 
-task default: "test:units"
+task default: ["test:units", "test:spec"]

data/lib/raygun.rb

@@ -14,8 +14,10 @@ end
 require "raygun/version"
 require "raygun/configuration"
 require "raygun/client"
+require "raygun/javascript_tracker"
 require "raygun/middleware/rack_exception_interceptor"
 require "raygun/middleware/breadcrumbs_store_initializer"
+require "raygun/middleware/javascript_exception_tracking"
 require "raygun/testable"
 require "raygun/error"
 require "raygun/affected_user"

data/lib/raygun/configuration.rb

@@ -25,6 +25,12 @@ module Raygun
     # Your Raygun API Key - this can be found on your dashboard at Raygun.io
     config_option :api_key
 
+    # Your JS Raygun API Key - Should be different to your api_key, it's best practice to separate your errors between front end and back end.
+    config_option :js_api_key
+
+    # Your JS Raygun API Version, defaults to latest as found on https://raygun.com/raygun-providers/javascript
+    config_option :js_api_version
+
     # Array of exception classes to ignore
     config_option :ignore
 

data/lib/raygun/javascript_tracker.rb

@@ -0,0 +1,42 @@
+# Client for injecting JavaScript code for tracking front end exceptions
+# https://raygun.com/docs/languages/javascript
+module Raygun
+  class JavaScriptTracker
+    def head_html
+      return unless js_api_key?
+      [
+        '<script type="text/javascript">',
+        '!function(a,b,c,d,e,f,g,h){a.RaygunObject=e,a[e]=a[e]||function(){',
+        '(a[e].o=a[e].o||[]).push(arguments)},f=b.createElement(c),g=b.getElementsByTagName(c)[0],',
+        'f.async=1,f.src=d,g.parentNode.insertBefore(f,g),h=a.onerror,a.onerror=function(b,c,d,f,g){',
+        'h&&h(b,c,d,f,g),g||(g=new Error(b)),a[e].q=a[e].q||[],a[e].q.push({',
+        'e:g})}}(window,document,"script","//cdn.raygun.io/raygun4js/' + js_api_version + 'raygun.min.js","rg4js");',
+        '</script>'
+      ].join('').html_safe
+    end
+
+    def body_html
+      return unless js_api_key?
+      [
+        '<script type="text/javascript">',
+        "rg4js('apiKey', '#{js_api_key}');",
+        "rg4js('enableCrashReporting', true);",
+        '</script>'
+      ].join('').html_safe
+    end
+
+    private
+
+    def js_api_key
+      @js_api_key ||= Raygun.configuration.js_api_key
+    end
+
+    def js_api_version
+      @js_api_version ||= Raygun.configuration.js_api_version ? "#{Raygun.configuration.js_api_version}/" : ''
+    end
+
+    def js_api_key?
+      js_api_key.present?
+    end
+  end
+end

data/lib/raygun/middleware/javascript_exception_tracking.rb

@@ -0,0 +1,30 @@
+module Raygun::Middleware
+  class JavascriptExceptionTracking
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+
+      # It's a html file, inject our JS
+      if headers['Content-Type'].include?('text/html')
+        response = inject_javascript_to_response(response)
+      end
+
+      [status, headers, response]
+    end
+
+    def inject_javascript_to_response(response)
+      response[0].gsub!('</head>', "#{js_tracker.head_html}</head>")
+      response[0].gsub!('</body>', "#{js_tracker.body_html}</body>")
+
+      response
+    end
+
+    private
+    def js_tracker
+      @js_tracker = Raygun::JavaScriptTracker.new
+    end
+  end
+end

data/lib/raygun/railtie.rb

@@ -19,7 +19,8 @@ class Raygun::Railtie < Rails::Railtie
     raygun_middleware = [
       Raygun::Middleware::RailsInsertAffectedUser,
       Raygun::Middleware::RackExceptionInterceptor,
-      Raygun::Middleware::BreadcrumbsStoreInitializer
+      Raygun::Middleware::BreadcrumbsStoreInitializer,
+      Raygun::Middleware::JavascriptExceptionTracking
     ]
     raygun_middleware = raygun_middleware.map(&:to_s) unless Rails::VERSION::STRING >= "5"
     raygun_middleware.each do |m|

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/raygun4ruby.gemspec

@@ -28,11 +28,18 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", ">= 1.1"
   spec.add_development_dependency "rake", "~> 11"
   spec.add_development_dependency "timecop"
-  spec.add_development_dependency "minitest", "~> 4.2"
+  spec.add_development_dependency "minitest", "~> 5.11"
   spec.add_development_dependency "redis-namespace", ">= 1.3.1"
   spec.add_development_dependency "resque"
   spec.add_development_dependency "sidekiq", [">= 3", "< 3.2.2"]
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "webmock"
+
+  spec.add_development_dependency 'rails', "= 5.2"
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "launchy"
+  spec.add_development_dependency "simplecov"
 end

data/spec/dummy/.ruby-version

@@ -0,0 +1 @@
+2.5.1

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_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

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

@@ -0,0 +1,15 @@
+// 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. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

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

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

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 other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/spec/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

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

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

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

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

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

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

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/spec/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/spec/dummy/app/views/home/index.html.erb

@@ -0,0 +1,3 @@
+<h1>Home#index</h1>
+<p>Find me in app/views/home/index.html.erb</p>
+<p><%= Raygun.configuration.js_api_key %></p>

data/spec/dummy/app/views/home/index.json.erb

@@ -0,0 +1 @@
+{}

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

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

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

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

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

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

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+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', __dir__)
+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,36 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+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') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end