gitlab-fogbugz 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008 John Reilly
+
+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.

data/README.markdown

@@ -0,0 +1,105 @@
+GitLab + Fogbugz
+===
+
+This is a simple sinatra application that has three responsibilities:
+
+* Receive and parse the JSON commit info from GitLab's post-receive hooks and send it to FogBugz
+* Act as a "gateway" for viewing multiple SCM repositories in FogBugz
+* Edit case history per the commit message's instructions.
+
+Prerequisites
+---
+Gems:
+
+* sinatra
+* json
+* mocha (for running tests)
+
+Optional:
+
+* [Ragel](http://research.cs.queensu.ca/~thurston/ragel/): for generating the FogBugz message parser. If you install gitlab-fogbugz as a gem, you will *not* need to generate the message parser.
+* [GraphViz](http://www.graphviz.org): for generating a graph of the Ragel generated state machine): 
+
+To Install and Run:
+---
+
+    # Install the prerequisite gems.
+    $ sudo gem install sinatra json
+    
+    # You need Ragel locally to make this next command work.
+    # If you installed gitlab-fogbugz as a gem, you do NOT need to execute this step.
+    $ rake ragel:compile 
+    
+    # Copies the config file examples to ~/.gitlab-fogbugz/config.yml
+    $ gitlab-fogbugz
+    
+    ...edit config.yml (see "configuration" section below)...
+    
+    $ gitlab-fogbugz-server [-p port] [-e production]
+
+    # Send your developers here so they can authenticate with FogBugz.
+    # Each developer must login here before their commit messages
+    # will be sent to FogBugz.
+    $ http://<gitlab-fogbugz-address>:<port>/login
+    
+Configuration
+---
+
+### GitLab repositories:
+Set up your repositories on GitLab to send a post-receive hook to the root url of this sinatra app. Be sure to include the port, if other than 80.
+
+### gitlab-fogbugz-server (this app):
+The configuration file holds several variables that you'll need to edit.
+
+* **fb\_submit\_url**: The url to the cvsSubmit.[php|asp] file on your FogBugz server.
+* **fb\_main\_url**: The url to your FogBugz's installation.
+* **curl**: The path to the curl binary. Curl is used to submit the commit to FogBugz.
+* **repos**: A list of the SCM repositories that you're using.  Each repo has two urls:
+  * *log_url*: The url to the commit log for a specific file 
+  * *diff_url*: The url to the specific commit or revision.
+
+Each repo name must match the the values that are in the *sRepo* field in FogBug's *CVS* table.
+
+### Authenticating:
+Each developer must login to FogBugz through this app.  Visit **/login** and follow the instructions.  The act of logging in will create a tokens.yml file in the app's config directory, chmod'ed 0600.  **Note**: gitlab-fogbugz-server expects the developer's E-Mail addresses to match in both GitLab and FogBugz.
+
+### FogBugz:  
+You'll need to do some configuration in FogBugz as well.  As the FogBugz admin, edit your site settings, and in the source control urls for logs and diffs, enter:
+
+* Logs: "http://thisapp:port/repo_url?type=log&repo=^REPO&file=^FILE&r1=^R1&r2=^R2" 
+* Diffs: "http://thisapp:port/repo_url?type=diff&repo=^REPO&file=^FILE&r1=^R1&r2=^R2"
+
+The only difference between the two is the "type" parameter.
+
+> I'm not a fan of Fog Creek's [suggested solution](http://www.fogcreek.com/FogBugz/KB/howto/MultipleRepositories-Mult.html) for multiple repositories, as it requires you to copy a new script into the FogBugz website directory. This seems fine, but (as is my understanding) you'll have to copy it over again and again with each FogBugz upgrade because the website directory gets recreated each time. That's why this script also acts as the SCM viewer "gateway."
+
+**Note:** If you've been using FogBugz in the past with only a single repository, odds are your *sRepo* field is empty. Mine was. Be sure that all of the records in FogBugz's *CVS* table have a valid *sRepo* that matches up to a repo specified in the config file.
+
+Other Notes
+---
+(NOTE: This section currently does not apply: as of gitlab 2.6 the post-receive hook does not receive the fle names, [see the request at github](https://github.com/gitlabhq/gitlabhq/issues/747) ).
+
+When parsing out the file names from gitlab commits, I've tacked on the branch that the file lives on.  So in FogBugz you'll see files like "master/myfile.rb".  This is simply because my team does the "release on a branch" thing (aka [Release Line](http://www.scmpatterns.com/book/pattern-summary.html)), and I like to see which branch certain bugs were fixed on.  Feel free to modify this behavior.
+
+Caveats
+---
+(NOTE: This section currently does not apply: as of gitlab 2.6 the post-receive hook does not receive the fle names, [see the request at github](https://github.com/gitlabhq/gitlabhq/issues/747) ).
+
+It's fairly obvious that FogBugz was written for a more traditional CVS/SVN SCM system in mind. As such, the commit list display doesn't really jive with git:
+
+![Messy Commits List in FogBugz](http://img.skitch.com/20080424-kb6kujbfd224436pqgnhgj33sk.jpg)
+
+This is in FogBugz 6.1.23.  I've got a [thread started](http://support.fogcreek.com/default.asp?fogbugz.4.24526.0) on their forum asking for this to be cleaned up a bit. We'll see if it gets better in future releases.
+
+Thanks
+---
+All praises go to John Reilly et al for their work on [github-fogbugz](https://github.com/johnreilly/github-fogbugz), I simply renamed and adjusted a few things to get it working with GitLab.
+
+Major thanks to [François Beausoleil](http://github.com/francois) for turning this project into something much greater than I had dreamed of.
+
+Inspired by [github-campfire](http://github.com/jnewland/github-campfire) by [jnewland](http://github.com/jnewland) and
+[github-twitter](http://github.com/jnunemaker/github-twitter) by [jnunemaker](http://github.com/jnunemaker). 
+
+License
+---
+MIT.  See LICENSE file.

data/Rakefile

@@ -0,0 +1,83 @@
+# encoding: utf-8
+require "rubygems"
+require "rake/testtask"
+require "rake/gempackagetask"
+
+GEM = "gitlab-fogbugz"
+VERSION = "0.0.1"
+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"
+SUMMARY = "Fork of github-fogbugz, a gem that acts as the gateway between GitLab and Fogbugz."
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.markdown", "LICENSE", "TODO"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.authors = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.executables = ["gitlab-fogbugz-server", "gitlab-fogbugz"]
+  
+  # Uncomment this to add a dependency
+  s.add_dependency "json", "~> 1.1.2"
+  
+  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}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{VERSION}}
+end
+
+Rake::TestTask.new("test" => "lib/message_parser.rb") do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/*_test.rb"]
+  t.verbose = true
+end
+
+task :default => :test
+
+file "lib/message_parser.rb" => "lib/message_parser_machine.rb" do
+  sh "ragel -R lib/message_parser_machine.rb -o lib/message_parser.rb"
+end
+
+file "tmp/machine.dot" => "lib/message_parser_machine.rb" do
+  sh "ragel -V lib/message_parser_machine.rb -o tmp/machine.dot"
+end
+
+file "tmp/machine.png" => "tmp/machine.dot" do
+  sh "dot -Tpng tmp/machine.dot > tmp/machine.png"
+end
+
+namespace :ragel do
+  desc "Compile the Ragel state machine to executable Ruby code"
+  task :compile => "lib/message_parser.rb"
+
+  desc "Generate tmp/machine.png"
+  task :graph => "tmp/machine.png"
+
+  desc "Delete generated Ragel files"
+  task :clean do
+    rm_f "lib/message_parser.rb"
+    rm_f "tmp/machine.dot"
+    rm_f "tmp/machine.png"
+  end
+end
+
+task :ragel => %w(ragel:compile ragel:graph)
+
+desc "Remove all generated files"
+task :clean => "ragel:clean" do
+  rm_rf "pkg"
+end

data/TODO

@@ -0,0 +1,4 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/<%= name %>.rb

data/bin/gitlab-fogbugz

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require "fileutils"
+
+case ARGV.length
+when 0
+  config_path = File.expand_path("~/.gitlab-fogbugz/")
+when 1
+  config_path = File.expand_path(ARGV.shift)
+else
+  puts "0 or 1 arguments expected, received #{ARGV.length}"
+  puts
+  puts "Usage:"
+  puts "  #{$0} </path/to/config/dir>"
+  puts "  defaults to ~/.gitlab-fogbugz"
+  exit 1
+end
+
+FileUtils.mkpath(config_path)
+filename = config_path + "/config.yml"
+if File.exists? filename
+  puts "You already have an existing configuration in '#{filename}', not overwriting."
+else
+  puts "Writing configuration file to #{config_path}/config.yml"
+  FileUtils.cp(File.dirname(__FILE__) + "/../config/config.yml.example", config_path + "/config.yml")
+  puts "You now have to edit the configuration file and set the right values."
+end
+puts "Documentation is available in the config file itself."

data/bin/gitlab-fogbugz-server

@@ -0,0 +1,262 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'json'
+require 'sinatra'
+require 'yaml'
+require 'cgi'
+require 'fileutils'
+
+$: << File.dirname(__FILE__) + "/../lib"
+require 'fogbugz_service'
+require 'fogbugz_listener'
+require 'message_parser'
+
+# Returns the path to the configuration file.  It defaults to ~/.gitlab-fogbugz/config.yml
+def config_path
+  @config_path ||= File.expand_path(ENV["CONFIG_PATH"] || "~/.gitlab-fogbugz/config.yml")
+end
+
+# Returns a Hash of configuration options read from +config_path+.
+def config
+  return @config if @config
+  @config = File.file?(config_path) ? YAML.load_file(config_path) : Hash.new
+end
+
+def write_config
+  FileUtils.mkpath(File.dirname(config_path)) if File.directory?(File.dirname(config_path))
+  File.open(config_path, "w") {|io| io.write config.to_yaml}
+end
+
+# Returns the path to the tokens file.  It defaults to ~/.gitlab-fogbugz/tokens.yml
+def tokens_path
+  @tokens_path ||= File.expand_path(ENV["TOKENS_PATH"] || "~/.gitlab-fogbugz/tokens.yml")
+end
+
+# Returns a Hash of tokens read from +tokens_path+.
+def tokens
+  return @tokens if @tokens
+  FileUtils.mkpath(File.dirname(tokens_path)) if File.directory?(File.dirname(tokens_path))
+  @tokens = File.file?(tokens_path) ? YAML.load_file(tokens_path) : Hash.new
+end
+
+def write_tokens
+  FileUtils.mkpath(File.dirname(tokens_path)) if File.directory?(File.dirname(tokens_path))
+  File.open(tokens_path, "w") {|io| io.write tokens.to_yaml}
+end
+
+# This sinatra app has a couple of endpoints:
+#  /              This is where GitLab will send 
+#                 its post-receive hooks
+#
+#  /repo_url      This is where FogBugz will send 
+#                 you when you click on a commit link
+#
+# If you want this Sinatra app to read the commit messages
+# to resolve/close issues automatically, you need to have
+# each of your developers to visit this page:
+#
+# /login          This is a simple form to tell gitlab-fogbugz
+#                 about all of your developers.  Each dev must
+#                 authenticate once with this app, then the token
+#                 is kept on the filesystem.
+
+##
+# 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
+}
+
+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
+
+post "/authenticate" do
+  begin
+    service = FogbugzService.new(config["fb_main_url"], config["curl"])
+    service.connect do
+      token = service.logon(params["email"], params["password"])
+      tokens[params["email"]] = token
+    end
+
+    write_tokens
+    redirect "/authenticated"
+  rescue FogbugzService::BadCredentials
+    "<p>Failed authentication: <strong>#{$!.message}</strong></p>" + AUTH_FORM.call(config['fb_main_url'], params)
+  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", Inquirt -&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>"
+  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
+
+## 
+# 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
+  
+  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
+
+
+##
+# This class does all of the json parsing and submits a push's commits to fogbugz
+class GitlabFogbugz
+  
+  def initialize(payload)
+    payload = JSON.parse(payload)
+    return unless payload.keys.include?("repository")
+    
+    repo = payload["repository"]["name"]
+    branch = payload["ref"].split('/').last
+    
+    payload["commits"].each do |c|
+      process_commit(c["id"], c, repo, branch, payload['before'], config['fb_submit_url'], config['curl'])
+    end
+    
+    rescue
+      puts "Oh noez, something went wrong: #{$!.message}"
+      puts $!.backtrace.join("\n")
+      raise
+  end
+
+  def submit_to_fogbugz(sha1, commit, token, curl_path)
+    listener = FogbugzListener.new(:commit_url => commit["url"], :message => commit["message"], :sha1 => sha1)
+    MessageParser.parse(commit["message"], listener)
+    service = FogbugzService.new(config["fb_main_url"], curl_path, token)
+    service.connect do
+      listener.update_fogbugz(service)
+    end
+  end
+
+  def process_commit(sha1, commit, repo, branch, before, fb_submit_url, curl_path)
+    
+    # from each commit in the payload, we need to extract:
+    # - name of repo, renamed as "gitlab-<repo>"
+    # - name of file, including branch. e.g.: "4.7/Builds/Cablecast.fbp4"
+    # - sha1 of commit (R2)
+    # - sha1 of before (R1)
+    # - bugzid (found inside the commit message)
+    
+    message = commit["message"]
+    author = commit["author"]["email"]
+
+    token = tokens[author]
+    submit_to_fogbugz(sha1, commit, token, curl_path) if token
+
+    files = commit["removed"] | commit["added"] | commit["modified"]
+    files = [] if !files
+    
+    # look for a bug id in each line of the commit message
+    bug_list = []
+    message.split("\n").each do |line|
+      if (line =~ /\s*Bug[zs]*\s*IDs*\s*[#:; ]+((\d+[ ,:;#]*)+)/i)
+        bug_list << $1.to_i
+      end
+    end
+    
+    # for each found bugzid, submit the files to fogbugz.
+    # this will set the sRepo to "gitlab-<repo>", which will be used above
+    # when fogbugz asks for the scm viewer url.
+    bug_list.each do |fb_bugzid|
+      files.each do |f|
+        fb_repo = CGI.escape("gitlab-#{repo}")
+        fb_r1 = CGI.escape("#{before}")
+        fb_r2 = CGI.escape("#{sha1}")
+        fb_file = CGI.escape("#{branch}/#{f}")
+        
+        #build the GET request, and send it to fogbugz
+        fb_url = "#{fb_submit_url}?ixBug=#{fb_bugzid}&sRepo=#{fb_repo}&sFile=#{fb_file}&sPrev=#{fb_r1}&sNew=#{fb_r2}"
+        puts `#{curl_path} --insecure --silent --output /dev/null '#{fb_url}'`
+
+      end
+    end
+  end
+end

data/config/config.yml.example

@@ -0,0 +1,24 @@
+# GithubFogbugz configuration file
+# ================================
+#
+# Setup your gitlab-fogbugz integration through this configuration file.
+#
+# The URL to the cvsSubmit.[php|asp] file on your server.  This is to add the list of changed files to the cases.
+fb_submit_url:  "http://fogbugz.server.com/cvsSubmit.php"
+
+# The URL to the root of your FogBugz installation.
+fb_main_url:  "http://fogbugz.server.com/"
+
+# The path to the Curl binary.  Curl is used because of issues with SSL in Ruby's libraries.
+curl: "/usr/bin/curl"
+
+# A list of repositories that are known to your FogBugz installation.
+# Each repository is identified by a name and has 2 values: log_url and diff_url.
+# The repository's name must match the value given in the sRepos field of your FogBugz installation.
+#
+# See the FogBugz section in README.markdown for the details of how to setup your urls.
+# The examples below will get you started.
+repos:
+  gitlab-project:
+    log_url: "https://gitlab/project/commits?path=^FILE"
+    diff_url: "https://gitlab/project/commits/^R2"

data/lib/fogbugz_listener.rb

@@ -0,0 +1,64 @@
+class FogbugzListener
+  attr_reader :options
+
+  def initialize(options={})
+    @options = options
+    @state = :invalid
+    @actions = Hash.new {|h, k| h[k] = Array.new}
+  end
+
+  def fix
+    @state = :fix
+  end
+
+  def implement
+    @state = :implement
+  end
+
+  def reopen
+    @state = :reopen
+  end
+
+  def close
+    @state = :close
+  end
+
+  def reference
+    @state = :reference
+  end
+
+  def complete
+    @state = :complete
+  end
+
+  def case(bugid)
+    @actions[@state] << bugid
+  end
+
+  def resolve
+    @state = :resolve
+  end
+
+  def update_fogbugz(service)
+    references = @actions.delete(:reference)
+
+    message_header = ""
+    message_header << "Commit: #{options[:sha1]}\n"
+    message_header << "#{options[:commit_url]}\n" if options[:commit_url]
+
+    message = message_header + "\n" + options[:message]
+
+    if @actions.empty? then
+      references.each do |bugid|
+        service.append_message(:case => bugid, :message => message)
+      end if references
+    else
+      message << "\n\nReferences " << references.map {|bugid| "case #{bugid}"}.join(", ") if references && !references.empty?
+      @actions.each_pair do |action, bugids|
+        bugids.each do |bugid|
+          service.send(action, :case => bugid, :message => message)
+        end
+      end
+    end
+  end
+end