mustaphee/pusher-whos-in-gem

Who's In?

This gem allows you to deploy to Heroku an application that lets you keep track of people who come and go from the office in realtime.

Installation

$ gem install pusher-whos-in

Usage

###Deployment

To deploy your own Who's In app, type into the command-line:

$ pusher-whos-in init

This will take you to the deployment page for Who's In on Heroku. Fill in the title of your app, and submit when ready. Heroku will provision you a Mongo database and a Pusher add-on.

View your app, and click the grey hexagon to add colleagues. You will need to enter their name, email and MAC address.

###Scanning Who's In

Who's In uses NMap to scan the specified network to see who is in the office. If you haven't installed NMap already, you can do so here.

When that's done, type the command:

$ pusher-whos-in run *your_app_name* *network_interface_to_scan*

E.g. pusher-whos-in run my_office_whos_in_app eth1. Then type your password. This script will run every two minutes and your Heroku application should show you who is in your office in realtime.

###Usage Without Gem

If you would prefer not to use this gem for your Who's In app, clone this script. Make sure you have PUSHER_URL = *something* set as an environment variable. If you are using Heroku, use the PUSHER_URL provisioned to you.

Click this shiny button:

Then run:

$ sh local_scanner.sh *url_to_post_mac_addresses* *your_pusher_url* *nmap_network*

###Usage Without Deployment

$ git clone https://github.com/pusher/pusher-whos-in.git

Get yourself some Pusher credentials and either set your PUSHER_URL as an environment variable, or place Pusher.url = *your_pusher_url* within app.rb. Now run your server:

$ shotgun

Contributing

1. Fork it ( https://github.com/pusher/pusher-whos-in-gem/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request