Merge pull request #5 from PilotConway/feature/crud

PilotConway · web-flow · commit 413d791a4e4d · 2019-06-17T11:11:06.000-04:00
Added CI
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,22 @@
+module.exports = {
+  parser: 'babel-eslint',
+  env: {
+    browser: true,
+    es6: true,
+    jest: true,
+  },
+  extends: 'eslint:recommended',
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly',
+  },
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 2018,
+    sourceType: 'module',
+  },
+  plugins: ['react'],
+  rules: {},
+};
diff --git a/.github/main.workflow b/.github/main.workflow
@@ -4,5 +4,5 @@ workflow "Link on Push" {
 }
 
 action "eslint" {
-  uses = "gimenete/eslint-action@1.0"
+  uses = "stefanoeb/eslint-action@master"
 }
diff --git a/.prettierrc b/.prettierrc
@@ -1,5 +1,5 @@
 {
-  "printWidth": 80,
+  "printWidth": 100,
   "tabWidth": 2,
   "useTabs": false,
   "semi": true,
@@ -8,4 +8,4 @@
   "bracketSpacing": true,
   "jsxBracketSameLine": false,
   "fluid": false
-}
+}
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - '10'
+after_success:
+  - yarn codecov
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.com/PilotConway/rxjs-api-client-prototype.svg?branch=master)](https://travis-ci.com/PilotConway/rxjs-api-client-prototype) [![codecov](https://codecov.io/gh/PilotConway/rxjs-api-client-prototype/branch/master/graph/badge.svg)](https://codecov.io/gh/PilotConway/rxjs-api-client-prototype)
+
 # rxjs-api-client-prototype
 
 This is a prototype project to feel out ways I can use RxJS to replace the apps current server.js
@@ -24,7 +26,7 @@ import ClientProvider from 'src/ClientProvider';
 function Root() {
   const client = createClient('https://localhost:3000/api/v1');
   return (
-    <ClientProvider client={client}>
+    <ClientProvider value={client}>
       <App />
     </ClientProvider>
   );
@@ -42,6 +44,8 @@ the url as provided to make the call.
 </Request>
 ```
 
+By default, if you do not provide a client using the `ClientProvider` and use a realtive endpoint in `Request` or `useEndpointData` then a default client using `window.location.origin` as the base url will be used.
+
 ### Render Prop Method
 
 The `<Request>` component provides a render prop method of performing a GET Request to retrieve
@@ -71,7 +75,7 @@ import React from 'react';
 import useEndpointData from 'src/useEndpointData`;
 
 export default function MyComponent() {
-  const [ data, loading, error, links, client ] = useEndpointHooks('/users');
+  const [ data, loading, error, links, client ] = useEndpointHooks('/users', { params: { per_page: 5 }});
   return (
     ... your component jsx
   )
@@ -82,12 +86,51 @@ See [`useEndpointData`](#useEndpointData) for details on the hook parameters and
 
 ## API
 
-### `Client`
+### `client`
+
+This is base object that is used to make requests to the server. It is recommended that you do not create this object but instead use `createClient` to create a new client.
+
+Both `Request` and `useEndpointData` will also provide the client object so you can use it to make other requests to the server such as a put/post/delete.
+
+#### Functions
+
+The `client` object contains 4 functions that can be used to communicate with the server.
+
+- get
+- put
+- post
+- delete
+
+##### get()
+
+Performs a get request to the server.
 
 ### `createClient`
 
+This function creates a new client. It's preferred over using `client` itself as you can set the base URL and headers using `createClient` where with `client` you will have to pass full URLs to every request.
+
 ### `<ClientProvider>`
 
+The ClientProvider allows for a client to be set as the default client for all requests in the component tree below the provider. You can use [`createClient`](#createClient) to create a client with a specific base url then use relative endpoints in all `Request` or `useEndpointData` calls to get information from the server.
+
+In addition to being able to set the base url, you can also set headers and other information for every request to use.
+
+```js
+...
+import { createClient } from 'src/client';
+import ClientProvider from 'src/ClientProvider';
+...
+
+function Root() {
+  const client = createClient('https://localhost:3000/api/v1');
+  return (
+    <ClientProvider value={client}>
+      <App />
+    </ClientProvider>
+  );
+}
+```
+
 ### `useEndpointData`
 
 This is a hook to perform a GET request to retrieve data.
@@ -145,6 +188,8 @@ The render function is called with a single parameter object that has the follow
 
 ### Request Error
 
+TODO: define request error and ensure all errors follow this format.
+
 ### Pagination
 
 When an endpoint supports Pagination, the response will contain a link object. This is passed
diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,32 @@
+codecov:
+  notify:
+    require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: '50...90'
+  status:
+    patch: off
+    project:
+      default:
+        target: auto
+        threshold: null
+        base: pr
+ignore:
+  - '**/*.spec.*'
+  - '**/*.stories.*'
+  - 'src/components/**/*'
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: 'header, diff'
+  behavior: default
+  require_changes: no
diff --git a/package.json b/package.json
@@ -15,6 +15,7 @@
     "rxjs": "6.5.2"
   },
   "devDependencies": {
+    "codecov": "^3.5.0",
     "typescript": "3.3.3"
   },
   "scripts": {
diff --git a/src/client/client.spec.js b/src/client/client.spec.js
@@ -1,4 +1,6 @@
 import client from './client';
+// Require get request import for mocks to work
+// eslint-disable-next-line no-unused-vars
 import getRequest from './getRequest';
 
 // SEE __mocks__/getRequest for which endpoint paths result in what types of
diff --git a/src/client/createClient.spec.js b/src/client/createClient.spec.js
@@ -1,4 +1,6 @@
 import createClient from './createClient';
+// Require get request import for mocks to work
+// eslint-disable-next-line no-unused-vars
 import getRequest from './getRequest';
 
 // SEE __mocks__/getRequest for which endpoint paths result in what types of
diff --git a/src/client/getRequest.js b/src/client/getRequest.js
@@ -8,12 +8,9 @@ const getRequest = path =>
       if (response === null) {
         return throwError('API Timed out', response);
       }
-      console.log('api response: ', response);
       return response;
     }),
     catchError(error => {
-      console.log(error);
-      console.error('api error: ', error.response);
       return of(error);
     }),
   );
diff --git a/src/index.jsx b/src/index.jsx
diff --git a/yarn.lock b/yarn.lock
@@ -1644,6 +1644,13 @@ address@^1.0.1:
   resolved "https://registry.yarnpkg.com/address/-/address-1.1.0.tgz#ef8e047847fcd2c5b6f50c16965f924fd99fe709"
   integrity sha512-4diPfzWbLEIElVG4AnqP+00SULlPzNuyJFNnmMrLgyaxG6tZXJ1sn7mjBu4fHrJE+Yp/jgylOweJn2xsLMFggQ==
 
+agent-base@^4.1.0:
+  version "4.3.0"
+  resolved "https://registry.yarnpkg.com/agent-base/-/agent-base-4.3.0.tgz#8165f01c436009bccad0b1d122f05ed770efc6ee"
+  integrity sha512-salcGninV0nPrwpGNn4VTXBb1SOuXQBiqbrNXoeizJsHrsL6ERFM2Ne3JUSBWRE6aeNJI2ROP/WEEIDUiDe3cg==
+  dependencies:
+    es6-promisify "^5.0.0"
+
 ajv-errors@^1.0.0:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/ajv-errors/-/ajv-errors-1.0.1.tgz#f35986aceb91afadec4102fbd85014950cefa64d"
@@ -1739,6 +1746,11 @@ argparse@^1.0.7:
   dependencies:
     sprintf-js "~1.0.2"
 
+argv@^0.0.2:
+  version "0.0.2"
+  resolved "https://registry.yarnpkg.com/argv/-/argv-0.0.2.tgz#ecbd16f8949b157183711b1bda334f37840185ab"
+  integrity sha1-7L0W+JSbFXGDcRsb2jNPN4QBhas=
+
 aria-query@^3.0.0:
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/aria-query/-/aria-query-3.0.0.tgz#65b3fcc1ca1155a8c9ae64d6eee297f15d5133cc"
@@ -2605,6 +2617,17 @@ code-point-at@^1.0.0:
   resolved "https://registry.yarnpkg.com/code-point-at/-/code-point-at-1.1.0.tgz#0d070b4d043a5bea33a2f1a40e2edb3d9a4ccf77"
   integrity sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=
 
+codecov@^3.5.0:
+  version "3.5.0"
+  resolved "https://registry.yarnpkg.com/codecov/-/codecov-3.5.0.tgz#3d0748932f9cb41e1ad7f21fa346ef1b2b1bed47"
+  integrity sha512-/OsWOfIHaQIr7aeZ4pY0UC1PZT6kimoKFOFYFNb6wxo3iw12nRrh+mNGH72rnXxNsq6SGfesVPizm/6Q3XqcFQ==
+  dependencies:
+    argv "^0.0.2"
+    ignore-walk "^3.0.1"
+    js-yaml "^3.13.1"
+    teeny-request "^3.11.3"
+    urlgrey "^0.4.4"
+
 collection-visit@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/collection-visit/-/collection-visit-1.0.0.tgz#4bc0373c164bc3291b4d368c829cf1a80a59dca0"
@@ -3178,7 +3201,7 @@ debug@2.6.9, debug@^2.2.0, debug@^2.3.3, debug@^2.6.0, debug@^2.6.8, debug@^2.6.
   dependencies:
     ms "2.0.0"
 
-debug@^3.2.5, debug@^3.2.6:
+debug@^3.1.0, debug@^3.2.5, debug@^3.2.6:
   version "3.2.6"
   resolved "https://registry.yarnpkg.com/debug/-/debug-3.2.6.tgz#e83d17de16d8a7efb7717edbe5fb10135eee629b"
   integrity sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ==
@@ -3589,6 +3612,18 @@ es-to-primitive@^1.2.0:
     is-date-object "^1.0.1"
     is-symbol "^1.0.2"
 
+es6-promise@^4.0.3:
+  version "4.2.8"
+  resolved "https://registry.yarnpkg.com/es6-promise/-/es6-promise-4.2.8.tgz#4eb21594c972bc40553d276e510539143db53e0a"
+  integrity sha512-HJDGx5daxeIvxdBxvG2cb9g4tEvwIk3i8+nhX0yGrYmZUzbkdg8QbDevheDB8gd0//uPj4c1EQua8Q+MViT0/w==
+
+es6-promisify@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/es6-promisify/-/es6-promisify-5.0.0.tgz#5109d62f3e56ea967c4b63505aef08291c8a5203"
+  integrity sha1-UQnWLz5W6pZ8S2NQWu8IKRyKUgM=
+  dependencies:
+    es6-promise "^4.0.3"
+
 escape-html@~1.0.3:
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/escape-html/-/escape-html-1.0.3.tgz#0258eae4d3d0c0974de1c169188ef0051d1d1988"
@@ -4731,6 +4766,14 @@ https-browserify@^1.0.0:
   resolved "https://registry.yarnpkg.com/https-browserify/-/https-browserify-1.0.0.tgz#ec06c10e0a34c0f2faf199f7fd7fc78fffd03c73"
   integrity sha1-7AbBDgo0wPL68Zn3/X/Hj//QPHM=
 
+https-proxy-agent@^2.2.1:
+  version "2.2.1"
+  resolved "https://registry.yarnpkg.com/https-proxy-agent/-/https-proxy-agent-2.2.1.tgz#51552970fa04d723e04c56d04178c3f92592bbc0"
+  integrity sha512-HPCTS1LW51bcyMYbxUIOO4HEOlQ1/1qRaFWcyxvwaqUS9TY88aoEuHUY33kuAh1YhVVaDQhLZsnPd+XNARWZlQ==
+  dependencies:
+    agent-base "^4.1.0"
+    debug "^3.1.0"
+
 hyphenate-style-name@^1.0.3:
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/hyphenate-style-name/-/hyphenate-style-name-1.0.3.tgz#097bb7fa0b8f1a9cf0bd5c734cf95899981a9b48"
@@ -6514,6 +6557,11 @@ no-case@^2.2.0:
   dependencies:
     lower-case "^1.1.1"
 
+node-fetch@^2.2.0:
+  version "2.6.0"
+  resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.0.tgz#e633456386d4aa55863f676a7ab0daa8fdecb0fd"
+  integrity sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==
+
 node-forge@0.7.5:
   version "0.7.5"
   resolved "https://registry.yarnpkg.com/node-forge/-/node-forge-0.7.5.tgz#6c152c345ce11c52f465c2abd957e8639cd674df"
@@ -9307,6 +9355,15 @@ tar@^4:
     safe-buffer "^5.1.2"
     yallist "^3.0.3"
 
+teeny-request@^3.11.3:
+  version "3.11.3"
+  resolved "https://registry.yarnpkg.com/teeny-request/-/teeny-request-3.11.3.tgz#335c629f7645e5d6599362df2f3230c4cbc23a55"
+  integrity sha512-CKncqSF7sH6p4rzCgkb/z/Pcos5efl0DmolzvlqRQUNcpRIruOhY9+T1FsIlyEbfWd7MsFpodROOwHYh2BaXzw==
+  dependencies:
+    https-proxy-agent "^2.2.1"
+    node-fetch "^2.2.0"
+    uuid "^3.3.2"
+
 terser-webpack-plugin@1.2.3:
   version "1.2.3"
   resolved "https://registry.yarnpkg.com/terser-webpack-plugin/-/terser-webpack-plugin-1.2.3.tgz#3f98bc902fac3e5d0de730869f50668561262ec8"
@@ -9723,6 +9780,11 @@ url@^0.11.0:
     punycode "1.3.2"
     querystring "0.2.0"
 
+urlgrey@^0.4.4:
+  version "0.4.4"
+  resolved "https://registry.yarnpkg.com/urlgrey/-/urlgrey-0.4.4.tgz#892fe95960805e85519f1cd4389f2cb4cbb7652f"
+  integrity sha1-iS/pWWCAXoVRnxzUOJ8stMu3ZS8=
+
 use@^3.1.0:
   version "3.1.1"
   resolved "https://registry.yarnpkg.com/use/-/use-3.1.1.tgz#d50c8cac79a19fbc20f2911f56eb973f4e10070f"

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,5 @@ workflow "Link on Push" {`
`4`	`4`	`}`
`5`	`5`
`6`	`6`	`action "eslint" {`
`7`		`- uses = "gimenete/eslint-action@1.0"`
	`7`	`+ uses = "stefanoeb/eslint-action@master"`
`8`	`8`	`}`