Added Github Issues Tracker.

Nathan Broadbent
1 parent 32964b43
Showing 12 changed files with 188 additions and 4 deletions Show diff stats
Gemfile
Gemfile.lock
app/models/issue_trackers/github_tracker.rb
app/views/apps/_issue_tracker_fields.html.haml
app/views/issue_trackers/github_body.txt.erb
public/images/github_create.png
public/images/github_goto.png
public/images/github_inactive.png
public/stylesheets/application.css
spec/controllers/apps_controller_spec.rb
spec/controllers/errs_controller_spec.rb
spec/factories/issue_tracker_factories.rb
@@ -12,6 +12,7 @@ gem &#39;mongoid_rails_migrations&#39;
 gem 'useragent', '~> 0.3.1'
 gem 'pivotal-tracker'
 gem 'ruby-fogbugz', :require => 'fogbugz'
+gem 'octokit'
 gem 'inherited_resources'
 group :production do
@@ -60,10 +60,17 @@ GEM
     factory_girl_rails (1.0.1)
       factory_girl (~> 1.3)
       railties (>= 3.0.0)
+    faraday (0.6.1)
+      addressable (~> 2.2.4)
+      multipart-post (~> 1.1.0)
+      rack (>= 1.1.0, < 2)
+    faraday_middleware (0.6.5)
+      faraday (~> 0.6.0)
     haml (3.0.25)
     happymapper (0.3.2)
       libxml-ruby (~> 1.1.3)
     has_scope (0.5.1)
+    hashie (1.0.0)
     hoptoad_notifier (2.4.11)
       activesupport
       builder
@@ -96,7 +103,16 @@ GEM
       bundler (>= 0.9.19)
       rails (~> 3.0.0)
       railties (~> 3.0.0)
+    multi_json (1.0.3)
+    multipart-post (1.1.3)
     nokogiri (1.4.4)
+    octokit (0.6.3)
+      addressable (~> 2.2.4)
+      faraday (~> 0.6.0)
+      faraday_middleware (~> 0.6.0)
+      hashie (~> 1.0.0)
+      multi_json (~> 1.0.0)
+      rash (~> 0.3.0)
     orm_adapter (0.0.5)
     pivotal-tracker (0.2.0)
       builder
@@ -123,6 +139,8 @@ GEM
       rake (>= 0.8.7)
       thor (~> 0.14.4)
     rake (0.8.7)
+    rash (0.3.0)
+      hashie (~> 1.0.0)
     rbx-require-relative (0.0.5)
     responders (0.6.4)
     rest-client (1.5.1)
@@ -193,6 +211,7 @@ DEPENDENCIES
   mongoid (= 2.0.2)
   mongoid_rails_migrations
   nokogiri
+  octokit
   pivotal-tracker
   rails (= 3.0.5)
   redmine_client!
@@ -0,0 +1,20 @@
+class GithubTracker < IssueTracker
+  def self.label; "github"; end
+
+  def check_params
+    if %w(project_id username api_token ).detect {|f| self[f].blank? }
+      errors.add :base, 'You must specify your Github repository, username and API token'
+    end
+  end
+
+  def create_issue(err)
+    client = Octokit::Client.new(:login => username, :token => api_token)
+    issue = client.create_issue(project_id, issue_title(err), body_template.result(binding), options = {})
+    err.update_attribute :issue_link, issue.html_url
+  end
+
+  def body_template
+    @@body_template ||= ERB.new(File.read(Rails.root + "app/views/issue_trackers/github_body.txt.erb").gsub(/^\s*/, ''))
+  end
+end
+
@@ -6,6 +6,9 @@
         = label_tag :type_none, :for => label_for_attr(w, 'type_issuetracker'), :class => "label_radio none" do
           = w.radio_button :type, "IssueTracker", 'data-section' => 'none'
           (None)
+        = label_tag :type_github, :for => label_for_attr(w, 'type_githubtracker'), :class => "label_radio github" do
+          = w.radio_button :type, "GithubTracker", 'data-section' => 'github'
+          Github Issues
         = label_tag :type_lighthouseapp, :for => label_for_attr(w, 'type_lighthousetracker'), :class => "label_radio lighthouseapp" do
           = w.radio_button :type, "LighthouseTracker", 'data-section' => 'lighthouse'
           Lighthouse
@@ -15,7 +18,6 @@
         = label_tag :type_pivotal, :for => label_for_attr(w, 'type_pivotallabstracker'), :class => "label_radio pivotal" do
           = w.radio_button :type, "PivotalLabsTracker", 'data-section' => 'pivotal'
           Pivotal Tracker
-        %br
         = label_tag :type_fogbugz, :for => label_for_attr(w, 'type_fogbugztracker'), :class => "label_radio fogbugz" do
           = w.radio_button :type, "FogbugzTracker", 'data-section' => 'fogbugz'
           FogBugz
@@ -25,6 +27,13 @@
       %div.tracker_params.none{:class => (w.object && !(w.object.class < IssueTracker)) ? 'chosen' : nil}
         %p When no issue tracker has been configured, you will be able to leave comments on errors.
+      %div.tracker_params.github{:class => w.object.is_a?(GithubTracker) ? 'chosen' : nil}
+        = w.label :project_id, "Repository"
+        = w.text_field :project_id, :placeholder => "errbit/errbit from https://github.com/errbit/errbit"
+        = w.label :username, "Username"
+        = w.text_field :username, :placeholder => "Your username on Github"
+        = w.label :api_token, "Token"
+        = w.text_field :api_token, :placeholder => "Your API Token"
       %div.tracker_params.lighthouse{:class => w.object.is_a?(LighthouseTracker) ? 'chosen' : nil}
         = w.label :account, "Account"
         = w.text_field :account, :placeholder => "abc from abc.lighthouseapp.com"
@@ -0,0 +1,45 @@
+[See this exception on Errbit](<%= app_err_url err.app, err %> "See this exception on Errbit")
+<% if notice = err.notices.first %>
+# <%= notice.message %> #
+## Summary ##
+<% if notice.request['url'].present? %>
+  ### URL ###
+  [<%= notice.request['url'] %>](<%= notice.request['url'] %>)"
+<% end %>
+### Where ###
+<%= notice.err.where %>
+
+### Occured ###
+<%= notice.created_at.to_s(:micro) %>
+
+### Similar ###
+<%= (notice.err.notices_count - 1).to_s %>
+
+## Params ##
+```
+<%= pretty_hash(notice.params) %>
+```
+
+## Session ##
+```
+<%= pretty_hash(notice.session) %>
+```
+
+## Backtrace ##
+```
+<% for line in notice.backtrace %><%= line['number'] %>:  <%= line['file'].sub(/^\[PROJECT_ROOT\]/, '') %> -> **<%= line['method'] %>**
+<% end %>
+```
+
+## Environment ##
+
+<table>
+<% for key, val in notice.env_vars %>
+  <tr>
+    <td><%= key %>:</td>
+    <td><%= val %></td>
+  </tr>
+<% end %>
+</table>
+<% end %>
+
@@ -540,7 +540,7 @@ div.issue_tracker.nested img {
 /* Icons for Issue Tracker Radio Buttons */
 div.issue_tracker.nested label.label_radio {
-  color: #777777;
+  color: #929292;
   padding-left: 33px;
   margin-bottom: 6px;
   margin-right: 8px;
@@ -551,7 +551,7 @@ div.issue_tracker.nested .label_radio input {
 }
 div.issue_tracker.nested label.r_on {
-  color: #262626;
+  color: #191919;
 }
@@ -562,6 +562,7 @@ div.issue_tracker.nested label.lighthouseapp { background: url(/images/lighthous
 div.issue_tracker.nested label.mingle { background: url(/images/mingle_inactive.png) no-repeat; }
 div.issue_tracker.nested label.fogbugz { background: url(/images/fogbugz_inactive.png) no-repeat; }
 div.issue_tracker.nested label.pivotal { background: url(/images/pivotal_inactive.png) no-repeat; }
+div.issue_tracker.nested label.github { background: url(/images/github_inactive.png) no-repeat; }
 /* Active icons */
 div.issue_tracker.nested label.r_on.none { background: url(/images/none_create.png) no-repeat; }
 div.issue_tracker.nested label.r_on.redmine { background: url(/images/redmine_create.png) no-repeat; }
@@ -569,7 +570,7 @@ div.issue_tracker.nested label.r_on.lighthouseapp { background: url(/images/ligh
 div.issue_tracker.nested label.r_on.mingle { background: url(/images/mingle_create.png) no-repeat; }
 div.issue_tracker.nested label.r_on.fogbugz { background: url(/images/fogbugz_create.png) no-repeat; }
 div.issue_tracker.nested label.r_on.pivotal { background: url(/images/pivotal_create.png) no-repeat; }
-
+div.issue_tracker.nested label.r_on.github { background: url(/images/github_create.png) no-repeat; }
 /* Apps Table */
 table.apps tbody tr:hover td ,table.errs tbody tr:hover td { background-color: #F2F2F2;}
@@ -677,6 +678,10 @@ table.tally th.value {
   background: transparent url(/images/mingle_create.png) 6px 5px no-repeat;
 }
+#action-bar a.github_create {
+  background: transparent url(/images/github_create.png) 6px 5px no-repeat;
+}
+
 #action-bar a.lighthouseapp_goto {
   background: transparent url(/images/lighthouseapp_goto.png) 6px 5px no-repeat;
 }
@@ -697,6 +702,10 @@ table.tally th.value {
   background: transparent url(/images/mingle_goto.png) 6px 5px no-repeat;
 }
+#action-bar a.github_goto {
+  background: transparent url(/images/github_goto.png) 6px 5px no-repeat;
+}
+
 /* Notices Pagination */
 .notice-pagination {
   float: left;
@@ -402,6 +402,33 @@ describe AppsController do
           end
         end
+        context "github issues" do
+          context 'with correct params' do
+            before do
+              put :update, :id => @app.id, :app => { :issue_tracker_attributes => {
+                :type => 'GithubTracker', :project_id => 'test', :username => 'user',
+                :api_token => '123123'
+              } }
+              @app.reload
+            end
+
+            subject {@app.issue_tracker}
+            its(:type) {should == "GithubTracker"}
+            its(:project_id) {should == 'test'}
+            its(:username) {should == 'user'}
+            its(:api_token) {should == '123123'}
+          end
+
+          it "should show validation notice when sufficient params are not present" do
+            put :update, :id => @app.id, :app => { :issue_tracker_attributes => {
+                :type => 'GithubTracker', :project_id => 'test', :username => 'user'
+            } }
+            @app.reload
+
+            @app.issue_tracker_configured?.should == false
+            response.body.should match(/You must specify your Github repository, username and API token/)
+          end
+        end
       end
     end
@@ -435,3 +462,4 @@ describe AppsController do
   end
 end
+
@@ -395,6 +395,53 @@ describe ErrsController do
           err.issue_link.should == @issue_link.sub(/\.xml$/, '')
         end
       end
+
+      context "github issues tracker" do
+        let(:notice) { Factory :notice }
+        let(:tracker) { Factory :github_tracker, :app => notice.err.app }
+        let(:err) { notice.err }
+
+        before(:each) do
+          number = 5
+          @issue_link = "https://github.com/#{tracker.project_id}/issues/#{number}"
+          body = <<EOF
+{
+  "issue": {
+    "position": 1.0,
+    "number": #{number},
+    "votes": 0,
+    "created_at": "2010/01/21 13:45:59 -0800",
+    "comments": 0,
+    "body": "Test Body",
+    "title": "Test Issue",
+    "user": "test_user",
+    "state": "open",
+    "html_url": "#{@issue_link}"
+  }
+}
+EOF
+          stub_request(:post, "https://#{tracker.username}%2Ftoken:#{tracker.api_token}@github.com/api/v2/json/issues/open/#{tracker.project_id}").
+            to_return(:status => 201, :headers => {'Location' => @issue_link}, :body => body )
+
+          post :create_issue, :app_id => err.app.id, :id => err.id
+          err.reload
+        end
+
+        it "should make request to Github with err params" do
+          requested = have_requested(:post, "https://#{tracker.username}%2Ftoken:#{tracker.api_token}@github.com/api/v2/json/issues/open/#{tracker.project_id}")
+          WebMock.should requested.with(:headers => {'Content-Type' => 'application/x-www-form-urlencoded'})
+          WebMock.should requested.with(:body => /title=%5Bproduction%5D%5Bfoo%23bar%5D%20FooError%3A%20Too%20Much%20Bar/)
+          WebMock.should requested.with(:body => /See%20this%20exception%20on%20Errbit/)
+        end
+
+        it "should redirect to err page" do
+          response.should redirect_to( app_err_path(err.app, err) )
+        end
+
+        it "should create issue link for err" do
+          err.issue_link.should == @issue_link
+        end
+      end
     end
     context "absent issue tracker" do
@@ -20,3 +20,9 @@ Factory.define :mingle_tracker, :parent =&gt; :issue_tracker, :class =&gt; :mingle_tra
   e.ticket_properties 'card_type = Defect, defect_status = open, priority = essential'
 end
+Factory.define :github_tracker, :parent => :issue_tracker, :class => :github_tracker do |e|
+  e.project_id 'test_account/test_project'
+  e.username 'test_username'
+  e.api_token '12497asfa987'
+end
+
	@@ -12,6 +12,7 @@ gem 'mongoid_rails_migrations'		@@ -12,6 +12,7 @@ gem 'mongoid_rails_migrations'
12	gem 'useragent', '~> 0.3.1'	12	gem 'useragent', '~> 0.3.1'
13	gem 'pivotal-tracker'	13	gem 'pivotal-tracker'
14	gem 'ruby-fogbugz', :require => 'fogbugz'	14	gem 'ruby-fogbugz', :require => 'fogbugz'
		15	+gem 'octokit'
15	gem 'inherited_resources'	16	gem 'inherited_resources'
16		17
17	group :production do	18	group :production do
	@@ -60,10 +60,17 @@ GEM		@@ -60,10 +60,17 @@ GEM
60	factory_girl_rails (1.0.1)	60	factory_girl_rails (1.0.1)
61	factory_girl (~> 1.3)	61	factory_girl (~> 1.3)
62	railties (>= 3.0.0)	62	railties (>= 3.0.0)
		63	+ faraday (0.6.1)
		64	+ addressable (~> 2.2.4)
		65	+ multipart-post (~> 1.1.0)
		66	+ rack (>= 1.1.0, < 2)
		67	+ faraday_middleware (0.6.5)
		68	+ faraday (~> 0.6.0)
63	haml (3.0.25)	69	haml (3.0.25)
64	happymapper (0.3.2)	70	happymapper (0.3.2)
65	libxml-ruby (~> 1.1.3)	71	libxml-ruby (~> 1.1.3)
66	has_scope (0.5.1)	72	has_scope (0.5.1)
		73	+ hashie (1.0.0)
67	hoptoad_notifier (2.4.11)	74	hoptoad_notifier (2.4.11)
68	activesupport	75	activesupport
69	builder	76	builder
	@@ -96,7 +103,16 @@ GEM		@@ -96,7 +103,16 @@ GEM
96	bundler (>= 0.9.19)	103	bundler (>= 0.9.19)
97	rails (~> 3.0.0)	104	rails (~> 3.0.0)
98	railties (~> 3.0.0)	105	railties (~> 3.0.0)
		106	+ multi_json (1.0.3)
		107	+ multipart-post (1.1.3)
99	nokogiri (1.4.4)	108	nokogiri (1.4.4)
		109	+ octokit (0.6.3)
		110	+ addressable (~> 2.2.4)
		111	+ faraday (~> 0.6.0)
		112	+ faraday_middleware (~> 0.6.0)
		113	+ hashie (~> 1.0.0)
		114	+ multi_json (~> 1.0.0)
		115	+ rash (~> 0.3.0)
100	orm_adapter (0.0.5)	116	orm_adapter (0.0.5)
101	pivotal-tracker (0.2.0)	117	pivotal-tracker (0.2.0)
102	builder	118	builder
	@@ -123,6 +139,8 @@ GEM		@@ -123,6 +139,8 @@ GEM
123	rake (>= 0.8.7)	139	rake (>= 0.8.7)
124	thor (~> 0.14.4)	140	thor (~> 0.14.4)
125	rake (0.8.7)	141	rake (0.8.7)
		142	+ rash (0.3.0)
		143	+ hashie (~> 1.0.0)
126	rbx-require-relative (0.0.5)	144	rbx-require-relative (0.0.5)
127	responders (0.6.4)	145	responders (0.6.4)
128	rest-client (1.5.1)	146	rest-client (1.5.1)
	@@ -193,6 +211,7 @@ DEPENDENCIES		@@ -193,6 +211,7 @@ DEPENDENCIES
193	mongoid (= 2.0.2)	211	mongoid (= 2.0.2)
194	mongoid_rails_migrations	212	mongoid_rails_migrations
195	nokogiri	213	nokogiri
		214	+ octokit
196	pivotal-tracker	215	pivotal-tracker
197	rails (= 3.0.5)	216	rails (= 3.0.5)
198	redmine_client!	217	redmine_client!
@@ -0,0 +1,20 @@		@@ -0,0 +1,20 @@
	1	+class GithubTracker < IssueTracker
	2	+ def self.label; "github"; end
	3	+
	4	+ def check_params
	5	+ if %w(project_id username api_token ).detect {\|f\| self[f].blank? }
	6	+ errors.add :base, 'You must specify your Github repository, username and API token'
	7	+ end
	8	+ end
	9	+
	10	+ def create_issue(err)
	11	+ client = Octokit::Client.new(:login => username, :token => api_token)
	12	+ issue = client.create_issue(project_id, issue_title(err), body_template.result(binding), options = {})
	13	+ err.update_attribute :issue_link, issue.html_url
	14	+ end
	15	+
	16	+ def body_template
	17	+ @@body_template \|\|= ERB.new(File.read(Rails.root + "app/views/issue_trackers/github_body.txt.erb").gsub(/^\s*/, ''))
	18	+ end
	19	+end
	20	+
@@ -0,0 +1,45 @@		@@ -0,0 +1,45 @@
	1	+[See this exception on Errbit](<%= app_err_url err.app, err %> "See this exception on Errbit")
	2	+<% if notice = err.notices.first %>
	3	+# <%= notice.message %> #
	4	+## Summary ##
	5	+<% if notice.request['url'].present? %>
	6	+ ### URL ###
	7	+ [<%= notice.request['url'] %>](<%= notice.request['url'] %>)"
	8	+<% end %>
	9	+### Where ###
	10	+<%= notice.err.where %>
	11	+
	12	+### Occured ###
	13	+<%= notice.created_at.to_s(:micro) %>
	14	+
	15	+### Similar ###
	16	+<%= (notice.err.notices_count - 1).to_s %>
	17	+
	18	+## Params ##
	19	+```
	20	+<%= pretty_hash(notice.params) %>
	21	+```
	22	+
	23	+## Session ##
	24	+```
	25	+<%= pretty_hash(notice.session) %>
	26	+```
	27	+
	28	+## Backtrace ##
	29	+```
	30	+<% for line in notice.backtrace %><%= line['number'] %>: <%= line['file'].sub(/^\[PROJECT_ROOT\]/, '') %> -> <%= line['method'] %>
	31	+<% end %>
	32	+```
	33	+
	34	+## Environment ##
	35	+
	36	+<table>
	37	+<% for key, val in notice.env_vars %>
	38	+ <tr>
	39	+ <td><%= key %>:</td>
	40	+ <td><%= val %></td>
	41	+ </tr>
	42	+<% end %>
	43	+</table>
	44	+<% end %>
	45	+
	@@ -402,6 +402,33 @@ describe AppsController do		@@ -402,6 +402,33 @@ describe AppsController do
402	end	402	end
403	end	403	end
404		404
		405	+ context "github issues" do
		406	+ context 'with correct params' do
		407	+ before do
		408	+ put :update, :id => @app.id, :app => { :issue_tracker_attributes => {
		409	+ :type => 'GithubTracker', :project_id => 'test', :username => 'user',
		410	+ :api_token => '123123'
		411	+ } }
		412	+ @app.reload
		413	+ end
		414	+
		415	+ subject {@app.issue_tracker}
		416	+ its(:type) {should == "GithubTracker"}
		417	+ its(:project_id) {should == 'test'}
		418	+ its(:username) {should == 'user'}
		419	+ its(:api_token) {should == '123123'}
		420	+ end
		421	+
		422	+ it "should show validation notice when sufficient params are not present" do
		423	+ put :update, :id => @app.id, :app => { :issue_tracker_attributes => {
		424	+ :type => 'GithubTracker', :project_id => 'test', :username => 'user'
		425	+ } }
		426	+ @app.reload
		427	+
		428	+ @app.issue_tracker_configured?.should == false
		429	+ response.body.should match(/You must specify your Github repository, username and API token/)
		430	+ end
		431	+ end
405		432
406	end	433	end
407	end	434	end
	@@ -435,3 +462,4 @@ describe AppsController do		@@ -435,3 +462,4 @@ describe AppsController do
435	end	462	end
436		463
437	end	464	end
		465	+
	@@ -395,6 +395,53 @@ describe ErrsController do		@@ -395,6 +395,53 @@ describe ErrsController do
395	err.issue_link.should == @issue_link.sub(/\.xml$/, '')	395	err.issue_link.should == @issue_link.sub(/\.xml$/, '')
396	end	396	end
397	end	397	end
		398	+
		399	+ context "github issues tracker" do
		400	+ let(:notice) { Factory :notice }
		401	+ let(:tracker) { Factory :github_tracker, :app => notice.err.app }
		402	+ let(:err) { notice.err }
		403	+
		404	+ before(:each) do
		405	+ number = 5
		406	+ @issue_link = "https://github.com/#{tracker.project_id}/issues/#{number}"
		407	+ body = <<EOF
		408	+{
		409	+ "issue": {
		410	+ "position": 1.0,
		411	+ "number": #{number},
		412	+ "votes": 0,
		413	+ "created_at": "2010/01/21 13:45:59 -0800",
		414	+ "comments": 0,
		415	+ "body": "Test Body",
		416	+ "title": "Test Issue",
		417	+ "user": "test_user",
		418	+ "state": "open",
		419	+ "html_url": "#{@issue_link}"
		420	+ }
		421	+}
		422	+EOF
		423	+ stub_request(:post, "https://#{tracker.username}%2Ftoken:#{tracker.api_token}@github.com/api/v2/json/issues/open/#{tracker.project_id}").
		424	+ to_return(:status => 201, :headers => {'Location' => @issue_link}, :body => body )
		425	+
		426	+ post :create_issue, :app_id => err.app.id, :id => err.id
		427	+ err.reload
		428	+ end
		429	+
		430	+ it "should make request to Github with err params" do
		431	+ requested = have_requested(:post, "https://#{tracker.username}%2Ftoken:#{tracker.api_token}@github.com/api/v2/json/issues/open/#{tracker.project_id}")
		432	+ WebMock.should requested.with(:headers => {'Content-Type' => 'application/x-www-form-urlencoded'})
		433	+ WebMock.should requested.with(:body => /title=%5Bproduction%5D%5Bfoo%23bar%5D%20FooError%3A%20Too%20Much%20Bar/)
		434	+ WebMock.should requested.with(:body => /See%20this%20exception%20on%20Errbit/)
		435	+ end
		436	+
		437	+ it "should redirect to err page" do
		438	+ response.should redirect_to( app_err_path(err.app, err) )
		439	+ end
		440	+
		441	+ it "should create issue link for err" do
		442	+ err.issue_link.should == @issue_link
		443	+ end
		444	+ end
398	end	445	end
399		446
400	context "absent issue tracker" do	447	context "absent issue tracker" do
	@@ -20,3 +20,9 @@ Factory.define :mingle_tracker, :parent => :issue_tracker, :class => :mingle_tra		@@ -20,3 +20,9 @@ Factory.define :mingle_tracker, :parent => :issue_tracker, :class => :mingle_tra
20	e.ticket_properties 'card_type = Defect, defect_status = open, priority = essential'	20	e.ticket_properties 'card_type = Defect, defect_status = open, priority = essential'
21	end	21	end
22		22
		23	+Factory.define :github_tracker, :parent => :issue_tracker, :class => :github_tracker do \|e\|
		24	+ e.project_id 'test_account/test_project'
		25	+ e.username 'test_username'
		26	+ e.api_token '12497asfa987'
		27	+end
		28	+