README.md

Github Event Server

Note: This project is under construction and not ready for use.

Sinatra application used to processing events posted by Github Web-hooks.

Built for specific purpose of receiving 'push' events from Github, and then running a static site build process on the same server, likely via a shell script with SUID execution bit.

Configuration

• Dependencies / configuration in environment.rb
• Controller in application.rb
• Models auto-loaded from lib directory
• Environment variables defined in .env

Testing

See Testing

Getting Started

You can run the Sinatra app using rackup or run it using Foreman:

bundle install
bundle exec foreman start

Console

Use rake console to open IRB with the environment loaded.

Resources

• Github
  • Github Web-hooks
  • Github Event Types
• Ruby / Rack
  • How to use Bundler with Ruby
  • Rack Request
• Sinatra
  • Sinatra Configuration
  • Sinatra Logging
  • Sinatra Applications with Rspec
  • A Simple Sinatra App to Receive Github Webhook Payload
  • sinatra-template provides example Sinatra app with Rspec tests
  • Sinatra App with Rspec
• Misc
  • PipeDream - HTTP request capture

Deployment

This application to deployed to production using Capistrano, with primary configuration in config/deploy.rb.

# View Capistrano tasks
bundle exec cap -T

# Deploy update to production
bundle exec cap production deploy