0.0.2 • Published 3 years ago

botium-connector-pandorabots v0.0.2

Weekly downloads
14
License
MIT
Repository
github
Last release
3 years ago

Botium Connector for Pandorabots

NPM

Codeship Status for codeforequity-at/botium-connector-pandorabots npm version license

This is a Botium connector for testing your Pandorabots chatbot.

Did you read the Botium in a Nutshell articles? Be warned, without prior knowledge of Botium you won't be able to properly use this library!

How it works

Botium connects to your Pandorabots chatbot with the Talk-to-bot-API

It can be used as any other Botium connector with all Botium Stack components:

Requirements

  • Node.js and NPM
  • a Pandorabots bot
  • a project directory on your workstation to hold test cases and Botium configuration

Install Botium and Pandorabots Connector

When using Botium CLI:

> npm install -g botium-cli
> npm install -g botium-connector-pandorabots
> botium-cli init
> botium-cli run

When using Botium Bindings:

> npm install -g botium-bindings
> npm install -g botium-connector-pandorabots
> botium-bindings init mocha
> npm install && npm run mocha

When using Botium Box:

Already integrated into Botium Box, no setup required

Connecting Pandorabots chatbot to Botium

Setting up Pandorabots

All you need is the public Bot key

Setting up Botium

Create a botium.json with the the Botkey of your Pandorabot in your project directory:

{
  "botium": {
    "Capabilities": {
      "PROJECTNAME": "<whatever>",
      "CONTAINERMODE": "pandorabots",
      "PANDORABOTS_BOTKEY": "..."
    }
  }
}

To check the configuration, run the emulator (Botium CLI required) to bring up a chat interface in your terminal window:

> botium-cli emulator

Botium setup is ready, you can begin to write your test cases with BotiumScript.

How to start sample

You can start the Pandorabots sample with these commands:

> cd ./samples/mitsuku
> npm install && npm test

Supported Capabilities

Set the capability CONTAINERMODE to pandorabots to activate this connector.

PANDORABOTS_BOTKEY

Bot key

PANDORABOTS_APIHOST

Default: api.pandorabots.com

Shouldn't have to change this

PANDORABOTS_CLIENT_NAME

Default: botium

Client name