hubot-ibmcloud-openwhisk

Script package that exposes various IBM Cloud Open Whisk functionality through Hubot.

Getting Started

• Usage
• Commands
• Open Whisk Integration
• Hubot Adapter Setup
• Cognitive Setup
• Development
• License
• Contribute

Usage

If you are new to Hubot visit the getting started content to get a basic bot up and running. Next, follow these steps for adding this external script into your hubot:

1. cd into your hubot directory
2. Install this package via npm install hubot-ibmcloud-openwhisk --save
3. Install this package via npm install hubot-ibmcloud-formatter --save
4. Add hubot-ibmcloud-openwhisk, hubot-ibmcloud-formatter to your external-scripts.json
5. Add the necessary environment variables:

HUBOT_BLUEMIX_API=<Bluemix API URL>
HUBOT_BLUEMIX_ORG=<Bluemix Organization>
HUBOT_BLUEMIX_SPACE=<Bluemix space>
HUBOT_BLUEMIX_USER=<Bluemix User ID>
HUBOT_BLUEMIX_PASSWORD=<Password for the Bluemix use>
HUBOT_OPENWHISK_TOKEN=<Basic authentication token for Bluemix OpenWhisk>

6. Start up your bot & off to the races!

Commands

• hubot openwhisk invoke action [action] - Invokes an OpenWhisk action in the active namespace.
• hubot openwhisk list|show namespaces - Lists all of the OpenWhisk namespaces.
• hubot openwhisk list|show actions - Lists all of the OpenWhisk actions in the active namespace.
• hubot openwhisk namespace - Gets current OpenWhisk namespace.
• hubot openwhisk set|use namespace [namespace] - Sets the active OpenWhisk namespace.
• hubot openwhisk help - Show available OpenWhisk commands.

OpenWhisk Integration

For more in-depth information about using OpenWhisk try the getting started with Bluemix OpenWhisk documentation. See the following documentation for obtaining the Base64 encoded token used by the bot.

Hubot Adapter Setup

Hubot supports a variety of adapters to connect to popular chat clients. For more feature rich experiences you can setup the following adapters:

• Slack setup
• Facebook Messenger setup

Cognitive Setup

This project supports natural language interactions using Watson and other Bluemix services. For more information on enabling these features, refer to Cognitive Setup.

Development

Please refer to the CONTRIBUTING.md before starting any work. Steps for running this script for development purposes:

Configuration Setup

1. Create config folder in root of this project.
2. Create env in the config folder, with the following contents:

export HUBOT_BLUEMIX_API=<Bluemix API URL>
export HUBOT_BLUEMIX_ORG=<Bluemix Organization>
export HUBOT_BLUEMIX_SPACE=<Bluemix space>
export HUBOT_BLUEMIX_USER=<Bluemix User ID>
export HUBOT_BLUEMIX_PASSWORD=<Password for the Bluemix use>
export HUBOT_OPENWHISK_TOKEN=<Basic authentication token for Bluemix OpenWhisk>

3. In order to view content in chat clients you will need to add hubot-ibmcloud-formatter to your external-scripts.json file. Additionally, if you want to use hubot-help to make sure your command documentation is correct. Create external-scripts.json in the root of this project, with the following contents:

[
	"hubot-help",
	"hubot-ibmcloud-formatter"
]

4. Lastly, run npm install to obtain all the dependent node modules.

Running Hubot with Adapters

Hubot supports a variety of adapters to connect to popular chat clients.

If you just want to use:

• Terminal: run npm run start
• Slack: link to setup instructions
• Facebook Messenger: link to setup instructions

License

See LICENSE.txt for license information.

Contribute

Please check out our Contribution Guidelines for detailed information on how you can lend a hand.