Merge pull request #68 from shanedewael/rename_export_name

Rename export name

Author: Shane DeWael

README.md

@@ -111,8 +111,8 @@ The easiest way to start using the Events API is by using the built-in HTTP serv
 
 ```javascript
 // Initialize using signing secret from environment variables
-const { createSlackEventAdapter } = require('@slack/events-api');
-const slackEvents = createSlackEventAdapter(process.env.SLACK_SIGNING_SECRET);
+const { createEventAdapter } = require('@slack/events-api');
+const slackEvents = createEventAdapter(process.env.SLACK_SIGNING_SECRET);
 const port = process.env.PORT || 3000;
 
 // Attach listeners to events by Slack Event "type". See: https://api.slack.com/events/message.im
@@ -141,8 +141,8 @@ middleware by calling the `expressMiddleware()` method;
 const http = require('http');
 
 // Initialize using signing secret from environment variables
-const { createSlackEventAdapter } = require('@slack/events-api');
-const slackEvents = createSlackEventAdapter(process.env.SLACK_SIGNING_SECRET);
+const { createEventAdapter } = require('@slack/events-api');
+const slackEvents = createEventAdapter(process.env.SLACK_SIGNING_SECRET);
 const port = process.env.PORT || 3000;
 
 // Initialize an Express application

docs/reference.md

@@ -1,6 +1,6 @@
 # Reference Documentation
 
-#### createSlackEventAdapter(_signingSecret_, [_options_])
+#### createEventAdapter(_signingSecret_, [_options_])
 
 A factory method for creating a new `SlackEventAdapter` instance.
 

examples/greet-and-react/index.js

@@ -9,7 +9,7 @@ const http = require('http');
 const express = require('express');
 
 // *** Initialize event adapter using signing secret from environment variables ***
-const slackEvents = slackEventsApi.createSlackEventAdapter(process.env.SIGNING_SECRET, {
+const slackEvents = slackEventsApi.createEventAdapter(process.env.SIGNING_SECRET, {
   includeBody: true
 });
 

src/index.js

@@ -2,6 +2,6 @@ import { errorCodes as adapterErrorCodes, SlackEventAdapter } from './adapter';
 
 export const errorCodes = adapterErrorCodes;
 
-export function createSlackEventAdapter(signingSecret, options) {
+export function createEventAdapter(signingSecret, options) {
   return new SlackEventAdapter(signingSecret, options);
 }

src/verify.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import yargs from 'yargs';
-import { createSlackEventAdapter } from './index';
+import { createEventAdapter } from './index';
 
 const argv = yargs
   .options({
@@ -27,7 +27,7 @@ const argv = yargs
   .help()
   .argv;
 
-const slackEvents = createSlackEventAdapter(argv.secret);
+const slackEvents = createEventAdapter(argv.secret);
 
 /* eslint-disable no-console */
 slackEvents

test/integration/test-adapter-options.js

@@ -1,7 +1,7 @@
 var assert = require('assert');
 var request = require('superagent');
 var createRequestSignature = require('../helpers').createRequestSignature;
-var createSlackEventAdapter = require('../../dist').createSlackEventAdapter;
+var createEventAdapter = require('../../dist').createEventAdapter;
 
 var isFunction = require('lodash.isfunction');
 var correctSigningSecret = 'SIGNING_SECRET';
@@ -13,7 +13,7 @@ describe('when using the waitForResponse option', function () {
     this.path = '/slack/events';
     this.signingSecret = correctSigningSecret;
     this.ts = Math.floor(Date.now() / 1000);
-    this.adapter = createSlackEventAdapter(this.signingSecret, {
+    this.adapter = createEventAdapter(this.signingSecret, {
       waitForResponse: true
     });
     return this.adapter.start(this.port);

test/integration/test-basic.js

@@ -2,7 +2,7 @@ var http = require('http');
 var assert = require('assert');
 var express = require('express');
 var request = require('superagent');
-var createSlackEventAdapter = require('../../dist').createSlackEventAdapter;
+var createEventAdapter = require('../../dist').createEventAdapter;
 var createRequestSignature = require('../helpers').createRequestSignature;
 var errorCodes = require('../../dist/http-handler').errorCodes;
 var uncaughtException = require('uncaughtException');
@@ -14,7 +14,7 @@ describe('when using middleware inside your own express application', function (
     this.port = process.env.PORT || '8080';
     this.signingSecret = 'SIGNING_SECRET';
     this.ts = Math.floor(Date.now() / 1000);
-    this.adapter = createSlackEventAdapter(this.signingSecret);
+    this.adapter = createEventAdapter(this.signingSecret);
     this.app = express();
     this.app.use('/slack', this.adapter.expressMiddleware());
     this.server = http.createServer(this.app);
@@ -178,7 +178,7 @@ describe('when using the built-in HTTP server', function () {
     // This is the default path
     this.path = '/slack/events';
     this.signingSecret = 'SIGNING_SECRET';
-    this.adapter = createSlackEventAdapter(this.signingSecret, {
+    this.adapter = createEventAdapter(this.signingSecret, {
       waitForResponse: true
     });
     return this.adapter.start(this.port);