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.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +30 -86
- data/.github/workflows/docs.yml +60 -0
- data/.github/workflows/release.yml +8 -8
- data/.gitignore +7 -0
- data/.npmrc +9 -0
- data/.standard.yml +4 -1
- data/Appraisals +33 -32
- data/CHANGELOG.md +41 -0
- data/README.md +13 -2
- data/UPGRADING.md +2 -68
- data/docs/concepts/backends-and-models.md +122 -0
- data/docs/concepts/endpoints.md +183 -0
- data/docs/concepts/links.md +212 -0
- data/docs/concepts/overview.md +80 -0
- data/docs/concepts/persisting.md +376 -0
- data/docs/concepts/relationships.md +527 -0
- data/docs/concepts/resources.md +677 -0
- data/docs/getting-started/first-api.md +289 -0
- data/docs/getting-started/installation.md +185 -0
- data/docs/intro.md +307 -0
- data/docs/js/authentication.md +63 -0
- data/docs/js/ddau.md +20 -0
- data/docs/js/extra-params.md +41 -0
- data/docs/js/index.md +112 -0
- data/docs/js/installation.md +120 -0
- data/docs/js/middleware.md +72 -0
- data/docs/js/models.md +202 -0
- data/docs/js/reads.md +494 -0
- data/docs/js/state-syncing.md +100 -0
- data/docs/js/writes.md +373 -0
- data/docs/reference/vandal.md +63 -0
- data/docs/reference/why.md +13 -0
- data/docs/topics/authorization.md +155 -0
- data/docs/topics/caching.md +55 -0
- data/docs/topics/customizing-sideloads.md +156 -0
- data/docs/topics/debugging.md +216 -0
- data/docs/topics/error-handling.md +210 -0
- data/docs/topics/etags.md +46 -0
- data/docs/topics/hopping-relationships.md +149 -0
- data/docs/topics/json-attributes.md +77 -0
- data/docs/topics/openstruct-models.md +50 -0
- data/docs/topics/remote-resources.md +291 -0
- data/docs/topics/testing.md +894 -0
- data/docs/topics/without-activerecord.md +324 -0
- data/docs/tutorial/index.md +58 -0
- data/docs/tutorial/step_0.md +107 -0
- data/docs/tutorial/step_1.md +199 -0
- data/docs/tutorial/step_2.md +312 -0
- data/docs/tutorial/step_3.md +142 -0
- data/docs/tutorial/step_4.md +135 -0
- data/docs/tutorial/step_5.md +69 -0
- data/docs/tutorial/step_6.md +82 -0
- data/docs/tutorial/step_7.md +205 -0
- data/docs/tutorial/step_8.md +128 -0
- data/docs/tutorial/step_9.md +171 -0
- data/docs/upgrading.md +265 -0
- data/gemfiles/rails_7_1.gemfile +4 -3
- data/gemfiles/{rails_7_2_graphiti_rails.gemfile → rails_7_2.gemfile} +3 -3
- data/gemfiles/{rails_8_1_graphiti_rails.gemfile → rails_8_0.gemfile} +3 -3
- data/gemfiles/{rails_8_0_graphiti_rails.gemfile → rails_8_1.gemfile} +3 -3
- data/graphiti.gemspec +7 -5
- data/{deprecated_generators → lib/generators}/graphiti/api_test_generator.rb +7 -1
- data/{deprecated_generators → lib/generators}/graphiti/generator_mixin.rb +14 -1
- data/{deprecated_generators → lib/generators}/graphiti/install_generator.rb +19 -13
- data/{deprecated_generators → lib/generators}/graphiti/resource_generator.rb +43 -6
- data/{deprecated_generators → lib/generators}/graphiti/templates/index_request_spec.rb.erb +1 -1
- data/{deprecated_generators → lib/generators}/graphiti/templates/resource_reads_spec.rb.erb +6 -6
- data/{deprecated_generators → lib/generators}/graphiti/templates/show_request_spec.rb.erb +1 -1
- data/lib/graphiti/configuration.rb +2 -2
- data/lib/graphiti/error_serializers/conflict_request.rb +19 -0
- data/lib/graphiti/error_serializers/deprecated_constants.rb +48 -0
- data/lib/graphiti/error_serializers/invalid_request.rb +56 -0
- data/lib/graphiti/error_serializers/validation.rb +143 -0
- data/lib/graphiti/errors.rb +4 -23
- data/lib/graphiti/query.rb +1 -1
- data/lib/graphiti/rails/context.rb +33 -0
- data/lib/graphiti/rails/controller.rb +41 -0
- data/lib/graphiti/rails/debugging.rb +18 -0
- data/lib/graphiti/rails/exception_handlers.rb +77 -0
- data/lib/graphiti/rails/railtie.rb +139 -0
- data/lib/graphiti/rails/responders.rb +21 -0
- data/lib/graphiti/rails/test_helpers.rb +22 -0
- data/lib/graphiti/rails.rb +47 -29
- data/lib/graphiti/resource/configuration.rb +1 -0
- data/lib/graphiti/resource/interface.rb +2 -2
- data/lib/graphiti/resource/persistence.rb +14 -2
- data/lib/graphiti/resource/remote.rb +2 -2
- data/lib/graphiti/resource/sideloading.rb +1 -1
- data/lib/graphiti/resource.rb +13 -1
- data/lib/graphiti/responders.rb +7 -20
- data/lib/graphiti/schema.rb +5 -1
- data/lib/graphiti/schema_diff.rb +4 -0
- data/lib/graphiti/scope.rb +45 -37
- data/lib/graphiti/serializer.rb +6 -0
- data/lib/graphiti/sideload/belongs_to.rb +38 -5
- data/lib/graphiti/sideload/polymorphic_belongs_to.rb +27 -23
- data/lib/graphiti/sideload.rb +54 -35
- data/lib/graphiti/spec_helpers/errors.rb +73 -0
- data/lib/graphiti/spec_helpers/errors_proxy.rb +75 -0
- data/lib/graphiti/spec_helpers/helpers.rb +107 -0
- data/lib/graphiti/spec_helpers/node.rb +88 -0
- data/lib/graphiti/spec_helpers/rspec.rb +147 -0
- data/lib/graphiti/spec_helpers.rb +53 -0
- data/lib/graphiti/util/include_params.rb +2 -2
- data/lib/graphiti/util/persistence.rb +10 -11
- data/lib/graphiti/util/serializer_relationships.rb +41 -5
- data/lib/graphiti/version.rb +1 -1
- data/lib/graphiti-rails.rb +11 -0
- data/lib/graphiti.rb +34 -10
- data/lib/graphiti_errors.rb +11 -0
- data/lib/graphiti_spec_helpers/rspec.rb +3 -0
- data/lib/graphiti_spec_helpers.rb +11 -0
- data/lib/{graphiti/deprecated_tasks.rb → tasks/graphiti.rake} +6 -1
- data/package-lock.json +6199 -0
- data/package.json +5 -4
- data/website/.gitignore +20 -0
- data/website/README.md +43 -0
- data/website/docusaurus.config.js +141 -0
- data/website/package-lock.json +19474 -0
- data/website/package.json +46 -0
- data/website/sidebars.js +82 -0
- data/website/src/css/custom.css +58 -0
- data/website/src/pages/markdown-page.mdx +7 -0
- data/website/static/.nojekyll +0 -0
- data/website/static/1.13/2019/03/31/graphiti-1-0.html +205 -0
- data/website/static/1.13/2019/05/08/graphiti-1-1.html +212 -0
- data/website/static/1.13/2019/05/20/graphiti-1-2.html +214 -0
- data/website/static/1.13/2019/10/14/tutorial.html +198 -0
- data/website/static/1.13/CNAME +1 -0
- data/website/static/1.13/README.md +16 -0
- data/website/static/1.13/assets/css/syntax.css +60 -0
- data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
- data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
- data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
- data/website/static/1.13/assets/favicons/browserconfig.xml +9 -0
- data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
- data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
- data/website/static/1.13/assets/favicons/favicon.ico +0 -0
- data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
- data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +1 -0
- data/website/static/1.13/assets/favicons/site.webmanifest +19 -0
- data/website/static/1.13/assets/img/backend.gif +0 -0
- data/website/static/1.13/assets/img/conformity.png +0 -0
- data/website/static/1.13/assets/img/error_payload.png +0 -0
- data/website/static/1.13/assets/img/gh.png +0 -0
- data/website/static/1.13/assets/img/lifecycle.gif +0 -0
- data/website/static/1.13/assets/img/logo-500.png +0 -0
- data/website/static/1.13/assets/img/logo.png +0 -0
- data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
- data/website/static/1.13/assets/img/meta_total_count.png +0 -0
- data/website/static/1.13/assets/img/persist.jpg +0 -0
- data/website/static/1.13/assets/img/resource.gif +0 -0
- data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
- data/website/static/1.13/assets/img/rest1.gif +0 -0
- data/website/static/1.13/assets/img/rest2.gif +0 -0
- data/website/static/1.13/assets/img/rest3.gif +0 -0
- data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
- data/website/static/1.13/assets/img/why.png +0 -0
- data/website/static/1.13/assets/js/highlight.pack.js +2 -0
- data/website/static/1.13/assets/main.css +15518 -0
- data/website/static/1.13/assets/main.css.map +1 -0
- data/website/static/1.13/bin/bundle +109 -0
- data/website/static/1.13/bin/jekyll +27 -0
- data/website/static/1.13/bin/kramdown +27 -0
- data/website/static/1.13/bin/listen +27 -0
- data/website/static/1.13/bin/rake +27 -0
- data/website/static/1.13/bin/rougify +27 -0
- data/website/static/1.13/bin/safe_yaml +27 -0
- data/website/static/1.13/bin/sass +27 -0
- data/website/static/1.13/bin/sass-convert +27 -0
- data/website/static/1.13/bin/scss +27 -0
- data/website/static/1.13/blog.html +259 -0
- data/website/static/1.13/cheatsheet.html +316 -0
- data/website/static/1.13/cookbooks/authorization.md +0 -0
- data/website/static/1.13/cookbooks/caching.md +0 -0
- data/website/static/1.13/cookbooks/customizing-sideloads.html +325 -0
- data/website/static/1.13/cookbooks/etags.md +0 -0
- data/website/static/1.13/cookbooks/hopping-relationships.html +324 -0
- data/website/static/1.13/cookbooks/json_attributes.md +0 -0
- data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
- data/website/static/1.13/cookbooks/remote-resources.md +0 -0
- data/website/static/1.13/cookbooks/without-activerecord.html +510 -0
- data/website/static/1.13/features.html +249 -0
- data/website/static/1.13/feed.xml +106 -0
- data/website/static/1.13/guides/concepts/backends-and-models.html +467 -0
- data/website/static/1.13/guides/concepts/debugging.html +440 -0
- data/website/static/1.13/guides/concepts/endpoints.html +432 -0
- data/website/static/1.13/guides/concepts/error-handling.html +396 -0
- data/website/static/1.13/guides/concepts/links.html +501 -0
- data/website/static/1.13/guides/concepts/remote-resources.html +536 -0
- data/website/static/1.13/guides/concepts/resources.html +2176 -0
- data/website/static/1.13/guides/concepts/testing.html +1469 -0
- data/website/static/1.13/guides/getting-started/installation.html +420 -0
- data/website/static/1.13/guides/graphiti-rails-migration.html +242 -0
- data/website/static/1.13/guides/index.html +269 -0
- data/website/static/1.13/guides/overview.html +325 -0
- data/website/static/1.13/guides/upgrading-2-0.html +193 -0
- data/website/static/1.13/guides/upgrading.html +314 -0
- data/website/static/1.13/guides/vandal.html +282 -0
- data/website/static/1.13/guides/why.html +1121 -0
- data/website/static/1.13/index.html +72 -0
- data/website/static/1.13/js/authentication.html +295 -0
- data/website/static/1.13/js/ddau.html +238 -0
- data/website/static/1.13/js/extra-params.html +270 -0
- data/website/static/1.13/js/index.html +321 -0
- data/website/static/1.13/js/installation.html +637 -0
- data/website/static/1.13/js/introduction.html +257 -0
- data/website/static/1.13/js/middleware.html +318 -0
- data/website/static/1.13/js/reads/fieldsets.html +271 -0
- data/website/static/1.13/js/reads/filtering.html +289 -0
- data/website/static/1.13/js/reads/includes.html +260 -0
- data/website/static/1.13/js/reads/index.html +497 -0
- data/website/static/1.13/js/reads/nested-queries.html +353 -0
- data/website/static/1.13/js/reads/pagination.html +260 -0
- data/website/static/1.13/js/reads/sorting.html +265 -0
- data/website/static/1.13/js/reads/statistics.html +289 -0
- data/website/static/1.13/js/state-syncing.html +340 -0
- data/website/static/1.13/js/writes/deferred.html +296 -0
- data/website/static/1.13/js/writes/dirty-tracking.html +399 -0
- data/website/static/1.13/js/writes/index.html +391 -0
- data/website/static/1.13/js/writes/nested.html +330 -0
- data/website/static/1.13/js/writes/validations.html +272 -0
- data/website/static/1.13/quickstart.html +660 -0
- data/website/static/1.13/template +161 -0
- data/website/static/1.13/tutorial/index.html +250 -0
- data/website/static/1.13/tutorial/step_0.html +292 -0
- data/website/static/1.13/tutorial/step_1.html +517 -0
- data/website/static/1.13/tutorial/step_2.html +481 -0
- data/website/static/1.13/tutorial/step_3.html +323 -0
- data/website/static/1.13/tutorial/step_4.html +318 -0
- data/website/static/1.13/tutorial/step_5.html +265 -0
- data/website/static/1.13/tutorial/step_6.html +276 -0
- data/website/static/1.13/tutorial/step_7.html +390 -0
- data/website/static/1.13/tutorial/step_8.html +316 -0
- data/website/static/1.13/tutorial/step_9.html +365 -0
- data/website/static/assets/img/error_payload.png +0 -0
- data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
- data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
- data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
- data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
- data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
- data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
- data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
- data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
- data/website/static/assets/img/meta_total_count.png +0 -0
- data/website/static/img/docusaurus-social-card.jpg +0 -0
- data/website/static/img/docusaurus.png +0 -0
- data/website/static/img/favicon.ico +0 -0
- data/website/static/img/logo.png +0 -0
- data/website/static/img/logo.svg +1 -0
- data/website/static/img/undraw_docusaurus_mountain.svg +171 -0
- data/website/static/img/undraw_docusaurus_react.svg +170 -0
- data/website/static/img/undraw_docusaurus_tree.svg +40 -0
- metadata +245 -46
- data/gemfiles/rails_6.gemfile +0 -18
- data/gemfiles/rails_6_graphiti_rails.gemfile +0 -19
- data/gemfiles/rails_7.gemfile +0 -18
- data/gemfiles/rails_7_1_graphiti_rails.gemfile +0 -19
- data/gemfiles/rails_7_graphiti_rails.gemfile +0 -19
- data/lib/graphiti/railtie.rb +0 -121
- /data/{deprecated_generators → lib/generators}/graphiti/resource_test_generator.rb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/application_resource.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/controller.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/create_request_spec.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/destroy_request_spec.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/resource.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/resource_writes_spec.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/update_request_spec.rb.erb +0 -0
|
@@ -0,0 +1,420 @@
|
|
|
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"><</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"># => [#<Post>, #<Post>, ...]</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"><</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>
|