first commit

Author: kwangchin

CHANGELOG

@@ -0,0 +1,6 @@
+GitHubHook ChangeLog
+====================
+
+Version 1.0, 22 March, 2012
+---------------------------
+Initial Release

LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Chin Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,59 @@
+## GitHub Post-Receive Deployment Hook
+
+Deploying applications to development, staging and production never been so easy with GitHub Post-Receive Deployment Hook script!
+
+### Installation
+
+Clone the script:
+
+<pre><code>$ <strong>git clone https://github.com/kwangchin/GitHubHook.git</strong>
+</code></pre>
+
+Go to your `GitHub repo` &gt; `Admin` &gt; `Service Hooks`, select `Post-Receive URLS` and enter your hook URL like this:
+
+![GitHub Post-Receive URLs](http://s3.kcblog.net/images/GitHubHook-01.png)
+
+### How It Works
+
+GitHub provides [Post-Receive Hooks](http://help.github.com/post-receive-hooks/) to allow HTTP callback with a HTTP Post. We then create a script for the callback to deploy the systems automatically.
+
+You will need to create branches like `stage` and `prod` in Git before proceeding into the configurations.
+
+You then can have a brief look into `hook.php`, a WebHook example provided for you to experience how simple the configurations are.
+
+<pre><code>&lt;?php
+require_once('class.GitHubHook.php');
+
+// Initiate the GitHub Deployment Hook
+$hook = new GitHubHook;
+
+// Enable the debug log, kindly make `log/hook.log` writable
+$hook-&gt;enableDebug();
+
+// Adding `stage` branch to deploy for `staging` to path `/var/www/testhook/stage`
+$hook-&gt;addBranch('stage', 'staging', '/var/www/stage');
+
+// Adding `prod` branch to deploy for `production` to path `/var/www/testhook/prod`
+$hook-&gt;addBranch('prod', 'production', '/var/www/prod', array('user@gmail.com'));
+
+// Deploy the commits
+$hook-&gt;deploy();
+</code></pre>
+
+In this example, we enabled the debug log for messages with timestamp. You can disable this by commenting or removing the line `$hook->enableDebug()`
+
+We have a staging site and a production site in this example. You can add more branches easily with `$hook->addBranch()` method if you have more systems to deploy.
+
+We then use `$hook->deploy()` to deploy the systems.
+
+## 
+
+### Security
+
+Worry about securities? We have enabled IP check to allow only GitHub hook addresses: `207.97.227.253`, `50.57.128.197` to deploy the systems. We also return a `404 Not Found` page when there is illegal access to the hook script.
+
+For better security, try hiding this hook script in deep directories like `http://www.example.com/let/us/play/hide/and/seek/` and/or renaming the `hook.php` file into `a40b6cf7a5.php`.
+
+### For Developers
+
+We are trying to make developers life easier. Kindly fork this on GitHub and submit your pull requests to help us.

class.GitHubHook.php

@@ -0,0 +1,107 @@
+<?php
+error_reporting(0);
+
+/**
+ * GitHub Post-Receive Deployment Hook.
+ * 
+ * @author Chin Lee <kwangchin@gmail.com>
+ * @copyright Copyright (C) 2012 Chin Lee
+ * @license http://www.opensource.org/licenses/mit-license.php The MIT License
+ * @version 1.0
+ */
+
+class GitHubHook
+{
+  /**
+   * @var string Remote IP of the person.
+   * @since 1.0
+   */
+  private $_remoteIp = '';
+  
+  /**
+   * @var object Payload from GitHub.
+   * @since 1.0
+   */
+  private $_payload = '';
+  
+  /**
+   * @var boolean Log debug messages.
+   * @since 1.0
+   */
+  private $_debug = FALSE;
+  
+  /**
+   * @var array Branches.
+   * @since 1.0
+   */
+  private $_branches = array();
+  
+  
+  
+  /**
+   * Constructor.
+   * @since 1.0
+   */
+  function __construct() {
+    $this->_remoteIp = $_SERVER['REMOTE_ADDR'];
+    
+    if (isset($_POST['payload'])) {
+      $this->_payload  = json_decode($_POST['payload']);
+    } else {
+      header('HTTP/1.1 404 Not Found');
+      echo '404 Not Found.';
+      exit;
+    }
+  }
+  
+  /**
+   * Enable log of debug messages.
+   * @since 1.0
+   */
+  public function enableDebug() {
+    $this->_debug = TRUE;
+  }
+  
+  /**
+   * Add a branch.
+   * @param string $name Branch name, defaults to 'master'.
+   * @param string $title Branch title, defaults to 'development'.
+   * @param string $path Relative path to development directory, defaults to '/var/www/'.
+   * @param array $author Contains authorized users' email addresses, defaults to everyone.
+   * @since 1.0
+   */
+  public function addBranch($name = 'master', $title = 'development', $path = '/var/www/', $author = array()) {
+    $this->_branches[] = array(
+      'name'   => $name,
+      'title'  => $title,
+      'path'   => $path,
+      'author' => $author
+    );
+  }
+  
+  /**
+   * Log a message.
+   * @param string $message Message to log.
+   * @since 1.0
+   */
+  public function log($message) {
+    if ($this->_debug) {
+      file_put_contents('log/hook.log', '[' . date('Y-m-d H:i:s') . '] - ' . $message . PHP_EOL, FILE_APPEND);
+    }
+  }
+  
+  /**
+   * Deploys.
+   * @since 1.0
+   */
+  public function deploy() {
+    if ($this->_remoteIp == '207.97.227.253' || $this->_remoteIp == '50.57.128.197') {
+      foreach ($this->_branches as $branch) {
+        if ($this->_payload->ref == 'refs/heads/' . $branch['name']) {
+          $this->log('Deploying to ' . $branch['title'] . ' server');
+          shell_exec('./deploy.sh ' . $branch['path'] . ' ' . $branch['name']);
+        }
+      }
+    }
+  }
+}

deploy.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+cd $1
+git pull origin $2

hook.php

@@ -0,0 +1,17 @@
+<?php
+require_once('class.GitHubHook.php');
+
+// Initiate the GitHub Deployment Hook
+$hook = new GitHubHook;
+
+// Enable the debug log, kindly make `log/hook.log` writable
+$hook->enableDebug();
+
+// Adding `stage` branch to deploy for `staging` to path `/var/www/testhook/stage`
+$hook->addBranch('stage', 'staging', '/var/www/stage');
+
+// Adding `prod` branch to deploy for `production` to path `/var/www/testhook/prod` limiting to only `user@gmail.com`
+$hook->addBranch('prod', 'production', '/var/www/prod', array('user@gmail.com'));
+
+// Deploy the commits
+$hook->deploy();