Feature/resource builder

.babelrc

@@ -0,0 +1,10 @@
+{
+  "presets": [
+    "env",
+    "flow"
+  ],
+  "plugins": [
+    "transform-runtime",
+    "transform-object-rest-spread"
+  ]
+}

.circleci/config.yml

@@ -0,0 +1,41 @@
+# Javascript Node CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-javascript/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      - image: circleci/node:7.10
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/mongo:3.4.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "package.json" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run: yarn install
+
+      - save_cache:
+          paths:
+            - node_modules
+          key: v1-dependencies-{{ checksum "package.json" }}
+
+      # run tests!
+      - run:
+          name: Jest Suite
+          command: yarn jest tests --ci --testResultsProcessor="jest-junit"
+          environment:
+            JEST_JUNIT_OUTPUT: "reports/junit/js-test-results.xml"

.eslintrc

@@ -1,3 +1,8 @@
 {
-  "extends": "airbnb-base"
+  "parser": "babel-eslint",
+  "extends": "airbnb-base",
+  "env": {
+    "browser": true,
+    "jest": true
+  }
 }

.flowconfig

@@ -0,0 +1,11 @@
+[ignore]
+
+[include]
+
+[libs]
+
+[lints]
+
+[options]
+
+[strict]

README.md

@@ -0,0 +1,17 @@
+# Jsonapi Orchestrator
+
+Building better jsonapi-compliant code
+
+[![BCH compliance](https://bettercodehub.com/edge/badge/MyJobGlasses/jsonapi-orchestrator?branch=master)](https://bettercodehub.com/)
+
+[![CircleCI](https://circleci.com/gh/MyJobGlasses/jsonapi-orchestrator.svg?style=svg)](https://circleci.com/gh/MyJobGlasses/jsonapi-orchestrator)
+
+# HOW TO
+
+[See examples in the /examples folder](./examples/)
+
+# TODO
+[draft]
+- think to add fetch polyfill
+
+

package.json

@@ -4,7 +4,7 @@
   "description": "Jsonapi powered framework to harness the power of jsonapi with redux",
   "main": "src/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "jest --notify --watch"
   },
   "repository": {
     "type": "git",
@@ -21,12 +21,27 @@
   },
   "homepage": "https://github.com/MyJobGlasses/jsonapi-orchestrator#readme",
   "dependencies": {
+    "json-api-normalizer": "^0.4.10",
+    "lodash": "^4.17.10",
     "redux": "^3.7.2",
-    "redux-saga": "^0.16.0"
+    "redux-saga": "^0.16.0",
+    "uuid": "^3.2.1"
   },
   "devDependencies": {
+    "babel-core": "^6.26.3",
+    "babel-eslint": "^8.2.3",
+    "babel-jest": "^22.4.3",
+    "babel-plugin-transform-object-rest-spread": "^6.26.0",
+    "babel-plugin-transform-runtime": "^6.23.0",
+    "babel-preset-env": "^1.6.1",
+    "babel-preset-flow": "^6.23.0",
     "eslint": "^4.19.1",
     "eslint-config-airbnb-base": "^12.1.0",
-    "eslint-plugin-import": "^2.9.0"
+    "eslint-plugin-import": "^2.11.0",
+    "flow-bin": "^0.71.0",
+    "jest": "^22.4.3",
+    "jest-junit": "^4.0.0",
+    "redux-saga-test-plan": "^3.6.0",
+    "regenerator-runtime": "^0.11.1"
   }
 }

src/JsonApiConnector.js

@@ -0,0 +1,24 @@
+let mainConnector = null;
+
+/**
+ * @todo handle if we want to overwrite mainConnector
+ */
+export default class JsonApiConnector {
+  constructor(params) {
+    this.url = params.url;
+    mainConnector = mainConnector || this;
+  }
+
+  static connector() {
+    if (!mainConnector) {
+      return new JsonApiConnector();
+    }
+    return mainConnector;
+  }
+
+  buildEndpoint(path) {
+    return `${this.url}/${path}`;
+  }
+}
+
+export const getMainConnector = JsonApiConnector.connector;

src/__tests__/builders/JsonapiRequestBuilder.test.js

@@ -0,0 +1,116 @@
+import JsonapiRequestBuilder from '../../builders/JsonapiRequestBuilder';
+import JsonapiResourceReader from '../../builders/JsonapiResourceReader';
+import JsonapiResourceWriter from '../../builders/JsonapiResourceWriter';
+
+describe('JsonapiRequestBuilder', () => {
+  let requestBuilder;
+  let resource;
+
+  describe('constructor', () => {
+    test('can assign requestBuilder variables during instanciation', () => {
+      resource = new JsonapiResourceReader();
+      const requestBuilderArguments = {
+        path: '/foo/bar',
+        httpMethod: 'OPTIONS',
+        resource,
+        params: { id: '42' },
+      };
+      requestBuilder = new JsonapiRequestBuilder(requestBuilderArguments);
+      expect(requestBuilder.path).toEqual('/foo/bar');
+      expect(requestBuilder.httpMethod).toEqual('OPTIONS');
+      expect(requestBuilder.resource).toEqual(resource);
+      expect(requestBuilder.params).toEqual(expect.objectContaining({ id: '42' }));
+    });
+  });
+
+  describe('instance methods', () => {
+    describe('#addMeta', () => {
+      beforeEach( () => {
+        requestBuilder = new JsonapiRequestBuilder({});
+      });
+
+      test('merges new meta', () => {
+        requestBuilder.addMeta({ invitationToken: '42' });
+        requestBuilder.addMeta({ token: 'deadbeef' });
+
+        expect(requestBuilder.meta).toMatchObject({
+          invitationToken: '42',
+          token: 'deadbeef',
+        });
+      });
+    });
+
+    describe('#action', () => {
+      describe('building a read request', () => {
+        beforeEach(() => {
+          resource = new JsonapiResourceReader({
+            jsonapiType: 'conversation', params: { id: 'cafebabe' },
+          });
+          requestBuilder = new JsonapiRequestBuilder({
+            resource, method: 'OPTIONS', path: '/conversations',
+          });
+        });
+
+        test('returns a correct read action', () => {
+          expect(requestBuilder.action()).toMatchObject({
+            type: 'READ_CONVERSATION_RESOURCE',
+            // params: { id: 'cafebabe' },
+            meta: {},
+          });
+        });
+      });
+
+      describe('building a write request', () => {
+        beforeEach(() => {
+          const conversationResource = new JsonapiResourceWriter({
+            jsonapiType: 'conversation',
+            params: { userid: 'cafebabe' },
+            attributes: {
+              recipient: 'deadbeef',
+            },
+          });
+          const messageResource = new JsonapiResourceWriter({
+            jsonapiType: 'message',
+            attributes: {
+              text: 'Hello world !',
+              clientId: '0ff1ce',
+            },
+          });
+          conversationResource.sidepost('messages', [messageResource]);
+          requestBuilder = new JsonapiRequestBuilder({
+            resource: conversationResource, path: '/conversations',
+          });
+        });
+
+        test('returns a correct write action', () => {
+          expect(requestBuilder.action()).toMatchObject({
+            type: 'CREATE_CONVERSATION_RESOURCE',
+            params: { userid: 'cafebabe' },
+            data: {
+              type: 'conversation',
+              attributes: { recipient: 'deadbeef' },
+              relationships: {
+                messages: {
+                  data: [{
+                    type: 'message',
+                    method: 'create',
+                    'temp-id': expect.any(String),
+                  }],
+                },
+              },
+            },
+            included: [{
+              type: 'message',
+              'temp-id': expect.any(String),
+              attributes: {
+                text: 'Hello world !',
+                clientId: '0ff1ce',
+              },
+            }],
+          });
+        });
+      });
+    });
+  });
+});
+