Added web hooks functionality

This commit includes:

 * Projects can have zero or more WebHooks.
 * The PostReceive job will ask a project to execute any web hooks defined for that project.
 * WebHook has a URL, we post Github-compatible JSON to that URL.
 * Failure to execute a WebHook will be silently ignored.

Gemfile

@@ -24,6 +24,7 @@ gem "acts-as-taggable-on", "~> 2.1.0"
 gem "drapper"
 gem "rchardet19", "~> 1.3.5"
 gem "resque"
+gem "httparty"
 
 group :assets do
   gem "sass-rails",   "~> 3.1.0"
@@ -48,6 +49,7 @@ group :development, :test do
   gem "awesome_print"
   gem "database_cleaner"
   gem "launchy"
+  gem "webmock"
 end
 
 group :test do

Gemfile.lock

@@ -87,6 +87,7 @@ GEM
       execjs
     coffee-script-source (1.1.3)
     columnize (0.3.4)
+    crack (0.3.1)
     daemons (1.1.4)
     database_cleaner (0.7.0)
     devise (1.5.0)
@@ -111,6 +112,9 @@ GEM
       railties (~> 3.0)
     hashery (1.4.0)
     hike (1.2.1)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
     i18n (0.6.0)
     jquery-rails (1.0.17)
       railties (~> 3.0)
@@ -132,6 +136,7 @@ GEM
       treetop (~> 1.4.8)
     mime-types (1.17.2)
     multi_json (1.0.3)
+    multi_xml (0.4.1)
     nokogiri (1.5.0)
     orm_adapter (0.0.5)
     polyglot (0.3.3)
@@ -262,6 +267,9 @@ GEM
       rack (>= 1.0.0)
     warden (1.1.0)
       rack (>= 1.0)
+    webmock (1.7.8)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
     xpath (0.1.4)
       nokogiri (~> 1.3)
 
@@ -286,6 +294,7 @@ DEPENDENCIES
   gitolite!
   grit!
   haml-rails
+  httparty
   jquery-rails
   kaminari
   launchy
@@ -309,3 +318,4 @@ DEPENDENCIES
   thin
   turn
   uglifier
+  webmock

app/models/project.rb

@@ -14,6 +14,7 @@ class Project < ActiveRecord::Base
   has_many :users, :through => :users_projects
   has_many :notes, :dependent => :destroy
   has_many :snippets, :dependent => :destroy
+  has_many :web_hooks, :dependent => :destroy
 
   acts_as_taggable
 
@@ -79,12 +80,53 @@ class Project < ActiveRecord::Base
     :heads,
     :commits_since,
     :fresh_commits,
+    :commits_between,
     :to => :repository, :prefix => nil
 
   def to_param
     code
   end
 
+  def web_url
+    [GIT_HOST['host'], code].join("/")
+  end
+
+  def execute_web_hooks(oldrev, newrev, ref)
+    data = web_hook_data(oldrev, newrev, ref)
+    web_hooks.each { |web_hook| web_hook.execute(data) }
+  end
+
+  def web_hook_data(oldrev, newrev, ref)
+    data = {
+      before: oldrev,
+      after: newrev,
+      ref: ref,
+      repository: {
+        name: name,
+        url: web_url,
+        description: description,
+        homepage: web_url,
+        private: private?
+      },
+      commits: []
+    }
+
+    commits_between(oldrev, newrev).each do |commit|
+      data[:commits] << {
+        id: commit.id,
+        message: commit.safe_message,
+        timestamp: commit.date.xmlschema,
+        url: "http://#{GIT_HOST['host']}/#{code}/commits/#{commit.id}",
+        author: {
+          name: commit.author_name,
+          email: commit.author_email
+        }
+      }
+    end
+
+    data
+  end
+
   def team_member_by_name_or_email(email = nil, name = nil)
     user = users.where("email like ? or name like ?", email, name).first
     users_projects.find_by_user_id(user.id) if user
@@ -157,7 +199,7 @@ class Project < ActiveRecord::Base
     @admins ||= users_projects.includes(:user).where(:project_access => PROJECT_RWA).map(&:user)
   end
 
-  def root_ref 
+  def root_ref
     default_branch || "master"
   end
 

app/models/repository.rb

@@ -133,4 +133,8 @@ class Repository
       repo.commits(ref)
     end.map{ |c| Commit.new(c) } 
   end
+
+  def commits_between(from, to)
+    repo.commits_between(from, to).map { |c| Commit.new(c) }
+  end
 end

app/models/web_hook.rb

+class WebHook < ActiveRecord::Base
+  include HTTParty
+
+  # HTTParty timeout
+  default_timeout 10
+
+  belongs_to :project
+
+  validates :url,
+            presence: true,
+            format: {
+              with: /(^$)|(^(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?$)/ix,
+              message: "should be a valid url" }
+
+  def execute(data)
+    WebHook.post(url, body: data.to_json)
+  rescue
+    # There was a problem calling this web hook, let's forget about it.
+  end
+end

app/workers/post_receive.rb

 class PostReceive
   def self.perform(reponame, oldrev, newrev, ref)
-    puts "[#{reponame}] #{oldrev} => #{newrev} (#{ref})"
+    project = Project.find_by_path(reponame)
+    return false if project.nil?
+
+    project.execute_web_hooks(oldrev, newrev, ref)
   end
 end

db/migrate/20111214091851_create_web_hooks.rb

+class CreateWebHooks < ActiveRecord::Migration
+  def change
+    create_table :web_hooks do |t|
+      t.string :url
+      t.integer :project_id
+      t.timestamps
+    end
+  end
+end

db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20111207211728) do
+ActiveRecord::Schema.define(:version => 20111214091851) do
 
   create_table "issues", :force => true do |t|
     t.string   "title"
@@ -132,4 +132,18 @@ ActiveRecord::Schema.define(:version => 20111207211728) do
     t.integer  "project_access", :default => 0, :null => false
   end
 
+  create_table "web_hook_urls", :force => true do |t|
+    t.string   "url"
+    t.integer  "project_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "web_hooks", :force => true do |t|
+    t.string   "url"
+    t.integer  "project_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
 end

spec/factories.rb

@@ -54,3 +54,7 @@ Factory.add(:key, Key) do |obj|
   obj.title = "Example key"
   obj.key = File.read(File.join(Rails.root, "db", "pkey.example"))
 end
+
+Factory.add(:web_hook, WebHook) do |obj|
+  obj.url = Faker::Internet.url
+end

spec/models/project_spec.rb

@@ -7,6 +7,7 @@ describe Project do
     it { should have_many(:issues) }
     it { should have_many(:notes) }
     it { should have_many(:snippets) }
+    it { should have_many(:web_hooks).dependent(:destroy) }
   end
 
   describe "Validation" do
@@ -33,6 +34,7 @@ describe Project do
     it { should respond_to(:repo) }
     it { should respond_to(:tags) }
     it { should respond_to(:commit) }
+    it { should respond_to(:commits_between) }
   end
 
   it "should not allow 'gitolite-admin' as repo name" do
@@ -50,6 +52,11 @@ describe Project do
     project.path_to_repo.should == File.join(Rails.root, "tmp", "tests", "somewhere")
   end
 
+  it "returns the full web URL for this repo" do
+    project = Project.new(:code => "somewhere")
+    project.web_url.should == "#{GIT_HOST['host']}/somewhere"
+  end
+
   describe :valid_repo? do
     it "should be valid repo" do
       project = Factory :project
@@ -62,6 +69,85 @@ describe Project do
     end
   end
 
+  describe "web hooks" do
+    let(:project) { Factory :project }
+
+    context "with no web hooks" do
+      it "raises no errors" do
+        lambda {
+          project.execute_web_hooks('oldrev', 'newrev', 'ref')
+        }.should_not raise_error
+      end
+    end
+
+    context "with web hooks" do
+      before do
+        @webhook = Factory(:web_hook)
+        @webhook_2 = Factory(:web_hook)
+        project.web_hooks << [@webhook, @webhook_2]
+      end
+
+      it "executes multiple web hook" do
+        @webhook.should_receive(:execute).once
+        @webhook_2.should_receive(:execute).once
+
+        project.execute_web_hooks('oldrev', 'newrev', 'ref')
+      end
+    end
+
+    context "when gathering commit data" do
+      before do
+        @oldrev, @newrev, @ref = project.fresh_commits(2).last.sha, project.fresh_commits(2).first.sha, 'refs/heads/master'
+        @commit = project.fresh_commits(2).first
+
+        # Fill nil/empty attributes
+        project.description = "This is a description"
+
+        @data = project.web_hook_data(@oldrev, @newrev, @ref)
+      end
+
+      subject { @data }
+
+      it { should include(before: @oldrev) }
+      it { should include(after: @newrev) }
+      it { should include(ref: @ref) }
+
+      context "with repository data" do
+        subject { @data[:repository] }
+
+        it { should include(name: project.name) }
+        it { should include(url: project.web_url) }
+        it { should include(description: project.description) }
+        it { should include(homepage: project.web_url) }
+        it { should include(private: project.private?) }
+      end
+
+      context "with commits" do
+        subject { @data[:commits] }
+
+        it { should be_an(Array) }
+        it { should have(1).element }
+
+        context "the commit" do
+          subject { @data[:commits].first }
+
+          it { should include(id: @commit.id) }
+          it { should include(message: @commit.safe_message) }
+          it { should include(timestamp: @commit.date.xmlschema) }
+          it { should include(url: "http://localhost/#{project.code}/commits/#{@commit.id}") }
+
+          context "with a author" do
+            subject { @data[:commits].first[:author] }
+
+            it { should include(name: @commit.author_name) }
+            it { should include(email: @commit.author_email) }
+          end
+        end
+      end
+
+    end
+  end
+
   describe "updates" do
     let(:project) { Factory :project }
 
@@ -107,6 +193,21 @@ describe Project do
     it { project.fresh_commits.last.id.should == "0dac878dbfe0b9c6104a87d65fe999149a8d862c" }
   end
 
+  describe "commits_between" do
+    let(:project) { Factory :project }
+
+    subject do
+      commits = project.commits_between("a6d1d4aca0c85816ddfd27d93773f43a31395033",
+                                        "2fb376f61875b58bceee0492e270e9c805294b1a")
+      commits.map { |c| c.id }
+    end
+
+    it { should have(2).elements }
+    it { should include("2fb376f61875b58bceee0492e270e9c805294b1a") }
+    it { should include("4571e226fbcd7be1af16e9fa1e13b7ac003bebdf") }
+    it { should_not include("a6d1d4aca0c85816ddfd27d93773f43a31395033") }
+  end
+
   describe "Git methods" do
     let(:project) { Factory :project }
 

spec/models/web_hook_spec.rb

+require 'spec_helper'
+
+describe WebHook do
+  describe "Associations" do
+    it { should belong_to :project }
+  end
+
+  describe "Validations" do
+    it { should validate_presence_of(:url) }
+
+    context "url format" do
+      it { should allow_value("http://example.com").for(:url) }
+      it { should allow_value("https://excample.com").for(:url) }
+      it { should allow_value("http://test.com/api").for(:url) }
+      it { should allow_value("http://test.com/api?key=abc").for(:url) }
+      it { should allow_value("http://test.com/api?key=abc&type=def").for(:url) }
+
+      it { should_not allow_value("example.com").for(:url) }
+      it { should_not allow_value("ftp://example.com").for(:url) }
+      it { should_not allow_value("herp-and-derp").for(:url) }
+    end
+  end
+
+  describe "execute" do
+    before(:each) do
+      @webhook = Factory :web_hook
+      @project = Factory :project
+      @project.web_hooks << [@webhook]
+      @data = { before: 'oldrev', after: 'newrev', ref: 'ref'}
+
+      WebMock.stub_request(:post, @webhook.url)
+    end
+
+    it "POSTs to the web hook URL" do
+      @webhook.execute(@data)
+      WebMock.should have_requested(:post, @webhook.url).once
+    end
+
+    it "POSTs the data as JSON" do
+      json = @data.to_json
+
+      @webhook.execute(@data)
+      WebMock.should have_requested(:post, @webhook.url).with(body: json).once
+    end
+
+    it "catches exceptions" do
+      WebHook.should_receive(:post).and_raise("Some HTTP Post error")
+
+      lambda {
+        @webhook.execute(@data)
+      }.should_not raise_error
+    end
+  end
+end

spec/requests/projects_tree_perfomance_spec.rb

@@ -9,7 +9,6 @@ describe "Projects" do
       before do
         @project = Factory :project
         @project.add_access(@user, :read)
-
       end
 
       it "should be fast" do

spec/spec_helper.rb

@@ -8,6 +8,7 @@ require 'rspec/rails'
 require 'capybara/rails'
 require 'capybara/rspec'
 require 'capybara/dsl'
+require 'webmock/rspec'
 require 'factories'
 require 'monkeypatch'
 
@@ -48,6 +49,8 @@ RSpec.configure do |config|
     end
 
     DatabaseCleaner.start
+
+    WebMock.disable_net_connect!(allow_localhost: true)
   end
 
   config.after do

spec/workers/post_receive_spec.rb

+require 'spec_helper'
+
+describe PostReceive do
+
+  context "as a resque worker" do
+    it "reponds to #perform" do
+      PostReceive.should respond_to(:perform)
+    end
+  end
+
+  context "web hooks" do
+    let(:project) { Factory :project }
+
+    it "it retrieves the correct project" do
+      Project.should_receive(:find_by_path).with(project.path)
+      PostReceive.perform(project.path, 'sha-old', 'sha-new', 'refs/heads/master')
+    end
+
+    it "asks the project to execute web hooks" do
+      Project.stub(find_by_path: project)
+      project.should_receive(:execute_web_hooks).with('sha-old', 'sha-new', 'refs/heads/master')
+
+      PostReceive.perform(project.path, 'sha-old', 'sha-new', 'refs/heads/master')
+    end
+  end
+end