Merge pull request #1 from Shopify/feature/initial-code

Adding all the code

Author: minasmart

README.md

@@ -1,3 +1,5 @@
+[![Circle CI](https://circleci.com/gh/Shopify/graphql-js-schema-fetch.png?circle-token=b91d60ffd2266c360cfc56697c847af8e95f715b)](https://circleci.com/gh/Shopify/graphql-js-schema-fetch)
+
 # graphql-js-schema-fetch
 
 It fetches the JSON representation of the GraphQL schema from a live server
@@ -7,62 +9,49 @@ It fetches the JSON representation of the GraphQL schema from a live server
 - [Installation](#installation)
 - [Examples](#examples)
 - [API](#api)
-    + [`const instance = graphqlJsSchemaFetch([options])`](#const-instance-graphqljsschemafetch-options)
-    + [`someFunction(variable, callback)`](#somefunction-variable-callback)
-    + [`anotherFunction()`](#anotherfunction)
 - [License](http://github.com/Shopify/graphql-js-schema-fetch/blob/master/LICENSE.md)
 
 ## Installation
+
 ```bash
-$ npm install graphql-js-schema-fetch
+git clone [email protected]:Shopify/graphql-js-schema-fetch.git
+cd graphql-js-schema-fetch
+npm install
+npm link
 ```
 
 ## Examples
 
-#### Example 1
-
-Decribe Example 1. Stumptown selfies put a bird on it occupy, scenester ramps jean shorts next level kale chips seitan:
+To fetch the json representation of the graphql schema from a live server that
+implements the GraphQL (and optionally the Relay) spec, run:
 
-```javascript
-import graphqlJsSchemaFetch from 'graphql-js-schema-fetch';
-
-/********************************/
-/********************************/
-/* -- PUT AN EXAMPLE IN HERE -- */
-/********************************/
-/********************************/
+```bash
+graphql-js-schema-fetch --url https://www.my-server.com/api
 ```
 
-#### Example 2
+If your server requires additional credentials or headers, use the `--header`
+option:
 
-Decribe Example 1. Stumptown selfies put a bird on it occupy, scenester ramps jean shorts next level kale chips seitan:
+```bash
+graphql-js-schema-fetch --url https://www.my-server.com/api --header "Authorization: Basic abc123" --header "X-API-Version: 1.1"
+```
 
-```javascript
-import graphqlJsSchemaFetch from 'graphql-js-schema-fetch';
+If your server uses something other than the `POST` method for its API, use the
+`--method` option:
 
-/********************************/
-/********************************/
-/* -- PUT AN EXAMPLE IN HERE -- */
-/********************************/
-/********************************/
+```bash
+graphql-js-schema-fetch --url https://www.my-server.com/api --method GET
 ```
 
 ## API
 
-#### `const instance = graphqlJsSchemaFetch([options]);`
-
-Options you can pass `graphqlJsSchemaFetch`:
-- `option1` - Replace with a description of option 1
-- `option2` - Replace with a description of option 2
-- `option3` - Replace with a description of option 2
-
-#### `instance.someFunction(variable, callback);`
-
-Replace with `someFunction` description. Hoodie post-ironic polaroid salvia, microdosing vice ethical etsy bushwick roof party swag. Farm-to-table humblebrag etsy neutra synth.
-
-#### `instance.anotherFunction();`
+#### `const instance = graphqlJsSchemaFetch(url, method, [headers]);`
 
-Replace with `anotherFunction` description. Tacos polaroid cronut trust fund mumblecore biodiesel viral hella helvetica actually organic. Stumptown selfies put a bird on it occupy, scenester ramps jean shorts next level kale chips seitan.
+Params you can pass `graphqlJsSchemaFetch`:
+- `url` - The url where your GraphQL API resides
+- `method` - The HTTP method to use while making the request
+- `headers` - A hash representing the key value pairs of headers to pass to
+  `node-fetch`
 
 ## License
 

circle.yml

@@ -1,3 +1,3 @@
 machine:
   node:
-    version: v4.5.0
+    version: v6.7.0

package.json

@@ -0,0 +1,43 @@
+{
+  "name": "graphql-js-schema-fetch",
+  "version": "1.0.0",
+  "description": "A simple command line tool for fetching the JSON representation of the GraphQL schema from a live server",
+  "main": "lib/index.js",
+  "bin": "lib/cli.js",
+  "license": "MIT",
+  "author": "Shopify Inc.",
+  "dependencies": {
+    "graphql": "0.7.0",
+    "minimist": "1.2.0",
+    "node-fetch": "1.6.3"
+  },
+  "devDependencies": {
+    "babel": "6.5.2",
+    "babel-cli": "6.11.4",
+    "babel-core": "6.13.2",
+    "babel-plugin-add-shopify-header": "1.0.5",
+    "babel-preset-shopify": "13.0.0",
+    "babel-register": "6.11.6",
+    "eslint": "3.3.1",
+    "eslint-plugin-mocha": "4.5.1",
+    "eslint-plugin-shopify": "14.0.0",
+    "mocha": "3.0.2"
+  },
+  "scripts": {
+    "test": "npm run lint-allow-warning && mocha --compilers js:babel-register -u tdd test/index.js",
+    "prepublish": "babel -d lib/ src/",
+    "lint": "eslint --max-warnings 0 -c .eslintrc.json src/ test/",
+    "lint-allow-warning": "eslint -c .eslintrc.json src/ test/"
+  },
+  "keywords": [
+    "graphql,schema"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/Shopify/graphql-js-schema-fetch.git"
+  },
+  "homepage": "https://github.com/Shopify/graphql-js-schema-fetch",
+  "bugs": {
+    "url": "https://github.com/Shopify/graphql-js-schema-fetch/issues"
+  }
+}

src/cli.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+
+import parseArgs from './parse-args';
+import fetchSchema from './index';
+import help from './help';
+
+const args = parseArgs(process.argv.slice(2));
+
+if (args.showHelp) {
+  console.log(help);
+  process.exit(0);
+}
+
+fetchSchema(args.url, args.method, args.headers).then((schema) => {
+  console.log(JSON.stringify(schema));
+}).catch((error) => {
+  console.error(error);
+});

src/help.js

@@ -0,0 +1,12 @@
+export default `
+usage: graphql-js-schema-fetch --url my-api.com [--method=POST] [--header="...", --header="..."]
+
+Fetch the json representation of a GraphQL Schema from a live server.
+
+arguments:
+ --url               The URL where you GraphQL API resides.
+ --method            The HTTP method to use during the fetch (default: 'POST')
+ --header[,--header] Any headers to send along with the request. Specify this
+                     option multiple times for multiple headers. (example:
+                     --header "Authorization: Basic abc123" --header "X-Version: 1")
+`;

src/index.js

@@ -0,0 +1,14 @@
+import fetch from 'node-fetch';
+import {introspectionQuery} from 'graphql/utilities/introspectionQuery';
+
+export default function fetchSchema(url, method = 'POST', headers = {}) {
+  const body = `query=${introspectionQuery}`;
+
+  return fetch(url, {
+    method,
+    headers,
+    body
+  }).then((response) => {
+    return response.json();
+  });
+}

src/parse-args.js

@@ -0,0 +1,24 @@
+import minimist from 'minimist';
+
+export default function parseArgs(rawArgs) {
+  const args = minimist(rawArgs, {default: {method: 'POST'}});
+
+  if (args.help || !args.url) {
+    return {showHelp: true};
+  }
+
+  const url = args.url;
+  const method = args.method;
+  const headers = [].concat(args.header).reduce((headerAcc, header) => {
+    const pair = header.split(':');
+
+    headerAcc[pair[0].trim()] = pair[1].trim();
+
+    return headerAcc;
+  }, {
+    Accept: 'application/json',
+    'Content-Type': 'application/x-www-form-urlencoded'
+  });
+
+  return {url, method, headers};
+}

test/index.js

@@ -0,0 +1,42 @@
+import assert from 'assert';
+import parseArgs from '../src/parse-args';
+
+suite('This will test arg parsing', () => {
+  test('it indicates `showHelp` and skips all other args when the help flag is passed', () => {
+    const args = parseArgs(['--header', 'some-header: data', '--help', '--url', 'www.com']);
+
+    assert.deepEqual(args, {showHelp: true});
+  });
+
+  test('it indicates `showHelp` if required args aren\'t present', () => {
+    const args = parseArgs(['--header', 'Authorization: Basic abc123', '--method', 'post']);
+
+    assert.deepEqual(args, {showHelp: true});
+  });
+
+  test('it transforms single header args into a hash', () => {
+    const args = parseArgs(['--header', 'Authorization: Basic abc123', '--url', 'www.com']);
+
+    assert.equal(args.headers.Authorization, 'Basic abc123');
+  });
+
+  test('it transforms multi-header args into a hash', () => {
+    const args = parseArgs(['--header', 'Authorization: Basic abc123', '--header', 'X-API-Key: token123', '--url', 'www.com']);
+
+    assert.equal(args.headers.Authorization, 'Basic abc123');
+    assert.equal(args.headers['X-API-Key'], 'token123');
+  });
+
+  test('it supplies sane default headers', () => {
+    const args = parseArgs(['--header', 'Authorization: Basic abc123', '--header', 'X-API-Key: token123', '--url', 'www.com']);
+
+    assert.deepEqual(args.headers.Accept, 'application/json');
+    assert.deepEqual(args.headers['Content-Type'], 'application/x-www-form-urlencoded');
+  });
+
+  test('it cleans up arbitrary whitespace in headers', () => {
+    const args = parseArgs(['--header', '    Authorization:     Basic abc123     ', '--url', 'www.com']);
+
+    assert.equal(args.headers.Authorization, 'Basic abc123');
+  });
+});