Gem Version Build Status codecov

zoom_slack

Note: this is alpha quality software, and still under active development!

This gem provides an easy way to automatically set your Slack status any time you are in a Zoom meeting.

The current implementation will only work on Mac OS X, but other operating system implementations are welcome!

Getting Started

Install via Rubygems

gem install zoom_slack

Next, create a new Slack app, and install it in your workspace to get a oauth token.

Then add a cron entry via crontab -e like this

* * * * * zoom_slack <oauth_access_token>

Usage

You can see all the various config options by running zoom_slack -h

$ zoom_slack -h
Usage: zoom_slack [options]

Authentication options:
    -t, --token TOKEN               Slack token (defaults to $SLACK_API_TOKEN)

Profile status options:
    --text TEXT                     Status text (defaults to 'In a meeting')
    --emoji EMOJI                   Status emoji (defaults to ':spiral_calendar_pad:')
    --expires N                     Status expires in N minutes (defaults to 0)
    --clear-text TEXT               Clear status text (defaults to '')
    --clear-emoji EMOJI             Clear status emoji (defaults to '')

Common options:
    -h, --help                      Show this message

Creating a New App

You can obtain an oauth token by creating a new app and installing it into your workspace with these directions:

  1. Go to https://api.slack.com/apps
  2. Click "Create New App"
  3. Give it an App Name (like "zoom_slack"), and assign it to your Workspace
  4. Click "Create App"
  5. Click "Permissions"
  6. Add the "Modify user's profile" scope
  7. Click "Save Changes"
  8. Under the "Settings" sidebar, click "Install App", then click "Install App to Workspace"
  9. Click "Authorize"
  10. Copy you OAuth Access Token

Todo

  1. Better documentation
  2. Support for additional platforms