restify 2.0.1 → 2.0.2

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 (70) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/lib/restify/relation.rb +6 -2
  4. data/lib/restify/version.rb +1 -1
  5. data/spec/restify/relation_spec.rb +54 -1
  6. data/vendor/bundle/ruby/3.4.0/bundler/gems/my-rubocop-3bcd2110ca87/LICENSE +21 -0
  7. data/vendor/bundle/ruby/3.4.0/bundler/gems/my-rubocop-3bcd2110ca87/README.md +23 -0
  8. data/vendor/bundle/ruby/3.4.0/gems/activesupport-8.0.2/CHANGELOG.md +255 -0
  9. data/vendor/bundle/ruby/3.4.0/gems/activesupport-8.0.2/MIT-LICENSE +20 -0
  10. data/vendor/bundle/ruby/3.4.0/gems/activesupport-8.0.2/README.rdoc +40 -0
  11. data/vendor/bundle/ruby/3.4.0/gems/addressable-2.8.7/CHANGELOG.md +301 -0
  12. data/vendor/bundle/ruby/3.4.0/gems/addressable-2.8.7/LICENSE.txt +202 -0
  13. data/vendor/bundle/ruby/3.4.0/gems/addressable-2.8.7/README.md +121 -0
  14. data/vendor/bundle/ruby/3.4.0/gems/base64-0.2.0/LICENSE.txt +22 -0
  15. data/vendor/bundle/ruby/3.4.0/gems/base64-0.2.0/README.md +48 -0
  16. data/vendor/bundle/ruby/3.4.0/gems/benchmark-0.4.0/README.md +138 -0
  17. data/vendor/bundle/ruby/3.4.0/gems/bigdecimal-3.1.9/LICENSE +56 -0
  18. data/vendor/bundle/ruby/3.4.0/gems/concurrent-ruby-1.3.5/CHANGELOG.md +603 -0
  19. data/vendor/bundle/ruby/3.4.0/gems/concurrent-ruby-1.3.5/LICENSE.txt +21 -0
  20. data/vendor/bundle/ruby/3.4.0/gems/concurrent-ruby-1.3.5/README.md +407 -0
  21. data/vendor/bundle/ruby/3.4.0/gems/connection_pool-2.5.3/LICENSE +20 -0
  22. data/vendor/bundle/ruby/3.4.0/gems/connection_pool-2.5.3/README.md +167 -0
  23. data/vendor/bundle/ruby/3.4.0/gems/drb-2.2.1/LICENSE.txt +22 -0
  24. data/vendor/bundle/ruby/3.4.0/gems/ethon-0.16.0/CHANGELOG.md +375 -0
  25. data/vendor/bundle/ruby/3.4.0/gems/ethon-0.16.0/LICENSE +20 -0
  26. data/vendor/bundle/ruby/3.4.0/gems/ethon-0.16.0/README.md +118 -0
  27. data/vendor/bundle/ruby/3.4.0/gems/ffi-1.17.2-x86_64-linux-gnu/CHANGELOG.md +473 -0
  28. data/vendor/bundle/ruby/3.4.0/gems/ffi-1.17.2-x86_64-linux-gnu/LICENSE +24 -0
  29. data/vendor/bundle/ruby/3.4.0/gems/ffi-1.17.2-x86_64-linux-gnu/LICENSE.SPECS +22 -0
  30. data/vendor/bundle/ruby/3.4.0/gems/ffi-1.17.2-x86_64-linux-gnu/README.md +137 -0
  31. data/vendor/bundle/ruby/3.4.0/gems/hitimes-3.1.0/LICENSE.txt +16 -0
  32. data/vendor/bundle/ruby/3.4.0/gems/hitimes-3.1.0/README.md +187 -0
  33. data/vendor/bundle/ruby/3.4.0/gems/i18n-1.14.7/MIT-LICENSE +20 -0
  34. data/vendor/bundle/ruby/3.4.0/gems/i18n-1.14.7/README.md +127 -0
  35. data/vendor/bundle/ruby/3.4.0/gems/little-plugger-1.1.4/README.rdoc +53 -0
  36. data/vendor/bundle/ruby/3.4.0/gems/logger-1.7.0/README.md +104 -0
  37. data/vendor/bundle/ruby/3.4.0/gems/logging-2.4.0/LICENSE +22 -0
  38. data/vendor/bundle/ruby/3.4.0/gems/logging-2.4.0/README.md +140 -0
  39. data/vendor/bundle/ruby/3.4.0/gems/minitest-5.25.5/README.rdoc +842 -0
  40. data/vendor/bundle/ruby/3.4.0/gems/msgpack-1.8.0/ChangeLog +368 -0
  41. data/vendor/bundle/ruby/3.4.0/gems/msgpack-1.8.0/LICENSE +177 -0
  42. data/vendor/bundle/ruby/3.4.0/gems/msgpack-1.8.0/README.md +302 -0
  43. data/vendor/bundle/ruby/3.4.0/gems/multi_json-1.15.0/CHANGELOG.md +275 -0
  44. data/vendor/bundle/ruby/3.4.0/gems/multi_json-1.15.0/LICENSE.md +20 -0
  45. data/vendor/bundle/ruby/3.4.0/gems/multi_json-1.15.0/README.md +121 -0
  46. data/vendor/bundle/ruby/3.4.0/gems/opentelemetry-api-1.5.0/CHANGELOG.md +193 -0
  47. data/vendor/bundle/ruby/3.4.0/gems/opentelemetry-api-1.5.0/LICENSE +201 -0
  48. data/vendor/bundle/ruby/3.4.0/gems/opentelemetry-api-1.5.0/README.md +68 -0
  49. data/vendor/bundle/ruby/3.4.0/gems/opentelemetry-common-0.22.0/CHANGELOG.md +98 -0
  50. data/vendor/bundle/ruby/3.4.0/gems/opentelemetry-common-0.22.0/LICENSE +201 -0
  51. data/vendor/bundle/ruby/3.4.0/gems/opentelemetry-common-0.22.0/README.md +62 -0
  52. data/vendor/bundle/ruby/3.4.0/gems/public_suffix-6.0.2/CHANGELOG.md +498 -0
  53. data/vendor/bundle/ruby/3.4.0/gems/public_suffix-6.0.2/LICENSE.txt +22 -0
  54. data/vendor/bundle/ruby/3.4.0/gems/public_suffix-6.0.2/README.md +222 -0
  55. data/vendor/bundle/ruby/3.4.0/gems/rack-3.1.15/CHANGELOG.md +1146 -0
  56. data/vendor/bundle/ruby/3.4.0/gems/rack-3.1.15/MIT-LICENSE +20 -0
  57. data/vendor/bundle/ruby/3.4.0/gems/rack-3.1.15/README.md +355 -0
  58. data/vendor/bundle/ruby/3.4.0/gems/rake-13.2.1/MIT-LICENSE +21 -0
  59. data/vendor/bundle/ruby/3.4.0/gems/rake-13.2.1/README.rdoc +155 -0
  60. data/vendor/bundle/ruby/3.4.0/gems/rake-release-1.3.0/LICENSE +21 -0
  61. data/vendor/bundle/ruby/3.4.0/gems/rake-release-1.3.0/README.md +107 -0
  62. data/vendor/bundle/ruby/3.4.0/gems/securerandom-0.4.1/README.md +72 -0
  63. data/vendor/bundle/ruby/3.4.0/gems/typhoeus-1.4.1/CHANGELOG.md +410 -0
  64. data/vendor/bundle/ruby/3.4.0/gems/typhoeus-1.4.1/LICENSE +22 -0
  65. data/vendor/bundle/ruby/3.4.0/gems/typhoeus-1.4.1/README.md +588 -0
  66. data/vendor/bundle/ruby/3.4.0/gems/tzinfo-2.0.6/LICENSE +19 -0
  67. data/vendor/bundle/ruby/3.4.0/gems/tzinfo-2.0.6/README.md +406 -0
  68. data/vendor/bundle/ruby/3.4.0/gems/uri-1.0.3/README.md +55 -0
  69. metadata +66 -4
  70. data/doc/file.README.html +0 -192
@@ -0,0 +1,20 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (C) 2007-2021 Leah Neukirchen <http://leahneukirchen.org/infopage.html>
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
7
+ deal in the Software without restriction, including without limitation the
8
+ rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9
+ sell 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
18
+ THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,355 @@
1
+ # ![Rack](contrib/logo.webp)
2
+
3
+ Rack provides a minimal, modular, and adaptable interface for developing web
4
+ applications in Ruby. By wrapping HTTP requests and responses in the simplest
5
+ way possible, it unifies and distills the bridge between web servers, web
6
+ frameworks, and web application into a single method call.
7
+
8
+ The exact details of this are described in the [Rack Specification], which all
9
+ Rack applications should conform to.
10
+
11
+ ## Version support
12
+
13
+ | Version | Support |
14
+ |----------|------------------------------------|
15
+ | 3.0.x | Bug fixes and security patches. |
16
+ | 2.2.x | Security patches only. |
17
+ | <= 2.1.x | End of support. |
18
+
19
+ Please see the [Security Policy] for more information.
20
+
21
+ ## Rack 3.0
22
+
23
+ This is the latest version of Rack. It contains API improvements but also some
24
+ breaking changes. Please check the [Upgrade Guide](UPGRADE-GUIDE.md) for more
25
+ details about migrating servers, middlewares and applications designed for Rack 2
26
+ to Rack 3. For detailed information on specific changes, check the [Change Log](CHANGELOG.md).
27
+
28
+ ## Rack 2.2
29
+
30
+ This version of Rack is receiving security patches only, and effort should be
31
+ made to move to Rack 3.
32
+
33
+ Starting in Ruby 3.4 the `base64` dependency will no longer be a default gem,
34
+ and may cause a warning or error about `base64` being missing. To correct this,
35
+ add `base64` as a dependency to your project.
36
+
37
+ ## Installation
38
+
39
+ Add the rack gem to your application bundle, or follow the instructions provided
40
+ by a [supported web framework](#supported-web-frameworks):
41
+
42
+ ```bash
43
+ # Install it generally:
44
+ $ gem install rack
45
+
46
+ # or, add it to your current application gemfile:
47
+ $ bundle add rack
48
+ ```
49
+
50
+ If you need features from `Rack::Session` or `bin/rackup` please add those gems separately.
51
+
52
+ ```bash
53
+ $ gem install rack-session rackup
54
+ ```
55
+
56
+ ## Usage
57
+
58
+ Create a file called `config.ru` with the following contents:
59
+
60
+ ```ruby
61
+ run do |env|
62
+ [200, {}, ["Hello World"]]
63
+ end
64
+ ```
65
+
66
+ Run this using the rackup gem or another [supported web
67
+ server](#supported-web-servers).
68
+
69
+ ```bash
70
+ $ gem install rackup
71
+ $ rackup
72
+ $ curl http://localhost:9292
73
+ Hello World
74
+ ```
75
+
76
+ ## Supported web servers
77
+
78
+ Rack is supported by a wide range of servers, including:
79
+
80
+ * [Agoo](https://github.com/ohler55/agoo)
81
+ * [Falcon](https://github.com/socketry/falcon)
82
+ * [Iodine](https://github.com/boazsegev/iodine)
83
+ * [NGINX Unit](https://unit.nginx.org/)
84
+ * [Phusion Passenger](https://www.phusionpassenger.com/) (which is mod_rack for
85
+ Apache and for nginx)
86
+ * [Puma](https://puma.io/)
87
+ * [Thin](https://github.com/macournoyer/thin)
88
+ * [Unicorn](https://yhbt.net/unicorn/)
89
+ * [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/)
90
+ * [Lamby](https://lamby.custominktech.com) (for AWS Lambda)
91
+
92
+ You will need to consult the server documentation to find out what features and
93
+ limitations they may have. In general, any valid Rack app will run the same on
94
+ all these servers, without changing anything.
95
+
96
+ ### Rackup
97
+
98
+ Rack provides a separate gem, [rackup](https://github.com/rack/rackup) which is
99
+ a generic interface for running a Rack application on supported servers, which
100
+ include `WEBRick`, `Puma`, `Falcon` and others.
101
+
102
+ ## Supported web frameworks
103
+
104
+ These frameworks and many others support the [Rack Specification]:
105
+
106
+ * [Camping](https://github.com/camping/camping)
107
+ * [Hanami](https://hanamirb.org/)
108
+ * [Ramaze](https://github.com/ramaze/ramaze)
109
+ * [Padrino](https://padrinorb.com/)
110
+ * [Roda](https://github.com/jeremyevans/roda)
111
+ * [Ruby on Rails](https://rubyonrails.org/)
112
+ * [Rum](https://github.com/leahneukirchen/rum)
113
+ * [Sinatra](https://sinatrarb.com/)
114
+ * [Utopia](https://github.com/socketry/utopia)
115
+ * [WABuR](https://github.com/ohler55/wabur)
116
+
117
+ ## Available middleware shipped with Rack
118
+
119
+ Between the server and the framework, Rack can be customized to your
120
+ applications needs using middleware. Rack itself ships with the following
121
+ middleware:
122
+
123
+ * `Rack::CommonLogger` for creating Apache-style logfiles.
124
+ * `Rack::ConditionalGet` for returning [Not
125
+ Modified](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/304)
126
+ responses when the response has not changed.
127
+ * `Rack::Config` for modifying the environment before processing the request.
128
+ * `Rack::ContentLength` for setting a `content-length` header based on body
129
+ size.
130
+ * `Rack::ContentType` for setting a default `content-type` header for responses.
131
+ * `Rack::Deflater` for compressing responses with gzip.
132
+ * `Rack::ETag` for setting `etag` header on bodies that can be buffered.
133
+ * `Rack::Events` for providing easy hooks when a request is received and when
134
+ the response is sent.
135
+ * `Rack::Files` for serving static files.
136
+ * `Rack::Head` for returning an empty body for HEAD requests.
137
+ * `Rack::Lint` for checking conformance to the [Rack Specification].
138
+ * `Rack::Lock` for serializing requests using a mutex.
139
+ * `Rack::Logger` for setting a logger to handle logging errors.
140
+ * `Rack::MethodOverride` for modifying the request method based on a submitted
141
+ parameter.
142
+ * `Rack::Recursive` for including data from other paths in the application, and
143
+ for performing internal redirects.
144
+ * `Rack::Reloader` for reloading files if they have been modified.
145
+ * `Rack::Runtime` for including a response header with the time taken to process
146
+ the request.
147
+ * `Rack::Sendfile` for working with web servers that can use optimized file
148
+ serving for file system paths.
149
+ * `Rack::ShowException` for catching unhandled exceptions and presenting them in
150
+ a nice and helpful way with clickable backtrace.
151
+ * `Rack::ShowStatus` for using nice error pages for empty client error
152
+ responses.
153
+ * `Rack::Static` for more configurable serving of static files.
154
+ * `Rack::TempfileReaper` for removing temporary files creating during a request.
155
+
156
+ All these components use the same interface, which is described in detail in the
157
+ [Rack Specification]. These optional components can be used in any way you wish.
158
+
159
+ ### Convenience interfaces
160
+
161
+ If you want to develop outside of existing frameworks, implement your own ones,
162
+ or develop middleware, Rack provides many helpers to create Rack applications
163
+ quickly and without doing the same web stuff all over:
164
+
165
+ * `Rack::Request` which also provides query string parsing and multipart
166
+ handling.
167
+ * `Rack::Response` for convenient generation of HTTP replies and cookie
168
+ handling.
169
+ * `Rack::MockRequest` and `Rack::MockResponse` for efficient and quick testing
170
+ of Rack application without real HTTP round-trips.
171
+ * `Rack::Cascade` for trying additional Rack applications if an application
172
+ returns a not found or method not supported response.
173
+ * `Rack::Directory` for serving files under a given directory, with directory
174
+ indexes.
175
+ * `Rack::MediaType` for parsing content-type headers.
176
+ * `Rack::Mime` for determining content-type based on file extension.
177
+ * `Rack::RewindableInput` for making any IO object rewindable, using a temporary
178
+ file buffer.
179
+ * `Rack::URLMap` to route to multiple applications inside the same process.
180
+
181
+ ## Configuration
182
+
183
+ Rack exposes several configuration parameters to control various features of the
184
+ implementation.
185
+
186
+ ### `RACK_QUERY_PARSER_BYTESIZE_LIMIT`
187
+
188
+ This environment variable sets the default for the maximum query string bytesize
189
+ that `Rack::QueryParser` will attempt to parse. Attempts to use a query string
190
+ that exceeds this number of bytes will result in a
191
+ `Rack::QueryParser::QueryLimitError` exception. If this enviroment variable is
192
+ provided, it must be an integer, or `Rack::QueryParser` will raise an exception.
193
+
194
+ The default limit can be overridden on a per-`Rack::QueryParser` basis using
195
+ the `bytesize_limit` keyword argument when creating the `Rack::QueryParser`.
196
+
197
+ ### `RACK_QUERY_PARSER_PARAMS_LIMIT`
198
+
199
+ This environment variable sets the default for the maximum number of query
200
+ parameters that `Rack::QueryParser` will attempt to parse. Attempts to use a
201
+ query string with more than this many query parameters will result in a
202
+ `Rack::QueryParser::QueryLimitError` exception. If this enviroment variable is
203
+ provided, it must be an integer, or `Rack::QueryParser` will raise an exception.
204
+
205
+ The default limit can be overridden on a per-`Rack::QueryParser` basis using
206
+ the `params_limit` keyword argument when creating the `Rack::QueryParser`.
207
+
208
+ This is implemented by counting the number of parameter separators in the
209
+ query string, before attempting parsing, so if the same parameter key is
210
+ used multiple times in the query, each counts as a separate parameter for
211
+ this check.
212
+
213
+ ### `param_depth_limit`
214
+
215
+ ```ruby
216
+ Rack::Utils.param_depth_limit = 32 # default
217
+ ```
218
+
219
+ The maximum amount of nesting allowed in parameters. For example, if set to 3,
220
+ this query string would be allowed:
221
+
222
+ ```
223
+ ?a[b][c]=d
224
+ ```
225
+
226
+ but this query string would not be allowed:
227
+
228
+ ```
229
+ ?a[b][c][d]=e
230
+ ```
231
+
232
+ Limiting the depth prevents a possible stack overflow when parsing parameters.
233
+
234
+ ### `multipart_file_limit`
235
+
236
+ ```ruby
237
+ Rack::Utils.multipart_file_limit = 128 # default
238
+ ```
239
+
240
+ The maximum number of parts with a filename a request can contain. Accepting
241
+ too many parts can lead to the server running out of file handles.
242
+
243
+ The default is 128, which means that a single request can't upload more than 128
244
+ files at once. Set to 0 for no limit.
245
+
246
+ Can also be set via the `RACK_MULTIPART_FILE_LIMIT` environment variable.
247
+
248
+ (This is also aliased as `multipart_part_limit` and `RACK_MULTIPART_PART_LIMIT` for compatibility)
249
+
250
+
251
+ ### `multipart_total_part_limit`
252
+
253
+ The maximum total number of parts a request can contain of any type, including
254
+ both file and non-file form fields.
255
+
256
+ The default is 4096, which means that a single request can't contain more than
257
+ 4096 parts.
258
+
259
+ Set to 0 for no limit.
260
+
261
+ Can also be set via the `RACK_MULTIPART_TOTAL_PART_LIMIT` environment variable.
262
+
263
+
264
+ ## Changelog
265
+
266
+ See [CHANGELOG.md](CHANGELOG.md).
267
+
268
+ ## Contributing
269
+
270
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for specific details about how to make a
271
+ contribution to Rack.
272
+
273
+ Please post bugs, suggestions and patches to [GitHub
274
+ Issues](https://github.com/rack/rack/issues).
275
+
276
+ Please check our [Security Policy](https://github.com/rack/rack/security/policy)
277
+ for responsible disclosure and security bug reporting process. Due to wide usage
278
+ of the library, it is strongly preferred that we manage timing in order to
279
+ provide viable patches at the time of disclosure. Your assistance in this matter
280
+ is greatly appreciated.
281
+
282
+ ## See Also
283
+
284
+ ### `rack-contrib`
285
+
286
+ The plethora of useful middleware created the need for a project that collects
287
+ fresh Rack middleware. `rack-contrib` includes a variety of add-on components
288
+ for Rack and it is easy to contribute new modules.
289
+
290
+ * https://github.com/rack/rack-contrib
291
+
292
+ ### `rack-session`
293
+
294
+ Provides convenient session management for Rack.
295
+
296
+ * https://github.com/rack/rack-session
297
+
298
+ ## Thanks
299
+
300
+ The Rack Core Team, consisting of
301
+
302
+ * Aaron Patterson [tenderlove](https://github.com/tenderlove)
303
+ * Samuel Williams [ioquatix](https://github.com/ioquatix)
304
+ * Jeremy Evans [jeremyevans](https://github.com/jeremyevans)
305
+ * Eileen Uchitelle [eileencodes](https://github.com/eileencodes)
306
+ * Matthew Draper [matthewd](https://github.com/matthewd)
307
+ * Rafael França [rafaelfranca](https://github.com/rafaelfranca)
308
+
309
+ and the Rack Alumni
310
+
311
+ * Ryan Tomayko [rtomayko](https://github.com/rtomayko)
312
+ * Scytrin dai Kinthra [scytrin](https://github.com/scytrin)
313
+ * Leah Neukirchen [leahneukirchen](https://github.com/leahneukirchen)
314
+ * James Tucker [raggi](https://github.com/raggi)
315
+ * Josh Peek [josh](https://github.com/josh)
316
+ * José Valim [josevalim](https://github.com/josevalim)
317
+ * Michael Fellinger [manveru](https://github.com/manveru)
318
+ * Santiago Pastorino [spastorino](https://github.com/spastorino)
319
+ * Konstantin Haase [rkh](https://github.com/rkh)
320
+
321
+ would like to thank:
322
+
323
+ * Adrian Madrid, for the LiteSpeed handler.
324
+ * Christoffer Sawicki, for the first Rails adapter and `Rack::Deflater`.
325
+ * Tim Fletcher, for the HTTP authentication code.
326
+ * Luc Heinrich for the Cookie sessions, the static file handler and bugfixes.
327
+ * Armin Ronacher, for the logo and racktools.
328
+ * Alex Beregszaszi, Alexander Kahn, Anil Wadghule, Aredridel, Ben Alpert, Dan
329
+ Kubb, Daniel Roethlisberger, Matt Todd, Tom Robinson, Phil Hagelberg, S. Brent
330
+ Faulkner, Bosko Milekic, Daniel Rodríguez Troitiño, Genki Takiuchi, Geoffrey
331
+ Grosenbach, Julien Sanchez, Kamal Fariz Mahyuddin, Masayoshi Takahashi,
332
+ Patrick Aljordm, Mig, Kazuhiro Nishiyama, Jon Bardin, Konstantin Haase, Larry
333
+ Siden, Matias Korhonen, Sam Ruby, Simon Chiang, Tim Connor, Timur Batyrshin,
334
+ and Zach Brock for bug fixing and other improvements.
335
+ * Eric Wong, Hongli Lai, Jeremy Kemper for their continuous support and API
336
+ improvements.
337
+ * Yehuda Katz and Carl Lerche for refactoring rackup.
338
+ * Brian Candler, for `Rack::ContentType`.
339
+ * Graham Batty, for improved handler loading.
340
+ * Stephen Bannasch, for bug reports and documentation.
341
+ * Gary Wright, for proposing a better `Rack::Response` interface.
342
+ * Jonathan Buch, for improvements regarding `Rack::Response`.
343
+ * Armin Röhrl, for tracking down bugs in the Cookie generator.
344
+ * Alexander Kellett for testing the Gem and reviewing the announcement.
345
+ * Marcus Rückert, for help with configuring and debugging lighttpd.
346
+ * The WSGI team for the well-done and documented work they've done and Rack
347
+ builds up on.
348
+ * All bug reporters and patch contributors not mentioned above.
349
+
350
+ ## License
351
+
352
+ Rack is released under the [MIT License](MIT-LICENSE).
353
+
354
+ [Rack Specification]: SPEC.rdoc
355
+ [Security Policy]: SECURITY.md
@@ -0,0 +1,21 @@
1
+ Copyright (c) Jim Weirich
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21
+
@@ -0,0 +1,155 @@
1
+ = RAKE -- Ruby Make
2
+
3
+ home :: https://github.com/ruby/rake
4
+ bugs :: https://github.com/ruby/rake/issues
5
+ docs :: https://ruby.github.io/rake
6
+
7
+ == Description
8
+
9
+ Rake is a Make-like program implemented in Ruby. Tasks and dependencies are
10
+ specified in standard Ruby syntax.
11
+
12
+ Rake has the following features:
13
+
14
+ * Rakefiles (rake's version of Makefiles) are completely defined in
15
+ standard Ruby syntax. No XML files to edit. No quirky Makefile
16
+ syntax to worry about (is that a tab or a space?)
17
+
18
+ * Users can specify tasks with prerequisites.
19
+
20
+ * Rake supports rule patterns to synthesize implicit tasks.
21
+
22
+ * Flexible FileLists that act like arrays but know about manipulating
23
+ file names and paths.
24
+
25
+ * A library of prepackaged tasks to make building rakefiles easier. For example,
26
+ tasks for building tarballs. (Formerly
27
+ tasks for building RDoc, Gems, and publishing to FTP were included in rake but they're now
28
+ available in RDoc, RubyGems, and rake-contrib respectively.)
29
+
30
+ * Supports parallel execution of tasks.
31
+
32
+ == Installation
33
+
34
+ === Gem Installation
35
+
36
+ Download and install rake with the following.
37
+
38
+ gem install rake
39
+
40
+ == Usage
41
+
42
+ === Simple Example
43
+
44
+ First, you must write a "Rakefile" file which contains the build rules. Here's
45
+ a simple example:
46
+
47
+ task default: %w[test]
48
+
49
+ task :test do
50
+ ruby "test/unittest.rb"
51
+ end
52
+
53
+ This Rakefile has two tasks:
54
+
55
+ * A task named "test", which -- upon invocation -- will run a unit test file
56
+ in Ruby.
57
+ * A task named "default". This task does nothing by itself, but it has exactly
58
+ one dependency, namely the "test" task. Invoking the "default" task will
59
+ cause Rake to invoke the "test" task as well.
60
+
61
+ Running the "rake" command without any options will cause it to run the
62
+ "default" task in the Rakefile:
63
+
64
+ % ls
65
+ Rakefile test/
66
+ % rake
67
+ (in /home/some_user/Projects/rake)
68
+ ruby test/unittest.rb
69
+ ....unit test output here...
70
+
71
+ Type "rake --help" for all available options.
72
+
73
+ == Resources
74
+
75
+ === Rake Information
76
+
77
+ * {Rake command-line}[link:doc/command_line_usage.rdoc]
78
+ * {Writing Rakefiles}[link:doc/rakefile.rdoc]
79
+ * The original {Rake announcement}[link:doc/rational.rdoc]
80
+ * Rake {glossary}[link:doc/glossary.rdoc]
81
+
82
+ === Presentations and Articles about Rake
83
+
84
+ * Avdi Grimm's rake series:
85
+ 1. {Rake Basics}[https://avdi.codes/rake-part-1-basics/]
86
+ 2. {Rake File Lists}[https://avdi.codes/rake-part-2-file-lists-2/]
87
+ 3. {Rake Rules}[https://avdi.codes/rake-part-3-rules/]
88
+ 4. {Rake Pathmap}[https://avdi.codes/rake-part-4-pathmap/]
89
+ 5. {File Operations}[https://avdi.codes/rake-part-5-file-operations/]
90
+ 6. {Clean and Clobber}[https://avdi.codes/rake-part-6-clean-and-clobber/]
91
+ 7. {MultiTask}[https://avdi.codes/rake-part-7-multitask/]
92
+ * {Jim Weirich's 2003 RubyConf presentation}[https://web.archive.org/web/20140221123354/http://onestepback.org/articles/buildingwithrake/]
93
+ * Martin Fowler's article on Rake: https://martinfowler.com/articles/rake.html
94
+
95
+ == Other Make Re-envisionings ...
96
+
97
+ Rake is a late entry in the make replacement field. Here are links to
98
+ other projects with similar (and not so similar) goals.
99
+
100
+ * https://directory.fsf.org/wiki/Bras -- Bras, one of earliest
101
+ implementations of "make in a scripting language".
102
+ * http://www.a-a-p.org -- Make in Python
103
+ * https://ant.apache.org -- The Ant project
104
+ * https://search.cpan.org/search?query=PerlBuildSystem -- The Perl Build System
105
+ * https://www.rubydoc.info/gems/rant/0.5.7/frames -- Rant, another Ruby make tool.
106
+
107
+ == Credits
108
+
109
+ [<b>Jim Weirich</b>] Who originally created Rake.
110
+
111
+ [<b>Ryan Dlugosz</b>] For the initial conversation that sparked Rake.
112
+
113
+ [<b>Nobuyoshi Nakada <nobu@ruby-lang.org></b>] For the initial patch for rule support.
114
+
115
+ [<b>Tilman Sauerbeck <tilman@code-monkey.de></b>] For the recursive rule patch.
116
+
117
+ [<b>Eric Hodel</b>] For aid in maintaining rake.
118
+
119
+ [<b>Hiroshi SHIBATA</b>] Maintainer of Rake 10 and later
120
+
121
+ == License
122
+
123
+ Rake is available under an MIT-style license.
124
+
125
+ :include: MIT-LICENSE
126
+
127
+ ---
128
+
129
+ = Other stuff
130
+
131
+ Author:: Jim Weirich <jim.weirich@gmail.com>
132
+ Requires:: Ruby 2.0.0 or later
133
+ License:: Copyright Jim Weirich.
134
+ Released under an MIT-style license. See the MIT-LICENSE
135
+ file included in the distribution.
136
+
137
+ == Warranty
138
+
139
+ This software is provided "as is" and without any express or implied
140
+ warranties, including, without limitation, the implied warranties of
141
+ merchantability and fitness for a particular purpose.
142
+
143
+ == Historical
144
+
145
+ Rake was originally created by Jim Weirich, who unfortunately passed away in
146
+ February 2014. This repository was originally hosted at
147
+ {github.com/jimweirich/rake}[https://github.com/jimweirich/rake/], however
148
+ with his passing, has been moved to {ruby/rake}[https://github.com/ruby/rake].
149
+
150
+ You can view Jim's last commit here:
151
+ https://github.com/jimweirich/rake/tree/336559f28f55bce418e2ebcc0a57548dcbac4025
152
+
153
+ You can {read more about Jim}[https://en.wikipedia.org/wiki/Jim_Weirich] at Wikipedia.
154
+
155
+ Thank you for this great tool, Jim. We'll remember you.
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Jan Graichen
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 all
13
+ 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 THE
21
+ SOFTWARE.
@@ -0,0 +1,107 @@
1
+ # Rake::Release
2
+
3
+ Customized fork for bundlers gem task helpers.
4
+
5
+ Automatically detects multiple gemspecs and protect from releasing code not matching git version tag.
6
+
7
+ ## Installation
8
+
9
+ Add this line to your Gemfile:
10
+
11
+ ```ruby
12
+ gem 'rake-release'
13
+ ```
14
+
15
+ ## Usage
16
+
17
+ Simply require in Rakefile:
18
+
19
+ ```ruby
20
+ require 'rake/release'
21
+ ```
22
+
23
+ Check with `rake -D`:
24
+
25
+ ```
26
+ rake build
27
+ Build rake-release-0.2.1.gem.gem into the pkg directory.
28
+
29
+ rake install
30
+ Build and install rake-release-0.2.1.gem into system gems.
31
+
32
+ rake install:local
33
+ Build and install rake-release-0.2.1.gem into system gems without network access.
34
+
35
+ rake release[remote]
36
+ Create and push tag v0.2.1, build gem and publish to rubygems.org.
37
+ ```
38
+
39
+ ### With multiple gemspecs
40
+
41
+ ```
42
+ > rake -T
43
+ rake lib-alpha:build # Build lib-alpha-0.6.0.gem.gem into the pkg directory
44
+ rake lib-alpha:install # Build and install lib-alpha-0.6.0.gem into system gems
45
+ rake lib-alpha:install:local # Build and install lib-alpha-0.6.0.gem into system gems without network access
46
+ rake lib-alpha:release[remote] # Create and push tag v0.6.0, build gem and publish to rubygems.org
47
+ rake lib-beta:build # Build lib-beta-0.8.0.gem.gem into the pkg directory
48
+ rake lib-beta:install # Build and install lib-beta-0.8.0.gem into system gems
49
+ rake lib-beta:install:local # Build and install lib-beta-0.8.0.gem into system gems without network access
50
+ rake lib-beta:release[remote] # Create and push tag v0.6.0, build gem and publish to rubygems.org
51
+ ```
52
+
53
+ ### With tag signing
54
+
55
+ Enable tag signing by manually loading the task:
56
+
57
+ ```ruby
58
+ require 'rake/release/task'
59
+
60
+ Rake::Release::Task.new do |spec|
61
+ spec.sign_tag = true
62
+ end
63
+ ```
64
+
65
+ Or with multiple gems:
66
+
67
+ ```ruby
68
+ require 'rake/release/task'
69
+
70
+ Rake::Release::Task.load_all do |spec|
71
+ spec.sign_tag = true
72
+ end
73
+ ```
74
+
75
+ ### Manually set namespace
76
+
77
+ ```ruby
78
+ require 'rake/release/task'
79
+
80
+ Rake::Release::Task.new do |spec|
81
+ spec.namespace = 'client'
82
+ end
83
+ ```
84
+
85
+ ```
86
+ > rake -T
87
+ rake client:build # Build rake-release-0.6.0.gem.gem into the pkg directory
88
+ rake client:install # Build and install rake-release-0.6.0.gem into system gems
89
+ rake client:install:local # Build and install rake-release-0.6.0.gem into system gems without network access
90
+ rake client:release[remote] # Create and push tag v0.6.0, build gem and publish to rubygems.org
91
+ ```
92
+
93
+ ### Set gem host and version tag
94
+
95
+ You can customize the task e.g. with a custom git tag or gem push host:
96
+
97
+ ```ruby
98
+ Rake::Release::Task.load_all do |spec|
99
+ spec.version_tag = "gem-v#{spec.version}"
100
+ spec.host = 'https://user:pass@gemhost/'
101
+ end
102
+
103
+ ```
104
+
105
+ # License
106
+
107
+ MIT