shopify-cli 1.4.0 → 1.7.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (302) hide show
  1. checksums.yaml +4 -4
  2. data/.github/CODEOWNERS +2 -2
  3. data/.github/CONTRIBUTING.md +9 -1
  4. data/.github/PULL_REQUEST_TEMPLATE.md +10 -1
  5. data/.github/workflows/release.yml +61 -0
  6. data/.github/workflows/triage.yml +22 -0
  7. data/.rubocop.yml +56 -7
  8. data/.rubocop_todo.yml +4 -13
  9. data/.travis.yml +1 -0
  10. data/CHANGELOG.md +27 -1
  11. data/Gemfile +12 -10
  12. data/Gemfile.lock +33 -31
  13. data/README.md +39 -7
  14. data/RELEASING.md +5 -27
  15. data/Rakefile +32 -28
  16. data/bin/load_shopify.rb +6 -6
  17. data/bin/shopify +2 -2
  18. data/dev.yml +2 -2
  19. data/docs/_config.yml +1 -18
  20. data/docs/app/node/commands/index.md +2 -80
  21. data/docs/app/node/index.md +2 -33
  22. data/docs/app/rails/commands/index.md +2 -78
  23. data/docs/app/rails/index.md +2 -34
  24. data/docs/core/index.md +2 -84
  25. data/docs/getting-started/index.md +2 -25
  26. data/docs/getting-started/install/index.md +1 -118
  27. data/docs/getting-started/migrate/index.md +2 -94
  28. data/docs/getting-started/uninstall/index.md +2 -35
  29. data/docs/getting-started/upgrade/index.md +2 -39
  30. data/docs/help/start-app/index.md +2 -4
  31. data/docs/index.md +2 -24
  32. data/ext/shopify-cli/extconf.rb +7 -7
  33. data/install.sh +1 -1
  34. data/lib/docgen/markdown.rb +11 -11
  35. data/lib/{project_types/extension/graphql → graphql}/get_app_by_api_key.graphql +0 -0
  36. data/lib/project_types/extension/cli.rb +64 -47
  37. data/lib/project_types/extension/commands/build.rb +3 -3
  38. data/lib/project_types/extension/commands/create.rb +16 -9
  39. data/lib/project_types/extension/commands/extension_command.rb +8 -5
  40. data/lib/project_types/extension/commands/push.rb +8 -8
  41. data/lib/project_types/extension/commands/register.rb +19 -30
  42. data/lib/project_types/extension/commands/serve.rb +23 -3
  43. data/lib/project_types/extension/commands/tunnel.rb +12 -12
  44. data/lib/project_types/extension/extension_project.rb +4 -4
  45. data/lib/project_types/extension/extension_project_keys.rb +4 -4
  46. data/lib/project_types/extension/features/argo.rb +117 -0
  47. data/lib/project_types/extension/features/argo_config.rb +5 -5
  48. data/lib/project_types/extension/features/argo_dependencies.rb +5 -5
  49. data/lib/project_types/extension/features/argo_setup.rb +2 -2
  50. data/lib/project_types/extension/features/argo_setup_steps.rb +4 -4
  51. data/lib/project_types/extension/forms/create.rb +28 -34
  52. data/lib/project_types/extension/forms/questions/ask_app.rb +53 -0
  53. data/lib/project_types/extension/forms/questions/ask_name.rb +40 -0
  54. data/lib/project_types/extension/forms/questions/ask_type.rb +36 -0
  55. data/lib/project_types/extension/messages/messages.rb +53 -52
  56. data/lib/project_types/extension/models/lazy_specification_handler.rb +12 -0
  57. data/lib/project_types/extension/models/specification.rb +35 -0
  58. data/lib/project_types/extension/models/specification_handlers/checkout_post_purchase.rb +19 -0
  59. data/lib/project_types/extension/models/specification_handlers/default.rb +67 -0
  60. data/lib/project_types/extension/models/specifications.rb +77 -0
  61. data/lib/project_types/extension/tasks/configure_features.rb +52 -0
  62. data/lib/project_types/extension/tasks/converters/app_converter.rb +6 -6
  63. data/lib/project_types/extension/tasks/converters/registration_converter.rb +6 -6
  64. data/lib/project_types/extension/tasks/converters/validation_error_converter.rb +4 -4
  65. data/lib/project_types/extension/tasks/converters/version_converter.rb +7 -7
  66. data/lib/project_types/extension/tasks/create_extension.rb +4 -4
  67. data/lib/project_types/extension/tasks/fetch_specifications.rb +38 -0
  68. data/lib/project_types/extension/tasks/get_app.rb +4 -4
  69. data/lib/project_types/extension/tasks/get_apps.rb +3 -3
  70. data/lib/project_types/extension/tasks/update_draft.rb +4 -4
  71. data/lib/project_types/extension/tasks/user_errors.rb +4 -4
  72. data/lib/project_types/node/cli.rb +19 -16
  73. data/lib/project_types/node/commands/connect.rb +15 -0
  74. data/lib/project_types/node/commands/create.rb +44 -41
  75. data/lib/project_types/node/commands/deploy.rb +4 -4
  76. data/lib/project_types/node/commands/deploy/heroku.rb +24 -24
  77. data/lib/project_types/node/commands/generate.rb +9 -18
  78. data/lib/project_types/node/commands/open.rb +2 -2
  79. data/lib/project_types/node/commands/populate.rb +6 -6
  80. data/lib/project_types/node/commands/populate/customer.rb +5 -5
  81. data/lib/project_types/node/commands/populate/draft_order.rb +5 -5
  82. data/lib/project_types/node/commands/populate/product.rb +5 -5
  83. data/lib/project_types/node/commands/serve.rb +9 -9
  84. data/lib/project_types/node/commands/tunnel.rb +7 -7
  85. data/lib/project_types/node/forms/create.rb +7 -7
  86. data/lib/project_types/node/messages/messages.rb +19 -53
  87. data/lib/project_types/rails/cli.rb +21 -18
  88. data/lib/project_types/rails/commands/connect.rb +15 -0
  89. data/lib/project_types/rails/commands/create.rb +58 -57
  90. data/lib/project_types/rails/commands/deploy.rb +4 -4
  91. data/lib/project_types/rails/commands/deploy/heroku.rb +30 -30
  92. data/lib/project_types/rails/commands/generate.rb +7 -7
  93. data/lib/project_types/rails/commands/generate/webhook.rb +6 -6
  94. data/lib/project_types/rails/commands/open.rb +2 -2
  95. data/lib/project_types/rails/commands/populate.rb +6 -6
  96. data/lib/project_types/rails/commands/populate/customer.rb +5 -5
  97. data/lib/project_types/rails/commands/populate/draft_order.rb +5 -5
  98. data/lib/project_types/rails/commands/populate/product.rb +5 -5
  99. data/lib/project_types/rails/commands/serve.rb +11 -11
  100. data/lib/project_types/rails/commands/tunnel.rb +7 -7
  101. data/lib/project_types/rails/forms/create.rb +24 -24
  102. data/lib/project_types/rails/gem.rb +24 -24
  103. data/lib/project_types/rails/messages/messages.rb +12 -9
  104. data/lib/project_types/rails/ruby.rb +2 -2
  105. data/lib/project_types/script/cli.rb +44 -38
  106. data/lib/project_types/script/commands/create.rb +15 -10
  107. data/lib/project_types/script/commands/disable.rb +3 -3
  108. data/lib/project_types/script/commands/enable.rb +19 -9
  109. data/lib/project_types/script/commands/push.rb +10 -17
  110. data/lib/project_types/script/config/extension_points.yml +17 -12
  111. data/lib/project_types/script/errors.rb +22 -0
  112. data/lib/project_types/script/forms/create.rb +29 -5
  113. data/lib/project_types/script/graphql/app_script_update_or_create.graphql +12 -1
  114. data/lib/project_types/script/layers/application/build_script.rb +19 -19
  115. data/lib/project_types/script/layers/application/create_script.rb +41 -12
  116. data/lib/project_types/script/layers/application/disable_script.rb +2 -2
  117. data/lib/project_types/script/layers/application/enable_script.rb +2 -2
  118. data/lib/project_types/script/layers/application/extension_points.rb +24 -0
  119. data/lib/project_types/script/layers/application/project_dependencies.rb +4 -4
  120. data/lib/project_types/script/layers/application/push_script.rb +15 -18
  121. data/lib/project_types/script/layers/domain/config_ui.rb +16 -0
  122. data/lib/project_types/script/layers/domain/errors.rb +23 -0
  123. data/lib/project_types/script/layers/domain/extension_point.rb +62 -7
  124. data/lib/project_types/script/layers/domain/metadata.rb +55 -0
  125. data/lib/project_types/script/layers/domain/push_package.rb +29 -6
  126. data/lib/project_types/script/layers/infrastructure/assemblyscript_project_creator.rb +19 -55
  127. data/lib/project_types/script/layers/infrastructure/assemblyscript_task_runner.rb +49 -18
  128. data/lib/project_types/script/layers/infrastructure/config_ui_repository.rb +46 -0
  129. data/lib/project_types/script/layers/infrastructure/errors.rb +37 -1
  130. data/lib/project_types/script/layers/infrastructure/extension_point_repository.rb +12 -6
  131. data/lib/project_types/script/layers/infrastructure/project_creator.rb +2 -1
  132. data/lib/project_types/script/layers/infrastructure/push_package_repository.rb +20 -13
  133. data/lib/project_types/script/layers/infrastructure/rust_project_creator.rb +72 -0
  134. data/lib/project_types/script/layers/infrastructure/rust_task_runner.rb +59 -0
  135. data/lib/project_types/script/layers/infrastructure/script_service.rb +39 -17
  136. data/lib/project_types/script/layers/infrastructure/task_runner.rb +4 -3
  137. data/lib/project_types/script/messages/messages.rb +79 -10
  138. data/lib/project_types/script/script_project.rb +26 -16
  139. data/lib/project_types/script/ui/error_handler.rb +141 -45
  140. data/lib/project_types/script/ui/printing_spinner.rb +1 -1
  141. data/lib/project_types/script/ui/strict_spinner.rb +1 -1
  142. data/lib/project_types/theme/cli.rb +40 -0
  143. data/lib/project_types/theme/commands/connect.rb +54 -0
  144. data/lib/project_types/theme/commands/create.rb +48 -0
  145. data/lib/project_types/theme/commands/deploy.rb +38 -0
  146. data/lib/project_types/theme/commands/generate.rb +20 -0
  147. data/lib/project_types/theme/commands/generate/env.rb +79 -0
  148. data/lib/project_types/theme/commands/push.rb +55 -0
  149. data/lib/project_types/theme/commands/serve.rb +31 -0
  150. data/lib/project_types/theme/forms/connect.rb +34 -0
  151. data/lib/project_types/theme/forms/create.rb +22 -0
  152. data/lib/project_types/theme/messages/messages.rb +147 -0
  153. data/lib/project_types/theme/tasks/ensure_themekit_installed.rb +78 -0
  154. data/lib/project_types/theme/themekit.rb +113 -0
  155. data/lib/rubygems_plugin.rb +3 -3
  156. data/lib/shopify-cli/admin_api.rb +52 -12
  157. data/lib/shopify-cli/admin_api/populate_resource_command.rb +17 -17
  158. data/lib/shopify-cli/admin_api/schema.rb +3 -3
  159. data/lib/shopify-cli/api.rb +36 -31
  160. data/lib/shopify-cli/command.rb +1 -1
  161. data/lib/shopify-cli/commands.rb +9 -9
  162. data/lib/shopify-cli/commands/config.rb +28 -28
  163. data/lib/shopify-cli/commands/connect.rb +35 -18
  164. data/lib/shopify-cli/commands/create.rb +5 -5
  165. data/lib/shopify-cli/commands/help.rb +6 -6
  166. data/lib/shopify-cli/commands/logout.rb +3 -3
  167. data/lib/shopify-cli/commands/system.rb +33 -33
  168. data/lib/shopify-cli/commands/version.rb +2 -2
  169. data/lib/shopify-cli/context.rb +43 -22
  170. data/lib/shopify-cli/core.rb +4 -4
  171. data/lib/shopify-cli/core/entry_point.rb +5 -5
  172. data/lib/shopify-cli/core/executor.rb +1 -1
  173. data/lib/shopify-cli/core/help_resolver.rb +2 -2
  174. data/lib/shopify-cli/core/monorail.rb +21 -19
  175. data/lib/shopify-cli/db.rb +2 -2
  176. data/lib/shopify-cli/feature.rb +1 -3
  177. data/lib/shopify-cli/form.rb +1 -1
  178. data/lib/shopify-cli/git.rb +17 -17
  179. data/lib/shopify-cli/helpers.rb +1 -1
  180. data/lib/shopify-cli/helpers/haikunator.rb +1 -1
  181. data/lib/shopify-cli/heroku.rb +28 -28
  182. data/lib/shopify-cli/http_request.rb +21 -9
  183. data/lib/shopify-cli/js_deps.rb +13 -13
  184. data/lib/shopify-cli/js_system.rb +5 -5
  185. data/lib/shopify-cli/lazy_delegator.rb +55 -0
  186. data/lib/shopify-cli/messages/messages.rb +21 -10
  187. data/lib/shopify-cli/method_object.rb +104 -0
  188. data/lib/shopify-cli/oauth.rb +25 -25
  189. data/lib/shopify-cli/oauth/servlet.rb +9 -9
  190. data/lib/shopify-cli/options.rb +3 -3
  191. data/lib/shopify-cli/packager.rb +24 -24
  192. data/lib/shopify-cli/partners_api.rb +38 -16
  193. data/lib/shopify-cli/partners_api/organizations.rb +10 -10
  194. data/lib/shopify-cli/process_supervision.rb +8 -8
  195. data/lib/shopify-cli/project.rb +27 -23
  196. data/lib/shopify-cli/project_type.rb +21 -5
  197. data/lib/shopify-cli/resolve_constant.rb +25 -0
  198. data/lib/shopify-cli/resources.rb +1 -1
  199. data/lib/shopify-cli/resources/env_file.rb +9 -9
  200. data/lib/shopify-cli/result.rb +432 -0
  201. data/lib/shopify-cli/shopifolk.rb +35 -18
  202. data/lib/shopify-cli/sub_command.rb +1 -1
  203. data/lib/shopify-cli/task.rb +9 -1
  204. data/lib/shopify-cli/tasks.rb +7 -7
  205. data/lib/shopify-cli/tasks/create_api_client.rb +17 -6
  206. data/lib/shopify-cli/tasks/ensure_dev_store.rb +11 -11
  207. data/lib/shopify-cli/tasks/ensure_env.rb +18 -15
  208. data/lib/shopify-cli/tasks/ensure_loopback_url.rb +4 -4
  209. data/lib/shopify-cli/tasks/select_org_and_shop.rb +29 -24
  210. data/lib/shopify-cli/tasks/update_dashboard_urls.rb +10 -10
  211. data/lib/shopify-cli/transform_data_structure.rb +86 -0
  212. data/lib/shopify-cli/tunnel.rb +36 -30
  213. data/lib/shopify-cli/version.rb +1 -1
  214. data/lib/shopify_cli.rb +57 -52
  215. data/shopify-cli.gemspec +6 -6
  216. data/shopify.fish +1 -1
  217. data/shopify.sh +1 -1
  218. data/vendor/deps/cli-kit/REVISION +1 -1
  219. data/vendor/deps/cli-kit/lib/cli/kit/logger.rb +2 -2
  220. data/vendor/deps/cli-kit/lib/cli/kit/system.rb +3 -3
  221. data/vendor/deps/cli-ui/REVISION +1 -1
  222. data/vendor/deps/cli-ui/lib/cli/ui.rb +26 -22
  223. data/vendor/deps/cli-ui/lib/cli/ui/ansi.rb +4 -6
  224. data/vendor/deps/cli-ui/lib/cli/ui/frame.rb +3 -3
  225. data/vendor/deps/cli-ui/lib/cli/ui/frame/frame_stack.rb +8 -9
  226. data/vendor/deps/cli-ui/lib/cli/ui/frame/frame_style.rb +1 -1
  227. data/vendor/deps/cli-ui/lib/cli/ui/glyph.rb +1 -0
  228. data/vendor/deps/cli-ui/lib/cli/ui/printer.rb +15 -3
  229. data/vendor/deps/cli-ui/lib/cli/ui/prompt/interactive_options.rb +4 -11
  230. data/vendor/deps/cli-ui/lib/cli/ui/spinner.rb +3 -5
  231. data/vendor/deps/cli-ui/lib/cli/ui/terminal.rb +10 -10
  232. data/vendor/deps/cli-ui/lib/cli/ui/version.rb +1 -1
  233. data/vendor/deps/cli-ui/lib/cli/ui/wrap.rb +56 -0
  234. data/vendor/deps/webrick/.gitignore +9 -0
  235. data/vendor/deps/webrick/Gemfile +3 -0
  236. data/vendor/deps/webrick/LICENSE.txt +22 -0
  237. data/vendor/deps/webrick/README.md +61 -0
  238. data/vendor/deps/webrick/Rakefile +10 -0
  239. data/vendor/deps/webrick/lib/webrick.rb +232 -0
  240. data/vendor/deps/webrick/lib/webrick/accesslog.rb +157 -0
  241. data/vendor/deps/webrick/lib/webrick/cgi.rb +313 -0
  242. data/vendor/deps/webrick/lib/webrick/compat.rb +36 -0
  243. data/vendor/deps/webrick/lib/webrick/config.rb +158 -0
  244. data/vendor/deps/webrick/lib/webrick/cookie.rb +172 -0
  245. data/vendor/deps/webrick/lib/webrick/htmlutils.rb +30 -0
  246. data/vendor/deps/webrick/lib/webrick/httpauth.rb +96 -0
  247. data/vendor/deps/webrick/lib/webrick/httpauth/authenticator.rb +117 -0
  248. data/vendor/deps/webrick/lib/webrick/httpauth/basicauth.rb +116 -0
  249. data/vendor/deps/webrick/lib/webrick/httpauth/digestauth.rb +395 -0
  250. data/vendor/deps/webrick/lib/webrick/httpauth/htdigest.rb +132 -0
  251. data/vendor/deps/webrick/lib/webrick/httpauth/htgroup.rb +97 -0
  252. data/vendor/deps/webrick/lib/webrick/httpauth/htpasswd.rb +158 -0
  253. data/vendor/deps/webrick/lib/webrick/httpauth/userdb.rb +53 -0
  254. data/vendor/deps/webrick/lib/webrick/httpproxy.rb +354 -0
  255. data/vendor/deps/webrick/lib/webrick/httprequest.rb +636 -0
  256. data/vendor/deps/webrick/lib/webrick/httpresponse.rb +564 -0
  257. data/vendor/deps/webrick/lib/webrick/https.rb +152 -0
  258. data/vendor/deps/webrick/lib/webrick/httpserver.rb +294 -0
  259. data/vendor/deps/webrick/lib/webrick/httpservlet.rb +23 -0
  260. data/vendor/deps/webrick/lib/webrick/httpservlet/abstract.rb +152 -0
  261. data/vendor/deps/webrick/lib/webrick/httpservlet/cgi_runner.rb +47 -0
  262. data/vendor/deps/webrick/lib/webrick/httpservlet/cgihandler.rb +126 -0
  263. data/vendor/deps/webrick/lib/webrick/httpservlet/erbhandler.rb +88 -0
  264. data/vendor/deps/webrick/lib/webrick/httpservlet/filehandler.rb +552 -0
  265. data/vendor/deps/webrick/lib/webrick/httpservlet/prochandler.rb +47 -0
  266. data/vendor/deps/webrick/lib/webrick/httpstatus.rb +194 -0
  267. data/vendor/deps/webrick/lib/webrick/httputils.rb +512 -0
  268. data/vendor/deps/webrick/lib/webrick/httpversion.rb +76 -0
  269. data/vendor/deps/webrick/lib/webrick/log.rb +156 -0
  270. data/vendor/deps/webrick/lib/webrick/server.rb +381 -0
  271. data/vendor/deps/webrick/lib/webrick/ssl.rb +215 -0
  272. data/vendor/deps/webrick/lib/webrick/utils.rb +265 -0
  273. data/vendor/deps/webrick/lib/webrick/version.rb +18 -0
  274. data/vendor/deps/webrick/webrick.gemspec +74 -0
  275. data/vendor/gen/template/bin/update-deps +9 -9
  276. metadata +83 -29
  277. data/docs/Gemfile +0 -5
  278. data/docs/Gemfile.lock +0 -258
  279. data/docs/_data/nav.yml +0 -35
  280. data/docs/_includes/footer.html +0 -15
  281. data/docs/_includes/head.html +0 -19
  282. data/docs/_includes/sidebar_nav.html +0 -22
  283. data/docs/_includes/toc.html +0 -112
  284. data/docs/_layouts/default.html +0 -79
  285. data/docs/css/docs.css +0 -157
  286. data/docs/images/header.png +0 -0
  287. data/docs/installing-ruby.md +0 -28
  288. data/lib/project_types/extension/features/argo/admin.rb +0 -20
  289. data/lib/project_types/extension/features/argo/base.rb +0 -129
  290. data/lib/project_types/extension/features/argo/checkout.rb +0 -20
  291. data/lib/project_types/extension/forms/register.rb +0 -47
  292. data/lib/project_types/extension/models/type.rb +0 -81
  293. data/lib/project_types/extension/models/types/checkout_post_purchase.rb +0 -23
  294. data/lib/project_types/extension/models/types/product_subscription.rb +0 -24
  295. data/lib/project_types/node/commands/generate/billing.rb +0 -39
  296. data/lib/project_types/node/commands/generate/page.rb +0 -59
  297. data/lib/project_types/node/commands/generate/webhook.rb +0 -37
  298. data/lib/project_types/script/layers/domain/script.rb +0 -18
  299. data/lib/project_types/script/layers/infrastructure/assemblyscript_tsconfig.rb +0 -38
  300. data/lib/project_types/script/layers/infrastructure/script_repository.rb +0 -59
  301. data/lib/project_types/script/templates/ts/as-pect.config.js +0 -27
  302. data/lib/project_types/script/templates/ts/as-pect.d.ts +0 -1
@@ -0,0 +1,61 @@
1
+ # Webrick
2
+
3
+ WEBrick is an HTTP server toolkit that can be configured as an HTTPS server, a proxy server, and a virtual-host server.
4
+
5
+ WEBrick features complete logging of both server operations and HTTP access.
6
+
7
+ WEBrick supports both basic and digest authentication in addition to algorithms not in RFC 2617.
8
+
9
+ A WEBrick server can be composed of multiple WEBrick servers or servlets to provide differing behavior on a per-host or per-path basis. WEBrick includes servlets for handling CGI scripts, ERB pages, Ruby blocks and directory listings.
10
+
11
+ WEBrick also includes tools for daemonizing a process and starting a process at a higher privilege level and dropping permissions.
12
+
13
+ ## Installation
14
+
15
+ Add this line to your application's Gemfile:
16
+
17
+ ```ruby
18
+ gem 'webrick'
19
+ ```
20
+
21
+ And then execute:
22
+
23
+ $ bundle
24
+
25
+ Or install it yourself as:
26
+
27
+ $ gem install webrick
28
+
29
+ ## Usage
30
+
31
+ To create a new WEBrick::HTTPServer that will listen to connections on port 8000 and serve documents from the current user's public_html folder:
32
+
33
+ ```ruby
34
+ require 'webrick'
35
+
36
+ root = File.expand_path '~/public_html'
37
+ server = WEBrick::HTTPServer.new :Port => 8000, :DocumentRoot => root
38
+ ```
39
+
40
+ To run the server you will need to provide a suitable shutdown hook as
41
+ starting the server blocks the current thread:
42
+
43
+ ```ruby
44
+ trap 'INT' do server.shutdown end
45
+
46
+ server.start
47
+ ```
48
+
49
+ ## Development
50
+
51
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
52
+
53
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
54
+
55
+ ## Contributing
56
+
57
+ Bug reports and Patch are welcome on https://bugs.ruby-lang.org/.
58
+
59
+ ## License
60
+
61
+ The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test" << "test/lib"
6
+ t.libs << "lib"
7
+ t.test_files = FileList['test/**/test_*.rb']
8
+ end
9
+
10
+ task :default => :test
@@ -0,0 +1,232 @@
1
+ # frozen_string_literal: false
2
+ ##
3
+ # = WEB server toolkit.
4
+ #
5
+ # WEBrick is an HTTP server toolkit that can be configured as an HTTPS server,
6
+ # a proxy server, and a virtual-host server. WEBrick features complete
7
+ # logging of both server operations and HTTP access. WEBrick supports both
8
+ # basic and digest authentication in addition to algorithms not in RFC 2617.
9
+ #
10
+ # A WEBrick server can be composed of multiple WEBrick servers or servlets to
11
+ # provide differing behavior on a per-host or per-path basis. WEBrick
12
+ # includes servlets for handling CGI scripts, ERB pages, Ruby blocks and
13
+ # directory listings.
14
+ #
15
+ # WEBrick also includes tools for daemonizing a process and starting a process
16
+ # at a higher privilege level and dropping permissions.
17
+ #
18
+ # == Security
19
+ #
20
+ # *Warning:* WEBrick is not recommended for production. It only implements
21
+ # basic security checks.
22
+ #
23
+ # == Starting an HTTP server
24
+ #
25
+ # To create a new WEBrick::HTTPServer that will listen to connections on port
26
+ # 8000 and serve documents from the current user's public_html folder:
27
+ #
28
+ # require 'webrick'
29
+ #
30
+ # root = File.expand_path '~/public_html'
31
+ # server = WEBrick::HTTPServer.new :Port => 8000, :DocumentRoot => root
32
+ #
33
+ # To run the server you will need to provide a suitable shutdown hook as
34
+ # starting the server blocks the current thread:
35
+ #
36
+ # trap 'INT' do server.shutdown end
37
+ #
38
+ # server.start
39
+ #
40
+ # == Custom Behavior
41
+ #
42
+ # The easiest way to have a server perform custom operations is through
43
+ # WEBrick::HTTPServer#mount_proc. The block given will be called with a
44
+ # WEBrick::HTTPRequest with request info and a WEBrick::HTTPResponse which
45
+ # must be filled in appropriately:
46
+ #
47
+ # server.mount_proc '/' do |req, res|
48
+ # res.body = 'Hello, world!'
49
+ # end
50
+ #
51
+ # Remember that +server.mount_proc+ must precede +server.start+.
52
+ #
53
+ # == Servlets
54
+ #
55
+ # Advanced custom behavior can be obtained through mounting a subclass of
56
+ # WEBrick::HTTPServlet::AbstractServlet. Servlets provide more modularity
57
+ # when writing an HTTP server than mount_proc allows. Here is a simple
58
+ # servlet:
59
+ #
60
+ # class Simple < WEBrick::HTTPServlet::AbstractServlet
61
+ # def do_GET request, response
62
+ # status, content_type, body = do_stuff_with request
63
+ #
64
+ # response.status = 200
65
+ # response['Content-Type'] = 'text/plain'
66
+ # response.body = 'Hello, World!'
67
+ # end
68
+ # end
69
+ #
70
+ # To initialize the servlet you mount it on the server:
71
+ #
72
+ # server.mount '/simple', Simple
73
+ #
74
+ # See WEBrick::HTTPServlet::AbstractServlet for more details.
75
+ #
76
+ # == Virtual Hosts
77
+ #
78
+ # A server can act as a virtual host for multiple host names. After creating
79
+ # the listening host, additional hosts that do not listen can be created and
80
+ # attached as virtual hosts:
81
+ #
82
+ # server = WEBrick::HTTPServer.new # ...
83
+ #
84
+ # vhost = WEBrick::HTTPServer.new :ServerName => 'vhost.example',
85
+ # :DoNotListen => true, # ...
86
+ # vhost.mount '/', ...
87
+ #
88
+ # server.virtual_host vhost
89
+ #
90
+ # If no +:DocumentRoot+ is provided and no servlets or procs are mounted on the
91
+ # main server it will return 404 for all URLs.
92
+ #
93
+ # == HTTPS
94
+ #
95
+ # To create an HTTPS server you only need to enable SSL and provide an SSL
96
+ # certificate name:
97
+ #
98
+ # require 'webrick'
99
+ # require 'webrick/https'
100
+ #
101
+ # cert_name = [
102
+ # %w[CN localhost],
103
+ # ]
104
+ #
105
+ # server = WEBrick::HTTPServer.new(:Port => 8000,
106
+ # :SSLEnable => true,
107
+ # :SSLCertName => cert_name)
108
+ #
109
+ # This will start the server with a self-generated self-signed certificate.
110
+ # The certificate will be changed every time the server is restarted.
111
+ #
112
+ # To create a server with a pre-determined key and certificate you can provide
113
+ # them:
114
+ #
115
+ # require 'webrick'
116
+ # require 'webrick/https'
117
+ # require 'openssl'
118
+ #
119
+ # cert = OpenSSL::X509::Certificate.new File.read '/path/to/cert.pem'
120
+ # pkey = OpenSSL::PKey::RSA.new File.read '/path/to/pkey.pem'
121
+ #
122
+ # server = WEBrick::HTTPServer.new(:Port => 8000,
123
+ # :SSLEnable => true,
124
+ # :SSLCertificate => cert,
125
+ # :SSLPrivateKey => pkey)
126
+ #
127
+ # == Proxy Server
128
+ #
129
+ # WEBrick can act as a proxy server:
130
+ #
131
+ # require 'webrick'
132
+ # require 'webrick/httpproxy'
133
+ #
134
+ # proxy = WEBrick::HTTPProxyServer.new :Port => 8000
135
+ #
136
+ # trap 'INT' do proxy.shutdown end
137
+ #
138
+ # See WEBrick::HTTPProxy for further details including modifying proxied
139
+ # responses.
140
+ #
141
+ # == Basic and Digest authentication
142
+ #
143
+ # WEBrick provides both Basic and Digest authentication for regular and proxy
144
+ # servers. See WEBrick::HTTPAuth, WEBrick::HTTPAuth::BasicAuth and
145
+ # WEBrick::HTTPAuth::DigestAuth.
146
+ #
147
+ # == WEBrick as a daemonized Web Server
148
+ #
149
+ # WEBrick can be run as a daemonized server for small loads.
150
+ #
151
+ # === Daemonizing
152
+ #
153
+ # To start a WEBrick server as a daemon simple run WEBrick::Daemon.start
154
+ # before starting the server.
155
+ #
156
+ # === Dropping Permissions
157
+ #
158
+ # WEBrick can be started as one user to gain permission to bind to port 80 or
159
+ # 443 for serving HTTP or HTTPS traffic then can drop these permissions for
160
+ # regular operation. To listen on all interfaces for HTTP traffic:
161
+ #
162
+ # sockets = WEBrick::Utils.create_listeners nil, 80
163
+ #
164
+ # Then drop privileges:
165
+ #
166
+ # WEBrick::Utils.su 'www'
167
+ #
168
+ # Then create a server that does not listen by default:
169
+ #
170
+ # server = WEBrick::HTTPServer.new :DoNotListen => true, # ...
171
+ #
172
+ # Then overwrite the listening sockets with the port 80 sockets:
173
+ #
174
+ # server.listeners.replace sockets
175
+ #
176
+ # === Logging
177
+ #
178
+ # WEBrick can separately log server operations and end-user access. For
179
+ # server operations:
180
+ #
181
+ # log_file = File.open '/var/log/webrick.log', 'a+'
182
+ # log = WEBrick::Log.new log_file
183
+ #
184
+ # For user access logging:
185
+ #
186
+ # access_log = [
187
+ # [log_file, WEBrick::AccessLog::COMBINED_LOG_FORMAT],
188
+ # ]
189
+ #
190
+ # server = WEBrick::HTTPServer.new :Logger => log, :AccessLog => access_log
191
+ #
192
+ # See WEBrick::AccessLog for further log formats.
193
+ #
194
+ # === Log Rotation
195
+ #
196
+ # To rotate logs in WEBrick on a HUP signal (like syslogd can send), open the
197
+ # log file in 'a+' mode (as above) and trap 'HUP' to reopen the log file:
198
+ #
199
+ # trap 'HUP' do log_file.reopen '/path/to/webrick.log', 'a+'
200
+ #
201
+ # == Copyright
202
+ #
203
+ # Author: IPR -- Internet Programming with Ruby -- writers
204
+ #
205
+ # Copyright (c) 2000 TAKAHASHI Masayoshi, GOTOU YUUZOU
206
+ # Copyright (c) 2002 Internet Programming with Ruby writers. All rights
207
+ # reserved.
208
+ #--
209
+ # $IPR: webrick.rb,v 1.12 2002/10/01 17:16:31 gotoyuzo Exp $
210
+
211
+ module WEBrick
212
+ end
213
+
214
+ require 'webrick/compat.rb'
215
+
216
+ require 'webrick/version.rb'
217
+ require 'webrick/config.rb'
218
+ require 'webrick/log.rb'
219
+ require 'webrick/server.rb'
220
+ require_relative 'webrick/utils.rb'
221
+ require 'webrick/accesslog'
222
+
223
+ require 'webrick/htmlutils.rb'
224
+ require 'webrick/httputils.rb'
225
+ require 'webrick/cookie.rb'
226
+ require 'webrick/httpversion.rb'
227
+ require 'webrick/httpstatus.rb'
228
+ require 'webrick/httprequest.rb'
229
+ require 'webrick/httpresponse.rb'
230
+ require 'webrick/httpserver.rb'
231
+ require 'webrick/httpservlet.rb'
232
+ require 'webrick/httpauth.rb'
@@ -0,0 +1,157 @@
1
+ # frozen_string_literal: true
2
+ #--
3
+ # accesslog.rb -- Access log handling utilities
4
+ #
5
+ # Author: IPR -- Internet Programming with Ruby -- writers
6
+ # Copyright (c) 2002 keita yamaguchi
7
+ # Copyright (c) 2002 Internet Programming with Ruby writers
8
+ #
9
+ # $IPR: accesslog.rb,v 1.1 2002/10/01 17:16:32 gotoyuzo Exp $
10
+
11
+ module WEBrick
12
+
13
+ ##
14
+ # AccessLog provides logging to various files in various formats.
15
+ #
16
+ # Multiple logs may be written to at the same time:
17
+ #
18
+ # access_log = [
19
+ # [$stderr, WEBrick::AccessLog::COMMON_LOG_FORMAT],
20
+ # [$stderr, WEBrick::AccessLog::REFERER_LOG_FORMAT],
21
+ # ]
22
+ #
23
+ # server = WEBrick::HTTPServer.new :AccessLog => access_log
24
+ #
25
+ # Custom log formats may be defined. WEBrick::AccessLog provides a subset
26
+ # of the formatting from Apache's mod_log_config
27
+ # http://httpd.apache.org/docs/mod/mod_log_config.html#formats. See
28
+ # AccessLog::setup_params for a list of supported options
29
+
30
+ module AccessLog
31
+
32
+ ##
33
+ # Raised if a parameter such as %e, %i, %o or %n is used without fetching
34
+ # a specific field.
35
+
36
+ class AccessLogError < StandardError; end
37
+
38
+ ##
39
+ # The Common Log Format's time format
40
+
41
+ CLF_TIME_FORMAT = "[%d/%b/%Y:%H:%M:%S %Z]"
42
+
43
+ ##
44
+ # Common Log Format
45
+
46
+ COMMON_LOG_FORMAT = "%h %l %u %t \"%r\" %s %b"
47
+
48
+ ##
49
+ # Short alias for Common Log Format
50
+
51
+ CLF = COMMON_LOG_FORMAT
52
+
53
+ ##
54
+ # Referer Log Format
55
+
56
+ REFERER_LOG_FORMAT = "%{Referer}i -> %U"
57
+
58
+ ##
59
+ # User-Agent Log Format
60
+
61
+ AGENT_LOG_FORMAT = "%{User-Agent}i"
62
+
63
+ ##
64
+ # Combined Log Format
65
+
66
+ COMBINED_LOG_FORMAT = "#{CLF} \"%{Referer}i\" \"%{User-agent}i\""
67
+
68
+ module_function
69
+
70
+ # This format specification is a subset of mod_log_config of Apache:
71
+ #
72
+ # %a:: Remote IP address
73
+ # %b:: Total response size
74
+ # %e{variable}:: Given variable in ENV
75
+ # %f:: Response filename
76
+ # %h:: Remote host name
77
+ # %{header}i:: Given request header
78
+ # %l:: Remote logname, always "-"
79
+ # %m:: Request method
80
+ # %{attr}n:: Given request attribute from <tt>req.attributes</tt>
81
+ # %{header}o:: Given response header
82
+ # %p:: Server's request port
83
+ # %{format}p:: The canonical port of the server serving the request or the
84
+ # actual port or the client's actual port. Valid formats are
85
+ # canonical, local or remote.
86
+ # %q:: Request query string
87
+ # %r:: First line of the request
88
+ # %s:: Request status
89
+ # %t:: Time the request was received
90
+ # %T:: Time taken to process the request
91
+ # %u:: Remote user from auth
92
+ # %U:: Unparsed URI
93
+ # %%:: Literal %
94
+
95
+ def setup_params(config, req, res)
96
+ params = Hash.new("")
97
+ params["a"] = req.peeraddr[3]
98
+ params["b"] = res.sent_size
99
+ params["e"] = ENV
100
+ params["f"] = res.filename || ""
101
+ params["h"] = req.peeraddr[2]
102
+ params["i"] = req
103
+ params["l"] = "-"
104
+ params["m"] = req.request_method
105
+ params["n"] = req.attributes
106
+ params["o"] = res
107
+ params["p"] = req.port
108
+ params["q"] = req.query_string
109
+ params["r"] = req.request_line.sub(/\x0d?\x0a\z/o, '')
110
+ params["s"] = res.status # won't support "%>s"
111
+ params["t"] = req.request_time
112
+ params["T"] = Time.now - req.request_time
113
+ params["u"] = req.user || "-"
114
+ params["U"] = req.unparsed_uri
115
+ params["v"] = config[:ServerName]
116
+ params
117
+ end
118
+
119
+ ##
120
+ # Formats +params+ according to +format_string+ which is described in
121
+ # setup_params.
122
+
123
+ def format(format_string, params)
124
+ format_string.gsub(/\%(?:\{(.*?)\})?>?([a-zA-Z%])/){
125
+ param, spec = $1, $2
126
+ case spec[0]
127
+ when ?e, ?i, ?n, ?o
128
+ raise AccessLogError,
129
+ "parameter is required for \"#{spec}\"" unless param
130
+ (param = params[spec][param]) ? escape(param) : "-"
131
+ when ?t
132
+ params[spec].strftime(param || CLF_TIME_FORMAT)
133
+ when ?p
134
+ case param
135
+ when 'remote'
136
+ escape(params["i"].peeraddr[1].to_s)
137
+ else
138
+ escape(params["p"].to_s)
139
+ end
140
+ when ?%
141
+ "%"
142
+ else
143
+ escape(params[spec].to_s)
144
+ end
145
+ }
146
+ end
147
+
148
+ ##
149
+ # Escapes control characters in +data+
150
+
151
+ def escape(data)
152
+ data = data.gsub(/[[:cntrl:]\\]+/) {$&.dump[1...-1]}
153
+ data.untaint if RUBY_VERSION < '2.7'
154
+ data
155
+ end
156
+ end
157
+ end