Rename model methods and export aliases for easier usage. Add documentation

Author: javierbrea

README.md

@@ -5,21 +5,64 @@
 [![NPM downloads][npm-downloads-image]][npm-downloads-url] [![License][license-image]][license-url]
 
 
-# Mocks-server administration API client.
+# Mocks-server administration api client
 
-This package contains methods for administrating the mocks-server (using the plugin-admin-api RESTful API).
+This package contains methods for administrating the mocks-server _(through the [@mocks-server/plugin-admin-api](https://github.com/mocks-server/plugin-admin-api) RESTful API)_.
 
-It can be used both from Browsers or from Node.js.
+Built using [@data-provider](https://github.com/data-provider), it can be used in Node.js, browsers, and is also compatible with @data-provider connectors, such as [@data-provider/connector-react](https://github.com/data-provider/connector-react), so can be easily integrated with frameworks.
 
-## Usage
+## Usage with promises
+
+All methods described in the [Api](#api) (expect the `config` method) return Promises when executed:
 
 ```js
-import { setBaseUrl, changeDelay } from "@mocks-server/admin-api-client";
+import { about, settings } from "@mocks-server/admin-api-client";
+
+const example = async () => {
+  const { version } = await about.read();
+  console.log(`Current plugin-admin-api version is ${version}`);
+
+  const currentSettings = await settings.read();
+  console.log("Current mocks-server settings are", currentSettings);
+
+  await settings.update({
+    behavior: "user-super-admin",
+    delay: 1000
+  });
+  console.log("Behavior and delay changed");
+};
+
+example();
+```
+
+## Usage with data-provider
 
-setBaseUrl("http://localhost:3100");
+Exported properties `about`, `settings`, `behaviors`, `behaviorsModel`, `fixtures` and `fixturesModel` are [@data-provider/axios](https://github.com/data-provider/axios) providers, so can be used to define @data-provider Selectors. Methods can also be connected to frameworks using @data-provider connectors, such as [@data-provider/connector-react](https://github.com/data-provider/connector-react).
+
+## Api
+
+* `about.read()` - Returns info about mocks-server/plugin-admin-api, such as current version.
+* `settings.read()` - Returns current @mocks-server settings.
+* `settings.update(settingsObject)` - Updates @mocks-server settings. A settings object has to be provided. Read the [@mocks-server configuration documentation](https://www.mocks-server.org/docs/configuration-options) for further info.
+* `behaviors.read()` - Returns collection of available behaviors.
+* `behavior(behaviorName).read()` - Returns an specific behavior.
+* `behaviorsModel.byName(behaviorName).read()` - Returns an specific behavior.
+* `fixtures.read()` - Returns collection of available fixtures.
+* `fixture(fixtureId).read()` - Returns an specific fixture.
+* `fixturesModel.byId(fixtureId).read()` - Returns an specific fixture.
+
+## Configuration
+
+By default, the client is configured to request to http://localhost:3100/admin, based in the [default options of @mocks-server](https://www.mocks-server.org/docs/configuration-options)
+
+You can change both the base url of the "@mocks-server", and the base api path of the "@mocks-server/plugin-admin-api" using the `config` method:
+
+```js
+import { config } from "@mocks-server/admin-api-client";
 
-changeDelay(1000).then(() => {
-  console.log("Delay setting changed!");
+config({
+  apiPath: "/foo-admin",
+  baseUrl: "http://my-mocks-server:3000"
 });
 ```
 

index.js

@@ -1,4 +1,2 @@
-import configuration from "./src/config";
+export * from "./src/config";
 export * from "./src/providers";
-
-export const config = configuration;

src/config.js

@@ -1,12 +1,13 @@
 import { instances } from "@data-provider/core";
+import { DEFAULT_BASE_PATH } from "@mocks-server/admin-api-paths";
 import TAG from "./tag";
 
 const DEFAULT_OPTIONS = {
-  apiPath: "/admin",
+  apiPath: DEFAULT_BASE_PATH,
   baseUrl: "http://localhost:3100"
 };
 
-const config = options => {
+export const config = options => {
   const finalOptions = {
     ...DEFAULT_OPTIONS,
     ...options
@@ -18,5 +19,3 @@ const config = options => {
 };
 
 config();
-
-export default config;

src/providers.js

@@ -16,9 +16,9 @@ export const settings = new Api(SETTINGS, {
   tags: [TAG]
 });
 
-export const behaviorsCollection = new Api(BEHAVIORS, {
+export const behaviors = new Api(BEHAVIORS, {
   defaultValue: [],
-  uuid: "behaviors-collection",
+  uuid: "behaviors",
   tags: [TAG]
 });
 
@@ -29,16 +29,20 @@ export const behaviorsModel = new Api(`${BEHAVIORS}/:name`, {
 });
 
 behaviorsModel.addCustomQuery({
-  findByName: name => ({
+  byName: name => ({
     urlParams: {
       name
     }
   })
 });
 
-export const fixturesCollection = new Api(FIXTURES, {
+export const behavior = name => {
+  return behaviorsModel.byName(name);
+};
+
+export const fixtures = new Api(FIXTURES, {
   defaultValue: [],
-  uuid: "fixtures-collection",
+  uuid: "fixtures",
   tags: [TAG]
 });
 
@@ -49,9 +53,13 @@ export const fixturesModel = new Api(`${FIXTURES}/:id`, {
 });
 
 fixturesModel.addCustomQuery({
-  findById: id => ({
+  byId: id => ({
     urlParams: {
       id
     }
   })
 });
+
+export const fixture = id => {
+  return fixturesModel.byId(id);
+};

test-e2e/browser/react-app/src/modules/behaviors/BehaviorsController.js

@@ -1,10 +1,10 @@
 import { connect } from "@data-provider/connector-react";
-import { behaviorsCollection } from "mocks-server-admin-api-client";
+import { behaviors } from "mocks-server-admin-api-client";
 
 import BehaviorsView from "./BehaviorsView";
 
 const BehaviorsController = connect(() => ({
-  behaviors: behaviorsCollection.read.getters.value
+  behaviors: behaviors.read.getters.value
 }))(BehaviorsView);
 
 export default BehaviorsController;

test-e2e/browser/react-app/src/modules/current-behavior/CurrentBehaviorController.js

@@ -9,7 +9,7 @@ const currentBehavior = new Selector(
   {
     provider: behaviorsModel,
     query: (query, prevResults) => {
-      return behaviorsModel.customQueries.findByName(prevResults[0].behavior);
+      return behaviorsModel.customQueries.byName(prevResults[0].behavior);
     }
   },
   (settingsResults, behaviorResult) => {
@@ -25,7 +25,7 @@ const currentFixture = new Selector(
   {
     provider: fixturesModel,
     query: (query, prevResults) => {
-      return fixturesModel.customQueries.findById(
+      return fixturesModel.customQueries.byId(
         prevResults[0].fixtures[prevResults[0].fixtures.length - 1]
       );
     }

test-e2e/browser/react-app/src/modules/fixtures/FixturesController.js

@@ -1,10 +1,10 @@
 import { connect } from "@data-provider/connector-react";
-import { fixturesCollection } from "mocks-server-admin-api-client";
+import { fixtures } from "mocks-server-admin-api-client";
 
 import FixturesView from "./FixturesView";
 
 const FixturesController = connect(() => ({
-  fixtures: fixturesCollection.read.getters.value
+  fixtures: fixtures.read.getters.value
 }))(FixturesView);
 
 export default FixturesController;

test-e2e/browser/vanilla-app/public/main.js

@@ -76,7 +76,7 @@ var loadSettings = function() {
 };
 
 var loadBehaviors = function() {
-  return adminApiClient.behaviorsCollection.read().then(function(behaviorsCollection) {
+  return adminApiClient.behaviors.read().then(function(behaviorsCollection) {
     $behaviorsContainer.empty();
     behaviorsCollection.forEach(function(behavior) {
       $behaviorsContainer.append(
@@ -89,7 +89,7 @@ var loadBehaviors = function() {
 };
 
 var loadFixtures = function() {
-  return adminApiClient.fixturesCollection.read().then(function(fixturesCollection) {
+  return adminApiClient.fixtures.read().then(function(fixturesCollection) {
     $fixturesContainer.empty();
     fixturesCollection.forEach(function(fixture) {
       $fixturesContainer.append(

test-e2e/nodejs/es6/index.js

@@ -1,9 +1,9 @@
 const {
   about,
-  behaviorsCollection,
-  behaviorsModel,
-  fixturesCollection,
-  fixturesModel,
+  behaviors,
+  behavior,
+  fixtures,
+  fixture,
   settings
 } = require("../../../dist/index.cjs");
 
@@ -12,19 +12,19 @@ const readAbout = () => {
 };
 
 const readBehaviors = () => {
-  return behaviorsCollection.read();
+  return behaviors.read();
 };
 
 const readBehavior = name => {
-  return behaviorsModel.findByName(name).read();
+  return behavior(name).read();
 };
 
 const readFixtures = () => {
-  return fixturesCollection.read();
+  return fixtures.read();
 };
 
 const readFixture = id => {
-  return fixturesModel.findById(id).read();
+  return fixture(id).read();
 };
 
 const readSettings = () => {

test/src/config.spec.js

@@ -1,7 +1,8 @@
 import sinon from "sinon";
 import { instances } from "@data-provider/core";
+import { DEFAULT_BASE_PATH } from "@mocks-server/admin-api-paths";
 
-import config from "../../src/config";
+import { config } from "../../src/config";
 import TAG from "../../src/tag";
 
 describe("config method", () => {
@@ -22,7 +23,9 @@ describe("config method", () => {
     config({
       baseUrl: BASE_URL
     });
-    expect(instances.getByTag(TAG).config.getCall(0).args[0].baseUrl).toEqual(`${BASE_URL}/admin`);
+    expect(instances.getByTag(TAG).config.getCall(0).args[0].baseUrl).toEqual(
+      `${BASE_URL}${DEFAULT_BASE_PATH}`
+    );
   });
 
   it("should set apiPath in admin-api-client tagged providers", () => {