graphiti 2.0.0.beta.2 → 2.0.0.beta.4

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 (269) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +30 -86
  3. data/.github/workflows/docs.yml +60 -0
  4. data/.github/workflows/release.yml +8 -8
  5. data/.gitignore +7 -0
  6. data/.npmrc +9 -0
  7. data/.standard.yml +4 -1
  8. data/Appraisals +33 -32
  9. data/CHANGELOG.md +41 -0
  10. data/README.md +13 -2
  11. data/UPGRADING.md +2 -68
  12. data/docs/concepts/backends-and-models.md +122 -0
  13. data/docs/concepts/endpoints.md +183 -0
  14. data/docs/concepts/links.md +212 -0
  15. data/docs/concepts/overview.md +80 -0
  16. data/docs/concepts/persisting.md +376 -0
  17. data/docs/concepts/relationships.md +527 -0
  18. data/docs/concepts/resources.md +677 -0
  19. data/docs/getting-started/first-api.md +289 -0
  20. data/docs/getting-started/installation.md +185 -0
  21. data/docs/intro.md +307 -0
  22. data/docs/js/authentication.md +63 -0
  23. data/docs/js/ddau.md +20 -0
  24. data/docs/js/extra-params.md +41 -0
  25. data/docs/js/index.md +112 -0
  26. data/docs/js/installation.md +120 -0
  27. data/docs/js/middleware.md +72 -0
  28. data/docs/js/models.md +202 -0
  29. data/docs/js/reads.md +494 -0
  30. data/docs/js/state-syncing.md +100 -0
  31. data/docs/js/writes.md +373 -0
  32. data/docs/reference/vandal.md +63 -0
  33. data/docs/reference/why.md +13 -0
  34. data/docs/topics/authorization.md +155 -0
  35. data/docs/topics/caching.md +55 -0
  36. data/docs/topics/customizing-sideloads.md +156 -0
  37. data/docs/topics/debugging.md +216 -0
  38. data/docs/topics/error-handling.md +210 -0
  39. data/docs/topics/etags.md +46 -0
  40. data/docs/topics/hopping-relationships.md +149 -0
  41. data/docs/topics/json-attributes.md +77 -0
  42. data/docs/topics/openstruct-models.md +50 -0
  43. data/docs/topics/remote-resources.md +291 -0
  44. data/docs/topics/testing.md +894 -0
  45. data/docs/topics/without-activerecord.md +324 -0
  46. data/docs/tutorial/index.md +58 -0
  47. data/docs/tutorial/step_0.md +107 -0
  48. data/docs/tutorial/step_1.md +199 -0
  49. data/docs/tutorial/step_2.md +312 -0
  50. data/docs/tutorial/step_3.md +142 -0
  51. data/docs/tutorial/step_4.md +135 -0
  52. data/docs/tutorial/step_5.md +69 -0
  53. data/docs/tutorial/step_6.md +82 -0
  54. data/docs/tutorial/step_7.md +205 -0
  55. data/docs/tutorial/step_8.md +128 -0
  56. data/docs/tutorial/step_9.md +171 -0
  57. data/docs/upgrading.md +265 -0
  58. data/gemfiles/rails_7_1.gemfile +4 -3
  59. data/gemfiles/{rails_7_2_graphiti_rails.gemfile → rails_7_2.gemfile} +3 -3
  60. data/gemfiles/{rails_8_1_graphiti_rails.gemfile → rails_8_0.gemfile} +3 -3
  61. data/gemfiles/{rails_8_0_graphiti_rails.gemfile → rails_8_1.gemfile} +3 -3
  62. data/graphiti.gemspec +7 -5
  63. data/{deprecated_generators → lib/generators}/graphiti/api_test_generator.rb +7 -1
  64. data/{deprecated_generators → lib/generators}/graphiti/generator_mixin.rb +14 -1
  65. data/{deprecated_generators → lib/generators}/graphiti/install_generator.rb +19 -13
  66. data/{deprecated_generators → lib/generators}/graphiti/resource_generator.rb +43 -6
  67. data/{deprecated_generators → lib/generators}/graphiti/templates/index_request_spec.rb.erb +1 -1
  68. data/{deprecated_generators → lib/generators}/graphiti/templates/resource_reads_spec.rb.erb +6 -6
  69. data/{deprecated_generators → lib/generators}/graphiti/templates/show_request_spec.rb.erb +1 -1
  70. data/lib/graphiti/configuration.rb +2 -2
  71. data/lib/graphiti/error_serializers/conflict_request.rb +19 -0
  72. data/lib/graphiti/error_serializers/deprecated_constants.rb +48 -0
  73. data/lib/graphiti/error_serializers/invalid_request.rb +56 -0
  74. data/lib/graphiti/error_serializers/validation.rb +143 -0
  75. data/lib/graphiti/errors.rb +4 -23
  76. data/lib/graphiti/query.rb +1 -1
  77. data/lib/graphiti/rails/context.rb +33 -0
  78. data/lib/graphiti/rails/controller.rb +41 -0
  79. data/lib/graphiti/rails/debugging.rb +18 -0
  80. data/lib/graphiti/rails/exception_handlers.rb +77 -0
  81. data/lib/graphiti/rails/railtie.rb +139 -0
  82. data/lib/graphiti/rails/responders.rb +21 -0
  83. data/lib/graphiti/rails/test_helpers.rb +22 -0
  84. data/lib/graphiti/rails.rb +47 -29
  85. data/lib/graphiti/resource/configuration.rb +1 -0
  86. data/lib/graphiti/resource/interface.rb +2 -2
  87. data/lib/graphiti/resource/persistence.rb +14 -2
  88. data/lib/graphiti/resource/remote.rb +2 -2
  89. data/lib/graphiti/resource/sideloading.rb +1 -1
  90. data/lib/graphiti/resource.rb +13 -1
  91. data/lib/graphiti/responders.rb +7 -20
  92. data/lib/graphiti/schema.rb +5 -1
  93. data/lib/graphiti/schema_diff.rb +4 -0
  94. data/lib/graphiti/scope.rb +45 -37
  95. data/lib/graphiti/serializer.rb +6 -0
  96. data/lib/graphiti/sideload/belongs_to.rb +38 -5
  97. data/lib/graphiti/sideload/polymorphic_belongs_to.rb +27 -23
  98. data/lib/graphiti/sideload.rb +54 -35
  99. data/lib/graphiti/spec_helpers/errors.rb +73 -0
  100. data/lib/graphiti/spec_helpers/errors_proxy.rb +75 -0
  101. data/lib/graphiti/spec_helpers/helpers.rb +107 -0
  102. data/lib/graphiti/spec_helpers/node.rb +88 -0
  103. data/lib/graphiti/spec_helpers/rspec.rb +147 -0
  104. data/lib/graphiti/spec_helpers.rb +53 -0
  105. data/lib/graphiti/util/include_params.rb +2 -2
  106. data/lib/graphiti/util/persistence.rb +10 -11
  107. data/lib/graphiti/util/serializer_relationships.rb +41 -5
  108. data/lib/graphiti/version.rb +1 -1
  109. data/lib/graphiti-rails.rb +11 -0
  110. data/lib/graphiti.rb +34 -10
  111. data/lib/graphiti_errors.rb +11 -0
  112. data/lib/graphiti_spec_helpers/rspec.rb +3 -0
  113. data/lib/graphiti_spec_helpers.rb +11 -0
  114. data/lib/{graphiti/deprecated_tasks.rb → tasks/graphiti.rake} +6 -1
  115. data/package-lock.json +6199 -0
  116. data/package.json +5 -4
  117. data/website/.gitignore +20 -0
  118. data/website/README.md +43 -0
  119. data/website/docusaurus.config.js +141 -0
  120. data/website/package-lock.json +19474 -0
  121. data/website/package.json +46 -0
  122. data/website/sidebars.js +82 -0
  123. data/website/src/css/custom.css +58 -0
  124. data/website/src/pages/markdown-page.mdx +7 -0
  125. data/website/static/.nojekyll +0 -0
  126. data/website/static/1.13/2019/03/31/graphiti-1-0.html +205 -0
  127. data/website/static/1.13/2019/05/08/graphiti-1-1.html +212 -0
  128. data/website/static/1.13/2019/05/20/graphiti-1-2.html +214 -0
  129. data/website/static/1.13/2019/10/14/tutorial.html +198 -0
  130. data/website/static/1.13/CNAME +1 -0
  131. data/website/static/1.13/README.md +16 -0
  132. data/website/static/1.13/assets/css/syntax.css +60 -0
  133. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  134. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  135. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  136. data/website/static/1.13/assets/favicons/browserconfig.xml +9 -0
  137. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  138. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  139. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  140. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  141. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +1 -0
  142. data/website/static/1.13/assets/favicons/site.webmanifest +19 -0
  143. data/website/static/1.13/assets/img/backend.gif +0 -0
  144. data/website/static/1.13/assets/img/conformity.png +0 -0
  145. data/website/static/1.13/assets/img/error_payload.png +0 -0
  146. data/website/static/1.13/assets/img/gh.png +0 -0
  147. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  148. data/website/static/1.13/assets/img/logo-500.png +0 -0
  149. data/website/static/1.13/assets/img/logo.png +0 -0
  150. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  151. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  152. data/website/static/1.13/assets/img/persist.jpg +0 -0
  153. data/website/static/1.13/assets/img/resource.gif +0 -0
  154. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  155. data/website/static/1.13/assets/img/rest1.gif +0 -0
  156. data/website/static/1.13/assets/img/rest2.gif +0 -0
  157. data/website/static/1.13/assets/img/rest3.gif +0 -0
  158. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  159. data/website/static/1.13/assets/img/why.png +0 -0
  160. data/website/static/1.13/assets/js/highlight.pack.js +2 -0
  161. data/website/static/1.13/assets/main.css +15518 -0
  162. data/website/static/1.13/assets/main.css.map +1 -0
  163. data/website/static/1.13/bin/bundle +109 -0
  164. data/website/static/1.13/bin/jekyll +27 -0
  165. data/website/static/1.13/bin/kramdown +27 -0
  166. data/website/static/1.13/bin/listen +27 -0
  167. data/website/static/1.13/bin/rake +27 -0
  168. data/website/static/1.13/bin/rougify +27 -0
  169. data/website/static/1.13/bin/safe_yaml +27 -0
  170. data/website/static/1.13/bin/sass +27 -0
  171. data/website/static/1.13/bin/sass-convert +27 -0
  172. data/website/static/1.13/bin/scss +27 -0
  173. data/website/static/1.13/blog.html +259 -0
  174. data/website/static/1.13/cheatsheet.html +316 -0
  175. data/website/static/1.13/cookbooks/authorization.md +0 -0
  176. data/website/static/1.13/cookbooks/caching.md +0 -0
  177. data/website/static/1.13/cookbooks/customizing-sideloads.html +325 -0
  178. data/website/static/1.13/cookbooks/etags.md +0 -0
  179. data/website/static/1.13/cookbooks/hopping-relationships.html +324 -0
  180. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  181. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  182. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  183. data/website/static/1.13/cookbooks/without-activerecord.html +510 -0
  184. data/website/static/1.13/features.html +249 -0
  185. data/website/static/1.13/feed.xml +106 -0
  186. data/website/static/1.13/guides/concepts/backends-and-models.html +467 -0
  187. data/website/static/1.13/guides/concepts/debugging.html +440 -0
  188. data/website/static/1.13/guides/concepts/endpoints.html +432 -0
  189. data/website/static/1.13/guides/concepts/error-handling.html +396 -0
  190. data/website/static/1.13/guides/concepts/links.html +501 -0
  191. data/website/static/1.13/guides/concepts/remote-resources.html +536 -0
  192. data/website/static/1.13/guides/concepts/resources.html +2176 -0
  193. data/website/static/1.13/guides/concepts/testing.html +1469 -0
  194. data/website/static/1.13/guides/getting-started/installation.html +420 -0
  195. data/website/static/1.13/guides/graphiti-rails-migration.html +242 -0
  196. data/website/static/1.13/guides/index.html +269 -0
  197. data/website/static/1.13/guides/overview.html +325 -0
  198. data/website/static/1.13/guides/upgrading-2-0.html +193 -0
  199. data/website/static/1.13/guides/upgrading.html +314 -0
  200. data/website/static/1.13/guides/vandal.html +282 -0
  201. data/website/static/1.13/guides/why.html +1121 -0
  202. data/website/static/1.13/index.html +72 -0
  203. data/website/static/1.13/js/authentication.html +295 -0
  204. data/website/static/1.13/js/ddau.html +238 -0
  205. data/website/static/1.13/js/extra-params.html +270 -0
  206. data/website/static/1.13/js/index.html +321 -0
  207. data/website/static/1.13/js/installation.html +637 -0
  208. data/website/static/1.13/js/introduction.html +257 -0
  209. data/website/static/1.13/js/middleware.html +318 -0
  210. data/website/static/1.13/js/reads/fieldsets.html +271 -0
  211. data/website/static/1.13/js/reads/filtering.html +289 -0
  212. data/website/static/1.13/js/reads/includes.html +260 -0
  213. data/website/static/1.13/js/reads/index.html +497 -0
  214. data/website/static/1.13/js/reads/nested-queries.html +353 -0
  215. data/website/static/1.13/js/reads/pagination.html +260 -0
  216. data/website/static/1.13/js/reads/sorting.html +265 -0
  217. data/website/static/1.13/js/reads/statistics.html +289 -0
  218. data/website/static/1.13/js/state-syncing.html +340 -0
  219. data/website/static/1.13/js/writes/deferred.html +296 -0
  220. data/website/static/1.13/js/writes/dirty-tracking.html +399 -0
  221. data/website/static/1.13/js/writes/index.html +391 -0
  222. data/website/static/1.13/js/writes/nested.html +330 -0
  223. data/website/static/1.13/js/writes/validations.html +272 -0
  224. data/website/static/1.13/quickstart.html +660 -0
  225. data/website/static/1.13/template +161 -0
  226. data/website/static/1.13/tutorial/index.html +250 -0
  227. data/website/static/1.13/tutorial/step_0.html +292 -0
  228. data/website/static/1.13/tutorial/step_1.html +517 -0
  229. data/website/static/1.13/tutorial/step_2.html +481 -0
  230. data/website/static/1.13/tutorial/step_3.html +323 -0
  231. data/website/static/1.13/tutorial/step_4.html +318 -0
  232. data/website/static/1.13/tutorial/step_5.html +265 -0
  233. data/website/static/1.13/tutorial/step_6.html +276 -0
  234. data/website/static/1.13/tutorial/step_7.html +390 -0
  235. data/website/static/1.13/tutorial/step_8.html +316 -0
  236. data/website/static/1.13/tutorial/step_9.html +365 -0
  237. data/website/static/assets/img/error_payload.png +0 -0
  238. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  239. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  240. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  241. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  242. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  243. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  244. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  245. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  246. data/website/static/assets/img/meta_total_count.png +0 -0
  247. data/website/static/img/docusaurus-social-card.jpg +0 -0
  248. data/website/static/img/docusaurus.png +0 -0
  249. data/website/static/img/favicon.ico +0 -0
  250. data/website/static/img/logo.png +0 -0
  251. data/website/static/img/logo.svg +1 -0
  252. data/website/static/img/undraw_docusaurus_mountain.svg +171 -0
  253. data/website/static/img/undraw_docusaurus_react.svg +170 -0
  254. data/website/static/img/undraw_docusaurus_tree.svg +40 -0
  255. metadata +245 -46
  256. data/gemfiles/rails_6.gemfile +0 -18
  257. data/gemfiles/rails_6_graphiti_rails.gemfile +0 -19
  258. data/gemfiles/rails_7.gemfile +0 -18
  259. data/gemfiles/rails_7_1_graphiti_rails.gemfile +0 -19
  260. data/gemfiles/rails_7_graphiti_rails.gemfile +0 -19
  261. data/lib/graphiti/railtie.rb +0 -121
  262. /data/{deprecated_generators → lib/generators}/graphiti/resource_test_generator.rb +0 -0
  263. /data/{deprecated_generators → lib/generators}/graphiti/templates/application_resource.rb.erb +0 -0
  264. /data/{deprecated_generators → lib/generators}/graphiti/templates/controller.rb.erb +0 -0
  265. /data/{deprecated_generators → lib/generators}/graphiti/templates/create_request_spec.rb.erb +0 -0
  266. /data/{deprecated_generators → lib/generators}/graphiti/templates/destroy_request_spec.rb.erb +0 -0
  267. /data/{deprecated_generators → lib/generators}/graphiti/templates/resource.rb.erb +0 -0
  268. /data/{deprecated_generators → lib/generators}/graphiti/templates/resource_writes_spec.rb.erb +0 -0
  269. /data/{deprecated_generators → lib/generators}/graphiti/templates/update_request_spec.rb.erb +0 -0
data/website/static/1.13/tutorial/step_5.html ADDED
@@ -0,0 +1,265 @@
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="tutorial">Tutorial</h1>
85
+
86
+ <ul>
87
+ <li><a href="/1.13/tutorial/step_0">Step 0: Bootstrapping</a></li>
88
+ <li><a href="/1.13/tutorial/step_1">Step 1: Initial Resource</a></li>
89
+ <li><a href="/1.13/tutorial/step_2">Step 2: Has Many</a></li>
90
+ <li><a href="/1.13/tutorial/step_3">Step 3: Belongs To</a></li>
91
+ <li><a href="/1.13/tutorial/step_4">Step 4: Customizing Queries</a></li>
92
+ <li><a href="/1.13/tutorial/step_5">Step 5: Has One</a></li>
93
+ <li><a href="/1.13/tutorial/step_6">Step 6: Customizing Writes</a></li>
94
+ <li><a href="/1.13/tutorial/step_7">Step 7: Many-to-Many</a></li>
95
+ <li><a href="/1.13/tutorial/step_8">Step 8: Polymorphic Relationships</a></li>
96
+ <li><a href="/1.13/tutorial/step_9">Step 9: Polymorphic Resources</a></li>
97
+ </ul>
98
+ </div>
99
+
100
+ <div class="col-md-8">
101
+
102
+ <h3 id="step-5-has-one">Step 5: Has One</h3>
103
+
104
+ <blockquote>
105
+ <p><a href="https://github.com/graphiti-api/employee_directory/compare/step_4_customizations...step_5_has_one">View the Diff</a></p>
106
+ </blockquote>
107
+
108
+ <p>In the last step, we introduced the concept of a “current position” to
109
+ the model layer. Let’s now expose that relationship to the API.</p>
110
+
111
+ <h3 id="the-rails-stuff-">The Rails Stuff 🚂</h3>
112
+
113
+ <p>We already defined a <code class="language-plaintext highlighter-rouge">Position.current</code> scope that we’ll re-use -
114
+ let’s just make a small tweak to support the opposite use case as
115
+ well:</p>
116
+
117
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">scope</span> <span class="ss">:current</span><span class="p">,</span> <span class="o">-&gt;</span><span class="p">(</span><span class="n">bool</span><span class="p">)</span> <span class="p">{</span>
118
+ <span class="n">clause</span> <span class="o">=</span> <span class="p">{</span> <span class="ss">historical_index: </span><span class="mi">1</span> <span class="p">}</span>
119
+ <span class="n">bool</span> <span class="p">?</span> <span class="n">where</span><span class="p">(</span><span class="n">clause</span><span class="p">)</span> <span class="p">:</span> <span class="n">where</span><span class="p">.</span><span class="nf">not</span><span class="p">(</span><span class="n">clause</span><span class="p">)</span>
120
+ <span class="p">}</span></code></pre></figure>
121
+
122
+ <h3 id="the-graphiti-stuff-">The Graphiti Stuff 🎨</h3>
123
+
124
+ <p>You might already have an idea how this might work from the prior step</p>
125
+ <ul>
126
+ <li>we’ll use the <code class="language-plaintext highlighter-rouge">params</code> block to customize the relationship. The
127
+ <code class="language-plaintext highlighter-rouge">has_one</code> macro ensures the result is treated as a single object and
128
+ not an array.</li>
129
+ </ul>
130
+
131
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/employee_resource.rb</span>
132
+ <span class="n">has_one</span> <span class="ss">:current_position</span><span class="p">,</span> <span class="ss">resource: </span><span class="no">PositionResource</span> <span class="k">do</span>
133
+ <span class="n">params</span> <span class="k">do</span> <span class="o">|</span><span class="nb">hash</span><span class="o">|</span>
134
+ <span class="nb">hash</span><span class="p">[</span><span class="ss">:filter</span><span class="p">][</span><span class="ss">:current</span><span class="p">]</span> <span class="o">=</span> <span class="kp">true</span>
135
+ <span class="k">end</span>
136
+ <span class="k">end</span></code></pre></figure>
137
+
138
+ <p>Which means we’ll have to implement that filter - re-using the
139
+ ActiveRecord scope we already defined!</p>
140
+
141
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">filter</span> <span class="ss">:current</span><span class="p">,</span> <span class="ss">:boolean</span> <span class="k">do</span>
142
+ <span class="n">eq</span> <span class="p">{</span> <span class="o">|</span><span class="n">scope</span><span class="p">,</span> <span class="n">value</span><span class="o">|</span> <span class="n">scope</span><span class="p">.</span><span class="nf">current</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> <span class="p">}</span>
143
+ <span class="k">end</span></code></pre></figure>
144
+
145
+ <h4 id="digging-deeper-">Digging Deeper 🧐</h4>
146
+
147
+ <p>In this example, we’re able to return only a single record because we
148
+ have a <code class="language-plaintext highlighter-rouge">historical_index</code> column. If this column didn’t exist - maybe
149
+ we’re just ordering on <code class="language-plaintext highlighter-rouge">created_at</code> and taking the first record - we’d
150
+ have a problem. What if we were loading 20 employees and wanted the
151
+ <code class="language-plaintext highlighter-rouge">current_position</code> of each - what SQL would limit the resultset
152
+ correctly?</p>
153
+
154
+ <p>We call this a <a href="/1.13/guides/concepts/resources#faux-has-one">faux has_one</a> and there’s nothing easily done here. Graphiti will ensure only one record
155
+ is returned by the API, but the query will take longer and loading extra
156
+ records will eat memory. If there are lots of records in the
157
+ association, look into adding a column like <code class="language-plaintext highlighter-rouge">historical_index</code>.</p>
158
+
159
+ </div>
160
+
161
+ <div class="clearfix">
162
+ <h2 id="next">
163
+ <a href="/1.13/tutorial/step_6">
164
+ NEXT -
165
+ <small>Step 6: Customizing Writes</small>
166
+ &raquo;
167
+ </a>
168
+ </h2>
169
+ </div>
170
+
171
+ </div>
172
+ </div>
173
+ </main>
174
+ <div class="main-footer main-footer--dark">
175
+ <div class="container">
176
+ <div class="row">
177
+ <div class="col-sm-4 menu">
178
+ <h3>Overview</h3>
179
+ <ul>
180
+ <li>
181
+ <a href="/1.13/quickstart">Quickstart</a>
182
+ </li>
183
+ <li>
184
+ <a href="/1.13/tutorial">Tutorial</a>
185
+ </li>
186
+ <li>
187
+ <a href="/1.13/guides">Guides</a>
188
+ </li>
189
+ </ul>
190
+ </div>
191
+ <div class="col-sm-4 menu">
192
+ <h3>Contact</h3>
193
+ <ul>
194
+ <li>
195
+ <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
196
+ </li>
197
+ <li>
198
+ <a href="mailto:richmolj@gmail.com">Email</a>
199
+ </li>
200
+ </ul>
201
+ </div>
202
+ <div class="col-sm-4 menu">
203
+ <h3>Related</h3>
204
+ <ul>
205
+ <li>
206
+ <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
207
+ </li>
208
+ <li>
209
+ <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
210
+ </li>
211
+ <li>
212
+ <a target="_blank" href="https://vuejs.org/">VueJS</a>
213
+ </li>
214
+ </ul>
215
+ </div>
216
+ </div>
217
+ </div>
218
+ </div>
219
+
220
+ <script type="text/javascript">
221
+ $(function () {
222
+
223
+ var flipTabs = function() {
224
+ var isTS = true;
225
+ if (localStorage.getItem('js-lang') === 'javascript') {
226
+ isTS = false;
227
+ }
228
+
229
+ $('.code-tabs').each(function(index, el) {
230
+ if (isTS) {
231
+ console.log('hiding js');
232
+ $($(el).children()[1]).hide();
233
+ $($(el).children()[0]).show();
234
+ } else {
235
+ console.log('hiding ts');
236
+ $($(el).children()[0]).hide();
237
+ $($(el).children()[1]).show();
238
+ }
239
+ });
240
+
241
+ if (isTS) {
242
+ $('.tab.typescript').addClass('active');
243
+ $('.tab.javascript').removeClass('active');
244
+ } else {
245
+ $('.tab.typescript').removeClass('active');
246
+ $('.tab.javascript').addClass('active');
247
+ }
248
+ }
249
+
250
+ $('.tab').click(function() {
251
+ if ($(this).hasClass('typescript')) {
252
+ localStorage.setItem('js-lang', 'typescript');
253
+ } else {
254
+ localStorage.setItem('js-lang', 'javascript');
255
+ }
256
+
257
+ flipTabs();
258
+ });
259
+
260
+ flipTabs();
261
+ })
262
+ </script>
263
+
264
+ </body>
265
+ </html>
data/website/static/1.13/tutorial/step_6.html ADDED
@@ -0,0 +1,276 @@
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="tutorial">Tutorial</h1>
85
+
86
+ <ul>
87
+ <li><a href="/1.13/tutorial/step_0">Step 0: Bootstrapping</a></li>
88
+ <li><a href="/1.13/tutorial/step_1">Step 1: Initial Resource</a></li>
89
+ <li><a href="/1.13/tutorial/step_2">Step 2: Has Many</a></li>
90
+ <li><a href="/1.13/tutorial/step_3">Step 3: Belongs To</a></li>
91
+ <li><a href="/1.13/tutorial/step_4">Step 4: Customizing Queries</a></li>
92
+ <li><a href="/1.13/tutorial/step_5">Step 5: Has One</a></li>
93
+ <li><a href="/1.13/tutorial/step_6">Step 6: Customizing Writes</a></li>
94
+ <li><a href="/1.13/tutorial/step_7">Step 7: Many-to-Many</a></li>
95
+ <li><a href="/1.13/tutorial/step_8">Step 8: Polymorphic Relationships</a></li>
96
+ <li><a href="/1.13/tutorial/step_9">Step 9: Polymorphic Resources</a></li>
97
+ </ul>
98
+ </div>
99
+
100
+ <div class="col-md-8">
101
+
102
+ <h3 id="step-6-customizing-writes">Step 6: Customizing Writes</h3>
103
+
104
+ <blockquote>
105
+ <p><a href="https://github.com/graphiti-api/employee_directory/compare/step_5_has_one...step_6_write_customization">View the Diff</a></p>
106
+ </blockquote>
107
+
108
+ <p>When we ran the generators (and created a blank Resource class), we got the ability to create, update, and destroy resources for free. You can turn off this behavior with <code class="language-plaintext highlighter-rouge">self.read_only = true</code>. Or for relationships: <code class="language-plaintext highlighter-rouge">has_many :positions, writable: false</code>.</p>
109
+
110
+ <p>But in RESTful APIs, it’s super common for persistence operations to
111
+ have side effects - that’s how we avoid extraneous verbs and
112
+ inconsistent patterns.</p>
113
+
114
+ <p>In a prior step, we updated <code class="language-plaintext highlighter-rouge">position</code> Factory to automatically reorder
115
+ the <code class="language-plaintext highlighter-rouge">historical_index</code>: when a new record comes in, all the prior
116
+ values need to change. This step will show how to add that behavior to
117
+ our API, using hooks that work for a variety of scenarios: sending
118
+ emails, checking authorization roles, queuing delayed jobs, and more.</p>
119
+
120
+ <h3 id="the-rails-stuff-">The Rails Stuff 🚂</h3>
121
+
122
+ <p>Previously, we put the logic that re-ordered the <code class="language-plaintext highlighter-rouge">historical_index</code>
123
+ column in the <code class="language-plaintext highlighter-rouge">position</code> factory. Let’s move that to the model so our
124
+ tests and API can share the same logic:</p>
125
+
126
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/models/position.rb</span>
127
+ <span class="k">def</span> <span class="nc">self</span><span class="o">.</span><span class="nf">reorder!</span><span class="p">(</span><span class="n">employee_id</span><span class="p">)</span>
128
+ <span class="n">scope</span> <span class="o">=</span> <span class="no">Position</span><span class="p">.</span><span class="nf">where</span><span class="p">(</span><span class="ss">employee_id: </span><span class="n">employee_id</span><span class="p">).</span><span class="nf">order</span><span class="p">(</span><span class="ss">created_at: :desc</span><span class="p">)</span>
129
+ <span class="n">scope</span><span class="p">.</span><span class="nf">each_with_index</span> <span class="k">do</span> <span class="o">|</span><span class="nb">p</span><span class="p">,</span> <span class="n">index</span><span class="o">|</span>
130
+ <span class="nb">p</span><span class="p">.</span><span class="nf">update_attribute</span><span class="p">(</span><span class="ss">:historical_index</span><span class="p">,</span> <span class="n">index</span> <span class="o">+</span> <span class="mi">1</span><span class="p">)</span>
131
+ <span class="k">end</span>
132
+ <span class="k">end</span></code></pre></figure>
133
+
134
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># spec/factories/positions.rb</span>
135
+ <span class="c1"># ... code ...</span>
136
+ <span class="n">after</span><span class="p">(</span><span class="ss">:create</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">position</span><span class="o">|</span>
137
+ <span class="k">unless</span> <span class="n">position</span><span class="p">.</span><span class="nf">historical_index</span>
138
+ <span class="no">Position</span><span class="p">.</span><span class="nf">reorder!</span><span class="p">(</span><span class="n">position</span><span class="p">.</span><span class="nf">employee</span><span class="p">.</span><span class="nf">id</span><span class="p">)</span>
139
+ <span class="k">end</span>
140
+ <span class="k">end</span></code></pre></figure>
141
+
142
+ <h3 id="the-graphiti-stuff-">The Graphiti Stuff 🎨</h3>
143
+
144
+ <p>All Graphiti updates happen within a transaction. We want to insert our
145
+ code right before that transaction closes - after the graph of objects
146
+ has been persisted and validations have passed. To do that, we’ll use
147
+ the <code class="language-plaintext highlighter-rouge">before_commit</code> hook:</p>
148
+
149
+ <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">before_commit</span> <span class="ss">only: </span><span class="p">[</span><span class="ss">:create</span><span class="p">,</span> <span class="ss">:destroy</span><span class="p">]</span> <span class="k">do</span> <span class="o">|</span><span class="n">position</span><span class="o">|</span>
150
+ <span class="no">Position</span><span class="p">.</span><span class="nf">reorder!</span><span class="p">(</span><span class="n">position</span><span class="p">.</span><span class="nf">employee_id</span><span class="p">)</span>
151
+ <span class="k">end</span></code></pre></figure>
152
+
153
+ <p>Again, note that the <code class="language-plaintext highlighter-rouge">Position.reorder!</code> code existed independent of our
154
+ API, and was re-used in our factory.</p>
155
+
156
+ <h4 id="digging-deeper-">Digging Deeper 🧐</h4>
157
+
158
+ <p>Resources come with <a href="/1.13/guides/concepts/resources#persistence-lifecycle-hooks">Lifecycle Hooks</a>, similar to ActiveRecord <a href="https://guides.rubyonrails.org/active_record_callbacks.html">Callbacks</a>.</p>
159
+
160
+ <p>Those callbacks have gotten a bad reputation. This is because your Model
161
+ can be - is supposed to be - used in a variety of contexts across your
162
+ application. Some of those contexts will want a given callback to fire,
163
+ others will not, and accomodating the conditionals gets hairy. This is
164
+ why many developers move that functionality into <a href="https://engineering.gusto.com/the-rails-callbacks-best-practices-used-at-gusto/">Service Objects</a>.</p>
165
+
166
+ <p>But Resource callbacks don’t have the same problem - they only fire in
167
+ the context of your API, and can be associated to a single endpoint. You
168
+ can still use Service Objects if you’d like; Graphiti callbacks simply wire them up.</p>
169
+
170
+ </div>
171
+
172
+ <div class="clearfix">
173
+ <h2 id="next">
174
+ <a href="/1.13/tutorial/step_7">
175
+ NEXT -
176
+ <small>Step 7: Many to Many</small>
177
+ &raquo;
178
+ </a>
179
+ </h2>
180
+ </div>
181
+
182
+ </div>
183
+ </div>
184
+ </main>
185
+ <div class="main-footer main-footer--dark">
186
+ <div class="container">
187
+ <div class="row">
188
+ <div class="col-sm-4 menu">
189
+ <h3>Overview</h3>
190
+ <ul>
191
+ <li>
192
+ <a href="/1.13/quickstart">Quickstart</a>
193
+ </li>
194
+ <li>
195
+ <a href="/1.13/tutorial">Tutorial</a>
196
+ </li>
197
+ <li>
198
+ <a href="/1.13/guides">Guides</a>
199
+ </li>
200
+ </ul>
201
+ </div>
202
+ <div class="col-sm-4 menu">
203
+ <h3>Contact</h3>
204
+ <ul>
205
+ <li>
206
+ <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
207
+ </li>
208
+ <li>
209
+ <a href="mailto:richmolj@gmail.com">Email</a>
210
+ </li>
211
+ </ul>
212
+ </div>
213
+ <div class="col-sm-4 menu">
214
+ <h3>Related</h3>
215
+ <ul>
216
+ <li>
217
+ <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
218
+ </li>
219
+ <li>
220
+ <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
221
+ </li>
222
+ <li>
223
+ <a target="_blank" href="https://vuejs.org/">VueJS</a>
224
+ </li>
225
+ </ul>
226
+ </div>
227
+ </div>
228
+ </div>
229
+ </div>
230
+
231
+ <script type="text/javascript">
232
+ $(function () {
233
+
234
+ var flipTabs = function() {
235
+ var isTS = true;
236
+ if (localStorage.getItem('js-lang') === 'javascript') {
237
+ isTS = false;
238
+ }
239
+
240
+ $('.code-tabs').each(function(index, el) {
241
+ if (isTS) {
242
+ console.log('hiding js');
243
+ $($(el).children()[1]).hide();
244
+ $($(el).children()[0]).show();
245
+ } else {
246
+ console.log('hiding ts');
247
+ $($(el).children()[0]).hide();
248
+ $($(el).children()[1]).show();
249
+ }
250
+ });
251
+
252
+ if (isTS) {
253
+ $('.tab.typescript').addClass('active');
254
+ $('.tab.javascript').removeClass('active');
255
+ } else {
256
+ $('.tab.typescript').removeClass('active');
257
+ $('.tab.javascript').addClass('active');
258
+ }
259
+ }
260
+
261
+ $('.tab').click(function() {
262
+ if ($(this).hasClass('typescript')) {
263
+ localStorage.setItem('js-lang', 'typescript');
264
+ } else {
265
+ localStorage.setItem('js-lang', 'javascript');
266
+ }
267
+
268
+ flipTabs();
269
+ });
270
+
271
+ flipTabs();
272
+ })
273
+ </script>
274
+
275
+ </body>
276
+ </html>