https://github.com/gjbianco/hubot-simple-attendance

This plugin allows hubot to track weekly user attendance for a list (e.g. who will be in an office during the week).
https://github.com/gjbianco/hubot-simple-attendance

Last synced: about 1 month ago
JSON representation

This plugin allows hubot to track weekly user attendance for a list (e.g. who will be in an office during the week).

• Host: GitHub
• URL: https://github.com/gjbianco/hubot-simple-attendance
• Owner: gjbianco
• License: mit
• Created: 2018-07-03T21:32:44.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-07-05T18:49:07.000Z (over 6 years ago)
• Last Synced: 2024-12-09T12:57:37.928Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hubot-simple-attendance

This plugin allows hubot to track weekly *user* attendance for a *list* (e.g. who will be in an office during the week).

## Concepts

#### Lists

- Each *list* has multiple *users*

- Each *user* can be on multiple *lists*

- Each *user* can only be on each *list* once

#### Days in the week

- *Lists* have multiple *days*

- A *user* is either present (1) or absent (0) on each *day*

- *Days* are represented by a list of 7 bits (one per DOW) OR 5 bits (weekdays)

#### Administration

- Whenever a *list* is _cycled_, all *users* in that *list* are cleared (it is generally the list "owner" responsibility to do so at the end of the week).

- One user can _lock_ the list so only they can lock/unlock/cycle/rm the *list* (this makes them the "owner" of that list)

## Commands

#### Setting your bits

```

!attendance  <5/7 day bits>

```

Set the speaker's current weeks' attendance to the *list*. Accepts either 5 or 7 bits, with each bit representing present (1) or absent (0) for the positional day. Weeks start with Sunday.

Examples:

- `!attendance charlotte 11111` --> set present for all weekdays

- `!attendance charlotte 0101010` --> set present for MWF

#### Showing the attendance for a list

```

!attendance  [day]

```

Show current week's attendance for *list*. Takes an optional day, in which case it only shows the attendance for that particular day.

#### Cycling the list

```

!attendance cycle 

```

Cycles the *list* to the next week. Meta info (such as owner) for the list are maintained. All user attendance is cleared. This should be done by the owner/locker at the end of each week.

#### (Un)locking the list

```

!attendance  

```

Locks or unlocks the *list* so that only the speaker can cycle|unlock|rm the list.

#### Removing a list

```

!attendance rm 

```

Completely deletes the *list* (including meta info). If you just want to go to the next week, use `cycle`.