Pull Request Notifier

WARNING! This project is not maintained anymore.

You want to follow some pull requests and get notified when they are merged? Here is a GitHub Pull Request Notifier!

• Sign in with your GitHub account
• Paste the URL of the pull request you want to follow
• Get a daily mail with a list of the pull requests that have been merged

A sample Rails app

This is a sample Rails app for the Gemnasium workshop at dotRB2013.

Warning! This app has been written for the workshop and is not production-ready!

Requirements

The app is known to work with:

• ruby 1.9.3
• bundler 1.3.5
• postgresql 9.1
• redis 2.2

Here are the packages you need to make it run on ubuntu 12.04 "precise":

sudo apt-get install ruby1.9.1 \
  ruby1.9.1-dev build-essential \
  libpq-dev libv8-dev libsqlite3-dev \
  postgresql-9.1 postgresql-contrib-9.1 postgresql-client-9.1 \
  redis-server

Remember that ruby1.9.1 ubuntu package contains ruby 1.9.3.

You then need to install bundler:

sudo gem install bundler

Install

1. clone this project
2. run bundle install
3. setup the database
4. configure the mailer
5. export GitHub client credentials
6. run the ./start script

ActionMailer is used to send emails to the users, so you may have to set config.action_mailer in your config/environments/development.rb and config/environments/production.rb config files.

When in development mode, we suggest you deliver the emails using mailtrap.io:

1. create a mailtrap account
2. create a mailtrap inbox for this rails app
3. setup mailtrap SMTP delivery in development.rb config file

Go to gemnasium/dotrb2013-docker if you want to install with docker.

GitHub application

You need credentials for your GitHub client:

1. go to the GitHub applications settings
2. register your application with name, homepage and callback URL
3. export your credentials

If your homepage URL is http://localhost:3000/, then the callback URL must be set to http://localhost:3000/auth/github/callback.

Export your credentials:

GITHUB_CLIENT_ID="1337"
GITHUB_CLIENT_SECRET="secret"

export GITHUB_CLIENT_ID
export GITHUB_CLIENT_SECRET

rails server

The app also looks for a .env file when running in development environment.

Usage

Normal user

1. visit the root URL
2. sign in using GitHub
3. manage your subscriptions

There is no sign up: user account is automatically created from GitHub account.

Admin interface

• /admin for activeadmin
• /admin/resque for resque-web

Default admin user

• login is admin@example.com
• password is password

How it works

Data model:

• User: a normal user, comes from GitHub
• PullRequest - mirrors GitHub Pull Request object
• Subscription - relation b/w a user and a pull request she watches
• Notification - relation b/w a merged pull request and a user that will be notified about it
• AdminUser - to access the admin interface only, not bound to GitHub, works with the devise gem

Resque elementary jobs:

• connect to GitHub and fetch pull request metadata: title, body, etc.
• connect to GitHub and update the "merged" status
• notify one user about the pull requests that have been merged

Resque scheduled jobs (every day):

• update all the open pull requests
• notify all the users

Licence

MIT Licence.