0.0.2 • Published 3 years ago

botium-connector-ondewo v0.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

Botium Connector for Ondewo Chatbots

NPM

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

This is a Botium connector for testing your Ondewo 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 the API of your ondewo chatbot.

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

Requirements

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

Install Botium and Ondewo Connector

When using Botium CLI:

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

When using Botium Bindings:

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

When using Botium Box:

Already integrated into Botium Box, no setup required

Connecting Ondewo chatbot to Botium

You have to know just the endpoint URL for your chatbot, as well as username and password.

Create a botium.json with this URL in your project directory:

{
  "botium": {
    "Capabilities": {
      "PROJECTNAME": "<whatever>",
      "CONTAINERMODE": "ondewo",
      "ONDEWO_EMAIL": "...",
      "ONDEWO_PASSWORD": "...",
      "ONDEWO_AUTH_TOKEN": "...",
      "ONDEWO_PROJECT_ID": "..."
    }
  }
}

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 BotiumScript files.

How to start sample

  • Adapt botium.json in the samples/ondewo directory
  • Install botium-core
  • Install packages, run the test
> npm install --no-save botium-core
> cd ./samples/ondewo
> npm install && npm test

Supported Capabilities

Set the capability CONTAINERMODE to ondewo to activate this connector.

ONDEWO_BASEURL

Ondewo chatbot base url. By default grpc-nlu.ondewo.com:443 is used.

ONDEWO_EMAIL*

Ondewo login email address

ONDEWO_PASSWORD*

Ondewo login password

ONDEWO_AUTH_TOKEN*

Ondewo basic auth token

ONDEWO_PROJECT_ID*

Ondewo chatbot project id

ONDEWO_LANGUAGE_CODE*

Ondewo language code. By default en code is used.

Roadmap

  • Support for sentiment analyze