Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jrschumacher/hubot-hall

A Hall adapter for Hubot
https://github.com/jrschumacher/hubot-hall

Last synced: about 3 hours ago
JSON representation

A Hall adapter for Hubot

Awesome Lists containing this project

README 

        
hubot-hall

==========



# A [Hubot](https://github.com/github/hubot) adapter for [Hall](https://hall.com)



### Compatibility with Hubot



 * Hubot >= 2.4.2



### Compatibility with NodeJS



 * Preferably use NodeJS 0.8.x or later



## Installing Hubot-Hall on Heroku



1. Complete the [instructions in the Hubot wiki](https://github.com/github/hubot/wiki/Deploying-Hubot-onto-Heroku) and return to these steps to configure your app for Hall.



1. Create a new Hall account for your bot to use.

 * You can set the first name and last name on the account to whatever you wish.

 * Once setup is complete, you can invoke your bot with either the full name of the user account or with the name you give the bot when you start it up.

 * Record the email address and password so you can configure your Hubot-Hall adapter later.



1. The `hubot/` directory that you created in the Hubot on Heroku instructions above is all that is relevant to us now. Let's switch to it:



        % cd hubot/



1. Edit `package.json` and add `hubot-hall` to the `dependencies` section. It should look something like this:



        "dependencies": {

          "hubot-hall": "latest",

          ...

        }



1. If you won't be using the `redis-brain.coffee` script, you need to remove it from the array in `hubot-scripts.json` file.



1. Edit `Procfile` and change it to use the `hall` adapter and give it a name (optional) where `bot_name` is the name you'll use to invoke the bot (it will default to hubot):



        web: bin/hubot -a hall -n bot_name



1. Configure it:



      You will need to set a configuration variable if you are hosting on the free Heroku plan (if you haven't already done so).



        % heroku config:add HEROKU_URL=http://soothing-mists-4567.herokuapp.com



      Where the URL is your Heroku app's URL (shown after running `heroku create`, or `heroku rename`).



      Set the email to the email you used to register the bot with Hall:



        % heroku config:add HUBOT_HALL_EMAIL="..."



      Set the password to the password chosen when you created the bot's account.



        % heroku config:add HUBOT_HALL_PASSWORD="..."

		

1. Add and commit your package.json changes:



        % git add .

		% git commit -m "added the hubot-hall dependency"



1. Deploy and start the bot:



        % git push heroku master

        % heroku ps:scale web=1



      This will tell Heroku to run 1 of the `web` process type which is described in the `Procfile`.



1. You should see the bot join all rooms it has been added to. If not, check the output of `heroku logs`. You can also use `heroku config` to check the config vars and `heroku restart` to restart the bot. `heroku ps` will show you its current process state.



1. Assuming your bot's name is "Hubot", the bot will respond to commands like "@hubot help".  The '@' symbol is optional.



1. To configure the commands the bot responds to, you'll need to edit the `hubot-scripts.json` file ([valid script names here](https://github.com/github/hubot-scripts/tree/master/src/scripts)) or add scripts to the `scripts/` directory.



1. To deploy an updated version of the bot, simply commit your changes and run `git push heroku master` again.



## Running on Unix



1. Complete the [instructions in the Hubot wiki](https://github.com/github/hubot/wiki/Deploying-Hubot-onto-Unix) and return to these steps to configure your app for Hall.



1. Create a new Hall account for your bot to use.

 * You can set the first name and last name on the account to whatever you wish.

 * Once setup is complete, you can invoke your bot with either the full name of the user account or with the name you give the bot when you start it up.

 * Record the email address and password so you can configure your Hubot-Hall adapter later.



1. The `hubot/` directory that you created in the Hubot on Unix instructions above is all that is relevant to us now. Let's switch to it:



        % cd hubot/



1. Edit `package.json` and add `hubot-hall` to the `dependencies` section. It should look something like this:



        "dependencies": {

          "hubot-hall": "latest",

          ...

        }



1. Install the dependencies



        % npm install



1. Configure it:



      Set the email to the email you used to register the bot with Hall:



        % heroku config:add HUBOT_HALL_EMAIL="..."



      Set the password to the password chosen when you created the bot's account.



        % heroku config:add HUBOT_HALL_PASSWORD="..."



1. Run the hubot with the Hall adapter



        % bin/hubot -a hall



1. Or run hubot from a script like so:



```bash

#!/bin/bash



export HUBOT_HALL_EMAIL="..."

export HUBOT_HALL_PASSWORD="..."



bin/hubot --a hall

```