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
@@ -1,501 +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="links">Links</h1>
85
-
86
- <ul>
87
- <li>1 <a href="#overview">Overview</a>
88
- <ul>
89
- <li><a href="#linking-relationships">Linking Relationships</a></li>
90
- </ul>
91
- </li>
92
- <li>2 <a href="#resource-endpoints">Resource Endpoints</a>
93
- <ul>
94
- <li><a href="#validation">Validation</a></li>
95
- </ul>
96
- </li>
97
- <li>3 <a href="#configuration">Configuration</a>
98
- <ul>
99
- <li><a href="#autolinking">Autolinking</a></li>
100
- <li><a href="#endpoint-validation">Endpoint Validation</a></li>
101
- <li><a href="#links-on-demand">Links-On-Demand</a></li>
102
- <li><a href="#pagination-links">Pagination Links</a></li>
103
- <li><a href="#custom-endpoint-urls">Custom Endpoint URLs</a></li>
104
- </ul>
105
- </li>
106
- </ul>
107
-
108
- </div>
109
-
110
- <div class="col-md-8">
111
-
112
- <p align="center">
113
- <img width="100%" src="https://pbs.twimg.com/media/CeKlfWPUIAATWZZ.jpg" />
114
- </p>
115
-
116
- <a class="anchor" id="overview" />
117
- <a class="header" href="#overview">
118
- <h2>
119
- 1 Overview
120
- </h2>
121
- </a>
122
-
123
- <p>Links are useful for:</p>
124
-
125
- <ul>
126
- <li>Discoverability</li>
127
- <li>Lazy-loading</li>
128
- <li>Hiding implementation details</li>
129
- </ul>
130
-
131
- <p>Let’s say we’re loading a Post and its “Top Comments”. On Day One, we
132
- might <strong>eager load</strong> the data like so:</p>
133
-
134
- <p><code class="language-plaintext highlighter-rouge">/posts/123?include=top_comments</code></p>
135
-
136
- <p>This fetches all the data in a single request. But after some UI
137
- testing, we decide to add a “show comments” button. This way our
138
- page can load more quickly - it only needs to load the Post
139
- initially, and loading Top Comments can be deferred. We
140
- want to <strong>lazy load</strong> the relationship.</p>
141
-
142
- <p>How would we do this? We <em>could</em> bake this logic into our next request:</p>
143
-
144
- <p><code class="language-plaintext highlighter-rouge">/comments?filter[post_id]=123&amp;filter[upvotes][gte]=100</code></p>
145
-
146
- <p>But this requires the client to have knowledge of what a “Top Comment”
147
- is. If this logic ever changed, we’d have to update every client - our
148
- desktop app, mobile apps, reports, etc… Not to mention, third parties who
149
- just want to display Top Comments are required to have this knowledge
150
- and update their implementations as well.</p>
151
-
152
- <p>Maybe we could hide what “Top Comment” means with a special endpoint:</p>
153
-
154
- <p><code class="language-plaintext highlighter-rouge">/top_comments?filter[post_id]=123</code></p>
155
-
156
- <p>But now clients <em>need to know</em> to hit this special endpoint instead of
157
- the normal <code class="language-plaintext highlighter-rouge">/comments</code> endpoint. How would they know? What if
158
- <code class="language-plaintext highlighter-rouge">top_comments</code> had special caching rules and <em>shouldn’t</em> be used for
159
- this purpose?</p>
160
-
161
- <p>The main problem here is <strong>there is no way to guarantee our lazy-loaded data will
162
- match our eager loaded data</strong>. Whether we fetch the Post and its Top
163
- Comments in a single request, or lazy-load that data in a separate
164
- request, the same data should always be returned.</p>
165
-
166
- <p align="center">
167
- <img width="100%" src="/1.13/assets/img/rest2.gif" />
168
- </p>
169
-
170
- <p><a href="http://jsonapi.org/format/#document-links">Links</a> solve this problem. When we fetch the Post, the <code class="language-plaintext highlighter-rouge">top_comments</code>
171
- relationship will contain a URL. Clients can simply follow that URL to
172
- lazy-load the same data. We can now change the definition of a Top
173
- Comment - 500 upvotes, factor in recency, apply downvotes - and no
174
- clients need to change. They simple continue to follow a Link.</p>
175
-
176
- <a class="anchor" id="linking-relationships" />
177
- <a class="header" href="#linking-relationships">
178
- <h3>
179
- 1.1 Linking Relationships
180
- </h3>
181
- </a>
182
-
183
- <p>When defining a relationship, we get a Link for free:</p>
184
-
185
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">PostResource</span> <span class="o">&lt;</span> <span class="no">ApplicationResource</span>
186
- <span class="n">has_many</span> <span class="ss">:comments</span>
187
- <span class="k">end</span></code></pre></figure>
188
-
189
- <blockquote>
190
- <p><code class="language-plaintext highlighter-rouge">/comments?filter[post_id]=123</code></p>
191
- </blockquote>
192
-
193
- <p>And when customizing a relationship with <code class="language-plaintext highlighter-rouge">params</code>, our Link will be
194
- updated:</p>
195
-
196
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:comments</span> <span class="k">do</span>
197
- <span class="n">params</span> <span class="k">do</span> <span class="o">|</span><span class="nb">hash</span><span class="o">|</span>
198
- <span class="nb">hash</span><span class="p">[</span><span class="ss">:filter</span><span class="p">][</span><span class="ss">:upvotes</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span> <span class="ss">gte: </span><span class="mi">100</span> <span class="p">}</span>
199
- <span class="k">end</span>
200
- <span class="k">end</span></code></pre></figure>
201
-
202
- <blockquote>
203
- <p><code class="language-plaintext highlighter-rouge">/comments?filter[post_id]=123&amp;filter[upvotes][gte]=100</code></p>
204
- </blockquote>
205
-
206
- <p>Note: if you use the <code class="language-plaintext highlighter-rouge">scope</code> block directly, it may cause incorrect
207
- links. Avoid using <code class="language-plaintext highlighter-rouge">scope</code> directly and instead use <code class="language-plaintext highlighter-rouge">params</code> and
208
- <code class="language-plaintext highlighter-rouge">pre_load</code> if possible.</p>
209
-
210
- <p>To manually generate a Link:</p>
211
-
212
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:comments</span> <span class="k">do</span>
213
- <span class="n">link</span> <span class="k">do</span> <span class="o">|</span><span class="n">post</span><span class="o">|</span>
214
- <span class="n">helpers</span> <span class="o">=</span> <span class="no">Rails</span><span class="p">.</span><span class="nf">application</span><span class="p">.</span><span class="nf">routes</span><span class="p">.</span><span class="nf">url_helpers</span>
215
- <span class="n">helpers</span><span class="p">.</span><span class="nf">comments_url</span><span class="p">(</span><span class="ss">params: </span><span class="p">{</span> <span class="ss">filter: </span><span class="p">{</span> <span class="ss">post_id: </span><span class="n">post</span><span class="p">.</span><span class="nf">id</span> <span class="p">}</span> <span class="p">})</span>
216
- <span class="c1"># or</span>
217
- <span class="c1"># http://example.com/api/v1/comments?filter[post_id]=123</span>
218
- <span class="k">end</span>
219
- <span class="k">end</span></code></pre></figure>
220
-
221
- <p>To avoid a Relationship Link altogether:</p>
222
-
223
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:comments</span><span class="p">,</span> <span class="ss">link: </span><span class="kp">false</span></code></pre></figure>
224
-
225
- <a class="anchor" id="resource-endpoints" />
226
- <a class="header" href="#resource-endpoints">
227
- <h2>
228
- 2 Resource Endpoints
229
- </h2>
230
- </a>
231
-
232
- <p>To generate links, we need to associate a Resource to a URL. By default,
233
- this happens automatically:</p>
234
-
235
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationResource</span> <span class="o">&lt;</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Resource</span>
236
- <span class="c1"># ... code ...</span>
237
- <span class="nb">self</span><span class="p">.</span><span class="nf">endpoint_namespace</span> <span class="o">=</span> <span class="s1">'/api/v1'</span>
238
- <span class="k">end</span>
239
-
240
- <span class="k">class</span> <span class="nc">PostResource</span> <span class="o">&lt;</span> <span class="no">ApplicationResource</span>
241
- <span class="c1"># under the hood:</span>
242
- <span class="n">primary_endpoint</span> <span class="s1">'posts'</span><span class="p">,</span>
243
- <span class="p">[</span><span class="ss">:index</span><span class="p">,</span> <span class="ss">:show</span><span class="p">,</span> <span class="ss">:create</span><span class="p">,</span> <span class="ss">:update</span><span class="p">,</span> <span class="ss">:destroy</span><span class="p">]</span>
244
- <span class="k">end</span></code></pre></figure>
245
-
246
- <p>Which would generate links to <code class="language-plaintext highlighter-rouge">/api/v1/posts</code>.</p>
247
-
248
- <a class="anchor" id="validation" />
249
- <a class="header" href="#validation">
250
- <h3>
251
- 2.1 Validation
252
- </h3>
253
- </a>
254
-
255
- <p>Associating a Resource to an Endpoint serves two purposes. We’ve gone
256
- over link generation. But we also want to make sure we’re not linking to
257
- something that doesn’t actually exist. That’s why we perform <strong>Endpoint
258
- Validation</strong>.</p>
259
-
260
- <p>If we tried to access the above resource at a <code class="language-plaintext highlighter-rouge">/comments</code> endpoint:</p>
261
-
262
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">CommentsController</span> <span class="o">&lt;</span> <span class="no">ApplicationController</span>
263
- <span class="k">def</span> <span class="nf">index</span>
264
- <span class="no">PostResource</span><span class="p">.</span><span class="nf">all</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
265
- <span class="c1"># ...</span>
266
- <span class="k">end</span>
267
- <span class="k">end</span></code></pre></figure>
268
-
269
- <p>We’d get a <code class="language-plaintext highlighter-rouge">Graphiti::Errors::InvalidEndpoint</code> error. Endpoint
270
- validation ensures that our auto-generated Links are actually valid.</p>
271
-
272
- <p>To change the endpoint associated to a Resource:</p>
273
-
274
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">primary_endpoint</span> <span class="s1">'special_posts'</span><span class="p">,</span> <span class="p">[</span><span class="ss">:index</span><span class="p">,</span> <span class="ss">:show</span><span class="p">]</span></code></pre></figure>
275
-
276
- <p>Or to alter only the <strong>path</strong>:</p>
277
-
278
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="nb">self</span><span class="p">.</span><span class="nf">endpoint</span><span class="p">[</span><span class="ss">:path</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'special_posts'</span></code></pre></figure>
279
-
280
- <p>Or to alter only the <strong>actions</strong> supported:</p>
281
-
282
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="nb">self</span><span class="p">.</span><span class="nf">endpoint</span><span class="p">[</span><span class="ss">:actions</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="ss">:index</span><span class="p">,</span> <span class="ss">:show</span><span class="p">]</span></code></pre></figure>
283
-
284
- <p>A resource may be accessible by multiple endpoints. Maybe <code class="language-plaintext highlighter-rouge">PostResource</code>
285
- is also used at <code class="language-plaintext highlighter-rouge">/top_posts</code>. We want to keep all auto-generated links
286
- pointing to <code class="language-plaintext highlighter-rouge">/posts</code> (the primary endpoint), but <em>allow</em> accessing
287
- <code class="language-plaintext highlighter-rouge">PostResource</code> from the <code class="language-plaintext highlighter-rouge">/top_posts</code> endpoint:</p>
288
-
289
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">secondary_endpoint</span> <span class="s1">'/top_posts'</span><span class="p">,</span> <span class="p">[</span><span class="ss">:index</span><span class="p">]</span></code></pre></figure>
290
-
291
- <a class="anchor" id="configuration" />
292
- <a class="header" href="#configuration">
293
- <h2>
294
- 3 Configuration
295
- </h2>
296
- </a>
297
-
298
- <a class="anchor" id="autolinking" />
299
- <a class="header" href="#autolinking">
300
- <h3>
301
- 3.1 Autolinking
302
- </h3>
303
- </a>
304
-
305
- <p>To turn off automatically generated links:</p>
306
-
307
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationResource</span> <span class="o">&lt;</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Resource</span>
308
- <span class="nb">self</span><span class="p">.</span><span class="nf">autolink</span> <span class="o">=</span> <span class="kp">false</span>
309
- <span class="k">end</span></code></pre></figure>
310
-
311
- <a class="anchor" id="endpoint-validation" />
312
- <a class="header" href="#endpoint-validation">
313
- <h3>
314
- 3.2 Endpoint Validation
315
- </h3>
316
- </a>
317
-
318
- <p>To turn off Endpoint Validation:</p>
319
-
320
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationResource</span> <span class="o">&lt;</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Resource</span>
321
- <span class="nb">self</span><span class="p">.</span><span class="nf">validate_endpoints</span> <span class="o">=</span> <span class="kp">false</span>
322
- <span class="k">end</span></code></pre></figure>
323
-
324
- <a class="anchor" id="links-on-demand" />
325
- <a class="header" href="#links-on-demand">
326
- <h3>
327
- 3.3 Links-on-Demand
328
- </h3>
329
- </a>
330
-
331
- <p>To only render links when requested in the URL with <code class="language-plaintext highlighter-rouge">?links=true</code>:</p>
332
-
333
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">Graphiti</span><span class="p">.</span><span class="nf">configure</span> <span class="k">do</span> <span class="o">|</span><span class="n">c</span><span class="o">|</span>
334
- <span class="n">c</span><span class="p">.</span><span class="nf">links_on_demand</span> <span class="o">=</span> <span class="kp">true</span>
335
- <span class="k">end</span></code></pre></figure>
336
-
337
- <a class="anchor" id="pagination-links" />
338
- <a class="header" href="#pagination-links">
339
- <h3>
340
- 3.4 Pagination Links
341
- </h3>
342
- </a>
343
-
344
- <p>Requesting big collections can result into slow responses sometimes. In order to avoid this, you could use <a href="https://jsonapi.org/format/#fetching-pagination">pagination</a>. It’ll break your response into smaller pieces that will make your server responds faster. Paginations links can be present in your response in the following ways:</p>
345
-
346
- <a class="anchor" id="pagination-links-showing-by-default" />
347
- <a class="header" href="#pagination-links-showing-by-default">
348
- <h4>
349
- 3.4.1 Showing by default
350
- </h4>
351
- </a>
352
-
353
- <p>With this configuration, all the responses will return the pagination links</p>
354
-
355
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">Graphiti</span><span class="p">.</span><span class="nf">configure</span> <span class="k">do</span> <span class="o">|</span><span class="n">c</span><span class="o">|</span>
356
- <span class="n">c</span><span class="p">.</span><span class="nf">pagination_links</span> <span class="o">=</span> <span class="kp">true</span>
357
- <span class="k">end</span></code></pre></figure>
358
-
359
- <a class="anchor" id="pagination-links-when-requested" />
360
- <a class="header" href="#pagination-links-when-requested">
361
- <h4>
362
- 3.4.2 When requested
363
- </h4>
364
- </a>
365
-
366
- <p>You can showing the pagination links when it was requested in the URL with <code class="language-plaintext highlighter-rouge">?pagination_links=true</code></p>
367
-
368
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">Graphiti</span><span class="p">.</span><span class="nf">configure</span> <span class="k">do</span> <span class="o">|</span><span class="n">c</span><span class="o">|</span>
369
- <span class="n">c</span><span class="p">.</span><span class="nf">pagination_links_on_demand</span> <span class="o">=</span> <span class="kp">true</span>
370
- <span class="k">end</span></code></pre></figure>
371
-
372
- <p>Pagination links won’t show up for <em>#show</em> actions.</p>
373
-
374
- <a class="anchor" id="custom-endpoint-urls" />
375
- <a class="header" href="#custom-endpoint-urls">
376
- <h3>
377
- 3.5 Custom Endpoint URLs
378
- </h3>
379
- </a>
380
-
381
- <p>To change the URL associated with a Resource:</p>
382
-
383
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">PostResource</span> <span class="o">&lt;</span> <span class="no">ApplicationResource</span>
384
- <span class="c1"># Most commonly seen in ApplicationResource</span>
385
- <span class="nb">self</span><span class="p">.</span><span class="nf">endpoint_namespace</span> <span class="o">=</span> <span class="s1">'/api/v1'</span>
386
-
387
- <span class="n">primary_endpoint</span> <span class="s1">'/posts'</span><span class="p">,</span> <span class="p">[</span><span class="ss">:index</span><span class="p">,</span> <span class="ss">:show</span><span class="p">]</span>
388
- <span class="c1"># OR</span>
389
- <span class="nb">self</span><span class="p">.</span><span class="nf">endpoint</span><span class="p">[</span><span class="ss">:path</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'/posts'</span>
390
- <span class="c1"># OR</span>
391
- <span class="nb">self</span><span class="p">.</span><span class="nf">endpoint</span><span class="p">[</span><span class="ss">:actions</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="ss">:index</span><span class="p">,</span> <span class="ss">:show</span><span class="p">]</span>
392
- <span class="k">end</span></code></pre></figure>
393
-
394
- <p>To generate a Relationship Link manually:</p>
395
-
396
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:comments</span> <span class="k">do</span>
397
- <span class="n">link</span> <span class="k">do</span> <span class="o">|</span><span class="n">post</span><span class="o">|</span>
398
- <span class="n">helpers</span> <span class="o">=</span> <span class="no">Rails</span><span class="p">.</span><span class="nf">application</span><span class="p">.</span><span class="nf">routes</span><span class="p">.</span><span class="nf">url_helpers</span>
399
- <span class="n">helpers</span><span class="p">.</span><span class="nf">comments_url</span><span class="p">(</span><span class="ss">params: </span><span class="p">{</span> <span class="ss">filter: </span><span class="p">{</span> <span class="ss">post_id: </span><span class="n">post</span><span class="p">.</span><span class="nf">id</span> <span class="p">}</span> <span class="p">})</span>
400
- <span class="c1"># or</span>
401
- <span class="c1"># http://example.com/api/v1/comments?filter[post_id]=123</span>
402
- <span class="k">end</span>
403
- <span class="k">end</span></code></pre></figure>
404
-
405
- </div>
406
-
407
- </div>
408
- </div>
409
- </main>
410
- <div class="main-footer main-footer--dark">
411
- <div class="container">
412
- <div class="row">
413
- <div class="col-sm-4 menu">
414
- <h3>Overview</h3>
415
- <ul>
416
- <li>
417
- <a href="/1.13/quickstart">Quickstart</a>
418
- </li>
419
- <li>
420
- <a href="/1.13/tutorial">Tutorial</a>
421
- </li>
422
- <li>
423
- <a href="/1.13/guides">Guides</a>
424
- </li>
425
- </ul>
426
- </div>
427
- <div class="col-sm-4 menu">
428
- <h3>Contact</h3>
429
- <ul>
430
- <li>
431
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
432
- </li>
433
- <li>
434
- <a href="mailto:richmolj@gmail.com">Email</a>
435
- </li>
436
- </ul>
437
- </div>
438
- <div class="col-sm-4 menu">
439
- <h3>Related</h3>
440
- <ul>
441
- <li>
442
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
443
- </li>
444
- <li>
445
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
446
- </li>
447
- <li>
448
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
449
- </li>
450
- </ul>
451
- </div>
452
- </div>
453
- </div>
454
- </div>
455
-
456
- <script type="text/javascript">
457
- $(function () {
458
-
459
- var flipTabs = function() {
460
- var isTS = true;
461
- if (localStorage.getItem('js-lang') === 'javascript') {
462
- isTS = false;
463
- }
464
-
465
- $('.code-tabs').each(function(index, el) {
466
- if (isTS) {
467
- console.log('hiding js');
468
- $($(el).children()[1]).hide();
469
- $($(el).children()[0]).show();
470
- } else {
471
- console.log('hiding ts');
472
- $($(el).children()[0]).hide();
473
- $($(el).children()[1]).show();
474
- }
475
- });
476
-
477
- if (isTS) {
478
- $('.tab.typescript').addClass('active');
479
- $('.tab.javascript').removeClass('active');
480
- } else {
481
- $('.tab.typescript').removeClass('active');
482
- $('.tab.javascript').addClass('active');
483
- }
484
- }
485
-
486
- $('.tab').click(function() {
487
- if ($(this).hasClass('typescript')) {
488
- localStorage.setItem('js-lang', 'typescript');
489
- } else {
490
- localStorage.setItem('js-lang', 'javascript');
491
- }
492
-
493
- flipTabs();
494
- });
495
-
496
- flipTabs();
497
- })
498
- </script>
499
-
500
- </body>
501
- </html>