graphiti 2.0.0.beta.6 → 2.0.0.beta.8

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 (246) hide show
  1. checksums.yaml +4 -4
  2. data/.git-blame-ignore-revs +2 -0
  3. data/.github/workflows/ci.yml +55 -3
  4. data/.github/workflows/docs.yml +1 -1
  5. data/.github/workflows/notify-example-app.yml +18 -0
  6. data/.gitignore +2 -0
  7. data/.standard.yml +6 -0
  8. data/CHANGELOG.md +54 -0
  9. data/CONTRIBUTING.md +3 -1
  10. data/README.md +13 -206
  11. data/Rakefile +6 -3
  12. data/UPGRADING.md +1 -1
  13. data/graphiti.gemspec +8 -4
  14. data/lib/generators/graphiti/generator_mixin.rb +1 -1
  15. data/lib/generators/graphiti/install_generator.rb +1 -2
  16. data/lib/generators/graphiti/resource_generator.rb +6 -3
  17. data/lib/generators/graphiti/templates/application_resource.rb.erb +19 -0
  18. data/lib/generators/graphiti/templates/controller.rb.erb +26 -8
  19. data/lib/generators/graphiti/templates/index_request_spec.rb.erb +2 -2
  20. data/lib/generators/graphiti/templates/resource_reads_spec.rb.erb +4 -4
  21. data/lib/generators/graphiti/templates/show_request_spec.rb.erb +2 -2
  22. data/lib/graphiti/audit/report.rb +6 -6
  23. data/lib/graphiti/audit.rb +3 -4
  24. data/lib/graphiti/delegates/pagination.rb +2 -2
  25. data/lib/graphiti/deserializer.rb +3 -3
  26. data/lib/graphiti/errors.rb +6 -6
  27. data/lib/graphiti/extensions/temp_id.rb +1 -1
  28. data/lib/graphiti/query.rb +27 -8
  29. data/lib/graphiti/rails/context.rb +2 -1
  30. data/lib/graphiti/rails/controller.rb +3 -0
  31. data/lib/graphiti/rails/debugging.rb +1 -1
  32. data/lib/graphiti/rails/responders.rb +2 -1
  33. data/lib/graphiti/resource/configuration.rb +1 -0
  34. data/lib/graphiti/resource/dsl.rb +2 -2
  35. data/lib/graphiti/resource/interface.rb +3 -3
  36. data/lib/graphiti/resource/links.rb +1 -1
  37. data/lib/graphiti/resource/persistence.rb +1 -1
  38. data/lib/graphiti/resource/polymorphism.rb +1 -1
  39. data/lib/graphiti/resource.rb +2 -2
  40. data/lib/graphiti/resource_proxy.rb +0 -1
  41. data/lib/graphiti/runner.rb +8 -3
  42. data/lib/graphiti/scope.rb +13 -0
  43. data/lib/graphiti/scoping/filter.rb +5 -3
  44. data/lib/graphiti/scoping/paginate.rb +1 -1
  45. data/lib/graphiti/scoping/sort.rb +1 -1
  46. data/lib/graphiti/sideload/has_many.rb +1 -1
  47. data/lib/graphiti/spec_helpers/errors_proxy.rb +1 -1
  48. data/lib/graphiti/spec_helpers/matchers.rb +1 -1
  49. data/lib/graphiti/spec_helpers.rb +5 -0
  50. data/lib/graphiti/types.rb +5 -1
  51. data/lib/graphiti/util/cache_debug.rb +3 -3
  52. data/lib/graphiti/util/hash.rb +1 -1
  53. data/lib/graphiti/util/persistence.rb +6 -6
  54. data/lib/graphiti/util/serializer_relationships.rb +1 -1
  55. data/lib/graphiti/version.rb +1 -1
  56. data/lib/tasks/graphiti.rake +1 -1
  57. data/package.json +1 -0
  58. metadata +31 -197
  59. data/docs/concepts/backends-and-models.md +0 -122
  60. data/docs/concepts/endpoints.md +0 -183
  61. data/docs/concepts/links.md +0 -212
  62. data/docs/concepts/overview.md +0 -80
  63. data/docs/concepts/persisting.md +0 -376
  64. data/docs/concepts/relationships.md +0 -627
  65. data/docs/concepts/resources.md +0 -677
  66. data/docs/getting-started/first-api.md +0 -289
  67. data/docs/getting-started/installation.md +0 -185
  68. data/docs/intro.md +0 -307
  69. data/docs/js/authentication.md +0 -63
  70. data/docs/js/ddau.md +0 -20
  71. data/docs/js/extra-params.md +0 -41
  72. data/docs/js/index.md +0 -112
  73. data/docs/js/installation.md +0 -120
  74. data/docs/js/middleware.md +0 -72
  75. data/docs/js/models.md +0 -202
  76. data/docs/js/reads.md +0 -494
  77. data/docs/js/state-syncing.md +0 -100
  78. data/docs/js/writes.md +0 -373
  79. data/docs/reference/vandal.md +0 -63
  80. data/docs/reference/why.md +0 -13
  81. data/docs/topics/authorization.md +0 -155
  82. data/docs/topics/caching.md +0 -55
  83. data/docs/topics/customizing-sideloads.md +0 -156
  84. data/docs/topics/debugging.md +0 -242
  85. data/docs/topics/error-handling.md +0 -210
  86. data/docs/topics/etags.md +0 -46
  87. data/docs/topics/hopping-relationships.md +0 -149
  88. data/docs/topics/json-attributes.md +0 -77
  89. data/docs/topics/openstruct-models.md +0 -50
  90. data/docs/topics/remote-resources.md +0 -291
  91. data/docs/topics/testing.md +0 -894
  92. data/docs/topics/without-activerecord.md +0 -324
  93. data/docs/tutorial/index.md +0 -58
  94. data/docs/tutorial/step_0.md +0 -107
  95. data/docs/tutorial/step_1.md +0 -199
  96. data/docs/tutorial/step_2.md +0 -312
  97. data/docs/tutorial/step_3.md +0 -142
  98. data/docs/tutorial/step_4.md +0 -135
  99. data/docs/tutorial/step_5.md +0 -69
  100. data/docs/tutorial/step_6.md +0 -82
  101. data/docs/tutorial/step_7.md +0 -205
  102. data/docs/tutorial/step_8.md +0 -128
  103. data/docs/tutorial/step_9.md +0 -171
  104. data/docs/upgrading.md +0 -266
  105. data/website/.gitignore +0 -20
  106. data/website/README.md +0 -43
  107. data/website/docusaurus.config.js +0 -197
  108. data/website/package-lock.json +0 -19474
  109. data/website/package.json +0 -46
  110. data/website/sidebars.js +0 -82
  111. data/website/src/css/custom.css +0 -85
  112. data/website/src/pages/markdown-page.mdx +0 -7
  113. data/website/static/.nojekyll +0 -0
  114. data/website/static/1.13/2019/03/31/graphiti-1-0.html +0 -205
  115. data/website/static/1.13/2019/05/08/graphiti-1-1.html +0 -212
  116. data/website/static/1.13/2019/05/20/graphiti-1-2.html +0 -214
  117. data/website/static/1.13/2019/10/14/tutorial.html +0 -198
  118. data/website/static/1.13/CNAME +0 -1
  119. data/website/static/1.13/README.md +0 -16
  120. data/website/static/1.13/assets/css/syntax.css +0 -60
  121. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  122. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  123. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  124. data/website/static/1.13/assets/favicons/browserconfig.xml +0 -9
  125. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  126. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  127. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  128. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  129. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +0 -1
  130. data/website/static/1.13/assets/favicons/site.webmanifest +0 -19
  131. data/website/static/1.13/assets/img/backend.gif +0 -0
  132. data/website/static/1.13/assets/img/conformity.png +0 -0
  133. data/website/static/1.13/assets/img/error_payload.png +0 -0
  134. data/website/static/1.13/assets/img/fancy-cushion.png +0 -0
  135. data/website/static/1.13/assets/img/gh.png +0 -0
  136. data/website/static/1.13/assets/img/home-bg.jpg +0 -0
  137. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  138. data/website/static/1.13/assets/img/logo-500.png +0 -0
  139. data/website/static/1.13/assets/img/logo.png +0 -0
  140. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  141. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  142. data/website/static/1.13/assets/img/persist.jpg +0 -0
  143. data/website/static/1.13/assets/img/resource.gif +0 -0
  144. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  145. data/website/static/1.13/assets/img/rest1.gif +0 -0
  146. data/website/static/1.13/assets/img/rest2.gif +0 -0
  147. data/website/static/1.13/assets/img/rest3.gif +0 -0
  148. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  149. data/website/static/1.13/assets/img/sunrise.png +0 -0
  150. data/website/static/1.13/assets/img/why.png +0 -0
  151. data/website/static/1.13/assets/js/highlight.pack.js +0 -2
  152. data/website/static/1.13/assets/main.css +0 -15518
  153. data/website/static/1.13/assets/main.css.map +0 -1
  154. data/website/static/1.13/bin/bundle +0 -109
  155. data/website/static/1.13/bin/jekyll +0 -27
  156. data/website/static/1.13/bin/kramdown +0 -27
  157. data/website/static/1.13/bin/listen +0 -27
  158. data/website/static/1.13/bin/rake +0 -27
  159. data/website/static/1.13/bin/rougify +0 -27
  160. data/website/static/1.13/bin/safe_yaml +0 -27
  161. data/website/static/1.13/bin/sass +0 -27
  162. data/website/static/1.13/bin/sass-convert +0 -27
  163. data/website/static/1.13/bin/scss +0 -27
  164. data/website/static/1.13/blog.html +0 -259
  165. data/website/static/1.13/cheatsheet.html +0 -316
  166. data/website/static/1.13/cookbooks/authorization.md +0 -0
  167. data/website/static/1.13/cookbooks/caching.md +0 -0
  168. data/website/static/1.13/cookbooks/customizing-sideloads.html +0 -325
  169. data/website/static/1.13/cookbooks/etags.md +0 -0
  170. data/website/static/1.13/cookbooks/hopping-relationships.html +0 -324
  171. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  172. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  173. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  174. data/website/static/1.13/cookbooks/without-activerecord.html +0 -510
  175. data/website/static/1.13/features.html +0 -249
  176. data/website/static/1.13/feed.xml +0 -106
  177. data/website/static/1.13/guides/concepts/backends-and-models.html +0 -467
  178. data/website/static/1.13/guides/concepts/debugging.html +0 -440
  179. data/website/static/1.13/guides/concepts/endpoints.html +0 -432
  180. data/website/static/1.13/guides/concepts/error-handling.html +0 -396
  181. data/website/static/1.13/guides/concepts/links.html +0 -501
  182. data/website/static/1.13/guides/concepts/remote-resources.html +0 -536
  183. data/website/static/1.13/guides/concepts/resources.html +0 -2176
  184. data/website/static/1.13/guides/concepts/testing.html +0 -1469
  185. data/website/static/1.13/guides/getting-started/installation.html +0 -420
  186. data/website/static/1.13/guides/graphiti-rails-migration.html +0 -242
  187. data/website/static/1.13/guides/index.html +0 -269
  188. data/website/static/1.13/guides/overview.html +0 -325
  189. data/website/static/1.13/guides/upgrading-2-0.html +0 -193
  190. data/website/static/1.13/guides/upgrading.html +0 -314
  191. data/website/static/1.13/guides/vandal.html +0 -282
  192. data/website/static/1.13/guides/why.html +0 -1121
  193. data/website/static/1.13/index.html +0 -72
  194. data/website/static/1.13/js/authentication.html +0 -295
  195. data/website/static/1.13/js/ddau.html +0 -238
  196. data/website/static/1.13/js/extra-params.html +0 -270
  197. data/website/static/1.13/js/index.html +0 -321
  198. data/website/static/1.13/js/installation.html +0 -637
  199. data/website/static/1.13/js/introduction.html +0 -257
  200. data/website/static/1.13/js/middleware.html +0 -318
  201. data/website/static/1.13/js/reads/fieldsets.html +0 -271
  202. data/website/static/1.13/js/reads/filtering.html +0 -289
  203. data/website/static/1.13/js/reads/includes.html +0 -260
  204. data/website/static/1.13/js/reads/index.html +0 -497
  205. data/website/static/1.13/js/reads/nested-queries.html +0 -353
  206. data/website/static/1.13/js/reads/pagination.html +0 -260
  207. data/website/static/1.13/js/reads/sorting.html +0 -265
  208. data/website/static/1.13/js/reads/statistics.html +0 -289
  209. data/website/static/1.13/js/state-syncing.html +0 -340
  210. data/website/static/1.13/js/writes/deferred.html +0 -296
  211. data/website/static/1.13/js/writes/dirty-tracking.html +0 -399
  212. data/website/static/1.13/js/writes/index.html +0 -391
  213. data/website/static/1.13/js/writes/nested.html +0 -330
  214. data/website/static/1.13/js/writes/validations.html +0 -272
  215. data/website/static/1.13/quickstart.html +0 -660
  216. data/website/static/1.13/template +0 -161
  217. data/website/static/1.13/tutorial/index.html +0 -250
  218. data/website/static/1.13/tutorial/step_0.html +0 -292
  219. data/website/static/1.13/tutorial/step_1.html +0 -517
  220. data/website/static/1.13/tutorial/step_2.html +0 -481
  221. data/website/static/1.13/tutorial/step_3.html +0 -323
  222. data/website/static/1.13/tutorial/step_4.html +0 -318
  223. data/website/static/1.13/tutorial/step_5.html +0 -265
  224. data/website/static/1.13/tutorial/step_6.html +0 -276
  225. data/website/static/1.13/tutorial/step_7.html +0 -390
  226. data/website/static/1.13/tutorial/step_8.html +0 -316
  227. data/website/static/1.13/tutorial/step_9.html +0 -365
  228. data/website/static/CNAME +0 -1
  229. data/website/static/assets/img/error_payload.png +0 -0
  230. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  231. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  232. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  233. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  234. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  235. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  236. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  237. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  238. data/website/static/assets/img/meta_total_count.png +0 -0
  239. data/website/static/img/docusaurus-social-card.jpg +0 -0
  240. data/website/static/img/docusaurus.png +0 -0
  241. data/website/static/img/favicon.ico +0 -0
  242. data/website/static/img/logo.png +0 -0
  243. data/website/static/img/logo.svg +0 -1
  244. data/website/static/img/undraw_docusaurus_mountain.svg +0 -171
  245. data/website/static/img/undraw_docusaurus_react.svg +0 -170
  246. data/website/static/img/undraw_docusaurus_tree.svg +0 -40
@@ -1,242 +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
- <h1 id="migrating-to-graphiti-rails">Migrating to graphiti-rails</h1>
84
-
85
- <p>You can continue using Graphiti 1.0 without this, but the migration
86
- is only a few simple steps.</p>
87
-
88
- <h2 id="application-code">Application Code</h2>
89
-
90
- <p>First, bump to Graphiti 1.2 - everything should work as-is, but you’ll
91
- start seeing deprecation notices.</p>
92
-
93
- <p>Then add <code class="language-plaintext highlighter-rouge">graphiti-rails</code> to your <code class="language-plaintext highlighter-rouge">Gemfile</code>:</p>
94
-
95
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">gem</span> <span class="s1">'graphiti-rails'</span><span class="p">,</span> <span class="s1">'~&gt; 0.1'</span></code></pre></figure>
96
-
97
- <p>You’ll see slightly different deprecation notices at this point. To fix:</p>
98
-
99
- <ul>
100
- <li>Remove <code class="language-plaintext highlighter-rouge">include Graphiti::Rails</code> from <code class="language-plaintext highlighter-rouge">ApplicationController</code></li>
101
- <li>Remove <code class="language-plaintext highlighter-rouge">include Graphiti::Responders</code> from <code class="language-plaintext highlighter-rouge">ApplicationController</code></li>
102
- <li>Remove the <code class="language-plaintext highlighter-rouge">register_exception</code> for <code class="language-plaintext highlighter-rouge">404</code> errors if you have one. Keep
103
- anything else, but this is now built-in by default.</li>
104
- <li>If you’re using <a href="https://github.com/plataformatec/responders">responders</a>, Add <code class="language-plaintext highlighter-rouge">include Graphiti::Rails::Responders</code> from <code class="language-plaintext highlighter-rouge">ApplicationController</code>.</li>
105
- <li>Remove the <code class="language-plaintext highlighter-rouge">rescue_from</code> block.</li>
106
- </ul>
107
-
108
- <p>Finally, if you were passing the <code class="language-plaintext highlighter-rouge">show_raw_error</code> option to
109
- <code class="language-plaintext highlighter-rouge">#handle_exception</code>, replace this with <code class="language-plaintext highlighter-rouge">#show_detailed_exceptions?</code>:</p>
110
-
111
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">def</span> <span class="nf">show_detailed_exceptions?</span>
112
- <span class="n">current_user</span><span class="p">.</span><span class="nf">admin?</span>
113
- <span class="k">end</span></code></pre></figure>
114
-
115
- <blockquote>
116
- <p>Keep in mind, we’ll always show detailed exceptions in development
117
- mode, per Rails conventions. If this is confusing or not desirable,
118
- set <code class="language-plaintext highlighter-rouge">config.consider_all_requests_local = false</code> in
119
- <code class="language-plaintext highlighter-rouge">config/environments/development.rb</code></p>
120
- </blockquote>
121
-
122
- <blockquote>
123
- <p>If you’re not running Rails in API-only mode, be sure to set
124
- <code class="language-plaintext highlighter-rouge">config.debug_exception_response_format = :api</code> in
125
- <code class="language-plaintext highlighter-rouge">config/application.rb</code></p>
126
- </blockquote>
127
-
128
- <h2 id="testing">Testing</h2>
129
-
130
- <p>Add <code class="language-plaintext highlighter-rouge">config.include Graphiti::Rails::TestHelpers</code> to
131
- <code class="language-plaintext highlighter-rouge">spec/rails_helper.rb</code>.</p>
132
-
133
- <p>Replace</p>
134
-
135
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">config</span><span class="p">.</span><span class="nf">before</span> <span class="ss">:each</span> <span class="k">do</span>
136
- <span class="no">GraphitiErrors</span><span class="p">.</span><span class="nf">disable!</span>
137
- <span class="k">end</span></code></pre></figure>
138
-
139
- <p>With</p>
140
-
141
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">config</span><span class="p">.</span><span class="nf">before</span> <span class="ss">:each</span> <span class="k">do</span>
142
- <span class="n">handle_request_exceptions</span><span class="p">(</span><span class="kp">false</span><span class="p">)</span>
143
- <span class="k">end</span></code></pre></figure>
144
-
145
- <p>Change any calls to <code class="language-plaintext highlighter-rouge">GraphitiErrors.enable!/disable!</code> with
146
- <code class="language-plaintext highlighter-rouge">handle_request_exceptions(true|false)</code>.</p>
147
-
148
- </div>
149
- </div>
150
- </main>
151
- <div class="main-footer main-footer--dark">
152
- <div class="container">
153
- <div class="row">
154
- <div class="col-sm-4 menu">
155
- <h3>Overview</h3>
156
- <ul>
157
- <li>
158
- <a href="/1.13/quickstart">Quickstart</a>
159
- </li>
160
- <li>
161
- <a href="/1.13/tutorial">Tutorial</a>
162
- </li>
163
- <li>
164
- <a href="/1.13/guides">Guides</a>
165
- </li>
166
- </ul>
167
- </div>
168
- <div class="col-sm-4 menu">
169
- <h3>Contact</h3>
170
- <ul>
171
- <li>
172
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
173
- </li>
174
- <li>
175
- <a href="mailto:richmolj@gmail.com">Email</a>
176
- </li>
177
- </ul>
178
- </div>
179
- <div class="col-sm-4 menu">
180
- <h3>Related</h3>
181
- <ul>
182
- <li>
183
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
184
- </li>
185
- <li>
186
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
187
- </li>
188
- <li>
189
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
190
- </li>
191
- </ul>
192
- </div>
193
- </div>
194
- </div>
195
- </div>
196
-
197
- <script type="text/javascript">
198
- $(function () {
199
-
200
- var flipTabs = function() {
201
- var isTS = true;
202
- if (localStorage.getItem('js-lang') === 'javascript') {
203
- isTS = false;
204
- }
205
-
206
- $('.code-tabs').each(function(index, el) {
207
- if (isTS) {
208
- console.log('hiding js');
209
- $($(el).children()[1]).hide();
210
- $($(el).children()[0]).show();
211
- } else {
212
- console.log('hiding ts');
213
- $($(el).children()[0]).hide();
214
- $($(el).children()[1]).show();
215
- }
216
- });
217
-
218
- if (isTS) {
219
- $('.tab.typescript').addClass('active');
220
- $('.tab.javascript').removeClass('active');
221
- } else {
222
- $('.tab.typescript').removeClass('active');
223
- $('.tab.javascript').addClass('active');
224
- }
225
- }
226
-
227
- $('.tab').click(function() {
228
- if ($(this).hasClass('typescript')) {
229
- localStorage.setItem('js-lang', 'typescript');
230
- } else {
231
- localStorage.setItem('js-lang', 'javascript');
232
- }
233
-
234
- flipTabs();
235
- });
236
-
237
- flipTabs();
238
- })
239
- </script>
240
-
241
- </body>
242
- </html>
@@ -1,269 +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
- <h1 id="guides">Guides</h1>
84
-
85
- <div class="guides-video">
86
- <iframe height="400" src="https://www.youtube.com/embed/_QqXjZDzTf4" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen=""></iframe>
87
- </div>
88
-
89
- <p>Graphiti makes <strong>RESTful Resources</strong> a first-class concept. This enables
90
- reading and writing a graph of data in a single request, a schema with
91
- backwards-compatible guarantee, end-to-end integration test
92
- patterns, seamless microservices and much more.</p>
93
-
94
- <p>If you just want to get a 5-minute feel for Graphiti code and all the
95
- functionality that comes out-of-the box, head to the
96
- <a href="/1.13/quickstart">Quickstart</a>. If you want a birds-eye view of Graphiti’s
97
- moving pieces, check out <a href="https://www.youtube.com/watch?v=_QqXjZDzTf4&amp;feature=youtu.be">our Intro to Graphiti video</a> or <a href="/1.13/guides/overview#lifecycle-of-a-graphiti-request">The Lifecycle of a Graphiti
98
- Request</a>. Or to understand Resources,
99
- Graphiti’s core concept, see the <a href="/1.13/guides/concepts/resources">Resource
100
- API</a>.</p>
101
-
102
- <p>Or to dive into code, check out our sample apps in <a href="https://github.com/graphiti-api/employee_directory">Rails</a>, <a href="https://github.com/graphiti-api/sinatra_example">Sinatra</a> and <a href="https://github.com/graphiti-api/plain_ruby_example">Plain Ruby</a>.</p>
103
-
104
- <p>But ideally, read everything 🙂</p>
105
-
106
- <ul>
107
- <li>
108
- <h2 id="overview-what-is-graphiti">Overview: What is Graphiti?</h2>
109
- <ul>
110
- <li><a href="/1.13/guides/why">Why Graphiti</a> <em>(or, why not
111
- GraphQL?)</em></li>
112
- <li><a href="/1.13/guides/overview#lifecycle-of-a-graphiti-request">Lifecycle of a Graphiti Request</a></li>
113
- <li><a href="https://www.youtube.com/watch?v=_QqXjZDzTf4&amp;feature=youtu.be">🎬🍿 Video: Intro to Graphiti</a></li>
114
- </ul>
115
- </li>
116
- <li>
117
- <h2 id="getting-started">Getting Started</h2>
118
- <ul>
119
- <li><a href="/1.13/guides/getting-started/installation">Installation</a></li>
120
- <li><a href="/1.13/quickstart">Quickstart</a></li>
121
- <li><a href="/1.13/tutorial">Tutorial</a> (now with step-by-step write-ups 🔥!)</li>
122
- <li><a href="/1.13/guides/vandal">Vandal: The Graphiti UI</a></li>
123
- <li><a href="/1.13/guides/upgrading">Upgrading from JSONAPI Suite</a></li>
124
- <li><a href="/1.13/guides/upgrading-2-0">Upgrading to Graphiti 2.0</a></li>
125
- <li><a href="/1.13/guides/graphiti-rails-migration">Upgrading to Graphiti 1.2</a></li>
126
- <li><a href="/1.13/blog">Blog</a></li>
127
- </ul>
128
- </li>
129
- <li>
130
- <h2 id="concepts">Concepts</h2>
131
- <ul>
132
- <li><a href="/1.13/guides/concepts/resources">Resources</a></li>
133
- <li><a href="/1.13/guides/concepts/endpoints">Endpoints</a></li>
134
- <li><a href="/1.13/guides/concepts/backends-and-models">Backends and Models</a></li>
135
- <li><a href="/1.13/guides/concepts/links">Links</a></li>
136
- <li><a href="/1.13/guides/concepts/error-handling">Error Handling</a></li>
137
- <li><a href="/1.13/guides/concepts/testing">Testing</a></li>
138
- <li><a href="/1.13/guides/concepts/debugging">Debugging</a></li>
139
- <li><a href="/1.13/guides/concepts/remote-resources">Remote Resources (Microservices)</a></li>
140
- </ul>
141
- </li>
142
- <li>
143
- <h2 id="consuming-graphiti">Consuming Graphiti</h2>
144
- <ul>
145
- <li><a href="/1.13/js">Spraypaint JS Client</a></li>
146
- </ul>
147
- </li>
148
- <li>
149
- <h2 id="tutorial">Tutorial</h2>
150
- <ul>
151
- <li><a href="/1.13/tutorial">Step-By-Step</a></li>
152
- </ul>
153
- </li>
154
- <li>
155
- <h2 id="cookbooks">Cookbooks</h2>
156
- <ul>
157
- <li><a href="/1.13/cookbooks/without-activerecord">Usage Without ActiveRecord</a></li>
158
- <li><a href="/1.13/cookbooks/customizing-sideloads">Customizing Sideloads</a></li>
159
- <li><a href="/1.13/cookbooks/hopping-relationships">Hopping Relationships</a></li>
160
- </ul>
161
- </li>
162
- <li>
163
- <h2 id="sample-apps">Sample Apps</h2>
164
- <ul>
165
- <li><a href="https://github.com/graphiti-api/employee_directory">Rails</a></li>
166
- <li><a href="https://github.com/graphiti-api/sinatra_example">Sinatra</a></li>
167
- <li><a href="https://github.com/graphiti-api/plain_ruby_example">Plain Ruby</a></li>
168
- </ul>
169
- </li>
170
- </ul>
171
-
172
- <p><br />
173
- <br /></p>
174
-
175
- </div>
176
- </div>
177
- </main>
178
- <div class="main-footer main-footer--dark">
179
- <div class="container">
180
- <div class="row">
181
- <div class="col-sm-4 menu">
182
- <h3>Overview</h3>
183
- <ul>
184
- <li>
185
- <a href="/1.13/quickstart">Quickstart</a>
186
- </li>
187
- <li>
188
- <a href="/1.13/tutorial">Tutorial</a>
189
- </li>
190
- <li>
191
- <a href="/1.13/guides">Guides</a>
192
- </li>
193
- </ul>
194
- </div>
195
- <div class="col-sm-4 menu">
196
- <h3>Contact</h3>
197
- <ul>
198
- <li>
199
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
200
- </li>
201
- <li>
202
- <a href="mailto:richmolj@gmail.com">Email</a>
203
- </li>
204
- </ul>
205
- </div>
206
- <div class="col-sm-4 menu">
207
- <h3>Related</h3>
208
- <ul>
209
- <li>
210
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
211
- </li>
212
- <li>
213
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
214
- </li>
215
- <li>
216
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
217
- </li>
218
- </ul>
219
- </div>
220
- </div>
221
- </div>
222
- </div>
223
-
224
- <script type="text/javascript">
225
- $(function () {
226
-
227
- var flipTabs = function() {
228
- var isTS = true;
229
- if (localStorage.getItem('js-lang') === 'javascript') {
230
- isTS = false;
231
- }
232
-
233
- $('.code-tabs').each(function(index, el) {
234
- if (isTS) {
235
- console.log('hiding js');
236
- $($(el).children()[1]).hide();
237
- $($(el).children()[0]).show();
238
- } else {
239
- console.log('hiding ts');
240
- $($(el).children()[0]).hide();
241
- $($(el).children()[1]).show();
242
- }
243
- });
244
-
245
- if (isTS) {
246
- $('.tab.typescript').addClass('active');
247
- $('.tab.javascript').removeClass('active');
248
- } else {
249
- $('.tab.typescript').removeClass('active');
250
- $('.tab.javascript').addClass('active');
251
- }
252
- }
253
-
254
- $('.tab').click(function() {
255
- if ($(this).hasClass('typescript')) {
256
- localStorage.setItem('js-lang', 'typescript');
257
- } else {
258
- localStorage.setItem('js-lang', 'javascript');
259
- }
260
-
261
- flipTabs();
262
- });
263
-
264
- flipTabs();
265
- })
266
- </script>
267
-
268
- </body>
269
- </html>