From bdbf1e5fed5f4547ce5c6876add9d48fc4f0fef9 Mon Sep 17 00:00:00 2001 From: Justin Dalrymple Date: Sat, 17 Mar 2018 00:04:21 -0400 Subject: [PATCH] Updated docs and fixed templates --- README.md | 10 +- package-lock.json | 20 +-- package.json | 4 +- src/index.js | 172 ++++++++++++------------ src/services/GroupAccessRequests.js | 4 +- src/services/GroupCustomAttributes.js | 4 +- src/services/GroupMembers.js | 4 +- src/services/GroupMilestones.js | 4 +- src/services/GroupVariables.js | 4 +- src/services/MergeRequestNotes.js | 4 +- src/services/ProjectAccessRequests.js | 4 +- src/services/ProjectCustomAttributes.js | 4 +- src/services/ProjectMembers.js | 4 +- src/services/ProjectMilestones.js | 4 +- src/services/ProjectSnippets.js | 4 +- src/services/ProjectVariables.js | 4 +- src/services/UserCustomAttributes.js | 4 +- 17 files changed, 127 insertions(+), 131 deletions(-) diff --git a/README.md b/README.md index 27cbd0a0..f397ce4d 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,9 @@ URL to your GitLab instance should not include `/api/v4` path. Instantiate the library using a basic token created in your [Gitlab Profile](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html) ```javascript -const GitlabAPI = require('node-gitlab-api')({ +import GitlabAPI from 'node-gitlab-api'; + +const API = GitlabAPI({ url: 'http://example.com', // Defaults to http://gitlab.com token: 'abcdefghij123456' //Can be created in your profile. }) @@ -47,7 +49,9 @@ const GitlabAPI = require('node-gitlab-api')({ Or, use a OAuth token instead! ```javascript -const GitlabAPI = require('node-gitlab-api')({ +import GitlabAPI from 'node-gitlab-api'; + +const API = GitlabAPI({ url: 'http://example.com', // Defaults to http://gitlab.com oauthToken: 'abcdefghij123456' }) @@ -56,7 +60,7 @@ const GitlabAPI = require('node-gitlab-api')({ The same parameters as above, but the require url inclues a `/dist/es5`: ```javascript -const GitlabAPI = require('node-gitlab-api/dist/es5')({ +const GitlabAPI = require('node-gitlab-api/dist/es5').default({ ... }) ``` diff --git a/package-lock.json b/package-lock.json index bf9ceb53..cf790ce7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -356,15 +356,6 @@ "@babel/plugin-syntax-export-default-from": "7.0.0-beta.42" } }, - "@babel/plugin-proposal-export-namespace": { - "version": "7.0.0-beta.32", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-export-namespace/-/plugin-proposal-export-namespace-7.0.0-beta.32.tgz", - "integrity": "sha512-vSnkdadqxvkOtNgoY8lo3cpXkBkRBLS6Z/2IoHZRplp1e/V6a/wGRBwwJGEQoi24WDIMwzlOl6V0I7q/MTo9jA==", - "dev": true, - "requires": { - "@babel/plugin-syntax-export-extensions": "7.0.0-beta.32" - } - }, "@babel/plugin-proposal-export-namespace-from": { "version": "7.0.0-beta.42", "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-export-namespace-from/-/plugin-proposal-export-namespace-from-7.0.0-beta.42.tgz", @@ -461,12 +452,6 @@ "@babel/helper-plugin-utils": "7.0.0-beta.42" } }, - "@babel/plugin-syntax-export-extensions": { - "version": "7.0.0-beta.32", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-export-extensions/-/plugin-syntax-export-extensions-7.0.0-beta.32.tgz", - "integrity": "sha512-rPCgRGdA2nUGRGsDlfII8g665+ECp0IpKtjRtpBJB7GMBG+WpAbWVM6P4h40IsEe9wv38jl0Nuv3lVVvKTi/Mw==", - "dev": true - }, "@babel/plugin-syntax-export-namespace-from": { "version": "7.0.0-beta.42", "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-export-namespace-from/-/plugin-syntax-export-namespace-from-7.0.0-beta.42.tgz", @@ -3129,6 +3114,11 @@ "sshpk": "1.14.1" } }, + "humps": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/humps/-/humps-2.0.1.tgz", + "integrity": "sha1-3QLqYIG9BWjcXQcxhEY5V7qe+ao=" + }, "iconv-lite": { "version": "0.4.19", "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.19.tgz", diff --git a/package.json b/package.json index 061c5b03..c5808da4 100644 --- a/package.json +++ b/package.json @@ -7,9 +7,10 @@ "node": ">=8.9.0" }, "scripts": { + "build:clean": "rimraf -rf dist && mkdirp -p dist", "build:es6": "babel src -d dist/latest", "build:es5": "babel src -d dist/es5 --no-babelrc --presets=@babel/env --plugins=@babel/plugin-proposal-export-default-from,@babel/plugin-proposal-export-namespace-from", - "build": "npm run build:es6 && npm run build:es5", + "build": "npm run build:clean && npm run build:es6 && npm run build:es5", "prepublishOnly": "npm run build" }, "repository": { @@ -40,6 +41,7 @@ "eslint-plugin-react": "^7.7.0" }, "dependencies": { + "humps": "^2.0.1", "parse-link-header": "^1.0.1", "request": "^2.85.0", "request-promise": "^4.2.2", diff --git a/src/index.js b/src/index.js index 76b5e50d..c29cb635 100644 --- a/src/index.js +++ b/src/index.js @@ -1,8 +1,8 @@ -import * as Services from './services'; +import * as APIServices from './services'; import { init } from './infrastructure/Namespace'; // All not initialized -// export * from './services'; +export * from './services'; // Groups const { @@ -13,93 +13,93 @@ const { GroupMilestones, GroupProjects, GroupVariables, -} = Services; +} = APIServices; -// export const GroupNamespace = options => init(options, { -// Groups, -// GroupAccessRequests, -// GroupCustomAttributes, -// GroupMembers, -// GroupMilestones, -// GroupProjects, -// GroupVariables, -// }); +export const GroupNamespace = options => init(options, { + Groups, + GroupAccessRequests, + GroupCustomAttributes, + GroupMembers, + GroupMilestones, + GroupProjects, + GroupVariables, +}); -// // Users -// const { -// Users, -// UserEmails, -// UserImpersonationTokens, -// UserKeys, -// UserGPGKeys, -// } = Services; +// Users +const { + Users, + UserEmails, + UserImpersonationTokens, + UserKeys, + UserGPGKeys, +} = APIServices; -// export const UserNamespace = options => init(options, { -// Users, -// UserEmails, -// UserImpersonationTokens, -// UserKeys, -// UserGPGKeys, -// }); +export const UserNamespace = options => init(options, { + Users, + UserEmails, + UserImpersonationTokens, + UserKeys, + UserGPGKeys, +}); -// // // Projects -// const { -// Branches, -// Commits, -// DeployKeys, -// Environments, -// Issues, -// Jobs, -// Labels, -// MergeRequests, -// MergeRequestNotes, -// MergeRequestVersions, -// Pipelines, -// Projects, -// ProjectAccessRequests, -// ProjectCustomAttributes, -// ProjectHooks, -// ProjectMembers, -// ProjectMilestones, -// ProjectSnippets, -// ProtectedBranches, -// ProjectVariables, -// Repositories, -// RepositoryFiles, -// Runners, -// Services, -// Tags, -// Triggers, -// } = Services; +// Projects +const { + Branches, + Commits, + DeployKeys, + Environments, + Issues, + Jobs, + Labels, + MergeRequests, + MergeRequestNotes, + MergeRequestVersions, + Pipelines, + Projects, + ProjectAccessRequests, + ProjectCustomAttributes, + ProjectHooks, + ProjectMembers, + ProjectMilestones, + ProjectSnippets, + ProtectedBranches, + ProjectVariables, + Repositories, + RepositoryFiles, + Runners, + Services, + Tags, + Triggers, +} = APIServices; -// export const ProjectNamespace = options => init(options, { -// Branches, -// Commits, -// DeployKeys, -// Environments, -// Issues, -// Jobs, -// Labels, -// MergeRequests, -// MergeRequestNotes, -// MergeRequestVersions, -// Pipelines, -// Projects, -// ProjectAccessRequests, -// ProjectCustomAttributes, -// ProjectHooks, -// ProjectMembers, -// ProjectMilestones, -// ProjectSnippets, -// ProtectedBranches, -// ProjectVariables, -// Repositories, -// RepositoryFiles, -// Runners, -// Services, -// Tags, -// Triggers, -// }); +export const ProjectNamespace = options => init(options, { + Branches, + Commits, + DeployKeys, + Environments, + Issues, + Jobs, + Labels, + MergeRequests, + MergeRequestNotes, + MergeRequestVersions, + Pipelines, + Projects, + ProjectAccessRequests, + ProjectCustomAttributes, + ProjectHooks, + ProjectMembers, + ProjectMilestones, + ProjectSnippets, + ProtectedBranches, + ProjectVariables, + Repositories, + RepositoryFiles, + Runners, + Services, + Tags, + Triggers, +}); -// // All initialized -// export default options => init(options, Services); +// All initialized +export default options => init(options, Services); diff --git a/src/services/GroupAccessRequests.js b/src/services/GroupAccessRequests.js index b5527d68..b6a5327f 100644 --- a/src/services/GroupAccessRequests.js +++ b/src/services/GroupAccessRequests.js @@ -1,8 +1,8 @@ import { ResourceAccessRequests } from '../templates'; -class GroupAccessRequests { +class GroupAccessRequests extends ResourceAccessRequests { constructor(options) { - return new ResourceAccessRequests('groups', options); + super('groups', options); } } diff --git a/src/services/GroupCustomAttributes.js b/src/services/GroupCustomAttributes.js index e31031cc..6a9a05d5 100644 --- a/src/services/GroupCustomAttributes.js +++ b/src/services/GroupCustomAttributes.js @@ -1,8 +1,8 @@ import { ResourceCustomAttributes } from '../templates'; -class GroupCustomAttributes { +class GroupCustomAttributes extends ResourceCustomAttributes { constructor(options) { - return new ResourceCustomAttributes('groups', options); + super('groups', options); } } diff --git a/src/services/GroupMembers.js b/src/services/GroupMembers.js index 50c2c3ce..a76c0919 100644 --- a/src/services/GroupMembers.js +++ b/src/services/GroupMembers.js @@ -1,8 +1,8 @@ import { ResourceMembers } from '../templates'; -class GroupMembers { +class GroupMembers extends ResourceMembers { constructor(options) { - return new ResourceMembers('groups', options); + super('groups', options); } } diff --git a/src/services/GroupMilestones.js b/src/services/GroupMilestones.js index 4a31c5a2..b13306c1 100644 --- a/src/services/GroupMilestones.js +++ b/src/services/GroupMilestones.js @@ -1,8 +1,8 @@ import { ResourceMilestones } from '../templates'; -class GroupMilestones { +class GroupMilestones extends ResourceMilestones { constructor(options) { - return new ResourceMilestones('groups', options); + super('groups', options); } } diff --git a/src/services/GroupVariables.js b/src/services/GroupVariables.js index 0ea819f5..7bd40792 100644 --- a/src/services/GroupVariables.js +++ b/src/services/GroupVariables.js @@ -1,8 +1,8 @@ import { ResourceVariables } from '../templates'; -class GroupVariables { +class GroupVariables extends ResourceVariables { constructor(options) { - return new ResourceVariables('groups', options); + super('groups', options); } } diff --git a/src/services/MergeRequestNotes.js b/src/services/MergeRequestNotes.js index a9b21209..4e07fb22 100644 --- a/src/services/MergeRequestNotes.js +++ b/src/services/MergeRequestNotes.js @@ -1,8 +1,8 @@ import { ResourceNotes } from '../templates'; -class MergeRequestNotes { +class MergeRequestNotes extends ResourceNotes { constructor(options) { - return new ResourceNotes('mergerequests', 'notes', options); + super('mergerequests', 'notes', options); } } diff --git a/src/services/ProjectAccessRequests.js b/src/services/ProjectAccessRequests.js index 9bea05e0..39c686ac 100644 --- a/src/services/ProjectAccessRequests.js +++ b/src/services/ProjectAccessRequests.js @@ -1,8 +1,8 @@ import { ResourceAccessRequests } from '../templates'; -class ProjectAccessRequests { +class ProjectAccessRequests extends ResourceAccessRequests { constructor(options) { - return new ResourceAccessRequests('projects', options); + super('projects', options); } } diff --git a/src/services/ProjectCustomAttributes.js b/src/services/ProjectCustomAttributes.js index 419f7db4..6f3bb339 100644 --- a/src/services/ProjectCustomAttributes.js +++ b/src/services/ProjectCustomAttributes.js @@ -1,8 +1,8 @@ import { ResourceCustomAttributes } from '../templates'; -class ProjectCustomAttributes { +class ProjectCustomAttributes extends ResourceCustomAttributes { constructor(options) { - return new ResourceCustomAttributes('projects', options); + super('projects', options); } } diff --git a/src/services/ProjectMembers.js b/src/services/ProjectMembers.js index 1a649111..59c8acb5 100644 --- a/src/services/ProjectMembers.js +++ b/src/services/ProjectMembers.js @@ -1,8 +1,8 @@ import { ResourceMembers } from '../templates'; -class ProjectMembers { +class ProjectMembers extends ResourceMembers { constructor(options) { - return new ResourceMembers('projects', options); + super('projects', options); } } diff --git a/src/services/ProjectMilestones.js b/src/services/ProjectMilestones.js index 477053e3..300687a3 100644 --- a/src/services/ProjectMilestones.js +++ b/src/services/ProjectMilestones.js @@ -1,8 +1,8 @@ import { ResourceMilestones } from '../templates'; -class ProjectMilestones { +class ProjectMilestones extends ResourceMilestones { constructor(options) { - return new ResourceMilestones('projects', options); + super('projects', options); } } diff --git a/src/services/ProjectSnippets.js b/src/services/ProjectSnippets.js index 30f3f732..58cfe3bb 100644 --- a/src/services/ProjectSnippets.js +++ b/src/services/ProjectSnippets.js @@ -1,8 +1,8 @@ import { ResourceNotes } from '../templates'; -class ProjectSnippets { +class ProjectSnippets extends ResourceNotes { constructor(options) { - return new ResourceNotes('projects', 'snippets', options); + super('projects', 'snippets', options); } } diff --git a/src/services/ProjectVariables.js b/src/services/ProjectVariables.js index 65811cdc..dedac47d 100644 --- a/src/services/ProjectVariables.js +++ b/src/services/ProjectVariables.js @@ -1,8 +1,8 @@ import { ResourceVariables } from '../templates'; -class ProjectVariables { +class ProjectVariables extends ResourceVariables { constructor(options) { - return new ResourceVariables('projects', options); + super('projects', options); } } diff --git a/src/services/UserCustomAttributes.js b/src/services/UserCustomAttributes.js index 9ad18e17..109fb9aa 100644 --- a/src/services/UserCustomAttributes.js +++ b/src/services/UserCustomAttributes.js @@ -1,8 +1,8 @@ import { ResourceCustomAttributes } from '../templates'; -class UserCustomAttributes { +class UserCustomAttributes extends ResourceCustomAttributes { constructor(options) { - return new ResourceCustomAttributes('users', options); + super('users', options); } }