Hackathon project

.gitignore

@@ -1,6 +1,13 @@
 config.json
+config.yaml
 *.pyc
 
 log*.csv
 log*.csv_DEBUG
 user_cache.save
+*.log
+
+build/
+dist/
+
+.DS_STORE

.travis.yml

@@ -0,0 +1,12 @@
+language: python
+python:
+  - "2.7"
+branches:
+  only:
+    - hackathon
+addons:
+  postgresql: "9.4"
+install: "pip install -r requirements.txt"
+before_script:
+  - psql -c 'CREATE DATABASE travis_ci_test;' -U postgres
+script: nosetests -sv

Dockerfile

@@ -0,0 +1,24 @@
+FROM ubuntu:15.04
+
+RUN apt-get update && apt-get install -y \
+    python-pip \
+    postgresql-common \
+    libpq-dev \
+    python-dev \
+ && apt-get clean \
+ && rm -rf /var/lib/apt/lists/* \
+ && mkdir /flexbot /flexbot/configuration /flexbot/flexbot /flexbot/samples /flexbot/logs
+
+EXPOSE 80
+EXPOSE 8080
+
+COPY requirements.txt /flexbot/
+RUN pip install -r /flexbot/requirements.txt
+
+COPY flexbot /flexbot/flexbot
+COPY exercises /flexbot/exercises
+COPY samples /flexbot/samples
+
+WORKDIR /flexbot
+CMD ["python", "-m", "samples.run_flexbot", "--config", "configuration/config.yaml", "--logging-config", "configuration/logging.yaml"]
+

MANIFEST.in

@@ -0,0 +1,2 @@
+prune samples
+prune test

README.md

@@ -1,14 +1,15 @@
 # slackbot-workout
+[![Build Status](https://travis-ci.org/mgyucht/slackbot-workout.svg?branch=hackathon)](https://travis-ci.org/mgyucht/slackbot-workout)
+
 A fun hack that gets Slackbot to force your teammates to work out!
 
 <img src = "https://ctrlla-blog.s3.amazonaws.com/2015/Jun/Screen_Shot_2015_06_10_at_5_57_55_PM-1433984292189.png" width = 500>
 
-
 # Instructions
 
 1. Clone the repo and navigate into the directory in your terminal.
 
-    `$ git clone [email protected]:brandonshin/slackbot-workout.git`
+    `$ git clone [email protected]:mgyucht/slackbot-workout.git`
 
 2. Go to your slack home page [https://{yourgroup}.slack.com/home](http://my.slack.com/home) & click on **Integrations** on the left sidebar.
 
@@ -22,33 +23,38 @@ A fun hack that gets Slackbot to force your teammates to work out!
 
     <img src="https://ctrlla-blog.s3.amazonaws.com/2015/Jun/Screen_Shot_2015_06_05_at_7_00_24_PM-1433557433415.png" width = 500>
 
-5. In the **Slackbot** (Remote control page). Register an integration & you should see this. __Make sure you grab just the token out of the url__, e.g. `AizJbQ24l38ai4DlQD9yFELb`
+5. Set up channel and customize configurations
+
+    Copy `default.yaml` or `default.json` and configure to your heart's desire. There are a handful of sample configurations located in the `samples/` directory.
 
-    <img src="https://ctrlla-blog.s3.amazonaws.com/2015/Jun/Screen_Shot_2015_06_03_at_8_44_00_AM-1433557565175.png" width = 500>
+6. While in the project directory, run
 
-6. Save your SLACK_USER_TOKEN_STRING and SLACK_URL_TOKEN_STRING as environmental variables in your terminal.
+    ```
+    $ sudo ./install-dependencies.sh
+    $ sudo pip install -r requirements.txt
+    $ python -m samples.flexbot
+    ```
 
-    `$ export SLACK_USER_TOKEN_STRING=YOURUSERTOKEN`
-
-    `$ export SLACK_URL_TOKEN_STRING=YOURURLTOKEN`
-
-    If you need help with this, try adapting the first 5 steps of the guide to [edit your .bash_profile](http://natelandau.com/my-mac-osx-bash_profile/)
-
-7. Set up channel and customize configurations
+    Run the script to start the workouts and hit ctrl+\ to stop the script. Hope you have fun with it!
 
-    Open `default.json` and set `teamDomain` (ex: ctrlla) `channelName` (ex: general) and `channelId` (ex: B22D35YMS). Save the file as `config.json` in the same directory. Set any other configurations as you like.
+# Docker usage
 
-    If you don't know the channel Id, fetch it using
+Alternatively to running the source directly, my [Docker hub page for flexbot](https://hub.docker.com/r/yucht/flexbot/) is linked to the current version on the `hackathon` branch. This should simplify the setup substantially. In order to run this docker container, you need to bind mount the configuration and logging configuration into the `/flexbot/configuration` directory in the container. Additionally, you'll need to set up the port mapping for whatever port you have specified the web server to run on.
 
-    `$ python fetchChannelId.py channelname`
+1. Run `docker pull yucht/flexbot:latest` to get the most recent version from the registry.
+2. Run 
 
-8. If you haven't set up pip for python, go in your terminal and run.
-`$ sudo easy_install pip`
+   ```
+   docker run -v <config_file>:/flexbot/configuration/config.yaml \
+       -v <logging_config_file>:/flexbot/configuration/logging.yaml \
+       -d -p 80:80 -t yucht/flexbot:latest
+   ```
 
-9. While in the project directory, run
+   where <config_file> is your flexbot configuration and <logging_config_file> is your logging
+   configuration to start running flexbot.
 
-    `$ sudo pip install -r requirements.txt`
+To ease development, this docker container also exposes port 8080, so if you want to run a development version for testing and a production version simultaneously, you can simply bring up your webserver on port 8080 and run a production container and a development one simultaneously.
 
-    `$ python slackbotExercise.py`
+# Usage
 
-Run the script to start the workouts and hit ctrl+c to stop the script. Hope you have fun with it!
+Currently, you can specify two configuration files, one which controls the behavior of slackbot, and the other which controls the behavior of the loggers in slackbot. The `samples.flexbot` module currently defaults to using `config.yaml` and `logging.yaml` in the current working directory, but you can specify alternate configuration files by using `--config` and `--logging-config` respectively. Slackbot can read both YAML and JSON files for the configuration files and exercise files.

exercises/calf_raises.yaml

@@ -0,0 +1,15 @@
+name: calf raises
+min_reps: 20
+max_reps: 30
+units: rep
+info: |
+  *How to do calf raises:*
+  - Stand on the edge of a step, or, if you have a step-aerobics platform, place two sets of risers underneath the platform.
+  - Stand tall with your abdominals pulled in, the balls of your feet firmly planted on the step, and your heels hanging over the edge.
+  - Rest your hands against a wall or a sturdy object for balance.
+  - Raise your heels a few inches above the edge of the step so that you're on your tiptoes.
+  - Hold the position for a moment, and then lower your heels below the platform, feeling a stretch in your calf muscles.
+
+  *Tips for doing the calf raise*
+  - Lift as high as you can onto your toes and lower your heels down as much as your ankle flexibility allows.
+  - Push evenly through the entire width of your foot. Don't push off from your big toe or the outside edge of your feet.

exercises/chair_dips.yaml

@@ -0,0 +1,14 @@
+name: chair dips
+min_reps: 15
+max_reps: 30
+units: rep
+info: |
+  *How to do chair dips:*
+  For this workout, all you need is a elevated surface that's approximately knee high, such as a bench press, a stable chair (hence the alternative name chair dips), or a park bench. Prior to starting this exercise, it's advised to stretch for push-ups. Lets get started!
+
+  - The easiest way to perform bench dips is to begin in the most obvious position. While seated on the edge your chair, place both hands by your side right next to your thighs and clasp the edge of the seat. Using your arms, push your butt up off the chair whilst maintaining a firm grip. With your arms fully extended and your butt off the chair, extend your legs directly in front of you so that your knees are no longer bent. This will be your starting position.
+  - Lower yourself by bending your elbows until your triceps and forearms are perpendicular to each other (90 degrees). Make sure your feet aren't sliding and let your hips "hang".
+  - Using your triceps, lift yourself back to the starting position. (See Step 1).
+  - Repeat the above sequence for the desired amount of repetitions.
+
+  Once you've become familiar with the normal bench dips and you're up for a challenge, you can progress to bench dips with elevated legs. This variation puts a lot more stress on the triceps and as a result, works your muscles harder.

exercises/planks.yaml

@@ -0,0 +1,16 @@
+name: planks
+min_reps: 40
+max_reps: 60
+units: second
+info: |
+  *How to do planks*
+  - Get in the pushup position, only put your forearms on the ground instead of your hands. Your elbows should line up directly underneath your shoulders. Toes on the ground.
+  - Squeeze your glutes and tighten your abdominals.
+  - Keep a neutral neck and spine.
+  - Create a straight, strong line from head to toes - a plank, if you will.
+  - Hold that position until the time is up!
+
+  *Things to Remember:*
+  - Don't let your hips sag down to the ground. Sagging hips makes the exercise initially easier, but it's not a plank and it defeats the purpose of the exercise.
+  - Look down at the ground. This is a good prompt for maintaining a neutral neck position.
+  - When your form begins to suffer, pull the plug. You're only benefiting from the plank by actually doing the plank.

exercises/pushups.yaml

@@ -0,0 +1,28 @@
+name: pushups
+min_reps: 15
+max_reps: 20
+units: rep
+info: |
+  *How to set up for a proper push up*
+
+  When it comes to push ups, your form is crucial. Each push up needs to be done perfectly so that your total reps measured from workout to workout are on equal footing. If you did thirty perfect push ups two days ago, and then today you did sixty push ups by only going down halfway, sticking your ass up in the air, etc., it's absolutely impossible to tell if you got any stronger.
+
+  Here's how to get set up to do a push up:
+
+  - When down on the ground, set your hands at a distance that is slightly wider than shoulder-width apart. Your hands should not be rotated: this reduces the ability to generate torque and increases the chance of improper elbow/wrist alignment, which in turn might lead to injury.
+  - Your feet should be set up in a way that feels right and comfortable to you. For some, that might be shoulder width apart. For others, it might be that the feet are touching.  Generally speaking, the wider apart your feet, the more stable you'll be for your push ups.
+  - Think of your body as one giant straight line - from the top of your head down through your heels. Your butt shouldn't be sticking way up in the air or sagging.
+  - If you have a problem getting the proper form with your body, try this (yes I'm serious): clench your butt, and then tighten your abs. Your core will be engaged, and your body should be in that straight line. If you've been doing push ups incorrectly, this might be a big change for you.
+  - Your head should be looking slightly ahead of you, not straight down (yeah I know I'm looking straight down in my top picture, I hadn't started yet!). I read somewhere that said "if you're doing them right, your chin should be the first part of your head to touch the floor, not your nose." Looking up helps you keep your body in line, but feel free to look down if that helps you concentrate more.
+  - At the top of your push up, your arms should be straight and supporting your weight. You're now ready to do a push up.
+
+  *How to complete a push up*
+
+  Alright, now that you're actually all set up and eager to begin, let's get you through one repetition. Remember that good form is crucial, so keep your focus through each movement and start to set good habits.
+
+  Here's how to complete one repetition of a push up:
+
+  - With your arms straight, butt clenched, and abs braced, steadily lower yourself until your elbows are at a 90 degree angle or smaller. Depending on your level of experience, age, and flexibility, 90 degrees might be the lowest you're able to go. Personally, I like to go down until my chest (not my face), hits the floor.  That way, I know I'm going the same distance each and every time.
+  - Try not to let your elbows go flying way out with each repetition. Keep them relatively close to your body, and keep note of when they start to fly out when you get tired.
+  - Once your chest touches the floor (or your arms go down to a 90 degree angle), pause slightly and then explode back up until you're back in the same position.
+  - Congratulations, you just did a proper push up. Do as many as you can until you start to feel your form slip (even slightly); you are done for that set. Ten good push ups and 5 crappy ones are tough to quantify against eleven good push ups. If you can only do ten of something, write down your results and aim for 11 next time. Perfect form allows you to keep track of your improvements week over week.

exercises/wall_sit.yaml

@@ -0,0 +1,10 @@
+name: wall sit
+min_reps: 40
+max_reps: 50
+units: second
+info: |
+  *How to do wall sits:*
+  - Stand with your back against a wall, placing your feet about two feet out in front of you. Feet should be hip-distance apart.
+  - Bending your knees, slide your back down the wall until your knees are at 90 degree angles. Your knee joints should be over your ankle joints, so you may need to inch your feet further from the wall to create proper alignment. Your thighs should remain parallel.
+  - Hold for the specified duration.
+  - To make this move more challenging, alternate between lifting your left heel for a few seconds and then your right. This helps to target your calves.