graphiti 2.0.0.beta.7 → 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 (238) 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 +45 -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 -1
  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/graphiti/audit/report.rb +6 -6
  20. data/lib/graphiti/audit.rb +3 -4
  21. data/lib/graphiti/delegates/pagination.rb +2 -2
  22. data/lib/graphiti/deserializer.rb +3 -3
  23. data/lib/graphiti/errors.rb +6 -6
  24. data/lib/graphiti/extensions/temp_id.rb +1 -1
  25. data/lib/graphiti/query.rb +3 -3
  26. data/lib/graphiti/rails/context.rb +2 -1
  27. data/lib/graphiti/rails/controller.rb +3 -0
  28. data/lib/graphiti/rails/debugging.rb +1 -1
  29. data/lib/graphiti/rails/responders.rb +2 -1
  30. data/lib/graphiti/resource/configuration.rb +1 -0
  31. data/lib/graphiti/resource/dsl.rb +2 -2
  32. data/lib/graphiti/resource/links.rb +1 -1
  33. data/lib/graphiti/resource/persistence.rb +1 -1
  34. data/lib/graphiti/resource/polymorphism.rb +1 -1
  35. data/lib/graphiti/resource.rb +2 -2
  36. data/lib/graphiti/resource_proxy.rb +0 -1
  37. data/lib/graphiti/scoping/filter.rb +5 -3
  38. data/lib/graphiti/scoping/paginate.rb +1 -1
  39. data/lib/graphiti/scoping/sort.rb +1 -1
  40. data/lib/graphiti/sideload/has_many.rb +1 -1
  41. data/lib/graphiti/spec_helpers/errors_proxy.rb +1 -1
  42. data/lib/graphiti/spec_helpers/matchers.rb +1 -1
  43. data/lib/graphiti/types.rb +5 -1
  44. data/lib/graphiti/util/cache_debug.rb +3 -3
  45. data/lib/graphiti/util/hash.rb +1 -1
  46. data/lib/graphiti/util/persistence.rb +6 -6
  47. data/lib/graphiti/util/serializer_relationships.rb +1 -1
  48. data/lib/graphiti/version.rb +1 -1
  49. data/lib/tasks/graphiti.rake +1 -1
  50. metadata +31 -197
  51. data/docs/concepts/backends-and-models.md +0 -122
  52. data/docs/concepts/endpoints.md +0 -183
  53. data/docs/concepts/links.md +0 -212
  54. data/docs/concepts/overview.md +0 -80
  55. data/docs/concepts/persisting.md +0 -376
  56. data/docs/concepts/relationships.md +0 -627
  57. data/docs/concepts/resources.md +0 -677
  58. data/docs/getting-started/first-api.md +0 -289
  59. data/docs/getting-started/installation.md +0 -185
  60. data/docs/intro.md +0 -307
  61. data/docs/js/authentication.md +0 -63
  62. data/docs/js/ddau.md +0 -20
  63. data/docs/js/extra-params.md +0 -41
  64. data/docs/js/index.md +0 -112
  65. data/docs/js/installation.md +0 -120
  66. data/docs/js/middleware.md +0 -72
  67. data/docs/js/models.md +0 -202
  68. data/docs/js/reads.md +0 -494
  69. data/docs/js/state-syncing.md +0 -100
  70. data/docs/js/writes.md +0 -373
  71. data/docs/reference/vandal.md +0 -63
  72. data/docs/reference/why.md +0 -13
  73. data/docs/topics/authorization.md +0 -155
  74. data/docs/topics/caching.md +0 -55
  75. data/docs/topics/customizing-sideloads.md +0 -156
  76. data/docs/topics/debugging.md +0 -242
  77. data/docs/topics/error-handling.md +0 -210
  78. data/docs/topics/etags.md +0 -46
  79. data/docs/topics/hopping-relationships.md +0 -149
  80. data/docs/topics/json-attributes.md +0 -77
  81. data/docs/topics/openstruct-models.md +0 -50
  82. data/docs/topics/remote-resources.md +0 -291
  83. data/docs/topics/testing.md +0 -916
  84. data/docs/topics/without-activerecord.md +0 -324
  85. data/docs/tutorial/index.md +0 -58
  86. data/docs/tutorial/step_0.md +0 -107
  87. data/docs/tutorial/step_1.md +0 -199
  88. data/docs/tutorial/step_2.md +0 -312
  89. data/docs/tutorial/step_3.md +0 -142
  90. data/docs/tutorial/step_4.md +0 -135
  91. data/docs/tutorial/step_5.md +0 -69
  92. data/docs/tutorial/step_6.md +0 -82
  93. data/docs/tutorial/step_7.md +0 -205
  94. data/docs/tutorial/step_8.md +0 -128
  95. data/docs/tutorial/step_9.md +0 -171
  96. data/docs/upgrading.md +0 -267
  97. data/website/.gitignore +0 -20
  98. data/website/README.md +0 -43
  99. data/website/docusaurus.config.js +0 -197
  100. data/website/package-lock.json +0 -19474
  101. data/website/package.json +0 -46
  102. data/website/sidebars.js +0 -82
  103. data/website/src/css/custom.css +0 -85
  104. data/website/src/pages/markdown-page.mdx +0 -7
  105. data/website/static/.nojekyll +0 -0
  106. data/website/static/1.13/2019/03/31/graphiti-1-0.html +0 -205
  107. data/website/static/1.13/2019/05/08/graphiti-1-1.html +0 -212
  108. data/website/static/1.13/2019/05/20/graphiti-1-2.html +0 -214
  109. data/website/static/1.13/2019/10/14/tutorial.html +0 -198
  110. data/website/static/1.13/CNAME +0 -1
  111. data/website/static/1.13/README.md +0 -16
  112. data/website/static/1.13/assets/css/syntax.css +0 -60
  113. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  114. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  115. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  116. data/website/static/1.13/assets/favicons/browserconfig.xml +0 -9
  117. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  118. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  119. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  120. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  121. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +0 -1
  122. data/website/static/1.13/assets/favicons/site.webmanifest +0 -19
  123. data/website/static/1.13/assets/img/backend.gif +0 -0
  124. data/website/static/1.13/assets/img/conformity.png +0 -0
  125. data/website/static/1.13/assets/img/error_payload.png +0 -0
  126. data/website/static/1.13/assets/img/fancy-cushion.png +0 -0
  127. data/website/static/1.13/assets/img/gh.png +0 -0
  128. data/website/static/1.13/assets/img/home-bg.jpg +0 -0
  129. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  130. data/website/static/1.13/assets/img/logo-500.png +0 -0
  131. data/website/static/1.13/assets/img/logo.png +0 -0
  132. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  133. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  134. data/website/static/1.13/assets/img/persist.jpg +0 -0
  135. data/website/static/1.13/assets/img/resource.gif +0 -0
  136. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  137. data/website/static/1.13/assets/img/rest1.gif +0 -0
  138. data/website/static/1.13/assets/img/rest2.gif +0 -0
  139. data/website/static/1.13/assets/img/rest3.gif +0 -0
  140. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  141. data/website/static/1.13/assets/img/sunrise.png +0 -0
  142. data/website/static/1.13/assets/img/why.png +0 -0
  143. data/website/static/1.13/assets/js/highlight.pack.js +0 -2
  144. data/website/static/1.13/assets/main.css +0 -15518
  145. data/website/static/1.13/assets/main.css.map +0 -1
  146. data/website/static/1.13/bin/bundle +0 -109
  147. data/website/static/1.13/bin/jekyll +0 -27
  148. data/website/static/1.13/bin/kramdown +0 -27
  149. data/website/static/1.13/bin/listen +0 -27
  150. data/website/static/1.13/bin/rake +0 -27
  151. data/website/static/1.13/bin/rougify +0 -27
  152. data/website/static/1.13/bin/safe_yaml +0 -27
  153. data/website/static/1.13/bin/sass +0 -27
  154. data/website/static/1.13/bin/sass-convert +0 -27
  155. data/website/static/1.13/bin/scss +0 -27
  156. data/website/static/1.13/blog.html +0 -259
  157. data/website/static/1.13/cheatsheet.html +0 -316
  158. data/website/static/1.13/cookbooks/authorization.md +0 -0
  159. data/website/static/1.13/cookbooks/caching.md +0 -0
  160. data/website/static/1.13/cookbooks/customizing-sideloads.html +0 -325
  161. data/website/static/1.13/cookbooks/etags.md +0 -0
  162. data/website/static/1.13/cookbooks/hopping-relationships.html +0 -324
  163. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  164. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  165. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  166. data/website/static/1.13/cookbooks/without-activerecord.html +0 -510
  167. data/website/static/1.13/features.html +0 -249
  168. data/website/static/1.13/feed.xml +0 -106
  169. data/website/static/1.13/guides/concepts/backends-and-models.html +0 -467
  170. data/website/static/1.13/guides/concepts/debugging.html +0 -440
  171. data/website/static/1.13/guides/concepts/endpoints.html +0 -432
  172. data/website/static/1.13/guides/concepts/error-handling.html +0 -396
  173. data/website/static/1.13/guides/concepts/links.html +0 -501
  174. data/website/static/1.13/guides/concepts/remote-resources.html +0 -536
  175. data/website/static/1.13/guides/concepts/resources.html +0 -2176
  176. data/website/static/1.13/guides/concepts/testing.html +0 -1469
  177. data/website/static/1.13/guides/getting-started/installation.html +0 -420
  178. data/website/static/1.13/guides/graphiti-rails-migration.html +0 -242
  179. data/website/static/1.13/guides/index.html +0 -269
  180. data/website/static/1.13/guides/overview.html +0 -325
  181. data/website/static/1.13/guides/upgrading-2-0.html +0 -193
  182. data/website/static/1.13/guides/upgrading.html +0 -314
  183. data/website/static/1.13/guides/vandal.html +0 -282
  184. data/website/static/1.13/guides/why.html +0 -1121
  185. data/website/static/1.13/index.html +0 -72
  186. data/website/static/1.13/js/authentication.html +0 -295
  187. data/website/static/1.13/js/ddau.html +0 -238
  188. data/website/static/1.13/js/extra-params.html +0 -270
  189. data/website/static/1.13/js/index.html +0 -321
  190. data/website/static/1.13/js/installation.html +0 -637
  191. data/website/static/1.13/js/introduction.html +0 -257
  192. data/website/static/1.13/js/middleware.html +0 -318
  193. data/website/static/1.13/js/reads/fieldsets.html +0 -271
  194. data/website/static/1.13/js/reads/filtering.html +0 -289
  195. data/website/static/1.13/js/reads/includes.html +0 -260
  196. data/website/static/1.13/js/reads/index.html +0 -497
  197. data/website/static/1.13/js/reads/nested-queries.html +0 -353
  198. data/website/static/1.13/js/reads/pagination.html +0 -260
  199. data/website/static/1.13/js/reads/sorting.html +0 -265
  200. data/website/static/1.13/js/reads/statistics.html +0 -289
  201. data/website/static/1.13/js/state-syncing.html +0 -340
  202. data/website/static/1.13/js/writes/deferred.html +0 -296
  203. data/website/static/1.13/js/writes/dirty-tracking.html +0 -399
  204. data/website/static/1.13/js/writes/index.html +0 -391
  205. data/website/static/1.13/js/writes/nested.html +0 -330
  206. data/website/static/1.13/js/writes/validations.html +0 -272
  207. data/website/static/1.13/quickstart.html +0 -660
  208. data/website/static/1.13/template +0 -161
  209. data/website/static/1.13/tutorial/index.html +0 -250
  210. data/website/static/1.13/tutorial/step_0.html +0 -292
  211. data/website/static/1.13/tutorial/step_1.html +0 -517
  212. data/website/static/1.13/tutorial/step_2.html +0 -481
  213. data/website/static/1.13/tutorial/step_3.html +0 -323
  214. data/website/static/1.13/tutorial/step_4.html +0 -318
  215. data/website/static/1.13/tutorial/step_5.html +0 -265
  216. data/website/static/1.13/tutorial/step_6.html +0 -276
  217. data/website/static/1.13/tutorial/step_7.html +0 -390
  218. data/website/static/1.13/tutorial/step_8.html +0 -316
  219. data/website/static/1.13/tutorial/step_9.html +0 -365
  220. data/website/static/CNAME +0 -1
  221. data/website/static/assets/img/error_payload.png +0 -0
  222. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  223. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  224. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  225. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  226. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  227. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  228. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  229. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  230. data/website/static/assets/img/meta_total_count.png +0 -0
  231. data/website/static/img/docusaurus-social-card.jpg +0 -0
  232. data/website/static/img/docusaurus.png +0 -0
  233. data/website/static/img/favicon.ico +0 -0
  234. data/website/static/img/logo.png +0 -0
  235. data/website/static/img/logo.svg +0 -1
  236. data/website/static/img/undraw_docusaurus_mountain.svg +0 -171
  237. data/website/static/img/undraw_docusaurus_react.svg +0 -170
  238. data/website/static/img/undraw_docusaurus_tree.svg +0 -40
data/website/static/1.13/guides/getting-started/installation.html DELETED
@@ -1,420 +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="installation">Installation</h1>
85
-
86
- <ul>
87
- <li>1 <a href="#from-scratch">From Scratch</a></li>
88
- <li>2 <a href="#adding-to-an-existing-app">Adding to an Existing App</a>
89
- <ul>
90
- <li><a href="#responders">Responders</a></li>
91
- <li><a href="#graphiticfg">.graphiticfg.yml</a></li>
92
- <li><a href="#testing">Testing</a></li>
93
- <li><a href="#will-paginate">will_paginate</a></li>
94
- </ul>
95
- </li>
96
- <li>3 <a href="#without-rails">Without Rails</a></li>
97
- </ul>
98
-
99
- </div>
100
-
101
- <div class="col-md-8">
102
-
103
- <a class="anchor" id="from-scratch" />
104
- <a class="header" href="#from-scratch">
105
- <h2>
106
- 1 From Scratch
107
- </h2>
108
- </a>
109
-
110
- <p>The easiest way to start from scratch is to use the application
111
- template:</p>
112
-
113
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>rails new blog <span class="nt">--api</span> <span class="nt">-m</span> https://raw.githubusercontent.com/graphiti-api/graphiti_rails_template/master/all.rb</code></pre></figure>
114
-
115
- <p>Alternatively, download and point to the template locally:</p>
116
-
117
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>curl <span class="nt">-O</span> https://raw.githubusercontent.com/graphiti-api/graphiti_rails_template/master/all.rb
118
- <span class="nv">$ </span>rails new blog <span class="nt">--api</span> <span class="nt">-m</span> all.rb</code></pre></figure>
119
-
120
- <p>Run <code class="language-plaintext highlighter-rouge">git diff</code> to see the changes to a blank Rails app.</p>
121
-
122
- <a class="anchor" id="adding-to-an-existing-app" />
123
- <a class="header" href="#adding-to-an-existing-app">
124
- <h2>
125
- 2 Adding to an Existing App
126
- </h2>
127
- </a>
128
-
129
- <p>This process is straightforward; you can add Graphiti to an existing
130
- Rails app alongside <a href="https://github.com/rails/jbuilder">JBuilder</a> or <a href="https://github.com/rails-api/active_model_serializers">ActiveModelSerializers</a>.</p>
131
-
132
- <p>Start with gems:</p>
133
-
134
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># The only strictly-required gem</span>
135
- <span class="n">gem</span> <span class="s1">'graphiti'</span>
136
-
137
- <span class="c1"># For automatic ActiveRecord pagination</span>
138
- <span class="n">gem</span> <span class="s1">'kaminari'</span>
139
-
140
- <span class="c1"># Test-specific gems</span>
141
- <span class="n">group</span> <span class="ss">:development</span><span class="p">,</span> <span class="ss">:test</span> <span class="k">do</span>
142
- <span class="n">gem</span> <span class="s1">'rspec-rails'</span>
143
- <span class="n">gem</span> <span class="s1">'factory_bot_rails'</span>
144
- <span class="n">gem</span> <span class="s1">'faker'</span>
145
- <span class="k">end</span>
146
-
147
- <span class="n">group</span> <span class="ss">:test</span> <span class="k">do</span>
148
- <span class="n">gem</span> <span class="s1">'database_cleaner'</span>
149
- <span class="k">end</span></code></pre></figure>
150
-
151
- <p>You’ll be up-and-running at this point. Verify with a simple standalone
152
- Resource:</p>
153
-
154
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># Assuming you already have a Post ActiveRecord Model</span>
155
- <span class="k">class</span> <span class="nc">PostResource</span> <span class="o">&lt;</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Resource</span>
156
- <span class="nb">self</span><span class="p">.</span><span class="nf">adapter</span> <span class="o">=</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Adapters</span><span class="o">::</span><span class="no">ActiveRecord</span>
157
- <span class="n">attribute</span> <span class="ss">:title</span><span class="p">,</span> <span class="ss">:string</span>
158
- <span class="k">end</span>
159
-
160
- <span class="no">PostResource</span><span class="p">.</span><span class="nf">all</span><span class="p">.</span><span class="nf">data</span> <span class="c1"># =&gt; [#&lt;Post&gt;, #&lt;Post&gt;, ...]</span></code></pre></figure>
161
-
162
- <p>Now we just need to integrate with Rails endpoints (to give us things
163
- like <a href="/1.13/guides/concepts/resources#context">#context</a>):</p>
164
-
165
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/controllers/application_controller.rb</span>
166
- <span class="k">class</span> <span class="nc">ApplicationController</span> <span class="o">&lt;</span> <span class="no">ActionController</span><span class="o">::</span><span class="no">Base</span>
167
- <span class="kp">include</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Rails</span><span class="o">::</span><span class="no">Controller</span>
168
- <span class="k">end</span></code></pre></figure>
169
-
170
- <p>And wire-up our error-handling:</p>
171
-
172
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/controllers/application_controller.rb</span>
173
- <span class="c1"># When #show action does not find record, return 404</span>
174
- <span class="n">register_exception</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Errors</span><span class="o">::</span><span class="no">RecordNotFound</span><span class="p">,</span>
175
- <span class="ss">status: </span><span class="mi">404</span>
176
-
177
- <span class="n">rescue_from</span> <span class="no">Exception</span> <span class="k">do</span> <span class="o">|</span><span class="n">e</span><span class="o">|</span>
178
- <span class="n">handle_exception</span><span class="p">(</span><span class="n">e</span><span class="p">)</span>
179
- <span class="k">end</span></code></pre></figure>
180
-
181
- <p>That’s it for the basics. You may have issues with generators
182
- conflicting with your existing application structure - but you can
183
- always write files manually or <a href="https://github.com/graphiti-api/graphiti/issues">submit an issue</a>.</p>
184
-
185
- <a class="anchor" id="responders" />
186
- <a class="header" href="#responders">
187
- <h3>
188
- 2.1 Responders
189
- </h3>
190
- </a>
191
-
192
- <p>Graphiti supports JSONAPI, simple JSON, and XML. You can do this
193
- manually when inheriting from <code class="language-plaintext highlighter-rouge">ActionController::Base</code></p>
194
-
195
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">def</span> <span class="nf">index</span>
196
- <span class="n">posts</span> <span class="o">=</span> <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>
197
-
198
- <span class="n">respond_to</span> <span class="k">do</span> <span class="o">|</span><span class="nb">format</span><span class="o">|</span>
199
- <span class="nb">format</span><span class="p">.</span><span class="nf">json</span> <span class="p">{</span> <span class="n">render</span><span class="p">(</span><span class="ss">json: </span><span class="n">posts</span><span class="p">)</span> <span class="p">}</span>
200
- <span class="nb">format</span><span class="p">.</span><span class="nf">jsonapi</span> <span class="p">{</span> <span class="n">render</span><span class="p">(</span><span class="ss">jsonapi: </span><span class="n">posts</span><span class="p">)</span> <span class="p">}</span>
201
- <span class="nb">format</span><span class="p">.</span><span class="nf">xml</span> <span class="p">{</span> <span class="n">render</span><span class="p">(</span><span class="ss">xml: </span><span class="n">posts</span><span class="p">)</span> <span class="p">}</span>
202
- <span class="k">end</span>
203
- <span class="k">end</span></code></pre></figure>
204
-
205
- <p>But we can inherit from <code class="language-plaintext highlighter-rouge">ActionController::API</code> while avoiding this
206
- boilerplate with with the <a href="https://github.com/plataformatec/responders">Responders</a> gem:</p>
207
-
208
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">def</span> <span class="nf">index</span>
209
- <span class="n">posts</span> <span class="o">=</span> <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>
210
- <span class="n">respond_with</span><span class="p">(</span><span class="n">posts</span><span class="p">)</span>
211
- <span class="k">end</span></code></pre></figure>
212
-
213
- <p>To get this functionality:</p>
214
-
215
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># Gemfile</span>
216
- <span class="n">gem</span> <span class="s1">'responders'</span>
217
-
218
- <span class="c1"># app/controllers/application_controller.rb</span>
219
- <span class="kp">include</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Rails</span><span class="o">::</span><span class="no">Responders</span></code></pre></figure>
220
-
221
- <blockquote>
222
- <p>Note: Persistence operations only support JSONAPI format, so you’ll
223
- still use <code class="language-plaintext highlighter-rouge">render jsonapi:</code> and <code class="language-plaintext highlighter-rouge">render jsonapi_errors:</code> for those.</p>
224
- </blockquote>
225
-
226
- <a class="anchor" id="graphiticfg" />
227
- <a class="header" href="#graphiticfg">
228
- <h3>
229
- 2.3 .graphiticfg.yml
230
- </h3>
231
- </a>
232
-
233
- <p>The <code class="language-plaintext highlighter-rouge">.graphiticfg.yml</code> file lives in the root directory of your
234
- application. It holds configuration we need to reuse across a variety of
235
- contexts (primarily generates and rake tasks). If you use our template to create your application, it’s created for you.</p>
236
-
237
- <p>Primarily this is used to hold your “API namespace”:</p>
238
-
239
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nt">---</span>
240
- namespace: /my_api/v1</code></pre></figure>
241
-
242
- <p>If this file doesn’t exist you may get unexpected errors - make sure to
243
- create it!</p>
244
-
245
- <a class="anchor" id="testing" />
246
- <a class="header" href="#testing">
247
- <h3>
248
- 2.4 Testing
249
- </h3>
250
- </a>
251
-
252
- <p>To add our <a href="/1.13/guides/concepts/testing">Integration Tests</a>:</p>
253
-
254
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># Gemfile</span>
255
- <span class="n">group</span> <span class="ss">:development</span><span class="p">,</span> <span class="ss">:test</span> <span class="k">do</span>
256
- <span class="n">gem</span> <span class="s1">'factory_bot_rails'</span>
257
- <span class="n">gem</span> <span class="s1">'rspec_rails'</span>
258
- <span class="n">gem</span> <span class="s1">'faker'</span>
259
- <span class="k">end</span>
260
-
261
- <span class="n">group</span> <span class="ss">:test</span> <span class="k">do</span>
262
- <span class="n">gem</span> <span class="s1">'database_cleaner'</span>
263
- <span class="k">end</span></code></pre></figure>
264
-
265
- <p>Bootstrap RSpec if you haven’t already:</p>
266
-
267
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>bin/rails g rspec:install</code></pre></figure>
268
-
269
- <p>Add some RSpec configuration:</p>
270
-
271
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="nb">require</span> <span class="s1">'graphiti/spec_helpers/rspec'</span>
272
-
273
- <span class="no">RSpec</span><span class="p">.</span><span class="nf">configure</span> <span class="k">do</span> <span class="o">|</span><span class="n">config</span><span class="o">|</span>
274
- <span class="n">config</span><span class="p">.</span><span class="nf">include</span> <span class="no">FactoryBot</span><span class="o">::</span><span class="no">Syntax</span><span class="o">::</span><span class="no">Methods</span>
275
- <span class="n">config</span><span class="p">.</span><span class="nf">include</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">SpecHelpers</span><span class="o">::</span><span class="no">RSpec</span>
276
- <span class="n">config</span><span class="p">.</span><span class="nf">include</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">SpecHelpers</span><span class="o">::</span><span class="no">Sugar</span>
277
- <span class="n">config</span><span class="p">.</span><span class="nf">include</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Rails</span><span class="o">::</span><span class="no">TestHelpers</span><span class="p">,</span> <span class="ss">type: :request</span>
278
-
279
- <span class="c1"># Clean your DB between test runs</span>
280
- <span class="n">config</span><span class="p">.</span><span class="nf">before</span><span class="p">(</span><span class="ss">:suite</span><span class="p">)</span> <span class="k">do</span>
281
- <span class="no">DatabaseCleaner</span><span class="p">.</span><span class="nf">strategy</span> <span class="o">=</span> <span class="ss">:transaction</span>
282
- <span class="no">DatabaseCleaner</span><span class="p">.</span><span class="nf">clean_with</span><span class="p">(</span><span class="ss">:truncation</span><span class="p">)</span>
283
- <span class="k">end</span>
284
-
285
- <span class="n">config</span><span class="p">.</span><span class="nf">around</span><span class="p">(</span><span class="ss">:each</span><span class="p">)</span> <span class="k">do</span> <span class="o">|</span><span class="n">example</span><span class="o">|</span>
286
- <span class="k">begin</span>
287
- <span class="no">DatabaseCleaner</span><span class="p">.</span><span class="nf">cleaning</span> <span class="k">do</span>
288
- <span class="n">example</span><span class="p">.</span><span class="nf">run</span>
289
- <span class="k">end</span>
290
- <span class="k">ensure</span>
291
- <span class="no">DatabaseCleaner</span><span class="p">.</span><span class="nf">clean</span>
292
- <span class="k">end</span>
293
- <span class="k">end</span>
294
- <span class="k">end</span></code></pre></figure>
295
-
296
- <a class="anchor" id="will-paginate" />
297
- <a class="header" href="#will-paginate">
298
- <h3>
299
- 2.5 will_paginate
300
- </h3>
301
- </a>
302
-
303
- <p>By default, we use <a href="https://github.com/kaminari/kaminari">Kaminari</a> for
304
- ActiveRecord pagination. If you prefer [will_paginate] (or anything
305
- else):</p>
306
-
307
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="c1"># app/resources/application_resource.rb</span>
308
- <span class="n">paginate</span> <span class="k">do</span> <span class="o">|</span><span class="n">scope</span><span class="p">,</span> <span class="n">current_page</span><span class="p">,</span> <span class="n">per_page</span><span class="o">|</span>
309
- <span class="n">scope</span><span class="p">.</span><span class="nf">paginate</span><span class="p">(</span><span class="ss">page: </span><span class="n">current_page</span><span class="p">,</span> <span class="ss">per_page: </span><span class="n">per_page</span><span class="p">)</span>
310
- <span class="k">end</span></code></pre></figure>
311
-
312
- <a class="anchor" id="without-rails" />
313
- <a class="header" href="#without-rails">
314
- <h2>
315
- 3 Without Rails
316
- </h2>
317
- </a>
318
-
319
- <p>You can use Graphiti in any plain <code class="language-plaintext highlighter-rouge">.rb</code> file. To see this in action,
320
- check out the <a href="https://github.com/graphiti-api/plain_ruby_example">Plain Ruby Sample App</a>.</p>
321
-
322
- <p><br />
323
- <br /></p>
324
- </div>
325
-
326
- </div>
327
- </div>
328
- </main>
329
- <div class="main-footer main-footer--dark">
330
- <div class="container">
331
- <div class="row">
332
- <div class="col-sm-4 menu">
333
- <h3>Overview</h3>
334
- <ul>
335
- <li>
336
- <a href="/1.13/quickstart">Quickstart</a>
337
- </li>
338
- <li>
339
- <a href="/1.13/tutorial">Tutorial</a>
340
- </li>
341
- <li>
342
- <a href="/1.13/guides">Guides</a>
343
- </li>
344
- </ul>
345
- </div>
346
- <div class="col-sm-4 menu">
347
- <h3>Contact</h3>
348
- <ul>
349
- <li>
350
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
351
- </li>
352
- <li>
353
- <a href="mailto:richmolj@gmail.com">Email</a>
354
- </li>
355
- </ul>
356
- </div>
357
- <div class="col-sm-4 menu">
358
- <h3>Related</h3>
359
- <ul>
360
- <li>
361
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
362
- </li>
363
- <li>
364
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
365
- </li>
366
- <li>
367
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
368
- </li>
369
- </ul>
370
- </div>
371
- </div>
372
- </div>
373
- </div>
374
-
375
- <script type="text/javascript">
376
- $(function () {
377
-
378
- var flipTabs = function() {
379
- var isTS = true;
380
- if (localStorage.getItem('js-lang') === 'javascript') {
381
- isTS = false;
382
- }
383
-
384
- $('.code-tabs').each(function(index, el) {
385
- if (isTS) {
386
- console.log('hiding js');
387
- $($(el).children()[1]).hide();
388
- $($(el).children()[0]).show();
389
- } else {
390
- console.log('hiding ts');
391
- $($(el).children()[0]).hide();
392
- $($(el).children()[1]).show();
393
- }
394
- });
395
-
396
- if (isTS) {
397
- $('.tab.typescript').addClass('active');
398
- $('.tab.javascript').removeClass('active');
399
- } else {
400
- $('.tab.typescript').removeClass('active');
401
- $('.tab.javascript').addClass('active');
402
- }
403
- }
404
-
405
- $('.tab').click(function() {
406
- if ($(this).hasClass('typescript')) {
407
- localStorage.setItem('js-lang', 'typescript');
408
- } else {
409
- localStorage.setItem('js-lang', 'javascript');
410
- }
411
-
412
- flipTabs();
413
- });
414
-
415
- flipTabs();
416
- })
417
- </script>
418
-
419
- </body>
420
- </html>