raygun4ruby 3.0.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/.rspec +1 -0
  4. data/.travis.yml +0 -2
  5. data/CHANGELOG.md +5 -0
  6. data/Rakefile +9 -2
  7. data/lib/raygun.rb +2 -0
  8. data/lib/raygun/configuration.rb +6 -0
  9. data/lib/raygun/javascript_tracker.rb +42 -0
  10. data/lib/raygun/middleware/javascript_exception_tracking.rb +30 -0
  11. data/lib/raygun/railtie.rb +2 -1
  12. data/lib/raygun/version.rb +1 -1
  13. data/raygun4ruby.gemspec +8 -1
  14. data/spec/dummy/.ruby-version +1 -0
  15. data/spec/dummy/Rakefile +6 -0
  16. data/spec/dummy/app/assets/config/manifest.js +3 -0
  17. data/spec/dummy/app/assets/images/.keep +0 -0
  18. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  19. data/spec/dummy/app/assets/javascripts/cable.js +13 -0
  20. data/spec/dummy/app/assets/javascripts/channels/.keep +0 -0
  21. data/spec/dummy/app/assets/stylesheets/application.css +15 -0
  22. data/spec/dummy/app/channels/application_cable/channel.rb +4 -0
  23. data/spec/dummy/app/channels/application_cable/connection.rb +4 -0
  24. data/spec/dummy/app/controllers/application_controller.rb +2 -0
  25. data/spec/dummy/app/controllers/concerns/.keep +0 -0
  26. data/spec/dummy/app/controllers/home_controller.rb +4 -0
  27. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  28. data/spec/dummy/app/jobs/application_job.rb +2 -0
  29. data/spec/dummy/app/mailers/application_mailer.rb +4 -0
  30. data/spec/dummy/app/models/application_record.rb +3 -0
  31. data/spec/dummy/app/models/concerns/.keep +0 -0
  32. data/spec/dummy/app/views/home/index.html.erb +3 -0
  33. data/spec/dummy/app/views/home/index.json.erb +1 -0
  34. data/spec/dummy/app/views/layouts/application.html.erb +15 -0
  35. data/spec/dummy/app/views/layouts/mailer.html.erb +13 -0
  36. data/spec/dummy/app/views/layouts/mailer.text.erb +1 -0
  37. data/spec/dummy/bin/bundle +3 -0
  38. data/spec/dummy/bin/rails +4 -0
  39. data/spec/dummy/bin/rake +4 -0
  40. data/spec/dummy/bin/setup +36 -0
  41. data/spec/dummy/bin/update +31 -0
  42. data/spec/dummy/bin/yarn +11 -0
  43. data/spec/dummy/config.ru +5 -0
  44. data/spec/dummy/config/application.rb +18 -0
  45. data/spec/dummy/config/boot.rb +5 -0
  46. data/spec/dummy/config/cable.yml +10 -0
  47. data/spec/dummy/config/database.yml +25 -0
  48. data/spec/dummy/config/environment.rb +5 -0
  49. data/spec/dummy/config/environments/development.rb +61 -0
  50. data/spec/dummy/config/environments/production.rb +94 -0
  51. data/spec/dummy/config/environments/test.rb +46 -0
  52. data/spec/dummy/config/initializers/application_controller_renderer.rb +8 -0
  53. data/spec/dummy/config/initializers/assets.rb +14 -0
  54. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  55. data/spec/dummy/config/initializers/content_security_policy.rb +25 -0
  56. data/spec/dummy/config/initializers/cookies_serializer.rb +5 -0
  57. data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  58. data/spec/dummy/config/initializers/inflections.rb +16 -0
  59. data/spec/dummy/config/initializers/mime_types.rb +4 -0
  60. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  61. data/spec/dummy/config/locales/en.yml +33 -0
  62. data/spec/dummy/config/puma.rb +34 -0
  63. data/spec/dummy/config/routes.rb +3 -0
  64. data/spec/dummy/config/spring.rb +6 -0
  65. data/spec/dummy/config/storage.yml +34 -0
  66. data/spec/dummy/db/schema.rb +15 -0
  67. data/spec/dummy/db/test.sqlite3 +0 -0
  68. data/spec/dummy/lib/assets/.keep +0 -0
  69. data/spec/dummy/package.json +5 -0
  70. data/spec/dummy/public/404.html +67 -0
  71. data/spec/dummy/public/422.html +67 -0
  72. data/spec/dummy/public/500.html +66 -0
  73. data/spec/dummy/public/apple-touch-icon-precomposed.png +0 -0
  74. data/spec/dummy/public/apple-touch-icon.png +0 -0
  75. data/spec/dummy/public/favicon.ico +0 -0
  76. data/spec/dummy/storage/.keep +0 -0
  77. data/spec/features/javascript_spec.rb +48 -0
  78. data/spec/rails_helper.rb +4 -0
  79. data/{specs → spec}/raygun/breadcrumbs/breadcrumb_spec.rb +19 -19
  80. data/{specs → spec}/raygun/breadcrumbs/store_spec.rb +21 -23
  81. data/{specs → spec}/raygun/raygun_spec.rb +5 -8
  82. data/{specs → spec}/services/apply_whitelist_filter_to_payload_spec.rb +9 -9
  83. data/spec/spec_helper.rb +24 -0
  84. data/spec/support/fake_logger.rb +17 -0
  85. data/test/test_helper.rb +1 -0
  86. data/test/unit/configuration_test.rb +12 -0
  87. metadata +163 -9
  88. data/specs/spec_helper.rb +0 -29
@@ -0,0 +1,34 @@
1
+ # Puma can serve each request in a thread from an internal thread pool.
2
+ # The `threads` method setting takes two numbers: a minimum and maximum.
3
+ # Any libraries that use thread pools should be configured to match
4
+ # the maximum value specified for Puma. Default is set to 5 threads for minimum
5
+ # and maximum; this matches the default thread size of Active Record.
6
+ #
7
+ threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
8
+ threads threads_count, threads_count
9
+
10
+ # Specifies the `port` that Puma will listen on to receive requests; default is 3000.
11
+ #
12
+ port ENV.fetch("PORT") { 3000 }
13
+
14
+ # Specifies the `environment` that Puma will run in.
15
+ #
16
+ environment ENV.fetch("RAILS_ENV") { "development" }
17
+
18
+ # Specifies the number of `workers` to boot in clustered mode.
19
+ # Workers are forked webserver processes. If using threads and workers together
20
+ # the concurrency of the application would be max `threads` * `workers`.
21
+ # Workers do not work on JRuby or Windows (both of which do not support
22
+ # processes).
23
+ #
24
+ # workers ENV.fetch("WEB_CONCURRENCY") { 2 }
25
+
26
+ # Use the `preload_app!` method when specifying a `workers` number.
27
+ # This directive tells Puma to first boot the application and load code
28
+ # before forking the application. This takes advantage of Copy On Write
29
+ # process behavior so workers use less memory.
30
+ #
31
+ # preload_app!
32
+
33
+ # Allow puma to be restarted by `rails restart` command.
34
+ plugin :tmp_restart
@@ -0,0 +1,3 @@
1
+ Rails.application.routes.draw do
2
+ root 'home#index'
3
+ end
@@ -0,0 +1,6 @@
1
+ %w[
2
+ .ruby-version
3
+ .rbenv-vars
4
+ tmp/restart.txt
5
+ tmp/caching-dev.txt
6
+ ].each { |path| Spring.watch(path) }
@@ -0,0 +1,34 @@
1
+ test:
2
+ service: Disk
3
+ root: <%= Rails.root.join("tmp/storage") %>
4
+
5
+ local:
6
+ service: Disk
7
+ root: <%= Rails.root.join("storage") %>
8
+
9
+ # Use rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
10
+ # amazon:
11
+ # service: S3
12
+ # access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
13
+ # secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
14
+ # region: us-east-1
15
+ # bucket: your_own_bucket
16
+
17
+ # Remember not to checkin your GCS keyfile to a repository
18
+ # google:
19
+ # service: GCS
20
+ # project: your_project
21
+ # credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
22
+ # bucket: your_own_bucket
23
+
24
+ # Use rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
25
+ # microsoft:
26
+ # service: AzureStorage
27
+ # storage_account_name: your_account_name
28
+ # storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
29
+ # container: your_container_name
30
+
31
+ # mirror:
32
+ # service: Mirror
33
+ # primary: local
34
+ # mirrors: [ amazon, google, microsoft ]
@@ -0,0 +1,15 @@
1
+ # This file is auto-generated from the current state of the database. Instead
2
+ # of editing this file, please use the migrations feature of Active Record to
3
+ # incrementally modify your database, and then regenerate this schema definition.
4
+ #
5
+ # Note that this schema.rb definition is the authoritative source for your
6
+ # database schema. If you need to create the application database on another
7
+ # system, you should be using db:schema:load, not running all the migrations
8
+ # from scratch. The latter is a flawed and unsustainable approach (the more migrations
9
+ # you'll amass, the slower it'll run and the greater likelihood for issues).
10
+ #
11
+ # It's strongly recommended that you check this file into your version control system.
12
+
13
+ ActiveRecord::Schema.define(version: 0) do
14
+
15
+ end
File without changes
File without changes
@@ -0,0 +1,5 @@
1
+ {
2
+ "name": "dummy",
3
+ "private": true,
4
+ "dependencies": {}
5
+ }
@@ -0,0 +1,67 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The page you were looking for doesn't exist (404)</title>
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <style>
7
+ .rails-default-error-page {
8
+ background-color: #EFEFEF;
9
+ color: #2E2F30;
10
+ text-align: center;
11
+ font-family: arial, sans-serif;
12
+ margin: 0;
13
+ }
14
+
15
+ .rails-default-error-page div.dialog {
16
+ width: 95%;
17
+ max-width: 33em;
18
+ margin: 4em auto 0;
19
+ }
20
+
21
+ .rails-default-error-page div.dialog > div {
22
+ border: 1px solid #CCC;
23
+ border-right-color: #999;
24
+ border-left-color: #999;
25
+ border-bottom-color: #BBB;
26
+ border-top: #B00100 solid 4px;
27
+ border-top-left-radius: 9px;
28
+ border-top-right-radius: 9px;
29
+ background-color: white;
30
+ padding: 7px 12% 0;
31
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
32
+ }
33
+
34
+ .rails-default-error-page h1 {
35
+ font-size: 100%;
36
+ color: #730E15;
37
+ line-height: 1.5em;
38
+ }
39
+
40
+ .rails-default-error-page div.dialog > p {
41
+ margin: 0 0 1em;
42
+ padding: 1em;
43
+ background-color: #F7F7F7;
44
+ border: 1px solid #CCC;
45
+ border-right-color: #999;
46
+ border-left-color: #999;
47
+ border-bottom-color: #999;
48
+ border-bottom-left-radius: 4px;
49
+ border-bottom-right-radius: 4px;
50
+ border-top-color: #DADADA;
51
+ color: #666;
52
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
53
+ }
54
+ </style>
55
+ </head>
56
+
57
+ <body class="rails-default-error-page">
58
+ <!-- This file lives in public/404.html -->
59
+ <div class="dialog">
60
+ <div>
61
+ <h1>The page you were looking for doesn't exist.</h1>
62
+ <p>You may have mistyped the address or the page may have moved.</p>
63
+ </div>
64
+ <p>If you are the application owner check the logs for more information.</p>
65
+ </div>
66
+ </body>
67
+ </html>
@@ -0,0 +1,67 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The change you wanted was rejected (422)</title>
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <style>
7
+ .rails-default-error-page {
8
+ background-color: #EFEFEF;
9
+ color: #2E2F30;
10
+ text-align: center;
11
+ font-family: arial, sans-serif;
12
+ margin: 0;
13
+ }
14
+
15
+ .rails-default-error-page div.dialog {
16
+ width: 95%;
17
+ max-width: 33em;
18
+ margin: 4em auto 0;
19
+ }
20
+
21
+ .rails-default-error-page div.dialog > div {
22
+ border: 1px solid #CCC;
23
+ border-right-color: #999;
24
+ border-left-color: #999;
25
+ border-bottom-color: #BBB;
26
+ border-top: #B00100 solid 4px;
27
+ border-top-left-radius: 9px;
28
+ border-top-right-radius: 9px;
29
+ background-color: white;
30
+ padding: 7px 12% 0;
31
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
32
+ }
33
+
34
+ .rails-default-error-page h1 {
35
+ font-size: 100%;
36
+ color: #730E15;
37
+ line-height: 1.5em;
38
+ }
39
+
40
+ .rails-default-error-page div.dialog > p {
41
+ margin: 0 0 1em;
42
+ padding: 1em;
43
+ background-color: #F7F7F7;
44
+ border: 1px solid #CCC;
45
+ border-right-color: #999;
46
+ border-left-color: #999;
47
+ border-bottom-color: #999;
48
+ border-bottom-left-radius: 4px;
49
+ border-bottom-right-radius: 4px;
50
+ border-top-color: #DADADA;
51
+ color: #666;
52
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
53
+ }
54
+ </style>
55
+ </head>
56
+
57
+ <body class="rails-default-error-page">
58
+ <!-- This file lives in public/422.html -->
59
+ <div class="dialog">
60
+ <div>
61
+ <h1>The change you wanted was rejected.</h1>
62
+ <p>Maybe you tried to change something you didn't have access to.</p>
63
+ </div>
64
+ <p>If you are the application owner check the logs for more information.</p>
65
+ </div>
66
+ </body>
67
+ </html>
@@ -0,0 +1,66 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>We're sorry, but something went wrong (500)</title>
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <style>
7
+ .rails-default-error-page {
8
+ background-color: #EFEFEF;
9
+ color: #2E2F30;
10
+ text-align: center;
11
+ font-family: arial, sans-serif;
12
+ margin: 0;
13
+ }
14
+
15
+ .rails-default-error-page div.dialog {
16
+ width: 95%;
17
+ max-width: 33em;
18
+ margin: 4em auto 0;
19
+ }
20
+
21
+ .rails-default-error-page div.dialog > div {
22
+ border: 1px solid #CCC;
23
+ border-right-color: #999;
24
+ border-left-color: #999;
25
+ border-bottom-color: #BBB;
26
+ border-top: #B00100 solid 4px;
27
+ border-top-left-radius: 9px;
28
+ border-top-right-radius: 9px;
29
+ background-color: white;
30
+ padding: 7px 12% 0;
31
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
32
+ }
33
+
34
+ .rails-default-error-page h1 {
35
+ font-size: 100%;
36
+ color: #730E15;
37
+ line-height: 1.5em;
38
+ }
39
+
40
+ .rails-default-error-page div.dialog > p {
41
+ margin: 0 0 1em;
42
+ padding: 1em;
43
+ background-color: #F7F7F7;
44
+ border: 1px solid #CCC;
45
+ border-right-color: #999;
46
+ border-left-color: #999;
47
+ border-bottom-color: #999;
48
+ border-bottom-left-radius: 4px;
49
+ border-bottom-right-radius: 4px;
50
+ border-top-color: #DADADA;
51
+ color: #666;
52
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
53
+ }
54
+ </style>
55
+ </head>
56
+
57
+ <body class="rails-default-error-page">
58
+ <!-- This file lives in public/500.html -->
59
+ <div class="dialog">
60
+ <div>
61
+ <h1>We're sorry, but something went wrong.</h1>
62
+ </div>
63
+ <p>If you are the application owner check the logs for more information.</p>
64
+ </div>
65
+ </body>
66
+ </html>
File without changes
File without changes
File without changes
@@ -0,0 +1,48 @@
1
+ require 'rails_helper'
2
+
3
+ feature 'JavaScript Tracking', feature: true do
4
+ before { Raygun.configuration.js_api_key = nil }
5
+ after { Raygun.configuration.js_api_key = nil }
6
+
7
+ it "Includes the Raygun Javascript Middleware" do
8
+ expect(Rails.application.config.middleware).to include(Raygun::Middleware::JavascriptExceptionTracking)
9
+ end
10
+
11
+ it "Does not inject the JS snippet" do
12
+ visit root_path
13
+
14
+ expect(page.html).to_not include('cdn.raygun.io/raygun4js/raygun.min.js')
15
+ expect(page.html).to_not include('rg4js(')
16
+ end
17
+
18
+ context 'With a JS API Key' do
19
+ before { Raygun.configuration.js_api_key = 'Sample key' }
20
+
21
+ it "Injects the JS snippet" do
22
+ visit root_path
23
+
24
+ expect(page.html).to include('cdn.raygun.io/raygun4js/raygun.min.js')
25
+ expect(page.html).to include('rg4js(')
26
+ end
27
+
28
+ it "Does not inject the JS snippet" do
29
+ visit root_path(format: :json)
30
+
31
+ expect(page.html).to_not include('cdn.raygun.io/raygun4js/raygun.min.js')
32
+ expect(page.html).to_not include('rg4js(')
33
+ end
34
+ end
35
+
36
+ context "With JS version overriden" do
37
+ before do
38
+ Raygun.configuration.js_api_version = "2.14.1"
39
+ Raygun.configuration.js_api_key = "Sample key"
40
+ end
41
+
42
+ it "Uses the overriden version" do
43
+ visit root_path
44
+
45
+ expect(page.html).to include('cdn.raygun.io/raygun4js/2.14.1/raygun.min.js')
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,4 @@
1
+ ENV['RAILS_ENV'] ||= 'test'
2
+ require 'dummy/config/environment'
3
+
4
+ require 'rspec/rails'
@@ -1,4 +1,4 @@
1
- require_relative "../../spec_helper"
1
+ require "spec_helper"
2
2
 
3
3
  module Raygun
4
4
  module Breadcrumbs
@@ -10,7 +10,7 @@ module Raygun
10
10
 
11
11
  subject.message = message
12
12
 
13
- subject.message.must_equal(message)
13
+ expect(subject.message).to eq(message)
14
14
  end
15
15
 
16
16
  it 'has a category' do
@@ -18,7 +18,7 @@ module Raygun
18
18
 
19
19
  subject.category = category
20
20
 
21
- subject.category.must_equal(category)
21
+ expect(subject.category).to eq(category)
22
22
  end
23
23
 
24
24
  it 'has a level' do
@@ -26,7 +26,7 @@ module Raygun
26
26
 
27
27
  subject.level = level
28
28
 
29
- subject.level.must_equal(level)
29
+ expect(subject.level).to eq(level)
30
30
  end
31
31
 
32
32
  it 'has a timestamp' do
@@ -34,7 +34,7 @@ module Raygun
34
34
 
35
35
  subject.timestamp = timestamp
36
36
 
37
- subject.timestamp.must_equal(timestamp)
37
+ expect(subject.timestamp).to eq(timestamp)
38
38
  end
39
39
 
40
40
  it 'has metadata' do
@@ -42,7 +42,7 @@ module Raygun
42
42
 
43
43
  subject.metadata = metadata
44
44
 
45
- subject.metadata.must_equal(metadata)
45
+ expect(subject.metadata).to eq(metadata)
46
46
  end
47
47
 
48
48
  it 'has a class_name' do
@@ -50,7 +50,7 @@ module Raygun
50
50
 
51
51
  subject.class_name = class_name
52
52
 
53
- subject.class_name.must_equal(class_name)
53
+ expect(subject.class_name).to eq(class_name)
54
54
  end
55
55
 
56
56
  it 'has a method_name' do
@@ -58,7 +58,7 @@ module Raygun
58
58
 
59
59
  subject.method_name = method_name
60
60
 
61
- subject.method_name.must_equal(method_name)
61
+ expect(subject.method_name).to eq(method_name)
62
62
  end
63
63
 
64
64
  it 'has a line_number' do
@@ -66,7 +66,7 @@ module Raygun
66
66
 
67
67
  subject.line_number = line_number
68
68
 
69
- subject.line_number.must_equal(line_number)
69
+ expect(subject.line_number).to eq(line_number)
70
70
  end
71
71
  end
72
72
 
@@ -98,35 +98,35 @@ module Raygun
98
98
  let(:payload) { breadcrumb.build_payload }
99
99
 
100
100
  it "joins the class name, method name and line number together" do
101
- payload[:location].must_equal("HomeController:index:17")
101
+ expect(payload[:location]).to eq("HomeController:index:17")
102
102
  end
103
103
 
104
104
  it "does not include the method name and line number if the class name is missing" do
105
105
  breadcrumb.class_name = nil
106
106
 
107
- payload.has_key?(:location).must_equal(false)
107
+ expect(payload.has_key?(:location)).to eq(false)
108
108
  end
109
109
 
110
110
  it "does not inlcude the line number if is it missing" do
111
111
  breadcrumb.line_number = nil
112
112
 
113
- payload[:location].must_equal("HomeController:index")
113
+ expect(payload[:location]).to eq("HomeController:index")
114
114
  end
115
115
 
116
116
  it "does not include keys in payload with nil values" do
117
117
  breadcrumb.metadata = nil
118
118
  breadcrumb.category = nil
119
119
 
120
- payload.key?(:CustomData).must_equal(false)
121
- payload.key?(:category).must_equal(false)
120
+ expect(payload.key?(:CustomData)).to eq(false)
121
+ expect(payload.key?(:category)).to eq(false)
122
122
  end
123
123
 
124
124
  it 'includes the rest of the fields' do
125
- payload[:message].must_equal('test')
126
- payload[:category].must_equal('test')
127
- payload[:level].must_equal(1)
128
- payload[:timestamp].wont_be_nil
129
- payload[:CustomData].must_equal(foo: 'bar')
125
+ expect(payload[:message]).to eq('test')
126
+ expect(payload[:category]).to eq('test')
127
+ expect(payload[:level]).to eq(1)
128
+ expect(payload[:timestamp]).to_not eq(nil)
129
+ expect(payload[:CustomData]).to eq(foo: 'bar')
130
130
  end
131
131
  end
132
132
  end