Add REST API stitching

docs/README.md

@@ -38,15 +38,15 @@ open http://localhost:3000
 open http://localhost:8080
 ```
 
-::: warning DEMO REQUIREMENTS  
-This demo requires `docker` you can either install it using `brew` or from the 
+::: warning DEMO REQUIREMENTS
+This demo requires `docker` you can either install it using `brew` or from the
 docker website [https://docs.docker.com/docker-for-mac/install/](https://docs.docker.com/docker-for-mac/install/)
 :::
 
 ## Try out GraphQL
 
-```graphql 
-query { 
+```graphql
+query {
   users {
     id
     email
@@ -68,6 +68,11 @@ I always liked GraphQL it sounded friendly, but it still required me to write al
 
 And so after a lot of coffee and some Avocado toasts __Super Graph was born, a GraphQL server that just works, is high performance and easy to deploy__. I hope you find it as useful as I do and there's a lot more coming so hit that :star: to stay in the loop.
 
-## Say hello 
 
-[twitter.com/dosco](https://twitter.com/dosco)
+## Watch some talks
+
+<iframe class="w-full h-full" src="https://www.youtube.com/embed/TGq9wJAj78I" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+
+## Say hello
+
+[twitter.com/dosco](https://twitter.com/dosco)

docs/guide.md

@@ -347,6 +347,75 @@ class AddSearchColumn < ActiveRecord::Migration[5.1]
 end
 ```
 
+## Stitching in REST APIs
+
+It often happens that after fetching some data from the DB we need to call another API to fetch some more data and all this combined into a single JSON response.
+
+For example you need to list the last 3 payments made by a user. You will first need to look up the user in the database and then call the Stripe API to fetch his last 3 payments. For this to work your user table in the db has a `customer_id` column that contains his Stripe customer ID.
+
+Similiarly you might also have the need to fetch the users last tweet and include that too. Super Graph can handle this for you using it's `API Stitching` feature.
+
+### API Stitching configuration
+
+The configuration is self explanatory. A `payments` field has been added under the `customers` table. This field is added to the `remotes` subsection that defines fields associated with `customers` that are remote and not real database columns.
+
+The `id` parameter maps a column from the `customers` table to the `$id` variable. In this case it maps `$id` to the `customer_id` column.
+
+```yaml
+ tables:
+    - name: customers
+
+      remotes:
+        - name: payments
+          id: customer_id
+          path: data
+          pass_headers: 
+            - cookie
+            - host
+          # set_headers:
+          #   - name: authorize
+          #     value: Bearer 1234567890
+          url: http://rails_app:3000/stripe/$id
+```
+
+#### How do I make use of this?
+
+Just include `payments` like you would any other GraphQL selector under the `customers` selector. Super Graph will call the configured API for you and stitch (merge) the JSON the API sends back with the JSON generated from the database query. GraphQL features like aliases and fields all work.
+
+```graphql
+query {
+  customers {
+    id
+    email
+    payments {
+      customer_id
+      amount
+      billing_details
+    }
+  }
+}
+```
+
+And voila here is the result. You get all of this advanced and honestly complex querying capability without writing a single line of code.
+
+```json
+"data": {
+  "customers": [
+    {
+      "id": 1,
+      "email": "linseymertz@reilly.co",
+      "payments": [
+        {
+          "customer_id": "cus_YCj3ndB5Mz",
+          "amount": 100,
+            "billing_details": {
+            "address": "1 Infinity Drive",
+            "zipcode": "94024"
+          }
+        },
+      ...
+```
+
 ## Authentication
 
 You can only have one type of auth enabled. You can either pick Rails or JWT. 
@@ -515,7 +584,7 @@ database:
   defaults:
     filter: ["{ user_id: { eq: $user_id } }"]
 
-    # Fields and table names that you wish to block
+    # Field and table names that you wish to block
     blacklist:
       - ar_internal_metadata
       - schema_migrations
@@ -524,7 +593,7 @@ database:
       - encrypted
       - token
 
-  fields:
+  tables:
     - name: users
       # This filter will overwrite defaults.filter
       filter: ["{ id: { eq: $user_id } }"]
@@ -587,7 +656,7 @@ brew install yarn
 go generate ./...
 
 # do this the only the time to setup the database
-docker-compose run web rake db:create db:migrate
+docker-compose run rails_app rake db:create db:migrate
 
 # start super graph in development mode with a change watcher
 docker-compose up

docs/yarn.lock

@@ -3476,6 +3476,11 @@ lodash.uniq@^4.5.0:
   version "4.5.0"
   resolved "https://registry.yarnpkg.com/lodash.uniq/-/lodash.uniq-4.5.0.tgz#d0225373aeb652adc1bc82e4945339a842754773"
 
+lodash@^4.17.11:
+  version "4.17.11"
+  resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.11.tgz#b39ea6229ef607ecd89e2c8df12536891cac9b8d"
+  integrity sha512-cQKh8igo5QUhZ7lg38DYWAxMvjSAKG0A8wGSVimP07SIUEK2UO+arSRKbRZWtelMtN5V0Hkwh5ryOto/SshYIg==
+
 lodash@^4.17.3, lodash@^4.17.4, lodash@^4.17.5:
   version "4.17.10"
   resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.10.tgz#1b7793cf7259ea38fb3661d4d38b3260af8ae4e7"
@@ -5372,6 +5377,13 @@ table@^4.0.3:
     slice-ansi "1.0.0"
     string-width "^2.1.1"
 
+tailwindcss-aspect-ratio@^1.0.3:
+  version "1.0.3"
+  resolved "https://registry.yarnpkg.com/tailwindcss-aspect-ratio/-/tailwindcss-aspect-ratio-1.0.3.tgz#7aa7cb73ffeeb9f69cedebbfd3980176b14a256f"
+  integrity sha512-burkG+yxTNp8REWMtFkRzXGdt+8/QR2LMRDHjQ37DV4Y7dk+f/WQtfZYFXXU2GKASrp6WidzrtN2z8OA/jilww==
+  dependencies:
+    lodash "^4.17.11"
+
 tapable@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/tapable/-/tapable-1.0.0.tgz#cbb639d9002eed9c6b5975eb20598d7936f1f9f2"