gitlab-fogbugz 0.0.2 → 0.0.3

data/HISTORY.md

@@ -0,0 +1,12 @@
+# 0.0.3 / 2012-07-15
+* Make gitlab-fogbugz-server actually work when installed as gem
+* Fix tests in Ruby 1.9.2 (did work in 1.8 and 1.9.3)
+
+# 0.0.2 / 2012-07-12
+* Switched from curl to programmatically use the FogBugz API via ruby-fogbugz
+  The initial reason to use curl were Ruby 1.8 SSL issues; just hope they've
+  been fixed in the last four years.
+
+# 0.0.1 / 2012-07-12
+* Forked from github-fogbugz
+* First adaption to work with GitLiab

data/README.markdown

@@ -1,5 +1,6 @@
 GitLab + Fogbugz
 ===
+(forked and adapted from [github-fogbugz](https://github.com/johnreilly/github-fogbugz/))
 
 This is a simple sinatra application that has three responsibilities:
 

data/Rakefile

@@ -4,7 +4,7 @@ require "rake/testtask"
 require "rake/gempackagetask"
 
 GEM = "gitlab-fogbugz"
-VERSION = "0.0.2"
+VERSION = "0.0.3"
 AUTHOR = ["John Reilly", "François Beausoleil", "Markus Fischer"]
 EMAIL = ["jr@trms.com", "francois@teksol.info", "markus@fischer.name"]
 HOMEPAGE = "http://github.com/mfn/gitlab-fogbugz"
@@ -32,7 +32,7 @@ spec = Gem::Specification.new do |s|
   s.require_path = "lib"
 
   # Must reference lib/message_parser.rb explicitely, or it won't be automatically generated
-  s.files = %w(LICENSE README.markdown Rakefile TODO lib/message_parser.rb) + Dir.glob("{lib,test,config,samples,bin}/**/*")
+  s.files = %w(HISTORY.md LICENSE README.markdown Rakefile TODO lib/message_parser.rb) + Dir.glob("{lib,test,config,samples,bin}/**/*")
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/TODO

@@ -1,3 +1,6 @@
-TODO:
-- Implement FogBugz checkins once GitLab provides this feature
+# TODO:
+* Implement FogBugz checkins once GitLab provides this feature
   (see https://github.com/gitlabhq/gitlabhq/issues/747 )
+* After switching to Sinatra::Base, automagically --help and e.g. setting port
+  from sinatra isn't available anymore. Provide some alternative or do in a
+  smarter way.

data/bin/gitlab-fogbugz-server

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# vim: filetype=ruby:
 require 'rubygems'
 require 'json'
-require 'sinatra'
+require 'sinatra/base'
 require 'yaml'
 require 'cgi'
 require 'fileutils'
@@ -60,128 +61,130 @@ end
 #                 about all of your developers.  Each dev must
 #                 authenticate once with this app, then the token
 #                 is kept on the filesystem.
+class GitlabFogbugzServer < Sinatra::Base
 
-##
-# GitLab should send its post-receive hook here.
-post '/' do
-  request.body.rewind
-  GitlabFogbugz.new(request.body.read)
-end
+  ##
+  # GitLab should send its post-receive hook here.
+  post '/' do
+    request.body.rewind
+    GitlabFogbugz.new(request.body.read)
+  end
 
-AUTH_FORM = lambda {|fb_url, params|
-  <<-EOHTML
-<h1>FogBugz Authentication</h1>
-<p>This form will authenticate you to <strong>#{fb_url}</strong></p>
-<form method="post" action="/authenticate">
-  <p><label for="email">Email:</label><br/>
-  <input name="email" size="40" value="#{params['email']}"/></p>
-  <p><label for="password">Password:</label><br/>
-  <input type="password" name="password" size="20"/></p>
-  <p><input type="submit" value="Authenticate to FogBugz"/></p>
-</form>
-EOHTML
-}
+  AUTH_FORM = lambda {|fb_url, params|
+    <<-EOHTML
+  <h1>FogBugz Authentication</h1>
+  <p>This form will authenticate you to <strong>#{fb_url}</strong></p>
+  <form method="post" action="/authenticate">
+    <p><label for="email">Email:</label><br/>
+    <input name="email" size="40" value="#{params['email']}"/></p>
+    <p><label for="password">Password:</label><br/>
+    <input type="password" name="password" size="20"/></p>
+    <p><input type="submit" value="Authenticate to FogBugz"/></p>
+  </form>
+  EOHTML
+  }
 
-get "/login" do
-  if fb_main_url = config['fb_main_url'] then
-    AUTH_FORM.call(fb_main_url, Hash.new)
-  else
-    "<h1>A configuration error exists</h1><p>Ooops, the configuration file does not exist at path: <strong><tt>#{config_path}</tt></strong>.</p>"
+  get "/login" do
+    if fb_main_url = config['fb_main_url'] then
+      AUTH_FORM.call(fb_main_url, Hash.new)
+    else
+      "<h1>A configuration error exists</h1><p>Ooops, the configuration file does not exist at path: <strong><tt>#{config_path}</tt></strong>.</p>"
+    end
   end
-end
 
-post "/authenticate" do
-  begin
-    api = Fogbugz::Interface.new(:email => params["email"], :password => params["password"], :uri => config["fb_main_url"])
-    tokens[ params["email"] ] = api.authenticate
-    write_tokens
-    redirect "/authenticated"
-  rescue Fogbugz::AuthenticationException
-    "<p>Failed authentication: <strong>#{$!.message}</strong></p>" + AUTH_FORM.call(config['fb_main_url'], params)
+  post "/authenticate" do
+    begin
+      api = Fogbugz::Interface.new(:email => params["email"], :password => params["password"], :uri => config["fb_main_url"])
+      tokens[ params["email"] ] = api.authenticate
+      write_tokens
+      redirect "/authenticated"
+    rescue Fogbugz::AuthenticationException
+      "<p>Failed authentication: <strong>#{$!.message}</strong></p>" + AUTH_FORM.call(config['fb_main_url'], params)
+    end
   end
-end
-
-get "/authenticated" do
-  <<-HTML
-    <h1>Authenticated</h1>
-    <p>You are now authenticated to FogBugz.  Go forth and commit!</p>
-    
-    <h2>Writing commit messages</h2>
-    <p>Your commit messages can now contain text like the following to automatically manage your cases:</p>
-    <blockquote>
-      <p>Implemented foo, corrected baz.</p>
-      <p>Implements #1234, references #2345.  Closes #1234.</p>
-    </blockquote>
-    <p>This would automatically add the commit message to cases #1234 <em>and</em> #2345.  The commit message will be appended as an event to the case.  In addition, case #1234 will be closed.</p>
-    <p>You can also mention multiple cases with one keyword, e.g. <tt>Implements #1234 and #5123</tt>.</p>
-    <p>GitlabFogbugz recognizes the following keywords (also singular versions of the same keywords):</p>
-    <ul>
-        <li><tt>bugzid:</tt><br>For "compatibility" with the subversion wrapper provided by Fogcreek; however you still need to prefix the case number with <tt>#</tt>. Works like <tt>references</tt>.</li>
-        <li><tt>closes</tt></li>
-        <li><tt>completes</tt></li>
-        <li><tt>fixes</tt></li>
-        <li><tt>implements</tt></li>
-        <li><tt>reopens</tt></li>
-        <li><tt>references</tt> or <tt>refs</tt><br>Does not change the state of the case, just adds the commit message to this case.</li>
-        <li><tt>resolves</tt><br>Resolves is different then <tt>closes</tt>, <tt>completes</tt>, <tt>fixes</tt> and <tt>implements</tt>: it does not explicitly sets the FogBugz case status, thus changes the case to it's categories default status for resolved cases: Bug -&gt; "fixed", Feature -&gt; "Implemented", Inquiry -&gt; "Responded" and Schedule Item -&gt; "Completed"</li>
-    </ul>
-    <p>NOTE:  FogBugz does not allow closing a case that isn't resolved, so you really must use "Implements X, closes X", or else it won't work.</p>
-    <p>Back to <a href="/tokens">Authenticated users</a></p>
-  HTML
-end
 
-get "/tokens" do
-  response = []
-  response << "<h1>List of authenticated users</h1>"
-  response << "<ul>"
-  tokens.map do |email, token|
-    response << "<li>#{email}"
-    response << %Q(<form method="post" action="/remove"><input type="hidden" name="email" value="#{email}"/><input type="submit" value="Remove"/></form>)
-    response << "</li>"
+  get "/authenticated" do
+    <<-HTML
+      <h1>Authenticated</h1>
+      <p>You are now authenticated to FogBugz.  Go forth and commit!</p>
+      
+      <h2>Writing commit messages</h2>
+      <p>Your commit messages can now contain text like the following to automatically manage your cases:</p>
+      <blockquote>
+        <p>Implemented foo, corrected baz.</p>
+        <p>Implements #1234, references #2345.  Closes #1234.</p>
+      </blockquote>
+      <p>This would automatically add the commit message to cases #1234 <em>and</em> #2345.  The commit message will be appended as an event to the case.  In addition, case #1234 will be closed.</p>
+      <p>You can also mention multiple cases with one keyword, e.g. <tt>Implements #1234 and #5123</tt>.</p>
+      <p>GitlabFogbugz recognizes the following keywords (also singular versions of the same keywords):</p>
+      <ul>
+          <li><tt>bugzid:</tt><br>For "compatibility" with the subversion wrapper provided by Fogcreek; however you still need to prefix the case number with <tt>#</tt>. Works like <tt>references</tt>.</li>
+          <li><tt>closes</tt></li>
+          <li><tt>completes</tt></li>
+          <li><tt>fixes</tt></li>
+          <li><tt>implements</tt></li>
+          <li><tt>reopens</tt></li>
+          <li><tt>references</tt> or <tt>refs</tt><br>Does not change the state of the case, just adds the commit message to this case.</li>
+          <li><tt>resolves</tt><br>Resolves is different then <tt>closes</tt>, <tt>completes</tt>, <tt>fixes</tt> and <tt>implements</tt>: it does not explicitly sets the FogBugz case status, thus changes the case to it's categories default status for resolved cases: Bug -&gt; "fixed", Feature -&gt; "Implemented", Inquiry -&gt; "Responded" and Schedule Item -&gt; "Completed"</li>
+      </ul>
+      <p>NOTE:  FogBugz does not allow closing a case that isn't resolved, so you really must use "Implements X, closes X", or else it won't work.</p>
+      <p>Back to <a href="/tokens">Authenticated users</a></p>
+    HTML
   end
 
-  response << "</ul>"
-  response << %Q(<p><a href="/login">Add a user</a></p>)
-  response.join("\n")
-end
-
-post "/remove" do
-  redirect "/tokens" unless params["email"]
-  tokens.delete(params["email"])
-  write_tokens
-  redirect "/tokens"
-end
+  get "/tokens" do
+    response = []
+    response << "<h1>List of authenticated users</h1>"
+    response << "<ul>"
+    tokens.map do |email, token|
+      response << "<li>#{email}"
+      response << %Q(<form method="post" action="/remove"><input type="hidden" name="email" value="#{email}"/><input type="submit" value="Remove"/></form>)
+      response << "</li>"
+    end
 
-## 
-# Set the log and diff urls (in fogbugz's site settings) to point here.
-# Log url:  http://localhost:4567/repo_url?type=log&repo=^REPO&file=^FILE&r1=^R1&r2=^R2
-# Diff url: http://localhost:4567/repo_url?type=diff&repo=^REPO&file=^FILE&r1=^R1&r2=^R2
-get '/repo_url' do
-  #pull out the repo's scm viewer url from the config file
-  if params[:type] == 'log'
-    url = config['repos'][params[:repo]]['log_url']
-  elsif params[:type] == 'diff'
-    url = config['repos'][params[:repo]]['diff_url']
-  else
-    "Unknown repo viewer type."
+    response << "</ul>"
+    response << %Q(<p><a href="/login">Add a user</a></p>)
+    response.join("\n")
   end
-  
-  if url
-    url.gsub!(/\^REPO/, params[:repo])
-    url.gsub!(/\^FILE/, params[:file])
-    url.gsub!(/\^R1/, params[:r1])
-    url.gsub!(/\^R2/, params[:r2])
-    redirect url
+
+  post "/remove" do
+    redirect "/tokens" unless params["email"]
+    tokens.delete(params["email"])
+    write_tokens
+    redirect "/tokens"
   end
+
+  ## 
+  # Set the log and diff urls (in fogbugz's site settings) to point here.
+  # Log url:  http://localhost:4567/repo_url?type=log&repo=^REPO&file=^FILE&r1=^R1&r2=^R2
+  # Diff url: http://localhost:4567/repo_url?type=diff&repo=^REPO&file=^FILE&r1=^R1&r2=^R2
+  get '/repo_url' do
+    #pull out the repo's scm viewer url from the config file
+    if params[:type] == 'log'
+      url = config['repos'][params[:repo]]['log_url']
+    elsif params[:type] == 'diff'
+      url = config['repos'][params[:repo]]['diff_url']
+    else
+      "Unknown repo viewer type."
+    end
     
-end
+    if url
+      url.gsub!(/\^REPO/, params[:repo])
+      url.gsub!(/\^FILE/, params[:file])
+      url.gsub!(/\^R1/, params[:r1])
+      url.gsub!(/\^R2/, params[:r2])
+      redirect url
+    end
+      
+  end
 
-error do
-  err = request.env['sinatra.error']
-  puts "Error handling request: #{err.name}"
-  puts err.backtrace.join("\n")
-end
+  error do
+    err = request.env['sinatra.error']
+    puts "Error handling request: #{err.name}"
+    puts err.backtrace.join("\n")
+  end
 
+end
 
 ##
 # This class does all of the json parsing and submits a push's commits to fogbugz
@@ -255,3 +258,5 @@ class GitlabFogbugz
     end
   end
 end
+
+GitlabFogbugzServer.run!

data/test/fogbugz_listener_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/test_helper"
+require_relative "test_helper"
 require "fogbugz_listener"
 
 class FogbugzListenerTest < Test::Unit::TestCase

data/test/message_parser_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/test_helper"
+require_relative "test_helper"
 require "message_parser"
 
 class MessageParserTest < Test::Unit::TestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-fogbugz
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-14 00:00:00.000000000 Z
+date: 2012-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -92,6 +92,7 @@ extra_rdoc_files:
 - LICENSE
 - TODO
 files:
+- HISTORY.md
 - LICENSE
 - README.markdown
 - Rakefile