flame-sentry_context 0.2.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 (7) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +22 -0
  3. data/LICENSE.txt +21 -0
  4. data/README.md +112 -0
  5. data/lib/flame/sentry_context/version.rb +7 -0
  6. data/lib/flame/sentry_context.rb +93 -0
  7. metadata +243 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: b8f20d3683eaf611380ba1068d61fa8166a4731470269dd330651bcc15ab5197
4
+ data.tar.gz: f64384eeb00488a6bc37d1e40ff7e0b80faed8f7bdc2c3cc5a76ed2930336025
5
+ SHA512:
6
+ metadata.gz: ee6426b08e1ce9ce971bcc001fae0cbe1fe6e88b13f514be5eeb151136d4f1e66feb76bbe0e5c4dc1bfae65103fddd2f218d74c38bc55fa65cbf9af7d503641c
7
+ data.tar.gz: b1dd5de430354ee415b00d9339d8e894b1bf166e41952f8bd99ae624fa8fce93c1ce13e15ea9e6bab6dd0cac66ffc51f08967132b8fd212e657dad07065a0109
data/CHANGELOG.md ADDED
@@ -0,0 +1,22 @@
1
+ # Changelog
2
+
3
+ ## Unreleased
4
+
5
+ ## 0.2.0 (2022-09-04)
6
+
7
+ * Switch to `sentry-ruby`, rename to `flame-sentry_context`.
8
+ * Drop Ruby 2.5 support.
9
+ * Add Ruby 3.1 for CI.
10
+ * Rename `master` git branch to `main`.
11
+
12
+ ## 0.1.2 (2020-09-21)
13
+
14
+ * Fix `sentry-raven` gem requirement.
15
+
16
+ ## 0.1.1 (2020-08-21)
17
+
18
+ * Require `raven`.
19
+
20
+ ## 0.1.0 (2020-08-02)
21
+
22
+ * Initial release.
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2020 Alexander Popov
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,112 @@
1
+ # Flame Sentry Context
2
+
3
+ [![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/flame-sentry_context?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/flame-sentry_context)
4
+ [![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/flame-sentry_context/main.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/flame-sentry_context)
5
+ [![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/flame-sentry_context.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/flame-sentry_context)
6
+ [![Depfu](https://img.shields.io/depfu/AlexWayfer/flame-sentry_context?style=flat-square)](https://depfu.com/repos/github/AlexWayfer/flame-sentry_context)
7
+ [![Inline docs](https://inch-ci.org/github/AlexWayfer/flame-sentry_context.svg?branch=main)](https://inch-ci.org/github/AlexWayfer/flame-sentry_context)
8
+ [![License](https://img.shields.io/github/license/AlexWayfer/flame-sentry_context.svg?style=flat-square)](https://github.com/AlexWayfer/flame-sentry_context/blob/main/LICENSE.txt)
9
+ [![Gem](https://img.shields.io/gem/v/flame-sentry_context.svg?style=flat-square)](https://rubygems.org/gems/flame-sentry_context)
10
+
11
+ Helper class for [Sentry](https://sentry.io/) reports
12
+ via [`sentry-ruby` gem](https://rubygems.org/gems/sentry-ruby)
13
+ from [Flame](https://github.com/AlexWayfer/flame) web applications.
14
+
15
+ ## Installation
16
+
17
+ Add this line to your application's Gemfile:
18
+
19
+ ```ruby
20
+ gem 'flame-sentry_context'
21
+ ```
22
+
23
+ And then execute:
24
+
25
+ ```shell
26
+ bundle install
27
+ ```
28
+
29
+ Or install it yourself as:
30
+
31
+ ```shell
32
+ gem install flame-sentry_context
33
+ ```
34
+
35
+ ## Usage
36
+
37
+ Default loggers:
38
+
39
+ * [`:puma`](https://puma.io/)
40
+ * `:server`
41
+ * `:not_found`
42
+ * `:translations` ([R18n](https://github.com/r18n/r18n))
43
+ * `:validation_errors` ([Formalism R18n Errors](https://github.com/AlexWayfer/formalism-r18n_errors))
44
+
45
+ You can change them via `Flame::SentryContext.loggers` reader.
46
+
47
+ Example from [Flame application template](https://github.com/AlexWayfer/flame-cli/tree/main/template):
48
+
49
+ ```ruby
50
+ require 'flame/sentry_context'
51
+
52
+ module MyApplication
53
+ ## Base controller for any others controllers
54
+ class Controller < Flame::Controller
55
+ protected
56
+
57
+ def not_found
58
+ unless request.bot?
59
+ Flame::SentryContext.new(:not_found, controller: self).capture_message
60
+ end
61
+
62
+ super
63
+ end
64
+
65
+ def server_error(exception)
66
+ Flame::SentryContext.new(:server, controller: self).capture_exception(exception)
67
+
68
+ super
69
+ end
70
+
71
+ private
72
+
73
+ ## This can be used as `capture_validation_errors form_outcome.errors.translations`
74
+ ## inside `else` of `if (form_outcome = @form.run).success?` condition.
75
+ def capture_validation_errors(errors)
76
+ Flame::SentryContext.new(
77
+ :validation_errors,
78
+ controller: self,
79
+ form_class: @form.class,
80
+ errors: errors
81
+ ).capture_message
82
+ end
83
+ end
84
+ end
85
+ ```
86
+
87
+ You can pass `:user` into initialization or redefine `user` getter globally via:
88
+
89
+ ```ruby
90
+ ## here is default value in example
91
+ Flame::SentryContext.user_block = -> { @controller&.send(:authenticated)&.account }
92
+ ```
93
+
94
+ ## Development
95
+
96
+ After checking out the repo, run `bundle install` to install dependencies.
97
+
98
+ Then, run `toys rspec` to run the tests.
99
+
100
+ To install this gem onto your local machine, run `toys gem install`.
101
+
102
+ To release a new version, run `toys gem release %version%`.
103
+ See how it works [here](https://github.com/AlexWayfer/gem_toys#release).
104
+
105
+ ## Contributing
106
+
107
+ Bug reports and pull requests are welcome on [GitHub](https://github.com/AlexWayfer/flame-sentry_context).
108
+
109
+ ## License
110
+
111
+ The gem is available as open source under the terms of the
112
+ [MIT License](https://opensource.org/licenses/MIT).
data/lib/flame/sentry_context/version.rb ADDED
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Flame
4
+ class SentryContext
5
+ VERSION = '0.2.0'
6
+ end
7
+ end
data/lib/flame/sentry_context.rb ADDED
@@ -0,0 +1,93 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'sentry_context/version'
4
+
5
+ require 'gorilla_patch/deep_dup'
6
+ require 'memery'
7
+ require 'sentry-ruby'
8
+
9
+ module Flame
10
+ ## Class for request context initialization
11
+ class SentryContext
12
+ include Memery
13
+
14
+ DEFAULT_TYPES = {
15
+ puma: {
16
+ level: :error
17
+ }.freeze,
18
+ server: {
19
+ level: :error
20
+ }.freeze,
21
+ not_found: {
22
+ level: :warning,
23
+ message: -> { "404: #{@controller.request.path}" }
24
+ }.freeze,
25
+ translations: {
26
+ level: :error,
27
+ message: -> { "Translation missing: #{@extra[:key]}" }
28
+ }.freeze,
29
+ validation_errors: {
30
+ level: :warning,
31
+ message: -> { "Validation errors: #{@extra[:form_class]}" }
32
+ }.freeze
33
+ }.freeze
34
+
35
+ class << self
36
+ include Memery
37
+
38
+ using GorillaPatch::DeepDup
39
+
40
+ attr_writer :user_block
41
+
42
+ def user_block
43
+ @user_block ||= -> { @controller&.send(:authenticated)&.account }
44
+ end
45
+
46
+ memoize def types
47
+ DEFAULT_TYPES.deep_dup
48
+ end
49
+ end
50
+
51
+ attr_reader :exception
52
+
53
+ def initialize(
54
+ type, controller: nil, env: controller&.request&.env, **extra
55
+ )
56
+ @type = type
57
+ @type_data = self.class.types[@type]
58
+ @controller = controller
59
+ @env = env
60
+ @user = extra.delete(:user) || instance_exec(&self.class.user_block)
61
+ @extra = extra
62
+ end
63
+
64
+ def capture_exception(exception)
65
+ @extra[:sql] = exception.sql if exception.respond_to? :sql
66
+
67
+ Sentry.capture_exception exception, **context
68
+ end
69
+
70
+ def capture_message
71
+ message = instance_exec(&@type_data[:message])
72
+
73
+ Sentry.capture_message message, **context
74
+ end
75
+
76
+ private
77
+
78
+ memoize def context
79
+ Sentry.get_current_scope.clear
80
+
81
+ Sentry.get_current_scope.set_rack_env(@env) if @env
82
+
83
+ {
84
+ level: @type_data[:level],
85
+ user: @user || {},
86
+ tags: {
87
+ type: @type
88
+ },
89
+ extra: @extra
90
+ }
91
+ end
92
+ end
93
+ end
metadata ADDED
@@ -0,0 +1,243 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: flame-sentry_context
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.2.0
5
+ platform: ruby
6
+ authors:
7
+ - Alexander Popov
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2022-09-04 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: alt_memery
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '2.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '2.0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: gorilla_patch
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '4.0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '4.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: sentry-ruby
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '5.4'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '5.4'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry-byebug
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '3.9'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '3.9'
69
+ - !ruby/object:Gem::Dependency
70
+ name: bundler
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - "~>"
74
+ - !ruby/object:Gem::Version
75
+ version: '2.0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - "~>"
81
+ - !ruby/object:Gem::Version
82
+ version: '2.0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: gem_toys
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: 0.12.0
90
+ type: :development
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - "~>"
95
+ - !ruby/object:Gem::Version
96
+ version: 0.12.0
97
+ - !ruby/object:Gem::Dependency
98
+ name: toys
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - "~>"
102
+ - !ruby/object:Gem::Version
103
+ version: 0.13.0
104
+ type: :development
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: 0.13.0
111
+ - !ruby/object:Gem::Dependency
112
+ name: rspec
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '3.9'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '3.9'
125
+ - !ruby/object:Gem::Dependency
126
+ name: simplecov
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: 0.21.2
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: 0.21.2
139
+ - !ruby/object:Gem::Dependency
140
+ name: simplecov-cobertura
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '2.1'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '2.1'
153
+ - !ruby/object:Gem::Dependency
154
+ name: rubocop
155
+ requirement: !ruby/object:Gem::Requirement
156
+ requirements:
157
+ - - "~>"
158
+ - !ruby/object:Gem::Version
159
+ version: '1.2'
160
+ type: :development
161
+ prerelease: false
162
+ version_requirements: !ruby/object:Gem::Requirement
163
+ requirements:
164
+ - - "~>"
165
+ - !ruby/object:Gem::Version
166
+ version: '1.2'
167
+ - !ruby/object:Gem::Dependency
168
+ name: rubocop-performance
169
+ requirement: !ruby/object:Gem::Requirement
170
+ requirements:
171
+ - - "~>"
172
+ - !ruby/object:Gem::Version
173
+ version: '1.0'
174
+ type: :development
175
+ prerelease: false
176
+ version_requirements: !ruby/object:Gem::Requirement
177
+ requirements:
178
+ - - "~>"
179
+ - !ruby/object:Gem::Version
180
+ version: '1.0'
181
+ - !ruby/object:Gem::Dependency
182
+ name: rubocop-rspec
183
+ requirement: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - "~>"
186
+ - !ruby/object:Gem::Version
187
+ version: '2.0'
188
+ type: :development
189
+ prerelease: false
190
+ version_requirements: !ruby/object:Gem::Requirement
191
+ requirements:
192
+ - - "~>"
193
+ - !ruby/object:Gem::Version
194
+ version: '2.0'
195
+ description: 'Helper class for Sentry reports via `sentry-ruby` gem from Flame web
196
+ applications.
197
+
198
+ '
199
+ email:
200
+ - alex.wayfer@gmail.com
201
+ executables: []
202
+ extensions: []
203
+ extra_rdoc_files: []
204
+ files:
205
+ - CHANGELOG.md
206
+ - LICENSE.txt
207
+ - README.md
208
+ - lib/flame/sentry_context.rb
209
+ - lib/flame/sentry_context/version.rb
210
+ homepage: https://github.com/AlexWayfer/flame-sentry_context
211
+ licenses:
212
+ - MIT
213
+ metadata:
214
+ bug_tracker_uri: https://github.com/AlexWayfer/flame-sentry_context/issues
215
+ changelog_uri: https://github.com/AlexWayfer/flame-sentry_context/blob/v0.2.0/CHANGELOG.md
216
+ documentation_uri: http://www.rubydoc.info/gems/flame-sentry_context/0.2.0
217
+ homepage_uri: https://github.com/AlexWayfer/flame-sentry_context
218
+ rubygems_mfa_required: 'true'
219
+ source_code_uri: https://github.com/AlexWayfer/flame-sentry_context
220
+ wiki_uri: https://github.com/AlexWayfer/flame-sentry_context/wiki
221
+ post_install_message:
222
+ rdoc_options: []
223
+ require_paths:
224
+ - lib
225
+ required_ruby_version: !ruby/object:Gem::Requirement
226
+ requirements:
227
+ - - ">="
228
+ - !ruby/object:Gem::Version
229
+ version: '2.6'
230
+ - - "<"
231
+ - !ruby/object:Gem::Version
232
+ version: '4'
233
+ required_rubygems_version: !ruby/object:Gem::Requirement
234
+ requirements:
235
+ - - ">="
236
+ - !ruby/object:Gem::Version
237
+ version: '0'
238
+ requirements: []
239
+ rubygems_version: 3.3.7
240
+ signing_key:
241
+ specification_version: 4
242
+ summary: Helper class for Sentry reports from Flame web applications
243
+ test_files: []