graphiti 2.0.0.beta.7 → 2.0.0.beta.9

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 (251) hide show
  1. checksums.yaml +4 -4
  2. data/.git-blame-ignore-revs +2 -0
  3. data/.github/workflows/ci.yml +56 -4
  4. data/.github/workflows/docs.yml +10 -7
  5. data/.github/workflows/notify-example-app.yml +18 -0
  6. data/.github/workflows/release.yml +1 -1
  7. data/.gitignore +2 -0
  8. data/.standard.yml +6 -0
  9. data/CHANGELOG.md +66 -0
  10. data/CONTRIBUTING.md +3 -1
  11. data/README.md +13 -206
  12. data/Rakefile +34 -3
  13. data/UPGRADING.md +2 -2
  14. data/graphiti.gemspec +8 -4
  15. data/lib/generators/graphiti/generator_mixin.rb +1 -1
  16. data/lib/generators/graphiti/install_generator.rb +1 -1
  17. data/lib/generators/graphiti/resource_generator.rb +6 -3
  18. data/lib/generators/graphiti/templates/application_resource.rb.erb +19 -0
  19. data/lib/generators/graphiti/templates/controller.rb.erb +26 -8
  20. data/lib/graphiti/audit/report.rb +6 -6
  21. data/lib/graphiti/audit.rb +3 -4
  22. data/lib/graphiti/configuration.rb +11 -4
  23. data/lib/graphiti/debugger.rb +18 -6
  24. data/lib/graphiti/delegates/pagination.rb +2 -2
  25. data/lib/graphiti/deserializer.rb +3 -3
  26. data/lib/graphiti/error_serializers/deprecated_constants.rb +23 -0
  27. data/lib/graphiti/error_serializers/invalid_request.rb +6 -0
  28. data/lib/graphiti/errors.rb +22 -6
  29. data/lib/graphiti/extensions/temp_id.rb +1 -1
  30. data/lib/graphiti/query.rb +5 -4
  31. data/lib/graphiti/rails/context.rb +2 -1
  32. data/lib/graphiti/rails/controller.rb +3 -0
  33. data/lib/graphiti/rails/debugging.rb +1 -1
  34. data/lib/graphiti/rails/responders.rb +2 -1
  35. data/lib/graphiti/rails.rb +14 -0
  36. data/lib/graphiti/railtie.rb +8 -0
  37. data/lib/graphiti/resource/configuration.rb +1 -0
  38. data/lib/graphiti/resource/dsl.rb +2 -2
  39. data/lib/graphiti/resource/links.rb +1 -1
  40. data/lib/graphiti/resource/persistence.rb +1 -1
  41. data/lib/graphiti/resource/polymorphism.rb +1 -1
  42. data/lib/graphiti/resource.rb +2 -2
  43. data/lib/graphiti/resource_proxy.rb +0 -1
  44. data/lib/graphiti/scope.rb +68 -21
  45. data/lib/graphiti/scoping/filter.rb +5 -3
  46. data/lib/graphiti/scoping/paginate.rb +1 -1
  47. data/lib/graphiti/scoping/sort.rb +1 -1
  48. data/lib/graphiti/sideload/has_many.rb +1 -1
  49. data/lib/graphiti/sideload/polymorphic_belongs_to.rb +11 -4
  50. data/lib/graphiti/sideload.rb +8 -6
  51. data/lib/graphiti/spec_helpers/errors_proxy.rb +1 -1
  52. data/lib/graphiti/spec_helpers/matchers.rb +1 -1
  53. data/lib/graphiti/types.rb +5 -1
  54. data/lib/graphiti/util/cache_debug.rb +3 -3
  55. data/lib/graphiti/util/hash.rb +1 -1
  56. data/lib/graphiti/util/persistence.rb +6 -6
  57. data/lib/graphiti/util/serializer_relationships.rb +11 -2
  58. data/lib/graphiti/version.rb +1 -1
  59. data/lib/graphiti.rb +1 -1
  60. data/lib/tasks/graphiti.rake +1 -1
  61. data/package-lock.json +114 -0
  62. data/package.json +16 -3
  63. metadata +33 -198
  64. data/docs/concepts/backends-and-models.md +0 -122
  65. data/docs/concepts/endpoints.md +0 -183
  66. data/docs/concepts/links.md +0 -212
  67. data/docs/concepts/overview.md +0 -80
  68. data/docs/concepts/persisting.md +0 -376
  69. data/docs/concepts/relationships.md +0 -627
  70. data/docs/concepts/resources.md +0 -677
  71. data/docs/getting-started/first-api.md +0 -289
  72. data/docs/getting-started/installation.md +0 -185
  73. data/docs/intro.md +0 -307
  74. data/docs/js/authentication.md +0 -63
  75. data/docs/js/ddau.md +0 -20
  76. data/docs/js/extra-params.md +0 -41
  77. data/docs/js/index.md +0 -112
  78. data/docs/js/installation.md +0 -120
  79. data/docs/js/middleware.md +0 -72
  80. data/docs/js/models.md +0 -202
  81. data/docs/js/reads.md +0 -494
  82. data/docs/js/state-syncing.md +0 -100
  83. data/docs/js/writes.md +0 -373
  84. data/docs/reference/vandal.md +0 -63
  85. data/docs/reference/why.md +0 -13
  86. data/docs/topics/authorization.md +0 -155
  87. data/docs/topics/caching.md +0 -55
  88. data/docs/topics/customizing-sideloads.md +0 -156
  89. data/docs/topics/debugging.md +0 -242
  90. data/docs/topics/error-handling.md +0 -210
  91. data/docs/topics/etags.md +0 -46
  92. data/docs/topics/hopping-relationships.md +0 -149
  93. data/docs/topics/json-attributes.md +0 -77
  94. data/docs/topics/openstruct-models.md +0 -50
  95. data/docs/topics/remote-resources.md +0 -291
  96. data/docs/topics/testing.md +0 -916
  97. data/docs/topics/without-activerecord.md +0 -324
  98. data/docs/tutorial/index.md +0 -58
  99. data/docs/tutorial/step_0.md +0 -107
  100. data/docs/tutorial/step_1.md +0 -199
  101. data/docs/tutorial/step_2.md +0 -312
  102. data/docs/tutorial/step_3.md +0 -142
  103. data/docs/tutorial/step_4.md +0 -135
  104. data/docs/tutorial/step_5.md +0 -69
  105. data/docs/tutorial/step_6.md +0 -82
  106. data/docs/tutorial/step_7.md +0 -205
  107. data/docs/tutorial/step_8.md +0 -128
  108. data/docs/tutorial/step_9.md +0 -171
  109. data/docs/upgrading.md +0 -267
  110. data/website/.gitignore +0 -20
  111. data/website/README.md +0 -43
  112. data/website/docusaurus.config.js +0 -197
  113. data/website/package-lock.json +0 -19474
  114. data/website/package.json +0 -46
  115. data/website/sidebars.js +0 -82
  116. data/website/src/css/custom.css +0 -85
  117. data/website/src/pages/markdown-page.mdx +0 -7
  118. data/website/static/.nojekyll +0 -0
  119. data/website/static/1.13/2019/03/31/graphiti-1-0.html +0 -205
  120. data/website/static/1.13/2019/05/08/graphiti-1-1.html +0 -212
  121. data/website/static/1.13/2019/05/20/graphiti-1-2.html +0 -214
  122. data/website/static/1.13/2019/10/14/tutorial.html +0 -198
  123. data/website/static/1.13/CNAME +0 -1
  124. data/website/static/1.13/README.md +0 -16
  125. data/website/static/1.13/assets/css/syntax.css +0 -60
  126. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  127. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  128. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  129. data/website/static/1.13/assets/favicons/browserconfig.xml +0 -9
  130. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  131. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  132. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  133. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  134. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +0 -1
  135. data/website/static/1.13/assets/favicons/site.webmanifest +0 -19
  136. data/website/static/1.13/assets/img/backend.gif +0 -0
  137. data/website/static/1.13/assets/img/conformity.png +0 -0
  138. data/website/static/1.13/assets/img/error_payload.png +0 -0
  139. data/website/static/1.13/assets/img/fancy-cushion.png +0 -0
  140. data/website/static/1.13/assets/img/gh.png +0 -0
  141. data/website/static/1.13/assets/img/home-bg.jpg +0 -0
  142. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  143. data/website/static/1.13/assets/img/logo-500.png +0 -0
  144. data/website/static/1.13/assets/img/logo.png +0 -0
  145. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  146. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  147. data/website/static/1.13/assets/img/persist.jpg +0 -0
  148. data/website/static/1.13/assets/img/resource.gif +0 -0
  149. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  150. data/website/static/1.13/assets/img/rest1.gif +0 -0
  151. data/website/static/1.13/assets/img/rest2.gif +0 -0
  152. data/website/static/1.13/assets/img/rest3.gif +0 -0
  153. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  154. data/website/static/1.13/assets/img/sunrise.png +0 -0
  155. data/website/static/1.13/assets/img/why.png +0 -0
  156. data/website/static/1.13/assets/js/highlight.pack.js +0 -2
  157. data/website/static/1.13/assets/main.css +0 -15518
  158. data/website/static/1.13/assets/main.css.map +0 -1
  159. data/website/static/1.13/bin/bundle +0 -109
  160. data/website/static/1.13/bin/jekyll +0 -27
  161. data/website/static/1.13/bin/kramdown +0 -27
  162. data/website/static/1.13/bin/listen +0 -27
  163. data/website/static/1.13/bin/rake +0 -27
  164. data/website/static/1.13/bin/rougify +0 -27
  165. data/website/static/1.13/bin/safe_yaml +0 -27
  166. data/website/static/1.13/bin/sass +0 -27
  167. data/website/static/1.13/bin/sass-convert +0 -27
  168. data/website/static/1.13/bin/scss +0 -27
  169. data/website/static/1.13/blog.html +0 -259
  170. data/website/static/1.13/cheatsheet.html +0 -316
  171. data/website/static/1.13/cookbooks/authorization.md +0 -0
  172. data/website/static/1.13/cookbooks/caching.md +0 -0
  173. data/website/static/1.13/cookbooks/customizing-sideloads.html +0 -325
  174. data/website/static/1.13/cookbooks/etags.md +0 -0
  175. data/website/static/1.13/cookbooks/hopping-relationships.html +0 -324
  176. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  177. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  178. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  179. data/website/static/1.13/cookbooks/without-activerecord.html +0 -510
  180. data/website/static/1.13/features.html +0 -249
  181. data/website/static/1.13/feed.xml +0 -106
  182. data/website/static/1.13/guides/concepts/backends-and-models.html +0 -467
  183. data/website/static/1.13/guides/concepts/debugging.html +0 -440
  184. data/website/static/1.13/guides/concepts/endpoints.html +0 -432
  185. data/website/static/1.13/guides/concepts/error-handling.html +0 -396
  186. data/website/static/1.13/guides/concepts/links.html +0 -501
  187. data/website/static/1.13/guides/concepts/remote-resources.html +0 -536
  188. data/website/static/1.13/guides/concepts/resources.html +0 -2176
  189. data/website/static/1.13/guides/concepts/testing.html +0 -1469
  190. data/website/static/1.13/guides/getting-started/installation.html +0 -420
  191. data/website/static/1.13/guides/graphiti-rails-migration.html +0 -242
  192. data/website/static/1.13/guides/index.html +0 -269
  193. data/website/static/1.13/guides/overview.html +0 -325
  194. data/website/static/1.13/guides/upgrading-2-0.html +0 -193
  195. data/website/static/1.13/guides/upgrading.html +0 -314
  196. data/website/static/1.13/guides/vandal.html +0 -282
  197. data/website/static/1.13/guides/why.html +0 -1121
  198. data/website/static/1.13/index.html +0 -72
  199. data/website/static/1.13/js/authentication.html +0 -295
  200. data/website/static/1.13/js/ddau.html +0 -238
  201. data/website/static/1.13/js/extra-params.html +0 -270
  202. data/website/static/1.13/js/index.html +0 -321
  203. data/website/static/1.13/js/installation.html +0 -637
  204. data/website/static/1.13/js/introduction.html +0 -257
  205. data/website/static/1.13/js/middleware.html +0 -318
  206. data/website/static/1.13/js/reads/fieldsets.html +0 -271
  207. data/website/static/1.13/js/reads/filtering.html +0 -289
  208. data/website/static/1.13/js/reads/includes.html +0 -260
  209. data/website/static/1.13/js/reads/index.html +0 -497
  210. data/website/static/1.13/js/reads/nested-queries.html +0 -353
  211. data/website/static/1.13/js/reads/pagination.html +0 -260
  212. data/website/static/1.13/js/reads/sorting.html +0 -265
  213. data/website/static/1.13/js/reads/statistics.html +0 -289
  214. data/website/static/1.13/js/state-syncing.html +0 -340
  215. data/website/static/1.13/js/writes/deferred.html +0 -296
  216. data/website/static/1.13/js/writes/dirty-tracking.html +0 -399
  217. data/website/static/1.13/js/writes/index.html +0 -391
  218. data/website/static/1.13/js/writes/nested.html +0 -330
  219. data/website/static/1.13/js/writes/validations.html +0 -272
  220. data/website/static/1.13/quickstart.html +0 -660
  221. data/website/static/1.13/template +0 -161
  222. data/website/static/1.13/tutorial/index.html +0 -250
  223. data/website/static/1.13/tutorial/step_0.html +0 -292
  224. data/website/static/1.13/tutorial/step_1.html +0 -517
  225. data/website/static/1.13/tutorial/step_2.html +0 -481
  226. data/website/static/1.13/tutorial/step_3.html +0 -323
  227. data/website/static/1.13/tutorial/step_4.html +0 -318
  228. data/website/static/1.13/tutorial/step_5.html +0 -265
  229. data/website/static/1.13/tutorial/step_6.html +0 -276
  230. data/website/static/1.13/tutorial/step_7.html +0 -390
  231. data/website/static/1.13/tutorial/step_8.html +0 -316
  232. data/website/static/1.13/tutorial/step_9.html +0 -365
  233. data/website/static/CNAME +0 -1
  234. data/website/static/assets/img/error_payload.png +0 -0
  235. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  236. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  237. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  238. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  239. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  240. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  241. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  242. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  243. data/website/static/assets/img/meta_total_count.png +0 -0
  244. data/website/static/img/docusaurus-social-card.jpg +0 -0
  245. data/website/static/img/docusaurus.png +0 -0
  246. data/website/static/img/favicon.ico +0 -0
  247. data/website/static/img/logo.png +0 -0
  248. data/website/static/img/logo.svg +0 -1
  249. data/website/static/img/undraw_docusaurus_mountain.svg +0 -171
  250. data/website/static/img/undraw_docusaurus_react.svg +0 -170
  251. data/website/static/img/undraw_docusaurus_tree.svg +0 -40
data/website/static/1.13/guides/concepts/error-handling.html DELETED
@@ -1,396 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
-
4
- <head>
5
- <meta charset="utf-8">
6
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
7
- <meta name="viewport" content="width=device-width, initial-scale=1">
8
- <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet">
9
- <link href="https://fonts.googleapis.com/css?family=Boogaloo" rel="stylesheet">
10
-
11
- <link rel="apple-touch-icon" sizes="180x180" href="/1.13/assets/favicons/apple-touch-icon.png">
12
- <link rel="icon" type="image/png" sizes="32x32" href="/1.13/assets/favicons/favicon-32x32.png">
13
- <link rel="icon" type="image/png" sizes="16x16" href="/1.13/assets/favicons/favicon-16x16.png">
14
- <link rel="manifest" href="/1.13/assets/favicons/site.webmanifest">
15
- <link rel="mask-icon" href="/1.13/assets/favicons/safari-pinned-tab.svg" color="#F86DA7">
16
- <link rel="shortcut icon" href="/1.13/assets/favicons/favicon.ico">
17
- <meta name="msapplication-TileColor" content="#F86DA7">
18
- <meta name="msapplication-config" content="/1.13/assets/favicons/browserconfig.xml">
19
- <meta name="theme-color" content="#F86DA7">
20
-
21
- <title>Graphiti</title>
22
- <meta name="description" content="Stylish Graph APIs">
23
-
24
- <link rel="stylesheet" href="/1.13/assets/main.css?ref=wh4t3v45">
25
- <link rel="alternate" type="application/rss+xml" title="Graphiti" href="/1.13/feed.xml">
26
-
27
- <!-- Global site tag (gtag.js) - Google Analytics -->
28
- <script async src="https://www.googletagmanager.com/gtag/js?id=UA-127904727-1"></script>
29
- <script>
30
- window.dataLayer = window.dataLayer || [];
31
- function gtag(){dataLayer.push(arguments);}
32
- gtag('js', new Date());
33
-
34
- gtag('config', 'UA-127904727-1');
35
- </script>
36
-
37
- <!-- javascript -->
38
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
39
- <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
40
-
41
-
42
- </head>
43
-
44
-
45
- <body>
46
- <main class="page-content" aria-label="Content">
47
- <div class="wrapper">
48
- <header class="navbar navbar-inverse normal" role="banner">
49
- <div class="container">
50
- <div class="navbar-header">
51
- <a href="/1.13/1.13" class="navbar-brand">
52
- <img alt="logo" src="/1.13/assets/img/logo.png">
53
- </a>
54
- </div>
55
- <nav class="" role="navigation">
56
- <ul class="nav navbar-nav nav-links">
57
- <li>
58
- <a class="quickstart nav-link" href="/1.13/quickstart">Quickstart</a>
59
- </li>
60
- <li>
61
- <a class="guides nav-link" href="/1.13/guides">Guides</a>
62
- </li>
63
- <li>
64
- <a class="tutorial nav-link" href="/1.13/tutorial">Tutorial</a>
65
- </li>
66
- <li>
67
- <a class="spraypaint nav-link" href="/1.13/js">Spraypaint</a>
68
- </li>
69
- </ul>
70
- <ul class="nav gh navbar-nav navbar-right visible-lg visible-md">
71
- <li>
72
- <span class="star">⭐</span>
73
- <a href="https://github.com/graphiti-api/graphiti">
74
- <img alt="github-star" style="margin-right: 65px;margin-top: -20px" src="/1.13/assets/img/gh.png">
75
- </a>
76
- </li>
77
- </ul>
78
- </nav>
79
- </div>
80
- </header>
81
-
82
- <div class="container">
83
- <div class="toc col-md-3">
84
- <h1 id="error-handling">Error Handling</h1>
85
-
86
- <ul>
87
- <li>1 <a href="#overview">Overview</a>
88
- <ul>
89
- <li><a href="#setup">Setup</a></li>
90
- <li><a href="#displaying-raw-errors">Displaying Raw Errors</a></li>
91
- </ul>
92
- </li>
93
- <li>2 <a href="#usage">Usage</a>
94
- <ul>
95
- <li><a href="#basic">Basic</a></li>
96
- <li><a href="#advanced">Advanced</a></li>
97
- </ul>
98
- </li>
99
- <li>3 <a href="#testing">Testing</a></li>
100
- </ul>
101
-
102
- </div>
103
-
104
- <div class="col-md-8">
105
-
106
- <a class="anchor" id="overview" />
107
- <a class="header" href="#overview">
108
- <h2>
109
- 1 Overview
110
- </h2>
111
- </a>
112
-
113
- <p>Whenever we have an application error, we want to respond with a
114
- <a href="http://jsonapi.org/format/#errors">JSONAPI-compliant errors payload</a>.
115
- This way clients have a predictable response detailing information about
116
- the error.</p>
117
-
118
- <p align="center">
119
- <img width="100%" src="https://user-images.githubusercontent.com/55264/45879320-06096300-bd72-11e8-8920-6e83f4a2fce3.png" />
120
- </p>
121
-
122
- <p>We’ll also need a way to customize this payload. For instance, if a
123
- <code class="language-plaintext highlighter-rouge">NotAuthorized</code> error is raised, the response should have a <code class="language-plaintext highlighter-rouge">403</code> status
124
- code. For other errors, we may want to render a helpful error message:</p>
125
-
126
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationController</span> <span class="o">&lt;</span> <span class="no">ActionController</span><span class="o">::</span><span class="no">API</span>
127
- <span class="n">register_exception</span> <span class="no">NotAuthorized</span><span class="p">,</span> <span class="ss">status: </span><span class="mi">403</span>
128
- <span class="n">register_exception</span> <span class="no">ShipmentDelayed</span><span class="p">,</span>
129
- <span class="ss">detail: </span><span class="o">-&gt;</span><span class="p">(</span><span class="n">e</span><span class="p">)</span> <span class="p">{</span> <span class="s2">"Contact us at 123-456-7899"</span> <span class="p">}</span>
130
- <span class="c1"># ... code ...</span>
131
- <span class="k">end</span></code></pre></figure>
132
-
133
- <p>Exception handling lives in Graphiti’s Rails integration. Customizing the behavior based on error class happens in the <a href="https://github.com/wagenet/rescue_registry">RescueRegistry</a> dependency.</p>
134
-
135
- <a class="anchor" id="setup" />
136
- <a class="header" href="#setup">
137
- <h3>
138
- 1.1 Setup
139
- </h3>
140
- </a>
141
-
142
- <p>Include the Rails integration in the controllers serving your resources:</p>
143
-
144
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationController</span> <span class="o">&lt;</span> <span class="no">ActionController</span><span class="o">::</span><span class="no">Base</span>
145
- <span class="kp">include</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Rails</span><span class="o">::</span><span class="no">Controller</span>
146
- <span class="k">end</span></code></pre></figure>
147
-
148
- <p>That registers handlers for Graphiti’s own exceptions and renders anything else as JSON:API. <code class="language-plaintext highlighter-rouge">register_exception</code> itself is available on every controller without it — see below.</p>
149
-
150
- <a class="anchor" id="displaying-raw-errors" />
151
- <a class="header" href="#displaying-raw-errors">
152
- <h4>
153
- 1.1.1 Displaying Raw Errors
154
- </h4>
155
- </a>
156
-
157
- <p align="center">
158
- <img width="100%" src="https://user-images.githubusercontent.com/55264/45879208-9bf0be00-bd71-11e8-8427-282c5a426394.png" />
159
- </p>
160
- <p><br /></p>
161
-
162
- <p>It can be useful to display the raw error as part of the JSON response -
163
- but you probably don’t want to expose your stack trace to customers.
164
- Let’s only show raw errors for the <code class="language-plaintext highlighter-rouge">staging</code> environment:</p>
165
-
166
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationController</span> <span class="o">&lt;</span> <span class="no">ActionController</span><span class="o">::</span><span class="no">API</span>
167
- <span class="c1"># ... code ...</span>
168
-
169
- <span class="k">def</span> <span class="nf">show_detailed_exceptions?</span>
170
- <span class="no">Rails</span><span class="p">.</span><span class="nf">env</span><span class="p">.</span><span class="nf">staging?</span>
171
- <span class="k">end</span>
172
- <span class="k">end</span></code></pre></figure>
173
-
174
- <p>Another common pattern is to only show raw errors when the user is
175
- privileged to see them:</p>
176
-
177
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationController</span> <span class="o">&lt;</span> <span class="no">ActionController</span><span class="o">::</span><span class="no">API</span>
178
- <span class="c1"># ... code ...</span>
179
-
180
- <span class="k">def</span> <span class="nf">show_detailed_exceptions?</span>
181
- <span class="n">current_user</span><span class="p">.</span><span class="nf">admin?</span>
182
- <span class="k">end</span>
183
- <span class="k">end</span></code></pre></figure>
184
-
185
- <p>When <code class="language-plaintext highlighter-rouge">#show_detailed_exceptions?</code> returns <code class="language-plaintext highlighter-rouge">true</code>, you’ll get the raw error class,
186
- message, and backtrace in the JSON response.</p>
187
-
188
- <a class="anchor" id="usage" />
189
- <a class="header" href="#usage">
190
- <h2>
191
- 2 Usage
192
- </h2>
193
- </a>
194
-
195
- <a class="anchor" id="basic" />
196
- <a class="header" href="#basic">
197
- <h3>
198
- 2.1 Basic
199
- </h3>
200
- </a>
201
-
202
- <p>Let’s register an error with a custom response code:</p>
203
-
204
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">register_exception</span> <span class="no">Errors</span><span class="o">::</span><span class="no">NotAuthorized</span><span class="p">,</span> <span class="ss">status: </span><span class="mi">403</span></code></pre></figure>
205
-
206
- <p>Now if we <code class="language-plaintext highlighter-rouge">raise Errors::NotAuthorized</code>, the response code will be
207
- <code class="language-plaintext highlighter-rouge">403</code>.</p>
208
-
209
- <p>Additional options:</p>
210
-
211
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">register_exception</span> <span class="no">Errors</span><span class="o">::</span><span class="no">NotAuthorized</span><span class="p">,</span>
212
- <span class="ss">status: </span><span class="mi">403</span><span class="p">,</span>
213
- <span class="ss">title: </span><span class="s2">"You cannot perform this action"</span><span class="p">,</span>
214
- <span class="ss">detail: :exception</span><span class="p">,</span> <span class="c1"># render the raw error message</span>
215
- <span class="ss">detail: </span><span class="o">-&gt;</span><span class="p">(</span><span class="n">error</span><span class="p">)</span> <span class="p">{</span> <span class="s2">"Invalid Action"</span> <span class="p">}</span> <span class="c1"># message via proc</span></code></pre></figure>
216
-
217
- <p><a href="https://github.com/wagenet/rescue_registry">See full documentation in the RescueRegistry README</a>.</p>
218
-
219
- <p>All controllers will inherit any registered exceptions from their parent. They can also add their own. In this example, <code class="language-plaintext highlighter-rouge">FooError</code> will only throw a custom status code when thrown from <code class="language-plaintext highlighter-rouge">FooController</code>:</p>
220
-
221
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">FooController</span> <span class="o">&lt;</span> <span class="no">ApplicationController</span>
222
- <span class="n">register_exception</span> <span class="no">FooError</span><span class="p">,</span> <span class="ss">status: </span><span class="mi">422</span>
223
- <span class="k">end</span></code></pre></figure>
224
-
225
- <a class="anchor" id="advanced" />
226
- <a class="header" href="#advanced">
227
- <h3>
228
- 2.2 Advanced
229
- </h3>
230
- </a>
231
-
232
- <p>The final option <code class="language-plaintext highlighter-rouge">register_exception</code> accepts is <code class="language-plaintext highlighter-rouge">handler</code>. Here you can inject your own error handling class that customize <code class="language-plaintext highlighter-rouge">RescueRegistry::ExceptionHandler</code>. For example:</p>
233
-
234
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">MyCustomHandler</span> <span class="o">&lt;</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Rails</span><span class="o">::</span><span class="no">ExceptionHandler</span>
235
- <span class="c1"># self.exception accessible within all instance methods</span>
236
-
237
- <span class="k">def</span> <span class="nf">status_code</span>
238
- <span class="c1"># ...customize...</span>
239
- <span class="k">end</span>
240
-
241
- <span class="k">def</span> <span class="nf">error_code</span>
242
- <span class="c1"># ...customize...</span>
243
- <span class="k">end</span>
244
-
245
- <span class="k">def</span> <span class="nf">title</span>
246
- <span class="c1"># ...customize...</span>
247
- <span class="k">end</span>
248
-
249
- <span class="k">def</span> <span class="nf">detail</span>
250
- <span class="c1"># ...customize...</span>
251
- <span class="k">end</span>
252
-
253
- <span class="k">def</span> <span class="nf">meta</span>
254
- <span class="c1"># ...customize...</span>
255
- <span class="k">end</span>
256
- <span class="k">end</span>
257
-
258
- <span class="n">register_exception</span> <span class="no">FooError</span><span class="p">,</span> <span class="ss">handler: </span><span class="no">MyCustomHandler</span></code></pre></figure>
259
-
260
- <p>If you would like to use the same custom handler for all errors, override <code class="language-plaintext highlighter-rouge">default_exception_handler</code>:</p>
261
-
262
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/controllers/application_controller.rb</span>
263
- <span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">default_exception_handler</span>
264
- <span class="no">MyCustomHandler</span>
265
- <span class="k">end</span></code></pre></figure>
266
-
267
- <a class="anchor" id="testing" />
268
- <a class="header" href="#testing">
269
- <h2>
270
- 3 Testing
271
- </h2>
272
- </a>
273
-
274
- <p>This pattern of globally rescuing exceptions makes sense when
275
- running our live application…but during testing, we may want to
276
- raise real errors and bypass this rescue logic.</p>
277
-
278
- <p>This is why we turn off error-handling during tests by default:</p>
279
-
280
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># spec/rails_helper.rb</span>
281
- <span class="no">RSpec</span><span class="p">.</span><span class="nf">configure</span> <span class="k">do</span> <span class="o">|</span><span class="n">config</span><span class="o">|</span>
282
- <span class="n">config</span><span class="p">.</span><span class="nf">include</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Rails</span><span class="o">::</span><span class="no">TestHelpers</span>
283
- <span class="c1"># ... code ...</span>
284
-
285
- <span class="n">config</span><span class="p">.</span><span class="nf">before</span> <span class="ss">:each</span> <span class="k">do</span>
286
- <span class="n">handle_request_exceptions</span><span class="p">(</span><span class="kp">false</span><span class="p">)</span>
287
- <span class="k">end</span>
288
- <span class="k">end</span></code></pre></figure>
289
-
290
- <p>If you want to turn this on for an individual test (so you can test
291
- error codes, etc):</p>
292
-
293
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">before</span> <span class="k">do</span>
294
- <span class="n">handle_request_exceptions</span><span class="p">(</span><span class="kp">true</span><span class="p">)</span>
295
- <span class="k">end</span></code></pre></figure>
296
-
297
- <p><br />
298
- <br /></p>
299
-
300
- </div>
301
-
302
- </div>
303
- </div>
304
- </main>
305
- <div class="main-footer main-footer--dark">
306
- <div class="container">
307
- <div class="row">
308
- <div class="col-sm-4 menu">
309
- <h3>Overview</h3>
310
- <ul>
311
- <li>
312
- <a href="/1.13/quickstart">Quickstart</a>
313
- </li>
314
- <li>
315
- <a href="/1.13/tutorial">Tutorial</a>
316
- </li>
317
- <li>
318
- <a href="/1.13/guides">Guides</a>
319
- </li>
320
- </ul>
321
- </div>
322
- <div class="col-sm-4 menu">
323
- <h3>Contact</h3>
324
- <ul>
325
- <li>
326
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
327
- </li>
328
- <li>
329
- <a href="mailto:richmolj@gmail.com">Email</a>
330
- </li>
331
- </ul>
332
- </div>
333
- <div class="col-sm-4 menu">
334
- <h3>Related</h3>
335
- <ul>
336
- <li>
337
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
338
- </li>
339
- <li>
340
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
341
- </li>
342
- <li>
343
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
344
- </li>
345
- </ul>
346
- </div>
347
- </div>
348
- </div>
349
- </div>
350
-
351
- <script type="text/javascript">
352
- $(function () {
353
-
354
- var flipTabs = function() {
355
- var isTS = true;
356
- if (localStorage.getItem('js-lang') === 'javascript') {
357
- isTS = false;
358
- }
359
-
360
- $('.code-tabs').each(function(index, el) {
361
- if (isTS) {
362
- console.log('hiding js');
363
- $($(el).children()[1]).hide();
364
- $($(el).children()[0]).show();
365
- } else {
366
- console.log('hiding ts');
367
- $($(el).children()[0]).hide();
368
- $($(el).children()[1]).show();
369
- }
370
- });
371
-
372
- if (isTS) {
373
- $('.tab.typescript').addClass('active');
374
- $('.tab.javascript').removeClass('active');
375
- } else {
376
- $('.tab.typescript').removeClass('active');
377
- $('.tab.javascript').addClass('active');
378
- }
379
- }
380
-
381
- $('.tab').click(function() {
382
- if ($(this).hasClass('typescript')) {
383
- localStorage.setItem('js-lang', 'typescript');
384
- } else {
385
- localStorage.setItem('js-lang', 'javascript');
386
- }
387
-
388
- flipTabs();
389
- });
390
-
391
- flipTabs();
392
- })
393
- </script>
394
-
395
- </body>
396
- </html>