1.0.0

Author: GuilhermeSCP

.eslintrc

@@ -0,0 +1,46 @@
+// Use this file as a starting point for your projects .eslintrc.
+// Copy this file, and add rule overrides as needed.
+{
+    "extends": "airbnb",
+    "env": {
+        es6: true,
+        node: true,
+        browser: true
+    },
+    "rules" : {
+        // enforce indentation of 4 spaces
+        // http://eslint.org/docs/rules/indent
+        "indent": ["error", 4],
+
+        // enforce the max line length to be 120 chars
+        // http://eslint.org/docs/rules/max-len
+        "max-len": ["error", 120],
+
+        // disallowing comma trailing
+        // http://eslint.org/docs/rules/max-len
+        "comma-dangle": ["error", "never"],
+
+        // disallowing space after function name
+        // http://eslint.org/docs/rules/space-before-function-paren
+        "space-before-function-paren": "error",
+
+        // allowing unary operators
+        // http://eslint.org/docs/rules/no-plusplus
+        "no-plusplus": "off",
+
+        // Forbid the use of dev packages
+        // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md
+        "import/no-extraneous-dependencies": ["error",
+            {
+            "devDependencies": false
+            }
+        ],
+
+        // enforce braces in arrow function bodies
+        // http://eslint.org/docs/rules/arrow-body-style
+        "arrow-body-style": ["error", "always"]
+    },
+    "globals" : {
+        "window": true
+    }
+}

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+node_modules/
+dist/
+secret.json
+docs/
+.idea/
+coverage

LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Bynder B.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,2 +1,116 @@
-# bynder-js-sdk
-Bynder javascript SDK
+# Bynder JavaScript SDK
+This SDK aims to help the development of integrations with Bynder that use JavaScript, providing an easy interface to communicate with Bynder's REST API and request the information required.
+For that purpose, many ES2015 features were used, as well as Promises notation to help dealing with asynchronous code.
+
+## Requirements
+In order to use this SDK, the only thing needed is an updated version of Node.js:
+* [Node.js v6.3.0 or above](https://nodejs.org/)
+* [Yarn](https://yarnpkg.com/)
+
+Node installation will include NPM, which is responsible for the dependencies management.
+
+## Installation
+
+### Node.js
+TBD
+
+`npm install bynder-js-sdk`
+
+### Browser
+TBD
+
+`<script src="path/to/bynder-js-sdk.js"></script>`
+
+## Usage
+As said before, this SDK relies heavily on [Promises](https://developers.google.com/web/fundamentals/getting-started/primers/promises), making it easier to handle the asynchronous requests made to the API.
+Besides that, it provides a `Bynder` object  containing several methods corresponding to the calls to be performed, which accept the parameters exactly according [Bynder's API documentation](http://docs.bynder.apiary.io/).
+
+This is a generic example of how to use the SDK, if you need specific details for a specific module, refer to [samples folder](https://github.com/Bynder/bynder-js-sdk-private/tree/develop/samples).
+
+Before executing any request, you need to call the constructor passing your credentials as parameters, making it possible to authorize the calls to the API:
+
+```js
+const bynder = new Bynder({
+    consumer: {
+        public: "<public_consumer_key>",
+        secret: "<secret_consumer_key>"
+    },
+    accessToken: {
+        public: "<public_access_key>",
+        secret: "<secret_access_key>"
+    },
+    baseURL: "http://api-url.bynder.io/api/"
+});
+```
+
+From this point on, you just need to call the methods made available to call the API and retrieve the data your looking for. Following the Promises notation, you should use `.then()/.catch()` to handle respectively the successful and failed requests.
+Except for some special cases, most of the calls only take an object as parameter. After that, you'll need to refer to the API to tune the query as intended.
+
+```js
+bynder.getMediaList({
+    type: 'image',
+    limit: 9,
+    page: 1
+})
+.then((data) => {
+    // TODO stuff
+})
+.catch((error) => {
+    // TODO Handle the error
+});
+```
+
+## Methods available
+Here's a list of all the methods available, separated by module:
+
+### Authentication
+* `userLogin()`
+* `getRequestToken()`
+* `getAuthorisedURL(token, callback)`
+* `getAccessToken(token, secret)`
+
+### Media items
+* `getMediaList(queryObject)`
+* `getMediaInfo(queryObject)`
+* `getAllMediaItems(queryObject)`
+* `getMediaTotal(queryObject)`
+* `editMedia(object)`
+
+### Metaproperties
+* `getMetaproperties(queryObject)`
+* `getMetaproperty(queryObject)`
+* `saveNewMetaproperty(object)`
+* `deleteMetaproperty(object)`
+
+### Tags
+* `getTags()`
+
+### Categories
+* `getCategories()`
+
+## Contribute to the SDK
+If you wish to contribute to this repository and further extend the API coverage of the SDK, here are the steps necessary to prepare your environment:
+
+1. Clone the repository
+2. In the root folder, run `npm install` to install all the dependencies.
+3. Use the file named 'secret.json' for the tokens with this structure:
+```json
+{   
+    "consumer": {
+        "public": "<public_consumer_key>",
+        "secret": "<secret_consumer_key>"
+    },
+    "accessToken": {
+        "public": "<public_access_key>",
+        "secret": "<secret_access_key>"
+    },
+    "baseURL": "http://api-url.bynder.io/api/"
+}
+```
+4. Use any of these gulp tasks to:
+  1. `gulp lint` - Run ESlint and check the code.
+  2. `gulp build` - Run webpack to bundle the code in order to run in a browser.
+  3. `gulp babel` - Run Babel to create a folder 'dist' with ES2015 compatible code.
+  4. `gulp jasmine` - Run Jasmine for all the spec files inside 'tests'.
+  5. `gulp doc` - Run JSDoc to create a 'doc' folder with automatically generated documentation for the source code.
+  6. `gulp webserver` - Deploy a web server from the root folder at `localhost:8080` to run the html samples (in order to avoid CORS problems). 

gulpfile.js

@@ -0,0 +1,89 @@
+const gulp = require('gulp');
+const eslint = require('gulp-eslint');
+const babel = require('gulp-babel');
+const jasmine = require('gulp-jasmine');
+const jsdoc = require('gulp-jsdoc3');
+const connect = require('gulp-connect');
+const webpack = require('webpack');
+const path = require('path');
+
+gulp.task('default', () => {
+    gulp.start('lint', 'jasmine', 'babel', 'doc');
+});
+
+gulp.task('lint', () => {
+    return gulp.src(['src/*.js', '!node_modules/**'])
+        .pipe(eslint())
+        .pipe(eslint.format());
+});
+
+gulp.task('babel', () => {
+    gulp.src('src/*.js')
+        .pipe(babel({
+            presets: ['env']
+        }))
+        .pipe(gulp.dest('dist'));
+});
+
+gulp.task('build', () => {
+    webpack({
+        entry: [
+            'babel-polyfill',
+            path.join(__dirname, 'src/bynder-js-sdk')
+        ],
+        output: {
+            path: './dist/',
+            filename: 'bundle.js',
+            library: 'Bynder'
+        },
+        module: {
+            loaders: [
+                {
+                    test: /\.js$/,
+                    exclude: /node_modules/,
+                    loader: 'babel-loader',
+                    query: {
+                        presets: ['env']
+                    }
+                },
+                {
+                    test: /\.json$/,
+                    loader: 'json-loader'
+                }
+            ]
+        },
+        resolve: {
+            extensions: ['', '.js']
+        }
+    }).run((err, stat) => {
+        if (err) {
+            console.log('Error building application - ', err);
+            return;
+        }
+        const statJson = stat.toJson();
+        if (statJson.errors.length > 0) {
+            console.log('Error building application - ', statJson.errors);
+            return;
+        }
+        console.log('Application built successfully !');
+    });
+});
+
+gulp.task('jasmine', () => {
+    gulp.src('tests/*.js')
+        // gulp-jasmine works on filepaths so you can't have any plugins before it
+        .pipe(jasmine({
+            verbose: true
+        }));
+});
+
+gulp.task('doc', (cb) => {
+    gulp.src(['README.md', 'src/*.js'], { read: false })
+        .pipe(jsdoc(cb));
+});
+
+gulp.task('webserver', () => {
+    connect.server({
+        port: 8080
+    });
+});

package.json

@@ -0,0 +1,40 @@
+{
+  "name": "bynder-js-sdk",
+  "version": "1.0.0",
+  "description": "Bynder Javascript SDK",
+  "main": "bynder-js-sdk.js",
+  "scripts": {
+    "test": "jasmine tests/*"
+  },
+  "author": "Bynder",
+  "license": "MIT",
+  "devDependencies": {
+    "babel": "^6.5.2",
+    "babel-core": "^6.20.0",
+    "babel-loader": "^6.2.9",
+    "babel-polyfill": "^6.20.0",
+    "babel-preset-env": "^1.1.1",
+    "eslint": "~3.7.1",
+    "eslint-config-airbnb": "~12.0.0",
+    "eslint-plugin-import": "~1.16.0",
+    "eslint-plugin-jsx-a11y": "~2.2.3",
+    "eslint-plugin-react": "~6.4.1",
+    "gulp": "^3.9.1",
+    "gulp-babel": "^6.1.2",
+    "gulp-connect": "^5.0.0",
+    "gulp-eslint": "^3.0.1",
+    "gulp-jasmine": "^2.4.0",
+    "gulp-jsdoc3": "^0.3.0",
+    "istanbul": "^0.4.5",
+    "jasmine": "^2.6.0",
+    "json-loader": "^0.5.4",
+    "path": "^0.12.7",
+    "webpack": "^1.14.0"
+  },
+  "dependencies": {
+    "axios": "^0.15.3",
+    "node-fetch": "^1.6.0",
+    "oauth-1.0a": "^1.0.1"
+  },
+  "repository": "[email protected]:Bynder/bynder-js-sdk.git"
+}

samples/categories.html

@@ -0,0 +1,44 @@
+<html>
+    <head>
+        <meta charset="UTF-8">
+        <title>Categories sample</title>
+        <script src="../dist/bundle.js"></script>
+    </head>
+    <body>
+        <ul id="categories-container">
+        </ul>
+
+        <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
+        <script src="https://unpkg.com/babel-standalone@6/babel.min.js"></script>
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/dompurify/0.9.0/purify.min.js"></script>
+        <script type="text/babel">
+            const Bynder = Bynder.default;
+
+            function appendCategories(categories) {
+                const categoriesContainer = document.getElementById('categories-container');
+                for (const category of categories) {
+                    categoriesContainer.innerHTML += `<li>${DOMPurify.sanitize(category.name)}</li>`;
+                }
+            }
+
+            axios('../secret.json')
+                .then((response) => {
+                    if (response.status < 300) {
+                        return response.data;
+                    }
+                    return Promise.reject(response);
+                })
+                .then((configs) => {
+                    const bynder = new Bynder(configs);
+                    return bynder.getCategories();
+                })
+                .then((data) => {
+                    appendCategories(data);
+                    console.log(data);
+                })
+                .catch((error) => {
+                    console.error(error);
+                });
+        </script>
+    </body>
+</html>

samples/categories.js

@@ -0,0 +1,12 @@
+const Bynder = require('../dist/bynder-js-sdk.js').default;
+const configs = require('../secret.json');
+
+const bynder = new Bynder(configs);
+
+bynder.getCategories()
+    .then((data) => {
+        console.log(data);
+    })
+    .catch((error) => {
+        console.error(error);
+    });