Merge branch '30060466_updates' into 'develop'

Updates

See merge request luettich/receiver!5

Author: callmekatootie

README.md

@@ -33,11 +33,22 @@ The following config parameters are supported, they are defined in `config/defau
 | PORT                           | the port the application will listen on    |  3000                            |
 | LOG_LEVEL                      | the log level                              |  info                            |
 | TOPIC                          | the kafka subscribe topic name             |  events_topic                    |
-| ZOO_KEEPER                     | the ip:port to connect to ZOO_KEEPER       |  localhost:2181                  |
+|KAFKA_OPTIONS                   | the connection option for kafka            |  see below about KAFKA options                   |
 | GITHUB_SECRET_TOKEN            | the webhook security token for github      |                                  |
 | GITLAB_SECRET_TOKEN            | the webhook security token for gitlab      |                                  |
 | WATCH_REPOS                    | the repos we want to watch                 |                                  |
 
+KAFKA_OPTIONS should be object as described in https://github.com/SOHU-Co/kafka-node#kafkaclient
+For using with SSL, the options should be as
+```
+ {
+    kafkaHost: '<server>',
+    sslOptions: {
+      cert: '<certificate>', 
+      key:  '<key>'
+    }
+ }
+```
 
 To change the WATCH_REPOS, you'd better create a `config/local.js` file to override the WATCH_REPOS, see `config/sample-local.js` for example.
 
@@ -108,6 +119,7 @@ ngrok http 3000
 - create an issue in the repo, you can see the logs in `receiver` and `processor`, the `issue.created` event is generated.
 - update an issue in the repo, you can see the logs in `receiver` and `processor`, the `issue.updated` event is generated.
 - create a comment on an issue, you can see the logs in `receiver` and `processor`, the `comment.created` event is generated.
+- update a comment on an issue, you can see the logs in `receiver` and `processor`, the `comment.updated` event is generated.
 - assigned a user to an issue, you can see the logs in `receiver` and `processor`, the `issue.assigned` event is generated.
 - assigned a user to an issue, you can see the logs in `receiver` and `processor`, the `issue.unassigned` event is generated.
 - add a label to an issue, you can see the logs in `receiver` and `processor`, the `issue.labeled` event is generated.

config/default.js

@@ -4,20 +4,23 @@
 
 /**
  * This module contains the configurations of the app.
- *
+ * Changes in 1.1:
+ * - changes related to https://www.topcoder.com/challenges/30060466
  * @author TCSCODER
- * @version 1.0
+ * @version 1.1
  */
 'use strict';
 
 module.exports = {
   PORT: process.env.PORT || 3000, // eslint-disable-line no-magic-numbers
   LOG_LEVEL: process.env.LOG_LEVEL || 'info',
   TOPIC: process.env.TOPIC || 'events_topic',
-  ZOO_KEEPER: process.env.ZOO_KEEPER || 'localhost:2181',
   GITHUB_SECRET_TOKEN: process.env.GITHUB_SECRET_TOKEN || '',
   GITLAB_SECRET_TOKEN: process.env.GITLAB_SECRET_TOKEN || '',
   WATCH_REPOS: [
     'https://github.com/cwdcwd/challengeFetcher'
-  ]
+  ],
+  KAFKA_OPTIONS: {
+    kafkaHost: 'localhost:9092'
+  }
 };

models/CommentUpdatedEvent.js

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2017 TopCoder, Inc. All rights reserved.
+ */
+/**
+ * This module contains the schema of the CommentUpdatedEvent.
+ *
+ * @author TCSCODER
+ * @version 1.0
+ */
+'use strict';
+const Joi = require('joi');
+const {issueSchema, repositorySchema} = require('./common');
+
+const CommentUpdatedEvent = {
+  name: 'comment.updated'
+};
+
+CommentUpdatedEvent.schema = Joi.object().keys({
+  issue: issueSchema.required(),
+  comment: Joi.object().keys({
+    id: Joi.number().required(),
+    body: Joi.string().allow(''),
+    user: Joi.object().keys({
+      id: Joi.number().required(),
+      name: Joi.string().required()
+    }).required()
+  }),
+  repository: repositorySchema.required()
+});
+
+
+module.exports = CommentUpdatedEvent;
+

models/common.js

@@ -4,9 +4,10 @@
 
 /**
  * This module contains some common schemas.
- *
+ * Changes in 1.1:
+ * - changes related to https://www.topcoder.com/challenges/30060466
  * @author TCSCODER
- * @version 1.0
+ * @version 1.1
  */
 
 'use strict';
@@ -16,6 +17,7 @@ const Joi = require('joi');
 // the repository schema
 const repositorySchema = Joi.object().keys({
   id: Joi.number().required(),
+  name: Joi.string().required(),
   full_name: Joi.string().required()
 });
 

models/index.js

@@ -3,15 +3,17 @@
  */
 /**
  * This module contains all the events in this app.
- *
+ * Changes in 1.1:
+ * - changes related to https://www.topcoder.com/challenges/30060466
  * @author TCSCODER
- * @version 1.0
+ * @version 1.1
  */
 'use strict';
 
 const IssueCreatedEvent = require('./IssueCreatedEvent');
 const IssueUpdatedEvent = require('./IssueUpdatedEvent');
 const CommentCreatedEvent = require('./CommentCreatedEvent');
+const CommentUpdatedEvent = require('./CommentUpdatedEvent');
 const UserAssignedEvent = require('./UserAssignedEvent');
 const UserUnassignedEvent = require('./UserUnassignedEvent');
 const LabelAssignedEvent = require('./LabelAssignedEvent');
@@ -23,6 +25,7 @@ module.exports = {
   IssueCreatedEvent,
   IssueUpdatedEvent,
   CommentCreatedEvent,
+  CommentUpdatedEvent,
   UserAssignedEvent,
   UserUnassignedEvent,
   LabelAssignedEvent,

package-lock.json

@@ -4,7 +4,7 @@
   "private": true,
   "scripts": {
     "start": "node ./bin/www",
-    "lint": "eslint . --ignore-pattern 'public/*' --ext .js || true"
+    "lint": "eslint . --ignore-pattern 'public/*' --ext .js --fix || true"
   },
   "engines": {
     "node": ">8.6.0"

package.json

@@ -4,9 +4,10 @@
 
 /**
  * This module contains the EventDetector for github.
- *
+ * Changes in 1.1:
+ * - changes related to https://www.topcoder.com/challenges/30060466
  * @author TCSCODER
- * @version 1.0
+ * @version 1.1
  */
 'use strict';
 
@@ -33,6 +34,7 @@ const parseIssue = (issue) => ({
 
 const parseRepository = (repository) => ({
   id: repository.id,
+  name: repository.name,
   full_name: repository.full_name
 });
 
@@ -88,6 +90,18 @@ IssueUpdatedEvent.parse = (data) => ({
 
 // end the IssueUpdatedEvent
 
+const parseComment = (data) => ({
+  issue: parseIssue(data.issue),
+  repository: parseRepository(data.repository),
+  comment: {
+    id: data.comment.id,
+    body: data.comment.body,
+    user: {
+      id: data.comment.user.id,
+      name: data.comment.user.login
+    }
+  }
+});
 // begin the CommentCreatedEvent
 const CommentCreatedEvent = {
   event: models.CommentCreatedEvent
@@ -100,21 +114,25 @@ CommentCreatedEvent.schema = Joi.object().keys({
   comment: Joi.object().required()
 });
 
-CommentCreatedEvent.parse = (data) => ({
-  issue: parseIssue(data.issue),
-  repository: parseRepository(data.repository),
-  comment: {
-    id: data.comment.id,
-    body: data.comment.body,
-    user: {
-      id: data.comment.user.id,
-      name: data.comment.user.login
-    }
-  }
-});
+CommentCreatedEvent.parse = parseComment;
 
 // end the CommentCreatedEvent
 
+// begin the CommentUpdatedEvent
+const CommentUpdatedEvent = {
+  event: models.CommentUpdatedEvent
+};
+
+CommentUpdatedEvent.schema = Joi.object().keys({
+  action: Joi.string().valid('edited').required(),
+  issue: Joi.object().required(),
+  repository: Joi.object().required(),
+  comment: Joi.object().required()
+});
+
+CommentUpdatedEvent.parse = parseComment;
+// end the CommentUpdatedEvent
+
 // begin the UserAssignedEvent
 const UserAssignedEvent = {
   event: models.UserAssignedEvent
@@ -238,6 +256,7 @@ module.exports = new EventDetector('github', [
   IssueCreatedEvent,
   IssueUpdatedEvent,
   CommentCreatedEvent,
+  CommentUpdatedEvent,
   UserAssignedEvent,
   UserUnassignedEvent,
   LabelAssignedEvent,

utils/GithubEventDetector.js

@@ -3,9 +3,10 @@
  */
 /**
  * This module is a wrapper for kafka producer.
- *
+ * Changes in 1.1:
+ * - changes related to https://www.topcoder.com/challenges/30060466
  * @author TCSCODER
- * @version 1.0
+ * @version 1.1
  */
 'use strict';
 
@@ -16,7 +17,7 @@ const logger = require('./logger');
 
 class Kafka {
   constructor() {
-    this.client = new kafka.Client(config.ZOO_KEEPER);
+    this.client = new kafka.KafkaClient(config.KAFKA_OPTIONS);
     this.producer = new kafka.Producer(this.client);
     this.producer.on('ready', () => {
       logger.info('kafka producer is ready.');