{"id":15524442,"url":"https://github.com/codeforequity-at/botium-connector-holmes","last_synced_at":"2025-03-28T20:48:33.464Z","repository":{"id":91176429,"uuid":"211837106","full_name":"codeforequity-at/botium-connector-holmes","owner":"codeforequity-at","description":"Botium Connector for Wipro Holmes","archived":false,"fork":false,"pushed_at":"2020-02-20T16:08:38.000Z","size":49,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-03T06:35:29.799Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.botium.at","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codeforequity-at.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-30T10:41:40.000Z","updated_at":"2020-09-01T09:31:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"a981e7b3-df53-4632-b651-5bc945eba105","html_url":"https://github.com/codeforequity-at/botium-connector-holmes","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-holmes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-holmes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-holmes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeforequity-at%2Fbotium-connector-holmes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeforequity-at","download_url":"https://codeload.github.com/codeforequity-at/botium-connector-holmes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246100488,"owners_count":20723469,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-02T10:51:20.784Z","updated_at":"2025-03-28T20:48:33.443Z","avatar_url":"https://github.com/codeforequity-at.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botium Connector for Wipro Holmes\n\n[![NPM](https://nodei.co/npm/botium-connector-holmes.png?downloads=true\u0026downloadRank=true\u0026stars=true)](https://nodei.co/npm/botium-connector-holmes/)\n\n[![Codeship Status for codeforequity-at/botium-connector-holmes](https://app.codeship.com/projects/2bb81a70-c59f-0137-b318-6afa87cdc716/status?branch=master)](https://app.codeship.com/projects/366879)\n[![npm version](https://badge.fury.io/js/botium-connector-holmes.svg)](https://badge.fury.io/js/botium-connector-holmes)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()\n\n\nThis is a [Botium](https://github.com/codeforequity-at/botium-core) connector for testing your [Wipro Holmes](https://www.wipro.com/holmes/) chatbot.\n\n__Did you read the [Botium in a Nutshell](https://medium.com/@floriantreml/botium-in-a-nutshell-part-1-overview-f8d0ceaf8fb4) articles? Be warned, without prior knowledge of Botium you won't be able to properly use this library!__\n\n## How it works\nBotium connects to the API of your Wipro Holmes chatbot.\n\nIt can be used as any other Botium connector with all Botium Stack components:\n* [Botium CLI](https://github.com/codeforequity-at/botium-cli/)\n* [Botium Bindings](https://github.com/codeforequity-at/botium-bindings/)\n* [Botium Box](https://www.botium.at)\n\n## Requirements\n* **Node.js and NPM**\n* a **Wipro Holmes bot**\n* a **project directory** on your workstation to hold test cases and Botium configuration\n\n## Install Botium and Holmes Connector\n\nWhen using __Botium CLI__:\n\n```\n\u003e npm install -g botium-cli\n\u003e npm install -g botium-connector-holmes\n\u003e botium-cli init\n\u003e botium-cli run\n```\n\nWhen using __Botium Bindings__:\n\n```\n\u003e npm install -g botium-bindings\n\u003e npm install -g botium-connector-holmes\n\u003e botium-bindings init mocha\n\u003e npm install \u0026\u0026 npm run mocha\n```\n\nWhen using __Botium Box__:\n\n_Already integrated into Botium Box, no setup required_\n\n## Connecting Holmes chatbot to Botium\n\nProcess is very simple, you have to know just the endpoint URL for your chatbot.\n  \nCreate a botium.json with this URL in your project directory: \n\n```\n{\n  \"botium\": {\n    \"Capabilities\": {\n      \"PROJECTNAME\": \"\u003cwhatever\u003e\",\n      \"CONTAINERMODE\": \"holmes\",\n      \"HOLMES_URL\": \"...\"\n    }\n  }\n}\n```\n\nTo check the configuration, run the emulator (Botium CLI required) to bring up a chat interface in your terminal window:\n\n```\n\u003e botium-cli emulator\n```\n\nBotium setup is ready, you can begin to write your [BotiumScript](https://github.com/codeforequity-at/botium-core/wiki/Botium-Scripting) files.\n\n## How to start samples\n\nThere is two small demos in [samples](./samples) with Botium Bindings. One uses a mocked Holmes API, other one uses real Holmes API.\n\n### Mocked sample\nYou have to start the [Mock API](./samples/mocked/MockApi) first. This API accepts every request, and sends a constant response back.\n\n* Install packages, run Mock API\n```\n\u003e cd ./samples/mocked\n\u003e npm install \u0026\u0026 npm mock\n```\n\n* And start the test\n\n```\n\u003e cd ./samples/mocked\n\u003e npm test\n```\n\n### Real Holmes API sample\n\n* Adapt botium.json in the sample directory if required (change URL, delete other HOLMES_* entries)\n* Install packages, run the test\n\n```\n\u003e cd ./samples/real\n\u003e npm install \u0026\u0026 npm test\n```\n\n## Supported Capabilities\n\nSet the capability __CONTAINERMODE__ to __holmes__ to activate this connector.\n\n### HOLMES_URL\nHolmes chatbot endpoint url\n\n### HOLMES_SERVICE_URL\nHolmes service url\n\nOptional. Default same as HOLMES_URL. \n\n### HOLMES_USER\nUser name\n\nOptional. Default \"user\".\n\n### HOLMES_USER_ID\nUser id\n\nOptional. Default \"user@wipro.com\". \n\n### HOLMES_CHANNEL\nChannel in escaped JSON format. \n\nExample:\n```\n\"{\\\"id\\\": \\\"2\\\",\\\"type\\\": \\\"web\\\",\\\"lang\\\": \\\"en\\\"}\"\n```\n\nOptional. Default \n```\n{\"id\": \"1\",\"type\": \"web\",\"lang\": \"en\"}\n```\n\n### Roadmap\n* Support for intent/entity asserter\n* Support for sentiment analyze\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-holmes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-holmes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeforequity-at%2Fbotium-connector-holmes/lists"}