support v3

Author: kfiroo

Diff for: .babelrc

@@ -0,0 +1,5 @@
+{
+  "presets": ["es2015", "stage-2", "es2015-node"],
+  "plugins": [],
+  "sourceMaps": "both"
+}

Diff for: .gitignore

@@ -36,3 +36,4 @@ jspm_packages
 # Optional REPL history
 .node_repl_history
 /.idea/
+/dist/

Diff for: README.md

@@ -1,41 +1,120 @@
 # sendbird-nodejs
-Thin wrapper around SendBird Server REST API
-
-# PLEASE NOTE THIS WORKS ON TOP OF `SENDBIRD V2.0` API - V3.0 WILL COME SOON
+Thin wrapper around SendBird's Platform API
 
 ## Installation
-`npm install sendbird-nodejs --save`
+    npm install sendbird-nodejs --save
+
+or
 
+    yarn add sendbird-nodejs
 
 ## Usage
-See [SendBird Documentation](https://docs.sendbird.com/v2/platform) for payload and response details.  
-You don't need to pass the `auth` field on the payload, you provide it when creating a new instance of `SendBird` and it is attached to all requests. 
+See [SendBird Documentation](https://docs.sendbird.com/platform) for payload and response details.  
+You must provide your `API Token` when creating a new instance of `SendBird` and it will be attached to all requests. 
 
 ```javascript
 var SendBird = require('sendbird-nodejs');
-var sb = new SendBird(config.sendBird.appToken);
+var sb = new SendBird(/* your sendbird api token here */);
+```
+
+The `sb` instance we just created has an entry for each endpoint in the [SendBird Platform API](https://docs.sendbird.com/platform), it is an object with the endpoints methods.  
+Note that all methods return a `Promise` as returned by [request-promise](https://github.com/request/request-promise).
+
+
+[sb.users](https://docs.sendbird.com/platform#user)  
+
+[sb.openChannels](https://docs.sendbird.com/platform#open_channel)  
+[sb.openChannels.messages](https://docs.sendbird.com/platform#messages)  
+[sb.openChannels.metadata](https://docs.sendbird.com/platform#meta)  
+[sb.openChannels.metacounter](https://docs.sendbird.com/platform#meta)  
+
+[sb.groupChannels](https://docs.sendbird.com/platform#group_channel)  
+[sb.groupChannels.messages](https://docs.sendbird.com/platform#messages)  
+[sb.groupChannels.metadata](https://docs.sendbird.com/platform#meta)  
+[sb.groupChannels.metacounter](https://docs.sendbird.com/platform#meta)  
+
+##### Missing endpoints
+
+[sb.applications](https://docs.sendbird.com/platform#application)  
+[sb.migration](https://docs.sendbird.com/platform#migration)  
+[sb.bots](https://docs.sendbird.com/platform#bot_interface)  
+
+### Example
+
+To create a user you would simply need to have something like this:  
+```javascript
+const SendBird = require('sendbird-nodejs');
+const sb = SendBird('<SOME API TOKEN>');
+
+const payload = {
+    "user_id": string,
+    "nickname": string,
+    "profile_url": string,
+    "issue_access_token": boolean // (Optional)
+};
+sb.users.create(payload)
+    .then(function (response) {
+        // do something with SendBird response
+        // {
+        //     "user_id": string,
+        //     "nickname": string,
+        //     "profile_url": string,
+        //     "access_token": string,
+        //     "last_seen_at": long,
+        //     "is_online": boolean
+        // }
+    });
 ```
 
-The `sb` instance we just created has a field for each endpoint in the [SendBird Server API](https://docs.sendbird.com/v2/platform#overview) that is an object with the endpoints methods.  
-[sb.user](https://docs.sendbird.com/v2/platform#user)  
-[sb.channel](https://docs.sendbird.com/v2/platform#open_chat)  
-[sb.messaging](https://docs.sendbird.com/v2/platform#messaging)  
-[sb.admin](https://docs.sendbird.com/v2/platform#admin)  
-[sb.migration](https://docs.sendbird.com/v2/platform#migration)  
+There are two different types of parameters the Platform API requires  
+
+1. `url params` - you can see them in sendbird docs as `{some_param}` in the `URL`
+2. `payload/querystring params` - you can see them in the sendbird docs under the `request` section
 
-So, to create a user you would simply need to have something like this:  
+We will treat the two types differently when calling the API.  
+`url params` will be used as arguments for the API method you are calling.  
+`payload/querystring params` will always a plain object and the last argument of the API method.
+
+This is how we would `send` a `message` to a `group channel` on behalf of some user using the API: [Send Message Docs](https://docs.sendbird.com/platform#messages_3_send)
 ```javascript
-var payload = {
-    "id": string,                 // User ID
-    "nickname": string,           // User nickname
-    "image_url": string,          // User profile image URL
-    "issue_access_token": boolean // Default is false. Use only if you want to create an access token for this user
+const SendBird = require('sendbird-nodejs');
+const sb = SendBird('<SOME API TOKEN>');
+
+const channelUrl = 'channel-url-from-sendbird';
+const payload = {
+    "message_type": "MESG",       // Text message
+    "user_id": string,            // Sender user_id
+    "message": string,            // Empty string is not allowed.
+    "data": string,               // (Optional) Custom data 
+    "custom_type": string,        // (Optional) default: ''  
+    "mark_as_read": boolean       // (Optional) default: true  
 };
-sb.user.create(payload)
+sb.groupChannels.messages.send(channelUrl, payload)
     .then(function (response) {
-        // do something with SendBird response    
+        // do something with SendBird response
+        // {
+        //     "message_id": long,
+        //     "type": "MESG",
+        //     "message": string,
+        //     "file": {
+        //         "name": string,
+        //         "url": string,
+        //         "type": string,
+        //         "size": int
+        //     },
+        //     "data": string,
+        //     "channel_url": string,
+        //     "created_at": long,
+        //     "user": {
+        //         "nickname": string,
+        //         "user_id": string,
+        //         "profile_url": string
+        //     },
+        //     "custom_type": string
+        // }
     });
 ```
+In the [docs](https://docs.sendbird.com/platform#messages_3_send) we see the `URL` is `https://api.sendbird.com/v3/{channel_type}/{channel_url}/messages` so the `channel_type` param will be set by using `sb.groupChannels` and the `channel_url` is the first argument we of `sb.groupChannels.message.send`
 
 
 ## Contributing

Diff for: package.json

@@ -1,30 +1,44 @@
 {
   "name": "sendbird-nodejs",
-  "version": "0.0.8",
-  "description": "Thin wrapper around SendBird Server REST API",
-  "main": "index.js",
+  "version": "1.0.0",
+  "description": "Thin wrapper around SendBird Server REST API v3",
+  "main": "dist/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "babel src -d dist",
+    "test": "mocha --compilers js:babel-register"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/kfiroo/sendbird-nodejs.git"
   },
   "keywords": [
     "sendbird",
+    "sendbird sdk",
+    "sdk",
     "node",
     "nodejs"
   ],
-  "author": "kfiroo",
+  "author": "kfiroo <[email protected]>",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/kfiroo/sendbird-nodejs/issues"
   },
   "homepage": "https://github.com/kfiroo/sendbird-nodejs#readme",
   "dependencies": {
-    "bluebird": "3.4.1",
-    "lodash": "4.13.1",
-    "request": "2.73.0"
+    "babel-cli": "6.18.0",
+    "babel-preset-es2015": "6.18.0",
+    "babel-preset-es2015-node": "6.1.1",
+    "babel-preset-stage-2": "6.18.0",
+    "bluebird": "3.4.6",
+    "expect": "1.20.2",
+    "lodash": "4.17.2",
+    "mocha": "3.2.0",
+    "nock": "9.0.2",
+    "nodemon": "1.11.0",
+    "request": "2.79.0",
+    "request-promise": "4.1.1"
   },
-  "browserDependencies": {}
+  "devDependencies": {
+
+  }
 }

Diff for: src/SendBird.js

@@ -1,25 +1,35 @@
 'use strict';
 
-var createService = require('./utils/createService');
+const rp = require('request-promise');
 
-var adminService = require('./services/adminService');
-var channelService = require('./services/channelService');
-var messagingService = require('./services/messagingService');
-var migrationService = require('./services/migrationService');
-var userService = require('./services/userService');
+const DEFAULT_BASE_URL = 'https://api.sendbird.com/v3/';
 
-function SendBird(apiToken) {
-    if (!(this instanceof SendBird)) {
-        return new SendBird(apiToken);
-    }
+// users
+const usersService = require('./services/users');
+// open channel
+const openChannelsService = require('./services/openChannels');
+// group channel
+const groupChannelsService = require('./services/groupChannels');
+
+function SendBird(apiToken, baseUrl = DEFAULT_BASE_URL) {
     if (!apiToken) {
         throw new Error('Invalid api token');
     }
-    this.admin = createService(apiToken, adminService);
-    this.channel = createService(apiToken, channelService);
-    this.messaging = createService(apiToken, messagingService);
-    this.migration = createService(apiToken, migrationService);
-    this.user = createService(apiToken, userService);
+    const request = rp.defaults({
+        baseUrl,
+        headers: {
+            'Api-Token': apiToken
+        },
+        json: true
+    });
+
+    const api = {};
+
+    api.users = usersService(request);
+    api.openChannels = openChannelsService(request);
+    api.groupChannels = groupChannelsService(request);
+
+    return api;
 }
 
-module.exports = SendBird;
+module.exports = SendBird;

Diff for: src/constants/requestTypes.js

@@ -0,0 +1,8 @@
+'use strict';
+
+module.exports = {
+    GET: 'GET',
+    POST: 'POST',
+    PUT: 'PUT',
+    DELETE: 'DELETE'
+};

Diff for: index.js renamed to src/index.js

@@ -1,5 +1,5 @@
 'use strict';
 
-var SendBird = require('./src/SendBird');
+const SendBird = require('./SendBird');
 
 module.exports = SendBird;