raygun4ruby 3.1.0 → 3.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: acbc458153d576b6856920cb72985952f9f6ed22
-  data.tar.gz: bb9976f64347bce6b6a6a6f3920564b489b478bb
+SHA256:
+  metadata.gz: 03f1be499b87a7e21e94ffb59e414dad9681adcbf13b58a2fcc66e29c939f43d
+  data.tar.gz: 24885acd5b4076e37c9778114547302f2997bb993d1d353aa3880c0964f497b8
 SHA512:
-  metadata.gz: d603e52d886065cf9cc7b26f6639a8f6c237447d2af106bd5e55b96e5d25b721b1b2607a34f25b71ef9ea5514252492dd7f584463d36a7dd2d614db1a00b66c1
-  data.tar.gz: 9c1f5c46f012cc003a32ed8829755f3c8321d3049c6b1c7c349063461674f6bf0a6c7114fb9bf444f8ce926c101cd9125c96f92438a34c2a6f1dd8322e650734
+  metadata.gz: 60d5e19831a25963ae99355c235e7e184c916db16cf5cec1d93bdf4ca86cf899bf78c406cf4598fc89c08bb11145f420e3eced31c1d0db7875fedd194c0de61b
+  data.tar.gz: de64cda810b1d3b9c625606933e4f437a1285b0bb47d5033c24876a4f3605844a2a40d5fe89a4b084e6c4468230d3eaa74b7913deab5f61158c769940e998585

data/.travis.yml

@@ -1,12 +1,20 @@
+language: ruby
+
 before_install:
-  - gem install bundler
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
 
 script:
   - bundle exec rake
 
 rvm:
- - 2.3.3
- - 2.4.0
+ - 2.0.0-p648
+ - 2.1.0
+ - 2.2.10
+ - 2.3.8
+ - 2.4.5
+ - 2.5.3
+ - 2.6.1
 
 gemfile:
   - Gemfile

data/CHANGELOG.md

@@ -1,7 +1,28 @@
+## 3.2.2 (10/06/2020):
+  - Introduce support for Raygun APM exceptions correlation ([#154](https://github.com/MindscapeHQ/raygun4ruby/pull/154))
+
+## 3.2.1 (25/02/2019):
+Bugfix:
+  - Remove Ruby 2.3 syntax to retain support for Ruby >= 2.0 ([#148](https://github.com/MindscapeHQ/raygun4ruby/pull/148))
+
+## 3.2.0 (21/02/2019):
+Bugfix:
+  - Fix NoMethodError Exception: undefined method `include?' for nil:NilClass in `JavascriptExceptionTracking` class. Thanks @yamanaltereh for this ([#141](https://github.com/MindscapeHQ/raygun4ruby/pull/141))
+  - Fix ([#145](https://github.com/MindscapeHQ/raygun4ruby/issues/145)), "raygun4ruby will load pry if it is in the gem bundle". Thanks to @eoinkelly for reporting this
+
+Feature:
+  - If you have recorded a large number of Breadcrumbs, or just very large ones, Raygun4Ruby will now only send up to 100KB of them instead of all of them, potentially going over the 128KB payload limit Raygun accepts ([#147](https://github.com/MindscapeHQ/raygun4ruby/pull/147))
+
+## 3.1.1 (16/01/2019):
+Bugfix:
+  - Don't attempt to modify response unless JS api key is present
+  - Don't attempt to modify response unless it responds to indexing ([])
+  - See PR ([#140](https://github.com/MindscapeHQ/raygun4ruby/pull/140))
+
 ## 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)])
+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:

data/README.md

@@ -19,7 +19,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Rails 3/4
+### Rails 3/4/5
 
 Run:
 
@@ -83,7 +83,7 @@ rescue => e
 end
 ```
 
-You can also pass a Hash as the second parameter to `track_exception`. It should look like a [Rack Env Hash](http://rack.rubyforge.org/doc/SPEC.html)
+You can also pass a Hash as the second parameter to `track_exception`. It should look like a [Rack Env Hash](https://www.rubydoc.info/github/rack/rack/master/file/SPEC)
 
 ### Customizing The Parameter Filtering
 
@@ -182,7 +182,7 @@ Raygun.setup do |config|
   config.api_key = "YOUR_RAYGUN_API_KEY"
   config.filter_payload_with_whitelist = true
 
-  config.whitelist_payload_keys do |payload|
+  config.whitelist_payload_shape do |payload|
     # Return the payload mutated into your desired form
     payload
   end

data/lib/raygun.rb

@@ -6,11 +6,6 @@ require "socket"
 require "rack"
 require "ostruct"
 
-begin
-  require "pry"
-rescue LoadError
-end
-
 require "raygun/version"
 require "raygun/configuration"
 require "raygun/client"
@@ -152,6 +147,8 @@ module Raygun
         env[:custom_data] ||= {}
         env[:custom_data].merge!(original_stacktrace: exception_instance.backtrace)
 
+        ::Raygun::Breadcrumbs::Store.clear
+
         track_exception(new_exception, env, user, retry_count - 1)
       else
         raise e

data/lib/raygun/breadcrumbs/breadcrumb.rb

@@ -25,6 +25,10 @@ module Raygun
           v != nil
         end]
       end
+
+      def size
+        return message.length + 100
+      end
     end
   end
 end

data/lib/raygun/breadcrumbs/store.rb

@@ -47,6 +47,16 @@ module Raygun
         stored != nil && stored.length > 0
       end
 
+      def self.take_until_size(size)
+        breadcrumb_size = 0
+
+        stored.reverse.take_while do |crumb|
+          breadcrumb_size += crumb.size
+
+          breadcrumb_size < size
+        end.reverse
+      end
+
       private
 
       def self.should_record?(crumb)

data/lib/raygun/client.rb

@@ -5,6 +5,7 @@ module Raygun
 
     ENV_IP_ADDRESS_KEYS = %w(action_dispatch.remote_ip raygun.remote_ip REMOTE_ADDR)
     NO_API_KEY_MESSAGE  = "[RAYGUN] Just a note, you've got no API Key configured, which means we can't report exceptions. Specify your Raygun API key using Raygun#setup (find yours at https://app.raygun.io)"
+    MAX_BREADCRUMBS_SIZE = 100_000
 
     include HTTParty
 
@@ -191,6 +192,7 @@ module Raygun
         Raygun.log('set tags')
 
         grouping_key = env.delete(:grouping_key)
+        correlation_id = env.delete(:correlation_id)
 
         configuration_custom_data = Raygun.configuration.custom_data
         configured_custom_data = if configuration_custom_data.is_a?(Proc)
@@ -214,11 +216,12 @@ module Raygun
             }
         }
         store = ::Raygun::Breadcrumbs::Store
-        error_details[:breadcrumbs] = store.stored.map(&:build_payload) if store.any?
+        error_details[:breadcrumbs] = store.take_until_size(MAX_BREADCRUMBS_SIZE).map(&:build_payload) if store.any?
 
         Raygun.log('set details and breadcrumbs')
 
         error_details.merge!(groupingKey: grouping_key) if grouping_key
+        error_details.merge!(correlationId: correlation_id) if correlation_id
 
         user_details = if affected_user_present?(env)
                          user_information(env)

data/lib/raygun/middleware/javascript_exception_tracking.rb

@@ -8,7 +8,7 @@ module Raygun::Middleware
       status, headers, response = @app.call(env)
 
       # It's a html file, inject our JS
-      if headers['Content-Type'].include?('text/html')
+      if headers['Content-Type'] && headers['Content-Type'].include?('text/html')
         response = inject_javascript_to_response(response)
       end
 
@@ -16,8 +16,10 @@ module Raygun::Middleware
     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>")
+      if Raygun.configuration.js_api_key.present? && response.respond_to?('[]')
+        response[0].gsub!('</head>', "#{js_tracker.head_html}</head>")
+        response[0].gsub!('</body>', "#{js_tracker.body_html}</body>")
+      end
 
       response
     end

data/lib/raygun/sidekiq.rb

@@ -25,6 +25,9 @@ module Raygun
           sidekiq_context: context_hash
         }
       }
+      if correlation_id = exception.instance_variable_get(:@__raygun_correlation_id)
+        data.merge!(correlation_id: correlation_id)
+      end
       ::Raygun.track_exception(
           exception,
           data,

data/lib/raygun/version.rb

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

data/raygun4ruby.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "concurrent-ruby"
 
   spec.add_development_dependency "bundler", ">= 1.1"
-  spec.add_development_dependency "rake", "~> 11"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "timecop"
   spec.add_development_dependency "minitest", "~> 5.11"
   spec.add_development_dependency "redis-namespace", ">= 1.3.1"
@@ -36,10 +36,10 @@ Gem::Specification.new do |spec|
   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 'rails', "= 4.2.11"
+  spec.add_development_dependency 'sqlite3', '~> 1.3.6'
   spec.add_development_dependency 'capybara'
-  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "rspec-rails", '~> 3.9'
   spec.add_development_dependency "launchy"
   spec.add_development_dependency "simplecov"
 end

data/spec/dummy/.gitignore

@@ -0,0 +1,17 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+!/log/.keep
+/tmp

data/spec/dummy/Gemfile

@@ -0,0 +1,47 @@
+source 'https://rubygems.org'
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.2.11'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 5.0'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .coffee assets and views
+gem 'coffee-rails', '~> 4.1.0'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0', group: :doc
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug'
+end
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> in views
+  gem 'web-console', '~> 2.0'
+
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+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

@@ -1,6 +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'
+require File.expand_path('../config/application', __FILE__)
 
 Rails.application.load_tasks

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

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

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

@@ -5,11 +5,9 @@
 // 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.
+// compiled file.
 //
 // 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/stylesheets/application.css

@@ -6,9 +6,9 @@
  * 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.
+ * 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

@@ -1,2 +1,5 @@
 class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
 end

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

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