Event entity created

Observe issue, merge request, note creation - create event register push event

Event entity created
Observe issue, merge request, note creation - create event register push event
Dmitriy Zaporozhets
1 parent 85954621
Showing 16 changed files with 310 additions and 104 deletions Show diff stats
app/models/activity_observer.rb
app/models/event.rb
app/models/project.rb
app/models/users_project.rb
app/models/wiki.rb
app/workers/post_receive.rb
config/application.rb
db/migrate/20120228130210_create_events.rb
db/migrate/20120228134252_add_action_to_event.rb
db/schema.rb
spec/factories.rb
spec/models/activity_observer_spec.rb
spec/models/event_spec.rb
spec/models/project_hooks_spec.rb
spec/models/project_spec.rb
spec/models/users_project_spec.rb
@@ -0,0 +1,12 @@
+class ActivityObserver < ActiveRecord::Observer
+  observe :issue, :merge_request, :note
+
+  def after_create(record)
+    Event.create(
+      :project => record.project,
+      :target_id => record.id,
+      :target_type => record.class.name,
+      :action => Event.determine_action(record)
+    )
+  end
+end
@@ -0,0 +1,36 @@
+class Event < ActiveRecord::Base
+  Created   = 1
+  Updated   = 2
+  Closed    = 3
+  Reopened  = 4
+  Pushed    = 5
+  Commented = 6
+
+  belongs_to :project
+  belongs_to :target, :polymorphic => true
+
+  serialize :data
+
+  def self.determine_action(record)
+    if [Issue, MergeRequest].include? record.class
+      Event::Created
+    elsif record.kind_of? Note
+      Event::Commented
+    end
+  end
+end
+# == Schema Information
+#
+# Table name: events
+#
+#  id          :integer         not null, primary key
+#  target_type :string(255)
+#  target_id   :integer
+#  title       :string(255)
+#  data        :text
+#  project_id  :integer
+#  created_at  :datetime        not null
+#  updated_at  :datetime        not null
+#  action      :integer
+#
+
@@ -3,6 +3,7 @@ require &quot;grit&quot;
 class Project < ActiveRecord::Base
   belongs_to :owner, :class_name => "User"
+  has_many :events, :dependent => :destroy
   has_many :merge_requests, :dependent => :destroy
   has_many :issues, :dependent => :destroy, :order => "position"
   has_many :users_projects, :dependent => :destroy
@@ -89,6 +90,16 @@ class Project &lt; ActiveRecord::Base
     [GIT_HOST['host'], code].join("/")
   end
+  def observe_push(oldrev, newrev, ref)
+    data = web_hook_data(oldrev, newrev, ref)
+
+    Event.create(
+      :project => self,
+      :action => Event::Pushed,
+      :data => data
+    )
+  end
+
   def execute_web_hooks(oldrev, newrev, ref)
     ref_parts = ref.split('/')
@@ -96,6 +107,7 @@ class Project &lt; ActiveRecord::Base
     return if ref_parts[1] !~ /heads/ || oldrev == "00000000000000000000000000000000"
     data = web_hook_data(oldrev, newrev, ref)
+
     web_hooks.each { |web_hook| web_hook.execute(data) }
   end
@@ -364,5 +376,6 @@ end
 #  issues_enabled         :boolean         default(TRUE), not null
 #  wall_enabled           :boolean         default(TRUE), not null
 #  merge_requests_enabled :boolean         default(TRUE), not null
+#  wiki_enabled           :boolean         default(TRUE), not null
 #
@@ -80,7 +80,6 @@ end
 #  project_id     :integer         not null
 #  created_at     :datetime
 #  updated_at     :datetime
-#  repo_access    :integer         default(0), not null
 #  project_access :integer         default(0), not null
 #
@@ -31,3 +31,17 @@ class Wiki &lt; ActiveRecord::Base
   end
 end
+# == Schema Information
+#
+# Table name: wikis
+#
+#  id         :integer         not null, primary key
+#  title      :string(255)
+#  content    :text
+#  project_id :integer
+#  created_at :datetime        not null
+#  updated_at :datetime        not null
+#  slug       :string(255)
+#  user_id    :integer
+#
+
@@ -5,6 +5,7 @@ class PostReceive
     project = Project.find_by_path(reponame)
     return false if project.nil?
+    project.observe_push(oldrev, newrev, ref)
     project.execute_web_hooks(oldrev, newrev, ref)
   end
 end
@@ -23,7 +23,7 @@ module Gitlab
     # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
     # Activate observers that should always be running.
-    config.active_record.observers = :mailer_observer
+    config.active_record.observers = :mailer_observer, :activity_observer
     # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
     # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
@@ -0,0 +1,14 @@
+class CreateEvents < ActiveRecord::Migration
+  def change
+    create_table :events do |t|
+      t.string :target_type, :null => true
+      t.integer :target_id, :null => true
+
+      t.string :title, :null => true
+      t.text :data, :null => true
+      t.integer :project_id, :null => true
+
+      t.timestamps
+    end
+  end
+end
@@ -0,0 +1,5 @@
+class AddActionToEvent < ActiveRecord::Migration
+  def change
+    add_column :events, :action, :integer, :null => true
+  end
+end
@@ -11,7 +11,18 @@
 #
 # It's strongly recommended to check this file into your version control system.
-ActiveRecord::Schema.define(:version => 20120219193300) do
+ActiveRecord::Schema.define(:version => 20120228134252) do
+
+  create_table "events", :force => true do |t|
+    t.string   "target_type"
+    t.integer  "target_id"
+    t.string   "title"
+    t.text     "data"
+    t.integer  "project_id"
+    t.datetime "created_at",  :null => false
+    t.datetime "updated_at",  :null => false
+    t.integer  "action"
+  end
   create_table "issues", :force => true do |t|
     t.string   "title"
@@ -32,10 +32,14 @@ end
 Factory.add(:issue, Issue) do |obj|
   obj.title = Faker::Lorem.sentence
+  obj.author = Factory :user
+  obj.assignee = Factory :user
 end
 Factory.add(:merge_request, MergeRequest) do |obj|
   obj.title = Faker::Lorem.sentence
+  obj.author = Factory :user
+  obj.assignee = Factory :user
   obj.source_branch = "master"
   obj.target_branch = "master"
   obj.closed = false
@@ -64,3 +68,8 @@ Factory.add(:wikis, WebHook) do |obj|
   obj.title = Faker::Lorem.sentence
   obj.content = Faker::Lorem.sentence
 end
+
+Factory.add(:event, Event) do |obj|
+  obj.title = Faker::Lorem.sentence
+  obj.project = Factory(:project)
+end
@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe ActivityObserver do
+  let(:project)  { Factory :project } 
+
+  def self.it_should_be_valid_event
+    it { @event.should_not be_nil }
+    it { @event.project.should == project }
+  end
+
+  describe "Merge Request created" do 
+    before do 
+      @merge_request = Factory :merge_request, :project => project
+      @event = Event.last
+    end
+
+    it_should_be_valid_event
+    it { @event.action.should == Event::Created }
+    it { @event.target.should == @merge_request }
+  end
+
+  describe "Issue created" do 
+    before do 
+      @issue = Factory :issue, :project => project
+      @event = Event.last
+    end
+
+    it_should_be_valid_event
+    it { @event.action.should == Event::Created }
+    it { @event.target.should == @issue }
+  end
+
+  describe "Issue commented" do 
+    before do 
+      @issue = Factory :issue, :project => project
+      @note = Factory :note, :noteable => @issue, :project => project
+      @event = Event.last
+    end
+
+    it_should_be_valid_event
+    it { @event.action.should == Event::Commented }
+    it { @event.target.should == @note }
+  end
+end
@@ -0,0 +1,32 @@
+# == Schema Information
+#
+# Table name: events
+#
+#  id          :integer         not null, primary key
+#  target_type :string(255)
+#  target_id   :integer
+#  title       :string(255)
+#  data        :text
+#  project_id  :integer
+#  created_at  :datetime        not null
+#  updated_at  :datetime        not null
+#  action      :integer
+#
+
+require 'spec_helper'
+
+describe Event do
+  describe "Associations" do
+    it { should belong_to(:project) }
+  end
+
+  describe "Creation" do
+    before do 
+      @event = Factory :event
+    end
+
+    it "should create a valid event" do 
+      @event.should be_valid
+    end
+  end
+end
@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe Project, "Hooks" do
+  let(:project) { Factory :project }
+
+  describe "Post Receive Event" do 
+    it "should create push event" do 
+      oldrev, newrev, ref = '00000000000000000000000000000000', 'newrev', 'refs/heads/master'
+      project.observe_push(oldrev, newrev, ref)
+      event = Event.last
+
+      event.should_not be_nil
+      event.project.should == project
+      event.action.should == Event::Pushed
+      event.data == project.web_hook_data(oldrev, newrev, ref)
+    end
+  end
+
+  describe "Web hooks" do
+    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', 'refs/heads/master')
+      end
+    end
+
+    context "does not execute web hooks" do
+      before do
+        @webhook = Factory(:web_hook)
+        project.web_hooks << [@webhook]
+      end
+
+      it "when pushing a branch for the first time" do
+        @webhook.should_not_receive(:execute)
+        project.execute_web_hooks('00000000000000000000000000000000', 'newrev', 'refs/heads/master')
+      end
+
+      it "when pushing tags" do
+        @webhook.should_not_receive(:execute)
+        project.execute_web_hooks('oldrev', 'newrev', 'refs/tags/v1.0.0')
+      end
+    end
+
+    context "when pushing new branches" do
+
+    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
+end
@@ -2,6 +2,7 @@ require &#39;spec_helper&#39;
 describe Project do
   describe "Associations" do
+    it { should have_many(:events) }
     it { should have_many(:users) }
     it { should have_many(:users_projects) }
     it { should have_many(:issues) }
@@ -69,106 +70,6 @@ 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', 'refs/heads/master')
-      end
-    end
-
-    context "does not execute web hooks" do
-      before do
-        @webhook = Factory(:web_hook)
-        project.web_hooks << [@webhook]
-      end
-
-      it "when pushing a branch for the first time" do
-        @webhook.should_not_receive(:execute)
-        project.execute_web_hooks('00000000000000000000000000000000', 'newrev', 'refs/heads/master')
-      end
-
-      it "when pushing tags" do
-        @webhook.should_not_receive(:execute)
-        project.execute_web_hooks('oldrev', 'newrev', 'refs/tags/v1.0.0')
-      end
-    end
-
-    context "when pushing new branches" do
-
-    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 }
@@ -303,5 +204,6 @@ end
 #  issues_enabled         :boolean         default(TRUE), not null
 #  wall_enabled           :boolean         default(TRUE), not null
 #  merge_requests_enabled :boolean         default(TRUE), not null
+#  wiki_enabled           :boolean         default(TRUE), not null
 #
@@ -25,7 +25,6 @@ end
 #  project_id     :integer         not null
 #  created_at     :datetime
 #  updated_at     :datetime
-#  repo_access    :integer         default(0), not null
 #  project_access :integer         default(0), not null
 #
@@ -0,0 +1,12 @@		@@ -0,0 +1,12 @@
	1	+class ActivityObserver < ActiveRecord::Observer
	2	+ observe :issue, :merge_request, :note
	3	+
	4	+ def after_create(record)
	5	+ Event.create(
	6	+ :project => record.project,
	7	+ :target_id => record.id,
	8	+ :target_type => record.class.name,
	9	+ :action => Event.determine_action(record)
	10	+ )
	11	+ end
	12	+end
@@ -0,0 +1,36 @@		@@ -0,0 +1,36 @@
	1	+class Event < ActiveRecord::Base
	2	+ Created = 1
	3	+ Updated = 2
	4	+ Closed = 3
	5	+ Reopened = 4
	6	+ Pushed = 5
	7	+ Commented = 6
	8	+
	9	+ belongs_to :project
	10	+ belongs_to :target, :polymorphic => true
	11	+
	12	+ serialize :data
	13	+
	14	+ def self.determine_action(record)
	15	+ if [Issue, MergeRequest].include? record.class
	16	+ Event::Created
	17	+ elsif record.kind_of? Note
	18	+ Event::Commented
	19	+ end
	20	+ end
	21	+end
	22	+# == Schema Information
	23	+#
	24	+# Table name: events
	25	+#
	26	+# id :integer not null, primary key
	27	+# target_type :string(255)
	28	+# target_id :integer
	29	+# title :string(255)
	30	+# data :text
	31	+# project_id :integer
	32	+# created_at :datetime not null
	33	+# updated_at :datetime not null
	34	+# action :integer
	35	+#
	36	+
	@@ -3,6 +3,7 @@ require "grit"		@@ -3,6 +3,7 @@ require "grit"
3	class Project < ActiveRecord::Base	3	class Project < ActiveRecord::Base
4	belongs_to :owner, :class_name => "User"	4	belongs_to :owner, :class_name => "User"
5		5
		6	+ has_many :events, :dependent => :destroy
6	has_many :merge_requests, :dependent => :destroy	7	has_many :merge_requests, :dependent => :destroy
7	has_many :issues, :dependent => :destroy, :order => "position"	8	has_many :issues, :dependent => :destroy, :order => "position"
8	has_many :users_projects, :dependent => :destroy	9	has_many :users_projects, :dependent => :destroy
	@@ -89,6 +90,16 @@ class Project < ActiveRecord::Base		@@ -89,6 +90,16 @@ class Project < ActiveRecord::Base
89	[GIT_HOST['host'], code].join("/")	90	[GIT_HOST['host'], code].join("/")
90	end	91	end
91		92
		93	+ def observe_push(oldrev, newrev, ref)
		94	+ data = web_hook_data(oldrev, newrev, ref)
		95	+
		96	+ Event.create(
		97	+ :project => self,
		98	+ :action => Event::Pushed,
		99	+ :data => data
		100	+ )
		101	+ end
		102	+
92	def execute_web_hooks(oldrev, newrev, ref)	103	def execute_web_hooks(oldrev, newrev, ref)
93	ref_parts = ref.split('/')	104	ref_parts = ref.split('/')
94		105
	@@ -96,6 +107,7 @@ class Project < ActiveRecord::Base		@@ -96,6 +107,7 @@ class Project < ActiveRecord::Base
96	return if ref_parts[1] !~ /heads/ \|\| oldrev == "00000000000000000000000000000000"	107	return if ref_parts[1] !~ /heads/ \|\| oldrev == "00000000000000000000000000000000"
97		108
98	data = web_hook_data(oldrev, newrev, ref)	109	data = web_hook_data(oldrev, newrev, ref)
		110	+
99	web_hooks.each { \|web_hook\| web_hook.execute(data) }	111	web_hooks.each { \|web_hook\| web_hook.execute(data) }
100	end	112	end
101		113
	@@ -364,5 +376,6 @@ end		@@ -364,5 +376,6 @@ end
364	# issues_enabled :boolean default(TRUE), not null	376	# issues_enabled :boolean default(TRUE), not null
365	# wall_enabled :boolean default(TRUE), not null	377	# wall_enabled :boolean default(TRUE), not null
366	# merge_requests_enabled :boolean default(TRUE), not null	378	# merge_requests_enabled :boolean default(TRUE), not null
		379	+# wiki_enabled :boolean default(TRUE), not null
367	#	380	#
368		381
	@@ -80,7 +80,6 @@ end		@@ -80,7 +80,6 @@ end
80	# project_id :integer not null	80	# project_id :integer not null
81	# created_at :datetime	81	# created_at :datetime
82	# updated_at :datetime	82	# updated_at :datetime
83	-# repo_access :integer default(0), not null
84	# project_access :integer default(0), not null	83	# project_access :integer default(0), not null
85	#	84	#
86		85
	@@ -31,3 +31,17 @@ class Wiki < ActiveRecord::Base		@@ -31,3 +31,17 @@ class Wiki < ActiveRecord::Base
31		31
32	end	32	end
33	end	33	end
		34	+# == Schema Information
		35	+#
		36	+# Table name: wikis
		37	+#
		38	+# id :integer not null, primary key
		39	+# title :string(255)
		40	+# content :text
		41	+# project_id :integer
		42	+# created_at :datetime not null
		43	+# updated_at :datetime not null
		44	+# slug :string(255)
		45	+# user_id :integer
		46	+#
		47	+
	@@ -5,6 +5,7 @@ class PostReceive		@@ -5,6 +5,7 @@ class PostReceive
5	project = Project.find_by_path(reponame)	5	project = Project.find_by_path(reponame)
6	return false if project.nil?	6	return false if project.nil?
7		7
		8	+ project.observe_push(oldrev, newrev, ref)
8	project.execute_web_hooks(oldrev, newrev, ref)	9	project.execute_web_hooks(oldrev, newrev, ref)
9	end	10	end
10	end	11	end
	@@ -23,7 +23,7 @@ module Gitlab		@@ -23,7 +23,7 @@ module Gitlab
23	# config.plugins = [ :exception_notification, :ssl_requirement, :all ]	23	# config.plugins = [ :exception_notification, :ssl_requirement, :all ]
24		24
25	# Activate observers that should always be running.	25	# Activate observers that should always be running.
26	- config.active_record.observers = :mailer_observer	26	+ config.active_record.observers = :mailer_observer, :activity_observer
27		27
28	# Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.	28	# Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
29	# Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.	29	# Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
@@ -0,0 +1,14 @@		@@ -0,0 +1,14 @@
	1	+class CreateEvents < ActiveRecord::Migration
	2	+ def change
	3	+ create_table :events do \|t\|
	4	+ t.string :target_type, :null => true
	5	+ t.integer :target_id, :null => true
	6	+
	7	+ t.string :title, :null => true
	8	+ t.text :data, :null => true
	9	+ t.integer :project_id, :null => true
	10	+
	11	+ t.timestamps
	12	+ end
	13	+ end
	14	+end
@@ -0,0 +1,5 @@		@@ -0,0 +1,5 @@
	1	+class AddActionToEvent < ActiveRecord::Migration
	2	+ def change
	3	+ add_column :events, :action, :integer, :null => true
	4	+ end
	5	+end
	@@ -11,7 +11,18 @@		@@ -11,7 +11,18 @@
11	#	11	#
12	# It's strongly recommended to check this file into your version control system.	12	# It's strongly recommended to check this file into your version control system.
13		13
14	-ActiveRecord::Schema.define(:version => 20120219193300) do	14	+ActiveRecord::Schema.define(:version => 20120228134252) do
		15	+
		16	+ create_table "events", :force => true do \|t\|
		17	+ t.string "target_type"
		18	+ t.integer "target_id"
		19	+ t.string "title"
		20	+ t.text "data"
		21	+ t.integer "project_id"
		22	+ t.datetime "created_at", :null => false
		23	+ t.datetime "updated_at", :null => false
		24	+ t.integer "action"
		25	+ end
15		26
16	create_table "issues", :force => true do \|t\|	27	create_table "issues", :force => true do \|t\|
17	t.string "title"	28	t.string "title"