marlowe 1.0.3 → 3.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 (24) hide show
  1. checksums.yaml +5 -5
  2. data/.github/workflows/ruby.yml +55 -0
  3. data/.standard.yml +4 -0
  4. data/Contributing.md +71 -0
  5. data/History.md +43 -0
  6. data/Licence.md +25 -0
  7. data/Manifest.txt +8 -4
  8. data/README.rdoc +168 -50
  9. data/Rakefile +51 -44
  10. data/lib/marlowe/config.rb +116 -0
  11. data/lib/marlowe/faraday.rb +20 -0
  12. data/lib/marlowe/formatter.rb +4 -4
  13. data/lib/marlowe/middleware.rb +50 -20
  14. data/lib/marlowe/rails.rb +20 -5
  15. data/lib/marlowe/simple_formatter.rb +3 -4
  16. data/lib/marlowe.rb +40 -5
  17. data/test/minitest_config.rb +8 -19
  18. data/test/test_marlowe.rb +90 -19
  19. data/test/test_marlowe_config.rb +109 -0
  20. metadata +127 -64
  21. data/.autotest +0 -25
  22. data/Gemfile +0 -9
  23. data/History.rdoc +0 -17
  24. data/Licence.rdoc +0 -27
metadata CHANGED
@@ -1,15 +1,15 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: marlowe
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.3
4
+ version: '3.0'
5
5
  platform: ruby
6
6
  authors:
7
7
  - Trevor Oke
8
8
  - Kinetic Cafe
9
- autorequire:
9
+ autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2016-01-15 00:00:00.000000000 Z
12
+ date: 2022-09-12 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: request_store
@@ -31,78 +31,92 @@ dependencies:
31
31
  requirements:
32
32
  - - ">="
33
33
  - !ruby/object:Gem::Version
34
- version: '0.9'
34
+ version: '1'
35
35
  - - "<"
36
36
  - !ruby/object:Gem::Version
37
- version: '2'
37
+ version: '4'
38
38
  type: :runtime
39
39
  prerelease: false
40
40
  version_requirements: !ruby/object:Gem::Requirement
41
41
  requirements:
42
42
  - - ">="
43
43
  - !ruby/object:Gem::Version
44
- version: '0.9'
44
+ version: '1'
45
45
  - - "<"
46
46
  - !ruby/object:Gem::Version
47
- version: '2'
47
+ version: '4'
48
48
  - !ruby/object:Gem::Dependency
49
49
  name: minitest
50
50
  requirement: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: '5.8'
54
+ version: '5.16'
55
55
  type: :development
56
56
  prerelease: false
57
57
  version_requirements: !ruby/object:Gem::Requirement
58
58
  requirements:
59
59
  - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: '5.8'
61
+ version: '5.16'
62
62
  - !ruby/object:Gem::Dependency
63
- name: rdoc
63
+ name: appraisal
64
64
  requirement: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: '4.0'
68
+ version: '2.1'
69
69
  type: :development
70
70
  prerelease: false
71
71
  version_requirements: !ruby/object:Gem::Requirement
72
72
  requirements:
73
73
  - - "~>"
74
74
  - !ruby/object:Gem::Version
75
- version: '4.0'
75
+ version: '2.1'
76
76
  - !ruby/object:Gem::Dependency
77
- name: rack-test
77
+ name: hoe-doofus
78
78
  requirement: !ruby/object:Gem::Requirement
79
79
  requirements:
80
80
  - - "~>"
81
81
  - !ruby/object:Gem::Version
82
- version: '0.6'
82
+ version: '1.0'
83
83
  type: :development
84
84
  prerelease: false
85
85
  version_requirements: !ruby/object:Gem::Requirement
86
86
  requirements:
87
87
  - - "~>"
88
88
  - !ruby/object:Gem::Version
89
- version: '0.6'
89
+ version: '1.0'
90
90
  - !ruby/object:Gem::Dependency
91
- name: rake
91
+ name: hoe-gemspec2
92
92
  requirement: !ruby/object:Gem::Requirement
93
93
  requirements:
94
94
  - - "~>"
95
95
  - !ruby/object:Gem::Version
96
- version: '10.0'
96
+ version: '1.1'
97
97
  type: :development
98
98
  prerelease: false
99
99
  version_requirements: !ruby/object:Gem::Requirement
100
100
  requirements:
101
101
  - - "~>"
102
102
  - !ruby/object:Gem::Version
103
- version: '10.0'
103
+ version: '1.1'
104
104
  - !ruby/object:Gem::Dependency
105
- name: hoe-doofus
105
+ name: hoe-git
106
+ requirement: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - "~>"
109
+ - !ruby/object:Gem::Version
110
+ version: '1.6'
111
+ type: :development
112
+ prerelease: false
113
+ version_requirements: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '1.6'
118
+ - !ruby/object:Gem::Dependency
119
+ name: hoe-rubygems
106
120
  requirement: !ruby/object:Gem::Requirement
107
121
  requirements:
108
122
  - - "~>"
@@ -116,164 +130,211 @@ dependencies:
116
130
  - !ruby/object:Gem::Version
117
131
  version: '1.0'
118
132
  - !ruby/object:Gem::Dependency
119
- name: hoe-gemspec2
133
+ name: minitest-autotest
120
134
  requirement: !ruby/object:Gem::Requirement
121
135
  requirements:
122
136
  - - "~>"
123
137
  - !ruby/object:Gem::Version
124
- version: '1.1'
138
+ version: '1.0'
125
139
  type: :development
126
140
  prerelease: false
127
141
  version_requirements: !ruby/object:Gem::Requirement
128
142
  requirements:
129
143
  - - "~>"
130
144
  - !ruby/object:Gem::Version
131
- version: '1.1'
145
+ version: '1.0'
132
146
  - !ruby/object:Gem::Dependency
133
- name: hoe-git
147
+ name: minitest-bonus-assertions
134
148
  requirement: !ruby/object:Gem::Requirement
135
149
  requirements:
136
150
  - - "~>"
137
151
  - !ruby/object:Gem::Version
138
- version: '1.5'
152
+ version: '3.0'
139
153
  type: :development
140
154
  prerelease: false
141
155
  version_requirements: !ruby/object:Gem::Requirement
142
156
  requirements:
143
157
  - - "~>"
144
158
  - !ruby/object:Gem::Version
145
- version: '1.5'
159
+ version: '3.0'
146
160
  - !ruby/object:Gem::Dependency
147
- name: hoe-travis
161
+ name: minitest-focus
148
162
  requirement: !ruby/object:Gem::Requirement
149
163
  requirements:
150
164
  - - "~>"
151
165
  - !ruby/object:Gem::Version
152
- version: '1.2'
166
+ version: '1.1'
153
167
  type: :development
154
168
  prerelease: false
155
169
  version_requirements: !ruby/object:Gem::Requirement
156
170
  requirements:
157
171
  - - "~>"
158
172
  - !ruby/object:Gem::Version
159
- version: '1.2'
173
+ version: '1.1'
160
174
  - !ruby/object:Gem::Dependency
161
- name: minitest-autotest
175
+ name: minitest-moar
162
176
  requirement: !ruby/object:Gem::Requirement
163
177
  requirements:
164
178
  - - "~>"
165
179
  - !ruby/object:Gem::Version
166
- version: '1.0'
180
+ version: '0.0'
167
181
  type: :development
168
182
  prerelease: false
169
183
  version_requirements: !ruby/object:Gem::Requirement
170
184
  requirements:
171
185
  - - "~>"
172
186
  - !ruby/object:Gem::Version
173
- version: '1.0'
187
+ version: '0.0'
174
188
  - !ruby/object:Gem::Dependency
175
- name: minitest-bisect
189
+ name: rack-test
176
190
  requirement: !ruby/object:Gem::Requirement
177
191
  requirements:
178
192
  - - "~>"
179
193
  - !ruby/object:Gem::Version
180
- version: '1.2'
194
+ version: '2.0'
181
195
  type: :development
182
196
  prerelease: false
183
197
  version_requirements: !ruby/object:Gem::Requirement
184
198
  requirements:
185
199
  - - "~>"
186
200
  - !ruby/object:Gem::Version
187
- version: '1.2'
201
+ version: '2.0'
188
202
  - !ruby/object:Gem::Dependency
189
- name: minitest-focus
203
+ name: rake
204
+ requirement: !ruby/object:Gem::Requirement
205
+ requirements:
206
+ - - ">="
207
+ - !ruby/object:Gem::Version
208
+ version: '10.0'
209
+ - - "<"
210
+ - !ruby/object:Gem::Version
211
+ version: '14'
212
+ type: :development
213
+ prerelease: false
214
+ version_requirements: !ruby/object:Gem::Requirement
215
+ requirements:
216
+ - - ">="
217
+ - !ruby/object:Gem::Version
218
+ version: '10.0'
219
+ - - "<"
220
+ - !ruby/object:Gem::Version
221
+ version: '14'
222
+ - !ruby/object:Gem::Dependency
223
+ name: rdoc
224
+ requirement: !ruby/object:Gem::Requirement
225
+ requirements:
226
+ - - ">="
227
+ - !ruby/object:Gem::Version
228
+ version: '4.2'
229
+ type: :development
230
+ prerelease: false
231
+ version_requirements: !ruby/object:Gem::Requirement
232
+ requirements:
233
+ - - ">="
234
+ - !ruby/object:Gem::Version
235
+ version: '4.2'
236
+ - !ruby/object:Gem::Dependency
237
+ name: standard
190
238
  requirement: !ruby/object:Gem::Requirement
191
239
  requirements:
192
240
  - - "~>"
193
241
  - !ruby/object:Gem::Version
194
- version: '1.1'
242
+ version: '1.0'
195
243
  type: :development
196
244
  prerelease: false
197
245
  version_requirements: !ruby/object:Gem::Requirement
198
246
  requirements:
199
247
  - - "~>"
200
248
  - !ruby/object:Gem::Version
201
- version: '1.1'
249
+ version: '1.0'
202
250
  - !ruby/object:Gem::Dependency
203
- name: minitest-moar
251
+ name: simplecov
204
252
  requirement: !ruby/object:Gem::Requirement
205
253
  requirements:
206
254
  - - "~>"
207
255
  - !ruby/object:Gem::Version
208
- version: '0.0'
256
+ version: '0.21'
209
257
  type: :development
210
258
  prerelease: false
211
259
  version_requirements: !ruby/object:Gem::Requirement
212
260
  requirements:
213
261
  - - "~>"
214
262
  - !ruby/object:Gem::Version
215
- version: '0.0'
263
+ version: '0.21'
216
264
  - !ruby/object:Gem::Dependency
217
- name: simplecov
265
+ name: psych
218
266
  requirement: !ruby/object:Gem::Requirement
219
267
  requirements:
220
268
  - - "~>"
221
269
  - !ruby/object:Gem::Version
222
- version: '0.7'
270
+ version: '3.1'
223
271
  type: :development
224
272
  prerelease: false
225
273
  version_requirements: !ruby/object:Gem::Requirement
226
274
  requirements:
227
275
  - - "~>"
228
276
  - !ruby/object:Gem::Version
229
- version: '0.7'
277
+ version: '3.1'
230
278
  - !ruby/object:Gem::Dependency
231
279
  name: hoe
232
280
  requirement: !ruby/object:Gem::Requirement
233
281
  requirements:
234
282
  - - "~>"
235
283
  - !ruby/object:Gem::Version
236
- version: '3.14'
284
+ version: '3.25'
237
285
  type: :development
238
286
  prerelease: false
239
287
  version_requirements: !ruby/object:Gem::Requirement
240
288
  requirements:
241
289
  - - "~>"
242
290
  - !ruby/object:Gem::Version
243
- version: '3.14'
244
- description: "{marlowe}[https://github.com/KineticCafe/marlowe] provides a correlation
245
- id \nheader for Rails and Rack applications to correlate logs for a single request
246
- \nacross multiple services."
291
+ version: '3.25'
292
+ description: |-
293
+ {Marlowe}[https://github.com/KineticCafe/marlowe] is a Rack middleware that
294
+ extracts or creates a request ID using a pre-defined header, permitting request
295
+ correlation across multiple services.
296
+
297
+ When using Rails, Marlowe automatically adds itself to the middleware before
298
+ <tt>Rails::Rack::Logger</tt>.
299
+
300
+ As of Marlowe 3.0, a Faraday middleware is provided (<tt>require 'marlowe/faraday'</tt>).
247
301
  email:
248
302
  - toke@kineticcafe.com
249
303
  - dev@kineticcafe.com
250
304
  executables: []
251
305
  extensions: []
252
306
  extra_rdoc_files:
253
- - History.rdoc
254
- - Licence.rdoc
307
+ - Contributing.md
308
+ - History.md
309
+ - Licence.md
255
310
  - Manifest.txt
256
311
  - README.rdoc
257
312
  files:
258
- - ".autotest"
259
- - Gemfile
260
- - History.rdoc
261
- - Licence.rdoc
313
+ - ".github/workflows/ruby.yml"
314
+ - ".standard.yml"
315
+ - Contributing.md
316
+ - History.md
317
+ - Licence.md
262
318
  - Manifest.txt
263
319
  - README.rdoc
264
320
  - Rakefile
265
321
  - lib/marlowe.rb
322
+ - lib/marlowe/config.rb
323
+ - lib/marlowe/faraday.rb
266
324
  - lib/marlowe/formatter.rb
267
325
  - lib/marlowe/middleware.rb
268
326
  - lib/marlowe/rails.rb
269
327
  - lib/marlowe/simple_formatter.rb
270
328
  - test/minitest_config.rb
271
329
  - test/test_marlowe.rb
272
- homepage:
330
+ - test/test_marlowe_config.rb
331
+ homepage: https://github.com/KineticCafe/marlowe/
273
332
  licenses:
274
333
  - MIT
275
- metadata: {}
276
- post_install_message:
334
+ metadata:
335
+ source_code_uri: https://github.com/KineticCafe/marlowe/
336
+ documentation_uri: http://www.rubydoc.info/github/KineticCafe/marlowe/master
337
+ post_install_message:
277
338
  rdoc_options:
278
339
  - "--main"
279
340
  - README.rdoc
@@ -283,18 +344,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
283
344
  requirements:
284
345
  - - ">="
285
346
  - !ruby/object:Gem::Version
286
- version: '0'
347
+ version: '2.0'
348
+ - - "<"
349
+ - !ruby/object:Gem::Version
350
+ version: '4'
287
351
  required_rubygems_version: !ruby/object:Gem::Requirement
288
352
  requirements:
289
353
  - - ">="
290
354
  - !ruby/object:Gem::Version
291
355
  version: '0'
292
356
  requirements: []
293
- rubyforge_project:
294
- rubygems_version: 2.4.8
295
- signing_key:
357
+ rubygems_version: 3.3.7
358
+ signing_key:
296
359
  specification_version: 4
297
- summary: "{marlowe}[https://github.com/KineticCafe/marlowe] provides a correlation
298
- id header for Rails and Rack applications to correlate logs for a single request
299
- \ across multiple services."
360
+ summary: "{Marlowe}[https://github.com/KineticCafe/marlowe] is a Rack middleware that
361
+ extracts or creates a request ID using a pre-defined header, permitting request
362
+ correlation across multiple services"
300
363
  test_files: []
data/.autotest DELETED
@@ -1,25 +0,0 @@
1
- # -*- ruby -*-
2
-
3
- require "autotest/restart"
4
-
5
- # Autotest.add_hook :initialize do |at|
6
- # at.testlib = "minitest/unit"
7
- #
8
- # at.extra_files << "../some/external/dependency.rb"
9
- #
10
- # at.libs << ":../some/external"
11
- #
12
- # at.add_exception "vendor"
13
- #
14
- # at.add_mapping(/dependency.rb/) do |f, _|
15
- # at.files_matching(/test_.*rb$/)
16
- # end
17
- #
18
- # %w(TestA TestB).each do |klass|
19
- # at.extra_class_map[klass] = "test/test_misc.rb"
20
- # end
21
- # end
22
-
23
- # Autotest.add_hook :run_command do |at|
24
- # system "rake build"
25
- # end
data/Gemfile DELETED
@@ -1,9 +0,0 @@
1
- # -*- ruby -*-
2
-
3
- # NOTE: This file is present to keep Travis CI happy. Edits to it will not
4
- # be accepted.
5
-
6
- source 'https://rubygems.org/'
7
- gemspec
8
-
9
- # vim: filetype=ruby
data/History.rdoc DELETED
@@ -1,17 +0,0 @@
1
- === 1.0.3 / 2016-01-15
2
-
3
- * Update Readme example of using available formatted subclass
4
- * Make the correlation header name configurable
5
-
6
- === 1.0.2 / 2015-11-24
7
-
8
- * Add documentation for using Marlowe with {lograge}[https://github.com/roidrage/lograge]
9
-
10
- === 1.0.1 / 2015-10-20
11
-
12
- * Update gemspec with homepage
13
- * Update Rakefile
14
-
15
- === 1.0.0 / 2015-10-16
16
-
17
- * Initial Commit
data/Licence.rdoc DELETED
@@ -1,27 +0,0 @@
1
- cence
2
-
3
- This software is available under an MIT-style licence.
4
-
5
- * Copyright 2015 Kinetic Cafe
6
-
7
- Permission is hereby granted, free of charge, to any person obtaining a copy of
8
- this software and associated documentation files (the "Software"), to deal in
9
- the Software without restriction, including without limitation the rights to
10
- use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
11
- of the Software, and to permit persons to whom the Software is furnished to do
12
- so, subject to the following conditions:
13
-
14
- * The names of its contributors may not be used to endorse or promote
15
- products derived from this software without specific prior written
16
- permission.
17
-
18
- The above copyright notice and this permission notice shall be included in all
19
- copies or substantial portions of the Software.
20
-
21
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27
- SOFTWARE.