feat: upgrade to 1.x format (#5)

* feat: 1.x refactor

* feat: update getting started instructions

* ci: change Node targets

Author: jlengstorf

.travis.yml

@@ -4,9 +4,9 @@ cache:
   directories:
   - node_modules
 node_js:
-- "6"
-- "7"
-- "8"
+- 6
+- 8
+- 9
 notifications:
   email: false
 before_script:

README.md

@@ -1,17 +1,17 @@
-<img src="https://gramps-graphql.github.io/gramps-express/assets/img/gramps-banner.png" alt="GrAMPS · An easier way to manage the data sources powering your GraphQL server" width="450">
+<a href="https://gramps.js.org/"><img src="https://gramps.js.org/assets/img/gramps-banner.png" alt="GrAMPS · An easier way to manage the data sources powering your GraphQL server" width="450"></a>
 
 # GrAMPS GraphQL Data Source Base
 [![Build Status](https://travis-ci.org/gramps-graphql/data-source-base.svg?branch=master)](https://travis-ci.org/gramps-graphql/data-source-base) [![Maintainability](https://api.codeclimate.com/v1/badges/ac264833fac1fbd1afe0/maintainability)](https://codeclimate.com/github/gramps-graphql/data-source-base/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/ac264833fac1fbd1afe0/test_coverage)](https://codeclimate.com/github/gramps-graphql/data-source-base/test_coverage) [![npm version](https://img.shields.io/npm/v/@gramps/data-source-base.svg?style=flat)](https://www.npmjs.com/package/@gramps/data-source-base) [![Greenkeeper badge](https://badges.greenkeeper.io/gramps-graphql/data-source-base.svg)](https://greenkeeper.io/)
 
 This is a minimal example and boilerplate for a GrAMPS data source. Inside, you’ll find:
 
- -  **Connector** — how to access the data source (e.g. a REST API)
- -  **Model** — methods to retrieve/modify data from the data source (e.g. a 
-    CRUD wrapper)
- -  **Schema** — description for GraphQL to interpret the data (see the 
+ -  **Context** — an object with methods to retrieve/modify data from the data 
+    source (e.g. a CRUD wrapper)
+ -  **Schema** — type definitions for GraphQL to interpret the data (see the 
     [GraphQL docs on schemas](http://graphql.org/learn/schema/))
  -  **Resolvers** — functions to map the results of calls to model methods to
     the schema
+ -  **Mock Resolvers** — mock functions for offline development
 
 Each file contains a `TODO` comment explaining the changes you’ll need to make to create a working data source.
 
@@ -32,40 +32,43 @@ To help ensure a reliable, easy-to-maintain data source, this example also inclu
 **NOTE:** Replace all instances of `YOUR_DATA_SOURCE_NAME` with the actual name you want to use (e.g. `data-source-companyname-datatype`).
 
 ```sh
-# Clone the repo
-git clone git@github.com:gramps-graphql/data-source-base.git data-source-YOUR_DATA_SOURCE_NAME
+# Get a copy of the data source
+npx degit gramps-graphql/data-source-base data-source-YOUR_DATA_SOURCE_NAME
 
 # Move into it
 cd data-source-YOUR_DATA_SOURCE_NAME/
 
-# Change the remote repo
-git remote set-url origin git@github.com:USER_OR_ORG/YOUR_REPO_NAME.git
-
 # IMPORTANT: Make sure to edit the name, description, contributors, and 
 # repository fields in package.json
 
 # Install dependencies
-yarn install
-```
+yarn
 
-### To Develop with Mock Data
+# Start the dev server
+yarn dev
+```
 
-Start the app with the following command:
+You'll see a message with URLs for the GraphQL gateway and the [GraphQL Playground](https://github.com/graphcool/graphql-playground). Open the Playground link (usually http://localhost:8080/playground if you don’t already have something running on port 8080), then run a query:
 
-```sh
-# Develop with mock data
-yarn mock-data
+```graphql
+{
+  getById(id: 123) {
+    id
+    name
+    lucky_numbers
+  }
+}
 ```
 
-### To Develop with Live Data
+### To Develop with Mock Data
 
-Once you’ve got your data source configured to load live data, you can enable live data in development:
+Start the app with the following command:
 
 ```sh
-# Develop with live data
-yarn live-data
+# Start the gateway with mock data
+yarn dev --mock
 ```
 
 ### Notes for Developers
 
-Currently, there is no watch capability (PRs welcome!), so the service needs to be stopped (`control` + `C`) and restarted (`yarn [mock-data|live-data]`) to reflect new changes to the data source.
+Currently, there is no watch capability (PRs welcome!), so the service needs to be stopped (`control` + `C`) and restarted (`yarn dev`) to reflect new changes to the data source.

package.json

@@ -19,9 +19,8 @@
     "prepush": "npm test",
     "prebuild": "del-cli ./dist",
     "build": "babel src -d dist",
-    "dev": "gramps --data-source-dir ./",
-    "mock-data": "npm run dev -- --mock",
-    "live-data": "npm run dev -- --live",
+    "dev": "gramps dev --data-source .",
+    "dev:mock-data": "gramps dev --data-source . --mock",
     "lint": "eslint src/",
     "test:unit": "cross-env NODE_ENV=test jest --coverage",
     "test": "npm run lint --silent && npm run test:unit --silent",
@@ -32,33 +31,34 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@gramps/gramps-express": "^0.1.3",
-    "casual": "^1.5.14"
+    "casual": "^1.5.19"
   },
   "peerDependencies": {
     "graphql": "^0.9.0 || ^0.10.0 || ^0.11.0",
     "graphql-tools": "^1.2.1 || ^2.5.1"
   },
   "devDependencies": {
+    "@gramps/cli": "^1.0.0-beta.4",
+    "@gramps/gramps": "^1.0.0-beta-7",
     "babel-cli": "^6.24.1",
-    "babel-eslint": "^8.0.1",
+    "babel-eslint": "^8.0.3",
     "babel-jest": "^21.2.0",
     "babel-plugin-inline-import": "^2.0.6",
     "babel-preset-env": "^1.6.1",
     "babel-preset-stage-2": "^6.24.1",
     "cross-env": "^5.1.1",
     "del-cli": "^1.1.0",
-    "eslint": "^4.4.1",
+    "eslint": "^4.13.1",
     "eslint-config-airbnb-base": "^12.1.0",
-    "eslint-config-prettier": "^2.3.0",
-    "eslint-plugin-import": "^2.7.0",
-    "eslint-plugin-prettier": "^2.1.2",
+    "eslint-config-prettier": "^2.9.0",
+    "eslint-plugin-import": "^2.8.0",
+    "eslint-plugin-prettier": "^2.4.0",
     "graphql": "^0.11.7",
-    "graphql-tools": "^2.5.1",
+    "graphql-tools": "^2.13.0",
     "husky": "^0.14.3",
     "jest": "^21.2.1",
-    "nodemon": "^1.11.0",
-    "prettier": "^1.5.3",
+    "nodemon": "^1.13.3",
+    "prettier": "^1.9.2",
     "semantic-release": "^8.2.0"
   },
   "jest": {

src/connector.js

@@ -0,0 +1,7 @@
+export default {
+  getById: id => ({
+    id,
+    name: 'GrAMPS Data Source Base',
+    lucky_numbers: [1, 2, 3, 5, 8, 13, 21],
+  }),
+};

src/context.js

@@ -1,16 +1,17 @@
-import schema from './schema.graphql';
+import typeDefs from './schema.graphql';
+import context from './context';
 import resolvers from './resolvers';
-import Connector from './connector';
-import Model from './model';
+import mocks from './mocks';
 
 /*
  * For more information on the main data source object, see
  * https://ibm.biz/graphql-data-source-main
  */
 export default {
   // TODO: Rename the context to describe the data source.
-  context: 'YourDataSource',
-  model: new Model({ connector: new Connector() }),
-  schema,
+  namespace: 'DataSourceBase',
+  context,
+  typeDefs,
   resolvers,
+  mocks,
 };

src/index.js

@@ -0,0 +1,11 @@
+import { MockList } from 'graphql-tools';
+import casual from 'casual';
+
+export default {
+  // TODO: Update to mock all schema fields and types.
+  PFX_DataSourceBase: () => ({
+    id: casual.uuid,
+    name: casual.name,
+    lucky_numbers: () => new MockList([0, 3]), // casual.array_of_digits(3),
+  }),
+};

src/mocks.js

@@ -1,41 +1,12 @@
-import { MockList } from 'graphql-tools';
-import casual from 'casual';
-
-/*
- * For more information on data source resolvers, see
- * https://ibm.biz/graphql-data-source-resolvers
- */
-
 export default {
-  // Queries (where does the data come from?)
-  queryResolvers: {
+  Query: {
     // TODO: Update query resolver name(s) to match schema queries
-    YourDataSource: (rootValue, { id }, context) =>
-      new Promise((resolve, reject) => {
-        // TODO: Update to use the model and call the proper method.
-        context.YourDataSource
-          .getById(id)
-          .then(resolve)
-          .catch(reject);
-      }),
+    getById: (_, { id }, context) =>
+      // TODO: Update to use the model and call the proper method.
+      context.getById(id),
   },
-
-  // Data fields (which data from the response goes to which field?)
-  dataResolvers: {
-    // TODO: Update to reference the schema type(s) and field(s).
-    PFX_YourDataSource: {
-      // If a field isn’t always set, but it shouldn’t break the response, make it nullable.
-      name: data => data.name || null,
-    },
-  },
-
-  // Mock data (How can I get real-feeling fake data while working offline?)
-  mockResolvers: {
-    // TODO: Update to mock all schema fields and types.
-    PFX_YourDataSource: () => ({
-      id: casual.uuid,
-      name: casual.name,
-      lucky_numbers: () => new MockList([0, 3]),
-    }),
+  // TODO: Update to reference the schema type(s) and field(s).
+  PFX_DataSourceBase: {
+    name: data => data.name || null,
   },
 };

src/model.js

@@ -1,14 +1,13 @@
-# The query/queries to access data MUST extend the Query type.
-extend type Query {
+type Query {
   # TODO: rename and add a description of this query
-  YourDataSource(
+  getById(
     # TODO: Describe this argument
     id: ID!
-  ): PFX_YourDataSource
+  ): PFX_DataSourceBase
 }
 
 # TODO: Choose a unique prefix and rename the type descriptively.
-type PFX_YourDataSource {
+type PFX_DataSourceBase {
   # The unique ID of the thing.
   id: ID!
   # Describe each field to help people use the data more effectively.